quality_extensions 0.1.1

data/lib/qualitysmith_extensions/string/each_char_with_index.rb

@@ -0,0 +1,41 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes! A great compliment to each_char!
+# Developer notes::
+#++
+
+require 'rubygems'
+require 'qualitysmith_extensions/enumerable/enum'
+
+class String
+  def each_char_with_index
+    i = 0
+    split(//).each do |c|
+      yield i, c
+      i += 1
+    end
+  end
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class TheTest < Test::Unit::TestCase
+  def test_1
+    assert_equal [[0, "a"], [1, "b"], [2, "c"]],
+                 'abc'.enum(:each_char_with_index).to_a
+  end
+end
+=end
+
+

data/lib/qualitysmith_extensions/string/md5.rb

@@ -0,0 +1,29 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes
+#++
+
+require "digest/md5"
+
+class String
+  # Because it's so much more natural to have this as a method of the string rather than having to call <tt>Digest::MD5.hexdigest(string)</tt>.
+  def md5
+    return Digest::MD5.hexdigest(self)
+  end
+end
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+class TheTest < Test::Unit::TestCase
+  def test_md5
+    assert_equal "abc".md5, Digest::MD5.hexdigest("abc")
+  end
+end
+=end

data/lib/qualitysmith_extensions/string/shell_escape.rb

@@ -0,0 +1,43 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes
+#++
+
+require 'rubygems'
+require 'escape'    # http://www.a-k-r.org/escape/
+require 'facets/core/symbol/to_proc' unless Symbol.method_defined?(:to_proc)
+require 'facets/core/kernel/require_local'
+
+class String
+  def shell_escape
+    Escape.shell_command([self])
+  end
+end
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+class TheTest < Test::Unit::TestCase
+  def assert_that_echo_gives_back_what_we_put_in(input)
+    input = %q{!&'"`$0 |()<>}
+    output = `echo -n #{input.shell_escape}`
+    assert_equal input, output
+  end
+  def test_1
+    assert_that_echo_gives_back_what_we_put_in( 
+      %q{!&'"`$0 |()<>} )
+  end
+  def test_2
+    assert_that_echo_gives_back_what_we_put_in( 
+      %q{'an arg that's got "quotes"} )
+  end
+end
+=end
+

data/lib/qualitysmith_extensions/string/to_underscored_label.rb

@@ -0,0 +1,37 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Probably not.
+# Developer notes:
+# * Can we use a more general method instead (like humanize or methodize)? Does this really have a use distinct from all the other inflection methods out there?
+#++
+
+class String
+  # Strips out most non-alphanumeric characters and leaves you with a lowercased, underscored string that can safely be used as a class_name 
+  def to_underscored_label
+    self.
+      downcase.
+      gsub(/-+/, "_").gsub(/ +/, "_").  # spaces and -'s-> underscores
+      gsub(/[^a-z0-9_]/, "").           # keep only alphanumeric and _ characters
+      gsub(/_+$/, "").                   # We don't want any _ characters at the end
+      gsub(/^_+/, "")                   # ... or the beginning 
+  end
+end
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+class TheTest < Test::Unit::TestCase
+  def test_to_underscored_label
+    assert_equal "discount_amount", "Discount Amount".to_underscored_label
+    assert_equal "more_spaces", "More    SPACES".to_underscored_label
+    assert_equal "other_123_types_of_characters", "Other-123 Types? Of!!! Characters".to_underscored_label
+    assert_equal "weird_characters_on_the_end", "weird characters on the end *#*#**".to_underscored_label
+  end
+end
+=end

data/lib/qualitysmith_extensions/string/with_knowledge_of_color.rb

@@ -0,0 +1,64 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Maybe
+#++
+
+module WithKnowledgeOfColor
+  Color_regexp = /\e\[[^m]+m/
+
+  def strip_color
+    gsub(Color_regexp, '')
+  end
+
+  # This version of +length+ takes into account the fact that the ANSI color codes themselves don't take up any space to display on the screen.
+  # So this returns the number of characters wide the string is when it is actually printed to the screen.
+  def length_without_color
+    strip_color.length
+  end
+
+  def nonprinting_characters_used_for_color
+    self.scan(Color_regexp).join
+  end
+
+  def ljust_without_color(width)
+    ljust(width + nonprinting_characters_used_for_color.length)
+  end
+end
+
+class String
+  include WithKnowledgeOfColor
+end
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'rubygems'
+gem 'colored'
+require 'colored'
+
+class TheTest < Test::Unit::TestCase
+  def test_strip_color
+    assert       "abc" != "abc".blue
+    assert_equal "abc",   "abc".blue.strip_color
+  end
+  def test_length_without_color
+    assert_equal 12, "abc".blue.length
+    assert_equal 3,  "abc".blue.length_without_color
+  end
+  def test_nonprinting_characters_used_for_color
+    assert_equal "\e[34m\e[0m", 'abc'.blue.nonprinting_characters_used_for_color
+  end
+  def test_ljust_without_color
+    assert_equal "abc  ", 'abc'.     ljust(              5)
+    assert_equal "abc  ", 'abc'.blue.ljust_without_color(5).strip_color
+    assert_equal "\e[34mabc\e[0m  ", 'abc'.blue.ljust_without_color(5)
+  end
+
+end
+=end

data/lib/qualitysmith_extensions/symbol/constantize.rb

@@ -0,0 +1,69 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes!
+# Developer notes::
+# Changes::
+#++
+
+require 'rubygems'
+require 'facets/core/kernel/constant'
+
+class Symbol
+  # Tries to find a declared constant with the name specified in self.
+  #
+  #   :Foo.constantize => Foo
+  #
+  # Unlike ActiveSupport, we don't do this check (because Kernel.module "can handle module hierarchy"):
+  #   vendor/rails/activesupport/lib/active_support/inflector.rb
+  #     unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
+  #       raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
+  #     end
+  def constantize
+    Kernel.constant(self)
+  end
+end
+class String
+  # Tries to find a declared constant with the name specified in self.
+  #
+  #   'Foo'.constantize => Foo
+  #
+  # Unlike ActiveSupport, we don't do this check (because Kernel.module "can handle module hierarchy"):
+  #   vendor/rails/activesupport/lib/active_support/inflector.rb
+  #     unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
+  #       raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
+  #     end
+  def constantize
+    Kernel.constant(self)
+  end
+end
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+module OuterModule; end
+module OuterModule::InnerModule; end
+
+class SymbolTest < Test::Unit::TestCase
+  module InnerModule; end
+  def test_1
+    assert_equal OuterModule,              :OuterModule.constantize
+    assert_equal OuterModule::InnerModule, :'OuterModule::InnerModule'.constantize
+  end
+end
+class StringTest < Test::Unit::TestCase
+  module InnerModule; end
+  def test_1
+    assert_equal OuterModule,              'OuterModule'.constantize
+    assert_equal OuterModule::InnerModule, 'OuterModule::InnerModule'.constantize
+  end
+end
+=end
+

data/lib/qualitysmith_extensions/symbol/match.rb

@@ -0,0 +1,157 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Maybe, if we can get the bugs worked out. I can't believe Facets has Regexp#chomp, capitalize, downcase, etc., but not match/=~ !
+# Developer notes::
+# * Rename to symbol/regexp.rb ?
+#++
+
+require 'rubygems'
+require 'facets/core/module/alias_method_chain'
+
+unless defined?(Symbol::HasSymbolSupport)
+
+class Symbol
+  HasSymbolSupport = true
+
+  def match(regexp)
+    to_s.match(regexp)
+  end
+
+  # Warning: Due to what I think is a bug in Ruby, $1, Regexp.last_match do not yield accurate results when queried after
+  # returning from a method call that does a regexp match!
+  # If you need access to that data, you're better off just doing :symbol.to_s =~ /regexp/ yourself.
+  # If all you need is a true/false (matches or doesn't match) result, then you can use this.
+  #   :cat =~ /c.t/
+  #
+  def =~(regexp)
+    to_s =~ regexp
+  end
+  # Seems to be equivalent to this, if anyone cares:
+  #  m = self.match(regexp)
+  #  m ? m.begin(0) : nil
+
+end
+
+# I would just do something like this, but it causes the $1-not-set-after-method-call bug to infect anything that uses Regexp#===, which would be really bad!!
+  #class Regexp
+  #  alias_method :orig_eee, :===
+  #  def === (other)
+  #    orig_eee(other)
+  #  end
+  #
+  #end
+# I can't even run the tests in this file after making this (trivial) wrapper for ===! If I try, I get this error:
+#/usr/lib/ruby/1.8/optparse.rb:1099:in `make_switch': undefined method `downcase' for nil:NilClass (NoMethodError)
+#        from /usr/lib/ruby/1.8/optparse.rb:1032:in `each'
+#        from /usr/lib/ruby/1.8/optparse.rb:1032:in `make_switch'
+#        from /usr/lib/ruby/1.8/optparse.rb:1140:in `define'
+#        from /usr/lib/ruby/1.8/optparse.rb:1149:in `on'
+#        from /usr/lib/ruby/1.8/test/unit/autorunner.rb:106:in `options'
+#        from /usr/lib/ruby/1.8/optparse.rb:755:in `initialize'
+#        from /usr/lib/ruby/1.8/test/unit/autorunner.rb:101:in `new'
+#        from /usr/lib/ruby/1.8/test/unit/autorunner.rb:101:in `options'
+#        from /usr/lib/ruby/1.8/test/unit/autorunner.rb:88:in `process_args'
+#        from /usr/lib/ruby/1.8/test/unit/autorunner.rb:10:in `run'
+#        from /usr/lib/ruby/1.8/test/unit.rb:278
+#        from -:46
+
+class Regexp
+  def eee_with_support_for_symbols (other)
+    case other
+    when Symbol
+      __send__ :===, other.to_s
+    else
+      __send__ :===, other
+    end
+  end
+
+  module WithSupportForSymbols
+    def self.extended(base)
+      base.class.class_eval do
+        alias_method :eee_without_support_for_symbols, :===
+      end
+    end
+    def === (other)
+      case other
+      when Symbol
+        eee_without_support_for_symbols(other.to_s)
+      else
+        eee_without_support_for_symbols(other)
+      end
+    end
+  end
+end
+
+module Enumerable
+  def grep_with_regexp_support_for_symbols(pattern, &block)
+    map { |element|
+      element.is_a?(Symbol) ? element.to_s : element
+    }.grep_without_regexp_support_for_symbols(pattern, &block)
+  end
+  alias_method_chain :grep, :regexp_support_for_symbols
+  
+end
+
+end # unless defined?(Symbol::HasSymbolSupport)
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+require 'rubygems'
+require 'qualitysmith_extensions/object/singleton_send'
+
+class TheTest < Test::Unit::TestCase
+  def test_equal_tilde
+    assert_equal 1, :chopper =~ /hopper/
+  end
+  def test_match
+    assert :chopper.match(/hopper/).is_a?(MatchData)
+    assert_equal 'hopper', :chopper.match(/hopper/).to_s
+  end
+  def test_triple_equal
+    assert_equal true, /hopper/ === 'chopper'
+    assert_equal false, /hopper/ === :chopper       # Doesn't work!
+
+    assert_equal true, /hopper/.eee_with_support_for_symbols(:chopper)
+    assert_equal true, /hopper/.singleton_send(Regexp::WithSupportForSymbols, :===, :chopper)
+    regexp = /chopper/
+    regexp.extend Regexp::WithSupportForSymbols
+    assert_equal true, regexp === :chopper
+  end
+
+  # Due to what I think is a BUG in Ruby, the details of the last_match appear to be reset after returning from a method.
+  # In other words, if you print out $1 from within Symbol#=~, it has the value you'd expected, but as soon as we get back from
+  # Symbol#=~, it's gone!
+  # See http://svn.tylerrick.com/public/ruby/examples/regexp-variables_reset_after_return_from_method.rb
+  def test_the_setting_of_match_variables
+    # This doesn't work, unfortunately.
+    assert_equal 0, :cat =~ /c(.)t/
+    assert_equal nil, $1
+    assert_equal nil, Regexp.last_match(1)
+
+    # Nor this
+    assert :cat.match(/c(.)t/)
+    assert_equal nil, $1
+    assert_equal nil, Regexp.last_match(1)
+
+    # But if we do the to_s conversion *here* (as opposed to from within Symbol#=~), it works! Yuck!
+    assert_equal 0, :cat.to_s =~ /c(.)t/
+    assert_equal 'a', $1
+    assert_equal 'a', Regexp.last_match(1)
+  end
+
+  def test_grep
+    assert_equal ['a'], ['a', 'b', 'c'].grep(/a/)
+
+    # This only works because of our grep_with_regexp_support_for_symbols() monkey patch.
+    assert_equal ['a'], [:a, :b, :c].grep(/a/)
+  end
+end
+=end