grape-entity-matchers 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 85553a894b305c75e1d5d6c553f63672227d72f2
-  data.tar.gz: 6823417b9c2ca57cb21f20b9989ade6a942a3e7e
+SHA256:
+  metadata.gz: 179d037a620591d43c496fc8ee7ffa2ae1e1b93d1bb372ce16adeb2855524a54
+  data.tar.gz: 76a101cc479badf012f8587bf90b1164b101542f46efa4ba13dc6327c631bd95
 SHA512:
-  metadata.gz: 8c99842401858a6303bb01c0901bc00a5f1467aad81ab4572405020ad76b0e745ebb968e97ad56761063a0803bca5200ca037f17086643183a13260be8727ff3
-  data.tar.gz: a2c0306cb164ce03f5033a39b4cff116e7e4da5d0b4018332caeba80a53941aabfc1f2ff6b9a42aae2b62b9e30a6e86739e71add41a5dbf2d876c4a59b962cb4
+  metadata.gz: ed9c6bf7a3ded651aafc8828418fa2675ace09c031b58b6da05999b896efd7ff000d85fb98233c7ed0d89a0eee689606e54c3ff3d7d8b7c65f20d72719cf2bb6
+  data.tar.gz: 31b4c0148e4f7befb14de5d3bac85b0d9fc4433163d80482cadde6752ee9ca47bdc18dd133c7bba595dc9090e75b5bacfefabeb325eb005ed76c30f22a44215a

data/.travis.yml

@@ -1,3 +1,4 @@
 rvm:
-  - 2.2.5
-  - 2.3.1
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0

data/CHANGELOG.markdown

@@ -1,34 +1,47 @@
-Next Release
-============
-* add support for minitest
+# Next Release
 
-1.1.0 (06/08/2016)
-===========
-* support grape-entity ~> 0.4.6
-* add with_documentation method to RepresentMatcher
+- add support for minitest
 
-1.0.1 (07/30/2015)
-============
-* added fix for double from @zephyr-dev
-* added formatters from @cveneziani
+  # 1.3.1 (unreleased)
 
-1.0.0 (07/30/2014)
-============
-* move support from rspec 2.x to rspec 3.x
+- {add changes here}
 
-0.4.1 (02/22/2014)
-============
-* fix error when an entity contains itself nested by nil-ing out the nested version.
+  # 1.3.0 (01/24/2020)
 
-0.4.0 (02/22/2014)
-============
-* Support grape-entity 0.4.0.
+- support for grape-entity >= 0.5.0
+- require ruby >= 2.5
+- fix deprecation warnings
 
-0.0.2 (01/17/2013)
-============
-* Fixed error in error messages.
+  # 1.2.0 (08/16/2016)
 
-0.0.1 (01/11/2013)
-==================
+- support grape-entity 0.4.8
 
-* Initial Release
+  # 1.1.0 (06/08/2016)
+
+- support grape-entity ~> 0.4.6
+- add with_documentation method to RepresentMatcher
+
+  # 1.0.1 (07/30/2015)
+
+- added fix for double from @zephyr-dev
+- added formatters from @cveneziani
+
+  # 1.0.0 (07/30/2014)
+
+- move support from rspec 2.x to rspec 3.x
+
+  # 0.4.1 (02/22/2014)
+
+- fix error when an entity contains itself nested by nil-ing out the nested version.
+
+  # 0.4.0 (02/22/2014)
+
+- Support grape-entity 0.4.0.
+
+  # 0.0.2 (01/17/2013)
+
+- Fixed error in error messages.
+
+  # 0.0.1 (01/11/2013)
+
+- Initial Release

data/README.markdown

@@ -1,6 +1,6 @@
 # Grape::Entity::Matchers
 
-[![Build Status](https://travis-ci.org/agileanimal/grape-entity-matchers.png?branch=master)](https://travis-ci.org/agileanimal/grape-entity-matchers)
+[![Build Status](https://travis-ci.org/agileanimal/grape-entity-matchers.svg?branch=master)](https://travis-ci.org/agileanimal/grape-entity-matchers)
 
 ## Introduction
 

data/grape-entity-matchers.gemspec

@@ -12,12 +12,11 @@ Gem::Specification.new do |s|
   s.description = %q{Shoulda-like matchers for Grape Entity.}
   s.license     = "MIT"
 
-  s.rubyforge_project = "grape-entity-matchers"
+  s.required_ruby_version = '>= 2.5'
 
-  s.add_runtime_dependency 'grape-entity', '0.4.8'
+  s.add_runtime_dependency 'grape-entity', '>= 0.5.0'
   s.add_runtime_dependency 'rspec', '>= 3.2.0'
 
-
   s.add_development_dependency 'rake'
   s.add_development_dependency 'maruku'
   s.add_development_dependency 'yard'

data/lib/grape_entity_matchers.rb

@@ -1,4 +1,5 @@
 require 'grape_entity_matchers/version'
+require 'grape_entity_matchers/exposures'
 require 'grape_entity_matchers/represent_matcher'
 require 'grape_entity_matchers/document_matcher'
 require 'grape_entity_matchers/rspec_integration'

data/lib/grape_entity_matchers/document_matcher.rb

@@ -5,6 +5,8 @@ module GrapeEntityMatchers
     end
 
     class DocumentMatcher
+      include Exposures
+
       def initialize(documentable)
         @expected_documentable = documentable
       end
@@ -75,26 +77,25 @@ module GrapeEntityMatchers
 
       def match_documentation
         if has_documentation?
-          exposure[:documentation].slice(*expected_documentation.keys)
+          actual_documentation.slice(*expected_documentation.keys)
         end
       end
 
       def actual_documentation
-        exposure.try(:[], :documentation)
+        exposure.documentation
       end
 
       def has_documentation?
-        @subject.exposures.has_key?(@expected_documentable) &&
-            exposure[:documentation]
+        exposures.has_key?(@expected_documentable) && actual_documentation
       end
 
       def exposure
-        @subject.exposures[@expected_documentable]
+        exposures[@expected_documentable]
       end
 
       def verify_documentation
         if @documentation
-          @documentation == exposure[:documentation]
+          @documentation == actual_documentation
         else
           expected_documentation == match_documentation
         end

data/lib/grape_entity_matchers/exposures.rb

@@ -0,0 +1,21 @@
+module GrapeEntityMatchers
+  module Exposures
+    private
+
+    def exposures
+      @exposures ||= extract_exposures(@subject.root_exposures)
+    end
+
+    def extract_exposures(exposures, hash = {}, prefix = nil)
+      exposures.each_with_object(hash) do |exposure, hash|
+        key = "#{prefix}#{exposure.attribute}"
+        if exposure.is_a?(Grape::Entity::Exposure::NestingExposure)
+          hash[key.to_sym] = Hash.new
+          extract_exposures(exposure.nested_exposures.to_a, hash, "#{key}__")
+        else
+          hash[key.to_sym] = exposure
+        end
+      end
+    end
+  end
+end

data/lib/grape_entity_matchers/represent_matcher.rb

@@ -9,6 +9,8 @@ module GrapeEntityMatchers
 
     class RepresentMatcher
       include ::RSpec::Mocks::ExampleMethods
+      include Exposures
+
       def initialize(representable)
         @expected_representable = representable
         RSpec::Mocks::setup
@@ -43,9 +45,8 @@ module GrapeEntityMatchers
       def using(other_entity)
         @other_entity = other_entity
         @represented_attribute  = double("RepresentedAttribute")
-        @other_entity.exposures.keys.each do |key|
-          allow(@represented_attribute ).to receive(key).and_return( @other_entity.exposures[key].nil? ? :value : nil)
-        end
+        other_entity_exposures =  extract_exposures(@other_entity.root_exposures)
+        allow_exposure_methods(@represented_attribute, other_entity_exposures)
         self
       end
 
@@ -90,7 +91,7 @@ module GrapeEntityMatchers
 
       def limit_exposure_to_method(entity, method)
         allow(entity).to receive(:root_exposures).and_return(
-          entity.exposures.slice(method)
+          extract_exposures(entity.root_exposures).slice(method).values
         )
       end
 
@@ -98,10 +99,19 @@ module GrapeEntityMatchers
         @representee = double("RepresentedObject")
         @represented_attribute ||= :value
 
-        allow(@representee).to receive(@expected_representable).and_return(@represented_attribute)
-        expect(@representee).to receive(@conditions.keys.first).and_return(@conditions.values.first) unless @conditions.nil?
+        # The condition will only be checked if entity has the exposure
+        if exposure_keys.include?(@actual_representation || @expected_representable) && !@conditions.nil?
+          expect(@representee).to receive(@conditions.keys.first).and_return(@conditions.values.first) unless @conditions.nil?
+        end
+
+        if @actual_representation
+          exposure = exposures.values.find { |exposure| exposure.key == @actual_representation }
+          allow(@representee).to receive(exposure.attribute).and_return(@represented_attribute) if exposure
+        else
+          allow(@representee).to receive(@expected_representable).and_return(@represented_attribute)
+        end
 
-        representation = @subject.represent(@representee)
+        representation = @subject.represent(@representee, only: [@actual_representation || @expected_representable])
 
         @serialized_hash = if @root
                              limit_exposure_to_method(representation[@root.to_s], @expected_representable)
@@ -123,7 +133,11 @@ module GrapeEntityMatchers
       end
 
       def has_exposure?
-        @subject.exposures.has_key?(@expected_representable)
+        exposures.has_key?(@expected_representable)
+      end
+
+      def exposure_keys
+        exposures.values.map { |exposure| exposure.key || exposure.attribute }
       end
 
       def verify_exposure
@@ -132,7 +146,7 @@ module GrapeEntityMatchers
         hash[:as] = @actual_representation unless @actual_representation.nil?
         hash[:format_with] = @formatter if @formatter
 
-        exposure = @subject.exposures[@expected_representable].dup
+        exposure = exposures[@expected_representable].send(:options).dup
 
         # ignore documentation unless with_documentation was specified
         if @documentation
@@ -148,13 +162,17 @@ module GrapeEntityMatchers
         end
       end
 
+      def allow_exposure_methods(entity, exposures)
+        exposures.keys.each do |key|
+          allow(entity).to receive(key).and_return(exposures[key].nil? ? :value : nil)
+        end
+      end
+
       def check_value
         if @other_entity
           other_representation = @other_entity.represent(@represented_attribute)
-
-          other_representation.exposures.keys.each do |key|
-            allow(other_representation).to receive(key).and_return( other_representation.exposures[key].nil? ? :value : nil)
-          end
+          other_representation_exposures = extract_exposures(other_representation.root_exposures)
+          allow_exposure_methods(other_representation, other_representation_exposures)
 
           @serialized_hash[@actual_representation || @expected_representable] ==  other_representation.serializable_hash
         else

data/lib/grape_entity_matchers/version.rb

@@ -1,3 +1,3 @@
 module GrapeEntityMatchers
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec/grape_entity_matchers/document_matcher_spec.rb

@@ -32,7 +32,7 @@ describe GrapeEntityMatchers::DocumentMatcher do
 
   context "ensure individual keys of documentation" do
     it { is_expected.to document(:str).type(String) }
-    it { is_expected.not_to document(:str).type(Fixnum) }
+    it { is_expected.not_to document(:str).type(Integer) }
 
     it { is_expected.to document(:str).desc('Some string') }
     it { is_expected.not_to document(:str).desc('Some other string') }
@@ -58,4 +58,29 @@ describe GrapeEntityMatchers::DocumentMatcher do
   context "ensure that a specific documentation is not used" do
     it { is_expected.to_not document(:str).with(type: String, required: false) }
   end
+
+  context "with a nested exposure" do
+    before(:all) do
+      class TestEntityWithNested < Grape::Entity
+        expose :nested do
+          expose :str, documentation:  {
+            type: String,
+            desc: 'Some string',
+            default: 'xyz',
+            required: false,
+            values: ['abc', 'xyz']
+          }
+          expose :no_doc
+        end
+      end
+    end
+
+    subject(:entity) do
+      TestEntityWithNested
+    end
+
+    context "ensure that a nested exposure matches the documentation" do
+      it { is_expected.to document(:nested__str).with(documentation) }
+    end
+  end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity-matchers
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Mark Madsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-entity
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.8
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.8
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +115,7 @@ files:
 - lib/grape-entity-matchers.rb
 - lib/grape_entity_matchers.rb
 - lib/grape_entity_matchers/document_matcher.rb
+- lib/grape_entity_matchers/exposures.rb
 - lib/grape_entity_matchers/represent_matcher.rb
 - lib/grape_entity_matchers/rspec_integration.rb
 - lib/grape_entity_matchers/version.rb
@@ -133,15 +134,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: grape-entity-matchers
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Shoulda-like matchers for Grape Entity.
@@ -149,4 +149,3 @@ test_files:
 - spec/grape_entity_matchers/document_matcher_spec.rb
 - spec/grape_entity_matchers/represent_matcher_spec.rb
 - spec/spec_helper.rb
-has_rdoc: