frequency-dsl 0.0.5 → 0.0.7

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.7

data/frequency-dsl.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{frequency-dsl}
-  s.version = "0.0.5"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tiago Peczenyj"]

data/lib/frequency.rb

@@ -1,24 +1,52 @@
+# Module Frequency
+# A small dsl written in ruby to work with frequency events (never, sometimes, always..)
+#
 module Frequency
   NORMALLY  = 0.75
   SOMETIMES = 0.50
   RARELY    = 0.25
   
+  # always do something
+  # example:
+  #   always { puts "ok"}
   def always(cond={})
     yield if block_given?
   end
   
+  # normally (75%) do something,
+  # see sometimes method
+  # example:
+  #   normally { puts "ok"}
   def normally(cond={})
     execute_with_probability(cond,NORMALLY ) { yield } if block_given?
   end
   
+  # sometimes (50%) do something
+  # example:
+  #   sometimes do
+  #      # some code
+  #   end
+  # or adjusting the probability
+  #   sometimes :with_probability => 0.12 do
+  #     # some code
+  #   end
+  # you can use "12%" instead 0.12
+  #   sometimes(:with_probability => '13.6%') { ... }
   def sometimes(cond={})
     execute_with_probability(cond,SOMETIMES) { yield } if block_given?
   end
   
+  # rarely (25%) do something,
+  # see sometimes method
+  # example:
+  #   rarely { puts "ok"}
   def rarely(cond={})
     execute_with_probability(cond,RARELY   ) { yield } if block_given?
   end
   
+  # never do something
+  # example:
+  #   never { puts "ok"}  
   def never(cond={})
     nil
   end

data/rdoc/classes/Frequency.html

@@ -72,6 +72,15 @@
 
   <div id="contextContent">
 
+    <div id="description">
+      <p>
+Module <a href="Frequency.html">Frequency</a> A small dsl written in ruby
+to work with frequency events (<a href="Frequency.html#M000005">never</a>,
+<a href="Frequency.html#M000003">sometimes</a>, <a
+href="Frequency.html#M000001">always</a>..)
+</p>
+
+    </div>
 
 
    </div>
@@ -139,11 +148,17 @@
         </div>
       
         <div class="method-description">
+          <p>
+<a href="Frequency.html#M000001">always</a> do something example:
+</p>
+<pre>
+  always { puts &quot;ok&quot;}
+</pre>
           <p><a class="source-toggle" href="#"
             onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000001-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/frequency.rb, line 6</span>
+<span class="ruby-comment cmt"># File lib/frequency.rb, line 12</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">always</span>(<span class="ruby-identifier">cond</span>={})
     <span class="ruby-keyword kw">yield</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
   <span class="ruby-keyword kw">end</span>
@@ -162,11 +177,17 @@
         </div>
       
         <div class="method-description">
+          <p>
+<a href="Frequency.html#M000005">never</a> do something example:
+</p>
+<pre>
+  never { puts &quot;ok&quot;}
+</pre>
           <p><a class="source-toggle" href="#"
             onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000005-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/frequency.rb, line 22</span>
+<span class="ruby-comment cmt"># File lib/frequency.rb, line 50</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">never</span>(<span class="ruby-identifier">cond</span>={})
     <span class="ruby-keyword kw">nil</span>
   <span class="ruby-keyword kw">end</span>
@@ -185,11 +206,18 @@
         </div>
       
         <div class="method-description">
+          <p>
+<a href="Frequency.html#M000002">normally</a> (75%) do something, see <a
+href="Frequency.html#M000003">sometimes</a> method example:
+</p>
+<pre>
+  normally { puts &quot;ok&quot;}
+</pre>
           <p><a class="source-toggle" href="#"
             onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000002-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/frequency.rb, line 10</span>
+<span class="ruby-comment cmt"># File lib/frequency.rb, line 20</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">normally</span>(<span class="ruby-identifier">cond</span>={})
     <span class="ruby-identifier">execute_with_probability</span>(<span class="ruby-identifier">cond</span>,<span class="ruby-constant">NORMALLY</span> ) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
   <span class="ruby-keyword kw">end</span>
@@ -208,11 +236,18 @@
         </div>
       
         <div class="method-description">
+          <p>
+<a href="Frequency.html#M000004">rarely</a> (25%) do something, see <a
+href="Frequency.html#M000003">sometimes</a> method example:
+</p>
+<pre>
+  rarely { puts &quot;ok&quot;}
+</pre>
           <p><a class="source-toggle" href="#"
             onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000004-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/frequency.rb, line 18</span>
+<span class="ruby-comment cmt"># File lib/frequency.rb, line 43</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rarely</span>(<span class="ruby-identifier">cond</span>={})
     <span class="ruby-identifier">execute_with_probability</span>(<span class="ruby-identifier">cond</span>,<span class="ruby-constant">RARELY</span>   ) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
   <span class="ruby-keyword kw">end</span>
@@ -231,11 +266,33 @@
         </div>
       
         <div class="method-description">
+          <p>
+<a href="Frequency.html#M000003">sometimes</a> (50%) do something example:
+</p>
+<pre>
+  sometimes do
+     # some code
+  end
+</pre>
+<p>
+or adjusting the probability
+</p>
+<pre>
+  sometimes :with_probability =&gt; 0.12 do
+    # some code
+  end
+</pre>
+<p>
+you can use &quot;12%&quot; instead 0.12
+</p>
+<pre>
+  sometimes(:with_probability =&gt; '13.6%') { ... }
+</pre>
           <p><a class="source-toggle" href="#"
             onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000003-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/frequency.rb, line 14</span>
+<span class="ruby-comment cmt"># File lib/frequency.rb, line 35</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sometimes</span>(<span class="ruby-identifier">cond</span>={})
     <span class="ruby-identifier">execute_with_probability</span>(<span class="ruby-identifier">cond</span>,<span class="ruby-constant">SOMETIMES</span>) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
   <span class="ruby-keyword kw">end</span>

data/rdoc/created.rid

@@ -1 +1 @@
-Wed, 19 May 2010 21:49:00 -0300
+Wed, 19 May 2010 22:05:20 -0300

data/rdoc/files/lib/frequency_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Wed May 19 21:40:37 -0300 2010</td>
+      <td>Wed May 19 22:02:24 -0300 2010</td>
     </tr>
     </table>
   </div>
@@ -68,6 +68,13 @@
 
   <div id="contextContent">
 
+    <div id="description">
+      <p>
+Module <a href="../../classes/Frequency.html">Frequency</a> A small dsl
+written in ruby to work with frequency events (never, sometimes, always..)
+</p>
+
+    </div>
 
 
    </div>

data/rdoc/index.html

@@ -5,13 +5,13 @@
 
 <!--
 
-    frequency 0.0.4
+    frequency 0.0.6
 
 
   -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <title>frequency 0.0.4
+  <title>frequency 0.0.6
 </title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
 </head>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: frequency-dsl
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Tiago Peczenyj