backports 3.11.4 → 3.12.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 34204ecd79e022cc9d1096bfb9a5fe1258fe288d
-  data.tar.gz: 8b91a3d894e3d6a7a846a411d133092855cdc360
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODRmY2Q4YmY5NzU5YTM0NzM3NjgwYTBkZWNiNTczM2JiM2FmNWZhYw==
+  data.tar.gz: !binary |-
+    OWFjNjgyNDQ5ZWM4MDMwYjUyYTUxYWI2MjJlZGQ2NWI1ZmMxOTI1Yg==
 SHA512:
-  metadata.gz: da12841604ea64a39db7c6872981ff708180b8e0ad6b2c2185efeff54640cba276bdde9e2f7bad8e97f7b490be00d3c06ed5ea6a55592ba686c981865b0f7975
-  data.tar.gz: 9d6c0ec16579891f0a6322e6da92316cf74c3e747f3b4de686ed22dd1ed212061fd6ee0d6cd0b6f9bc7640f1424094b7ef14b1c792b3ac9a083512eab184eab2
+  metadata.gz: !binary |-
+    ZTY4N2YzYzYzY2YzNTkxOWYzNTJmOWQ5ZmU5ZjZjYzA4ZWExNWMwOTMzODI5
+    ZmExMGEwNTdmZjk5OTRhMjhmNzMwNzMzYjViYjhhMzg3YWI3MjU5NzNlN2I2
+    YTZiZWRiYzVlZTFkNDJmM2FiMjIwZjEwODFmZGUwNzZkMjRlODQ=
+  data.tar.gz: !binary |-
+    NjI2ZjkzODNhNDZlMTRhYWVhYTkxYjNhYTVjMDQ2NTk0YjI0NzY0Yzg4OTky
+    MjRkM2VjNzgxZmUxYzQ4YmMyNWE2MTJiNmM1Njg4MTU1MmQ1YWExMzkyZmU1
+    Mzc4MmNmZDE1OTVmZmUzMGE5ODkwOGZmYjAyMWMxZDNmYmQyYjU=

data/.travis.yml

@@ -8,6 +8,8 @@ rvm:
   - "2.2.0"
   - "2.3.0"
   - "2.4.0"
+  - "2.5.0"
+  - "2.6.0"
   - ruby-head
 
 # matrix:

data/CHANGELOG.rdoc

@@ -1,5 +1,7 @@
 = Backports --- History
 
+* From 2.5.0: <tt>String#undump</tt> (Note, much slower performances)
+
 == Version 3.11.0 - December 25th, 2017
 
 * New Ruby version 2.5.0

data/README.rdoc

@@ -1,6 +1,6 @@
 = Backports Library {<img src="https://travis-ci.org/marcandre/backports.svg?branch=master">}[https://travis-ci.org/marcandre/backports] {<img src="https://badge.fury.io/rb/backports.svg" alt="Gem Version" />}[http://badge.fury.io/rb/backports]
 
-Yearning to use some of the new cool features in Ruby 2.5 while using 2.3.x? Have some legacy code in Ruby 1.8 but can't live without `flat_map`?
+Yearning to use some of the new cool features in Ruby 2.6 while using 2.3.x? Have some legacy code in Ruby 1.8 but can't live without `flat_map`?
 
 This gem is for you!
 
@@ -75,6 +75,21 @@ Compatible with Ruby itself, JRuby and Rubinius.
 
 = Complete List of backports
 
+== Ruby 2.6 backports
+
+* Array
+  * +difference+, +union+
+  * +to_h+ (with block)
+
+* Enumerable
+  * +chain+
+  * +to_h+ (with block)
+
+* Enumerator::Chain (use Enumerable#chain)
+
+* Kernel
+  * +then+
+
 == Ruby 2.5 backports
 
 * Array
@@ -97,6 +112,7 @@ Compatible with Ruby itself, JRuby and Rubinius.
 * String
   * +delete_prefix+, +delete_prefix!+
   * +delete_suffix+, +delete_suffix!+
+  * +undump+
 * Struct
   * +new+ (with <code>keyword_init: true</code>)
 
@@ -111,9 +127,9 @@ Compatible with Ruby itself, JRuby and Rubinius.
   * +compact+, +compact!+
   * +transform_values+, +transform_values!+
 * Regexp
-  * +match?+ (slow)
+  * +match?+
 * String
-  * +match?+ (slow)
+  * +match?+
 * FalseClass, Fixnum, Float, NilClass, TrueClass
   * +dup+
 
@@ -375,12 +391,17 @@ 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 ruby/spec[https://github.com/ruby/spec] and then a patch to backports that make it pass the spec. To test rubyspec:
+== Contributing
+
+The best way to submit a patch is to also submit a patch to ruby/spec[https://github.com/ruby/spec] and then a patch to backports that make it pass the spec.
+
+See below to test rubyspec. Note that only features missing from your Ruby version are tested.
 
     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
+    bundle install
+    bundle exec rake spec[hash/slice]          # => tests Hash#slice  (must be in Ruby 2.4 or less)
+    bundle exec rake spec[hash/*]              # => tests all backported Hash methods
+    bundle exec rake spec  (or rake spec[*/*]) # => all rubyspecs for backported methods
 
 Failures that are acceptable are added the to `tags` file.
 

data/Rakefile

@@ -62,9 +62,15 @@ desc "Run specs, where path can be '*/*' (default), 'class/*' or 'class/method'.
 task :spec, :path, :action do |t, args|
   args.with_defaults(:path => '*/*', :action => 'ci')
   specs = SpecRunner.new
-  mspec_cmds(args[:path], 'frozen_old_spec', args[:action]) do |cmd, path|
-    specs.run(cmd, path)
+
+  # Avoid unclear error message by checking if at least one spec exists in the old specs
+  has_frozen_spec = !Dir.glob('frozen_old_spec/rubyspec/core/#{path}_spec.rb')
+  if has_frozen_spec || RUBY_VERSION < '1.9'
+    mspec_cmds(args[:path], 'frozen_old_spec', args[:action]) do |cmd, path|
+      specs.run(cmd, path)
+    end
   end
+
   unless RUBY_VERSION < '1.9' # Give up entirely on running new specs in 1.8.x, mainly because of {hash: 'syntax'}
     mspec_cmds(args[:path], 'spec', args[:action]) do |cmd, path|
       specs.run(cmd, path)
@@ -128,6 +134,7 @@ IGNORE_IN_19 = %w[
   2.1.0/enumerable/to_h
   2.1.0/array/to_h
   2.1.0/module/include
+  2.2.0/kernel/itself
   2.5.0/module/define_method
   2.5.0/module/alias_method
   2.5.0/module/undef_method
@@ -150,6 +157,10 @@ CLASS_MAP = Hash.new{|k, v| k[v] = v}.merge!(
   'nil_class' => 'nil'
 )
 
+EXTRA_SPECS = {
+  'enumerable/chain' => %w[enumerator/chain/*]
+}
+
 def mspec_cmds(pattern, spec_folder, action='ci')
   pattern = "lib/backports/*.*.*/#{pattern}.rb"
   Dir.glob(pattern) do |lib_path|
@@ -166,12 +177,13 @@ def mspec_cmds(pattern, spec_folder, action='ci')
     deps = [*DEPENDENCIES[version_path]].map{|p| "-r #{p}"}.join(' ')
     klass, method = path.split('/')
     path = [CLASS_MAP[klass], method].join('/')
+    spec_paths = [path, *EXTRA_SPECS[path]].map {|p| "#{spec_folder}/rubyspec/core/#{p}_spec.rb" }
     yield %W[mspec #{action}
               -I lib
               -r ./set_version/#{version}
               #{deps}
               -r backports/#{version_path}
-              #{spec_folder}/rubyspec/core/#{path}_spec.rb
+              #{spec_paths.join(' ')}
             ].join(' '), path
   end
 end

data/backports.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Backports::VERSION
   gem.authors       = ["Marc-André Lafortune"]
   gem.email         = ["github@marc-andre.ca"]
-  gem.description   = %q{Essential backports that enable many of the nice features of Ruby 1.8.7 up to 2.1.0 for earlier versions.}
+  gem.description   = %q{Essential backports that enable many of the nice features of Ruby for earlier versions.}
   gem.summary       = %q{Backports of Ruby features for older Ruby.}
   gem.homepage      = "http://github.com/marcandre/backports"
   gem.license       = "MIT"
@@ -17,4 +17,10 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  if gem.respond_to?(:metadata)
+    gem.metadata['changelog_uri'] = 'https://github.com/marcandre/backports/blob/master/CHANGELOG.rdoc'
+    gem.metadata['source_code_uri'] = 'https://github.com/marcandre/backports'
+    gem.metadata['bug_tracker_uri'] = 'https://github.com/marcandre/backports/issues'
+  end
 end

data/default.mspec

@@ -2,7 +2,12 @@ if (Backports::TARGET_VERSION rescue false) # Conf loaded at different times, no
   class MSpecScript
     # The set of substitutions to transform a spec filename
     # into a tag filename.
-    set :tags_patterns, [ [%r(rubyspec/), "tags/#{RUBY_VERSION}/"] ]
+    main_version = RUBY_VERSION
+    unless File.exist?(File.expand_path("../lib/backports/#{main_version}.rb", __FILE__))
+      main_version = main_version.sub(/\.\d+$/, '.0')
+    end
+
+    set :tags_patterns, [ [%r(rubyspec/), "tags/#{main_version}/"] ]
   end
 
   SpecGuard.ruby_version_override = Backports::TARGET_VERSION if Backports::TARGET_VERSION > RUBY_VERSION

data/lib/backports/1.9.1/string/codepoints.rb

@@ -3,6 +3,7 @@ unless String.method_defined? :codepoints
     def codepoints
       return to_enum(:codepoints) unless block_given?
       unpack("U*").each{|cp| yield cp}
+      self
     end
   end
 end

data/lib/backports/2.1.0/enumerable/to_h.rb

@@ -1,5 +1,7 @@
 unless Enumerable.method_defined?(:to_h)
   require 'backports/tools/arguments'
+  require 'backports/1.9.2/enumerable/each_entry'
+
   module Enumerable
     def to_h(*args)
       h = {}

data/lib/backports/2.5.0/string/undump.rb

@@ -0,0 +1,65 @@
+unless String.method_defined? :undump
+  class String
+    def undump
+      # Making sure to return a String and not a subclass
+      string = to_s
+      raise 'string contains null byte' if string["\0"]
+      raise 'non-ASCII character detected' unless string.ascii_only?
+
+      #raise '.force_encoding("...") format is not supported by backports' if string.match(/\A".*"\.force_encoding\("[^"]*"\)\z/)
+      match = string.match(/\A(".*?"?)(?:\.force_encoding\("([^"]*)"\))?\z/)
+      if match
+        string = match[1]
+        encoding = match[2]
+      else
+        raise %(invalid dumped string; not wrapped with '"' nor '"...".force_encoding("...")' form)
+      end
+
+      # Ruby 1.9.3 does weird things to encoding during gsub
+      encoding ||= string.encoding.to_s
+
+      # Unescaped have an even number of backslashes in front of them
+      # because the double-quote is included, the unescaped quotes are where the size is odd
+      nb_unescaped_quote = string.scan(/\\*"/).select { |s| s.size.odd? }.size
+
+      raise 'unterminated dumped string' if nb_unescaped_quote == 1
+
+      if string[-1] != '"' || nb_unescaped_quote > 2
+        raise %(invalid dumped string; not wrapped with '"' nor '"...".force_encoding("...")' form)
+      end
+
+      string = string[1...-1]
+
+      if RUBY_VERSION >= '1.9'
+        # Look-arounds are not supported in ruby 1.8. Using a string with Regexp avoids the SyntaxError in 1.8.7
+        # \xY, \x3Y and finishing with \x
+        regex = Regexp.new("(?<!\\)(?:\\\\)*\\x(?![0-9a-f]{2})".gsub('\\', '\\\\\\\\'), Regexp::IGNORECASE)
+        raise 'invalid hex escape' if string[regex]
+      end
+
+      # The real #undump ignores the \C, \c and \M escapes
+      # Code injection is avoided by:
+      #   * only allowing \u to have {}, so \\\\#{injection} will not eval the injection
+      #   * only allowing the first character after the \\ to not be alpha/num/space, so \\\\#@inst_var_access is ignored
+      # To reduce the number of calls to eval a little, we wrap everything in a (...)+ so that consecutive escapes are
+      # handled at the same time.
+      result = string.gsub(/(\\+(u\{[\w ]+\}|[^cCM][\w]*))+/) do |s|
+        begin
+          eval("\"#{s}\"")
+        rescue SyntaxError => e
+          raise RuntimeError, e.message, e.backtrace
+        end
+      end
+
+      if encoding
+        begin
+          Encoding.find(encoding)
+        rescue ArgumentError
+          raise "dumped string has unknown encoding name"
+        end
+        result = result.force_encoding(encoding)
+      end
+      result
+    end
+  end
+end

data/lib/backports/2.6.0.rb

@@ -0,0 +1,3 @@
+# require this file to load all the backports up to Ruby 2.5
+require 'backports/2.5'
+Backports.require_relative_dir

data/lib/backports/2.6.0/array.rb

@@ -0,0 +1,3 @@
+require 'backports/tools/require_relative_dir'
+
+Backports.require_relative_dir

data/lib/backports/2.6.0/array/difference.rb

@@ -0,0 +1,5 @@
+class Array
+  def difference(*arrays)
+    arrays.inject(Array.new(self), :-)
+  end unless method_defined? :difference
+end

data/lib/backports/2.6.0/array/to_h.rb

@@ -0,0 +1,13 @@
+require 'backports/2.1.0/array/to_h' unless Array.method_defined? :to_h
+
+if [[:need, true]].to_h { [:need, false] } [:need]
+  require 'backports/tools/alias_method_chain'
+
+  class Array
+    def to_h_with_block(&block)
+      receiver = block ? map(&block) : self
+      receiver.to_h_without_block
+    end
+    Backports.alias_method_chain self, :to_h, :block
+  end
+end

data/lib/backports/2.6.0/array/union.rb

@@ -0,0 +1,5 @@
+class Array
+  def union(*arrays)
+    [self, *arrays].inject([], :|)
+  end unless method_defined? :union
+end

data/lib/backports/2.6.0/enumerable.rb

@@ -0,0 +1,3 @@
+require 'backports/tools/require_relative_dir'
+
+Backports.require_relative_dir

data/lib/backports/2.6.0/enumerable/chain.rb

@@ -0,0 +1,47 @@
+unless Enumerable.method_defined? :chain
+  module Enumerable
+    def chain(*enums)
+      Enumerator::Chain.new(self, *enums)
+    end
+  end
+
+  Enumerator = Enumerable::Enumerator unless Object.const_defined? :Enumerator # For 1.8.x
+
+  class Enumerator::Chain < Enumerator
+    def initialize(*enums)
+      @enums = enums
+      @rewindable = -1
+      self
+    end
+
+    def each(*args, &block)
+      @enums.each_with_index do |enum, i|
+        @rewindable = i
+        enum.each(*args, &block)
+      end
+    end
+
+    def size
+      sum = 0
+      @enums.each do |enum|
+        s = enum.size
+        return s if s == nil || s == Float::INFINITY
+        sum += s
+      end
+      sum
+    end
+
+    def inspect
+      detail = @enums.map(&:inspect).join(', ')
+      "#<Enumerator::Chain: [#{detail}]>"
+    end
+
+    def rewind
+      @rewindable.downto(0) do |i|
+        enum = @enums[i]
+        enum.rewind if enum.respond_to? :rewind
+      end
+      self
+    end
+  end unless Enumerator.const_defined? :Chain
+end

data/lib/backports/2.6.0/enumerable/to_h.rb

@@ -0,0 +1,13 @@
+require 'backports/2.1.0/enumerable/to_h' unless Enumerable.method_defined? :to_h
+
+if Enumerable.instance_method(:to_h).bind([[:need, true]]).call { [:need, false] } [:need]
+  require 'backports/tools/alias_method_chain'
+
+  module Enumerable
+    def to_h_with_block(*args, &block)
+      return to_h_without_block(*args) unless block
+      map(*args, &block).to_h_without_block
+    end
+    Backports.alias_method_chain self, :to_h, :block
+  end
+end

data/lib/backports/2.6.0/kernel.rb

@@ -0,0 +1,3 @@
+require 'backports/tools/require_relative_dir'
+
+Backports.require_relative_dir

data/lib/backports/2.6.0/kernel/then.rb

@@ -0,0 +1,7 @@
+unless Kernel.method_defined? :then
+  require 'backports/2.5.0/kernel/yield_self'
+
+  module Kernel
+    alias_method :then, :yield_self
+  end
+end

data/lib/backports/2.6.rb

@@ -0,0 +1,2 @@
+# require this file to load all the backports of Ruby 2.4 and below
+require 'backports/2.6.0'

data/lib/backports/version.rb

@@ -1,3 +1,3 @@
 module Backports
-  VERSION = "3.11.4" unless const_defined? :VERSION # the guard is against a redefinition warning that happens on Travis
+  VERSION = "3.12.0" unless const_defined? :VERSION # the guard is against a redefinition warning that happens on Travis
 end

data/set_version/2.6.0.rb

@@ -0,0 +1 @@
+require File.expand_path(File.dirname(__FILE__) + "/setter")

data/spec/tags/1.8.7/core/array/to_h_spec.rb

@@ -0,0 +1,3 @@
+fails:Array#to_h with block raises ArgumentError if block returns longer or shorter array
+fails:Array#to_h with block raises TypeError if block returns something other than Array
+fails:Array#to_h with block does not coerce returned pair to Array with #to_a

data/spec/tags/1.8.7/core/enumerable/to_h_spec.rb

@@ -0,0 +1,2 @@
+fails:Enumerable#to_h with block raises TypeError if block returns something other than Array
+fails:Enumerable#to_h with block does not coerce returned pair to Array with #to_a

data/spec/tags/1.8.7/core/module/attr_spec.rb

@@ -0,0 +1 @@
+fails:Module#attr with a boolean argument emits a warning when $VERBOSE is true

data/spec/tags/1.9.1/core/hash/slice_spec.rb

@@ -0,0 +1 @@
+fails:Hash#slice uses the regular Hash#[] method, even on subclasses that override it

data/spec/tags/1.9.1/core/module/attr_spec.rb

@@ -0,0 +1 @@
+fails:Module#attr with a boolean argument emits a warning when $VERBOSE is true

data/spec/tags/1.9.2/core/array/to_h_spec.rb

@@ -0,0 +1,3 @@
+fails:Array#to_h with block raises ArgumentError if block returns longer or shorter array
+fails:Array#to_h with block raises TypeError if block returns something other than Array
+fails:Array#to_h with block does not coerce returned pair to Array with #to_a

data/spec/tags/1.9.2/core/enumerable/to_h_spec.rb

@@ -0,0 +1,2 @@
+fails:Enumerable#to_h with block raises TypeError if block returns something other than Array
+fails:Enumerable#to_h with block does not coerce returned pair to Array with #to_a

data/spec/tags/1.9.2/core/hash/slice_spec.rb

@@ -0,0 +1 @@
+fails:Hash#slice uses the regular Hash#[] method, even on subclasses that override it

data/spec/tags/1.9.2/core/kernel/then_spec.rb

@@ -0,0 +1 @@
+fails:Kernel#then returns a sized Enumerator when no block given