rspec-rails-api 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06e9bc31ff4e310ca952011e76cc3fb6dcc39b15ea090229edb1385b51ed16f6
-  data.tar.gz: 8be9cba238ce37496e2e7eb2db221754cde5c673b1e404541ea84e71095e6ccb
+  metadata.gz: 232e1ea8b43dd1e3b5258f0029d28a54d886156634e87d4a6854a3543752fb0f
+  data.tar.gz: 71828ab75d08ff900cbe9f018af219bc79b98231118712d127e35c274690d7ad
 SHA512:
-  metadata.gz: 5a9058a1121e702991d55696687b64cb8d2bb3872596b4d92f79aa33de8ef54a5b9ef33d2275f92087256cd6d7afcd1fc16472157d52529e19a97b5b66118b70
-  data.tar.gz: 85777059873dd5fba1842ce286c0c0c4c445aa2dad584a2992b2add593de51cb267e1b398dd6038fe71f5ec36bfa38bf8f03fa4ce0877d0438ae62f4f58fb82f
+  metadata.gz: dbb37718158f52e0a2056bbe9b8ccde44782cafe915cc146f05333532484b10ae8260e7abbd3f571e657c778b8d8ac37c731adfa452d3e94af253dcf6849aede
+  data.tar.gz: 731f623490f7e15b3f0acb8851955835083249b60e62f722ab9870c6658d3e690ed0b6aca8ac4edcdc3f6b1c892517511937d190459b8020fcb2b3c2ef99047a

data/.gitignore

@@ -10,9 +10,4 @@
 # rspec failure tracking
 .rspec_status
 
-# Ignore lockfile for Gemfile
-Gemfile.lock
-# Keep the dummy one
-!dummy/Gemfile.lock
-
 .byebug_history

data/.gitlab-ci.yml

@@ -1,5 +1,5 @@
 ---
-image: ruby:2.5
+image: ruby:2.7
 
 stages:
   - prepare

data/.rubocop.yml

@@ -1,9 +1,11 @@
 ---
 require:
   - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   Exclude:
     - dummy/**/*
     - vendor/bundle/**/*
@@ -33,3 +35,5 @@ Style/TrailingCommaInArrayLiteral:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
+RSpec/NestedGroups:
+  Max: 4

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/CHANGELOG.md

@@ -3,6 +3,15 @@ All notable changes to this project will be documented in this file.
 
 ## Not released
 
+## 0.5.0 - 2023-01-02
+
+- Improved error messages
+- Improved usage of primitive types: use `:string` instead of `:type_string`, and  more generally, remove the `type_`
+  prefix
+- Fixed an error when an object is defined with an attribute named `type`.
+
+## 0.4.0 - 2021-12-19
+
 - All parameters attributes are considered required unless specified
 - Fix object `attributes` key in spec and documentation.
   When defining object attributes, documentation and tests used `properties` key

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    rspec-rails-api (0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rack (3.0.3)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.16.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport (~> 6.0)
+  bundler
+  byebug
+  rack
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-rails-api!
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  simplecov
+  yard
+
+BUNDLED WITH
+   2.4.1

data/README.md

@@ -263,12 +263,12 @@ inline.
 Both `:of` and `attributes` may be a hash of fields or a symbol. If they
 are omitted, they will be documented, but responses won't be validated.
 
-Arrays of primitives are supported; the type should be prefixed by `type_` to 
-avoid collisions with defined entities of the same name:
+Arrays of primitives are supported; refer to the [documentation](https://swagger.io/specification/#data-types) for the 
+list. Usage:
 
 ```rb
 entity :user,
-       surnames: { type: :array, of: :type_int32 }
+       favorite_numbers: { type: :array, of: :int32 }
 ```
 
 Check `lib/rspec_rails_api.rb` for the full list.

data/lib/rspec/rails/api/dsl/example.rb

@@ -44,17 +44,15 @@ module RSpec
           #
           # @return [RSpec::Rails::Api::EntityConfig, Hash] Defined entity
           def defined(entity)
-            return { type: entity.to_s.split('_').last.to_sym } if PRIMITIVES.include? entity
+            return { type: entity } if PRIMITIVES.include? entity
 
             current_resource = rra_metadata.current_resource
             raise '@current_resource is unset' unless current_resource
 
             entities = rra_metadata.resources[current_resource][:entities]
+            raise "Unknown entity '#{entity}' in resource '#{current_resource}'" unless entities.key? entity.to_sym
 
-            out = entities[entity]
-            raise "Unknown entity '#{entity}' in resource '#{current_resource}'" unless out
-
-            out.expand_with(entities)
+            entities[entity.to_sym].expand_with(entities)
           end
 
           ##

data/lib/rspec/rails/api/dsl/example_group.rb

@@ -186,7 +186,7 @@ module RSpec
           #
           # @return [void]
           def execute_for_code_block(callback_block)
-            example 'Test and create documentation', caller: callback_block.send(:caller) do
+            example 'Test response and create documentation', caller: callback_block.send(:caller) do
               instance_eval(&callback_block) if callback_block
             end
           end

data/lib/rspec/rails/api/entity_config.rb

@@ -55,15 +55,12 @@ module RSpec
         # @param attribute [Symbol] Attribute name
         # @param entities  [Hash]   List of entities
         def expand_attribute(attribute, entities)
-          if PRIMITIVES.include? attribute
-            # Primitives support
-            { type: attribute.to_s.split('_').last.to_sym }
-          else
-            # Defined attribute
-            raise "Entity #{attribute} not found for entity completion." unless entities[attribute]
+          # Primitives support
+          return { type: attribute } if PRIMITIVES.include? attribute
 
-            entities[attribute].expand_with(entities)
-          end
+          raise "Entity #{attribute} not found for entity completion." unless entities[attribute]
+
+          entities[attribute].expand_with(entities)
         end
       end
     end

data/lib/rspec/rails/api/field_config.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'rspec/rails/api/entity_config'
-require 'rspec/rails/api/utils'
+require 'rspec/rails/api/validator'
 
 module RSpec
   module Rails
@@ -14,7 +14,7 @@ module RSpec
         def initialize(type:, description:, required: true, attributes: nil, of: nil)
           @required    = required
           @description = description
-          raise "Field type not allowed: '#{type}'" unless Utils.check_attribute_type(type)
+          raise "Field type not allowed: '#{type}'" unless Validator.valid_type?(type)
 
           define_attributes attributes if type == :object
           define_attributes of if type == :array

data/lib/rspec/rails/api/matchers.rb

@@ -1,53 +1,48 @@
 # frozen_string_literal: true
 
 require 'active_support/hash_with_indifferent_access'
+require 'yaml'
 
+require 'rspec/rails/api/validator'
 require 'rspec/rails/api/utils'
 
 ##
 # RSpec matcher to check something against an array of `expected`
-#
-# FIXME: Split the matcher in something else; it's too messy.
 RSpec::Matchers.define :have_many do |expected|
   match do |actual|
-    @actual = actual
-    @actual = JSON.parse(actual.body) if actual.respond_to? :body
+    actual = RSpec::Rails::Api::Utils.hash_from_response actual
 
-    raise "Response is not an array: #{@actual.class}" unless @actual.is_a? Array
-    raise 'Response has no item to compare with' unless @actual.count.positive?
+    raise "Response is not an array: #{actual.class}" unless actual.is_a? Array
+    raise 'Response has no item to compare with' unless actual.count.positive?
 
-    # Primitive type
-    if expected[:type].is_a?(Symbol)
-      @actual.each do |item|
-        return false unless RSpec::Rails::Api::Utils.check_value_type(expected[:type], item)
-      end
+    @errors = RSpec::Rails::Api::Validator.validate_array actual, expected
 
-      return true
-    end
-
-    # Check every entry
-    @actual.each do |item|
-      return false unless RSpec::Rails::Api::Utils.validate_object_structure item, expected
-    end
-
-    true
+    @errors.blank?
   end
 
-  diffable
+  failure_message do |actual|
+    object = RSpec::Rails::Api::Utils.hash_from_response(actual).to_json.chomp
+    RSpec::Rails::Api::Validator.format_failure_message @errors, object
+  end
 end
 
 ##
 # RSpec matcher to check something against the `expected` definition
-# FIXME: Split the matcher in something else; it's too messy.
 RSpec::Matchers.define :have_one do |expected|
   match do |actual|
-    @actual = actual
-    @actual = JSON.parse(actual.body) if actual.respond_to? :body
+    actual = RSpec::Rails::Api::Utils.hash_from_response actual
 
-    raise "Response is not a hash: #{@actual.class}" unless @actual.is_a? Hash
+    @errors = if expected.keys.count == 1 && expected.key?(:type)
+                RSpec::Rails::Api::Validator.validate_type actual, expected[:type]
+              else
+                RSpec::Rails::Api::Validator.validate_object actual, expected
+              end
 
-    RSpec::Rails::Api::Utils.validate_object_structure @actual, expected
+    @errors.blank?
   end
 
-  diffable
+  failure_message do |actual|
+    object = RSpec::Rails::Api::Utils.hash_from_response(actual).to_json.chomp
+    RSpec::Rails::Api::Validator.format_failure_message @errors, object
+  end
 end

data/lib/rspec/rails/api/metadata.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
 require 'rspec/rails/api/utils'
+require 'rspec/rails/api/validator'
 require 'rspec/rails/api/open_api_renderer'
 require 'rspec/rails/api/entity_config'
 
 module RSpec
   module Rails
     module Api
-      # Handles contexts and examples metadatas.
+      # Handles contexts and examples metadata.
       class Metadata # rubocop:disable Metrics/ClassLength
         attr_reader :entities, :resources, :parameters, :current_resource, :current_url, :current_method, :current_code
 
@@ -30,7 +31,7 @@ module RSpec
         #
         # @return [void]
         def add_resource(name, description)
-          @resources[name.to_sym] = { description: description, paths: {} }
+          @resources[name.to_sym] = { description: description, paths: {}, entities: {} }
           @current_resource       = name.to_sym
         end
 
@@ -44,7 +45,7 @@ module RSpec
         # @return [void]
         def add_entity(name, fields)
           Utils.deep_set(@resources,
-                         "#{@current_resource}.entities.#{name}",
+                         [@current_resource, 'entities', name],
                          EntityConfig.new(fields))
         end
 
@@ -76,11 +77,11 @@ module RSpec
           chunks = @current_url.split('?')
 
           fields.each do |name, field|
-            valid_attribute = Utils.check_attribute_type(field[:type], except: %i[array object])
+            valid_attribute = Validator.valid_type?(field[:type], except: %i[array object])
             raise "Field type not allowed: #{field[:type]}" unless valid_attribute
 
             scope = path_param_scope(chunks, name)
-            Utils.deep_set(@resources, "#{@current_resource}.paths.#{@current_url}.path_params.#{name}",
+            Utils.deep_set(@resources, [@current_resource, 'paths', @current_url, 'path_params', name],
                            description: field[:description] || nil,
                            type:        field[:type] || nil,
                            required:    field[:required] || true,
@@ -109,7 +110,7 @@ module RSpec
 
           params = organize_params fields
           Utils.deep_set(@resources,
-                         "#{@current_resource}.paths.#{@current_url}.actions.#{@current_method}.params",
+                         [@current_resource, 'paths', @current_url, 'actions', @current_method, 'params'],
                          params)
         end
 
@@ -125,7 +126,7 @@ module RSpec
         def add_action(method, url, summary, description = '')
           check_current_context :resource
 
-          Utils.deep_set(@resources, "#{@current_resource}.paths.#{url}.actions.#{method}",
+          Utils.deep_set(@resources, [@current_resource, 'paths', url, 'actions', method],
                          description: description || '',
                          summary:     summary,
                          statuses:    {},
@@ -148,7 +149,7 @@ module RSpec
           check_current_context :resource, :url, :method
 
           Utils.deep_set(@resources,
-                         "#{@current_resource}.paths.#{@current_url}.actions.#{@current_method}.statuses.#{status_code}",
+                         [@current_resource, 'paths', @current_url, 'actions', @current_method, 'statuses', status_code],
                          description: description,
                          example:     { response: nil })
           @current_code = status_code
@@ -160,10 +161,13 @@ module RSpec
         #
         # @return [Hash] Current example metadata
         def current_example
-          # rubocop:disable Layout/LineLength
-          Utils.deep_get @resources,
-                         "#{@current_resource}.paths.#{@current_url}.actions.#{@current_method}.statuses.#{@current_code}"
-          # rubocop:enable Layout/LineLength
+          @resources.dig @current_resource,
+                         :paths,
+                         @current_url.to_sym,
+                         :actions,
+                         @current_method.to_sym,
+                         :statuses,
+                         @current_code.to_s.to_sym
         end
 
         ##
@@ -179,7 +183,7 @@ module RSpec
 
           # rubocop:disable Layout/LineLength
           Utils.deep_set(@resources,
-                         "#{@current_resource}.paths.#{@current_url}.actions.#{@current_method}.statuses.#{@current_code}.expectations",
+                         [@current_resource, 'paths', @current_url, 'actions', @current_method, 'statuses', @current_code, 'expectations'],
                          {
                            one:  one,
                            many: many,
@@ -195,20 +199,20 @@ module RSpec
         # @param action      [String, nil]  HTTP verb
         # @param status_code [Integer, nil] Status code
         # @param response    [String, nil]  Response body
-        # @param path_params [Hash, nil]    Used path parameterss
+        # @param path_params [Hash, nil]    Used path parameters
         # @param params      [Hash, nil]    Used body parameters
         #
         # rubocop:disable Metrics/ParameterLists
         def add_request_example(url: nil, action: nil, status_code: nil, response: nil, path_params: nil, params: nil)
           resource = nil
           @resources.each do |key, res|
-            resource = key if Utils.deep_get(res, "paths.#{url}.actions.#{action}.statuses.#{status_code}")
+            resource = key if res.dig :paths, url.to_sym, :actions, action.to_sym, :statuses, status_code.to_s.to_sym
           end
 
           raise "Resource not found for #{action.upcase} #{url}" unless resource
 
           Utils.deep_set(@resources,
-                         "#{resource}.paths.#{url}.actions.#{action}.statuses.#{status_code}.example",
+                         [resource, 'paths', url, 'actions', action, 'statuses', status_code, 'example'],
                          path_params: path_params,
                          params:      params,
                          response:    response)
@@ -261,12 +265,16 @@ module RSpec
         ##
         # Checks and complete a field definition
         #
-        # @param fields [Hash] Fields definitions
+        # @param fields [Hash,Symbol] Fields definitions
         #
-        # @return [Hash] Completed field definition
-        def organize_params(fields) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        # @return [Hash,Symbol] Completed field definition
+        def organize_params(fields) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          return fields if fields.is_a?(Symbol) && PRIMITIVES.include?(fields)
+          raise "Unsupported type \"#{fields}\"" unless fields.is_a? Hash
+
           out      = { properties: {} }
           required = []
+
           allowed_types = %i[array object]
           fields.each do |name, field|
             allowed_type = allowed_types.include?(field[:type]) || PARAM_TYPES.key?(field[:type])

data/lib/rspec/rails/api/open_api_renderer.rb

@@ -6,7 +6,7 @@ require 'active_support'
 module RSpec
   module Rails
     module Api
-      # Class to render metadatas.
+      # Class to render metadata.
       # Example:
       #   ```rb
       #   renderer = RSpec::Rails::Api::OpenApiRenderer.new
@@ -35,11 +35,11 @@ module RSpec
         #
         # @return [void
         def merge_context(context, dump_metadata: false)
-          @metadata[:resources].deep_merge! context[:resources]
-          @metadata[:entities].deep_merge! context[:entities]
+          @metadata[:resources].deep_merge! context.respond_to?(:resources) ? context.resources : context[:resources]
+          @metadata[:entities].deep_merge! context.respond_to?(:entities) ? context.entities : context[:entities]
 
           # Save context for debug and fixtures
-          File.write ::Rails.root.join('tmp', 'rra_metadata.yaml'), context.to_yaml if dump_metadata
+          File.write ::Rails.root.join('tmp', 'rra_metadata.yaml'), @metadata.to_yaml if dump_metadata
         end
 
         ##
@@ -50,10 +50,11 @@ module RSpec
         #
         # @return [void]
         def write_files(path = nil, only: %i[yaml json])
+          return unless write_file? RSpec.world.filtered_examples
+
           path ||= ::Rails.root.join('tmp', 'rspec_api_rails')
 
           file_types = %i[yaml json]
-
           only.each do |type|
             next unless file_types.include? type
 
@@ -66,7 +67,7 @@ module RSpec
         #
         # @return [Hash] The OpenAPI structure
         def prepare_metadata
-          extract_metadatas
+          extract_metadata
           # Example: https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore-expanded.yaml
           hash = {
             openapi:    '3.0.0',
@@ -107,11 +108,23 @@ module RSpec
 
         private
 
+        def write_file?(examples)
+          acceptance_examples = examples.values.flatten.filter do |e|
+            e.metadata[:type] == :acceptance
+          end
+          unless acceptance_examples.none?(&:exception)
+            puts "\n\e[00;31mSome acceptance tests failed. OpenApi specification file was not updated.\n\e[00m"
+            return false
+          end
+
+          true
+        end
+
         ##
         # Extracts metadata for rendering
         #
         # @return [void]
-        def extract_metadatas
+        def extract_metadata
           extract_from_resources
           api_infos
           api_servers
@@ -190,10 +203,8 @@ module RSpec
             property[:format]         = PARAM_TYPES[field.type][:format] if PARAM_TYPES[field.type][:format]
             schema[:properties][name] = property
             # Primitives support
-            if PRIMITIVES.include? field.attributes
-              property[:items] =
-                { type: field.attributes.to_s.split('_').last.to_sym }
-            end
+            property[:items] = { type: field.attributes } if PRIMITIVES.include? field.attributes
+
             required.push name unless field.required == false
           end
 
@@ -282,7 +293,7 @@ module RSpec
         #
         # @return [void]
         def process_request_body(schema: nil, ref: nil, examples: {})
-          Utils.deep_set @api_components, "schemas.#{ref}", schema
+          Utils.deep_set @api_components, ['schemas', ref], schema
           {
             # description: '',
             required: true,
@@ -321,7 +332,7 @@ module RSpec
         def response_schema(expectations)
           if expectations[:many]
             items = if PRIMITIVES.include?(expectations[:many])
-                      { type: expectations[:many].to_s.split('_').last }
+                      { type: expectations[:many] }
                     else
                       { '$ref' => "#/components/schemas/#{expectations[:many]}" }
                     end

data/lib/rspec/rails/api/utils.rb

@@ -7,139 +7,38 @@ module RSpec
     module Api
       # Helper methods
       class Utils
-        ##
-        # Gets a value in a hash by specifying a dotted path
-        #
-        # @param hash [Hash]   The hash to search in
-        # @param path [String] The dotted path
-        #
-        # @return [*] The value or nil
-        def self.deep_get(hash, path)
-          path.split('.').inject(hash) do |sub_hash, key|
-            return nil unless sub_hash.is_a?(Hash) && sub_hash.key?(key.to_sym)
-
-            sub_hash[key.to_sym] # rubocop:disable Lint/UnmodifiedReduceAccumulator
+        class << self
+          ##
+          # Sets a value at given dotted path in a hash
+          #
+          # @param hash      [Hash]   The target hash
+          # @param path      [Array]  List of keys to access value
+          # @param value     [*]      Value to set
+          #
+          # @return [Hash] The modified hash
+          def deep_set(hash, path, value)
+            raise 'path should be an array' unless path.is_a? Array
+
+            return value if path.count.zero?
+
+            current_key       = path.shift.to_s.to_sym
+            hash[current_key] = {} unless hash[current_key].is_a?(Hash)
+            hash[current_key] = deep_set(hash[current_key], path, value)
+
+            hash
           end
-        end
-
-        ##
-        # Sets a value at given dotted path in a hash
-        #
-        # @param hash  [Hash]   The target hash
-        # @param path  [String] Dotted path
-        # @param value [*]      Value to set
-        #
-        # @return [Hash] The modified hash
-        def self.deep_set(hash, path, value)
-          path = path.split('.') unless path.is_a? Array
-
-          return value if path.count.zero?
-
-          current_key       = path.shift.to_sym
-          hash[current_key] = {} unless hash[current_key].is_a?(Hash)
-          hash[current_key] = deep_set(hash[current_key], path, value)
-
-          hash
-        end
-
-        ##
-        # Checks if a value is of the given parameter type
-        #
-        # @param type  [Symbol] Type to compare to
-        # @param value [*]      Value to test
-        #
-        # @return [Boolean] True when the value corresponds to the given type
-        def self.check_value_type(type, value)
-          return true if type == :boolean && (value.is_a?(TrueClass) || value.is_a?(FalseClass))
-          return true if type == :array && value.is_a?(Array)
-
-          raise "Unknown type #{type}" unless PARAM_TYPES.key? type
-
-          value.is_a? PARAM_TYPES[type][:class]
-        end
-
-        ##
-        # Validates an object keys and values types
-        #
-        # @param actual   [Hash] Hash to compare
-        # @param expected [Hash] Structure to compare
-        #
-        # @return [Boolean] True when the object matches the structure
-        def self.validate_object_structure(actual, expected)
-          # Check keys
-          return false unless same_keys? actual, expected
-
-          expected.each_key do |key|
-            next unless expected[key][:required]
-
-            expected_type       = expected[key][:type]
-            expected_attributes = expected[key][:attributes]
 
-            # Type
-            return false unless check_value_type expected_type, actual[key.to_s]
+          ##
+          # Returns a hash from an object
+          #
+          # @param value [Hash,Class] A hash or something with a "body" (as responses object in tests)
+          #
+          # @return [Hash]
+          def hash_from_response(value)
+            return JSON.parse(value.body) if value.respond_to? :body
 
-            # Deep object ?
-            return false unless validate_deep_object expected_type, expected_attributes, actual[key.to_s]
+            value
           end
-
-          true
-        end
-
-        ##
-        # Validates an array or hash against a definition
-        #
-        # @param expected_type       [:object, :array] The expected type
-        # @param expected_attributes [Hash]            Attributes configuration
-        # @param actual              [Array, Hash]     Value to check
-        #
-        # @return [Boolean] True when `actual` is of the expected definition
-        def self.validate_deep_object(expected_type, expected_attributes, actual)
-          if %i[object array].include?(expected_type) && expected_attributes.is_a?(Hash)
-            case expected_type
-            when :object
-              return false unless validate_object_structure actual, expected_attributes
-            when :array
-              return false unless validate_deep_object_array actual, expected_attributes
-            end
-          end
-
-          true
-        end
-
-        ##
-        # Validates each entry of an array
-        #
-        # @param array               [Array] The array to check
-        # @param expected_attributes [Hash]  Attributes configuration
-        #
-        # @return [Boolean] True when all values matches the attribute configuration
-        def self.validate_deep_object_array(array, expected_attributes)
-          array.each do |array_entry|
-            if expected_attributes[:type]
-              return false unless check_value_type expected_attributes[:type], array_entry
-            else
-              return false unless validate_object_structure array_entry, expected_attributes
-            end
-          end
-
-          true
-        end
-
-        ##
-        # Checks if a hash have the required keys in it
-        #
-        # @param actual   [Hash] The hash
-        # @param expected [Hash] Attributes definitions
-        #
-        # @return [Boolean] True when the object is valid
-        def self.same_keys?(actual, expected)
-          optional = expected.reject { |_key, value| value[:required] }.keys
-          actual.symbolize_keys.keys.sort - optional == expected.keys.sort - optional
-        end
-
-        def self.check_attribute_type(type, except: [])
-          keys = PARAM_TYPES.keys.reject { |key| except.include? key }
-          keys.include?(type)
         end
       end
     end

data/lib/rspec/rails/api/validator.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+require 'active_support/hash_with_indifferent_access'
+require 'rspec_rails_api'
+
+module RSpec
+  module Rails
+    module Api
+      # Set of method to validate data and data structures
+      class Validator
+        class << self
+          ##
+          # Validates an object keys and values types
+          #
+          # @param actual   [*]              Value to compare
+          # @param expected [Hash, NilClass] Definition
+          #
+          # @return [String, Hash, NilClass] Nil when no error, string when not an object and dictionary of errors
+          #         otherwise
+          def validate_object(actual, expected)
+            return 'is not a hash' unless actual.is_a? Hash
+            # Don't validate without a definition
+            return unless expected
+
+            keys_errors = validate_object_keys actual, expected
+            return keys_errors unless keys_errors.nil?
+
+            attributes_errors = validate_object_attributes(actual, expected)
+
+            attributes_errors unless attributes_errors.keys.empty?
+          end
+
+          ##
+          # Validates each entry of an array
+          #
+          # @param array    [*]                      The array to check
+          # @param expected [Symbol, Hash, NilClass] Attributes configuration
+          #
+          # @return [String, Hash, NilClass] Nil when no error, string when not an object and dictionary of errors
+          #         otherwise
+          def validate_array(array, expected)
+            return 'is not an array' unless array.is_a? Array
+            # Arrays without an expected entry type
+            return unless expected
+
+            errors = {}
+            array.each_with_index do |array_entry, index|
+              value_error = validate_array_entry array_entry, expected
+              errors["##{index}"] = value_error if value_error
+            end
+
+            errors unless errors.keys.empty?
+          end
+
+          ##
+          # Returns a human-readable string from matcher errors
+          #
+          # @param errors [String,Hash] Validation errors
+          # @param values [String]      JSON string representing the value
+          #
+          # @return [String]
+          def format_failure_message(errors, values)
+            if errors.is_a? Hash
+              errors = errors.deep_stringify_keys.to_yaml.split("\n")
+              errors.shift
+              errors.map! do |line|
+                "  #{line.sub(/^(\s+)"(#\d+)":(.*)$/, '\1\2:\3')}"
+              end
+              errors = errors.join("\n")
+            end
+
+            <<~TXT
+              expected object structure not to have these errors:
+              #{errors}
+
+              As a notice, here is the JSON object:
+                #{values}
+            TXT
+          end
+
+          ##
+          # Checks if a given type is in the supported types list
+          #
+          # @param type   [Symbol]   Type to check
+          # @param except [[Symbol]] List of types to ignore
+          #
+          # @return [Boolean]
+          def valid_type?(type, except: [])
+            keys = PARAM_TYPES.keys.reject { |key| except.include? key }
+            keys.include?(type)
+          end
+
+          ##
+          # Checks if a value is of the given type
+          #
+          # @param value [*]      Value to test
+          # @param type  [Symbol] Type to compare to
+          #
+          # @return [String,NilClass] True when the value corresponds to the given type
+          def validate_type(value, type)
+            if type == :boolean
+              return nil if value.is_a?(TrueClass) || value.is_a?(FalseClass)
+
+              return 'is not a "boolean"'
+            end
+
+            raise "Unknown type #{type}" unless PARAM_TYPES.key? type
+
+            return nil if value.is_a? PARAM_TYPES[type][:class]
+
+            "is not a \"#{type}\""
+          end
+
+          private
+
+          # Checks if a key should be skipped, whether it's missing and optional or nil
+          #
+          # @param key        [Symbol] Key to check
+          # @param value      [*]      Associated value
+          # @param definition [Hash]   Entity definitions
+          #
+          # @return [Boolean]
+          def skip_key_check?(key, value, definition)
+            # Ignore missing optional keys
+            return true unless value.key?(key.to_s) || definition[key][:required]
+            # Ignore null optional keys
+            return true if !definition[key][:required] && value[key.to_s].nil?
+
+            false
+          end
+
+          # Validates the keys of a hash
+          #
+          # @param actual     [Hash] The hash to check
+          # @param definition [Hash] The object definition
+          #
+          # @return [String, Hash, NilClass] Nil when no error, string when not an object and dictionary of errors
+          #         otherwise
+          def validate_object_keys(actual, definition)
+            # Hashes without an expected attributes type
+            return unless definition
+
+            errors = {}
+            actual.each_key do |key|
+              errors[key] = 'is not defined' unless definition.key?(key.to_sym)
+            end
+
+            errors unless errors.keys.empty?
+          end
+
+          ##
+          # Validates the attributes of a Hash
+          #
+          # @param actual   [Hash] Value to compare
+          # @param expected [Hash] Definition
+          #
+          # @return [String, Hash, NilClass] Nil when no error, string when not an object and dictionary of errors
+          #         otherwise
+          def validate_object_attributes(actual, expected)
+            errors = {}
+            expected.each_key do |key|
+              next if skip_key_check? key, actual, expected
+
+              value_error = validate_object_attribute key, actual, expected[key][:type], expected[key][:attributes]
+              errors[key] = value_error unless value_error.nil?
+            end
+
+            errors unless errors.keys.nil?
+          end
+
+          # Checks the value of an entry in a Hash
+          #
+          # @param key           [Symbol]      Key to check
+          # @param actual        [Hash]        Hash to check
+          # @param expected_type [Symbol]      Expected type
+          # @param definition    [Symbol,Hash] Attribute definition
+          #
+          # @return [String,Hash,NilClass] Nil when no error is met, string when not a primitive and dictionary of
+          #         errors otherwise
+          def validate_object_attribute(key, actual, expected_type, definition)
+            return 'is missing' unless actual.key? key.to_s
+
+            case expected_type
+            when :object
+              validate_object actual[key.to_s], definition
+            when :array
+              validate_array actual[key.to_s], definition
+            else
+              validate_type actual[key.to_s], expected_type
+            end
+          end
+
+          # Checks the validity of an array entry against a definition
+          #
+          # @param entry      [*]    Entry to check
+          # @param definition [Hash] Fields definition
+          #
+          # @return [String,Hash,NilClass] Nil when no error is met, string when not a primitive and dictionary of
+          #         errors otherwise
+          def validate_array_entry(entry, definition)
+            if definition[:type].is_a? Symbol # Array of "simple" values
+              validate_type entry, definition[:type]
+            else # Objects
+              validate_object entry, definition
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/rails/api/version.rb

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.4.0'
+      VERSION = '0.5.0'
     end
   end
 end

data/lib/rspec_rails_api.rb

@@ -35,11 +35,7 @@ module RSpec
         object:   { type: 'object', format: nil, class: Hash },
       }.freeze
 
-      EXCLUDED_PRIMITIVES = %i[array object].freeze
-
       PRIMITIVES = PARAM_TYPES.keys
-                              .reject { |key| EXCLUDED_PRIMITIVES.include? key }
-                              .map { |key| "type_#{key}".to_sym }
     end
   end
 end

data/rspec-rails-api.gemspec

@@ -33,15 +33,18 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.add_development_dependency 'activesupport', '~> 6.0'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rack'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-19 00:00:00.000000000 Z
+date: 2023-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -149,10 +191,12 @@ files:
 - ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -166,6 +210,7 @@ files:
 - lib/rspec/rails/api/metadata.rb
 - lib/rspec/rails/api/open_api_renderer.rb
 - lib/rspec/rails/api/utils.rb
+- lib/rspec/rails/api/validator.rb
 - lib/rspec/rails/api/version.rb
 - lib/rspec_rails_api.rb
 - rspec-rails-api.gemspec
@@ -185,15 +230,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Tests standard Rails API responses and generate doc