butterfly_net 0.0.4 → 0.0.5

data/lib/butterfly_net.rb

@@ -1,4 +1,5 @@
 require 'butterfly_net/file_writer'
+require 'butterfly_net/definitions'
 require 'butterfly_net/test_unit_method'
 require 'butterfly_net/test_unit_adapter'
 require 'butterfly_net/rails_test_unit_adapter'

data/lib/butterfly_net/commands.rb

@@ -11,9 +11,9 @@ module ButterflyNet
   module Commands
 
     def bn_open(file_name=nil)
-      @file_writer.close if @file_writer
-      @file_writer = ReadlineReader.new(file_name)
-      Kernel.at_exit { puts @file_writer.close if @file_writer; @file_writer = nil }
+      @readline_reader.close if @readline_reader
+      @readline_reader = ReadlineReader.new(file_name)
+      Kernel.at_exit { puts @readline_reader.close if @readline_reader; @readline_reader = nil }
       true
     rescue Exception => e
       puts e
@@ -22,9 +22,9 @@ module ButterflyNet
     end
 
     def bn_close
-      if @file_writer
-        status = @file_writer.close
-        @file_writer = nil
+      if @readline_reader
+        status = @readline_reader.close
+        @readline_reader = nil
         status
       else
         puts "butterfly_net: First invoke 'bn' or 'bn_open' to begin a session"
@@ -33,8 +33,8 @@ module ButterflyNet
     end
 
     def bn_method(method_name=nil)
-      if @file_writer
-        @file_writer.new_assertion_set(method_name)
+      if @readline_reader
+        @readline_reader.new_assertion_set(method_name)
       else
         puts "butterfly_net: First invoke 'bn' or 'bn_open' to begin a session"
         false

data/lib/butterfly_net/definitions.rb

@@ -0,0 +1,44 @@
+module ButterflyNet
+  class Definitions
+
+    attr_reader :lines
+
+    def initialize
+      @nesting_level = 0
+      @lines = []
+    end
+
+    def empty?
+      @lines.empty?
+    end
+
+    def self.start_def?(line)  # todo: extract to line class
+      line =~ /^\s*def\s+|^\s*class\s+|^\s*module\s+/
+    end
+
+    def self.end_def?(line)  # todo: extract to line class
+      line =~ /end\s*$/
+    end
+
+    def <<(line)
+      if Definitions.start_def?(line) and Definitions.end_def?(line)
+        @lines << "  #{("  " * @nesting_level)}#{line}\n\n"
+      elsif Definitions.start_def?(line)
+        @nesting_level += 1
+        @lines << "#{("  " * @nesting_level)}#{line}\n"
+      elsif Definitions.end_def?(line)
+        @nesting_level -= 1
+        @lines << "  #{("  " * @nesting_level)}#{line}\n#{ @nesting_level == 0 ? "\n" : ""}"
+      elsif @nesting_level > 0
+        @lines << "  #{("  " * @nesting_level)}#{line}\n"  unless @nesting_level == 0
+      else
+        false
+      end
+    end
+
+    def to_s
+      @lines.join
+    end
+    
+  end
+end

data/lib/butterfly_net/test_unit_method.rb

@@ -2,14 +2,27 @@ module ButterflyNet
   class TestUnitMethod
 
     attr_accessor :name
+    attr_reader :definitions, :lines
 
     def initialize
-      @commands = []
-      @definitions = []
+      @commands = []       # todo: merge these 2 arrays in to single array of 2element pairs
+      @lines = []
+      @definitions = Definitions.new
     end
 
     def <<(line)
-      @commands << line
+      unless @definitions << line
+        begin
+          code = @definitions.to_s + @commands.join("\n") + "\n" + line
+          retval = eval code
+          @commands << line    # todo replace def handling below with definitions (work in progress)
+          @lines << final_line_string(line, retval)
+        rescue Exception
+          @commands << "# #{line}   # butterfly_net: Could not evaluate."
+          @lines << "  # #{line}   # butterfly_net: Could not evaluate."
+        end
+      end
+      self
     end
 
     def empty?
@@ -25,57 +38,12 @@ module ButterflyNet
       line =~ /require\s*['|"]\w+['|"]|[^=<>!*%\/+-\\|&]=[^=~]/
     end
 
-    def self.start_def?(line)  # todo: extract to line class
-      line =~ /^\s*def\s+|^\s*class\s+|^\s*module\s+/
-    end
-
-    def self.end_def?(line)  # todo: extract to line class
-      line =~ /end\s*$/
-    end
-
     def text
-      purge_bad_commands
-      before_test_method = ""
-      lines_string = ""
-      nesting_level = 0
-      @commands.each_with_index do |current_line, i|
-        if TestUnitMethod.start_def?(current_line) and TestUnitMethod.end_def?(current_line)
-          before_test_method += "  #{("  " * nesting_level)}#{current_line}\n\n"
-        elsif TestUnitMethod.start_def?(current_line)
-          nesting_level += 1
-          before_test_method += "#{("  " * nesting_level)}#{current_line}\n"
-        elsif TestUnitMethod.end_def?(current_line)
-          nesting_level -= 1
-          before_test_method += "  #{("  " * nesting_level)}#{current_line}\n#{ nesting_level == 0 ? "\n" : ""}"
-        elsif nesting_level == 0
-          text = assertion(i)
-          lines_string += "    #{text}\n" if text
-        else
-          before_test_method += "  #{("  " * nesting_level)}#{current_line}\n"
-        end
-      end
-      before_test_method += "  "
-      lines_string.empty? ? nil : "#{before_test_method}def #{@name}\n#{lines_string}  end\n\n"
+      lines_string = @lines.inject("") {|result, e| result += "    #{e}\n" if e; result}
+      lines_string.empty? ? nil : "#{@definitions.to_s}  def #{@name}\n#{lines_string}  end\n\n"
     end
 
-    def assertion(current_i)
-
-      current_line = @commands[current_i]
-      commands = current_line
-      start_i = current_i
-
-      begin
-        retval = eval commands
-      rescue Exception
-        start_i -= 1
-        commands = @commands[start_i..current_i].join("\n")
-
-        if start_i < 0
-          return nil    # give up, can't go further back
-        else
-          retry
-        end
-      end
+    def final_line_string(current_line, retval)
       if TestUnitMethod.assignment_or_require?(current_line)
         current_line
       elsif instances_equal_by_value?(retval) # expression result supports value equality
@@ -87,13 +55,10 @@ module ButterflyNet
         else
           "assert_equal(#{retval.inspect}, #{current_line})"
         end
-
       else
-
         # any other sort of object is handled as a not equal assertion
-        "assert_not_equal((#{current_line}), #{current_line})"    # todo assert_not_nil in some cases?
+        "assert_not_nil(#{current_line})"    # todo assert_not_nil in some cases?
       end
-
     end
 
     def instances_equal_by_value?(instance)
@@ -102,40 +67,6 @@ module ButterflyNet
 
     private
 
-#    def extract_definitions         # work in progress, todo: handle definitions separately, place at top of file
-#      @commands.each_with_index do |current_line, i|
-#        if TestUnitMethod.start_def?(current_line) or TestUnitMethod.end_def?(current_line)
-#          @definitions << current_line
-#        end
-#      end
-#    end
-
-    def purge_bad_commands
-      begin
-        commands = ""
-        index = 0
-        nesting_level = 0
-        @commands.each_with_index do |current_line, i|
-          index = i
-          commands += current_line + "\n"
-          if TestUnitMethod.start_def?(current_line) and TestUnitMethod.end_def?(current_line)
-            #let it ride
-          elsif TestUnitMethod.start_def?(current_line)
-            nesting_level += 1
-          elsif TestUnitMethod.end_def?(current_line)
-            nesting_level -= 1
-          elsif nesting_level == 0
-            eval commands  #todo write tests breaking assumption that definitions are valid code, and impl separate eval's for definitions
-          end
-        end
-        nil
-      rescue Exception
-        # delete offender and start again from the beginning
-        @commands.delete_at index      # todo: test if string equality is safe for delete()
-        retry
-      end
-    end
-
     # Adapted from ActiveSupport Inflector
     def underscore(name)
       name.to_s.strip.
@@ -146,7 +77,5 @@ module ButterflyNet
               downcase
     end
 
-
-
   end
 end

data/test/butterfly_net_tests.rb

@@ -1,5 +1,6 @@
 require "test/unit"
 $: << File.expand_path(File.dirname(__FILE__))
 $: << File.join(File.expand_path(File.dirname(__FILE__)), File.join("..", "lib"))
+require "definitions_test"
 require "test_unit_method_test"
 require "test_case_test"

data/test/definitions_test.rb

@@ -0,0 +1,77 @@
+require "test/unit"
+$: << File.expand_path(File.dirname(__FILE__))
+$: << File.join(File.expand_path(File.dirname(__FILE__)), File.join("..", "lib"))
+require "butterfly_net/definitions"
+
+class DefinitionsTest < Test::Unit::TestCase
+  include ButterflyNet
+
+  def setup
+    @definitions = Definitions.new
+  end
+
+
+  def test_method_def_true_whitespace
+    assert Definitions.start_def?(" def timestwo(i); i * 2; end ")
+  end
+
+  def test_class_def_true_whitespace
+    assert Definitions.start_def?(" class MyClass; end ")
+  end
+
+  def test_class_def_true_whitespace
+    assert Definitions.start_def?(" module MyModule; end ")
+  end
+
+  def test_method_def_false_variable
+    assert !Definitions.start_def?("definite == true ")
+  end
+
+
+  def test_start_def_true_inline
+    assert Definitions.start_def?(" def timestwo(i); i * 2; end ")
+  end
+
+  def test_end_def_true_inline
+    assert Definitions.end_def?(" def timestwo(i); i * 2; end ")
+  end
+
+  def test_end_def_true_whitespace
+    assert Definitions.end_def?(" end ")
+  end
+
+  def test_definitions_inline
+    line = "def timestwo(i); i * 2; end"
+    @definitions << line
+    assert @definitions.lines.include?("  def timestwo(i); i * 2; end\n\n")
+  end
+
+  def test_definitions_class_empty
+    line = "class MyClass"
+    line2 = "end"
+    @definitions << line
+    @definitions << line2
+    assert_equal(["  class MyClass\n", "  end\n\n"], @definitions.lines)
+  end
+
+  def test_to_s_method_inline
+    @definitions << "def timestwo(i); i * 2; end"
+    assert_equal("  def timestwo(i); i * 2; end\n\n", @definitions.to_s)
+  end
+
+  def test_to_s_class_with_method
+    @definitions << "class MyClass"
+    @definitions << "def name"
+    @definitions << "\"classy\""
+    @definitions << "end"
+    @definitions << "end"
+    assert_equal "  class MyClass\n    def name\n      \"classy\"\n    end\n  end\n\n", @definitions.to_s
+  end
+
+# todo write tests breaking assumption that definitions are valid code, and impl separate eval's for definitions
+#  def test_text_bad_input_constant
+#    @definitions << "BADCONSTANT"
+#    assert_equal "  # BADCONSTANT # NameError: uninitialized constant BADCONSTANT", @definitions.to_s
+#  end
+
+end

data/test/test_case_test.rb

@@ -2,6 +2,7 @@ require "test/unit"
 $: << File.expand_path(File.dirname(__FILE__))
 $: << File.join(File.expand_path(File.dirname(__FILE__)), File.join("..", "lib"))
 require "butterfly_net/file_writer"
+require "butterfly_net/definitions"
 require "butterfly_net/test_unit_method"
 require "butterfly_net/test_unit_adapter"
 require "butterfly_net/rails_test_unit_adapter"
@@ -105,7 +106,7 @@ class TestCaseTest < Test::Unit::TestCase
   def test_test_methods_bad_input
     @adapter.add_command("BADCOMMAND")
     @adapter.close_assertion_set
-    assert_nil @adapter.test_methods.first
+    assert_equal "  def test_1\n      # BADCOMMAND   # butterfly_net: Could not evaluate.\n  end\n\n", @adapter.test_methods.first
   end
   
   def test_create_file

data/test/test_unit_method_test.rb

@@ -1,6 +1,7 @@
 require "test/unit"
 $: << File.expand_path(File.dirname(__FILE__))
 $: << File.join(File.expand_path(File.dirname(__FILE__)), File.join("..", "lib"))
+require "butterfly_net/definitions"
 require "butterfly_net/test_unit_method"
 
 class TestUnitMethodTest < Test::Unit::TestCase
@@ -111,35 +112,6 @@ class TestUnitMethodTest < Test::Unit::TestCase
     assert !TestUnitMethod.assignment_or_require?("a *= 1")
   end
 
-  def test_method_def_true_whitespace
-    assert TestUnitMethod.start_def?(" def timestwo(i); i * 2; end ")
-  end
-
-  def test_class_def_true_whitespace
-    assert TestUnitMethod.start_def?(" class MyClass; end ")
-  end
-
-  def test_class_def_true_whitespace
-    assert TestUnitMethod.start_def?(" module MyModule; end ")
-  end
-
-  def test_method_def_false_variable
-    assert !TestUnitMethod.start_def?("definite == true ")
-  end
-
-
-  def test_start_def_true_inline
-    assert TestUnitMethod.start_def?(" def timestwo(i); i * 2; end ")
-  end
-
-  def test_end_def_true_inline
-    assert TestUnitMethod.end_def?(" def timestwo(i); i * 2; end ")
-  end
-
-  def test_end_def_true_whitespace
-    assert TestUnitMethod.end_def?(" end ")
-  end
-
   def test_name_uppercase
     @method.name = "MYMETHOD"
     assert_equal("test_mymethod", @method.name)
@@ -172,7 +144,7 @@ class TestUnitMethodTest < Test::Unit::TestCase
 
 
 
-#  def test_text_split_statements_into_lines      todo
+#  def test_text_split_expressions_into_lines      todo
 #    @method << "a = 1; a + 1"
 #    assert_equal "def test_1\n    a = 1\n    assert_equal(2, a + 1)\n  end", @method.text
 #  end
@@ -181,14 +153,14 @@ class TestUnitMethodTest < Test::Unit::TestCase
     @method << "a = 1"
     @method << "2b" # syntax error, unexpected tIDENTIFIER, expecting $end
     @method << "a += 1"
-    assert_equal "  def test_1\n    a = 1\n    assert_equal(2, a += 1)\n  end\n\n", @method.text
+    assert_equal "  def test_1\n    a = 1\n      # 2b   # butterfly_net: Could not evaluate.\n    assert_equal(2, a += 1)\n  end\n\n", @method.text
   end
 
   def test_purge_unexpected_identifiers
     @method << "a += 1"  # undefined method `+' for nil:NilClass
     @method << "a = 1"
     @method << "a += 1"
-    assert_equal "  def test_1\n    a = 1\n    assert_equal(2, a += 1)\n  end\n\n", @method.text
+    assert_equal "  def test_1\n      # a += 1   # butterfly_net: Could not evaluate.\n    a = 1\n    assert_equal(2, a += 1)\n  end\n\n", @method.text
   end
 
   def test_text_require
@@ -201,68 +173,68 @@ class TestUnitMethodTest < Test::Unit::TestCase
   def test_expected_boolean
     line = "1 == 1"
     @method << line
-    assert_equal("assert(#{line})", @method.assertion(0))
+    assert_equal("assert(#{line})", @method.lines[0])
   end
 
   def test_assertion_fixnum
     line = "1"
     @method << line
-    assert_equal("assert_equal(#{line}, #{line})", @method.assertion(0))
+    assert_equal("assert_equal(#{line}, #{line})", @method.lines[0])
   end
 
   def test_assertion_boolean_false
     line = "1 != 1"
     @method << line
-    assert_equal("assert_equal(false, #{line})", @method.assertion(0))
+    assert_equal("assert_equal(false, #{line})", @method.lines[0])
   end
 
   def test_array_add
     @method << "a = []"
     line2 = "a << \"1\""
     @method << line2
-    assert_equal("assert_equal([\"1\"], #{line2})", @method.assertion(1))
+    assert_equal("assert_equal([\"1\"], #{line2})", @method.lines[1])
   end
 
   def test_butterfly_net
     @method << "method = TestUnitMethod.new"
     @method << "method << \"1 + 1\""
-    assert_equal("assert_equal([\"1 + 1\"], method << \"1 + 1\")", @method.assertion(1))
+    assert_equal("assert_not_nil(method << \"1 + 1\")", @method.lines[1])
   end
 
   def test_assertion_boolean
     line = "1 == 1"
     @method << line
-    assert_equal("assert(#{line})", @method.assertion(0))
+    assert_equal("assert(#{line})", @method.lines[0])
   end
 
   def test_assertion_string
     line = "'a' + 'b'"
     @method << line
-    assert_equal("assert_equal(\"ab\", #{line})", @method.assertion(0))
+    assert_equal("assert_equal(\"ab\", #{line})", @method.lines[0])
   end
 
   def test_assertion_nil
     line = "[].first"
     @method << line
-    assert_equal("assert_nil(#{line})", @method.assertion(0))
+    assert_equal("assert_nil(#{line})", @method.lines[0])
   end
 
   def test_assertion_boolean
     line = "1 == 1"
     @method << line
-    assert_equal("assert(#{line})", @method.assertion(0))
+    assert_equal("assert(#{line})", @method.lines[0])
   end
 
   def test_assertion_object_not_equal
     line = "Object.new"
     @method << line
-    assert_equal("assert_not_equal((#{line}), #{line})", @method.assertion(0))
+    assert_equal("assert_not_nil(#{line})", @method.lines[0])
   end
 
   def test_assertion_array
     line = "([1,2,3])[0..0]"
     @method << line
-    assert_equal("assert_equal([1], #{line})", @method.assertion(0))
+    assert_equal("assert_equal([1], #{line})", @method.lines[0])
   end
 
   def test_text_def_method_single_line
@@ -272,10 +244,10 @@ class TestUnitMethodTest < Test::Unit::TestCase
     assert_equal("  def timestwo(i); i * 2; end\n\n  def test_1\n    assert_equal(4, #{line})\n  end\n\n", @method.text)
   end
 
-  def test_assertion_illegal_input
+  def test_text_illegal_input
     line = "badtext"
     @method << line
-    assert_nil @method.assertion(0)
+    assert_equal "  def test_1\n      # badtext   # butterfly_net: Could not evaluate.\n  end\n\n", @method.text
   end
 
   def test_text
@@ -289,17 +261,17 @@ class TestUnitMethodTest < Test::Unit::TestCase
     assert_equal "  def test_1\n    #{line}\n  end\n\n", @method.text
   end
 
-  def test_extract_definitions_class_multiline_empty
+  def test_definitions_class_multiline_empty
     line = "class MyClass"
     line2 = "end"
     line3 = "MyClass.new"
     @method << line
     @method << line2
     @method << line3
-    assert_equal "  #{line}\n  #{line2}\n\n  def test_1\n    assert_not_equal((#{line3}), #{line3})\n  end\n\n", @method.text
+    assert_equal "  #{line}\n  #{line2}\n\n  def test_1\n    assert_not_nil(#{line3})\n  end\n\n", @method.text
   end
 
-  def test_extract_definitions_class_with_method
+  def test_definitions_class_with_method
     @method << "class MyClass"
     @method << "def name"
     @method << "\"classy\""
@@ -311,8 +283,11 @@ class TestUnitMethodTest < Test::Unit::TestCase
 
   def test_text_bad_input_constant
     @method << "BADCONSTANT"
-    assert_nil @method.text
+    assert_equal "  def test_1\n      # BADCONSTANT   # butterfly_net: Could not evaluate.\n  end\n\n", @method.text
   end
+
+
+
   # non-project tests (scratchpad)
 
   def test_eval_scope

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: butterfly_net
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Chris Smith
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-24 00:00:00 -07:00
+date: 2010-03-01 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -24,6 +24,7 @@ extra_rdoc_files: []
 files: 
 - README.md
 - lib/butterfly_net/commands.rb
+- lib/butterfly_net/definitions.rb
 - lib/butterfly_net/file_writer.rb
 - lib/butterfly_net/rails_test_unit_adapter.rb
 - lib/butterfly_net/readline_reader.rb
@@ -32,6 +33,7 @@ files:
 - lib/butterfly_net/test_unit_method.rb
 - lib/butterfly_net.rb
 - test/butterfly_net_tests.rb
+- test/definitions_test.rb
 - test/test_case_test.rb
 - test/test_unit_method_test.rb
 has_rdoc: true
@@ -61,6 +63,6 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: IRB and Rails console history captured as Test::Unit tests. (RSpec and others hopefully soon to come.)
+summary: IRB and Rails console history captured as Test::Unit tests.
 test_files: 
 - test/butterfly_net_tests.rb