backports 3.0.3 → 3.1.0

data/.gitignore

@@ -5,4 +5,4 @@ coverage
 rdoc
 pkg
 assets
-rs
+rs

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "rubyspec"]
+	path = rubyspec
+	url = git://github.com/rubyspec/rubyspec.git

data/.travis.yml

@@ -1,6 +1,6 @@
+---
 language: ruby
 rvm:
-  - "1.8.6"
   - "1.8.7"
   - "1.9.2"
   - "1.9.3"
@@ -10,4 +10,13 @@ rvm:
   - rbx-18mode
   - rbx-19mode
 
-bundle exec rake test
+matrix:
+  allow_failures:
+    - rvm: "2.0.0" # Must wait for 2.0.0p0...
+    - rvm: jruby-18mode
+    - rvm: jruby-19mode
+    - rvm: rbx-18mode
+    - rvm: rbx-19mode
+
+before_install:
+  - git submodule update --init --recursive

data/CHANGELOG.rdoc

@@ -1,5 +1,11 @@
 = Backports --- History
 
+== Version 3.1.0 - March 5th, 2013
+
+* Backports can now be loaded separately!
+
+* Small tweaks and fixes for many methods to pass more RubySpecs
+
 == Version 3.0.0 - February 24th, 2013
 
 * Features of 2.0.0 are now required when requiring 'backports'.

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in backports.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+group :test do
+  gem "rake"
+  gem 'mspec', :git => 'git://github.com/rubyspec/mspec.git'
+end
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GIT
+  remote: git://github.com/rubyspec/mspec.git
+  revision: 69c388b1187789f4996eda7dec4c1404fcd6b742
+  specs:
+    mspec (1.5.18)
+
+PATH
+  remote: .
+  specs:
+    backports (3.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rake (10.0.3)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  backports!
+  mspec!
+  rake

data/README.rdoc

@@ -1,4 +1,4 @@
-= Backports Library
+= Backports Library {<img src="https://travis-ci.org/marcandre/backports.png?branch=master">}[https://travis-ci.org/marcandre/backports]
 
 * 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?
@@ -6,7 +6,16 @@
 
 This gem is for you!
 
-The goal of 'backports' is to make it easier to write ruby code that runs across different versions of Ruby. All you need to bring any version of Ruby up to today's standards:
+The goal of 'backports' is to make it easier to write ruby code that runs across different versions of Ruby.
+
+For example, if you want to use flat_map, even in Ruby implementations that don't include it, as well as the new bsearch method:
+
+  require 'backports/1.9.2/enumerable/flat_map'
+  require 'backports/2.0.0/array/bsearch'
+
+This will enable Enumerable#flat_map and Array#bsearch, using the native versions if available or otherwise provide a pure Ruby version.
+
+You can load many backports at once. For example, any version of Ruby up to today's standards:
 
   require 'backports'
 
@@ -16,12 +25,12 @@ This will bring in all the features of 1.8.7 and many features of Ruby 1.9.x and
 
 == What's inside
 
-Features in this gem:
+Goals for backported features:
 1. Won't break older code
 2. Pure Ruby (no C extensions)
 3. Pass RubySpec[http://github.com/rubyspec/rubyspec]
 
-Let's be a bit more precise about the breaking code business. It is of course entirely possible that code will break, for example some core methods are monkeypatched or if the code relies on a certain call raising an exception. Example: <tt>[42].sample rescue "dum example"</tt> will return <tt>"dum example"</tt> without this gem and <tt>42</tt> with it.
+Let's be a bit more precise about the "breaking code" business. It is of course entirely possible that code will break, for example some core methods are monkeypatched or if the code relies on a certain call raising an exception. Example: <tt>[42].sample rescue "dum example"</tt> will return <tt>"dum example"</tt> without this gem and <tt>42</tt> with it.
 
 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)
 
@@ -38,7 +47,23 @@ Some generic and self-contained features of active-support are also included. By
 To use:
 
   require 'rubygems'
-  require 'backports'   # or a subset, see next section
+  # For only specific backports:
+  require 'backports/1.9.1/kernel/require_relative'
+  require 'backports/2.0.0/enumerable/lazy'
+
+  # For all backports up to a given version
+  require 'backports/1.9.2' # All backports for Ruby 1.9.2 and below
+
+  # Or for all backports
+  require 'backports'
+
+Note: about a dozen of backports have a dependency that will be also loaded. For example, the backport of Enumerable#flat_map uses flatten(1), so if required from Ruby 1.8.6 (where Array#flatten does not accept an argument), the backport for Ruby's 1.8.7 flatten with an argument will also be loaded.
+
+With bundler, add to your Gemfile:
+
+  gem 'backports', :load => false
+
+Run <tt>bundle install</tt> and require the desired backports.
 
 Compatible with Ruby 1.8.6, 1.8.7, 1.9.1, 1.9.2, 1.9.3, JRuby and Rubinius.
 
@@ -46,12 +71,12 @@ Compatible with Ruby 1.8.6, 1.8.7, 1.9.1, 1.9.2, 1.9.3, JRuby and Rubinius.
 
 == Ruby 1.8.7
 
-Complete Ruby 1.8.7 backporting (core language). Refer to the official list of changes[https://github.com/ruby/ruby/blob/ruby_1_8_7/NEWS].
+Complete Ruby 1.8.7 backporting (core language). Refer to the official list of changes[https://github.com/ruby/ruby/blob/ruby_1_8_7/NEWS]. That's about 130 backports!
 
 Only exceptions:
 * String#gsub (the form returning an enumerator)
 * GC.stress=  (not implemented)
-* Array#choice (removed in 1.9, use Array#sample instead)
+* Array#choice (removed in 1.9, use 1.9.1's Array#sample instead)
 
 To include _only_ these backports, <tt>require "backports/1.8.7"</tt>
 
@@ -64,6 +89,7 @@ Ruby 1.8.8 has been officially cancelled. As of version 2.2, <tt>require "backpo
 Additionally, the following Ruby 1.9 features have been backported:
 * Array
   * +try_convert+
+  * +sample+
 
 * Enumerable
   * +each_with_object+
@@ -275,7 +301,6 @@ Some backports would create incompatibilities in their current Ruby version but
 
 These must be imported in addition to the backports gem, for example:
 
-  require "backports"
   require "backports/force/hash_select"
   {}.select{} # => {}, even in Ruby 1.8
 
@@ -287,11 +312,14 @@ Thanks for the bug reports and patches, in particular the repeat offenders:
 * Konstantin Haase ( rkh[https://github.com/rkh])
 * Roger Pack ( rdp[http://github.com/rdp] )
 
-The best way to submit a patch is to also submit a patch to RubySpec[https://github.com/rubyspec/rubyspec] and then a patch to backports that make it pass the spec. To test rubyspec along with backports, one way to test this is:
+The best way to submit a patch is to also submit a patch to RubySpec[https://github.com/rubyspec/rubyspec] and then a patch to backports that make it pass the spec. To test rubyspec:
 
-    mspec path/to/specs -t path/to/ruby186 --unguarded -r path/to/backports
+    git submodule init && git submodule update # => pulls rubyspecs
+    rake spec[array/bsearch]       # => tests Array#bsearch
+    rake spec[array/*]             # => tests all backported Array methods
+    rake spec  (or rake spec[*/*]) # => all rubyspecs for backported methods
 
-You must then check manually for which failures are acceptable and which are not.
+Failures that are acceptable are added the to `tags` file.
 
 = License
 

data/Rakefile

@@ -1,4 +1,8 @@
-require "bundler/gem_tasks"
+begin
+  require "bundler/gem_tasks"
+rescue LoadError
+  # bundler not installed
+end
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -6,3 +10,96 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/**/*_test.rb'
   test.verbose = false
 end
+
+task :spec, :path, :action do |t, args|
+  args.with_defaults(:path => '*/*', :action => 'ci')
+  stats = [[0] * 5]
+  not_found = []
+  mspec_cmds(args[:path], args[:action]) do |cmd, path|
+    result = `#{cmd}`
+    match = result.match(/(\d+) files?, (\d+) examples?, (\d+) expectations?, (\d+) failures?, (\d+) errors?/)
+    if match.nil?
+      puts "*** mspec returned with unexpected results:"
+      puts result
+      puts "Command was:", cmd
+      fail "Unexpected output from mspec"
+    end
+    _, ex, p, f, e = data = match.captures.map{|x| x.to_i}
+    not_found << path if ex == 0
+    stats << data
+    if f + e > 0
+      puts cmd
+      puts result
+    else
+      print "."
+      STDOUT.flush
+    end
+  end
+  $:.unshift 'lib'
+  require 'backports/rails'
+  _, ex, p, f, e = stats = stats.transpose.map{|x| x.sum}
+  puts "*** Overall:", stats.zip(%w[files examples expectations failures errors]).map{|a| a.join(' ')}.join(', ')
+  puts "No spec found for #{not_found.join(', ')}" unless not_found.empty?
+  fail unless f + e == 0
+end
+
+task :all_spec do # Necessary because of argument passing bug in 1.8.7
+  Rake::Task[:spec].invoke
+end
+
+task :spec_tag, :path do |t, args|
+  Rake::Task[:spec].invoke(args[:path], 'tag -G fails')
+end
+
+task :default => [:test, :all_spec]
+
+DEPENDENCIES = Hash.new([]).merge!(
+  '1.8.7/argf/chars'     => 'backports/1.8.7/string/each_char',
+  '1.8.7/argf/each_char' => 'backports/1.8.7/string/each_char',
+  '1.8.7/array/cycle'    => 'backports/1.8.7/stop_iteration',
+  '1.8.7/enumerable/entries' => ['backports/1.8.7/enumerable/each_with_index', 'backports/1.8.7/enumerable/to_a'],
+  '1.8.7/enumerator/rewind' => 'backports/1.8.7/enumerator/next',
+  '1.8.7/hash/reject' => 'backports/1.8.7/integer/even',
+  '1.9.1/hash/rassoc'    => 'backports/1.8.7/hash/key',
+  '1.9.1/proc/lambda'    => 'backports/1.9.1/proc/curry',
+  '1.9.2/complex/to_r'   => 'complex',
+  '1.9.2/array/select'    => 'backports/1.8.7/array/select',
+  '1.9.2/hash/select'    => 'backports/1.8.7/hash/select',
+  '1.9.2/enumerable/each_entry' => 'backports/1.8.7/enumerable/each_with_index',
+  '2.0.0/hash/to_h'      => 'backports/1.9.1/hash/default_proc'
+)
+{
+  :each_with_index => %w[enumerable/detect enumerable/find enumerable/find_all enumerable/select enumerable/to_a],
+  :first => %w[enumerable/cycle io/bytes io/chars io/each_byte io/each_char io/lines io/each_line]
+}.each do |req, libs|
+  libs.each{|l| DEPENDENCIES["1.8.7/#{l}"] = "backports/1.8.7/enumerable/#{req}" }
+end
+
+# These cause actual errors while loading in 1.8:
+IGNORE_IN_18 = %w[
+  1.9.1/symbol/length
+  1.9.1/symbol/size
+  1.9.3/string/byteslice
+  1.8.7/proc/yield
+  1.9.1/proc/case_compare
+]
+def mspec_cmds(pattern, action='ci')
+  pattern = "lib/backports/*.*.*/#{pattern}.rb"
+  Dir.glob(pattern) do |lib_path|
+    _match, version, path = lib_path.match(/backports\/(\d\.\d\.\d)\/(.*)\.rb/).to_a
+    next if path =~ /stdlib/
+    next if version <= RUBY_VERSION
+    version_path = "#{version}/#{path}"
+    next if IGNORE_IN_18.include? version_path if RUBY_VERSION < '1.9'
+    deps = [*DEPENDENCIES[version_path]].map{|p| "-r #{p}"}.join(' ')
+    klass, method = path.split('/')
+    path = [klass.gsub('_', ''), method].join('/') # don't ask me why RubySpec uses matchdata instead of match_data
+    yield %W[mspec #{action}
+              -I lib
+              -r ./set_version/#{version}
+              #{deps}
+              -r backports/#{version_path}
+              rubyspec/core/#{path}_spec.rb
+            ].join(' '), path
+  end
+end

data/default.mspec

@@ -0,0 +1,9 @@
+if (Backports::TARGET_VERSION rescue false) # Conf loaded at different times, not sure why
+  class MSpecScript
+    # The set of substitutions to transform a spec filename
+    # into a tag filename.
+    set :tags_patterns, [ [%r(rubyspec/), "tags/#{RUBY_VERSION}/"] ]
+  end
+
+  SpecGuard.ruby_version_override = Backports::TARGET_VERSION if Backports::TARGET_VERSION > RUBY_VERSION
+end

data/lib/backports.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/backports/tools")
-Backports.require_relative "backports/version"
-Backports.require_relative "backports/2.0"
-Backports.require_relative "backports/rails"
+require "backports/tools"
+require "backports/version"
+require "backports/2.0"
+require "backports/rails"

data/lib/backports/1.8.7.rb

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

data/lib/backports/1.8.7/argf.rb

@@ -1,44 +1,3 @@
-class << ARGF
-  # No official documentation...
+require 'backports/tools'
 
-  if RUBY_VERSION < '1.8.7' # Can't test without block, as this hangs
-    Backports.make_block_optional self, :each, :each_line, :each_byte, :force => true
-  end
-
-  def each_char
-    return to_enum(:each_char) unless block_given?
-    if $KCODE == "UTF-8"
-      lookup = 7.downto(4)
-      while c = read(1) do
-        n = c[0]
-        leftmost_zero_bit = lookup.find{|i| n[i].zero? }
-        case leftmost_zero_bit
-        when 7 # ASCII
-          yield c
-        when 6 # UTF 8 complementary characters
-          next # Encoding error, ignore
-        else
-          more = read(6-leftmost_zero_bit)
-          break unless more
-          yield c+more
-        end
-      end
-    else
-      while s = read(1)
-        yield s
-      end
-    end
-
-    self
-  end unless method_defined? :each_char
-
-  # No official documentation...
-  Backports.alias_method self, :getbyte, :getc
-
-  # No official documentation...
-  Backports.alias_method self, :readbyte, :readchar
-
-  Backports.alias_method self, :bytes, :each_byte
-  Backports.alias_method self, :chars, :each_char
-  Backports.alias_method self, :lines, :each_line
-end
+Backports.require_relative_dir

data/lib/backports/1.8.7/argf/bytes.rb

@@ -0,0 +1 @@
+require 'backports/1.8.7/argf/each_byte'

data/lib/backports/1.8.7/argf/chars.rb

@@ -0,0 +1 @@
+require 'backports/1.8.7/argf/each_char'

data/lib/backports/1.8.7/argf/each.rb

@@ -0,0 +1,3 @@
+require 'backports/tools'
+
+Backports.make_block_optional ARGF, :each, :force => true if RUBY_VERSION < '1.8.7'

data/lib/backports/1.8.7/argf/each_byte.rb

@@ -0,0 +1,9 @@
+if RUBY_VERSION < '1.8.7'
+  require 'backports/tools'
+
+  class << ARGF
+    Backports.make_block_optional ARGF, :each_byte, :force => true
+
+    alias_method :bytes, :each_byte
+  end
+end

data/lib/backports/1.8.7/argf/each_char.rb

@@ -0,0 +1,35 @@
+unless ARGF.respond_to? :each_char
+  require 'backports/tools'
+  require 'enumerator'
+
+  class << ARGF
+    def each_char
+      return to_enum(:each_char) unless block_given?
+      if $KCODE == "UTF-8"
+        lookup = 7.downto(4)
+        while c = read(1) do
+          n = c[0]
+          leftmost_zero_bit = lookup.find{|i| n[i].zero? }
+          case leftmost_zero_bit
+          when 7 # ASCII
+            yield c
+          when 6 # UTF 8 complementary characters
+            next # Encoding error, ignore
+          else
+            more = read(6-leftmost_zero_bit)
+            break unless more
+            yield c+more
+          end
+        end
+      else
+        while s = read(1)
+          yield s
+        end
+      end
+
+      self
+    end
+
+    Backports.alias_method self, :chars, :each_char
+  end
+end

data/lib/backports/1.8.7/argf/each_line.rb

@@ -0,0 +1,3 @@
+require 'backports/tools'
+
+Backports.make_block_optional ARGF, :each_line, :force => true if RUBY_VERSION < '1.8.7'