couch_potato 0.5.1 → 0.5.2

data/README.md

@@ -256,6 +256,9 @@ If you have larger structures and you only want to load some attributes you can
 
   CouchPotato.database.view(User.everyone).first.name # => "joe"
   CouchPotato.database.view(User.everyone).first.bio # => nil
+  
+  CouchPotato.database.first(User.everyone).name # => "joe" # convenience function, returns nil if nothing found
+  CouchPotato.database.first!(User.everyone) # would raise CouchPotato::NotFound if nothing was found
 
 You can also pass in custom map/reduce functions with the custom view spec:
 

data/lib/couch_potato/database.rb

@@ -4,7 +4,7 @@ module CouchPotato
     class ValidationsFailedError < ::StandardError; end
 
     def initialize(couchrest_database)
-      @database = couchrest_database
+      @couchrest_database = couchrest_database
       begin
         couchrest_database.info
       rescue RestClient::ResourceNotFound
@@ -45,7 +45,7 @@ module CouchPotato
     #   db.view(User.all(keys: [1, 2, 3]))
     def view(spec)
       results = CouchPotato::View::ViewQuery.new(
-        database,
+        couchrest_database,
         spec.design_document,
         {spec.view_name => {
           :map => spec.map_function,
@@ -60,6 +60,16 @@ module CouchPotato
       end if processed_results.respond_to?(:each)
       processed_results
     end
+    
+    # returns the first result from a #view query or nil
+    def first(spec)
+      view(spec).first
+    end
+    
+    # returns th first result from a #view or raises CouchPotato::NotFound
+    def first!(spec)
+      first(spec) || raise(CouchPotato::NotFound)
+    end
 
     # saves a document. returns true on success, false on failure
     def save_document(document, validate = true)
@@ -81,7 +91,7 @@ module CouchPotato
     def destroy_document(document)
       document.run_callbacks :destroy do
         document._deleted = true
-        database.delete_doc document.to_hash
+        couchrest_database.delete_doc document.to_hash
       end
       document._id = nil
       document._rev = nil
@@ -92,7 +102,7 @@ module CouchPotato
     def load_document(id)
       raise "Can't load a document without an id (got nil)" if id.nil?
       begin
-        instance = database.get(id)
+        instance = couchrest_database.get(id)
         instance.database = self
         instance
       rescue(RestClient::ResourceNotFound)
@@ -102,7 +112,12 @@ module CouchPotato
     alias_method :load, :load_document
 
     def inspect #:nodoc:
-      "#<CouchPotato::Database @root=\"#{database.root}\">"
+      "#<CouchPotato::Database @root=\"#{couchrest_database.root}\">"
+    end
+    
+    # returns the underlying CouchRest::Database instance
+    def couchrest_database
+      @couchrest_database
     end
 
     private
@@ -121,7 +136,7 @@ module CouchPotato
       
       document.run_callbacks :save do
         document.run_callbacks :create do
-          res = database.save_doc document.to_hash
+          res = couchrest_database.save_doc document.to_hash
           document._rev = res['rev']
           document._id = res['id']
         end
@@ -141,7 +156,7 @@ module CouchPotato
 
       document.run_callbacks :save do
         document.run_callbacks :update do
-          res = database.save_doc document.to_hash
+          res = couchrest_database.save_doc document.to_hash
           document._rev = res['rev']
         end
       end
@@ -156,10 +171,5 @@ module CouchPotato
       end
       document.errors.empty?
     end
-    
-    def database
-      @database
-    end
-
   end
 end

data/lib/couch_potato/persistence/attachments.rb

@@ -13,7 +13,7 @@ module CouchPotato
     end
     
     def to_hash
-      if _attachments
+      if _attachments && _attachments.any?
         super.merge('_attachments' => _attachments)
       else
         super

data/lib/couch_potato/version.rb

@@ -1,3 +1,3 @@
 module CouchPotato
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

data/lib/couch_potato/view/view_query.rb

@@ -41,7 +41,11 @@ module CouchPotato
       end
       
       def view_functions
-        {'map' => @map_function, 'reduce' => @reduce_function}
+        if @reduce_function
+          {'map' => @map_function, 'reduce' => @reduce_function}
+        else
+          {'map' => @map_function}
+        end
       end
       
       def empty_design_document

data/lib/couch_potato.rb

@@ -10,6 +10,8 @@ JSON.create_id = 'ruby_class'
 module CouchPotato
   Config = Struct.new(:database_name, :validation_framework).new
   Config.validation_framework = :active_model
+  
+  class NotFound < StandardError; end
 
   # Returns a database instance which you can then use to create objects and query views. You have to set the CouchPotato::Config.database_name before this works.
   def self.database

data/spec/property_spec.rb

@@ -124,7 +124,7 @@ describe 'properties' do
     db.should_receive(:save_doc).with do |attributes|
       attributes.has_key?(:ship_address).should == true
     end.and_return({})
-    CouchPotato.database.stub(:database).and_return(db)
+    CouchPotato.database.stub(:couchrest_database).and_return(db)
     CouchPotato.database.save_document! p
   end
 

data/spec/unit/database_spec.rb

@@ -207,6 +207,46 @@ describe CouchPotato::Database, 'save_document' do
   end
 end
 
+describe CouchPotato::Database, 'first' do
+  before(:each) do
+    @couchrest_db = stub('couchrest db').as_null_object
+    @db = CouchPotato::Database.new(@couchrest_db)
+    @result = stub('result')
+    @spec = stub('view spec', :process_results => [@result]).as_null_object
+    CouchPotato::View::ViewQuery.stub(:new => stub('view query', :query_view! => {'rows' => [@result]}))
+  end
+  
+  it "should return the first result from a view query" do
+    @db.first(@spec).should == @result
+  end
+  
+  it "should return nil if there are no results" do
+    @spec.stub(:process_results => [])
+    @db.first(@spec).should be_nil
+  end
+end
+
+describe CouchPotato::Database, 'first!' do
+  before(:each) do
+    @couchrest_db = stub('couchrest db').as_null_object
+    @db = CouchPotato::Database.new(@couchrest_db)
+    @result = stub('result')
+    @spec = stub('view spec', :process_results => [@result]).as_null_object
+    CouchPotato::View::ViewQuery.stub(:new => stub('view query', :query_view! => {'rows' => [@result]}))
+  end
+  
+  it "should return the first result from a view query" do
+    @db.first!(@spec).should == @result
+  end
+  
+  it "should raise an error if there are no results" do
+    @spec.stub(:process_results => [])
+    lambda {
+      @db.first!(@spec)
+    }.should raise_error(CouchPotato::NotFound)
+  end
+end
+
 describe CouchPotato::Database, 'view' do
   before(:each) do
     @couchrest_db = stub('couchrest db').as_null_object

data/spec/unit/json_spec.rb

@@ -12,6 +12,12 @@ describe CouchPotato::Persistence::Json do
       sake = Drink.new(:alcohol => "18%")
       sake.to_hash[JSON.create_id].should eql("Drink")
     end
+    
+    it "should not include _attachments if there are none" do
+      sake = Drink.new(:alcohol => "18%")
+      sake.to_hash.keys.should_not include('_attachments')
+    end
+    
   end
   
   context '.json_create' do

data/spec/unit/view_query_spec.rb

@@ -26,53 +26,61 @@ describe CouchPotato::View::ViewQuery, 'query_view!' do
   it "should update a view when the map function has changed" do
     db = mock 'db', :get => {'views' => {'view2' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}}, :view => nil
     db.should_receive(:save_doc)
-    CouchPotato::View::ViewQuery.new(db, 'design', :view2 => {:map => '<new map_code>', :recude => '<reduce_code>'}).query_view!
+    CouchPotato::View::ViewQuery.new(db, 'design', :view2 => {:map => '<new map_code>', :reduce => '<reduce_code>'}).query_view!
+  end
+  
+  it "should not pass in a reduce key if there is no reduce function" do
+    db = mock 'db', :get => {'views' => {}}, :view => nil
+    
+    db.should_receive(:save_doc).with('views' => {'view3' => {'map' => '<map code>'}})
+    
+    CouchPotato::View::ViewQuery.new(db, 'design', :view3 => {:map => '<map code>', :reduce => nil}).query_view!
   end
   
   it "should update a view when the reduce function has changed" do
-    db = mock 'db', :get => {'views' => {'view3' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}}, :view => nil
+    db = mock 'db', :get => {'views' => {'view4' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}}, :view => nil
     db.should_receive(:save_doc)
-    CouchPotato::View::ViewQuery.new(db, 'design', :view3 => {:map => '<map_code>', :reduce => '<new reduce_code>'}).query_view!
+    CouchPotato::View::ViewQuery.new(db, 'design', :view4 => {:map => '<map_code>', :reduce => '<new reduce_code>'}).query_view!
   end
   
   it "should update a view when the list function has changed" do
     db = mock 'db', :get => {
-      'views' => {'view4' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}},
+      'views' => {'view5' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}},
       'lists' => {'list1' => '<list_code>'}
       }, :view => nil
     db.should_receive(:save_doc)
-    CouchPotato::View::ViewQuery.new(db, 'design', {:view4 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, :list1 => '<new_list_code>').query_view!
+    CouchPotato::View::ViewQuery.new(db, 'design', {:view5 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, :list1 => '<new_list_code>').query_view!
   end
   
   it "should update a view when there wasn't a list function but now there is one" do
     db = mock 'db', :get => {
-      'views' => {'view5' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}
+      'views' => {'view6' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}
       }, :view => nil
     db.should_receive(:save_doc)
-    CouchPotato::View::ViewQuery.new(db, 'design', {:view5 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, :list1 => '<new_list_code>').query_view!
+    CouchPotato::View::ViewQuery.new(db, 'design', {:view6 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, :list1 => '<new_list_code>').query_view!
   end
   
   it "should not update a view when there is a list function but no list function is passed" do
     db = mock 'db', :get => {
-      'views' => {'view6' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}},
+      'views' => {'view7' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}},
       'lists' => {'list1' => '<list_code>'}
       }, :view => nil
     db.should_not_receive(:save_doc)
-    CouchPotato::View::ViewQuery.new(db, 'design', {:view6 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, {}).query_view!
+    CouchPotato::View::ViewQuery.new(db, 'design', {:view7 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, {}).query_view!
   end
   
   it "should not update a view when there were no lists before and no list function is passed" do
     db = mock 'db', :get => {
-      'views' => {'view6' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}
+      'views' => {'view8' => {'map' => '<map_code>', 'reduce' => '<reduce_code>'}}
       }, :view => nil
     db.should_not_receive(:save_doc)
-    CouchPotato::View::ViewQuery.new(db, 'design', {:view6 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, {}).query_view!
+    CouchPotato::View::ViewQuery.new(db, 'design', {:view8 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, {}).query_view!
   end
   
   it "should query CouchRest directly when querying a list" do
     db = stub('db').as_null_object
-    CouchRest.should_receive(:get).with('http://127.0.0.1:5984/couch_potato_test/_design/my_design/_list/list1/view7?key=1')
-    CouchPotato::View::ViewQuery.new(db, 'my_design', {:view7 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, :list1 => '<new_list_code>').query_view!(:key => 1)
+    CouchRest.should_receive(:get).with('http://127.0.0.1:5984/couch_potato_test/_design/my_design/_list/list1/view9?key=1')
+    CouchPotato::View::ViewQuery.new(db, 'my_design', {:view9 => {:map => '<map_code>', :reduce => '<reduce_code>'}}, :list1 => '<new_list_code>').query_view!(:key => 1)
   end
   
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: couch_potato
 version: !ruby/object:Gem::Version 
-  hash: 9
   prerelease: 
-  segments: 
-  - 0
-  - 5
-  - 1
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - Alexander Lang
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-10 00:00:00 +02:00
+date: 2011-04-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,9 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -40,11 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 0
-        - 1
         version: 1.0.1
   type: :runtime
   version_requirements: *id002
@@ -56,9 +43,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id003
@@ -70,10 +54,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
         version: "2.0"
   type: :development
   version_requirements: *id004
@@ -85,9 +65,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id005
@@ -99,9 +76,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id006
@@ -215,18 +189,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []