polyfill 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d536c32a25db0ccb7bbbe70e7e921c35a97d95f
-  data.tar.gz: e8b0d4bf4c7ece75a844065d2407ce761e093564
+  metadata.gz: c8ffdd9cc5cb6a688ba0bcedc79a627c63f1916f
+  data.tar.gz: 3028c8eed9c64fd43d65d049c4aadeb7843aac48
 SHA512:
-  metadata.gz: 4eb22154fb993d183068e2f8a7345b05a298b040d6911c2c4dbf71fbe5c524b505a2074067012d8d87b8afb90e83c50673a59b094a4c437058509c49fc98dca6
-  data.tar.gz: f2bacc5168680b5fa4a3b4a4c29d7e83cc8467d45fc4e78b9f551161ea0f898f72c8aa8a6e97f0e2951cf3516a6cf5dbafe5105bdea638c4fec2a71981171ad3
+  metadata.gz: 8fc2cf9a4bc8f49268c396d7a7caf911941f8a4c9b05ecf4c84f93bb60e99c2fb6e1becf7d824fa34a89534f653a66586f6bfd826b788bd0cf387c5f24711bec
+  data.tar.gz: '082b8f86fe28e66a3aedd6bcd809c09720ed37bf5745fbc7d1b9f1a23de7ac9fd5cb6808ff5f6da4dcea57b909866da0dbefc4c06c2ecf2376fa4d090187280d'

data/CHANGELOG.md

@@ -1,4 +1,25 @@
-# [0.2.0][]
+# [0.3.0][]
+
+## Added
+
+ - v2.4 Dir.empty?
+ - v2.4 File.empty?
+ - v2.4 IO#each_line
+ - v2.4 IO.foreach
+ - v2.4 IO#gets
+ - v2.4 IO#readline
+ - v2.4 IO#readlines
+ - v2.4 IO.readlines
+ - v2.4 StringIO#each_line
+ - v2.4 StringIO#gets
+ - v2.4 StringIO#readline
+ - v2.4 StringIO#readlines
+
+## Changes
+
+ - New way to select methods that doesn't rely on knowing the module structure
+
+# [0.2.0][] (2017-03-16)
 
 ## Added
 
@@ -33,5 +54,6 @@
  - v2.4 String#concat?
  - v2.4 String#prepend?
 
