rspec-rails-api 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c81756e5b64eb7e5d7363231a498c947377879806b92dac3d8f11c0d28fd7bb
-  data.tar.gz: 728634d884084a356b2f2d29ae410b6a54c70d47a8dfe9f0ac821bc75a80e160
+  metadata.gz: d574f6e06c94fc87d2db77079f80a341da7455b5776c3513a7e84b5b80165090
+  data.tar.gz: 23ddbfe59c098baa1ffcec4dce21d5d6ba25f8fe0143d965d11a8bee25771aad
 SHA512:
-  metadata.gz: 6b50cb2972931d3a160bd2e3ab7ee73d73d4a762c7ee8e9264fae4903b3a98954d8d34aa6dc1aeecbd1fe40dea99cc6d02bd592e710a9a136b4665dd0285cd03
-  data.tar.gz: 482ab0880d61cf4b709034903a7509b57750bf121dcdab9acba7bc519ef4fd8e9c079f2b263d3c7732db18e8fbb6f333743ccd700ebe286fcb548ca3c1b8cbde
+  metadata.gz: 3430d1d5da42f6c7bf9d28f6c6e6a74ff332fb3cd31cf92d170d9c87f76527dd0d64d6ae510ae19873d7ca078c4405a05154d867f100f804e806c6e6fc342049
+  data.tar.gz: f251c30d40efaeef76bfd3ea0f313834dc7323ab56dc07ddf1ecc845b033160dd29afd053d3de3b0a2d7afee7092e858a1844795296e6593d9598f0d17f4df58

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   Exclude:
     - dummy/**/*
     - vendor/bundle/**/*
+  NewCops: enable
 
 Layout/LineLength:
   Max: 120

data/CHANGELOG.md

@@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file.
 
 ## Not released
 
+## 0.3.2 - 2021-03-09
+- Fix YAML rendering (ruby objects were sometimes rendered in documentation)
+- Render examples results as YAML/JSON objects instead of text blocks.
+
+## 0.3.1 - 2020-04-09
+- Add support for "test only" examples, allowing to write examples without documentation.
+
 ## 0.3.0 - 2019-12-26
 
 ### Changed

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

@@ -55,7 +55,7 @@ module RSpec
           end
 
           def prepare_request_params(description, request_params = {}, payload = {}, request_headers = {})
-            example_params = description.split ' '
+            example_params = description.split
 
             {
               action:      example_params[0].downcase,

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

@@ -11,7 +11,7 @@ module RSpec
       class FieldConfig
         attr_accessor :required, :type, :attributes, :description
 
-        def initialize(type:, required: true, description:, attributes: nil, of: nil)
+        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)
@@ -40,9 +40,10 @@ module RSpec
         private
 
         def define_attributes(attributes)
-          @attributes = if attributes.is_a? Hash
+          @attributes = case attributes
+                        when Hash
                           @attributes = EntityConfig.new attributes
-                        elsif attributes.is_a? Symbol
+                        when Symbol
                           attributes
                         end
         end

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

@@ -87,7 +87,7 @@ module RSpec
           @current_method = method
         end
 
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         def add_status_code(status_code, description)
           check_current_context :resource, :url, :method
 
@@ -97,7 +97,7 @@ module RSpec
                          example:     { response: nil })
           @current_code = status_code
         end
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
 
         # rubocop:disable Metrics/ParameterLists
         def add_request_example(url: nil, action: nil, status_code: nil, response: nil, path_params: nil, params: nil)
@@ -125,25 +125,14 @@ module RSpec
 
         private
 
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength, Style/GuardClause
-        def check_current_context(*scope)
+        def check_current_context(*scope) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           scope ||= []
-          if scope.include?(:resource)
-            raise 'No resource declared' unless @current_resource
-          end
-          if scope.include?(:method)
-            raise 'No action declared' unless @current_method
-          end
-          if scope.include?(:url)
-            raise 'No url declared' unless @current_url
-          end
-          if scope.include?(:code)
-            raise 'No status code declared' unless @current_code
-          end
+          raise 'No resource declared' if scope.include?(:resource) && !@current_resource
+          raise 'No action declared' if scope.include?(:method) && !@current_method
+          raise 'No url declared' if scope.include?(:url) && !@current_url
+          raise 'No status code declared' if scope.include?(:code) && !@current_code
         end
 
-        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength, Style/GuardClause
-
         def path_param_scope(url_chunks, name)
           if /:#{name}/.match?(url_chunks[0])
             :path
@@ -154,11 +143,12 @@ module RSpec
           end
         end
 
-        def organize_params(fields) # rubocop:disable Metrics/AbcSize
+        def organize_params(fields) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
           out      = { properties: {} }
           required = []
+          allowed_types = %i[array object]
           fields.each do |name, field|
-            allowed_type = %i[array object].include?(field[:type]) || PARAM_TYPES.key?(field[:type])
+            allowed_type = allowed_types.include?(field[:type]) || PARAM_TYPES.key?(field[:type])
             raise "Field type not allowed: #{field[:type]}" unless allowed_type
 
             required.push name.to_s if field[:required]

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

@@ -39,10 +39,12 @@ module RSpec
           content = prepare_metadata
           path ||= ::Rails.root.join('tmp', 'rspec_api_rails')
 
+          file_types = %i[yaml json]
+
           only.each do |type|
-            next unless %i[yaml json].include? type
+            next unless file_types.include? type
 
-            File.write "#{path}.#{type}", content.send("to_#{type}")
+            File.write "#{path}.#{type}", JSON.parse(JSON.pretty_generate(content)).send("to_#{type}")
           end
         end
 
@@ -89,13 +91,14 @@ module RSpec
         end
 
         def process_resource(resource: nil, resource_config: nil) # rubocop:disable Metrics/MethodLength
+          http_verbs = %i[get post put patch delete]
           resource_config[:paths].each do |path_key, path|
             url        = path_with_params path_key.to_s
             actions    = {}
             parameters = path.key?(:path_params) ? process_path_params(path[:path_params]) : []
 
             path[:actions].each_key do |action|
-              next unless %i[get post put patch delete].include? action
+              next unless http_verbs.include? action
 
               actions[action] = process_action resource:      resource,
                                                path:          path_key,
@@ -117,7 +120,7 @@ module RSpec
           parameters
         end
 
-        def process_path_param(name, param) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        def process_path_param(name, param) # rubocop:disable Metrics/MethodLength
           parameter = {
             name:        name.to_s,
             description: param[:description],
@@ -138,13 +141,12 @@ module RSpec
           responses    = {}
           request_body = nil
 
-          if %i[post put patch].include? action_config
-            if path_config[:actions][action_config][:params].keys.count.positive?
-              schema       = path_config[:actions][action_config][:params]
-              schema_ref   = escape_operation_id("#{action_config}_#{path}")
-              examples     = process_examples(path_config[:actions][action_config][:statuses])
-              request_body = process_request_body schema: schema, ref: schema_ref, examples: examples
-            end
+          if %i[post put
+                patch].include?(action_config) && path_config[:actions][action_config][:params].keys.count.positive?
+            schema = path_config[:actions][action_config][:params]
+            schema_ref   = escape_operation_id("#{action_config}_#{path}")
+            examples     = process_examples(path_config[:actions][action_config][:statuses])
+            request_body = process_request_body schema: schema, ref: schema_ref, examples: examples
           end
 
           path_config[:actions][action_config][:statuses].each do |status_key, status|
@@ -190,7 +192,7 @@ module RSpec
 
           response[:content] = {
             'application/json': {
-              examples: { default: { value: JSON.pretty_generate(JSON.parse(content)) } },
+              examples: { default: { value: JSON.parse(content) } },
             },
           }
 
@@ -220,7 +222,7 @@ module RSpec
           string.downcase.gsub(/[^\w]+/, '_')
         end
 
-        def api_infos # rubocop:disable Metrics/CyclomaticComplexity
+        def api_infos
           @api_infos = {
             title:   @api_title || 'Some sample app',
             version: @api_version || '1.0',

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

@@ -11,7 +11,7 @@ module RSpec
           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]
+            sub_hash[key.to_sym] # rubocop:disable Lint/UnmodifiedReduceAccumulator
           end
         end
 
@@ -27,7 +27,7 @@ module RSpec
           hash
         end
 
-        def self.check_value_type(type, value) # rubocop:disable Metrics/CyclomaticComplexity
+        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)
 

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

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.3.1'
+      VERSION = '0.3.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2021-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport