qualitysmith_extensions 0.0.3 → 0.0.4

data/lib/qualitysmith_extensions/array/average.rb

@@ -1,9 +1,11 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes.
 #   Wait, so Facets has mode (http://facets.rubyforge.org/src/doc/rdoc/core/classes/Enumerable.html#M001253) but it doesn't have mean/average?
 #   Whether or not this Array#average is included, Facets ought to have an Enumerable#mean/average similar to mode that uses each iterator rather than Array#size. (Still might want to keep this version if it's more efficient for Arrays?)
+#++
 
 class Array
   # Calculates the arithmetic average (mean) of the elements in the array as a <tt>Float</tt>.

data/lib/qualitysmith_extensions/array/expand_ranges.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes.
+#++
 
 require 'rubygems'
 require 'facets/core/kernel/silence_warnings'

data/lib/qualitysmith_extensions/array/group_by.rb

@@ -1,9 +1,11 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes
 # Developer notes:
 # * Name is too general? Name it something to do with 'tables'?
+#++
 
 require 'rubygems'
 require_gem 'facets'
@@ -39,7 +41,7 @@ class Array
         "a"=>[['a', 1], ['a', 2]], 
         "b"=>[['b', 3], ['b', 4]]
    
-   Notes:
+   *Notes*:
    * <tt>self</tt> must be in the shape of a "table" (a non-sparse, rectangular, two-dimensional array).
    * This is different from the GROUP BY in SQL in that it doesn't apply an aggregate (like sum or average) to each group -- it just returns each group unmodified.
 

data/lib/qualitysmith_extensions/array/sequence.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Lance Ivy
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Not sure.
+#++
 
 class Array
 =begin rdoc

data/lib/qualitysmith_extensions/array/shell_escape.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes. Symbol#to_proc -> Facets
+#++
 
 require 'rubygems'
 require 'extensions/symbol' unless Symbol.method_defined?(:to_proc)

data/lib/qualitysmith_extensions/array/to_a_recursive.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes.
+#++
 
 class Array
   

data/lib/qualitysmith_extensions/array/to_query_string.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Anthony Kaufman, Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes.
+#++
 
 autoload :CGI, 'cgi'
 class Array

data/lib/qualitysmith_extensions/date/deprecated.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: No!
+#++
 
 # Depends on some niceties from ActiveSupport (which really should be in core Ruby but aren't)...
 require "rubygems"

data/lib/qualitysmith_extensions/date/iso8601.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes.
+#++
 
 require 'date'
 require 'rubygems'

data/lib/qualitysmith_extensions/date/month_ranges.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Not sure.
+#++
 
 # Depends on some niceties from ActiveSupport (which really should be in core Ruby but aren't)... Date.new(a, b, c)
 require "rubygems"

data/lib/qualitysmith_extensions/enumerable/enum.rb

@@ -1,29 +1,32 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes!
+#++
 
 require 'enumerator'
 module Enumerable
 
   # The core Enumerable module provides the following enumerator methods;
-  # * enum_cons()
-  # * enum_slice()
-  # * enum_with_index()
-  # but for some reason they didn't provide a generic enum() method for the cases they didn't think of!
+  # * <tt>enum_cons()</tt>
+  # * <tt>enum_slice()</tt>
+  # * <tt>enum_with_index()</tt>
+  # but for some reason they didn't provide a generic <tt>enum()</tt> method for the cases they didn't think of!
   #
-  # +enum+ lets you turn *any* iterator into a general-purpose Enumerator, which, according to the RDocs, is 
-  # "A class which provides a method `each' to be used as an Enumerable object."
+  # +enum+ lets you turn *any* iterator into a general-purpose <tt>Enumerator</tt>, which, according to the RDocs, is 
+  # "A class which provides a method `<tt>each</tt>' to be used as an <tt>Enumerable</tt> object."
   #
-  # This lets you turn any 'each'-type iterator (each_byte, each_line, ...) into a 'map'-type iterator, or into an array, etc.
+  # This lets you turn any '<tt>each'-type</tt> iterator (<tt>each_byte</tt>, <tt>each_line</tt>, ...) into a
+  # '<tt>map</tt>'-type iterator (one that returns a collection), or into an array, etc.
   #
-  # So if an object responds to :each_line but not to :map_lines or :lines, you could just do:
+  # So if an object responds to <tt>:each_line</tt> but not to <tt>:map_lines</tt> or <tt>:lines</tt>, you could just do:
   #   object.enum(:each_line).map { block }
-  #   object.enum(:each_line).to_a
   #   object.enum(:each_line).min
   #   object.enum(:each_line).grep /pattern/
+  #   lines = object.enum(:each_line).to_a
   #
-  # If no iterator is specified, :each is assumed:
+  # If no iterator is specified, <tt>:each</tt> is assumed:
   #   object.enum.map { block }
   #
   # More examples:
@@ -36,13 +39,7 @@ module Enumerable
   def enum(iterator = :each)
     Enumerable::Enumerator.new(self, iterator)
   end
-  # Old version, which I don't think was accurate since enum requires obj to be Enumerable as a prerequisite!:
-  #
-  # Lets you add the methods available to Enumerables to any object that responds to :each (or any other iterator).
-  # +enum+ returns a general-purpose Enumerator, which, according to the RDocs, is "A class which provides a method `each' to be used as an Enumerable object."
-  #
-  # This lets you use 'map'-type iterator, for example, on an object that only provides an 'each'-type iterator.
-  # So if an object only responds to :each, but you want to send it :map, you could just do:
+
 end
 
 #  _____         _

data/lib/qualitysmith_extensions/file/exact_match_regexp.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes
+#++
 
 # To do:
 # * Is there a more object-oriented way to do this? Instance method instead of class method?

data/lib/qualitysmith_extensions/file_test/binary_file.rb

@@ -1,3 +1,4 @@
+#--
 # Author::    Lloyd Zusman, Tyler Rick
 # Copyright:: Copyright (c) 2002-2007 Lloyd Zusman
 # License::   Ruby License
@@ -5,6 +6,7 @@
 # * 2002-10-05: Based on code posted by Lloyd Zusman on ruby-talk on 2002-10-05 (http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/52548) 
 # * 2007-03-15: Cleaned up a bit and wrote tests.
 # Submit to Facets?:: Yes
+#++
 
 module FileTest
 

data/lib/qualitysmith_extensions/global_variable_set.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: No, too ugly and unreliable.
+#++
 
 module Kernel
   # Gets the global variable +var+, which can either be a symbol or an actual global variable (use +:match_object+).

data/lib/qualitysmith_extensions/hash/to_date.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes. Unless it is deemed not generally reusable enough. Also, only if we can get a Date.new(y,m,d) added to Facets.
+#++
 
 require "rubygems"
 require "active_support"

data/lib/qualitysmith_extensions/hash/to_query_string.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Anthony Kaufman, Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes.
+#++
 
 autoload :CGI, 'cgi'
 require 'rubygems'

data/lib/qualitysmith_extensions/kernel/backtrace.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Not sure. This might not be necessary if caller() actually works reliably.
+#++
 
 require "rubygems"
 require "facet/string/lines"

data/lib/qualitysmith_extensions/kernel/capture_output.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes
+#++
 
 # :todo: Can we find a simpler way to do this based on facets' silence_stream?
   #

data/lib/qualitysmith_extensions/kernel/die.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes
+#++
 
 module Kernel
   def die(message)
@@ -17,7 +19,10 @@ end
 #   |_|\___||___/\__|
 #
 =begin test
+require 'rubygems'
 require 'qualitysmith_extensions/kernel/capture_output'
+#require 'facets/core/kernel/require_local'
+#require_local './capture_output'
 
 class TheTest < Test::Unit::TestCase
 

data/lib/qualitysmith_extensions/{filter_output.rb → kernel/filter_output.rb}

@@ -1,9 +1,10 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes.
 # Developer notes:
-# * Move to kernel/?
+#++
 
 require 'stringio'
 
@@ -46,7 +47,7 @@ end
 =begin test
 require 'test/unit'
 
-# Not sure whether it's better to duplicate for increased readability or metaprogram for decreased duplication...
+# Not sure whether it's better to duplicate for increased readability here or metaprogram for decreased duplication...
 
 # Duplicate for increased readability:
   def noisy_command

data/lib/qualitysmith_extensions/kernel/require_all.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes
+#++
 
 require 'rubygems'
 require 'facets/more/filelist'

data/lib/qualitysmith_extensions/kernel/require_once.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: No, not yet
+#++
 
 require 'rubygems'
 

data/lib/qualitysmith_extensions/{simulate_input.rb → kernel/simulate_input.rb}

@@ -1,9 +1,10 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes
 # Developer notes:
-# * Move to kernel/?
+#++
 
 require 'stringio'
 require 'rubygems'

data/lib/qualitysmith_extensions/month.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Not sure. Who really cares about Months anyway?
+#++
 
 require "rubygems"
 require "active_support"

data/lib/qualitysmith_extensions/object/singleton.rb

@@ -1,3 +1,4 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
@@ -14,51 +15,55 @@
 #     * extend_call
 #     * create_and_send
 #     * create_and_call
+#++
 
 class Object
 
   # Creates a singleton method and then calls it.
   #
-  # More specificaly, it +extend+s +self+ with the methods from +moduule+ and then sends the supplied +message+ and +args+ (if any).
+  # More specificaly, it <tt>extend</tt>s +self+ with the methods from +moduule+ and then sends the supplied +message+ and +args+ (if any).
   #
   # Advantages:
   # * Keeps things object-oriented. Better than having global/class methods.
-  # ** (<tt>"whatever".single_send(MyColorizer, :colorize).single_send(SomeOtherClass, :another_class_method)</tt> instead of <tt>SomeOtherClass::another_class_method(MyColorizer::colorize("whatever"))</tt>)
-  # ** Method calls are _listed_ in the order in which they are _called_.
+  #   * (<tt>"whatever".ss(MyColorizer, :colorize).ss(SomeOtherClass, :another_class_method)</tt> instead of 
+  #     * <tt>SomeOtherClass::another_class_method(MyColorizer::colorize("whatever"))</tt>)
+  #   * Method calls are _listed_ in the order in which they are _called_.
   # * Still lets you keep your methods in a namespace.
   # * Doesn't clutter up the base classes with methods that are only useful within a very small context. The methods are only added to the objects you specify. So you can "use" the base class <b>without cluttering up _all_ instances of the class with your methods</b>.
   # * Useful for cases where creating a subclass wouldn't help because the methods you are calling would still return instances of the base class.
   #
   # Disadvantages:
   # * You have to have/create a *module* for the functions you want to use.
-  # ** Can't just call .sigleton(self, :some_method) if some_method is defined in self.
-  # ** So what do we call the module containing the "singleton method"? String::MyColorizer? MyColorizer::String? MyStringColorizer?
+  #   * Can't just call .sigleton_send(self, :some_method) if you want to use +some_method+ that's defined in +self+.
+  #   * So what do we call the module containing the "singleton method"? String::MyColorizer? MyColorizer::String? MyStringColorizer?
   #
   # Examples:
-  # "whatever".singleton(MyColorizer, :colorize, :blue)
+  #   "whatever".ss(MyColorizer, :colorize, :blue)
   #
-  def singleton(moduule, message, *args)
+  def singleton_send(moduule, message, *args)
     self.extend(moduule)
     self.send(message, *args)
   end
+  alias_method :ss, :singleton_send
 
-  def singleton_that_accepts_object(object, method_name, *args)
-#    #class << self 
-#    #self.instance_eval do
-#    self.class.module_eval do
-#      define_method(:colorize2, object.class.instance_method(:colorize2))
-#    end
-#    # raises "TypeError: bind argument must be an instance of TheTest"
-
-#    object.class.instance_method(method_name).
-#      bind(self)
-#    # raises "TypeError: bind argument must be an instance of TheTest"
-
-#    self.class.extend(object.class)
-#    self.class.send(:include, object.class)
-#    # raises "TypeError: wrong argument type Class (expected Module)"
-    self.send(method_name, *args)
-  end
+  # Couldn't get this idea to work:
+#  def singleton_that_accepts_object(object, method_name, *args)
+##    #class << self 
+##    #self.instance_eval do
+##    self.class.module_eval do
+##      define_method(:colorize2, object.class.instance_method(:colorize2))
+##    end
+##    # raises "TypeError: bind argument must be an instance of TheTest"
+#
+##    object.class.instance_method(method_name).
+##      bind(self)
+##    # raises "TypeError: bind argument must be an instance of TheTest"
+#
+##    self.class.extend(object.class)
+##    self.class.send(:include, object.class)
+##    # raises "TypeError: wrong argument type Class (expected Module)"
+#    self.send(method_name, *args)
+#  end
 
 end
 
