polyfill 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8ffdd9cc5cb6a688ba0bcedc79a627c63f1916f
-  data.tar.gz: 3028c8eed9c64fd43d65d049c4aadeb7843aac48
+  metadata.gz: a78a97eb49d10c541939893c1df67dc431f56570
+  data.tar.gz: b56aa89aaafa5cf0ae1238c7a5d6a7b1be9277d8
 SHA512:
-  metadata.gz: 8fc2cf9a4bc8f49268c396d7a7caf911941f8a4c9b05ecf4c84f93bb60e99c2fb6e1becf7d824fa34a89534f653a66586f6bfd826b788bd0cf387c5f24711bec
-  data.tar.gz: '082b8f86fe28e66a3aedd6bcd809c09720ed37bf5745fbc7d1b9f1a23de7ac9fd5cb6808ff5f6da4dcea57b909866da0dbefc4c06c2ecf2376fa4d090187280d'
+  metadata.gz: ca64b371d0e8287f87f67be903b9b48be65f318ad6ae991d4789114addc5500d785638efc65d3bfd464b5769cc80a07be033cdef17770752a1da55c1a984d2b8
+  data.tar.gz: bdfce84cb85bb20c013584b259c0612468a103985007824a38b2f635fa4adc86a0f4182ea5aaa362d873eaef0f789a02cb38a4f47df3810d6f792b75ddedf081

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 2.3
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+Style/ClassAndModuleCamelCase:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%W': '[]'
+    '%i': '[]'
+    '%w': '[]'

data/CHANGELOG.md

@@ -1,4 +1,32 @@
-# [0.3.0][]
+# [0.4.0][] (2017-03-24)
+
+## Added
+
+ - v2.4 Array#sum
+ - v2.4 Enumerable#chunk
+ - v2.4 Enumerable#sum
+ - v2.4 Enumerable#uniq
+ - v2.4 Enumerator::Lazy#chunk_while
+ - v2.4 Enumerator::Lazy#uniq
+ - v2.4 IO#lines
+ - v2.4 IPAddr#==
+ - v2.4 IPAddr#<=>
+ - v2.4 Numeric#clone
+ - v2.4 Numeric#dup
+ - v2.4 Object#clone
+ - v2.4 Pathname#empty?
+ - v2.4 Regexp#match?
+ - v2.4 String#casecmp?
+ - v2.4 String#each_line
+ - v2.4 String#lines
+ - v2.4 String#match?
+ - v2.4 String.new
+ - v2.4 String#unpack1
+ - v2.4 Symbol#casecmp?
+ - v2.4 Symbol#match
+ - v2.4 Symbol#match?
+
+# [0.3.0][] (2017-03-19)
 
 ## Added
 
@@ -19,7 +47,7 @@
 
  - New way to select methods that doesn't rely on knowing the module structure
 
-# [0.2.0][] (2017-03-16)
+# [0.2.0][] (2017-03-17)
 
 ## Added
 
@@ -54,6 +82,7 @@
  - v2.4 String#concat?
  - v2.4 String#prepend?
 
