i_miss_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db2ed19ada7c81503f82f370d53b5f49da78b11f582ffe900b8772c8d36649e1
+  data.tar.gz: 48b84d49b5907f8ebdc417124fcbafea2b04c78078e726e1175c108d8af828e4
+SHA512:
+  metadata.gz: b4660f06c92b659da9d2d52ae93456ae4001fc383e7cc9fd1d9ef118fd6216adc3495afee7b403e071b475e60895a5255b628bcb9e640b7ad823f8b2f1e34f70
+  data.tar.gz: 0c207202bd01f2d5817008aaefce5af8313d9d996a77022cfb20b05002c9ab5913d84b398bf9090e6af29067252ebb11f8b5757b6ce5f5c7a4bdedf3d6153c7e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at y.wakahara@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in i_miss_validator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    i_miss_validator (0.1.0)
+      activerecord (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    concurrent-ruby (1.0.5)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    mysql2 (0.3.21)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  i_miss_validator!
+  minitest (~> 5.0)
+  mysql2 (>= 0.3, < 0.4)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 yo_waka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# IMissValidator
+
+This library discover validation that is not defined in the model.  
+It will suggest you undefined validations like this.
+
+```
+Model: User
+  Column: name
+    Missing: presence: true
+    Missing: length: { maximum: 255 }
+  Column: age
+    Missing: numericality: { only_integer: true, less_than_or_equal_to: -2147483648, greater_then_or_equal_to: 2147483648 }
+  Column: authorized
+    Missing: acceptance: true or acceptance: { accept: 'true', 'false' }
+  Column: bank_id
+    Missing: presence: true
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i_miss_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i_miss_validator
+
+## Usage
+
+```
+$ cd RAILS_APP_ROOT_DIR
+$ bundle exec i_miss_validator
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/waka/i_miss_validator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the IMissValidator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/waka/i_miss_validator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "i_miss_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/i_miss_validator

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+begin
+  require File.join(Dir.pwd, 'config', 'boot')
+  require File.join(Dir.pwd, 'config', 'environment')
+rescue LoadError
+  raise 'Must be in the root dir on rails app'
+end
+
+require 'bundler/setup'
+require 'i_miss_validator'
+
+IMissValidator.run

data/bin/setup

@@ -0,0 +1,8 @@
+#!/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

data/i_miss_validator.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "i_miss_validator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "i_miss_validator"
+  spec.version       = IMissValidator::VERSION
+  spec.authors       = ["yo_waka"]
+  spec.email         = ["y.wakahara@gmail.com"]
+
+  spec.summary       = %q{Check missing validators by database schema.}
+  spec.description   = %q{Check missing validators by database schema.}
+  spec.homepage      = "https://github.com/waka/i_miss_validator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["i_miss_validator".freeze]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mysql2", ">= 0.3", "< 0.4"
+
+  spec.add_dependency "activerecord", ">= 4.2"
+end

data/lib/i_miss_validator.rb

@@ -0,0 +1,37 @@
+require 'i_miss_validator/inspector'
+require 'i_miss_validator/inspector/acceptance_inspector'
+require 'i_miss_validator/inspector/length_inspector'
+require 'i_miss_validator/inspector/numericality_inspector'
+require 'i_miss_validator/inspector/presence_inspector'
+require 'i_miss_validator/reporter'
+require 'i_miss_validator/version'
+
+module IMissValidator
+  def self.run(inspectors = [])
+    inspector = IMissValidator::Inspector.new(
+      default_models_path,
+      default_inspectors + inspectors
+    )
+    inspector.inspect
+
+    IMissValidator::Reporter.report(inspector.results)
+
+    true
+  rescue => ex
+    puts ex.message
+    false
+  end
+
+  def self.default_models_path
+    File.join(Dir.pwd, 'app', 'models')
+  end
+
+  def self.default_inspectors
+    [
+      IMissValidator::Inspector::AcceptanceInspector,
+      IMissValidator::Inspector::LengthInspector,
+      IMissValidator::Inspector::NumericalityInspector,
+      IMissValidator::Inspector::PresenceInspector
+    ]
+  end
+end

data/lib/i_miss_validator/inspector.rb

@@ -0,0 +1,43 @@
+require 'active_record'
+
+class IMissValidator::Inspector
+  attr_reader :results
+
+  def initialize(models_path, inspectors = [])
+    @models_path = models_path
+    @inspectors = inspectors
+    @results = []
+  end
+
+  def models
+    Dir.glob(File.join(@models_path, "**", "*.rb")).sort.each do |filename|
+      begin
+        Kernel.require_dependency filename
+      rescue
+        puts "Not a class #{filename}"
+      end
+    end
+
+    ActiveRecord::Base.descendants.sort_by(&:name)
+  end
+
+  def inspect
+    models.each do |model|
+      begin
+        model.columns
+      rescue
+        puts "No schema in model class #{model.to_s}"
+        next
+      end
+
+      problems = @inspectors.map do |inspector|
+        inspector.inspect(model)
+      end
+
+      @results << {
+        model: model.to_s,
+        problems: problems.flatten.compact.group_by {|pb| pb[:column] }
+      }
+    end
+  end
+end

data/lib/i_miss_validator/inspector/acceptance_inspector.rb

@@ -0,0 +1,35 @@
+require 'active_record'
+
+#
+# Check columns if defined as integer, but no validator.
+#
+class IMissValidator::Inspector::AcceptanceInspector
+  def self.columns(model)
+    model.columns.select do |column|
+      column.type == :boolean
+    end
+  end
+
+  def self.validators(model)
+    model.validators.select do |validator|
+      validator.class == ActiveModel::Validations::AcceptanceValidator
+    end
+  end
+
+  def self.missing_columns(model)
+    validated_columns = validators(model).map(&:attributes).flatten.uniq
+    columns(model).select do |column|
+      validated_columns.include?(column.name.to_sym) == false
+    end
+  end
+
+  def self.inspect(model)
+    missing_columns(model).map do |column|
+      {
+        column: column.name,
+        missing_validator: :acceptance_validator,
+        message: "acceptance: true or acceptance: { accept: 'true', 'false' }"
+      }
+    end
+  end
+end

data/lib/i_miss_validator/inspector/length_inspector.rb

@@ -0,0 +1,35 @@
+require 'active_record'
+
+#
+# Check columns if defined limit, but no validator.
+#
+class IMissValidator::Inspector::LengthInspector
+  def self.columns(model)
+    model.columns.select do |column|
+      column.text?
+    end
+  end
+
+  def self.validators(model)
+    model.validators.select do |validator|
+      validator.class == ActiveModel::Validations::LengthValidator
+    end
+  end
+
+  def self.missing_columns(model)
+    validated_columns = validators(model).map(&:attributes).flatten.uniq
+    columns(model).select do |column|
+      validated_columns.include?(column.name.to_sym) == false
+    end
+  end
+
+  def self.inspect(model)
+    missing_columns(model).map do |column|
+      {
+        column: column.name,
+        missing_validator: :length_validator,
+        message: "length: { maximum: #{column.limit} }"
+      }
+    end
+  end
+end

data/lib/i_miss_validator/inspector/numericality_inspector.rb

@@ -0,0 +1,40 @@
+require 'active_record'
+
+#
+# Check columns if defined as integer, but no validator.
+#
+class IMissValidator::Inspector::NumericalityInspector
+  IGNORE_COLUMN_NAMES = ['id', 'lock_version']
+
+  def self.columns(model)
+    model.columns.select do |column|
+      column.type == :integer &&
+        IGNORE_COLUMN_NAMES.include?(column.name) == false &&
+        (column.name =~ /.*id$/) == nil
+    end
+  end
+
+  def self.validators(model)
+    model.validators.select do |validator|
+      validator.class == ActiveModel::Validations::NumericalityValidator
+    end
+  end
+
+  def self.missing_columns(model)
+    validated_columns = validators(model).map(&:attributes).flatten.uniq
+    columns(model).select do |column|
+      !validated_columns.include?(column.name.to_sym)
+    end
+  end
+
+  def self.inspect(model)
+    missing_columns(model).map do |column|
+      range = column.cast_type.send(:range)
+      {
+        column: column.name,
+        missing_validator: :numericality_validator,
+        message: "numericality: { only_integer: true, less_than_or_equal_to: #{range.first}, greater_then_or_equal_to: #{range.last} }"
+      }
+    end
+  end
+end

data/lib/i_miss_validator/inspector/presence_inspector.rb

@@ -0,0 +1,37 @@
+require 'active_record'
+
+#
+# Check columns if defined not null, but no validator.
+#
+class IMissValidator::Inspector::PresenceInspector
+  IGNORE_COLUMN_NAMES = ['id', 'lock_version']
+
+  def self.columns(model)
+    model.columns.select do |column|
+      column.null == false && IGNORE_COLUMN_NAMES.include?(column.name) == false
+    end
+  end
+
+  def self.validators(model)
+    model.validators.select do |validator|
+      validator.class == ActiveRecord::Validations::PresenceValidator
+    end
+  end
+
+  def self.missing_columns(model)
+    validated_columns = validators(model).map(&:attributes).flatten.uniq
+    columns(model).select do |column|
+      validated_columns.include?(column.name.to_sym) == false
+    end
+  end
+
+  def self.inspect(model)
+    missing_columns(model).map do |column|
+      {
+        column: column.name,
+        missing_validator: :presence_validator,
+        message: 'presence: true'
+      }
+    end
+  end
+end

data/lib/i_miss_validator/reporter.rb

@@ -0,0 +1,40 @@
+class IMissValidator::Reporter
+  module Colorize
+    refine String do
+      def red
+        "\e[36m#{self}\e[0m"
+      end
+
+      def yellow
+        "\e[33m#{self}\e[0m"
+      end
+
+      def pink
+        "\e[35m#{self}\e[0m"
+      end
+    end
+  end
+
+  using Colorize
+
+  def self.report(results = [])
+    results.each do |result|
+      next if result[:problems].keys.size == 0
+
+      print_with_indent(1, "Model".red + ": #{result[:model]}")
+
+      result[:problems].each do |column, problems|
+        print_with_indent(2, "Column".pink + ": #{column}")
+
+        problems.each do |problem|
+          print_with_indent(3, "Missing".yellow + ": #{problem[:message]}")
+        end
+      end
+    end
+  end
+
+  def self.print_with_indent(level, str = "")
+    level = 1 if 1 > level
+    puts "  " * (level - 1) + str
+  end
+end

data/lib/i_miss_validator/version.rb

@@ -0,0 +1,3 @@
+module IMissValidator
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: i_miss_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yo_waka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Check missing validators by database schema.
+email:
+- y.wakahara@gmail.com
+executables:
+- i_miss_validator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/i_miss_validator
+- bin/setup
+- i_miss_validator.gemspec
+- lib/i_miss_validator.rb
+- lib/i_miss_validator/inspector.rb
+- lib/i_miss_validator/inspector/acceptance_inspector.rb
+- lib/i_miss_validator/inspector/length_inspector.rb
+- lib/i_miss_validator/inspector/numericality_inspector.rb
+- lib/i_miss_validator/inspector/presence_inspector.rb
+- lib/i_miss_validator/reporter.rb
+- lib/i_miss_validator/version.rb
+homepage: https://github.com/waka/i_miss_validator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Check missing validators by database schema.
+test_files: []