json_statham 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcc57468bc33bb597b1817adc3f882a28b6f9f06e2377d3cd6abe2e0a16c1bd8
-  data.tar.gz: fae57291e39be69d2fe5a84763eb2280c3c0112719e4cc43959c0decf94bb35d
+  metadata.gz: e8086da405fa7309573448af4957f39283b821b40419269126c81e00d653aea0
+  data.tar.gz: 75e2b6b518a10367b81c28cc358e855aad94e603ca251a7dca3201df86e9a7ef
 SHA512:
-  metadata.gz: ba7b836e09f469ec095b73b0908bf0ccffa19605fb3e1ccbf6aa855824a1c1b8f55677370595bda2b326445b61b7a8f1d010544edef8e3b30a0c923b8cce5591
-  data.tar.gz: 3c5fda63e093ff347e378b75fa507559b23b7b59cbacfaf72ef7151651ecbe43a48d5fd56dca817573a17137cd744d882ea02afa6f3ddfbe86de500fca11cb75
+  metadata.gz: 7aa2487a098ad2ad6dee3ab47a7257c866b41ebdc3d676f09a99f6c86c43ff82180208e63be708aeb471694c1e82d750e02dcd685a91e17121c3728693cf659b
+  data.tar.gz: b548f34e21f7963ce62c4f957740fc312129c08e74fd2f8e7b552a1430a7be782e63017e00e3bd783b2c4db37e9ec9ed4c3d79d460351fb3b90e14aee76657c1

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   NewCops: enable
   SuggestExtensions: false
   Exclude:

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## Changelog
 
+### [0.1.3] - 2023-02-18
+
+  * Features:
+    * Add Rails support.
+
+### [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

@@ -14,3 +14,10 @@ gem "rubocop", "~> 1.21"
 gem "pry", "~> 0.14.2"
 
 gem "simplecov", "~> 0.22.0"
+
+gem "rails", "~> 6.1.7.1"
+
+group :test do
+  gem "generator_spec"
+  gem "rspec-rails"
+end

data/Gemfile.lock

@@ -1,23 +1,149 @@
 PATH
   remote: .
   specs:
