couch_potato 0.3.2 → 0.4.0

data/CHANGES.md

@@ -1,5 +1,21 @@
 ## Changes
 
+### 0.4.0
+* ruby 1.9.2 compatibility (langalex)
+* couch potato objects now behave correctly when used as keys in Hashes (langalex)
+* use as\_json instead of to\_s(:json), which is the rails way
+* use ActiveModel dirty tracking (langalex) - this means no more "deep tracking", e.g. `user.tags << 'new_tag'; user.dirty? # false`
+
+### 0.3.2
+* support yielding to blocks on #initialize (martinrehfeld)
+* support for negative numbers in Fixnum/Float properties (langalex)
+
+### 0.3.1
+* ActiveModel callbacks (kazjote)
+* do not use Rails.env in initializer as it will free Rails.env for all times and in Rails 2.3.x apps it will be called too early thus always beeing development (jweiss)
+* ruby 1.9.2 compatibility (langalex)
+* can configure validation framework in couchdb.yml, process couchdb.yml with erb (langalex)
+
 ### 0.3.0
 * support for lists (langalex)
 

data/README.md

@@ -74,8 +74,7 @@ Then create a config/couchdb.yml:
       <<: *default
       database: <%= ENV['DB_NAME'] %>
 
-
-Alternatively you can also install Couch Potato directly as a plugin.
+Note: please make sure that when you run `Date.today.as_json` in the Rails console it returns something like `2010/12/10` and not `2010-12-10` - if it does another gem has overwritten Couch Potato's Date patches - in this case move Couch Potato further down in your Gemfile or whereever you load it.
 
 ### Introduction
 

data/VERSION.yml

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

data/lib/core_ext/date.rb

@@ -1,18 +1,11 @@
 class Date
   def to_json(*a)
-    %("#{to_s(:json)}")
+    %("#{as_json}")
   end
   
-  def to_s_with_json(*args)
-    if args[0] == :json
-      strftime("%Y/%m/%d")
-    else
-      to_s_without_json *args
-    end
+  def as_json(*args)
+    strftime("%Y/%m/%d")
   end
-  alias_method :to_s_without_json, :to_s
-  alias_method :to_s, :to_s_with_json
-  
   
   def self.json_create string
     return nil if string.nil?

data/lib/core_ext/time.rb

@@ -1,17 +1,11 @@
 class Time
   def to_json(*a)
-    %("#{to_s(:json)}")
+    %("#{as_json}")
   end
   
-  def to_s_with_json(*args)
-    if args[0] == :json
-      getutc.strftime("%Y/%m/%d %H:%M:%S +0000")
-    else
-      to_s_without_json *args
-    end
+  def as_json(*args)
+    getutc.strftime("%Y/%m/%d %H:%M:%S +0000")
   end
-  alias_method :to_s_without_json, :to_s
-  alias_method :to_s, :to_s_with_json
   
   def self.json_create string
     return nil if string.nil?

data/lib/couch_potato/database.rb

@@ -63,7 +63,7 @@ module CouchPotato
 
     # saves a document. returns true on success, false on failure
     def save_document(document, validate = true)
-      return true unless document.dirty?
+      return true unless document.dirty? || document.new?
       if document.new?
         create_document(document, validate)
       else

data/lib/couch_potato/persistence.rb

@@ -30,7 +30,8 @@ module CouchPotato
     end
 
     # initialize a new instance of the model optionally passing it a hash of attributes.
-    # the attributes have to be declared using the #property method
+    # the attributes have to be declared using the #property method.
+    # the new model will be yielded to an optionally given block.
     # 
     # example: 
     #   class Book
@@ -38,11 +39,20 @@ module CouchPotato
     #     property :title
     #   end
     #   book = Book.new :title => 'Time to Relax'
+    #
+    #   OR
+    #
+    #   book = Book.new do |b|
+    #     b.title = 'Time to Relax'
+    #   end
     #   book.title # => 'Time to Relax'
     def initialize(attributes = {})
-      attributes.each do |name, value|
-        self.send("#{name}=", value)
-      end if attributes
+      if attributes
+        attributes.each do |name, value|
+          self.send("#{name}=", value)
+        end
+      end
+      yield self if block_given?
     end
     
     # assign multiple attributes at once.
