activevalidation 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad51852232b76c40ae0c6ecc5592471613cca20e5a50eea9315f9c16f0146faf
-  data.tar.gz: cf6e173d154de0c0fbeb9a5f154975b663b4d2228fb505fca3215f3d6c0c9db6
+  metadata.gz: a5fb5e334a2e1d3f53754612dceea966b88354289f44fadcfceb9785319b63f7
+  data.tar.gz: 233d20c566b01decb2d01b5f61d27ef56b3529048d916c3f49d5b331bceaab53
 SHA512:
-  metadata.gz: f1ad40509c6b81b22f975605a2d9332db591be361f7d2b208c574dcb7a9b32fd2ada624cd4e97b6b828ece3384706d597360ea5cc48daaca5b74f814eaa90154
-  data.tar.gz: 71f0341744affa0c53c5b8855ca77665f4fb60da19ca292551499593afadd4e402b72a7ea1ff82004fdd8157f0e9acdd7a3a6af6f570c08bcdd7ff82f2c3f6d9
+  metadata.gz: 1c8f416c502ebf647489cdcc81dc5340c416314fe272cceaab3fd7031bfeec02446a5db865c851d159f8fc9bfd963b892f648a43ad83a34be18882d91b68317e
+  data.tar.gz: ccbe3be59044be2b025f7b34777248e4e0e2a99bd651003ce2a8ed12250b57d1366faa1b1f947268524cb8b51ee0ba3e85a115c67cfbc8d25c6df855aac06daa

data/.gitignore

@@ -1,11 +1,34 @@
-/.bundle/
+*.gem
+*.sqlite3
+*.sqlite3-journal
+*~
+.DS_Store
+.bundle
+.byebug_history
+.env
+.idea
+.pry_history
+.pryrc
+.rake_tasks
+.rbenv-gemsets
+.rbenv-version
+.rspec_results
+.ruby-gemset
+.ruby-version
+.rvmrc
+.secret.*
+.tool-versions
+.vscode/
 /.yardoc
 /_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
+Gemfile.lock
+NOTES
+coverage/*
+doc/
+log
+node_modules/
+passenger.*
+pkg
+rdoc/*
+tmp/
+yarn-error.log

data/.overcommit.yml

@@ -0,0 +1,93 @@
+verify_signatures: false
+CommitMsg:
+  ALL:
+  CapitalizedSubject:
+    enabled: true
+    description: 'Checking subject capitalization'
+    quiet: true
+    on_warn: fail
+  EmptyMessage:
+    enabled: true
+    description: 'Checking for empty commit message'
+    quiet: true
+  HardTabs:
+    enabled: true
+    description: 'Checking for hard tabs'
+  RussianNovel:
+    enabled: true
+    description: 'Checking length of commit message'
+    quiet: true
+  SingleLineSubject:
+    enabled: true
+    description: 'Checking subject line'
+  SpellCheck:
+    enabled: true
+    description: 'Checking for misspelled words'
+    required_executable: 'hunspell'
+    flags: ['-a']
+    on_fail: warn
+  TextWidth:
+    enabled: true
+    description: 'Checking text width'
+    max_subject_width: 60
+    max_body_width: 72
+    on_warn: fail
+  TrailingPeriod:
+    enabled: true
+    description: 'Checking for trailing periods in subject'
+    on_warn: fail
+  MessageFormat:
+    enabled: false
+    description: 'Message must be ended with task number'
+    expected_pattern_message: '<Commit Message Description> <Issue Id>'
+    sample_message: 'Refactored Onboarding flow FOO-1234'
+    pattern: '\s([A-Z]{1,4}-\d{1,4}|\d{1,6})$'
+PreCommit:
+  ALL:
+    problem_on_unmodified_line: report
+    requires_files: true
+    required: false
+    quiet: false
+  AuthorEmail:
+    enabled: true
+    description: 'Checking author email'
+    requires_files: false
+    required: true
+    quiet: true
+    pattern: '^[^@]+@.*$'
+  AuthorName:
+    enabled: false
+    description: 'Checking for author name'
+    requires_files: false
+    required: true
+    quiet: true
+  BrokenSymlinks:
+    enabled: true
+    description: 'Checking for broken symlinks'
+    quiet: true
+  CaseConflicts:
+    enabled: true
+    description: 'Checking for case-insensitivity conflicts'
+    quiet: true
+  MergeConflicts:
+    enabled: true
+    description: 'Checking for merge conflicts'
+    quiet: true
+    required_executable: 'grep'
+    flags: ['-IHn', "^<<<<<<<[ \t]"]
+
+  RuboCop:
+    enabled: true
+    required: true
+    quiet: false
+    description: 'Analyzing with RuboCop'
+    command: ['bundle', 'exec', 'rubocop']
+    flags: ['--format=emacs', '--force-exclusion', '--display-cop-names']
+    install_command: 'gem install rubocop'
+    on_warn: fail
+    include:
+      - '**/*.gemspec'
+      - '**/*.rake'
+      - '**/*.rb'
+      - '**/Gemfile'
+      - '**/Rakefile'

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
 --color
 --require spec_helper
+--require turnip/rspec

data/.rubocop.yml

@@ -0,0 +1,80 @@
+inherit_from: .rubocop_todo.yml
+
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+  AutoCorrect: true
+Layout/IndentationConsistency:
+  EnforcedStyle: normal
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+Style/AndOr:
+  EnforcedStyle: conditionals
+Metrics/ClassLength:
+  CountComments: false
+  Max: 300
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 300
+Layout/EndAlignment:
+  AutoCorrect: true
+Layout/DefEndAlignment:
+  AutoCorrect: true
+Style/AutoResourceCleanup:
+  Description: 'Suggests the usage of an auto resource cleanup version of a method (if available).'
+  Enabled: true
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 25
+NumericLiterals:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120
+Documentation:
+  Enabled: false
+Lint/Debugger:
+  Enabled: true
+Metrics/AbcSize:
+  Max: 40
+Metrics/CyclomaticComplexity:
+  Max: 10
+Style/DoubleNegation:
+  Description: 'Checks for uses of double negation (!!).'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-bang-bang'
+  Enabled: false
+Style/AsciiComments:
+  Description: 'Use only ascii symbols in comments.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-comments'
+  Enabled: false
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  Enabled: false
+Style/SingleLineMethods:
+  Description: 'Avoid single-line methods.'
+  StyleGuide: '#no-single-line-methods'
+  Enabled: false
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'gemfiles/*'
+
+require: rubocop-rspec
+RSpec/MultipleExpectations:
+  Max: 7
+RSpec/NestedGroups:
+  Max: 7
+RSpec/ExampleLength:
+  Max: 10
+RSpec/LetSetup:
+  Enabled: false
+RSpec/ContextWording:
+  Enabled: false
+RSpec/RepeatedDescription:
+  Enabled: false
+RSpec/NamedSubject:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-07-07 02:56:05 +0100 using RuboCop version 0.72.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

@@ -1,7 +1,47 @@
 ---
 sudo: false
 language: ruby
+install: bundle --without local_development --jobs=3 --retry=3
 cache: bundler
 rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.0.2
+  - 2.4
+  - 2.5
+  - 2.6
+
+services:
+  - mysql
+  - postgresql
+
+gemfile:
+  - gemfiles/am_5.0.gemfile
+  - gemfiles/am_5.1.gemfile
+  - gemfiles/am_5.2.gemfile
+  - gemfiles/am_6.0.gemfile
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=73c88f60a4ed839ffb0da252514d11374fff29c811beebd0796311faffa7b6b5
+    - COVERAGE=1
+    - TRAVIS_TEST_RESULT=simplecov
+  matrix:
+    - DB=mysql
+    - DB=sqlite
+    - DB=postgres
+
+matrix:
+  exclude:
+    - rvm: 2.4
+      gemfile: gemfiles/am_6.0.gemfile
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+  - psql -c 'create database test;' -U postgres
+  - mysql -e 'CREATE DATABASE IF NOT EXISTS test;'
+
+before_install: gem install bundler -v 2.0.1
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/.yardops

