backports 2.6.7 → 2.7.0

data/CHANGELOG.rdoc

@@ -1,4 +1,10 @@
-= Packable --- History
+= Backports --- History
+
+== Version 2.7.0 - January 14th, 2013
+
+* Added some features of 2.0.0 (must be required explicitly until official release):
+  * Enumerable#lazy
+  * Enumerator::Lazy
 
 == Version 2.6.0 - May 29th, 2012
 

data/README.rdoc

@@ -1,6 +1,6 @@
 = Backports Library
 
-* Yearning to use some of the new cool features in 1.9.3 while using 1.8.6?
+* Yearning to use some of the new cool features in Ruby 2.0.0 while using 1.8.6?
 * One of your client is stuck with Ruby 1.8.6 but you want to use a gem using some features of 1.8.7?
 * Can't remember if you can use Array#sample or String#each_char on a friend's box?
 
@@ -25,7 +25,7 @@ Let's be a bit more precise about the breaking code business. It is of course en
 
 A real incompatibility is, for example, <tt>Module::instance_methods</tt> which returns strings in 1.8 and symbols in 1.9. No change can be made without the risk of breaking existing code. Such incompatibilities are left unchanged, although you can require some of these changes in addition (see below)
 
-All features of 1.8.7 are backported (well, almost all, see the exception list bellow), and many of 1.9 are also.
+All features of 1.8.7 are backported (well, almost all, see the exception list bellow), and many of 1.9 are also. Some features of 2.0.0 are backported, but not loaded until a final version of Ruby 2.0.0 is released.
 
 Some generic and self-contained features of active-support are also included. By simple I mean that String#camelcase is there, but #pluralize isn't.
 
@@ -191,6 +191,16 @@ Some features of Ruby 1.9.3 have been backported:
 
 To include all Ruby backports but not those of Rails, <tt>require "backports/1.9.3"</tt> (or "backports/1.9")
 
+== Ruby 2.0.0
+
+Some features of Ruby 2.0.0 have been backported:
+
+* Enumerable
+  * +lazy+
+* Enumerator::Lazy
+
+*Note*: Ruby 2.0.0 will not included by default until 2.0.0 is released (and specs are thus finalized). To play around with these today, <tt>require "backports/2.0"</tt>.
+
 == Rails
 
 Some generic methods from Rails methods have been copied:

data/lib/backports/1.8.7/array.rb

@@ -66,8 +66,8 @@ class Array
         out.concat(array)
       else
         array.each do |o|
-          if o.respond_to? :to_ary
-            recursively_flatten_finite(o.to_ary, out, level - 1)
+          if ary = Backports.is_array?(o)
+            recursively_flatten_finite(ary, out, level - 1)
             ret = self
           else
             out << o
@@ -178,7 +178,7 @@ 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 = Backports::Undefined)
@@ -205,4 +205,4 @@ class Array
     self
   end unless method_defined? :shuffle!
 
-end
+end

data/lib/backports/1.8.7/hash.rb

@@ -8,8 +8,7 @@ class Hash
         return constructor_without_key_value_pair_form(*args) unless args.length == 1 && args.first.is_a?(Array)
         h = {}
         args.first.each do |arr|
-          next unless arr.respond_to? :to_ary
-          arr = arr.to_ary
+          next unless arr == Backports.is_array?(arr)
           next unless (1..2).include? arr.size
           h[arr.at(0)] = arr.at(1)
         end
@@ -40,4 +39,4 @@ class Hash
 
   # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/Hash.html]
   Backports.alias_method self, :key, :index
-end
+end

data/lib/backports/1.9.rb

@@ -1,4 +1,4 @@
-# require this file to load all the backports of Ruby
+# require this file to load all the backports of Ruby 1.9.x
 
 require File.expand_path(File.dirname(__FILE__) + "/tools")
 Backports.require_relative "1.9.3"

data/lib/backports/2.0.0.rb

@@ -0,0 +1,4 @@
+# require this file to load all the backports up to Ruby 2.0.0
+
+Backports.require_relative "1.9"
+Backports.require_relative_dir "2.0.0"

data/lib/backports/2.0.0/enumerable.rb

@@ -0,0 +1,9 @@
+module Enumerable
+  def lazy
+    Enumerator::Lazy.new(self){|yielder, *val| yielder.<<(*val)}
+  end unless method_defined? :lazy
+end
+
+class Enumerator
+  autoload :Lazy, File.expand_path(File.dirname(__FILE__) + "/enumerator/lazy")
+end

data/lib/backports/2.0.0/enumerator/lazy.rb

@@ -0,0 +1,160 @@
+class Enumerator
+  class Yielder
+    # Current API for Lazy Enumerator does not provide an easy way
+    # to handle internal state. We "cheat" and use yielder to hold it for us.
+    # A new yielder is created when generating or after a `rewind`.
+    # This way we avoid issues like http://bugs.ruby-lang.org/issues/7691
+    # or http://bugs.ruby-lang.org/issues/7696
+    attr_accessor :backports_memo
+  end
+
+  class Lazy < Enumerator
+    @@done = Object.new   # used internally to bail out of an iteration
+
+    alias_method :non_lazy_cycle, :cycle # cycle must be handled in a tricky way
+    @@cycler = Struct.new(:object, :n)
+
+    def initialize(obj)
+      return super(obj.object, :non_lazy_cycle, obj.n) if obj.is_a?(@@cycler)
+      raise ArgumentError, "must supply a block" unless block_given?
+      super() do |yielder, *args|
+        catch @@done do
+          obj.each(*args) do |*x|
+            yield yielder, *x
+          end
+        end
+      end
+    end
+
+    alias_method :force, :to_a
+
+    def lazy
+      self
+    end
+
+    def map
+      raise ArgumentError, "tried to call lazy map without a block" unless block_given?
+      Lazy.new(self) do |yielder, *values|
+        yielder << yield(*values)
+      end
+    end
+    alias_method :collect, :map
+
+    def select
+      raise ArgumentError, "tried to call lazy select without a block" unless block_given?
+      Lazy.new(self) do |yielder, *values|
+        values = values.first unless values.size > 1
+        yielder.yield values if yield values
+      end
+    end
+    alias_method :find_all, :select
+
+    def reject
+      raise ArgumentError, "tried to call lazy reject without a block" unless block_given?
+      Lazy.new(self) do |yielder, *values|
+        values = values.first unless values.size > 1
+        yielder.yield(values) unless yield values
+      end
+    end
+
+    def grep(pattern)
+      if block_given?
+        # Split for performance
+        Lazy.new(self) do |yielder, *values|
+          values = values.first unless values.size > 1
+          yielder.yield(yield(values)) if pattern === values
+        end
+      else
+        Lazy.new(self) do |yielder, *values|
+          values = values.first unless values.size > 1
+          yielder.yield(values) if pattern === values
+        end
+      end
+    end
+
+    def drop(n)
+      n = Backports::coerce_to_int(n)
+      Lazy.new(self) do |yielder, *values|
+        data = yielder.backports_memo ||= {remain: n}
+        if data[:remain] > 0
+          data[:remain] -= 1
+        else
+          yielder.yield(*values)
+        end
+      end
+    end
+
+    def drop_while
+      raise ArgumentError, "tried to call lazy drop_while without a block" unless block_given?
+      Lazy.new(self) do |yielder, *values|
+        data = yielder.backports_memo ||= {dropping: true}
+        yielder.yield(*values) unless data[:dropping] &&= yield(*values)
+      end
+    end
+
+    def take(n)
+      n = Backports::coerce_to_int(n)
+      raise ArgumentError, 'attempt to take negative size' if n < 0
+      return Lazy.new([]){} if n == 0
+      Lazy.new(self) do |yielder, *values|
+        data = yielder.backports_memo ||= {remain: n}
+        yielder.yield(*values)
+        throw @@done if (data[:remain] -= 1) == 0
+      end
+    end
+
+    def take_while
+      raise ArgumentError, "tried to call lazy take_while without a block" unless block_given?
+      Lazy.new(self) do |yielder, *values|
+        throw @@done unless yield(*values)
+        yielder.yield(*values)
+      end
+    end
+
+    def flat_map
+      raise ArgumentError, "tried to call lazy flat_map without a block" unless block_given?
+      Lazy.new(self) do |yielder, *values|
+        result = yield(*values)
+        if ary = Backports.is_array?(result) || (result.respond_to?(:each) && result.respond_to?(:force))
+          ary.each{|x| yielder << x }
+        else
+          yielder << result
+        end
+      end
+    end
+    alias_method :collect_concat, :flat_map
+
+    def cycle(n = nil)
+      return super if block_given?
+      Lazy.new(@@cycler.new(self, n))
+    end
+
+    def zip(*args)
+      return super if block_given?
+      arys = args.map{ |arg| Backports.is_array?(arg) }
+      if arys.all?
+        # Handle trivial case of multiple array arguments separately
+        # by avoiding Enumerator#next for efficiency & compatibility
+        Lazy.new(self) do |yielder, *values|
+          data = yielder.backports_memo ||= {iter: 0}
+          values = values.first unless values.size > 1
+          yielder << arys.map{|ary| ary[data[:iter]]}.unshift(values)
+          data[:iter] += 1
+        end
+      else
+        Lazy.new(self) do |yielder, *values|
+          enums = yielder.backports_memo ||= args.map(&:each)
+          values = values.first unless values.size > 1
+          others = enums.map do |arg|
+            begin
+              arg.next
+            rescue StopIteration
+              nil
+            end
+          end
+          yielder << others.unshift(values)
+        end
+      end
+    end
+  end
+end

data/lib/backports/2.0.rb

@@ -0,0 +1,4 @@
+# require this file to load all the backports of Ruby 2.0.x
+
+require File.expand_path(File.dirname(__FILE__) + "/tools")
+Backports.require_relative "2.0.0"

data/lib/backports/tools.rb

@@ -219,6 +219,10 @@ module Backports
     coerce_to(obj, String, :to_str)
   end
 
+  def self.is_array?(obj)
+    coerce_to(obj, Array, :to_ary) if obj.respond_to? :to_ary
+  end
+
   def self.try_convert(obj, cls, meth)
     return obj if obj.kind_of?(cls)
     return nil unless obj.respond_to?(meth)

data/lib/backports/version.rb

@@ -1,3 +1,3 @@
 module Backports
-  VERSION = "2.6.7"
+  VERSION = "2.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backports
 version: !ruby/object:Gem::Version
-  version: 2.6.7
+  version: 2.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2013-01-18 00:00:00.000000000 Z
 dependencies: []
 description: 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.
@@ -101,6 +101,10 @@ files:
 - lib/backports/1.9.3/io.rb
 - lib/backports/1.9.3/string.rb
 - lib/backports/1.9.rb
+- lib/backports/2.0.0.rb
+- lib/backports/2.0.0/enumerable.rb
+- lib/backports/2.0.0/enumerator/lazy.rb
+- lib/backports/2.0.rb
 - lib/backports/basic_object.rb
 - lib/backports/force/array_map.rb
 - lib/backports/force/enumerable_map.rb