couch_potato 0.2.12

data/lib/couch_potato/database.rb

@@ -0,0 +1,106 @@
+module CouchPotato
+  class Database
+
+    class ValidationsFailedError < ::StandardError; end
+
+    def initialize(couchrest_database)
+      @database = couchrest_database
+      begin
+        couchrest_database.info
+      rescue RestClient::ResourceNotFound
+        raise "Database '#{couchrest_database.name}' does not exist."
+      end
+    end
+
+    def view(spec)
+      results = CouchPotato::View::ViewQuery.new(database,
+        spec.design_document, spec.view_name, spec.map_function,
+        spec.reduce_function).query_view!(spec.view_parameters)
+      spec.process_results results
+    end
+
+    def save_document(document)
+      return true unless document.dirty?
+      if document.new?
+        create_document document
+      else
+        update_document document
+      end
+    end
+    alias_method :save, :save_document
+
+    def save_document!(document)
+      save_document(document) || raise(ValidationsFailedError.new(document.errors.full_messages))
+    end
+    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._id = nil
+      document._rev = nil
+    end
+    alias_method :destroy, :destroy_document
+
+    def load_document(id)
+      raise "Can't load a document without an id (got nil)" if id.nil?
+      begin
+        json = database.get(id)
+        klass = json['ruby_class'].split('::').inject(Class){|scope, const| scope.const_get(const)}
+        instance = klass.json_create json
+        instance.database = self
+        instance
+      rescue(RestClient::ResourceNotFound)
+        nil
+      end
+    end
+    alias_method :load, :load_document
+
+    def inspect
+      "#<CouchPotato::Database>"
+    end
+
+    private
+
+    def clean_hash(hash)
+      hash.each do |k,v|
+        hash.delete k unless v
+      end
+    end
+
+    def create_document(document)
+      document.database = self
+      document.run_callbacks :before_validation_on_save
+      document.run_callbacks :before_validation_on_create
+      return unless document.valid?
+      document.run_callbacks :before_save
+      document.run_callbacks :before_create
+      res = database.save_doc clean_hash(document.to_hash)
+      document._rev = res['rev']
+      document._id = res['id']
+      document.run_callbacks :after_save
+      document.run_callbacks :after_create
+      true
+    end
+
+    def update_document(document)
+      document.run_callbacks :before_validation_on_save
+      document.run_callbacks :before_validation_on_update
+      return unless document.valid?
+      document.run_callbacks :before_save
+      document.run_callbacks :before_update
+      res = database.save_doc clean_hash(document.to_hash)
+      document._rev = res['rev']
+      document.run_callbacks :after_save
+      document.run_callbacks :after_update
+      true
+    end
+
+    def database
+      @database
+    end
+
+  end
+end

data/lib/couch_potato/persistence.rb

@@ -0,0 +1,98 @@
+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/ghost_attributes'
+require File.dirname(__FILE__) + '/persistence/attachments'
+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, GhostAttributes, Attachments
+      base.send :include, MagicTimestamps
+      base.class_eval do
+        attr_accessor :_id, :_rev, :_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/attachments.rb

@@ -0,0 +1,31 @@
+module CouchPotato
+  module Attachments
+    def self.included(base)
+      base.class_eval do
+        attr_writer :_attachments
+        
+        def _attachments
+          @_attachments || {}
+        end
+        
+        base.extend ClassMethods
+      end
+    end
+    
+    def to_hash
+      if _attachments
+        super.merge('_attachments' => _attachments)
+      else
+        super
+      end
+    end
+    
+    module ClassMethods
+      def json_create(json)
+        instance = super
+        instance._attachments = json['_attachments'] if json
+        instance
+      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,49 @@
+module CouchPotato
+  module Persistence
+    module DirtyAttributes
+      
+      def self.included(base)
+        base.class_eval do
+          after_save :reset_dirty_attributes
+          
+          def initialize(attributes = {})
+            super
+            assign_attribute_copies_for_dirty_tracking
+          end
+        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 assign_attribute_copies_for_dirty_tracking
+        attributes.each do |name, value|
+          self.instance_variable_set("@#{name}_was", clone_attribute(value))
+        end if attributes
+      end
+      
+      def reset_dirty_attributes
+        self.class.properties.each do |property|
+          instance_variable_set("@#{property.name}_was", clone_attribute(send(property.name)))
+        end
+      end
+      
+      def clone_attribute(value)
+        if [Fixnum, Symbol, TrueClass, FalseClass, NilClass, Float].include?(value.class)
+          value
+        elsif [Hash, Array].include?(value.class)
+          #Deep clone
+          Marshal::load(Marshal::dump(value))
+        else
+          value.clone
+        end
+      end
+    end
+  end
+end

data/lib/couch_potato/persistence/ghost_attributes.rb

@@ -0,0 +1,22 @@
+module CouchPotato
+  module GhostAttributes
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :_document
+        def self.json_create(json)
+          instance = super
+          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
+  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,52 @@
+require File.dirname(__FILE__) + '/simple_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
+
+      end
+    end
+  end
+end