refinements 3.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fac72c34bfb6a876d35c12e6286f649c09754678
-  data.tar.gz: 30cf5ec268f368c13befd78f0f389ab20c428694
+  metadata.gz: 19bcdd156b3b6053dd3ff8a312502d807b6dacfd
+  data.tar.gz: 91b591f5acfd7ae55b174dd48183effdf09fb10f
 SHA512:
-  metadata.gz: 73587dc8896e3c799fb9a81fa1e0b748ef63865d740afe26e9446b3feb41a7428e2bedaae0068bd0233fc1e539daee201daa89f83dc0cfd2af5baf7254b772c6
-  data.tar.gz: dd4845ac56ea495cf387dd3459b022e732bce845e63d4cd7d7fff9bb1c25023aa3d512eab5eba02d5eec0e5a54263553b4dfe45c3e038f10d653f68efcdd79c2
+  metadata.gz: 5af7222803acf6bebb65b266d8a33b76eebd3712181a4f9b321464d28290a6d51e4611eb3248a33e18c3c5402488ec8a8fd91ec982b43ecf8072966bd846b875
+  data.tar.gz: ff2fb700725382ef9dd508d9e72df9a7ba5675730c916bb4b6865799b1e4b5da9a484d299a7196337fbf085f5ef32ea9ebe46f7a81be1035edbfda2b59a741c4

data/README.md

@@ -42,8 +42,8 @@ Provides a collection of refinements to core Ruby objects.
 - Provides BigDecimal refinements:
   - `BigDecimal#inspect` - Allows one to inspect a big decimal with numeric representation.
 - Provides Hash refinements:
-  - `#compact` - Removes key/value pairs with `nil` values without modifying itself.
-  - `#compact!` - Removes key/value pairs with `nil` values while modifying itself.
+  - `except` - Answers new hash with given with given keys removed without modifying calling hash.
+  - `except!` - Answers new hash with given with given keys removed while modifying calling hash.
   - `#symbolize_keys` - Converts keys to symbols without modifying itself.
   - `#symbolize_keys!` - Converts keys to symbols while modifying itself.
   - `#slice` - Selects hash subset for given keys without modifying itself.
@@ -53,6 +53,8 @@ Provides a collection of refinements to core Ruby objects.
   - `#reverse_merge` - Merges calling hash into passed in hash without modifying calling hash.
   - `#reverse_merge!` - Merges calling hash into passed in hash while modifying calling hash.
 - Provides String refinements:
+  - `#first` - Answers first character of a string or first set of characters if given a number.
+  - `#last` - Answers last character of a string or last set of characters if given a number.
   - `#blank?` - Answers `true`/`false` based on whether string is blank or not (i.e. `<space>`,
     `\n`, `\t`, `\r`).
   - `#up` - Answers string with only first letter upcased.
@@ -60,10 +62,12 @@ Provides a collection of refinements to core Ruby objects.
   - `#camelcase` - Answers a camelcased string. Example: "ThisIsCamelcase".
   - `#snakecase` - Answers a snakecased string. Example: "this_is_snakecase".
   - `#titleize` - Answers titleized string. Example: "This Is Titleized".
+  - `#use` - Provides hash value computation, via a block, by using
+    only the keys as arguments to the block.
 
 # Requirements
 
