marcandre-backports 1.7.1 → 1.8.0

data/lib/backports/tools.rb

@@ -0,0 +1,117 @@
+# Methods used internally by the backports.
+
+module Backports
+  # Adapted from Pragmatic's "Programming Ruby" (since their version was buggy...)
+  def self.require_relative(relative_feature)
+    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
+  
+  # Metaprogramming utility to make block optional.
+  # Tests first if block is already optional when given options
+  def self.make_block_optional mod,*methods
+    options = methods.last.is_a?(Hash) ? methods.pop : {}
+    methods.each do |selector|
+      unless mod.method_defined? selector
+        warn "#{mod}##{selector} is not defined, so block can't be made optional"
+        next
+      end
+      unless options.empty?
+        test_on = options[:test_on] || self.new
+        next if (test_on.send(selector, *options.fetch(:arg, [])) rescue false)
+      end
+      
+      arity = mod.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(mod, selector, :optional_block) do |aliased_target, punctuation|
+        mod.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
+
+  # Modified to avoid polluting Module if so desired
+  # (from Rails)
+  def self.alias_method_chain(mod, target, feature)
+    mod.class_eval do
+      # Strip out punctuation on predicates or bang methods since
+      # e.g. target?_without_feature is not a valid method name.
+      aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
+      yield(aliased_target, punctuation) if block_given?
+
+      with_method, without_method = "#{aliased_target}_with_#{feature}#{punctuation}", "#{aliased_target}_without_#{feature}#{punctuation}"
+
+      alias_method without_method, target
+      alias_method target, with_method
+
+      case
+        when public_method_defined?(without_method)
+          public target
+        when protected_method_defined?(without_method)
+          protected target
+        when private_method_defined?(without_method)
+          private target
+      end
+    end
+  end
+  
+  # Helper method to coerce a value into a specific class.
+  # Raises a TypeError if the coercion fails or the returned value
+  # is not of the right class. 
+  # (from Rubinius)
+  def self.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
+  
+  # Checks for a failed comparison (in which case it throws an ArgumentError)
+  # Additionally, it maps any negative value to -1 and any positive value to +1
+  # (from Rubinius)
+  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
+
+  # Used internally to make it easy to deal with optional arguments
+  # (from Rubinius)
+  Undefined = Object.new
+  
+  # A simple class which allows the construction of Enumerator from a block
+  class Yielder
+    def initialize(&block)
+      @main_block = block
+    end
+
+    def each(&block)
+      @final_block = block
+      @main_block.call(self)
+    end
+
+    def yield(*arg)
+      @final_block.yield(*arg)
+    end
+  end
+end

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/test/enumerator_test.rb

@@ -16,12 +16,12 @@ class EnumeratorTest < Test::Unit::TestCase
     context "#new" do
       should "should accept block" do
         enum = Enumerator.new do |yielder|
-          yielder.yield "This cool new syntax is sponsored by"
-          yielder.yield yielder.class
+          yielder.yield "This syntax is"
+          yielder.yield "cool!"
         end
         assert enum.is_a?(Enumerator)
         2.times do
-          assert_equal ["This cool new syntax is sponsored by", Enumerator::Yielder], enum.to_a
+          assert_equal ["This syntax is", "cool!"], enum.to_a
         end
       end
     end

data/test/test_helper.rb

@@ -2,9 +2,7 @@ require 'rubygems'
 require 'test/unit'
 require 'shoulda'
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'backports'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/backports")
 
 # class Test::Unit::TestCase
 # end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: marcandre-backports
 version: !ruby/object:Gem::Version 
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors: 
 - "Marc-Andr\xC3\xA9 Lafortune"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-20 00:00:00 -07:00
+date: 2009-08-31 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -32,32 +32,49 @@ files:
 - 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
@@ -71,9 +88,8 @@ files:
 - test/string_test.rb
 - test/symbol_test.rb
 - test/test_helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/marcandre/backports
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -100,9 +116,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: backports
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Backports or ruby 1.8.7+ & rails for older ruby.
 test_files: 
 - test/array_test.rb

data/lib/backports/core_ext.rb

@@ -1,61 +0,0 @@
-# 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

data/lib/backports/dir.rb

@@ -1,7 +0,0 @@
-class Dir
-  make_block_optional :each, :test_on => Dir.new(".")
-  class << self
-    make_block_optional :foreach, :test_on => Dir, :arg => "."
-  end
-end
-  

data/lib/backports/enumerator.rb

@@ -1,43 +0,0 @@
-class Enumerator
-  alias_method :with_object, :each_with_object unless method_defined? :with_object
-
-  def next
-    require 'generator'
-    @generator ||= Generator.new(self)
-    raise StopIteration unless @generator.next?
-    @generator.next
-  end unless method_defined? :next
-
-  def rewind
-    @object.rewind if @object.respond_to? :rewind
-    require 'generator'
-    @generator ||= Generator.new(self)
-    @generator.rewind
-    self
-  end unless method_defined? :rewind
-
-  # new with block, standard in Ruby 1.9
-  unless (self.new{} rescue false)
-    class Yielder
-      def initialize(&block)
-        @main_block = block
-      end
-
-      def each(&block)
-        @final_block = block
-        @main_block.call(self)
-      end
-
-      def yield(*arg)
-        @final_block.yield(*arg)
-      end
-    end
-
-    def initialize_with_optional_block(*arg, &block)
-      @object = arg.first
-      return initialize_without_optional_block(*arg, &nil) unless arg.empty?  # Ruby 1.9 apparently ignores the block if any argument is present
-      initialize_without_optional_block(Yielder.new(&block))
-    end
-    alias_method_chain :initialize, :optional_block
-  end
-end

data/lib/backports/env.rb

@@ -1,3 +0,0 @@
-class << ENV
-  make_block_optional :delete_if, :each, :each_key, :each_pair, :each_value, :reject!, :select, :test_on => ENV
-end

data/lib/backports/fixnum.rb

@@ -1,11 +0,0 @@
-class Fixnum
-  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Fixnum.html]
-  def div(n)
-    (self / n).to_i
-  end unless method_defined? :div
-
-  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Fixnum.html]
-  def fdiv(n)
-    to_f / n
-  end unless method_defined? :fdiv
-end

data/lib/backports/float.rb

@@ -1,4 +0,0 @@
-class Fixnum
-  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Fixnum.html]
-  alias_method :fdiv, :/ unless method_defined? :fdiv
-end

data/lib/backports/hash.rb

@@ -1,64 +0,0 @@
-class Hash
-  # New Ruby 1.8.7+ constructor -- not documented, see redmine # 1385
-  # <tt>Hash[[[:foo, :bar],[:hello, "world"]]] ==> {:foo => :bar, :hello => "world"}</tt>
-  class << self
-    alias_method :original_constructor, :[]
-    def [](*args)
-      return original_constructor(*args) unless args.length == 1 && args.first.is_a?(Array)
-      returning({}) do |h|
-        args.first.each do |arr|
-          next unless arr.respond_to? :to_ary
-          arr = arr.to_ary
-          next unless (1..2).include? arr.size
-          h[arr.at(0)] = arr.at(1)
-        end
-      end
-    end unless (Hash[[[:test, :test]]] rescue false)
-
-    # Standard in Ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Hash.html]
-    def try_convert(x)
-      return nil unless x.respond_to? :to_hash
-      x.to_hash
-    end unless method_defined? :to_hash
-  end
-
-  make_block_optional :delete_if, :each, :each_key, :each_pair, :each_value, :reject, :reject!, :select, :test_on => {:hello => "world!"}
-
-  # Standard in Ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Hash.html]
-  def default_proc=(proc)
-    replace(Hash.new(&Type.coerce_to(proc, Proc, :to_proc)).merge!(self))
-  end unless method_defined? :default_proc=
-
-  # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Hash.html]
-  alias_method :key, :index unless method_defined? :key
-
-  # Standard in rails. See official documentation[http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Hash/Keys.html]
-  def reverse_merge(other_hash)
-    other_hash.merge(self)
-  end
-
-  # Standard in rails. See official documentation[http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Hash/Keys.html]
-  def reverse_merge!(other_hash)
-    replace(reverse_merge(other_hash))
-  end
-
-  # Standard in rails. See official documentation[http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Hash/Keys.html]
-  def symbolize_keys
-    Hash[map{|key,value| [(key.to_sym rescue key) || key, value] }]
-  end unless method_defined? :symbolize_keys
-
-  # Standard in rails. See official documentation[http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Hash/Keys.html]
-  def symbolize_keys!
-    self.replace(self.symbolize_keys)
-  end unless method_defined? :symbolize_keys!
-
-  # Standard in rails. See official documentation[http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Hash/Keys.html]
-  def stringify_keys
-    Hash[map{|key,value| [key.to_s, value] }]
-  end unless method_defined? :stringify_keys
-
-  # Standard in rails. See official documentation[http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Hash/Keys.html]
-  def stringify_keys!
-    self.replace(self.stringify_keys)
-  end unless method_defined? :stringify_keys!
-end

data/lib/backports/integer.rb

@@ -1,25 +0,0 @@
-class Integer
-  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Fixnum.html]
-  def even?
-    self[0].zero?
-  end unless method_defined? :even?
-
-  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Fixnum.html]
-  def odd?
-    !even?
-  end unless method_defined? :odd?
-
-  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Fixnum.html]
-  def ord
-    self
-  end unless method_defined? :ord
-
-  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Fixnum.html]
-  def pred
-    self - 1
-  end unless method_defined? :pred
-
-  alias_method :magnitude, :abs unless method_defined? :magnitude
-
-  make_block_optional :downto, :times, :upto, :test_on => 42, :arg => 42
-end

data/lib/backports/kernel.rb

@@ -1,55 +0,0 @@
-require 'enumerator'
-# Must be defined outside of Kernel for jruby, see http://jira.codehaus.org/browse/JRUBY-3609
-Enumerator = Enumerable::Enumerator unless Kernel.const_defined? :Enumerator # Standard in ruby 1.9
-
-module Kernel
-
-  def __callee__
-    caller(1).first[/`(.*)'/,1].try(:to_sym)
-  end unless (__callee__ || true rescue false)
-
-  alias_method :__method__, :__callee__  unless (__method__ || true rescue false)
-
-  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Object.html]
-  def define_singleton_method(*args, &block)
-    class << self
-      self
-    end.send(:define_method, *args, &block)
-  end unless method_defined? :define_singleton_method
-
-  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Object.html]
-  def instance_exec(*arg, &block)
-    define_singleton_method(:"temporary method for instance_exec", &block)
-    send(:"temporary method for instance_exec", *arg)
-  end unless method_defined? :instance_exec
-
-  # Loop. Standard in ruby 1.8.7. See official documentation[http://ruby-doc.org/core-1.9/classes/Object.html]
-  unless const_defined? :StopIteration
-    class StopIteration < IndexError; end
-
-    def loop_with_stop_iteration(&block)
-      loop_without_stop_iteration(&block)
-    rescue StopIteration
-      # ignore silently
-    end
-    alias_method_chain :loop, :stop_iteration
-  end
-
-  # Standard in ruby 1.8.7. See official documentation[http://ruby-doc.org/core-1.9/classes/Object.html]
-  def tap
-    yield self
-    self
-  end unless method_defined? :tap
-
-  # Standard in rails. See official documentation[http://api.rubyonrails.org/classes/Object.html]
-  def try(method_id, *args, &block)
-    send(method_id, *args, &block) unless self.nil? #todo: check new def
-  end unless method_defined? :try
-
-  # Standard in rails. See official documentation[http://api.rubyonrails.org/classes/Object.html]
-  def returning(obj)
-    yield obj
-    obj
-  end unless method_defined? :returning
-
-end

data/lib/backports/module.rb

@@ -1,30 +0,0 @@
-class Module
-  # Standard in rails... See official documentation[http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Module.html]
-  def alias_method_chain(target, feature)
-    # Strip out punctuation on predicates or bang methods since
-    # e.g. target?_without_feature is not a valid method name.
-    aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
-    yield(aliased_target, punctuation) if block_given?
-    
-    with_method, without_method = "#{aliased_target}_with_#{feature}#{punctuation}", "#{aliased_target}_without_#{feature}#{punctuation}"
-    
-    alias_method without_method, target
-    alias_method target, with_method
-    
-    case
-      when public_method_defined?(without_method)
-        public target
-      when protected_method_defined?(without_method)
-        protected target
-      when private_method_defined?(without_method)
-        private target
-    end
-  end unless method_defined? :alias_method_chain
-  
-  # Can't use alias_method here because of jruby (see http://jira.codehaus.org/browse/JRUBY-2435 )
-  def module_exec(*arg, &block)
-    instance_exec(*arg, &block)
-  end unless method_defined? :module_exec
-  alias_method :class_exec, :module_exec unless method_defined? :class_exec
-  
-end

data/lib/backports/numeric.rb

@@ -1,3 +0,0 @@
-class Numeric
-  make_block_optional :step, :test_on => 42, :arg => [100, 6]
-end

data/lib/backports/object_space.rb

@@ -1,5 +0,0 @@
-module ObjectSpace
-  module_eval do
-    make_block_optional :each_object, :test_on => ObjectSpace
-  end
-end

data/lib/backports/range.rb

@@ -1,4 +0,0 @@
-class Range
-  make_block_optional :each, :test_on => 69..666
-  make_block_optional :step, :test_on => 69..666, :arg => 42
-end