fitting 0.4.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b691110010526d218502ab3a96d72d42c2f7b7ee
-  data.tar.gz: 22970b49d14ae1a301104accc9eacd00c36cdafe
+  metadata.gz: 3fd051bc55d0a84202300a746cb5c75041440924
+  data.tar.gz: a6be0e42f772ea7dd5505dc46a0eee5b68b90c29
 SHA512:
-  metadata.gz: 739fd734d8ff748bbd7e3dbe5f55e8d402b1abb6493872e92b9ba1ddcbb77c145f4f388b52aed0a3c8a5a6b8560cb5646640e0905c980b0e3f2a67d7562e070f
-  data.tar.gz: 3990b73d16072cdb1f2a570d7c1ed2efc0c9b31e9e5f3322b789d5e08546de29e368edd93b4ecf4e4deea70a9c5bde9de7fb8445e829db055f80f019ba8909bb
+  metadata.gz: 2fe0cb6d71f87702f48a83573732f515aa673d616e32f92b479144129423129aca0bb9bbfca65672fa55f9cc695e58fdeea07e038af99a88db70e0fa2706ec77
+  data.tar.gz: 6f5bdefbe659626a84a41b7682fe0edfb90a7dbb7f3768e7ad55d36787d53e2fa4e422544538b2f186e2e1235c909ae263f751ac055c147c56d24b490ee774a1

data/.gitignore

@@ -9,5 +9,3 @@
 /tmp/
 .idea/
 .byebug_history
-report_response_macro.yaml
-report_response_micro.yaml

data/README.md

@@ -24,34 +24,11 @@ Or install it yourself as:
 
 ## Usage
 
-### rspec-rails
-
-rails_helper.rb
+In your `spec_helper.rb`:
 
 ```ruby
-require 'fitting'
-config.after(:each, :type => :controller) do
-  Fitting::Documentation.try_on(self, request, response)
-end
-```
-
-### Formatting
-
-```
-bundle exec rspec --format Fitting::Formatter::Response::MacroYaml
-```
-
-or
-
+config.include JSON::SchemaMatchers
 ```
-bundle exec rspec --format Fitting::Formatter::Response::MicroYaml
-```
-
-After that you can find the report in `report_response_macro.yaml` or `report_response_micro.yaml`.
-
-## Config
-
-### tomogram
 
 This gem takes a simplified format json convert from API Blueprint which we have called API Tomogram.
 
@@ -64,17 +41,23 @@ Use gem [tomograph](https://github.com/funbox/tomograph)
 
 ```
 
-### skip_not_documented
+You can then write tests such as:
 
-Default true.
+```ruby
+ expect(response).to match_response
+```
 
-### validation_requests
+If you want check all tests:
 
-Default true.
+```ruby
+config.after(:each, :type => :controller) do
+  expect(response).to match_response
+end
+```
 
-### validation_response
+## Report
 
-Default true.
+Autogenerate `report_request_by_response.yaml` and `report_response.yaml reports`.
 
 ## Contributing
 

data/lib/fitting.rb

@@ -1,6 +1,11 @@
 require 'fitting/version'
-require 'fitting/documentation'
 require 'fitting/configuration'
+require 'fitting/documentation/response/route'
+require 'fitting/documentation/request/route'
+require 'fitting/storage/responses'
+require 'fitting/storage/documentation'
+require 'fitting/report/response'
+require 'fitting/matchers/response_matcher'
 
 module Fitting
   class << self
@@ -13,3 +18,26 @@ module Fitting
     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)
+        origin_run_specs(example_groups)
+        return if Fitting::Storage::Responses.nil?
+
+        response_routes = Fitting::Documentation::Response::Route.new(
+          Fitting::Storage::Documentation.hash,
+          Fitting::Storage::Responses.all
+        )
+        request_routes = Fitting::Documentation::Request::Route.new(response_routes)
+        puts "Coverage documentation API (responses) by RSpec tests: #{response_routes.cover_ratio}%"
+        Fitting::Report::Response.new('report_response.yaml', response_routes).save
+        Fitting::Report::Response.new('report_request_by_response.yaml', request_routes).save
+      end
+    end
+  end
+end

data/lib/fitting/configuration.rb

@@ -1,14 +1,5 @@
 module Fitting
   class Configuration
-    attr_accessor :tomogram,
-                  :skip_not_documented,
-                  :validation_requests,
-                  :validation_response
-
-    def initialize
-      @skip_not_documented = true
-      @validation_requests = true
-      @validation_response = true
-    end
+    attr_accessor :tomogram
   end
 end

data/lib/fitting/documentation/request/route.rb

@@ -0,0 +1,57 @@
+require 'multi_json'
+
+module Fitting
+  module Documentation
+    module Request
+      class Route
+        def initialize(response_routes)
+          @response_routes = response_routes
+        end
+
+        def coverage_statistic
+          stat = {}
+          @response_routes.coverage.map do |route|
+            macro_key = route.split(' ')[0..1].join(' ')
+            micro_key = route.split(' ')[2..3].join(' ')
+            stat[macro_key] ||= {}
+            stat[macro_key]['cover'] ||= []
+            stat[macro_key]['not_cover'] ||= []
+            stat[macro_key]['cover'].push(micro_key)
+          end
+          @response_routes.not_coverage.map do |route|
+            macro_key = route.split(' ')[0..1].join(' ')
+            micro_key = route.split(' ')[2..3].join(' ')
+            stat[macro_key] ||= {}
+            stat[macro_key]['cover'] ||= []
+            stat[macro_key]['not_cover'] ||= []
+            stat[macro_key]['not_cover'].push(micro_key)
+          end
+          @stat = stat.inject(
+            {
+              'full cover' => [],
+              'partial cover' => [],
+              'no cover' => []
+            }
+          ) do |res, date|
+            ratio = date.last['cover_ratio'] =
+              (date.last['cover'].size.to_f /
+                (date.last['cover'].size + date.last['not_cover'].size).to_f * 100.0).round(2)
+            info = {date.first => {'cover' => date.last['cover'], 'not_cover' => date.last['not_cover']}}
+            if ratio == 100.0
+              res['full cover'].push(info)
+            elsif ratio == 0.0
+              res['no cover'].push(info)
+            else
+              res['partial cover'].push(info)
+            end
+            res
+          end
+        end
+
+        def to_hash
+          @stat ||= coverage_statistic
+        end
+      end
+    end
+  end
+end

data/lib/fitting/documentation/response/route.rb

@@ -0,0 +1,51 @@
+require 'multi_json'
+
+module Fitting
+  module Documentation
+    module Response
+      class Route
+        def initialize(tomogram, coverage_responses)
+          @tomogram = tomogram
+          @coverage_responses = coverage_responses
+        end
+
+        def coverage
+          @coverage ||= @coverage_responses.map do |response|
+            response.route if response.documented? && response.valid?
+          end.compact.uniq
+        end
+
+        def not_coverage
+          @not_coverage ||= all - coverage
+        end
+
+        def all
+          @all ||= MultiJson.load(@tomogram).inject([]) do |routes, request|
+            request['responses'].inject({}) do |responses, response|
+              responses[response['status']] ||= 0
+              responses[response['status']] += 1
+              responses
+            end.map do |status, indexes|
+              indexes.times do |index|
+                route = "#{request['method']} #{request['path']} #{status} #{index}"
+                routes.push(route)
+              end
+            end
+            routes
+          end.uniq
+        end
+
+        def cover_ratio
+          @cover_ratio ||= (coverage.size.to_f / all.size.to_f * 100.0).round(2)
+        end
+
+        def to_hash
+          {
+            'coverage' => coverage,
+            'not coverage' => not_coverage
+          }
+        end
+      end
+    end
+  end
+end

data/lib/fitting/matchers/response_matcher.rb

@@ -0,0 +1,40 @@
+require 'fitting/response'
+require 'fitting/storage/responses'
+require 'fitting/storage/documentation'
+
+module Fitting
+  module Matchers
+    class Response
+      def matches?(response)
+        @response = Fitting::Response.new(
+          response,
+          Fitting::Storage::Documentation.tomogram
+        )
+        Fitting::Storage::Responses.push(@response)
+        @response.valid?
+      end
+
+      def ===(other)
+        matches?(other)
+      end
+
+      def failure_message
+        unless @response.documented?
+          return "response not documented\n"\
+                 "got: #{@response.real_request_with_status}"
+        end
+
+        unless @response.valid?
+          "response not valid json-schema\n"\
+          "got: #{@response.got}\n"\
+          "diff: \n#{@response.diff}"\
+          "expected: \n#{@response.expected}\n"
+        end
+      end
+    end
+
+    def match_response
+      Response.new
+    end
+  end
+end

data/lib/fitting/report/response.rb

@@ -0,0 +1,18 @@
+require 'yaml'
+
+module Fitting
+  module Report
+    class Response
+      def initialize(name, routes)
+        @name = name
+        @json = routes.to_hash
+      end
+
+      def save
+        File.open(@name, 'w') do |file|
+          file.write(YAML.dump(@json))
+        end
+      end
+    end
+  end
+end

data/lib/fitting/request.rb

@@ -1,35 +1,32 @@
+require 'json-schema'
+
 module Fitting
   class Request
-    attr_accessor :path, :method, :body, :schema
-
-    class Unsuitable < RuntimeError; end
-    class NotDocumented < RuntimeError; end
-
     def initialize(env_request, tomogram)
       @method = env_request.request_method
       @path = env_request.env['PATH_INFO']
       @body = env_request.env['action_dispatch.request.request_parameters']
       @schema = tomogram.find_request(method: @method, path: @path)
-      raise NotDocumented unless @schema || Fitting.configuration.skip_not_documented
+      @fully_validate = JSON::Validator.fully_validate(@schema['request'], @body) if @schema
+      @valid = false
+      @valid = true if @fully_validate == []
       self
     end
 
-    def valid!
-      res = JSON::Validator.fully_validate(@schema['request'], @body)
-      raise Unsuitable unless res.empty?
+    def route
+      "#{@schema['method']} #{@schema['path']}"
     end
 
-    def validate?
-      @schema && Fitting.configuration.validation_requests
+    def real_method_with_path
+      "#{@method} #{@path}"
     end
 
-    def to_hash
-      {
-        'method' => @method,
-        'path' => @path,
-        'body' => @body,
-        'schema' => @schema
-      }
+    def schemas_of_possible_responses(status:)
+      if @schema
+        @schema.find_responses(status: status).map do |response|
+          response['body']
+        end
+      end
     end
   end
 end

data/lib/fitting/response.rb

@@ -1,21 +1,14 @@
+require 'fitting/request'
+require 'json-schema'
+
 module Fitting
   class Response
-    attr_accessor :status, :body, :schemas
-
-    class Unsuitable < RuntimeError; end
-    class NotDocumented < RuntimeError; end
-
-    def initialize(env_response, expect_request)
+    def initialize(env_response, tomogram)
+      @request = Request.new(env_response.request, tomogram)
       @status = env_response.status
       @body = env_response.body
-      @schemas = expect_request.find_responses(status: @status).map{|response|response['body']} if expect_request
+      @schemas = @request.schemas_of_possible_responses(status: @status)
       @fully_validates = set_fully_validate if @schemas
-      raise Response::NotDocumented unless (@schemas && @schemas.first) || Fitting.configuration.skip_not_documented
-      self
-    end
-
-    def valid!
-      raise Unsuitable unless @valid
     end
 
     def set_fully_validate
@@ -29,18 +22,46 @@ module Fitting
       fully_validates
     end
 
-    def validate?
-      @schemas && @schemas.first && Fitting.configuration.validation_response
+    def documented?
+      @schemas && @schemas.present?
+    end
+
+    def valid?
+      @valid == true
+    end
+
+    def route
+      "#{@request.route} #{@status} #{index}"
+    end
+
+    def real_request_with_status
+      "#{@request.real_method_with_path} #{@status}"
     end
 
-    def to_hash
-      {
-        'status' => @status,
-        'body' => @body,
-        'schemas' => @schemas,
-        'fully_validates' => @fully_validates,
-        'valid' => @valid
-      }
+    def got
+      @body
+    end
+
+    def diff
+      @fully_validates.inject("") do |res, fully_validate|
+        res + "#{fully_validate}\n"
+      end
+    end
+
+    def expected
+      @schemas.inject("") do |res, schema|
+        res + "#{schema}\n"
+      end
+    end
+
+    private
+
+    def index
+      @schemas.size.times do |i|
+        if @fully_validates[i] == []
+          return i
+        end
+      end
     end
   end
 end

data/lib/fitting/storage/documentation.rb

@@ -0,0 +1,17 @@
+require 'tomogram_routing'
+
+module Fitting
+  module Storage
+    module Documentation
+      class << self
+        def tomogram
+          @tomogram ||= TomogramRouting::Tomogram.craft(hash)
+        end
+
+        def hash
+          Fitting.configuration.tomogram
+        end
+      end
+    end
+  end
+end

data/lib/fitting/storage/responses.rb

@@ -0,0 +1,21 @@
+module Fitting
+  module Storage
+    module Responses
+      class << self
+        def push(test)
+          @responses ||= []
+          @responses.push(test)
+        end
+
+        def all
+          @responses ||= []
+          @responses.uniq
+        end
+
+        def nil?
+          @responses.nil?
+        end
+      end
+    end
+  end
+end

data/lib/fitting/version.rb

@@ -1,3 +1,3 @@
 module Fitting
-  VERSION = '0.4.2'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitting
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 1.0.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -192,15 +192,14 @@ files:
 - fitting.gemspec
 - lib/fitting.rb
 - lib/fitting/configuration.rb
-- lib/fitting/documentation.rb
-- lib/fitting/formatter/response/macro_yaml.rb
-- lib/fitting/formatter/response/micro_yaml.rb
-- lib/fitting/report/response/macro.rb
-- lib/fitting/report/response/micro.rb
+- lib/fitting/documentation/request/route.rb
+- lib/fitting/documentation/response/route.rb
+- lib/fitting/matchers/response_matcher.rb
+- lib/fitting/report/response.rb
 - lib/fitting/request.rb
 - lib/fitting/response.rb
-- lib/fitting/storage/json_file.rb
-- lib/fitting/storage/yaml_file.rb
+- lib/fitting/storage/documentation.rb
+- lib/fitting/storage/responses.rb
 - lib/fitting/version.rb
 homepage: https://github.com/funbox/fitting
 licenses:

data/lib/fitting/documentation.rb

@@ -1,42 +0,0 @@
-require 'tomogram_routing'
-require 'json-schema'
-require 'fitting/storage/yaml_file'
-require 'fitting/request'
-require 'fitting/response'
-
-module Fitting
-  class Documentation
-    class << self
-      def try_on(date, env_request, env_response)
-        request = Request.new(env_request, tomogram)
-        request.valid! if request.validate?
-        response = Response.new(env_response, request.schema)
-        response.valid! if response.validate?
-        add_storage(location(date), request, response)
-      end
-
-      private
-
-      def add_storage(location, request, response)
-        Fitting::Storage::YamlFile.push(
-          location,
-          'request' => MultiJson.dump(request.to_hash),
-          'response' => MultiJson.dump(response.to_hash)
-        )
-      end
-
-      def tomogram
-        @tomogram ||= TomogramRouting::Tomogram.craft(Fitting.configuration.tomogram)
-      end
-
-      def location(date)
-        name = date.inspect.to_s
-        if name.split('(').size > 1
-          name.split('(').last.split(')').first[2..-1]
-        else
-          name.split(' ')[3][2..-3]
-        end
-      end
-    end
-  end
-end

data/lib/fitting/formatter/response/macro_yaml.rb

@@ -1,36 +0,0 @@
-require 'rspec/core/formatters/base_formatter'
-require 'yaml'
-require 'fitting/storage/yaml_file'
-require 'fitting/report/response/macro'
-
-module Fitting
-  module Formatter
-    module Response
-      class MacroYaml < RSpec::Core::Formatters::BaseFormatter
-        RSpec::Core::Formatters.register self, :start, :stop
-
-        def start(_notification)
-          Fitting::Storage::YamlFile.craft
-        end
-
-        def stop(_notification)
-          tests = Fitting::Storage::YamlFile.load
-          Fitting::Storage::YamlFile.destroy
-
-          if tests
-            report = Report::Response::Macro.new(tests).to_hash
-          else
-            report = 'no tests controllers'
-          end
-          craft_json(report)
-        end
-
-        def craft_json(report)
-          File.open('report_response_macro.yaml', 'w') do |file|
-            file.write(YAML.dump(report))
-          end
-        end
-      end
-    end
-  end
-end

data/lib/fitting/formatter/response/micro_yaml.rb

@@ -1,36 +0,0 @@
-require 'rspec/core/formatters/base_formatter'
-require 'yaml'
-require 'fitting/storage/yaml_file'
-require 'fitting/report/response/micro'
-
-module Fitting
-  module Formatter
-    module Response
-      class MicroYaml < RSpec::Core::Formatters::BaseFormatter
-        RSpec::Core::Formatters.register self, :start, :stop
-
-        def start(_notification)
-          Fitting::Storage::YamlFile.craft
-        end
-
-        def stop(_notification)
-          tests = Fitting::Storage::YamlFile.load
-          Fitting::Storage::YamlFile.destroy
-
-          if tests
-            report = Report::Response::Micro.new(tests).to_hash
-          else
-            report = 'no tests controllers'
-          end
-          craft_json(report)
-        end
-
-        def craft_json(report)
-          File.open('report_response_micro.yaml', 'w') do |file|
-            file.write(YAML.dump(report))
-          end
-        end
-      end
-    end
-  end
-end

data/lib/fitting/report/response/macro.rb

@@ -1,89 +0,0 @@
-module Fitting
-  module Report
-    module Response
-      class Macro
-        def initialize(tests)
-          @json = responses(tests)
-        end
-
-        def responses(tests)
-          data = {
-            'not_documented' => {},
-            'invalid' => {},
-            'valid' => {}
-          }
-          full_responses = {}
-
-          tests.map do |location, test|
-            request = MultiJson.load(test['request'])
-            response = MultiJson.load(test['response'])
-            if request['schema'].nil?
-              data['not_documented'][response_key(request, response)] = [location]
-            else
-              if response['schemas'].nil?
-                data['not_documented'][response_key(request['schema'], response)] = [location]
-              else
-                responses_documented(location, response['valid'], data, response_key(request['schema'], response), full_responses, response)
-              end
-            end
-          end
-
-          not_cover = {}
-          full_responses.map do |response, date|
-            date['cases'].map do |one_case|
-              if not_cover["#{response} #{one_case}"]
-                not_cover["#{response} #{one_case}"] = not_cover["#{response} #{one_case}"] + [date['test']]
-              else
-                not_cover["#{response} #{one_case}"] = [date['test']]
-              end
-            end
-          end
-          data['not_cover_where_either'] = not_cover
-          data
-        end
-
-        def responses_documented(location, valid, data, name, full_responses, response)
-          if valid
-            unless full_responses[name]
-              full_responses[name] = {}
-              full_responses[name]['cases'] = (0..response['schemas'].size-1).to_a
-            end
-            full_responses[name]['test'] = location
-            full_responses[name]['cases'].delete(find_index(response))
-            push('valid', data, "#{name} #{find_index(response)}", location)
-          else
-            push('invalid', data, name, location)
-          end
-        end
-
-        def find_index(response)
-          response['schemas'].size.times do |i|
-            if response['fully_validates'][i] == []
-              return i
-            end
-          end
-        end
-
-        def push(key, data, name, location)
-          data[key] = if data[key][name]
-            data[key].merge(name => data[key][name] + [location])
-          else
-            data[key].merge(name => [location])
-          end
-        end
-
-        def request_key(request_data)
-          "#{request_data['method']} #{request_data['path']}"
-        end
-
-        def response_key(request_data, response_data)
-          "#{request_key(request_data)} #{response_data['status']}"
-        end
-
-        def to_hash
-          @json
-        end
-      end
-    end
-  end
-end

data/lib/fitting/report/response/micro.rb

@@ -1,76 +0,0 @@
-require 'multi_json'
-
-module Fitting
-  module Report
-    module Response
-      class Micro
-        def initialize(tests)
-          @json = responses(tests)
-        end
-
-        def responses(tests)
-          data = {}
-
-          tests.map do |location, test|
-            request = MultiJson.load(test['request'])
-            response = MultiJson.load(test['response'])
-            if request['schema'].nil?
-              data[location] = {
-                'status' => 'not_documented',
-                'got' => response['body']
-              }
-            else
-              if response['schemas'].nil?
-                data[location] = {
-                  'status' => 'not_documented',
-                  'got' => response['body']
-                }
-              else
-                responses_documented(location, data, response)
-              end
-            end
-          end
-
-          data
-        end
-
-        def responses_documented(location, data, response)
-          if response['valid']
-            expect_body = {}
-
-            response['schemas'].size.times do |i|
-              if response['fully_validates'][i] == []
-                expect_body = response['schemas'][i]
-              end
-            end
-
-            data[location] = {
-              'status' => 'valid',
-              'got' => response['body'],
-              'expect' => MultiJson.dump(expect_body)
-            }
-          else
-            fully_validates = response['fully_validates'].map do |fully_validate|
-              MultiJson.dump(fully_validate)
-            end
-
-            schemas = response['schemas'].map do |schema|
-              MultiJson.dump(schema)
-            end
-
-            data[location] = {
-              'status' => 'invalid',
-              'got' => response['body'],
-              'diff' => fully_validates,
-              'expected' => schemas
-            }
-          end
-        end
-
-        def to_hash
-          @json
-        end
-      end
-    end
-  end
-end

data/lib/fitting/storage/json_file.rb

@@ -1,37 +0,0 @@
-require 'multi_json'
-
-module Fitting
-  module Storage
-    class JsonFile
-      NAME = 'storage.json'.freeze
-
-      def self.craft
-        save({})
-      end
-
-      def self.save(json)
-        File.open(NAME, 'w') do |file|
-          file.write(MultiJson.dump(json))
-        end
-      end
-
-      def self.push(key, value)
-        save(tests.merge(key => value))
-      rescue
-      end
-
-      def self.tests
-        MultiJson.load(File.read(NAME))
-      rescue
-      end
-
-      def self.load
-        MultiJson.load(File.read(NAME))
-      end
-
-      def self.destroy
-        File.delete(NAME)
-      end
-    end
-  end
-end

data/lib/fitting/storage/yaml_file.rb

@@ -1,37 +0,0 @@
-require 'yaml'
-
-module Fitting
-  module Storage
-    class YamlFile
-      NAME = 'storage.yaml'.freeze
-
-      def self.craft
-        save("---\n")
-      end
-
-      def self.save(json)
-        File.open(NAME, 'w') do |file|
-          file.write(json)
-        end
-      end
-
-      def self.push(key, value)
-        save(tests + YAML.dump(key => value)[4..-1])
-      rescue
-      end
-
-      def self.tests
-        File.read(NAME)
-      rescue
-      end
-
-      def self.load
-        YAML.load(File.read(NAME))
-      end
-
-      def self.destroy
-        File.delete(NAME)
-      end
-    end
-  end
-end