ShyCouch 0.6.0 → 0.7.0

data/test/test_couchdb_factory.rb

@@ -3,13 +3,13 @@ require_relative '../lib/ShyCouch.rb'
 
 class TestCouchDBFactory < Test::Unit::TestCase
   def setup
-    @valid_settings = $settings
+		@valid_settings = $settings
   end
   
   def teardown
   end
   
   def test_create_database
-    assert_kind_of(ShyCouch::CouchDatabase, ShyCouch.getDB(@valid_settings))
+		assert_kind_of(ShyCouch::CouchDatabase, ShyCouch.getDB(@valid_settings))
   end
-end
+end

data/test/test_design_documents.rb

@@ -3,143 +3,164 @@ require_relative '../lib/ShyCouch.rb'
 
 class DesignDocumentTests
   class ShyCouchDesignTestHelper < ShyCouchTestHelper
-    def setup
-      super
-      # add some docs to the database
-      @documents = add_some_documents
-      # make some views
-      @views = setup_views
-      # make a design, push it
-      @design = setup_design_document
-      @design.push!
-    end
-    def teardown
-      super
-    end
-    def setup_views
-      view1 = ShyCouch::Data::View.new :recipes do
-        map do
-          emit(doc.name, null) if doc.kind == "Recipe"
-        end
-      end
-      view2 = ShyCouch::Data::View.new :recipe_count do
-        map do
-          emit(doc.name, null) if doc.kind == "Recipe"
-        end
-        reduce do
-          return sum(values)
-        end
-      end
-      return [view1, view2]
-    end
-    
-    def setup_design_document
-      return ShyCouch::Data::Design.new :food, {:views => @views, :push_to => @couchdb }
-    end
-    
-    def add_some_documents
-      4.times do
-        recipe = Recipe.new(:push_to => @couchdb)
-        recipe.push!
-      end
-    end
+		def setup
+		  super
+		  # add some docs to the database
+		  @documents = add_some_documents
+		  # make some views
+		  @views = setup_views
+		  # make a design, push it
+		  @design = setup_design_document
+		  @design.push!
+		end
+		def teardown
+		  super
+		end
+		def setup_views
+		  view1 = ShyCouch::Data::View.new :recipes do
+				map do
+				  emit(doc._id, null) if doc.kind == "Recipe"
+				end
+		  end
+		  view2 = ShyCouch::Data::View.new :recipe_count do
+				map do
+				  emit(doc.name, null) if doc.kind == "Recipe"
+				end
+				reduce do
+				  return sum(values)
+				end
+		  end
+		  return [view1, view2]
+		end
+		
+		def setup_design_document
+		  return ShyCouch::Data::Design.new :food, {:views => @views, :push_to => @couchdb }
+		end
+		
+		def add_some_documents
+		  4.times do
+				recipe = Recipe.new(:push_to => @couchdb)
+				recipe.push!
+		  end
+		end
   end
   
   class TestDesignDocument < ShyCouchDesignTestHelper
-    Design = ShyCouch::Data::Design
-    CouchDocument = ShyCouch::Data::CouchDocument
-    
-    class Recipe < CouchDocument; end
-    
-    def setup
-      super
-    end
-    def teardown
-      super
-    end
-    
-    def test_create_design
-      assert_nothing_raised {
-        @design = setup_design_document
-      }
-    end
-    
-    def test_create_design_to_db
-      new_doc = @couchdb.pull_design(@design._id)
-      assert_equal(@design.as_hash, new_doc.as_hash)
-    end
+		Design = ShyCouch::Data::Design
+		CouchDocument = ShyCouch::Data::CouchDocument
+		
+		class Recipe < CouchDocument; end
+		
+		def setup
+		  super
+		end
+		def teardown
+		  super
+		end
+		
+		def test_create_design
+		  assert_nothing_raised {
+				@design = setup_design_document
+		  }
+		end
+
+		def test_kind_key
+			assert_equal("Design", @design.kind)
+		end
+		
+		def test_create_design_to_db
+		  new_doc = @couchdb.pull_design(@design._id)
+	  	assert_equal(@design.to_hash, new_doc.to_hash)
+		end
+
+		def test_rev
+	 		assert(@design._rev)
+		end
+  end
+  
+  class TestDesignDocumentHandleConflicts < ShyCouchDesignTestHelper
+		def setup; super; end
+		
+		def test_create_conflicting_design
+		  assert_nothing_raised ShyCouch::DesignConflict do
+				design = ShyCouch::Data::Design.new :food, {:views => @views, :push_to => @couchdb }
+				design.push!
+		  end
+		end
+		
+		def teardown; super; end
   end
   
   class TestDesignsInDatabase < ShyCouchDesignTestHelper