@@ -77,13 +82,21 @@ module MyColorizer
   end
 end
 
+
+#module PresentationLayer
+#  create_module_method :to_currency do
+#    #...
+#  end
+#end
+
+
 class TheTest < Test::Unit::TestCase
   def test_1
-    assert_equal "whatever (colorized in )", "whatever".singleton(MyColorizer, :colorize)
-    assert_equal "whatever (colorized in blue)", "whatever".singleton(MyColorizer, :colorize, :blue)
+    assert_equal "whatever (colorized in )", "whatever".ss(MyColorizer, :colorize)
+    assert_equal "whatever (colorized in blue)", "whatever".singleton_send(MyColorizer, :colorize, :blue)
   end
 
-#  def test_2
+#  def test_singleton_that_accepts_object
 #    assert_equal "whatever (colorized in )", "whatever".singleton_that_accepts_object(self, :colorize2)
 #    assert_equal "whatever (colorized in blue)", "whatever".singleton_that_accepts_object(self, :colorize2, :blue)
 #  end

data/lib/qualitysmith_extensions/string/digits_only.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes
+#++
 
 class String
   # Strips out everything except digits.

data/lib/qualitysmith_extensions/string/md5.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes
+#++
 
 require "digest/md5"
 

data/lib/qualitysmith_extensions/string/shell_escape.rb

@@ -1,7 +1,9 @@
+#--
 # 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/

data/lib/qualitysmith_extensions/string/to_underscored_label.rb

@@ -1,9 +1,11 @@
+#--
 # 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 

data/lib/qualitysmith_extensions/test/assert_changed.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes
+#++
 
 require 'test/unit'
 class Test::Unit::TestCase

data/lib/qualitysmith_extensions/test/assert_exception.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes
+#++
 
 require 'test/unit'
 class Test::Unit::TestCase

data/lib/qualitysmith_extensions/test/assert_includes.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: Yes
+#++
 
 require 'test/unit'
 class Test::Unit::TestCase

data/lib/qualitysmith_extensions/test/assert_user_error.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: No
+#++
 
 require 'test/unit'
 class Test::Unit::TestCase

data/lib/qualitysmith_extensions/time/deprecated.rb

@@ -1,7 +1,9 @@
+#--
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
 # Submit to Facets?:: No!
+#++
 
 class Time
   # This should be moved elsewhere because it is subjective and depends on the context where it's used.

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: qualitysmith_extensions
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2007-03-20 00:00:00 -07:00
+  version: 0.0.4
+date: 2007-03-21 00:00:00 -07:00
 summary: A collection of reusable Ruby methods developed by QualitySmith.
 require_paths: 
 - lib
@@ -29,10 +29,8 @@ authors:
 - Tyler Rick and others
 files: 
 - lib/qualitysmith_extensions/global_variable_set.rb
-- lib/qualitysmith_extensions/simulate_input.rb
 - lib/qualitysmith_extensions/collection_extensions_for_cgi.rb
 - lib/qualitysmith_extensions/all.rb
-- lib/qualitysmith_extensions/filter_output.rb
 - lib/qualitysmith_extensions/month.rb
 - lib/qualitysmith_extensions/test/assert_exception.rb
 - lib/qualitysmith_extensions/test/assert_user_error.rb
@@ -40,9 +38,11 @@ files:
 - lib/qualitysmith_extensions/test/assert_includes.rb
 - lib/qualitysmith_extensions/file_test/binary_file.rb
 - lib/qualitysmith_extensions/kernel/require_all.rb
+- lib/qualitysmith_extensions/kernel/simulate_input.rb
 - lib/qualitysmith_extensions/kernel/die.rb
 - lib/qualitysmith_extensions/kernel/require_once.rb
 - lib/qualitysmith_extensions/kernel/all.rb
+- lib/qualitysmith_extensions/kernel/filter_output.rb
 - lib/qualitysmith_extensions/kernel/backtrace.rb
 - lib/qualitysmith_extensions/kernel/capture_output.rb
 - lib/qualitysmith_extensions/object/singleton.rb