langalex-couch_potato 0.1.1 → 0.2.0

data/lib/couch_potato/persistence.rb

@@ -1,35 +1,28 @@
 require 'digest/md5'
-require 'couchrest'
-require 'validatable'
-require File.dirname(__FILE__) + '/persistence/inline_collection'
-require File.dirname(__FILE__) + '/persistence/external_collection'
+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/bulk_save_queue'
-require File.dirname(__FILE__) + '/persistence/find'
 require File.dirname(__FILE__) + '/persistence/dirty_attributes'
-require File.dirname(__FILE__) + '/persistence/custom_view'
-require File.dirname(__FILE__) + '/persistence/view_query'
+require File.dirname(__FILE__) + '/view/custom_views'
+require File.dirname(__FILE__) + '/view/view_query'
+
 
 module CouchPotato
   module Persistence
     
-    class ValidationsFailedError < ::Exception; end
-    class UnsavedRecordError < ::Exception; end
-    
     def self.included(base)
-      base.send :extend, ClassMethods, Find
-      base.send :include, Callbacks, Properties, Validatable, Json, DirtyAttributes, CustomView
+      base.send :include, Properties, Callbacks, Validatable, Json, CouchPotato::View::CustomViews
+      base.send :include, DirtyAttributes
+      base.send :include, MagicTimestamps
       base.class_eval do
-        attr_accessor :_id, :_rev, :_attachments, :_deleted, :created_at, :updated_at
-        attr_reader :bulk_save_queue
+        attr_accessor :_id, :_rev, :_attachments, :_deleted
         alias_method :id, :_id
       end
     end
     
     def initialize(attributes = {})
-      @bulk_save_queue = BulkSaveQueue.new
       attributes.each do |name, value|
         self.send("#{name}=", value)
       end if attributes
@@ -41,11 +34,6 @@ module CouchPotato
       end
     end
     
-    def update_attributes(hash)
-      self.attributes = hash
-      save
-    end
-    
     def attributes
       self.class.properties.inject({}) do |res, property|
         property.serialize(res, self)
@@ -53,159 +41,17 @@ module CouchPotato
       end
     end
     
-    def save!
-      save || raise(ValidationsFailedError.new(self.errors.full_messages))
-    end
-    
-    def save
-      if new_document?
-        create_document 
-      else
-        update_document
-      end
-    end
-    
-    def destroy
-      run_callbacks(:before_destroy)
-      self._deleted = true
-      bulk_save_queue << self
-      destroy_dependent_objects
-      bulk_save_queue.save do |res|
-        self._id = nil
-        self._rev = nil
-      end
-      run_callbacks(:after_destroy)
-    end
-
-    def reload
-      raise(UnsavedRecordError.new) unless _id
-      json = self.class.db.get _id
-      self.class.properties.each do |property|
-        property.build self, json
-      end
-    end
-    
-    def new_document?
-      _id.nil?
+    def new?
+      _rev.nil?
     end
     
     def to_param
       _id
     end
     
-    def [](name)
-      self.send name
-    end
-    
     def ==(other)
       other.class == self.class && self.to_json == other.to_json
     end
     
-    private
-    
-    def create_document
-      run_callbacks :before_validation_on_save
-      run_callbacks :before_validation_on_create
-      return unless valid?
-      run_callbacks :before_save
-      run_callbacks :before_create
-      self.created_at = Time.now
-      self.updated_at = Time.now
-      self._id = generate_uuid
-      bulk_save_queue << self
-      save_dependent_objects
-      bulk_save_queue.save do |res|
-        self._rev = extract_rev(res)
-      end
-      run_callbacks :after_save
-      run_callbacks :after_create
-      true
-    end
-    
-    def generate_uuid
-      self.class.server.next_uuid rescue Digest::MD5.hexdigest(rand(1000000000000).to_s) # only works with couchdb 0.9
-    end
-    
-    def extract_rev(res)
-      res['new_revs'].select{|hash| hash['id'] == self.id}.first['rev']
-    end
-    
-    def update_document
-      run_callbacks(:before_validation_on_save)
-      run_callbacks(:before_validation_on_update)
-      return unless valid?
-      run_callbacks :before_save
-      run_callbacks :before_update
-      self.updated_at = Time.now
-      bulk_save_queue << self
-      save_dependent_objects
-      bulk_save_queue.save do |res|
-        self._rev = extract_rev(res)
-      end
-      run_callbacks :after_save
-      run_callbacks :after_update
-      true
-    end
-    
-    def save_dependent_objects
-      self.class.properties.each do |property|
-        property.save(self)
-      end
-    end
-    
-    def destroy_dependent_objects
-      self.class.properties.each do |property|
-        property.destroy(self)
-      end
-    end
-    
-    module ClassMethods
-      
-      def create!(attributes = {})
-        instance = self.new attributes
-        instance.save!
-        instance
-      end
-      
-      def create(attributes = {})
-        instance = self.new attributes
-        instance.save
-        instance
-      end
-      
-      def get(id)
-        begin
-          self.json_create db.get(id)
-        rescue(RestClient::ResourceNotFound)
-          nil
-        end
-      end
-      
-      def db(name = nil)
-        ::CouchPotato::Persistence.Db(name)
-      end
-      
-    end
-    
-    def self.Db(database_name = nil)
-      @@__database ||= CouchRest.database(full_url_to_database(database_name))
-    end
-    
-    def self.Server(database_name = nil)
-      @@_server ||= Db(database_name).server
-    end
-    
-    def self.Db!(database_name = nil)
-      CouchRest.database!(full_url_to_database(database_name))
-    end
-    
-    def self.full_url_to_database(database_name)
-      database_name ||= CouchPotato::Config.database_name || raise('No Database configured. Set CouchPotato::Config.database_name')
-      url = database_name
-      if url !~ /^http:\/\//
-        url = "http://localhost:5984/#{database_name}"
-      end
-      url
-    end
   end    
 end

