butterfly_net 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,169 @@
+Butterfly Net
+=============
+
+[Home page and source]: http://butterflynet.org
+[Rubygems page]: http://rubygems.org/gems/butterfly_net
+
+Author: Chris Smith (quartzmo -at- gmail.com)
+
+
+## DESCRIPTION
+
+IRB and Rails console history captured as Test::Unit tests. (RSpec and others hopefully soon to come.)
+
+
+## INSTALL
+
+Butterfly Net is available as a gem from rubygems.org (http://rubygems.org/gems/butterfly_net), or as source from
+butterflynet.org.
+
+    sudo gem install butterfly_net
+
+To automatically require Butterfly Net on every IRB session, add the following to your ~/.irbrc:
+
+    require 'rubygems'
+    require 'butterfly_net'
+
+
+## USAGE
+
+### Command methods
+
+The following commands can be used in any IRB-based console.
+
+* bn, bn_open- Open a new test case, closing the current test case if one exists. Args: file_name:string (optional; '.rb' will appended if needed)
+* bnc, bn_close  - Close the active test case, and write the output to a file.
+* m, bn_method   - Close the current test method (or block), naming it with the arg method_name:string (optional)
+
+### Example Usage in IRB
+
+    $ irb
+    irb(main):001:0> bn 'irb_tests'
+    => true
+    irb(main):002:0> a = 1
+    => 1
+    irb(main):003:0> a += 2
+    => 3
+    irb(main):004:0> m 'plusequals'
+    => true
+    irb(main):005:0> require 'bigdecimal'
+    => true
+    irb(main):006:0> infinity = BigDecimal('Infinity')
+    => #<BigDecimal:114ed34,'Infinity',4(4)>
+    irb(main):007:0> BigDecimal.new("1.0") / BigDecimal.new("0.0") == infinity
+    => true
+    irb(main):008:0> m 'bigdecimal_infinity'
+    => true
+    irb(main):009:0> exit
+    butterfly_net: irb_tests.rb closed
+    true
+    $ cat irb_tests.rb
+    require "test/unit"
+
+    # IRB test capture courtesy of butterfly_net (butterflynet.org)
+    class MyTest < Test::Unit::TestCase
+
+      def test_plusequals
+        a = 1
+        assert_equal(3, a += 2)
+      end
+
+      def test_bigdecimal_infinity
+        require 'bigdecimal'
+        infinity = BigDecimal('Infinity')
+        assert(BigDecimal.new("1.0") / BigDecimal.new("0.0") == infinity)
+      end
+
+    end
+    $ ruby irb_tests.rb
+    Loaded suite irb_tests
+    Started
+    ..
+    Finished in 0.001603 seconds.
+
+    2 tests, 2 assertions, 0 failures, 0 errors
+
+
+### Ruby on Rails console
+
+For repeatable tests, be sure to load the Rails test environment with "./script/console test".
+In a Rails project, you can run all tests with the standard rake command 'rake test',
+or an individual test by adding the test directory to the path with the option -I when you invoke Ruby.
+
+    chris$ ./script/console test
+    Loading test environment (Rails 2.3.4)
+    >> bn "test/unit/person_console_test"
+    . . .
+    >> Person.count
+    => 2
+    >> exit
+    . . .
+    chris$ ruby -Itest test/unit/person_console_test.rb
+    . . .
+    1 tests, 1 assertions, 0 failures, 0 errors
+
+
+## KNOWN ISSUES
+
+This section covers issues which may not be resolved quickly. Feel free to lend a hand!
+
+### Object inspect output
+
+Butterfly Net relies on an expectation value responding with valid Ruby code to the inspect method, which is the case for core
+classes such as Hash and Array. However, it's not the case with most classes, many of which respond with the familiar
+#<...> notation, which can't be interpreted.
+
+For example:
+
+    assert_equal(#<BigDecimal:11511d8,'Infinity',4(24)>, BigDecimal.new("1.0") / BigDecimal.new("0.0"))  # doesn't work
+
+The workaround is to assign expected values to a variable. Of course, you have to know what to expect in order to do this, 
+which may take a few tries. Sorry.
+
+
+### Inline variable assignment
+
+Butterfly Net tries to detect simple assignments, such as "a = 1", in order to write them out clearly,
+without enclosing assertions. In some cases this causes it to miss statements that should be tested.
+
+For example:
+
+    irb(main):002:0> a = 1; a + 1
+    => 2
+    irb(main):003:0> "a=1".split('=')
+    => ["a", "1"]
+
+results in
+
+    def test_1
+      a = 1; a + 1  # should have been a = 1; assert_equal(2, a + 1)
+      "a=1".split('=')  # should have been assert_equal(["a", "1"],"a=1".split('='))
+    end
+
+In order to avoid this issue, just put assignments (and anything that looks like an assignment) on separate lines.
+
+
+## LICENSE
+
+The MIT License
+
+Copyright (c) 2010 Chris Smith
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/butterfly_net/commands.rb

@@ -21,8 +21,9 @@ module ButterflyNet
       file_name += ".rb" unless file_name =~ /.rb$/
       @file = FileWriter.new(file_name, start_index)
       Kernel.at_exit { puts @file.close if @file; @file = nil }
-      puts "butterfly_net: #{file_name} opened at Readline::HISTORY ##{start_index}"
       true
+    rescue
+      false
     end
 
     def bn_close
@@ -37,9 +38,20 @@ module ButterflyNet
       end
     end
 
+    def bn_method(method_name=nil)
+      check_for_readline
+      if @file
+        @file.new_assertion_set(method_name)
+      else
+        puts "butterfly_net: First invoke 'bn' or 'bn_open' to begin a session"
+        false
+      end
+    end
+
 
     alias :bn :bn_open
     alias :bnc :bn_close
+    alias :m :bn_method
 
     private
 

data/lib/butterfly_net/file_writer.rb

@@ -7,33 +7,60 @@ module ButterflyNet
     def initialize(file_name, start_index)
       @file_name = file_name
       @start_index = start_index
+      @adapter = TestUnitAdapter.new
     end
 
-    def new_assertion_set
-
-    end
-
-
-    def close
+    def new_assertion_set(method_name)
       lines = Readline::HISTORY.to_a
       @end_index ||= Readline::HISTORY.size - 3 # in case of no call to 'bn_close'
       if @end_index < 0 || lines[@start_index..@end_index].empty?
-        puts "butterfly_net: #{@file_name} closed, no file written to disk"
         false
       else
-        adapter = TestUnitAdapter.new
+
 
         lines[@start_index..@end_index].each do |line|
-          adapter.add_command(line)
+          @adapter.add_command(line)
         end
 
-        adapter.create_file(@file_name)
+        @adapter.close_assertion_set(method_name)
+        @start_index = Readline::HISTORY.size - 1
+        @end_index = nil
 
-        puts "butterfly_net: #{@file_name} closed after Readline::HISTORY ##{@end_index}"
         true
       end
-    rescue Exception => msg
-      puts "butterfly_net:  Error generating tests: #{msg}"
+    rescue Exception => e
+      puts "butterfly_net:  Error generating tests: #{e}"
+      puts e.backtrace
+      false
+    end
+
+
+    def close
+      lines = Readline::HISTORY.to_a
+      @end_index ||= Readline::HISTORY.size - 3 # in case of no call to 'bn_close'
+#      if @adapter.empty?
+#        puts "butterfly_net: #{@file_name} closed, no file written to disk."
+#
+#        false
+#
+#      else
+        if @end_index < 0 || lines[@start_index..@end_index].empty?
+          puts "butterfly_net: #{@file_name} closed"
+        else
+          lines[@start_index..@end_index].each do |line|
+            @adapter.add_command(line)
+          end
+          puts "butterfly_net: #{@file_name} closed, with #{@end_index - @start_index + 1} lines, from '#{lines[@start_index]}' to '#{lines[@end_index]}'"
+
+        end
+
+        @adapter.create_file(@file_name)
+
+        true
+  #    end
+    rescue Exception => e
+      puts "butterfly_net:  Error generating tests: #{e}"
+      puts e.backtrace
       false
     end
 

data/lib/butterfly_net/test_unit_adapter.rb

@@ -12,22 +12,28 @@ module ButterflyNet
       @assertion_sets.last << line
     end
 
-    def close_assertion_set
+    def close_assertion_set(method_name = nil)
+      @assertion_sets.last.name = (method_name ? method_name : @assertion_sets.size)
       @assertion_sets << TestUnitMethod.new
     end
 
+    def empty?
+      @assertion_sets.empty?
+    end
+
     def create_file(filename)
-      return nil if @assertion_sets.empty?
+      return nil if empty?
 
       #todo detect existing file, and delete last 'end' line
       file = File.open(filename, 'a+')  # starts at end of file if file exists
 
       if defined? ActiveSupport::TestCase # rails  # todo support earlier versions of rails
-        file.puts "require \"test_helper\"\n\nclass TempTest < ActiveSupport::TestCase"
+        file.puts "require \"test_helper\"\n\n# script/console test capture courtesy of butterfly_net (butterflynet.org)\nclass MyTest < ActiveSupport::TestCase"
       else
-        file.puts "require \"test/unit\"\n\nclass TempTest < Test::Unit::TestCase"
+        file.puts "require \"test/unit\"\n\n# IRB test capture courtesy of butterfly_net (butterflynet.org)\nclass MyTest < Test::Unit::TestCase"
       end
 
+
       test_methods.each do |test_method|
         file.puts "\n  #{test_method}"
       end
@@ -41,13 +47,8 @@ module ButterflyNet
     end
 
     def test_methods
-      method_strings = []
-      @assertion_sets.each_with_index do |assertions, i|
-
-
-        method_strings << assertions.text(i + 1)
-      end
-      method_strings
+      @assertion_sets.last.name = @assertion_sets.size unless @assertion_sets.last.name # done here for testing     
+      @assertion_sets.collect {|i| i.text }.compact
     end
 
   end

data/lib/butterfly_net/test_unit_method.rb

@@ -1,67 +1,55 @@
 module ButterflyNet
   class TestUnitMethod
 
+    attr_accessor :name
+
     def initialize
-      @lines = []
+      @commands = []
     end
 
     def <<(line)
-      @lines << line
-    end
-
-    def self.simple_assignment_only?(line)  # todo: extract to line class
-      line =~ /[^=<>!*%\/+-\\|&]=[^=~]/
+      @commands << line
     end
 
-    def self.assertion(expected, line)     # todo: extract to assertion class
-      if expected && simple_assignment_only?(line)
-        line
-      elsif expected && expected == line # type not supported, assume object inequality
-        "assert_not_equal((#{expected}), #{line})"
-      elsif expected == "true" # use simple assert() for true boolean expressions
-        "assert(#{line})"
-      elsif expected
-        "assert_equal(#{expected}, #{line})"
-      else
-        nil
-      end
+    def name=(name)
+      name = underscore(name)
+      @name = name =~ /^test_/ ? name : "test_#{name}"
     end
 
-    def text_from_expression(line, i)
-      expected_assertion(i)
+    def self.assignment_or_require?(line)  # todo: extract to line class
+      line =~ /require\s*['|"]\w+['|"]|[^=<>!*%\/+-\\|&]=[^=~]/
     end
 
-    def text(method_name)
-      method_string = "def test_#{method_name}\n"
-      @lines.each_with_index do |line, i|
-        text = text_from_expression(line, i)
-        method_string += "    #{text}\n" if text
+    def text
+      purge_bad_commands
+      lines_string = ""
+      @commands.each_index do |i|
+        text = assertion(i)
+        lines_string += "    #{text}\n" if text
       end
-      method_string += "  end"
+      lines_string.empty? ? nil : "def #{@name}\n#{lines_string}  end"
     end
 
-    def expected_assertion(current_i)
+    def assertion(current_i)
 
-      current_line = @lines[current_i]
+      current_line = @commands[current_i]
       commands = current_line
       start_i = current_i
 
       begin
         retval = eval commands
-      rescue
+      rescue Exception
         start_i -= 1
-        commands = @lines[start_i..current_i].join("\n")
+        commands = @commands[start_i..current_i].join("\n")
 
         if start_i < 0
-          puts "failure evaluating: eval[#{start_i}..#{current_i}] : #{commands}\n"
-          return nil
+          return nil    # give up, can't go further back
         else
           retry
         end
       end
-      if retval && TestUnitMethod.simple_assignment_only?(current_line)
+      if TestUnitMethod.assignment_or_require?(current_line)
         current_line
-
       elsif instances_equal_by_value?(retval) # expression result supports value equality
 
         if retval == true # use simple assert() for true boolean expressions
@@ -84,6 +72,37 @@ module ButterflyNet
       instance == instance.dup rescue true  # can't dup Fixnum, et al...
     end
 
+    private
+
+
+    def purge_bad_commands
+      begin
+        commands = ""
+        index = 0
+        @commands.each_with_index do |current_line, i|
+          index = i
+          commands += current_line + "\n"
+          eval commands
+        end
+
+      rescue Exception
+        # delete offender and start again from the beginning
+        @commands.delete_at index
+      end
+      nil
+    end
+
+    # Adapted from ActiveSupport Inflector
+    def underscore(name)
+      name.to_s.strip.
+              gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+              gsub(/([a-z\d])([A-Z])/, '\1_\2').
+              tr("-", "_").
+              tr(" ", "_").
+              downcase
+    end
+
+
 
   end
 end

data/test/test_unit_adapter_test.rb

@@ -22,7 +22,6 @@ class TestUnitAdapterTest < Test::Unit::TestCase
   def test_test_methods_single
     @adapter.add_command("1 + 1")
     expected = "def test_1\n    assert_equal(2, 1 + 1)\n  end"
-    @adapter.test_methods
     assert_equal expected, @adapter.test_methods.first
   end
 
@@ -30,7 +29,6 @@ class TestUnitAdapterTest < Test::Unit::TestCase
     @adapter.add_command("1 + 1")
     @adapter.add_command("1 + 2")
     expected = "def test_1\n    assert_equal(2, 1 + 1)\n    assert_equal(3, 1 + 2)\n  end"
-    @adapter.test_methods
     assert_equal expected, @adapter.test_methods.last
   end
 
@@ -38,7 +36,13 @@ class TestUnitAdapterTest < Test::Unit::TestCase
     @adapter.add_command("a = 1")
     @adapter.add_command("a + 2")
     expected = "def test_1\n    a = 1\n    assert_equal(3, a + 2)\n  end"
-    @adapter.test_methods
+    assert_equal expected, @adapter.test_methods.last
+  end
+
+  def test_test_methods_require
+    @adapter.add_command("require 'bigdecimal'")
+    @adapter.add_command("BigDecimal(\"1.0\") - 0.5")
+    expected = "def test_1\n    require 'bigdecimal'\n    assert_equal(0.5, BigDecimal(\"1.0\") - 0.5)\n  end"
     assert_equal expected, @adapter.test_methods.last
   end
 
@@ -46,9 +50,20 @@ class TestUnitAdapterTest < Test::Unit::TestCase
     @adapter.add_command("1 + 1")
     @adapter.close_assertion_set
     @adapter.add_command("1 + 2")
-    expected = "def test_2\n    assert_equal(3, 1 + 2)\n  end"
-    @adapter.test_methods
-    assert_equal expected, @adapter.test_methods.last
+    assert_equal "def test_1\n    assert_equal(2, 1 + 1)\n  end", @adapter.test_methods.first
+    assert_equal "def test_2\n    assert_equal(3, 1 + 2)\n  end", @adapter.test_methods.last
+  end
+
+  def test_test_methods_naming
+    @adapter.add_command("1 + 1")
+    @adapter.close_assertion_set 'test_one_plus_one'
+    assert_equal "def test_one_plus_one\n    assert_equal(2, 1 + 1)\n  end", @adapter.test_methods.first
+  end
+
+  def test_test_methods_bad_input
+    @adapter.add_command("BADCOMMAND")
+    @adapter.close_assertion_set
+    assert_nil @adapter.test_methods.first
   end
   
   def test_create_file
@@ -56,7 +71,8 @@ class TestUnitAdapterTest < Test::Unit::TestCase
     expected  = <<-EOF
 require "test/unit"
 
-class TempTest < Test::Unit::TestCase
+# IRB test capture courtesy of butterfly_net (butterflynet.org)
+class MyTest < Test::Unit::TestCase
 
   def test_1
     assert_equal(2, 1 + 1)
@@ -64,7 +80,7 @@ class TempTest < Test::Unit::TestCase
 
 end
     EOF
-    @adapter.create_file('temp_test.rb')
+    @adapter.create_file('temp_test.rb')   # todo: write to memory instead of file...
     assert_equal expected, File.open('temp_test.rb').readlines.join('')
   end
 

data/test/test_unit_method_test.rb

@@ -8,174 +8,265 @@ class TestUnitMethodTest < Test::Unit::TestCase
 
   def setup
     @method = TestUnitMethod.new
+    @method.name = "1"
   end
 
-  def test_simple_assignment_only_true
-     assert TestUnitMethod.simple_assignment_only? "a=1"
+  def test_assignment_or_require_true
+     assert TestUnitMethod.assignment_or_require? "a=1"
   end
 
-#  def test_simple_assignment_only_true_orequals          todo: solve orequals in regex
-#     assert TestUnitMethod.simple_assignment_only? "a ||= 1"
+#  def test_assignment_or_require_true_orequals          todo: solve orequals in regex
+#     assert TestUnitMethod.assignment_or_require? "a ||= 1"
 #  end
 
-  def test_simple_assignment_only_true_whitespace
-     assert TestUnitMethod.simple_assignment_only? "a = 1"
+  def test_assignment_or_require_true_whitespace
+     assert TestUnitMethod.assignment_or_require? "a = 1"
   end
 
-  def test_simple_assignment_only_true_contains_equals
-     assert TestUnitMethod.simple_assignment_only? "a = (1 == 1)"
+  def test_assignment_or_require_true_contains_equals
+     assert TestUnitMethod.assignment_or_require? "a = (1 == 1)"
   end
 
-  def test_simple_assignment_only_false
-     assert !TestUnitMethod.simple_assignment_only?("a + 1")
+  def test_assignment_or_require_true_require_bigdecimal
+     assert TestUnitMethod.assignment_or_require? "require 'bigdecimal'"
   end
 
-  def test_simple_assignment_only_false_with_equals
-     assert !TestUnitMethod.simple_assignment_only?("a == 1")
+  def test_assignment_or_require_true_require
+     assert TestUnitMethod.assignment_or_require? "require 'rubygems'"
   end
 
-  def test_simple_assignment_only_false_threequals
-     assert !TestUnitMethod.simple_assignment_only?("a===1")
+  def test_assignment_or_require_true_require_no_spaces
+     assert TestUnitMethod.assignment_or_require? "require\"rubygems\""
   end
 
-  def test_simple_assignment_only_false_regex
-    assert !TestUnitMethod.simple_assignment_only?("'a' =~ /a/")
+  def test_assignment_or_require_false
+     assert !TestUnitMethod.assignment_or_require?("a + 1")
   end
 
-  def test_simple_assignment_only_false_regex
-    assert !TestUnitMethod.simple_assignment_only?("'a' =~ /a/")
+  def test_assignment_or_require_false_with_equals
+     assert !TestUnitMethod.assignment_or_require?("a == 1")
   end
 
-  def test_simple_assignment_only_false_lessthanequals
-    assert !TestUnitMethod.simple_assignment_only?("1 <= 1")
+  def test_assignment_or_require_false_threequals
+     assert !TestUnitMethod.assignment_or_require?("a===1")
   end
 
-  def test_simple_assignment_only_false_greaterthanequals
-    assert !TestUnitMethod.simple_assignment_only?("1 >= 1")
+  def test_assignment_or_require_false_regex
+    assert !TestUnitMethod.assignment_or_require?("'a' =~ /a/")
   end
 
-  def test_simple_assignment_only_false_flyingsaucer
-    assert !TestUnitMethod.simple_assignment_only?("1 <=> 1")
+  def test_assignment_or_require_false_regex
+    assert !TestUnitMethod.assignment_or_require?("'a' =~ /a/")
   end
 
-  def test_simple_assignment_only_false_notequal
-    assert !TestUnitMethod.simple_assignment_only?("1 != 0")
+  def test_assignment_or_require_false_lessthanequals
+    assert !TestUnitMethod.assignment_or_require?("1 <= 1")
   end
 
-  def test_simple_assignment_only_false_modequal
-    assert !TestUnitMethod.simple_assignment_only?("a %= 1")
+  def test_assignment_or_require_false_greaterthanequals
+    assert !TestUnitMethod.assignment_or_require?("1 >= 1")
   end
 
-  def test_simple_assignment_only_false_orequal
-    assert !TestUnitMethod.simple_assignment_only?("a |= 1")
+  def test_assignment_or_require_false_flyingsaucer
+    assert !TestUnitMethod.assignment_or_require?("1 <=> 1")
   end
 
-  def test_simple_assignment_only_false_plusequal
-    assert !TestUnitMethod.simple_assignment_only?("a += 1")
+  def test_assignment_or_require_false_notequal
+    assert !TestUnitMethod.assignment_or_require?("1 != 0")
   end
 
-  def test_simple_assignment_only_false_minusequal
-    assert !TestUnitMethod.simple_assignment_only?("a -= 1")
+  def test_assignment_or_require_false_modequal
+    assert !TestUnitMethod.assignment_or_require?("a %= 1")
   end
 
-  def test_simple_assignment_only_false_divideequal
-    assert !TestUnitMethod.simple_assignment_only?("a /= 1")
+  def test_assignment_or_require_false_orequal
+    assert !TestUnitMethod.assignment_or_require?("a |= 1")
   end
 
-  def test_simple_assignment_only_false_andequal
-    assert !TestUnitMethod.simple_assignment_only?("a &= 1")
+  def test_assignment_or_require_false_plusequal
+    assert !TestUnitMethod.assignment_or_require?("a += 1")
   end
 
-  def test_simple_assignment_only_false_shiftrightequal
-    assert !TestUnitMethod.simple_assignment_only?("a >>= 1")
+  def test_assignment_or_require_false_minusequal
+    assert !TestUnitMethod.assignment_or_require?("a -= 1")
   end
 
-  def test_simple_assignment_only_false_shiftleftequal
-    assert !TestUnitMethod.simple_assignment_only?("a <<= 1")
+  def test_assignment_or_require_false_divideequal
+    assert !TestUnitMethod.assignment_or_require?("a /= 1")
   end
 
-  def test_simple_assignment_only_false_timesequal
-    assert !TestUnitMethod.simple_assignment_only?("a *= 1")
+  def test_assignment_or_require_false_andequal
+    assert !TestUnitMethod.assignment_or_require?("a &= 1")
   end
 
+  def test_assignment_or_require_false_shiftrightequal
+    assert !TestUnitMethod.assignment_or_require?("a >>= 1")
+  end
+
+  def test_assignment_or_require_false_shiftleftequal
+    assert !TestUnitMethod.assignment_or_require?("a <<= 1")
+  end
+
+  def test_assignment_or_require_false_timesequal
+    assert !TestUnitMethod.assignment_or_require?("a *= 1")
+  end
+
+  def test_name_uppercase
+    @method.name = "MYMETHOD"
+    assert_equal("test_mymethod", @method.name)
+  end
+
+  def test_name_camelcase
+    @method.name = "MyMethod"
+    assert_equal("test_my_method", @method.name)
+  end
+
+  def test_name_hyphenated
+    @method.name = "my-Method"
+    assert_equal("test_my_method", @method.name)
+  end
+
+  def test_name_spaces
+    @method.name = " my Method "
+    assert_equal("test_my_method", @method.name)
+  end
+
+  def test_test_methods_naming_no_changes
+    @method.name = 'test_one_plus_one'
+    assert_equal("test_one_plus_one", @method.name)
+  end
+
+  def test_test_methods_naming_prepends_test
+    @method.name = 'one_plus_one'
+    assert_equal("test_one_plus_one", @method.name)
+  end
+
+
+
+#  def test_text_split_statements_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
+
+  def test_purge_unexpected_identifier
+    @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", @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", @method.text
+  end
+
+  def test_text_require
+    @method << "require 'rubygems'"
+    @method << "require'active_support'"
+    @method << "'CamelCase'.underscore"
+    assert_equal "def test_1\n    require 'rubygems'\n    require'active_support'\n    assert_equal(\"camel_case\", 'CamelCase'.underscore)\n  end", @method.text
+  end
 
   def test_expected_boolean
     line = "1 == 1"
     @method << line
-    assert_equal("assert(#{line})", @method.expected_assertion(0))
+    assert_equal("assert(#{line})", @method.assertion(0))
   end
 
   def test_assertion_fixnum
     line = "1"
     @method << line
-    assert_equal("assert_equal(#{line}, #{line})", @method.expected_assertion(0))
+    assert_equal("assert_equal(#{line}, #{line})", @method.assertion(0))
   end
 
   def test_assertion_boolean_false
     line = "1 != 1"
     @method << line
-    assert_equal("assert_equal(false, #{line})", @method.expected_assertion(0))
+    assert_equal("assert_equal(false, #{line})", @method.assertion(0))
   end
 
-
-
   def test_array_add
     @method << "a = []"
     line2 = "a << \"1\""
     @method << line2
-    assert_equal("assert_equal([\"1\"], #{line2})", @method.expected_assertion(1))
+    assert_equal("assert_equal([\"1\"], #{line2})", @method.assertion(1))
   end
 
   def test_butterfly_net
     @method << "method = TestUnitMethod.new"
     @method << "method << \"1 + 1\""
-    assert_equal("assert_equal([\"1 + 1\"], method << \"1 + 1\")", @method.expected_assertion(1))
+    assert_equal("assert_equal([\"1 + 1\"], method << \"1 + 1\")", @method.assertion(1))
   end
 
-
-
-  def test_text_from_expression_boolean
+  def test_assertion_boolean
     line = "1 == 1"
     @method << line
-    assert_equal("assert(#{line})", @method.text_from_expression(line, 0))
+    assert_equal("assert(#{line})", @method.assertion(0))
   end
 
-  def test_text_from_expression_string
+  def test_assertion_string
     line = "'a' + 'b'"
     @method << line
-    assert_equal("assert_equal(\"ab\", #{line})", @method.text_from_expression(line, 0))
+    assert_equal("assert_equal(\"ab\", #{line})", @method.assertion(0))
   end
 
-  def test_text_from_expression_nil
+  def test_assertion_nil
     line = "[].first"
     @method << line
-    assert_equal("assert_nil(#{line})", @method.text_from_expression(line, 0))
+    assert_equal("assert_nil(#{line})", @method.assertion(0))
   end
 
-  def test_text_from_expression_boolean
+  def test_assertion_boolean
     line = "1 == 1"
     @method << line
-    assert_equal("assert(#{line})", @method.text_from_expression(line, 0))
+    assert_equal("assert(#{line})", @method.assertion(0))
   end
 
-  def test_text_from_expression_object_not_equal
+  def test_assertion_object_not_equal
     line = "Object.new"
     @method << line
-    assert_equal("assert_not_equal((#{line}), #{line})", @method.text_from_expression(line, 0))
+    assert_equal("assert_not_equal((#{line}), #{line})", @method.assertion(0))
   end
 
-  def test_text_from_expression_array
+  def test_assertion_array
     line = "([1,2,3])[0..0]"
     @method << line
-    assert_equal("assert_equal([1], #{line})", @method.text_from_expression(line, 0))
+    assert_equal("assert_equal([1], #{line})", @method.assertion(0))
   end
 
-  def test_text_from_expression_illegal_input
-    line = "BADCOMMAND"
+  def test_assertion_illegal_input
+    line = "badtext"
     @method << line
-    assert_nil @method.text_from_expression(line, 0)
+    assert_nil @method.assertion(0)
   end
 
+  def test_text
+    @method << "1 + 1"
+    assert_equal "def test_1\n    assert_equal(2, 1 + 1)\n  end", @method.text
+  end
+
+
+
+  def test_text_bad_input_constant
+    @method << "BADCONSTANT"
+    assert_nil @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.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Chris Smith
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-20 00:00:00 -07:00
+date: 2010-02-21 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -22,7 +22,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
+- README.md
 - lib/butterfly_net/commands.rb
 - lib/butterfly_net/file_writer.rb
 - lib/butterfly_net/test_unit_adapter.rb
@@ -32,7 +32,7 @@ files:
 - test/test_unit_adapter_test.rb
 - test/test_unit_method_test.rb
 has_rdoc: true
-homepage: http://github.com/quartzmo/butterfly_net
+homepage: http://www.butterflynet.org
 licenses: []
 
 post_install_message: 

data/README

@@ -1,71 +0,0 @@
-butterfly_net
-
-    Version: 0.0.2
-
-    Author: Chris Smith
-    Email: quartzmo@gmail.com
-    Project homepage: http://github.com/quartzmo/butterfly_net
-
-DESCRIPTION
-
-    IRB history captured as Test::Unit tests. (RSpec and others hopefully soon to come.)
-
-INSTALL
-
-    1. gem sources -a http://gemcutter.org
-    2. sudo gem install butterfly_net
-    3. To automatically require butterfly_net on every IRB session, add the following to your ~/.irbrc:
-
-        require 'rubygems'
-        require 'butterfly_net'
-
-USAGE
-
-    Command methods:
-
-    bn, bn_open    - Open an active test case, with optional string arg file_name ('.rb' is appended if needed)
-    bnc, bn_close  - Close the active test case, and write the output to a file
-
-    Ruby on Rails console:
-
-    For repeatable tests, be sure to load the Rails test environment with "./script/console test".
-    In a Rails project, you can run all tests with the standard rake command 'rake test',
-    or an individual test by adding the test directory to the path with the option -I when you invoke Ruby.
-
-    chris$ ./script/console test
-    Loading test environment (Rails 2.3.4)
-    >> bn "test/unit/person_console_test"
-    . . .
-    >> Person.count
-    => 2
-    >> exit
-    . . .
-    chris$ ruby -Itest test/unit/person_console_test.rb
-    . . .
-    1 tests, 1 assertions, 0 failures, 0 errors
-
-
-LICENSE
-
-    (The MIT License)
-
-    Copyright (c) 2010 Chris Smith
-
-    Permission is hereby granted, free of charge, to any person obtaining
-    a copy of this software and associated documentation files (the
-    'Software'), to deal in the Software without restriction, including
-    without limitation the rights to use, copy, modify, merge, publish,
-    distribute, sublicense, and/or sell copies of the Software, and to
-    permit persons to whom the Software is furnished to do so, subject to
-    the following conditions:
-
-    The above copyright notice and this permission notice shall be
-    included in all copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.