davber_couch_potato 0.3.0

data/lib/couch_potato/database.rb

@@ -0,0 +1,161 @@
+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
+
+    # executes a view and return the results. you pass in a view spec
+    # which is usually a result of a SomePersistentClass.some_view call.
+    # also return the total_rows returned by CouchDB as an accessor on the results.
+    #
+    # Example:
+    #
+    #   class User
+    #     include CouchPotato::Persistence
+    #     property :age
+    #     view :all, key: :age
+    #   end
+    #   db = CouchPotato.database
+    #
+    #   db.view(User.all) # => [user1, user2]
+    #   db.view(User.all).total_rows # => 2
+    #
+    # You can pass the usual parameters you can pass to a couchdb view to the view:
+    #
+    #   db.view(User.all(limit: 5, startkey: 2, reduce: false))
+    #
+    # For your convenience when passing a hash with only a key parameter you can just pass in the value
+    #
+    #   db.view(User.all(key: 1)) == db.view(User.all(1))
+    # 
+    # Instead of passing a startkey and endkey you can pass in a key with a range:
+    #
+    #   db.view(User.all(key: 1..20)) == db.view(startkey: 1, endkey: 20) == db.view(User.all(1..20))
+    #   
+    # You can also pass in multiple keys:
+    #
+    #   db.view(User.all(keys: [1, 2, 3]))
+    def view(spec)
+      results = CouchPotato::View::ViewQuery.new(
+        database,
+        spec.design_document,
+        {spec.view_name => {
+          :map => spec.map_function,
+          :reduce => spec.reduce_function}
+        },
+        ({spec.list_name => spec.list_function} unless spec.list_name.nil?)
+      ).query_view!(spec.view_parameters)
+      processed_results = spec.process_results results
+      processed_results.instance_eval "def total_rows; #{results['total_rows']}; end" if results['total_rows']
+      processed_results.each do |document|
+        document.database = self if document.respond_to?(:database=)
+      end if processed_results.respond_to?(:each)
+      processed_results
+    end
+
+    # saves a document. returns true on success, false on failure
+    def save_document(document, validate = true)
+      return true unless document.dirty?
+      if document.new?
+        create_document(document, validate)
+      else
+        update_document(document, validate)
+      end
+    end
+    alias_method :save, :save_document
+    
+    # saves a document, raises a CouchPotato::Database::ValidationsFailedError on failure
+    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
+
+    # loads a document by its id
+    def load_document(id)
+      raise "Can't load a document without an id (got nil)" if id.nil?
+      begin
+        instance = database.get(id)
+        instance.database = self
+        instance
+      rescue(RestClient::ResourceNotFound)
+        nil
+      end
+    end
+    alias_method :load, :load_document
+
+    def inspect #:nodoc:
+      "#<CouchPotato::Database>"
+    end
+
+    private
+
+    def create_document(document, validate)
+      document.database = self
+      
+      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)
+      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
+      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)
+      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
+
+    def valid_document?(document)
+      errors = document.errors.errors.dup
+      document.valid?
+      errors.each_pair do |k, v|
+        v.each {|message| document.errors.add(k, message)}
+      end
+      document.errors.empty?
+    end
+    
+    def database
+      @database
+    end
+
+  end
+end

data/lib/couch_potato/persistence/active_model_compliance.rb

@@ -0,0 +1,44 @@
+module CouchPotato
+  module Persistence
+    module ActiveModelCompliance
+      begin
+        require 'active_model'
+
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        def to_model
+          self
+        end
+
+        def errors
+          super || []
+        end
+        
+        def persisted?
+          !self.new?
+        end
+        
+        def to_key
+          persisted? ? [to_param] : nil
+        end
+
+        def destroyed?
+          !!_deleted
+        end
+
+        module ClassMethods
+          def model_name
+            @model_name ||= ::ActiveModel::Name.new(self)
+          end
+        end
+
+      rescue LoadError, NameError
+        # if it's not installed you probably don't want to use it anyway
+      end
+    end
+  end
+end
+
+

data/lib/couch_potato/persistence/attachments.rb

@@ -0,0 +1,31 @@
+module CouchPotato
+  module Attachments
+    def self.included(base) #:nodoc:
+      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,62 @@
+module CouchPotato
+  module Persistence
+    module Callbacks
+      def self.included(base) #:nodoc:
+        base.extend ClassMethods
+
+        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
+        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)
+        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
+      end
+    end
+  end
+end

data/lib/couch_potato/persistence/dirty_attributes.rb

@@ -0,0 +1,56 @@
+require 'bigdecimal'
+module CouchPotato
+  module Persistence
+    module DirtyAttributes
+      
+      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
+      
+      # 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
+      end
+      
+      # marks a model as dirty
+      def is_dirty
+        @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
+      end
+      
+      def reset_dirty_attributes
+        @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)
+        if [Fixnum, Symbol, TrueClass, FalseClass, NilClass, Float, BigDecimal].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 #:nodoc:
+    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) #:nodoc:
+        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(JSON.create_id => 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,20 @@
+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
+          model.updated_at ||= Time.now
+          model.updated_at_not_changed
+        }
+        before_update 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,86 @@
+require File.dirname(__FILE__) + '/simple_property'
+
+module CouchPotato
+  module Persistence
+    module Properties
+      class PropertyList
+        include Enumerable
+        
+        attr_accessor :list
+        
+        def initialize(clazz)
+          @clazz = clazz
+          @list = []
+        end
+        
+        def each
+          (list + inherited_properties).each {|property| yield property}
+        end
+        
+        def <<(property)
+          @list << property
+        end
+        
+        def inherited_properties
+          superclazz = @clazz.superclass
+          properties = []
+          while superclazz && superclazz.respond_to?(:properties)
+            properties << superclazz.properties.list
+            superclazz = superclazz.superclass
+          end
+          properties.flatten
+        end
+      end
+      
+      def self.included(base) #:nodoc:
+        base.extend ClassMethods
+        base.class_eval do
+          def self.properties
+            @properties ||= {}
+            @properties[name] ||= PropertyList.new(self)
+          end
+        end
+      end
+      
+      def type_caster #:nodoc:
+        @type_caster ||= TypeCaster.new
+      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 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, :type => Publisher
+        #  end
+        def property(name, options = {})
+          properties << SimpleProperty.new(self, name, options)
+        end
+
+      end
+    end
+  end
+end

data/lib/couch_potato/persistence/simple_property.rb

@@ -0,0 +1,72 @@
+module CouchPotato
+  module Persistence
+    class SimpleProperty  #:nodoc:
+      attr_accessor :name, :type
+      
+      def initialize(owner_clazz, name, options = {})
+        self.name = name
+        self.type = options[:type]
+        @type_caster = TypeCaster.new
+        
+        define_accessors accessors_module_for(owner_clazz), name, options
+      end
+      
+      def build(object, json)
+        value = json[name.to_s].nil? ? json[name.to_sym] : json[name.to_s]
+        object.send "#{name}=", value
+      end
+      
+      def dirty?(object)
+        object.send("#{name}_changed?")
+      end
+      
+      def serialize(json, object)
+        json[name] = object.send name
+      end
+      alias :value :serialize
+      
+      private
+      
+      def accessors_module_for(clazz)
+        unless clazz.const_defined?('AccessorMethods')
+          accessors_module = clazz.const_set('AccessorMethods', Module.new) 
+          clazz.send(:include, accessors_module)
+        end
+        clazz.const_get('AccessorMethods')
+      end
+      
+      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]
+              default = clone_attribute(options[:default])
+              self.instance_variable_set("@#{name}", default)
+              default
+            else
+              value
+            end
+          end
+          
+          define_method "#{name}=" do |value|
+            self.instance_variable_set("@#{name}", type_caster.cast(value, options[:type]))
+          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
+  end
+end

data/lib/couch_potato/persistence/type_caster.rb

@@ -0,0 +1,40 @@
+module CouchPotato
+  module Persistence
+    class TypeCaster #:nodoc:
+      def cast(value, type)
+        if type == :boolean
+          cast_boolen(value)
+        else
+          cast_native(value, type)
+        end
+      end
+      
+      private
+      
+      def cast_boolen(value)
+        if [FalseClass, TrueClass].include?(value.class) || value.nil?
+          value
+        elsif [0, '0'].include?(value)
+          false
+        else
+          true
+        end
+      end
+      
+      def cast_native(value, type)
+        if type && !value.instance_of?(type)
+          if type == Fixnum
+            value.to_s.scan(/\d/).join.to_i unless value.blank?
+          elsif type == Float
+            value.to_s.scan(/\d+\.?\d*/).join.to_f unless value.blank?
+          else
+            type.json_create value unless value.blank?
+          end
+        else
+          value
+        end
+      end
+      
+    end
+  end
+end