@@ -97,6 +107,14 @@ module CouchPotato
     def ==(other) #:nodoc:
       other.class == self.class && self.to_json == other.to_json
     end
+    
+    def eql?(other)
+      self == other
+    end
+    
+    def hash
+      _id.hash * (_id.hash.to_s.size ** 10) + _rev.hash
+    end
    
     def inspect
       attributes_as_string = attributes.map {|attribute, value| "#{attribute}: #{value.inspect}"}.join(", ")

data/lib/couch_potato/persistence/dirty_attributes.rb

@@ -4,6 +4,7 @@ module CouchPotato
     module DirtyAttributes
       
       def self.included(base) #:nodoc:
+        base.send :include, ActiveModel::Dirty
         base.class_eval do
           after_save :reset_dirty_attributes
         end
@@ -11,14 +12,12 @@ module CouchPotato
       
       def initialize(attributes = {})
         super
-        assign_attribute_copies_for_dirty_tracking
+        # 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|
-          res || property.dirty?(self)
-        end
+        changed? || @forced_dirty
       end
       
       # marks a model as dirty
@@ -26,19 +25,21 @@ module CouchPotato
         @forced_dirty = true
       end
       
-      private
-      
-      def assign_attribute_copies_for_dirty_tracking
-        attributes.each do |name, value|
-          self.instance_variable_set("@#{name}_was", clone_attribute(value))
-        end if attributes
+      def method_missing(name, *args)
+        if(name.to_s.include?('_will_change!'))
+          self.class.define_attribute_methods self.class.property_names
+          send(name, *args)
+        else
+          super
+        end
       end
       
+      private
+      
       def reset_dirty_attributes
+        @previously_changed = changes
+        @changed_attributes.clear
         @forced_dirty = nil
-        self.class.properties.each do |property|
-          instance_variable_set("@#{property.name}_was", clone_attribute(send(property.name)))
-        end
       end
       
       def clone_attribute(value)

data/lib/couch_potato/persistence/ghost_attributes.rb

@@ -3,11 +3,15 @@ module CouchPotato
     def self.included(base)
       base.class_eval do
         attr_accessor :_document
-        def self.json_create(json)
-          instance = super
+        def self.json_create_with_ghost(json)
+          instance = json_create_without_ghost(json)
           instance._document = json if json
           instance
         end
+        
+        class << self
+          alias_method_chain :json_create, :ghost
+        end
       end
     end
     
@@ -18,6 +22,6 @@ module CouchPotato
         super
       end
     end
-    
   end
-end
+end
+

data/lib/couch_potato/persistence/json.rb

@@ -35,9 +35,12 @@ module CouchPotato
           instance = self.new
           instance._id = json[:_id] || json['_id']
           instance._rev = json[:_rev] || json['_rev']
+          instance.instance_variable_set('@skip_dirty_tracking', true)
           properties.each do |property|
             property.build(instance, json)
           end
+          instance.instance_variable_set('@skip_dirty_tracking', false)
+          # instance.instance_variable_get("@changed_attributes").clear if instance.instance_variable_get("@changed_attributes")
           instance
         end
       end

data/lib/couch_potato/persistence/magic_timestamps.rb

@@ -7,13 +7,14 @@ module CouchPotato
         
         before_create lambda {|model|
           model.created_at ||= Time.now
-          model.created_at_not_changed
+          @changed_attributes.delete 'created_at'
           model.updated_at ||= Time.now
-          model.updated_at_not_changed
+          @changed_attributes.delete 'updated_at'
         }
         before_update lambda {|model|
           model.updated_at = Time.now
-          model.updated_at_not_changed}
+          @changed_attributes.delete 'updated_at'
+        }
       end
     end
   end

data/lib/couch_potato/persistence/properties.rb

@@ -59,13 +59,6 @@ module CouchPotato
           properties.map(&:name)
         end
 
-        def json_create(json) #:nodoc:
-          return if json.nil?
-          instance = super
-          instance.send(:assign_attribute_copies_for_dirty_tracking)
-          instance
-        end
-
         # 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.

data/lib/couch_potato/persistence/simple_property.rb

@@ -37,8 +37,6 @@ module CouchPotato
       
       def define_accessors(base, name, options)
         base.class_eval do
-          attr_reader "#{name}_was"
-
           define_method "#{name}" do
             value = self.instance_variable_get("@#{name}")
             if value.nil? && options[:default]
@@ -51,20 +49,14 @@ module CouchPotato
           end
           
           define_method "#{name}=" do |value|
-            self.instance_variable_set("@#{name}", type_caster.cast(value, options[:type]))
+            typecasted_value = type_caster.cast(value, options[:type])
+            send("#{name}_will_change!") unless @skip_dirty_tracking || typecasted_value == send(name)
+            self.instance_variable_set("@#{name}", typecasted_value)
           end
           
           define_method "#{name}?" do
             !self.send(name).nil? && !self.send(name).try(:blank?)
           end
-          
-          define_method "#{name}_changed?" do
-            !self.instance_variable_get("@#{name}_not_changed") && self.send(name) != self.send("#{name}_was")
-          end
-          
-          define_method "#{name}_not_changed" do
-            self.instance_variable_set("@#{name}_not_changed", true)
-          end
         end
       end
     end

data/rails/reload_classes.rb

@@ -7,7 +7,7 @@ module CouchPotato
       begin
         yield
       rescue ArgumentError => e
-        if(name = e.message.scan(/(can't find const|undefined class\/module) ([\w\:]+)/).first[1])
+        if(name = e.message.scan(/(can't find const|undefined class\/module) ([\w\:]+)/).try(:first).try(:[], 1))
           eval name.gsub(/\:+$/, '')
           retry
         else

data/spec/rails_spec.rb

@@ -32,7 +32,7 @@ describe CouchPotato::Database, 'rails specific behavior' do
       CouchPotato.couchrest_database.save_doc(JSON.create_id => 'Autoloader::Uninitialized', '_id' => '1')
       CouchPotato.database.load('1').class.name.should == 'Autoloader::Uninitialized'
     end
-  
+    
     it "should load nested models" do
       CouchPotato.couchrest_database.save_doc(JSON.create_id => 'Autoloader::Nested::Nested2', '_id' => '1')
       CouchPotato.database.load('1').class.name.should == 'Autoloader::Nested::Nested2'

data/spec/railtie_spec.rb

@@ -17,6 +17,14 @@ end
 require 'couch_potato/railtie'
 
 describe "railtie" do
+  before(:all) do
+    @validation_framework = CouchPotato::Config.validation_framework
+  end
+  
+  after(:all) do
+    CouchPotato::Config.validation_framework = @validation_framework
+  end
+  
   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")

data/spec/unit/database_spec.rb

@@ -119,10 +119,10 @@ describe CouchPotato::Database, 'save_document' do
     it "should not run the validations when saved with false" do
       category = Category.new(:name => 'food')
       @db.save_document(category)
-      category.new?.should == false
+      category.new?.should be_false
       category.name = nil
       @db.save_document(category, false)
-      category.dirty?.should == false
+      category.dirty?.should be_false
     end
 
     it "should run the validations when saved with true" do

data/spec/unit/date_spec.rb

@@ -7,10 +7,10 @@ describe Date, 'to_json' do
   end
 end
 
-describe Date, 'to_s(:json)' do
+describe Date, 'as_json' do
   it "should format it in the same way as to_json does so i can use this to do queries over date attributes" do
     date = Date.parse('2009-01-01')
-    date.to_s(:json).should == "2009/01/01"
+    date.as_json.should == "2009/01/01"
   end
 end
 

data/spec/unit/dirty_attributes_spec.rb

@@ -33,24 +33,6 @@ describe 'dirty attribute tracking' do
       @couchrest_db.should_receive(:save_doc)
       @db.save_document(plate)
     end
-
-    it "should correctly track dirty hashes (deep clone)" do
-      plate = Plate.new :food => {:veggies => ['carrots', 'peas']}
-      @db.save_document(plate)
-      plate.food[:veggies] << 'beans'
-      @couchrest_db.should_receive(:save_doc)
-      @db.save_document(plate)
-    end
-
-    it "should correctly track dirty hashes (deep clone) after a save" do
-      plate = Plate.new :food => {:veggies => ['carrots', 'peas']}
-      @db.save_document(plate)
-      plate.food[:veggies] << 'beans'
-      @db.save_document(plate)
-      plate.food[:veggies] << 'cauliflower'
-      @couchrest_db.should_receive(:save_doc)
-      @db.save_document(plate)
-    end
   end
   
   describe "newly created object" do
@@ -67,21 +49,22 @@ describe 'dirty attribute tracking' do
       
       describe "with type BigDecimal" do
         before(:each) do
-          class ::Plate
+          class Bowl
+            include CouchPotato::Persistence
             property :price
           end
         end
         it "should not dup BigDecimal" do
 
           lambda {
-            Plate.new :price => BigDecimal.new("5.23") 
+            Bowl.new :price => BigDecimal.new("5.23") 
           }.should_not raise_error(TypeError)
         end
         
         it "should return the old value" do
-          plate = Plate.new :price => BigDecimal.new("5.23") 
-          plate.price = BigDecimal.new("2.23")
-          plate.price_was.should == 5.23
+          bowl = Bowl.new :price => BigDecimal.new("5.23") 
+          bowl.price = BigDecimal.new("2.23")
+          bowl.price_was.should == 5.23
         end
         
       end
@@ -94,13 +77,7 @@ describe 'dirty attribute tracking' do
       end
 
       it "should return false if attribute not changed" do
-        @plate.should_not be_food_changed
-      end
-      
-      it "should return false if attribute forced not changed" do
-        @plate.food = 'burger'
-        @plate.food_not_changed
-        @plate.should_not be_food_changed
+        Plate.new.should_not be_food_changed
       end
       
       it "should return true if forced dirty" do
@@ -128,13 +105,6 @@ describe 'dirty attribute tracking' do
         @plate.food = 'burger'
         @plate.should be_food_changed
       end
-      
-      it "should return true if array attribute changed" do
-        couchrest_db = stub('database', :get => Plate.json_create({'_id' => '1', '_rev' => '2', 'food' => ['sushi'], JSON.create_id => 'Plate'}), :info => nil)
-        plate = CouchPotato::Database.new(couchrest_db).load_document '1'
-        plate.food << 'burger'
-        plate.should be_food_changed
-      end
 
       it "should return false if attribute not changed" do
         @plate.should_not be_food_changed

data/spec/unit/initialize_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+class Document
+  include CouchPotato::Persistence
+  
+  property :title
+  property :content
+end
+
+describe "new" do
+  context "without arguments" do
+    subject { Document.new }
+
+    it { should be_a(Document) }
+    its(:title) { should be_nil }
+    its(:content) { should be_nil }
+  end
+
+  context "with an argument hash" do
+    subject { Document.new(:title => 'My Title') }
+
+    it { should be_a(Document) }
+    its(:title) { should == 'My Title'}
+    its(:content) { should be_nil }
+  end
+
+  context "yielding to a block" do
+    subject {
+      Document.new(:title => 'My Title') do |doc|
+        doc.content = 'My Content'
+      end
+    }
+
+    it { should be_a(Document) }
+    its(:title) { should == 'My Title'}
+    its(:content) { should == 'My Content'}
+  end
+end

data/spec/unit/time_spec.rb

@@ -7,10 +7,10 @@ describe Time, 'to_json' do
   end
 end
 
-describe Time, 'to_s(:json)' do
+describe Time, 'as_json' do
   it "should format it in the same way as to_json does so i can use this to do queries over time attributes" do
     time = Time.parse('2009-01-01 11:12:23 +0200')
-    time.to_s(:json).should == "2009/01/01 09:12:23 +0000"
+    time.as_json.should == "2009/01/01 09:12:23 +0000"
   end
 end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Alexander Lang
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-03 00:00:00 +01:00
+date: 2010-12-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -135,6 +135,7 @@ files:
 - spec/unit/database_spec.rb
 - spec/unit/date_spec.rb
 - spec/unit/dirty_attributes_spec.rb
+- spec/unit/initialize_spec.rb
 - spec/unit/json_create_id_spec.rb
 - spec/unit/lists_spec.rb
 - spec/unit/model_view_spec_spec.rb
@@ -202,6 +203,7 @@ test_files:
 - spec/unit/database_spec.rb
 - spec/unit/date_spec.rb
 - spec/unit/dirty_attributes_spec.rb
+- spec/unit/initialize_spec.rb
 - spec/unit/json_create_id_spec.rb
 - spec/unit/lists_spec.rb
 - spec/unit/model_view_spec_spec.rb