refinements 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 187d41db156d487f8f558ff6479bdaf1b5529175
-  data.tar.gz: 3944401486fe06119d64a1412bb64a23c12653fb
+  metadata.gz: 17b47190dc2dd923e2970e7e78a2cb449a02b570
+  data.tar.gz: b98ff991a80234011b9032cb37ab884f18517483
 SHA512:
-  metadata.gz: dedc8913cb29503b6589cede6211caef97708a977793c612374abb00b8d72ed1100cce3f7bd7be441dcd5ebaa7d02ef954c29f1ac6810aa34902ab9b14e30df8
-  data.tar.gz: 69caac9d19cb287026da1fbb992dfa6ae8b9d58efe07baa01ec263fe7f5f3ad1ee534da2508bb8a8f15da65e4e7ec7baf9bc2153b87794c2b57f14a29d1b124d
+  metadata.gz: 92469e4d6ad36f32fc2cdb84303c286863831875caa144d3859d4d21d683f3ab8b6ef347e59ff4e364d588d5585613fd374b80cf352e007fc572f79447ca3b16
+  data.tar.gz: 056235b52753623d09440e7d3e99b660dfeb52e9eab9986d70686a5fdfe68925ee96ccc524cec11e33798e95bc05990b3e32bb364efb39992c98ef18108e49a2

data/README.md

