nondeterminism 0.1.0 → 0.2.1

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/{array_test.rb → test_array.rb}

@@ -1,7 +1,6 @@
-require 'test/unit'
 require File.dirname(__FILE__) + '/test_helper'
 
-class ArrayTest < Test::Unit::TestCase
+class TestArray < Test::Unit::TestCase
 
   def setup
     Nondeterminism::integer_generator = Proc.new { |x, y| x }

data/test/test_helper.rb

@@ -1 +1,2 @@
-require 'nondeterminism'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/nondeterminism'

data/test/{integer_generator_test.rb → test_integer_generator.rb}

@@ -1,7 +1,5 @@
-require 'test/unit'
 require File.dirname(__FILE__) + '/test_helper'
 
-
 class NoToProc
 end
 
@@ -23,7 +21,7 @@ class ToProcArityTwoReturnsAverage
   end
 end
 
-class IntegerGeneratorTest < Test::Unit::TestCase
+class TestIntegerGenerator < Test::Unit::TestCase
 
   def test_generator_must_define_to_proc
     assert_raises(ArgumentError) { Nondeterminism::integer_generator = NoToProc.new }
@@ -42,4 +40,13 @@ class IntegerGeneratorTest < Test::Unit::TestCase
     end
   end
   
+  def test_default_generator
+    Nondeterminism::integer_generator = Nondeterminism::DEFAULT_INTEGER_GENERATOR
+    i = 0
+    10000.times do 
+      i += Nondeterminism::random_integer(1, 19)
+    end
+    assert_in_delta 100000, i, 800, 'it may be a fluke; try again'
+  end
+  
 end

data/test/{percent_probability_test.rb → test_percent_probability.rb}

@@ -1,7 +1,6 @@
-require 'test/unit'
 require File.dirname(__FILE__) + '/test_helper'
 
-class PercentProbabilisticTest < Test::Unit::TestCase
+class TestPercentProbabilistic < Test::Unit::TestCase
 
   def setup
     Nondeterminism::probability_generator = Proc.new { 0.5 }

data/test/{probability_event_chain_test.rb → test_probability_event_chain.rb}

@@ -1,8 +1,6 @@
-require 'test/unit'
-require 'nondeterminism/probability/event_chain'
 require File.dirname(__FILE__) + '/test_helper'
 
-class ProbabilityEventChainTest < Test::Unit::TestCase
+class TestProbabilityEventChain < Test::Unit::TestCase
   
   def new_chain(*args)
     Nondeterminism::Probability::EventChain.new(*args)

data/test/{probability_generator_test.rb → test_probability_generator.rb}

@@ -1,4 +1,3 @@
-require 'test/unit'
 require File.dirname(__FILE__) + '/test_helper'
 
 
@@ -18,7 +17,7 @@ class ToProcReturnsFour
   end
 end
 
-class ProbabilityGeneratorTest < Test::Unit::TestCase
+class TestProbabilityGenerator < Test::Unit::TestCase
 
   def test_generator_must_define_to_proc
     assert_raises(ArgumentError) { Nondeterminism::probability_generator = NoToProc.new }

data/test/{range_test.rb → test_range.rb}

@@ -1,7 +1,6 @@
-require 'test/unit'
 require File.dirname(__FILE__) + '/test_helper'
 
-class RangeTest < Test::Unit::TestCase
+class TestRange < Test::Unit::TestCase
 
   def setup
     Nondeterminism::integer_generator = Proc.new { |x, y| y }

data/test/{ratio_probability_test.rb → test_ratio_probability.rb}

@@ -1,7 +1,6 @@
-require 'test/unit'
 require File.dirname(__FILE__) + '/test_helper'
 
-class RatioProbabilisticTest < Test::Unit::TestCase
+class TestRatioProbabilistic < Test::Unit::TestCase
 
   def setup
     Nondeterminism::probability_generator = Proc.new { 0.5 }

data/website/index.html

@@ -0,0 +1,181 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      nondeterminism
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>nondeterminism</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/nondeterminism"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/nondeterminism" class="numbers">0.2.1</a>
+    </div>
+    <h1>&#x2192; &#8216;nondeterminism&#8217;</h1>
+
+
+	<h2>What
+    probabilistic code utilities</h2>
+
+
+	<h2>Installing</h2>
+
+
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">nondeterminism</span></pre></p>
+
+
+	<h2>The basics</h2>
+
+
+	<h2>Demonstration of usage</h2>
+
+
+	<pre class='syntax'>
+	<span class="comment"># accept only half of emails</span>
+	<span class="number">50</span><span class="punct">.</span><span class="ident">percent_of_the_time</span> <span class="keyword">do</span>
+		<span class="ident">email</span><span class="punct">.</span><span class="ident">accept!</span>
+	<span class="keyword">end</span></pre>
+
+
+	<pre class='syntax'>
+	<span class="comment"># accept only half of emails and send nasty</span>
+	<span class="comment"># responses to the rest</span>
+	<span class="number">50</span><span class="punct">.</span><span class="ident">percent_of_the_time</span> <span class="keyword">do</span>
+		<span class="ident">email</span><span class="punct">.</span><span class="ident">accept!</span>
+	<span class="keyword">end</span><span class="punct">.</span><span class="ident">else</span> <span class="keyword">do</span>
+		<span class="ident">email</span><span class="punct">.</span><span class="ident">send_nasty_response!</span>
+	<span class="keyword">end</span></pre>
+
+
+	<pre class='syntax'>
+	<span class="comment"># name should be</span>
+	<span class="comment"># 	'jerome'  30% of the time</span>
+	<span class="comment"># 	'kevin'   40% of the time</span>
+	<span class="comment"># 	'leslie'  the rest of the time</span>
+	<span class="ident">with_probability</span><span class="punct">(</span><span class="number">0.30</span><span class="punct">)</span> <span class="keyword">do</span>
+		<span class="ident">name</span> <span class="punct">=</span> <span class="punct">'</span><span class="string">jerome</span><span class="punct">'</span>
+	<span class="keyword">end</span><span class="punct">.</span><span class="ident">else_with_probability</span><span class="punct">(</span><span class="number">0.40</span><span class="punct">)</span> <span class="keyword">do</span>
+		<span class="ident">name</span> <span class="punct">=</span> <span class="punct">'</span><span class="string">kevin</span><span class="punct">'</span>
+	<span class="keyword">end</span><span class="punct">.</span><span class="ident">else</span>
+		<span class="ident">name</span> <span class="punct">=</span> <span class="punct">'</span><span class="string">leslie</span><span class="punct">'</span>
+	<span class="keyword">end</span></pre>
+
+
+	<pre class='syntax'>
+	<span class="comment"># select a random friend from an Array:</span>
+	<span class="ident">friend</span> <span class="punct">=</span> <span class="ident">person</span><span class="punct">.</span><span class="ident">friends</span><span class="punct">.</span><span class="ident">random_element</span></pre>
+
+
+	<pre class='syntax'>
+	<span class="comment"># call foo between 5 and 8 times (inclusive):</span>
+	<span class="punct">(</span><span class="number">5</span><span class="punct">..</span><span class="number">8</span><span class="punct">).</span><span class="ident">times</span> <span class="keyword">do</span>
+		<span class="ident">foo</span>
+	<span class="keyword">end</span></pre>
+
+
+	<h2>Customization</h2>
+
+
+	<h3>Using a custom random probability generator:</h3>
+
+
+	<p>if you want to change the random-probability-generation mechanism, do
+something like:</p>
+
+
+	<pre class='syntax'>
+	<span class="constant">Nondeterminism</span><span class="punct">::</span><span class="ident">probability_generator</span> <span class="punct">=</span> <span class="constant">Proc</span><span class="punct">.</span><span class="ident">new</span> <span class="punct">{</span> <span class="punct">...</span> <span class="punct">}</span></pre>
+
+
+	<p>or</p>
+
+
+	<pre class='syntax'>
+	<span class="constant">Nondeterminism</span><span class="punct">::</span><span class="ident">probability_generator</span> <span class="punct">=</span> <span class="ident">my_obj</span></pre>
+
+
+	<p>just make sure my_obj responds to #to_proc and the Proc only returns
+numbers in [0.0, 1.0]</p>
+
+
+	<h3>Using a custom random integer generator:</h3>
+
+
+	<p>if you want to change the random-integer-generation mechanism, do
+something like:</p>
+
+
+	<pre class='syntax'>
+	<span class="constant">Nondeterminism</span><span class="punct">::</span><span class="ident">integer_generator</span> <span class="punct">=</span> <span class="constant">Proc</span><span class="punct">.</span><span class="ident">new</span> <span class="punct">{</span> <span class="punct">|</span><span class="ident">low</span><span class="punct">,</span> <span class="ident">high</span><span class="punct">|</span> <span class="punct">...</span> <span class="punct">}</span></pre>
+
+
+	<p>or</p>
+
+
+	<pre class='syntax'>
+	<span class="constant">Nondeterminism</span><span class="punct">::</span><span class="ident">integer_generator</span> <span class="punct">=</span> <span class="constant">Proc</span><span class="punct">.</span><span class="ident">new</span> <span class="punct">{</span> <span class="punct">|</span><span class="ident">low</span><span class="punct">,</span> <span class="ident">high</span><span class="punct">|</span> <span class="punct">...</span> <span class="punct">}</span></pre>
+
+
+	<p>just make sure my_obj responds to #to_proc, the Proc has #arity = 2
+(or &lt; -2), and only returns numbers in [low, high]</p>
+
+
+	<h2>Forum</h2>
+
+
+	<p><a href="http://groups.google.com/group/ruby-nondeterminism">http://groups.google.com/group/ruby-nondeterminism</a></p>
+
+
+	<h2>How to submit patches</h2>
+
+
+	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+
+
+	<p>The trunk repository is svn://rubyforge.org/var/svn/nondeterminism/trunk for anonymous access.</p>
+
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the Apache License.</p>
+
+
+	<h2>Contact</h2>
+
+
+	<p>Comments are welcome. Send an email to <a href="mailto:ruby-nondeterminism@googlegroups.com">Ruby Nondeterminism Google Group</a> email via the <a href="http://groups.google.com/group/ruby-nondeterminism">forum</a></p>
+    <p class="coda">
+      <a href="mailto:james@u-presence.com">James Rosen</a>, 30th January 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>

data/website/index.txt

@@ -0,0 +1,111 @@
+h1. nondeterminism
+
+h1. → 'nondeterminism'
+
+
+h2. What
+	probabilistic code utilities
+
+h2. Installing
+
+<pre syntax="ruby">sudo gem install nondeterminism</pre>
+
+h2. The basics
+
+
+h2. Demonstration of usage
+
+	<pre syntax='ruby'>
+	# accept only half of emails
+	50.percent_of_the_time do
+		email.accept!
+	end</pre>
+	
+	<pre syntax='ruby'>
+	# accept only half of emails and send nasty
+	# responses to the rest
+	50.percent_of_the_time do
+		email.accept!
+	end.else do
+		email.send_nasty_response!
+	end</pre>
+	
+	<pre syntax='ruby'>
+	# name should be
+	# 	'jerome'  30% of the time
+	# 	'kevin'   40% of the time
+	# 	'leslie'  the rest of the time
+	with_probability(0.30) do
+		name = 'jerome'
+	end.else_with_probability(0.40) do
+		name = 'kevin'
+	end.else
+		name = 'leslie'
+	end</pre>
+	
+	<pre syntax='ruby'>
+	# select a random friend from an Array:
+	friend = person.friends.random_element</pre>
+	
+	<pre syntax='ruby'>
+	# call foo between 5 and 8 times (inclusive):
+	(5..8).times do
+		foo
+	end</pre>
+
+
+h2. Customization
+
+h3. Using a custom random probability generator:
+
+if you want to change the random-probability-generation mechanism, do
+something like:
+	
+	<pre syntax='ruby'>
+	Nondeterminism::probability_generator = Proc.new { ... }</pre>
+	
+or
+	
+	<pre syntax='ruby'>
+	Nondeterminism::probability_generator = my_obj</pre>
+	
+just make sure my_obj responds to #to_proc and the Proc only returns
+numbers in [0.0, 1.0]
+
+
+h3. Using a custom random integer generator:
+
+if you want to change the random-integer-generation mechanism, do
+something like:
+	
+	<pre syntax='ruby'>
+	Nondeterminism::integer_generator = Proc.new { |low, high| ... }</pre>
+	
+or
+	
+	<pre syntax='ruby'>
+	Nondeterminism::integer_generator = Proc.new { |low, high| ... }</pre>
+	
+just make sure my_obj responds to #to_proc, the Proc has #arity = 2
+(or < -2), and only returns numbers in [low, high]
+
+
+
+h2. Forum
+
+"http://groups.google.com/group/ruby-nondeterminism":http://groups.google.com/group/ruby-nondeterminism
+
+h2. How to submit patches
+
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+
+The trunk repository is svn://rubyforge.org/var/svn/nondeterminism/trunk for anonymous access.
+
+h2. License
+
+This code is free to use under the terms of the Apache License. 
+
+h2. Contact
+
+Comments are welcome. Send an email to "Ruby Nondeterminism Google Group":mailto:ruby-nondeterminism@googlegroups.com email via the "forum":http://groups.google.com/group/ruby-nondeterminism
+