openlogic-couchrest_model 1.0.0

data/spec/unit/casted_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+class Driver < CouchRest::Model::Base
+  use_database TEST_SERVER.default_database
+  # You have to add a casted_by accessor if you want to reach a casted extended doc parent
+  attr_accessor :casted_by
+  
+  property :name
+end
+
+class Car < CouchRest::Model::Base
+  use_database TEST_SERVER.default_database
+  
+  property :name
+  property :driver, Driver
+end
+
+describe "casting an extended document" do
+  
+  before(:each) do
+    @driver = Driver.new(:name => 'Matt')
+    @car    = Car.new(:name => 'Renault 306', :driver => @driver)
+  end
+
+  it "should retain all properties of the casted attribute" do
+    @car.driver.should == @driver
+  end
+  
+  it "should let the casted document know who casted it" do
+    @car.driver.casted_by.should == @car
+  end
+end
+
+describe "assigning a value to casted attribute after initializing an object" do
+
+  before(:each) do
+    @car    = Car.new(:name => 'Renault 306')
+    @driver = Driver.new(:name => 'Matt')
+  end
+  
+  it "should not create an empty casted object" do
+    @car.driver.should be_nil
+  end
+  
+  it "should let you assign the value" do
+    @car.driver = @driver
+    @car.driver.name.should == 'Matt'
+  end
+  
+  it "should cast attribute" do
+    @car.driver = JSON.parse(@driver.to_json)
+    @car.driver.should be_instance_of(Driver)
+  end
+
+end
+
+describe "casting a model from parsed JSON" do
+
+  before(:each) do
+    @driver = Driver.new(:name => 'Matt')
+    @car    = Car.new(:name => 'Renault 306', :driver => @driver)
+    @new_car = Car.new(JSON.parse(@car.to_json))
+  end
+
+  it "should cast casted attribute" do
+    @new_car.driver.should be_instance_of(Driver)
+  end
+  
+  it "should retain all properties of the casted attribute" do
+    @new_car.driver.should == @driver
+  end
+end

data/spec/unit/class_proxy_spec.rb

@@ -0,0 +1,167 @@
+require "spec_helper"
+
+class UnattachedDoc < CouchRest::Model::Base
+  # Note: no use_database here
+  property :title
+  property :questions
+  property :professor
+  view_by :title
+end
+
+
+describe "Proxy Class" do
+
+  before(:all) do
+    reset_test_db!
+    # setup the class default doc to save the design doc
+    UnattachedDoc.use_database nil # just to be sure it is really unattached
+    @us = UnattachedDoc.on(DB)
+    %w{aaa bbb ddd eee}.each do |title|
+      u = @us.new(:title => title)
+      u.save
+      @first_id ||= u.id
+    end
+  end
+
+  it "should query all" do
+    rs = @us.all
+    rs.length.should == 4
+  end
+  it "should count" do
+    @us.count.should == 4
+  end
+  it "should make the design doc upon first query" do
+    @us.by_title
+    doc = @us.design_doc
+    doc['views']['all']['map'].should include('UnattachedDoc')
+  end
+  it "should merge query params" do
+    rs = @us.by_title :startkey=>"bbb", :endkey=>"eee"
+    rs.length.should == 3
+  end
+  it "should query via view" do
+    view = @us.view :by_title
+    designed = @us.by_title
+    view.should == designed
+  end
+  
+  it "should query via first_from_view" do
+    UnattachedDoc.should_receive(:first_from_view).with('by_title', 'bbb', {:database => DB})
+    @us.first_from_view('by_title', 'bbb')
+  end
+
+  it "should query via first_from_view with complex options" do
+    UnattachedDoc.should_receive(:first_from_view).with('by_title', {:key => 'bbb', :database => DB})
+    @us.first_from_view('by_title', :key => 'bbb')
+  end
+
+  it "should query via first_from_view with complex extra options" do
+    UnattachedDoc.should_receive(:first_from_view).with('by_title', 'bbb', {:limit => 1, :database => DB})
+    @us.first_from_view('by_title', 'bbb', :limit => 1)
+  end
+
+  it "should allow dynamic view matching for single elements" do
+    @us.should_receive(:first_from_view).with('by_title', 'bbb')
+    @us.find_by_title('bbb')
+  end
+
+  it "should yield" do
+    things = []
+    @us.view(:by_title) do |thing|
+      things << thing
+    end
+    things[0]["doc"]["title"].should =='aaa'
+  end
+  it "should yield with by_key method" do
+    things = []
+    @us.by_title do |thing|
+      things << thing
+    end
+    things[0]["doc"]["title"].should =='aaa'
+  end
+  it "should get from specific database" do
+    u = @us.get(@first_id)
+    u.title.should == "aaa"
+  end
+  it "should get first" do
+    u = @us.first
+    u.should == @us.all.first
+  end
+  
+  it "should get last" do
+    u = @us.last
+    u.should == @us.all.last
+  end
+  
+  it "should set database on first retreived document" do
+    u = @us.first
+    u.database.should === DB
+  end
+  it "should set database on all retreived documents" do
+    @us.all.each do |u|
+      u.database.should === DB
+    end
+  end
+  it "should set database on each retreived document" do
+    rs = @us.by_title :startkey=>"bbb", :endkey=>"eee"
+    rs.length.should == 3
+    rs.each do |u|
+      u.database.should === DB
+    end
+  end
+  it "should set database on document retreived by id" do
+    u = @us.get(@first_id)
+    u.database.should === DB
+  end
+  it "should not attempt to set database on raw results using :all" do
+    @us.all(:raw => true).each do |u|
+      u.respond_to?(:database).should be_false
+    end
+  end
+  it "should not attempt to set database on raw results using view" do
+    @us.by_title(:raw => true).each do |u|
+      u.respond_to?(:database).should be_false
+    end
+  end
+
+  describe "#get!" do 
+    it "raises exception when passed a nil" do 
+      expect { @us.get!(nil)}.to raise_error(CouchRest::Model::DocumentNotFound)
+    end
+    
+    it "raises exception when passed an empty string " do 
+      expect { @us.get!("")}.to raise_error(CouchRest::Model::DocumentNotFound)
+    end
+    
+    it "raises exception when document with provided id does not exist" do 
+      expect { @us.get!("thisisnotreallyadocumentid")}.to raise_error(CouchRest::Model::DocumentNotFound)
+    end
+  end
+
+  describe "#find!" do 
+    it "raises exception when passed a nil" do 
+      expect { @us.find!(nil)}.to raise_error(CouchRest::Model::DocumentNotFound)
+    end
+    
+    it "raises exception when passed an empty string " do 
+      expect { @us.find!("")}.to raise_error(CouchRest::Model::DocumentNotFound)
+    end
+    
+    it "raises exception when document with provided id does not exist" do 
+      expect { @us.find!("thisisnotreallyadocumentid")}.to raise_error(CouchRest::Model::DocumentNotFound)
+    end
+  end
+
+  # Sam Lown 2010-04-07
+  # Removed as unclear why this should happen as before my changes 
+  # this happend by accident, not explicitly.
+  # If requested, this feature should be added as a specific method.
+  #
+  #it "should clean up design docs left around on specific database" do
+  #  @us.by_title
+  #  original_id = @us.model_design_doc['_rev']
+  #  Unattached.view_by :professor
+  #  @us.by_professor
+  #  @us.model_design_doc['_rev'].should_not == original_id
+  #end
+end

data/spec/unit/collection_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+
+describe "Collections" do
+
+  before(:all) do
+    reset_test_db!
+    titles = ["very uniq one", "really interesting", "some fun",
+      "really awesome", "crazy bob", "this rocks", "super rad"]
+    titles.each_with_index do |title,i|
+      a = Article.new(:title => title, :date => Date.today)
+      a.save
+    end
+    
+    titles = ["yesterday very uniq one", "yesterday really interesting", "yesterday some fun",
+      "yesterday really awesome", "yesterday crazy bob", "yesterday this rocks"]
+    titles.each_with_index do |title,i|
+      a = Article.new(:title => title, :date => Date.today - 1)
+      a.save
+    end
+  end 
+  it "should return a proxy that looks like an array of 7 Article objects" do
+    articles = Article.collection_proxy_for('Article', 'by_date', :descending => true,
+      :key => Date.today, :include_docs => true)
+    articles.class.should == Array
+    articles.size.should == 7
+  end
+  it "should provide a class method for paginate" do
+    articles = Article.paginate(:design_doc => 'Article', :view_name => 'by_date',
+      :per_page => 3, :descending => true, :key => Date.today)
+    articles.size.should == 3
+
+    articles = Article.paginate(:design_doc => 'Article', :view_name => 'by_date',
+      :per_page => 3, :page => 2, :descending => true, :key => Date.today)
+    articles.size.should == 3
+
+    articles = Article.paginate(:design_doc => 'Article', :view_name => 'by_date',
+      :per_page => 3, :page => 3, :descending => true, :key => Date.today)
+    articles.size.should == 1
+  end
+  it "should provide a class method for paginated_each" do
+    options = { :design_doc => 'Article', :view_name => 'by_date',
+      :per_page => 3, :page => 1, :descending => true, :key => Date.today }
+    Article.paginated_each(options) do |a|
+      a.should_not be_nil
+    end
+  end
+  it "should provide a class method to get a collection for a view" do
+    articles = Article.find_all_article_details(:key => Date.today)
+    articles.class.should == Array
+    articles.size.should == 7
+  end
+  it "should get a subset of articles using paginate" do
+    articles = Article.collection_proxy_for('Article', 'by_date', :key => Date.today, :include_docs => true)
+    articles.paginate(:page => 1, :per_page => 3).size.should == 3
+    articles.paginate(:page => 2, :per_page => 3).size.should == 3
+    articles.paginate(:page => 3, :per_page => 3).size.should == 1
+  end
+  it "should get all articles, a few at a time, using paginated each" do
+    articles = Article.collection_proxy_for('Article', 'by_date', :key => Date.today, :include_docs => true)
+    articles.paginated_each(:per_page => 3) do |a|
+      a.should_not be_nil
+    end
+  end 
+
+  it "should raise an exception if design_doc is not provided" do
+    lambda{Article.collection_proxy_for(nil, 'by_date')}.should raise_error
+    lambda{Article.paginate(:view_name => 'by_date')}.should raise_error
+  end
+  it "should raise an exception if view_name is not provided" do
+    lambda{Article.collection_proxy_for('Article', nil)}.should raise_error
+    lambda{Article.paginate(:design_doc => 'Article')}.should raise_error
+  end
+  it "should be able to span multiple keys" do
+    articles = Article.collection_proxy_for('Article', 'by_date', :startkey => Date.today - 1, :endkey => Date.today, :include_docs => true)
+    articles.paginate(:page => 1, :per_page => 3).size.should == 3
+    articles.paginate(:page => 3, :per_page => 3).size.should == 3
+    articles.paginate(:page => 5, :per_page => 3).size.should == 1
+  end
+  it "should pass database parameter to pager" do
+    proxy = mock(:proxy)
+    proxy.stub!(:paginate)
+    ::CouchRest::Model::Collection::CollectionProxy.should_receive(:new).with('database', anything(), anything(), anything(), anything()).and_return(proxy)
+    Article.paginate(:design_doc => 'Article', :view_name => 'by_date', :database => 'database')
+  end
+
+end

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe CouchRest::Model::Configuration do
+
+  before do
+    @class = Class.new(CouchRest::Model::Base)
+  end
+
+  describe '.configure' do
+    it "should set a configuration parameter" do
+      @class.add_config :foo_bar
+      @class.configure do |config|
+        config.foo_bar = 'monkey'
+      end
+      @class.foo_bar.should == 'monkey'
+    end
+  end
+
+  describe '.add_config' do
+    
+    it "should add a class level accessor" do
+      @class.add_config :foo_bar
+      @class.foo_bar = 'foo'
+      @class.foo_bar.should == 'foo'
+    end
+    
+    ['foo', :foo, 45, ['foo', :bar]].each do |val|
+      it "should be inheritable for a #{val.class}" do
+        @class.add_config :foo_bar
+        @child_class = Class.new(@class)
+
+        @class.foo_bar = val
+        @class.foo_bar.should == val
+        @child_class.foo_bar.should == val
+
+        @child_class.foo_bar = "bar"
+        @child_class.foo_bar.should == "bar"
+
+        @class.foo_bar.should == val
+      end
+    end
+    
+    
+    it "should add an instance level accessor" do
+      @class.add_config :foo_bar
+      @class.foo_bar = 'foo'
+      @class.new.foo_bar.should == 'foo'
+    end
+    
+    it "should add a convenient in-class setter" do
+      @class.add_config :foo_bar
+      @class.foo_bar "monkey"
+      @class.foo_bar.should == "monkey"
+    end
+  end
+
+  describe "General examples" do
+
+    before(:all) do
+      @default_model_key = 'model-type'
+    end
+
+
+    it "should be possible to override on class using configure method" do
+      default_model_key = Cat.model_type_key
+      Cat.instance_eval do
+        model_type_key 'cat-type'
+      end
+      CouchRest::Model::Base.model_type_key.should eql(default_model_key)
+      Cat.model_type_key.should eql('cat-type')
+      cat = Cat.new
+      cat.model_type_key.should eql('cat-type')
+    end
+  end
+
+end

