jsonapi_rspec 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6f6a700c0770ee5ba9954b77fcc7818dce6274ae
-  data.tar.gz: cbd8512415d501c272add052d2b7ae9668ab5ca4
+SHA256:
+  metadata.gz: 91691a7bae77e856d4e74a25dd19c77b975db69236cef26c86b63a0c3784aa7e
+  data.tar.gz: 73a0e0e28874965a75a9656d7d96f164c3433c1301c067c081109e6c0ff29ee2
 SHA512:
-  metadata.gz: 2a59ac4bda91aa5f2ec4c41096779803f1266c9e9d509a22c977b9d2b39145957864da2b8b0a8fb2a3948de1e24654f7e12084da0bbd1803375af8d54a4e783d
-  data.tar.gz: 9ecc45dad3f2f86d63c992c8c8aff538125c8d9e1a3f2241b5bb740c78aee641c388f036c3fa466a7212d5d9b6a346f371f4cd6ee7afaad6f2a193ca142e2dbd
+  metadata.gz: 824688ffa37f0cde362c2bcc3ff17fb3f1186e4c770e723567855f7dc5f5d4802cc57aa1c41eee1b36e7d4336b06c725f20960038c533fbf6faedf6833cb5f65
+  data.tar.gz: 1aae4f5f3c127ff877566123e9f0a3cecf165390c0b508dfcca1c7d5fea2a39adef7eafd98ca344955d5a75ddfb36c3ad041c0919a5acbfb4caf912a7c4ccc91

data/.gitignore

@@ -9,3 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
+
+# Don't checking Gemfile.lock for Gems
+# https://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,246 @@
+require:
+  - rubocop-rspec
+  # - rubocop-factory_bot
+  # - rubocop-rails
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+
+  Include:
+    - '**/*.gemspec'
+    - '**/*.jbuilder'
+    - '**/*.rake'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Capfile'
+    - '**/Guardfile'
+    - '**/*.rb'
+  Exclude:
+    - 'Capfile'
+    - 'tmp/**/*'
+    - 'log/**/*'
+    - 'db/**/*'
+    - 'vendor/**/*'
+    - 'stubs/**/*'
+    - 'bin/**/*'
+    - 'node_modules/**/*'
+    - 'features/step_definitions/*'
+    - 'app/views/**/*.jbuilder'
+
+# Checks formatting of special comments
+Style/CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+
+########################################
+# Style Cops
+
+Style/Documentation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/MixinUsage:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+# String#format is private now
+Style/FormatString:
+  Enabled: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+########################################
+# Layout Cops
+
+Layout/LineLength:
+  Max: 110
+  Exclude:
+    - 'app/views/**/*'
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    association:
+      - has_many
+      - has_one
+    attribute_macros:
+      - attr_accessor
+      - attr_reader
+      - attr_writer
+    macros:
+      - validates
+      - validate
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+    - module_inclusion
+    - constants
+    - association
+    - public_attribute_macros
+    - public_delegate
+    - macros
+    - public_class_methods
+    - initializer
+    - public_methods
+    - protected_attribute_macros
+    - protected_methods
+    - private_attribute_macros
+    - private_delegate
+    - private_methods
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/HashAlignment:
+  Enabled: false
+  EnforcedColonStyle: key
+  EnforcedHashRocketStyle: table
+
+Layout/AssignmentIndentation:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+
+Layout/CaseIndentation:
+  Enabled: false
+
+Layout/ElseAlignment:
+  Enabled: false
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+########################################
+# Naming Cops
+
+Naming/FileName:
+  Enabled: false
+
+########################################
+# Security Cops
+
+Security/Eval:
+  Enabled: true
+
+########################################
+# Lint Cops
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+########################################
+# Metrics Cops
+
+# I don't care about the complexity for this simple gem
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+    - lib/tasks/**/*.rake
+    - config/routes.rb
+    - config/environments/*.rb
+
+########################################
+# Rspec Cops
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/IndexedLet:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+########################################
+# Bundler Cops
+
+Bundler/OrderedGems:
+  Enabled: false
+
+########################################
+# Gemspec Cops
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+  Include: ['**/*.gemspec']
+
+

data/.ruby-version

@@ -0,0 +1 @@
+3.1.3

data/CHANGELOG

@@ -0,0 +1,6 @@
+*0.2.3* (February 20, 2024)
+
+* Update gem for modern use
+* Fix rubocop issues
+
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,42 @@
+# Jsonapi Rspec Code of Conduct
+
+The Jsonapi Rspec project strongly values contributors from anywhere, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, age, religion, or nationality. As a result, the Jsonapi Rspec team has agreed to and enforces this code of conduct in order to provide a harassment-free experience for everyone who participates in the development of Jsonapi Rspec.
+
+### Summary
+
+Just Be Nice!!!
+
+Harassment in code and discussion or violation of physical boundaries is completely unacceptable anywhere in the Jsonapi Rspec codebase, issue trackers, chat rooms, mailing lists, meetups, and any other events. Violators will be warned and then blocked or banned by the core team at or before the 3rd violation.
+
+### In Detail
+
+Harassment includes offensive verbal comments related to level of experience, gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, age, religion, nationality, the use of sexualized language or imagery, deliberate intimidation, stalking, sustained disruption, and unwelcome sexual attention.
+
+Individuals asked to stop any harassing behavior are expected to comply immediately.
+
+Maintainers, including the core team, are also subject to the anti-harassment policy.
+
+If anyone engages in abusive, harassing, or otherwise unacceptable behavior, including maintainers, we may take appropriate action, up to and including warning the offender, deletion of comments, removal from the project’s codebase and communication systems, and escalation to GitHub support.
+
+If you are being harassed, notice that someone else is being harassed, or have any other concerns, please contact [Chris Blackburn](mailto:87a1779b@opayq.com).
+
+We expect everyone to follow these rules anywhere in the Jsonapi Rspec codebase, issue trackers, IRC channel, group chat, and mailing lists.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Finally, don't forget that it is human to make mistakes! We all do. Let’s work together to help each other, resolve issues, and learn from the mistakes that we will all inevitably make from time to time.
+
+### Thanks
+
+Thanks to the [JSConf Code of Conduct](http://jsconf.com/codeofconduct.html) and [Fedora Code of Conduct](http://fedoraproject.org/code-of-conduct) for inspiration and ideas.
+
+### License
+
+<p class="license" xmlns:dct="http://purl.org/dc/terms/" xmlns:vcard="http://www.w3.org/2001/vcard-rdf/3.0#">
+  To the extent possible under law, <a rel="dct:publisher" href="https://github.com/midwire/jsonapi_rspec">The Jsonapi Rspec Team</a> has waived all copyright and related or neighboring rights to the <span property="dct:title">Jsonapi Rspec Code of Conduct</span>. This work is published from the <span property="vcard:Country" datatype="dct:ISO3166" content="US" about="https://github.com/midwire/jsonapi_rspec">United States.</span>
+  <br>
+  <br>
+  <a rel="license" href="http://creativecommons.org/publicdomain/zero/1.0/">
+    <img src="http://i.creativecommons.org/p/zero/1.0/88x31.png" style="border-style: none;" alt="CC0">
+  </a>
+</p>

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+## How to contribute to jsonapi_rspec
+
+#### **Did you find a bug?**
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/midwire/jsonapi_rspec/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/midwire/jsonapi_rspec/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+#### **Did you write a patch that fixes a bug?**
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+* Before submitting, please read run [Rubocop](http://batsov.com/rubocop/) on your code. If your PR fails our Rubocop convensions defined in `.rubocop.yml`, it will likely be rejected on those grounds.
+
+* Ensure that you write RSpec tests that cover any new or modified code. PR's without spec coverage will likely be rejected.
+
+#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**
+
+Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Jsonapi Rspec will generally not be accepted.
+
+Thanks for any contributions!
+
+--Midwire

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/ISSUE_TEMPLATE.md

@@ -0,0 +1,9 @@
+### Expected Behavior
+
+### Actual Behavior
+
+### Steps to reproduce the problem
+
+---
+* Current Version:
+* Operating System:

data/{LICENSE.txt → LICENSE.md}

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+## The MIT License (MIT)
 
-Copyright (c) 2017 Chris Blackburn
+##### Copyright (c) 2017 Midwire Technologies, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -12,10 +12,10 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+**_THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE._**

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+- [ ] I wrote specs to cover new or modified code in this PR
+- [ ] I ran `rake spec` locally and ALL specs pass
+
+Related Issue: # <please-add-issue-number-here>
+Description: <please-add-a-comprehensive-description-of-fix/feature>

data/README.md

@@ -28,19 +28,36 @@ And then execute:
 In your controller specs:
 
 ```ruby
-my_model = MyModel.create(...)
-get :show, params: { id: my_model.id }
-expect(response).to be_jsonapi_response_for(my_model)
+describe 'GET index' do
+  before do
+    get :index
+  end
+
+  it 'returns a json:api response' do
+    expect(response).to be_jsonapi_response
+  end
+end
+```
+
+```ruby
+describe 'POST create' do
+  context 'with valid content data' do
+    it 'responds with valid json' do
+      post :create, params: valid_params
+      expect(response).to be_jsonapi_response_for(Content.last)
+    end
+  end
+end
 ```
 
-It currently tests for required json:api sections and matching attributes for the passed model instance.
+It currently tests for compliant json:api sections and matching attributes for the passed model instance.
 ```
 {
-  "jsonapi": "version 1.1",   // does not check
-  "data":{                    // checks if exists and is a hash
-    "id":"123",               // checks if this matches the object.id
-    "type":"tags",     // checks if exists and is the matching type for object
-    "attributes":{     // checks each attrib. against object attributes
+  "jsonapi": "version 1.1", // does not check
+  "data":{                  // checks if exists and is a hash
+    "id":"123",             // checks if this matches the object.id
+    "type":"tags",          // checks if exists and is the matching type for object
+    "attributes":{          // checks each attr. against object attributes
       "string_attribute":"Category",
       "datetime_attribute":"2017-10-13T19:33:54+00:00",
       "time_attribute":"2017-10-14 17:12:45 -0500",
@@ -50,12 +67,12 @@ It currently tests for required json:api sections and matching attributes for th
       "fixnum_attribute":11,
       "float_attribute":11.11,
       "bignum_attribute":9999999999999999999999999999999,
-      "links":{                // does not check
+      "links":{             // does not check
         "self":"http://test.host/api/v1/tag_types.123"
       }
     }
   },
-  "included": [{               // does not check
+  "included": [{            // does not check
     "type": "users",
     "id": 9,
     "attributes": {
@@ -67,26 +84,30 @@ It currently tests for required json:api sections and matching attributes for th
       "self": "http://example.com/users/9"
     }
   }],
-  "meta":{  // does not check for existance by default
-    "copyright":"Copyright 2017 Chris Blackburn", // required if meta tag exists
-    "version":"v1"  // required if meta tag exists
+  "meta":{                  // checks are configurable
+    "copyright":"Copyright 2017 Chris Blackburn",
+    "version":"v1"
   }
 }
 ```
 
+### Checks
+
+* Empty response - `response.empty?`
+* Nil response - `response.nil?`
+* Error response - catches if the response is an error when expecting a matching object response.
+* Missing a required top level section - must include 'data', 'errors' or 'meta'
+* Conflicting top level section - 'included' is invalid without a 'data' section
+* Unexpected top level key - catches invalid top level keys
+* Invalid data section - 'data' section must be an Array (collection) or Hash (single-object)
+* Data type mismatch - 'data:type' doesn't match the object type
+* Object ID mismatch - 'data:id' doesn't match the object ID
+* Missing meta - if configured (see Configuration below) reports missing 'meta' section
+* Validates data attributes - checks for matching data attributes including their variable types. For example if an Integer is expected, a String fails.
+
 ### Possible Failure Messages
 
-* "Attribute: :#{attr_name} with a value of '#{json_val}'(#{json_val.class.name}) does not match object: '#{obj_val}'(#{obj_val.class.name})
-* "Expected '#{value}' to match object id: '#{object_id}'"
-* "Expected data:type '#{data_type}' to match: '#{object_type}'"
-* "Fix 'match_attribute?' method to handle: '#{obj_val_class_name}'" - [please file an issue](https://github.com/midwire/jsonapi_rspec/issues/new) if you get this one.
-* "The 'data' section is missing or invalid"
-* "The 'meta' section is missing or invalid"
-* "The 'meta:copyright' is missing or invalid - regex: '/^Copyright.+\\d{4}/'"
-* "The 'meta:version' is missing"
-* "Unexpected key in response: '#{key}'"
-* 'Expected response to match an object instance but it is an empty string'
-* 'Response is an error'
+[See failure_messages.rb](https://github.com/midwire/jsonapi_rspec/blob/develop/lib/jsonapi_rspec/failure_messages.rb).
 
 [See the specs](https://github.com/midwire/jsonapi_rspec/blob/develop/spec/lib/jsonapi_rspec/be_json_api_response_for_spec.rb) for more details.
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'

data/SUPPORT.md

@@ -0,0 +1,6 @@
+# Jsonapi Rspec Support
+
+As noted in our [license](LICENSE.md), jsonapi_rspec is provided "as is", without any kind of warranty.
+
+Having said that, we desire to support jsonapi_rspec as well as possible given current and ongoing professional commitments. If you experience any kind of bug or issue that is blocking your workflow, please [file an Issue](https://github.com/midwire/jsonapi_rspec/issues/new) on GitHub.
+

data/jsonapi_rspec.gemspec

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jsonapi_rspec/version'
 
@@ -7,27 +8,30 @@ Gem::Specification.new do |spec|
   spec.name          = 'jsonapi_rspec'
   spec.version       = JsonapiRspec::VERSION
   spec.authors       = ['Chris Blackburn']
-  spec.email         = ['chris@midwiretech.com']
+  spec.email         = ['bogus@example.com']
 
   spec.summary       = 'Provides RSpec matchers for json:api related specs'
   spec.description   = spec.summary
   spec.homepage      = 'https://github.com/midwire/jsonapi_rspec'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.required_ruby_version = Gem::Requirement.new(">= #{Bundler.root.join('.ruby-version').read.strip}")
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.15.4'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'midwire_common'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'midwire_common', '~> 0.1'
 
   spec.add_dependency 'activesupport', '>= 4.2.8'
 end

data/lib/jsonapi_rspec/be_json_api_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/matchers'
 
 require_relative 'string'
@@ -24,9 +26,7 @@ class BeJsonApiResponse
     return false unless required_top_level_sections?
     return false if conflicting_sections?
 
-    if JsonapiRspec.configuration.meta_required
-      return false unless valid_meta_section?
-    end
+    return false if JsonapiRspec.configuration.meta_required && !valid_meta_section?
 
     @parsed_response.each_key do |key|
       case key.to_sym
@@ -41,7 +41,7 @@ class BeJsonApiResponse
       when :links
         next # TODO: handle links objects
       else
-        return set_failure_message(FailureMessages::UNEXPECTED_TOP_LVL_KEY % key)
+        return failure_message(FailureMessages::UNEXPECTED_TOP_LVL_KEY % key)
       end
     end
 
@@ -56,7 +56,7 @@ class BeJsonApiResponse
   #
   # @return [Boolean] always returns false
   #
-  def set_failure_message(msg)
+  def failure_message(msg)
     @failure_message = "#{FailureMessages::GENERAL_PREFIX} #{msg}"
     false
   end

data/lib/jsonapi_rspec/be_json_api_response_for.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/matchers'
 require 'active_support/all'
 
@@ -18,11 +20,27 @@ require_relative 'string'
 class BeJsonApiResponseFor
   include JsonapiRspec
 
+  # Initialize an instance of the BeJsonApiResponseFor class
+  #
+  # @param [Object] object_instance Any instantiated object that responds to the
+  #   attribute-related method calls passed in by the json:api
+  # @param [String] plural_form Sometimes the ActiveSupport::Inflector has
+  #   problems with pluralizing certain strings. This allows setting of the
+  #   plural form directly. It should be the lowercase, dasherized plural form of the
+  #   passed object_instance.
+  #
   def initialize(object_instance, plural_form = nil)
     @object_instance = object_instance
     @plural_form = plural_form
   end
 
+  # Gets called by RSpec or by the camel_cased syntactical method below.
+  #
+  # @param [Rack::Response] response A type of Rack::Response or any object that
+  #   responds to the :body method.
+  #
+  # @return [Boolean] true if it matches, false if not
+  #
   def matches?(response)
     return false unless valid_response?(response)
 
@@ -30,9 +48,8 @@ class BeJsonApiResponseFor
 
     return false if response_is_error?
     return false unless valid_data_section?
-    if JsonapiRspec.configuration.meta_required
-      return false unless valid_meta_section?
-    end
+
+    return false if JsonapiRspec.configuration.meta_required && !valid_meta_section?
 
     @parsed_response.each do |key, value|
       case key.to_sym
@@ -47,7 +64,7 @@ class BeJsonApiResponseFor
       when :links
         next # TODO: handle links objects
       else
-        return set_failure_message(FailureMessages::UNEXPECTED_TOP_LVL_KEY % key)
+        return failure_message(FailureMessages::UNEXPECTED_TOP_LVL_KEY % key)
       end
     end
 
@@ -62,39 +79,54 @@ class BeJsonApiResponseFor
   #
   # @return [Boolean] always returns false
   #
-  def set_failure_message(msg)
+  def failure_message(msg)
     @failure_message = "#{FailureMessages::OBJECT_PREFIX} #{msg}"
     false
   end
 
+  # Check the json:api data:type against the plural form of the passed
+  # object instance.
+  #
+  # @param [String] data_type The json:api data:type.
+  #
+  # @return [Boolean] True if matches, false if not
+  #
   def valid_type?(data_type)
     object_type = @plural_form ||
-                  @object_instance.class.name.pluralize.underscore.dasherize
+        @object_instance.class.name.pluralize.underscore.dasherize
     unless data_type == object_type
-      return set_failure_message(
+      return failure_message(
         format(FailureMessages::DATA_TYPE_MISMATCH, data_type, object_type)
       )
     end
     true
   end
 
+  # Match an object's attribute value to the json:api value
+  #
+  # @param [String] attr_name A String or Symbol of the object's attribute
+  # @param [String] json_val Typically a String but could be any value type
+  #   that is legal JSON
+  #
+  # @return [Boolean] true if the values match, false if not
+  #
   def match_attribute?(attr_name, json_val)
     obj_val = @object_instance.send(attr_name.to_sym)
     obj_val_class_name = obj_val.class.name
 
-    case obj_val_class_name
+    matched = case obj_val_class_name
     when 'Float'
-      matched = obj_val == json_val.to_f
+      obj_val == json_val.to_f
     when 'DateTime'
-      matched = obj_val.to_i == DateTime.parse(json_val).to_i
+      obj_val.to_i == DateTime.parse(json_val).to_i
     when 'Time'
-      matched = obj_val.to_i == Time.parse(json_val).to_i
+      obj_val.to_i == Time.parse(json_val).to_i
     else
-      matched = obj_val == json_val
+      obj_val == json_val
     end
 
     unless matched
-      return set_failure_message(
+      return failure_message(
         <<-STRING.here_with_pipe!(' ')
           |Attribute: :#{attr_name}
           |with a value of '#{json_val}'(#{json_val.class.name})
@@ -105,13 +137,19 @@ class BeJsonApiResponseFor
     true
   end
 
+  # Match the jsonapi values to the object instance.
+  #
+  # @param [Hash] values A Ruby Hash of parsed jsonapi values
+  #
+  # @return [Boolean] True if match, false if not.
+  #
   def match_object?(values)
     values.each do |key, value|
       case key.to_sym
       when :id
         object_id = @object_instance.send(key)
         unless object_id == value.to_i
-          return set_failure_message(
+          return failure_message(
             format(FailureMessages::OBJECT_ID_MISMATCH, value, object_id)
           )
         end
@@ -134,6 +172,8 @@ class BeJsonApiResponseFor
   end
 end
 
+# This is the syntactic sugar matcher method.
+#
 # Usage:
 #   expect(response).to be_jsonapi_response_for(object_instance)
 #

data/lib/jsonapi_rspec/configuration.rb

@@ -1,9 +1,16 @@
+# frozen_string_literal: true
+
 module JsonapiRspec
+  # Class Configuration provides a config object for certain options
+  #
+  # @author Chris Blackburn <87a1779b@opayq.com>
+  #
   class Configuration
-    attr_accessor :meta_required
+    attr_accessor :meta_required, :required_meta_sections
 
     def initialize
       @meta_required = false
+      @required_meta_sections = [] # :copyright, :version, etc.
     end
   end
 end

data/lib/jsonapi_rspec/failure_messages.rb

@@ -1,16 +1,22 @@
+# frozen_string_literal: true
+
+# Module FailureMessages provides a list of defined failure messages.
+#
+# @author Chris Blackburn <87a1779b@opayq.com>
+#
 module FailureMessages
-  GENERAL_PREFIX = 'Expected a json:api compliant success response but'.freeze
-  OBJECT_PREFIX = 'Expected a json:api response for an object instance but'.freeze
+  GENERAL_PREFIX = 'Expected a json:api compliant success response but'
+  OBJECT_PREFIX = 'Expected a json:api response for an object instance but'
 
-  ERROR = 'it is an error'.freeze
-  EMPTY = 'it is empty'.freeze
-  NIL   = 'it is nil'.freeze
+  ERROR = 'it is an error'
+  EMPTY = 'it is empty'
+  NIL   = 'it is nil'
 
-  MISSING_REQ_TOP_LVL    = 'it is missing a required top-level section'.freeze
-  CONFLICTING_TOP_LVL    = "it cannot contain 'included' without a 'data' section".freeze
-  UNEXPECTED_TOP_LVL_KEY = "it has an unexpected key: '%s'".freeze
-  INVALID_DATA_SECTION   = "the 'data' section must be a Hash or an Array".freeze
-  DATA_TYPE_MISMATCH     = "data:type '%s' doesn't match: '%s'".freeze
-  OBJECT_ID_MISMATCH     = "data:id '%s' doesn't match object id: '%s'".freeze
-  MISSING_META           = "the 'meta' section is missing or invalid".freeze
+  MISSING_REQ_TOP_LVL    = 'it is missing a required top-level section'
+  CONFLICTING_TOP_LVL    = "it cannot contain 'included' without a 'data' section"
+  UNEXPECTED_TOP_LVL_KEY = "it has an unexpected key: '%s'"
+  INVALID_DATA_SECTION   = "the 'data' section must be a Hash or an Array"
+  DATA_TYPE_MISMATCH     = "data:type '%s' doesn't match: '%s'"
+  OBJECT_ID_MISMATCH     = "data:id '%s' doesn't match object id: '%s'"
+  MISSING_META           = "the 'meta' section is missing or invalid"
 end

data/lib/jsonapi_rspec/string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class String
   # Helper for the heredoc functionality. Allows pipe '|' delimeted heredocs
   # with a parameterized delimeter.

data/lib/jsonapi_rspec/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JsonapiRspec
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.3'.freeze
 end

data/lib/jsonapi_rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jsonapi_rspec/version'
 require 'jsonapi_rspec/failure_messages'
 require 'jsonapi_rspec/be_json_api_response'
@@ -17,6 +19,10 @@ module JsonapiRspec
     end
   end
 
+  # Called by RSpec when an the json:api response doesn't match the object instance
+  #
+  # @return [String] The failure message to display in the RSpec output
+  #
   def failure_message
     "#{@failure_message} - parsed response: #{pretty_response}"
   end
@@ -28,54 +34,84 @@ module JsonapiRspec
 
   private
 
+  # Generate a nicely formatted version of the json:api response for output
+  #
+  # @return [String] Formatted JSON
+  #
   def pretty_response
     JSON.pretty_generate(@parsed_response)
   rescue JSON::GeneratorError
     @parsed_response.to_s
   end
 
+  # Determine if the passed response is empty or nil.
+  #
+  # @param [Rack::Response] response Any object that responds to the :body method
+  #
+  # @return [Boolean] True if valid, false if not
+  #
   def valid_response?(response)
     return set_failure_message(FailureMessages::EMPTY) if response.body == ''
     return set_failure_message(FailureMessages::NIL) if response.body.nil?
+
     true
   end
 
+  # Determine if the json:api response contains the required top-level sections.
+  #
+  # @return [Boolean] True if the required sections exist, false if not
+  #
   def required_top_level_sections?
-    valid = @parsed_response.dig('data') || @parsed_response.dig('errors') || @parsed_response.dig('meta')
+    valid = @parsed_response['data'] || @parsed_response['errors'] || @parsed_response['meta']
     return set_failure_message(FailureMessages::MISSING_REQ_TOP_LVL) unless valid
+
     true
   end
 
+  # Determine if the json:api response contains conflicting top-level sections
+  #
+  # @return [Boolean] True if the response has an 'included' section but no 'data', false if not
+  #
   def conflicting_sections?
     conflicting = false
-    if @parsed_response.dig('included')
-      # must have a data section
-      if @parsed_response.dig('data').nil?
-        conflicting = true
-        set_failure_message(FailureMessages::CONFLICTING_TOP_LVL)
-      end
+    # must have a data section
+    if @parsed_response['included'] && @parsed_response['data'].nil?
+      conflicting = true
+      set_failure_message(FailureMessages::CONFLICTING_TOP_LVL)
     end
     conflicting
   end
 
+  # Check the json:api response for a 'meta' section. This is configurable.
+  #
+  # @return [Boolean] True if the meta section exists and is a Hash, false if not
+  #
   def valid_meta_section?
-    meta = @parsed_response.dig('meta')
+    meta = @parsed_response['meta']
     return set_failure_message(FailureMessages::MISSING_META) unless meta.is_a?(Hash)
+
     true
   end
 
+  # Determine if the json:api response is an error response.
+  #
+  # @return [Boolean] True if the response is an error response, false if not
+  #
   def response_is_error?
-    is_error = !@parsed_response.dig('errors').nil?
+    is_error = !@parsed_response['errors'].nil?
     set_failure_message(FailureMessages::ERROR) if is_error
     is_error
   end
 
+  # Determine if the json:api response contains a valid 'data' section.
+  #
+  # @return [Boolean] True if the section exists and is value, false if not.
+  #
   def valid_data_section?
-    data_section = @parsed_response.dig('data')
+    data_section = @parsed_response['data']
     valid = data_section.is_a?(Hash) || data_section.is_a?(Array)
-    unless valid
-      return set_failure_message(FailureMessages::INVALID_DATA_SECTION)
-    end
+    return set_failure_message(FailureMessages::INVALID_DATA_SECTION) unless valid
+
     true
   end
 

metadata

@@ -1,73 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Chris Blackburn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: midwire_common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-nav
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: midwire_common
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -124,19 +124,26 @@ dependencies:
         version: 4.2.8
 description: Provides RSpec matchers for json:api related specs
 email:
-- chris@midwiretech.com
+- bogus@example.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
+- CHANGELOG
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
-- LICENSE.txt
+- ISSUE_TEMPLATE.md
+- LICENSE.md
+- PULL_REQUEST_TEMPLATE.md
 - README.md
 - Rakefile
+- SUPPORT.md
 - bin/console
 - bin/setup
 - jsonapi_rspec.gemspec
@@ -150,7 +157,8 @@ files:
 homepage: https://github.com/midwire/jsonapi_rspec
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -159,15 +167,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Provides RSpec matchers for json:api related specs

data/Gemfile.lock

@@ -1,71 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jsonapi_rspec (0.2.2)
-      activesupport (>= 4.2.8)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.1.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    coderay (1.1.2)
-    concurrent-ruby (1.0.5)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    i18n (0.8.6)
-    json (2.1.0)
-    method_source (0.8.2)
-    midwire_common (0.3.0)
-      thor (~> 0.19)
-    minitest (5.10.3)
-    pry (0.10.4)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-nav (0.2.4)
-      pry (>= 0.9.10, < 0.11.0)
-    rack (2.0.3)
-    rake (10.5.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    slop (3.6.0)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.3)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.15.4)
-  jsonapi_rspec!
-  midwire_common (~> 0.1)
-  pry-nav (~> 0.2.4)
-  rack
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  simplecov
-
-BUNDLED WITH
-   1.16.0.pre.3