active_subset_validator 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul Sorensen
+
+MIT License
+
+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,35 @@
+# ActiveSubsetValidator
+[![Code Climate](https://codeclimate.com/github/paulnsorensen/active_subset_validator.png)](https://codeclimate.com/github/paulnsorensen/active_subset_validator)
+[![Dependency Status](https://gemnasium.com/paulnsorensen/active_subset_validator.png)](https://gemnasium.com/paulnsorensen/active_subset_validator)
+
+Provides subset validation for serialized arrays or sets in Active Record.
+Checks whether given values for a serialized array or set are a subset of
+a given array, set or proc against which to validate.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_subset_validator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_subset_validator
+
+## Usage
+
+    class Foo < ActiveRecord::Base
+      validates :bars, subset: { of: %w(some list of strings) }
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/active_subset_validator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_subset_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_subset_validator"
+  spec.version       = ActiveSubsetValidator::VERSION
+  spec.authors       = ["Paul Sorensen"]
+  spec.email         = ["paulnsorensen@gmail.com"]
+  spec.description   = %q{Provides subset validation for serialized arrays or sets in Active Record}
+  spec.summary       = %q{Checks whether given values for a serialized array or set are a subset of a given array, set or proc against which to validate}
+  spec.homepage      = "https://github.com/paulnsorensen/active_subset_validator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
+  spec.add_runtime_dependency 'activemodel', '>= 3'
+end

data/lib/active_subset_validator/railtie.rb

@@ -0,0 +1,9 @@
+module ActiveSubsetValidator
+  class Railtie < Rails::Railtie
+    initializer 'active_subset_validator' do
+      ActiveSupport.on_load :active_record do
+        include ActiveSubsetValidator
+      end
+    end
+  end
+end

data/lib/active_subset_validator/subset_validator.rb

@@ -0,0 +1,40 @@
+class SubsetValidator < ActiveModel::EachValidator
+   ERROR_MESSAGE = "An argument must be supplied for the :of option " <<
+   "of the configuration hash and must evaluate to an array or a set"
+
+  def check_validity!
+    if options[:of].respond_to?(:call)
+      return
+    elsif options[:of].is_a?(Array) || options[:of].is_a?(Set)
+      unless ActiveSubsetValidator.is_a_set? options[:of]
+        raise ArgumentError, ERROR_MESSAGE
+      end
+    else
+      raise ArgumentError, ERROR_MESSAGE
+    end
+  end
+
+  def validate_each(record, attribute, value)
+    message = options[:message] ? options[:message] : "is not a subset of the list"
+    allow_nil = options[:allow_nil] === false ? false : true
+
+    if options[:of].respond_to?(:call)
+      superset = options[:of].call(record)
+      unless ActiveSubsetValidator.is_a_set? superset
+        raise ArgumentError, ERROR_MESSAGE
+      end
+    else
+      superset = options[:of]
+    end
+    
+    if value.nil?
+      unless allow_nil
+        record.errors[attribute] << "cannot be nil"
+      end
+    else
+      unless ActiveSubsetValidator.set_difference(value, superset).empty?
+        record.errors[attribute] << message
+      end
+    end
+  end
+end

data/lib/active_subset_validator/version.rb

@@ -0,0 +1,3 @@
+module ActiveSubsetValidator
+  VERSION = "0.0.1"
+end

data/lib/active_subset_validator.rb

@@ -0,0 +1,32 @@
+require 'active_model'
+require "active_subset_validator/version"
+require "active_subset_validator/subset_validator"
+require "active_subset_validator/railtie" if defined? Rails
+
+module ActiveSubsetValidator
+  SET_DIFF_ERROR = "Arguments much match types upon evaluation. " <<
+              "Expects Array or Set."
+
+  def self.is_a_set? obj, *args
+    if obj.respond_to?(:call)
+      obj = obj.call *args
+    end
+    if obj.is_a?(Set)
+      return true
+    elsif obj.is_a?(Array)
+      return obj.to_set.to_a == obj
+    else
+      return false
+    end
+  end
+
+  def self.set_difference obj1, obj2
+    if obj1.is_a?(Array) && obj2.is_a?(Array)
+      (obj1.to_set - obj2.to_set).to_a
+    elsif obj1.is_a?(Set) && obj2.is_a?(Set)
+      obj1 - obj2
+    else
+      raise ArgumentError, SET_DIFF_ERROR
+    end
+  end
+end

data/spec/active_subset_validator/subset_validator_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+class Comment < ActiveRecord::Base
+end
+
+describe SubsetValidator do
+  it "inherits from ActiveModel::EachValidator" do
+    SubsetValidator.superclass.should equal ActiveModel::EachValidator
+  end
+
+  describe "#check_validity!" do
+    before(:each) do
+      Comment.send(:serialize, :tags, Array)
+      Comment.reset_callbacks(:validate)
+    end
+    
+    it "fails on an invalid array" do
+      expect {
+        Comment.validates :tags, subset: { of: %w(foo bar baz baz) }
+      }.to raise_error ArgumentError
+    end
+    it "fails on an invalid argument" do
+      expect {
+        Comment.validates :tags, subset: { of: Hash.new }
+      }.to raise_error ArgumentError
+    end
+    it "does not fail when passed a lambda" do
+      expect {
+        Comment.validates :tags, subset: { of: lambda { |a| Set.new a } }
+      }.not_to raise_error
+    end
+  end
+
+  describe "#validate_each" do
+    before(:each) do
+      Comment.reset_callbacks(:validate)
+    end
+
+    it "raises an error when the attribute is Array and :of type is Set" do
+      Comment.send(:serialize, :tags, Array)
+      Comment.validates :tags, subset: { of: Set.new([1,2,3]) }
+      comment = Comment.new
+      comment.tags = %w(python java)
+      expect { comment.valid? }.to raise_error ArgumentError
+    end
+
+    it "raises an error when the attribute is Set and :of type is Array" do
+      Comment.send(:serialize, :tags, Set)
+      Comment.validates :tags, subset: { of: %w(tee hee) }
+      comment = Comment.new
+      comment.tags = Set.new %w(python java)      
+      expect { comment.valid? }.to raise_error ArgumentError
+    end
+
+    it "raises an error when proc evaluates to an incorrect type" do
+      Comment.send(:serialize, :tags, Set)
+      Comment.validates :tags, subset: { of: Proc.new { |r| r.class.to_s } }
+      comment = Comment.new
+      comment.tags = Set.new %w(python java)
+      expect { comment.valid? }.to raise_error ArgumentError
+    end
+
+    it "adds an error for the invalid attribute when :of is a Proc" do
+      Comment.send(:serialize, :tags, Set)
+      Comment.send(:define_method, 'valid_set') do
+        Set.new %w(ruby python scala)
+      end
+      Comment.validates :tags, subset: { of: Proc.new { |r| r.valid_set } }
+      comment = Comment.new
+      comment.tags = Set.new %w(python java)
+      comment.valid?
+      comment.errors[:tags].first.should eq "is not a subset of the list"
+    end
+
+    it "adds an error for the invalid attribute when :of is a Set" do
+      Comment.send(:serialize, :tags, Set)
+      Comment.validates :tags, subset: { of: Set.new([1,2,3,5]) }
+      comment = Comment.new
+      comment.tags = Set.new [2,4]
+      comment.valid?
+      comment.errors[:tags].first.should eq "is not a subset of the list"
+    end
+
+    it "adds an error for the invalid attribute when :of is an Array" do
+      Comment.send(:serialize, :tags, Array)
+      Comment.validates :tags, subset: { of: %w(Atlanta Cleveland Chicago) }
+      comment = Comment.new
+      comment.tags = %w(Chicago Boston)
+      comment.valid?
+      comment.errors[:tags].first.should eq "is not a subset of the list"
+    end
+
+    it "adds a custom error message for an invalid attribute when passed" do
+      Comment.send(:serialize, :tags, Array)
+      Comment.validates :tags, subset: { 
+        of: %w(Atlanta Cleveland Chicago), 
+        message: "contains an out-of-range city"
+      }
+      comment = Comment.new
+      comment.tags = %w(Chicago Boston)
+      comment.valid?
+      comment.errors[:tags].first.should eq "contains an out-of-range city"
+    end
+
+    it "correctly validates a serialized Set when :of is a Set" do
+      Comment.send(:serialize, :tags, Set)
+      Comment.send(:define_method, 'valid_set') do
+        Set.new %w(ruby python scala)
+      end
+      Comment.validates :tags, subset: { of: Set.new(%w(java scala python)) }
+      comment = Comment.new
+      comment.tags = Set.new %w(python java)
+      comment.valid?.should eq true
+    end
+  
+    it "correctly validates a serialized Set when :of is a Proc" do
+      Comment.send(:serialize, :tags, Set)
+      Comment.send(:define_method, 'valid_set') do
+        Set.new %w(ruby python scala)
+      end
+      Comment.validates :tags, subset: { of: Proc.new { |r| r.valid_set } }
+      comment = Comment.new
+      comment.tags = Set.new %w(python ruby)
+      comment.valid?.should eq true
+    end
+
+    it "correctly validates a serialized Array when :of is a Array" do
+      Comment.send(:serialize, :tags, Array)
+      Comment.validates :tags, subset: { of: %w(Atlanta Boston Chicago) }
+      comment = Comment.new
+      comment.tags = %w(Chicago Boston)
+      comment.valid?.should eq true
+    end
+  
+    it "correctly validates a serialized Array when :of is a Proc" do
+      Comment.send(:serialize, :tags, Array)
+      Comment.validates :tags, subset: { of: Proc.new { [1,3,9,27,81] } }
+      comment = Comment.new
+      comment.tags = [9,27]
+      comment.valid?.should eq true
+    end
+
+    it "allows nil if :allow_nil is true (default)" do
+      Comment.send(:serialize, :tags, Array)
+      Comment.validates :tags, subset: { of: [1,3,9,27,81] }
+      comment = Comment.new
+      comment.tags = nil
+      comment.valid?.should eq true
+    end
+
+    it "doesn't allow nil if :allow_nil is false" do
+      Comment.send(:serialize, :tags, Array)
+      Comment.validates :tags, subset: { of: [1,3,9,27,81], allow_nil: false }
+      comment = Comment.new
+      comment.tags = nil
+      comment.valid?
+      comment.errors[:tags].first.should eq "cannot be nil"
+    end    
+  end
+end

data/spec/active_subset_validator_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe ActiveSubsetValidator do
+  describe "#is_a_set?" do
+    it "returns true if an array is a set" do
+      ActiveSubsetValidator.is_a_set?((1..20).to_a).should eq(true)
+    end
+
+    it "returns false if an array has duplicate values" do
+      ActiveSubsetValidator.is_a_set?(%w(foo foo bar baz)).should eq(false)
+    end
+
+    it "returns true if a Set is a set" do
+      ActiveSubsetValidator.is_a_set?(Set.new [1,2,4]).should eq(true)
+    end
+
+    it "returns true if a proc that is passed returns a proper array" do
+      ActiveSubsetValidator.is_a_set?(Proc.new { %w(foo bar baz) }).should eq(true)
+    end
+
+    it "returns false if a proc that is passed returns an improper array" do
+      ActiveSubsetValidator.is_a_set?(Proc.new { %w(foo foo bar baz) }).should eq(false)
+    end
+
+    it "returns true if a proc that is passed returns a set" do
+      ActiveSubsetValidator.is_a_set?(Proc.new { Set.new [1,2,4] }).should eq(true)
+    end
+
+    it "returns true for valid procs with arguments" do
+      ActiveSubsetValidator.is_a_set?(Proc.new { |a| Set.new a }, [1,2,3]).should eq(true)
+    end
+  end
+
+  describe "#set_difference" do
+    it "returns [] if the first array is a subset of the second array" do
+      ActiveSubsetValidator.set_difference(%w(foo bar), %w(foo bar baz)).should eq([])
+    end
+
+    it "returns [] if the first and second arrays have the same values" do
+      ActiveSubsetValidator.set_difference([1.0, 2.4, 3.9], [2.4, 1.0, 3.9]).should eq([])
+    end
+
+    it "returns the set difference when the first array has more values" do
+      ActiveSubsetValidator.set_difference(%w(foo bar baz beans), %w(foo bar baz)).should eq(%w(beans))
+    end
+
+    it "returns the set difference when the first array is outside the set of the second" do
+      ActiveSubsetValidator.set_difference(%w(beans), %w(foo bar baz)).should eq(%w(beans))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'active_subset_validator'
+require 'support/active_record'
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end

data/spec/support/active_record.rb

@@ -0,0 +1,29 @@
+require 'active_record'
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+module ActiveModel::Validations
+  # Extension to enhance `should have` on AR Model instances.  Calls
+  # model.valid? in order to prepare the object's errors object.
+  #
+  # You can also use this to specify the content of the error messages.
+  #
+  # @example
+  #
+  #     model.should have(:no).errors_on(:attribute)
+  #     model.should have(1).error_on(:attribute)
+  #     model.should have(n).errors_on(:attribute)
+  #
+  #     model.errors_on(:attribute).should include("can't be blank")
+  def errors_on(attribute)
+    self.valid?
+    [self.errors[attribute]].flatten.compact
+  end
+  alias :error_on :errors_on
+end
+
+# test model we'll use in each spec
+ActiveRecord::Migration.create_table :comments do |t|
+  t.string :text
+  t.text :tags
+  t.timestamps
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: active_subset_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul Sorensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Provides subset validation for serialized arrays or sets in Active Record
+email:
+- paulnsorensen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_subset_validator.gemspec
+- lib/active_subset_validator.rb
+- lib/active_subset_validator/railtie.rb
+- lib/active_subset_validator/subset_validator.rb
+- lib/active_subset_validator/version.rb
+- spec/active_subset_validator/subset_validator_spec.rb
+- spec/active_subset_validator_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+homepage: https://github.com/paulnsorensen/active_subset_validator
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4092742916326351878
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4092742916326351878
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Checks whether given values for a serialized array or set are a subset of
+  a given array, set or proc against which to validate
+test_files:
+- spec/active_subset_validator/subset_validator_spec.rb
+- spec/active_subset_validator_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb