qualitysmith_extensions 0.0.20 → 0.0.24

data/lib/qualitysmith_extensions/test/difference_highlighting.rb

@@ -0,0 +1,244 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?::
+# Developer notes::
+#++
+
+
+require 'rubygems'
+gem 'colored'
+require 'colored'
+gem 'facets'
+require 'facets/core/module/alias_method_chain'
+gem 'qualitysmith_extensions', '>=0.0.22'
+require 'qualitysmith_extensions/object/send_if'
+require 'qualitysmith_extensions/string/each_char_with_index'
+require 'qualitysmith_extensions/module/mattr_tester'
+require 'qualitysmith_extensions/module/guard_method'
+require 'qualitysmith_extensions/colored/toggleability'
+
+class String
+  # For all of the next 3 methods, we will underline spaces so that they are actually visible on the screen.
+  # Newlines will be replaced with '\n'"\n".
+
+  # This is a (sub)string that is common to both expected and actual
+  def highlight_commonality
+    self.
+      make_control_characters_visible.
+      underline_spaces.
+      green.
+      send_unless(self == ' ', :bold)     # spaces are not bold, '_'s (and everything else) are
+  end
+  # This is a (sub)string that is different between expected and actual
+  def highlight_difference
+    self.
+      make_control_characters_visible.
+      underline_spaces.
+      red.
+      send_unless(self == ' ', :bold)     # spaces are not bold, '_'s (and everything else) are
+  end
+  # This is a (sub)string that exists only in *self*, not in the other string
+  def highlight_unique
+    self.
+      make_control_characters_visible.
+      underline_spaces.
+      yellow
+  end
+  # This is a (sub)string that doesn't exist in self, only in the *other* string
+  def highlight_absence
+    self.white.on_yellow.bold
+  end
+  def underline_spaces
+    #:todo: Make this optional? Might be useful if you are comparing things with lots of spaces and underscores and you want to be able to tell the difference between them...?
+    self.gsub(' ', ' '.underline)
+  end
+  def make_control_characters_visible 
+    self.gsub(/\n/, '\n'+"\n").   # Show '\n' in addition to actually doing the line break
+         gsub(/\r/, '\r').        # Just escape it...
+         gsub(/\t/, '\t')
+    #:todo: Add other control characters?
+  end
+end
+module Test
+  module Unit
+    module Assertions
+      class AssertionMessage
+        @@inspect_strings = false
+        #mattr_tester :inspect_strings
+        mguard_method :inspect_strings!, :@@inspect_strings, :disable_inspect_strings!
+
+        # The problem with the original convert() is that it always called #inspect on strings... which is fine if you really
+        # want to see all those \n's and such. But not so great if you want to visually compare the strings. And if you have
+        # ANSI color codes in the strings, it will escape those so that you see the codes (\e[33m1) rather than the nice
+        # colored strings that you (sometimes) *want* to see...
+        #
+        def convert_with_option_to_not_use_inspect_for_strings(object)
+          if String === object
+            if self.class.inspect_strings?
+              # Use the original method, which used pp or inspect
+              convert_without_option_to_not_use_inspect_for_strings(object)
+            else
+              object
+            end
+          else
+            # We only care about strings. Everything else can just keep happening like it was before.
+            convert_without_option_to_not_use_inspect_for_strings(object)
+          end
+        end
+        alias_method_chain :convert, :option_to_not_use_inspect_for_strings
+      end
+
+      # Rather than showing the expected and the actual and asking the user to painstakingly compare the two and figure out the
+      # commonalities and differences himself, this method will highlight the differences for the user (in color), so that they
+      # can be spotted in less than an instant!
+      #
+      # Strings:
+      #   Does a characterwise comparison between the two strings.
+      #   Common characters are displayed in green, different characters in red, and characters that exist in one but not the
+      #   other are displayed in yellow (a blank yellow background as placeholders for the string in which those characters
+      #   are missing).
+      # Arrays:
+      #   [:todo:] 
+      # Hashes:
+      #   [:todo:] 
+      #
+      # Difference in method signature from assert_equal_without_difference_highlighting:
+      # * last argument is a hash (+options+) rather than message=nil, since I don't see the use in passing in a message if
+      #   the default message can be made useful enough.
+      # * If you really want to pass in a message, use :message => 'my message'
+      #
+      # * If you want everything to be escaped (so you would see the color codes instead of the color itself), use :inspect_strings => true
+      #
+      # Spaces are displayed with an underline so that they are actually visible on the screen.
+      # * : 
+      def assert_equal_with_difference_highlighting(expected, actual, options = {})
+        message = options.delete(:message) || nil
+        AssertionMessage.inspect_strings!(options.delete(:inspect_strings) || false)
+
+        if String===expected and String===actual and expected!=actual
+          expected_with_highlighting = ''
+          actual_with_highlighting = ''
+          full_message = nil
+          String.color_on! do
+            longest_string = [expected, actual].max {|a, b| a.length <=> b.length}
+            longest_string.each_char_with_index do |i, exp|
+              exp = expected[i] ? expected[i].chr : nil
+              act = actual[i]   ? actual[i].chr   : nil
+              if act.nil?
+                expected_with_highlighting << exp.highlight_unique
+                actual_with_highlighting   << ' '.highlight_absence
+              elsif exp.nil?
+                expected_with_highlighting << ' '.highlight_absence
+                actual_with_highlighting   << act.highlight_unique
+
+              elsif exp != act
+                expected_with_highlighting << exp.highlight_difference
+                actual_with_highlighting   << act.highlight_difference
+              else
+                expected_with_highlighting << exp.highlight_commonality
+                actual_with_highlighting   << exp.highlight_commonality
+              end
+
+            end
+            full_message = build_message(message, <<End, expected_with_highlighting, actual_with_highlighting)
+#{(' '*50 + ' Expected: ' + ' '*50).blue.on_white }
+?
+#{(' '*50 + ' But was:  ' + ' '*50).yellow.on_red }
+?
+End
+          end
+          assert_block(full_message) { expected == actual }
+        else
+          assert_equal_without_difference_highlighting(expected, actual, message)
+        end
+      end # def assert_equal_with_difference_highlighting
+      #alias_method :assert_equal_with_highlighting, :assert_equal_with_difference_highlighting
+      alias_method_chain :assert_equal, :difference_highlighting
+
+    end
+  end
+end
+
+
+
+
+
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class TheTest < Test::Unit::TestCase
+  def test1_single_character_difference
+    assert_equal <<End, <<End
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Sed feugiat mi. In sagittis, augue non eleifend sodales, arcu urna congue sapien, aliquet molestie pede urna sit amet dolor. Etiam diam. Vestibulum ornare, felis et porta faucibus, magna sapien vulputate arcu, vel facilisis lectus ipsum et ipsum.
+
+Vivamus massa odio, lacinia eu, euismod vitae, lobortis eu, erat. Duis tincidunt, neque ac tincidunt convallis, nibh tellus sodales eros, ut tristique nunc purus in urna. Nullam semper. Fusce quis augue ut metus interdum congue. Duis id dolor eu mi pellentesque sagittis. Quisque imperdiet orci a odio.
+End
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Sed feugiat mi. In sagittis, augue non eleifend sodales, arcu urna congue sapien, aliquet molestie pede urna sit amet dolor. Etiam diam. Vestibulum ornare, felis et porta faucibus, magna sapien vulputate arcu, vel facilisis lectus ipsum et ipsum.
+
+Vivamus massa odio, lacinia eu, euismod vitae, lobortis eu, erat. Duis tincidunt, neque ac tincidunt convallis, nibh tellus sodales eros, ut tristique nunc purus in urna. Nullam semper. Fusce quis augue ut metus interdum congue. Duis id color eu mi pellentesque sagittis. Quisque imperdiet orci a odio.
+End
+  end
+
+  def test2_difference_in_control_characters
+    assert_equal "Lorem ipsum dolor sit amet,\nconsectetuer adipiscing elit.\nSed feugiat mi.",
+                 "Lorem ipsum_dolor sit amet, consectetuer\tadipiscing elit.\n\rSed feugiat mi."
+  end
+
+  def test3_expected_is_longer
+    assert_equal '1234567890', '123'
+  end
+
+  def test4_actual_is_longer
+    assert_equal '123', '1234567890'
+  end
+
+  # Use the ones above this line as screenshot material...
+
+  def test5_one_is_much_longer
+    assert_equal <<End, <<End
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Sed feugiat mi. In sagittis, augue non eleifend sodales, arcu urna congue sapien, aliquet molestie pede urna sit amet dolor. Etiam diam. Vestibulum ornare, felis et porta faucibus, magna sapien vulputate arcu, vel facilisis lectus ipsum et ipsum. Sed dictum, dolor suscipit malesuada pharetra, orci augue lobortis lectus, porta porta magna magna ut dui. Duis viverra enim sed felis. Mauris semper volutpat pede. Integer lectus lorem, lacinia in, iaculis ut, euismod non, nulla. Nunc non libero eget diam congue ornare. Nunc dictum tellus sed turpis. Sed venenatis, pede non ultricies pharetra, dolor felis malesuada nisl, id imperdiet lorem dui vel velit.
+End
+Lorem ipsum dolor sit amet
+End
+  end
+
+  def test6_only_minor_single_character_differences_but_then_it_gets_out_of_sync
+    assert_equal <<End, <<End
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Sed feugiat mi. In sagittis, augue non eleifend sodales, arcu urna congue sapien.
+
+Vivamus massa odio, lacinia eu, euismod vitae, lobortis eu, erat. Duis tincidunt, neque ac tincidunt convallis, nibh tellus sodales eros, ut tristique nunc purus in urna. Nullam semper. Fusce quis augue ut metus interdum congue. Duis id dolor eu mi pellentesque sagittis. Quisque imperdiet orci a odio.
+End
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Sed feugiat mi. In sagittis, argue non eleifend sodales, arcu urna conque sapien.
+
+Vivamus massa odio, lacinia eu, euismod vitae, lobortis eu, erat. Duis tincidunt, neque ac tincidunt convallis, nibh tellus sodales eros, ut tristique nunc purus in urna. Nullam semper. Fusce quis augue ut metus interdum congue. Duis id dolor eu mi pellentesque sagittis. Quisque imperdiet orci a odio.
+End
+  end
+  def test7_underscores_versus_underlines
+    assert_equal <<End, <<End
+If you look really closely, you'll see that underscores are a brighter color (bold), while spaces appear somewhaat faded, less visible:
+___[Underscores]___[Underscores]   [Spaces] _ _ _ _ _ [Mix]
+End
+If you look really closely, you'll see that underscores are a brighter color (bold), while spaces appear somewhaat faded, less visible:
+   [Spaces]     ___[Underscores]   [Spaces] _ _ __ _ _[Mix]     
+End
+  end
+
+  def test12_expected_is_longer
+    assert_equal '1234567890', '123', :inspect_strings => true
+  end
+
+end
+=end
+
+

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: qualitysmith_extensions
 version: !ruby/object:Gem::Version 
-  version: 0.0.20
-date: 2007-04-26 00:00:00 -07:00
+  version: 0.0.24
+date: 2007-04-27 00:00:00 -07:00
 summary: A collection of reusable Ruby methods developed by QualitySmith.
 require_paths: 
 - lib
@@ -37,9 +37,11 @@ files:
 - lib/qualitysmith_extensions/test/assert_exception.rb
 - lib/qualitysmith_extensions/test/assert_user_error.rb
 - lib/qualitysmith_extensions/test/assert_changed.rb
+- lib/qualitysmith_extensions/test/difference_highlighting.rb
 - lib/qualitysmith_extensions/test/all.rb
 - lib/qualitysmith_extensions/test/assert_includes.rb
 - lib/qualitysmith_extensions/exception/inspect_with_backtrace.rb
+- lib/qualitysmith_extensions/colored/toggleability.rb
 - lib/qualitysmith_extensions/file_test/binary_file.rb
 - lib/qualitysmith_extensions/kernel/require_all.rb
 - lib/qualitysmith_extensions/kernel/simulate_input.rb
@@ -51,6 +53,13 @@ files:
 - lib/qualitysmith_extensions/kernel/backtrace.rb
 - lib/qualitysmith_extensions/kernel/capture_output.rb
 - lib/qualitysmith_extensions/kernel/trap_chain.rb
+- lib/qualitysmith_extensions/module.bak/guard_method.rb
+- lib/qualitysmith_extensions/module.bak/alias_method.rb
+- lib/qualitysmith_extensions/module.bak/includable_once.rb
+- lib/qualitysmith_extensions/module.bak/mattr_tester.rb
+- lib/qualitysmith_extensions/module.bak/create_setter.rb
+- lib/qualitysmith_extensions/module.bak/attribute_accessors.rb
+- lib/qualitysmith_extensions/module.bak/bool_attr_accessor.rb
 - lib/qualitysmith_extensions/dir/each_child.rb
 - lib/qualitysmith_extensions/object/singleton_send.rb
 - lib/qualitysmith_extensions/object/mcall.rb
@@ -73,10 +82,9 @@ files:
 - lib/qualitysmith_extensions/module/guard_method.rb
 - lib/qualitysmith_extensions/module/alias_method.rb
 - lib/qualitysmith_extensions/module/includable_once.rb
-- lib/qualitysmith_extensions/module/mattr_tester.rb
 - lib/qualitysmith_extensions/module/create_setter.rb
 - lib/qualitysmith_extensions/module/attribute_accessors.rb
-- lib/qualitysmith_extensions/module/attr_tester.rb
+- lib/qualitysmith_extensions/module/bool_attr_accessor.rb
 - lib/qualitysmith_extensions/symbol/match.rb
 - lib/qualitysmith_extensions/enumerable/enum.rb
 - lib/qualitysmith_extensions/hash/to_query_string.rb
