polyfill 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 378610a792ea5873a656859b5e1bd5d46402dd70
-  data.tar.gz: d0d81f15485b7bc5de7f0480071aa32d90f583f2
+  metadata.gz: f89fe1c04a0c5226662965adf194eca6e5efb720
+  data.tar.gz: 714c012252e26b39e93e3967af657a1ba1a6b7f2
 SHA512:
-  metadata.gz: c9a61e5c76de85f31c9ee24ec75e125102b78acd7ed235e1227c55e3792bacb6bf991eadc90f2695141e3978abdd8ce4720d00e137bf0a7e20197ae213e7ea7b
-  data.tar.gz: f3b1f7bfd59f1fd341c061a05ce48804db9e933db5b8bad4e664473bcaf586a37cb1bb84e63c4f55dd60fde0271f2d57aa64362723263539327f3c9adac5ea51
+  metadata.gz: 518365852878a1fd4146557895021ecaeff61ae04804e5d386bf43623a8f5114e3cfc7fc8801c978654f83403cff56326fa63e55795cbc3b89fc3d4653a02ddb
+  data.tar.gz: 27082bfce68e460d5dc49697f6020194293631b5b1170653a1edf04bc8145e2d002e3027d110094ee238adf58d76aed0c7b4d29bfe7bc521c12a499453918945

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.1
 Metrics/AbcSize:
   Enabled: false
 Metrics/BlockLength:

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
   - 2.4.1
-  - 2.3.3
-  - 2.2.6
+  - 2.3.4
+  - 2.2.7
+  - 2.1.10

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# [0.7.0][] (2017-04-22)
+
+## Changed
+
+ - Sending no parameters to `Polyfill()` now returns nothing instead of everything.
+
+## Added
+
+ - Support for Ruby 2.1
+ - v2.2 Enumerable#slice_after
+ - v2.2 Kernel#itself
+ - v2.3 Kernel#loop
+
 # [0.6.0][] (2017-04-06)
 
 ## Fix
@@ -56,6 +69,10 @@
 
 # [0.3.0][] (2017-03-19)
 
+## Changed
+
+ - New way to select methods that doesn't rely on knowing the module structure
+
 ## Added
 
  - v2.4 Dir.empty?
@@ -71,11 +88,14 @@
  - v2.4 StringIO#readline
  - v2.4 StringIO#readlines
 
-## Changes
+# [0.2.0][] (2017-03-17)
 
- - New way to select methods that doesn't rely on knowing the module structure
+## Changed
 
-# [0.2.0][] (2017-03-17)
+ - Modules are camel case instead of only uppercasing the first letter of the method name.
+ - Modules for predicate methods now end with `Q` instead of `__Q`.
+ - Modules for dangerous methods now end with `E` instead of `__E`.
+ - Methods will no longer attempt to fix `#respond_to?`, `#methods`, or `.instance_methods`. This will be revisited later with a more comprehensive solution.
 
 ## Added
 
@@ -86,13 +106,6 @@
  - v2.4 Hash#transform_values
  - v2.4 Hash#transform_values!
 
-## Changes
-
- - Modules are camel case instead of only uppercasing the first letter of the method name.
- - Modules for predicate methods now end with `Q` instead of `__Q`.
- - Modules for dangerous methods now end with `E` instead of `__E`.
- - Methods will no longer attempt to fix `#respond_to?`, `#methods`, or `.instance_methods`. This will be revisited later with a more comprehensive solution.
-
 # [0.1.0][] (2017-03-14)
 
  - v2.4 Array#concat
@@ -110,6 +123,9 @@
  - v2.4 String#concat?
  - v2.4 String#prepend?
 
+[0.7.0]: https://github.com/AaronLasseigne/polyfill/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/AaronLasseigne/polyfill/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/AaronLasseigne/polyfill/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/AaronLasseigne/polyfill/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/AaronLasseigne/polyfill/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/AaronLasseigne/polyfill/compare/v0.1.0...v0.2.0

data/CONTRIBUTING.md

@@ -12,8 +12,6 @@ A list of changes can be found at:
  * https://raw.githubusercontent.com/ruby/ruby/v2_4_1/NEWS
  * https://raw.githubusercontent.com/ruby/ruby/v2_3_4/NEWS
  * https://raw.githubusercontent.com/ruby/ruby/v2_2_7/NEWS
- * https://raw.githubusercontent.com/ruby/ruby/v2_1_10/NEWS
- * https://raw.githubusercontent.com/ruby/ruby/v2_0_0_648/NEWS
 
 Specific changes can be found by going to the [Ruby bug/feature tracker].
 

