model_validator 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d39b8ed8b26347cd45b16cd9c446bc30a926c79f507c06c2e6d86b1df354aa90
-  data.tar.gz: a5fef5baa38f2e5ee415ff8bcc30b5f31c344d86fd02b50bad772b2b4c6a0968
+  metadata.gz: f891705a9cd1d3195f54ba04d7d1a4634fb921527dd2472975d249ad43835fab
+  data.tar.gz: b133ec1cbdbb89c9b43d42871dd65cbbc2baa614f776b89ce5b5cae545bd21f0
 SHA512:
-  metadata.gz: 3359f10c445f0bf9a7f6f186e3e8a96d087b92720bca005782f4edcc3b9a1ce0f2dbbc9d8dea938e9302a89b0f64db93d3494ed0683a5280cd34ac4daf0c2af5
-  data.tar.gz: db3cd3080195468d3e338775c52749418063156562944d2ac2e6ade738bda764b039c942caf9492ed0044333d53282a39d028e37f9e4d0952dad20ad0f31699b
+  metadata.gz: 54adca12ba9576cb7b12eea53cdd04717dabc3dfc2bb494a8fae30ae664453b75707f3929fabd37a0f32f324b0d9dd32af351e0394716e3ac2f544b2f6529ba5
+  data.tar.gz: 63e5029d404976f34008d2e9bc5dc5713dd7ba26681c3e8bb8fa76567c3b5dbab4acfcc7146da67340b7a66566b57008f7ef435ca7c3e5a40f3dcbe8050aad33

data/.travis.yml

@@ -4,3 +4,4 @@ cache: bundler
 rvm:
   - 2.7.2
 before_install: gem install bundler -v 2.2.7
+script: make test

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    model_validator (1.2.0)
+    model_validator (1.2.1)
       rails (>= 4.0)
 
 GEM

data/Makefile

@@ -5,6 +5,7 @@ install: ## Install dependencies
 	bundle install
 
 test: ## Test application
+	rm -f db/test.sqlite3
 	bundle exec rspec
 
 lint: ## Check file format, smell code, conventions…

data/README.md

