nudge 0.0.2 → 0.1.0

data/lib/nudge.rb

@@ -2,39 +2,38 @@ $: << File.join(File.dirname(__FILE__), "/../lib")
 
 require 'rubygems'
 require 'treetop'
-require 'polyglot'
 require 'active_support'
-require 'interpreter/grammars/nudge_language_helpers'
-require 'interpreter/grammars/nudge_language'
+
+require 'interpreter/parse.tab'
+
+require 'interpreter/grammars/nudge_common'
+
+require 'interpreter/grammars/nudge_value_helpers'
+require 'interpreter/grammars/nudge_reference_helpers'
+require 'interpreter/grammars/nudge_instruction_helpers'
+require 'interpreter/grammars/nudge_codeblock_helpers'
+require 'interpreter/grammars/nudge_reference'
+require 'interpreter/grammars/nudge_instruction'
+require 'interpreter/grammars/nudge_value'
+require 'interpreter/grammars/nudge_codeblock'
+
+require 'interpreter/nudge_program'
+
 require 'interpreter/interpreter'
 require 'interpreter/types/pushTypes'
 require 'interpreter/types/codeType'
 require 'interpreter/stack'
 require 'interpreter/programPoints'
-require 'search/helpers'
 
 require 'instructions/infrastructure'
-require 'instructions/stack_manipulation'
-require 'instructions/int_arithmetic'
-require 'instructions/float_arithmetic'
-require 'instructions/float_transcendental'
-require 'instructions/bool_basics'
-require 'instructions/comparisons'
-require 'instructions/conditionals'
-require 'instructions/conversions'
-require 'instructions/random_value'
-require 'instructions/exec'
-require 'instructions/name_bindings'
-require 'instructions/name_basics'
-require 'instructions/code_basics'
-
-
-require 'search/individual/individual'
-require 'search/individual/batch'
-require 'search/operators/basic_operators'
-require 'search/operators/samplers_and_selectors'
-require 'search/operators/evaluators'
-require 'search/stations/station'
-require 'search/experiments/experiment'
+
+Dir.glob(File.dirname(__FILE__) + '/instructions/bool/*') {|file| require file}
+Dir.glob(File.dirname(__FILE__) + '/instructions/code/*') {|file| require file}
+Dir.glob(File.dirname(__FILE__) + '/instructions/exec/*') {|file| require file}
+Dir.glob(File.dirname(__FILE__) + '/instructions/int/*') {|file| require file}
+Dir.glob(File.dirname(__FILE__) + '/instructions/float/*') {|file| require file}
+Dir.glob(File.dirname(__FILE__) + '/instructions/name/*') {|file| require file}
+
+Dir.glob(File.dirname(__FILE__) + '/instructions/conversion/*') {|file| require file}
 
 include NudgeType

data/readme.md

@@ -1,19 +1,22 @@
-# Pragmatic Genetic Programming
+# Nudge Language Interpreter in Ruby
 