@@ -0,0 +1,9 @@
+--protected
+--no-private
+--embed-mixin ClassMethods
+-
+README.md
+CHANGELOG.rdoc
+CONTRIBUTING.md
+MIT-LICENSE
+CODE_OF_CONDUCT.md

data/Appraisals

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Specify here only version constraints that differ from
+# `active_validation.gemspec`.
+#
+# > The dependencies in your Appraisals file are combined with dependencies in
+# > your Gemfile, so you don't need to repeat anything that's the same for each
+# > appraisal. If something is specified in both the Gemfile and an appraisal,
+# > the version from the appraisal takes precedence.
+# > https://github.com/thoughtbot/appraisal
+
+appraise "am-5.0" do
+  gem "activerecord", "~> 5.0.0"
+end
+
+appraise "am-5.1" do
+  gem "activerecord", "~> 5.1.0"
+end
+
+appraise "am-5.2" do
+  gem "activerecord", "~> 5.2.0"
+end
+
+appraise "am-6.0" do
+  gem "activerecord", "~> 6.0.0"
+  gem "sqlite3", "~> 1.4.0"
+end

data/Gemfile

@@ -1,4 +1,27 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
+# git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-# Specify your gem's dependencies in activevalidation.gemspec
+# Declare your gem's dependencies in active_validation.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
 gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+
+group :local_development do
+  gem "appraisal",  "~> 2.2.0"
+  gem "overcommit", "~> 0.48.0"
+  gem "pry",        "~> 0.12.0"
+  gem "pry-byebug", "~> 3.7.0"
+  gem "reek",       "~> 5.4.0"
+  gem "rubocop",       "~> 0.72.0"
+  gem "rubocop-rspec", "~> 1.32"
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 kvokka
+
+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

@@ -1,43 +1,165 @@
-# Activevalidation
+# ActiveValidation
 
-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/activevalidation`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Version               ][rubygems_badge]][rubygems]
+[![Build Status          ][travisci_badge]][travisci]
+[![Codacy Badge          ][codacy_badge]][codacy]
+[![Reviewed by Hound     ][hound_badge]][hound]
+[![Maintainability       ][codeclimate_badge]][codeclimate]
+[![Test Coverage		 ][codeclimate_coverage_badge]][codeclimate_coveradge]
 
-TODO: Delete this and the text above, and describe your gem
+Extend ActiveModel validations, which introduce validations with versions and
+allows to manage validations of the records dynamically.
 
-## Installation
+With `ActiveValidation` instead of storing all validations hardcoded
+in the Model, you can also store them in the database. Validation Manifests
+are lazy loaded once, and only when they required so it does not
+affect the performance.
+
+## Require
+
+Ruby 2.4+
+ActiveModel ~> 5.0
+
+Supported ORM:
+
+* ActiveRecord ~> 5.0
+
+## Overview
+
+This is the add-on for ActiveModel validations. The gem allows to store
+`ActiveModel` validations in some backend, like DB.
+Each record with `ActiveValidation` belongs to
+`ActiveValidation::Manifest` which holds general information about
+the validation, including `name`, `version` and `id`. Assumed, that
+`ActiveValidation::Manifest`'s with the same version are compatible and share
+the same validation methods. Folder structure example for model `MyModelName`:
+
+```
+.
+└── app
+    └── models
+        ├── my_model_name
+        │   └── validations
+        │       └── v1.rb
+        └── my_model_name.rb
+```
+
+ for different versions of the records.
+Validation versions are stored in the selected backend.
+Validations themselves are stored in `ActiveValidation::Check`, 1 validation
+per one record. `ActiveValidation::Manifest` has many `ActiveValidation::Check`'s.
+
+`Manifest`'s and `Check`'s are immutable by design. Instead of updating or
+patching the existed objects the developer should clone and create the new
+record.
 
+It is assumed that inside one version manifests are compatible. Verifier version
+is a border between new version and the existed one, which allows co-existing of
+both versions at the same time.
+
+To control `ActiveValidation::Manifest`'s there is `ActiveValidation::Verifier`
+class. Each model with activated `ActiveValidation` has one corresponding
+`ActiveValidation::Verifier` instance (which can easily taken with
+`MyModelName.active_validation` method). Through this instance user can add or find
+`Minifest`(s).
+
+
+## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'activevalidation'
+gem 'active_validation'
 ```
 