data/spec/unit/connection_spec.rb

@@ -0,0 +1,148 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe CouchRest::Model::Connection do
+
+  before do
+    @class = Class.new(CouchRest::Model::Base)
+  end
+
+  describe "instance methods" do
+    before :each do
+      @obj = @class.new
+    end
+
+    describe "#database" do
+      it "should respond to" do
+        @obj.should respond_to(:database)
+      end
+      it "should provided class's database" do
+        @obj.class.should_receive :database
+        @obj.database
+      end
+    end
+
+    describe "#server" do
+      it "should respond to method" do
+        @obj.should respond_to(:server)
+      end
+      it "should return class's server" do
+        @obj.class.should_receive :server
+        @obj.server
+      end
+    end
+  end
+
+  describe "default configuration" do
+
+    it "should provide environment" do
+      @class.environment.should eql(:development)
+    end
+    it "should provide connection config file" do
+      @class.connection_config_file.should eql(File.join(Dir.pwd, 'config', 'couchdb.yml'))
+    end
+    it "should provided simple connection details" do
+      @class.connection[:prefix].should eql('couchrest')
+    end
+
+  end
+
+  describe "class methods" do
+
+    describe ".use_database" do
+      it "should respond to" do
+        @class.should respond_to(:use_database)
+      end
+    end
+
+    describe ".database" do
+      it "should respond to" do
+        @class.should respond_to(:database)
+      end
+      it "should provide a database object" do
+        @class.database.should be_a(CouchRest::Database)
+      end
+      it "should provide a database with default name" do
+
+      end
+
+    end
+
+    describe ".server" do
+      it "should respond to" do
+        @class.should respond_to(:server)
+      end
+      it "should provide a server object" do
+        @class.server.should be_a(CouchRest::Server)
+      end
+      it "should provide a server with default config" do
+        @class.server.uri.should eql("http://localhost:5984")
+      end
+      it "should allow the configuration to be overwritten" do
+        @class.connection = {
+            :protocol => "https",
+            :host => "127.0.0.1",
+            :port => '5985',
+            :prefix => 'sample',
+            :suffix => 'test',
+            :username => 'foo',
+            :password => 'bar'
+          }
+        @class.server.uri.should eql("https://foo:bar@127.0.0.1:5985")
+      end
+
+    end
+
+    describe ".prepare_database" do
+
+      it "should respond to" do
+        @class.should respond_to(:prepare_database)
+      end
+
+      it "should join the database name correctly" do
+        @class.connection[:suffix] = 'db'
+        db = @class.prepare_database('test')
+        db.name.should eql('couchrest_test_db')
+      end
+
+      it "should ignore nil values in database name" do
+        @class.connection[:suffix] = nil
+        db = @class.prepare_database('test')
+        db.name.should eql('couchrest_test')
+      end
+    end
+
+    describe "protected methods" do
+
+      describe ".connection_configuration" do
+        it "should provide main config by default" do
+          @class.send(:connection_configuration).should eql(@class.connection)
+        end
+        it "should load file if available" do
+          @class.connection_config_file = File.join(FIXTURE_PATH, 'config', 'couchdb.yml')
+          hash = @class.send(:connection_configuration)
+          hash[:protocol].should eql('https')
+          hash[:host].should eql('sample.cloudant.com')
+          hash[:join].should eql('_')
+        end
+      end
+
+      describe ".load_connection_config_file" do
+        it "should provide an empty hash if config not found" do
+          @class.send(:load_connection_config_file).should eql({})
+        end
+        it "should load file if available" do
+          @class.connection_config_file = File.join(FIXTURE_PATH, 'config', 'couchdb.yml')
+          hash = @class.send(:load_connection_config_file)
+          hash[:development].should_not be_nil
+          @class.server.uri.should eql("https://test:user@sample.cloudant.com:443")
+        end
+
+      end
+
+    end
+
+  end
+
+
+end