nondeterminism 0.1.0 → 0.2.1

data/History.txt

@@ -0,0 +1,28 @@
+== 0.1.0 2008-01-30
+
+* 9 major enhancements:
+  * with_probability(x) {...}
+  * with_probability(x) {...}.else {...}
+  * with_probability(x) {...}.else_with_probability(y) {...}
+  * with_probability(x) {...}.else_with_probability(y) {...}...else {...}
+  * x.percent_of_the_time {...}
+  * x.percent_of_the_time {...}.else {...}
+  * [a, b, ...].random_element
+  * [a, b, ...].rand
+  * (x..y).times
+
+== 0.2.0 2008-01-30
+
+* 1 major change:
+  * changed project file structure to match rubygems / newgem standards
+
+== 0.2.1 2008-01-30
+
+* 1 minor fix:
+  * fixed Nondeterminism::DEFAULT_INTEGER_GENERATOR
+
+* 1 minor enhancement:
+  * Nondeterminism::DEFAULT_INTEGER_GENERATOR now relies on Nondeterminism::DEFAULT_PROBABILITY_GENERATOR
+
+* 1 minor change:
+  * moved all documentation from README.txt to website/index.txt (or .html)

data/License.txt

@@ -0,0 +1,17 @@
+Copyright 2008 James Rosen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+
+

data/Manifest.txt

@@ -0,0 +1,37 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/nondeterminism.rb
+lib/nondeterminism/array.rb
+lib/nondeterminism/probability/event.rb
+lib/nondeterminism/probability/event_chain.rb
+lib/nondeterminism/probability/helper_methods.rb
+lib/nondeterminism/probability/kernel.rb
+lib/nondeterminism/probability/numeric.rb
+lib/nondeterminism/range.rb
+lib/nondeterminism/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_array.rb
+test/test_helper.rb
+test/test_integer_generator.rb
+test/test_percent_probability.rb
+test/test_probability_event_chain.rb
+test/test_probability_generator.rb
+test/test_range.rb
+test/test_ratio_probability.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1 @@
+see website/index.html

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'nondeterminism/version'
+
+AUTHOR = 'James Rosen'  # can also be an array of Authors
+EMAIL = "james @nospam@ u-presence.com"
+DESCRIPTION = "probabilistic blocks, random elements"
+GEM_NAME = 'nondeterminism'
+RUBYFORGE_PROJECT = 'nondeterminism'
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "gcnovus"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Nondeterminism::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'nondeterminism documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'nondeterminism'

data/lib/nondeterminism.rb

@@ -1,3 +1,5 @@
+$:.unshift File.dirname(__FILE__)
+
 require 'nondeterminism/probability/kernel'
 require 'nondeterminism/probability/numeric'
 require 'nondeterminism/array'
@@ -5,48 +7,54 @@ require 'nondeterminism/range'
 
 module Nondeterminism
   
+  unless self.const_defined?(:DEFAULT_PROBABILITY_GENERATOR)
     DEFAULT_PROBABILITY_GENERATOR = Proc.new { Kernel.rand }
-    
-    @@probability_generator = DEFAULT_PROBABILITY_GENERATOR
-    
+  
+    @@probability_generator = Nondeterminism::DEFAULT_PROBABILITY_GENERATOR
+  
     def self.probability_generator
       @@probability_generator
     end
-  
+
     def self.probability_generator=(generator)
       raise ArgumentError.new('generator must respond to #to_proc') unless generator.respond_to?(:to_proc)
       @@probability_generator = generator.to_proc
     end
-  
+
     def self.random_probability
       result = probability_generator.call
       raise "generator (#{probability_generator}) generated invalid probability: #{result}" unless result >= 0.0 && result <= 1.0
       result
     end
-    
-    
-    DEFAULT_INTEGER_GENERATOR = Proc.new { |low, high| Kernel.rand * high + low }
-    
-    @@integer_generator = DEFAULT_PROBABILITY_GENERATOR
-    
+  end
+  
+  
+  
+  
+  unless self.const_defined?(:DEFAULT_INTEGER_GENERATOR)
+    DEFAULT_INTEGER_GENERATOR = Proc.new { |low, high| Nondeterminism.random_probability * (high + 1 - low) + low }
+  
+    @@integer_generator = Nondeterminism::DEFAULT_INTEGER_GENERATOR
+  
     def self.integer_generator
       @@integer_generator
     end
-  
+
     def self.integer_generator=(generator)
       raise ArgumentError.new('generator must respond to #to_proc') unless generator.respond_to?(:to_proc)
       proc = generator.to_proc
       raise ArgumentError.new('generator must have arity == 2 or < -2') unless proc.arity == 2 || proc.arity < -2
       @@integer_generator = proc
     end
-  
+
     def self.random_integer(range)
       self.random_integer(range.first, range.last)
     end
-    
+  
     def self.random_integer(low, high)
       result = integer_generator.call(low, high).to_i
       raise "generator (#{integer_generator}) generated invalid integer: #{result}" unless result >= low && result <= high
       result
     end
+  end
 end

data/lib/nondeterminism/array.rb

@@ -0,0 +1,10 @@
+Array.class_eval do
+  
+  def rand
+    return nil if empty?
+    self[Nondeterminism::random_integer(0, self.size - 1)]
+  end
+  
+  alias_method :random_element, :rand
+  
+end

data/lib/nondeterminism/probability/event.rb

@@ -0,0 +1,29 @@
+require 'nondeterminism/probability/helper_methods'
+require 'nondeterminism/probability/event_chain'
+
+module Nondeterminism
+  module Probability
+    class Event
+        
+      include Nondeterminism::Probability::HelperMethods
+      
+      attr_reader :probability
+      
+      def initialize(probability, &block)
+        validate_probability(:probability, probability)
+        raise ArgumentError.new('no block given') unless block_given?
+        @probability = probability
+        @block = block
+      end
+      
+      def call
+        random = random_probability
+        if random <= probability
+          @block.call
+        end
+        return Nondeterminism::Probability::EventChain.new(probability, random)
+      end
+    
+    end
+  end
+end

data/lib/nondeterminism/probability/event_chain.rb

@@ -0,0 +1,42 @@
+require 'nondeterminism/probability/helper_methods'
+
+module Nondeterminism
+  module Probability
+    class EventChain
+        
+      include Nondeterminism::Probability::HelperMethods
+      
+      attr_reader :total_probability, :random_value
+      
+      # a new chain, with random value +random+
+      def initialize(total_probability = 0.0, random_value = nil)
+        @total_probability = total_probability
+        @random_value = random_value || random_probability
+      end
+      
+      def else_with_probability(probability, &block)
+        raise ArgumentError.new('no block given') unless block_given?
+        validate_probability(:probability, probability)
+        new_total = total_probability + probability
+        raise ArgumentError.new("total probability (#{new_total}) cannot exceed 1.0") if new_total > 1.0
+        
+        if !completed? && random_value <= new_total
+          yield block
+        end
+        @total_probability = new_total
+        return self
+      end
+      
+      def else(&block)
+        raise ArgumentError.new('no block given') unless block_given?
+        yield block unless completed?
+        return nil
+      end
+      
+      def completed?
+        random_value <= total_probability
+      end
+    
+    end
+  end
+end

data/lib/nondeterminism/probability/helper_methods.rb

@@ -0,0 +1,17 @@
+require 'nondeterminism'
+
+module Nondeterminism
+  module Probability
+    module HelperMethods
+      
+      def validate_probability(sym, value)
+        raise ArgumentError.new("#{sym} (#{value}) must be between 0.0 and 1.0 (inclusive)") unless value >= 0.0 && value <= 1.0
+      end
+      
+      def random_probability
+        Nondeterminism::random_probability
+      end
+      
+    end
+  end
+end

data/lib/nondeterminism/probability/kernel.rb

@@ -0,0 +1,10 @@
+require 'nondeterminism/probability/event'
+
+Kernel.class_eval do
+  def with_probability(prob, &block)
+    raise(ArgumentError, 'probability must be between 0.0 and 1.0 (inclusive)') unless prob >= 0.0 && prob <= 1.0
+    return Nondeterminism::Probability::Event.new(prob, &block).call
+  end
+  
+  alias_method :with_likelihood, :with_probability
+end

data/lib/nondeterminism/probability/numeric.rb

@@ -0,0 +1,8 @@
+Numeric.class_eval do
+  
+  def percent_of_the_time(&block)
+    raise(ArgumentError, 'percent must be between 0 and 100 (inclusive)') unless self >= 0.0 && self <= 100.0
+    with_probability(self / 100.0, &block)
+  end
+  
+end

data/lib/nondeterminism/range.rb

@@ -0,0 +1,10 @@
+Range.class_eval do
+  
+  # ex: (3..6).times do
+  def times(&block)
+    raise "#{self} contains negative indices" if self.first < 0 || self.last < 0
+    raise ArgumentError.new('no block given') unless block_given?
+    self.to_a.rand.times(&block)
+  end
+  
+end

data/lib/nondeterminism/version.rb

@@ -0,0 +1,9 @@
+module Nondeterminism #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 2
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)