subset_validator 0.3.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem 'activemodel', '~> 3.0.3', :require => 'active_model'
+
+group :development do
+  gem "rspec",    "~> 2.1.0"
+  gem "bundler",  "~> 1.0.0"
+  gem "jeweler",  "~> 1.5.1"
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.3)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    i18n (0.4.2)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (~> 3.0.3)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rspec (~> 2.1.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Nick Hoffman
+
+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.rdoc

@@ -0,0 +1,80 @@
+= subset_validator
+
+
+== Description
+
+An ActiveModel validation for checking if an attribute's values are a subset of another set.
+
+In other words, check that an array is a subset of another array, a hash is a subset of another hash, etc.
+
+
+== Usage Example
+
+Say you have a User model, and each user can multiple roles, like this:
+    class User
+      attr_accessor :roles
+
+      @@valid_roles = %w(admin manager developer)
+
+      def initialize(roles)
+        raise ArgumentError, 'The roles must be an array.' unless roles.is_a? Array
+
+        @roles = roles
+      end
+    end
+You probably want your model to prevent arbitrary roles from being assigned. Eg:
+    the_boss = User.new %w(bonehead)
+One solution is to write a custom setter method that checks if each element of the _roles_ array is contained in <i>@@valid_roles</i> . That's a pain in the ass, especially if you need to do it more than once.
+
+Enter SubsetValidator:
+    require 'subset_validator'
+
+    class User
+      include ActiveModel::Validations
+
+      attr_accessor :roles
+
+      @@valid_roles = %w(admin manager developer)
+
+      validates :roles, :subset => {:in => @@valid_roles}
+
+      def initialize(roles)
+        raise ArgumentError, 'The roles must be an array.' unless roles.is_a? Array
+
+        @roles = roles
+      end
+    end
+That one validation takes care of it all for you:
+    the_boss = User.new %w(bonehead)
+     => #<User:0x9980a04 @roles=["bonehead"]>
+
+    the_boss.valid?
+     => false
+    the_boss.errors
+     => {:roles=>["contains an invalid value"]}
+
+    the_boss.roles = %w(manager)
+     => ["manager"]
+    the_boss.valid?
+     => true
+
+
+SubsetValidator works on more than just arrays, too. In fact, it'll work on anything, provided that:
+* the attribute's value can be anything that responds to <i>#each</i> ;
+* the set of valid values can be anything that responds to <i>#include?</i> .
+
+
+== Contributing to subset_validator
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add RSpec specs for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate that to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Nick Hoffman. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name        = "subset_validator"
+  gem.homepage    = "http://github.com/nickhoffman/subset_validator"
+  gem.license     = "MIT"
+  gem.summary     = %Q{An ActiveModel validation for checking if an attribute's values are a subset of another set.}
+  gem.description = %Q{An ActiveModel validation for checking if an attribute's values are a subset of another set.}
+  gem.email       = "nick@deadorange.com"
+  gem.authors     = ["Nick Hoffman"]
+
+  gem.add_dependency  'activemodel', '~> 3.0.3'
+
+  gem.add_development_dependency "rspec",    "~> 2.1.0"
+  gem.add_development_dependency "bundler",  "~> 1.0.0"
+  gem.add_development_dependency "jeweler",  "~> 1.5.1"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "subset_validator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/subset_validator.rb

@@ -0,0 +1,22 @@
+class SubsetValidator < ActiveModel::EachValidator
+  @@error_message = 'contains an invalid value'
+
+  def validate_each(record, attribute, value)
+    unless options[:in].respond_to? :include?
+      raise ArgumentError, 'An object with the method include? must be supplied as the :in option of the configuration hash'
+    end
+
+    unless value.respond_to? :each
+      raise ArgumentError, 'The attribute being validated must respond to #each'
+    end
+
+    error_message = options[:message] || @@error_message
+
+    value.each do |element|
+      unless options[:in].include? element
+        record.errors.add attribute, error_message
+        break
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_model'
+require 'subset_validator'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/subset_validator_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class UserTest
+  include ActiveModel::Validations
+
+  @@valid_values = %w(echidna wombat tuatara)
+
+  attr_accessor :missing_in
+  validates     :missing_in, :allow_blank => true, :subset => true
+
+  attr_accessor :doesnt_respond_to_each
+  validates     :doesnt_respond_to_each,  :allow_blank => true, :subset => {:in => @@valid_values}
+
+  attr_accessor :contains_invalid_value
+  validates     :contains_invalid_value,
+    :allow_blank  => true,
+    :subset       => {:in => @@valid_values}
+
+  attr_accessor :custom_error_message
+  validates     :custom_error_message,
+    :allow_blank  => true,
+    :subset       => {:in => @@valid_values, :message => 'a custom error message'}
+
+  def initialize(params = {})
+    params.each {|k, v| send "#{k}=", v}
+  end
+end
+
+describe SubsetValidator do
+  it 'inherits from ActiveModel::EachValidator' do
+    SubsetValidator.superclass.should equal ActiveModel::EachValidator
+  end
+
+  describe 'class variables' do
+    it 'has @@error_message' do
+      SubsetValidator.class_variables.should include :@@error_message
+    end
+  end
+
+  describe '#validate_each' do
+    describe "when the configuration hash's :in element is invalid" do
+      it 'raises an error' do
+        expect {UserTest.new(:missing_in => 'fails').valid?}.to raise_error(
+          ArgumentError,
+          'An object with the method include? must be supplied as the :in option of the configuration hash'
+        )
+      end
+    end
+
+    describe "when the attribute doesn't respond to #each" do
+      it 'raises an error' do
+        expect {UserTest.new(:doesnt_respond_to_each => 'fails').valid?}.to raise_error(
+          ArgumentError,
+          'The attribute being validated must respond to #each'
+        )
+      end
+    end
+
+    describe 'when the attribute contains an invalid value' do
+      it 'adds an error on the attribute' do
+        u = UserTest.new :contains_invalid_value => %w(asdf)
+        u.valid?
+
+        u.errors[:contains_invalid_value].count.should equal 1
+        u.errors[:contains_invalid_value].first.should == 'contains an invalid value'
+      end
+
+      describe 'when a custom error message is given' do
+        it 'uses the custom error message' do
+          u = UserTest.new :custom_error_message => %w(foobar)
+          u.valid?
+
+          u.errors[:custom_error_message].first.should == 'a custom error message'
+        end
+      end
+    end
+  end
+end

data/subset_validator.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{subset_validator}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nick Hoffman"]
+  s.date = %q{2010-11-22}
+  s.description = %q{An ActiveModel validation for checking if an attribute's values are a subset of another set.}
+  s.email = %q{nick@deadorange.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/subset_validator.rb",
+    "spec/spec_helper.rb",
+    "spec/subset_validator_spec.rb",
+    "subset_validator.gemspec"
+  ]
+  s.homepage = %q{http://github.com/nickhoffman/subset_validator}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{An ActiveModel validation for checking if an attribute's values are a subset of another set.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+    "spec/subset_validator_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activemodel>, ["~> 3.0.3"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_runtime_dependency(%q<activemodel>, ["~> 3.0.3"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+    else
+      s.add_dependency(%q<activemodel>, ["~> 3.0.3"])
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<activemodel>, ["~> 3.0.3"])
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    end
+  else
+    s.add_dependency(%q<activemodel>, ["~> 3.0.3"])
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<activemodel>, ["~> 3.0.3"])
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+  end
+end
+

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification 
+name: subset_validator
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Nick Hoffman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-22 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+description: An ActiveModel validation for checking if an attribute's values are a subset of another set.
+email: nick@deadorange.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/subset_validator.rb
+- spec/spec_helper.rb
+- spec/subset_validator_spec.rb
+- subset_validator.gemspec
+has_rdoc: true
+homepage: http://github.com/nickhoffman/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 
+      hash: -489382847
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An ActiveModel validation for checking if an attribute's values are a subset of another set.
+test_files: 
+- spec/spec_helper.rb
+- spec/subset_validator_spec.rb