-0. [Ruby 2.3.x](https://www.ruby-lang.org).
+0. [Ruby 2.4.x](https://www.ruby-lang.org).
 0. A solid understanding of [Ruby refinements and lexical scope](https://www.youtube.com/watch?v=qXC9Gk4dCEw).
 
 # Setup
@@ -117,6 +121,12 @@ The following sections demonstrate how each refinement enriches your objects wit
 
 ### String
 
+    "example".first # => "e"
+    "example".first 4 # => "exam"
+
+    "instant".last # => "t"
+    "instant".first 3 # => "ant"
+
     " \n\t\r".blank? # => true
     "example".up # => "Example"
     "EXAMPLE".down # => "eXAMPLE"
@@ -141,13 +151,13 @@ The following sections demonstrate how each refinement enriches your objects wit
 
 ### Hash
 
-    example = {a: 1, b: nil}
-    example.compact # => {a: 1}
-    example # => {a: 1, b: nil}
+    example = {a: 1, b: 2, c: 3}
+    example.except :a, :b # => {c: 3}
+    example # => {a: 1, b: 2, c: 3}
 
-    example = {a: 1, b: nil}
-    example.compact! # => {a: 1}
-    example # => {a: 1}
+    example = {a: 1, b: 2, c: 3}
+    example.except! :a, :b # => {c: 3}
+    example # => {c: 3}
 
     example = {"a" => 1, "b" => 2}
     example.symbolize_keys # => {a: 1, b: 2}
@@ -181,6 +191,9 @@ The following sections demonstrate how each refinement enriches your objects wit
     example.reverse_merge! a: 0, c: 3 # => {a: 1, b: 2, c: 3}
     example # => {a: 1, b: 2, c: 3}
 
+    example = {unit: "221B", street: "Baker Street", city: "London", country: "UK"}
+    example.use { |unit, street| "#{unit} #{street}" } # => "221B Baker Street"
+
 # Tests
 
 To test, run:

data/lib/refinements/hashes.rb

@@ -5,16 +5,12 @@ module Refinements
   module Hashes
     # rubocop:disable Metrics/BlockLength
     refine Hash do
-      # TODO: Remove when Ruby 2.4 is released.
-      def compact
-        puts "[DEPRECATION]: #compact is deprecated and is included, by default, in Ruby 2.4."
-        dup.compact!
+      def except *keys
+        reject { |key, _value| keys.include? key }
       end
 
-      # TODO: Remove when Ruby 2.4 is released.
-      def compact!
-        puts "[DEPRECATION]: #compact! is deprecated and is included, by default, in Ruby 2.4."
-        reject! { |_, value| value.nil? }
+      def except! *keys
+        replace except(*keys)
       end
 
       def symbolize_keys
@@ -27,39 +23,44 @@ module Refinements
       end
 
       def slice *keys
-        keys.each.with_object({}) do |key, sliced_hash|
-          sliced_hash[key] = self[key] if key?(key)
-        end
+        select { |key, _value| keys.include? key }
       end
 
       def slice! *keys
         replace slice(*keys)
       end
 
-      def deep_merge other_hash
-        dup.deep_merge! other_hash
+      def deep_merge other
+        dup.deep_merge! other
       end
 
-      def deep_merge! other_hash
-        other_hash.each.with_object self do |(other_key, other_value), original_hash|
-          current_value = original_hash[other_key]
-          original_hash[other_key] = deep_merge_value current_value, other_value
+      def deep_merge! other
+        other.each do |(other_key, other_value)|
+          current_value = self[other_key]
+
+          self[other_key] = if current_value.is_a?(Hash) && other_value.is_a?(Hash)
+                              current_value.deep_merge! other_value
+                            else
+                              other_value
+                            end
         end
+
+        self
       end
 
-      def reverse_merge other_hash
-        other_hash.merge self
+      def reverse_merge other
+        other.merge self
       end
 
-      def reverse_merge! other_hash
-        merge!(other_hash) { |_, left_value, _| left_value }
+      def reverse_merge! other
+        merge!(other) { |_key, old_value, _new_value| old_value }
       end
 
-      private
+      def use &block
+        return [] unless block_given?
 
-      def deep_merge_value current_value, other_value
-        return current_value.deep_merge(other_value) if current_value.is_a?(Hash) && other_value.is_a?(Hash)
-        other_value
+        values = block.parameters.map { |(_type, key)| self[key] }
+        yield values
       end
     end
   end

data/lib/refinements/identity.rb

@@ -12,7 +12,7 @@ module Refinements
     end
 
     def self.version
-      "3.2.0"
+      "4.0.0"
     end
 
     def self.version_label

data/lib/refinements/strings.rb

@@ -11,42 +11,66 @@ module Refinements
 
     # rubocop:disable Metrics/BlockLength
     refine String do
+      def first number = 0
+        return self if empty?
+
+        max = Integer number
+
+        return self[0] if max.zero?
+        return "" if max.negative?
+
+        self[0..(max - 1)]
+      end
+
+      # :reek:TooManyStatements
+      def last number = 0
+        return self if empty?
+
+        min = Integer number
+        max = size - 1
+
+        return self[max] if min.zero?
+        return "" if min.negative?
+
+        self[(min + 1)..max]
+      end
+
       def blank?
-        !match(/\A\s*\z/).nil?
+        match?(/\A\s*\z/)
       end
 
       def up
         return self if empty?
-        self[0].upcase + self[1, size]
+        first.upcase + self[1, size]
       end
 
       def down
         return self if empty?
-        self[0].downcase + self[1, size]
+        first.downcase + self[1, size]
       end
 
       def camelcase
-        if self =~ self.class.delimiters
-          result = up_and_join split(%r(\s*\-\s*|\s*\/\s*|\s*\:+\s*)), delimiter: "::"
-          up_and_join result.split(/\s*\_\s*|\s+/)
+        if match?(self.class.delimiters)
+          result = join_parts split(%r(\s*\-\s*|\s*\/\s*|\s*\:+\s*)), method: :up, delimiter: "::"
+          join_parts result.split(/\s*\_\s*|\s+/), method: :up
         else
           up
         end
       end
 
       def snakecase
-        if self =~ self.class.delimiters
-          result = down_and_join split(%r(\s*\-\s*|\s*\/\s*|\s*\:+\s*)), delimiter: "/"
-          down_and_join result.split(/(?=[A-Z])|\s*\_\s*|\s+/), delimiter: "_"
+        if match?(self.class.delimiters)
+          result = join_parts split(%r(\s*\-\s*|\s*\/\s*|\s*\:+\s*)), method: :down, delimiter: "/"
+          join_parts result.split(/(?=[A-Z])|\s*\_\s*|\s+/), method: :down, delimiter: "_"
         else
           downcase
         end
       end
 
       def titleize
-        if self =~ self.class.delimiters
-          result = up_and_join split(/(?=[A-Z])|\s*\_\s*|\s*\-\s*|\s+/), delimiter: " "
-          up_and_join result.split(%r(\s*\/\s*|\s*\:+\s*)), delimiter: "/"
+        if match?(self.class.delimiters)
+          result = join_parts split(/(?=[A-Z])|\s*\_\s*|\s*\-\s*|\s+/), method: :up, delimiter: " "
+          join_parts result.split(%r(\s*\/\s*|\s*\:+\s*)), method: :up, delimiter: "/"
         else
           capitalize
         end
@@ -54,17 +78,12 @@ module Refinements
 
       private
 
-      def up_and_join parts, delimiter: ""
-        parts.reduce "" do |result, part|
-          next part.up if result.empty?
-          "#{result}#{delimiter}#{part.up}"
-        end
-      end
-
-      def down_and_join parts, delimiter: ""
+      # :reek:DuplicateMethodCall
+      # :reek:UtilityFunction
+      def join_parts parts, method:, delimiter: ""
         parts.reduce "" do |result, part|
-          next part.down if result.empty?
-          "#{result}#{delimiter}#{part.down}"
+          next part.send(method) if result.empty?
+          "#{result}#{delimiter}#{part.send method}"
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   n/LUZ1dKhIHzfKx1B4+TEIefArObGfkLIDM8+Dq1RX7TF1k81Men7iu4MgE9bYBn
   3dE+xI3FdB5gWcdWxdtgRCmWjtXeYYyb4z6NQQ==
   -----END CERTIFICATE-----
-date: 2016-12-18 00:00:00.000000000 Z
+date: 2017-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -50,14 +50,14 @@ dependencies:
   name: gemsmith
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '8.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '8.2'
 - !ruby/object:Gem::Dependency
@@ -206,14 +206,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.46'
+        version: '0.47'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.46'
+        version: '0.47'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -257,7 +257,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -265,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.9
 signing_key: 
 specification_version: 4
 summary: Provides a collection of refinements to core Ruby objects.