data/README.md

@@ -10,15 +10,14 @@ code that would like newer features but is not completely ready to upgrade
 Ruby versions. The polyfills are built using refinements so there is **no
 monkey patching** that may cause issues outside of your use.
 
-Right now the only update is from 2.3 to 2.4 however the goal is to go all the way back to 2.0 (when refinements were introduced). Additionally, core methods are being focused on but stdlib will eventually be added.
-
 - [Caveat Emptor](#caveat-emptor)
 - [Installation](#installation)
 - [Goals](#goals)
 - [Usage](#usage)
 - [Implementation Table](#implementation-table)
-  - [2.3 to 2.4](#23-to-24)
-  - [2.2 to 2.3](#22-to-23)
+  - [2.4](#24)
+  - [2.3](#23)
+  - [2.2](#22)
 
 ## Caveat Emptor
 
@@ -34,7 +33,7 @@ See the [implementation table](#implementation-table) for specifics about what h
 Add it to your Gemfile:
 
 ```ruby
-gem 'polyfill', '0.6.0'
+gem 'polyfill', '0.7.0'
 ```
 
 Or install it manually:
@@ -47,59 +46,63 @@ This project uses [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## Goals
 
-1. Features should ideally mimic the true behavior (including bugs).
+1. Features should ideally mimic the true behavior (including bugs, error messages, etc).
 2. Features should not significantly burden the runtime.
 3. Keep everything modular so users can be specific or broad in their usage.
 
 ## Usage
 
-To use all updates:
-
-```ruby
-using Polyfill
-```
-
-To specify methods from a particular object use it's class name and pass an
-array of strings containing the methods you'd like to use. Instance methods
-need to start with "#" and class methods need to start with ".".
+With the `Polyfill` method, you can polyfill methods for one or more Ruby
+objects. Each object is passed as a key. The value is an array of strings
+containing the methods you would like to polyfill. Instance methods need to
+start with '#' and class methods need to start with '.'.
 
 ```ruby
 using Polyfill(
   Array: %w[#concat],
   Dir: %w[.empty?],
-  Hash: %w[#compact! #transform_values],
+  Hash: %w[#compact! #transform_values]
 )
 ```
 
-If you want all of the methods for a particular class you can use `:all`.
+If you want all of the methods for a particular object you can use `:all` in
+place of the array.
 
 ```ruby
 using Polyfill(Numeric: :all)
 ```
 
-Updates can be stopped at a specific version by pass it via `:version`. The
-version selected must be formatted as "MAJOR.MINOR".
+Polyfills can be halted at a maximum version with the `:version` option. The
+version must be a string with the major and minor version only.
 
 ```ruby
 using Polyfill(version: '2.3', Numeric: :all)
 ```
 
-Methods can be included in the same way. Prior to Ruby 2.4, refinements did
-not work on modules. In order to get methods you'll need to include them after
-the module. Calling `using` on a module will add it to all core Ruby classes
-that include it. The methods will only be included if they are needed by the
-Ruby version running the code.
+When you add a method it will not be available in all of the ways a normal
+method is. For example, you can't call `send` on a refined method prior to
+Ruby 2.4. To gain back some of this support you can set `native: true`.
+This currently adds support for `respond_to?`, `__send__`, and `send`.
+
+```ruby
+using Polyfill(native: true, Numeric: :all)
+```
+
+Prior to Ruby 2.4, refinements do not work on Modules. When using a polyfill
+on a module it will instead refine the core classes that use the module. If
+you're building your own class, it will not receive the polyfill. Instead,
+you can add the polyfill by using `include`.
 
 ```ruby
 class Foo
   include Comparable
-  include Polyfill(Comparable: %w[#clamp])
+  include Polyfill(Comparable: :all)
 end
 ```
 
 ## Implementation Table
 
-### 2.3 to 2.4
+### 2.4
 
 | Object           | Method                   | Implemented | Notes |
 | ---------------- | ------------------------ | ----------- | ----- |
@@ -108,6 +111,7 @@ end
 |                  | #min                     | No          | This method already existed but was inherited from `Enumerable`. It was optimized on `Array` so redefining `Enumerable#min` no longer affects this.
 |                  | #pack                    | No          |
 |                  | #sum                     | Yes         |
+| BasicObject      | #__send__                | No          |
 | Binding          | #irb                     | No          |
 | Comparable       | #clamp                   | Yes         |
 | CSV              | #new                     | No          |
@@ -141,6 +145,7 @@ end
 |                  | .readlines               | Yes         |
 | IPAddr           | #==                      | Yes         |
 |                  | #<=>                     | Yes         |
+| Kernel           | #send                    | No          |
 | Logger           | #new                     | No          |
 | MatchData        | #named_captures          | Yes         |
 |                  | #values_at               | Yes         |
@@ -197,6 +202,7 @@ end
 |                  | #match?                  | Yes         |
 |                  | #swapcase                | No          |
 |                  | #swapcase!               | No          |
+|                  | #to_proc                 | No          |
 |                  | #upcase                  | No          |
 |                  | #upcase!                 | No          |
 | Thread           | #report\_on\_exception   | No          |
@@ -204,7 +210,7 @@ end
 | TracePoint       | #callee_id               | No          |
 | Warning          | #warn                    | No          |
 
-### 2.2 to 2.3
+### 2.3
 
 | Object                  | Method                   | Implemented | Notes |
 | ----------------------- | ------------------------ | ----------- | ----- |
@@ -242,7 +248,7 @@ end
 |                         | #close                   | No          |
 |                         | #each_codepoint          | No          |
 |                         | #wait_readable           | No          |
-| Kernel                  | #loop                    | No          |
+| Kernel                  | #loop                    | Yes         |
 | Logger                  | #level=                  | No          |
 |                         | #reopen                  | No          |
 | Module                  | #define_method           | No          |
@@ -279,6 +285,79 @@ end
 | UNIXServer              | #accept_nonblock         | No          |
 | Vector                  | #round                   | No          |
 
+### 2.2
+
+| Object      | Method                                  | Implemented | Notes |
+| ----------  | --------------------------------------- | ----------- | ----- |
+| Binding     | #local_variables                        | No          |
+|             | #receiver                               | No          |
+| Dir         | #fileno                                 | No          |
+| Enumerable  | #max                                    | No          |
+|             | #max_by                                 | No          |
+|             | #min                                    | No          |
+|             | #min_by                                 | No          |
+|             | #slice_after                            | Yes         |
+|             | #slice_when                             | No          |
+| Etc         | .confstr                                | No          |
+|             | .sysconf                                | No          |
+|             | .nprocessors                            | No          |
+|             | .uname                                  | No          |
+| Float       | #next_float                             | No          |
+|             | #prev_float                             | No          |
+| File        | .birthtime                              | No          |
+|             | #birthtime                              | No          |
+|             | .find                                   | No          |
+|             | #find                                   | No          |
+| File::Stat  | #birthtime                              | No          |
+| GC          | .latest_gc_info                         | No          |
+|             | .stat                                   | No          |
+| IO          | #each_codepoint                         | No          |
+|             | #nonblock_read                          | No          |
+|             | #nonblock_write                         | No          |
+|             | #pathconf                               | No          |
+| Kernel      | #itself                                 | Yes         |
+|             | #throw                                  | No          |
+| Math        | .atan2                                  | No          |
+|             | .log                                    | No          |
+| Matrix      | #+@                                     | No          |
+|             | #-@                                     | No          |
+|             | #adjugate                               | No          |
+|             | #cofactor                               | No          |
+|             | #first_minor                            | No          |
+|             | .hstack                                 | No          |
+|             | #hstack                                 | No          |
+|             | #laplace_expansion                      | No          |
+|             | .vstack                                 | No          |
+|             | #vstack                                 | No          |
+| Method      | #curry                                  | No          |
+|             | #super_method                           | No          |
+| ObjectSpace | .memsize_of                             | No          |
+| Pathname    | #/                                      | No          |
+|             | #birthtime                              | No          |
+|             | #find                                   | No          |
+| Prime       | .prime?                                 | No          |
+| Process     | .spawn                                  | No          |
+| String      | #unicode_normalize                      | No          |
+|             | #unicode_normalize!                     | No          |
+|             | #unicode_normalized?                    | No          |
+| Time        | .httpdate                               | No          |
+|             | .parse                                  | No          |
+|             | .rfc2822                                | No          |
+|             | .strptime                               | No          |
+|             | .xmlschema                              | No          |
+| TSort       | .each_strongly_connected_component      | No          |
+|             | .each_strongly_connected_component_from | No          |
+|             | .tsort_each                             | No          |
+| Vector      | #+@                                     | No          |
+|             | #-@                                     | No          |
+|             | #angle_with                             | No          |
+|             | .basis                                  | No          |
+|             | #cross                                  | No          |
+|             | #cross_product                          | No          |
+|             | #dot                                    | No          |
+|             | .independent?                           | No          |
+|             | #independent?                           | No          |
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/AaronLasseigne/polyfill.

data/lib/polyfill.rb

@@ -1,22 +1,23 @@
+require 'ipaddr'
+require 'stringio'
 require 'polyfill/version'
 require 'polyfill/utils'
-require 'polyfill/v2_3'
-require 'polyfill/v2_4'
 
 module Polyfill
-  include V2_3
-  include V2_4
-
   module Parcel; end
 end
 
-def Polyfill(options) # rubocop:disable Style/MethodName
+def Polyfill(options = {}) # rubocop:disable Style/MethodName
   mod = Module.new
 
+  #
+  # parse options
+  #
   objects, others = options.partition { |key,| key[/\A[A-Z]/] }
   others = others.to_h
 
   versions = {
+    '2.2' => Polyfill::V2_2,
     '2.3' => Polyfill::V2_3,
     '2.4' => Polyfill::V2_4
   }
@@ -28,91 +29,171 @@ def Polyfill(options) # rubocop:disable Style/MethodName
     version_number > desired_version
   end
 
+  native = others.delete(:native) { false }
+
   unless others.empty?
     raise ArgumentError, "unknown keyword: #{others.first[0]}"
   end
 
+  #
+  # useful vars
+  #
   current_ruby_version = RUBY_VERSION[/\A(\d+\.\d+)/, 1]
+  all_instance_modules = []
+
+  objects.each do |full_name, methods|
+    #
+    # find all polyfills for the object across all versions
+    #
+    object_module_names = full_name.to_s.split('::')
+
+    object_modules = versions
+      .map do |version_number, version_module|
+        begin
+          final_module = object_module_names
+            .reduce(version_module) do |current_mod, name|
+              current_mod.const_get(name, false)
+            end
 
-  if objects.empty?
-    mod.module_eval do
-      versions.each do |_, object_module|
-        include object_module
+          [version_number, final_module]
+        rescue NameError
+          nil
+        end
       end
-    end
-  else
-    objects.each do |full_name, methods|
-      object_module_names = full_name.to_s.split('::')
-
-      object_modules = versions
-        .map do |version_number, version_module|
-          begin
-            final_module = object_module_names
-              .reduce(version_module) do |current_mod, name|
-                current_mod.const_get(name, false)
-              end
+      .compact
 
-            [version_number, final_module]
-          rescue NameError
-            nil
-          end
-        end
-        .compact
+    if object_modules.empty?
+      raise ArgumentError, %Q("#{full_name}" is not a valid class or has no updates)
+    end
 
-      if object_modules.empty?
-        raise ArgumentError, %Q("#{full_name}" is not a valid class or has no updates)
+    #
+    # get all class modules and instance modules from the polyfills
+    #
+    class_modules = object_modules.map do |version_number, object_module|
+      begin
+        [version_number, object_module.const_get(:ClassMethods, false).clone]
+      rescue NameError
+        nil
       end
+    end.compact
+    instance_modules = object_modules.map do |version_number, object_module|
+      [version_number, object_module.clone]
+    end
 
-      if methods == :all
-        mod.module_eval do
-          object_modules.each do |version_number, object_module|
-            include object_module if version_number > current_ruby_version
-          end
-        end
+    #
+    # get all requested class and instance methods
+    #
+    if methods != :all && (method_name = methods.find { |method| method !~ /\A[.#]/ })
+      raise ArgumentError, %Q("#{method_name}" must start with a "." if it's a class method or "#" if it's an instance method)
+    end
+
+    all_methods_for = lambda do |modules|
+      modules.flat_map { |_, m| m.instance_methods }.uniq
+    end
+    available_class_methods = all_methods_for.call(class_modules)
+    available_instance_methods = all_methods_for.call(instance_modules)
+
+    select_and_clean = lambda do |leader|
+      methods.select { |method| method.start_with?(leader) }.map { |method| method[1..-1].to_sym }
+    end
+    requested_class_methods = methods == :all ? available_class_methods : select_and_clean.call('.')
+    requested_instance_methods = methods == :all ? available_instance_methods : select_and_clean.call('#')
+
+    unless (leftovers = (requested_class_methods - available_class_methods)).empty?
+      raise ArgumentError, %Q(".#{leftovers.first}" is not a valid method on #{full_name} or has no updates)
+    end
+    unless (leftovers = (requested_instance_methods - available_instance_methods)).empty?
+      raise ArgumentError, %Q("##{leftovers.first}" is not a valid method on #{full_name} or has no updates)
+    end
+
+    #
+    # get the class(es) to refine
+    #
+    base_class = object_modules.first.last.name.sub(/\APolyfill::V\d_\d::/, '')
+    base_classes =
+      case base_class
+      when 'Comparable'
+        %w[Numeric String Time]
+      when 'Enumerable'
+        %w[Array Dir Enumerator Hash IO Range StringIO Struct]
+      when 'Kernel'
+        %w[Object]
       else
-        methods.each do |method|
-          type =
-            case method[0]
-            when '.'
-              :Class
-            when '#'
-              :Instance
-            else
-              raise ArgumentError, %Q("#{method}" must start with a "." if it's a class method or "#" if it's an instance method)
-            end
+        [base_class]
+      end
+
+    #
+    # refine in class methods
+    #
+    class_modules.each do |version_number, class_module|
+      next if version_number <= current_ruby_version
 
-          method_name = method[1..-1]
-          symbol_conversions = {
-            '-' => 'minus', # must come first otherwise it creates a range in the regexp
-            '+' => 'plus',
-            '@' => '_unary',
-            '=' => 'equal',
-            '<' => 'lessthan',
-            '>' => 'greaterthan',
-            '?' => '_q',
-            '!' => '_e'
-          }
-          method_name.gsub!(/[#{symbol_conversions.keys.join}]/o, symbol_conversions)
-          method_name.capitalize!
-          method_name.gsub!(/_(.)/) { |match| match[1].capitalize }
-
-          method_modules = object_modules
-            .map do |version_number, object_module|
-              begin
-                [version_number, object_module.const_get(type, false).const_get(method_name, false)]
-              rescue NameError
-                nil
+      class_module.instance_methods.each do |name|
+        class_module.send(:remove_method, name) unless requested_class_methods.include?(name)
+      end
+
+      next if class_module.instance_methods.empty?
+
+      mod.module_exec(requested_class_methods) do |methods_added|
+        base_classes.each do |klass|
+          refine Object.const_get(klass).singleton_class do
+            include class_module
+
+            if native
+              Polyfill::Utils.ignore_warnings do
+                define_method :respond_to? do |name, include_all = false|
+                  return true if methods_added.include?(name)
+
+                  super(name, include_all)
+                end
+
+                define_method :__send__ do |name, *args, &block|
+                  return super(name, *args, &block) unless methods_added.include?(name)
+
+                  class_module.instance_method(name).bind(self).call(*args, &block)
+                end
+                alias_method :send, :__send__
               end
             end
-            .compact
-
-          if method_modules.empty?
-            raise ArgumentError, %Q("#{method}" is not a valid method on #{full_name} or has no updates)
           end
+        end
+      end
+    end
+
+    #
+    # refine in instance methods
+    #
+    instance_modules.each do |version_number, instance_module|
+      next if version_number <= current_ruby_version
+
+      instance_module.instance_methods.each do |name|
+        instance_module.send(:remove_method, name) unless requested_instance_methods.include?(name)
+      end
 
-          mod.module_eval do
-            method_modules.each do |version_number, method_module|
-              include method_module if version_number > current_ruby_version
+      next if instance_module.instance_methods.empty?
+
+      all_instance_modules << instance_module
+
+      mod.module_exec(requested_instance_methods) do |methods_added|
+        base_classes.each do |klass|
+          refine Object.const_get(klass) do
+            include instance_module
+
+            if native
+              Polyfill::Utils.ignore_warnings do
+                define_method :respond_to? do |name, include_all = false|
+                  return super(name, include_all) unless methods_added.include?(name)
+
+                  true
+                end
+
+                define_method :__send__ do |name, *args, &block|
+                  return super(name, *args, &block) unless methods_added.include?(name)
+
+                  instance_module.instance_method(name).bind(self).call(*args, &block)
+                end
+                alias_method :send, :__send__
+              end
             end
           end
         end
@@ -120,5 +201,18 @@ def Polyfill(options) # rubocop:disable Style/MethodName
     end
   end
 
+  #
+  # make sure the includes get added if this module is included
+  #
+  mod.singleton_class.send(:define_method, :included) do |base|
+    all_instance_modules.each do |instance_module|
+      base.include instance_module
+    end
+  end
+
   Polyfill::Parcel.const_set("O#{mod.object_id}", mod)
 end
+
+require 'polyfill/v2_2'
+require 'polyfill/v2_3'
+require 'polyfill/v2_4'