conditional_validation 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f8439c1243d6b4e770578bbe617ae84198b357e
-  data.tar.gz: 354132d0055c66be64b37e1b9795c45006341951
+  metadata.gz: 90cffc4ad349929eec7e85fe75148d41c88d1ca1
+  data.tar.gz: 1ab36808cdd42d52e10322d6d4bc30756d730556
 SHA512:
-  metadata.gz: f7472d107e930e460cbf41cc915b1e29ff783c889538872cd29b38c21dfbd6a3ceb8a525be0192eb5fee1dc78a4346fcc06295c68832dab3cd9508729a4ccb6f
-  data.tar.gz: aee3f61319d87dc3b3db636d95da59f0a036673152dce706dff52b82031438631966a4ee3a952c6010533542c4c08f666226ab8f7d160beec00700123850716e
+  metadata.gz: e94799edf5f451c998a291478ba7e407f285aaf4ad256e8c1b82ff19943c5807465f21fa34a4cb3187e06a7b6793904eae8b5a529a5ae5add6c840a4ee44d9e2
+  data.tar.gz: 10167ba772717e646d678c8294dc3e0d3776b32d769af5408170c81363fdfc275036b5cb6ccddea6c2c48f7d030ed5cc18fc407f5f5a987c98265114c6d01c76

data/README.md

@@ -0,0 +1,86 @@
+# Conditional Validation
+
+[![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.
+
+## Compatibility
+
+Tested with:
+
+* Ruby: MRI 2.0.0
+* Rails: 4.0.1
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "conditional_validation"
+```
+
+And then execute:
+
+```ruby
+bundle
+```
+
+## Usage
+
+First, define a validation accessor:
+
+```ruby
+# app/models/some_model.rb
+class SomeModel
+  validation_accessor :some_grouping_name
+end
+```
+
+Then, this model will receive the following methods 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
+```
+
+<b>A "Real World" Example</b>
+
+```ruby
+# app/models/user.rb
+User < ActiveRecord::Base
+  validation_accessor :address_attributes # Initialize conditional validation on address attributes
+
+  with_options if: :validate_on_address_attributes? do |obj|
+    obj.validates :street, presence: true
+    obj.validates :city, presence: true
+    # ...
+  end
+end
+
+# app/controllers/user_controller.rb
+def update
+  current_user.enable_address_attributes_validation # Enable conditional validation on address attributes
+  if current_user.save
+    current_user.disable_address_attributes_validation # Not necessarily needed, but disables conditional validation on address attributes
+    # ...
+  end
+end
+```
+
+<b>Method Chaining</b>
+
+The enable and disable methods allow for method chaining so that multiple
+validation accessors may be enabled/disabled at once:
+
+```ruby
+if current_user.enable_address_attributes_validation.enable_some_other_validation.save
+  # ...
+end
+```
+
+## Author
+
+- Paul Dobbins

data/lib/conditional_validation/version.rb

@@ -1,3 +1,3 @@
 module ConditionalValidation
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: conditional_validation
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Paul Dobbins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-20 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +93,7 @@ files:
 - lib/conditional_validation.rb
 - MIT-LICENSE
 - Rakefile
+- README.md
 - test/conditional_validation_test.rb
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
@@ -136,7 +137,8 @@ files:
 - test/dummy/test/models/user_test.rb
 - test/test_helper.rb
 homepage: https://github.com/pdobb/conditional_validation
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -154,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Add conditional validation methods to a model.