backports 1.0.0 → 1.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,14 @@
+= Packable --- History
+
+== Version 1.1 - April 11, 2009
+
+* Array
+  * +flatten+, <tt>flatten!</tt>
+  * +find_index+, +index+
+  
+* Hash
+  * +reverse_merge+, <tt>reverse_merge!</tt>
+
+== Version 1.0 - April 2nd, 2009
+
+=== Initial release.

data/README.rdoc

@@ -10,10 +10,14 @@ Conditions for inclusion:
 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 String::pluralize), won't be included. <tt>require 'activesupport'</tt> if you need them!
+More complex features of activesupport (even things like <tt>String::pluralize</tt>), won't be included. <tt>require 'activesupport'</tt> if you need them!
 
 I've added those as I need them; pull requests welcome (with tests for ruby 1.9 backports)
 
+== Compatibility
+
+Works with ruby 1.8 & 1.9
+
 = List of backports
 
 * Symbol
@@ -33,15 +37,21 @@ I've added those as I need them; pull requests welcome (with tests for ruby 1.9
 * Hash
   * <tt>Hash[[[:foo, :bar],[:hello, "world"]]] ==> {:foo => :bar, :hello => "world"}</tt>
   * +key+
-  * +symbolize_keys+, +symbolize_keys!+
+  * +symbolize_keys+, <tt>symbolize_keys!</tt>
+  * +reverse_merge+, <tt>reverse_merge!</tt>
 * Enumerable
   * +sum+
   * +find_index+
   * +take+, +take_while+, +drop+, +drop_while+
   * +first+
+* Array
+  * +flatten+, <tt>flatten!</tt>
+  * +find_index+, +index+
 * 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>)
+
 = License
 
 +backports+ is released under the terms of the MIT License, see the included LICENSE file.

data/Rakefile

@@ -0,0 +1,91 @@
+# encoding: utf-8
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "backports"
+    gem.summary = "Backports or ruby 1.8.7+ & rails for older ruby."
+    gem.email = "github@marc-andre.ca"
+    gem.homepage = "http://github.com/marcandre/backports"
+    gem.authors = ["Marc-André Lafortune"]
+    gem.rubyforge_project = "backports"
+  
+    gem.description = <<-EOS
+      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.
+    EOS
+    gem.has_rdoc = true
+    gem.rdoc_options << '--title' << 'Backports library' <<
+                           '--main' << 'README.rdoc' <<
+                           '--line-numbers' << '--inline-source'
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "backports #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+    
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+    
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/backports/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION.yml

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

data/lib/backports.rb

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

data/lib/backports/array.rb

@@ -0,0 +1,60 @@
+class Array
+  # flatten & flatten!, standard in ruby 1.9. 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)
+      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)
+      
+      ret, out = nil, []
+      ret = recursively_flatten_finite(self, out, level)
+      replace(out) if ret
+      ret
+    end
+
+    alias_method_chain :flatten, :optional_argument
+    alias_method_chain :flatten!, :optional_argument
+
+    # Helper to recurse through flattening since the method
+    # is not allowed to recurse itself. Detects recursive structures.
+    # Adapted from rubinius'; recursion guards are not needed because level is finite
+    def recursively_flatten_finite(array, out, level)
+      ret = nil
+      if level <= 0
+        out.concat(array)
+      else
+        array.each do |o|
+          if o.respond_to? :to_ary
+            recursively_flatten_finite(o.to_ary, out, level - 1)
+            ret = self
+          else
+            out << o
+          end
+        end
+      end
+      ret
+    end
+    private :recursively_flatten_finite
+  end # flatten & flatten!
+  
+  # index
+  unless ([1].index{true} rescue false)
+    def index_with_block(*arg)
+      return index_without_block(*arg) unless block_given? && arg.empty?
+      each_with_index{|o,i| return i if yield o}
+      return nil
+    end
+    
+    alias_method_chain :index, :block
+    alias_method :find_index, :index
+  end
+end

data/lib/backports/hash.rb

@@ -23,4 +23,15 @@ class Hash
   
   # Standard in ruby 1.9. 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
+  
 end

data/test/backports_test.rb

@@ -62,4 +62,32 @@ class BackportsTest < Test::Unit::TestCase
       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"}
+    end
+  end
+      
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: backports
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - "Marc-Andr\xC3\xA9 Lafortune"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-01 00:00:00 -04:00
+date: 2009-04-11 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -20,12 +20,16 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
 - LICENSE
+- README.rdoc
 files: 
+- CHANGELOG.rdoc
+- LICENSE
 - README.rdoc
+- Rakefile
 - VERSION.yml
-- lib/backports
+- lib/backports.rb
+- lib/backports/array.rb
 - lib/backports/enumerable.rb
 - lib/backports/fixnum.rb
 - lib/backports/hash.rb
@@ -33,22 +37,19 @@ files:
 - lib/backports/object.rb
 - lib/backports/string.rb
 - lib/backports/symbol.rb
-- lib/backports.rb
 - test/backports_test.rb
 - test/test_helper.rb
-- LICENSE
 has_rdoc: true
 homepage: http://github.com/marcandre/backports
 post_install_message: 
 rdoc_options: 
+- --charset=UTF-8
 - --title
 - Backports library
 - --main
 - README.rdoc
 - --line-numbers
 - --inline-source
-- --inline-source
-- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -65,10 +66,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: marcandre
+rubyforge_project: backports
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Backports or ruby 1.8.7+ & rails for older ruby.
-test_files: []
-
+test_files: 
+- test/backports_test.rb
+- test/test_helper.rb