fitting 2.16.0 → 2.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9de3ef63b994a6585d5795ebff3c5473d5b150a47b29abab37d8c306a813e4ee
-  data.tar.gz: 0c8b4c52d63c38f4b1d6fb174b991544b185bedde24722b09428adfb0260cf05
+  metadata.gz: 5d4c64b93e5cc274fd6ce45447011be34413072ac0cddc20d75799ef9ccb3f8d
+  data.tar.gz: be18cc02c5f5a3be1167d17bf46039c8b2f9cc404f0c7849297166bffa45a1d5
 SHA512:
-  metadata.gz: df9e196563d7a3430b228d9bc4fdaf13600a4db62ee0c8182506b30a4c890fb39a4bb3dc0ae194df63d6a48489ccaf8817dda54c6e6ab3c509a9fa5ee73421c2
-  data.tar.gz: a140201ca99818ce637b39d80721a26a0c00a75beb5435778e41aacce5e60e953d6b62c285272295b48446c234c3992dd0b7c87c8670bad91d0601f64a7ded1e
+  metadata.gz: 0f3b8b8a48f3927c09325dd9d0057b2cfe9294d495eb3693471f2e7e1a11f37cdc5165e44bbbd5d736bbb504875fa68e81473624c113217d1d2573b5735179e9
+  data.tar.gz: 00b71dc28323aefa7dd022a8ea441a337c5316228ffb2ddc0b6f6ad310bcd3fefcad35c174dcbe734fdd8cf1178992125f850d6729225a7627f0be70dbeb4706

data/.rubocop.yml

@@ -1,8 +1,8 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
 
-Metrics/LineLength:
-  Max: 120
+Layout/LineLength:
+  Max: 130
 
 Style/Documentation:
   Enabled: false
@@ -18,3 +18,34 @@ Style/CaseEquality:
 
 Style/NilComparison:
   Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Lint/UnreachableCode:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 50
+
+# FIXME
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/ParameterLists:
+  Max: 7
+
+Metrics/ClassLength:
+  Max: 150
+
+Lint/UselessAssignment:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Change log
 
+### 2.18.1 - 2021-10-12
+
+* patch
+  * fix bugs and refactoring
+
+### 2.18.0 - 2021-09-29
+
+* patch
+  * remove multi_json [#119](https://github.com/funbox/fitting/issues/119)
+
+### 2.17.0 - 2021-09-20
+
+* features
+  * display tests_without_responses details on the main page [#115](https://github.com/funbox/fitting/issues/115)
+
+### 2.16.1 - 2021-02-10
+* patch
+  * make prefix optional [#98](https://github.com/funbox/fitting/issues/98)
+
 ### 2.16.0 - 2021-02-10
 
 * features

data/README.md

@@ -1,6 +1,19 @@
 # Fitting
-Coverage API Blueprint, Swagger and OpenAPI with rspec tests for easily make high-quality API and documenatiton.
-![exmaple](example.png)
+
+<img align="right" width="192" height="192"
+alt="Optimizt avatar: OK sign with Mona Lisa picture between the fingers"
+src="./images/logo.png">
+
+There are such ways of describing the API documentation as API Blueprint, Swagger and OpenAPI. And using the tests already writed for your code, you can reuse them to find out the documentation coverage.
+This makes it easy to find out how much the documentation matches the implementation.
+
+* Cool if you already have a project with tests and documentation, you can check how good everything is and fix microbags.
+
+* If are you going developing API and  write documentation for it, this tool will help you document-driven development easily create high-quality write API documentation and API.
+
+* Also, if you have an undocumented API, this is an easy way to describe it.
+
+![exmaple](images/example.png)
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -119,11 +132,31 @@ tests_without_responses: 43
 
 And task will create HTML (`fitting/index.html`) reports.
 
-![exmaple](example.png)
+![exmaple](images/example.png)
 
 More information on action coverage
 
-![exmaple2](example2.png)
+![exmaple2](images/example2.png)
+
+## prefix name
+
+Setting the prefix name is optional. For example, you can do this:
+
+```yaml
+prefixes:
+  - openapi2_json_path: doc.json
+```
+
+## prefix skip
+
+It is not necessary to immediately describe each prefix in detail, you can only specify its name and skip it until you are ready to documented it
+```yaml
+prefixes:
+- name: /api/v1
+  openapi2_json_path: doc.json
+- name: /api/v3
+  skip: true
+```
 
 ## Contributing
 

data/fitting.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fitting/version'
 
@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['d.efimov']
   spec.email         = ['d.efimov@fun-box.ru']
 
-  spec.summary       = 'Coverage API Blueprint, Swagger and OpenAPI with rspec tests'
-  spec.description   = 'Coverage API Blueprint, Swagger and OpenAPI with rspec tests for easily make high-quality API and documenatiton.'
+  spec.summary       = 'Coverage API Blueprint, Swagger and OpenAPI with RSpec'
+  spec.description   = 'Coverage API Blueprint, Swagger and OpenAPI with RSpec for easily make high-quality API and documenatiton'
   spec.homepage      = 'https://github.com/funbox/fitting'
   spec.license       = 'MIT'
 
@@ -18,13 +18,13 @@ 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.6.0'
   spec.add_runtime_dependency 'json-schema', '~> 2.6', '>= 2.6.2'
-  spec.add_runtime_dependency 'multi_json', '~> 1.11'
   spec.add_runtime_dependency 'tomograph', '~> 3.1', '>= 3.1.0'
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'byebug', '~> 8.2', '>= 8.2.1'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
-  spec.add_development_dependency 'rubocop', '~> 0.49.1', '>= 0.49.1'
-  spec.add_development_dependency 'simplecov', '~> 0.11', '>= 0.11.2'
+  spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.3'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.22.0'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
 end

data/lib/fitting/configuration/legacy.rb

@@ -36,11 +36,12 @@ module Fitting
                           drafter_4_apib_path: @drafter_4_apib_path,
                           drafter_4_yaml_path: @drafter_4_yaml_path
                         )
-                      else Tomograph::Tomogram.new(
-                        prefix: @prefix,
-                        apib_path: @apib_path,
-                        drafter_yaml_path: @drafter_yaml_path
-                      )
+                      else
+                        Tomograph::Tomogram.new(
+                          prefix: @prefix,
+                          apib_path: @apib_path,
+                          drafter_yaml_path: @drafter_yaml_path
+                        )
                       end
       end
 

data/lib/fitting/configuration/yaml.rb

@@ -43,13 +43,13 @@ module Fitting
                         Tomograph::Tomogram.new(
                           prefix: @prefix,
                           crafter_apib_path: @crafter_apib_path,
-                          crafter_yaml_path: @crafter_yaml_path,
+                          crafter_yaml_path: @crafter_yaml_path
                         )
                       elsif @drafter_4_apib_path || @drafter_4_yaml_path
                         Tomograph::Tomogram.new(
                           prefix: @prefix,
                           drafter_4_apib_path: @drafter_4_apib_path,
-                          drafter_4_yaml_path: @drafter_4_yaml_path,
+                          drafter_4_yaml_path: @drafter_4_yaml_path
                         )
                       else
                         Tomograph::Tomogram.new(

data/lib/fitting/cover/json_schema.rb

@@ -15,17 +15,18 @@ module Fitting
 
       def inception(json_schema, combinations)
         json_schema.each do |key, value|
-          if key == 'properties' and json_schema['required'] != value.keys
+          if (key == 'properties') && (json_schema['required'] != value.keys)
             schema = json_schema.dup
             one_of = schema.delete('required') || []
             schema['properties'].each_key do |property|
               next if one_of.include?(property)
+
               combinations.push([schema.merge('required' => one_of + [property]), "required.#{property}"])
             end
           elsif value.is_a?(Hash)
             com = inception(value, [])
             com.each do |combination|
-              combination[0] = { key => value.merge(combination[0])}
+              combination[0] = { key => value.merge(combination[0]) }
               combination[1] = "#{key}.#{combination[1]}"
             end
             combinations += com

data/lib/fitting/cover/json_schema_enum.rb

@@ -24,7 +24,7 @@ module Fitting
           elsif value.is_a?(Hash)
             com = inception(value, [])
             com.each do |combination|
-              combination[0] = { key => value.merge(combination[0])}
+              combination[0] = { key => value.merge(combination[0]) }
               combination[1] = "#{key}.#{combination[1]}"
             end
             combinations += com

data/lib/fitting/cover/json_schema_one_of.rb

@@ -24,7 +24,7 @@ module Fitting
           elsif value.is_a?(Hash)
             com = inception(value, [])
             com.each do |combination|
-              combination[0] = { key => value.merge(combination[0])}
+              combination[0] = { key => value.merge(combination[0]) }
               combination[1] = "#{key}.#{combination[1]}"
             end
             combinations += com

data/lib/fitting/cover/response.rb

@@ -13,11 +13,7 @@ module Fitting
         end
       end
 
-      attr_reader :json_schemas
-
-      attr_reader :combinations
-
-      attr_reader :flags
+      attr_reader :json_schemas, :combinations, :flags
 
       def update(response)
         index = 0

data/lib/fitting/documentation.rb

@@ -1,5 +1,3 @@
-require 'multi_json'
-
 module Fitting
   class Documentation
     def initialize(tomogram, white_list)

data/lib/fitting/matchers/response_matcher.rb

@@ -39,7 +39,8 @@ module Fitting
         if response.within_prefix?(config.prefix)
           @response = response
           return true if @response.ignored?(config.ignore_list)
-          return @response.fully_validates.valid?
+
+          @response.fully_validates.valid?
         else
           true
         end

data/lib/fitting/records/documented/request.rb

@@ -35,6 +35,7 @@ module Fitting
           return false if @white_list[path.to_s] == nil
           return true if @white_list[path.to_s] == []
           return true if @white_list[path.to_s].include?(method)
+
           false
         end
 

data/lib/fitting/records/realized_unit.rb

@@ -9,27 +9,25 @@ module Fitting
       end
 
       def fully_covered?
+        all_good_documented = false
+        all_good_response_documented = false
+        all_good_response_json_schemas = false
+        all_good_valid_json_schemas = false
+
         test_file_paths.each do |_key, requests|
-          all_good = requests.all?(&:documented?)
-          return false unless all_good
-        end
-        test_file_paths.each do |_key, requests|
-          all_good = requests.all?(&:response_documented?)
-          return false unless all_good
-        end
-        test_file_paths.each do |_key, requests|
-          all_good = requests.all?(&:response_json_schemas?)
-          return false unless all_good
-        end
-        test_file_paths.each do |_key, requests|
-          all_good = requests.all?(&:valid_json_schemas?)
-          return false unless all_good
+          all_good_documented = requests.all?(&:documented?)
+          all_good_response_documented = requests.all?(&:response_documented?)
+          all_good_response_json_schemas = requests.all?(&:response_json_schemas?)
+          all_good_valid_json_schemas = requests.all?(&:valid_json_schemas?)
         end
-        true
+
+        all_good_documented && all_good_response_documented &&
+          all_good_response_json_schemas && all_good_valid_json_schemas
       end
 
       def test_file_paths
         return @test_file_paths if @test_file_paths
+
         @test_file_paths = {}
         white_unit.map do |request|
           @test_file_paths[request.test_file_path] ||= []

data/lib/fitting/records/spherical/request.rb

@@ -27,7 +27,7 @@ module Fitting
           }
         end
 
-        def to_json
+        def to_json(*_args)
           JSON.dump(to_hash)
         end
 

data/lib/fitting/records/spherical/requests.rb

@@ -10,11 +10,12 @@ module Fitting
 
           array = []
           Dir['fitting_tests/*.json'].each do |file|
-            array += JSON.load(File.read(file))
+            array += JSON.parse(File.read(file))
           end
           @to_a = array.inject([]) do |res, tested_request|
             request = Fitting::Records::Spherical::Request.load(tested_request)
             next res unless request.path.to_s.start_with?(Fitting.configuration.prefix)
+
             res.push(request)
           end
         end

data/lib/fitting/records/spherical/response.rb

@@ -14,7 +14,7 @@ module Fitting
         def to_hash
           {
             status: status,
-            body: JSON.load(body)
+            body: JSON.parse(body)
           }
         rescue JSON::ParserError
           {
@@ -23,7 +23,7 @@ module Fitting
           }
         end
 
-        def to_json
+        def to_json(*_args)
           JSON.dump(to_hash)
         end
 

data/lib/fitting/records/test_unit/request.rb

@@ -37,6 +37,7 @@ module Fitting
           @documented_requests ||= @all_documented_requests.inject([]) do |res, documented_request|
             next res unless @tested_request.method == documented_request.method &&
                             documented_request.path.match(@tested_request.path.to_s)
+
             res.push(documented_request)
           end
         end
@@ -49,6 +50,7 @@ module Fitting
           @documented_responses ||= documented_requests.inject([]) do |res, documented_request|
             documented_request.responses.map do |documented_response|
               next unless documented_response['status'] == response.status.to_s
+
               res.push(documented_response)
             end
           end.flatten.compact
@@ -71,6 +73,7 @@ module Fitting
         def valid_json_schemas
           @valid_json_schemas ||= response_json_schemas.inject([]) do |res, json_schema|
             next res unless JSON::Validator.validate(json_schema, response.body)
+
             res.push(json_schema)
           end.flatten
         end
@@ -78,6 +81,7 @@ module Fitting
         def invalid_json_schemas
           @invalid_json_schemas ||= response_json_schemas.inject([]) do |res, json_schema|
             next res if JSON::Validator.validate(json_schema, response.body)
+
             res.push(
               json_schema: json_schema,
               fully_validate: JSON::Validator.fully_validate(json_schema, response.body)

data/lib/fitting/records/tested/request.rb

@@ -6,9 +6,9 @@ module Fitting
   class Records
     class Tested
       class Request
-        def initialize(env_response, test_title)
+        def initialize(env_response, metadata)
           @env_response = env_response
-          @test_title = test_title
+          @metadata = metadata
         end
 
         def method
@@ -28,11 +28,11 @@ module Fitting
         end
 
         def test_path
-          @test_path ||= @test_title[/#{'\(\.'}(.*?)#{'\)'}/m, 1] || @test_title[/#{'\.'}(.*?)#{'\"'}/m, 1]
+          @test_path ||= @metadata.fetch(:location)
         end
 
         def test_file_path
-          @test_file_path ||= test_path.split(':').first
+          @test_file_path ||= @metadata.fetch(:file_path)
         end
 
         def to_spherical

data/lib/fitting/records/unit/combination.rb

@@ -14,12 +14,11 @@ module Fitting
 
         def valid_bodies
           @valid_bodies ||= @bodies.inject([]) do |res, tested_body|
-            begin
-              next res unless JSON::Validator.validate(@json_schema, tested_body)
-              res.push(tested_body)
-            rescue JSON::Schema::UriError
-              res.push(tested_body)
-            end
+            next res unless JSON::Validator.validate(@json_schema, tested_body)
+
+            res.push(tested_body)
+          rescue JSON::Schema::UriError
+            res.push(tested_body)
           end
         end
       end

data/lib/fitting/records/unit/json_schema.rb

@@ -17,50 +17,55 @@ module Fitting
 
         def bodies
           @bodies ||= @tested_bodies.inject([]) do |res, tested_body|
-            begin
-              next res unless JSON::Validator.validate(@json_schema, tested_body)
-              res.push(tested_body)
-            rescue JSON::Schema::UriError
-              res.push(tested_body)
-            end
+            next res unless JSON::Validator.validate(@json_schema, tested_body)
+
+            res.push(tested_body)
+          rescue JSON::Schema::UriError
+            res.push(tested_body)
           end
         end
 
         def combinations
           return @combinations if @combinations
+
           @combinations = []
           cover_json_schema = Fitting::Cover::JSONSchema.new(@json_schema)
           cover_json_schema.combi.map do |comb|
             @combinations.push(Fitting::Records::Unit::Combination.new(
-              comb,
-              bodies
-            ))
+                                 comb,
+                                 bodies
+                               ))
           end
           @combinations
         end
 
         def combinations_with_enum
           return @combinations_with_enum if @combinations_with_enum
+
           @combinations_with_enum = []
-          qwe = Fitting::Cover::JSONSchema.new(@json_schema).combi + Fitting::Cover::JSONSchemaEnum.new(@json_schema).combi
+          qwe = Fitting::Cover::JSONSchema.new(@json_schema).combi +
+                Fitting::Cover::JSONSchemaEnum.new(@json_schema).combi
           qwe.map do |comb|
             @combinations_with_enum.push(Fitting::Records::Unit::Combination.new(
-              comb,
-              bodies
-            ))
+                                           comb,
+                                           bodies
+                                         ))
           end
           @combinations_with_enum
         end
 
         def combinations_with_one_of
           return @combinations_with_one_of if @combinations_with_one_of
+
           @combinations_with_one_of = []
-          qwe = Fitting::Cover::JSONSchema.new(@json_schema).combi + Fitting::Cover::JSONSchemaEnum.new(@json_schema).combi + Fitting::Cover::JSONSchemaOneOf.new(@json_schema).combi
+          qwe = Fitting::Cover::JSONSchema.new(@json_schema).combi +
+                Fitting::Cover::JSONSchemaEnum.new(@json_schema).combi +
+                Fitting::Cover::JSONSchemaOneOf.new(@json_schema).combi
           qwe.map do |comb|
             @combinations_with_one_of.push(Fitting::Records::Unit::Combination.new(
-              comb,
-              bodies
-            ))
+                                             comb,
+                                             bodies
+                                           ))
           end
           @combinations_with_one_of
         end
@@ -79,26 +84,26 @@ module Fitting
 
         def cover_enum
           @cover_enum ||= if bodies == []
-            0
-          else
-            count = 0
-            combinations_with_enum.map do |combination|
-              count += 1 unless combination.valid_bodies == []
-            end
-            (count + 1) * 100 / (combinations_with_enum.size + 1)
-          end
+                            0
+                          else
+                            count = 0
+                            combinations_with_enum.map do |combination|
+                              count += 1 unless combination.valid_bodies == []
+                            end
+                            (count + 1) * 100 / (combinations_with_enum.size + 1)
+                          end
         end
 
         def cover_one_of
           @cover_one_of ||= if bodies == []
-            0
-          else
-            count = 0
-            combinations_with_one_of.map do |combination|
-              count += 1 unless combination.valid_bodies == []
-            end
-            (count + 1) * 100 / (combinations_with_one_of.size + 1)
-          end
+                              0
+                            else
+                              count = 0
+                              combinations_with_one_of.map do |combination|
+                                count += 1 unless combination.valid_bodies == []
+                              end
+                              (count + 1) * 100 / (combinations_with_one_of.size + 1)
+                            end
         end
       end
     end

data/lib/fitting/records/unit/request.rb

@@ -27,6 +27,7 @@ module Fitting
           @tested_responses ||= @tested_requests.to_a.inject([]) do |res, tested_request|
             next res unless @documented_request.method == tested_request.method &&
                             @documented_request.path.match(tested_request.path.to_s)
+
             res.push(tested_request.response)
           end
         end

data/lib/fitting/records/unit/response.rb

@@ -22,6 +22,7 @@ module Fitting
         def tested_bodies
           @tested_bodies ||= @tested_responses.inject([]) do |res, tested_response|
             next res unless status == tested_response.status.to_s
+
             res.push(tested_response.body)
           end
         end

data/lib/fitting/report/action.rb

@@ -17,9 +17,7 @@ module Fitting
         @action.path.to_s
       end
 
-      def responses
-        @responses
-      end
+      attr_reader :responses, :tests
 
       def add_test(test)
         @tests.push(test)
@@ -38,14 +36,13 @@ module Fitting
         @regexp = Regexp.new(str)
       end
 
-      def tests
-        @tests
-      end
-
       def details
         {
-            tests_without_responses: @tests.without_responses,
-            responses_details: @responses.to_a.map { |r| {method: r.status, tests_size: r.tests.size, json_schema: r.id, combinations: r.details} }
+          tests_without_responses: @tests.without_responses,
+          responses_details: @responses.to_a.map do |r|
+                               { method: r.status, tests_size: r.tests.size, json_schema: r.id,
+                                 combinations: r.details }
+                             end
         }
       end
     end