hash_map 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8087bb03fb5521f63c3fc63689b7047610996f04
-  data.tar.gz: 139b3dbac032b2799a5bc825c0473a1c6f2b6954
+  metadata.gz: 6bae76ad044288eb46403cd3ea870146d210bc91
+  data.tar.gz: 268a72ffcdc09a0e79a1c7bce05adbeb7f3b3ee2
 SHA512:
-  metadata.gz: 4a1713d1a9e4c18474b7f86626b0c8c51a0b12c92619ac4bc1fbae3e75403cc0780de1732c473f230aed2799e9ed70f09f27ee39d0274822c404beb54b28bc39
-  data.tar.gz: 50292c55159b07a14421df7dfc4720d447f4b2e25b16e5d4b847195ebb32dd9f9da75a244966cbdb6124974245224d3d3578223a76695ad9b931485c31f847cf
+  metadata.gz: 6b938e9d58a66274c45b34769ed5de353189b62c0d4b59ade8a6307057c7accadc4b2b64cd0429186c36e133c322c852ab401fc31d58dc5bfc6797c1989ccfe6
+  data.tar.gz: 4dc6a6f3ab70adbb9e31592614f5dee586d9911f7e99a9df8e8311c2aeaf2041ffb99a48f2f8219fb07d473beaac4701c5e9eee1ced7de66b23860b584a6a544

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-04-26 22:01:05 +0200 using RuboCop version 0.37.2.
+# on 2016-09-13 00:25:45 +0200 using RuboCop version 0.40.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -8,19 +8,28 @@
 
 # Offense count: 4
 # Cop supports --auto-correct.
-# Configuration parameters: IgnoreEmptyBlocks.
+# Configuration parameters: AllowUnusedKeywordArguments.
 Lint/UnusedBlockArgument:
   Exclude:
     - 'spec/examples/blocks_spec.rb'
     - 'spec/hash_map/dsl_spec.rb'
     - 'spec/hash_map/mapper_spec.rb'
 
-# Offense count: 28
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 17
+
+# Offense count: 37
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 238
 
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 12
+
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
@@ -41,7 +50,15 @@ Style/Alias:
   Exclude:
     - 'lib/hash_map/base.rb'
 
-# Offense count: 8
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: braces, no_braces, context_dependent
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'lib/hash_map/matchers.rb'
+
+# Offense count: 10
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -53,6 +70,7 @@ Style/Documentation:
     - 'lib/hash_map/dsl.rb'
     - 'lib/hash_map/json_adapter.rb'
     - 'lib/hash_map/mapper.rb'
+    - 'lib/hash_map/matchers.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -94,13 +112,6 @@ Style/MutableConstant:
 Style/NumericLiterals:
   MinDigits: 6
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-    - 'hash_map.gemspec'
-
 # Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
@@ -110,7 +121,7 @@ Style/SignalException:
     - 'lib/hash_map/dsl.rb'
     - 'lib/hash_map/json_adapter.rb'
 
-# Offense count: 4
+# Offense count: 5
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: space, no_space
@@ -138,28 +149,20 @@ Style/SpaceInsideBrackets:
   Exclude:
     - 'spec/examples/collections_spec.rb'
 
-# Offense count: 3
+# Offense count: 4
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
 # SupportedStyles: space, no_space
 Style/SpaceInsideHashLiteralBraces:
   Enabled: false
 
-# Offense count: 21
+# Offense count: 35
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
 Style/StringLiterals:
   Enabled: false
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: final_newline, final_blank_line
-Style/TrailingBlankLines:
-  Exclude:
-    - 'lib/hash_map.rb'
-
 # Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
@@ -169,9 +172,3 @@ Style/TrailingCommaInLiteral:
     - 'spec/examples/defaults_spec.rb'
     - 'spec/hash_map/dsl_spec.rb'
     - 'spec/hash_map/mapper_spec.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/UnneededPercentQ:
-  Exclude:
-    - 'hash_map.gemspec'

data/README.md

