rspec-json_api 1.5.0 → 2.0.0

data/lib/rspec/json_api/matchers/match_json_schema.rb

@@ -24,6 +24,11 @@ module RSpec
         # @return [Boolean] true if the actual JSON matches the expected schema, false otherwise.
         def matches?(actual)
           @diff = nil
+          @actual = actual
+          @type_error = !actual.is_a?(String)
+
+          return false if @type_error
+
           @actual = JSON.parse(actual, symbolize_names: true)
 
           RSpec::JsonApi::SchemaMatch.match(@actual, expected)
@@ -32,9 +37,23 @@ module RSpec
           false
         end
 
+        # A non-String actual is a mistake in the spec rather than a fact about the
+        # response, so the negated form has to fail rather than pass by default.
+        # @param actual [String] The JSON string to test against the expected schema.
+        # @return [Boolean] true if the actual JSON does not match the expected schema.
+        def does_not_match?(actual)
+          !matches?(actual) && !@type_error
+        end
+
+        def description
+          "match JSON schema"
+        end
+
         # Provides a failure message for when the JSON data does not match the expected schema.
         # @return [String] A descriptive message detailing the mismatch between expected and actual JSON.
         def failure_message
+          return type_error_message if @type_error
+
           <<~MSG
             expected: #{expected}
                  got: #{actual}
@@ -46,8 +65,10 @@ module RSpec
 
         # Provides a failure message for when the JSON data matches the expected schema, but it was expected not to.
         # This is used in negative matchers.
-        # @return [self] Returns itself, but typically this method should be implemented to return a descriptive message
+        # @return [String] A descriptive message indicating the JSON was expected not to match the schema.
         def failure_message_when_negated
+          return type_error_message if @type_error
+
           "expected the JSON data not to match the provided schema, but it did."
         end
 
@@ -58,6 +79,10 @@ module RSpec
         def diff
           @diff ||= Diffy::Diff.new(expected, actual, context: 5)
         end
+
+        def type_error_message
+          "expected a JSON String to match against the schema, got #{actual.class}"
+        end
       end
     end
   end

data/lib/rspec/json_api/schema_match.rb

@@ -10,30 +10,28 @@ module RSpec
     module SchemaMatch
       module_function
 
-      # Top-level comparison. Applies the shape guards (class equality and, for
-      # objects, key-set equality) before recursing.
+      # Top-level comparison. Applies shape guards to objects and collections,
+      # then uses the same value dispatch as nested schema values.
       def match(actual, expected)
-        return false unless actual.instance_of?(expected.class)
-
         case expected
         when Array
           compare_array(actual, expected)
         when Hash
+          return false unless actual.is_a?(Hash)
           return false unless same_key_structure?(actual, expected)
 
           compare(actual, expected)
         else
-          compare_simple_value(actual, expected)
+          compare_values(actual, expected)
         end
       end
 
       def same_key_structure?(actual, expected)
-        Traversal.deep_sort(Traversal.deep_keys(actual)) ==
-          Traversal.deep_sort(Traversal.deep_keys(expected))
+        Traversal.same_key_structure?(actual, expected)
       end
 
       def compare(actual, expected)
-        return false if actual.blank? && expected.present?
+        return false unless actual.is_a?(Hash)
 
         keys = Traversal.deep_key_paths(expected) | Traversal.deep_key_paths(actual)
 
@@ -76,14 +74,40 @@ module RSpec
       end
 
       def compare_regexp(actual_value, expected_value)
-        expected_value.match?(actual_value.to_s)
+        actual_value.is_a?(String) && expected_value.match?(actual_value)
       end
 
+      # A schema Proc describes the constraints for a value; it is called without
+      # arguments and must return the option Hash. A Proc that expects the value
+      # as an argument is a common misreading of the DSL, and calling it here
+      # would raise a bare "wrong number of arguments" from deep in the matcher.
       def compare_proc(actual_value, expected_value)
-        Constraints.match(actual_value, expected_value.call)
+        if declares_value_parameter?(expected_value)
+          raise ArgumentError,
+                "schema Proc must take no arguments; " \
+                "write -> { { lambda: ->(value) { ... } } } to test the value itself"
+        end
+
+        options = expected_value.call
+        raise ArgumentError, "schema Proc must return an options Hash, got #{options.class}" unless options.is_a?(Hash)
+
+        Constraints.match(actual_value, options)
       end
 
+      # A non-lambda Proc reports its block parameters as optional, so
+      # `proc { |value| ... }` has to be caught on the parameter list rather
+      # than on arity. A bare splat states no expectation and is left alone.
+      def declares_value_parameter?(callable)
+        callable.parameters.any? { |type, _name| %i[req opt keyreq].include?(type) }
+      end
+
+      # A list schema only ever matches an actual Array. Without this guard the
+      # branches below call Array methods on whatever the response contained, so
+      # a null or a scalar where a list was expected raised NoMethodError
+      # instead of failing the match.
       def compare_array(actual_value, expected_value)
+        return false unless actual_value.is_a?(Array)
+
         if simple_type?(expected_value)
           compare_typed_array(actual_value, expected_value)
         elsif interface?(expected_value)
@@ -112,10 +136,10 @@ module RSpec
 
       # Any other array => element-by-element match, sizes must be equal.
       def compare_exact_array(actual_value, expected_value)
-        return false if actual_value&.size != expected_value&.size
+        return false if actual_value.size != expected_value.size
 
         expected_value.each_with_index.all? do |elem, index|
-          elem.is_a?(Hash) ? compare(actual_value[index], elem) : compare_simple_value(actual_value[index], elem)
+          elem.is_a?(Hash) ? match(actual_value[index], elem) : compare_values(actual_value[index], elem)
         end
       end
 

data/lib/rspec/json_api/traversal.rb

@@ -44,6 +44,22 @@ module RSpec
           .map { |element| element.is_a?(Array) ? deep_sort(element) : element }
           .sort_by { |element| element.is_a?(Array) ? element.first.to_s : element.to_s }
       end
+
+      # Whether two hashes have the same keys under the same parent objects.
+      def same_key_structure?(actual, expected)
+        same_keys?(actual, expected) && actual.all? do |key, actual_value|
+          same_nested_key_structure?(actual_value, expected[key])
+        end
+      end
+
+      def same_keys?(actual, expected)
+        actual.size == expected.size && actual.each_key.all? { |key| expected.key?(key) }
+      end
+
+      def same_nested_key_structure?(actual, expected)
+        nested = actual.is_a?(Hash) || expected.is_a?(Hash)
+        !nested || (actual.is_a?(Hash) && expected.is_a?(Hash) && same_key_structure?(actual, expected))
+      end
     end
   end
 end

data/lib/rspec/json_api/types/uri.rb

@@ -3,7 +3,11 @@
 module RSpec
   module JsonApi
     module Types
-      URI = URI::DEFAULT_PARSER.make_regexp
+      # URI::DEFAULT_PARSER.make_regexp is unanchored, and comparison uses
+      # Regexp#match?, so on its own it accepts any string that merely contains
+      # a URI ("see https://example.com for details"). \A...\z holds the whole
+      # value to the pattern, the same way EMAIL and UUID already are anchored.
+      URI = /\A#{::URI::DEFAULT_PARSER.make_regexp}\z/
     end
   end
 end

data/lib/rspec/json_api/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module JsonApi
-    VERSION = "1.5.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/rspec/json_api.rb

@@ -4,10 +4,11 @@
 require "json"
 require "uri"
 require "diffy"
-require "active_support/core_ext/object/blank"
+require "rspec/expectations"
 
 # Load the json_api parts
 require "rspec/json_api/version"
+require "rspec/json_api/blank"
 require "rspec/json_api/traversal"
 require "rspec/json_api/constraints"
 require "rspec/json_api/schema_match"

metadata

@@ -1,28 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-json_api
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Michal Gajowiak
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.4.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.4.1
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
@@ -38,67 +24,38 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.4.2
 - !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.4.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.4.1
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: '3.0'
 email:
 - m.gajowiak@nomtek.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitattributes"
-- ".github/workflows/main.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
+- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- gemfiles/rails_6_1.gemfile
-- gemfiles/rails_7_1.gemfile
-- gemfiles/rails_7_2.gemfile
-- gemfiles/rails_8_0.gemfile
-- gemfiles/rails_8_1.gemfile
+- SECURITY.md
 - lib/generators/rspec/json_api/install/install_generator.rb
 - lib/generators/rspec/json_api/install/templates/rspec/json_api/interfaces/.empty_directory
 - lib/generators/rspec/json_api/install/templates/rspec/json_api/types/.empty_directory
 - lib/generators/rspec/json_api/interface/interface_generator.rb
 - lib/generators/rspec/json_api/type/type_generator.rb
 - lib/rspec/json_api.rb
