rubyonacid 0.2.0 → 0.3.0

data/README.textile

@@ -75,6 +75,10 @@ Start by looking at the code for the bundled factories in the lib/rubyonacid/fac
 
 h1. Resources
 
+API documentation is hosted on RDoc.info.
+
+"RDoc documentation":http://rdoc.info/projects/jaymcgavren/rubyonacid
+
 The project page on GitHub lets you browse the latest code, or clone or fork the source repo for yourself.
 
 "GitHub project":http://www.github.com/jaymcgavren/rubyonacid

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/examples/ascii.rb

@@ -1,3 +1,5 @@
+require 'rubyonacid/factories/all'
+
 #This method takes any Factory and uses it to determine the length of lines to print.
 def make_lines(factory)
   #Show what factory we're working with.
@@ -11,33 +13,29 @@ def make_lines(factory)
 end
 
 #Random factories generate a random number between 0 and 1.
-require 'rubyonacid/factories/random'
 make_lines RubyOnAcid::RandomFactory.new
 
+#Random walk factories increase or decrease the prior return value within a given amount.
+make_lines RubyOnAcid::RandomWalkFactory.new(0.1)
+
 #Loop factories loop from 0 to 1 (or 1 to 0 if the increment value is negative).
-require 'rubyonacid/factories/loop'
 make_lines RubyOnAcid::LoopFactory.new(0.2)
 make_lines RubyOnAcid::LoopFactory.new(-0.2)
 
 #Constant factories always return the same value,
-require 'rubyonacid/factories/constant'
 make_lines RubyOnAcid::ConstantFactory.new(0.5)
 
 #This flash factory returns 0 twice, then 1 twice, then 0 twice, etc.
-require 'rubyonacid/factories/flash'
 make_lines RubyOnAcid::FlashFactory.new(2)
 
 #Sine factories produce a "wave" pattern.
-require 'rubyonacid/factories/sine'
 make_lines RubyOnAcid::SineFactory.new(0.3)
 
 #A RepeatFactory wraps another factory, queries it, and repeats the same value a certain number of times.
-require 'rubyonacid/factories/repeat'
 factory_to_repeat = RubyOnAcid::LoopFactory.new(0.3)
 make_lines RubyOnAcid::RepeatFactory.new(factory_to_repeat, 2)
 
 #A CombinationFactory combines the values of two or more other factories.
