conditional_validation 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 85f47600c28259d876df108d8465339eb32dd021
-  data.tar.gz: 05fbb9cf2672e68ff8297b548dc78c4152084931
+SHA256:
+  metadata.gz: 30e3326be3141037e97c1cb5d73b2a0e1adc0d7726cf31abe88900243b51eeaa
+  data.tar.gz: c042b1ba75f2f3bade811bbbe8aead65ccbc87b176450771b3cbb240ff5a492b
 SHA512:
-  metadata.gz: 9f8f40b43dd9967e175a8780b37074ecf2b359368f8d2061945b98e8fa48d45124f1db0f12c4fc5b1cc045b6f92fbc6995b0f1722c348e561e497b7c336a81b2
-  data.tar.gz: 3486772d09179433722a3d53f6db3726ae0a86520c68348e2bb45ed8280c3e8fb5fbe3f8e77d207b169c6889a798a4c951c21b672fe60b2a3a86c7d393bb4443
+  metadata.gz: 238787bd9346e5806b96e9d9b6d31786ff7dd715e382236d8f5098c76766cb240459623fa056f1b68cce552493d0d4815328cba604ded3fd40ca78213665f5f9
+  data.tar.gz: a9c98d23238f3ef3275ecb0ac926e3ec64717cd9f13161de3d13903814145ffb392c5ce64e9350735c7fb94d6e03e3033219e456cb736e30b2cdd69b13dfd502

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+*.gem
+.DS_Store

data/.travis.yml

@@ -0,0 +1,21 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=ce4fc4d08e215d267d51d1add4379d2ee836127c64bbd1bc5bf48537fa9ea2ff
+sudo: false
+language: ruby
+rvm:
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+  - ruby-head
+notifications:
+  email: false
+before_install: gem install bundler -v 1.16.1
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### 1.0.0 - 2018-04-16
+- Remove the deprecated `validation_accessor` macro in favor of `validation_flag`.
+- Remove ActiveRecord monkey patch. Instead, use `extend ConditionalValidation::ValidationFlag` in ApplicationRecord.
+- Refresh gem. Remove Rails dependency.
+- Improve README.
+
+
+### 0.1.0
+
+- Deprecate `validation_accessor` macro in favor of `validation_flag`.
+- Documentation updates.

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 conditional_validation.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    conditional_validation (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    docile (1.3.0)
+    json (2.1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    minitest-reporters (1.2.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug (~> 10.0)
+  conditional_validation!
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.2)
+  pry (~> 0.11)
+  pry-byebug (~> 3.6)
+  rake (~> 10.0)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Paul Dobbins
+
+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

@@ -1,23 +1,13 @@
 # Conditional Validation
 
-[![Gem Version](https://badge.fury.io/rb/conditional_validation.png)](http://badge.fury.io/rb/conditional_validation)
+[![Gem Version](https://badge.fury.io/rb/conditional_validation.svg)](https://badge.fury.io/rb/conditional_validation)
+[![Build Status](https://travis-ci.org/pdobb/conditional_validation.svg?branch=master)](https://travis-ci.org/pdobb/conditional_validation)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a7cb8fa224f2390c6c99/test_coverage)](https://codeclimate.com/github/pdobb/conditional_validation/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a7cb8fa224f2390c6c99/maintainability)](https://codeclimate.com/github/pdobb/conditional_validation/maintainability)
 
-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.
+ConditionalValidation simplifies adding validation flags and then querying state to determine when associated validations should be run on models. While models tend to have a set of core validations that should always be run, some validations may be specific to a certain context.
 
-
-## Compatibility
-
-Tested with:
-
-* Ruby: MRI 1.9.3
-* Ruby: MRI 2.0.0 +
-* Rails: 3+
-* Rails: 4+
+The typical use-case for ConditionalValidation is to flag a model's non-core validations to run from specific controller actions, while they default to not run from all others.
 
 
 ## Installation
@@ -25,34 +15,85 @@ Tested with:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'conditional_validation'
+gem "conditional_validation"
 ```
 
 And then execute:
 
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install conditional_validation
+
+
+## Upgrading from v0.1.0
+
+### Monkey Patching Eliminated
+
+v0.1.0 automatically added ConditionalValidation::ValidationFlag to ActiveRecord::Base. Since monkey patching was never a good idea, ConditionalValidation should now be added to Models manually.
+
+```ruby
+# app/models/my_model.rb
+class MyModel
+  extend ConditionalValidation::ValidationFlag
+
+  validation_flag :test_attributes
+end
+
+my_model = MyModel.new
+
+my_model.enable_test_attributes_validation
+# => #<MyModel:0x007fd76bbecb80 @_test_attributes_validation_flag=true>
+
+my_model.validate_on_test_attributes?
+# => true
+```
+
+Or, to use ConditionalValidation globally in a Rails app, call extend ConditionalValidation::ValidationFlag within ApplicationRecord.
+
 ```ruby
-bundle
+# app/models/application_record.rb
+class ApplicationRecord < ActiveRecord::Base
+  extend ConditionalValidation::ValidationFlag
+end
 ```
 
 
+### `validation_accessor` Macro Removed
+
+Additionally, the old ConditionalValidation::ValidationAccessor module and its `validation_accessor` macro are gone. To fix: Search and replace `validation_accessor` with `validation_flag`.
+
+
+## Compatibility
+
+Tested MRI Ruby Versions:
+* 2.2.10
+* 2.3.7
+* 2.4.4
+* 2.5.1
+* edge
+
+VersionCompare has no other dependencies.
+
+
 ## Usage
 
 First, define a validation flag:
 
 ```ruby
-# app/models/some_model.rb
-class SomeModel
+# app/models/my_model.rb
+class MyModel
   validation_flag :<flag_name>
 end
 ```
 
-Then, the following methods will be defined on SomeModel for conditional
-validation:
+The `validation_flag` macro will define the following instance methods on MyModel for conditional validation:
 
 ```ruby
-enable_<flag_name>_validation # Enables conditional validation
-disable_<flag_name>_validation # Disables conditional validation
-validate_on_<flag_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 or not
 ```
 
 
@@ -60,41 +101,60 @@ validate_on_<flag_name>? # Check if conditional validation is enabled
 
 ```ruby
 # app/models/user.rb
-User < ActiveRecord::Base
+class User < ApplicationRecord
   # Initialize conditional validation on address attributes
   validation_flag :address_attributes
 
-  with_options if: :validate_on_address_attributes? do |obj|
-    obj.validates :street, presence: true
-    obj.validates :city, presence: true
+  with_options if: :validate_on_address_attributes? do |o|
+    o.validates :street, presence: true
+    o.validates :city, presence: true
     # ...
   end
 end
 
 # app/controllers/user_controller.rb
-def update
-  # Enable conditional validation on address attributes
-  current_user.enable_address_attributes_validation
-  if current_user.save
-    # Not typically needed, but disables conditional validation on address attributes
-    current_user.disable_address_attributes_validation
-    # ...
+class UsersController < ApplicationController
+  def update
+    # Enable conditional validation on address attributes
+    current_user.enable_address_attributes_validation
+
+    if current_user.save
+      # Not typically needed, but disables conditional validation on address attributes
+      current_user.disable_address_attributes_validation
+
+      # ...
+    end
   end
 end
 ```
 
+
 ### Method Chaining
 
-The enable and disable methods allow for method chaining so that multiple
-validation flags may be enabled/disabled at once:
+The `enable_<flag_name>_validation` and `disable_<flag_name>_validation` methods allow for method chaining so that multiple validation flags may be enabled/disabled at once:
 
 ```ruby
-if current_user.enable_address_attributes_validation.enable_some_other_validation.save
+if current_user.
+     enable_address_attributes_validation.
+     enable_some_other_validation.
+     save
   # ...
 end
 ```
 
 
-## Author
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/pdobb/conditional_validation.
+
+
+## License
 
-- Paul Dobbins
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,32 +1,10 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ConditionalValidation'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
+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
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-
-task default: :test
+task :default => :test

data/bin/console

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

@@ -0,0 +1,40 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "conditional_validation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "conditional_validation"
+  spec.version       = ConditionalValidation::VERSION
+  spec.authors       = ["Paul Dobbins"]
+  spec.email         = ["paul.dobbins@icloud.com"]
+
+  spec.summary       = %q{ConditionalValidation simplifies adding validation flags to models.}
+  spec.description   = %q{ConditionalValidation simplifies adding validation flags and then querying state to determine when associated validations should be run on models.}
+  spec.homepage      = "https://github.com/pdobb/conditional_validation"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.2"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+  spec.add_development_dependency "byebug", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "pry-byebug", "~> 3.6"
+end