butterfly_net 0.0.3 → 0.0.4

data/README.md

@@ -1,21 +1,35 @@
 Butterfly Net
 =============
 
-[Home page and source]: http://butterflynet.org
-[Rubygems page]: http://rubygems.org/gems/butterfly_net
 
 Author: Chris Smith (quartzmo -at- gmail.com)
 
+[Home page and source download](http://github.com/quartzmo/butterfly_net)
 
-## DESCRIPTION
+[RubyGems page](http://rubygems.org/gems/butterfly_net)
+
+
+## Summary
 
 IRB and Rails console history captured as Test::Unit tests. (RSpec and others hopefully soon to come.)
 
+## Description
+
+Butterfly Net is intended to help you capture, as executable tests, surprising or unexpected behavior that you come across while
+interacting with your project code in IRB.
+
+** Warning **
+
+Butterfly Net is not a tool for [test-first](http://www.extremeprogramming.org/rules/testfirst.html) development, and is
+not intended as a primary tool for [Test-Driven Development](http://en.wikipedia.org/wiki/Test-driven_development) (TDD).
+Please use it in addition to these valuable methods.
 
-## INSTALL
+## Install
 
-Butterfly Net is available as a gem from rubygems.org (http://rubygems.org/gems/butterfly_net), or as source from
-butterflynet.org.
+Butterfly Net is available as a gem from [rubygems.org](http://rubygems.org/gems/butterfly_net), or as source from
+[GitHub](http://github.com/quartzmo/butterfly_net).
+
+To install the gem:
 
     sudo gem install butterfly_net
 
@@ -25,36 +39,40 @@ To automatically require Butterfly Net on every IRB session, add the following t
     require 'butterfly_net'
 
 
-## USAGE
+## Usage
 
 ### Command methods
 
-The following commands can be used in any IRB-based console.
+The following commands can be used in any IRB-based console. The shortcuts should be preferred, the longer aliases exist in case of naming conflicts.
 
-* 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)
+* `bn(file_name=nil)`, `bn_open(file_name=nil)`       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(method_name=nil)`, `bn_method(method_name=nil)`      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'
+    irb(main):001:0> require 'rubygems'
+    => true
+    irb(main):002:0> require 'butterfly_net'
     => true
-    irb(main):002:0> a = 1
+    irb(main):003:0> bn 'irb_tests'
+    => true
+    irb(main):004:0> a = 1
     => 1
-    irb(main):003:0> a += 2
+    irb(main):005:0> a += 2
     => 3
-    irb(main):004:0> m 'plusequals'
+    irb(main):006:0> m 'plusequals'
     => true
-    irb(main):005:0> require 'bigdecimal'
+    irb(main):007:0> require 'bigdecimal'
     => true
-    irb(main):006:0> infinity = BigDecimal('Infinity')
+    irb(main):008:0> infinity = BigDecimal('Infinity')
     => #<BigDecimal:114ed34,'Infinity',4(4)>
-    irb(main):007:0> BigDecimal.new("1.0") / BigDecimal.new("0.0") == infinity
+    irb(main):009:0> BigDecimal.new("1.0") / BigDecimal.new("0.0") == infinity
     => true
-    irb(main):008:0> m 'bigdecimal_infinity'
+    irb(main):010:0> m 'bigdecimal_infinity'
     => true
-    irb(main):009:0> exit
+    irb(main):011:0> exit
     butterfly_net: irb_tests.rb closed
     true
     $ cat irb_tests.rb
@@ -86,11 +104,13 @@ The following commands can be used in any IRB-based console.
 
 ### 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.
+For repeatable tests, be sure to load the Rails test environment with `./script/console test`. Invoke the `bn` command
+with the relative path to the appropriate test sub-directory, and file name. (Hint: In a Rails project, you can run an 
+individual test by adding the test directory to the path with the option -I when you invoke Ruby.)
+
+For example:
 
-    chris$ ./script/console test
+    $ ./script/console test
     Loading test environment (Rails 2.3.4)
     >> bn "test/unit/person_console_test"
     . . .
@@ -98,33 +118,41 @@ or an individual test by adding the test directory to the path with the option -
     => 2
     >> exit
     . . .
-    chris$ ruby -Itest test/unit/person_console_test.rb
+    $ ruby -Itest test/unit/person_console_test.rb
     . . .
     1 tests, 1 assertions, 0 failures, 0 errors
 
 
-## KNOWN ISSUES
+## Known Issues
 
 This section covers issues which may not be resolved quickly. Feel free to lend a hand!
 
-### Object inspect output
+### The return value of Object#inspect is often not valid Ruby
 
-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.
+Currently, the expectation that Butterfly Net places into an assertion is the output of Object#inspect. Simple types and value-oriented
+types such as Hash and Array usually do return valid code, which works great. Unfortunately, most other types 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.
+The best workaround is to use IRB in a way that gets you to simple types, the same way you write unit tests that
+compare values by calling `to_s`, `to_i`, `to_f`, etc on more complex objects.
+Another solution, more appropriate for cases like the BigDecimal infinity example above, is to assign the expected
+result to a variable.
+
+    infinity = BigDecimal('Infinity')
+    assert(BigDecimal.new("1.0") / BigDecimal.new("0.0") == infinity)    # works great, IF you know what to expect
+
+Of course, you have to know what to expect in order to do this, which may take a few tries. Sorry.
+I'll be searching for a better solution to this one.
 
 
-### Inline variable assignment
+### Assigning a variable, even within a string, results in no assertion for that line 
 
-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.
+To keep tests readable, Butterfly Net writes simple assignment expressions such as "a = 1" without enclosing assertions.
+However, the regular expression it uses to accomplish this can cause Butterfly Net to miss some tests.
 
 For example:
 
@@ -136,14 +164,41 @@ For example:
 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('='))
+      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.
+Maybe someone can suggest how Butterfly Net can become just enough of an actual Ruby interpreter to get past this issue?
+In the meantime, just put assignments (and anything that looks like an assignment) on separate lines 
+from the expressions you want to be tested.
+
+
+## Story
+
+Coming to Ruby from Java, I felt "The Console" was like a magical English butler, always there discreetly
+at my side to instantly and precisely answer all my questions. How incredible!
+
+In Java, JUnit had been my preferred tool for exploring code, both my own project code and
+third-party libraries and frameworks. As anyone who has worked on a legacy (i.e., test-deprived) codebase or experienced
+java.util.Calendar knows, the tighter the feedback loop, the sooner you get your answers. Experimenting with code behavior through an
+application UI is only for the foolish, or those racking up billable hours on a big waterfall project.
+JUnit tests were usually the fastest way I could experience what code did in real life, and with IntelliJ IDEA generating the
+boilerplate at a keystroke, exploratory testing was quick and very acceptable. When I was done learning and
+experimenting, I deleted most of the tests, in accordance with the idea that less is better, and you shouldn't
+run automated regression tests for stable, third-party code.
+
+Switching to Ruby, I found IRB to be a much better tool, but as with all great conveniences, it had a downside.
+Although I generally program in a test-first style, I also explore existing code after it is written,
+kicking the tires and banging on the doors. With JUnit, any interesting behavior I discovered during this process was captured in a
+test, and was duly added to the suite. With IRB? Gone, flown off into the deep blue yonder. The idea for Butterfly Net
+occurred to me pretty quickly. That's the story, so far. I'm not sure how others will use Butterfly Net, but I don't
+want to limit the possibilities. Should it become more generalized and flexible, something of a view framework like
+[Hirb](http://github.com/cldwalker/hirb)? Or did I re-invent something that already existed? 
+
+Please send comments and suggestions to quartzmo -at- gmail.com
 
 
-## LICENSE
+## License
 
 The MIT License
 

data/lib/butterfly_net/commands.rb

@@ -3,6 +3,7 @@
 #
 # bn  - open a new Butterfly Net test case, with optional name
 # bnc - close Butterfly Net test case, writing output file
+# m   - close current test method, and open a new one
 # bns - add preceding line to setup method, instead of current assertion set           # todo
 # bnt - add preceding line to teardown method, instead of current assertion set        # todo
 #
@@ -10,27 +11,20 @@ module ButterflyNet
   module Commands
 
     def bn_open(file_name=nil)
-
-
-      @file.close if @file
-      check_for_readline
-      # todo: if Rails, WARNING if env is not test
-
-      start_index = Readline::HISTORY.empty? ? 0 : (Readline::HISTORY.size - 1)
-      file_name ||= "butterfly_net_#{Time.now.strftime("%Y%m%d%H%M%S")}.rb"
-      file_name += ".rb" unless file_name =~ /.rb$/
-      @file = FileWriter.new(file_name, start_index)
-      Kernel.at_exit { puts @file.close if @file; @file = 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 }
       true
-    rescue
+    rescue Exception => e
+      puts e
+      puts e.backtrace
       false
     end
 
     def bn_close
-      check_for_readline
-      if @file
-        status = @file.close
-        @file = nil
+      if @file_writer
+        status = @file_writer.close
+        @file_writer = nil
         status
       else
         puts "butterfly_net: First invoke 'bn' or 'bn_open' to begin a session"
@@ -39,25 +33,17 @@ module ButterflyNet
     end
 
     def bn_method(method_name=nil)
-      check_for_readline
-      if @file
-        @file.new_assertion_set(method_name)
+      if @file_writer
+        @file_writer.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
-
-    def check_for_readline
-      raise "butterfly_net: Readline::HISTORY required!" unless defined? Readline::HISTORY
-    end
-
   end
 end

data/lib/butterfly_net/file_writer.rb

@@ -1,69 +1,19 @@
 module ButterflyNet
   class FileWriter
 
-    attr_accessor :end_index
-    attr_reader :start_index
-
-    def initialize(file_name, start_index)
-      @file_name = file_name
-      @start_index = start_index
-      @adapter = TestUnitAdapter.new
+    def initialize(filename)
+      @file = File.open(filename, 'a+')
     end
 
-    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?
-        false
-      else
-
-
-        lines[@start_index..@end_index].each do |line|
-          @adapter.add_command(line)
-        end
 
-        @adapter.close_assertion_set(method_name)
-        @start_index = Readline::HISTORY.size - 1
-        @end_index = nil
-
-        true
+    def create_file(data)
+      @file.puts data
+      true
+    ensure
+      if @file # todo: closing is always good, but prevent writing partial data in case of exception
+        @file.close
       end
-    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
 
   end
-
-end
+end

data/lib/butterfly_net/rails_test_unit_adapter.rb

@@ -0,0 +1,9 @@
+module ButterflyNet
+  class RailsTestUnitAdapter < TestUnitAdapter
+
+    def header_text
+      "require \"test_helper\"\n\n# script/console test capture courtesy of butterfly_net (butterflynet.org)\nclass MyTest < ActiveSupport::TestCase\n\n"
+    end
+
+  end
+end

data/lib/butterfly_net/readline_reader.rb

@@ -0,0 +1,74 @@
+module ButterflyNet
+  class ReadlineReader
+
+    attr_accessor :end_index
+    attr_reader :start_index
+
+    def initialize(file_name)
+
+      check_for_readline
+      # todo: if Rails, WARNING if env is not test
+
+      @start_index = Readline::HISTORY.empty? ? 0 : (Readline::HISTORY.size - 1)
+      if file_name
+        @file_name = file_name.to_s + ".rb" unless file_name.to_s =~ /.rb$/
+      else
+        @file_name = "butterfly_net_#{Time.now.strftime("%Y%m%d%H%M%S")}.rb"  # todo: something like heroku's generated names
+      end
+      @test_case = TestCase.new
+    end
+
+    def new_assertion_set(method_name)
+      check_for_readline
+
+      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?
+        false
+      else
+        lines[@start_index..@end_index].each do |line|
+          @test_case.add_command(line)
+        end
+
+        @test_case.close_assertion_set(method_name)
+        @start_index = Readline::HISTORY.size - 1
+        @end_index = nil
+
+        true
+      end
+    rescue Exception => e
+      puts "butterfly_net:  Error generating tests: #{e}"
+      puts e.backtrace
+      false
+    end
+
+
+    def close
+      check_for_readline
+      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?
+      else
+        lines[@start_index..@end_index].each do |line|
+          @test_case.add_command(line)
+        end
+
+      end
+
+      result = @test_case.create_file(@file_name)
+      puts result ? "butterfly_net: #{@file_name} created." : "butterfly_net: #{@file_name} was not created. No tests were generated from this session."
+      result
+
+    rescue Exception => e
+      puts "butterfly_net:  Error generating tests: #{e}"
+      puts e.backtrace
+      false
+    end
+
+
+    def check_for_readline
+      raise "butterfly_net: Readline::HISTORY required!" unless defined? Readline::HISTORY
+    end
+
+  end
+end

data/lib/butterfly_net/test_case.rb

@@ -0,0 +1,43 @@
+module ButterflyNet
+  class TestCase
+
+    attr_reader :assertion_sets
+
+    def initialize
+      rails = defined? ActiveSupport::TestCase  # todo support earlier versions of rails?
+      @adapter = rails ? RailsTestUnitAdapter.new : TestUnitAdapter.new
+      @assertion_sets = [@adapter.test_method]
+    end
+
+    def add_command(line)
+      @assertion_sets.last << line
+    end
+
+    # user provides name at closing
+    def close_assertion_set(method_name = nil)
+      @assertion_sets.last.name = (method_name ? method_name : @assertion_sets.size)
+      @assertion_sets << @adapter.test_method
+    end
+
+    # true if ALL are empty
+    def empty?
+      @assertion_sets.inject(true) {|result,e| result = (result and e.empty?); result}
+    end
+
+    def create_file(filename)
+      bodytext = generate_bodytext
+      return false if empty? || bodytext.empty?
+      FileWriter.new(filename).create_file(@adapter.header_text + bodytext + @adapter.footer_text)
+    end
+
+    def test_methods
+      @assertion_sets.last.name = @assertion_sets.size unless @assertion_sets.last.name # assign the default, numbered name; done here for testing
+      @assertion_sets.collect {|i| i.text }.compact
+    end
+
+    def generate_bodytext
+      test_methods.inject("") { |result,e|result += e; result }
+    end
+
+  end
+end

data/lib/butterfly_net/test_unit_adapter.rb

@@ -1,54 +1,16 @@
 module ButterflyNet
   class TestUnitAdapter
 
-    attr_reader :assertion_sets
-
-    def initialize
-      @assertion_sets = []
-    end
-
-    def add_command(line)
-      @assertion_sets << TestUnitMethod.new unless @assertion_sets.last
-      @assertion_sets.last << line
-    end
-
-    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?
+    def header_text
+      "require \"test/unit\"\n\n# IRB test capture courtesy of butterfly_net (butterflynet.org)\nclass MyTest < Test::Unit::TestCase\n\n"
     end
 
-    def create_file(filename)
-      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\n# script/console test capture courtesy of butterfly_net (butterflynet.org)\nclass MyTest < ActiveSupport::TestCase"
-      else
-        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
-
-    ensure
-      if file # todo: closing is always good, but prevent writing partial data in case of exception
-        file.puts "\nend"
-        file.close
-      end
-
+    def footer_text
+      'end'
     end
 
-    def test_methods
-      @assertion_sets.last.name = @assertion_sets.size unless @assertion_sets.last.name # done here for testing     
-      @assertion_sets.collect {|i| i.text }.compact
+    def test_method
+      TestUnitMethod.new
     end
 
   end

data/lib/butterfly_net/test_unit_method.rb

@@ -5,29 +5,57 @@ module ButterflyNet
 
     def initialize
       @commands = []
+      @definitions = []
     end
 
     def <<(line)
       @commands << line
     end
 
+    def empty?
+      @commands.empty?
+    end
+
     def name=(name)
       name = underscore(name)
-      @name = name =~ /^test_/ ? name : "test_#{name}"
+      @name = name =~ /^\s*test_/ ? name : "test_#{name}"
     end
 
     def self.assignment_or_require?(line)  # todo: extract to line class
       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 = ""
-      @commands.each_index do |i|
-        text = assertion(i)
-        lines_string += "    #{text}\n" if text
+      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
-      lines_string.empty? ? nil : "def #{@name}\n#{lines_string}  end"
+      before_test_method += "  "
+      lines_string.empty? ? nil : "#{before_test_method}def #{@name}\n#{lines_string}  end\n\n"
     end
 
     def assertion(current_i)
@@ -63,33 +91,49 @@ module ButterflyNet
       else
 
         # any other sort of object is handled as a not equal assertion
-        "assert_not_equal((#{current_line}), #{current_line})"
+        "assert_not_equal((#{current_line}), #{current_line})"    # todo assert_not_nil in some cases?
       end
 
     end
 
     def instances_equal_by_value?(instance)
-      instance == instance.dup rescue true  # can't dup Fixnum, et al...
+      instance == instance.dup rescue true  # assume anything like Fixnum that can't be dup'd is a value type...
     end
 
     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"
-          eval commands
+          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
+        @commands.delete_at index      # todo: test if string equality is safe for delete()
+        retry
       end
-      nil
     end
 
     # Adapted from ActiveSupport Inflector

data/lib/butterfly_net.rb

@@ -1,6 +1,9 @@
 require 'butterfly_net/file_writer'
 require 'butterfly_net/test_unit_method'
 require 'butterfly_net/test_unit_adapter'
+require 'butterfly_net/rails_test_unit_adapter'
+require 'butterfly_net/test_case'
+require 'butterfly_net/readline_reader'
 require 'butterfly_net/commands'
 
 include ButterflyNet::Commands

data/test/butterfly_net_tests.rb

@@ -2,4 +2,4 @@ require "test/unit"
 $: << File.expand_path(File.dirname(__FILE__))
 $: << File.join(File.expand_path(File.dirname(__FILE__)), File.join("..", "lib"))
 require "test_unit_method_test"
-require "test_unit_adapter_test"
+require "test_case_test"

data/test/{test_unit_adapter_test.rb → test_case_test.rb}

@@ -1,14 +1,17 @@
 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/test_unit_method"
 require "butterfly_net/test_unit_adapter"
+require "butterfly_net/rails_test_unit_adapter"
+require "butterfly_net/test_case"
 
-class TestUnitAdapterTest < Test::Unit::TestCase
+class TestCaseTest < Test::Unit::TestCase
   include ButterflyNet
   
   def setup
-    @adapter = TestUnitAdapter.new
+    @adapter = TestCase.new
   end
 
   def teardown
@@ -21,43 +24,82 @@ 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"
+    expected = "  def test_1\n    assert_equal(2, 1 + 1)\n  end\n\n"
     assert_equal expected, @adapter.test_methods.first
   end
 
   def test_test_methods_2_assertions_1_method
     @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"
+    expected = "  def test_1\n    assert_equal(2, 1 + 1)\n    assert_equal(3, 1 + 2)\n  end\n\n"
     assert_equal expected, @adapter.test_methods.last
   end
 
   def test_test_methods_variable_in_assertion
     @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"
+    expected = "  def test_1\n    a = 1\n    assert_equal(3, a + 2)\n  end\n\n"
     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"
+    expected = "  def test_1\n    require 'bigdecimal'\n    assert_equal(0.5, BigDecimal(\"1.0\") - 0.5)\n  end\n\n"
     assert_equal expected, @adapter.test_methods.last
   end
 
-  def test_test_methods_numbering
+  def test_test_methods_def_method_single_inline
+    @adapter.add_command("def timestwo(i); i * 2; end")
+    @adapter.add_command("timestwo(4)")
+    expected = <<-EOF
+  def timestwo(i); i * 2; end
+
+  def test_1
+    assert_equal(8, timestwo(4))
+  end
+
+    EOF
+    assert_equal expected, @adapter.generate_bodytext
+  end
+
+  def test_test_methods_def_methods_two_inline
+    @adapter.add_command("def timestwo(i); i * 2; end")
+    @adapter.add_command("def timesfour(i); timestwo(i) * timestwo(i); end")
+    @adapter.add_command("timestwo(1)")
+    @adapter.add_command("timesfour(1)")
+    expected = <<-EOF
+  def timestwo(i); i * 2; end
+
+  def timesfour(i); timestwo(i) * timestwo(i); end
+
+  def test_1
+    assert_equal(2, timestwo(1))
+    assert_equal(4, timesfour(1))
+  end
+
+    EOF
+    assert_equal expected, @adapter.generate_bodytext
+  end
+
+  def test_test_methods_numbering_first_method
+    @adapter.add_command("1 + 1")
+    @adapter.close_assertion_set
+    @adapter.add_command("1 + 2")
+    assert_equal "  def test_1\n    assert_equal(2, 1 + 1)\n  end\n\n", @adapter.test_methods.first
+  end       
+
+  def test_test_methods_numbering_second_method
     @adapter.add_command("1 + 1")
     @adapter.close_assertion_set
     @adapter.add_command("1 + 2")
-    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
+    assert_equal "  def test_2\n    assert_equal(3, 1 + 2)\n  end\n\n", @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
+    assert_equal "  def test_one_plus_one\n    assert_equal(2, 1 + 1)\n  end\n\n", @adapter.test_methods.first
   end
 
   def test_test_methods_bad_input

data/test/test_unit_method_test.rb

@@ -111,6 +111,35 @@ 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)
@@ -152,21 +181,21 @@ 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", @method.text
+    assert_equal "  def test_1\n    a = 1\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", @method.text
+    assert_equal "  def test_1\n    a = 1\n    assert_equal(2, a += 1)\n  end\n\n", @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
+    assert_equal "  def test_1\n    require 'rubygems'\n    require'active_support'\n    assert_equal(\"camel_case\", 'CamelCase'.underscore)\n  end\n\n", @method.text
   end
 
   def test_expected_boolean
@@ -236,6 +265,13 @@ class TestUnitMethodTest < Test::Unit::TestCase
     assert_equal("assert_equal([1], #{line})", @method.assertion(0))
   end
 
+  def test_text_def_method_single_line
+    @method << "def timestwo(i); i * 2; end"
+    line = "timestwo(2)"
+    @method << line
+    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
     line = "badtext"
     @method << line
@@ -244,29 +280,39 @@ class TestUnitMethodTest < Test::Unit::TestCase
 
   def test_text
     @method << "1 + 1"
-    assert_equal "def test_1\n    assert_equal(2, 1 + 1)\n  end", @method.text
+    assert_equal "  def test_1\n    assert_equal(2, 1 + 1)\n  end\n\n", @method.text
   end
 
+  def test_text_variable_assignment_only
+    line = "a = 1"
+    @method << line
+    assert_equal "  def test_1\n    #{line}\n  end\n\n", @method.text
+  end
 
+  def test_extract_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
+  end
+
+  def test_extract_definitions_class_with_method
+    @method << "class MyClass"
+    @method << "def name"
+    @method << "\"classy\""
+    @method << "end"
+    @method << "end"
+    @method << "MyClass.new.name"
+    assert_equal "  class MyClass\n    def name\n      \"classy\"\n    end\n  end\n\n  def test_1\n    assert_equal(\"classy\", MyClass.new.name)\n  end\n\n", @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.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Chris Smith
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-21 00:00:00 -07:00
+date: 2010-02-24 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -25,11 +25,14 @@ files:
 - README.md
 - lib/butterfly_net/commands.rb
 - lib/butterfly_net/file_writer.rb
+- lib/butterfly_net/rails_test_unit_adapter.rb
+- lib/butterfly_net/readline_reader.rb
+- lib/butterfly_net/test_case.rb
 - lib/butterfly_net/test_unit_adapter.rb
 - lib/butterfly_net/test_unit_method.rb
 - lib/butterfly_net.rb
 - test/butterfly_net_tests.rb
-- test/test_unit_adapter_test.rb
+- test/test_case_test.rb
 - test/test_unit_method_test.rb
 has_rdoc: true
 homepage: http://www.butterflynet.org