+[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/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.2.0'
+gem 'polyfill', '0.3.0'
 ```
 
 Or install it manually:
@@ -57,46 +57,31 @@ To use all updates:
 using Polyfill
 ```
 
-To use all updates up to V2_4:
+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 ".".
 
 ```ruby
-using Polyfill::V2_4
+using Polyfill(
+  Array: %w[#concat],
+  Dir: %w[.empty?],
+  Hash: %w[#compact! #transform_values],
+)
 ```
 
-To use all updates for a particular object, add it to the end:
+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.
 
 ```ruby
-using Polyfill::V2_4::Array
-using Polyfill::V2_4::String
+class Foo
+  include Comparable
+  include Polyfill(Comparable: %w[#clamp])
+end
 ```
 
-To use a particular method, we can add it after the object. The method is
-converted to camel case. Predicate methods (ending with a question mark)
-have their question converted to a `Q`. Dangerous methods (ending with an
-exclamation mark) have their exclamation replaced with `E`.
-
-```ruby
-using Polyfill::V2_4::Array::Concat
-using Polyfill::V2_4::Dir::EmptyQ # :empty?
-using Polyfill::V2_4::Hash::CompactE # :compact!
-using Polyfill::V2_4::Hash::TransformValues # :transform_values!
-```
-
-Any method can be accessed as a stand-alone module by adding `Method` to
-the end:
-
-```ruby
-include Polyfill::V2_4::Comparable::Clamp::Method
-```
-
-**A note about modules:** Prior to 2.4, refinements do not work on modules.
-This means modules like `Comparable` will apply the refinement to all child
-classes. Anything custom classes that inherit from `Comparable` will be
-unaffected by the refinement. In cases like this you can use `include` as
-demonstrated above to pull in the needed method. Just like always, the
-method is only defined if the Ruby version requires it.
-
-
 ## Implementation Table
 
 ### 2.3 to 2.4
@@ -109,13 +94,13 @@ method is only defined if the Ruby version requires it.
 |                  | #pack                  | No          |
 |                  | #sum                   | No          |
 | Comparable       | #clamp                 | Yes         |
-| Dir              | #empty?                | No          |
+| Dir              | .empty?                | Yes         |
 | Enumerable       | #chunk                 | No          |
 |                  | #sum                   | No          |
 |                  | #uniq                  | No          |
 | Enumerator::Lazy | #chunk_while           | No          |
 |                  | #uniq                  | No          |
-| File             | #empty?                | No          |
+| File             | .empty?                | Yes         |
 | Float            | #ceil                  | Yes         |
 |                  | #floor                 | Yes         |
 |                  | #round                 | No          |
@@ -129,11 +114,12 @@ method is only defined if the Ruby version requires it.
 |                  | #floor                 | Yes         |
 |                  | #round                 | Yes         |
 |                  | #truncate              | Yes         |
-| IO               | #each_line             | No          |
-|                  | .foreach               | No          |
-|                  | #gets                  | No          |
-|                  | #readline              | No          |
-|                  | #readlines             | No          |
+| IO               | #each_line             | Yes         |
+|                  | .foreach               | Yes         |
+|                  | #gets                  | Yes         |
+|                  | #readline              | Yes         |
+|                  | #readlines             | Yes         |
+|                  | .readlines             | Yes         |
 | Kernel           | #clone                 | No          |
 | MatchData        | #named_captures        | Yes         |
 |                  | #values_at             | Yes         |
@@ -159,10 +145,10 @@ method is only defined if the Ruby version requires it.
 |                  | #unpack1               | No          |
 |                  | #upcase                | No          |
 |                  | #upcase!               | No          |
-| StringIO         | #each_line             | No          |
-|                  | #gets                  | No          |
-|                  | #readline              | No          |
-|                  | #readlines             | No          |
+| StringIO         | #each_line             | Yes         |
+|                  | #gets                  | Yes         |
+|                  | #readline              | Yes         |
+|                  | #readlines             | Yes         |
 | Symbol           | #capitalize            | No          |
 |                  | #capitalize!           | No          |
 |                  | #casecmp?              | No          |

data/lib/polyfill.rb

@@ -4,3 +4,66 @@ require 'polyfill/v2_4'
 module Polyfill
   include V2_4
 end
+
+def Polyfill(options)
+  mod = Module.new
+
+  klasses, others = options.partition { |key,| key[/\A[A-Z]/] }
+
+  unless others.empty?
+    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)
+      end
+
+    if methods == :all
+      mod.module_eval do
+        include class_or_module_mod
+      end
+    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
+        method_name =
+          case method[-1]
+          when '?'
+            "#{method[1..-2]}_q"
+          when '!'
+            "#{method[1..-2]}_e"
+          else
+            method[1..-1]
+          end
+        method_name.capitalize!
+        method_name.gsub!(/_(.)/) { $1.capitalize }
+
+        method_mod =
+          begin
+            class_or_module_mod
+              .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)
+          end
+
+        mod.module_eval do
+          include class_or_module_mod.const_get(type, false).const_get(method_name, false)
+        end
+      end
+    end
+  end
+
+  mod
+end

data/lib/polyfill/v2_4.rb

@@ -1,21 +1,29 @@
 require 'polyfill/v2_4/array'
 require 'polyfill/v2_4/comparable'
+require 'polyfill/v2_4/dir'
+require 'polyfill/v2_4/file'
 require 'polyfill/v2_4/float'
 require 'polyfill/v2_4/hash'
 require 'polyfill/v2_4/integer'
+require 'polyfill/v2_4/io'
 require 'polyfill/v2_4/match_data'
 require 'polyfill/v2_4/numeric'
 require 'polyfill/v2_4/string'
