model_validator 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64f760c55b0d9771afce630e56523e689a3bf1ebd65f21acc003009518f1c340
-  data.tar.gz: 5854b1987c516583bd2e50a8b97ff576594a6bd9cb3fc1157262ce2995cd4cd4
+  metadata.gz: ad05f1a13e54602959a5913973a2faed03b80203233285d48b692fd3310a6b81
+  data.tar.gz: a5cf56f9d5d792f675c4ccc918b448772ad4af4d02bdd2647b2a697c0c15b6d6
 SHA512:
-  metadata.gz: 6550ec508bfa1a5670f6ad3548e3efddc744dd08df7302d7dbbdbe5afd331e59aa44ca4dbe8681172ed6ed0299a500370d98220153d5a7df63fed0025cc86900
-  data.tar.gz: e66fb4032041a9b6323a70afd95939f8083736b089d3a27e2f09843c266e43d1d414085ae05d5919dadeac8daf6e8416d03378a2a534bf8e3e1b729a810f733c
+  metadata.gz: a629d909b30a1582bb07d9bf5b1884911cb1991c6749ba2fb5fbd75b625648536c1f6ce16c6dcf6d39192a19af0326b6d6c7e96b87e507fc86f76cd3d0d02347
+  data.tar.gz: e0440d447f4c11cb7f9fa9a027963476181d1114f18ed9a3fa2e00e4822bd7fd22b8e11ad7f1e019cf57e57d5f45bf9e6a8bc9317b9c9a09fecdf7ea486a3548

data/Gemfile

@@ -4,12 +4,10 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "coveralls", require: false
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.7"
-
-gem "sqlite3", "~> 1.4"
-
-gem "rubocop-rspec", "~> 2.2"
-
 gem "rubocop-rake", "~> 0.5.1"
+gem "rubocop-rspec", "~> 2.2"
+gem "sqlite3", "~> 1.4"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    model_validator (1.0.0)
+    model_validator (1.1.0)
       rails (~> 6.1)
 
 GEM
@@ -69,13 +69,21 @@ GEM
     ast (2.4.2)
     builder (3.2.4)
     concurrent-ruby (1.1.7)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
     crass (1.0.6)
     diff-lcs (1.4.4)
+    docile (1.3.5)
     erubi (1.10.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
+    json (2.5.1)
     loofah (2.8.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -157,6 +165,11 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -165,7 +178,12 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
     thor (1.0.1)
+    tins (1.28.0)
+      sync
     tzinfo (2.0.3)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
@@ -179,6 +197,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  coveralls
   model_validator!
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://www.travis-ci.com/jibidus/model_validation.svg?branch=main)](https://www.travis-ci.com/jibidus/model_validation)
+[![Coverage Status](https://coveralls.io/repos/github/jibidus/model_validation/badge.svg?branch=main)](https://coveralls.io/github/jibidus/model_validation?branch=main)
 
 # model_validator
 
@@ -27,10 +28,10 @@ So, because of performances reason, this is only acceptable for tiny databases (
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application"s Gemfile:
 
 ```ruby
-gem 'model_validator'
+gem "model_validator"
 ```
 
 And then execute:
@@ -70,7 +71,7 @@ ModelValidator.validate_all skipped_models: [Model1,Model2]
 
 After checking out the repo, run `make install` to install dependencies.
 
-Then, run `make test` to run the tests.
+Then, run `make test` to run the tests (test coverage is available in `coverage/index.html`).
 
 Then, run `make lint` to run linters ([rubocop](https://github.com/rubocop-hq/rubocop)).
 
@@ -78,8 +79,12 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ### How to release new version?
 
-- Update the version number in `version.rb`
-- run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Make sure your are in `main` branch. Then, run:
+```bash
+rake release:make[major|minor|patch|x.y.z]
+```
+
+Example for building a new minor release: `rake release:make[minor]`
 
 ## Why not contributing to existing gem?
 
@@ -88,7 +93,7 @@ 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 🤪
+- [schema-validations](https://github.com/robworley/schema-validations): I don"t understand what it really does 🤪
 
 ## Contributing
 
@@ -100,4 +105,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the ModelValidator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/model_validator/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ModelValidator project"s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/model_validator/blob/master/CODE_OF_CONDUCT.md).

data/lib/model_validator.rb

@@ -6,55 +6,81 @@ require "rails"
 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"
     else
       Rails.logger.info "Skipped model(s): #{skipped_models.map(&:to_s).join(", ")}"
     end
-    handler = LogHandler.new
-    Validator.new(handler, skip_models: skipped_models).run
-    handler.violations_count
+    stats_handler = StatsHandler.new
+    handlers = [LogHandler.new, stats_handler]
+    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(handler, skip_models: [])
-      @handler = handler
+    def initialize(handlers: [], skip_models: [])
+      @handlers = handlers
       @skip_models = skip_models
     end
 
-    def models_to_validate
+    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
-      models_to_validate.each do |type|
-        @handler.start_model type
-        type.unscoped.find_each do |record|
-          @handler.on_violation(type, record) unless record.valid?
+      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
 
-  # Validation handler, which logs each violation
+  # This handler logs validation progression
   class LogHandler
-    attr_reader :violations_count
+    def on_new_class(model_class)
+      Rails.logger.info "Checking #{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
-      @violations_count = 0
+      @result = Result.new(violations: 0, total: 0)
     end
 
-    def start_model(type)
-      Rails.logger.info "Checking #{type}..."
+    def on_new_class(_) end
+
+    def on_violation(_)
+      @result.violations += 1
     end
 
-    def on_violation(type, record)
-      Rails.logger.error "#<#{type} id: #{record.id}, errors: #{record.errors.full_messages}>" unless record.valid?
-      @violations_count += 1
+    def after_validation(_)
+      @result.total += 1
     end
   end
 end

data/lib/model_validator/version.rb

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

data/model_validator.gemspec

@@ -8,19 +8,18 @@ Gem::Specification.new do |spec|
   spec.authors = ["Jibidus"]
   spec.email = ["jibidus@gmail.com"]
 
-  spec.summary = "Validate database against Active Record model validations."
-  spec.description = <<~FOO
-    Many reason may make database violate Active Record validation rules
-    (database modification without Active Record, migration…).
-    This raises unexpected error when these records are manipulated by rails.
-  FOO
-  spec.homepage = "https://github.com/jibidus/model_validation"
+  spec.summary = "Validate database against Active Record model validations"
+  spec.description = <<~DESC
+    Find models in database which violate Active Record validation rules.
+    Invalid models may raise unexpected error when updated.
+  DESC
+  spec.homepage = "https://github.com/jibidus/model_validator"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/jibidus/model_validation"
-  spec.metadata["changelog_uri"] = "https://github.com/jibidus/model_validation"
+  spec.metadata["source_code_uri"] = "https://github.com/jibidus/model_validator"
+  spec.metadata["changelog_uri"] = "https://github.com/jibidus/model_validator"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/rakelib/release.rake

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "./rakelib/release/release"
+
+namespace :release do
+  desc <<~DESC
+    Build new release.
+      - bump_type (mandatory): [major|minor|patch|x.y.z]
+      - dry_run (optional): skip commit, tag and publishing
+  DESC
+  task :make, [:bump_type, :dry_run] do |_, args|
+    release = Release.new args[:bump_type]
+    puts "Bump version from #{release.current_version} to #{release.new_version}"
+    release.apply!
+
+    puts
+    puts "#{release.new_version} changelog"
+    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
+  end
+end

data/rakelib/release/commit.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Represents a commit in a git repository
+class Commit
+  attr_reader :type, :message
+
+  def initialize(type, message)
+    @type = type
+    @message = message
+  end
+
+  def type?(types)
+    types.include? @type
+  end
+end

data/rakelib/release/release.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "./rakelib/release/repository"
+require "./rakelib/release/version"
+require "./lib/model_validator/version"
+
+AUTHORIZED_BRANCH = "main"
+
+# All commit message prefix to include in changelog
+COMMIT_TYPES = {
+  "tada" => "Feature",
+  "bug" => "Bug fix"
+}.freeze
+
+# This class can create and publish a new version of the current gem
+class Release
+  GEM_NAME = "model_validator"
+  VERSION_FILE = "lib/model_validator/version.rb"
+  GEMFILE_LOCK = "Gemfile.lock"
+
+  def initialize(type)
+    @type = type
+  end
+
+  def current_version
+    Version.new(*ModelValidator::VERSION.split(".").map(&:to_i))
+  end
+
+  def new_version
+    @new_version ||= current_version.bump(@type)
+  end
+
+  def apply!
+    if Repository.current_branch != AUTHORIZED_BRANCH
+      raise <<~MSG
+        You can only release new version from '#{AUTHORIZED_BRANCH}' branch.
+        Current branch: '#{Repository.current_branch}'
+      MSG
+    end
+
+    sub_file_content VERSION_FILE, current_version.to_s, new_version.to_s
+    sub_file_content GEMFILE_LOCK, "#{GEM_NAME} (#{current_version})", "#{GEM_NAME} (#{new_version})"
+  end
+
+  def changelog
+    commits_by_type.map do |type, commits|
+      messages_list = commits.map { |commit| "- #{commit.message}\n" }.join
+      "# #{COMMIT_TYPES[type]}\n#{messages_list}"
+    end.join("\n")
+  end
+
+  def git_commit!
+    `git add #{VERSION_FILE} #{GEMFILE_LOCK}`
+    `git commit -m ":label: release version #{new_version}"`
+  end
+
+  private
+
+  def sub_file_content(file_path, from, to)
+    current_content = File.read(file_path)
+    modified_content = current_content.sub(from, to)
+    raise "Cannot find regexp '#{from}' in file #{file_path}" if modified_content == current_content
+
+    File.open(file_path, "w") { |file| file << modified_content }
+  end
+
+  def commits_by_type
+    Repository.commits_from(current_version)
+              .select { |commit| commit.type?(COMMIT_TYPES.keys) }
+              .group_by(&:type)
+  end
+end

data/rakelib/release/repository.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "./rakelib/release/commit"
+
+# This module contains many methods to manipulate current git repository
+module Repository
+  def self.current_branch
+    `git rev-parse --abbrev-ref HEAD`.strip
+  end
+
+  def self.commits_from(tag)
+    logs_from("v#{tag}").sort
+                        .uniq
+                        .map do |commit_message|
+      _, type, message = commit_message.split(":", 3).map(&:strip)
+      if message.nil?
+        message = type
+        type = "unknown"
+      end
+      Commit.new(type, message)
+    end
+  end
+
+  def self.logs_from(revision)
+    `git log #{revision}..HEAD --pretty=format:"%s"`.split("\n")
+  end
+end

data/rakelib/release/version.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Represent a gem version, which can be bumped for new release.
+class Version
+  def initialize(major, minor, patch)
+    @major = major
+    @minor = minor
+    @patch = patch
+  end
+
+  def bump(release_type)
+    case release_type
+    when "major"
+      Version.new(@major + 1, 0, 0)
+    when "minor"
+      Version.new(@major, @minor + 1, 0)
+    when "patch"
+      Version.new(@major, @minor, @patch + 1)
+    else
+      raise "Unknonwn bump type '#{release_type}'"
+    end
+  end
+
+  def to_s
+    [@major, @minor, @patch].join(".")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_validator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jibidus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-14 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,9 +25,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.1'
 description: |
-  Many reason may make database violate Active Record validation rules
-  (database modification without Active Record, migration…).
-  This raises unexpected error when these records are manipulated by rails.
+  Find models in database which violate Active Record validation rules.
+  Invalid models may raise unexpected error when updated.
 email:
 - jibidus@gmail.com
 executables: []
@@ -45,21 +44,24 @@ files:
 - Makefile
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/model_validator.rb
 - lib/model_validator/Rakefile
 - lib/model_validator/railtie.rb
 - lib/model_validator/tasks/db/validate.rake
 - lib/model_validator/version.rb
 - model_validator.gemspec
-homepage: https://github.com/jibidus/model_validation
+- rakelib/release.rake
+- rakelib/release/commit.rb
+- rakelib/release/release.rb
+- rakelib/release/repository.rb
+- rakelib/release/version.rb
+homepage: https://github.com/jibidus/model_validator
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/jibidus/model_validation
-  source_code_uri: https://github.com/jibidus/model_validation
-  changelog_uri: https://github.com/jibidus/model_validation
+  homepage_uri: https://github.com/jibidus/model_validator
+  source_code_uri: https://github.com/jibidus/model_validator
+  changelog_uri: https://github.com/jibidus/model_validator
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -78,5 +80,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Validate database against Active Record model validations.
+summary: Validate database against Active Record model validations
 test_files: []

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "model_validator"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here