-The first release of the Pragmatic GP package will include a Ruby implementation of a [Push 3.0 language interpreter](http://hampshire.edu/lspector/push3-description.html "Push 3"), a framework for setting up and managing straightforward genetic programming projects using an [ALPS](http://idesign.ucsc.edu/projects/alps.html "ALPS algorithms")-based algorithm, and a simple architecture for monitoring and exploring the results of GP runs as they arise.
+Nudge is a flexible programming language descended from [Push 3.0](http://hampshire.edu/lspector/push3-description.html "Push 3"). It's an extensible stack-based language with a very simple interpreter structure, but a lot of functionality.
 
-This is a complete rewrite of an earlier project written in Python, and is really just a huge down-to-the-roots refactoring that relies on a lot of Ruby's more convenient metaprogramming features.
+Like Push, Nudge is _usable_ by human beings, but it's actually designed for genetic programming applications. Unlike Push, we've incorporated a lot of syntactic sugar to make it a bit more human-readable (even when machine-generated), and this library implements simple mechanisms for passing in problem-specific variables and extending the core language by writing new instructions.
 
-We're building this from the bottom up, so it doesn't "work" in the sense you might expect. At the moment, only the specs pass. There isn't any centralized run behavior in place yet, though that will be coming soon.
+See the [project Wiki](http://github.com/Vaguery/Nudge/wikis) for a more thorough explanation.
 
-## Requirements
+## Getting started
 
-For the time being requirements need to be installed by hand.
+[tbd]
 
-First, the codebase increasingly relies on features of ruby 1.9.1. If you'd like to work with it, I'd recommend using [rvm](http://rvm.beginrescueend.com/) to set it up to work alongside the other version(s) of the Ruby interpreter your system may depend on.
+## Requirements
 
-You'll need to download and install [couchDB](http://couchdb.apache.org/), and have it running before launching a full-fledged Nudge Experiment.
+The interpreter code relies heavily on functional programming features of Ruby 1.9+. If you have not yet installed Ruby 1.9, I'd recommend using [rvm](http://rvm.beginrescueend.com/) to set up a special "sandbox" version of 1.9 until you're ready to upgrade your development or production machine.
 
-To run and verify the codebase, you'll need to have recent versions of the following gems: [haml](http://haml-lang.com/), [sinatra](http://www.sinatrarb.com/), [treetop](http://treetop.rubyforge.org/), [activesupport](http://as.rubyonrails.org/), and [couchrest](http://github.com/jchris/couchrest); [rspec](http://rspec.info/), [cucumber](http://cukes.info/) and [fakeweb](http://fakeweb.rubyforge.org/) to be able to run the specs and confirm the codebase works on your system.
+The following gems need to be present to run the code:
 
-If as we are you're developing with TextMate, you'll need to make sure your 'PATH' variable in the application is set correctly by adding the path to your *active* ruby binary and gems to the front.
+* [treetop](http://treetop.rubyforge.org/)
+* [activesupport](http://as.rubyonrails.org/)
+  
+and you will want [rspec](http://rspec.info/) to be able to run the specs and confirm the codebase works on your system.

data/spec/fixtures/long_arithmetic.example

@@ -1,7 +1,10 @@
 block {
-  literal int(8)
-  literal int(9)
+  value «int»
+  value «int»
   do int_multiply
   block {
-    sample int(-2)
-    do int_divide}}
+    value «int»
+    do int_divide}}
+«int» 8
+«int» 9
+«int» -2

data/spec/instructions/bool/bool_and_spec.rb

@@ -0,0 +1,61 @@
+require File.join(File.dirname(__FILE__), "../../spec_helper")
+include Nudge
+
+
+describe BoolAndInstruction do
+  
+  it_should_behave_like "every Nudge Instruction"
+  
+  before(:each) do
+    @context = Interpreter.new
+    @i1 = BoolAndInstruction.new(@context)
+  end
+  
+
+  describe "\#go" do
+    before(:each) do
+      @i1 = BoolAndInstruction.new(@context)
+      @bool1 = ValuePoint.new("bool", false)
+    end
+
+    describe "\#preconditions?" do
+      it "should check that there are enough parameters" do
+        2.times {@context.stacks[:bool].push(@bool1)}
+        @i1.preconditions?.should == true
+      end
+      
+      it "should raise an error if the preconditions aren't met" do
+        @context.clear_stacks # there are no params at all
+        lambda{@i1.preconditions?}.should raise_error(Instruction::NotEnoughStackItems)
+      end
+      
+      it "should successfully run #go only if all preconditions are met" do
+        3.times {@context.stacks[:bool].push(@bool1)}
+        @i1.should_receive(:cleanup)
+        @i1.go
+      end
+    end
+    
+    describe "\#derive" do
+      it "should pop all the arguments" do
+        2.times {@context.stacks[:bool].push(@bool1)}
+        @i1.stub!(:cleanup) # and do nothing
+        @i1.go
+        @context.stacks[:bool].depth.should == 0
+      end
+    end
+    
+    describe "\#cleanup" do
+      describe "should push the result" do
+        {[true, true] => true, [true, false] => false, [false, false] => false}.each do |inputs, expected|
+          params = inputs.inspect
+          it "should produce #{expected} given #{params}" do
+            inputs.each {|i| @context.stacks[:bool].push(ValuePoint.new("bool", i))}
+            @i1.go
+            @context.stacks[:bool].peek.value.should == expected
+          end
+        end
+      end
+    end
+  end
+end

data/spec/instructions/bool/bool_define_spec.rb

@@ -0,0 +1,69 @@
+require File.join(File.dirname(__FILE__), "../../spec_helper")
+include Nudge
+
+
+describe BoolDefineInstruction do
+  
+  it_should_behave_like "every Nudge Instruction"
+  
+  before(:each) do
+    @context = Interpreter.new
+    @i1 = BoolDefineInstruction.new(@context)
+  end
+  
+  
+  describe "\#go" do
+    before(:each) do
+      @i1 = BoolDefineInstruction.new(@context)
+      @context.clear_stacks
+      @name1 = ReferencePoint.new("xyz")
+    end
+    
+    describe "\#preconditions?" do
+      it "should check that there is one :name and one :bool" do
+        @context.stacks[:name].push(@name1)
+        @context.stacks[:bool].push(ValuePoint.new("bool", false))
+        @i1.preconditions?.should == true
+      end
+    end
+    
+    describe "\#cleanup" do
+      before(:each) do
+        @context.clear_stacks
+        @context.reset_names
+      end
+      
+      it "should bind the top :bool to the top :name" do
+        @context.stacks[:name].push(@name1)
+        @context.stacks[:bool].push(ValuePoint.new("bool", false))
+        @i1.go
+        @context.stacks[:name].depth.should == 0
+        @context.stacks[:bool].depth.should == 0
+        @context.names.length.should_not == 0        
+        @context.names["xyz"].value.should == false
+      end
+      
+      it "should overwrite the binding if it already exists" do
+        @context.bind_name("xyz", ValuePoint.new("float", 3.3))
+        @context.names["xyz"].value.should == 3.3
+        
+        @context.stacks[:name].push(@name1)
+        @context.stacks[:bool].push(ValuePoint.new("bool", false))
+        @i1.go
+        @context.stacks[:name].depth.should == 0
+        @context.stacks[:bool].depth.should == 0
+        @context.names.length.should_not == 0        
+        @context.names["xyz"].value.should == false
+      end
+      
+      it "should not re-bind a name that is a variable, though" do
+        @context.bind_variable("xyz", ValuePoint.new("bool", false))
+        @context.stacks[:bool].push(ValuePoint.new("bool", 456))
+        @context.stacks[:name].push(ReferencePoint.new("xyz"))
+        @i1.go
+        @context.stacks[:error].peek.blueprint.should include "cannot redefine a variable"
+      end
+      
+    end
+  end
+end

data/spec/instructions/bool/bool_depth_spec.rb

@@ -0,0 +1,39 @@
+#encoding: utf-8
+require File.join(File.dirname(__FILE__), "../../spec_helper")
+include Nudge
+
+describe BoolDepthInstruction do
+  
+  it_should_behave_like "every Nudge Instruction"
+  
+  before(:each) do
+    @context = Interpreter.new
+    @i1 = BoolDepthInstruction.new(@context)
+  end
+  
+  
+  describe "\#go" do
+    before(:each) do
+      @i1 = BoolDepthInstruction.new(@context)
+      @context.clear_stacks
+      @bool1 = ValuePoint.new("bool", false)
+    end
+    
+    describe "\#preconditions?" do
+      it "should check that the :bool stack responds to #depth" do
+        @i1.preconditions?.should == true
+      end
+    end
+    
+    describe "\#cleanup" do
+      it "should count the items on the stack and push it onto the :int stack" do
+        @context.stacks[:int].depth.should == 0
+        @i1.go # there are no bools
+        @context.stacks[:int].peek.value.should == 0
+        7.times {@context.stacks[:bool].push @bool1}
+        @i1.go
+        @context.stacks[:int].peek.value.should == 7
+      end
+    end
+  end
+end

data/spec/instructions/bool/bool_equal_q_spec.rb

@@ -0,0 +1,61 @@
+require File.join(File.dirname(__FILE__), "../../spec_helper")
+include Nudge
+
+
+describe BoolEqualQInstruction do
+  
+  it_should_behave_like "every Nudge Instruction"
+  
+  before(:each) do
+    @context = Interpreter.new
+    @i1 = BoolEqualQInstruction.new(@context)
+  end
+  
+  
+  describe "\#go" do
+    before(:each) do
+      @i1 = BoolEqualQInstruction.new(@context)
+      @bool1 = ValuePoint.new("bool", false)
+    end
+
+    describe "\#preconditions?" do
+      it "should check that there are enough parameters" do
+        2.times {@context.stacks[:bool].push(@bool1)}
+        @i1.preconditions?.should == true
+      end
+      
+      it "should raise an error if the preconditions aren't met" do
+        @context.clear_stacks # there are no params at all
+        lambda{@i1.preconditions?}.should raise_error(Instruction::NotEnoughStackItems)
+      end
+      
+      it "should successfully run #go only if all preconditions are met" do
+        3.times {@context.stacks[:bool].push(@bool1)}
+        @i1.should_receive(:cleanup)
+        @i1.go
+      end
+    end
+    
+    describe "\#derive" do
+      it "should pop all the arguments" do
+        2.times {@context.stacks[:bool].push(@bool1)}
+        @i1.stub!(:cleanup) # and do nothing
+        @i1.go
+        @context.stacks[:bool].depth.should == 0
+      end
+    end
+    
+    describe "\#cleanup" do
+      describe "should push the result" do
+        {[true, true] => true, [true, false] => false, [false, false] => true}.each do |inputs, expected|
+          params = inputs.inspect
+          it "should produce #{expected} given #{params}" do
+            inputs.each {|i| @context.stacks[:bool].push(ValuePoint.new("bool", i))}
+            @i1.go
+            @context.stacks[:bool].peek.value.should == expected
+          end
+        end
+      end
+    end
+  end
+end

data/spec/instructions/bool/bool_flush_spec.rb

@@ -0,0 +1,37 @@
+#encoding: utf-8
+require File.join(File.dirname(__FILE__), "../../spec_helper")
+include Nudge
+
+describe BoolFlushInstruction do
+  
+  it_should_behave_like "every Nudge Instruction"
+  
+  before(:each) do
+    @context = Interpreter.new
+    @i1 = BoolFlushInstruction.new(@context)
+  end
+  
+  
+  describe "\#go" do
+    before(:each) do
+      @i1 = BoolFlushInstruction.new(@context)
+      @context.clear_stacks
+      @bool1 = ValuePoint.new("bool", "true")
+    end
+    
+    describe "\#preconditions?" do
+      it "should check that the :bool stack responds to #depth" do
+        @i1.preconditions?.should == true
+      end
+    end
+    
+    describe "\#cleanup" do
+      it "should remove all items on the stack" do
+        11.times {@context.stacks[:bool].push(@bool1)}
+        @context.stacks[:bool].depth.should == 11
+        @i1.go
+        @context.stacks[:bool].depth.should == 0
+      end
+    end
+  end
+end

data/spec/instructions/bool/bool_not_spec.rb

@@ -0,0 +1,61 @@
+require File.join(File.dirname(__FILE__), "../../spec_helper")
+include Nudge
+
+
+describe BoolNotInstruction do
+  
+  it_should_behave_like "every Nudge Instruction"
+  
+  before(:each) do
+    @context = Interpreter.new
+    @i1 = BoolNotInstruction.new(@context)
+  end
+  
+
+  describe "\#go" do
+    before(:each) do
+      @i1 = BoolNotInstruction.new(@context)
+      @bool1 = ValuePoint.new("bool", false)
+    end
+
+    describe "\#preconditions?" do
+      it "should check that there are enough parameters" do
+        1.times {@context.stacks[:bool].push(@bool1)}
+        @i1.preconditions?.should == true
+      end
+      
+      it "should raise an error if the preconditions aren't met" do
+        @context.clear_stacks # there are no params at all
+        lambda{@i1.preconditions?}.should raise_error(Instruction::NotEnoughStackItems)
+      end
+      
+      it "should successfully run #go only if all preconditions are met" do
+        1.times {@context.stacks[:bool].push(@bool1)}
+        @i1.should_receive(:cleanup)
+        @i1.go
+      end
+    end
+    
+    describe "\#derive" do
+      it "should pop all the arguments" do
+        1.times {@context.stacks[:bool].push(@bool1)}
+        @i1.stub!(:cleanup) # and do nothing
+        @i1.go
+        @context.stacks[:bool].depth.should == 0
+      end
+    end
+    
+    describe "\#cleanup" do
+      describe "should push the result" do
+        {[true] => false, [false] => true}.each do |inputs, expected|
+          params = inputs.inspect
+          it "should produce #{expected} given #{params}" do
+            inputs.each {|i| @context.stacks[:bool].push(ValuePoint.new("bool", i))}
+            @i1.go
+            @context.stacks[:bool].peek.value.should == expected
+          end
+        end
+      end
+    end
+  end
+end

data/spec/instructions/bool/bool_or_spec.rb

@@ -0,0 +1,61 @@
+require File.join(File.dirname(__FILE__), "../../spec_helper")
+include Nudge
+
+
+describe BoolOrInstruction do
+  
+  it_should_behave_like "every Nudge Instruction"
+  
+  before(:each) do
+    @context = Interpreter.new
+    @i1 = BoolOrInstruction.new(@context)
+  end
+  
+
+  describe "\#go" do
+    before(:each) do
+      @i1 = BoolOrInstruction.new(@context)
+      @bool1 = ValuePoint.new("bool", false)
+    end
+
+    describe "\#preconditions?" do
+      it "should check that there are enough parameters" do
+        2.times {@context.stacks[:bool].push(@bool1)}
+        @i1.preconditions?.should == true
+      end
+      
+      it "should raise an error if the preconditions aren't met" do
+        @context.clear_stacks # there are no params at all
+        lambda{@i1.preconditions?}.should raise_error(Instruction::NotEnoughStackItems)
+      end
+      
+      it "should successfully run #go only if all preconditions are met" do
+        3.times {@context.stacks[:bool].push(@bool1)}
+        @i1.should_receive(:cleanup)
+        @i1.go
+      end
+    end
+    
+    describe "\#derive" do
+      it "should pop all the arguments" do
+        2.times {@context.stacks[:bool].push(@bool1)}
+        @i1.stub!(:cleanup) # and do nothing
+        @i1.go
+        @context.stacks[:bool].depth.should == 0
+      end
+    end
+    
+    describe "\#cleanup" do
+      describe "should push the result" do
+        {[true, true] => true, [true, false] => true, [false, false] => false}.each do |inputs, expected|
+          params = inputs.inspect
+          it "should produce #{expected} given #{params}" do
+            inputs.each {|i| @context.stacks[:bool].push(ValuePoint.new("bool", i))}
+            @i1.go
+            @context.stacks[:bool].peek.value.should == expected
+          end
+        end
+      end
+    end
+  end
+end

data/spec/instructions/bool/bool_random_spec.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), "../../spec_helper")
+include Nudge
+
+
+describe BoolRandomInstruction do
+  
+  it_should_behave_like "every Nudge Instruction"
+  
+  before(:each) do
+    @context = Interpreter.new
+    @i1 = BoolRandomInstruction.new(@context)
+  end
+  
+  describe "\#go" do
+    before(:each) do
+      @i1 = BoolRandomInstruction.new(@context)
+      @context.clear_stacks
+    end
+      
+    describe "\#cleanup" do
+      it "should invoke Type#any_value" do
+        @context.clear_stacks
+        BoolType.should_receive(:any_value)
+        @i1.go
+      end
+      
+      it "should have a created a new instance of the right type and pushed it" do
+        @context.clear_stacks
+        @i1.go
+        @context.stacks[:bool].depth.should == 1
+        result = @context.stacks[:bool].peek
+        result.value.should_not == nil
+        result.type.should == :bool
+      end
+    end
+  end
+end
+
+

data/spec/instructions/bool/bool_shove_spec.rb

@@ -0,0 +1,69 @@
+#encoding: utf-8
+require File.join(File.dirname(__FILE__), "../../spec_helper")
+include Nudge
+
+
+describe BoolShoveInstruction do
+  
+  it_should_behave_like "every Nudge Instruction"
+  
+  before(:each) do
+    @context = Interpreter.new
+    @i1 = BoolShoveInstruction.new(@context)
+  end
+  
+  
+  describe "\#go" do
+    before(:each) do
+      @i1 = BoolShoveInstruction.new(@context)
+      @context.clear_stacks
+      @bool1 = ValuePoint.new("bool", "true")
+    end
+    
+    describe "\#preconditions?" do
+      it "should check that there is one :int and at least one :bool" do
+        @context.stacks[:int].push(ValuePoint.new("int", "4"))
+        @context.stacks[:bool].push(@bool1)
+        @i1.preconditions?.should == true
+      end
+    end
+    
+    describe "\#cleanup" do
+      before(:each) do
+        @context.clear_stacks
+        11.times {@context.stacks[:bool].push(@bool1)}
+        @context.stacks[:bool].push(ValuePoint.new("bool", "false")) # making it 12 deep
+      end
+      
+      it "should not move the top item if the integer is negative" do
+        @context.stacks[:int].push(ValuePoint.new("int", "-99"))
+        @i1.go
+        @context.stacks[:bool].depth.should == 12
+        @context.stacks[:bool].peek.value.should == false
+      end
+      
+      it "should not move the top item if the integer is zero" do
+        @context.stacks[:int].push(ValuePoint.new("int", "0"))
+        @i1.go
+        @context.stacks[:bool].depth.should == 12
+        @context.stacks[:bool].peek.value.should == false  
+      end
+      
+      it "should move the top item farther down if the value is less than the depth" do
+        @context.stacks[:int].push(ValuePoint.new("int", "1000"))
+        @i1.go
+        @context.stacks[:bool].depth.should == 12
+        @context.stacks[:bool].entries[0].value.should == false
+      end
+      
+      it "should move the top item to the bottom if the value is more than the depth" do
+        @context.stacks[:int].push(ValuePoint.new("int", "4"))
+        @i1.go
+        @context.stacks[:bool].depth.should == 12
+        @context.stacks[:bool].entries[11].value.should == true
+        @context.stacks[:bool].entries[7].value.should == false
+      end
+      
+    end
+  end
+end