nudge 0.2.6 → 0.2.7

data/lib/instructions/name/name_disable_lookup.rb

@@ -1,3 +1,14 @@
+# Sets the value of the context attribute Interpreter#evaluate_references to false.
+# This will persist until the next time the Interpreter evaluates a ReferencePoint;
+# instead of attempting to look up the variable or name referred to by the ReferencePoint,
+# it will instead push the ReferencePoint onto the +:name+ stack.
+#
+# needs: nothing
+#
+# pushes: nothing
+#
+#
+#
 class NameDisableLookupInstruction < Instruction
   def preconditions?
     true

data/lib/instructions/name/name_duplicate.rb

@@ -1,3 +1,10 @@
+# makes and pushes a clone of the top item on the +:name+ stack
+#
+# *needs:* 1 +:name+
+#
+# *pushes:* 1 +:name+
+#
+
 class NameDuplicateInstruction < Instruction
   include DuplicateInstruction
   def initialize(context)

data/lib/instructions/name/name_equal_q.rb

@@ -1,3 +1,11 @@
+# pops the top 2 items of the +:name+ stack;
+# pushes a new ValuePoint onto the +:bool+ stack, with value +true+ if the names are identical
+#
+# *needs:* 2 +:name+
+#
+# *pushes:* 1 +:bool+
+#
+
 class NameEqualQInstruction < Instruction
   def preconditions?
     needs :name, 2

data/lib/instructions/name/name_flush.rb

@@ -1,3 +1,6 @@
+# deletes all items from the +:name+ stack
+#
+
 class NameFlushInstruction < Instruction
   include FlushInstruction
   def initialize(context)

data/lib/instructions/name/name_next.rb

@@ -1,3 +1,10 @@
+# Creates and pushes a new ReferencePoint onto the +:name+ stack. The name itself
+# will be a new string, obtained by invoking the context's Interpreter#next_name method.
+#
+# needs: nothing
+#
+# pushes: 1 +:name+
+
 class NameNextInstruction < Instruction
   def preconditions?
     true

data/lib/instructions/name/name_pop.rb

@@ -1,3 +1,6 @@
+# pops (and discards) the topmost item from the +:name+ stack
+#
+
 class NamePopInstruction < Instruction
   include PopInstruction
   def initialize(context)

data/lib/instructions/name/name_random_bound.rb

@@ -1,3 +1,12 @@
+# Creates a new ReferencePoint and pushes it onto the +:name+ stack.
+# The name will be randomly sampled (with uniform probability) from the union of all
+# currently bound variables and names.
+#
+# needs: at least one bound variable or name
+#
+# pushes: 1 +:name+
+#
+
 class NameRandomBoundInstruction < Instruction
   def preconditions?
     @context.references.length > 0

data/lib/instructions/name/name_rotate.rb

@@ -1,3 +1,14 @@
+# pops the top 3 items of the +:name+ stack;
+# pushes them back in _rotated_ order
+# 
+# If they were A, B and C (with C originally at the top of the stack)
+# the result will be B, C, A (with A at the top)
+#
+# *needs:* 3 +:name+
+#
+# *pushes:* 3 +:name+
+#
+
 class NameRotateInstruction < Instruction
   include RotateInstruction
   def initialize(context)

data/lib/instructions/name/name_shove.rb

@@ -1,3 +1,17 @@
+# pops the top items of the +:name+ and +:int+ stacks;
+# pushes the +:name+ down "into" the stack, at a level determined by the +:int+ "destination" value.
+# 
+# If the destination value is negative or 0, the item stays on top;
+# if the destination value is greater than or equal to the depth of the stack, the item goes to the bottom;
+# otherwise, the item is inserted farther from the stack's top as the destination value increases.
+# 
+# note: the destination depth is calculated after the items have been popped
+#
+# *needs:* 1 +:name+, 1 +:int+
+#
+# *pushes:* 1 +:name+ (sortof)
+#
+
 class NameShoveInstruction < Instruction
   include ShoveInstruction
   def initialize(context)

data/lib/instructions/name/name_swap.rb

@@ -1,3 +1,6 @@
+# exchanges the position of the top 2 items on the +:name+ stack
+#
+
 class NameSwapInstruction < Instruction
   include SwapInstruction
   def initialize(context)

data/lib/instructions/name/name_unbind.rb

@@ -1,3 +1,10 @@
+# Pops the top +:name+ item, and if it is bound to a name (a local, not a variable)
+# it removes that binding.
+#
+# needs: 1 +:name+
+#
+# pushes: nothing
+
 class NameUnbindInstruction < Instruction
   def preconditions?
     needs :name,1

data/lib/instructions/name/name_yank.rb

@@ -1,3 +1,15 @@
+# pops the top item of the +:int+ stack (the "index");
+# then repositions an item from down "inside" the +:name+ stack to its top.
+# 
+# If the index value is negative or 0, the bottom item on the stack is moved;
+# if the index value is greater than or equal to the depth of the stack, there is no change;
+# otherwise, the index value refers to the bottom-to-top order of stack items.
+#
+# *needs:* 1 +:int+, 1 +:name+
+#
+# *pushes:* 1 +:name+ (sortof)
+#
+
 class NameYankInstruction < Instruction
   include YankInstruction
   def initialize(context)

data/lib/instructions/name/name_yankdup.rb

@@ -1,3 +1,15 @@
+# pops the top item of the +:int+ stack (the "index");
+# pushes a duplicate of an item from down "inside" the +:name+ stack to its top.
+# 
+# If the index value is negative or 0, the bottom item on the stack is copied;
+# if the index value is greater than or equal to the depth of the stack, the top item is copied;
+# otherwise, the index value refers to the bottom-to-top order of stack items.
+#
+# *needs:* 1 +:int+, 1 +:name+
+#
+# *pushes:* 1 +:name+ (sortof)
+#
+
 class NameYankdupInstruction < Instruction
   include YankdupInstruction
   def initialize(context)

data/spec/instructions/code/code_nth_cdr_spec.rb

@@ -59,13 +59,21 @@ describe CodeNthCdrInstruction do
         @context.stacks[:code].peek.value.should == "block {}"
       end
       
-      it "should wrap a non-codeblock point and just return it" do
-        @context.stacks[:int].push(ValuePoint.new("int", 12))
+      it "should wrap a non-codeblock point and just return it if the index is less than 1" do
+        @context.stacks[:int].push(ValuePoint.new("int", -12))
         @context.stacks[:code].push(ValuePoint.new("code", "do x1"))
         @i1.go
         @context.stacks[:code].peek.value.should == "block {\n  do x1}"
       end
       
+      it "should return an empty block if the index is positive" do
+        @context.stacks[:int].push(ValuePoint.new("int", 12))
+        @context.stacks[:code].push(ValuePoint.new("code", "do x1"))
+        @i1.go
+        @context.stacks[:code].peek.value.should == "block {}"
+      end
+      
+      
       it "should not remove anything if the int % length == 0" do
         @context.stacks[:int].push(ValuePoint.new("int", -921231)) # => 0
         @context.stacks[:code].push(ValuePoint.new("code", "block {ref a ref b ref c}"))

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 6
-  version: 0.2.6
+  - 7
+  version: 0.2.7
 platform: ruby
 authors: 
 - Bill Tozier
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-30 00:00:00 -04:00
+date: 2010-05-02 00:00:00 -04:00
 default_executable: nudge
 dependencies: 
 - !ruby/object:Gem::Dependency