andrewtimberlake-couch_potato 0.2.8.1

data/lib/couch_potato/persistence.rb

@@ -0,0 +1,96 @@
+require 'digest/md5'
+require File.dirname(__FILE__) + '/database'
+require File.dirname(__FILE__) + '/persistence/properties'
+require File.dirname(__FILE__) + '/persistence/magic_timestamps'
+require File.dirname(__FILE__) + '/persistence/callbacks'
+require File.dirname(__FILE__) + '/persistence/json'
+require File.dirname(__FILE__) + '/persistence/dirty_attributes'
+require File.dirname(__FILE__) + '/persistence/validation'
+require File.dirname(__FILE__) + '/view/custom_views'
+require File.dirname(__FILE__) + '/view/view_query'
+
+
+module CouchPotato
+  module Persistence
+    
+    def self.included(base)
+      base.send :include, Properties, Callbacks, Validation, Json, CouchPotato::View::CustomViews
+      base.send :include, DirtyAttributes
+      base.send :include, MagicTimestamps
+      base.class_eval do
+        attr_accessor :_id, :_rev, :_attachments, :_deleted, :database
+        alias_method :id, :_id
+      end
+    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
+    # 
+    # example: 
+    #   class Book
+    #     include CouchPotato::Persistence
+    #     property :title
+    #   end
+    #   book = Book.new :title => 'Time to Relax'
+    #   book.title # => 'Time to Relax'
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        self.send("#{name}=", value)
+      end if attributes
+    end
+    
+    # assign multiple attributes at once.
+    # the attributes have to be declared using the #property method
+    #
+    # example:
+    #   class Book
+    #     include CouchPotato::Persistence
+    #     property :title
+    #     property :year
+    #   end
+    #   book = Book.new
+    #   book.attributes = {:title => 'Time to Relax', :year => 2009}
+    #   book.title # => 'Time to Relax'
+    #   book.year # => 2009
+    def attributes=(hash)
+      hash.each do |attribute, value|
+        self.send "#{attribute}=", value
+      end
+    end
+    
+    # returns all of a model's attributes that have been defined using the #property method as a Hash
+    #
+    # example:
+    #   class Book
+    #     include CouchPotato::Persistence
+    #     property :title
+    #     property :year
+    #   end
+    #   book = Book.new :year => 2009
+    #   book.attributes # => {:title => nil, :year => 2009}
+    def attributes
+      self.class.properties.inject({}) do |res, property|
+        property.serialize(res, self)
+        res
+      end
+    end
+    
+    # returns true if a  model hasn't been saved yet, false otherwise
+    def new?
+      _rev.nil?
+    end
+    alias_method :new_record?, :new?
+    
+    # returns the document id
+    # this is used by rails to construct URLs
+    # can be overridden to for example use slugs for URLs instead if ids
+    def to_param
+      _id
+    end
+    
+    def ==(other) #:nodoc:
+      other.class == self.class && self.to_json == other.to_json
+    end
+    
+  end    
+end

data/lib/couch_potato/persistence/belongs_to_property.rb

