butterfly_net 0.0.1

data/README

@@ -0,0 +1,50 @@
+butterfly_net
+
+    by Chris Smith
+
+    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
+
+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.rb

@@ -0,0 +1,6 @@
+require 'butterfly_net/file_writer'
+require 'butterfly_net/test_unit_method'
+require 'butterfly_net/test_unit_adapter'
+require 'butterfly_net/commands'
+
+include ButterflyNet::Commands

data/lib/butterfly_net/commands.rb

@@ -0,0 +1,47 @@
+#
+# Command shortcuts:
+#
+# bn  - open a new Butterfly Net test case, with optional name
+# bnc - close Butterfly Net test case, writing output file
+# 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
+#
+module ButterflyNet
+  module Commands
+
+    def bn_open(file_name=nil)
+      @file.close if @file
+      check_for_readline
+      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 }
+      puts "butterfly_net: #{file_name} opened at Readline::HISTORY ##{start_index}"
+      true
+    end
+
+    def bn_close
+      check_for_readline
+      if @file
+        status = @file.close
+        @file = nil
+        status
+      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
+
+    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

@@ -0,0 +1,42 @@
+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
+    end
+
+    def new_assertion_set
+
+    end
+
+
+    def close
+      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)
+        end
+
+        adapter.create_file(@file_name)
+
+        puts "butterfly_net: #{@file_name} closed after Readline::HISTORY ##{@end_index}"
+        true
+      end
+    rescue Exception => msg
+      puts "butterfly_net:  Error generating tests: #{msg}"
+      false
+    end
+
+  end
+
+end

data/lib/butterfly_net/test_unit_adapter.rb

@@ -0,0 +1,44 @@
+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
+      @assertion_sets << TestUnitMethod.new
+    end
+
+    def create_file(filename)
+      return nil if @assertion_sets.empty?
+      file = File.open(filename, 'w+')
+      file.puts "require \"test/unit\"\n\nclass TempTest < Test::Unit::TestCase"
+
+      test_methods.each do |test_method|
+        file.puts "\n  #{test_method}"
+      end
+
+      file.puts "\nend"
+    ensure
+      file.close if file # todo: closing is good, but prevent writing partial data in case of exception
+    end
+
+    def test_methods
+      method_strings = []
+      @assertion_sets.each_with_index do |assertions, i|
+
+
+        method_strings << assertions.text(i + 1)
+      end
+      method_strings
+    end
+
+  end
+end

data/lib/butterfly_net/test_unit_method.rb

@@ -0,0 +1,89 @@
+module ButterflyNet
+  class TestUnitMethod
+
+    def initialize
+      @lines = []
+    end
+
+    def <<(line)
+      @lines << line
+    end
+
+    def self.simple_assignment_only?(line)  # todo: extract to line class
+      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
+    end
+
+    def text_from_expression(line, i)
+      expected_assertion(i)
+    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
+      end
+      method_string += "  end"
+    end
+
+    def expected_assertion(current_i)
+
+      current_line = @lines[current_i]
+      commands = current_line
+      start_i = current_i
+
+      begin
+        retval = eval commands
+      rescue
+        start_i -= 1
+        commands = @lines[start_i..current_i].join("\n")
+
+        if start_i < 0
+          puts "failure evaluating: eval[#{start_i}..#{current_i}] : #{commands}\n"
+          return nil
+        else
+          retry
+        end
+      end
+      if retval && TestUnitMethod.simple_assignment_only?(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
+          "assert(#{current_line})"
+        elsif retval.nil?
+          "assert_nil(#{current_line})"
+        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})"
+      end
+
+    end
+
+    def instances_equal_by_value?(instance)
+      instance == instance.dup rescue true  # can't dup Fixnum, et al...
+    end
+
+
+  end
+end

data/test/butterfly_net_tests.rb

@@ -0,0 +1,5 @@
+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"

data/test/test_unit_adapter_test.rb

