context_validations 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c724b87e632a393002424843cee3cba7ebc3d9a4
+  data.tar.gz: dfae41788870a4f868a5788d862ffc9594cc8136
+SHA512:
+  metadata.gz: 542d270b429d4a8411881c32d472bbc189fa0edae33d3adc2df2f02691621a9c89f05f94691ca74fa1bebd993f56111820a7f4ec64dc4cecfc800096160513a0
+  data.tar.gz: 6a168a33e2603811f8c594d3792df684cc4ba0396faf464ca952b86eeee389c9c8e1dee1206b6c022f076d162d5f104a8fd61d3e29fb281537ec37c9c97adc07

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin/*

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+notifications:
+  email: 
+    - brian@dockyard.com

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in context_validations.gemspec
+gemspec

data/README.md

@@ -0,0 +1,118 @@
+# ContextValidations #
+
+[![Build Status](https://secure.travis-ci.org/dockyard/context_validations.png?branch=master)](http://travis-ci.org/dockyard/context_validations)
+[![Dependency Status](https://gemnasium.com/dockyard/context_validations.png?travis)](https://gemnasium.com/dockyard/context_validations)
+[![Code Climate](https://codeclimate.com/github/dockyard/context_validations.png)](https://codeclimate.com/github/dockyard/context_validations)
+
+Rails exceptions automatically opened as issues on GitHub
+
+## Looking for help? ##
+
+If it is a bug [please open an issue on GitHub](https://github.com/dockyard/context_validations/issues).
+
+## About ##
+
+Context based validations for model instances.
+
+## Example ##
+
+```ruby
+class UserController < ApplicationController
+  include ContextValidations::Controller
+
+  def create
+    @user = User.new(user_params)
+    @user.validations = validations(:create)
+
+    if @user.save
+      # happy path
+    else
+      # sad path
+    end
+  end
+
+  private
+
+  def create_validations
+    validates :password, :presence => true
+  end
+
+  def base_validations
+    validates :first_name, :last_name, :presence => true
+    validates :password, :confirmation => true
+    validates :email, :uniqueness => true, :format => EmailFormat
+  end
+end
+
+class User < ActiveRecord::Base
+  include ContextValidations::Model
+end
+```
+
+### Controllers ###
+In the above example we just call `validations` and pass the context. We
+set the result to `#validations=` on the model.
+
+While this does introduce some complexity into our controllers it frees
+us from the mental gymnastics of conditional validators and state flags.
+
+The corresponding `#{context}_validations` method, in this case
+`create_validations` defines the validations that will be used. Call the
+`#validates` method just like you would in model validations, the API is
+identical.
+
+A `#base_validations` method is always called prior to
+`#{context}_validations` that will allow you to group together common
+validations. The result of these methods appends onto a `@validations`
+array.
+
+If you are using `Ruby 2.0+` you can use implicit contexts:
+
+```ruby
+def create
+  @user = User.new(user_params)
+  # Notice we are only calling the #validations method and not passing
+  # context. In this example the context is derived from the calling
+  # method `create`
+  @user.validations = validations  
+end
+
+private
+
+def create_validations
+  ...
+end
+```
+
+### Models ###
+When the `ContextValidations::Model` module is mixed into the module all
+of the validation callbacks are removed from that model.
+
+Because we are setting the validations on the instance you should not
+use `ActiveRecord::Base.create` as we do not want to allow the
+validations to be set via mass-assignment. This does introduce an extra
+step in some places but it shouldn't be that big of a deal.
+
+## Authors ##
+
+* [Brian Cardarella](http://twitter.com/bcardarella)
+
+[We are very thankful for the many contributors](https://github.com/dockyard/context_validations/graphs/contributors)
+
+## Versioning ##
+
+This gem follows [Semantic Versioning](http://semver.org)
+
+## Want to help? ##
+
+Please do! We are always looking to improve this gem. Please see our
+[Contribution Guidelines](https://github.com/dockyard/context_validations/blob/master/CONTRIBUTING.md)
+on how to properly submit issues and pull requests.
+
+## Legal ##
+
+[DockYard](http://dockyard.com), LLC &copy; 2013
+
+[@dockyard](http://twitter.com/dockyard)
+
+[Licensed under the MIT license](http://www.opensource.org/licenses/mit-license.php)

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/context_validations/controller.rb

@@ -0,0 +1,79 @@
+module ContextValidations::Controller
+  # Will build the validations used to assign to a model instance
+  #
+  # Passing a context will call the `#{context}_validations` method if available
+  # `#base_validations` will always be called prior to `#{context}_validations`
+  #
+  # If you are using Ruby 2.0+ not passing a context will force an implicit context call
+  # based upon the calling method name.
+  #
+  # examples:
+  #   # Implicit method call will call `#base_validations` then `#create_validations`
+  #   def create
+  #     @user.validations = validations
+  #   end
+  #
+  #   # Will call `#base_validations` then `#create_validations`
+  #   def other_create
+  #     @user.validations = validations(:create)
+  #   end
+  #
+  #   # Will onliy call `#base_validations` because `#update_validations` does not exist
+  #   def update
+  #     @user.validations = validations
+  #   end
+  #
+  #   def create_validations
+  #     ...
+  #   end
+  #
+  # @param [String, Symbol]
+  def validations(context = nil)
+    if RUBY_VERSION > '2'
+      context ||= caller_locations(1, 1).first.label
+    end
+    @validations = []
+    base_validations
+    if respond_to?("#{context}_validations")
+      send("#{context}_validations")
+    end
+    @validations
+  end
+
+  # Instance level implementation of `ActiveModel::Validations.validates`
+  # Will accept all of the same options as the class-level model versions of the method
+  def validates(*attributes)
+    defaults = attributes.extract_options!
+    validations = defaults.slice!(*_validates_default_keys)
+
+    attributes.inject(@validations) do |validators, attribute|
+      defaults[:attributes] = [attribute]
+      validations.each do |key, options|
+        key = "#{key.to_s.camelize}Validator"
+        klass = key.include?('::') ? key.constantize : "ActiveModel::Validations::#{key}".constantize
+        validator = klass.new(defaults.merge(_parse_validates_options(options)))
+        validators << validator
+      end
+      validators
+    end.flatten.uniq
+  end
+
+  private
+
+  def _validates_default_keys
+    [:if, :unless, :on, :allow_blank, :allow_nil , :strict]
+  end
+
+  def _parse_validates_options(options)
+    case options
+    when TrueClass
+      {}
+    when Hash
+      options
+    when Range, Array
+      { :in => options }
+    else
+      { :with => options }
+    end
+  end
+end

data/lib/context_validations/model.rb

@@ -0,0 +1,36 @@
+module ContextValidations::Model
+  def self.included(base)
+    base.class_eval do
+      reset_callbacks(:validate)
+    end
+
+    base._validators.keys.each do |key|
+      base._validators.delete(key)
+    end
+  end
+
+  # The collection of validations assigned to this model instance
+  #
+  # @return [Array]
+  def validations
+    @validations ||= []
+  end
+
+  # Use to set the validations collection assigned to this model instance
+  #
+  # Pass an array of validator instances
+  #
+  # @param [[ActiveMode::Validations::Validator]]
+  def validations=(validations)
+    @validations = validations.flatten
+  end
+
+  protected
+
+  def run_validations!
+    Array.wrap(validations).each do |validator|
+      validator.validate(self)
+    end
+    errors.empty?
+  end
+end

data/lib/context_validations/version.rb

@@ -0,0 +1,3 @@
+module ContextValidations
+  VERSION = '0.0.1'
+end

data/lib/context_validations.rb

@@ -0,0 +1,9 @@
+require 'context_validations/version'
+require 'active_support'
+
+module ContextValidations
+  extend ActiveSupport::Autoload
+
+  autoload :Controller
+  autoload :Model
+end

data/strong_validations.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'context_validations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'context_validations'
+  spec.version       = ContextValidations::VERSION
+  spec.authors       = ['Brian Cardarella']
+  spec.email         = ['bcardarella@gmail.com']
+  spec.description   = %q{Context based validations for ActiveRecord models}
+  spec.summary       = %q{Context based validations for ActiveRecord models}
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'm'
+  spec.add_development_dependency 'activemodel'
+end

data/test/controller_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class UsersController
+  include ContextValidations::Controller
+
+  def create
+    validations
+  end
+
+  def other_create
+    validations(:create)
+  end
+
+  def update
+    validations
+  end
+
+  def base_validations
+    validates :first_name, :presence => true
+  end
+
+  def create_validations
+    validates :password, :presence => true
+  end
+end
+
+describe 'Controller' do
+  before do
+    @controller = UsersController.new
+  end
+
+  if RUBY_VERSION >= '2'
+    it 'combines base and create validations for create action, context is implied' do
+      @controller.create.length.must_equal 2
+    end
+  end
+
+  it 'combines base and create validations for other create action, context is forced' do
+    @controller.other_create.length.must_equal 2
+  end
+
+  it 'uses base validations when context validations are not set for update action' do
+    @controller.update.length.must_equal 1
+  end
+end

data/test/model_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+require 'active_model'
+
+EmailFormat = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/
+
+class User
+  include ActiveModel::Validations
+  include ContextValidations::Model
+  attr_accessor :first_name, :email
+
+  validates :first_name, :presence => true
+  validates :email, :format => EmailFormat
+end
+
+describe 'Model' do
+  before do
+    @user = User.new
+  end
+
+  it 'ignores existing validations' do
+    @user.valid?.must_equal true
+  end
+
+  it 'accepts validations set onto the instance' do
+    validations = [ActiveModel::Validations::PresenceValidator.new(:attributes => [:first_name]), ActiveModel::Validations::FormatValidator.new(:attributes => [:email], :with => EmailFormat)]
+    @user.validations = validations
+    @user.valid?.must_equal false
+    @user.errors.count.must_equal 2
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+
+if defined?(M)
+  require 'minitest/spec'
+else
+  require 'minitest/autorun'
+end
+
+require 'context_validations'
+
+class MiniTest::Spec
+  class << self
+    alias :context :describe
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: context_validations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Cardarella
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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: m
+  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: activemodel
+  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: Context based validations for ActiveRecord models
+email:
+- bcardarella@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/context_validations.rb
+- lib/context_validations/controller.rb
+- lib/context_validations/model.rb
+- lib/context_validations/version.rb
+- strong_validations.gemspec
+- test/controller_test.rb
+- test/model_test.rb
+- test/test_helper.rb
+homepage: 
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Context based validations for ActiveRecord models
+test_files:
+- test/controller_test.rb
+- test/model_test.rb
+- test/test_helper.rb