extlib 0.9.8 → 0.9.9

data/History.txt

@@ -0,0 +1,22 @@
+=== 0.9.9 / 2008-12-07
+
+* 1 major enhancement:
+
+  * Updated LazyArray to have a tail/head so that it can append/prepend
+    without lazy-loading.  This will eliminate some too-eager loading
+    from DataMapper::Collection, and (in certain cases) will boost
+    performance significantly.
+
+* 3 minor enhancements:
+
+  * Minor Ruby 1.9.1 fixes.  RSpec still needs to be updated to support
+    1.9.1 before everything can be verified completely.
+  * Updated Extlib::Inflection so that the plural of "cow" is now
+    "cows" instead of "kine".
+  * Misc documentation updates.
+
+* 2 bug fixes:
+
+  * Fixed Extlib::Pooling Threading issue on JRuby and Windows.
+  * Removed Object#encoded_hash.  It was not used by DataMapper or Merb,
+    and the specs were failing for JRuby.

data/LICENSE

@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -28,6 +28,14 @@ GEM_VERSION = Extlib::VERSION + PKG_BUILD
 
 RELEASE_NAME    = "REL #{GEM_VERSION}"
 
+WINDOWS = (RUBY_PLATFORM =~ /win32|mingw|bccwin|cygwin/) rescue nil
+JRUBY   = (RUBY_PLATFORM =~ /java/) rescue nil
+
+# sudo is used by default, except on Windows, or if SUDOLESS env is true
+SUDO = WINDOWS ? '' : ('sudo' unless ENV['SUDOLESS'])
+# RCov is run by default, except on the JRuby platform, or if NO_RCOV env is true
+RUN_RCOV = JRUBY ? false : (ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true)
+
 require "lib/extlib/tasks/release"
 
 spec = Gem::Specification.new do |s|
@@ -39,12 +47,12 @@ spec = Gem::Specification.new do |s|
   s.homepage     = PROJECT_URL
   s.summary      = PROJECT_SUMMARY
   s.description  = PROJECT_DESCRIPTION
-  s.require_path = "lib"
-  s.files        = ["LICENSE", "README.txt", "Rakefile"] + Dir["lib/**/*"]
+  s.require_path = 'lib'
+  s.files        = %w[ LICENSE README Rakefile History.txt ] + Dir['lib/**/*'] + Dir['spec/**/*']
 
   # rdoc
   s.has_rdoc         = false
-  s.extra_rdoc_files = ["LICENSE", "README.txt"]
+  s.extra_rdoc_files = %w[ LICENSE README History.txt ]
 
   # Dependencies
   # s.add_dependency "english", ">=0.2.0"
@@ -70,11 +78,12 @@ namespace :extlib do
     t.spec_files = Pathname.glob(ENV['FILES'] || 'spec/**/*_spec.rb')
 
     begin
-      t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
+      gem 'rcov'
+      t.rcov = RUN_RCOV
       t.rcov_opts << '--exclude' << 'spec'
       t.rcov_opts << '--text-summary'
       t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
-    rescue Exception
+    rescue LoadError
       # rcov not installed
     end
   end
@@ -95,10 +104,6 @@ task :doc do
   end
 end
 