-    json_statham (0.1.0)
+    json_statham (0.1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (6.1.7.1)
+      actionpack (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.7.1)
+      actionpack (= 6.1.7.1)
+      activejob (= 6.1.7.1)
+      activerecord (= 6.1.7.1)
+      activestorage (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.7.1)
+      actionpack (= 6.1.7.1)
+      actionview (= 6.1.7.1)
+      activejob (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.7.1)
+      actionview (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.7.1)
+      actionpack (= 6.1.7.1)
+      activerecord (= 6.1.7.1)
+      activestorage (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.7.1)
+      activesupport (= 6.1.7.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.7.1)
+      activesupport (= 6.1.7.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.7.1)
+      activesupport (= 6.1.7.1)
+    activerecord (6.1.7.1)
+      activemodel (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
+    activestorage (6.1.7.1)
+      actionpack (= 6.1.7.1)
+      activejob (= 6.1.7.1)
+      activerecord (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.7.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
+    builder (3.2.4)
     coderay (1.1.3)
+    concurrent-ruby (1.2.0)
+    crass (1.0.6)
+    date (3.3.3)
     diff-lcs (1.5.0)
     docile (1.4.0)
+    erubi (1.12.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
     json (2.6.3)
+    loofah (2.19.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
     method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.17.0)
+    net-imap (0.3.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.8)
+    nokogiri (1.14.1-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.1-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.22.1)
     parser (3.2.0.0)
       ast (~> 2.4.1)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    racc (1.6.2)
+    rack (2.2.6.2)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (6.1.7.1)
+      actioncable (= 6.1.7.1)
+      actionmailbox (= 6.1.7.1)
+      actionmailer (= 6.1.7.1)
+      actionpack (= 6.1.7.1)
+      actiontext (= 6.1.7.1)
+      actionview (= 6.1.7.1)
+      activejob (= 6.1.7.1)
+      activemodel (= 6.1.7.1)
+      activerecord (= 6.1.7.1)
+      activestorage (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.7.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (6.1.7.1)
+      actionpack (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.2)
@@ -34,6 +160,14 @@ GEM
     rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
+    rspec-rails (6.0.1)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.11)
+      rspec-expectations (~> 3.11)
+      rspec-mocks (~> 3.11)
+      rspec-support (~> 3.11)
     rspec-support (3.12.0)
     rubocop (1.44.1)
       json (~> 2.3)
@@ -54,17 +188,35 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    sprockets (4.2.0)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    thor (1.2.1)
+    timeout (0.3.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
+  generator_spec
   json_statham!
   pry (~> 0.14.2)
+  rails (~> 6.1.7.1)
   rake (~> 13.0)
   rspec (~> 3.0)
+  rspec-rails
   rubocop (~> 1.21)
   simplecov (~> 0.22.0)
 

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,75 @@ 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
+```
+
+## Rails
+
+Run the generator:
+
+    $ rails g json_statham:install
+
+This will create a new initializer at **config/initializers/json_statham.rb**.
+After running your tests to generate the json files you can now run `rails json_statham`.
+
+    $ rails json_statham
+
+This will show you a list of your json files ordered by duration.
+
+```
++------------------------------------------------------------------------+-----------------------+
+| File path                                                              | Duration              |
++------------------------------------------------------------------------+-----------------------+
+| schemas/user_serializer/valid_user.json                                | 0.5460864380002022    |
+| schemas/user_serializer/invalid_user.json                              | 0.2532647902998724    |
+| schemas/post_serializer/published.json                                 | 0.2153625870094402    |
+| schemas/post_serializer/draft.json                                     | 0.1238838530000066    |
++------------------------------------------------------------------------+-----------------------+
+```
+
 ## 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/generators/json_statham/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Adds json_statham initializer for configuration
+
+Example:
+    rails generate json_statham:install
+
+    This will create:
+        config/initializers/json_statham.rb

data/lib/generators/json_statham/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module JsonStatham
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def add_initializer
+      template "json_statham.rb", "config/initializers/json_statham.rb"
+    end
+  end
+end

data/lib/generators/json_statham/templates/json_statham.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+JsonStatham.configure do |config|
+  config.schemas_path = "schemas"
+  config.store_schema = true
+  config.raise_ratio  = 10
+end

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/logger.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module JsonStatham
+  class Logger
+    COL_LABELS = { file_path: "File path", duration: "Duration" }.freeze
+
+    def config
+      @_config = JsonStatham.config
+    end
+
+    def call
+      log_header
+      log_values
+      log_divider
+    end
+
+    def columns
+      @_columns ||= COL_LABELS.each_with_object({}) do |(col, label), hash|
+        hash[col] = { label: label, width: [max_val(col), label.size].max }
+      end
+    end
+
+    def max_val(col)
+      values.map { |val| val[col].to_s.size }.max
+    end
+
+    def values
+      @_values ||= Dir["#{config.schemas_path}/**/*.json"].map do |file_path|
+        duration = JSON.parse(File.read(file_path))["duration"]
+
+        { file_path: file_path, duration: duration }
+      end
+    end
+
+    private
+
+    def log_values
+      values
+        .sort_by { |hash| hash[:duration] }
+        .reverse
+        .each { |hash| log_schema(hash) }
+    end
+
+    def log_header
+      log_divider
+      puts "| #{columns.map { |_, col| col[:label].ljust(col[:width]) }.join(' | ')} |"
+      log_divider
+    end
+
+    def log_divider
+      puts "+-#{columns.map { |_, col| '-' * col[:width] }.join('-+-')}-+"
+    end
+
+    def log_schema(hash)
+      puts "| #{hash.keys.map { |key| hash[key].to_s.ljust(columns[key][:width]) }.join(' | ')} |"
+    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/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module JsonStatham
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load File.expand_path("../tasks/json_statham_tasks.rake", __dir__)
+    end
+  end
+end

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.3"
 end

data/lib/json_statham.rb

@@ -4,12 +4,14 @@ require_relative "json_statham/helper"
 require_relative "json_statham/version"
 require_relative "json_statham/requests"
 require_relative "json_statham/validation"
+require_relative "json_statham/railtie" if defined?(Rails::Railtie)
 
 module JsonStatham
   autoload :Config, "json_statham/config"
   autoload :Parser, "json_statham/parser"
   autoload :Schema, "json_statham/schema"
   autoload :Result, "json_statham/result"
+  autoload :Logger, "json_statham/logger"
 
   class << self
     def configure

data/lib/tasks/json_statham_tasks.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :statham do
+  task log_files_duration: :environment do
+    JsonStatham::Logger.new.call
+  end
+end
+
+task json_statham: ["statham:log_files_duration"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_statham
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Victor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2023-02-18 00:00:00.000000000 Z
 dependencies: []
 description: JsonStatham allows to check the structure changes in a json
 email:
@@ -27,10 +27,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/json_statham/USAGE
+- lib/generators/json_statham/install_generator.rb
+- lib/generators/json_statham/templates/json_statham.rb.tt
 - lib/json_statham.rb
 - lib/json_statham/config.rb
 - lib/json_statham/helper.rb
+- lib/json_statham/logger.rb
 - lib/json_statham/parser.rb
+- lib/json_statham/railtie.rb
 - lib/json_statham/requests.rb
 - lib/json_statham/requests/base.rb
 - lib/json_statham/requests/observer.rb
@@ -40,6 +45,7 @@ files:
 - lib/json_statham/schema.rb
 - lib/json_statham/validation.rb
 - lib/json_statham/version.rb
+- lib/tasks/json_statham_tasks.rake
 - sig/json_statham.rbs
 homepage: https://github.com/victorauthiat/json_statham
 licenses:
@@ -53,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="