From c5fbdc940b9e689a5f81631ab6a6617f5c101741 Mon Sep 17 00:00:00 2001 From: djezzzl Date: Sun, 21 Oct 2018 00:43:34 +0200 Subject: [PATCH] Initial commit - Add presence comparator - Configure Rubocop --- .gitignore | 14 ++++ .rspec | 3 + .rubocop.yml | 3 + .travis.yml | 7 ++ CHANGELOG.md | 2 + CODE_OF_CONDUCT.md | 74 +++++++++++++++++++ Gemfile | 6 ++ Gemfile.lock | 73 ++++++++++++++++++ LICENSE.txt | 21 ++++++ README.md | 43 +++++++++++ Rakefile | 6 ++ bin/console | 14 ++++ bin/setup | 8 ++ database_consistency.gemspec | 25 +++++++ lib/database_consistency.rb | 7 ++ .../comparators/presence_comparator.rb | 32 ++++++++ lib/database_consistency/comparison_result.rb | 10 +++ lib/database_consistency/version.rb | 3 + spec/database_consistency_spec.rb | 5 ++ spec/presence_comparator_spec.rb | 74 +++++++++++++++++++ spec/spec_helper.rb | 16 ++++ 21 files changed, 446 insertions(+) create mode 100644 .gitignore create mode 100644 .rspec create mode 100644 .rubocop.yml create mode 100644 .travis.yml create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 Rakefile create mode 100755 bin/console create mode 100755 bin/setup create mode 100644 database_consistency.gemspec create mode 100644 lib/database_consistency.rb create mode 100644 lib/database_consistency/comparators/presence_comparator.rb create mode 100644 lib/database_consistency/comparison_result.rb create mode 100644 lib/database_consistency/version.rb create mode 100644 spec/database_consistency_spec.rb create mode 100644 spec/presence_comparator_spec.rb create mode 100644 spec/spec_helper.rb diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..19448c5 --- /dev/null +++ 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 new file mode 100644 index 0000000..34c5164 --- /dev/null +++ b/.rspec @@ -0,0 +1,3 @@ +--format documentation +--color +--require spec_helper diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000..1934e9e --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,3 @@ +Metrics/BlockLength: + Exclude: + - 'spec/**/*' diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..6f0bdd3 --- /dev/null +++ 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 new file mode 100644 index 0000000..4dc68c6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,2 @@ +# Changelog + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..653c116 --- /dev/null +++ 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 new file mode 100644 index 0000000..8a8d3ec --- /dev/null +++ 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 new file mode 100644 index 0000000..3e3937a --- /dev/null +++ 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 new file mode 100644 index 0000000..36ee5d5 --- /dev/null +++ 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 new file mode 100644 index 0000000..30ab6a2 --- /dev/null +++ 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 new file mode 100644 index 0000000..4c774a2 --- /dev/null +++ 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 new file mode 100755 index 0000000..ec44e99 --- /dev/null +++ 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 new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ 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 new file mode 100644 index 0000000..da85519 --- /dev/null +++ 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 new file mode 100644 index 0000000..2ae2aa5 --- /dev/null +++ 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 new file mode 100644 index 0000000..655adc3 --- /dev/null +++ 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 new file mode 100644 index 0000000..f9b48fa --- /dev/null +++ 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 new file mode 100644 index 0000000..4cfda75 --- /dev/null +++ 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 new file mode 100644 index 0000000..54ff9c3 --- /dev/null +++ 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 diff --git a/spec/presence_comparator_spec.rb b/spec/presence_comparator_spec.rb new file mode 100644 index 0000000..4f3aa22 --- /dev/null +++ b/spec/presence_comparator_spec.rb @@ -0,0 +1,74 @@ +RSpec.describe DatabaseConsistency::Comparators::PresenceComparator do + subject(:compare) do + described_class.compare(klass.validators.first, klass.columns.first) + end + + let!(:database) do + ActiveRecord::Base.establish_connection( + adapter: 'sqlite3', + database: ':memory:' + ) + ActiveRecord::Schema.verbose = false + + options = field_options + ActiveRecord::Schema.define(version: 1) do + create_table :entities, id: false do |t| + t.string :field, options + end + end + end + + let(:klass) do + options = validates_options + Class.new(ActiveRecord::Base) do |klass| + klass.table_name = :entities + klass.validates :field, options + end + end + + context 'when database has null: false' do + let(:field_options) { { null: false } } + + context 'when presence: true' do + let(:validates_options) { { presence: true } } + + specify do + expect(compare).to eq(status: :ok) + end + + context 'when allow_nil/allow_blank/if/unless is true' do + let(:validates_options) { { presence: true, allow_nil: true } } + + specify do + expect(compare).to eq( + status: :fail, + message: 'possible null value insert' + ) + end + end + end + end + + context 'when database has null: true' do + let(:field_options) { { null: true } } + + context 'when presence: true' do + let(:validates_options) { { presence: true } } + + specify do + expect(compare).to eq( + status: :fail, + message: 'database field should have: "null: false"' + ) + end + + context 'when allow_nil/allow_blank/if/unless is true' do + let(:validates_options) { { presence: true, allow_nil: true } } + + specify do + expect(compare).to eq(status: :ok) + end + end + end + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..3de7bed --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,16 @@ +require 'bundler/setup' +require 'database_consistency' + +require 'active_record' + +RSpec.configure do |config| + # Enable flags like --only-failures and --next-failure + config.example_status_persistence_file_path = '.rspec_status' + + # Disable RSpec exposing methods globally on `Module` and `main` + config.disable_monkey_patching! + + config.expect_with :rspec do |c| + c.syntax = :expect + end +end