-And then execute:
+Also will be required create dependent tables in the migration.
 
-    $ bundle
+#### ActiveRecord
 
-Or install it yourself as:
+```bash
+  create_table :active_validation_manifests do |t|
+	t.string   :name
+	t.string   :version
+	t.string   :base_klass
 
-    $ gem install activevalidation
+	t.datetime :created_at
+  end
 
-## Usage
+  create_table :active_validation_checks do |t|
+	t.integer    :manifest_id
+	t.string     :type
+	t.string     :argument
 
-TODO: Write usage instructions here
+	t.json       :options
 
-## Development
+	t.datetime   :created_at
+  end
+```
 
-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.
+## Quick start
 
-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
+### Initial configuration
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activevalidation. 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.
+```ruby
+ActiveValidation.configuration do |c|
+  c.orm_adapter = :active_record
+end
+
+# app/models/foo
+class Foo < ActiveRecord::Base
+  active_validation
+
+#  active_validation do |verifier|          # this is a form with optional block
+# 	verifier.manifest = some_manifest       # lock manifest to some particular existed manifest
+# 	verifier.version = 42 			        # lock version
+# 	verifier.orm_adapter = :active_record	# ORM adapter name
+#  end
+end
+```
 
-## License
+The usage described [in special spec][readme-spec]. Only this way allows to keep it always up-to-date.
+
+## Configuration
+
+You can manage default values with the configuration:
+
+```ruby
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+ActiveValidation.configuration do |c|
+  c.manifest_name_formatter # You can set custom manifest name generator, see lib/active_validation/formatters/manifest_name_formatter.rb
 
-## Code of Conduct
+  c.validation_context_formatter # You can set custom validation context generator, see lib/active_validation/formatters/validation_context_formatter.rb
 
-Everyone interacting in the Activevalidation project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/activevalidation/blob/master/CODE_OF_CONDUCT.md).
+  c.orm_adapter # currently supported `active_record`
+
+  c.verifier_defaults do |v|
+    v.validations_module_name # folder with validations versions, default: "Validations"
+
+	v.failed_attempt_retry_time # Rate limiter for check of missing Manifest, default: `1 day`
+  end
+end
+```
+
+## FAQ
+
+
+## License
+The gem is available as open source under the terms of the
+[MIT License][mit-licence-link].
+
+[rubygems_badge]: http://img.shields.io/gem/v/activevalidation.svg
+[rubygems]: https://rubygems.org/gems/activevalidation
+[travisci_badge]: https://travis-ci.org/kvokka/activevalidation.svg?branch=master
+[travisci]: https://travis-ci.org/kvokka/activevalidation
+[codacy_badge]: https://api.codacy.com/project/badge/Grade/687bcb63afb74686b3acdd0b8cbaf2cf
+[codacy]: https://www.codacy.com/manual/kvokka/activevalidation?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=kvokka/activevalidation&amp;utm_campaign=Badge_Grade
+[hound_badge]: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg
+[hound]: https://houndci.com
+[codeclimate_badge]: https://api.codeclimate.com/v1/badges/53dc9ce7ec0b94570044/maintainability
+[codeclimate]: https://codeclimate.com/github/kvokka/activevalidation/maintainability
+[codeclimate_coverage_badge]: https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/test_coverage
+[codeclimate_coveradge]: https://codeclimate.com/github/codeclimate/codeclimate/test_coverage
+
+[readme-spec]: https://github.com/kvokka/activevalidation/blob/master/spec/active_validation/orm_plugins/active_record_plugin/readme_spec.rb
+
+[mit-licence-link]: http://opensource.org/licenses/MIT