+[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
 [0.1.0]: https://github.com/AaronLasseigne/polyfill/compare/v0.0.0...v0.1.0

data/CONTRIBUTING.md

@@ -1,33 +1,54 @@
 ## Contributing
 
+There are many ways to contribute. You can [file a bug], improve the
+[documentation], or submit [new code](#code). Finding all the changes
+for any given Ruby version can be difficult. If something is missing
+please add it to the documentation.
+
+### Code
+
+These are the steps that you'll need to follow for submitting code:
+
 1. [Fork](#fork)
 2. [Tests](#tests)
-3. [Code](#code)
+3. [Lib](#lib)
 4. [Push and Submit](#push-and-submit)
 5. [Refine Until Merged](#refine-until-merged)
 
-### Fork
+#### Fork
 
-[Fork](https://github.com/AaronLasseigne/polyfill/fork) the repo.
+[Fork] the repo.
 
-### Tests
+#### Tests
 
-The goal is to produce code that is identical to the real method. One
-of the best places to find examples is the
-[Ruby Spec Suite](https://github.com/ruby/spec). If tests exist there,
-please copy them out and change them from MSpec to RSpec. Newer
-methods may not be available in which case you'll have to add your
-own tests. If the feature is new then you'll need to test every aspect
-of it.
+The goal is to produce code that is identical to the real method. To
+ensure that nothing breaks and the new code is good we need tests! One
+of the best places to find examples is the [Ruby Spec Suite]. If the
+have tests for the new functionality then make sure those same cases
+are covered.
 
 If this is a change that adds to an existing feature make sure to have
 a basic test of the old functionality and then test all of the new
-functionality.
+functionality. These tests are typically grouped into two contexts.
 
-Looking over an existing test or two should give you an idea of what
-to do.
+```ruby
+RSpec.describe 'Obj#method' do
+  context 'existing behavior' do
+    # smoke test or two here
+  end
+  
+  context '2.4' do
+    # changes added in 2.4
+  end
+end
+```
 
-### Code
+Also make sure that your code passes rubocop. You can run
+`bundle exec rake` to execute the tests and run rubocop. If there's
+a good reason to violate rubocop (e.g. an optimization) then please
+bring it up and we'll figure it out.
+
+#### Lib
 
 The directory structure follows the module structure. Files are added
 (`require` and `include`) one directly level up from their location.
@@ -38,6 +59,11 @@ The structure is formulaic so looking through an existing example
 or two should clarify what to do. If you're not sure how to proceed,
 please reach out and we'll figure it out.
 
+Reusing the names of core classes means that in your methods you'll
+need to make sure you reference the top level class by preceding it
+with `::` (e.g. `::File`). This can be a frustrating mistake so be
+mindful.
+
 Partial implementations of features are welcome as long as they
 bring value. Generally it's only ok to leave out part of the feature
 when that part is very hard and/or secondary to the primary 
@@ -46,14 +72,19 @@ accepted may seem a bit arbitrary. If you're unsure, please reach out
 and we'll discuss. I'd hate to see a bunch of work done only to get
 rejected.
 
-### Push and Submit
+#### Push and Submit
 
 Push your branch up to your fork. Submit a pull request via
 GitHub.
 
-### Refine Until Merged
+#### Refine Until Merged
 
 There are weird edge cases and particulars that might need to be
 changed. Don't worry if you get a lot of comments on your pull
 request. That's why we have code reviews. People miss things and more
 eyes catch more issues. After everything is fixed: VICTORY!
+
+[file a bug]: https://github.com/AaronLasseigne/polyfill/issues/new
+[documentation]: README.md
+[Fork]: https://github.com/AaronLasseigne/polyfill/fork
+[Ruby Spec Suite]: https://github.com/ruby/spec

data/README.md

@@ -32,7 +32,7 @@ See the [implementation table](#implementation-table) for specifics about what h
 Add it to your Gemfile:
 
 ```ruby
-gem 'polyfill', '0.3.0'
+gem 'polyfill', '0.4.0'
 ```
 
 Or install it manually:
@@ -69,6 +69,12 @@ using Polyfill(
 )
 ```
 
+If you want all of the methods for a particular class you can use `:all`.
+
+```ruby
+using Polyfill(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
@@ -86,84 +92,108 @@ end
 
 ### 2.3 to 2.4
 
-| Object           | Method                 | Implemented | Notes |
-| ---------------- | ---------------------- | ----------- | ----- |
-| Array            | #concat                | Yes         |
-|                  | #max                   | No          |
-|                  | #min                   | No          |
-|                  | #pack                  | No          |
-|                  | #sum                   | No          |
-| Comparable       | #clamp                 | Yes         |
-| Dir              | .empty?                | Yes         |
-| Enumerable       | #chunk                 | No          |
-|                  | #sum                   | No          |
-|                  | #uniq                  | No          |
-| Enumerator::Lazy | #chunk_while           | No          |
-|                  | #uniq                  | No          |
-| File             | .empty?                | Yes         |
-| Float            | #ceil                  | Yes         |
-|                  | #floor                 | Yes         |
-|                  | #round                 | No          |
-|                  | #truncate              | Yes         |
-| Hash             | #compact               | Yes         |
-|                  | #compact!              | Yes         |
-|                  | #transform_values      | Yes         |
-|                  | #transform_values!     | Yes         |
-| Integer          | #ceil                  | Yes         |
-|                  | #digits                | Yes         |
-|                  | #floor                 | Yes         |
-|                  | #round                 | Yes         |
-|                  | #truncate              | Yes         |
-| IO               | #each_line             | Yes         |
-|                  | .foreach               | Yes         |
-|                  | #gets                  | Yes         |
-|                  | #readline              | Yes         |
-|                  | #readlines             | Yes         |
-|                  | .readlines             | Yes         |
-| Kernel           | #clone                 | No          |
-| MatchData        | #named_captures        | Yes         |
-|                  | #values_at             | Yes         |
-| Module           | #refine                | No          |
-|                  | .used_modules          | No          |
-| Numeric          | #finite?               | Yes         |
-|                  | #infinite?             | Yes         |
-| Rational         | #round                 | No          |
-| Regexp           | #match?                | No          |
-| String           | #capitalize            | No          |
-|                  | #capitalize!           | No          |
-|                  | #casecmp?              | No          |
-|                  | #concat                | Yes         |
-|                  | #downcase              | No          |
-|                  | #downcase!             | No          |
-|                  | #each_line             | No          |
-|                  | #lines                 | No          |
-|                  | #match?                | No          |
-|                  | .new                   | No          |
-|                  | #prepend               | Yes         |
-|                  | #swapcase              | No          |
-|                  | #swapcase!             | No          |
-|                  | #unpack1               | No          |
-|                  | #upcase                | No          |
-|                  | #upcase!               | No          |
-| StringIO         | #each_line             | Yes         |
-|                  | #gets                  | Yes         |
-|                  | #readline              | Yes         |
-|                  | #readlines             | Yes         |
-| Symbol           | #capitalize            | No          |
-|                  | #capitalize!           | No          |
-|                  | #casecmp?              | No          |
-|                  | #downcase              | No          |
-|                  | #downcase!             | No          |
-|                  | #match                 | No          |
-|                  | #match?                | No          |
-|                  | #swapcase              | No          |
-|                  | #swapcase!             | No          |
-|                  | #upcase                | No          |
-|                  | #upcase!               | No          |
-| Thread           | #report\_on\_exception | No          |
-|                  | .report\_on\_exception | No          |
-| TracePoint       | #callee_id             | No          |
-| Warning          | #warn                  | No          |
+| Object           | Method                   | Implemented | Notes |
+| ---------------- | ------------------------ | ----------- | ----- |
+| Array            | #concat                  | Yes         |
+|                  | #max                     | No          | This method already existed but was inherited from `Enumerable`. It was optimized on `Array` so redefining `Enumerable#max` no longer affects this.
+|                  | #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         |
+| Binding          | #irb                     | No          |
+| Comparable       | #clamp                   | Yes         |
+| CSV              | #new                     | No          |
+| Dir              | .empty?                  | Yes         |
+| Enumerable       | #chunk                   | Yes         |
+|                  | #sum                     | Yes         |
+|                  | #uniq                    | Yes         |
+| Enumerator::Lazy | #chunk_while             | Yes         |
+|                  | #uniq                    | Yes         |
+| File             | .empty?                  | Yes         |
+| FileTest         | .empty?                  | No          |
+| Float            | #ceil                    | Yes         |
+|                  | #floor                   | Yes         |
+|                  | #round                   | No          |
+|                  | #truncate                | Yes         |
+| Hash             | #compact                 | Yes         |
+|                  | #compact!                | Yes         |
+|                  | #transform_values        | Yes         |
+|                  | #transform_values!       | Yes         |
+| Integer          | #ceil                    | Yes         |
+|                  | #digits                  | Yes         |
+|                  | #floor                   | Yes         |
+|                  | #round                   | Yes         |
+|                  | #truncate                | Yes         |
+| IO               | #each_line               | Yes         |
+|                  | .foreach                 | Yes         |
+|                  | #gets                    | Yes         |
+|                  | #lines                   | Yes         |
+|                  | #readline                | Yes         |
+|                  | #readlines               | Yes         |
+|                  | .readlines               | Yes         |
+| IPAddr           | #==                      | Yes         |
+|                  | #<=>                     | Yes         |
+| Logger           | #new                     | No          |
+| MatchData        | #named_captures          | Yes         |
+|                  | #values_at               | Yes         |
+| Module           | #refine                  | No          |
+|                  | .used_modules            | No          |
+| Net::HTTP        | #post                    | No          |
+| Net::FTP         | #new                     | No          |
+|                  | #status                  | No          |
+| Numeric          | #clone                   | Yes         |
+|                  | #dup                     | Yes         |
+|                  | #finite?                 | Yes         |
+|                  | #infinite?               | Yes         |
+| Object           | #clone                   | Yes         |
+| OptionParser     | #order                   | No          |
+|                  | #order!                  | No          |
+|                  | #parse                   | No          |
+|                  | #parse!                  | No          |
+|                  | #permute                 | No          |
+|                  | #permute!                | No          |
+| Pathname         | #empty?                  | Yes         |
+| Readline         | #quoting_detection_proc  | No          |
+|                  | #quoting_detection_proc= | No          |
+| REXML::Element   | #[]                      | No          |
+| Rational         | #round                   | No          |
+| Regexp           | #match?                  | Yes         |
+| Set              | #compare_by_identity     | No          |
+|                  | #compare_by_identity?    | No          |
+| String           | #capitalize              | No          |
+|                  | #capitalize!             | No          |
+|                  | #casecmp?                | Partial     | Does not support Unicode characters.
+|                  | #concat                  | Yes         |
+|                  | #downcase                | No          |
+|                  | #downcase!               | No          |
+|                  | #each_line               | Yes         |
+|                  | #lines                   | Yes         |
+|                  | #match?                  | Yes         |
+|                  | .new                     | Partial     | Allows `:capacity` option to pass but does nothing.
+|                  | #prepend                 | Yes         |
+|                  | #swapcase                | No          |
+|                  | #swapcase!               | No          |
+|                  | #unpack1                 | Yes         |
+|                  | #upcase                  | No          |
+|                  | #upcase!                 | No          |
+| StringIO         | #each_line               | Yes         |
+|                  | #gets                    | Yes         |
+|                  | #readline                | Yes         |
+|                  | #readlines               | Yes         |
+| Symbol           | #capitalize              | No          |
+|                  | #capitalize!             | No          |
+|                  | #casecmp?                | Partial     | Does not support Unicode characters.
+|                  | #downcase                | No          |
+|                  | #downcase!               | No          |
+|                  | #match                   | Yes         |
+|                  | #match?                  | Yes         |
+|                  | #swapcase                | No          |
+|                  | #swapcase!               | No          |
+|                  | #upcase                  | No          |
+|                  | #upcase!                 | No          |
+| Thread           | #report\_on\_exception   | No          |
+|                  | .report\_on\_exception   | No          |
+| TracePoint       | #callee_id               | No          |
+| Warning          | #warn                    | No          |
 
 ## Contributing
 
@@ -172,4 +202,4 @@ Please read the [contributing file](CONTRIBUTING.md) prior to pull requests.
 
 ## Credits
 
-Polyfill is licensed under the [MIT License](LICENSE.md).
+Polyfill is licensed under the [MIT License](LICENSE.txt).

data/Rakefile

@@ -1,6 +1,8 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: %i[spec rubocop]

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "polyfill"
+require 'bundler/setup'
+require 'polyfill'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "polyfill"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/polyfill.rb

@@ -5,7 +5,7 @@ module Polyfill
   include V2_4
 end
 
-def Polyfill(options)
+def Polyfill(options) # rubocop:disable Style/MethodName
   mod = Module.new
 
   klasses, others = options.partition { |key,| key[/\A[A-Z]/] }
@@ -14,15 +14,23 @@ def Polyfill(options)
     raise ArgumentError, "unknown keyword: #{others.first[0]}"
   end
 
-  klasses.each do |name, methods|
-    class_or_module_mod =
-      begin
-        Polyfill::V2_4.const_get(name, false)
-      rescue NameError
-        raise ArgumentError, %Q("#{name}" is not a valid class or has no updates)
+  needs_update = RUBY_VERSION[/\A(\d+\.\d+)/, 1] < '2.4'
+
+  klasses.each do |names, methods|
+    class_or_module_mod = names
+      .to_s
+      .split('::')
+      .reduce(Polyfill::V2_4) do |current_mod, name|
+        begin
+          current_mod.const_get(name, false)
+        rescue NameError
+          raise ArgumentError, %Q("#{names}" is not a valid class or has no updates)
+        end
       end
 
     if methods == :all
+      next unless needs_update
+
       mod.module_eval do
         include class_or_module_mod
       end
@@ -37,17 +45,18 @@ def Polyfill(options)
           else
             raise ArgumentError, %Q("#{method}" must start with a "." if it's a class method or "#" if it's an instance method)
           end
-        method_name =
-          case method[-1]
-          when '?'
-            "#{method[1..-2]}_q"
-          when '!'
-            "#{method[1..-2]}_e"
-          else
-            method[1..-1]
-          end
+
+        method_name = method[1..-1]
+        symbol_conversions = {
+          '=' => 'equal',
+          '<' => 'lessthan',
+          '>' => 'greaterthan',
+          '?' => '_q',
+          '!' => '_e'
+        }
+        method_name.gsub!(/[#{symbol_conversions.keys.join}]/o, symbol_conversions)
         method_name.capitalize!
-        method_name.gsub!(/_(.)/) { $1.capitalize }
+        method_name.gsub!(/_(.)/) { |match| match[1].capitalize }
 
         method_mod =
           begin
@@ -55,11 +64,13 @@ def Polyfill(options)
               .const_get(type, false)
               .const_get(method_name, false)
           rescue NameError
-            raise ArgumentError, %Q("#{method}" is not a valid method on #{name} or has no updates)
+            raise ArgumentError, %Q("#{method}" is not a valid method on #{names} or has no updates)
           end
 
+        next unless needs_update
+
         mod.module_eval do
-          include class_or_module_mod.const_get(type, false).const_get(method_name, false)
+          include method_mod
         end
       end
     end