active_subset_validator 0.0.1 → 1.0.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v1.0.0
+
+* Production release
+* Some tests were refactored
+
 ## v0.0.1
 
 * Initial release
+

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in active_subset_validator.gemspec
 gemspec
+
+group :test do
+  gem 'coveralls', require: false
+end

data/README.md

@@ -1,6 +1,9 @@
 # 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)
+[![Gem Version](https://badge.fury.io/rb/active_subset_validator.png)](http://badge.fury.io/rb/active_subset_validator)
+[![Build Status](https://travis-ci.org/paulnsorensen/active_subset_validator.png)](https://travis-ci.org/paulnsorensen/active_subset_validator)
+[![Coverage Status](https://coveralls.io/repos/paulnsorensen/active_subset_validator/badge.png?branch=master)](https://coveralls.io/r/paulnsorensen/active_subset_validator?branch=master)
 
 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
@@ -22,9 +25,48 @@ Or install it yourself as:
 
 ## Usage
 
-    class Foo < ActiveRecord::Base
-      validates :bars, subset: { of: %w(some list of strings) }
+Add to your models like so:
+
+```ruby
+    class Article < ActiveRecord::Base
+      validates :categories, subset: { of: %w(foo bar baz ) }
+    end
+```
+The `:of` parameter may contain an `Array` or `Set` or a `Proc` or `lambda` that returns either type.
+
+The validator in this gem is a subclass `ActiveModel::EachValidator` so you should have all the nifty options to pass to the `validates` method as well.
+
+```ruby
+    class Comment < ActiveRecord::Base
+      attr_accessible :content, :tags,
+      validates :tags,
+        subset: { of: %w(some list of strings) },
+        if: ->(comment) { comment.some_method? },
+        allow_nil: false
+    end
+```
+
+## Testing
+
+You may write your tests similar to the following to ensure that the subset
+validator is working. Here's an example using [FactoryGirl](https://github.com/thoughtbot/factory_girl) and [RSpec](https://github.com/rspec/rspec):
+
+```ruby
+    it "ensures times_taken contains only values within the proper set" do
+     med = build(:medication)
+     med.times_taken = %w(as_needed breakfast lunch dinner bedtime)
+     med.should have(:no).errors_on(:times_taken)
+     med.times_taken << "midnight"
+     med.errors_on(:times_taken).should include("is not a subset of the list")
     end
+```
+
+Alternatively, if you use [shoulda-matchers](https://github.com/thoughtbot/shoulda-matchers), you could do this:
+
+```ruby
+    it { should allow_value(%w(good-val-0 good-val-1)).for(foo) }
+    it { should_not allow_value(%w(bad-val-0 bad-val-1)).for(:foo) }
+```
 
 ## Contributing
 

data/lib/active_subset_validator/version.rb

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

data/spec/active_subset_validator/subset_validator_spec.rb

@@ -68,8 +68,7 @@ describe SubsetValidator do
       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"
+      expect(comment.errors_on(:tags)).to include "is not a subset of the list"
     end
 
     it "adds an error for the invalid attribute when :of is a Set" do
@@ -77,8 +76,7 @@ describe SubsetValidator do
       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"
+      expect(comment.errors_on(:tags)).to include "is not a subset of the list"
     end
 
     it "adds an error for the invalid attribute when :of is an Array" do
@@ -86,8 +84,7 @@ describe SubsetValidator do
       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"
+      expect(comment.errors_on(:tags)).to include "is not a subset of the list"
     end
 
     it "adds a custom error message for an invalid attribute when passed" do
@@ -98,8 +95,7 @@ describe SubsetValidator do
       }
       comment = Comment.new
       comment.tags = %w(Chicago Boston)
-      comment.valid?
-      comment.errors[:tags].first.should eq "contains an out-of-range city"
+      expect(comment.errors_on(:tags)).to include "contains an out-of-range city"
     end
 
     it "correctly validates a serialized Set when :of is a Set" do
@@ -110,7 +106,7 @@ describe SubsetValidator do
       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
+      expect(comment).to have(:no).errors_on(:tags)
     end
   
     it "correctly validates a serialized Set when :of is a Proc" do
@@ -121,7 +117,7 @@ describe SubsetValidator do
       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
+      expect(comment).to have(:no).errors_on(:tags)
     end
 
     it "correctly validates a serialized Array when :of is a Array" do
@@ -129,7 +125,7 @@ describe SubsetValidator do
       Comment.validates :tags, subset: { of: %w(Atlanta Boston Chicago) }
       comment = Comment.new
       comment.tags = %w(Chicago Boston)
-      comment.valid?.should eq true
+      expect(comment).to have(:no).errors_on(:tags)
     end
   
     it "correctly validates a serialized Array when :of is a Proc" do
@@ -137,7 +133,7 @@ describe SubsetValidator do
       Comment.validates :tags, subset: { of: Proc.new { [1,3,9,27,81] } }
       comment = Comment.new
       comment.tags = [9,27]
-      comment.valid?.should eq true
+      expect(comment).to have(:no).errors_on(:tags)
     end
 
     it "allows nil if :allow_nil is true (default)" do
@@ -145,7 +141,7 @@ describe SubsetValidator do
       Comment.validates :tags, subset: { of: [1,3,9,27,81] }
       comment = Comment.new
       comment.tags = nil
-      comment.valid?.should eq true
+      expect(comment).to have(:no).errors_on(:tags)
     end
 
     it "doesn't allow nil if :allow_nil is false" do
@@ -153,8 +149,7 @@ describe SubsetValidator do
       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"
+      expect(comment.errors_on(:tags)).to include "cannot be nil"
     end    
   end
 end

data/spec/active_subset_validator_spec.rb

@@ -1,51 +1,51 @@
 require 'spec_helper'
 
 describe ActiveSubsetValidator do
-  describe "#is_a_set?" 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)
+      expect(ActiveSubsetValidator.is_a_set?((1..20).to_a)).to 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)
+      expect(ActiveSubsetValidator.is_a_set?(%w(foo foo bar baz))).to 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)
+      expect(ActiveSubsetValidator.is_a_set?(Set.new [1,2,4])).to 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)
+      expect(ActiveSubsetValidator.is_a_set?(Proc.new { %w(foo bar baz) })).to 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)
+      expect(ActiveSubsetValidator.is_a_set?(Proc.new { %w(foo foo bar baz) })).to 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)
+      expect(ActiveSubsetValidator.is_a_set?(Proc.new { Set.new [1,2,4] })).to 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)
+      expect(ActiveSubsetValidator.is_a_set?(Proc.new { |a| Set.new a }, [1,2,3])).to eq(true)
     end
   end
 
-  describe "#set_difference" do
+  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([])
+      expect(ActiveSubsetValidator.set_difference(%w(foo bar), %w(foo bar baz))).to 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([])
+      expect(ActiveSubsetValidator.set_difference([1.0, 2.4, 3.9], [2.4, 1.0, 3.9])).to 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))
+      expect(ActiveSubsetValidator.set_difference(%w(foo bar baz beans), %w(foo bar baz))).to 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))
+      expect(ActiveSubsetValidator.set_difference(%w(beans), %w(foo bar baz))).to eq(%w(beans))
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'active_subset_validator'
 require 'support/active_record'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_subset_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-14 00:00:00.000000000 Z
+date: 2013-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -145,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4092742916326351878
+      hash: 892968742125388242
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -154,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4092742916326351878
+      hash: 892968742125388242
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25