couch_potato 0.3.0 → 0.3.1

data/README.md

@@ -18,6 +18,13 @@ Lastly Couch Potato aims to provide a seamless integration with Ruby on Rails, e
 * declarative views with either custom or generated map/reduce functions
 * extensive spec suite
 
+### Supported Environments
+
+* Ruby 1.8.7, 1.9.1, 1.9.2
+* CouchDB 1.0.1
+
+(Supported means I run the specs against those before releasing a new gem.)
+
 ### Installation
 
 Couch Potato is hosted as a gem which you can install like this:
@@ -54,9 +61,19 @@ Add to your config/environment.rb:
 
 Then create a config/couchdb.yml:
 
-    development: development_db_name
-    test: test_db_name
-    production: http://db.server/production_db_name
+    default: &default
+      validation_framework: :active_model #optional
+
+    development:
+      <<: *default
+      database: development_db_name
+    test:
+      <<: *default
+      database: test_db_name
+    production:
+      <<: *default
+      database: <%= ENV['DB_NAME'] %>
+
 
 Alternatively you can also install Couch Potato directly as a plugin.
 

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:major: 0
 :minor: 3
-:patch: 0
+:patch: 1
 :build: 
+:major: 0

data/lib/core_ext/string.rb

@@ -4,5 +4,9 @@ module ActiveSupportMethods
       $1.upcase
     end
   end
+
+  def blank?
+    empty?
+  end
 end
-String.send :include, ActiveSupportMethods unless String.new.respond_to?(:underscore)
+String.send :include, ActiveSupportMethods unless String.new.respond_to?(:underscore)

data/lib/couch_potato/database.rb

@@ -79,10 +79,10 @@ module CouchPotato
     alias_method :save!, :save_document!
 
     def destroy_document(document)
-      document.run_callbacks :before_destroy
-      document._deleted = true
-      database.delete_doc document.to_hash
-      document.run_callbacks :after_destroy
+      document.run_callbacks :destroy do
+        document._deleted = true
+        database.delete_doc document.to_hash
+      end
       document._id = nil
       document._rev = nil
     end
@@ -102,7 +102,7 @@ module CouchPotato
     alias_method :load, :load_document
 
     def inspect #:nodoc:
-      "#<CouchPotato::Database>"
+      "#<CouchPotato::Database @root=\"#{database.root}\">"
     end
 
     private
@@ -112,35 +112,39 @@ module CouchPotato
       
       if validate
         document.errors.clear
-        document.run_callbacks :before_validation_on_save
-        document.run_callbacks :before_validation_on_create
-        return false unless valid_document?(document)
+        document.run_callbacks :validation_on_save do
+          document.run_callbacks :validation_on_create do
+            return false unless valid_document?(document)
+          end
+        end
       end
       
-      document.run_callbacks :before_save
-      document.run_callbacks :before_create
-      res = database.save_doc document.to_hash
-      document._rev = res['rev']
-      document._id = res['id']
-      document.run_callbacks :after_save
-      document.run_callbacks :after_create
+      document.run_callbacks :save do
+        document.run_callbacks :create do
+          res = database.save_doc document.to_hash
+          document._rev = res['rev']
+          document._id = res['id']
+        end
+      end
       true
     end
 
     def update_document(document, validate)
       if validate
         document.errors.clear
-        document.run_callbacks :before_validation_on_save
-        document.run_callbacks :before_validation_on_update
-        return false unless valid_document?(document)
+        document.run_callbacks :validation_on_save do
+          document.run_callbacks :validation_on_update do
+            return false unless valid_document?(document)
+          end
+        end
+      end
+
+      document.run_callbacks :save do
+        document.run_callbacks :update do
+          res = database.save_doc document.to_hash
+          document._rev = res['rev']
+        end
       end
-      
-      document.run_callbacks :before_save
-      document.run_callbacks :before_update
-      res = database.save_doc document.to_hash
-      document._rev = res['rev']
-      document.run_callbacks :after_save
-      document.run_callbacks :after_update
       true
     end
 
@@ -158,4 +162,4 @@ module CouchPotato
     end
 
   end
-end
+end

data/lib/couch_potato/persistence/callbacks.rb

@@ -1,62 +1,29 @@
+require 'active_support/concern'
+require 'active_model/callbacks'
+
 module CouchPotato
   module Persistence
     module Callbacks
       def self.included(base) #:nodoc:
-        base.extend ClassMethods
+        base.extend ActiveModel::Callbacks
 
         base.class_eval do
           attr_accessor :skip_callbacks
-          def self.callbacks #:nodoc:
-            @callbacks ||= {:before_validation => [], :before_validation_on_create => [], 
-              :before_validation_on_update => [], :before_validation_on_save => [], :before_create => [], 
-              :after_create => [], :before_update => [], :after_update => [],
-              :before_save => [], :after_save => [],
-              :before_destroy => [], :after_destroy => []}
-          end
+
+          define_model_callbacks :create, :save, :update, :destroy
+          define_model_callbacks *[:save, :create, :update].map {|c| :"validation_on_#{c}"}
+          define_model_callbacks :validation unless Config.validation_framework == :active_model
         end
       end
 
       # Runs all callbacks on a model with the given name, e.g. :after_create.
       # 
       # This method is called by the CouchPotato::Database object when saving/destroying an object 
-      def run_callbacks(name)
+      def run_callbacks(name, &block)
         return if skip_callbacks
-        
-        callbacks = self.class.ancestors.map do |clazz|
-          clazz.callbacks[name] if clazz.respond_to?(:callbacks)
-        end.flatten.compact.uniq
-        
-        callbacks.each do |callback|
-          if [Symbol, String].include?(callback.class)
-            send callback
-          elsif callback.is_a?(Proc)
-            callback.call self
-          else
-            raise "Don't know how to handle callback of type #{callback.class.name}"
-          end
-        end
-      end
 
-      module ClassMethods
-        [
-          :before_validation,
-          :before_validation_on_create,
-          :before_validation_on_update,
-          :before_validation_on_save,
-          :before_create,
-          :before_save,
-          :before_update,
-          :before_destroy,
-          :after_update,
-          :after_save,
-          :after_create,
-          :after_destroy
-        ].each do |callback|
-          define_method callback do |*names|
-            callbacks[callback].push *names
-          end
-        end
+        send(:"_run_#{name}_callbacks", &block)
       end
     end
   end
-end
+end

data/lib/couch_potato/persistence/dirty_attributes.rb

@@ -6,14 +6,14 @@ module CouchPotato
       def self.included(base) #:nodoc:
         base.class_eval do
           after_save :reset_dirty_attributes
-          
-          def initialize(attributes = {})
-            super
-            assign_attribute_copies_for_dirty_tracking
-          end
         end
       end
       
+      def initialize(attributes = {})
+        super
+        assign_attribute_copies_for_dirty_tracking
+      end
+    
       # returns true if a model has dirty attributes, i.e. their value has changed since the last save
       def dirty? 
         new? || @forced_dirty || self.class.properties.inject(false) do |res, property|

data/lib/couch_potato/persistence/ghost_attributes.rb

@@ -8,15 +8,16 @@ module CouchPotato
           instance._document = json if json
           instance
         end
-        
-        def method_missing(name, *args)
-          if(value = _document && _document[name.to_s])
-            value
-          else
-            super
-          end
-        end
       end
     end
+    
+    def method_missing(name, *args)
+      if(value = _document && _document[name.to_s])
+        value
+      else
+        super
+      end
+    end
+    
   end
 end

data/lib/couch_potato/persistence/type_caster.rb

@@ -3,15 +3,15 @@ module CouchPotato
     class TypeCaster #:nodoc:
       def cast(value, type)
         if type == :boolean
-          cast_boolen(value)
+          cast_boolean(value)
         else
           cast_native(value, type)
         end
       end
-      
+
       private
-      
-      def cast_boolen(value)
+
+      def cast_boolean(value)
         if [FalseClass, TrueClass].include?(value.class) || value.nil?
           value
         elsif [0, '0'].include?(value)
@@ -20,7 +20,7 @@ module CouchPotato
           true
         end
       end
-      
+
       def cast_native(value, type)
         if type && !value.instance_of?(type)
           if type == Fixnum
@@ -34,7 +34,7 @@ module CouchPotato
           value
         end
       end
-      
+
     end
   end
-end
+end

data/lib/couch_potato/persistence.rb

@@ -18,9 +18,10 @@ module CouchPotato
   module Persistence
     
     def self.included(base) #:nodoc:
-      base.send :include, Properties, Callbacks, Validation, Json, CouchPotato::View::CustomViews, CouchPotato::View::Lists
+      base.send :include, Properties, Callbacks, Json, CouchPotato::View::CustomViews, CouchPotato::View::Lists
       base.send :include, DirtyAttributes, GhostAttributes, Attachments
       base.send :include, MagicTimestamps, ActiveModelCompliance
+      base.send :include, Validation
       base.class_eval do
         attr_accessor :_id, :_rev, :_deleted, :database
         alias_method :id, :_id

data/lib/couch_potato/railtie.rb

@@ -1,19 +1,24 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../rails/reload_classes')
+require 'erb'
 
 module CouchPotato
-
   def self.rails_init
-    CouchPotato::Config.database_name = YAML::load(File.read(Rails.root.join('config/couchdb.yml')))[Rails.env]
+    config = YAML::load(ERB.new(File.read(Rails.root.join('config/couchdb.yml'))).result)[RAILS_ENV]
+    if config.is_a?(String)
+      CouchPotato::Config.database_name = config
+    else
+      CouchPotato::Config.database_name = config['database']
+      CouchPotato::Config.validation_framework = config['validation_framework']
+    end
   end
 
   if defined?(::Rails::Railtie)
     class Railtie < ::Rails::Railtie
-      config.after_initialize do |app|
+      initializer 'couch_potato.load_config' do |app|
         CouchPotato.rails_init
       end
     end
   else
     rails_init
   end
-
 end

data/lib/couch_potato/validation/with_validatable.rb

@@ -11,16 +11,20 @@ module CouchPotato
         base.send :include, ::Validatable
         base.class_eval do
           # Override the validate method to first run before_validation callback
-          def valid?
+          def valid_with_before_validation_callback?
             errors.clear
-            run_callbacks :before_validation
-            before_validation_errors = errors.errors.dup
-            super
-            before_validation_errors.each do |k, v|
-              v.each {|message| errors.add(k, message)}
+            run_callbacks :validation do
+              before_validation_errors = errors.errors.dup
+              valid_without_before_validation_callback?
+              before_validation_errors.each do |k, v|
+                v.each {|message| errors.add(k, message)}
+              end
             end
             errors.empty?
           end
+          
+          alias_method :valid_without_before_validation_callback?, :valid?
+          alias_method :valid?, :valid_with_before_validation_callback?
         end
       end
     end

data/lib/couch_potato/view/model_view_spec.rb

@@ -35,7 +35,7 @@ module CouchPotato
         if count?
           results['rows'].first.try(:[], 'value') || 0
         else
-          results['rows'].map { |row| row['doc'] }
+          results['rows'].map { |row| row['doc'] || row['id'] }
         end
       end
       

data/spec/callbacks_spec.rb

@@ -22,9 +22,6 @@ class CallbackRecorder
   
   view :all, :key  => :required_property
   
-  attr_accessor :lambda_works
-  before_create lambda {|model| model.lambda_works = true }
-  
   def callbacks
     @callbacks ||= []
   end
@@ -58,7 +55,7 @@ describe "multiple callbacks at once" do
   
   it "should run all callback methods given to the callback method call" do
     monkey = Monkey.new
-    monkey.run_callbacks :before_create
+    monkey.run_callbacks :create
     monkey.eaten_banana.should be_true
     monkey.eaten_apple.should be_true
   end
@@ -263,14 +260,6 @@ describe "destroy callbacks" do
   end
 end
 
-describe "lambda callbacks" do
-  it "should run the lambda" do
-    recorder = CallbackRecorder.new
-    recorder.run_callbacks :before_create
-    recorder.lambda_works.should be_true
-  end
-end
-
 describe "validation callbacks" do
   class ValidatedUser
     include CouchPotato::Persistence
@@ -305,4 +294,4 @@ describe "validation callbacks" do
     user.valid?.should == true
     user.errors.on(:name).should == nil
   end
-end
+end

data/spec/custom_view_spec.rb

@@ -33,6 +33,13 @@ describe 'view' do
     results = @db.view(Build.timeline)
     results.map(&:class).should == [Build]
   end
+  
+  it "should return the ids if there document was not included" do
+    build = Build.new(:state => 'success', :time => '2008-01-01')
+    @db.save_document build
+    results = @db.view(Build.timeline(:include_docs => false))
+    results.should == [build.id]
+  end
 
   it "should pass the view options to the view query" do
     query = mock 'query'

data/spec/property_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
-require File.join(File.dirname(__FILE__), 'fixtures', 'address')
-require File.join(File.dirname(__FILE__), 'fixtures', 'person')
+require 'fixtures/address'
+require 'fixtures/person'
 
 class Watch
   include CouchPotato::Persistence

data/spec/rails_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require File.dirname(__FILE__) + '/../rails/reload_classes'
 
 module LoadConst
   def const_missing(name)

data/spec/railtie_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'yaml'
+require 'spec/mocks'
+
+RAILS_ENV = 'test'
+module Rails
+  class Railtie
+    def self.initializer(*args)
+    end
+  end
+  
+  def self.root
+    Spec::Mocks::Mock.new :join => ''
+  end
+end
+
+require 'couch_potato/railtie'
+
+describe "railtie" do
+  context 'yaml file contains only database names' do
+    it "should set the database name from the yaml file" do
+      File.stub(:read => "test: test_db")
+      
+      CouchPotato::Config.should_receive(:database_name=).with('test_db')
+      
+      CouchPotato.rails_init
+    end
+  end
+  
+  context 'yaml file contains more configuration' do
+    before(:each) do
+      File.stub(:read => "test: \n  database: test_db\n  validation_framework: :active_model")
+    end
+    
+    it "should set the database name from the yaml file" do
+      CouchPotato::Config.should_receive(:database_name=).with('test_db')
+      
+      CouchPotato.rails_init
+    end
+    
+    it "should set the validation framework from the yaml file" do
+      CouchPotato::Config.should_receive(:validation_framework=).with(:active_model)
+      
+      CouchPotato.rails_init
+    end
+  end
+  
+  it "should process the yml file with erb" do
+    File.stub(:read => "test: \n  database: <%= 'db' %>")
+
+    CouchPotato::Config.should_receive(:database_name=).with('db')
+    
+    CouchPotato.rails_init
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'spec'
+require 'time'
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 

data/spec/unit/callbacks_spec.rb

@@ -4,23 +4,15 @@ describe 'callbacks' do
   class Tree
     include CouchPotato::Persistence
 
-    before_validation :grow_leaf, 'grow_branch', lambda {|tree| tree.root_count ||= 0; tree.root_count += 1 }
+    before_validation :grow_leaf
 
     property :leaf_count
-    property :root_count
-    property :branch_count
     property :watered
-    
 
     def grow_leaf
       self.leaf_count ||= 0
       self.leaf_count += 1
     end
-    
-    def grow_branch
-      self.branch_count ||= 0
-      self.branch_count += 1
-    end
   end
   
   class AppleTree < Tree
@@ -37,31 +29,13 @@ describe 'callbacks' do
     end
   end
 
-  it "should call a method from a symbol when validated" do
-    tree = Tree.new(:leaf_count => 1, :root_count => 1)
-    tree.valid?
-    tree.leaf_count.should == 2
-  end
-  
-  it "should call a method from a string when validated" do
-    tree = Tree.new(:branch_count => 0)
-    tree.valid?
-    tree.branch_count.should == 1
-  end
-
-  it "should call a lambda when validated" do
-    tree = Tree.new(:leaf_count => 1, :root_count => 1)
-    tree.valid?
-    tree.root_count.should == 2
-  end
-  
   context 'inheritance' do
     it "should call the callbacks of the super class" do
       tree = AppleTree.new :leaf_count => 1
       tree.valid?
       tree.leaf_count.should == 2
     end
-    
+
     it "should call the callbacks of the child class" do
       tree = AppleTree.new :leaf_count => 1
       tree.valid?
@@ -69,4 +43,4 @@ describe 'callbacks' do
     end
   end
   
-end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: couch_potato
 version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Alexander Lang
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-23 00:00:00 +02:00
+date: 2010-09-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,15 +36,32 @@ dependencies:
   name: couchrest
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 21
         segments: 
+        - 1
         - 0
-        - 24
-        version: "0.24"
+        - 1
+        version: 1.0.1
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 description: Ruby persistence layer for CouchDB
 email: alex@upstream-berlin.com
 executables: []
@@ -106,6 +126,7 @@ files:
 - spec/fixtures/person.rb
 - spec/property_spec.rb
 - spec/rails_spec.rb
+- spec/railtie_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/unit/active_model_compliance_spec.rb
@@ -140,23 +161,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   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: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby persistence layer for CouchDB
@@ -171,6 +196,7 @@ test_files:
 - spec/fixtures/person.rb
 - spec/property_spec.rb
 - spec/rails_spec.rb
+- spec/railtie_spec.rb
 - spec/spec_helper.rb
 - spec/unit/active_model_compliance_spec.rb
 - spec/unit/attributes_spec.rb