backports 1.7.1 → 1.8.0

data/CHANGELOG.rdoc

@@ -1,5 +1,12 @@
 = Packable --- History
 
+== Version 1.8 - August 30, 2009
+
+Backports can be required selectively:
+* backports/1.8.7
+* backports/1.9 (which include 1.8.7)
+* rails
+
 == Version 1.7.1 - August 20, 2009
 
 Enumerable#take and Enumerable#first(n) are now returning as soon as possible. Previously, #each was yielding one element too many. See redmine issue #1554.

data/README.rdoc

@@ -1,18 +1,32 @@
 = Backports Library
 
-Essential backports that make it possible to use some of the really nice features of Ruby 1.8.7, Ruby 1.9 and rails from Ruby 1.8.x
+Would you like to use features of Ruby 1.8.7 without the need of having 1.8.7 installed? Simply
 
-Conditions for inclusion:
-1. Standard in either Ruby or Rails
-2. Won't break older code
-3. Simple and self-contained
+  require 'backports/1.8.7'
 
-The first and second rules avoids conflicts in future and the past respectively. Because of the second rule, incompatibilities between 1.8 and 1.9 methods are left alone.
-For example, <tt>Module::instance_methods</tt> returns strings in 1.8 and symbols in 1.9; no change can be made without the risk of breaking existing code.
+All 1.8.7 features are now available! Some of the features of 1.9 are also available with
 
-More complex features of active-support (even things like <tt>String::pluralize</tt>), won't be included. <tt>require 'activesupport'</tt> if you need them and are not in rails!
+  require 'backports/1.9'
+
+Finally, some features of rails' active-support are also available with
+
+  require 'backports/rails'
+  
+If you want them all:
+
+  require 'backports'
 
-I've added these backports as I need them; pull requests welcome (with tests for Ruby 1.9 backports)
+== What's inside
+
+All features of 1.8.7 are backported (well, almost all, see the exception list bellow).
+
+Conditions for inclusion of ruby 1.9 and activesupport features:
+1. Won't break older code
+2. Simple and self-contained
+
+For example, <tt>Module::instance_methods</tt> returns strings in 1.8 and symbols in 1.9; no change can be made without the risk of breaking existing code. Such incompatibilities between 1.8 and 1.9 methods are left unchanged.
+
+More complex features of active-support (even things like <tt>String::pluralize</tt>), won't be included. <tt>require 'activesupport'</tt> if you need them and are not in rails!
 
 == Installation & compatibility
 
@@ -23,58 +37,39 @@ I've added these backports as I need them; pull requests welcome (with tests for
 To use:
 
   require 'rubygems'
-  require 'backports'
+  require 'backports'   # or a subset like "backports/1.8.7"
   # and off you go!
 
-Compatible with Ruby 1.8 & 1.9.
+Compatible with Ruby 1.8 & 1.9, jruby and rubinius.
 
-= List of backports
+= Complete List of backports
 
 == Ruby 1.8.7
 