@@ -0,0 +1,58 @@
+module CouchPotato
+  module Persistence
+    class BelongsToProperty #:nodoc:
+      attr_accessor :name
+      
+      def initialize(owner_clazz, name, options = {})
+        self.name = name
+        accessors =  <<-ACCESSORS
+          def #{name}
+            return @#{name} if instance_variable_defined?(:@#{name})
+            @#{name} = @#{name}_id ? #{item_class_name}.find(@#{name}_id) : nil
+          end
+          
+          def #{name}=(value)
+            @#{name} = value
+            if value.nil?
+              @#{name}_id = nil
+            else
+              @#{name}_id = value.id
+            end
+          end
+          
+          def #{name}_id=(id)
+            remove_instance_variable(:@#{name}) if instance_variable_defined?(:@#{name})
+            @#{name}_id = id
+          end
+        ACCESSORS
+        owner_clazz.class_eval accessors
+        owner_clazz.send :attr_reader, "#{name}_id"
+      end
+      
+      def save(object)
+        
+      end
+      
+      def dirty?(object)
+        false
+      end
+      
+      def destroy(object)
+        
+      end
+      
+      def build(object, json)
+        object.send "#{name}_id=", json["#{name}_id"]
+      end
+      
+      def serialize(json, object)
+        json["#{name}_id"] = object.send("#{name}_id") if object.send("#{name}_id")
+      end
+      
+      def item_class_name
+        @name.to_s.camelize
+      end
+      
+    end
+  end
+end

data/lib/couch_potato/persistence/callbacks.rb

@@ -0,0 +1,60 @@
+module CouchPotato
+  module Persistence
+    module Callbacks
+      def self.included(base)
+        base.extend ClassMethods
+
+        base.class_eval do
+          attr_accessor :skip_callbacks
+          def self.callbacks
+            @callbacks ||= {}
+            @callbacks[self.name] ||= {: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
+        end
+      end
+
+      # Runs all callbacks on a model with the given name, i.g. :after_create.
+      # 
+      # This method is called by the CouchPotato::Database object when saving/destroying an object 
+      def run_callbacks(name)
+        return if skip_callbacks
+        self.class.callbacks[name].uniq.each do |callback|
+          if callback.is_a?(Symbol)
+            send callback
+          elsif callback.is_a?(Proc)
+            callback.call self
+          else
+            raise "Don't know how to handle callback of type #{name.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|
+            names.each do |name|
+              callbacks[callback] << name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/couch_potato/persistence/dirty_attributes.rb

@@ -0,0 +1,27 @@
+module CouchPotato
+  module Persistence
+    module DirtyAttributes
+      
+      def self.included(base)
+        base.class_eval do
+          after_save :reset_dirty_attributes
+        end
+      end
+      
+      # returns true if a model has dirty attributes, i.e. their value has changed since the last save
+      def dirty? 
+        new? || self.class.properties.inject(false) do |res, property|
+          res || property.dirty?(self)
+        end
+      end
+      
+      private
+      
+      def reset_dirty_attributes
+        self.class.properties.each do |property|
+          instance_variable_set("@#{property.name}_was", send(property.name))
+        end
+      end
+    end
+  end
+end

data/lib/couch_potato/persistence/json.rb

@@ -0,0 +1,46 @@
+module CouchPotato
+  module Persistence
+    module Json
+      def self.included(base)
+        base.extend ClassMethods
+      end
+      
+      # returns a JSON representation of a model in order to store it in CouchDB
+      def to_json(*args)
+        to_hash.to_json(*args)
+      end
+      
+      # returns all the attributes, the ruby class and the _id and _rev of a model as a Hash
+      def to_hash
+        (self.class.properties).inject({}) do |props, property|
+          property.serialize(props, self)
+          props
+        end.merge('ruby_class' => self.class.name).merge(id_and_rev_json)
+      end
+      
+      private
+      
+      def id_and_rev_json
+        ['_id', '_rev', '_deleted'].inject({}) do |hash, key|
+          hash[key] = self.send(key) unless self.send(key).nil?
+          hash
+        end
+      end
+      
+      module ClassMethods
+        
+        # creates a model instance from JSON
+        def json_create(json)
+          return if json.nil?
+          instance = self.new
+          instance._id = json[:_id] || json['_id']
+          instance._rev = json[:_rev] || json['_rev']
+          properties.each do |property|
+            property.build(instance, json)
+          end
+          instance
+        end
+      end
+    end
+  end
+end

data/lib/couch_potato/persistence/magic_timestamps.rb

@@ -0,0 +1,13 @@
+module CouchPotato
+  module MagicTimestamps #:nodoc:
+    def self.included(base)
+      base.instance_eval do
+        property :created_at, :type => Time
+        property :updated_at, :type => Time
+        
+        before_create lambda {|model| model.created_at = Time.now; model.created_at_not_changed}
+        before_save lambda {|model| model.updated_at = Time.now; model.updated_at_not_changed}
+      end
+    end
+  end
+end

data/lib/couch_potato/persistence/properties.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/simple_property'
+require File.dirname(__FILE__) + '/belongs_to_property'
+
+module CouchPotato
+  module Persistence
+    module Properties
+      def self.included(base)
+        base.extend ClassMethods
+        base.class_eval do
+          def self.properties
+            @properties ||= {}
+            @properties[self.name] ||= []
+          end
+        end
+      end
+
+      module ClassMethods
+        # returns all the property names of a model class that have been defined using the #property method
+        #
+        # example:
+        #  class Book
+        #    property :title
+        #    property :year
+        #  end
+        #  Book.property_names # => [:title, :year]
+        def property_names
+          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 proprty 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.
+        #
+        # example:
+        #  class Book
+        #    property :title
+        #    property :year
+        #    property :publisher, :class => Publisher
+        #  end
+        def property(name, options = {})
+          clazz = options.delete(:class)
+          properties << (clazz || SimpleProperty).new(self, name, options)
+        end
+
+        def belongs_to(name) #:nodoc:
+          property name, :class => BelongsToProperty
+        end
+
+      end
+    end
+  end
+end

data/lib/couch_potato/persistence/simple_property.rb

@@ -0,0 +1,83 @@
+module CouchPotato
+  module Persistence
+    class SimpleProperty  #:nodoc:
+      attr_accessor :name, :type
+      
+      def initialize(owner_clazz, name, options = {})
+        self.name = name
+        self.type = options[:type]
+        owner_clazz.class_eval do
+          attr_reader "#{name}_was"
+          
+          def initialize(attributes = {})
+            super attributes
+            assign_attribute_copies_for_dirty_tracking
+          end
+          
+          def assign_attribute_copies_for_dirty_tracking
+            attributes.each do |name, value|
+              self.instance_variable_set("@#{name}_was", clone_attribute(value))
+            end if attributes
+          end
+          private :assign_attribute_copies_for_dirty_tracking
+          
+          def clone_attribute(value)
+            if [Fixnum, Symbol, TrueClass, FalseClass, NilClass, Float].include?(value.class)
+              value
+            else
+              value.clone
+            end
+          end
+
+          define_method "#{name}" do
+            value = self.instance_variable_get("@#{name}")
+            default = options[:default]
+            value.blank? ? default : value
+          end
+          
+          define_method "#{name}=" do |value|
+            self.instance_variable_set("@#{name}", 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
+      
+      def build(object, json)
+        value = json[name.to_s] || json[name.to_sym]
+        typecasted_value =  if type
+                              type.json_create value
+                            else
+                              value
+                            end
+        object.send "#{name}=", typecasted_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
+    end
+  end
+end