@@ -362,6 +362,48 @@ hash.hash_map_with(UserMapper)
 # => {"name"=>"John", "surname"=>"Doe"}
 ```
 
+### Testing
+
+#### RSpec
+
+__hash_mapped__
+
+```ruby
+it do
+  output = { name: :hello }
+  expect(output).to hash_mapped(:name)
+end
+```
+
+`from`
+```ruby
+it do
+  original = { first_name: :hello }
+  output = { name: :hello }
+  expect(output).to hash_mapped(:name).from(original, :first_name)
+end
+
+it do
+  original = { user: { first_name: :hello } }
+  output = { name: :hello }
+  expect(output).to hash_mapped(:name).from(original, :user, :first_name)
+end
+
+it do
+  original = { user: { first_name: :hello } }
+  output = { user: { name: :hello } }
+  expect(output).to hash_mapped(:user, :name).from(original, :user, :first_name)
+end
+```
+
+`and_eq`
+
+```ruby
+it do
+  output = { user: { name: :hello } }
+  expect(output).to hash_mapped(:user, :name).and_eq(:hello)
+end
+```
 
 ### Motivation
 I got bored of doing this:

data/lib/hash_map/base.rb

@@ -33,23 +33,13 @@ module HashMap
     private
 
     def _transforms_output(output)
-      if middlewares = self.class.dsl.instance_variable_get(:@transform_output)
-        middlewares.inject(output) do |out, proccess|
-          proccess.call(out)
-        end
-      else
-        output
-      end
+      middlewares = self.class.dsl.instance_variable_get(:@transform_output)
+      run_middlewares(middlewares, output)
     end
 
     def _transforms_input(input)
-      if middlewares = self.class.dsl.instance_variable_get(:@transform_input)
-        middlewares.inject(input) do |out, proccess|
-          proccess.call(out)
-        end
-      else
-        input
-      end
+      middlewares = self.class.dsl.instance_variable_get(:@transform_input)
+      run_middlewares(middlewares, input)
     end
 
     def prepare_input(input)
@@ -60,5 +50,15 @@ module HashMap
         input
       end
     end
+
+    def run_middlewares(middlewares, input)
+      if middlewares
+        middlewares.inject(input) do |out, proccess|
+          proccess.call(out)
+        end
+      else
+        input
+      end
+    end
   end
 end

data/lib/hash_map/mapper.rb

@@ -28,7 +28,7 @@ module HashMap
       nil_to_default(value, struct)
     end
 
-    def after_each_middleware(value, key)
+    def after_each_middleware(value, _key)
       after_each_callbacks.inject(value) do |output, middle|
         middle.call(output)
       end
@@ -57,11 +57,11 @@ module HashMap
     def execute_block(struct)
       block = struct[:proc]
       value = if struct[:from_child]
-        nested = get_value_from_key(struct, :from_child)
-        hash_map.instance_exec nested, original, &block
-      else
-        hash_map.instance_exec original, original, &block
-      end
+                nested = get_value_from_key(struct, :from_child)
+                hash_map.instance_exec nested, original, &block
+              else
+                hash_map.instance_exec original, original, &block
+              end
       after_each_middleware(value, struct[:key].last)
     end
 

data/lib/hash_map/matchers.rb

@@ -0,0 +1,129 @@
+module HashMap
+  module Matchers
+    def hash_mapped(*original)
+      HashMappedMatcher.new(original)
+    end
+
+    class HashMappedMatcher
+      attr_reader :key, :mapped_hash, :original_hash, :from_key, :mapped_has_key,
+                  :description_messages, :failure_messages, :expected, :expected_provided
+
+      def initialize(key)
+        @key = key
+        @error = []
+        @description_messages = []
+        @failure_messages = []
+      end
+
+      def matches?(hash)
+        @mapped_hash = hash
+        _has_key && _from && equality
+      end
+
+      def description
+        description_messages.join(', ')
+      end
+
+      def failure_message
+        failure_messages.join(', ')
+      end
+
+      def from(original_hash, *from_key)
+        @original_hash = original_hash
+        @from_key = from_key
+        self
+      end
+
+      def and_eq(expected)
+        @expected_provided = true
+        @expected = expected
+        self
+      end
+
+      private
+
+      def mapped_has_key?
+        mapped_results[:has_key]
+      end
+
+      def mapped_value
+        mapped_results[:value]
+      end
+
+      def original_has_key?
+        original_results[:has_key]
+      end
+
+      def original_value
+        original_results[:value]
+      end
+
+      def mapped_results
+        @mapped_results ||= _nested_keys(mapped_hash, key)
+      end
+
+      def original_results
+        @original_results ||= _nested_keys(original_hash, from_key)
+      end
+
+      def _has_key
+        if mapped_has_key?
+          description_messages << "have key #{key_to_message} after been mapped"
+        else
+          failure_messages << "has no key #{key_to_message} after been mapped"
+          false
+        end
+      end
+
+      def _from
+        return true unless original_hash
+        if original_has_key?
+          if original_value == mapped_value
+            description_messages << "#{key_to_message} and original #{from_key_to_message} are the same"
+          else
+            failure_messages << "#{key_to_message} and original #{from_key_to_message} are NOT the same"
+            false
+          end
+        else
+          failure_messages << "original has no key: #{from_key_to_message}"
+          false
+        end
+      end
+
+      def from_key_to_message
+        keys_to_message from_key
+      end
+
+      def key_to_message
+        keys_to_message key
+      end
+
+      def keys_to_message(keys)
+        children = keys.map { |k| key_representation(k) }.join(' -> ')
+        "`#{children}`"
+      end
+
+      def key_representation(k)
+        k.is_a?(Symbol) ? ":#{k}" : "'#{k}'"
+      end
+
+      def equality
+        return true unless expected_provided
+        if mapped_value == expected
+          description_messages << "and eq `#{expected}`"
+        else
+          failure_messages << "key #{key_to_message} expected to eq `#{expected}`"
+          false
+        end
+      end
+
+      def _nested_keys(hash, keys)
+        keys.inject({ value: hash, has_key: true }) do |out, key|
+          return { value: nil, has_key: false } unless out[:value]
+          return { value: nil, has_key: false } unless out[:has_key]
+          { value: out[:value][key], has_key: out[:value].key?(key) }
+        end
+      end
+    end
+  end
+end

data/lib/hash_map/version.rb

@@ -1,3 +1,3 @@
 module HashMap
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_map
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2016-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,7 @@ files:
 - lib/hash_map/dsl.rb
 - lib/hash_map/json_adapter.rb
 - lib/hash_map/mapper.rb
+- lib/hash_map/matchers.rb
 - lib/hash_map/plugins.rb
 - lib/hash_map/version.rb
 homepage: https://github.com/arturictus/hash_map
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Library to map easily hashes.