grape-entity-matchers 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c0426e2c74d00cf63c93edbf8f02fe8d3b633fd
-  data.tar.gz: da5e0ab865318a1c637da23cefc2ebb31b11c91c
+  metadata.gz: 85553a894b305c75e1d5d6c553f63672227d72f2
+  data.tar.gz: 6823417b9c2ca57cb21f20b9989ade6a942a3e7e
 SHA512:
-  metadata.gz: 41cb2134865d792307c39b3c6e62bcc9d4237ffebbc93f141cb8b8af3a0f27651e306fcb7b3c9aa46e9f62fcf0001fc2a5513c64b8effa6b06c946891a10838c
-  data.tar.gz: 81e30fbd7fe9efa952c2146ebddb5c764dbf08546232700ba93862ad3d8d886ba082059f76641db507f0287b31683f7b4b6adec9ffe92a6a457bd469439a6806
+  metadata.gz: 8c99842401858a6303bb01c0901bc00a5f1467aad81ab4572405020ad76b0e745ebb968e97ad56761063a0803bca5200ca037f17086643183a13260be8727ff3
+  data.tar.gz: a2c0306cb164ce03f5033a39b4cff116e7e4da5d0b4018332caeba80a53941aabfc1f2ff6b9a42aae2b62b9e30a6e86739e71add41a5dbf2d876c4a59b962cb4

data/.travis.yml

@@ -1,3 +1,3 @@
 rvm:
-  - 2.1.2
-  - 2.0.0
+  - 2.2.5
+  - 2.3.1

data/CHANGELOG.markdown

@@ -2,6 +2,11 @@ Next Release
 ============
 * add support for minitest
 
+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

data/README.markdown

@@ -27,6 +27,9 @@ it { is_expected.to represent(:dog).using(PetEntity) }
 it { is_expected.to represent(:cat).as(:kitty).using(PetEntity) }
 
 it { is_expected.to represent(:name).with_documentation(type: String) }
