mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 03:46:00 -07:00
824 lines
28 KiB
HTML
824 lines
28 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>class GxG::Events::Message - RDoc Documentation</title>
|
|
|
|
<script type="text/javascript">
|
|
var rdoc_rel_prefix = "../../";
|
|
var index_rel_prefix = "../../";
|
|
</script>
|
|
|
|
<script src="../../js/navigation.js" defer></script>
|
|
<script src="../../js/search.js" defer></script>
|
|
<script src="../../js/search_index.js" defer></script>
|
|
<script src="../../js/searcher.js" defer></script>
|
|
<script src="../../js/darkfish.js" defer></script>
|
|
|
|
<link href="../../css/fonts.css" rel="stylesheet">
|
|
<link href="../../css/rdoc.css" rel="stylesheet">
|
|
|
|
|
|
|
|
<body id="top" role="document" class="class">
|
|
<nav role="navigation">
|
|
<div id="project-navigation">
|
|
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
<h2>
|
|
<a href="../../index.html" rel="home">Home</a>
|
|
</h2>
|
|
|
|
<div id="table-of-contents-navigation">
|
|
<a href="../../table_of_contents.html#pages">Pages</a>
|
|
<a href="../../table_of_contents.html#classes">Classes</a>
|
|
<a href="../../table_of_contents.html#methods">Methods</a>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
<form action="#" method="get" accept-charset="utf-8">
|
|
<div id="search-field-wrapper">
|
|
<input id="search-field" role="combobox" aria-label="Search"
|
|
aria-autocomplete="list" aria-controls="search-results"
|
|
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
title="Type to search, Up and Down to navigate, Enter to load">
|
|
</div>
|
|
|
|
<ul id="search-results" aria-label="Search Results"
|
|
aria-busy="false" aria-expanded="false"
|
|
aria-atomic="false" class="initially-hidden"></ul>
|
|
</form>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div id="class-metadata">
|
|
|
|
<div id="parent-class-section" class="nav-section">
|
|
<h3>Parent</h3>
|
|
|
|
|
|
<p class="link"><a href="../../Object.html">Object</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<div id="method-list-section" class="nav-section">
|
|
<h3>Methods</h3>
|
|
|
|
<ul class="link-list" role="directory">
|
|
|
|
<li ><a href="#method-c-new">::new</a>
|
|
|
|
<li ><a href="#method-i-5B-5D">#[]</a>
|
|
|
|
<li ><a href="#method-i-5B-5D-3D">#[]=</a>
|
|
|
|
<li ><a href="#method-i-body">#body</a>
|
|
|
|
<li ><a href="#method-i-compose_reply">#compose_reply</a>
|
|
|
|
<li ><a href="#method-i-fail">#fail</a>
|
|
|
|
<li ><a href="#method-i-get_at_path">#get_at_path</a>
|
|
|
|
<li ><a href="#method-i-id">#id</a>
|
|
|
|
<li ><a href="#method-i-inspect">#inspect</a>
|
|
|
|
<li ><a href="#method-i-keys">#keys</a>
|
|
|
|
<li ><a href="#method-i-on">#on</a>
|
|
|
|
<li ><a href="#method-i-paths_to">#paths_to</a>
|
|
|
|
<li ><a href="#method-i-process">#process</a>
|
|
|
|
<li ><a href="#method-i-process-21">#process!</a>
|
|
|
|
<li ><a href="#method-i-search">#search</a>
|
|
|
|
<li ><a href="#method-i-sender">#sender</a>
|
|
|
|
<li ><a href="#method-i-set_at_path">#set_at_path</a>
|
|
|
|
<li ><a href="#method-i-subject">#subject</a>
|
|
|
|
<li ><a href="#method-i-succeed">#succeed</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="class-GxG::Events::Message">
|
|
<h1 id="class-GxG::Events::Message" class="class">
|
|
class GxG::Events::Message
|
|
</h1>
|
|
|
|
<section class="description">
|
|
|
|
</section>
|
|
|
|
|
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Class Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-c-new" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">new</span><span
|
|
class="method-args">(*args)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="new-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 7</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
<span class="ruby-comment"># MUST provide a hash with at least :sender message field set</span>
|
|
<span class="ruby-comment"># {:sender => <some-object>, :body => <some-object>, :on_success => <some-proc>, :on_fail => <some-proc> }</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you must pass a Hash to create the message"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@data</span> = {<span class="ruby-value">:sender</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:id</span> <span class="ruby-operator">=></span> (<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">uuid_generate</span>().<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>), <span class="ruby-value">:subject</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>], <span class="ruby-value">:body</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:on_success</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:on_fail</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>])
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@data</span>[<span class="ruby-value">:sender</span>]
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you must set the :sender key in the argument Hash"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">self</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Instance Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-i-5B-5D" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">[]</span><span
|
|
class="method-args">(the_key)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="5B-5D-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 81</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">the_key</span>)
|
|
<span class="ruby-ivar">@data</span>[(<span class="ruby-identifier">the_key</span>)]
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-5B-5D-3D" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">[]=</span><span
|
|
class="method-args">(the_key, the_value)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="5B-5D-3D-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 84</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]=</span>(<span class="ruby-identifier">the_key</span>, <span class="ruby-identifier">the_value</span>)
|
|
<span class="ruby-ivar">@data</span>[(<span class="ruby-identifier">the_key</span>)] = <span class="ruby-identifier">the_value</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-body" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">body</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="body-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 36</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">body</span>()
|
|
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:body</span>]
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-compose_reply" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">compose_reply</span><span
|
|
class="method-args">(&block)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="compose_reply-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 40</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">compose_reply</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
|
<span class="ruby-identifier">reply_message</span> = <span class="ruby-identifier">new_message</span>({<span class="ruby-value">:sender</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>[<span class="ruby-value">:to</span>], <span class="ruby-value">:to</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>[<span class="ruby-value">:sender</span>], <span class="ruby-value">:context</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>[<span class="ruby-value">:context</span>], <span class="ruby-value">:subject</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>[<span class="ruby-value">:subject</span>], <span class="ruby-value">:body</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>[<span class="ruby-value">:body</span>]})
|
|
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">reply_message</span>)
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-fail" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">fail</span><span
|
|
class="method-args">(input=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="fail-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 55</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fail</span>(<span class="ruby-identifier">input</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@data</span>[<span class="ruby-value">:on_fail</span>].<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
|
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:on_fail</span>].<span class="ruby-identifier">call</span>(<span class="ruby-identifier">input</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-get_at_path" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">get_at_path</span><span
|
|
class="method-args">(*args)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="get_at_path-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 99</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_at_path</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">get_at_path</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-id" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">id</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="id-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 24</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">id</span>()
|
|
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:id</span>]
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-inspect" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">inspect</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="inspect-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 20</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>()
|
|
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">inspect</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-keys" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">keys</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Hash-like support methods:</p>
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="keys-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 78</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">keys</span>()
|
|
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">keys</span>()
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-on" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">on</span><span
|
|
class="method-args">(event_type=nil,&block)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="on-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 61</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">on</span>(<span class="ruby-identifier">event_type</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-keyword">if</span> [<span class="ruby-value">:success</span>, <span class="ruby-value">:fail</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">event_type</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
|
<span class="ruby-keyword">case</span> <span class="ruby-identifier">event_type</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:success</span>
|
|
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:on_success</span>] = <span class="ruby-identifier">block</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:fail</span>
|
|
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:on_fail</span>] = <span class="ruby-identifier">block</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a callable block."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"Unknown event type: #{event_type}"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-paths_to" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">paths_to</span><span
|
|
class="method-args">(*args)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="paths_to-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 96</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">paths_to</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">paths_to</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-process" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">process</span><span
|
|
class="method-args">(&block)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="process-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 87</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">process</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-process-21" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">process!</span><span
|
|
class="method-args">(&block)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="process-21-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 90</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process!</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">process!</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-search" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">search</span><span
|
|
class="method-args">(&block)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="search-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 93</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">search</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-sender" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">sender</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="sender-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 28</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sender</span>()
|
|
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:sender</span>]
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-set_at_path" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">set_at_path</span><span
|
|
class="method-args">(*args)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="set_at_path-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 102</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_at_path</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">set_at_path</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-subject" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">subject</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="subject-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 32</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subject</span>()
|
|
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:subject</span>]
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-succeed" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">succeed</span><span
|
|
class="method-args">(input=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="succeed-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 49</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">succeed</span>(<span class="ruby-identifier">input</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@data</span>[<span class="ruby-value">:on_success</span>].<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
|
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:on_success</span>].<span class="ruby-identifier">call</span>(<span class="ruby-identifier">input</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
</section>
|
|
</main>
|
|
|
|
|
|
<footer id="validator-badges" role="contentinfo">
|
|
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
|
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
</footer>
|
|
|