+- lib/rspec/json_api/blank.rb
 - lib/rspec/json_api/constraints.rb
-- lib/rspec/json_api/interfaces/example_interface.rb
 - lib/rspec/json_api/matchers.rb
 - lib/rspec/json_api/matchers/have_no_content.rb
 - lib/rspec/json_api/matchers/match_json_schema.rb
@@ -108,7 +65,6 @@ files:
 - lib/rspec/json_api/types/uri.rb
 - lib/rspec/json_api/types/uuid.rb
 - lib/rspec/json_api/version.rb
-- rspec-json_api.gemspec
 homepage: https://github.com/nomtek/rspec-json_api
 licenses:
 - MIT
@@ -131,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.6.9
 specification_version: 4
 summary: RSpec extension to test JSON API response.
 test_files: []

data/.gitattributes

@@ -1,28 +0,0 @@
-# Set default line ending behavior for all files
-* text=lf
-
-# Explicitly declare text files you want to always be normalized and converted
-# to native line endings on checkout.
-*.rb text=lf
-*.rake text=lf
-*.gemspec text=lf
-Gemfile text=lf
-Gemfile.lock text=lf
-Rakefile text=lf
-*.md text=lf
-*.yml text=lf
-*.yaml text=lf
-*.json text=lf
-*.txt text=lf
-*.sh text=lf
-
-# Denote all files that are truly binary and should not be modified.
-*.png binary
-*.jpg binary
-*.jpeg binary
-*.gif binary
-*.ico binary
-*.pdf binary
-*.zip binary
-*.tar binary
-*.gz binary

data/.github/workflows/main.yml

@@ -1,45 +0,0 @@
-name: Ruby
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    name: "rspec — Ruby ${{ matrix.ruby }} / ${{ matrix.gemfile }}"
-    strategy:
-      fail-fast: false
-      matrix:
-        # Covers the supported range from the floor (Ruby 3.2 / Rails 6.1) to
-        # the current ceiling (Ruby 3.4 / Rails 8.1). Curated pairs avoid
-        # Ruby/Rails combinations that are not mutually supported.
-        include:
-          - { ruby: "3.2", gemfile: rails_6_1 }
-          - { ruby: "3.2", gemfile: rails_7_1 }
-          - { ruby: "3.3", gemfile: rails_7_2 }
-          - { ruby: "3.3", gemfile: rails_8_0 }
-          - { ruby: "3.4", gemfile: rails_8_0 }
-          - { ruby: "3.4", gemfile: rails_8_1 }
-    env:
-      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - name: Run rspec
-        run: bundle exec rspec
-
-  lint:
-    runs-on: ubuntu-latest
-    name: rubocop
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.2"
-          bundler-cache: true
-      - name: Run rubocop
-        run: bundle exec rubocop

data/.gitignore

@@ -1,17 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# built gem files
-*.gem
-
-# per-appraisal lockfiles (resolved fresh in CI)
-gemfiles/*.gemfile.lock

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,41 +0,0 @@
-# Append to (rather than replace) RuboCop's default AllCops/Exclude, so the
-# defaults such as vendor/**/* stay excluded. Without this, CI installs gems
-# into vendor/bundle (bundler-cache) and RuboCop would lint third-party gems.
-inherit_mode:
-  merge:
-    - Exclude
-
-AllCops:
-  TargetRubyVersion: 3.2
-  NewCops: enable
-  SuggestExtensions: false
-  Exclude:
-    - "README.md"
-    - "vendor/**/*"
-    - "gemfiles/vendor/**/*"
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
-
-Metrics/BlockLength:
-  Exclude:
-    - "spec/**/*_spec.rb"
-
-Style/Documentation:
-  Enabled: false
-
-Naming/PredicatePrefix:
-  Exclude:
-    - "lib/rspec/json_api/matchers.rb"
-
-Naming/PredicateMethod:
-  Exclude:
-    - "lib/rspec/json_api/schema_match.rb"

data/.ruby-version

@@ -1 +0,0 @@
-3.2.2

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at m.gajowiak@nomtek.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-# Bundler version: 4.0.4 (see Gemfile.lock BUNDLED WITH section)
-source "https://rubygems.org"
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-# Specify your gem's dependencies in rspec-json_api.gemspec
-gemspec
-
-gem "activesupport", ">= 6.1.4.1"
-gem "diffy", "~> 3.4"
-gem "rake", "~> 13.2"
-gem "rspec-rails", ">= 5.0.2"
-gem "rubocop", "~> 1.65"