-Complete Ruby 1.8.7 backporting. Refer to the official list of changes[http://svn.ruby-lang.org/repos/ruby/tags/v1_8_7/NEWS]. All builtin classes are compatible with Ruby 1.8.7: 
-* Array
-* Binding
-* Dir
-* Enumerable
-* Enumerator
-* Fixnum
-* Hash
-* Integer
-* IO (& ARGF)
-* Method
-* Numeric
-* Object
-* ObjectSpace
-* Range
-* Regexp
-* Symbol
-* UnboundMethod
+Complete Ruby 1.8.7 backporting. Refer to the official list of changes[http://svn.ruby-lang.org/repos/ruby/tags/v1_8_7/NEWS].
 
 Only exceptions:
 * String#gsub
 * GC.stress=
 * Process.exec
+* Array#choice (use Array#sample instead)
 * recursive data handling (Array and Hash)
 
-As in Ruby 1.8.7+, there is no need to <tt>require 'enumerator'</tt> in older Ruby, and +Enumerator+ can be accessed directly (instead of <tt>Enumerable::Enumerator</tt>)
-
 == Ruby 1.9
 
 Additionally, the following Ruby 1.9 have been backported:
 
 * Array
-  * +sample+
+  * +try_convert+
 
 * Enumerable
   * +each_with_object+
-  * +reverse_each+
 
 * Enumerator
   * +new+ (with block)
 
 * Hash
-  * <tt>Hash[[[:foo, :bar],[:hello, "world"]]] ==> {:foo => :bar, :hello => "world"}</tt> (see _note_)
+  * +try_convert+
   * <tt>default_proc=</tt>
 
 * Kernel
@@ -93,7 +88,7 @@ Additionally, the following Ruby 1.9 have been backported:
   * +clear+
   * +codepoints+, +each_codepoint+
 
-_note_: This usage of <tt>Hash::[]</tt> is not yet documented[http://redmine.ruby-lang.org/issues/show/1385].
++Enumerator+ can be accessed directly (instead of <tt>Enumerable::Enumerator</tt>)
 
 == Rails
 

data/Rakefile

@@ -22,6 +22,9 @@ begin
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
@@ -62,30 +65,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.title = "backports #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-begin
-  require 'rake/contrib/sshpublisher'
-  namespace :rubyforge do
-    
-    desc "Release gem and RDoc documentation to RubyForge"
-    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
-    
-    namespace :release do
-      desc "Publish RDoc to RubyForge."
-      task :docs => [:rdoc] do
-        config = YAML.load(
-            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
-        )
-
-        host = "#{config['username']}@rubyforge.org"
-        remote_dir = "/var/www/gforge-projects/backports/"
-        local_dir = 'rdoc'
-
-        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
-      end
-    end
-  end
-rescue LoadError
-  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
-end
+end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
-:minor: 7
-:patch: 1
+:minor: 8
+:patch: 0

data/backports.gemspec

@@ -1,13 +1,17 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{backports}
-  s.version = "1.7.1"
+  s.version = "1.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marc-Andr\303\251 Lafortune"]
-  s.date = %q{2009-08-20}
-  s.description = %q{Essential backports that enable some of the really nice features of ruby 1.8.7, ruby 1.9 and rails from ruby 1.8.6 and earlier.}
+  s.date = %q{2009-08-31}
+  s.description = %q{      Essential backports that enable some of the really nice features of ruby 1.8.7, ruby 1.9 and rails from ruby 1.8.6 and earlier.
+}
   s.email = %q{github@marc-andre.ca}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -23,32 +27,49 @@ Gem::Specification.new do |s|
      "VERSION.yml",
      "backports.gemspec",
      "lib/backports.rb",
-     "lib/backports/argf.rb",
-     "lib/backports/array.rb",
-     "lib/backports/binding.rb",
-     "lib/backports/core_ext.rb",
-     "lib/backports/dir.rb",
-     "lib/backports/enumerable.rb",
-     "lib/backports/enumerator.rb",
-     "lib/backports/env.rb",
-     "lib/backports/fixnum.rb",
-     "lib/backports/float.rb",
-     "lib/backports/gc.rb",
-     "lib/backports/hash.rb",
-     "lib/backports/integer.rb",
-     "lib/backports/io.rb",
-     "lib/backports/kernel.rb",
-     "lib/backports/method.rb",
-     "lib/backports/module.rb",
-     "lib/backports/numeric.rb",
-     "lib/backports/object_space.rb",
-     "lib/backports/proc.rb",
-     "lib/backports/process.rb",
-     "lib/backports/range.rb",
-     "lib/backports/regexp.rb",
-     "lib/backports/string.rb",
-     "lib/backports/struct.rb",
-     "lib/backports/symbol.rb",
+     "lib/backports/1.8.7.rb",
+     "lib/backports/1.8.7/argf.rb",
+     "lib/backports/1.8.7/array.rb",
+     "lib/backports/1.8.7/binding.rb",
+     "lib/backports/1.8.7/dir.rb",
+     "lib/backports/1.8.7/enumerable.rb",
+     "lib/backports/1.8.7/enumerator.rb",
+     "lib/backports/1.8.7/env.rb",
+     "lib/backports/1.8.7/fixnum.rb",
+     "lib/backports/1.8.7/float.rb",
+     "lib/backports/1.8.7/gc.rb",
+     "lib/backports/1.8.7/hash.rb",
+     "lib/backports/1.8.7/integer.rb",
+     "lib/backports/1.8.7/io.rb",
+     "lib/backports/1.8.7/kernel.rb",
+     "lib/backports/1.8.7/method.rb",
+     "lib/backports/1.8.7/module.rb",
+     "lib/backports/1.8.7/numeric.rb",
+     "lib/backports/1.8.7/object_space.rb",
+     "lib/backports/1.8.7/proc.rb",
+     "lib/backports/1.8.7/process.rb",
+     "lib/backports/1.8.7/range.rb",
+     "lib/backports/1.8.7/regexp.rb",
+     "lib/backports/1.8.7/string.rb",
+     "lib/backports/1.8.7/struct.rb",
+     "lib/backports/1.8.7/symbol.rb",
+     "lib/backports/1.9.rb",
+     "lib/backports/1.9/array.rb",
+     "lib/backports/1.9/enumerable.rb",
+     "lib/backports/1.9/enumerator.rb",
+     "lib/backports/1.9/hash.rb",
+     "lib/backports/1.9/integer.rb",
+     "lib/backports/1.9/kernel.rb",
+     "lib/backports/1.9/string.rb",
+     "lib/backports/1.9/symbol.rb",
+     "lib/backports/rails.rb",
+     "lib/backports/rails/array.rb",
+     "lib/backports/rails/enumerable.rb",
+     "lib/backports/rails/hash.rb",
+     "lib/backports/rails/kernel.rb",
+     "lib/backports/rails/module.rb",
+     "lib/backports/rails/string.rb",
+     "lib/backports/tools.rb",
      "test/array_test.rb",
      "test/binding_test.rb",
      "test/enumerable_test.rb",
@@ -63,12 +84,11 @@ Gem::Specification.new do |s|
      "test/symbol_test.rb",
      "test/test_helper.rb"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/marcandre/backports}
   s.rdoc_options = ["--charset=UTF-8", "--title", "Backports library", "--main", "README.rdoc", "--line-numbers", "--inline-source"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{backports}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Backports or ruby 1.8.7+ & rails for older ruby.}
   s.test_files = [
     "test/array_test.rb",
@@ -88,7 +108,7 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else

data/lib/backports.rb

@@ -1,15 +1,4 @@
-module Kernel
-  # Standard in ruby 1.9.
-  def require_relative(relative_feature)
-    # Adapted from Pragmatic's "Programming Ruby" (since their version was buggy...)
-    file = caller.first.split(/:\d/,2).first
-    if /\A\((.*)\)/ =~ file # eval, etc. 
-      raise LoadError, "require_relative is called in #{$1}" 
-    end 
-    require File.expand_path(relative_feature, File.dirname(file))
-  end unless method_defined? :require_relative
-end
-
-%w(core_ext module kernel array enumerable enumerator string symbol integer numeric fixnum hash proc binding dir io method regexp struct float object_space argf gc env process).each do |lib|
-  require_relative "backports/#{lib}"
-end
+require File.expand_path(File.dirname(__FILE__) + "/backports/tools")
+Backports.require_relative "backports/1.8.7"
+Backports.require_relative "backports/1.9"
+Backports.require_relative "backports/rails"

data/lib/backports/1.8.7.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + "/tools")
+%w(module kernel array enumerable enumerator string symbol integer numeric fixnum hash proc binding dir io method regexp struct float object_space argf gc env process).each do |lib|
+  Backports.require_relative "1.8.7/#{lib}"
+end

data/lib/backports/{argf.rb → 1.8.7/argf.rb}

@@ -1,22 +1,22 @@
 if RUBY_VERSION < '1.8.7'
   class << ARGF
-    # Standard in Ruby 1.8.7.
-    make_block_optional :each, :each_line, :each_byte
+    # No official documentation...
+    Backports.make_block_optional self, :each, :each_line, :each_byte
   end
 end
 
 class << ARGF
-  # Standard in Ruby 1.8.7.
+  # No official documentation...
   def bytes
     to_enum :each_byte
   end unless method_defined? :bytes
 
-  # Standard in Ruby 1.8.7.
+  # No official documentation...
   def chars
     to_enum :each_char
   end unless method_defined? :chars
 
-  # Standard in Ruby 1.8.7.
+  # No official documentation...
   def each_char
     return to_enum(:each_char) unless block_given?
     if $KCODE == "UTF-8"
@@ -44,13 +44,13 @@ class << ARGF
     self
   end unless method_defined? :each_char
 
-  # Standard in Ruby 1.8.7.
+  # No official documentation...
   alias_method :getbyte, :getc
 
-  # Standard in Ruby 1.8.7.
+  # No official documentation...
   alias_method :readbyte, :readchar
 
-  # Standard in Ruby 1.8.7.
+  # No official documentation...
   def lines(*args)
     to_enum :each_line, *args
   end unless method_defined? :lines

data/lib/backports/{array.rb → 1.8.7/array.rb}

@@ -1,19 +1,7 @@
 class Array
-  # Standard in Ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
-  class << self
-    # Try to convert obj into an array, using to_ary method.
-    # Returns converted array or nil if obj cannot be converted
-    # for any reason. This method is to check if an argument is an array.
-    def try_convert(obj)
-      return nil unless obj.respond_to?(:to_ary)
-      Type.coerce_to(obj, Array, :to_ary)
-    end
-  end
-
-
   # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
   def combination(num)
-    num = Type.coerce_to num, Fixnum, :to_int
+    num = Backports.coerce_to num, Fixnum, :to_int
     return to_enum(:combination, num) unless block_given?
     return self unless (0..size).include? num
     # Implementation note: slightly tricky.
@@ -36,19 +24,14 @@ class Array
     if n.nil?
       loop(&block)
     else
-      n = Type.coerce_to n, Fixnum, :to_int
+      n = Backports.coerce_to n, Fixnum, :to_int
       n.times{each(&block)}
     end
     nil
   end unless method_defined? :cycle
 
-  # Standard in rails, and we use it here...
-  def extract_options!
-    last.is_a?(::Hash) ? pop : {}
-  end unless method_defined? :extract_options!
-
   # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
-  make_block_optional :collect!, :map!, :each, :each_index, :reverse_each, :reject, :reject!, :delete_if, :test_on => [42]
+  Backports.make_block_optional self, :collect!, :map!, :each, :each_index, :reverse_each, :reject, :reject!, :delete_if, :test_on => [42]
 
   # flatten & flatten!, standard in ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
   unless ([[]].flatten(1) rescue false)
@@ -63,7 +46,7 @@ class Array
     # made, returns nil, otherwise self.
     # Adapted from rubinius'
     def flatten_with_optional_argument!(level=-1)
-      level = Type.coerce_to(level, Integer, :to_int)
+      level = Backports.coerce_to(level, Integer, :to_int)
       return flatten_without_optional_argument! unless level >= 0
 
       ret, out = nil, []
@@ -72,8 +55,8 @@ class Array
       ret
     end
 
-    alias_method_chain :flatten, :optional_argument
-    alias_method_chain :flatten!, :optional_argument
+    Backports.alias_method_chain self, :flatten, :optional_argument
+    Backports.alias_method_chain self, :flatten!, :optional_argument
 
     # Helper to recurse through flattening
     # Adapted from rubinius'; recursion guards are not needed because level is finite
@@ -103,57 +86,57 @@ class Array
       each_with_index{|o,i| return i if yield o}
       return nil
     end
-    alias_method_chain :index, :block
+    Backports.alias_method_chain self, :index, :block
     alias_method :find_index, :index
   end
 
   # pop. Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
   unless ([1].pop(1) rescue false)
-    def pop_with_optional_argument(n = Undefined)
-      return pop_without_optional_argument if n == Undefined
-      n = Type.coerce_to(n, Fixnum, :to_int)
+    def pop_with_optional_argument(n = Backports::Undefined)
+      return pop_without_optional_argument if n == Backports::Undefined
+      n = Backports.coerce_to(n, Fixnum, :to_int)
       raise ArgumentError, "negative array size" if n < 0
       first = size - n
       first = 0 if first < 0
       slice!(first..size).to_a
     end
-    alias_method_chain :pop, :optional_argument
+    Backports.alias_method_chain self, :pop, :optional_argument
   end
 
-  # Standard in Ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
+  # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
   def product(*arg)
     # Implementation notes: We build an enumerator for all the combinations
     # by building it up successively using "inject" and starting from a trivial enumerator.
     # It would be easy to have "product" yield to a block but the standard
     # simply returns an array, so you'll find a simple call to "to_a" at the end.
     #
-    trivial_enum = Enumerator.new{|yielder| yielder.yield [] }
-    [self, *arg].map{|x| Type.coerce_to(x, Array, :to_ary)}.
+    trivial_enum = Enumerator.new(Backports::Yielder.new{|yielder| yielder.yield [] })  # Enumerator.new{...} is 1.9+ only
+    [self, *arg].map{|x| Backports.coerce_to(x, Array, :to_ary)}.
       inject(trivial_enum) do |enum, array|
-        Enumerator.new do |yielder|
+        Enumerator.new(Backports::Yielder.new do |yielder|   # Enumerator.new{...} is 1.9+ only
           enum.each do |partial_product|
             array.each do |obj|
               yielder.yield partial_product + [obj]
             end
           end
-        end
+        end)
     end.to_a
   end unless method_defined? :product
 
-  # rindex
+  # rindex. Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
   unless ([1].rindex{true} rescue false)
     def rindex_with_block(*arg)
       return rindex_without_block(*arg) unless block_given? && arg.empty?
       reverse_each.each_with_index{|o,i| return size - 1 - i if yield o}
       return nil
     end
-    alias_method_chain :rindex, :block
+    Backports.alias_method_chain self, :rindex, :block
   end
 
   # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
-  def sample(n = Undefined)
-    return self[rand(size)] if n == Undefined
-    n = Type.coerce_to(n, Fixnum, :to_int)
+  def sample(n = Backports::Undefined)
+    return self[rand(size)] if n == Backports::Undefined
+    n = Backports.coerce_to(n, Fixnum, :to_int)
     raise ArgumentError, "negative array size" if n < 0
     n = size if n > size
     result = Array.new(self)
@@ -164,16 +147,16 @@ class Array
     result[n..size] = []
     result
   end unless method_defined? :sample
-
+  
   # shift. Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
   unless ([1].shift(1) rescue false)
-    def shift_with_optional_argument(n = Undefined)
-      return shift_without_optional_argument if n == Undefined
-      n = Type.coerce_to(n, Fixnum, :to_int)
+    def shift_with_optional_argument(n = Backports::Undefined)
+      return shift_without_optional_argument if n == Backports::Undefined
+      n = Backports.coerce_to(n, Fixnum, :to_int)
       raise ArgumentError, "negative array size" if n < 0
       slice!(0, n)
     end
-    alias_method_chain :shift, :optional_argument
+    Backports.alias_method_chain self, :shift, :optional_argument
   end
 
   # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]