conditional_validation 0.0.5 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YjYyY2ZlNmExOTAxMDAyNDJjZjU2Y2E5Y2QzYzE0Yjk5MzE5YjIwOA==
-  data.tar.gz: !binary |-
-    OTQ4YmUzOTUzM2FmMjgzZmM5MzFkOWNmOTgzODBhZTAwNDBjZDNjZg==
+SHA1:
+  metadata.gz: 85f47600c28259d876df108d8465339eb32dd021
+  data.tar.gz: 05fbb9cf2672e68ff8297b548dc78c4152084931
 SHA512:
-  metadata.gz: !binary |-
-    YWM4NmIxNDNhMzJmOWEyNjJjMjA3YTFmODVkMmQwNGFlNWI2Mzc4ZWVlZDk2
-    ZWFiZGZhOTIxMWM2ZDQxMjE2NmU5ZWZlZDIwZjNjZDUwMTJjNmJkOGJjYWI4
-    MmVmYzEyYTNiMGZlZDM4OWRjMGJhZjZmYzIzODc4OWFlOTY4NDg=
-  data.tar.gz: !binary |-
-    YjE3NDlmODBlYzY5MDU1NWEwNDY0ZWFkY2UxM2I1YjBkMzcwODY5ZjRjZTE1
-    YThiNmVmZjJjMzM3ZjQ1ZTk2NjQ3ODYzYjZkMGZhYzU3MDkxYWVhMTEwZWE2
-    ZDcwYTMzZWE5ODljMjI0N2FiZmU3NzE3Y2JmNjJhYjczNzBiMWI=
+  metadata.gz: 9f8f40b43dd9967e175a8780b37074ecf2b359368f8d2061945b98e8fa48d45124f1db0f12c4fc5b1cc045b6f92fbc6995b0f1722c348e561e497b7c336a81b2
+  data.tar.gz: 3486772d09179433722a3d53f6db3726ae0a86520c68348e2bb45ed8280c3e8fb5fbe3f8e77d207b169c6889a798a4c951c21b672fe60b2a3a86c7d393bb4443

data/README.md

@@ -2,9 +2,13 @@
 
 [![Gem Version](https://badge.fury.io/rb/conditional_validation.png)](http://badge.fury.io/rb/conditional_validation)
 
-Conditional Validation allows controllers to communicate with models about
-whether or not certain validations should be run. This is great for multi-page
-wizards and context-dependent validations.
+Conditional Validation allows validation flags to be enabled to determine when
+certain validations should be run on a model. The idea being that, while models
+tend to have a set of core validations that should always be run, some
+validations may be specific to a certain context or state of the object. Typical
+use-case, then, is to flag a model's non-core validations to run from specific
+controller actions, while they default to not run from all others.
+
 
 ## Compatibility
 
@@ -12,15 +16,16 @@ Tested with:
 
 * Ruby: MRI 1.9.3
 * Ruby: MRI 2.0.0 +
-* Rails: 3.0.0 +
-* Rails: 4.0.0 +
+* Rails: 3+
+* Rails: 4+
+
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "conditional_validation"
+gem 'conditional_validation'
 ```
 
 And then execute:
@@ -29,31 +34,35 @@ And then execute:
 bundle
 ```
 
+
 ## Usage
 
-First, define a validation accessor:
+First, define a validation flag:
 
 ```ruby
 # app/models/some_model.rb
 class SomeModel
-  validation_accessor :some_grouping_name
+  validation_flag :<flag_name>
 end
 ```
 
-Then, this model will receive the following methods for conditional validation:
+Then, the following methods will be defined on SomeModel for conditional
+validation:
 
 ```ruby
-enable_some_grouping_name_validation # Enables conditional validation
-disable_some_grouping_name_validation # Disables conditional validation
-validate_on_some_grouping_name? # Check if conditional validation is enabled
+enable_<flag_name>_validation # Enables conditional validation
+disable_<flag_name>_validation # Disables conditional validation
+validate_on_<flag_name>? # Check if conditional validation is enabled
 ```
 
-<b>A "Real World" Example</b>
+
+### A "Real World" Example
 
 ```ruby
 # app/models/user.rb
 User < ActiveRecord::Base
-  validation_accessor :address_attributes # Initialize conditional validation on address attributes
+  # Initialize conditional validation on address attributes
+  validation_flag :address_attributes
 
   with_options if: :validate_on_address_attributes? do |obj|
     obj.validates :street, presence: true
@@ -64,18 +73,20 @@ end
 
 # app/controllers/user_controller.rb
 def update
-  current_user.enable_address_attributes_validation # Enable conditional validation on address attributes
+  # Enable conditional validation on address attributes
+  current_user.enable_address_attributes_validation
   if current_user.save
-    current_user.disable_address_attributes_validation # Not necessarily needed, but disables conditional validation on address attributes
+    # Not typically needed, but disables conditional validation on address attributes
+    current_user.disable_address_attributes_validation
     # ...
   end
 end
 ```
 
-<b>Method Chaining</b>
+### Method Chaining
 
 The enable and disable methods allow for method chaining so that multiple
-validation accessors may be enabled/disabled at once:
+validation flags may be enabled/disabled at once:
 
 ```ruby
 if current_user.enable_address_attributes_validation.enable_some_other_validation.save
@@ -83,6 +94,7 @@ if current_user.enable_address_attributes_validation.enable_some_other_validatio
 end
 ```
 
+
 ## Author
 
 - Paul Dobbins

data/lib/conditional_validation.rb

@@ -1,3 +1,4 @@
+require "conditional_validation/validation_flag"
 require "conditional_validation/validation_accessor"
 
 module ConditionalValidation

data/lib/conditional_validation/validation_accessor.rb

@@ -6,8 +6,10 @@ module ConditionalValidation
       # Macro method for defining an attr_accessor and various
       # enable/disable/predicate methods that wrap the attr_acessor for
       # determining when to run a set of validation on an ActiveRecord model.
+      #
       # @param args [*accessors] the section names for which to define
       #   validation accessors for
+      #
       # @example
       #   class User
       #     validation_accessor :address_attributes
@@ -18,24 +20,30 @@ module ConditionalValidation
       #   #      disable_address_attributes_validation
       #   #      validate_on_address_attributes?
       def validation_accessor(*accessors)
-        attr_accessor *accessors.map { |accessor| "_#{accessor}_validation_accessor" }
+        attr_accessor *accessors.map { |accessor|
+          "_#{accessor}_validation_accessor"
+        }
 
         accessors.each do |accessor|
-          define_method "enable_#{accessor}_validation" do
-            self.send("_#{accessor}_validation_accessor=", true)
-            self
-          end
+          class_eval <<-METHODS, __FILE__, __LINE__ + 1
+            def enable_#{accessor}_validation
+              self._#{accessor}_validation_accessor = true
+              self
+            end
 
-          define_method "disable_#{accessor}_validation" do
-            self.send("_#{accessor}_validation_accessor=", false)
-            self
-          end
+            def disable_#{accessor}_validation
+              self._#{accessor}_validation_accessor = false
+              self
+            end
 
-          define_method "validate_on_#{accessor}?" do
-            !!self.send("_#{accessor}_validation_accessor")
-          end
+            def validate_on_#{accessor}?
+              !!_#{accessor}_validation_accessor
+            end
+          METHODS
         end
       end
+      deprecate validation_accessor: :validation_flag,
+                deprecator: ActiveSupport::Deprecation.new('1.0', 'Conditional Validation')
     end
   end
 end

data/lib/conditional_validation/validation_flag.rb

@@ -0,0 +1,47 @@
+module ConditionalValidation
+  module ValidationFlag
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Macro method for defining an attr_accessor and
+      # enable/disable/predicate methods that wrap the attr_acessor for
+      # determining when to run a set of validation on an ActiveRecord model.
+      #
+      # @param [*Array] flags the section names for which to define
+      #   validation flags for
+      #
+      # @example
+      #   class User
+      #     validation_flag :address_attributes
+      #   end
+      #
+      #   # => Defines the following methods on instances of the User class:
+      #   #      enable_address_attributes_validation
+      #   #      disable_address_attributes_validation
+      #   #      validate_on_address_attributes?
+      def validation_flag(*flags)
+        attr_accessor *flags.map { |flag| "_#{flag}_validation_flag" }
+
+        flags.each do |flag|
+          class_eval <<-METHODS, __FILE__, __LINE__ + 1
+            def enable_#{flag}_validation
+              self._#{flag}_validation_flag = true
+              self
+            end
+
+            def disable_#{flag}_validation
+              self._#{flag}_validation_flag = false
+              self
+            end
+
+            def validate_on_#{flag}?
+              !!_#{flag}_validation_flag
+            end
+          METHODS
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ConditionalValidation::ValidationFlag)

data/lib/conditional_validation/version.rb

@@ -1,3 +1,3 @@
 module ConditionalValidation
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/test/conditional_validation_test.rb

@@ -1,56 +1,100 @@
 require 'test_helper'
 
 describe ConditionalValidation do
-  describe "validation_accessor macro" do
-    it "is available to ActiveRecord models" do
-      class SomeClass < ActiveRecord::Base
+  describe "#validation_flag" do
+    # User is defined in test/dummy/app/models/user.rb and is setup with
+    # validation_flags already.
+    subject { User.new }
+
+    it "is available to ActiveRecord models by default" do
+      class SomeClass < ActiveRecord::Base; end
+      SomeClass.must_respond_to(:validation_flag)
+    end
+
+    it "defines validation_flag methods" do
+      [:enable_flag_attributes_validation,
+        :disable_flag_attributes_validation,
+        :validate_on_flag_attributes?].each do |method|
+        subject.must_respond_to(method)
+      end
+    end
+
+    it "does not define validation_flag methods for unrequested validation_flags" do
+      [:"enable_unknown_attributes_validation",
+        :"disable_unknown_attributes_validation",
+        :"validate_on_unknown_attributes?"].each do |method|
+        subject.wont_respond_to(method)
+      end
+    end
+
+    describe "validation_flag methods" do
+      it "allows method chaining" do
+        subject.enable_flag_attributes_validation.must_equal subject
+        subject.disable_flag_attributes_validation.must_equal subject
+      end
+
+      it "requests validation when enabled" do
+        refute subject.validate_on_flag_attributes?
+
+        subject.enable_flag_attributes_validation
+        assert subject.validate_on_flag_attributes?
+      end
+
+      it "does not request validation when disabled" do
+        subject.enable_flag_attributes_validation
+        assert subject.validate_on_flag_attributes?
+
+        subject.disable_flag_attributes_validation
+        refute subject.validate_on_flag_attributes?
       end
-      assert { SomeClass.respond_to?(:validation_accessor) }
     end
   end
 
-  describe "when a model is using the validation_accessor macro" do
-    before do
-      @user = User.new # Defined in test/dummy app
+  describe "#validation_accessor" do
+    # User is defined in test/dummy/app/models/user.rb and is setup with
+    # validation_flags already.
+    subject { User.new }
+
+    it "is available to ActiveRecord models by default" do
+      class SomeClass < ActiveRecord::Base; end
+      SomeClass.must_respond_to(:validation_accessor)
     end
 
     it "defines validation_accessor methods" do
-      [:enable_address_attributes_validation,
-        :disable_address_attributes_validation,
-        :validate_on_address_attributes?].each do |method|
-        assert { @user.respond_to?(method) }
+      [:enable_accessor_attributes_validation,
+        :disable_accessor_attributes_validation,
+        :validate_on_accessor_attributes?].each do |method|
+        subject.must_respond_to(method)
       end
     end
 
     it "does not define validation_accessor methods for unrequested validation_accessors" do
-      %w[unknown_attributes test2].each do |accessor_name|
-        [:"enable_#{accessor_name}_validation",
-          :"disable_#{accessor_name}_validation",
-          :"validate_on_#{accessor_name}?"].each do |method|
-          deny { @user.respond_to?(method) }
-        end
+      [:"enable_unknown_attributes_validation",
+        :"disable_unknown_attributes_validation",
+        :"validate_on_unknown_attributes?"].each do |method|
+        subject.wont_respond_to(method)
       end
     end
 
-    it "allows method chaining when using the getter/setter methods" do
-      assert { @user.enable_address_attributes_validation == @user }
-      assert { @user.disable_address_attributes_validation == @user }
-    end
+    describe "validation_accessor methods" do
+      it "allows method chaining" do
+        subject.enable_accessor_attributes_validation.must_equal subject
+        subject.disable_accessor_attributes_validation.must_equal subject
+      end
 
-    describe "conditional validation" do
       it "requests validation when enabled" do
-        deny { @user.validate_on_address_attributes? }
+        refute subject.validate_on_accessor_attributes?
 
-        @user.enable_address_attributes_validation
-        assert { @user.validate_on_address_attributes? }
+        subject.enable_accessor_attributes_validation
+        assert subject.validate_on_accessor_attributes?
       end
 
-      it "does not request validation when disabled again" do
-        @user.enable_address_attributes_validation
-        assert { @user.validate_on_address_attributes? }
+      it "does not request validation when disabled" do
+        subject.enable_accessor_attributes_validation
+        assert subject.validate_on_accessor_attributes?
 
-        @user.disable_address_attributes_validation
-        deny { @user.validate_on_address_attributes? }
+        subject.disable_accessor_attributes_validation
+        refute subject.validate_on_accessor_attributes?
       end
     end
   end

data/test/dummy/app/models/user.rb

@@ -1,9 +1,21 @@
 class User < ActiveRecord::Base
-  validation_accessor :address_attributes, :other_attributes
+  attr_accessor :flag_name
+
+  validation_flag :flag_attributes, :other_flag_attributes
 
   validates :name, presence: true
-  with_options if: :validate_on_address_attributes? do |user|
-    user.validates :address, presence: true
-    user.validates :city, presence: true
+
+  with_options if: :validate_on_flag_attributes? do |user|
+    user.validates :flag_name, presence: true
+  end
+
+
+  # DEPRECATED
+  attr_accessor :accessor_name
+
+  validation_accessor :accessor_attributes, :other_accessor_attributes
+
+  with_options if: :validate_on_accessor_attributes? do |user|
+    user.validates :accessor_name, presence: true
   end
 end

data/test/dummy/db/migrate/20131119215801_create_users.rb

@@ -2,8 +2,6 @@ class CreateUsers < ActiveRecord::Migration
   def change
     create_table :users do |t|
       t.string :name
-      t.string :address
-      t.string :city
 
       t.timestamps
     end

data/test/dummy/log/development.log

@@ -12,3 +12,6 @@ Migrating to CreateUsers (20131119215801)
    (0.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
    (0.1ms)  SELECT version FROM "schema_migrations"
    (0.7ms)  INSERT INTO "schema_migrations" (version) VALUES ('20131119215801')
+DEPRECATION WARNING: validation_accessor is deprecated and will be removed from Rails 4.1 (validation_accessor is deprecated in favor of validation_flag and will be removed in v1.0.0.). (called from <class:User> at /Users/pdobb/Code/conditional_validation/test/dummy/app/models/user.rb:11)
+  User Load (0.1ms)  SELECT "users".* FROM "users" ORDER BY "users"."id" ASC LIMIT 1
+  User Load (0.2ms)  SELECT "users".* FROM "users" ORDER BY "users"."id" ASC LIMIT 1

data/test/dummy/test/fixtures/users.yml

@@ -2,11 +2,7 @@
 # http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
 
 one:
-  name: MyString
-  address: MyString
-  city: MyString
+  name: User1
 
 two:
-  name: MyString
-  address: MyString
-  city: MyString
+  name: User2

data/test/test_helper.rb

@@ -1,19 +1,14 @@
-# Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require "rails/test_help"
 require "minitest/rails"
-require "minitest/ansi"
-require "wrong/adapters/minitest"
-
-MiniTest::ANSI.use!
-Wrong.config.color
 
 Rails.backtrace_cleaner.remove_silencers!
+ActiveSupport::Deprecation.silenced = true
 
 # Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir[Rails.root.join("test/support/**/*.rb")].each { |f| require f }
 
 # Load fixtures from the engine
 if ActiveSupport::TestCase.method_defined?(:fixture_path=)

metadata

@@ -1,100 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: conditional_validation
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Paul Dobbins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-26 00:00:00.000000000 Z
+date: 2014-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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-rails
   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-ansi
-  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: wrong
-  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: Validation Accessor allows controllers to communicate with models about
-  whether or not certain validations should be run.
+description: Conditional Validation allows validation flags to be enabled to determine
+  when certain validations should be run on a model.
 email:
 - pdobbins@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/conditional_validation/validation_accessor.rb
-- lib/conditional_validation/version.rb
-- lib/conditional_validation.rb
 - MIT-LICENSE
-- Rakefile
 - README.md
+- Rakefile
+- lib/conditional_validation.rb
+- lib/conditional_validation/validation_accessor.rb
+- lib/conditional_validation/validation_flag.rb
+- lib/conditional_validation/version.rb
 - test/conditional_validation_test.rb
+- test/dummy/README.rdoc
+- test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
@@ -104,6 +79,7 @@ files:
 - test/dummy/bin/bundle
 - test/dummy/bin/rails
 - test/dummy/bin/rake
+- test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
 - test/dummy/config/database.yml
@@ -120,7 +96,6 @@ files:
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
-- test/dummy/config.ru
 - test/dummy/db/development.sqlite3
 - test/dummy/db/migrate/20131119215801_create_users.rb
 - test/dummy/db/schema.rb
@@ -131,8 +106,6 @@ files:
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
 - test/dummy/test/fixtures/users.yml
 - test/dummy/test/models/user_test.rb
 - test/test_helper.rb
@@ -146,20 +119,20 @@ 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.1.11
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
-summary: Add conditional validation methods to a model.
+summary: Add conditional validation flags to a model.
 test_files:
 - test/conditional_validation_test.rb
 - test/dummy/app/assets/javascripts/application.js
@@ -203,3 +176,4 @@ test_files:
 - test/dummy/test/fixtures/users.yml
 - test/dummy/test/models/user_test.rb
 - test/test_helper.rb
+has_rdoc: