activemodel-interdependence 0.0.1

data/Guardfile

@@ -0,0 +1,68 @@
+require 'guard'
+
+ignore /tmp/, /doc/
+
+guard :bundler do
+  watch('Gemfile')
+  watch('*.gemspec')
+end
+
+group :documentation do
+  guard :yardstick do
+    watch(%r{^(lib\/(.+)\.rb)$}) { |m| m[0] }
+  end
+
+  # Critique documentation (visual help and recommendations)
+  guard :inch do
+    watch(/.+\.rb/)
+  end
+end
+
+# Build documentation
+guard :yard, cli: '--plugin virtus' do
+  watch(%r{app/.+\.rb})
+  watch(%r{lib/.+\.rb})
+  watch(%r{ext/.+\.c})
+end
+
+group :critique do
+  # Critique code smells
+  guard :reek, cli: %w(-c config/reek.yml), run_all_with: ['lib'] do
+    watch(%r{.+\.rb$}) { 'lib' }
+  end
+
+  # Critique the most painful code
+  guard :flog do
+    watch(%r{^lib/(.+)\.rb$})
+
+    # Rails example
+    watch(%r{^app/(.+)\.rb$})
+  end
+
+  # Critique code for structural similarities
+  guard :flay do
+    watch(%r{^lib/(.+)\.rb$})
+
+    # Rails example
+    watch(%r{^app/(.+)\.rb$})
+    watch(%r{^app/(.*)(\.erb|\.haml)$})
+    watch('config/routes.rb')
+
+    # Flay specs
+    watch(%r{^spec/(.+)_spec\.rb$})
+  end
+
+  # Critique code style
+  guard :rubocop do
+    watch(%r{(.+\.rb)$}) { |m| m[0] }
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end
+
+# RSpec is often the longest running guard so we put it last
+guard :rspec, cmd: 'bundle exec rspec' do
+  # watch(%r(.*$)) { 'spec' }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2015 BlockScore
+
+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,76 @@
+# ActiveModel Interdependence
+
+[![Circle CI](https://img.shields.io/circleci/project/BlockScore/activemodel-interdependence.svg)](https://circleci.com/gh/BlockScore/activemodel-interdependence) [![Code Quality](https://img.shields.io/codeclimate/github/BlockScore/activemodel-interdependence.svg)](https://codeclimate.com/github/BlockScore/activemodel-interdependence) [![Code Coverage](https://img.shields.io/codeclimate/coverage/github/BlockScore/activemodel-interdependence.svg)](https://codeclimate.com/github/BlockScore/activemodel-interdependence/coverage) [![Inline Documentation](http://inch-ci.org/github/blockscore/activemodel-interdependence.png)](http://inch-ci.org/github/blockscore/activemodel-interdependence)
+
+Specify that validations depend on the validation of other fields
+
+Lets classes that implement `ActiveModel::Model` or `ActiveModel::Validator`
+specify that they are dependent on other fields being valid. These specifications
+are translated into a dependency graph, sorted, and applied in order to a model.
+As a result, fields are only validated once the fields that they depend on are
+validated.
+
+## Install
+
+Simply run
+```shell
+gem install activemodel-interdependence
+```
+
+or add activemodel-interdependence to your gemfile
+
+```ruby
+gem 'activemodel-interdependence'
+```
+
+and run `bundle install` from your shell.
+
+## Usage
+
+```ruby
+class DayValidator < ActiveModel::EachValidator
+  validates :month_field, inclusion: 1..12
+  validates :year_field, inclusion: 0..2015
+
+  def validate_each(record, attribute, value)
+    month = dependency(record, :month_field)
+    year = dependency(record, :year_field)
+
+    return if (1..Time.days_in_month(month, year)).cover?(value)
+    record.errors[attribute] << "is not valid for the month #{Date::MONTHNAMES[month]}"
+  end
+
+  def dependency(record, proxy_name)
+    name = options.fetch(:dependencies, {}).fetch(proxy_name)
+
+    record.send(name)
+  end
+end
+
+class Birthday
+  include ActiveModel::Model
+  attr_accessor :day, :month, :year
+
+  validates :day, day: {
+    dependencies: {
+      month_field: :month,
+      year_field: :year
+    }
+  }
+end
+
+leap_day = Birthday.new(day: 29, month: 2, year: 2000)
+leap_day.valid? # => true
+
+not_a_leap_day = Birthday.new(day: 29, month: 2, year: 1999)
+not_a_leap_day.valid? # => false
+not_a_leap_day.errors.full_messages # => ["Day is not valid for the month February"]
+
+bad_month = Birthday.new(day: 29, month: 0, year: 1999)
+bad_month.valid? # => false
+bad_month.errors.full_messages # => ["Month is not included in the list"]
+```
+
+## License
+
+**activemodel-interdependence** is released under the MIT license. See `LICENSE` for details.

data/Rakefile

@@ -0,0 +1,95 @@
+require 'bundler/setup'
+Bundler.require(:metrics)
+
+require 'rake'
+require 'yard-virtus'
+require 'yard/virtus/mixin_handler_monkey_patch'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = %w(lib/**/*.rb)
+end
+
+Devtools.init_rake_tasks
+
+##
+# Run mutant tasks and give a nice help message
+class MutantTask
+  include Rake::FileUtilsExt
+
+  def initialize(*)
+    @matcher = next_matcher
+  end
+
+  def run
+    if matcher?
+      run_mutant
+    else
+      puts 'No matchers remaining'
+    end
+  end
+
+  private
+
+  def next_matcher
+    matcher = read_next_matcher
+    matcher ? matcher.chomp : :no_matchers
+  end
+
+  def read_next_matcher
+    open('.mutants').readlines.first
+  end
+
+  HELP = <<-HELP.gsub(/^\s+\|/, '')
+  |Provide a valid mutant matcher. Here are some examples:
+  |
+  |    rake 'mutant[*]'
+  |    rake 'mutant[Foo]'
+  |    rake 'mutant[Foo*]'
+  |    rake 'mutant[Foo#instance_method]'
+  |    rake 'mutant[Foo.class_method]'
+  |    rake 'mutant[Foo::Bar]'
+  |    rake 'mutant[Foo::Bar*]'
+  |
+  |and so on.
+  |
+  |Try to be specific. Even a few methods can take a while.
+  HELP
+
+  attr_reader :matcher
+
+  def run_mutant
+    shift_mutants if mutant?
+  end
+
+  def shift_mutants
+    File.write('.mutants', shifted_mutants)
+  end
+
+  def shifted_mutants
+    open('.mutants').readlines.tap(&:shift).join('')
+  end
+
+  def mutant
+    @mutant ||= sh(command)
+  end
+  alias_method :mutant?, :mutant
+
+  def matcher?
+    !matcher.equal?(:no_matchers)
+  end
+
+  def print_help
+    puts HELP
+  end
+
+  def command
+    "bundle exec mutant -I lib -r interdependence --use rspec #{matcher}"
+  end
+end
+
+desc 'Run mutant'
+task :mutant, %i(matcher) do |_, args|
+  MutantTask.new(args).run
+end
+
+task default: :mutant

data/activemodel-interdependence.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'interdependence/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activemodel-interdependence"
+  spec.version       = Interdependence::VERSION
+  spec.authors       = ["John Backus"]
+  spec.email         = ["john@blockscore.com"]
+
+  spec.summary       = %q{Use validators interdependently}
+  spec.description   = %q{Interdependent model validations}
+  spec.homepage      = "https://github.com/blockscore/activemodel-interdependence"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version  = '>= 2.2.0'
+
+  spec.add_dependency 'activemodel', '~> 4.2'
+  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'virtus', '~> 1'
+  spec.add_dependency 'adamantium', '~> 0.2'
+
+  spec.add_development_dependency "rspec", '~> 3.0'
+  spec.add_development_dependency "rspec-core", '~> 3.0'
+  spec.add_development_dependency "rspec-its", '~> 1.2'
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/circle.yml

@@ -0,0 +1,7 @@
+---
+machine:
+  ruby:
+    version: '2.2.1'
+test:
+  override:
+    - bundle exec rake ci

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 0.5

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 12
+total_score: 195

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 14.1

data/config/mutant.yml

@@ -0,0 +1,9 @@
+---
+name: interdependence
+namespace: Interdependence
+expect_coverage: 1
+ignore_subjects:
+# I don't care about testing #inspect
+- 'Interdependence::Dependency::Base#inspect'
+# merge! causes infinite runtime on circle
+- 'Interdependence::DependencySetGraph#merge!'

data/config/reek.yml

@@ -0,0 +1,120 @@
+---
+Attribute:
+  enabled: false
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: false
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude:
+  - '#=='
+  - '#resolvable?'
+  - !ruby/regexp /(\.|#)included/
+  - !ruby/regexp /ActiveModel::/
+  - 'Interdependence::DependencyResolver::Model#resolve_with'
+IrresponsibleModule:
+  enabled: false
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 3
+  overrides:
+    initialize:
+      max_params: 5
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 3
+ModuleInitialize:
+  enabled: true
+  exclude: []
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 2
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude:
+  - !ruby/regexp /Coercer#self.call/
+PrimaDonnaMethod:
+  enabled: true
+  exclude:
+  - !ruby/regexp /DependencySetGraph/
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 2
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 9
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 25
+TooManyStatements:
+  enabled: true
+  exclude:
+  - initialize
+  max_statements: 5
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept:
+  - Inline::C
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  - !ruby/regexp /^_/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept:
+  - _
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude:
+  - '#resolvable?'
+  - 'Interdependence::Types::UnsetField#=='