Initial commit

- Add presence comparator - Configure Rubocop
djezzzl · Oct 20, 2018 · c5fbdc9 · c5fbdc9
commit c5fbdc9
Show file tree

Hide file tree

Showing 21 changed files with 446 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# RubyMine
+/.idea
diff --git a/.rspec b/.rspec
@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,3 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,2 @@
+# Changelog
+
diff --git a/CODE_OF_CONDUCT.md b/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 lawliet.djez@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/
diff --git a/Gemfile b/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 database_consistency.gemspec
+gemspec
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    database_consistency (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.2)
+  bundler (~> 1.16)
+  database_consistency!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.55)
+  sqlite3 (~> 1.3)
+
+BUNDLED WITH
+   1.16.4
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Evgeniy Demin
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,43 @@
+# DatabaseConsistency
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/database_consistency`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'database_consistency'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install database_consistency
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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/[USERNAME]/database_consistency. 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 DatabaseConsistency project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/database_consistency/blob/master/CODE_OF_CONDUCT.md).
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
diff --git a/bin/console b/bin/console
@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'database_consistency'
+
+# 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__)
diff --git a/bin/setup b/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
diff --git a/database_consistency.gemspec b/database_consistency.gemspec
@@ -0,0 +1,25 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'database_consistency/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'database_consistency'
+  spec.version       = DatabaseConsistency::VERSION
+  spec.authors       = ['Evgeniy Demin']
+  spec.email         = ['lawliet.djez@gmail.com']
+
+  spec.summary       = 'Provide an easy way to check the consistency of the '\
+                        'database constraints with the application validations.'
+  spec.homepage      = 'https://github.com/djezzzl/database_consistency'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['lib/**/*'] + %w[README.md LICENSE.txt]
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'activerecord', '~> 5.2'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.55'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+end
diff --git a/lib/database_consistency.rb b/lib/database_consistency.rb
@@ -0,0 +1,7 @@
+require 'database_consistency/version'
+require 'database_consistency/comparison_result'
+require 'database_consistency/comparators/presence_comparator'
+
+# The root module
+module DatabaseConsistency
+end
diff --git a/lib/database_consistency/comparators/presence_comparator.rb b/lib/database_consistency/comparators/presence_comparator.rb
@@ -0,0 +1,32 @@
+module DatabaseConsistency
+  module Comparators
+    # The comparator for {{ActiveModel::Validations::PresenceValidator}}
+    module PresenceComparator
+      module_function
+
+      WEAK_OPTIONS = %i[allow_nil allow_blank if unless].freeze
+      CONSTRAINT_MISSING = 'database field should have: "null: false"'.freeze
+      POSSIBLE_NULL = 'possible null value insert'.freeze
+
+      # Table of possible statuses
+      # | allow_nil/allow_blank/if/unless | database | status |
+      # | ------------------------------- | -------- | ------ |
+      # | at least one provided           | required | fail   |
+      # | at least one provided           | optional | ok     |
+      # | all missed                      | required | ok     |
+      # | all missed                      | optional | fail   |
+      def compare(validator, column)
+        can_be_null = column.null
+        has_weak_option = validator.options.slice(*WEAK_OPTIONS).any?
+
+        if can_be_null == has_weak_option
+          ComparisonResult.format(:ok)
+        elsif can_be_null
+          ComparisonResult.format(:fail, CONSTRAINT_MISSING)
+        else
+          ComparisonResult.format(:fail, POSSIBLE_NULL)
+        end
+      end
+    end
+  end
+end
diff --git a/lib/database_consistency/comparison_result.rb b/lib/database_consistency/comparison_result.rb
@@ -0,0 +1,10 @@
+module DatabaseConsistency
+  # This module formats output of comparison result
+  module ComparisonResult
+    module_function
+
+    def format(status, message = nil)
+      { status: status }.tap { |hash| hash[:message] = message if message }
+    end
+  end
+end
diff --git a/lib/database_consistency/version.rb b/lib/database_consistency/version.rb
@@ -0,0 +1,3 @@
+module DatabaseConsistency
+  VERSION = '0.1.0'.freeze
+end
diff --git a/spec/database_consistency_spec.rb b/spec/database_consistency_spec.rb
@@ -0,0 +1,5 @@
+RSpec.describe DatabaseConsistency do
+  it 'has a version number' do
+    expect(DatabaseConsistency::VERSION).not_to be nil
+  end
+end