test_equality_with_lcs 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Scott Noel-Hemming
+
+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/README

@@ -0,0 +1,67 @@
+= test_equality_with_lcs
+
+Compare two strings, or arrays, and get failed results back in an easy to distinguish LCS output.
+
+Let's say you want to test two strings:
+@string1 = "Hello World!"
+@string2 = "Hello Bob!"
+
+*Unit tests*:
+class ClassName < Test::Unit::TestCase
+  include TestWithLCS::Unit
+
+  def test_something
+	assert_equal_with_lcs @string1, @string2
+  end
+end
+
+and 
+
+*Spec tests*:
+define "Something" do
+  include TestEqualityWithLCS::Spec
+
+  it "matches" do
+    @string1.should be_equal_with_lcs(@string2)
+  end
+end
+
+result in the output:
+
+'      ! !   '
+'Hello World!'
+'Hello Bob  !'
+
+* without the quotes though. 
+  I added them to bring attention
+  to the included whitespace.
+
+== Dependencies
+
+diff-lcs ( http://rubyforge.org/projects/ruwiki/ )
+colored ( http://errtheblog.com/ )
+
+== Installation
+
+1. Require the gem
+2. Install the dependant gems
+2. Require the necessary lib for your framework
+3. include the appropriate module for your testing framework
+
+* TestWithLCS::Spec for Rspec
+* TestWithLCS::Unit for Test/Unit
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Scott Noel-Hemming. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,71 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "test_equality_with_lcs"
+    gem.summary = %Q{Compare two strings, or arrays, and get failed results back in an easy to distinguish LCS output.}
+    gem.description = %Q{Compare two strings, or arrays, and get failed results back in an easy to distinguish LCS output.}
+    gem.email = "frogstarr78@gmail.com"
+    gem.homepage = "http://github.com/frogstarr78/test_equality_with_lcs"
+    gem.authors = ["Scott Noel-Hemming"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "diff-lcs"
+    gem.add_development_dependency "colored"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "test_equality_with_lcs #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/test_equality_with_lcs/shared.rb

@@ -0,0 +1,58 @@
+module TestEqualityWithLCS
+  module SharedMethods
+    @@colorize = true
+    def self.included in_class
+      in_class.class.send :define_method, :colorize do
+        @@colorize
+      end
+
+      in_class.class.send :define_method, :colorize= do |color|
+        @@colorize = color
+      end
+    end
+
+    private
+      def message_for_argument_types string1, string2
+        if string1.is_a? String and string2.is_a? String
+          delegating_to_string_generating_method string1, string2
+        elsif string1.is_a? Array and string2.is_a? Array
+          lcs_message(string1, string2)
+        else
+          raise Test::Unit::AssertionFailedError.new("Comparing different types.")
+        end
+      end
+
+    def delegating_to_string_generating_method string1, string2
+      seq1 = string1.split "\n"
+      seq2 = string2.split "\n"
+      messages = []
+      (['']*seq1.size).zip(seq1, seq2).each do |junk, line1, line2|
+        messages << lcs_message("#{line1}", "#{line2}")
+      end
+      messages.join "\n"
+    end
+
+    def lcs_message string1, string2
+      message_array = []
+      Diff::LCS.sdiff string1, string2 do |diff| 
+        action = diff.action == '=' ? ' ' : diff.action
+        case action
+        when '-'
+          color  = :red
+        when '+'
+          color  = :green
+        when '!'
+          color = :magenta
+        else
+          color  = :white
+        end
+        left   = diff.new_element || ' '
+        right  = diff.old_element || ' '
+        message_array << [action, left, right].map {|thing| thing.send(@@colorize ? color : :to_s) }
+      end
+      horizontal_diff_array = message_array.transpose
+      horizontal_messages = horizontal_diff_array.map {|diff| diff.join '' }
+      horizontal_messages.join "\n"
+    end
+  end
+end

data/lib/test_equality_with_lcs/spec.rb

@@ -0,0 +1,28 @@
+module TestEqualityWithLCS
+  module Spec
+
+    class BeEqualWithLCS
+      include SharedMethods
+      def initialize expected
+        @expected = expected
+      end
+
+      def matches? target
+        @target = target
+        @expected == @target
+      end
+
+      def failure_message_for_should
+        message_for_argument_types @expected, @target
+      end
+
+      def failure_message_for_should_not
+        message_for_argument_types @expected, @target
+      end
+    end
+
+    def be_equal_with_lcs expected
+      BeEqualWithLCS.new expected
+    end
+  end
+end

data/lib/test_equality_with_lcs/unit.rb

@@ -0,0 +1,19 @@
+require 'test/unit/assertions'
+
+module TestEqualityWithLCS
+  module Unit
+    include SharedMethods
+    def assert_equal_with_lcs string1, string2
+      # depending on the size of the strings
+      # and since we generate the error message
+      # before running the assertion
+      # we want to bypass this behavior for the sake of speed
+      return if string1 == string2
+
+      message = message_for_argument_types string1, string2
+      assert_block message do
+        string1 == string2
+      end
+    end
+  end
+end

data/lib/test_equality_with_lcs.rb

@@ -0,0 +1,3 @@
+require 'diff/lcs'
+require 'colored'
+require 'test_equality_with_lcs/shared'

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'test_equality_with_lcs'
+require 'test_equality_with_lcs/spec'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.include TestEqualityWithLCS::Spec  
+end

data/spec/test_equality_with_lcs_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "TestEqualityWithLcs" do
+  it "passes" do
+    'actual'.should be_equal_with_lcs('actual')
+  end
+
+  it "doesn't pass" do
+    'actual'.should_not be_equal_with_lcs('something else so this test will fail and we can test the resulting string')
+  end
+
+  it "get's correct output" do
+    self.class.colorize = false
+    # careful of the whitespace required here.
+    expected_error = "---------------------------------- ---------- --- ----------- + -----------
+                                  a          c   t           ual           
+something else so this test will fail and we can test the resu lting string"
+    lambda{ 
+      'actual'.should be_equal_with_lcs('something else so this test will fail and we can test the resulting string')
+    }.should raise_error(Spec::Expectations::ExpectationNotMetError, expected_error)
+  end
+
+  it "get's correct output with multi-line string comparison" do
+    self.class.colorize = false
+    # careful of the whitespace required here.
+    seq1 = "actual
+ly
+I
+didn't want it all
+on one
+line"
+    seq2 = "actually I did want it on ...
+well a couple lines."
+
+    expected_error = "      -----------------------
+actual                       
+actually I did want it on ...
+-- !----------------
+  ly                
+well a couple lines."
+    lambda{ 
+      seq1.should be_equal_with_lcs(seq2)
+    }.should raise_error(Spec::Expectations::ExpectationNotMetError, expected_error)
+  end
+end

data/test/assert_equality_with_lcs_test.rb

@@ -0,0 +1,99 @@
+require 'test_helper'
+
+class AssertEqualityWithLCSTest < Test::Unit::TestCase
+  def test_my_failing_message
+    seq1 = %w(a b c e h j l \  m n p) 
+    seq2 = %w(b c d e f j k l m r s t) 
+    begin
+      self.class.colorize = true
+      assert_equal_with_lcs seq1, seq2
+    rescue Test::Unit::AssertionFailedError => received
+      expected = '-'.red << ' '.white << ' '.white << '+'.green << ' '.white << '!'.magenta << ' '.white << '+'.green << ' '.white << '-'.red << ' '.white << '!'.magenta << '!'.magenta << '+'.green << "\n" << 
+                 ' '.red << 'b'.white << 'c'.white << 'd'.green << 'e'.white << 'f'.magenta << 'j'.white << 'k'.green << 'l'.white << ' '.red << 'm'.white << 'r'.magenta << 's'.magenta << 't'.green << "\n" <<
+                 'a'.red << 'b'.white << 'c'.white << ' '.green << 'e'.white << 'h'.magenta << 'j'.white << ' '.green << 'l'.white << ' '.red << 'm'.white << 'n'.magenta << 'p'.magenta << ' '.green
+      assert_equal expected, received.message
+    end
+  end
+
+  def test_my_failing_message_on_multi_line_strings
+    seq1 = %Q|abce
+hjl
+\ mnp
+q\tu
+v
+y
+xz| 
+    seq2 = %Q|bcd
+efjklmr
+st|
+    begin
+      self.class.colorize = false
+      assert_equal_with_lcs seq1, seq2
+    rescue Test::Unit::AssertionFailedError => received
+      received_messages = received.message.split "\n"
+
+      assert_equal '-  !',    received_messages[0]
+      assert_equal ' bcd',    received_messages[1]
+      assert_equal 'abce',    received_messages[2]
+
+      assert_equal '!+ + ++', received_messages[3]
+      assert_equal 'efjklmr', received_messages[4]
+      assert_equal 'h j l  ', received_messages[5]
+
+      assert_equal '!!--',    received_messages[6]
+      assert_equal 'st  ',    received_messages[7] 
+      assert_equal ' mnp',    received_messages[8] 
+
+      assert_equal "---",     received_messages[9]
+      assert_equal "   ",     received_messages[10]
+      assert_equal "q\tu",    received_messages[11]
+
+      assert_equal '-',       received_messages[12]
+      assert_equal ' ',       received_messages[13]
+      assert_equal 'v',       received_messages[14]
+
+      assert_equal '-',       received_messages[15]
+      assert_equal ' ',       received_messages[16]
+      assert_equal 'y',       received_messages[17]
+
+      assert_equal '--',      received_messages[18]
+      assert_equal '  ',      received_messages[19]
+      assert_equal 'xz',      received_messages[20]
+    ensure
+      self.class.colorize = true
+    end
+  end
+
+  def test_me_failing_again
+    seq1 = %w(a b c e h j l \  m n p) 
+    seq2 = %w(b c d e f j k l m r s t) 
+    assert_raises Test::Unit::AssertionFailedError do
+      assert_equal_with_lcs seq1, seq2
+    end
+  end
+
+  def test_no_passing
+    seq1 = %w(a b c e h j l \  m n p) 
+    seq2 = %w(a b c e h j l \  m n p) 
+    assert_nothing_raised {
+      assert_equal_with_lcs seq1, seq2
+    }
+  end
+
+  def test_string_lcs_array
+    # though the underlying library supports it,
+    # we don't want to allow that kind of messiness 
+    # in our testing framework.
+    seq1 = %q(abcehjl mnp) 
+    seq2 = %w(a b c e h j l \  m n p) 
+    assert_raises Test::Unit::AssertionFailedError do
+      assert_equal_with_lcs seq1, seq2
+    end
+  end
+
+  def test_colorize
+    assert_equal true, self.class.colorize
+    self.class.colorize = false
+    assert_equal false, self.class.colorize
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'test_equality_with_lcs'
+require 'test_equality_with_lcs/unit'
+require 'test/unit'
+
+class Test::Unit::TestCase
+  include TestEqualityWithLCS::Unit
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: test_equality_with_lcs
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Scott Noel-Hemming
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: diff-lcs
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: colored
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Compare two strings, or arrays, and get failed results back in an easy to distinguish LCS output.
+email: frogstarr78@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/test_equality_with_lcs.rb
+- lib/test_equality_with_lcs/shared.rb
+- lib/test_equality_with_lcs/spec.rb
+- lib/test_equality_with_lcs/unit.rb
+- spec/spec_helper.rb
+- spec/test_equality_with_lcs_spec.rb
+- test/assert_equality_with_lcs_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/frogstarr78/test_equality_with_lcs
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Compare two strings, or arrays, and get failed results back in an easy to distinguish LCS output.
+test_files: 
+- spec/test_equality_with_lcs_spec.rb
+- spec/spec_helper.rb
+- test/test_helper.rb
+- test/assert_equality_with_lcs_test.rb