@@ -1,5 +1,6 @@
-[![Build Status](https://www.travis-ci.com/jibidus/model_validation.svg?branch=main)](https://www.travis-ci.com/jibidus/model_validation)
+[![Build Status](https://www.travis-ci.com/jibidus/model_validator.svg?branch=main)](https://www.travis-ci.com/jibidus/model_validator)
 [![Coverage Status](https://coveralls.io/repos/github/jibidus/model_validation/badge.svg?branch=main)](https://coveralls.io/github/jibidus/model_validation?branch=main)
+[![Gem Version](https://badge.fury.io/rb/model_validator.svg)](https://badge.fury.io/rb/model_validator)
 
 # model_validator
 
@@ -15,16 +16,16 @@ This is useful since error may occur when manipulating such data.
 
 It is recommended to use this gem during deployment step:
 
-- restore production database in a staging/preprod/non-production environment
-- validate the database
-- add missing migrations in case of violations
-- repeat validation and fix until there is no more violation
-- then, you are ready to deploy your application in production
+1. restore production database in a staging/preprod/non-production environment
+2. validate the database
+3. add missing migrations in case of violations
+4. repeat validation and fix until there is no more violation
+5. then, you are ready to deploy your application in production
 
 ## Limitations
 
 This gem fetch **all** record in database, and, for each record run the Active Record validation.
-So, because of performances reason, this is only acceptable for tiny databases (thousand of records).
+So, because of performances reason, this may be only acceptable for tiny databases (thousand of records).
 
 ## Installation
 
@@ -92,8 +93,8 @@ Many already existing gems may do the same, but none are satisfying:
 
 - [validb](https://github.com/jgeiger/validb): depends on [sidekiq](https://github.com/mperham/sidekiq)
 - [validates_blacklist](https://www.rubydoc.info/gems/validates_blacklist/0.0.1): requires to add configuration in each model 😨
-- [valid_items](https://rubygems.org/gems/valid_items): requires rails eager load 🤔
-- [schema-validations](https://github.com/robworley/schema-validations): I don"t understand what it really does 🤪
+- [valid_items](https://rubygems.org/gems/valid_items): not compliant with rails 6 + cannot find sources to contribute
+- [schema-validations](https://github.com/robworley/schema-validations): I didn't understand what it really does 🤪
 
 ## Contributing
 

data/lib/model_validator.rb

@@ -1,23 +1,14 @@
 # frozen_string_literal: true
 
 require "rails"
+require "./lib/model_validator/stats_handler"
+require "./lib/model_validator/log_handler"
+require "./lib/model_validator/validator"
 
 # Validate models in database according Active Record model validation rules
 module ModelValidator
   require "model_validator/railtie" if defined?(Rails)
 
-  # Validations summary, with:
-  # - violations: number of violations (i.e. number of model which validation failed)
-  # - total: total number of validated models
-  class Result
-    attr_accessor :violations, :total
-
-    def initialize(violations: 0, total: 0)
-      @violations = violations
-      @total = total
-    end
-  end
-
   def self.validate_all(skipped_models: [])
     if skipped_models.empty?
       Rails.logger.info "No model skipped"
@@ -29,58 +20,4 @@ module ModelValidator
     Validator.new(handlers: handlers, skip_models: skipped_models).run
     stats_handler.result
   end
-
-  # Validation engine, which fetch, and validate each database records
-  class Validator
-    def initialize(handlers: [], skip_models: [])
-      @handlers = handlers
-      @skip_models = skip_models
-    end
-
-    def classes_to_validate
-      ActiveRecord::Base.subclasses
-                        .reject { |type| type.to_s.include? "::" } # subclassed classes are not our own models
-                        .reject { |type| @skip_models.include? type }
-    end
-
-    def run
-      classes_to_validate.each do |model_class|
-        @handlers.each { |h| h.try(:on_new_class, model_class) }
-        model_class.unscoped.find_each do |model|
-          @handlers.each { |h| h.try(:on_violation, model) } unless model.valid?
-          @handlers.each { |h| h.try(:after_validation, model) }
-        end
-      end
-    end
-  end
-
-  # This handler logs validation progression
-  class LogHandler
-    def on_new_class(model_class)
-      Rails.logger.info "Checking #{model_class.count} #{model_class}…"
-    end
-
-    def on_violation(model)
-      Rails.logger.error "#<#{model.class} id: #{model.id}, errors: #{model.errors.full_messages}>" unless model.valid?
-    end
-  end
-
-  # This handler computes validation statistics
-  class StatsHandler
-    attr_reader :result
-
-    def initialize
-      @result = Result.new(violations: 0, total: 0)
-    end
-
-    def on_new_class(_) end
-
-    def on_violation(_)
-      @result.violations += 1
-    end
-
-    def after_validation(_)
-      @result.total += 1
-    end
-  end
 end

data/lib/model_validator/log_handler.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module ModelValidator
+  # This handler logs validation progression
+  class LogHandler
+    def on_new_class(model_class)
+      Rails.logger.info "Checking #{model_class.count} #{model_class}…"
+    end
+
+    def on_violation(model)
+      Rails.logger.error "#<#{model.class} id: #{model.id}, errors: #{model.errors.full_messages}>" unless model.valid?
+    end
+  end
+end

data/lib/model_validator/stats_handler.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ModelValidator
+  # Validations summary, with:
+  # - violations: number of violations (i.e. number of model which validation failed)
+  # - total: total number of validated models
+  Result = Struct.new(:violations, :total)
+
+  # This handler computes validation statistics
+  class StatsHandler
+    attr_reader :result
+
+    def initialize
+      @result = Result.new(0, 0)
+    end
+
+    def on_violation(_)
+      @result.violations += 1
+    end
+
+    def after_validation(_)
+      @result.total += 1
+    end
+  end
+end

data/lib/model_validator/validator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module ModelValidator
+  # Validation engine, which fetch, and validate each database records
+  class Validator
+    def initialize(handlers: [], skip_models: [])
+      @handlers = handlers
+      @skip_models = skip_models
+    end
+
+    def classes_to_validate
+      ActiveRecord::Base.descendants
+                        .reject(&:abstract_class)
+                        .select { |type| type.subclasses.empty? }
+                        .reject { |type| @skip_models.include? type }
+    end
+
+    def run
+      classes_to_validate.each do |model_class|
+        @handlers.each { |h| h.try(:on_new_class, model_class) }
+        model_class.unscoped.find_each do |model|
+          @handlers.each { |h| h.try(:on_violation, model) } unless model.valid?
+          @handlers.each { |h| h.try(:after_validation, model) }
+        end
+      end
+    end
+  end
+end

data/lib/model_validator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModelValidator
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/rakelib/release.rake

@@ -18,20 +18,9 @@ namespace :release do
     puts "---------------------------------------------------------------------"
     puts release.changelog
     puts "---------------------------------------------------------------------"
-
     next if args[:dry_run]
 
     release.git_commit!
-
-    puts <<~MSG
-      Release built.
-
-      Run following commands to publish version #{release.new_version}:
-       $> git push && git push --tags
-       $> bundle exec rake release
-
-      After that, do not forget to report changelog in Github Releases page:
-       https://github.com/jibidus/model_validator/releases
-    MSG
+    puts release.publishing_instructions
   end
 end

data/rakelib/release/release.rb

@@ -54,6 +54,20 @@ class Release
     `git commit -m ":label: release version #{new_version}"`
   end
 
+  def publishing_instructions
+    <<~MSG
+      New commit created with the release.
+
+      Run following commands to publish version #{new_version}:
+       $> git push
+       $> bundle exec rake release
+
+      Then edit tag with changelog:
+       $> git tag v#{new_version} -f -a
+       $> git push -f --tags
+    MSG
+  end
+
   private
 
   def sub_file_content(file_path, from, to)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_validator
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Jibidus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2021-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -158,8 +158,11 @@ files:
 - Rakefile
 - lib/model_validator.rb
 - lib/model_validator/Rakefile
+- lib/model_validator/log_handler.rb
 - lib/model_validator/railtie.rb
+- lib/model_validator/stats_handler.rb
 - lib/model_validator/tasks/db/validate.rake
+- lib/model_validator/validator.rb
 - lib/model_validator/version.rb
 - model_validator.gemspec
 - rakelib/release.rake