data/lib/couch_potato/view/base_view_spec.rb

@@ -0,0 +1,20 @@
+module CouchPotato
+  module View
+    class BaseViewSpec
+      attr_reader :reduce_function, :design_document, :view_name, :view_parameters, :klass, :options
+      private :klass, :options
+      
+      def initialize(klass, view_name, options, view_parameters)
+        @klass = klass
+        @design_document = klass.to_s.underscore
+        @view_name = view_name
+        @options = options
+        @view_parameters = options.select{|key, value| [:group, :include_docs, :descending, :group_level, :limit].include?(key.to_sym)}.merge(view_parameters)
+      end
+      
+      def process_results(results)
+        results
+      end
+    end
+  end
+end

data/lib/couch_potato/view/custom_view_spec.rb

@@ -0,0 +1,26 @@
+module CouchPotato
+  module View
+    # a view for custom map/reduce functions that still returns model instances
+    # example: view :my_custom_view, :map => "function(doc) { emit(doc._id, null); }", :include_docs => true, :type => :custom, :reduce => nil
+    
+    class CustomViewSpec < BaseViewSpec
+      def map_function
+        options[:map]
+      end
+      
+      def reduce_function
+        options[:reduce]
+      end
+      
+      def view_parameters
+        {:include_docs => options[:include_docs] || false}.merge(super)
+      end
+      
+      def process_results(results)
+        results['rows'].map do |row|
+          klass.json_create row['doc'] || row['value'].merge(:_id => row['id'])
+        end
+      end
+    end
+  end
+end

data/lib/couch_potato/view/custom_views.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/base_view_spec'
+require File.dirname(__FILE__) + '/model_view_spec'
+require File.dirname(__FILE__) + '/properties_view_spec'
+require File.dirname(__FILE__) + '/custom_view_spec'
+require File.dirname(__FILE__) + '/raw_view_spec'
+
+
+module CouchPotato
+  module View
+    module CustomViews
+      
+      def self.included(base)
+        base.extend ClassMethods
+      end
+      
+      module ClassMethods
+        
+        # declare a couchdb view, for examples on how to use see the *ViewSpec classes in CouchPotato::View
+        def view(view_name, options)
+          self.class.instance_eval do
+            define_method view_name do |view_parameters = {}|
+              klass = options[:type] ? options[:type].to_s.camelize : 'Model'
+              CouchPotato::View.const_get("#{klass}ViewSpec").new self, view_name, options, view_parameters
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/couch_potato/view/model_view_spec.rb

@@ -0,0 +1,39 @@
+module CouchPotato
+  module View
+    # a view to return model instances by searching its properties
+    # example: view :my_view, :key => :name
+    class ModelViewSpec < BaseViewSpec
+      
+      def view_parameters
+        {:include_docs => true}.merge(super)
+      end
+      
+      def map_function
+        "function(doc) {
+            emit(#{formatted_key(key)}, null);
+         }"
+      end
+      
+      def process_results(results)
+        results['rows'].map do |row|
+          klass.json_create row['doc']
+        end
+      end
+      
+      private
+      
+      def key
+        options[:key]
+      end
+      
+      def formatted_key(key)
+        if key.is_a? Array
+          '[' + key.map{|attribute| formatted_key(attribute)}.join(', ') + ']'
+        else
+          "doc['#{key}']"
+        end
+      end
+      
+    end
+  end
+end

data/lib/couch_potato/view/properties_view_spec.rb

@@ -0,0 +1,35 @@
+module CouchPotato
+  module View
+    # a view to return model instances with only some properties poulated by searching its properties, e.g. for very large documents where you are only interested in some of their data
+    # example: view :my_view, :key => :name, :properties => [:name, :author], :type => :properties
+    class PropertiesViewSpec < ModelViewSpec
+      def map_function
+        "function(doc) {
+            emit(#{formatted_key(key)}, #{properties_for_map(properties)});
+         }"
+      end
+      
+      def process_results(results)
+        results['rows'].map do |row|
+          klass.json_create row['value'].merge(:_id => row['id'])
+        end
+      end
+      
+      def view_parameters
+        {:include_docs => false}.merge(super)
+      end
+      
+      private
+      
+      def properties
+        options[:properties]
+      end
+      
+      def properties_for_map(properties)
+        '{' + properties.map{|p| "#{p}: doc.#{p}"}.join(', ') + '}'
+      end
+      
+      
+    end
+  end
+end

data/lib/couch_potato/view/raw_view_spec.rb

@@ -0,0 +1,21 @@
+module CouchPotato
+  # a view for custom map/reduce functions that returns the raw data fromcouchdb
+  # example: view :my_custom_view, :map => "function(doc) { emit(doc._id, null); }", :type => :raw, :reduce => nil
+  # optionally you can pass in a results filter which you can use to process the raw couchdb results before returning them
+  # example: view :my_custom_view, :map => "function(doc) { emit(doc._id, null); }", :type => :raw, :results_filter => lambda{|results| results['rows].map{|row| row['value']}}
+  module View
+    class RawViewSpec < BaseViewSpec
+      def map_function
+        options[:map]
+      end
+      
+      def process_results(results)
+        options[:results_filter] ? options[:results_filter].call(results) : results
+      end
+      
+      def reduce_function
+        options[:reduce]
+      end
+    end
+  end
+end

data/lib/couch_potato/view/view_query.rb

@@ -0,0 +1,45 @@
+module CouchPotato
+  module View
+
+    class ViewQuery
+      def initialize(couchrest_database, design_document_name, view_name, map_function, reduce_function = nil)
+        @database = couchrest_database
+        @design_document_name = design_document_name
+        @view_name = view_name
+        @map_function = map_function
+        @reduce_function = reduce_function
+      end
+      
+      def query_view!(parameters = {})
+        begin
+          query_view parameters
+        rescue RestClient::ResourceNotFound => e
+          create_view
+          retry
+        end
+      end
+      
+      private
+      
+      def create_view
+        design_doc = @database.get "_design/#{@design_document_name}" rescue nil
+        design_doc ||= {'views' => {}, "_id" => "_design/#{@design_document_name}"}
+        design_doc['views'][@view_name.to_s] = {
+          'map' => @map_function,
+          'reduce' => @reduce_function
+        }
+        @database.save_doc(design_doc)
+      end
+      
+      def query_view(parameters)
+        @database.view view_url, parameters
+      end
+      
+      def view_url
+        "#{@design_document_name}/#{@view_name}"
+      end
+      
+
+    end
+  end
+end

data/lib/couch_potato.rb

@@ -1,20 +1,37 @@
-require 'rubygems'
-require 'active_support'
+require 'couchrest'
 require 'json'
 require 'json/add/core'
 require 'json/add/rails'
 
 require 'ostruct'
 
+require 'validatable'
+
+
 module CouchPotato
   Config = OpenStruct.new
+  
+  def self.database
+    @@__database ||= Database.new(self.couchrest_database)
+  end
+  
+  def self.couchrest_database
+    @@__couchrest_database ||= CouchRest.database(full_url_to_database)
+  end
+  
+  def self.full_url_to_database
+    database_name = CouchPotato::Config.database_name || raise('No Database configured. Set CouchPotato::Config.database_name')
+    url = database_name
+    if url !~ /^http:\/\//
+      url = "http://localhost:5984/#{database_name}"
+    end
+    url
+  end
 end
 
 require File.dirname(__FILE__) + '/core_ext/object'
 require File.dirname(__FILE__) + '/core_ext/time'
-
+require File.dirname(__FILE__) + '/core_ext/date'
+require File.dirname(__FILE__) + '/core_ext/string'
 require File.dirname(__FILE__) + '/couch_potato/persistence'
-require File.dirname(__FILE__) + '/couch_potato/versioning'
-require File.dirname(__FILE__) + '/couch_potato/ordering'
-require File.dirname(__FILE__) + '/couch_potato/active_record/compatibility'
 

data/rails/init.rb

@@ -0,0 +1,7 @@
+# this is for rails only
+
+require File.dirname(__FILE__) + '/../lib/couch_potato'
+
+CouchPotato::Config.database_name = YAML::load(File.read(Rails.root.to_s + '/config/couchdb.yml'))[RAILS_ENV]
+
+RAILS_DEFAULT_LOGGER.info "** couch_potato: initialized from #{__FILE__}"