nudge 0.1.1 → 0.1.2

data/Rakefile

@@ -1,5 +1,7 @@
 require 'rake'
 
+
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
@@ -20,10 +22,10 @@ begin
     # files
     gemspec.files.exclude '_spikes/**'
     gemspec.files.exclude('exploring_nudge/**')
-    
   end
   
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"
-end
+end
+

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/bin/nudge

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby -U 
+
+puts "Hi there"

data/lib/cli/runner.rb

@@ -0,0 +1,41 @@
+#encoding: utf-8
+
+module Nudge
+  class CliRunner
+    attr_accessor :filename
+    attr_accessor :raw_code
+    attr_accessor :nudge_program
+    attr_accessor :interpreter
+    attr_accessor :options
+    attr_accessor :result
+    
+    
+    def initialize(filename, options={})
+      @filename = filename
+      @nudge_program = NudgeProgram.new("")
+      @options = options
+      @interpreter = Interpreter.new(@options)
+    end
+    
+    
+    def setup(options = {})
+      @raw_code = IO.open(@filename)
+      @interpreter.reset(@raw_code)
+      options[:variables].each {|name, val| @interpreter.bind_variable(name, val)} if options[:variables]
+      options[:sensors].each {|name, block| @interpreter.register_sensor(name, &block)} if options[:sensors]
+    end
+    
+    
+    def run
+      return @interpreter.run
+    end
+  end
+  
+  
+  class CliParser
+    
+    def initialize
+    end
+  end
+  
+end

data/lib/interpreter/interpreter.rb

@@ -13,7 +13,7 @@ module Nudge
   #    * ... NilPoint, do nothing
   
   class Interpreter
-    attr_accessor :program, :stepLimit, :steps
+    attr_accessor :program, :step_limit, :steps
     attr_accessor :stacks, :instructions_library, :variables, :names, :types
     attr_accessor :last_name, :evaluate_references
     attr_accessor :sensors
@@ -24,7 +24,7 @@ module Nudge
       initialProgram = params[:program] || nil
       @program = initialProgram
       @types = params[:types] || NudgeType.all_types
-      @stepLimit = params[:step_limit] || 3000
+      @step_limit = params[:step_limit] || 3000
       @sensors = Hash.new
       
       instructions = params[:instructions] || Instruction.all_instructions
@@ -105,9 +105,9 @@ module Nudge
     
     # Checks to see if either stopping condition applies:
     # 1. Is the <b>:exec</b> stack empty?
-    # 2. Are the number of steps greater than self.stepLimit?
+    # 2. Are the number of steps greater than self.step_limit?
     def notDone?
-      @stacks[:exec].depth > 0 && @steps < @stepLimit
+      @stacks[:exec].depth > 0 && @steps < @step_limit
     end
     
     

data/lib/interpreter/nudge_program.rb