@@ -84,6 +92,7 @@ files:
 - lib/qualitysmith_extensions/hash/to_date.rb
 - lib/qualitysmith_extensions/array/expand_ranges.rb
 - lib/qualitysmith_extensions/array/shell_escape.rb
+- lib/qualitysmith_extensions/array/classify.rb
 - lib/qualitysmith_extensions/array/to_query_string.rb
 - lib/qualitysmith_extensions/array/sequence.rb
 - lib/qualitysmith_extensions/array/to_a_recursive.rb

data/lib/qualitysmith_extensions/module/attr_tester.rb

@@ -1,2 +0,0 @@
-require 'rubygems'
-require 'facets/core/module/attr_tester'

data/lib/qualitysmith_extensions/module/mattr_tester.rb

@@ -1,120 +0,0 @@
-#--
-# Author::    Tyler Rick
-# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
-# License::   Ruby License
-# Submit to Facets?:: Yes
-# Developer notes::
-# * Based on /usr/lib/ruby/gems/1.8/gems/facets-1.8.54/lib/facets/core/module/attr_tester.rb
-# * Hey Thomas, don't you think Module#attr_tester should only create the read-only a? method and have another method that creates the writer (like there how we have attr_reader, _writer, and _accessor?) ? "tester" does not imply "setter" in my mind...
-#++
-
-class Module
-  # This creates two methods for each given variable name. One is used to test
-  # the attribute and the other is used to set or toggle it.
-  #
-  #   attr_tester :a
-  #
-  # is equivalent to
-  #
-  #   def self.a?
-  #     @@a ? true : @@a
-  #   end
-  #
-  #   def self.a!(switch=Exception)
-  #     if switch == Exception
-  #       @@a = !@@a
-  #     else
-  #       @@a = switch ? true : @@a
-  #       self
-  #     end
-  #   end
-  #
-  # Works for both classes and modules.
-  #
-  def mattr_tester(*args)
-
-    make = {}
-    args.each { |a|
-      # Initialize it first so that we won't have any NameErrors.
-      module_eval %{ @@#{a} = nil if !defined?(@@#{a}) }, __FILE__, __LINE__
-
-      make["#{a}?".to_sym] = %{
-        def self.#{a}?(true_value=true)
-          @@#{a} ? true_value : @@#{a}
-        end
-      }
-      make["#{a}!".to_sym] = %{
-        def self.#{a}!(switch=Exception)
-          if switch == Exception
-            @@#{a} = !@@#{a}
-          else
-            @@#{a} = switch ? true : @@#{a}
-            self
-          end
-        end
-      }
-    }
-    module_eval make.values.join("\n"), __FILE__, __LINE__
-
-    return make.keys
-  end
-end
-
-
-
-
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-require 'test/unit'
-require 'rubygems'
-require 'qualitysmith_extensions/object/ignore_access'
-
-
-class TheTest < Test::Unit::TestCase
-  class C
-    mattr_tester :a
-  end
-  module M
-    mattr_tester :a
-  end
-
-  def test_cattr_tester_exclamation
-    C.access.class_variable_set(:@@a, false)
-    assert_equal(false, C.a?)   # otherwise would have been nil
-    C.a!
-    assert_equal(true, C.a?)
-    C.a!
-    assert_equal(false, C.a?)
-  end
-  def test_cattr_tester_return
-    C.a!
-    assert_equal(true, C.a?)
-    C.a!("whatever")
-    assert_equal(true, C.a?)   # Still returns a boolean even though we set it to a string.
-  end
-
-  def test_mattr_tester_exclamation
-    assert_equal(nil, M.a?)
-    M.a!
-    assert_equal(true, M.a?)
-    M.a!
-    assert_equal(false, M.a?)
-  end
-  def test_mattr_tester_return
-    M.a!
-    assert_equal(true, M.a?)
-    M.a!("whatever")
-    assert_equal(true, M.a?)   # Still returns a boolean even though we set it to a string.
-  end
-
-end
-=end
-