+
+it { is_expected.to document(:name).with(type: String, desc: 'Name of the person') }
+it { is_expected.to document(:name).type(String).desc('Name of the person') }
 ```
 
 ## Support for Rspec 2.0.0

data/grape-entity-matchers.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "grape-entity-matchers"
 
-  s.add_runtime_dependency 'grape-entity', '~> 0.4.6'
+  s.add_runtime_dependency 'grape-entity', '0.4.8'
   s.add_runtime_dependency 'rspec', '>= 3.2.0'
 
 

data/lib/grape_entity_matchers.rb

@@ -1,3 +1,4 @@
 require 'grape_entity_matchers/version'
 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

@@ -0,0 +1,104 @@
+module GrapeEntityMatchers
+  module DocumentMatcher
+    def document(documentable)
+      DocumentMatcher.new(documentable)
+    end
+
+    class DocumentMatcher
+      def initialize(documentable)
+        @expected_documentable = documentable
+      end
+
+      def description
+        "ensure that #{@subject} documents the #{@expected_documentable} exposure"
+      end
+
+      def matches?(subject)
+        @subject = subject
+
+        has_documentation? && verify_documentation
+      end
+
+      def type(type_value)
+        @type = type_value
+        self
+      end
+
+      def required(required_value)
+        @required = required_value
+        self
+      end
+
+      def desc(desc_value)
+        @desc = desc_value
+        self
+      end
+
+      def default(default_value)
+        @default = default_value
+        self
+      end
+
+      def values(values)
+        @values = values
+        self
+      end
+
+      def with(documentation)
+        @documentation = documentation
+        self
+      end
+
+      def failure_message
+        "#{@subject} didn't document #{@expected_documentable} "\
+        "as expected: #{expected_documentation}, got #{match_documentation}"
+      end
+
+      def failure_message_when_negated
+        message = "didn't expect #{@subject} to document #{@expected_documentable}"
+        message << " with: #{expected_documentation}" unless expected_documentation.empty?
+        message << ", got: #{actual_documentation}"
+      end
+
+      private
+
+      def expected_documentation
+        @documentation ||
+            {
+              type: @type,
+              desc: @desc,
+              required: @required,
+              default: @default,
+              values: @values
+            }.compact
+      end
+
+      def match_documentation
+        if has_documentation?
+          exposure[:documentation].slice(*expected_documentation.keys)
+        end
+      end
+
+      def actual_documentation
+        exposure.try(:[], :documentation)
+      end
+
+      def has_documentation?
+        @subject.exposures.has_key?(@expected_documentable) &&
+            exposure[:documentation]
+      end
+
+      def exposure
+        @subject.exposures[@expected_documentable]
+      end
+
+      def verify_documentation
+        if @documentation
+          @documentation == exposure[:documentation]
+        else
+          expected_documentation == match_documentation
+        end
+      end
+    end
+  end
+end

data/lib/grape_entity_matchers/represent_matcher.rb

@@ -13,7 +13,7 @@ module GrapeEntityMatchers
         @expected_representable = representable
         RSpec::Mocks::setup
       end
-      
+
       def matches?(subject)
         @subject = subject
 

data/lib/grape_entity_matchers/rspec_integration.rb

@@ -3,4 +3,6 @@ require 'rspec'
 RSpec.configure do |config|
   require 'grape_entity_matchers/represent_matcher'
   config.include GrapeEntityMatchers::RepresentMatcher
-end
+  require 'grape_entity_matchers/document_matcher'
+  config.include GrapeEntityMatchers::DocumentMatcher
+end

data/lib/grape_entity_matchers/version.rb

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

data/spec/grape_entity_matchers/document_matcher_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'grape_entity'
+
+describe GrapeEntityMatchers::DocumentMatcher do
+  let(:documentation) do
+    {
+      type: String,
+      desc: 'Some string',
+      default: 'xyz',
+      required: false,
+      values: ['abc', 'xyz']
+    }
+  end
+  before(:all) do
+    class TestEntity < Grape::Entity
+      expose :str, documentation: {
+        type: String,
+        desc: 'Some string',
+        default: 'xyz',
+        required: false,
+        values: ['abc', 'xyz']
+      }
+      expose :no_doc
+    end
+  end
+
+  subject(:entity) { TestEntity }
+
+  context "ensure that the exposure matches the documentation" do
+    it { is_expected.to document(:str).with(documentation) }
+  end
+
+  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.to document(:str).desc('Some string') }
+    it { is_expected.not_to document(:str).desc('Some other string') }
+
+    it { is_expected.to document(:str).default('xyz') }
+    it { is_expected.not_to document(:str).default('abc') }
+
+    it { is_expected.to document(:str).required(false) }
+    it { is_expected.not_to document(:str).required(true) }
+
+    it { is_expected.to document(:str).values(['abc', 'xyz']) }
+    it { is_expected.not_to document(:str).values(['foo', 'bar']) }
+  end
+
+  context "ensure a combination of keys of documentation" do
+    it { is_expected.to document(:str).type(String).desc('Some string') }
+  end
+
+  context "ensure that an exposure is not documented" do
+    it { is_expected.to_not document(:no_doc) }
+  end
+
+  context "ensure that a specific documentation is not used" do
+    it { is_expected.to_not document(:str).with(type: String, required: false) }
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity-matchers
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Mark Madsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2016-08-17 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.6
+        version: 0.4.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.6
+        version: 0.4.8
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,9 +114,11 @@ files:
 - grape-entity-matchers.gemspec
 - lib/grape-entity-matchers.rb
 - lib/grape_entity_matchers.rb
+- lib/grape_entity_matchers/document_matcher.rb
 - lib/grape_entity_matchers/represent_matcher.rb
 - lib/grape_entity_matchers/rspec_integration.rb
 - lib/grape_entity_matchers/version.rb
+- spec/grape_entity_matchers/document_matcher_spec.rb
 - spec/grape_entity_matchers/represent_matcher_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/agileanimal/grape-entity-matchers
@@ -144,6 +146,7 @@ signing_key:
 specification_version: 4
 summary: Shoulda-like matchers for Grape Entity.
 test_files:
+- spec/grape_entity_matchers/document_matcher_spec.rb
 - spec/grape_entity_matchers/represent_matcher_spec.rb
 - spec/spec_helper.rb
 has_rdoc: