marcandre-backports 1.1.1 → 1.2.0

data/CHANGELOG.rdoc

@@ -1,5 +1,21 @@
 = Packable --- History
 
+== Version 1.2 - April 12, 2009
+
+* Array
+  * +reverse_each+
+  * +cycle+
+
+* Enumerable
+  * +reverse_each+
+  * +each_slice+, +each_cons+
+  * +count+
+  * +cycle+
+  * +group_by+
+  
+* Hash
+  * <tt>default_proc=</tt>
+
 == Version 1.1 - April 11, 2009
 
 * Array

data/README.rdoc

@@ -39,18 +39,25 @@ Works with ruby 1.8 & 1.9
   * +key+
   * +symbolize_keys+, <tt>symbolize_keys!</tt>
   * +reverse_merge+, <tt>reverse_merge!</tt>
+  * <tt>default_proc=</tt>
 * Enumerable
   * +sum+
   * +find_index+
   * +take+, +take_while+, +drop+, +drop_while+
   * +first+
+  * +reverse_each+
+  * +count+
+  * +cycle+
+  * +group_by+
 * Array
   * +flatten+, <tt>flatten!</tt>
   * +find_index+, +find+
+  * +reverse_each+
+  * +cycle+
 * Fixnum
   * <tt>odd?</tt>, <tt>even?</tt>
 
-Finally, there is no need to <tt>require 'enumerator'</tt> in older ruby, and +Enumerator+ can be accessed directly (instead of <tt>Enumerable::Enumerator</p>)
+Finally, there is no need to <tt>require 'enumerator'</tt> in older ruby, and +Enumerator+ can be accessed directly (instead of <tt>Enumerable::Enumerator</tt>)
 
 = License
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
-:minor: 1
-:patch: 1
+:minor: 2
+:patch: 0

data/lib/backports.rb

@@ -10,6 +10,6 @@ module Kernel
   end unless method_defined? :require_relative
 end
 
-%w(object module enumerable array string symbol fixnum hash).each do |lib|
+%w(object module array enumerable string symbol fixnum hash).each do |lib|
   require_relative "backports/#{lib}"
 end

data/lib/backports/array.rb

@@ -56,4 +56,28 @@ class Array
     alias_method_chain :index, :block
     alias_method :find_index, :index
   end
+  
+  # rindex
+  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
+  end
+
+  unless ([1].reverse_each rescue false)
+    def reverse_each_with_optional_block(&block)
+      return reverse_each_without_optional_block(&block) if block_given?
+      to_enum(:reverse_each)
+    end
+    alias_method_chain :reverse_each, :optional_block
+  end
+  
+  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)}
+  end unless method_defined? :cycle
 end

data/lib/backports/enumerable.rb

@@ -40,7 +40,7 @@ module Enumerable
   
   # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Enumerable.html]
   def take_while
-    raise NotImplemented unless block_given? #todo: what should this do?
+    return to_enum(:take_while) unless block_given?
     inject([]) do |array, elem|
       return array unless yield elem
       array << elem
@@ -55,7 +55,7 @@ module Enumerable
   
   # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Enumerable.html]
   def drop_while(&block)
-    raise NotImplemented unless block_given? #todo: what should this do?
+    return to_enum(:drop_while) unless block_given?
     array = to_a
     array.each_with_index do |element, i|
       return array.drop(i) unless yield(element)
@@ -68,4 +68,57 @@ module Enumerable
       arg.empty? ? take(1)[0] : take(arg.first)
   end unless method_defined? :first
 
+  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Enumerable.html]
+  def reverse_each(&block)
+    return to_enum(:reverse_each) unless block_given?
+    # There is no other way then to convert to an array first... see 1.9's source.
+    to_a.reverse_each(&block)
+    self
+  end unless method_defined? :reverse_each
+  
+  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Enumerable.html]
+  unless ((1..2).each_slice(1) rescue false)
+    def each_slice_with_optional_block(len, &block)
+      raise ArgumentError, "invalid slice size" if len <= 0
+      return to_enum(:each_slice, len) unless block_given?
+      each_slice_without_optional_block(len, &block)
+    end
+    alias_method_chain :each_slice, :optional_block
+  end
+  
+  def count(*arg)
+    result = 0
+    if block_given?
+      each{|o| result += 1 if yield o}
+    elsif arg.empty?
+      each{|o| result += 1}
+    else
+      obj = arg.first
+      each{|o| result += 1 if obj == o}
+    end
+    result
+  end unless method_defined? :count
+  
+  def cycle(*arg, &block)
+    return to_enum(:cycle, *arg) unless block_given?
+    to_a.cycle(*arg, &block)
+  end unless method_defined? :cycle
+  
+  unless ((1..2).each_cons(1) rescue false)
+    def each_cons_with_optional_block(len, &block)
+      raise ArgumentError, "invalid size" if len <= 0
+      return to_enum(:each_cons, len) unless block_given?
+      each_cons_without_optional_block(len, &block)
+    end
+    alias_method_chain :each_cons, :optional_block
+  end
+
+  def group_by
+    return to_enum(:group_by) unless block_given?
+    returning({}) do |result|
+      each do |o|
+        result.fetch(yield o){|key| result[key] = []} << o
+      end
+    end
+  end unless method_defined? :group_by
 end

data/lib/backports/hash.rb

@@ -34,4 +34,8 @@ class Hash
     replace(reverse_merge(other_hash))
   end
   
+  # 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(&proc).merge!(self))
+  end unless method_defined? :default_proc=
 end

data/test/backports_test.rb

@@ -1,63 +1,136 @@
 require 'test_helper'
 
 class BackportsTest < Test::Unit::TestCase
-  context "find_index" do
-    should "conform to doc" do
-      assert_equal 3, %w{ant bat cat dog}.find_index {|item| item =~ /g/ }
-      assert_equal nil, %w{ant bat cat dog}.find_index {|item| item =~ /h/ }
+  context "Enumerable" do
+    context "#find_index" do
+      should "conform to doc" do
+        assert_equal 3, %w{ant bat cat dog}.find_index {|item| item =~ /g/ }
+        assert_equal nil, %w{ant bat cat dog}.find_index {|item| item =~ /h/ }
+      end
+
+      should "#work for enumerables too" do
+        assert_equal 69-42, (42..666).find_index(69)
+      end
     end
 
-    should "work for enumerables too" do
-      assert_equal 69-42, (42..666).find_index(69)
+    context "#take" do
+      should "conform to doc" do
+        assert_equal [1, 2, 3], (1..7).take(3)
+        assert_equal [["a", 1], ["b", 2]], { 'a'=>1, 'b'=>2, 'c'=>3 }.take(2)
+      end
+    
+      should "only consume what's needed" do
+        assert_equal [], Enumerator.new(nil).take(0)
+        assert_raises(NoMethodError) { Enumerator.new(nil).take(1) }
+      end
     end
-  end
+  
+    context "#take_while" do
+      should "conform to doc" do
+        assert_equal [1,2], (1..7).take_while {|item| item < 3 }
+        assert_equal [2,4,6], [ 2, 4, 6, 9, 11, 16 ].take_while(&:even?)
+      end
 
-  context "take" do
-    should "conform to doc" do
-      assert_equal [1, 2, 3], (1..7).take(3)
-      assert_equal [["a", 1], ["b", 2]], { 'a'=>1, 'b'=>2, 'c'=>3 }.take(2)
+      should "work with infinite enumerables" do
+        assert_equal [1,2], (1..(1/0.0)).take_while {|item| item < 3 }
+      end
     end
+  
+    context "#drop" do
+      should "conform to doc" do
+        assert_equal [5, 8, 13], [ 1, 1, 2, 3, 5, 8, 13 ].drop(4)
+        assert_equal [], [ 1, 1, 2, 3, 5, 8, 13 ].drop(99)
+      end
     
-    should "only consume what's needed" do
-      assert_equal [], Enumerator.new(nil).take(0)
-      assert_raises(NoMethodError) { Enumerator.new(nil).take(1) }
+      should "work with enums" do
+        assert_equal [14,15], (10...16).drop(4)
+      end
     end
-  end
   
-  context "take_while" do
-    should "conform to doc" do
-      assert_equal [1,2], (1..7).take_while {|item| item < 3 }
-      assert_equal [2,4,6], [ 2, 4, 6, 9, 11, 16 ].take_while(&:even?)
+    context "#drop_while" do
+      should "conform to doc" do
+        assert_equal [8, 13], [ 1, 1, 2, 3, 5, 8, 13 ].drop_while {|item| item < 6 } 
+      end
+
+      should "work with enums" do
+        assert_equal [14,15], (10...16).drop_while {|item| item < 14}
+      end
+
+      should "work with extemity cases" do
+        assert_equal [10,11,12,13,14,15], (10...16).drop_while {|item| false}
+        assert_equal [], (10...16).drop_while {|item| true}
+      end
+    end
+    
+    context "#reverse_each" do
+      should "work as expected" do
+        assert_equal [4,3,2], (1..4).reverse_each.take(3)
+      end
+    end
+    
+    context "#each_slice" do
+      should "conform to doc" do
+        res = []
+        (1..10).each_slice(4){|ar| res << ar}
+        assert_equal [[1, 2, 3, 4],[5, 6, 7, 8],[9, 10]], res
+        assert_equal [[1, 2, 3, 4],[5, 6, 7, 8],[9, 10]], (1..10).each_slice(4).to_a
+      end
+    end
+    
+    context "#count" do
+      should "conform to doc" do
+        assert_equal 4, (1..4).count
+        assert_equal 1, (1..4).count(3)
+        assert_equal 2, (1..4).count{|obj| obj > 2 } 
+      end
     end
 
-    should "work with infinite enumerables" do
-      assert_equal [1,2], (1..(1/0.0)).take_while {|item| item < 3 }
+    context "#cycle" do
+      should "conform to doc" do
+        assert_equal ["a", "b", "c", "a", "b", "c"], ('a'..'c').cycle(2).to_a
+      end
     end
-  end
-  
-  context "drop" do
-    should "conform to doc" do
-      assert_equal [5, 8, 13], [ 1, 1, 2, 3, 5, 8, 13 ].drop(4)
-      assert_equal [], [ 1, 1, 2, 3, 5, 8, 13 ].drop(99)
+    
+    context "#each_cons" do
+      should "conform to doc" do
+        assert_equal [[1,2],[2,3],[3,4]], (1..4).each_cons(2).to_a
+      end
     end
     
-    should "work with enums" do
-      assert_equal [14,15], (10...16).drop(4)
+    context "#group_by" do
+      should "conform to doc" do
+        x = (1..5).group_by{|item| item.even? ? :even : :odd }
+        assert_equal({:even => [2,4], :odd => [1,3,5]}, x)
+        assert_equal nil, x[:xyz]
+      end
     end
-  end
+  end #Enumerable
   
-  context "drop_while" do
-    should "conform to doc" do
-      assert_equal [8, 13], [ 1, 1, 2, 3, 5, 8, 13 ].drop_while {|item| item < 6 } 
+  context "Array" do
+    context "#reverse_each" do
+      should "return an enumerator when no block is given" do
+        assert_equal [4,3,2], [1,2,3,4].reverse_each.take(3)
+      end
     end
 
-    should "work with enums" do
-      assert_equal [14,15], (10...16).drop_while {|item| item < 14}
+    context "#flatten" do
+      should "conform to doc" do
+        s = [ 1, 2, 3 ]           #=> [1, 2, 3]
+        t = [ 4, 5, 6, [7, 8] ]   #=> [4, 5, 6, [7, 8]]
+        a = [ s, t, 9, 10 ]       #=> [[1, 2, 3], [4, 5, 6, [7, 8]], 9, 10]
+        assert_equal [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], a.flatten
+        a = [ 1, 2, [3, [4, 5] ] ]
+        assert_equal [1, 2, 3, [4, 5]], a.flatten(1)
+      end
     end
 
-    should "work with extemity cases" do
-      assert_equal [10,11,12,13,14,15], (10...16).drop_while {|item| false}
-      assert_equal [], (10...16).drop_while {|item| true}
+    context "#index" do
+      should "conform to doc" do
+        a = [ "a", "b", "c" ]
+        assert_equal 1, a.index("b")
+        assert_equal nil, a.index("z")
+        assert_equal 1, a.index{|x|x=="b"}
+      end
     end
   end
   
@@ -65,33 +138,22 @@ class BackportsTest < Test::Unit::TestCase
     should "should be constructible from key value pairs" do
       assert_equal({1 => 2, 3 => 4}, Hash[[[1,2],[3,4]]])
     end
-  end
-  
-  context "flatten" do
-    should "conform to doc" do
-      s = [ 1, 2, 3 ]           #=> [1, 2, 3]
-      t = [ 4, 5, 6, [7, 8] ]   #=> [4, 5, 6, [7, 8]]
-      a = [ s, t, 9, 10 ]       #=> [[1, 2, 3], [4, 5, 6, [7, 8]], 9, 10]
-      assert_equal [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], a.flatten
-      a = [ 1, 2, [3, [4, 5] ] ]
-      assert_equal [1, 2, 3, [4, 5]], a.flatten(1)
-    end
-  
-    should "conform work for recursive arrays" do
-      x=[]
-      x.push(x,x)
-      4.times {|n| assert_equal 2 << n, x.flatten(n).length}
-      assert_raises(ArgumentError) {x.flatten}
-    end
-  end 
-  
-  context "index" do
-    should "conform to doc" do
-      a = [ "a", "b", "c" ]
-      assert_equal 1, a.index("b")
-      assert_equal nil, a.index("z")
-      assert_equal 1, a.index{|x|x=="b"}
+    
+    context "#default_proc=" do
+      should "conform to doc" do
+        h = { :foo => :bar }
+        h.default = "Go fish"
+        h.default_proc=lambda do |hash, key| 
+          key + key 
+        end 
+        assert_equal :bar, h[:foo]
+        assert_equal 4, h[2]
+        assert_equal "catcat", h["cat"]
+        h.default=nil
+        assert_equal nil, h[2]
+        assert_equal nil, h["cat"]
+      end
     end
   end
-      
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: marcandre-backports
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors: 
 - "Marc-Andr\xC3\xA9 Lafortune"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-11 00:00:00 -07:00
+date: 2009-04-12 00:00:00 -07:00
 default_executable: 
 dependencies: []