@@ -1,35 +1,10 @@
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-# Table of Contents
-
-- [Refinements](#refinements)
-- [Table of Contents](#table-of-contents)
-- [Features](#features)
-- [Requirements](#requirements)
-- [Setup](#setup)
-- [Usage](#usage)
-  - [Requires](#requires)
-  - [Using](#using)
-  - [Examples](#examples)
-    - [Array](#array)
-    - [Big Decimal](#big-decimal)
-- [Tests](#tests)
-- [Versioning](#versioning)
-- [Code of Conduct](#code-of-conduct)
-- [Contributions](#contributions)
-- [License](#license)
-- [History](#history)
-- [Credits](#credits)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
 # Refinements
 
 [![Gem Version](https://badge.fury.io/rb/refinements.svg)](http://badge.fury.io/rb/refinements)
 [![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/refinements.svg)](https://codeclimate.com/github/bkuhlmann/refinements)
 [![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/refinements/coverage.svg)](https://codeclimate.com/github/bkuhlmann/refinements)
 [![Gemnasium Status](https://gemnasium.com/bkuhlmann/refinements.svg)](https://gemnasium.com/bkuhlmann/refinements)
-[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/refinements.svg)](http://travis-ci.org/bkuhlmann/refinements)
+[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/refinements.svg)](https://travis-ci.org/bkuhlmann/refinements)
 [![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
 
 Provides a collection of refinements for core Ruby objects.
@@ -45,8 +20,9 @@ Provides a collection of refinements for core Ruby objects.
   - [Requires](#requires)
   - [Using](#using)
   - [Examples](#examples)
-    - [Array](#array)
     - [Big Decimal](#big-decimal)
+    - [Array](#array)
+    - [Hash](#hash)
 - [Tests](#tests)
 - [Versioning](#versioning)
 - [Code of Conduct](#code-of-conduct)
@@ -59,21 +35,27 @@ Provides a collection of refinements for core Ruby objects.
 
 # Features
 
-- Adds Array refinements:
-    - `Array#compress` - Removes nil and empty values without modifying original values.
-    - `Array#compress!` - Removes nil and empty values and modifies original values.
 - Adds BigDecimal refinements:
-    - `BigDecimal#inspect` - Allows one to inspect a big decimal with numeric representation.
+  - `BigDecimal#inspect` - Allows one to inspect a big decimal with numeric representation.
+- Adds Array refinements:
+  - `Array#compress` - Removes nil and empty values without modifying itself.
+  - `Array#compress!` - Removes nil and empty values and modifies itself.
+- Adds Hash refinements:
+  - `#deep_merge` - Merges deeply nested hashes together without itself.
+  - `#deep_merge!` - Merges deeply nested hashes together and modifies itself.
+  - `#reverse_merge` - Merges calling hash into passed in hash without modifying calling hash.
+  - `#reverse_merge!` - Merges calling hash into passed in hash and modifies calling hash.
 
 # Requirements
 
-0. [MRI 2.x.x](http://www.ruby-lang.org).
+0. [MRI 2.3.x](https://www.ruby-lang.org).
+0. A solid understanding of [Ruby refinements and lexical scope](https://www.youtube.com/watch?v=qXC9Gk4dCEw).
 
 # Setup
 
 For a secure install, type the following from the command line (recommended):
 
-    gem cert --add <(curl -Ls http://www.my-website.com/gem-public.pem)
+    gem cert --add <(curl -Ls https://www.my-website.com/gem-public.pem)
     gem install refinements --trust-policy MediumSecurity
 
 NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
@@ -95,8 +77,9 @@ Due to this gem being a collection of Ruby refinements, none of the refinements
 reduce code bloat for your app. Instead, require the specific requirement for the code that needs it. You'll want to
 require one or all of the following:
 
-    require "refinements/array_extensions"
     require "refinements/big_decimal_extensions"
+    require "refinements/array_extensions"
+    require "refinements/hash_extensions"
 
 ## Using
 
@@ -104,8 +87,9 @@ In addition to requiring the appropriate refinement file for the code that needs
 refinement by using the `using` keyword within your object. You'll want to use one or all of the following:
 
     class Example
-      using Refinements::ArrayExtensions
       using Refinements::BigDecimalExtensions
+      using Refinements::ArrayExtensions
+      using Refinements::HashExtensions
     end
 
 ## Examples
@@ -113,6 +97,11 @@ refinement by using the `using` keyword within your object. You'll want to use o
 With the appropriate refinements required and used within your objects, the following sections demonstrates how each
 refinement enriches your objects with new capabilities.
 
+### Big Decimal
+
+    big = BigDecimal.new "5.0E-10"
+    big.inspect # => "#<BigDecimal:3fd3d458fe84 0.0000000005>"
+
 ### Array
 
     example = ["An", nil, "", "Example"]
@@ -123,10 +112,23 @@ refinement enriches your objects with new capabilities.
     example.compress! # => ["An", "Example"]
     example # => ["An", "Example"]
 
-### Big Decimal
+### Hash
 
-    big = BigDecimal.new "5.0E-10"
-    big.inspect # => "#<BigDecimal:3fd3d458fe84 0.0000000005>"
+    example = {a: "A", b: {one: "One", two: "Two"}}
+    example.deep_merge b: {one: 1} # => {a: "A", b: {one: 1, two: "Two"}}
+    example # => {a: "A", b: {one: "One", two: "Two"}}
+
+    example = {a: "A", b: {one: "One", two: "Two"}}
+    example.deep_merge! b: {one: 1} # => {a: "A", b: {one: 1, two: "Two"}}
+    example # => {a: "A", b: {one: 1, two: "Two"}}
+
+    example = {a: 1, b: 2}
+    example.reverse_merge a: 0, c: 3 # => {a: 1, b: 2, c: 3}
+    example # => {a: 1, b: 2}
+
+    example = {a: 1, b: 2}
+    example.reverse_merge! a: 0, c: 3 # => {a: 1, b: 2, c: 3}
+    example # => {a: 1, b: 2, c: 3}
 
 # Tests
 

data/lib/refinements/hash_extensions.rb

@@ -0,0 +1,32 @@
+module Refinements
+  # Refinements for Hashes.
+  module HashExtensions
+    refine Hash do
+      def deep_merge other_hash
+        dup.deep_merge! other_hash
+      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
+        end
+      end
+
+      def reverse_merge other_hash
+        other_hash.merge self
+      end
+
+      def reverse_merge! other_hash
+        merge!(other_hash) { |_, left_value, _| left_value }
+      end
+
+      private
+
+      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
+      end
+    end
+  end
+end

data/lib/refinements/identity.rb

@@ -10,7 +10,7 @@ module Refinements
     end
 
     def self.version
-      "1.0.0"
+      "2.0.0"
     end
 
     def self.label_version

data/lib/tasks/console.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+desc "Open IRB console for gem development environment"
+task :console do
+  require "irb"
+  require "refinements"
+  ARGV.clear
+  IRB.start
+end

metadata

@@ -1,36 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMQ8wDQYDVQQDDAZicm9v
-  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
-  aW8wHhcNMTUwNzA1MTQ1MzExWhcNMTYwNzA0MTQ1MzExWjBBMQ8wDQYDVQQDDAZi
-  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
-  GRYCaW8wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCzhOVcvLGBCceM
-  PppVpJLUKsnskWzc1VqBXmv30feKNw+MOxMQaDsIP421qwqGO/2JHY60Kuobssk+
-  8/wqZkVFF/FFKxoQjuhlhc+VWLm8jWgXd4N1kwO2yytscQTzxc5qXarwA+36fqVH
-  RhBAHhjka+HdBI+6o3CXRHJoC47iav+QpR7u/wYl3gNq6MJO3MmTKqHegEDLjRN0
-  FJAr3bRAwq03ZtTuAVA2bdKLGThehe1RRRtJHJ/PHpmL2c203/GTXYtG6C8ILZIp
-  ZroTqQ8yglCJ+3hSOmodZqSAQ0Rj7GJgtuNH81qlSrHu5sTvoZjGmEqSIhvsSJ80
-  wKoPdZnFAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBSUnF478a5lB4xuOBiktJdMJv6JmDAfBgNVHREEGDAWgRRicm9va2VAYWxjaGVt
-  aXN0cy5pbzAfBgNVHRIEGDAWgRRicm9va2VAYWxjaGVtaXN0cy5pbzANBgkqhkiG
-  9w0BAQUFAAOCAQEAT7KtBXWsq1KA7NOSMeFEDeSvhrgdLwCG/37pIu0rjvx9iAW4
-  gncxV0MccqIUtaF+lekjlXkIO+rXAVjvdha23KtpFTW90dYXp4NLPnPlSdyvYzJy
-  FIAaWGvujOT8xEu4umd45q5aepE8li4bR071i5Z7F0trKNVYYrxjQFmH5SSKYRT/
-  fXtICtAh1de3z3SOSK58IMPwjuoApYBxiqlmx0Uhla7mrzCE5+NmLPit3hLH6JFK
-  aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
-  xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
-  -----END CERTIFICATE-----
-date: 2015-11-21 00:00:00.000000000 Z
+cert_chain: []
+date: 2016-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -256,9 +234,11 @@ files:
 - lib/refinements.rb
 - lib/refinements/array_extensions.rb
 - lib/refinements/big_decimal_extensions.rb
+- lib/refinements/hash_extensions.rb
 - lib/refinements/identity.rb
-- lib/refinements/tasks/rspec.rake
-- lib/refinements/tasks/rubocop.rake
+- lib/tasks/console.rake
+- lib/tasks/rspec.rake
+- lib/tasks/rubocop.rake
 homepage: https://github.com/bkuhlmann/refinements
 licenses:
 - MIT
@@ -269,9 +249,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -279,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Provides a collection of refinements for core Ruby objects.

checksums.yaml.gz.sig

@@ -1 +0,0 @@
-������ze���$(k�΢o�O6d�z�U�>���rƂ�q2��@�����?�W?����T/��HE�I
"�N�HD�Q)�s�������;�9R�,�U�[Y�҇n1dWMd��A!b��j�f�8:X��w�V���$�l|�I42��!u�ž��w���(L�W�*�\��d�Kυ�?��"Y0FK�8nf��t���Eum�Jl����\�ﳖw�r�dvX�~�>,[ږ�="�Nw��_���6��.eV0s