consistency_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca169d2d5a7667dd41da06e6c0f701a107778a78
+  data.tar.gz: 92443233a03ffd40c24c2ef6470f5a93920e1daa
+SHA512:
+  metadata.gz: f70e4c7c1565859b6210a114e693b54adbf21c257bd2ef5bd750b2c1c72645cd2c4c4cc77c54d0985e1b1f47a64496c22add91d53f80c0869421bd63f4a80fa9
+  data.tar.gz: 3f37bb868746d18a5d008c58c7469e835b975747d3e68c76d5dca36ac9ad0ff02672a0c040ff9c3f3ef7d0cfcebb7368ba3ee150d22400c611e537f28d77023c

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+*.iml

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+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 kovac@essential-data.sk. 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 consistency_check.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Michal Kováč
+
+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,45 @@
+# ConsistencyCheck
+
+Run your own consistency checks and store results (time, name of the check, consisitency violations) in DB.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'consistency_check'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install consistency_check
+    
+Then run generators, which create a migration, model and dummy consistency check definitions:
+
+    $ rails g consistency_check:install
+    
+And migrations:
+
+    $ rails db:migrate
+
+## Usage
+
+Write your own consistency check definitions into the file `jobs/consistency_check/definitions.rb` and run
+
+    $ ConsistencyCheck.run_all
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mirelon/consistency_check.
+
+## 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 ConsistencyCheck project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mirelon/consistency_check/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 "consistency_check"
+
+# 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

@@ -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/consistency_check.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "consistency_check/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "consistency_check"
+  spec.version       = ConsistencyCheck::VERSION
+  spec.authors       = ["Michal Kováč"]
+  spec.email         = ["miso@consistency_check.gem.ksp.sk"]
+
+  spec.summary       = %q{Run custom consistency checks against your DB and track the results.}
+  spec.homepage      = "https://github.com/mirelon/consistency_check"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rails", "~> 5.0"
+  spec.add_runtime_dependency "activerecord", "~> 5.0"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/consistency_check.rb

@@ -0,0 +1,18 @@
+require 'consistency_check/version'
+require 'consistency_check/runner'
+
+module ConsistencyCheck
+  def run_all
+    ConsistencyCheck::Definitions.methods(false ).map do |method|
+      puts "Running #{method}..."
+      violations = ConsistencyCheck::Definitions.send method
+      max_shown_violations = 5
+      first_violations_ids = violations.take(max_shown_violations).map(&:id).join(',')
+      optional_ellipsis = violations.to_a.count > max_shown_violations ? '...' : ''
+      result = violations.empty? ? 'OK' : "FAIL (#{violations.to_a.count} violations: #{first_violations_ids}#{optional_ellipsis})"
+      ConsistencyCheckResult.new(name: method.to_s.camelcase, violations: violations.to_a.count, result: result)
+    end
+  end
+
+  module_function :run_all
+end

data/lib/consistency_check/runner.rb

@@ -0,0 +1,5 @@
+module ConsistencyCheck
+  class Runner
+
+  end
+end

data/lib/consistency_check/version.rb

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

data/lib/generators/consistency_check/install/install_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module ConsistencyCheck
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      desc "Installs consistency_check and generates the necessary migrations"
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def create_migrations
+        migration_template 'migrations/create_consistency_check_results.rb.erb', 'db/migrate/create_consistency_check_results.rb'
+      end
+
+      def create_model
+        fname = 'app/models/consistency_check_result.rb'
+        template('models/consistency_check_result.rb.erb', fname)
+      end
+
+      def create_job
+        fname = 'app/jobs/consistency_check/definitions.rb'
+        template('jobs/consistency_check/definitions.rb.erb', fname)
+      end
+    end
+  end
+end

data/lib/generators/consistency_check/install/templates/jobs/consistency_check/definitions.rb.erb

@@ -0,0 +1,11 @@
+module ConsistencyCheck
+  module Definitions
+    # If you want to perform check in a way depending on DB version:
+    # POSTGRES_VERSION = ActiveRecord::Base.connection.select_value('SHOW server_version;')
+
+    def dummy_check
+      # Perform some check and return list of models that violate the consistency
+      []
+    end
+  end
+end

data/lib/generators/consistency_check/install/templates/migrations/create_consistency_check_results.rb.erb

@@ -0,0 +1,24 @@
+<%
+  parent_class = ActiveRecord::Migration
+  parent_class = parent_class[parent_class.current_version] if Rails::VERSION::MAJOR >= 5
+-%>
+class CreateConsistencyCheckResults < <%= parent_class.to_s %>
+  def self.up
+    create_table :consistency_check_results do |t|
+      t.string :name
+      t.string :result
+      t.integer :violations, default: 0, null: false
+      <%- if Rails::VERSION::MAJOR >= 5 -%>
+      t.timestamps
+      <%- else -%>
+      t.timestamps null: false
+      <%- end -%>
+    end
+    add_index :consistency_check_results, [:name]
+    add_index :consistency_check_results, [:violations]
+  end
+
+  def self.down
+    drop_table :consistency_check_results
+  end
+end

data/lib/generators/consistency_check/install/templates/models/consistency_check_result.rb.erb

@@ -0,0 +1,2 @@
+class ConsistencyCheckResult < ApplicationRecord
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: consistency_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michal Kováč
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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'
+description: 
+email:
+- miso@consistency_check.gem.ksp.sk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- consistency_check.gemspec
+- lib/consistency_check.rb
+- lib/consistency_check/runner.rb
+- lib/consistency_check/version.rb
+- lib/generators/consistency_check/install/install_generator.rb
+- lib/generators/consistency_check/install/templates/jobs/consistency_check/definitions.rb.erb
+- lib/generators/consistency_check/install/templates/migrations/create_consistency_check_results.rb.erb
+- lib/generators/consistency_check/install/templates/models/consistency_check_result.rb.erb
+homepage: https://github.com/mirelon/consistency_check
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Run custom consistency checks against your DB and track the results.
+test_files: []