marcandre-backports 1.2.0 → 1.3.0

data/CHANGELOG.rdoc

@@ -1,5 +1,19 @@
 = Packable --- History
 
+== Version 1.3 - April 17, 2009
+
+* Enumerable
+  * <tt>none?</tt>
+  
+* Array
+  * +sample+, +shuffle+, +shuffle!+
+
+* String
+  * +each_char+, +chars+
+  * +partition+
+
+Tests and fixes for <tt>String#start_with?</tt> and <tt>String#end_with?</tt>
+
 == Version 1.2 - April 12, 2009
 
 * Array

data/README.rdoc

@@ -1,22 +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
+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
 
 Conditions for inclusion:
-1. Standard in either rails or ruby
+1. Standard in either Ruby or Rails
 2. Won't break older code
 3. Simple and self-contained
 
 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.
 
-More complex features of activesupport (even things like <tt>String::pluralize</tt>), won't be included. <tt>require 'activesupport'</tt> if you need them!
+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!
 
-I've added those as I need them; pull requests welcome (with tests for ruby 1.9 backports)
+I've added these backports as I need them; pull requests welcome (with tests for Ruby 1.9 backports)
 
-== Compatibility
+== Installation & compatibility
 
-Works with ruby 1.8 & 1.9
++backports+ is mirrored on Rubyforge and can thus be installed with:
+
+  sudo gem install backports
+
+To use:
+
+  require 'rubygems'
+  require 'backports'
+  # and off you go!
+
+Compatible with Ruby 1.8 & 1.9.
 
 = List of backports
 
@@ -30,12 +40,14 @@ Works with ruby 1.8 & 1.9
   * +tap+, +returning+
   * +try+
 * String
+  * +each_char+, +chars+
   * <tt>start_with?</tt>, <tt>end_with?</tt>
   * +camelize+, +underscore+
   * +dasherize+, +demodulize+
   * +constantize+
+  * +partition+
 * Hash
-  * <tt>Hash[[[:foo, :bar],[:hello, "world"]]] ==> {:foo => :bar, :hello => "world"}</tt>
+  * <tt>Hash[[[:foo, :bar],[:hello, "world"]]] ==> {:foo => :bar, :hello => "world"}</tt> (see _note_)
   * +key+
   * +symbolize_keys+, <tt>symbolize_keys!</tt>
   * +reverse_merge+, <tt>reverse_merge!</tt>
@@ -49,6 +61,7 @@ Works with ruby 1.8 & 1.9
   * +count+
   * +cycle+
   * +group_by+
+  * <tt>none?</tt>
 * Array
   * +flatten+, <tt>flatten!</tt>
   * +find_index+, +find+
@@ -57,7 +70,9 @@ Works with ruby 1.8 & 1.9
 * 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</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</tt>)
+
+_note_: This usage of <tt>Hash::[]</tt> is not yet documented[http://redmine.ruby-lang.org/issues/show/1385].
 
 = License
 

data/VERSION.yml

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

data/lib/backports/array.rb

@@ -80,4 +80,24 @@ class Array
     nb = arg.empty? ? (1/0.0) : arg.first
     nb.to_i.times{each(&block)}
   end unless method_defined? :cycle
+  
+  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
+  
+  def shuffle
+    sample(size)
+  end unless method_defined? :shuffle
+
+  def shuffle!
+    replace(sample(size))
+  end unless method_defined? :shuffle!
+
 end

data/lib/backports/enumerable.rb

@@ -1,12 +1,11 @@
 module Enumerable
   # Standard in rails... See official documentation[http://api.rubyonrails.org/classes/Enumerable.html]
+  # Modified from rails 2.3 to not rely on size
   def sum(identity = 0, &block)
-    return identity unless size > 0
-
     if block_given?
-      map(&block).sum
+      map(&block).sum(identity)
     else
-      inject { |sum, element| sum + element }
+      inject { |sum, element| sum + element } || identity
     end
   end unless method_defined? :sum
 
@@ -86,6 +85,7 @@ module Enumerable
     alias_method_chain :each_slice, :optional_block
   end
   
+  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Enumerable.html]
   def count(*arg)
     result = 0
     if block_given?
@@ -99,11 +99,13 @@ module Enumerable
     result
   end unless method_defined? :count
   
+  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Enumerable.html]
   def cycle(*arg, &block)
     return to_enum(:cycle, *arg) unless block_given?
     to_a.cycle(*arg, &block)
   end unless method_defined? :cycle
   
+  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Enumerable.html]
   unless ((1..2).each_cons(1) rescue false)
     def each_cons_with_optional_block(len, &block)
       raise ArgumentError, "invalid size" if len <= 0
@@ -113,12 +115,19 @@ module Enumerable
     alias_method_chain :each_cons, :optional_block
   end
 
+  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Enumerable.html]
   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
+        result.fetch(yield(o)){|key| result[key] = []} << o
       end
     end
   end unless method_defined? :group_by
+  
+  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Enumerable.html]
+  def none?(&block)
+    !any?(&block)
+  end unless method_defined? :none?
+
 end

data/lib/backports/string.rb

@@ -1,14 +1,20 @@
 class String
   # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/String.html]
-  def start_with?(prefix)
-    prefix = prefix.to_s
-    self[0, prefix.length] == prefix
+  def start_with?(*prefixes)
+    prefixes.each do |prefix|
+      prefix = prefix.to_s
+      return true if self[0, prefix.length] == prefix
+    end
+    false
   end unless method_defined? :start_with?
   
   # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/String.html]
-  def end_with?(suffix) 
-    suffix = suffix.to_s
-    self[-suffix.length, suffix.length] == suffix    
+  def end_with?(*suffixes)
+    suffixes.each do |suffix|
+      suffix = suffix.to_s
+      return true if self[-suffix.length, suffix.length] == suffix
+    end
+    false
   end unless method_defined? :end_with?
   
   # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/String.html]
@@ -16,6 +22,36 @@ class String
     self[i]
   end unless method_defined? :getbyte
   
+  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/String.html]
+  unless method_defined? :each_char
+    VERY_BASIC_UTF8 = Regexp.new("[\x00-\x7f]|[\xc2-\xdf].|[\xe0-\xef]..|[\xf0-\xf4]...").freeze
+    def each_char(&block)
+      return to_enum(:each_char) unless block_given?
+      scan(VERY_BASIC_UTF8, &block)
+    end 
+  end
+  
+  alias_method :chars, :each_char unless method_defined? :chars
+  
+  
+  # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/String.html]
+  unless ("check partition".partition(" ") rescue false)
+    def partition_with_new_meaning(*args, &block)
+      return partition_without_new_meaning(*args, &block) unless args.length == 1
+      pattern = args.first
+      i = index(pattern)
+      return [self, "", ""] unless i
+      unless pattern.instance_of? Regexp
+        last = i+pattern.length
+        [self[0...i], self[i...last], self[last...length]]
+      else
+        match = Regexp.last_match
+        [match.pre_match, match[0], match.post_match]
+      end
+    end
+    alias_method_chain :partition, :new_meaning
+  end
+  
   # Standard in rails. See official documentation[http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/String/Inflections.html]
   def camelize(first_letter = :upper) 
     if first_letter == :upper

data/test/array_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class ArrayTest < Test::Unit::TestCase
+  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
+
+    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
+
+    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
+
+    context "#sample" do
+      should "conform to doc" do
+        assert_equal nil, [].sample
+        assert_equal [], [].sample(5)
+        assert_equal 42, [42].sample
+        assert_equal [42], [42].sample(5)
+        a = [ :foo, :bar, 42 ]
+        s = a.sample(2)
+        assert_equal 2, s.size
+        assert_equal 1, (a-s).size
+        assert_equal [], a-(0..20).sum{a.sample(2)} # ~ 3e-10
+      end
+    end
+  end
+end

data/test/{backports_test.rb → enumerable_test.rb}

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class BackportsTest < Test::Unit::TestCase
+class EnumerableTest < Test::Unit::TestCase
   context "Enumerable" do
     context "#find_index" do
       should "conform to doc" do
@@ -104,56 +104,5 @@ class BackportsTest < Test::Unit::TestCase
         assert_equal nil, x[:xyz]
       end
     end
-  end #Enumerable
-  
-  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
-
-    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
-
-    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
-  
-  context "Hash" do
-    should "should be constructible from key value pairs" do
-      assert_equal({1 => 2, 3 => 4}, Hash[[[1,2],[3,4]]])
-    end
-    
-    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
+end

data/test/hash_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class HashTest < Test::Unit::TestCase  
+  context "Hash" do
+    should "should be constructible from key value pairs" do
+      assert_equal({1 => 2, 3 => 4}, Hash[[[1,2],[3,4]]])
+    end
+    
+    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

data/test/string_test.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require 'test_helper'
+
+class StringTest < Test::Unit::TestCase
+  context "String" do
+    context "#chars" do
+      should "conform to doc" do
+        assert_equal ["d", "o", "g"], "dog".chars.to_a
+        assert_equal ["δ", "o", "g"], "δog".chars.to_a
+        result = [] 
+        "δog".chars.each {|b| result << b }
+        assert_equal ["δ", "o", "g"], result
+      end
+    end
+
+    context "#start_with" do
+      should "conform to doc" do
+        assert "Apache".start_with?("Apa")
+        assert "ruby code".start_with?("python", "perl", "ruby")
+        assert !"hello world".start_with?("world")
+      end
+    end
+
+    context "#end_with" do
+      should "conform to doc" do
+        assert "Apache".end_with?("ache")
+        assert "ruby code".end_with?("python", "perl", "code")
+        assert !"hello world".end_with?("hello")
+      end
+    end
+    
+    context "#partition" do
+      should "conform to doc" do
+        assert_equal ["THX", "11", "38"], "THX1138".partition("11")
+        assert_equal ["THX", "11", "38"], "THX1138".partition(/\d\d/)
+        assert_equal ["THX1138", "", ""], "THX1138".partition("99")
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: marcandre-backports
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - "Marc-Andr\xC3\xA9 Lafortune"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-12 00:00:00 -07:00
+date: 2009-04-17 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -37,7 +37,10 @@ files:
 - lib/backports/object.rb
 - lib/backports/string.rb
 - lib/backports/symbol.rb
-- test/backports_test.rb
+- test/array_test.rb
+- test/enumerable_test.rb
+- test/hash_test.rb
+- test/string_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/marcandre/backports
@@ -72,5 +75,8 @@ signing_key:
 specification_version: 2
 summary: Backports or ruby 1.8.7+ & rails for older ruby.
 test_files: 
-- test/backports_test.rb
+- test/array_test.rb
+- test/enumerable_test.rb
+- test/hash_test.rb
+- test/string_test.rb
 - test/test_helper.rb