+require 'polyfill/v2_4/string_io'
 
 module Polyfill
   module V2_4
     include Array
     include Comparable
+    include Dir
+    include File
     include Float
     include Hash
     include Integer
+    include IO
     include MatchData
     include Numeric
     include String
+    include StringIO
   end
 end

data/lib/polyfill/v2_4/array.rb

@@ -1,9 +1,9 @@
-require 'polyfill/v2_4/array/concat'
+require 'polyfill/v2_4/array/instance'
 
 module Polyfill
   module V2_4
     module Array
-      include Concat
+      include Instance
     end
   end
 end

data/lib/polyfill/v2_4/array/instance.rb

@@ -0,0 +1,11 @@
+require 'polyfill/v2_4/array/instance/concat'
+
+module Polyfill
+  module V2_4
+    module Array
+      module Instance
+        include Concat
+      end
+    end
+  end
+end

data/lib/polyfill/v2_4/array/instance/concat.rb

@@ -0,0 +1,32 @@
+module Polyfill
+  module V2_4
+    module Array
+      module Instance
+        module Concat
+          module Method
+            def concat(*others)
+              return super if others.length == 1
+
+              acc = [].concat(self)
+              others.each do |other|
+                acc.concat(other)
+              end
+
+              replace(acc)
+            end
+          end
+
+          if RUBY_VERSION < '2.4.0'
+            refine ::Array do
+              include Method
+            end
+
+            def self.included(base)
+              base.include Method
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/polyfill/v2_4/comparable.rb

@@ -1,9 +1,9 @@
-require 'polyfill/v2_4/comparable/clamp'
+require 'polyfill/v2_4/comparable/instance'
 
 module Polyfill
   module V2_4
     module Comparable
-      include Clamp
+      include Instance
     end
   end
 end

data/lib/polyfill/v2_4/comparable/instance.rb

@@ -0,0 +1,11 @@
+require 'polyfill/v2_4/comparable/instance/clamp'
+
+module Polyfill
+  module V2_4
+    module Comparable
+      module Instance
+        include Clamp
+      end
+    end
+  end
+end

data/lib/polyfill/v2_4/comparable/instance/clamp.rb

@@ -0,0 +1,37 @@
+module Polyfill
+  module V2_4
+    module Comparable
+      module Instance
+        module Clamp
+          module Method
+            def clamp(min, max)
+              if min > max
+                raise ArgumentError, 'min argument must be smaller than max argument'
+              end
+
+              return min if min > self
+              return max if max < self
+              self
+            end
+          end
+
+          if RUBY_VERSION < '2.4.0'
+            refine ::Numeric do
+              include Method
+            end
+            refine ::String do
+              include Method
+            end
+            refine ::Time do
+              include Method
+            end
+
+            def self.included(base)
+              base.include Method
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/polyfill/v2_4/dir.rb

@@ -0,0 +1,9 @@
+require 'polyfill/v2_4/dir/class'
+
+module Polyfill
+  module V2_4
+    module Dir
+      include Class
+    end
+  end
+end

data/lib/polyfill/v2_4/dir/class.rb

@@ -0,0 +1,11 @@
+require 'polyfill/v2_4/dir/class/empty_q'
+
+module Polyfill
+  module V2_4
+    module Dir
+      module Class
+        include EmptyQ
+      end
+    end
+  end
+end

data/lib/polyfill/v2_4/dir/class/empty_q.rb

@@ -0,0 +1,25 @@
+module Polyfill
+  module V2_4
+    module Dir
+      module Class
+        module EmptyQ
+          module Method
+            def empty?(path_name)
+              exist?(path_name) && (entries(path_name) - ['.', '..']).empty?
+            end
+          end
+
+          if RUBY_VERSION < '2.4.0'
+            refine ::Dir.singleton_class do
+              include Method
+            end
+
+            def self.included(base)
+              base.include Method
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/polyfill/v2_4/file.rb

@@ -0,0 +1,9 @@
+require 'polyfill/v2_4/file/class'
+
+module Polyfill
+  module V2_4
+    module File
+      include Class
+    end
+  end
+end