-require 'rubyonacid/factories/combination'
 factories_to_combine = [
   RubyOnAcid::SineFactory.new(0.1),
   RubyOnAcid::SineFactory.new(-0.2)

data/examples/midi.rb

@@ -1,55 +1,27 @@
 require 'rubygems'
-require 'rubyonacid/factories/meta'
-require 'rubyonacid/factories/constant'
-require 'rubyonacid/factories/flash'
-require 'rubyonacid/factories/loop'
-require 'rubyonacid/factories/random'
-require 'rubyonacid/factories/repeat'
-require 'rubyonacid/factories/sine'
-require 'rubyonacid/factories/skip'
+require 'rubyonacid/factories/example'
 
-random_factory = RubyOnAcid::RandomFactory.new
-
-#The MetaFactory assigns factories to requested value types.
-factory = RubyOnAcid::MetaFactory.new
-#Loop factories loop from 0.0 to 1.0 (or 1.0 to 0.0 if the increment value is negative).
-factory.factory_pool << RubyOnAcid::LoopFactory.new(0.01)
-factory.factory_pool << RubyOnAcid::LoopFactory.new(-0.01)
-factory.factory_pool << RubyOnAcid::LoopFactory.new(0.001)
-factory.factory_pool << RubyOnAcid::LoopFactory.new(-0.001)
-#Constant factories always return the same value,
-factory.factory_pool << RubyOnAcid::ConstantFactory.new(rand)
-factory.factory_pool << RubyOnAcid::ConstantFactory.new(rand)
-factory.factory_pool << RubyOnAcid::FlashFactory.new(rand(100))
-#Sine factories produce a "wave" pattern.
-factory.factory_pool << RubyOnAcid::SineFactory.new(0.1)
-factory.factory_pool << RubyOnAcid::SineFactory.new(-0.1)
-factory.factory_pool << RubyOnAcid::SineFactory.new(0.01)
-factory.factory_pool << RubyOnAcid::SineFactory.new(-0.01)
-factory.factory_pool << RubyOnAcid::RepeatFactory.new(
-  RubyOnAcid::LoopFactory.new(random_factory.within(:increment, -0.1, 0.1)),
-  random_factory.within(:interval, 2, 100)
-)
-factory.factory_pool << RubyOnAcid::RepeatFactory.new(
-  RubyOnAcid::SineFactory.new(random_factory.within(:increment, -0.1, 0.1)),
-  random_factory.within(:interval, 2, 100)
-)
-
-#A skip factory, in charge of randomly resetting the meta factory.
+#This factory chooses notes, play durations, etc.
+factory = RubyOnAcid::ExampleFactory.new
+    
+#This factory randomly resets the meta factory.
 @resetter = RubyOnAcid::SkipFactory.new(0.999)
 
-
-require 'midiator'
+begin
+  require 'midiator'
+rescue LoadError
+  raise "It appears that MIDIator is not installed. 'sudo gem install midiator' to install it."
+end
 
 midi = MIDIator::Interface.new
 midi.autodetect_driver
 
 loop do
   midi.play(
-    factory.within(:note, 10, 127).to_i,
-    factory.within(:duration, 0, 0.1),
-    factory.within(:channel, 0, 10).to_i,
-    factory.within(:velocity, 0, 127)
+    factory.get(:note, :min => 10, :max => 127).to_i,
+    factory.get(:duration, :max => 0.1),
+    factory.get(:channel, :max => 10).to_i,
+    factory.get(:velocity, :max => 127)
   )
   factory.reset_assignments if @resetter.boolean(:reset)
 end

data/examples/raw_audio.rb

@@ -1,51 +1,21 @@
-require 'rubygems'
-require 'rubyonacid/factories/meta'
-require 'rubyonacid/factories/constant'
-require 'rubyonacid/factories/flash'
-require 'rubyonacid/factories/loop'
-require 'rubyonacid/factories/random'
-require 'rubyonacid/factories/repeat'
-require 'rubyonacid/factories/sine'
-require 'rubyonacid/factories/skip'
-
-def generate_factories
-
-  random_factory = RubyOnAcid::RandomFactory.new
+puts "This demo writes raw 8-bit PCM data to a file.  Ctrl-C to stop.  Import the file to Audacity (or a similar audio editing program) to hear the results."
 
-  factory_pool = []
-
-  #Loop factories loop from 0.0 to 1.0 (or 1.0 to 0.0 if the increment value is negative).
-  factory_pool << RubyOnAcid::LoopFactory.new(random_factory.within(:increment, -0.01, 0.01))
-  #Constant factories always return the same value,
-  factory_pool << RubyOnAcid::ConstantFactory.new(rand)
-  factory_pool << RubyOnAcid::ConstantFactory.new(rand)
-  factory_pool << RubyOnAcid::FlashFactory.new(rand(100))
-  #Sine factories produce a "wave" pattern.
-  factory_pool << RubyOnAcid::SineFactory.new(random_factory.within(:increment, -0.01, 0.01))
-  factory_pool << RubyOnAcid::RepeatFactory.new(
-    RubyOnAcid::LoopFactory.new(random_factory.within(:increment, -0.1, 0.1)),
-    random_factory.within(:interval, 2, 100)
-  )
-  factory_pool << RubyOnAcid::RepeatFactory.new(
-    RubyOnAcid::SineFactory.new(random_factory.within(:increment, -0.1, 0.1)),
-    random_factory.within(:interval, 2, 100)
-  )
-  factory_pool
-end
+require 'rubygems'
+require 'rubyonacid/factories/example'
 
-#A skip factory, in charge of randomly resetting the meta factory.
-@resetter = RubyOnAcid::SkipFactory.new(0.99995)
+#This factory chooses notes, play durations, etc.
+factory = RubyOnAcid::ExampleFactory.new
+    
+#This factory randomly resets the meta factory.
+@resetter = RubyOnAcid::SkipFactory.new(0.999)
 
-factory = RubyOnAcid::MetaFactory.new
-factory.factory_pool = generate_factories
 File.open("raw_audio.dat", "w") do |file|
   loop do
-    channel_count = factory.within(:chanel_count, 0, 3).to_i
+    channel_count = factory.get(:channel_count, :max => 3).to_i
     channel_count.times do |i|
-      file.putc factory.within(i, 0, 255).to_i
+      file.putc factory.get(i, :max => 255).to_i
     end
     if @resetter.boolean(:reset)
-      factory.factory_pool = generate_factories
       factory.reset_assignments
     end
   end

data/examples/rinda_agent.rb

@@ -1,16 +1,10 @@
 require 'rubygems'
-require 'wx'
-require 'rubyonacid/factories/meta'
-require 'rubyonacid/factories/constant'
-require 'rubyonacid/factories/flash'
-require 'rubyonacid/factories/loop'
-require 'rubyonacid/factories/random'
-require 'rubyonacid/factories/repeat'
-require 'rubyonacid/factories/rinda'
-require 'rubyonacid/factories/sine'
-require 'rubyonacid/factories/skip'
-
-
+begin
+  require 'wx'
+rescue LoadError
+  raise "It appears that wxruby is not installed. 'sudo gem install wxruby' to install it."
+end
+require 'rubyonacid/factories/example'
 
 class MyApp < Wx::App
 
@@ -19,18 +13,16 @@ class MyApp < Wx::App
 
   def on_init
     
-    @f = RubyOnAcid::RindaFactory.new(ARGV[0])
-    @f.default_factory = create_factory
+    @f = RubyOnAcid::RindaFactory.new(ARGV[0] || "druby://127.0.0.1:7632")
+    @f.default_factory = RubyOnAcid::ExampleFactory.new
     @f.start_service
     
     #A skip factory, in charge of randomly resetting the meta factory.
     @resetter = RubyOnAcid::SkipFactory.new(0.999)
     
-    #Containing frame.
+    #Set up window.
     frame = Wx::Frame.new(nil, :size => [WIDTH, HEIGHT])
     frame.show
- 
-    #Displays drawing.
     window = Wx::Window.new(frame, :size => [WIDTH, HEIGHT])
  
     #Animate periodically.
@@ -40,38 +32,7 @@ class MyApp < Wx::App
       @f.default_factory.reset_assignments if @resetter.boolean(:reset)
     end
     t.start(33)
- 
-  end
- 
-  def create_factory
-    random_factory = RubyOnAcid::RandomFactory.new
-    
-    #The MetaFactory assigns factories to requested value types.
-    meta_factory = RubyOnAcid::MetaFactory.new
-    #Loop factories loop from 0.0 to 1.0 (or 1.0 to 0.0 if the increment value is negative).
-    meta_factory.factory_pool << RubyOnAcid::LoopFactory.new(0.01)
-    meta_factory.factory_pool << RubyOnAcid::LoopFactory.new(-0.01)
-    meta_factory.factory_pool << RubyOnAcid::LoopFactory.new(0.001)
-    meta_factory.factory_pool << RubyOnAcid::LoopFactory.new(-0.001)
-    #Constant factories always return the same value,
-    meta_factory.factory_pool << RubyOnAcid::ConstantFactory.new(rand)
-    meta_factory.factory_pool << RubyOnAcid::ConstantFactory.new(rand)
-    meta_factory.factory_pool << RubyOnAcid::FlashFactory.new(rand(100))
-    #Sine factories produce a "wave" pattern.
-    meta_factory.factory_pool << RubyOnAcid::SineFactory.new(0.1)
-    meta_factory.factory_pool << RubyOnAcid::SineFactory.new(-0.1)
-    meta_factory.factory_pool << RubyOnAcid::SineFactory.new(0.01)
-    meta_factory.factory_pool << RubyOnAcid::SineFactory.new(-0.01)
-    meta_factory.factory_pool << RubyOnAcid::RepeatFactory.new(
-      RubyOnAcid::LoopFactory.new(random_factory.within(:increment, -0.1, 0.1)),
-      random_factory.within(:interval, 2, 100)
-    )
-    meta_factory.factory_pool << RubyOnAcid::RepeatFactory.new(
-      RubyOnAcid::SineFactory.new(random_factory.within(:increment, -0.1, 0.1)),
-      random_factory.within(:interval, 2, 100)
-    )
-    
-    meta_factory
+
   end
 
   def render(surface)
@@ -81,7 +42,7 @@ class MyApp < Wx::App
       @f.get(:blue, :max => 255).to_i,
       @f.get(:alpha, :min => 50, :max => 200).to_i
     )
-    surface.pen = Wx::Pen.new(color, @f.within(:width, 1, 5).to_i)
+    surface.pen = Wx::Pen.new(color, @f.get(:width, :min => 1, :max => 5).to_i)
     surface.brush = Wx::Brush.new(color, Wx::SOLID)
     case @f.choose(:shape,
       :arc,

data/examples/svg.rb

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'rubyonacid/factories/example'
+
+def svg(factory)
+  return <<-EOD.strip
+    <?xml version="1.0" standalone="no"?>
+    <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+    <svg width="100%" height="100%" xmlns="http://www.w3.org/2000/svg" version="1.1">
+      #{shapes(factory).join("\n")}
+    </svg>
+  EOD
+end
+
+def shapes(factory)
+  shapes = []
+  1000.times do
+    shapes << case factory.choose(:shape, :rectangle, :ellipse, :line)
+    when :rectangle : rectangle(factory)
+    when :ellipse : ellipse(factory)
+    when :line : line(factory)
+    end
+  end
+  shapes
+end
+
+def rectangle(factory)
+  return <<-EOD
+    <rect
+      x='#{factory.get(:x, :max => 100)}%'
+      y='#{factory.get(:y, :max => 100)}%'
+      width='#{factory.get(:width, :max => 300)}'
+      height='#{factory.get(:height, :max => 300)}'
+      style='#{style(factory)}'
+      transform='#{transform(factory)}'
+    />
+  EOD
+end
+
+def ellipse(factory)
+  return <<-EOD
+    <ellipse
+      cx='#{factory.get(:x, :max => 100)}%'
+      cy='#{factory.get(:y, :max => 100)}%'
+      rx='#{factory.get(:width, :max => 300)}'
+      ry='#{factory.get(:height, :max => 300)}'
+      style='#{style(factory)}'
+      transform='#{transform(factory)}'
+    />
+  EOD
+end
+
+def line(factory)
+  return <<-EOD
+    <line
+      x1='#{factory.get(:x, :max => 100)}%'
+      y1='#{factory.get(:y, :max => 100)}%'
+      x2='#{factory.get(:x2, :max => 100)}%'
+      y2='#{factory.get(:y2, :max => 100)}%'
+      stroke='#{color(factory)}'
+      stroke-width='#{factory.get(:width, :max => 20)}'
+      stroke-opacity='#{factory.get(:opacity)}'
+    />
+  EOD
+end
+
+def style(factory)
+  "fill:#{color(factory)};fill-opacity:#{factory.get(:opacity)};"
+end
+
+def color(factory)
+  "rgb(#{factory.get(:red, :max => 255).to_i},#{factory.get(:green, :max => 255).to_i},#{factory.get(:blue, :max => 255).to_i})"
+end
+
+def transform(factory)
+  return <<-EOD
+    rotate(#{factory.get(:rotation, :max => 360)})
+    translate(#{factory.get(:x_translate, :max => 100)}, #{factory.get(:y_translate, :max => 100)})
+    scale(#{factory.get(:scale, :max => 2)})
+    skewX(#{factory.get(:x_skew, :max => 360)})
+    skewY(#{factory.get(:y_skew, :max => 360)})
+  EOD
+end
+
+factory = RubyOnAcid::ExampleFactory.new
+puts svg(factory)

data/examples/wxruby.rb

@@ -1,15 +1,10 @@
 require 'rubygems'
-require 'wx'
-require 'rubyonacid/factories/meta'
-require 'rubyonacid/factories/combination'
-require 'rubyonacid/factories/constant'
-require 'rubyonacid/factories/flash'
-require 'rubyonacid/factories/loop'
-require 'rubyonacid/factories/random'
-require 'rubyonacid/factories/repeat'
-require 'rubyonacid/factories/sine'
-require 'rubyonacid/factories/skip'
-
+begin
+  require 'wx'
+rescue LoadError
+  raise "It appears that wxruby is not installed. 'sudo gem install wxruby' to install it."
+end
+require 'rubyonacid/factories/example'
 
 
 class MyApp < Wx::App
@@ -19,16 +14,15 @@ class MyApp < Wx::App
 
   def on_init
     
-    @f = create_factory
+    #This factory will be in charge of all drawing coordinates, colors, etc.
+    @f = RubyOnAcid::ExampleFactory.new
         
     #A skip factory, in charge of randomly resetting the meta factory.
     @resetter = RubyOnAcid::SkipFactory.new(0.999)
     
-    #Containing frame.
+    #Set up window.
     frame = Wx::Frame.new(nil, :size => [WIDTH, HEIGHT])
     frame.show
- 
-    #Displays drawing.
     window = Wx::Window.new(frame, :size => [WIDTH, HEIGHT])
  
     #Animate periodically.
@@ -41,51 +35,7 @@ class MyApp < Wx::App
  
   end
   
-  
-  def create_factory
-    
-    random_factory = RubyOnAcid::RandomFactory.new
-    
-    source_factories = []
-    #Loop factories loop from 0.0 to 1.0 (or 1.0 to 0.0 if the increment value is negative).
-    source_factories << RubyOnAcid::LoopFactory.new(0.01)
-    source_factories << RubyOnAcid::LoopFactory.new(-0.01)
-    source_factories << RubyOnAcid::LoopFactory.new(0.001)
-    source_factories << RubyOnAcid::LoopFactory.new(-0.001)
-    #Constant factories always return the same value,
-    source_factories << RubyOnAcid::ConstantFactory.new(rand)
-    source_factories << RubyOnAcid::ConstantFactory.new(rand)
-    source_factories << RubyOnAcid::FlashFactory.new(rand(100))
-    #Sine factories produce a "wave" pattern.
-    source_factories << RubyOnAcid::SineFactory.new(0.1)
-    source_factories << RubyOnAcid::SineFactory.new(-0.1)
-    source_factories << RubyOnAcid::SineFactory.new(0.01)
-    source_factories << RubyOnAcid::SineFactory.new(-0.01)
-    #A RepeatFactory wraps another factory, queries it, and repeats the same value a certain number of times.
-    source_factories << RubyOnAcid::RepeatFactory.new(
-      RubyOnAcid::LoopFactory.new(random_factory.within(:increment, -0.1, 0.1)),
-      random_factory.get(:interval, :min => 2, :max => 100)
-    )
-    source_factories << RubyOnAcid::RepeatFactory.new(
-      RubyOnAcid::SineFactory.new(random_factory.within(:increment, -0.1, 0.1)),
-      random_factory.get(:interval, :min => 2, :max => 100)
-    )
-    #A CombinationFactory combines the values of two or more other factories.
-    combination_factory = RubyOnAcid::CombinationFactory.new
-    2.times do
-      combination_factory.source_factories << source_factories[rand(source_factories.length)]
-    end
-    source_factories << combination_factory
-    
-    #The MetaFactory pulls requested value types from the other factories.
-    meta_factory = RubyOnAcid::MetaFactory.new
-    meta_factory.factory_pool = source_factories
-    
-    meta_factory
-    
-  end
- 
- 
+  #Choose a shape and color and draw it to the given surface.
   def render(surface)
     color = Wx::Colour.new(
       @f.get(:red, :max => 255).to_i,
@@ -93,7 +43,7 @@ class MyApp < Wx::App
       @f.get(:blue, :max => 255).to_i,
       @f.get(:alpha, :min => 50, :max => 200).to_i
     )
-    surface.pen = Wx::Pen.new(color, @f.within(:width, 1, 5).to_i)
+    surface.pen = Wx::Pen.new(color, @f.get(:width, :min => 1, :max => 5).to_i)
     surface.brush = Wx::Brush.new(color, Wx::SOLID)
     case @f.choose(:shape,
       :arc,
@@ -139,7 +89,7 @@ class MyApp < Wx::App
     end
   end
   
-  
+  #Create an array of points for drawing complex shapes.
   def make_point_array
     points = []
     3.times do |i|

data/lib/rubyonacid/factories/all.rb

@@ -0,0 +1,13 @@
+require 'rubyonacid/factories/combination'
+require 'rubyonacid/factories/constant'
+require 'rubyonacid/factories/flash'
+require 'rubyonacid/factories/increment'
+require 'rubyonacid/factories/input'
+require 'rubyonacid/factories/loop'
+require 'rubyonacid/factories/meta'
+require 'rubyonacid/factories/random'
+require 'rubyonacid/factories/random_walk'
+require 'rubyonacid/factories/repeat'
+require 'rubyonacid/factories/rinda'
+require 'rubyonacid/factories/sine'
+require 'rubyonacid/factories/skip'

data/lib/rubyonacid/factories/combination.rb

@@ -4,15 +4,24 @@ module RubyOnAcid
 
 class CombinationFactory < Factory
   
+  #Causes get_unit value of all source_factories to be added together.
   ADD = :add
+  #Takes the get_unit value of the first of the source_factories and subtracts the get_unit value of all subsequent ones.
   SUBTRACT = :subtract
+  #Causes get_unit value of all source_factories to be multiplied.
   MULTIPLY = :multiply
+  #Takes the get_unit value of the first of the source_factories and divides the result by the get_unit value of all subsequent ones.
   DIVIDE = :divide
+  #Causes get_unit values above 1 to be truncated at 1 and values below 0 to be truncated at 0.
   CONSTRAIN = :constrain
+  #Causes get_unit values above 1 to wrap to 0 and values below 0 to wrap to 1.
   WRAP = :wrap
   
+  #An array of factories to be queried by get_unit. 
   attr_accessor :source_factories
+  #The operation get_unit will perform.
   attr_accessor :operation
+  #The method get_unit will use to constrain values between 0 and 1.
   attr_accessor :constrain_mode
   
   def initialize(options = {})
@@ -22,6 +31,8 @@ class CombinationFactory < Factory
     @constrain_mode = options[:constrain_mode] || WRAP
   end
   
+  #Queries all source_factories with given key and combines their return values with the set operation.
+  #Values will be constrained between 0 and 1 with the set constrain_mode.
   def get_unit(key)
     combined_value = combine(key)
     constrain(combined_value)

data/lib/rubyonacid/factories/constant.rb

@@ -2,8 +2,10 @@ require 'rubyonacid/factory'
 
 module RubyOnAcid
 
+#A factory that returns a preset value for all keys.
 class ConstantFactory < Factory
   
+  #A value between 0 and 1 that get_unit will return.
   attr_accessor :value
   def value=(value)
     raise "assigned #{value} to value, must be between -1 and 1" if value < -1 or value > 1
@@ -15,7 +17,7 @@ class ConstantFactory < Factory
     @value = value
   end
   
-  #Increment counter for key, looping it around to opposite side if it exits boundary.
+  #Returns assigned value.
   def get_unit(key)
     @value
   end

data/lib/rubyonacid/factories/example.rb

@@ -0,0 +1,63 @@
+require 'rubyonacid/factories/all'
+
+module RubyOnAcid
+
+#A preconfigured factory with all the bells and whistles.
+#Use this if you want to get up and running quickly and don't need to tweak the settings.
+class ExampleFactory < MetaFactory
+
+  
+  def initialize
+    super
+    @factory_pool = create_factories
+  end
+
+
+  private
+
+  
+    def create_factories
+      
+      random_factory = RubyOnAcid::RandomFactory.new
+
+      source_factories = []
+      
+      5.times do
+        factory = RubyOnAcid::LoopFactory.new
+        factory.interval = random_factory.get(:increment, :min => -0.1, :max => 0.1)
+        source_factories << factory
+      end
+      3.times do
+        factory = RubyOnAcid::ConstantFactory.new
+        factory.value = random_factory.get(:constant)
+        source_factories << factory
+      end
+      source_factories << RubyOnAcid::FlashFactory.new(
+        random_factory.get(:interval, :max => 100)
+      )
+      4.times do
+        factory = RubyOnAcid::SineFactory.new
+        factory.interval = random_factory.get(:increment, :min => -0.1, :max => 0.1)
+        source_factories << factory
+      end
+      2.times do
+        factory = RubyOnAcid::RepeatFactory.new
+        factory.repeat_count = random_factory.get(:interval, :min => 2, :max => 100)
+        factory.source_factory = source_factories[rand(source_factories.length)]
+        source_factories << factory
+      end
+      combination_factory = RubyOnAcid::CombinationFactory.new
+      2.times do
+        combination_factory.source_factories << source_factories[rand(source_factories.length)]
+      end
+      source_factories << combination_factory
+      source_factories << RubyOnAcid::RandomWalkFactory.new(0.1)
+      
+      source_factories
+
+    end
+
+
+end
+
+end

data/lib/rubyonacid/factories/flash.rb

@@ -2,6 +2,7 @@ require 'rubyonacid/factory'
 
 module RubyOnAcid
 
+#Returns 0.0 for a given number of queries, then 1.0 for the same number of queries, then goes back to 0.0 and repeats.
 class FlashFactory < Factory
   
   attr_accessor :interval

data/lib/rubyonacid/factories/increment.rb

@@ -2,6 +2,7 @@ require 'rubyonacid/factory'
 
 module RubyOnAcid
 
+#Increments from the minimum value, stopping at the maximum, or decrements from the maximum value, stopping at the minimum.
 class IncrementFactory < Factory
 
   #The amount to increment counters by.

data/lib/rubyonacid/factories/input.rb

@@ -0,0 +1,67 @@
+require 'rubyonacid/factory'
+
+module RubyOnAcid
+
+class InputFactory < Factory
+
+  attr_accessor :default_factory
+  
+  def initialize
+    super
+    @input_values = {}
+    @key_assignments = {}
+    @largest_seen_values = {}
+    @smallest_seen_values = {}
+  end
+  
+  def get_unit(key)
+    current_key = assigned_key(key)
+    if @input_values[current_key] and @input_values[current_key].length > 0
+      return scale(current_key, @input_values[current_key].shift) || default_value(key)
+    else
+      return default_value(key)
+    end
+  end
+  
+  def default_value(key)
+    @default_factory ? @default_factory.get_unit(key) : 0.0
+  end
+  
+  def put(key, value)
+    value = value.to_f
+    @input_values[key] ||= []
+    @input_values[key] << value
+    @smallest_seen_values[key] ||= 0.0
+    if @largest_seen_values[key] == nil or @smallest_seen_values[key] > @largest_seen_values[key]
+      @largest_seen_values[key] = @smallest_seen_values[key] + 1.0
+    end
+    @smallest_seen_values[key] = value if value < @smallest_seen_values[key]
+    @largest_seen_values[key] = value if value > @largest_seen_values[key]
+  end
+  
+  def clear_input_values
+    @input_values = {}
+  end
+  
+  def clear_assigned_keys
+    @assigned_keys = {}
+  end
+  
+  private
+  
+    def assigned_key(key)
+      return @key_assignments[key] if @key_assignments[key]
+      key_pool = @input_values.keys - @key_assignments.values
+      @key_assignments[key] = key_pool[rand(key_pool.length)]
+      @key_assignments[key]
+    end
+    
+    #Scales a value between the largest and smallest values seen for a key.
+    #Returns a value in the range 0 to 1.
+    def scale(key, value)
+      (value - @smallest_seen_values[key]) / (@largest_seen_values[key] - @smallest_seen_values[key])
+    end
+  
+end
+
+end

data/lib/rubyonacid/factories/loop.rb

@@ -2,9 +2,10 @@ require 'rubyonacid/factory'
 
 module RubyOnAcid
 
+#Loops from the minimum value to the maximum and around again.
 class LoopFactory < Factory
   
-  #The amount to increment counters by.
+  #An amount between 0 and 1 to increment counters by.
   attr_accessor :interval
   def interval=(value)
     raise "assigned #{value} to interval, must be between -1 and 1" if value < -1 or value > 1

data/lib/rubyonacid/factories/meta.rb

@@ -2,10 +2,11 @@ require 'rubyonacid/factory'
 
 module RubyOnAcid
 
+#The MetaFactory assigns factories to requested value types.
 class MetaFactory < Factory
   
+  #An array of Factory objects to assign to keys.
   attr_accessor :factory_pool
-  attr_accessor :assigned_factories
   
   def initialize(factory_pool = [])
     super
@@ -13,15 +14,19 @@ class MetaFactory < Factory
     @assigned_factories = {}
   end
   
+  #Assign a factory for subsequent get_unit requests for the given key.
   def assign_factory(key, factory)
     @assigned_factories[key] = factory
   end
   
+  #Returns the value of get_unit from the Factory assigned to the given key.
+  #When a key is needed that a Factory is not already assigned to, one will be assigned at random from the factory_pool.
   def get_unit(key)
     @assigned_factories[key] ||= @factory_pool[rand(@factory_pool.length)]
     @assigned_factories[key].get_unit(key)
   end
   
+  #Clear all factory assignments.
   def reset_assignments
     @assigned_factories.clear
   end

data/lib/rubyonacid/factories/random.rb

@@ -2,6 +2,7 @@ require 'rubyonacid/factory'
 
 module RubyOnAcid
 
+#Returns random numbers between the minimum and the maximum.
 class RandomFactory < Factory
 
   #Returns a random value between 0 and 1.

data/lib/rubyonacid/factories/random_walk.rb

@@ -0,0 +1,29 @@
+require 'rubyonacid/factory'
+
+module RubyOnAcid
+
+#Increments from the minimum value, stopping at the maximum, or decrements from the maximum value, stopping at the minimum.
+class RandomWalkFactory < Factory
+
+  #The maximum amount to change counters by.
+  attr_accessor :interval
+  
+  def initialize(interval = 0.001)
+    super
+    @start_value = 0.0
+    @values = {}
+    @interval = interval
+  end
+  
+  #Increment counter for given key and return it. Constrain between 0 and 1.
+  def get_unit(key)
+    @values[key] ||= rand
+    @values[key] += (rand * (2 * @interval)) - @interval
+    @values[key] = 1.0 if @values[key] > 1.0
+    @values[key] = 0.0 if @values[key] < 0.0
+    @values[key]
+  end
+
+end
+
+end

data/lib/rubyonacid/factories/rinda.rb

@@ -3,6 +3,7 @@ require 'rubyonacid/factory'
 
 module RubyOnAcid
 
+#Allows values to be sent over the network.  For more information, see the Ruby standard library documentation for Rinda.
 class RindaFactory < Factory
   
   #Time in seconds to wait for a value before giving up and returning a default value for the given key.
@@ -21,6 +22,7 @@ class RindaFactory < Factory
     @prior_values = {}
   end
   
+  #Create the Rinda TupleSpace for clients to write to.
   def start_service
     DRb.start_service 
     @space = Rinda::TupleSpaceProxy.new(DRbObject.new(nil, @uri))

data/lib/rubyonacid/factories/sine.rb

@@ -2,8 +2,10 @@ require 'rubyonacid/factory'
 
 module RubyOnAcid
 
+#Produces a "wave" pattern.
 class SineFactory < Factory
   
+  #Counters used to calculate sine values will be incremented by this amount with each query.
   attr_accessor :interval
   
   def initialize(interval = 0.1)

data/lib/rubyonacid/factories/skip.rb

@@ -2,6 +2,7 @@ require 'rubyonacid/factory'
 
 module RubyOnAcid
 
+#Returns the minimum or the maximum at random (influenced by the given odds).
 class SkipFactory < Factory
   
   #The percentage odds that the factory will return 0 instead of 1.

data/lib/rubyonacid/factory.rb

@@ -1,5 +1,7 @@
 module RubyOnAcid
 
+#The parent class for all other Factories.
+#Should not normally be instantiated directly.
 class Factory
 
   def initialize(*args)
@@ -16,7 +18,7 @@ class Factory
   def get(key, options = {})
     @minimums[key] = (options[:min] || @minimums[key] || 0.0)
     @maximums[key] = (options[:max] || @maximums[key] || (@minimums[key] > 1.0 ? @minimums[key] + 1.0 : 1.0))
-    get_unit(key) * (@maximums[key] - @minimums[key]) + @minimums[key]
+    (get_unit(key) * (@maximums[key] - @minimums[key])) + @minimums[key]
   end
   
   #Returns true if get_unit(key) returns greater than 0.5.
@@ -33,6 +35,7 @@ class Factory
     all_choices[index]
   end
   
+  
 end
 
 end

data/spec/factories/input_spec.rb

@@ -0,0 +1,96 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require "rubyonacid/factories/input"
+require "shared_factory_specs"
+
+include RubyOnAcid
+
+describe InputFactory do
+
+  before :each do
+    @it = InputFactory.new
+  end
+
+  describe "general behavior" do
+
+    before :each do
+      @it.put(:foo, 0.0)
+      @it.put(:foo, 1.0)
+    end
+
+    it_should_behave_like "a factory"
+    
+  end
+  
+  describe "#get_unit" do
+    
+    it "retrieves values assigned to a key" do
+      @it.put(:x, 0.1)
+      @it.get(:x).should == 0.1
+    end
+    
+    it "retrieves multiple input values in order" do
+      @it.put(:x, 0.1)
+      @it.put(:x, 0.2)
+      @it.get(:x).should == 0.1
+      @it.get(:x).should == 0.2
+    end
+    
+    it "maps to a different key if the requested one isn't present" do
+      @it.put(:x, 0.1)
+      @it.get(:y).should == 0.1
+    end
+    
+    it "returns 0 if a key is assigned but has no values" do
+      @it.put(:x, 0.1)
+      @it.put(:x, 0.2)
+      @it.get(:y).should == 0.1
+      @it.get(:y).should == 0.2
+      @it.put(:z, 0.3)
+      @it.get(:y).should == 0.0
+    end
+  
+  end
+  
+  describe "scaling" do
+    
+    it "scales highest seen values for a key to 0 to 1 range" do
+      @it.put(:x, 0.0)
+      @it.put(:x, 1.0)
+      @it.get(:x).should be_close(0.0, MARGIN)
+      @it.get(:x).should be_close(1.0, MARGIN)
+      @it.put(:x, 0.0)
+      @it.put(:x, 1.0)
+      @it.put(:x, 2.0)
+      @it.get(:x).should be_close(0.0, MARGIN)
+      @it.get(:x).should be_close(0.5, MARGIN)
+      @it.get(:x).should be_close(1.0, MARGIN)
+      @it.put(:x, 0.0)
+      @it.put(:x, 3.0)
+      @it.put(:x, 4.0)
+      @it.get(:x).should be_close(0.0, MARGIN)
+      @it.get(:x).should be_close(0.75, MARGIN)
+      @it.get(:x).should be_close(1.0, MARGIN)
+    end
+    
+    it "scales lowest seen values for a key to 0 to 1 range" do
+      @it.put(:x, 0.0)
+      @it.put(:x, 1.0)
+      @it.get(:x).should be_close(0.0, MARGIN)
+      @it.get(:x).should be_close(1.0, MARGIN)
+      @it.put(:x, 0.0)
+      @it.put(:x, 1.0)
+      @it.put(:x, -2.0)
+      @it.get(:x).should be_close(0.666, MARGIN)
+      @it.get(:x).should be_close(1.0, MARGIN)
+      @it.get(:x).should be_close(0.0, MARGIN)
+      @it.put(:x, -2.0)
+      @it.put(:x, 2.0)
+      @it.put(:x, 1.0)
+      @it.get(:x).should be_close(0.0, MARGIN)
+      @it.get(:x).should be_close(1.0, MARGIN)
+      @it.get(:x).should be_close(0.75, MARGIN)
+    end
+    
+  end
+  
+end

data/spec/factories/random_walk_spec.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require "shared_factory_specs"
+require 'rubyonacid/factories/random_walk'
+
+include RubyOnAcid
+
+describe RandomWalkFactory do
+  
+  
+  before :each do
+    @it = RandomWalkFactory.new
+  end
+  
+  it_should_behave_like "a factory"
+  
+  it "increases or decreases prior key value by random amount within given interval" do
+    values = []
+    values << @it.get_unit(:x)
+    @it.interval = 0.3
+    values << @it.get_unit(:x)
+    values[1].should be_close(values[0], 0.3)
+    @it.interval = 0.01
+    values << @it.get_unit(:x)
+    values[2].should be_close(values[1], 0.01)
+  end
+  
+end

data/spec/factories/rinda_spec.rb

@@ -4,28 +4,35 @@ require 'rubyonacid/factories/rinda'
 
 include RubyOnAcid
 
+require 'rinda/rinda'
+require 'rinda/tuplespace'
+DRb.start_service
+DRb.start_service("druby://127.0.0.1:7632", Rinda::TupleSpace.new) 
+
 describe RindaFactory do
   
-  
   before :each do
     @it = RindaFactory.new
-    uri = "druby://127.0.0.1:9999"
-    @it.uri = uri
-    require 'rinda/rinda'
-    require 'rinda/tuplespace'
-    DRb.start_service
-    DRb.start_service(uri, Rinda::TupleSpace.new) 
+    @it.uri = "druby://127.0.0.1:7632"
     @space = Rinda::TupleSpaceProxy.new(DRbObject.new(nil, @it.uri)) 
   end
   
-  it_should_behave_like "a factory"
+  describe "general behavior" do
+  
+    before :each do
+      @it.start_service
+    end
+  
+    it_should_behave_like "a factory"
+    
+  end
   
   it "gets keys from Rinda server" do
     @it.start_service
     @space.write([:x, 0.5])
     @it.get_unit(:x).should == 0.5
     @space.write([:y, 0.6])
-    @it.get_unit(:x).should == 0.6
+    @it.get_unit(:y).should == 0.6
   end
   
   it "gets keys from a backup factory when it cannot retrieve values via Rinda" do
@@ -36,4 +43,4 @@ describe RindaFactory do
     @it.get_unit(:a).should == 0.74
   end
   
-end
+end

data/spec/factories/sine_spec.rb

@@ -15,7 +15,6 @@ describe SineFactory do
   
   it "loops between 0 and 1" do
     @it.interval = 1.0
-    # @it.get_unit(:x).should be_close(0.500, MARGIN)
     @it.get_unit(:x).should be_close(0.920, MARGIN)
     @it.get_unit(:x).should be_close(0.954, MARGIN)
     @it.get_unit(:x).should be_close(0.570, MARGIN)
@@ -26,7 +25,6 @@ describe SineFactory do
   
   it "can take a different interval" do
     @it.interval = 0.5
-    # @it.get_unit(:x).should be_close(0.500, MARGIN)
     @it.get_unit(:x).should be_close(0.740, MARGIN)
     @it.get_unit(:x).should be_close(0.920, MARGIN)
   end

data/spec/shared_factory_specs.rb

@@ -73,6 +73,5 @@ shared_examples_for "a factory" do
       end
     end
   end
-  
-  
+    
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rubyonacid
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jay McGavren
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-03 00:00:00 -07:00
+date: 2009-12-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,19 +41,24 @@ files:
 - examples/midi.rb
 - examples/raw_audio.rb
 - examples/rinda_agent.rb
+- examples/svg.rb
 - examples/wxruby.rb
 - features/rubyonacid.feature
 - features/step_definitions/rubyonacid_steps.rb
 - features/support/env.rb
 - generators.png
 - lib/rubyonacid.rb
+- lib/rubyonacid/factories/all.rb
 - lib/rubyonacid/factories/combination.rb
 - lib/rubyonacid/factories/constant.rb
+- lib/rubyonacid/factories/example.rb
 - lib/rubyonacid/factories/flash.rb
 - lib/rubyonacid/factories/increment.rb
+- lib/rubyonacid/factories/input.rb
 - lib/rubyonacid/factories/loop.rb
 - lib/rubyonacid/factories/meta.rb
 - lib/rubyonacid/factories/random.rb
+- lib/rubyonacid/factories/random_walk.rb
 - lib/rubyonacid/factories/repeat.rb
 - lib/rubyonacid/factories/rinda.rb
 - lib/rubyonacid/factories/sine.rb
@@ -63,9 +68,11 @@ files:
 - spec/factories/constant_spec.rb
 - spec/factories/flash_spec.rb
 - spec/factories/increment_spec.rb
+- spec/factories/input_spec.rb
 - spec/factories/loop_spec.rb
 - spec/factories/meta_spec.rb
 - spec/factories/random_spec.rb
+- spec/factories/random_walk_spec.rb
 - spec/factories/repeat_spec.rb
 - spec/factories/rinda_spec.rb
 - spec/factories/sine_spec.rb
@@ -106,9 +113,11 @@ test_files:
 - spec/factories/constant_spec.rb
 - spec/factories/flash_spec.rb
 - spec/factories/increment_spec.rb
+- spec/factories/input_spec.rb
 - spec/factories/loop_spec.rb
 - spec/factories/meta_spec.rb
 - spec/factories/random_spec.rb
+- spec/factories/random_walk_spec.rb
 - spec/factories/repeat_spec.rb
 - spec/factories/rinda_spec.rb
 - spec/factories/sine_spec.rb
@@ -118,9 +127,7 @@ test_files:
 - spec/spec_helper.rb
 - examples/ascii.rb
 - examples/midi.rb
-- examples/permutations.rb
-- examples/quality_render.rb
-- examples/random_yaml.rb
 - examples/raw_audio.rb
 - examples/rinda_agent.rb
+- examples/svg.rb
 - examples/wxruby.rb

data/examples/permutations.rb

@@ -1,40 +0,0 @@
-require 'rubygems'
-require 'rubyonacid/factories/meta'
-require 'rubyonacid/factories/flash'
-require 'rubyonacid/factories/increment'
-require 'rubyonacid/factories/loop'
-require 'rubyonacid/factories/random'
-require 'rubyonacid/factories/sine'
-require 'rubyonacid/factories/skip'
-
-factories = []
-factories << RubyOnAcid::LoopFactory.new(0.001)
-factories << RubyOnAcid::LoopFactory.new(-0.001)
-factories << RubyOnAcid::LoopFactory.new(0.01)
-factories << RubyOnAcid::LoopFactory.new(-0.01)
-factories << RubyOnAcid::LoopFactory.new(0.1)
-factories << RubyOnAcid::LoopFactory.new(-0.1)
-factories << RubyOnAcid::IncrementFactory.new(0.001)
-factories << RubyOnAcid::RandomFactory.new
-factories << RubyOnAcid::FlashFactory.new(1)
-factories << RubyOnAcid::FlashFactory.new(3)
-factories << RubyOnAcid::FlashFactory.new(50)
-factories << RubyOnAcid::FlashFactory.new(100)
-factories << RubyOnAcid::SineFactory.new(0.1)
-factories << RubyOnAcid::SineFactory.new(-0.1)
-factories << RubyOnAcid::SineFactory.new(0.01)
-factories << RubyOnAcid::SineFactory.new(-0.01)
-factories << RubyOnAcid::SineFactory.new(0.001)
-factories << RubyOnAcid::SineFactory.new(-0.001)
-
-keys = [:red, :green, :blue, :alpha, :width, :x, :y, :x2, :y2]
-
-factories.permutation(keys.length).each_with_index do |permutation, i|
-  meta_factory = RubyOnAcid::MetaFactory.new
-  keys.each do |key|
-    meta_factory.assign_factory(key, permutation.shift)
-  end
-  File.open(sprintf('%05d.yml', i), "w") do |file|
-    YAML.dump(meta_factory, file)
-  end
-end

data/examples/quality_render.rb

@@ -1,46 +0,0 @@
-require File.join(File.dirname(__FILE__), 'wxruby.rb')
-
-
-
-class MyApp
-
-  WIDTH = 1920
-  HEIGHT = 1080
-
-  def on_init
-    
-    ARGV.each do |file_name|
-      
-      puts "Processing #{file_name}"
-      
-      @f = YAML.load_file(file_name)
-    
-      frame = Wx::Frame.new(nil, :size => [WIDTH, HEIGHT])
-
- 
-      #Displays drawing.
-      bitmap = Wx::Bitmap.new(WIDTH, HEIGHT)
-      bitmap.draw do |surface|
-        surface.brush = Wx::BLACK_BRUSH
-        surface.draw_rectangle(0, 0, WIDTH, HEIGHT)
-      end
-      10000.times do
-        bitmap.draw {|surface| render(surface)}
-      end
-      bitmap.draw do |surface|
-        surface.text_foreground = Wx::Colour.new(255, 255, 255, 255)
-        surface.draw_text("©2009 Jay McGavren. Licensed under a Creative Commons Attribution-Share Alike 3.0 United States License: http://creativecommons.org/licenses/by-sa/3.0/us/", 10, HEIGHT - 20)
-      end
-      
-      bitmap.save_file(file_name + ".png", Wx::BITMAP_TYPE_PNG)
-      
-    end
-    
-    exit
- 
-  end
-
-end
-
-app = MyApp.new
-app.main_loop

data/examples/random_yaml.rb

@@ -1,51 +0,0 @@
-require File.join(File.dirname(__FILE__), 'wxruby.rb')
-
-
-class MyApp
-
-  WIDTH = 320
-  HEIGHT = 320
-
-  def on_init
-    
-    (1..1000).each do |file_number|
-      
-      file_name = sprintf("%05d_random.jpg", file_number)
-      
-      @f = create_factory
-    
-      frame = Wx::Frame.new(nil, :size => [WIDTH, HEIGHT])
- 
-      bitmap = Wx::Bitmap.new(WIDTH, HEIGHT)
-      bitmap.draw do |surface|
-        surface.brush = Wx::BLACK_BRUSH
-        surface.draw_rectangle(0, 0, WIDTH, HEIGHT)
-      end
-      10000.times do
-        bitmap.draw {|surface| render(surface)}
-      end
-      bitmap.draw do |surface|
-        surface.text_foreground = Wx::Colour.new(255, 255, 255, 255)
-        y = 0
-        @f.to_yaml.split("\n").each do |line|
-          surface.draw_text(line, 0, y)
-          y += 10
-        end
-      end
-      
-      File.open(file_name + ".yml", "w") do |file|
-        YAML.dump(@f, file)
-      end
-      
-      bitmap.save_file(file_name, Wx::BITMAP_TYPE_JPEG)
-      
-    end
-    
-    exit
- 
-  end
-
-end
-
-app = MyApp.new
-app.main_loop