json_statham 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcc57468bc33bb597b1817adc3f882a28b6f9f06e2377d3cd6abe2e0a16c1bd8
-  data.tar.gz: fae57291e39be69d2fe5a84763eb2280c3c0112719e4cc43959c0decf94bb35d
+  metadata.gz: 9241e02a36d573851c728c187de5200135c00a07cc50911c14da92447b7da2fb
+  data.tar.gz: 86bc9cf226cc9229e776413c8953c00a65444ff817faf3d3477d070919d979f2
 SHA512:
-  metadata.gz: ba7b836e09f469ec095b73b0908bf0ccffa19605fb3e1ccbf6aa855824a1c1b8f55677370595bda2b326445b61b7a8f1d010544edef8e3b30a0c923b8cce5591
-  data.tar.gz: 3c5fda63e093ff347e378b75fa507559b23b7b59cbacfaf72ef7151651ecbe43a48d5fd56dca817573a17137cd744d882ea02afa6f3ddfbe86de500fca11cb75
+  metadata.gz: cd2fc935a733ea0a3eb9f56f8ef8d8b78339a5e5f768a4cc45a38532cb1ea030a41cf040a84ae4cad8a3f1b2aa1a1816915511f09753e2b20a1d2dd54e743d64
+  data.tar.gz: 39139005d3b156f53296b0c57607fdc4fc4c718a56dca022186ed773993743c63468ae4d09d2251eb3ebfb6b75ae6bcbe7a6da10da1f30021e9561392ae35074

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## Changelog
 
+### [0.1.2] - 2023-02-07
+
+  * Features:
+    * Add `raise_ratio` to config.
+
+  * Deprecations:
+    * Remove `logger` from config.
+
+### [0.1.1] - 2023-02-07
+  yanked
+
 ### [0.1.0] - 2023-02-06
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json_statham (0.1.0)
+    json_statham (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -69,19 +69,22 @@ Available configuration attributes:
 JsonStatham.configure do |config|
   config.schemas_path = "schemas"
   config.store_schema = true
-  config.logger       = true
+  config.raise_ratio  = 10
 end
 ```
 
 *Required attributes:*
 
-- `schemas_path` The path where the json files will be read and created
+- `schemas_path` String.
+  The path where the json files will be read and created.
 
 *Optional attributes:*
 
-- `store_schema` Default to `false`. It allows to create or not a new file
+- `store_schema` Boolean, default to `false`.
+  It allows to create or not a new file.
 
-- `logger` Default to `false`. It allows to create or not a new file
+- `raise_ratio` Integer, default to `nil`.
+  The ratio of increase in execution time. This allows to raise an error when the execution of the block takes longer than expected.
 
 ## Example using RSpec
 
@@ -114,7 +117,7 @@ You can thenuse stathamnize with different traits in your spec file.
 ```ruby
 RSpec.describe UserSerializer do
   describe "Schema" do
-    subject { stathamnize(trait) { serializer }.success? }
+    subject { stathamnize(trait) { serializer } }
 
     context "Given a valid user" do
       let(:serializer) { UserSerializer.new(user).to_h }
@@ -122,7 +125,7 @@ RSpec.describe UserSerializer do
       let(:user)       { create(:user, :valid) }
 
       it "has a valid schema" do
-        expect(subject).to eq(true)
+        expect(subject.success?).to eq(true)
       end
     end
 
@@ -132,13 +135,51 @@ RSpec.describe UserSerializer do
       let(:user)       { create(:user, :invalid) }
 
       it "has a valid schema" do
-        expect(subject).to eq(true)
+        expect(subject.success?).to eq(true)
       end
     end
   end
 end
 ```
 
+Or you can create a shared example
+
+```ruby
+RSpec.shared_examples 'a serializer' do |schema_name|
+  describe "#as_json" do
+    subject do
+      stathamnize("#{serializer_path}/#{schema_name}") do
+        described_class.new(record).as_json
+      end
+    end
+
+    let(:serializer_path) { described_class.name.underscore }
+
+    it "returns #{schema_name} object as json" do
+      expect(subject.success?).to eq(true)
+    end
+  end
+end
+```
+
+Then you can use it inside your specs
+
+```ruby
+require "spec_helper"
+
+RSpec.describe FooSerializer do
+  it_behaves_like "a serializer", "foo" do
+    let(:record) { create(:foo) }
+  end
+
+  FactoryBot.factories[:foo].definition.defined_traits.map(&:name).each do |trait|
+    it_behaves_like "a serializer", trait do
+      let(:record) { create(:foo, trait) }
+    end
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/json_statham/config.rb

@@ -2,26 +2,26 @@
 
 module JsonStatham
   class Config
-    attr_reader :schemas_path, :store_schema, :logger
+    attr_reader :schemas_path, :store_schema, :raise_ratio
 
     def initialize
       @schemas_path = nil
       @store_schema = nil
-      @logger       = nil
+      @raise_ratio  = nil
     end
 
     def store_schema?
       !!store_schema
     end
 
-    def logger?
-      !!logger
-    end
-
     def schemas_path_present?
       !!schemas_path
     end
 
+    def raise_on_failure?
+      !!raise_ratio
+    end
+
     def schemas_path=(value)
       Validation.check_object_class(value, [String])
 
@@ -34,10 +34,10 @@ module JsonStatham
       @store_schema = value
     end
 
-    def logger=(value)
-      Validation.check_object_class(value, [TrueClass, FalseClass, NilClass])
+    def raise_ratio=(value)
+      Validation.check_object_class(value, [Integer])
 
-      @logger = value
+      @raise_ratio = value
     end
   end
 end

data/lib/json_statham/parser.rb

@@ -18,10 +18,11 @@ module JsonStatham
     def call
       @reader   = JsonStatham::Requests::Reader.call(self)
       @observer = JsonStatham::Requests::Observer.call(self)
+      result    = JsonStatham::Result.call(self)
 
       store_current_schema
 
-      JsonStatham::Result.call(self)
+      result
     end
 
     def store_current_schema

data/lib/json_statham/result.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module JsonStatham
+  class InvalidRatioError < StandardError
+  end
+
   class Result
-    attr_reader :parser
+    attr_reader :parser, :config
 
     def self.call(parser)
       new(parser).call
@@ -12,15 +15,11 @@ module JsonStatham
       Validation.check_object_class(parser, [JsonStatham::Parser])
 
       @parser = parser
+      @config = JsonStatham.config
     end
 
     def call
-      if JsonStatham.config.logger?
-        puts <<-RESULT_MSG
-          Previous duration: #{previous_duration}
-          Current duration: #{current_duration}
-        RESULT_MSG
-      end
+      ensure_valid_ratio
 
       self
     end
@@ -39,6 +38,10 @@ module JsonStatham
       parser.previous_duration
     end
 
+    def previous_duration?
+      !!previous_duration
+    end
+
     def success?
       parser.valid?
     end
@@ -46,5 +49,23 @@ module JsonStatham
     def failure?
       !success?
     end
+
+    def ratio
+      return 0 unless observed?
+
+      current_duration.fdiv(previous_duration)
+    end
+
+    def raise_ratio
+      config.raise_ratio
+    end
+
+    private
+
+    def ensure_valid_ratio
+      return unless config.raise_on_failure? && previous_duration? && ratio > raise_ratio
+
+      raise JsonStatham::InvalidRatioError, "raise_ratio: #{raise_ratio}. current_ratio: #{ratio}"
+    end
   end
 end

data/lib/json_statham/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonStatham
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_statham
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Victor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies: []
 description: JsonStatham allows to check the structure changes in a json
 email: