couch_potato 0.2.24 → 0.2.25

data/CHANGES.md

@@ -1,5 +1,10 @@
 ## Changes
 
+### 0.2.25
+* automatic view updates: when you change the definition of a view couch potato will now update the design document in the database (langalex)
+* support for properties of type Date, better support for Time (langalex)
+* support for default reduce count methods in custom views (jweiss)
+
 ### 0.2.24
 * persistent instances can now be marked as dirty with #is_dirty (langalex)
 

data/README.md

@@ -90,7 +90,7 @@ Properties can be typed:
     end
     
 In this case Address also implements CouchPotato::Persistence which means its JSON representation will be added to the user document.  
-Couch Potato also has support for the basic types (right now Fixnum and :boolean are supported):
+Couch Potato also has support for the basic types (right now Fixnum, Date, Time and :boolean are supported):
 
     class User
       include CouchPotato::Persistence

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 2
-:patch: 24
+:patch: 25
 :build: 

data/lib/couch_potato.rb

@@ -40,4 +40,4 @@ require File.dirname(__FILE__) + '/core_ext/string'
 require File.dirname(__FILE__) + '/core_ext/symbol'
 require File.dirname(__FILE__) + '/couch_potato/validation'
 require File.dirname(__FILE__) + '/couch_potato/persistence'
-
+require File.dirname(__FILE__) + '/couch_potato/railtie' if defined?(Rails)

data/lib/couch_potato/persistence/properties.rb

@@ -66,17 +66,18 @@ module CouchPotato
           instance
         end
 
-        # Declare a property on a model class. properties are not typed by default. You can use any of the basic types by JSON (String, Integer, Fixnum, Array, Hash). If you want a property to be of a custom class you have to define it using the :class option.
+        # Declare a property on a model class. Properties are not typed by default.
+        # You can store anything in a property that can be serialized into JSON.
+        # If you want a property to be of a custom class you have to define it using the :type option.
         #
         # example:
         #  class Book
         #    property :title
         #    property :year
-        #    property :publisher, :class => Publisher
+        #    property :publisher, :type => Publisher
         #  end
         def property(name, options = {})
-          clazz = options.delete(:class)
-          properties << (clazz || SimpleProperty).new(self, name, options)
+          properties << SimpleProperty.new(self, name, options)
         end
 
       end

data/lib/couch_potato/persistence/simple_property.rb

@@ -13,21 +13,13 @@ module CouchPotato
       
       def build(object, json)
         value = json[name.to_s].nil? ? json[name.to_sym] : json[name.to_s]
-        object.send "#{name}=", @type_caster.cast(value, type)
+        object.send "#{name}=", value
       end
       
       def dirty?(object)
         object.send("#{name}_changed?")
       end
       
-      def save(object)
-        
-      end
-      
-      def destroy(object)
-        
-      end
-      
       def serialize(json, object)
         json[name] = object.send name
       end

data/lib/couch_potato/persistence/type_caster.rb

@@ -26,7 +26,7 @@ module CouchPotato
           if type == Fixnum
             value.to_s.scan(/\d/).join.to_i unless value.blank?
           else
-            type.json_create value
+            type.json_create value unless value.blank?
           end
         else
           value

data/lib/couch_potato/railtie.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../rails/reload_classes')
+
+module CouchPotato
+
+  def self.rails_init
+    CouchPotato::Config.database_name = YAML::load(File.read(Rails.root.join('config/couchdb.yml')))[Rails.env]
+  end
+
+  if Rails.version >= '3'
+    class Railtie < Rails::Railtie
+      railtie_name :couch_potato
+
+      config.after_initialize do |app|
+        CouchPotato.rails_init
+      end
+    end
+  else
+    rails_init
+  end
+
+end

data/lib/couch_potato/view/custom_view_spec.rb

@@ -18,14 +18,25 @@ module CouchPotato
       end
       
       def process_results(results)
-        results['rows'].map do |row|
-          if row['doc'].instance_of?(klass)
-            row['doc']
-          else
-            klass.json_create row['doc'] || row['value'].merge(:_id => row['id'] || row['key'])
+        if count?
+          results['rows'].first.try(:[], 'value') || 0
+        else  
+          results['rows'].map do |row|
+            if row['doc'].instance_of?(klass)
+              row['doc']
+            else
+              klass.json_create row['doc'] || row['value'].merge(:_id => row['id'] || row['key'])
+            end
           end
         end
       end
+      
+      private 
+      
+      def count?
+        view_parameters[:reduce]
+      end
+      
     end
   end
 end

data/lib/couch_potato/view/view_query.rb

@@ -11,24 +11,45 @@ module CouchPotato
       end
 
       def query_view!(parameters = {})
+        update_view unless view_has_been_updated?
         begin
           query_view parameters
         rescue RestClient::ResourceNotFound# => e
-          create_view
+          update_view
           retry
         end
       end
 
       private
 
-      def create_view
+      def update_view
         design_doc = @database.get "_design/#{@design_document_name}" rescue nil
-        design_doc ||= {'views' => {}, "_id" => "_design/#{@design_document_name}", "language" => "javascript"}
-        design_doc['views'][@view_name.to_s] = {
-          'map' => @map_function,
-          'reduce' => @reduce_function
-        }
-        @database.save_doc(design_doc)
+        original_views = design_doc && design_doc['views'].dup
+        view_updated unless design_doc.nil?
+        design_doc ||= empty_design_document
+        design_doc['views'][@view_name.to_s] = view_functions
+        @database.save_doc(design_doc) unless original_views == design_doc['views']
+      end
+      
+      def view_functions
+        {'map' => @map_function, 'reduce' => @reduce_function}
+      end
+      
+      def empty_design_document
+        {'views' => {}, "_id" => "_design/#{@design_document_name}", "language" => "javascript"}
+      end
+      
+      def view_has_been_updated?
+        updated_views[[@design_document_name, @view_name]]
+      end
+      
+      def view_updated
+        updated_views[[@design_document_name, @view_name]] = true
+      end
+      
+      def updated_views
+        @@updated_views ||= {}
+        @@updated_views
       end
 
       def query_view(parameters)

data/rails/init.rb

@@ -1,8 +1,4 @@
 # this is for rails only
 
 require File.expand_path(File.dirname(__FILE__) + '/../lib/couch_potato')
-require File.expand_path(File.dirname(__FILE__) + '/reload_classes')
-
-CouchPotato::Config.database_name = YAML::load(File.read(Rails.root.to_s + '/config/couchdb.yml'))[RAILS_ENV]
-
-RAILS_DEFAULT_LOGGER.info "** couch_potato: initialized from #{__FILE__}"
+Rails.logger.info "** couch_potato: initialized from #{__FILE__}"

data/spec/custom_view_spec.rb

@@ -13,6 +13,7 @@ class Build
   view :custom_timeline, :map => "function(doc) { emit(doc._id, {state: 'custom_' + doc.state}); }", :type => :custom
   view :custom_timeline_returns_docs, :map => "function(doc) { emit(doc._id, null); }", :include_docs => true, :type => :custom
   view :custom_with_reduce, :map => "function(doc) {if(doc.foreign_key) {emit(doc.foreign_key, 1);} else {emit(doc.id, 1)}}", :reduce => "function(key, values) {return({\"count\": sum(values)});}", :group => true, :type => :custom
+  view :custom_count_with_reduce, :map => "function(doc) {if(doc.foreign_key) {emit(doc.foreign_key, 1);} else {emit(doc.id, 1)}}", :reduce => "function(key, values) {return(sum(values));}", :group => true, :type => :custom
   view :raw, :type => :raw, :map => "function(doc) {emit(doc._id, doc.state)}"
   view :filtered_raw, :type => :raw, :map => "function(doc) {emit(doc._id, doc.state)}", :results_filter => lambda{|res| res['rows'].map{|row| row['value']}}
   view :with_view_options, :group => true, :key => :time
@@ -130,7 +131,14 @@ describe 'view' do
         doc = CouchPotato.couchrest_database.save_doc({})
         CouchPotato.couchrest_database.save_doc({:foreign_key => doc['id']})
         CouchPotato.database.view(Build.custom_with_reduce).map(&:_id).should == [doc['id']]
-        
+      end
+      
+      describe "when the additional reduce function is a typical count" do
+        it "should parse the reduce count" do
+          doc = CouchPotato.couchrest_database.save_doc({})
+          CouchPotato.couchrest_database.save_doc({:foreign_key => doc['id']})
+          CouchPotato.database.view(Build.custom_count_with_reduce(:reduce => true)).should == 1
+        end
       end
     end
   end

data/spec/property_spec.rb

@@ -6,6 +6,7 @@ class Watch
   include CouchPotato::Persistence
   
   property :time, :type => Time
+  property :date, :type => Date
   property :overwritten_read
   property :overwritten_write
   
@@ -98,13 +99,6 @@ describe 'properties' do
     ]
     it_should_persist something_very_complex
   end
-
-  it "should persist a Time object" do
-    w = Watch.new :time => Time.now
-    CouchPotato.database.save_document! w
-    w = CouchPotato.database.load_document w.id
-    w.time.year.should == Time.now.year
-  end
   
   it "should persist an object" do
     p = Person.new
@@ -142,6 +136,68 @@ describe 'properties' do
     p.ship_address.should be_false
   end
   
+  describe "time properties" do
+    it "should persist a Time as utc" do
+      time = Time.now
+      w = Watch.new :time => time
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.time.to_s.should == time.utc.to_s
+    end
+    
+    it "should parse a string and persist it as time" do
+      w = Watch.new :time => '2009-01-01 13:25 UTC'
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.time.should be_a(Time)
+    end
+    
+    it "should store nil" do
+      w = Watch.new :time => nil
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.time.should be_nil
+    end
+    
+    it "should store an empty string as nil" do
+      w = Watch.new :time => ''
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.time.should be_nil
+    end
+  end
+  
+  describe "date properties" do
+    it "should persist a date" do
+      date = Date.today
+      w = Watch.new :date => date
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.date.should == date
+    end
+    
+    it "should parse a string and persist it as a date" do
+      w = Watch.new :date => '2009-01-10'
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.date.should == Date.parse('2009-01-10')
+    end
+    
+    it "should store nil" do
+      w = Watch.new :date => nil
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.date.should be_nil
+    end
+    
+    it "should store an empty string as nil" do
+      w = Watch.new :date => ''
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.date.should be_nil
+    end
+  end
+  
   describe "boolean properties" do
     it "should persist '0' for false" do
       a = Address.new

data/spec/spec_helper.rb

@@ -5,7 +5,13 @@ $:.unshift(File.dirname(__FILE__) + '/../lib')
 
 require 'couch_potato'
 
-CouchPotato::Config.database_name = 'couch_potato_test'
+if ENV["RUN_CODE_RUN"]
+  CouchPotato::Config.database_name = 'http://langalex.couch.io/couch_potato_test'
+else
+  CouchPotato::Config.database_name = 'couch_potato_test'
+end
+
+
 CouchPotato::Config.validation_framework = ENV['VALIDATION_FRAMEWORK'].to_sym unless ENV['VALIDATION_FRAMEWORK'].blank?
 
 # silence deprecation warnings from ActiveModel as the Spec uses Errors#on

data/spec/unit/view_query_spec.rb

@@ -2,8 +2,20 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 describe CouchPotato::View::ViewQuery, 'query_view' do
   it "should not pass a key if conditions are empty" do
-    db = mock 'db'
+    db = mock 'db', :get => nil, :save_doc => nil
     db.should_receive(:view).with(anything, {})
     CouchPotato::View::ViewQuery.new(db, '', '', '', '').query_view!
   end
+  
+  it "should not update a view when the functions haven't changed" do
+    db = mock 'db', :get => {'views' => {'view' => {'map' => 'map', 'reduce' => 'reduce'}}}, :view => nil
+    db.should_not_receive(:save_doc)
+    CouchPotato::View::ViewQuery.new(db, 'design', 'view', 'map', 'reduce').query_view!
+  end
+  
+  it "should update a view when the functions have changed" do
+    db = mock 'db', :get => {'views' => {'view2' => {'map' => 'map', 'reduce' => 'reduce'}}}, :view => nil
+    db.should_receive(:save_doc)
+    CouchPotato::View::ViewQuery.new(db, 'design', 'view2', 'mapnew', 'reduce').query_view!
+  end
 end

data/spec/view_updates_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "automatic view updates" do
+  before(:each) do
+    recreate_db
+    @db = CouchPotato.couchrest_database
+  end
+  
+  it "should update a view that doesn't match the given functions" do
+    CouchPotato::View::ViewQuery.new(@db, 'test_design1', 'test_view', 'function(doc) {}', 'function() {}').query_view! # create view
+    CouchPotato::View::ViewQuery.new(@db, 'test_design1', 'test_view', 'function(doc) {emit(doc.id, null)}', 'function(key, values) {return sum(values)}').query_view!
+    CouchPotato.database.load('_design/test_design1')['views']['test_view'].should == {
+      'map' => 'function(doc) {emit(doc.id, null)}',
+      'reduce' => 'function(key, values) {return sum(values)}'
+    }
+  end
+  
+  it "should only update a view once to avoid writing the view for every request" do
+    CouchPotato::View::ViewQuery.new(@db, 'test_design2', 'test_view', 'function(doc) {}', 'function() {}').query_view! # create view
+    CouchPotato::View::ViewQuery.new(@db, 'test_design2', 'test_view', 'function(doc) {emit(doc.id, null)}', 'function(key, values) {return sum(values)}').query_view!
+    CouchPotato::View::ViewQuery.new(@db, 'test_design2', 'test_view', 'function(doc) {}', 'function() {}').query_view!
+    CouchPotato.database.load('_design/test_design2')['views']['test_view'].should == {
+      'map' => 'function(doc) {emit(doc.id, null)}',
+      'reduce' => 'function(key, values) {return sum(values)}'
+    }
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: couch_potato
 version: !ruby/object:Gem::Version 
-  version: 0.2.24
+  version: 0.2.25
 platform: ruby
 authors: 
 - Alexander Lang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-05 00:00:00 +01:00
+date: 2010-02-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,6 +74,7 @@ files:
 - lib/couch_potato/persistence/properties.rb
 - lib/couch_potato/persistence/simple_property.rb
 - lib/couch_potato/persistence/type_caster.rb
+- lib/couch_potato/railtie.rb
 - lib/couch_potato/rspec/matchers.rb
 - lib/couch_potato/rspec/matchers/map_to_matcher.rb
 - lib/couch_potato/rspec/matchers/print_r.js
@@ -118,6 +119,7 @@ files:
 - spec/unit/validation_spec.rb
 - spec/unit/view_query_spec.rb
 - spec/update_spec.rb
+- spec/view_updates_spec.rb
 has_rdoc: true
 homepage: http://github.com/langalex/couch_potato
 licenses: []
@@ -174,3 +176,4 @@ test_files:
 - spec/unit/validation_spec.rb
 - spec/unit/view_query_spec.rb
 - spec/update_spec.rb
+- spec/view_updates_spec.rb