@@ -5,6 +5,12 @@ Treetop.load(File.join(File.dirname(__FILE__),'grammars', "nudge_codeblock.treet
 
 module Nudge
   class NudgeProgram
+    
+    def self.random(options = {})
+      sourcecode = CodeType.any_value(options)
+      NudgeProgram.new(sourcecode)
+    end
+    
 
     attr_accessor :linked_code,:footnotes
     attr_accessor :raw_code
@@ -22,6 +28,8 @@ module Nudge
     
     
     
+    
+    
     def program_split!
       split_at_first_guillemet=@raw_code.partition( /^(?=«)/ )
       @code_section = split_at_first_guillemet[0].strip

data/lib/nudge.rb

@@ -19,6 +19,8 @@ require 'interpreter/grammars/nudge_codeblock'
 
 require 'interpreter/nudge_program'
 
+require 'cli/runner'
+
 require 'interpreter/interpreter'
 require 'interpreter/types/pushTypes'
 require 'interpreter/types/codeType'

data/readme.md

@@ -8,8 +8,16 @@ See the [project Wiki](http://github.com/Vaguery/Nudge/wikis) for a more thoroug
 
 ## Getting started
 
-[tbd]
+    gem install nudge
 
+As of this writing, the `nudge` gem can be used as a library in your Ruby programs. S Real Soon Now, it'll be part of a more interesting gem…
+
+Meanwhile, try this:
+
+    require 'nudge'
+    include Nudge
+    
+    my_program = Nudge.random(target_size_in_points:20) # generates 
 ## Requirements
 
 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.

data/spec/command_line/command_line_spec.rb

@@ -0,0 +1,131 @@
+#encoding: utf-8
+require File.join(File.dirname(__FILE__), "./../spec_helper")
+include Nudge
+
+
+describe "CliRunner" do
+  before(:each) do
+    IO.stub!(:open).and_return("xyz123") # to avoid hitting the file
+  end
+  
+  it "should capture the filename in an attribute" do
+    CliRunner.new("beeboop").filename.should == "beeboop"
+  end
+  
+  it "should create an Interpreter instance" do
+    Interpreter.should_receive(:new)
+    CliRunner.new("beeboop")
+  end
+  
+  it "should capture other options it gets" do
+    lambda{CliRunner.new("foo", types:["int"])}.should_not raise_error
+    a = CliRunner.new("bar", types:["bool"], step_limit: 10000)
+    a.options.should == {:types=>["bool"], :step_limit=>10000}
+  end
+  
+  it "should pass those options down into its Interpreter instance's initialization" do
+    lambda{CliRunner.new("foo", types:["int"])}.should_not raise_error
+    a = CliRunner.new("bar", types:["bool"], step_limit: 10000)
+    a.interpreter.step_limit.should == 10000
+    a.interpreter.types.should == ["bool"]
+  end
+  
+  
+  describe "setup" do
+    before(:each) do
+      IO.stub!(:open).and_return("ref g") # to avoid hitting the file
+      @cr = CliRunner.new("beebop")
+    end
+    
+    it "should open the file and read in the program" do
+      IO.should_receive(:open).with("beebop").and_return("block {}")
+      CliRunner.new("beebop").setup
+    end
+    
+    it "should save the read filestream into #raw_code" do
+      @cr.setup
+      @cr.raw_code.should == "ref g"
+    end
+    
+    it "should reset the Interpreter with the new program" do
+      @cr.setup
+      @cr.interpreter.program.should == @cr.raw_code
+    end
+    
+    it "should be able to accept an optional Hash of variable bindings" do
+      lambda{@cr.setup(variables:{"x" => ValuePoint.new("int", 9)})}.should_not raise_error
+    end
+    
+    it "should build those bindings into its interpreter" do
+      @cr.setup(variables:{"x" => ValuePoint.new("int",1002)})
+      @cr.interpreter.variables["x"].value.should == 1002
+    end
+    
+    it "should be able to accept an optional Hash of sensor definitions" do
+      lambda{@cr.setup(sensors:{"x" => Proc.new {|me| "hi there"}} )}.should_not raise_error
+    end
+    
+    it "should register those sensors in the interpreter" do
+      @cr.setup(sensors:{"x" => Proc.new {|me| "hi there"}})
+      @cr.interpreter.sensors["x"].call.should == "hi there"
+    end
+  end
+  
+  
+  describe "run" do
+    before(:each) do
+      IO.stub!(:open).and_return("value «bool»\n«bool» false") # to avoid hitting the file
+    end
+    
+    it "should run the interpreter" do
+      cr = CliRunner.new("fakefile")
+      cr.setup
+      cr.interpreter.should_receive(:run)
+      cr.run
+    end
+    
+    it "should pass along the return value of the interpreter (the sensors' output)" do
+      cr = CliRunner.new("fakefile")
+      cr.setup
+      cr.interpreter.register_sensor("output") {|intrprtr| 82}
+      cr.run.should == {"output"=>82}
+    end
+  end
+end
+
+
+describe CliParser do
+  describe "filename" do
+    it "should read the filename from ARGV"
+  end
+  
+  describe "step_limit" do
+    it "should be an optional parameter"
+    
+    it "should parse the step_limit from ARGV"
+  end
+  
+  describe "types" do
+    it "should be an optional parameter"
+    
+    it "should parse the type_names from ARGV"
+  end
+  
+  describe "instructions" do
+    it "should be an optional parameter"
+    
+    it "should parse the instruction_names from ARGV"
+  end
+  
+  describe "variable bindings" do
+    it "should be an optional parameter"
+    
+    it "should parse the variable bindings from ARGV"
+  end
+  
+  describe "sensors" do
+    it "should be an optional parameter"
+    
+    it "should parse the sensor definitions from ARGV"
+  end
+end

data/spec/interpreter/interpreter_spec.rb

@@ -405,9 +405,9 @@ describe "stepping" do
     lambda{3.times {@ii.step}}.should_not raise_error 
   end
   
-  it "should step only until the stepLimit has not been reached, if the :exec stack is full" do
+  it "should step only until the step_limit has not been reached, if the :exec stack is full" do
     myCode = "block {"*20 + "}"*20
-    @ii.stepLimit = 3
+    @ii.step_limit = 3
     @ii.reset(myCode)
     lambda{15.times {@ii.step}}.should_not raise_error
   end
@@ -431,8 +431,8 @@ describe "running" do
     @ii.reset(myCode)
   end
   
-  it "should run until the stepLimit has been reached, if the :exec stack isn't empty" do
-    @ii.stepLimit = 9
+  it "should run until the step_limit has been reached, if the :exec stack isn't empty" do
+    @ii.step_limit = 9
     @ii.run
     @ii.steps.should == 9
   end
@@ -449,10 +449,13 @@ describe "running" do
     @ii.steps.should == 0
   end
   
-  it "should #fire_all_sensors at the end of running" do
+  it "should #fire_all_sensors at the end of running if any are defined" do
+    @ii.register_sensor("y")
     @ii.should_receive(:fire_all_sensors)
     @ii.run
   end
+  
+  it "should return Stack#inspect for all its stacks if no sensors are defined"
 end
 
 

data/spec/interpreter/nudge_program_class_methods_spec.rb

@@ -0,0 +1,32 @@
+#encoding: utf-8
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+include Nudge
+
+
+describe NudgeProgram do
+  describe "#random" do
+    it "should return a new random-code program, given no params" do
+      lambda{NudgeProgram.random}.should_not raise_error
+      NudgeProgram.random.should be_a_kind_of(NudgeProgram)
+    end
+    
+    it "should use the 'global' defaults as needed" do
+      NudgeProgram.random.points.should == 20
+      Instruction.should_receive(:all_instructions).at_least(1).times.and_return([IntAddInstruction])
+      NudgeType.should_receive(:all_types).at_least(1).times.and_return([IntType])
+      NudgeProgram.random
+    end
+    
+    it "should accept an overridden_parameters Hash" do
+      NudgeProgram.random(target_size_in_points:30).points.should == 30
+      NudgeProgram.random(probabilities: {b:10, r:0, v:0, i:0}).blueprint.
+        scan("block").length.should == 20 # there should be 20 occurrences of 'block' only!
+      NudgeProgram.random(reference_names:["x"], probabilities: {b:0, r:10, v:0, i:0}).blueprint.
+        scan("ref x").length.should == 19 # there should be 19 occurrences of 'ref x' in a wrapper
+      NudgeProgram.random(type_names:["foo"], probabilities: {b:0, r:0, v:10, i:0}).blueprint.
+        scan("foo").length.should == 38 # there should be 19 occurrences of 'value «foo»', plus fn's
+      NudgeProgram.random(instruction_names:["bool_xor"], probabilities: {b:0, r:0, v:0, i:10}).blueprint.
+        scan("bool_xor").length.should == 19 # there should be 19 occurrences of 'do bool_xor'
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Bill Tozier
@@ -16,8 +16,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-27 00:00:00 -04:00
-default_executable: 
+date: 2010-03-28 00:00:00 -04:00
+default_executable: nudge
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: treetop
@@ -49,8 +49,8 @@ dependencies:
   version_requirements: *id002
 description: Provides a Ruby library & CLI implementing a flexible Nudge Language interpreter, plus a set of generators for adding domain-specific instructions and types.
 email: bill@vagueinnovation.com
-executables: []
-
+executables: 
+- nudge
 extensions: []
 
 extra_rdoc_files: 
@@ -60,6 +60,8 @@ files:
 - LICENSE.txt
 - Rakefile
 - VERSION
+- bin/nudge
+- lib/cli/runner.rb
 - lib/instructions/bool/bool_and.rb
 - lib/instructions/bool/bool_define.rb
 - lib/instructions/bool/bool_depth.rb
@@ -232,6 +234,7 @@ files:
 - lib/interpreter/types/pushTypes.rb
 - lib/nudge.rb
 - readme.md
+- spec/command_line/command_line_spec.rb
 - spec/fixtures/just_block.example
 - spec/fixtures/just_block_with_newline.example
 - spec/fixtures/long_arithmetic.example
@@ -369,6 +372,7 @@ files:
 - spec/interpreter/instruction_spec.rb
 - spec/interpreter/interpreter_spec.rb
 - spec/interpreter/nil_point_spec.rb
+- spec/interpreter/nudge_program_class_methods_spec.rb
 - spec/interpreter/nudge_program_spec.rb
 - spec/interpreter/reference_point_spec.rb
 - spec/interpreter/stack_spec.rb
@@ -411,6 +415,7 @@ signing_key:
 specification_version: 3
 summary: Nudge Language interpreter
 test_files: 
+- spec/command_line/command_line_spec.rb
 - spec/instructions/bool/bool_and_spec.rb
 - spec/instructions/bool/bool_define_spec.rb
 - spec/instructions/bool/bool_depth_spec.rb
@@ -542,6 +547,7 @@ test_files:
 - spec/interpreter/instruction_spec.rb
 - spec/interpreter/interpreter_spec.rb
 - spec/interpreter/nil_point_spec.rb
+- spec/interpreter/nudge_program_class_methods_spec.rb
 - spec/interpreter/nudge_program_spec.rb
 - spec/interpreter/reference_point_spec.rb
 - spec/interpreter/stack_spec.rb