jsonschema-matchers 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 376dbc86c2fda4f6e14a1c8442456b7ebb6093eb1b4d95e0787a3f06d0e6d1ef
-  data.tar.gz: 7a68f17ec58a5e779113d3b3f1236b7d1a97e352b9aeea5c954c815457d23880
+  metadata.gz: fcecc26c13440bd38f15ad40ad312c181e41af0950095126bad000f70f3899d8
+  data.tar.gz: ccde3fd0477af5c0342e223c6d9e2a74779c7f4688f25583e6e21a86d457ee3e
 SHA512:
-  metadata.gz: 02dc52f0df17e22782fec7a020206fa369842f0377088225b503c10fe322e0a6f20c45b1b62e41be80abae548dd48997edbd78a95d2ee27eb94046f8b91e4989
-  data.tar.gz: f738b6b69563a72f1078ab6cbdd3504351b9100f224a9ee867d29c517542ef795d37a27186d2237bef916167f8619ca4bdce9cefcb09224f12dfebe191b2beae
+  metadata.gz: cfd13418ee589571128f2444c9f77250162d25d1af9ca917ec6c6f529053ef89a8d05124f87bd2d6dd6fbaf33e1fb4817e65e3c1ae02b18868c1391e37f53b9f
+  data.tar.gz: b2677a218f124acd431cdbf1388da22fe92907fbcd7c75a4a11011566f7fb545f9fb2b2189b76ec47cc4d56240d67abb4eb8f478fe2f2cdaafc492edd0ef044d

data/README.md

@@ -22,8 +22,172 @@ Or install it yourself as:
 
 ## Usage
 
+Json example
+
+```ruby
+RSpec.describe 'Users Requests', type: :request do
+  describe 'GET index' do
+    before { create_list(:user, 5) }
+
+    it 'matches correct schema' do
+      get '/users'
+      expect(response.body).to match_jsonschema
+    end
+  end
+end
+```
+
+Will match/create schema
+
+`spec/jsonschemas/Users_Requests/GET_index/matches_correct_schema.json`
+
+```json
+{
+  "title": "Root",
+  "type": "array",
+  "minItems": 5,
+  "maxItems": 5,
+  "items": {
+    "properties": {
+      "id": {
+        "type": "integer"
+      },
+      "email": {
+        "type": "string"
+      },
+      "password_digest": {
+        "type": "null"
+      },
+      "created_at": {
+        "type": "string"
+      },
+      "updated_at": {
+        "type": "string"
+      },
+      "posts": {
+        "type": "array",
+        "minItems": 0,
+        "maxItems": 0,
+        "items": {
+        }
+      }
+    },
+    "type": "object",
+    "required": [
+      "id",
+      "email",
+      "password_digest",
+      "created_at",
+      "updated_at",
+      "posts"
+    ]
+  }
+}
+```
+
+JsonApi example
+
+```ruby
+RSpec.describe 'Users Requests', type: :request do
+  describe 'GET show' do
+    let(:user) { create(:user) }
+
+    before { create(:post, user: user) }
+
+    it 'matches correct schema with jsonapi spec' do
+      get "/users/#{user.id}"
+      expect(response.body).to match_jsonschema
+    end
+  end
+end
+```
+
+Will match/create schema
+
+`spec/jsonschemas/Users_Requests/GET_show/matches_correct_schema_with_jsonapi_spec.json`
+
+```json
+{
+  "title": "Root",
+  "properties": {
+    "data": {
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        },
+        "attributes": {
+          "properties": {
+            "email": {
+              "type": "string"
+            }
+          },
+          "type": "object",
+          "required": [
+            "email"
+          ]
+        },
+        "relationships": {
+          "properties": {
+            "posts": {
+              "properties": {
+                "data": {
+                  "type": "array",
+                  "minItems": 1,
+                  "maxItems": 1,
+                  "items": {
+                    "properties": {
+                      "id": {
+                        "type": "string"
+                      },
+                      "type": {
+                        "type": "string"
+                      }
+                    },
+                    "type": "object",
+                    "required": [
+                      "id",
+                      "type"
+                    ]
+                  }
+                }
+              },
+              "type": "object",
+              "required": [
+                "data"
+              ]
+            }
+          },
+          "type": "object",
+          "required": [
+            "posts"
+          ]
+        }
+      },
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "attributes",
+        "relationships"
+      ]
+    }
+  },
+  "type": "object",
+  "required": [
+    "data"
+  ]
+}
+```
+
+## Configuration
+
 ```ruby
-  expect(json_body).to match_jsonschema
+Jsonschema::Matchers.configure do |config|
+  config.schema_dir = 'spec/jsonschemas' # Default path
+end
 ```
 
 ## Development

data/jsonschema-matchers.gemspec

@@ -49,4 +49,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'fakefs', '~> 0.18'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.72'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.33'
 end

data/lib/jsonschema/matchers.rb

@@ -8,13 +8,33 @@ require 'jsonschema/matchers/version'
 require 'jsonschema/matchers/metadater'
 require 'jsonschema/generator'
 
+NO_SCHEMA_NAME_ERROR = 'No schema name provided'
+
+require 'jsonschema/matchers/configuration'
+
 module Jsonschema
-  # Matchers
+  # Main
   module Matchers
     class Error < StandardError; end
 
-    def match_jsonschema(name)
-      MatchJsonschema.new(self.class.metadata, name)
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def match_jsonschema(name: nil)
+      schema_name = name || inspect.scan(/\"(.*?)\"/).join
+
+      raise Error, NO_SCHEMA_NAME_ERROR unless schema_name
+
+      MatchJsonschema.new(self.class.metadata, schema_name)
     end
   end
 end

data/lib/jsonschema/matchers/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Jsonschema
+  module Matchers
+    # Configuration
+    class Configuration
+      attr_accessor :schema_dir
+
+      def initialize
+        @schema_dir = 'spec/jsonschemas'
+      end
+    end
+  end
+end

data/lib/jsonschema/matchers/match_jsonschema.rb

@@ -10,8 +10,8 @@ module Jsonschema
 
       def initialize(metadata, name)
         @metadata = metadata
-        @path = "spec/jsonschemas/#{Metadater.call(metadata)}"
-        @name = name
+        @path = "#{root_dir}/#{Metadater.call(metadata)}"
+        @name = name.downcase.gsub(%r{[\/\s]}, '/' => '_', ' ' => '_')
       end
 
       def matches?(actual)
@@ -29,6 +29,10 @@ module Jsonschema
 
       private
 
+      def root_dir
+        Jsonschema::Matchers.configuration.schema_dir
+      end
+
       def record(actual)
         json_schema = Jsonschema::Generator.call(actual)
         file_name = "#{name}.json"

data/lib/jsonschema/matchers/version.rb

@@ -2,6 +2,6 @@
 
 module Jsonschema
   module Matchers
-    VERSION = '0.1.4'
+    VERSION = '0.1.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonschema-matchers
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Alex Bykov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.72'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.72'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.33'
 description: Jsonschema matchers.
 email:
 - leksster@gmail.com
@@ -114,6 +142,7 @@ files:
 - bin/setup
 - jsonschema-matchers.gemspec
 - lib/jsonschema/matchers.rb
+- lib/jsonschema/matchers/configuration.rb
 - lib/jsonschema/matchers/match_jsonschema.rb
 - lib/jsonschema/matchers/metadater.rb
 - lib/jsonschema/matchers/version.rb
@@ -140,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Jsonschema matchers