fitting 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 873df0636bcad7162066d90caaeaebef52eb1ef6
-  data.tar.gz: 3ec118c489b012fdcc62c6f3ff4600a5efe6131a
+  metadata.gz: 0f803f26bbe2cb7472a2ca8077aa7a00754ec755
+  data.tar.gz: 38f77aec3f07b3aed3f82ebcae34549a953d45f5
 SHA512:
-  metadata.gz: 7072803275b24d10a44a58762f5c884c06310339da331c41514b24ccb40417681d3f51fc532196cdfa9aa27a08f70d4a4281a3dd254729c2b6c58f3878ed9f94
-  data.tar.gz: cdd978371460f13dde294c13eae7b2c8ed049d1faaecbc236e4504abd56107ddc9868f9c2fb189e11b34f672cd633ddd0642df111687537c891ce032a5417cd2
+  metadata.gz: 3a3619063602e165398a68ea20e4630be7d3877119f11cbead7fdc05a38b4f436e2d06039b75c3d09a55b069498e0f2e043d7acb14151342a90c7282378cc580
+  data.tar.gz: 7c2ec1512bc655dbd816b3ba9665ec6af4bbf7e9c68deb8f3d1f608396ac1e24389bb5099621c732aeb0f895c019cd7e54725e825015bfe8d94829dda00586f1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+### 2.6.0 - 2018-08-28
+
+* features
+  * Add two rake tasks fitting:documentation and fitting:tests
+
 ### 2.5.0 - 2018-07-05
 
 * features

data/lib/fitting.rb

@@ -3,6 +3,7 @@ require 'fitting/configuration'
 require 'fitting/matchers/response_matcher'
 require 'fitting/documentation'
 require 'fitting/storage/responses'
+require 'fitting/railtie' if defined?(Rails)
 
 module Fitting
   class << self
@@ -19,7 +20,7 @@ module Fitting
 
       RSpec.configure do |config|
         config.after(:each, type: :controller) do
-          responses.add(response)
+          responses.add(response, self.inspect)
         end
 
         config.after(:suite) do
@@ -27,5 +28,36 @@ module Fitting
         end
       end
     end
+
+    def save_test_data
+      responses = Fitting::Storage::Responses.new
+
+      RSpec.configure do |config|
+        config.after(:each, type: :controller) do
+          responses.add(response, self.inspect)
+        end
+
+        config.after(:suite) do
+          responses.tests.save
+        end
+      end
+    end
+  end
+
+  def self.loaded_tasks=(val)
+    @loaded_tasks = val
+  end
+
+  def self.loaded_tasks
+    @loaded_tasks
+  end
+
+  def self.load_tasks
+    return if loaded_tasks
+    self.loaded_tasks = true
+
+    Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each do |rake|
+      load rake
+    end
   end
 end

data/lib/fitting/railtie.rb

@@ -0,0 +1,9 @@
+require 'rake'
+
+module Fitting
+  class MyRailtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/fitting.rake'
+    end
+  end
+end

data/lib/fitting/records/realized_unit.rb

@@ -0,0 +1,54 @@
+require 'fitting/records/test_unit/request'
+
+module Fitting
+  class Records
+    class RealizedUnit
+      def initialize(realized_requests, documented_requests)
+        @realized_requests = realized_requests
+        @documented_requests = documented_requests
+      end
+
+      def fully_covered?
+        test_file_paths.each do |key, requests|
+          all_good = requests.all? { |request| request.documented? }
+          return false unless all_good
+        end
+        test_file_paths.each do |key, requests|
+          all_good = requests.all? { |request| request.response_documented? }
+          return false unless all_good
+        end
+        test_file_paths.each do |key, requests|
+          all_good = requests.all? { |request| request.response_json_schemas? }
+          return false unless all_good
+        end
+        test_file_paths.each do |key, requests|
+          all_good = requests.all? { |request| request.valid_json_schemas? }
+          return false unless all_good
+        end
+        true
+      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] ||= []
+          @test_file_paths[request.test_file_path].push(request)
+        end
+        @test_file_paths
+      end
+
+      def all_documented_requests
+        @all_documented_requests ||= @documented_requests.to_a.inject([]) do |res, tomogram_request|
+          res.push(Fitting::Records::Documented::Request.new(tomogram_request, nil))
+        end
+      end
+
+      def white_unit
+        @white_unit_requests ||= @realized_requests.to_a.inject([]) do |res, tested_request|
+          res.push(Fitting::Records::TestUnit::Request.new(tested_request, all_documented_requests))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require 'json'
+require 'fitting/records/spherical/response'
+
+module Fitting
+  class Records
+    class Spherical
+      class Request
+        attr_reader :method, :path, :body, :response, :title, :group
+
+        def initialize(method:, path:, body:, response:, title:, group:)
+          @method = method
+          @path = path
+          @body = body
+          @response = response
+          @title = title
+          @group = group
+        end
+
+        def to_hash
+          {
+            method: method,
+            path: path.to_s,
+            body: body,
+            response: response.to_hash,
+            title: title,
+            group: group
+          }
+        end
+
+        def to_json
+          JSON.dump(to_hash)
+        end
+
+        class << self
+          def load(hash)
+            new(
+              method: hash["method"],
+              path: hash["path"],
+              body: hash["body"],
+              response: Fitting::Records::Spherical::Response.load(hash["response"]),
+              title: hash["title"],
+              group: hash["group"]
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'fitting/records/spherical/request'
+require 'json'
+
+module Fitting
+  class Records
+    class Spherical
+      class Requests
+        def to_a
+          return @to_a if @to_a
+
+          array = JSON.load(File.read('tests.json'))
+          @to_a = array.inject([]) do |res, tested_request|
+            res.push(Fitting::Records::Spherical::Request.load(tested_request))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'json'
+
+module Fitting
+  class Records
+    class Spherical
+      class Response
+        attr_reader :status, :body
+
+        def initialize(status:, body:)
+          @status = status
+          @body = body
+        end
+
+        def to_hash
+          {
+            status: status,
+            body: JSON.load(body)
+          }
+        rescue JSON::ParserError
+          {
+            status: status,
+            body: {}
+          }
+        end
+
+        def to_json
+          JSON.dump(to_hash)
+        end
+
+        class << self
+          def load(hash)
+            new(status: hash["status"], body: hash["body"])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+require 'json-schema'
+
+module Fitting
+  class Records
+    class TestUnit
+      class Request
+        def initialize(tested_request, all_documented_requests)
+          @tested_request = tested_request
+          @all_documented_requests = all_documented_requests
+        end
+
+        def method
+          @method ||= @tested_request.method
+        end
+
+        def path
+          @path ||= @tested_request.path
+        end
+
+        def body
+          @body ||= @tested_request.body
+        end
+
+        def response
+          @response ||= @tested_request.response
+        end
+
+        def test_path
+          @test_path ||= @tested_request.title
+        end
+
+        def test_file_path
+          @test_file_path ||= @tested_request.group
+        end
+
+        def documented_requests
+          @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
+
+        def documented?
+          @documented ||= documented_requests.present?
+        end
+
+        def documented_responses
+          @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
+        end
+
+        def response_documented?
+          @response_documented ||= documented_responses.present?
+        end
+
+        def response_json_schemas
+          @response_json_schemas ||= documented_responses.inject([]) do |res, documented_response|
+            res.push(documented_response["json_schemas"])
+          end.flatten
+        end
+
+        def response_json_schemas?
+          @response_json_schemas_present ||= response_json_schemas.present?
+        end
+
+        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
+
+        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)
+              }
+            )
+          end.flatten
+        end
+
+        def valid_json_schemas?
+          @valid_json_schemas_present ||= valid_json_schemas.present?
+        end
+      end
+    end
+  end
+end

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

@@ -1,12 +1,14 @@
 require 'tomograph/path'
 require 'fitting/records/tested/response'
+require 'fitting/records/spherical/request'
 
 module Fitting
   class Records
     class Tested
       class Request
-        def initialize(env_response)
+        def initialize(env_response, test_title)
           @env_response = env_response
+          @test_title = test_title
         end
 
         def method
@@ -24,6 +26,25 @@ module Fitting
         def response
           @response ||= Fitting::Records::Tested::Response.new(@env_response)
         end
+
+        def test_path
+          @test_path ||= @test_title[/#{'\(\.'}(.*?)#{'\)'}/m, 1] || @test_title[/#{'\.'}(.*?)#{'\"'}/m, 1]
+        end
+
+        def test_file_path
+          @test_file_path ||= test_path.split(':').first
+        end
+
+        def to_spherical
+          Fitting::Records::Spherical::Request.new(
+            method: method,
+            path: path,
+            body: body,
+            response: response.to_spherical,
+            title: test_path,
+            group: test_file_path
+          )
+        end
       end
     end
   end

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

@@ -1,3 +1,5 @@
+require 'fitting/records/spherical/response'
+
 module Fitting
   class Records
     class Tested
@@ -13,6 +15,13 @@ module Fitting
         def body
           @body ||= @env_response.body
         end
+
+        def to_spherical
+          Fitting::Records::Spherical::Response.new(
+            status: status,
+            body: body
+          )
+        end
       end
     end
   end

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

@@ -24,7 +24,7 @@ module Fitting
         end
 
         def tested_responses
-          @tested_responses ||= @tested_requests.inject([]) do |res, tested_request|
+          @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)

data/lib/fitting/storage/responses.rb

@@ -1,4 +1,5 @@
 require 'fitting/statistics'
+require 'fitting/tests'
 require 'fitting/records/tested/request'
 
 module Fitting
@@ -8,13 +9,17 @@ module Fitting
         @tested_requests = []
       end
 
-      def add(env_response)
-        @tested_requests.push(Fitting::Records::Tested::Request.new(env_response))
+      def add(env_response, test_title = '')
+        @tested_requests.push(Fitting::Records::Tested::Request.new(env_response, test_title))
       end
 
       def statistics
         Fitting::Statistics.new(@tested_requests)
       end
+
+      def tests
+        Fitting::Tests.new(@tested_requests)
+      end
     end
   end
 end