-    def setup
-      super
-    end
-    
-    def teardown
-      super
-    end
-    
-    # three different ways of calling the design
-    def test_get_design_1
-      result = @couchdb.design(@design.name)
-      assert_equal(@design, result)
-    end
-    def test_get_design_2
-      result = @couchdb.design(@design)      
-      assert_equal(@design, result)
-    end
-    def test_get_design_3
-      result = @couchdb.design(:food)
-      assert_equal(@design, result)
-    end
-    
-    def test_modify_design_and_push
-      @design.views["recipe_count"].delete("map")
-      @design.push!
-    end
-    
+		def setup
+		  super
+		end
+		
+		def teardown
+		  super
+		end
+		
+		# three different ways of calling the design
+		def test_get_design_1
+		  result = @couchdb.design(@design.name)
+		  assert_equal(@design, result)
+		end
+		def test_get_design_2
+		  result = @couchdb.design(@design)		  
+		  assert_equal(@design, result)
+		end
+		def test_get_design_3
+		  result = @couchdb.design(:food)
+		  assert_equal(@design, result)
+		end
+		
+		def test_modify_design_and_push
+		  @design.views["recipe_count"].delete("map")
+		  @design.push!
+		end
+		
   end
   
   class TestCallViewFromDesign < ShyCouchDesignTestHelper
-    def setup
-      super
-    end
-    
-    def teardown
-      super
-    end
-    
-    def test_call_view_by_name
-      # for the map view:
-      result = @couchdb.design(@design).query_view(:recipes)
-      # test that we got the right kind of object:
-      assert_kind_of(ShyCouch::Data::ViewResult, result)
-      # test that the object has the expected number of rows:
-      assert_equal(4, result.length)
-      
-      # for the reduce view:
-      result = @couchdb.design(@design).query_view(:recipe_count)
-      assert_kind_of(ShyCouch::Data::ViewResult, result)
-      assert_equal(1, result.length)
-      assert_respond_to(result, :total_rows)
-      assert_respond_to(result, :offset)
-    end
-    
-    def test_call_view_with_view_object
-      # for the map view:
-      result = @couchdb.design(@design).query_view(@views[0])
-      # test that we got the right kind of object:
-      assert_kind_of(ShyCouch::Data::ViewResult, result)
-      # test that the object has the expected number of rows:
-      assert_equal(4, result.length)
-      # and that it responds to offset and total rows as method calls:
-      assert_respond_to(result, :total_rows)
-      assert_respond_to(result, :offset)
-      
-      # for the reduce view:
-      # TODO 
-    end
-    
+		def setup
+		  super
+		end
+		
+		def teardown
+		  super
+		end
+		
+		def test_call_view_by_name
+		  # for the map view:
+		  result = @couchdb.design(@design).query_view(:recipes)
+		  # test that we got the right kind of object:
+		  assert_kind_of(ShyCouch::Data::ViewResult, result)
+		  # test that the object has the expected number of rows:
+		  assert_equal(4, result.length)
+		  
+		  # for the reduce view:
+		  result = @couchdb.design(@design).query_view(:recipe_count)
+		  assert_kind_of(ShyCouch::Data::ViewResult, result)
+		  assert_equal(1, result.length)
+		  assert_respond_to(result, :total_rows)
+		  assert_respond_to(result, :offset)
+		end
+		
+		def test_call_view_with_view_object
+		  # for the map view:
+		  result = @couchdb.design(@design).query_view(@views[0])
+		  # test that we got the right kind of object:
+		  assert_kind_of(ShyCouch::Data::ViewResult, result)
+		  # test that the object has the expected number of rows:
+		  assert_equal(4, result.length)
+		  # and that it responds to offset and total rows as method calls:
+		  assert_respond_to(result, :total_rows)
+		  assert_respond_to(result, :offset)
+		  
+		  # for the reduce view:
+		  # TODO 
+		end
+		
   end
   
-end
+end

data/test/test_document_validation.rb

@@ -0,0 +1,85 @@
+require 'test/unit'
+require_relative '../lib/ShyCouch.rb'
+
+class CouchDocumentValidationTests
+  class TestDocumentValidation < ShyCouchTestHelper
+		
+		# define a class with some needs
+		class FussyRecipe < ShyCouch::Data::CouchDocument
+		  needs :name
+		  needs :cost
+		end
+		
+		# define a class with some suggests
+		class LenientRecipe < ShyCouch::Data::CouchDocument
+		  suggests :ingredients
+		  suggests :date
+		end
+		
+		# define a class with both needs and suggests
+		class PainfulRecipe < ShyCouch::Data::CouchDocument
+		  needs :name
+		  needs :cost
+		  suggests :ingredients
+		  suggests :date
+		end
+		
+		class VariedRecipe < ShyCouch::Data::CouchDocument
+		  # This just checks that you can pass multiple values
+		  needs :name, :cost
+		  suggests :ingredients, :date
+		end
+		
+		def setup
+		  super
+		end
+		
+		def test_needs_enforcement
+		  # Check that docs can be pushed if they satisfy the needs
+		  fr1 = FussyRecipe.new(:data => {:name => "cool", :cost => 1}, :push_to => @couchdb)
+		  assert_nothing_raised ShyCouch::DocumentValidationError do
+				fr1.push!
+		  end
+		  
+		  # Check that it fails if satisfies no needs
+		  fr2 = FussyRecipe.new(:push_to => @couchdb)
+		  assert_raises ShyCouch::DocumentValidationError do
+				fr2.push!
+		  end
+		  
+		  # Check that it fails if it satisfies only some needs
+		  fr3 = FussyRecipe.new(:data => {:name => "cool"}, :push_to => @couchdb)
+		  assert_raises ShyCouch::DocumentValidationError do
+				fr3.push!
+		  end
+		end
+		
+		def test_suggests_enforcement
+		  # Check that it fails with no suggestions satisfied
+		  lr1 = LenientRecipe.new(:push_to => @couchdb)
+		  assert_raises ShyCouch::DocumentValidationError do
+				lr1.push!
+		  end
+		  
+		  # Check that it fails with only some suggestions satisfied
+		  lr2 = LenientRecipe.new(:data => {:ingredients => "not many"}, :push_to => @couchdb)
+		end
+		def test_suggests_override
+		  # Check that it succeeds if the suggestions are overriden
+		  lr1 = LenientRecipe.new(:push_to => @couchdb)
+		  assert_nothing_raised ShyCouch::DocumentValidationError do 
+				lr1.push!(:ignore_suggestions => [:ingredients, :date])
+		  end
+		  
+		  # Check that it succeeds if some suggestions are satisfied and others are overriden
+		  lr2 = LenientRecipe.new(:data => {:ingredients => "heaps!"}, :push_to => @couchdb)
+		  assert_nothing_raised ShyCouch::DocumentValidationError do 
+				lr2.push!(:ignore_suggestion => :date)
+		  end
+		end
+		
+		def teardown
+		  super
+		end
+  end
+end

data/test/test_fields.rb

@@ -3,24 +3,24 @@ require_relative '../lib/ShyCouch.rb'
 
 class TestEmailField < Test::Unit::TestCase
   def setup
-    @valid_emails = ['bigbeggar@gmail.com', 'helpmeout@bigpond.com'] # more!
-    @invalid_emails = ['byby.head@heat']#, 'looptheloop@ireallyhopethisisntadomainpleasedontbeadomain.org'] # more!
-    #commented out the one with an invalid domain cos resolve timeout long
+		@valid_emails = ['bigbeggar@gmail.com', 'helpmeout@bigpond.com'] # more!
+		@invalid_emails = ['byby.head@heat']#, 'looptheloop@ireallyhopethisisntadomainpleasedontbeadomain.org'] # more!
+		#commented out the one with an invalid domain cos resolve timeout long
   end
   
   def teardown; end
   
   def test_valid_emails
-    @valid_emails.each do |email|
-      email_addr = ShyCouch::Fields::Email_Addr.new(email)
-      assert_equal(true, email_addr.valid?)
-    end
+		@valid_emails.each do |email|
+		  email_addr = ShyCouch::Fields::Email_Addr.new(email)
+		  assert_equal(true, email_addr.valid?)
+		end
   end
   
   def test_invalid_emails
-    @invalid_emails.each do |email|
-       email_addr = ShyCouch::Fields::Email_Addr.new(email)
-       assert_equal(false, email_addr.valid?)
-     end
+		@invalid_emails.each do |email|
+		   email_addr = ShyCouch::Fields::Email_Addr.new(email)
+		   assert_equal(false, email_addr.valid?)
+		 end
   end
-end
+end

data/test/test_views.rb

@@ -2,16 +2,16 @@ require 'test/unit'
 require_relative '../lib/ShyCouch.rb'
 
 class CouchViewTests < Test::Unit::TestCase
-  JS_MAP_FUNCTION_HEADER = "function ( doc ) { \n    "
-  JS_REDUCE_FUNCTION_HEADER = "function(key, values, rereduce) { \n    "
+  JS_MAP_FUNCTION_HEADER = "function ( doc ) { \n		"
+  JS_REDUCE_FUNCTION_HEADER = "function(key, values, rereduce) { \n		"
   JS_FUNCTION_FOOTER = "}"
   def setup
-    @couch_views = []
+		@couch_views = []
   end
   
   def view(view_name, &block)
-    #for convenience, and to imitate how it would be used in Camping
-    @couch_views << ShyCouch::Data::View.new(view_name, &block)
+		#for convenience, and to imitate how it would be used in Camping
+		@couch_views << ShyCouch::Data::View.new(view_name, &block)
   end
   def teardown; end
   
@@ -19,30 +19,30 @@ class CouchViewTests < Test::Unit::TestCase
 
   
   # def test_define_map_view
-  #     view :five_star_butts do
-  #       map do
-  #         # def function(doc)
-  #           emit(doc) if doc.kind == "butt" and doc.star_rating == 5
-  #         # end
-  #       end
-  #     end
-  #     expected_js = JS_MAP_FUNCTION_HEADER + %{if( doc.kind == 'butt' && doc.star_rating == 5 ) {\n  emit(doc)\n}} + JS_FUNCTION_FOOTER
-  #     assert_equal(expected_js, @couch_views[0].map)
+  #		 view :five_star_butts do
+  #		   map do
+  #				 # def function(doc)
+  #				   emit(doc) if doc.kind == "butt" and doc.star_rating == 5
+  #				 # end
+  #		   end
+  #		 end
+  #		 expected_js = JS_MAP_FUNCTION_HEADER + %{if( doc.kind == 'butt' && doc.star_rating == 5 ) {\n  emit(doc)\n}} + JS_FUNCTION_FOOTER
+  #		 assert_equal(expected_js, @couch_views[0].map)
   #   end
   #   
   #   def test_define_map_and_reduce_view
-  #     view :beggar_count do
-  #       map do
-  #         emit(doc) if doc.kind == "beggar"
-  #       end
-  #       reduce do
-  #         return sum(values)
-  #       end
-  #     end
-  #     expected_map = JS_MAP_FUNCTION_HEADER + %{if( doc.kind == 'beggar' ) {\n  emit(doc)\n}} + JS_FUNCTION_FOOTER
-  #     expected_reduce = JS_REDUCE_FUNCTION_HEADER + %{return sum(values);} + JS_FUNCTION_FOOTER
-  #     assert_equal(expected_map, @couch_views[0].map)
-  #     assert_equal(expected_reduce, @couch_views[0].reduce)
+  #		 view :beggar_count do
+  #		   map do
+  #				 emit(doc) if doc.kind == "beggar"
+  #		   end
+  #		   reduce do
+  #				 return sum(values)
+  #		   end
+  #		 end
+  #		 expected_map = JS_MAP_FUNCTION_HEADER + %{if( doc.kind == 'beggar' ) {\n  emit(doc)\n}} + JS_FUNCTION_FOOTER
+  #		 expected_reduce = JS_REDUCE_FUNCTION_HEADER + %{return sum(values);} + JS_FUNCTION_FOOTER
+  #		 assert_equal(expected_map, @couch_views[0].map)
+  #		 assert_equal(expected_reduce, @couch_views[0].reduce)
   #   end
   
 end
@@ -51,14 +51,14 @@ class CouchDefaultViewTests < ShyCouchTestHelper
   # define a class that should have an 'all' method to get all instances of that object
   class Leg < ShyCouch::Data::CouchDocument; end
   def setup
-    super
-    # add some instances of the object
-    @test_docs = []
-    @test_docs << Leg.new(:push_to => @couchdb, :data => {"length"=>30}).push!
-    @test_docs << Leg.new(:push_to => @couchdb, :data => {"length"=>18, "broken"=>true}).push!
+		super
+		# add some instances of the object
+		@test_docs = []
+		@test_docs << Leg.new(:push_to => @couchdb, :data => {"length"=>30}).push!
+		@test_docs << Leg.new(:push_to => @couchdb, :data => {"length"=>18, "broken"=>true}).push!
   end
   def teardown
-    super
+		super
   end
   # 
   # def test_query_all
@@ -67,4 +67,100 @@ class CouchDefaultViewTests < ShyCouchTestHelper
   #   assert_kind_of(ShyCouch::CouchDocumentCollection, @all_legs)
   #   # also test that the doc values worked, and that the response has the docs in it, etc.
   # end
-end
+end
+
+class CouchViewTestHelper < ShyCouchTestHelper
+	def setup
+		super
+		# make a view
+		view = ShyCouch::Data::View.new :all_recipes do
+			map do
+				emit(doc._id, doc.length) if doc.kind == "Recipe"
+			end
+		end
+		design = ShyCouch::Data::Design.new :food, {:views => [view], :push_to => @couchdb}
+		add_some_documents
+		design.push!
+		# make a design
+	end
+	def teardown; super; end
+end
+
+class CouchViewResultsTests < CouchViewTestHelper
+	def setup
+		super
+	end
+	def test_view_results_is_hash_keyed_by_results
+		result = @couchdb.design(:food).query_view(:all_recipes)
+		assert_kind_of ShyCouch::Data::ViewResult, result
+		# test that it's made of ViewResultRow objects that respond to "id"
+		result.each do |k,v|
+			assert_kind_of ShyCouch::Data::ViewResult::ViewResultRow, v
+			assert_respond_to v, :id
+		end
+		
+	end
+	def teardown; super; end
+end
+
+class CouchViewOptionTests < CouchViewTestHelper
+	def setup
+		super
+	end
+
+	def test_call_views_with_option
+		# just test all the different options and make sure nothing's thrown
+		# TODO - change this to test it with all the options, maybe? just to check no errors thrown, etc?
+		design = @couchdb.design(:food)
+		result = design.query_view(:all_recipes, {:include_docs => true})
+		assert_kind_of ShyCouch::Data::CouchDocumentCollection, result
+	end
+
+	def test_all_docs_query_has_docs_as_rows
+		# test that if we call a view with "include docs", the iterable of the collection returned is the document itself (as a couch document of the right kind)
+		result = @couchdb.design(:food).query_view(:all_recipes, :include_docs => true)
+		assert_kind_of ShyCouch::Data::CouchDocumentCollection, result
+		#result.each do |row|
+		#	assert_respond_to row, :kind	
+		#	puts "kind: #{row.kind}"
+		#end
+	end
+
+  def test_stringify_options
+    # Test that views can be called with string options:
+    # key, endkey, startkey
+    assert_nothing_raised ShyCouch::ViewError do
+      result = @couchdb.design(:food).query_view(:all_recipes, :key => "nice one")
+    end
+    assert_nothing_raised ShyCouch::ViewError do
+      result = @couchdb.design(:food).query_view(:all_recipes, :startkey => "nice one")
+    end
+    assert_nothing_raised ShyCouch::ViewError do
+      result = @couchdb.design(:food).query_view(:all_recipes, :endkey => "nice one")
+    end
+  end
+  def test_handle_empty_response
+    assert_nothing_raised NoMethodError do
+      # hopefully this key won't exist
+      result = @couchdb.design(:food).query_view(:all_recipes, :endkey => "FHDJFHSDJKFNJKNDWKJHjkhkjhjkh^")
+    end
+  end
+
+  def test_cannot_send_invalid_option
+    assert_raises ShyCouch::ViewError do
+      result = @couchdb.design(:food).query_view(:all_recipes, :some_magic => "i want this to be like sql!!")
+    end
+  end
+
+	# TODO - individual relevant tests for each option
+  
+  def test_query_by_key
+    # querying by key should return a document, not a collection with a single document in it
+	  recipe = Recipe.new(:push_to => @couchdb, :data => {:length => 10})
+    recipe.push!
+    doc_from_db = @couchdb.design(:food).query_view(:all_recipes, :key => recipe._id, :include_docs => true)
+    assert_kind_of(ShyCouch::Data::CouchDocument, doc_from_db)
+  end
+
+	def teardown; super; end
+end