json_rspec_match_maker 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bae227cfdefaa6a79eb4f3000bd7288dbfe98d1959245811f5e5bdf831838e5
-  data.tar.gz: c4bb1ec682a23d791ee73caba8775242c3a6c90e64a10e77887556b244cc841b
+  metadata.gz: 1b5b140faa0ef46843473e4c028a1d612bfb0321cd63538d36277f97cf9b129e
+  data.tar.gz: b59d16bc22e7f57d7f2b6fadc5faf71aaa1e2a2b0daf902ae194d656eefba551
 SHA512:
-  metadata.gz: 98cd96ca937e649b76f97957c7291344e1b64a968548dba869641f6499bbfb207f3e7b8e21b4c0dc179808e6c9bfc78c39dff7711c6004af4de24edd4b3ff8d7
-  data.tar.gz: 78f0bb747f35df684811b0b2c94814e1f542af1c9e2c0ae12c8c780bb8afc8881b09a4aedac45b4c611c74a0107db7c994a637016af08ef0bd8b14912b7b0b9c
+  metadata.gz: c9f543a7915141e2faf82ba1e4da26f0c347be97ac87ec44e5c3b2635807f4e1c8b774d4d13c480d1364de61b85c1ea3248523e963a093bdcfd4c787d9c1fe41
+  data.tar.gz: e64e5696fb2227dff2483c48dea976a9e8934aaf3bb529e776a73abc17c010d7fa2e2cfc6cf581d5bec05df24a21b4ae94aab5050cd07fb2c540c8f9d6558776

data/.rubocop.yml

@@ -1,4 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
+AllCops:
+  TargetRubyVersion: 2.5.1
+
 Metrics/LineLength:
   Max: 100

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-03-10 16:28:20 -0500 using RuboCop version 0.52.1.
+# on 2018-05-15 14:13:45 -0400 using RuboCop version 0.52.1.
 # 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

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json_rspec_match_maker (0.1.2)
+    json_rspec_match_maker (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'json_rspec_match_maker'

data/json_rspec_match_maker.gemspec

@@ -1,4 +1,6 @@
 
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'json_rspec_match_maker/version'

data/lib/json_rspec_match_maker/base.rb

@@ -1,14 +1,6 @@
-module JsonRspecMatchMaker
-  # Error raised when the child class has failed to set @match_definition
-  # @api private
-  class MatchDefinitionNotFound < StandardError
-    # Create an error message for a child class
-    # @param class_name [String] the name of the matcher class
-    def initialize(class_name)
-      super("Expected instance variable @match_defintion to be set for #{class_name}")
-    end
-  end
+# frozen_string_literal: true
 
+module JsonRspecMatchMaker
   # Base class that abstracts away all of the work of using the @match_definition
   class Base
     # The object being expected against
@@ -32,8 +24,9 @@ module JsonRspecMatchMaker
     # @example
     #   JsonRspecMatchMaker.new(active_record_model)
     #   JsonRspecMatchMaker.new(presenter_instance)
-    def initialize(expected)
+    def initialize(expected, match_definition)
       @expected = expected
+      @match_definition = expand_definition(match_definition)
       @errors = {}
     end
 
@@ -60,22 +53,43 @@ module JsonRspecMatchMaker
 
     private
 
+    # expands simple arrays into full hash definitions
+    # @api private
+    def expand_definition(definition)
+      return definition if definition.is_a? Hash
+      definition.each_with_object({}) do |key, result|
+        if key.is_a? String
+          result[key] = :default
+        elsif key.is_a? Hash
+          result.merge!(expand_sub_definition(key))
+        end
+      end
+    end
+
+    # expands nested simple definition into a full hash
+    # @api private
+    def expand_sub_definition(sub_definition)
+      subkey = sub_definition.keys.first
+      return sub_definition if sub_definition[subkey].respond_to? :call
+      sub_definition[subkey][:attributes] = expand_definition(sub_definition[subkey][:attributes])
+      sub_definition
+    end
+
     # Walks through the match definition, collecting errors for each field
     # @api private
     # @raise [MatchDefinitionNotFound] if child class does not set @match_definition
     # @return [nil] returns nothing, adds to error list as side effect
     def check_target_against_expected
-      raise MatchDefinitionNotFound, self.class.name unless @match_definition
-      check_definition(@match_definition)
+      check_definition(@match_definition, expected)
     end
 
-    def check_definition(definition, current_expected = expected, current_key = nil)
+    def check_definition(definition, current_expected, current_key = nil)
       definition.each do |error_key, match_def|
-        key = [current_key, error_key].compact.join('.')
-        if match_def.respond_to? :call
-          check_values(key, match_def, current_expected)
-        else
+        if match_def.is_a? Hash
+          key = [current_key, error_key].compact.join('.')
           check_each(key, match_def, current_expected)
+        else
+          check_values(current_key, error_key, match_def, current_expected)
         end
       end
     end
@@ -111,9 +125,9 @@ module JsonRspecMatchMaker
     #    :error_key the subfield reported in the error
     # the index if iterating through a list, otherwise nil
     # @return [nil] returns nothing, adds to error list as side effect
-    def check_values(error_key, match_function, expected_instance = expected)
-      expected_value = ExpectedValue.new(match_function, expected_instance)
-      target_value = TargetValue.new(error_key, target)
+    def check_values(key_prefix, error_key, match_function, expected_instance = expected)
+      expected_value = ExpectedValue.new(match_function, expected_instance, error_key)
+      target_value = TargetValue.new([key_prefix, error_key].compact.join('.'), target)
       add_error(expected_value, target_value) unless expected_value == target_value
     end
 

data/lib/json_rspec_match_maker/expected_value.rb

@@ -1,14 +1,30 @@
+# frozen_string_literal: true
+
 module JsonRspecMatchMaker
   # Handles fetching the expected value from the expected instance
   class ExpectedValue
     attr_reader :value
-    def initialize(match_function, expected_instance)
-      @value = match_function.call(expected_instance)
+    def initialize(match_function, expected_instance, error_key)
+      @value = fetch_expected_value(expected_instance, match_function, error_key)
     end
 
     def ==(other)
       raise ArgumentError unless other.is_a? TargetValue
       other.value == value
     end
+
+    private
+
+    def fetch_expected_value(instance, function, key)
+      if function == :default
+        key.split('.').inject(instance) do |expected, k|
+          expected&.send k
+        rescue NoMethodError
+          nil
+        end
+      else
+        function.call(instance)
+      end
+    end
   end
 end

data/lib/json_rspec_match_maker/target_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JsonRspecMatchMaker
   # Handles fetching the target value from the target object
   class TargetValue

data/lib/json_rspec_match_maker/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JsonRspecMatchMaker
-  VERSION = '0.1.2'.freeze
+  VERSION = '1.0.0'
 end

data/lib/json_rspec_match_maker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json_rspec_match_maker/version'
 require 'json_rspec_match_maker/expected_value'
 require 'json_rspec_match_maker/target_value'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_rspec_match_maker
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Patrick McGee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler