fitting 1.6.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 687724fcdc1df94e6f43ead5dd7d07a2847c4957
-  data.tar.gz: 86bbae4ea5919bd2b846b35430b2d55c976c037a
+  metadata.gz: 06aa35a9c436cb26d67b98c6e0b5f0a895154837
+  data.tar.gz: b00ac2fe2a7a6decec12900aac058b9ef289ee7e
 SHA512:
-  metadata.gz: 94369cc36505eaa4fc30b70cea9583ad445508cee603f80151a263667cb6081c143bd2fa8ef05d3c83d5abe62f81034d166accd4cf45337f71deb10cd62c3913
-  data.tar.gz: c3579f89a6ddf00adb0b24140edb570cb8fee0cb86445149edc0099ce92c3f35836940079b2d41ccdefdd608062c3bbd60447e54cd140b40b0852a2d9c4264cc
+  metadata.gz: bff39029299d63108358a8ba66809da543af39f08fd73647ca74e8d0dc396aa61cfc2c7033ab3f93166b5a57495c2afaf204da52ed1e505504522d2373c623a0
+  data.tar.gz: 94f4ab0036598e52ed418600c4a30ef04bbfa47ddb8de772073731217fbda75af0408793b3db0fd75da336f2fa791a02a4d868a3b00d12507ac02b74d936bb43

data/README.md

@@ -26,14 +26,40 @@ Or install it yourself as:
 In your `spec_helper.rb`:
 
 ```ruby
-  Fitting.configure do |config|
-    config.apib_path = '/path/to/doc.apib'
+require 'fitting'
+
+Fitting.statistics
+
+Fitting.configure do |config|
+  config.apib_path = '/path/to/doc.apib'
+end
+```
+
+or
+
+```ruby
+require 'fitting'
+
+responses = Fitting::Storage::Responses.new
+
+RSpec.configure do |config|
+  config.after(:each, type: :controller) do
+    responses.add(response)
+  end
+
+  config.after(:suite) do
+    responses.statistics.save
   end
+end
+
+Fitting.configure do |config|
+  config.apib_path = '/path/to/doc.apib'
+end
 ```
 
 ## Example output
 
-After running tests you will get statistics in the console:
+After running tests you will get statistics in the file `fitting/stats`:
 
 ```
 Fully conforming requests:
@@ -59,6 +85,8 @@ API responses conforming to the blueprint: 16 (64.00% of 25).
 API responses with validation errors or untested: 9 (36.00% of 25).
 ```
 
+Also you will get not covered responses in the file `fitting/not_covered`.
+
 ## Matchers
 
 If you want to know why you get crosses instead of checkmarks you can use matchers for RSpec.
@@ -67,20 +95,20 @@ If you want to know why you get crosses instead of checkmarks you can use matche
 config.include Fitting::Matchers, type: :controller
 ```
 
-### match_response
+### match_schema
 
 Makes a simple validation against JSON Schema.
 
 ```ruby
-expect(response).to match_response
+expect(response).to match_schema
 ```
 
-### strict_match_response
+### strictly_match_schema
 
 Makes a strict validation against JSON Schema. All properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`.
 
 ```ruby
-expect(response).to strict_match_response
+expect(response).to strictly_match_schema
 ```
 
 ## Config
@@ -93,10 +121,6 @@ Path to API Blueprint documentation. There must be an installed [drafter](https:
 
 Path to API Blueprint documentation pre-parsed with `drafter` and saved to a YAML file.
 
-### necessary_fully_implementation_of_responses
-
-Default `true`. It returns `exit 1` if not all responses are implemented according to the documentation. For this to work, `match_response` (see above) should run.
-
 ### strict
 
 Default `false`. If `true` then all properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`.
@@ -122,14 +146,6 @@ config.white_list = {
 
 Empty array `[]` means all methods.
 
-### create_report_with_name
-
-File name for the report.
-
-### show_statistics_in_console
-
-Default `true`.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/funbox/fitting. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/fitting.gemspec

@@ -22,7 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'json-schema', '~> 2.6', '>= 2.6.2'
   spec.add_runtime_dependency 'tomogram_routing', '~> 0.1', '>= 0.1.0'
   spec.add_runtime_dependency 'multi_json'
-  spec.add_runtime_dependency 'rspec-core', '~> 3.0', '>= 3.0.0'
   spec.add_runtime_dependency 'tomograph', '~> 0.4', '>= 0.4.0'
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/fitting.rb

@@ -1,15 +1,11 @@
 require 'fitting/version'
 require 'fitting/configuration'
 require 'fitting/storage/documentation'
-require 'fitting/storage/skip'
 require 'fitting/matchers/response_matcher'
-require 'rspec/core'
 require 'fitting/statistics'
 require 'fitting/documentation'
 require 'fitting/storage/responses'
 
-ERROR_EXIT_CODE = 1
-
 module Fitting
   class << self
     def configure
@@ -19,46 +15,19 @@ module Fitting
     def configuration
       @configuration ||= Configuration.new
     end
-  end
-end
-
-module RSpec
-  module Core
-    # Provides the main entry point to run a suite of RSpec examples.
-    class Runner
-      alias origin_run_specs run_specs
 
-      def run_specs(example_groups)
-        returned_exit_code = origin_run_specs(example_groups)
+    def statistics
+      responses = Fitting::Storage::Responses.new
 
-        return returned_exit_code if Fitting::Storage::Skip.get
-
-        statistics = Fitting::Statistics.new(
-          Fitting::Documentation.new(Fitting::Storage::Documentation.tomogram, Fitting.configuration.white_list),
-          Fitting::Storage::Responses.all,
-          Fitting.configuration.strict
-        )
-        puts statistics if Fitting.configuration.show_statistics_in_console
-        if Fitting.configuration.create_report_with_name
-          statistics.save(Fitting.configuration.create_report_with_name)
+      RSpec.configure do |config|
+        config.after(:each, type: :controller) do
+          responses.add(response)
         end
 
-        if Fitting.configuration.necessary_fully_implementation_of_responses &&
-          returned_exit_code == 0 &&
-          statistics.not_coverage?
-          return ERROR_EXIT_CODE
+        config.after(:suite) do
+          responses.statistics.save
         end
-        returned_exit_code
       end
     end
   end
 end
-
-RSpec.configure do |config|
-  config.after(:each, :type => :controller) do
-    Fitting::Storage::Responses.push(
-      Fitting::Response.new(
-        response,
-        Fitting::Storage::Documentation.tomogram))
-  end
-end

data/lib/fitting/configuration.rb

@@ -2,19 +2,13 @@ module Fitting
   class Configuration
     attr_accessor :apib_path,
                   :drafter_yaml_path,
-                  :necessary_fully_implementation_of_responses,
                   :strict,
                   :prefix,
-                  :white_list,
-                  :create_report_with_name,
-                  :tomogram,
-                  :show_statistics_in_console
+                  :white_list
 
     def initialize
-      @necessary_fully_implementation_of_responses = true
       @strict = false
       @prefix = ''
-      @show_statistics_in_console = true
     end
   end
 end

data/lib/fitting/matchers/response_matcher.rb

@@ -59,11 +59,11 @@ module Fitting
       end
     end
 
-    def match_response
+    def match_schema
       Response.new
     end
 
-    def strict_match_response
+    def strictly_match_schema
       StrictResponse.new
     end
   end

data/lib/fitting/response.rb

@@ -1,5 +1,7 @@
 require 'fitting/request'
 require 'fitting/response/fully_validates'
+require 'json'
+require 'multi_json'
 
 module Fitting
   class Response
@@ -35,12 +37,12 @@ module Fitting
     end
 
     def got
-      @body
+      JSON.pretty_generate(MultiJson.load(@body))
     end
 
     def expected
-      @schemas.inject([]) do |res, schema|
-        res.push("#{schema}")
+      @expected ||= @schemas.inject([]) do |res, schema|
+        res.push("#{JSON.pretty_generate(schema)}")
       end.join("\n\n")
     end
 

data/lib/fitting/route.rb

@@ -10,16 +10,18 @@ module Fitting
       @responses = Fitting::Route::Responses.new(routes, @coverage)
     end
 
-    def not_coverage?
-      @coverage.not_coverage.present?
-    end
-
     def statistics
       [@requests.statistics, @responses.statistics].join("\n\n")
     end
 
     def statistics_with_conformity_lists
+      return "All responses are 100% valid! Great job!\n" if @coverage.not_coverage.empty?
+
       [@requests.conformity_lists, statistics].join("\n\n")
     end
+
+    def errors
+      @coverage.not_coverage.join("\n") + "\n"
+    end
   end
 end

data/lib/fitting/statistics.rb

@@ -1,4 +1,5 @@
 require 'fitting/route'
+require 'fileutils'
 
 module Fitting
   class Statistics
@@ -8,12 +9,10 @@ module Fitting
       @white_route = Fitting::Route.new(all_responses, @documentation.white, strict)
     end
 
-    def not_coverage?
-      @white_route.not_coverage?
-    end
-
-    def save(name)
-      File.open(name, 'w') { |file| file.write(to_s) }
+    def save
+      FileUtils::mkdir_p 'fitting'
+      File.open('fitting/stats', 'w') { |file| file.write(to_s) }
+      File.open('fitting/not_covered', 'w') { |file| file.write(@white_route.errors) }
     end
 
     def to_s

data/lib/fitting/storage/documentation.rb

@@ -7,23 +7,23 @@ module Fitting
     module Documentation
       class << self
         def tomogram
-          @tomogram ||= if Fitting.configuration.apib_path
+          @tomogram ||= craft
+        end
+
+        def craft
+          if Fitting.configuration.apib_path
             @yaml ||= `drafter #{Fitting.configuration.apib_path}`
             Tomograph.configure do |config|
               config.drafter_yaml = @yaml
               config.prefix = Fitting.configuration.prefix
             end
-            TomogramRouting::Tomogram.craft(Tomograph::Tomogram.json)
-          elsif Fitting.configuration.tomogram
-            # legacy
-            TomogramRouting::Tomogram.craft(Fitting.configuration.tomogram)
           else
             Tomograph.configure do |config|
               config.documentation = Fitting.configuration.drafter_yaml_path
               config.prefix = Fitting.configuration.prefix
             end
-            TomogramRouting::Tomogram.craft(Tomograph::Tomogram.json)
           end
+          TomogramRouting::Tomogram.craft(Tomograph::Tomogram.json)
         end
       end
     end

data/lib/fitting/storage/responses.rb

@@ -1,20 +1,25 @@
 module Fitting
   module Storage
-    module Responses
-      class << self
-        def push(test)
-          @responses ||= []
-          @responses.push(test)
-        end
+    class Responses
+      def initialize
+        @responses = []
+      end
 
-        def all
-          @responses ||= []
-          @responses.uniq
-        end
+      def add(response)
+        @responses.push(
+          Fitting::Response.new(
+            response,
+            Fitting::Storage::Documentation.tomogram))
+      end
 
-        def nil?
-          @responses.nil?
-        end
+      def statistics
+        Fitting::Statistics.new(
+          Fitting::Documentation.new(
+            Fitting::Storage::Documentation.tomogram,
+            Fitting.configuration.white_list),
+          @responses.uniq,
+          Fitting.configuration.strict
+        )
       end
     end
   end

data/lib/fitting/version.rb

@@ -1,3 +1,3 @@
 module Fitting
-  VERSION = '1.6.2'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitting
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 2.0.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-03 00:00:00.000000000 Z
+date: 2017-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -64,26 +64,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: tomograph
   requirement: !ruby/object:Gem::Requirement
@@ -244,7 +224,6 @@ files:
 - lib/fitting/statistics.rb
 - lib/fitting/storage/documentation.rb
 - lib/fitting/storage/responses.rb
-- lib/fitting/storage/skip.rb
 - lib/fitting/version.rb
 homepage: https://github.com/funbox/fitting
 licenses:

data/lib/fitting/storage/skip.rb

@@ -1,15 +0,0 @@
-module Fitting
-  module Storage
-    module Skip
-      class << self
-        def set(skip)
-          @skip = skip
-        end
-
-        def get
-          @skip ||= false
-        end
-      end
-    end
-  end
-end