@@ -0,0 +1,71 @@
+require "test/unit"
+$: << File.expand_path(File.dirname(__FILE__))
+$: << File.join(File.expand_path(File.dirname(__FILE__)), File.join("..", "lib"))
+require "butterfly_net/test_unit_method"
+require "butterfly_net/test_unit_adapter"
+
+class TestUnitAdapterTest < Test::Unit::TestCase
+  include ButterflyNet
+  
+  def setup
+    @adapter = TestUnitAdapter.new
+  end
+
+  def teardown
+    File.delete 'temp_test.rb' if File.exists? 'temp_test.rb' # delete old in test, since impl should append, not overwrite
+  end
+
+  def test_expression_eval
+    # assert eval("assert_equal(2, 1 + 1)")    todo figure out how to eval assertions here
+  end
+
+  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
+
+  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"
+    @adapter.test_methods
+    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"
+    @adapter.test_methods
+    assert_equal expected, @adapter.test_methods.last
+  end
+
+  def test_test_methods_numbering
+    @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
+  end
+  
+  def test_create_file
+    @adapter.add_command("1 + 1")
+    expected  = <<-EOF
+require "test/unit"
+
+class TempTest < Test::Unit::TestCase
+
+  def test_1
+    assert_equal(2, 1 + 1)
+  end
+
+end
+    EOF
+    @adapter.create_file('temp_test.rb')
+    assert_equal expected, File.open('temp_test.rb').readlines.join('')
+  end
+
+end

data/test/test_unit_method_test.rb

@@ -0,0 +1,187 @@
+require "test/unit"
+$: << File.expand_path(File.dirname(__FILE__))
+$: << File.join(File.expand_path(File.dirname(__FILE__)), File.join("..", "lib"))
+require "butterfly_net/test_unit_method"
+
+class TestUnitMethodTest < Test::Unit::TestCase
+  include ButterflyNet
+
+  def setup
+    @method = TestUnitMethod.new
+  end
+
+  def test_simple_assignment_only_true
+     assert TestUnitMethod.simple_assignment_only? "a=1"
+  end
+
+#  def test_simple_assignment_only_true_orequals          todo: solve orequals in regex
+#     assert TestUnitMethod.simple_assignment_only? "a ||= 1"
+#  end
+
+  def test_simple_assignment_only_true_whitespace
+     assert TestUnitMethod.simple_assignment_only? "a = 1"
+  end
+
+  def test_simple_assignment_only_true_contains_equals
+     assert TestUnitMethod.simple_assignment_only? "a = (1 == 1)"
+  end
+
+  def test_simple_assignment_only_false
+     assert !TestUnitMethod.simple_assignment_only?("a + 1")
+  end
+
+  def test_simple_assignment_only_false_with_equals
+     assert !TestUnitMethod.simple_assignment_only?("a == 1")
+  end
+
+  def test_simple_assignment_only_false_threequals
+     assert !TestUnitMethod.simple_assignment_only?("a===1")
+  end
+
+  def test_simple_assignment_only_false_regex
+    assert !TestUnitMethod.simple_assignment_only?("'a' =~ /a/")
+  end
+
+  def test_simple_assignment_only_false_regex
+    assert !TestUnitMethod.simple_assignment_only?("'a' =~ /a/")
+  end
+
+  def test_simple_assignment_only_false_lessthanequals
+    assert !TestUnitMethod.simple_assignment_only?("1 <= 1")
+  end
+
+  def test_simple_assignment_only_false_greaterthanequals
+    assert !TestUnitMethod.simple_assignment_only?("1 >= 1")
+  end
+
+  def test_simple_assignment_only_false_flyingsaucer
+    assert !TestUnitMethod.simple_assignment_only?("1 <=> 1")
+  end
+
+  def test_simple_assignment_only_false_notequal
+    assert !TestUnitMethod.simple_assignment_only?("1 != 0")
+  end
+
+  def test_simple_assignment_only_false_modequal
+    assert !TestUnitMethod.simple_assignment_only?("a %= 1")
+  end
+
+  def test_simple_assignment_only_false_orequal
+    assert !TestUnitMethod.simple_assignment_only?("a |= 1")
+  end
+
+  def test_simple_assignment_only_false_plusequal
+    assert !TestUnitMethod.simple_assignment_only?("a += 1")
+  end
+
+  def test_simple_assignment_only_false_minusequal
+    assert !TestUnitMethod.simple_assignment_only?("a -= 1")
+  end
+
+  def test_simple_assignment_only_false_divideequal
+    assert !TestUnitMethod.simple_assignment_only?("a /= 1")
+  end
+
+  def test_simple_assignment_only_false_andequal
+    assert !TestUnitMethod.simple_assignment_only?("a &= 1")
+  end
+
+  def test_simple_assignment_only_false_shiftrightequal
+    assert !TestUnitMethod.simple_assignment_only?("a >>= 1")
+  end
+
+  def test_simple_assignment_only_false_shiftleftequal
+    assert !TestUnitMethod.simple_assignment_only?("a <<= 1")
+  end
+
+  def test_simple_assignment_only_false_timesequal
+    assert !TestUnitMethod.simple_assignment_only?("a *= 1")
+  end
+
+
+  def test_expected_boolean
+    line = "1 == 1"
+    @method << line
+    assert_equal("assert(#{line})", @method.expected_assertion(0))
+  end
+
+  def test_assertion_fixnum
+    line = "1"
+    @method << line
+    assert_equal("assert_equal(#{line}, #{line})", @method.expected_assertion(0))
+  end
+
+  def test_assertion_boolean_false
+    line = "1 != 1"
+    @method << line
+    assert_equal("assert_equal(false, #{line})", @method.expected_assertion(0))
+  end
+
+
+
+  def test_array_add
+    @method << "a = []"
+    line2 = "a << \"1\""
+    @method << line2
+    assert_equal("assert_equal([\"1\"], #{line2})", @method.expected_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))
+  end
+
+
+
+  def test_text_from_expression_boolean
+    line = "1 == 1"
+    @method << line
+    assert_equal("assert(#{line})", @method.text_from_expression(line, 0))
+  end
+
+  def test_text_from_expression_string
+    line = "'a' + 'b'"
+    @method << line
+    assert_equal("assert_equal(\"ab\", #{line})", @method.text_from_expression(line, 0))
+  end
+
+  def test_text_from_expression_nil
+    line = "[].first"
+    @method << line
+    assert_equal("assert_nil(#{line})", @method.text_from_expression(line, 0))
+  end
+
+  def test_text_from_expression_boolean
+    line = "1 == 1"
+    @method << line
+    assert_equal("assert(#{line})", @method.text_from_expression(line, 0))
+  end
+
+  def test_text_from_expression_object_not_equal
+    line = "Object.new"
+    @method << line
+    assert_equal("assert_not_equal((#{line}), #{line})", @method.text_from_expression(line, 0))
+  end
+
+  def test_text_from_expression_array
+    line = "([1,2,3])[0..0]"
+    @method << line
+    assert_equal("assert_equal([1], #{line})", @method.text_from_expression(line, 0))
+  end
+
+  def test_text_from_expression_illegal_input
+    line = "BADCOMMAND"
+    @method << line
+    assert_nil @method.text_from_expression(line, 0)
+  end
+
+  # non-project tests (scratchpad)
+
+  def test_eval_scope
+    value = eval "a = []\na << 1", Proc.new {}.binding
+    assert_equal([1], value)
+    assert_equal([1,1], eval("a << 1", Proc.new {}.binding))
+  end
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: butterfly_net
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-20 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: |+
+  IRB history captured as Test::Unit tests. (RSpec and others hopefully soon to come.)
+  
+  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
+  
+email: quartzmo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/butterfly_net/commands.rb
+- lib/butterfly_net/file_writer.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_unit_method_test.rb
+has_rdoc: true
+homepage: http://github.com/quartzmo/butterfly_net
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: IRB history captured as Test::Unit tests. (RSpec and others hopefully soon to come.)
+test_files: 
+- test/butterfly_net_tests.rb