marcandre-backports 1.6.8 → 1.7.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+*.rbc
+.DS_Store
+coverage
+rdoc
+pkg
+assets

data/CHANGELOG.rdoc

@@ -1,5 +1,13 @@
 = Packable --- History
 
+== Version 1.7 - May 27, 2009
+
+Porting all 1.8.7 features to rubinius was quite enlightening (http://blog.marc-andre.ca/2009/05/schizo-ruby-puzzle.html ).
+Many improvements were made to be consistent with MRI, e.g. converting arguments using to_int if needed, etc...
+The changes are now reflected in 'backports'.
+
+Some IO and ARGF methods were missing and are now complete.
+
 == Version 1.6.6 - April 30, 2009
 
 Important bug fix. String#gsub is left alone until I find a good way to modify it.

data/VERSION.yml

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

data/backports.gemspec

@@ -0,0 +1,98 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{backports}
+  s.version = "1.7.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-05-28}
+  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",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "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",
+     "test/array_test.rb",
+     "test/binding_test.rb",
+     "test/enumerable_test.rb",
+     "test/enumerator_test.rb",
+     "test/hash_test.rb",
+     "test/kernel_test.rb",
+     "test/method_test.rb",
+     "test/module_test.rb",
+     "test/object_test.rb",
+     "test/regexp_test.rb",
+     "test/string_test.rb",
+     "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.summary = %q{Backports or ruby 1.8.7+ & rails for older ruby.}
+  s.test_files = [
+    "test/array_test.rb",
+     "test/binding_test.rb",
+     "test/enumerable_test.rb",
+     "test/enumerator_test.rb",
+     "test/hash_test.rb",
+     "test/kernel_test.rb",
+     "test/method_test.rb",
+     "test/module_test.rb",
+     "test/object_test.rb",
+     "test/regexp_test.rb",
+     "test/string_test.rb",
+     "test/symbol_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/backports/argf.rb

@@ -0,0 +1,57 @@
+if RUBY_VERSION < '1.8.7'
+  class << ARGF
+    # Standard in Ruby 1.8.7.
+    make_block_optional :each, :each_line, :each_byte
+  end
+end
+
+class << ARGF
+  # Standard in Ruby 1.8.7.
+  def bytes
+    to_enum :each_byte
+  end unless method_defined? :bytes
+
+  # Standard in Ruby 1.8.7.
+  def chars
+    to_enum :each_char
+  end unless method_defined? :chars
+
+  # Standard in Ruby 1.8.7.
+  def each_char
+    return to_enum(:each_char) unless block_given?
+    if $KCODE == "UTF-8"
+      lookup = 7.downto(4)
+      while c = read(1) do
+        n = c[0]
+        leftmost_zero_bit = lookup.find{|i| n[i].zero? }
+        case leftmost_zero_bit
+        when 7 # ASCII
+          yield c
+        when 6 # UTF 8 complementary characters
+          next # Encoding error, ignore
+        else
+          more = read(6-leftmost_zero_bit)
+          break unless more
+          yield c+more
+        end
+      end
+    else
+      while s = read(1)
+        yield s
+      end
+    end
+
+    self
+  end unless method_defined? :each_char
+
+  # Standard in Ruby 1.8.7.
+  alias_method :getbyte, :getc
+
+  # Standard in Ruby 1.8.7.
+  alias_method :readbyte, :readchar
+
+  # Standard in Ruby 1.8.7.
+  def lines(*args)
+    to_enum :each_line, *args
+  end unless method_defined? :lines
+end

data/lib/backports/array.rb

@@ -1,17 +1,19 @@
 class Array
+  # Standard in Ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
   class << self
-    # Standard in Ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
-    def try_convert(x)
-      x.to_ary if x.respond_to? :to_ary
-    end unless method_defined? :try_convert
+    # 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.9. 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]
-  
-  # 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 combination(num)
-    num = num.to_i
+    num = Type.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.
@@ -27,32 +29,43 @@ class Array
       picks[move...num] = (new_index...(new_index+num-move)).to_a
     end
   end unless method_defined? :combination
-  
-  # Standard in Ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
-  def cycle(*arg, &block)
-    return to_enum(:cycle, *arg) unless block_given?
-    nb = arg.empty? ? (1/0.0) : arg.first
-    nb.to_i.times{each(&block)}
+
+  # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
+  def cycle(n = nil, &block)
+    return to_enum(:cycle, n) unless block_given?
+    if n.nil?
+      loop(&block)
+    else
+      n = Type.coerce_to n, Fixnum, :to_int
+      n.times{each(&block)}
+    end
+    nil
   end unless method_defined? :cycle
-  
-  # extract_options! in backports.rb
-  
-  # flatten & flatten!, standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
+
+  # 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]
+
+  # 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)
 
     # Recursively flatten any contained Arrays into an one-dimensional result.
     # Adapted from rubinius'
-    def flatten_with_optional_argument(level=nil)
-      return flatten_without_optional_argument unless level || level == (1/0.0)
+    def flatten_with_optional_argument(level=-1)
       dup.flatten!(level) || self
     end
 
     # Flattens self in place as #flatten. If no changes are
     # made, returns nil, otherwise self.
     # Adapted from rubinius'
-    def flatten_with_optional_argument!(level=nil)
-      return flatten_without_optional_argument! unless level || level == (1/0.0)
-      
+    def flatten_with_optional_argument!(level=-1)
+      level = Type.coerce_to(level, Integer, :to_int)
+      return flatten_without_optional_argument! unless level >= 0
+
       ret, out = nil, []
       ret = recursively_flatten_finite(self, out, level)
       replace(out) if ret
@@ -82,8 +95,8 @@ class Array
     end
     private :recursively_flatten_finite
   end # flatten & flatten!
-  
-  # index
+
+  # index. Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
   unless ([1].index{true} rescue false)
     def index_with_block(*arg)
       return index_without_block(*arg) unless block_given? && arg.empty?
@@ -93,27 +106,37 @@ class Array
     alias_method_chain :index, :block
     alias_method :find_index, :index
   end
-  
-  # pop. Standard in Ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
+
+  # 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(*arg)
-      return pop_without_optional_argument if arg.empty?
-      n = arg.first.to_i
-      slice!([0,size-n].max, size)
+    def pop_with_optional_argument(n = Undefined)
+      return pop_without_optional_argument if n == Undefined
+      n = Type.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
   end
-  
+
+  # Standard in Ruby 1.9. 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].inject(trivial_enum) do |enum, array|
-      Enumerator.new do |yielder|
-        enum.each do |partial_product|
-          array.each do |obj|
-            yielder.yield partial_product + [obj]
+    [self, *arg].map{|x| Type.coerce_to(x, Array, :to_ary)}.
+      inject(trivial_enum) do |enum, array|
+        Enumerator.new do |yielder|
+          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
 
@@ -126,35 +149,45 @@ class Array
     end
     alias_method_chain :rindex, :block
   end
-  
-  # shift. 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 sample(n = Undefined)
+    return self[rand(size)] if n == Undefined
+    n = Type.coerce_to(n, Fixnum, :to_int)
+    raise ArgumentError, "negative array size" if n < 0
+    n = size if n > size
+    result = Array.new(self)
+    n.times do |i|
+      r = i + rand(size - i)
+      result[i], result[r] = result[r], result[i]
+    end
+    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(*arg)
-      return shift_without_optional_argument if arg.empty?
-      n = arg.first.to_i
+    def shift_with_optional_argument(n = Undefined)
+      return shift_without_optional_argument if n == Undefined
+      n = Type.coerce_to(n, Fixnum, :to_int)
+      raise ArgumentError, "negative array size" if n < 0
       slice!(0, n)
     end
     alias_method_chain :shift, :optional_argument
   end
-  
-  
-  def sample(*arg)
-    return self[rand(size)] if arg.empty?
-    n = [arg.first.to_i, size].min
-    index = Array.new(size)
-    n.times do |i|
-      r = i + rand(size - i)
-      index[i], index[r] = index[r] || r, index[i] || i
-    end
-    values_at(*index.first(n))
-  end unless method_defined? :sample
-  
+
+  # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
   def shuffle
-    sample(size)
+    dup.shuffle!
   end unless method_defined? :shuffle
 
+  # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Array.html]
   def shuffle!
-    replace(sample(size))
+    size.times do |i|
+      r = i + rand(size - i)
+      self[i], self[r] = self[r], self[i]
+    end
+    self
   end unless method_defined? :shuffle!
 
 end

data/lib/backports/binding.rb

@@ -1,5 +1,5 @@
 class Binding
-  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Symbol.html]
+  # Standard in ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Symbol.html]
   def eval(expr, *arg)
     Kernel.eval(expr, self, *arg)
   end unless method_defined? :eval

data/lib/backports/core_ext.rb

@@ -0,0 +1,61 @@
+# These are non-standard extensions
+
+class Module
+  # Metaprogramming utility to make block optional.
+  # Tests first if block is already optional when given options
+  def make_block_optional(*methods)
+    options = methods.extract_options!
+    methods.each do |selector|
+      next unless method_defined? selector
+      unless options.empty?
+        test_on = options[:test_on] || self.new
+        next if (test_on.send(selector, *options.fetch(:arg, [])) rescue false)
+      end
+      
+      arity = instance_method(selector).arity
+      last_arg = []
+      if arity < 0
+        last_arg = ["*rest"]
+        arity = -1-arity
+      end
+      arg_sequence = ((0...arity).map{|i| "arg_#{i}"} + last_arg + ["&block"]).join(", ")
+
+      alias_method_chain(selector, :optional_block) do |aliased_target, punctuation|
+        module_eval <<-end_eval
+          def #{aliased_target}_with_optional_block#{punctuation}(#{arg_sequence})
+            return to_enum(:#{aliased_target}_without_optional_block#{punctuation}, #{arg_sequence}) unless block_given?
+            #{aliased_target}_without_optional_block#{punctuation}(#{arg_sequence})
+          end
+        end_eval
+      end
+    end
+  end
+end
+
+module Type
+  # From Rubinius
+  class << self
+    def coerce_to(obj, cls, meth)
+      return obj if obj.kind_of?(cls)
+
+      begin
+        ret = obj.__send__(meth)
+      rescue Exception => e
+        raise TypeError, "Coercion error: #{obj.inspect}.#{meth} => #{cls} failed:\n" \
+                         "(#{e.message})"
+      end
+      raise TypeError, "Coercion error: obj.#{meth} did NOT return a #{cls} (was #{ret.class})" unless ret.kind_of? cls
+      ret
+    end unless method_defined? :coerce_to
+  end
+  
+  def self.coerce_to_comparison(a, b, cmp = (a <=> b))
+    raise ArgumentError, "comparison of #{a} with #{b} failed" if cmp.nil?
+    return 1 if cmp > 0
+    return -1 if cmp < 0
+    0
+  end unless method_defined? :coerce_to_comparison
+end
+
+# From Rubinius
+Undefined = Object.new unless Kernel.const_defined? :Undefined