cavalry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 967d285751a7b9c490680cbfc6291dab9e9cbb43
+  data.tar.gz: 1b87f1ff8ef5d2749b57572d07dd9cb0c8cfa68a
+SHA512:
+  metadata.gz: '008f80c63a66b341afc6d372474ae7cc90d47c67ff21124063345b2d58c6bf2c23a5a2db83b72b01de9ec9477eb201e6841f2654b16e53c43d99908758cd576c'
+  data.tar.gz: cfeb4852f8614f9b4f1823d49bc79be93445af6f8522fa390eeef9a74a858dab697b4e3845b1f76e559573e9c1291c51305f02f028a16dbaf1677a0260eb83fa

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.15.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 cavalry.gemspec
+gemspec

data/README.md

@@ -0,0 +1,137 @@
+# Cavalry
+
+Cavalry is whole data validation DSL.
+
+
+# Strength
+
+The situation: When you need to validate some data, with foreign-key or has some constraints on associations(like Online-game's master-data), you need to insert all data first for validation.
+
+Cavalry can:
+  1. Write some validation with DSL like ActiveModel implementation.
+  2. Validate to each records, or grouped records.
+  3. Validations will not depend it's data-model.
+  3. Integrate friendly.
+
+# Workflow
+
+1. Prepare your data via ActiveModel or Insert your data to database via ActiveRecord. (like rake db:seed)
+2. Write your Validation
+3. Run Cavalry.run
+4. Fix the data if you need.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cavalry'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cavalry
+
+## Usage
+
+### How to write Validation
+
+Here is example model and validator!
+
+
+```:person.rb
+class Person < ActiveRecord::Base
+  has_many :books
+  has_one  :life
+end
+```
+
+```:person_validator.rb
+# 1. inherit Cavalry::Validator to define validator
+class PersonValidator < Cavalry::Validator
+  # 2. call Cavalry::Validator.validate_for, to define target model
+  validate_for Person
+
+  # 3. pass a block to Cavalry::Validator.validate_each. it runs EVERY data-record.
+  validate_each do
+    # people needs life...
+    validates :life, presence: true
+
+    validate :name_is_downcased
+
+    def name_is_downcased
+      if name != name.downcase
+        errors.add(:name, "should be downcase.")
+      end
+    end
+  end
+
+  # 4. pass a block to Cavalry::Validator.validate_group. it runs ONCE for whole data-record
+  validate_group do
+
+    # 5. call validate and give it block. it receives Person.all as argument "records"
+    validate do |records|
+      return unless records.count > 5
+      errors.add(:base, "Too many people.")
+    end
+
+    # 5. call validate and chain any methods. it receives Person.method as argument "records"
+    validate.where(name: "bob") do |records|
+      return if records.count == 1
+      errors.add(:base, "bob must be unique.")
+    end
+
+    # 6. call validate with symbol, it calls method that you defined same scope.
+    validate :books_are_unique
+
+    def number_of_books
+      all_books = Person.all.flat_map(&:book)
+
+      return if all_books == all_books.uniq
+
+      errors.add(:books, "books that people have should be unique")
+    end
+  end
+end
+```
+
+### How to execute
+
+Here is sample rake task file.
+I'm waiting some PR for improve!
+
+```:Rakefile
+namespace :data do
+  task check: :environment do
+    Cavalry.configure do |config|
+      config.modelss_path = "app/models"
+      config.validators_path = "app/validators"
+    end
+
+    unless Cavalry.valid?
+      print Cavalry.dump.to_yaml
+    end
+  end
+end
+```
+
+Then,
+
+```
+bundle exec rake data:check
+```
+
+
+## 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/the40san/cavalry.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cavalry/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cavalry"
+  spec.version       = Cavalry::VERSION
+  spec.authors       = ["Masashi AKISUE"]
+  spec.email         = ["m.akisue.b@gmail.com"]
+
+  spec.summary       = %q{Simple whole data validation via ActiveRecord}
+  spec.description   = %q{Simple whole data validation via ActiveRecord}
+  spec.homepage      = "https://github.com/the40san/cavalry"
+
+  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_dependency "activemodel", "~> 5.1"
+  spec.add_dependency "activesupport", "~> 5.1"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/cavalry.rb

@@ -0,0 +1,36 @@
+require "cavalry/version"
+require "active_support"
+require "active_model"
+
+module Cavalry
+  autoload :Config, 'cavalry/config'
+  autoload :Client, 'cavalry/client'
+  autoload :Validator, 'cavalry/validator'
+  autoload :Error, 'cavalry/error'
+
+  class DSLError < RuntimeError; end
+
+  class << self
+    def configure
+      yield config
+    end
+
+    delegate :run, :errors, :dump, to: :client
+
+    def valid?
+      run unless client.done?
+      errors.blank?
+    end
+
+
+    private
+
+    def client
+      @client ||= Client.new(config)
+    end
+
+    def config
+      @config ||= Config.new
+    end
+  end
+end

data/lib/cavalry/client.rb

@@ -0,0 +1,38 @@
+module Cavalry
+  class Client
+    attr_reader :errors
+
+    def initialize(config)
+      @config = config
+      @errors = []
+
+      config.load_models
+      config.load_validators
+    end
+
+    def run
+      @errors = all_validators.flat_map do |klass|
+        klass.execute_validation
+      end
+      @done = true
+    end
+
+    def done?
+      @done
+    end
+
+    def dump
+      errors.map(&:dump)
+    end
+
+    private
+
+    def all_validators
+      @all_validators ||= ObjectSpace.each_object(::Cavalry::Validator.singleton_class).map do |k|
+        next if k.singleton_class?
+        next if k == ::Cavalry::Validator
+        k
+      end.compact
+    end
+  end
+end

data/lib/cavalry/config.rb

@@ -0,0 +1,25 @@
+module Cavalry
+  class Config
+    # Defines validator definition path. files required with **/*.rb
+    mattr_accessor :models_path
+
+    # Defines validator definition path. files required with **/*.rb
+    mattr_accessor :validators_path
+
+    def load_models
+      load_rb_files(models_path)
+    end
+
+    def load_validators
+      load_rb_files(validators_path)
+    end
+
+    private
+
+    def load_rb_files(path)
+      return unless path
+      files = Dir.glob(File.join("#{path}", "**/*.rb"))
+      files.each { |f| require f }
+    end
+  end
+end

data/lib/cavalry/error.rb

@@ -0,0 +1,17 @@
+module Cavalry
+  class Error
+    delegate :errors, to: :@record
+
+    def initialize(record)
+      @record = record
+      dump
+    end
+
+    def dump
+      { record: @record.class.name }.tap do |h|
+        h.merge!(attributes: @record.attributes) if @record.respond_to?(:attributes)
+        h.merge!(errors: errors.to_hash)
+      end
+    end
+  end
+end

data/lib/cavalry/validator.rb

@@ -0,0 +1,40 @@
+module Cavalry
+  class Validator
+    autoload :EachValidator, 'cavalry/validator/each_validator'
+    autoload :GroupValidator, 'cavalry/validator/group_validator'
+
+    class << self
+      def validate_for(*klasses)
+        @klasses = klasses.map { |k| append_required_module(k) }
+        @each_validators = []
+        @group_validators = []
+      end
+
+      def validate_each(&block)
+        @each_validators += @klasses.map {|k| EachValidator.new(k, &block) }
+      end
+
+      def validate_group(&block)
+        @group_validators += @klasses.map {|k| GroupValidator.new(k, &block) }
+      end
+
+      def execute_validation
+        error_records = [].tap do |res|
+          res << @each_validators.map(&:validate).compact
+          res << @group_validators.map(&:validate).compact
+        end.flatten
+
+        error_records.map {|e| Error.new(e) }
+      end
+
+      private
+
+      def append_required_module(klass)
+        unless klass.include?(ActiveModel::Validations)
+          klass.include(ActiveModel::Validations)
+        end
+        klass
+      end
+    end
+  end
+end

data/lib/cavalry/validator/each_validator.rb

@@ -0,0 +1,23 @@
+module Cavalry
+  class Validator
+    class EachValidator
+      attr_reader :source_class
+
+      def initialize(klass, &block)
+        @source_class = klass
+        @source_class.class_eval(&block)
+      end
+
+      def validate
+        source_class.all.flat_map {|record| validate_record(record) }.compact
+      end
+
+      private
+
+      def validate_record(record)
+        return if record.valid?
+        record
+      end
+    end
+  end
+end

data/lib/cavalry/validator/group_validator.rb

@@ -0,0 +1,117 @@
+module Cavalry
+  class Validator
+    class GroupValidator
+      attr_reader :source_class
+      attr_reader :definitions
+
+      def initialize(klass, &block)
+        @source_class = klass
+        @definitions = block
+      end
+
+      def validate
+        validator_context = create_validations
+        validator_context.instance.validate
+        validator_context.instance.errors.any? ? validator_context.instance : nil
+      end
+
+      private
+
+      def create_validations
+        new_class = Class.new
+        new_class.include(GroupValidations)
+        new_class.source_class = source_class
+        new_class.class_eval(&@definitions)
+        new_class
+      end
+    end
+
+    module GroupValidations
+      extend ActiveSupport::Concern
+
+      included do
+        cattr_accessor :source_class
+        cattr_accessor :validators
+      end
+
+      class_methods do
+        def name
+          "GroupValidation"
+        end
+
+        def validate(*args, &block)
+          self.validators ||= []
+
+          if args.count.zero?
+            InlineValidator.new(source_class, instance, &block).tap do |validator|
+              self.validators << validator
+            end
+          else
+            args.each do |method_name|
+              self.validators << MethodCallValidator.new(source_class, instance, method_name)
+            end
+          end
+        end
+
+        def instance
+          @instance ||= new
+        end
+      end
+
+      def validate
+        self.validators.map(&:validate)
+      end
+
+      def errors
+        @errors ||= ActiveModel::Errors.new(self)
+      end
+    end
+
+    class MethodCallValidator
+      def initialize(source_class, context, method_name)
+        @source_class = source_class
+        @context = context
+        @method_name = method_name
+      end
+
+      def validate
+        if @context.method(@method_name).arity.zero?
+          @context.send(@method_name)
+        else
+          @context.send(@method_name, @source_class.all)
+        end
+      end
+    end
+
+    class InlineValidator
+      def initialize(source, context, &block)
+        @source = source
+        @context = context
+        @definition = block
+      end
+
+      # execute
+      def validate
+        fail(DSLError, "Give me a definition") unless @definition
+
+        tap do
+          @context.class.send(:define_method, :cavalry_validation, @definition)
+          @context.send(:cavalry_validation, @source.respond_to?(:all) ? @source.all : @source)
+          @context.class.send(:undef_method, :cavalry_validation)
+        end
+      end
+
+      # Modify the validation source when method is chained.
+      # if you pass a block to method, block will be stored as validation definition.
+      def method_missing(method_name, *arg, &block)
+        if @source.respond_to?(method_name)
+          @source = @source.send(method_name, *arg)
+        else
+          fail DSLError, "Method #{method_name} is missing for #{@source.inspect}"
+        end
+
+        @definition = block if block_given?
+      end
+    end
+  end
+end

data/lib/cavalry/version.rb

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

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: cavalry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masashi AKISUE
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple whole data validation via ActiveRecord
+email:
+- m.akisue.b@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cavalry.gemspec
+- lib/cavalry.rb
+- lib/cavalry/client.rb
+- lib/cavalry/config.rb
+- lib/cavalry/error.rb
+- lib/cavalry/validator.rb
+- lib/cavalry/validator/each_validator.rb
+- lib/cavalry/validator/group_validator.rb
+- lib/cavalry/version.rb
+homepage: https://github.com/the40san/cavalry
+licenses: []
+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.13
+signing_key: 
+specification_version: 4
+summary: Simple whole data validation via ActiveRecord
+test_files: []