-WINDOWS = (RUBY_PLATFORM =~ /win32|mingw|bccwin|cygwin/) rescue nil
-SUDO    = WINDOWS ? '' : ('sudo' unless ENV['SUDOLESS'])
-
-
 desc "Install #{GEM_NAME}"
 task :install => :package do
   sh %{#{SUDO} gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources}
@@ -106,7 +111,7 @@ end
 
 if WINDOWS
   namespace :dev do
-    desc 'Install for development (for windows)'
+    desc 'Install for development (for Windows)'
     task :winstall => :gem do
       system %{gem install --no-rdoc --no-ri -l pkg/#{GEM_NAME}-#{GEM_VERSION}.gem}
     end
@@ -169,9 +174,9 @@ namespace :benchmark do
   desc "Runs benchmarks"
   task :run do
     files = Dir["benchmarks/**/*.rb"]
-    
+
     files.each do |f|
       system "ruby #{f}"
     end
-  end  
+  end
 end

data/lib/extlib.rb

@@ -53,4 +53,4 @@ module Extlib
     @exiting
   end
 
-end
+end

data/lib/extlib/blank.rb

@@ -1,58 +1,88 @@
 class Object
-  # @return <TrueClass, FalseClass>
-  #
-  # @example [].blank?         #=>  true
-  # @example [1].blank?        #=>  false
-  # @example [nil].blank?      #=>  false
-  # 
+  ##
   # Returns true if the object is nil or empty (if applicable)
+  #
+  #   [].blank?         #=>  true
+  #   [1].blank?        #=>  false
+  #   [nil].blank?      #=>  false
+  #
+  # @return [TrueClass, FalseClass]
+  #
+  # @api public
   def blank?
     nil? || (respond_to?(:empty?) && empty?)
   end
 end # class Object
 
 class Numeric
-  # @return <TrueClass, FalseClass>
-  # 
-  # Numerics can't be blank
+  ##
+  # Numerics are never blank
+  #
+  #   0.blank?          #=>  false
+  #   1.blank?          #=>  false
+  #   6.54321.blank?    #=>  false
+  #
+  # @return [FalseClass]
+  #
+  # @api public
   def blank?
     false
   end
 end # class Numeric
 
 class NilClass
-  # @return <TrueClass, FalseClass>
-  # 
-  # Nils are always blank
+  ##
+  # Nil is always blank
+  #
+  #   nil.blank?        #=>  true
+  #
+  # @return [TrueClass]
+  #
+  # @api public
   def blank?
     true
   end
 end # class NilClass
 
 class TrueClass
-  # @return <TrueClass, FalseClass>
-  # 
-  # True is not blank.  
+  ##
+  # True is never blank.
+  #
+  #   true.blank?       #=>  false
+  #
+  # @return [FalseClass]
+  #
+  # @api public
   def blank?
     false
   end
 end # class TrueClass
 
 class FalseClass
+  ##
   # False is always blank.
+  #
+  #   false.blank?      #=>  true
+  #
+  # @return [TrueClass]
+  #
+  # @api public
   def blank?
     true
   end
 end # class FalseClass
 
 class String
-  # @example "".blank?         #=>  true
-  # @example "     ".blank?    #=>  true
-  # @example " hey ho ".blank? #=>  false
-  # 
-  # @return <TrueClass, FalseClass>
-  # 
+  ##
   # Strips out whitespace then tests if the string is empty.
+  #
+  #   "".blank?         #=>  true
+  #   "     ".blank?    #=>  true
+  #   " hey ho ".blank? #=>  false
+  #
+  # @return [TrueClass, FalseClass]
+  #
+  # @api public
   def blank?
     strip.empty?
   end

data/lib/extlib/boolean.rb

@@ -8,4 +8,4 @@ class FalseClass
   def try_dup
     self
   end
-end
+end

data/lib/extlib/class.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2004-2008 David Heinemeier Hansson
-# 
+#
 # 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
@@ -7,10 +7,10 @@
 # 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
@@ -73,7 +73,7 @@ class Class
           @@#{sym} = obj
         end
       RUBY
-      
+
       unless options[:instance_writer] == false
         class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
           def #{sym}=(obj)
@@ -111,14 +111,14 @@ class Class
   #   less useful.
   def class_inheritable_reader(*ivars)
     instance_reader = ivars.pop[:reader] if ivars.last.is_a?(Hash)
-    
+
     ivars.each do |ivar|
       self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def self.#{ivar}
-          return @#{ivar} if self == #{self} || defined?(@#{ivar})
+          return @#{ivar} if self.object_id == #{self.object_id} || defined?(@#{ivar})
           ivar = superclass.#{ivar}
           return nil if ivar.nil? && !#{self}.instance_variable_defined?("@#{ivar}")
-          @#{ivar} = ivar && !ivar.is_a?(Module) && !ivar.is_a?(Numeric) ? ivar.dup : ivar
+          @#{ivar} = ivar && !ivar.is_a?(Module) && !ivar.is_a?(Numeric) && !ivar.is_a?(TrueClass) && !ivar.is_a?(FalseClass) ? ivar.dup : ivar
         end
       RUBY
       unless instance_reader == false
@@ -130,7 +130,7 @@ class Class
       end
     end
   end
-  
+
   # Defines class-level inheritable attribute writer. Attributes are available to subclasses,
   # each subclass has a copy of parent's attribute.
   #
@@ -141,14 +141,14 @@ class Class
   #
   # @api public
   #
-  # @todo We need a style for class_eval <<-HEREDOC. I'd like to make it 
+  # @todo We need a style for class_eval <<-HEREDOC. I'd like to make it
   #   class_eval(<<-RUBY, __FILE__, __LINE__), but we should codify it somewhere.
   def class_inheritable_writer(*ivars)
     instance_writer = ivars.pop[:instance_writer] if ivars.last.is_a?(Hash)
     ivars.each do |ivar|
       self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def self.#{ivar}=(obj)
-          @#{ivar} = obj        
+          @#{ivar} = obj
         end
       RUBY
       unless instance_writer == false
@@ -158,11 +158,11 @@ class Class
       end
     end
   end
-  
+
   # Defines class-level inheritable attribute accessor. Attributes are available to subclasses,
   # each subclass has a copy of parent's attribute.
   #
-  # @param *syms<Array[*#to_s, Hash{:instance_writer => Boolean}]> Array of attributes to 
+  # @param *syms<Array[*#to_s, Hash{:instance_writer => Boolean}]> Array of attributes to
   #   define inheritable accessor for.
   # @option syms :instance_writer<Boolean> if true, instance-level inheritable attribute writer is defined.
   # @return <Array[#to_s]> An Array of attributes turned into inheritable accessors.

data/lib/extlib/datetime.rb

@@ -1,9 +1,27 @@
+require "date"
+
 class DateTime
+  ##
+  # Convert to Time object (for DateTime/Time conversion protocol).
+  #
+  #   DateTime.now.to_time    #=> Wed Nov 19 20:04:51 -0800 2008
+  #
+  # @return [Time] Time object representing the same moment as receiver
+  #
+  # @api public
   def to_time
     Time.parse self.to_s
   end
-  
+
+  ##
+  # Return receiver (for DateTime/Time conversion protocol).
+  #
+  #   DateTime.now.to_datetime    #=> #<DateTime: 212093913977/86400,-1/3,2299161>
+  #
+  # @return [DateTime] Receiver
+  #
+  # @api public
   def to_datetime
     self
   end
-end
+end

data/lib/extlib/dictionary.rb

@@ -407,7 +407,7 @@ class Dictionary
     each { |k,v| ary << [k,v] }
     ary
   end
-  
+
   def to_json
     buf = "["
     map do |k,v|
@@ -430,4 +430,4 @@ class Dictionary
   def to_h
     @hash.dup
   end
-end
+end

data/lib/extlib/hash.rb

@@ -2,15 +2,13 @@ class Hash
   class << self
     # Converts valid XML into a Ruby Hash structure.
     #
-    # @param xml<String> A string representation of valid XML.
+    # Mixed content is treated as text and any tags in it are left unparsed
     #
-    # @note Mixed content is treated as text and any tags in it are left unparsed
-    # @note Any attributes other than type on a node containing a text node will be
-    #   discarded
+    # Any attributes other than type on a node containing a text node will be
+    # discarded
     #
-    # @details [Typecasting]
-    #   Typecasting is performed on elements that have a +type+ attribute:
-    #   integer::
+    # [Typecasting is performed on elements that have a +type+ attribute:]
+    #   integer:: Returns an Integer
     #   boolean:: Anything other than "true" evaluates to false.
     #   datetime::
     #     Returns a Time object. See Time documentation for valid Time strings.
@@ -19,7 +17,8 @@ class Hash
     #
     # Keys are automatically converted to +snake_case+
     #
-    # @example [Simple]
+    # [Simple]
+    #
     #   <user gender='m'>
     #     <age type='integer'>35</age>
     #     <name>Home Simpson</name>
@@ -28,7 +27,7 @@ class Hash
     #     <is-cool type='boolean'>true</is-cool>
     #   </user>
     #
-    #   evaluates to
+    # Becomes:
     #
     #   { "user" => {
     #       "gender"    => "m",
@@ -40,48 +39,56 @@ class Hash
     #     }
     #   }
     #
-    # @example [Mixed Content]
+    # [Mixed Content]
+    #
     #   <story>
     #     A Quick <em>brown</em> Fox
     #   </story>
     #
-    #   evaluates to
+    # Evaluates to:
     #
     #   { "story" => "A Quick <em>brown</em> Fox" }
     #
-    # @details [Attributes other than type on a node containing text]
+    # [Attributes other than type on a node containing text]
+    #
     #   <story is-good='false'>
     #     A Quick <em>brown</em> Fox
     #   </story>
     #
-    #   evaluates to
+    # Are ignored:
     #
     #   { "story" => "A Quick <em>brown</em> Fox" }
     #
+    # [Other attributes in addition to +type+]
+    #
     #   <bicep unit='inches' type='integer'>60</bicep>
     #
-    #   evaluates with a typecast to an integer. But unit attribute is ignored.
+    # Evaluates with a typecast to an integer. But unit attribute is ignored:
     #
     #   { "bicep" => 60 }
+    #
+    # @param [String] xml A string representation of valid XML.
+    #
+    # @return [Hash] A hash created by parsing +xml+
     def from_xml( xml )
       ToHashParser.from_xml(xml)
     end
   end
-  
-  # This class has semantics of ActiveSupport's HashWithIndifferentAccess
-  # and we only have it so that people can write
+
+  # Convert to Mash. This class has semantics of ActiveSupport's
+  # HashWithIndifferentAccess and we only have it so that people can write
   # params[:key] instead of params['key'].
   #
-  # @return <Mash> This hash as a Mash for string or symbol key access.
+  # @return [Mash] This hash as a Mash for string or symbol key access.
   def to_mash
     hash = Mash.new(self)
     hash.default = default
     hash
   end
 
-  # @return <String> This hash as a query string
+  ##
+  # Convert to URL query param string
   #
-  # @example
   #   { :name => "Bob",
   #     :address => {
   #       :street => '111 Ruby Ave.',
@@ -90,18 +97,27 @@ class Hash
   #     }
   #   }.to_params
   #     #=> "name=Bob&address[city]=Ruby Central&address[phones][]=111-111-1111&address[phones][]=222-222-2222&address[street]=111 Ruby Ave."
+  #
+  # @return [String] This hash as a query string
+  #
+  # @api public
   def to_params
     params = self.map { |k,v| normalize_param(k,v) }.join
     params.chop! # trailing &
     params
   end
 
-  # @param key<Object> The key for the param.
-  # @param value<Object> The value for the param.
+  ##
+  # Convert a key, value pair into a URL query param string
+  #
+  #   normalize_param(:name, "Bob")   #=> "name=Bob&"
+  #
+  # @param [Object] key The key for the param.
+  # @param [Object] value The value for the param.
   #
   # @return <String> This key value pair as a param
   #
-  # @example normalize_param(:name, "Bob") #=> "name=Bob&"
+  # @api public
   def normalize_param(key, value)
     param = ''
     stack = []
@@ -127,26 +143,33 @@ class Hash
     param
   end
 
-  # @param *allowed<Array[(String, Symbol)]> The hash keys to include.
+  ##
+  # Create a hash with *only* key/value pairs in receiver and +allowed+
   #
-  # @return <Hash> A new hash with only the selected keys.
+  #   { :one => 1, :two => 2, :three => 3 }.only(:one)    #=> { :one => 1 }
   #
-  # @example
-  #   { :one => 1, :two => 2, :three => 3 }.only(:one)
-  #     #=> { :one => 1 }
+  # @param [Array[String, Symbol]] *allowed The hash keys to include.
+  #
+  # @return [Hash] A new hash with only the selected keys.
+  #
+  # @api public
   def only(*allowed)
     hash = {}
     allowed.each {|k| hash[k] = self[k] if self.has_key?(k) }
     hash
   end
 
-  # @param *rejected<Array[(String, Symbol)] The hash keys to exclude.
-  #
-  # @return <Hash> A new hash without the selected keys.
+  ##
+  # Create a hash with all key/value pairs in receiver *except* +rejected+
   #
-  # @example
-  #   { :one => 1, :two => 2, :three => 3 }.except(:one)
+  #    { :one => 1, :two => 2, :three => 3 }.except(:one)
   #     #=> { :two => 2, :three => 3 }
+  #
+  # @param [Array[String, Symbol]] *rejected The hash keys to exclude.
+  #
+  # @return [Hash] A new hash without the selected keys.
+  #
+  # @api public
   def except(*rejected)
     hash = self.dup
     rejected.each {|k| hash.delete(k) }
@@ -188,7 +211,7 @@ class Hash
   #
   # @return <Array> An array of they hash's keys
   #
-  # @example 
+  # @example
   #   hash = { One => 1, Two => 2 }.proctect_keys!
   #   hash # => { "One" => 1, "Two" => 2 }
   def protect_keys!