couchrest-uniqueness-validation 0.0.1 → 0.1.0

data/README.rdoc

@@ -1,16 +1,23 @@
-= couchrest-uniqueness-validation
+= Couchrest Uniqueness Validation
+
+This is a simple add-on to {couchrest}[http://github.com/couchrest/couchrest] gem
 
 Validates that the specified attribute is unique across documents with the same 
 couchrest-type using a view.
 
-@note
-  You have to define a design doc view.
-@see http://rdoc.info/rdoc/couchrest/couchrest/blob/1b34fe4b60694683e98866a51c2109c1885f7e42/CouchRest/Mixins/Views/ClassMethods.html#view_by-instance_method for more details about views.
-
-@example [Usage]
+== Install
 
-  class User
+  gem install couchrest-uniqueness-validation
   
+== Usage
+
+  require 'rubygems'
+  require 'couchrest'
+  require 'couchrest-uniqueness-validation'
+
+  class User < CouchRest::ExtendedDocument
+    include CouchRest::Validation
+    
     property :nickname
     property :login
 
@@ -26,9 +33,16 @@ couchrest-type using a view.
     # the same couchrest-type, nickname and login
   end
 
+Note: at least two views should exist in the User design doc for this example to work - 
+:by_nickname and :my_custom_view.
+
+See {CouchRest Views docs}[http://rdoc.info/rdoc/couchrest/couchrest/blob/1b34fe4b60694683e98866a51c2109c1885f7e42/CouchRest/Mixins/Views/ClassMethods.html#view_by-instance_method] 
+for more info on views.
+  
+
 == Note on Patches/Pull Requests
  
-* Fork the project.
+* Fork the {project}[http://github.com/crhym3/couchrest-uniqueness-validation].
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.

data/Rakefile

@@ -23,12 +23,22 @@ require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', "\"spec/spec.opts\""]
+end
+
+namespace :spec do
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
 end
 
 Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
+  spec.rcov_opts = ['--exclude "spec/*,gems/*"']
 end
 
 task :spec => :check_dependencies

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/couchrest-uniqueness-validation.rb

@@ -6,7 +6,7 @@ module CouchRest
       def initialize(field_name, options = {})
         super
         @field_name, @options = field_name, options
-        @options[:view] ||= "by_#{@field_name}".to_sym
+        @options[:view] ||= "by_#{@field_name}"
       end
       
       def call(target)
@@ -21,7 +21,7 @@ module CouchRest
       
       def unique?(target)
         value = target.validation_property_value(@field_name)
-        existing_docs = target.class.view(@options[:view], :key => value, :limit => 1, :include_docs => false)
+        existing_docs = target.class.view(@options[:view].to_sym, :key => value, :limit => 1, :include_docs => false)['rows']
         
         # normal case when target.new_document? == true and
         # no other document exists
@@ -40,13 +40,13 @@ module CouchRest
       # Validates that the specified attribute is unique across documents with the same 
       # couchrest-type using a view.
       #
-      # @note
-      #   You have to define a design doc view.
-      # @see http://rdoc.info/rdoc/couchrest/couchrest/blob/1b34fe4b60694683e98866a51c2109c1885f7e42/CouchRest/Mixins/Views/ClassMethods.html#view_by-instance_method for more details about views.
+      # == Example
       #
-      # @example [Usage]
-      # 
-      #   class User
+      #   require 'rubygems'
+      #   require 'couchrest'
+      #   require 'couchrest-uniqueness-validation' 
+      #
+      #   class User < CouchRest::ExtendedDocument
       #   
       #     property :nickname
       #     property :login
@@ -62,6 +62,12 @@ module CouchRest
       #     # a call to valid? will return false unless no other document exists with
       #     # the same couchrest-type, nickname and login
       #   end
+      #
+      # Note: at least two views should exist in the User design doc for this example to work - 
+      # :by_nickname and :my_custom_view.
+      # 
+      # See {CouchRest Views docs}[http://rdoc.info/rdoc/couchrest/couchrest/blob/1b34fe4b60694683e98866a51c2109c1885f7e42/CouchRest/Mixins/Views/ClassMethods.html#view_by-instance_method] 
+      # for more info on views
       def validates_uniqueness_of(*fields)
         opts = opts_from_validator_args(fields)
         add_validator_to_context(opts, fields, CouchRest::Validation::UniquenessValidator)

data/spec/couchrest-uniqueness-validation_spec.rb

@@ -2,12 +2,73 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe CouchRest::Validation::ValidatesUniqueness do
   
-  class SomeExtDoc < CouchRest::ExtendedDocument
+  class SomeDoc < CouchRest::ExtendedDocument
     include CouchRest::Validation
     use_database SPEC_COUCH
   end
   
   it "should provide validates_uniqueness_of method" do
-    SomeExtDoc.should respond_to :validates_uniqueness_of
+    SomeDoc.should respond_to :validates_uniqueness_of
   end
 end
+
+describe CouchRest::Validation::UniquenessValidator do
+  
+  class SomeUniqueDoc < CouchRest::ExtendedDocument
+    include CouchRest::Validation
+    use_database SPEC_COUCH
+    
+    property :unique_prop    
+    validates_uniqueness_of :unique_prop
+  end
+  
+  before(:each) do
+    @some_doc = SomeUniqueDoc.new :unique_prop => 'some property value'
+    SomeUniqueDoc.stub(:view).and_return({'rows' => []})
+  end
+  
+  it "should use a corresponding default view for uniqueness test" do
+    SomeUniqueDoc.should_receive(:view).
+      with(:by_unique_prop, hash_including(:key => @some_doc.unique_prop, :limit => 1, :include_docs => false))
+    @some_doc.valid?
+  end
+  
+  it "should pass validation if no other document exist with the same property value" do
+    @some_doc.should be_valid
+  end
+  
+  it "should not pass validation if another document exists already" do
+    SomeUniqueDoc.should_receive(:view).and_return({'rows' => [{'id' => 123}]})
+    @some_doc.should_not be_valid
+    @some_doc.errors.should have_key :unique_prop
+  end
+  
+  it "should pass validation for an existing document (should remove itself from the list)" do
+    SomeUniqueDoc.should_receive(:view).and_return({'rows' => [{'id' => 123}]})
+    @some_doc.stub(:new_document?).and_return(false)
+    @some_doc.stub(:id).and_return(123)
+    @some_doc.should be_valid
+  end
+  
+  describe "using custom view" do
+    
+    class SomeOtherUniqueDoc < CouchRest::ExtendedDocument
+      include CouchRest::Validation
+      use_database SPEC_COUCH
+      
+      property :another_prop
+      validates_uniqueness_of :another_prop, :view => 'my_custom_view'
+    end
+    
+    before(:each) do
+      @some_doc = SomeOtherUniqueDoc.new :another_prop => 'some property value'
+      SomeOtherUniqueDoc.stub(:view).and_return({'rows' => []})
+    end
+    
+    it "should work" do
+      SomeOtherUniqueDoc.should_receive(:view).
+        with(:my_custom_view, hash_including(:key => @some_doc.another_prop, :limit => 1, :include_docs => false))
+      @some_doc.valid?
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
 require 'rubygems'
 require 'couchrest'
 require 'couchrest/mixins/validation'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: couchrest-uniqueness-validation
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - alex