data/lib/fitting/templates/realized_template.rb

@@ -0,0 +1,49 @@
+module Fitting
+  class Templates
+    class RealizedTemplate
+      def initialize(realized_unit)
+        @realized_unit = realized_unit
+      end
+
+      def to_s
+        res = ''
+        res += "1. Find request method and path:\n"
+        @realized_unit.test_file_paths.each do |key, requests|
+          all_good = requests.all? { |request| request.documented? }
+          res += "file: #{key} #{all_good ? '✔' : '✖'}\n"
+        end
+        res += "\n2. Find response status code:\n"
+        @realized_unit.test_file_paths.each do |key, requests|
+          all_good = requests.all? { |request| request.response_documented? }
+          res += "file: #{key} #{all_good ? '✔' : '✖'}\n"
+        end
+        res += "\n3. Find response json-schemas:\n"
+        @realized_unit.test_file_paths.each do |key, requests|
+          all_good = requests.all? { |request| request.response_json_schemas? }
+          res += "file: #{key} #{all_good ? '✔' : '✖'}\n"
+        end
+        res += "\n4. Check valid json-schemas:\n"
+        @realized_unit.test_file_paths.each do |key, requests|
+          all_good = requests.all? { |request| request.valid_json_schemas? }
+          res += "path: #{key} #{all_good ? '✔' : '✖'}\n"
+          unless all_good
+            requests.map do |request|
+              unless request.valid_json_schemas?
+                res += "  full path: #{request.test_path} ✖\n"
+                res += "    request.method #{request.method}\n"
+                res += "    request.path #{request.path}\n"
+                res += "    request.response.status #{request.response.status}\n"
+                res += "    request.response.body #{request.response.body}\n\n"
+                request.invalid_json_schemas.map do |schema|
+                  res += "    json_schemas: #{schema[:json_schema]}\n"
+                  res += "    fully_validate: #{schema[:fully_validate]}\n\n"
+                end
+              end
+            end
+          end
+        end
+        res
+      end
+    end
+  end
+end

data/lib/fitting/tests.rb

@@ -0,0 +1,23 @@
+require 'fitting/statistics/template'
+
+module Fitting
+  class Tests
+    def initialize(tested_requests)
+      @tested_requests = tested_requests
+    end
+
+    def save
+      array = @tested_requests.inject([]) do |res, request|
+        next res unless request.path.to_s.start_with?(Fitting.configuration.prefix)
+        res.push(request.to_spherical.to_hash)
+      end
+      json = JSON.dump(array)
+      File.open("tests.json", 'w') { |file| file.write(json) }
+    end
+
+    def make_dir(dir_name)
+      FileUtils.mkdir_p(dir_name)
+    end
+  end
+end
+

data/lib/fitting/version.rb

@@ -1,3 +1,3 @@
 module Fitting
-  VERSION = '2.5.0'.freeze
+  VERSION = '2.6.0'.freeze
 end

data/lib/tasks/fitting.rake

@@ -0,0 +1,34 @@
+require 'fitting/records/spherical/requests'
+require 'fitting/configuration'
+require 'fitting/records/realized_unit'
+require 'fitting/templates/realized_template'
+
+namespace :fitting do
+  desc 'Fitting documentation'
+  task :documentation do
+    documented_unit = Fitting::Statistics::Template.new(
+      Fitting::Records::Spherical::Requests.new,
+      Fitting.configuration
+    )
+    puts documented_unit.stats
+
+    unless documented_unit.not_covered == "\n"
+      puts 'Not all responses from the whitelist are covered!'
+      exit 1
+    end
+  end
+
+  desc 'Fitting tests'
+  task :tests do
+    realized_unit = Fitting::Records::RealizedUnit.new(
+      Fitting::Records::Spherical::Requests.new,
+      Fitting.configuration.tomogram
+    )
+    puts Fitting::Templates::RealizedTemplate.new(realized_unit).to_s
+
+    unless realized_unit.fully_covered?
+      puts 'Not all responses from the whitelist are covered!'
+      exit 1
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitting
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-06 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -197,7 +197,13 @@ files:
 - lib/fitting/configuration/yaml.rb
 - lib/fitting/documentation.rb
 - lib/fitting/matchers/response_matcher.rb
+- lib/fitting/railtie.rb
 - lib/fitting/records/documented/request.rb
+- lib/fitting/records/realized_unit.rb
+- lib/fitting/records/spherical/request.rb
+- lib/fitting/records/spherical/requests.rb
+- lib/fitting/records/spherical/response.rb
+- lib/fitting/records/test_unit/request.rb
 - lib/fitting/records/tested/request.rb
 - lib/fitting/records/tested/response.rb
 - lib/fitting/records/unit/json_schema.rb
@@ -219,7 +225,10 @@ files:
 - lib/fitting/statistics/template.rb
 - lib/fitting/storage/responses.rb
 - lib/fitting/storage/white_list.rb
+- lib/fitting/templates/realized_template.rb
+- lib/fitting/tests.rb
 - lib/fitting/version.rb
+- lib/tasks/fitting.rake
 homepage: https://github.com/funbox/fitting
 licenses:
 - MIT