couch_potato 0.2.20 → 0.2.21

data/CHANGES.md

@@ -1,5 +1,11 @@
 ## Changes
 
+### 0.2.21
+* automatically set a database instance on results of CouchPotato::Database#view (langalex)
+* improved auto loading of unloaded constants - can now load constants that have never been loaded before (langalex)
+* raise exception on invalid parameters passed to a couchdb view query (langalex)
+* when querying a view: pass in ranges as key instead of startkey/endkey, pass in plain value instead of hash with key (langalex) 
+
 ### 0.2.20
 * support for :boolean properties (jweiss)
 * return the total_rows when querying a view (langalex)

data/VERSION.yml

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

data/lib/couch_potato/database.rb

@@ -13,25 +13,42 @@ module CouchPotato
     end
 
     # executes a view and return the results. you pass in a view spec
-    # which is usually a result of a SomePersistentClass.view call.
+    # 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
-    #     view :all, key: :created_at
+    #     property :age
+    #     view :all, key: :age
     #   end
+    #   db = CouchPotato.database
     #
-    #   CouchPotato.database.view(User.all) # => [user1, user2]
-    #   CouchPotato.database.view(User.all).total_rows # => 2
+    #   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 has 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))
+    #   
     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)
       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
 

data/lib/couch_potato/persistence.rb

@@ -16,7 +16,7 @@ require File.dirname(__FILE__) + '/view/view_query'
 module CouchPotato
   module Persistence
     
-    def self.included(base)
+    def self.included(base) #:nodoc:
       base.send :include, Properties, Callbacks, Validation, Json, CouchPotato::View::CustomViews
       base.send :include, DirtyAttributes, GhostAttributes, Attachments
       base.send :include, MagicTimestamps

data/lib/couch_potato/persistence/attachments.rb

@@ -1,6 +1,6 @@
 module CouchPotato
   module Attachments
-    def self.included(base)
+    def self.included(base) #:nodoc:
       base.class_eval do
         attr_writer :_attachments
         

data/lib/couch_potato/persistence/callbacks.rb

@@ -1,7 +1,7 @@
 module CouchPotato
   module Persistence
     module Callbacks
-      def self.included(base)
+      def self.included(base) #:nodoc:
         base.extend ClassMethods
 
         base.class_eval do

data/lib/couch_potato/persistence/dirty_attributes.rb

@@ -2,7 +2,7 @@ module CouchPotato
   module Persistence
     module DirtyAttributes
       
-      def self.included(base)
+      def self.included(base) #:nodoc:
         base.class_eval do
           after_save :reset_dirty_attributes
           

data/lib/couch_potato/persistence/ghost_attributes.rb

@@ -1,5 +1,5 @@
 module CouchPotato
-  module GhostAttributes
+  module GhostAttributes #:nodoc:
     def self.included(base)
       base.class_eval do
         attr_accessor :_document

data/lib/couch_potato/persistence/json.rb

@@ -1,7 +1,7 @@
 module CouchPotato
   module Persistence
     module Json
-      def self.included(base)
+      def self.included(base) #:nodoc:
         base.extend ClassMethods
       end
       

data/lib/couch_potato/persistence/properties.rb

@@ -32,7 +32,7 @@ module CouchPotato
         end
       end
       
-      def self.included(base)
+      def self.included(base) #:nodoc:
         base.extend ClassMethods
         base.class_eval do
           def self.properties
@@ -42,7 +42,7 @@ module CouchPotato
         end
       end
       
-      def type_caster
+      def type_caster #:nodoc:
         @type_caster ||= TypeCaster.new
       end
       

data/lib/couch_potato/persistence/type_caster.rb

@@ -1,6 +1,6 @@
 module CouchPotato
   module Persistence
-    class TypeCaster
+    class TypeCaster #:nodoc:
       def cast(value, type)
         if type == :boolean
           cast_boolen(value)

data/lib/couch_potato/persistence/validation.rb

@@ -3,7 +3,7 @@ require 'validatable'
 module CouchPotato
   module Persistence
     module Validation
-      def self.included(base)
+      def self.included(base) #:nodoc:
         base.send :include, Validatable
         base.class_eval do
           # Override the validate method to first run before_validation callback

data/lib/couch_potato/view/base_view_spec.rb

@@ -5,6 +5,8 @@ module CouchPotato
       private :klass, :options
 
       def initialize(klass, view_name, options, view_parameters)
+        normalized_view_parameters = normalize_view_parameters view_parameters
+        assert_valid_view_parameters normalized_view_parameters
         @klass = klass
         @design_document = klass.to_s.underscore
         @view_name = view_name
@@ -13,12 +15,47 @@ module CouchPotato
         [:group, :include_docs, :descending, :group_level, :limit].each do |key|
           @view_parameters[key] = options[key] if options.include?(key)
         end
-        @view_parameters.merge!(view_parameters)
+        @view_parameters.merge!(normalized_view_parameters)
       end
 
       def process_results(results)
         results
       end
+      
+      private
+      
+      def normalize_view_parameters(params)
+        normalized_params = params.dup
+        hash = wrap_in_hash params
+        replace_range_key hash
+      end
+      
+      def wrap_in_hash(params)
+        if params.is_a?(Hash)
+          params
+        else
+          {:key => params}
+        end
+      end
+      
+      def replace_range_key(params)
+        if((key = params[:key]).is_a?(Range))
+          params.delete :key
+          params[:startkey] = key.first
+          params[:endkey] = key.last
+        end
+        params
+      end
+      
+      def assert_valid_view_parameters(params)
+        params.keys.each do |key|
+          raise ArgumentError.new("invalid view parameter: #{key}") unless valid_view_parameters.include?(key.to_s)
+        end
+      end
+      
+      def valid_view_parameters
+        %w(key startkey startkey_docid endkey endkey_docid limit stale descending skip group group_level reduce include_docs inclusive_end)
+      end
     end
   end
 end

data/lib/couch_potato/view/custom_views.rb

@@ -9,13 +9,12 @@ module CouchPotato
   module View
     module CustomViews
 
-      def self.included(base)
+      def self.included(base) #:nodoc:
         base.extend ClassMethods
       end
 
       module ClassMethods
-        # Declare a CouchDB view, for examples on how to use see the *ViewSpec classes in CouchPotato::View
-        def views(view_name = nil)
+        def views(view_name = nil) #:nodoc:
           if view_name
             _find_view(view_name)
           else
@@ -23,10 +22,11 @@ module CouchPotato
           end
         end
 
-        def execute_view(view_name, view_parameters)
+        def execute_view(view_name, view_parameters) #:nodoc:
           view_spec_class(views(view_name)[:type]).new(self, view_name, views(view_name), view_parameters)
         end
-
+        
+        # Declare a CouchDB view, for examples on how to use see the *ViewSpec classes in CouchPotato::View
         def view(view_name, options)
           view_name = view_name.to_s
           views[view_name] = options
@@ -34,7 +34,7 @@ module CouchPotato
           self.instance_eval(method_str)
         end
 
-        def view_spec_class(type)
+        def view_spec_class(type) #:nodoc:
           if type && type.is_a?(Class)
             type
           else
@@ -43,7 +43,7 @@ module CouchPotato
           end
         end
         
-        def _find_view(view)
+        def _find_view(view) #:nodoc:
           return @views[view] if @views && @views[view]
           superclass._find_view(view) if superclass && superclass.respond_to?(:_find_view)
         end

data/rails/reload_classes.rb

@@ -1,32 +1,16 @@
 module CouchPotato
-  module Persistence
-    
-    def self.persistent_classes #:nodoc:
-      @persistent_classes ||= []
-    end
-
-    def self.reload_persistent_classes #:nodoc:
-      persistent_classes.each do |clazz|
-        eval clazz.name
-      end
-    end
-    
-    
-    def self.included_with_class_reloading(base) #:nodoc:
-      persistent_classes << base
-      included_without_class_reloading(base)
-    end
-    
-    class << self
-      alias_method :included_without_class_reloading, :included
-      alias_method :included, :included_with_class_reloading
-    end
-  end
-  
   Database.class_eval do
     def load_document_with_class_reloading(id)
-      Persistence.reload_persistent_classes
-      load_document_without_class_reloading id
+      begin
+        load_document_without_class_reloading id
+      rescue ArgumentError => e
+        if(name = e.message.scan(/(can't find const|undefined class\/module) ([\w\:]+)/).first[1])
+          eval name
+          retry
+        else
+          raise e
+        end
+      end
     end
     
     alias_method :load_document_without_class_reloading, :load_document

data/spec/rails_spec.rb

@@ -10,9 +10,7 @@ end
 
 describe CouchPotato::Database, 'rails specific behavior' do
   
-  it "should load load models whose constants are currently uninitialized (like with rails in development mode)" do
-    Autoloader::Uninitialized
-    Autoloader.send :remove_const, 'Uninitialized'
+  it "should load models whose constants are currently uninitialized (like with rails in development mode)" do
     recreate_db
     CouchPotato.couchrest_database.save_doc(JSON.create_id => 'Autoloader::Uninitialized', '_id' => '1')
     CouchPotato.database.load('1').class.name.should == 'Autoloader::Uninitialized'

data/spec/unit/base_view_spec_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe CouchPotato::View::BaseViewSpec, 'initialize' do
+  describe "view parameters" do
+    it "should raise an error when passing invalid view parameters" do
+      lambda {
+        CouchPotato::View::BaseViewSpec.new Object, 'all', {}, {:start_key => '1'}
+      }.should raise_error(ArgumentError, "invalid view parameter: start_key")
+    end
+
+    it "should not raise an error when passing valid view parameters" do
+      lambda {
+        CouchPotato::View::BaseViewSpec.new Object, 'all', {}, {
+          :key => 'keyvalue',
+          :startkey => 'keyvalue',
+          :startkey_docid => 'docid',
+          :endkey => 'keyvalue',
+          :endkey_docid => 'docid',
+          :limit => 3,
+          :stale => 'ok',
+          :descending => true,
+          :skip => 1,
+          :group => true,
+          :group_level => 1,
+          :reduce => false,
+          :include_docs => true,
+          :inclusive_end => true
+        }
+      }.should_not raise_error
+    end
+
+    it "should convert a range passed as key into startkey and endkey" do
+      spec = CouchPotato::View::BaseViewSpec.new Object, 'all', {}, {:key => '1'..'2'}
+      spec.view_parameters.should == {:startkey => '1', :endkey => '2'}
+    end
+    
+    it "should convert a plain value to a hash with a key" do
+      spec = CouchPotato::View::BaseViewSpec.new Object, 'all', {}, '2'
+      spec.view_parameters.should == {:key => '2'}
+    end
+    
+  end
+  
+end
+
+

data/spec/unit/database_spec.rb

@@ -205,3 +205,32 @@ describe CouchPotato::Database, 'save_document' do
     
   end
 end
+
+describe CouchPotato::Database, 'view' do
+  before(:each) do
+    @db = CouchPotato::Database.new(stub('couchrest db').as_null_object)
+    @result = stub('result')
+    @spec = stub('view spec', :process_results => [@result]).as_null_object
+    CouchPotato::View::ViewQuery.stub(:new => stub('view query', :query_view! => {'rows' => [@result]}))
+  end
+  
+  it "should set itself on returned results that have an accessor" do
+    @result.stub(:respond_to?).with(:database=).and_return(true)
+    @result.should_receive(:database=).with(@db)
+    @db.view(@spec)
+  end
+  
+  it "should not set itself on returned results that don't have an accessor" do
+    @result.stub(:respond_to?).with(:database=).and_return(false)
+    @result.should_not_receive(:database=).with(@db)
+    @db.view(@spec)
+  end
+  
+  it "should not try to set itself on result sets that are not collections" do
+    lambda {
+      @spec.stub(:process_results => 1)
+    }.should_not raise_error
+    
+    @db.view(@spec)
+  end
+end

data/spec/unit/model_view_spec_spec.rb

@@ -10,4 +10,4 @@ describe CouchPotato::View::ModelViewSpec, 'map_function' do
     spec = CouchPotato::View::ModelViewSpec.new Object, 'all', {}, {}
     spec.map_function.should include('if(doc.ruby_class && doc.ruby_class == \'Object\')')
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: couch_potato
 version: !ruby/object:Gem::Version 
-  version: 0.2.20
+  version: 0.2.21
 platform: ruby
 authors: 
 - Alexander Lang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-11 00:00:00 +01:00
+date: 2010-01-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,6 +100,7 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/unit/attributes_spec.rb
+- spec/unit/base_view_spec_spec.rb
 - spec/unit/callbacks_spec.rb
 - spec/unit/couch_potato_spec.rb
 - spec/unit/create_spec.rb
@@ -153,6 +154,7 @@ test_files:
 - spec/rails_spec.rb
 - spec/spec_helper.rb
 - spec/unit/attributes_spec.rb
+- spec/unit/base_view_spec_spec.rb
 - spec/unit/callbacks_spec.rb
 - spec/unit/couch_potato_spec.rb
 - spec/unit/create_spec.rb