couchrest_model 1.0.0.beta8 → 1.0.0

data/lib/couchrest/model/view.rb

@@ -0,0 +1,190 @@
+
+#### NOTE Work in progress! Not yet used!
+
+module CouchRest
+  module Model
+
+    # A proxy class that allows view queries to be created using
+    # chained method calls. After each call a new instance of the method
+    # is created based on the original in a similar fashion to ruby's sequel 
+    # library, or Rails 3's Arel.
+    #
+    # CouchDB views have inherent limitations, so joins and filters as used in 
+    # a normal relational database are not possible. At least not yet!
+    #
+    # 
+    #
+    class View
+
+      attr_accessor :query, :design, :database, :name
+
+      # Initialize a new View object. This method should not be called from outside CouchRest Model.
+      def initialize(parent, new_query = {}, name = nil)
+        if parent.is_a? Base
+          raise "Name must be provided for view to be initialized" if name.nil?
+          @name = name
+          @database = parent.database
+          @query = { :reduce => false }
+        elsif parent.is_a? View
+          @database = parent.database
+          @query = parent.query.dup
+        else
+          raise "View cannot be initialized without a parent Model or View"
+        end
+        @query.update(new_query)
+        super
+      end
+
+
+      # == View Execution Methods
+      #
+      # Send a request to the CouchDB database using the current query values.
+
+      # Inmediatly send a request to the database for all documents provided by the query.
+      #
+      def all(&block)
+        args = include_docs.query
+        
+      end
+
+      # Inmediatly send a request for the first result of the dataset. This will override 
+      # any limit set in the view previously.
+      def first(&block)
+        args = limit(1).include_docs.query
+
+      end
+
+      def info
+
+      end
+
+      def offset
+
+      end
+
+      def total_rows
+
+      end
+
+      def rows
+
+      end
+
+
+      # == View Filter Methods
+      # 
+      # View filters return an copy of the view instance with the query 
+      # modified appropriatly. Errors will be raised if the methods
+      # are combined in an incorrect fashion.
+      #
+      
+
+      # Find all entries in the index whose key matches the value provided.
+      #
+      # Cannot be used when the +#startkey+ or +#endkey+ have been set.
+      def key(value)
+        raise "View#key cannot be used when startkey or endkey have been set" unless query[:startkey].nil? && query[:endkey].nil?
+        update_query(:key => value)
+      end
+
+      # Find all index keys that start with the value provided. May or may not be used in
+      # conjunction with the +endkey+ option.
+      #
+      # When the +#descending+ option is used (not the default), the start and end keys should
+      # be reversed.
+      #
+      # Cannot be used if the key has been set.
+      def startkey(value)
+        raise "View#startkey cannot be used when key has been set" unless query[:key].nil?
+        update_query(:startkey => value)
+      end
+
+      # The result set should start from the position of the provided document. 
+      # The value may be provided as an object that responds to the +#id+ call
+      # or a string.
+      def startkey_doc(value)
+        update_query(:startkey_docid => value.is_a?(String) ? value : value.id
+      end
+
+      # The opposite of +#startkey+, finds all index entries whose key is before the value specified.
+      #
+      # See the +#startkey+ method for more details and the +#inclusive_end+ option.
+      def endkey(value)
+        raise "View#endkey cannot be used when key has been set" unless query[:key].nil?
+        update_query(:endkey => value)
+      end
+
+      # The result set should end at the position of the provided document. 
+      # The value may be provided as an object that responds to the +#id+ call
+      # or a string.
+      def endkey_doc(value)
+        update_query(:endkey_docid => value.is_a?(String) ? value : value.id
+      end
+
+
+      # The results should be provided in descending order.
+      #
+      # Descending is false by default, this method will enable it and cannot be undone.
+      def descending
+        update_query(:descending => true)
+      end
+
+      # Limit the result set to the value supplied.
+      def limit(value)
+        update_query(:limit => value)
+      end
+
+      # Skip the number of entries in the index specified by value. This would be
+      # the equivilent of an offset in SQL.
+      #
+      # The CouchDB documentation states that the skip option should not be used
+      # with large data sets as it is inefficient. Use the +startkey_doc+ method
+      # instead to skip ranges efficiently.
+      def skip(value = 0)
+        update_query(:skip => value)
+      end
+
+      # Use the reduce function on the view. If none is available this method will fail. 
+      def reduce
+        update_query(:reduce => true)
+      end
+
+      # Control whether the reduce function reduces to a set of distinct keys or to a single
+      # result row.
+      #
+      # By default the value is false, and can only be set when the view's +#reduce+ option
+      # has been set.
+      def group
+        raise "View#reduce must have been set before grouping is permitted" unless query[:reduce]
+        update_query(:group => true)
+      end
+
+      def group_level(value)
+        raise "View#reduce and View#group must have been set before group_level is called" unless query[:reduce] && query[:group]
+        update_query(:group_level => value.to_i)
+      end
+
+
+      protected
+
+      def update_query(new_query = {})
+        self.class.new(self, new_query)
+      end
+
+      # Used internally to ensure that docs are provided. Should not be used outside of 
+      # the view class under normal circumstances.
+      def include_docs
+        raise "Documents cannot be returned from a view that is prepared for a reduce" if query[:reduce]
+        update_query(:include_docs => true)
+      end
+      
+      
+      def execute(&block)
+
+
+      end
+
+
+    end
+  end
+end

data/lib/couchrest/model/views.rb

@@ -23,7 +23,7 @@ module CouchRest
         #     view_by :tags,                                                
         #       :map =>                                                     
         #         "function(doc) {                                          
-        #           if (doc['couchrest-type'] == 'Post' && doc.tags) {                   
+        #           if (doc['model'] == 'Post' && doc.tags) {                   
         #             doc.tags.forEach(function(tag){                       
         #               emit(doc.tag, 1);                                   
         #             });                                                   
@@ -39,7 +39,7 @@ module CouchRest
         # function:
         #  
         #   function(doc) {
-        #     if (doc['couchrest-type'] == 'Post' && doc.date) {
+        #     if (doc['model'] == 'Post' && doc.date) {
         #       emit(doc.date, null);
         #     }
         #   }
@@ -77,7 +77,7 @@ module CouchRest
           ducktype = opts.delete(:ducktype)
           unless ducktype || opts[:map]
             opts[:guards] ||= []
-            opts[:guards].push "(doc['couchrest-type'] == '#{self.to_s}')"
+            opts[:guards].push "(doc['#{model_type_key}'] == '#{self.to_s}')"
           end
           keys.push opts
           design_doc.view_by(*keys)

data/lib/couchrest/model.rb

@@ -3,7 +3,7 @@ module CouchRest
 
   module Model
 
-    VERSION = "1.0.0.beta8"
+    VERSION = File.read(File.expand_path('../../../VERSION', __FILE__)).strip
 
   end
 

data/lib/couchrest/railtie.rb

@@ -4,8 +4,9 @@ require "active_model/railtie"
 module CouchrestModel
   # = Active Record Railtie
   class Railtie < Rails::Railtie
-    config.generators.orm :couchrest
+    config.generators.orm :couchrest_model
+    config.generators.test_framework  :test_unit, :fixture => false
   end
   
 end
-                                      
+                                      

data/lib/couchrest_model.rb

@@ -1,13 +1,3 @@
-gem 'couchrest', ">= 1.0.0.beta"
-require 'couchrest'
-
-gem "tzinfo", ">= 0.3.22"
-
-gem "activesupport", ">= 2.3.5"
-require 'active_support/core_ext'
-require 'active_support/json'
-
-gem "activemodel", ">= 3.0.0.beta4"
 require 'active_model'
 require "active_model/callbacks"
 require "active_model/conversion"
@@ -19,7 +9,9 @@ require "active_model/translation"
 require "active_model/validator"
 require "active_model/validations"
 
-gem "mime-types", ">= 1.15"
+require 'active_support/core_ext'
+require 'active_support/json'
+
 require 'mime/types'
 require "enumerator"
 require "time"
@@ -28,11 +20,14 @@ require 'digest/md5'
 require 'bigdecimal' # used in typecast
 require 'bigdecimal/util' # used in typecast
 
+require 'couchrest'
+
 require 'couchrest/model'
 require 'couchrest/model/errors'
 require "couchrest/model/persistence"
 require "couchrest/model/typecast"
 require "couchrest/model/property"
+require "couchrest/model/property_protection"
 require "couchrest/model/casted_array"
 require "couchrest/model/properties"
 require "couchrest/model/validations"
@@ -43,9 +38,8 @@ require "couchrest/model/design_doc"
 require "couchrest/model/extended_attachments"
 require "couchrest/model/class_proxy"
 require "couchrest/model/collection"
-require "couchrest/model/attribute_protection"
-require "couchrest/model/attributes"
 require "couchrest/model/associations"
+require "couchrest/model/configuration"
 
 # Monkey patches applied to couchrest
 require "couchrest/model/support/couchrest"
@@ -58,4 +52,3 @@ require "couchrest/model/base"
 # Add rails support *after* everything has loaded
 
 require "couchrest/railtie"
-

data/lib/rails/generators/couchrest_model/model/model_generator.rb

@@ -3,7 +3,6 @@ require 'rails/generators/couchrest_model'
 module CouchrestModel
   module Generators
     class ModelGenerator < Base
-
       check_class_collision
 
       def create_model_file
@@ -14,6 +13,8 @@ module CouchrestModel
         return if class_path.empty?
         template 'module.rb', File.join('app/models', "#{class_path.join('/')}.rb") if behavior == :invoke
       end
+      
+      hook_for :test_framework
 
       protected
 

data/spec/.gitignore

@@ -0,0 +1 @@
+tmp

data/spec/couchrest/base_spec.rb

@@ -36,7 +36,7 @@ describe "Model Base" do
 
     it "should not failed on a nil value in argument" do
       @obj = Basic.new(nil)
-      @obj.should == { 'couchrest-type' => 'Basic' }
+      @obj.should_not be_nil
     end
   end
  
@@ -210,7 +210,7 @@ describe "Model Base" do
   
   describe "a doc with template values (CR::Model spec)" do
     before(:all) do
-      WithTemplateAndUniqueID.all.map{|o| o.destroy(true)}
+      WithTemplateAndUniqueID.all.map{|o| o.destroy}
       WithTemplateAndUniqueID.database.bulk_delete
       @tmpl = WithTemplateAndUniqueID.new
       @tmpl2 = WithTemplateAndUniqueID.new(:preset => 'not_value', 'important-field' => '1')
@@ -233,7 +233,7 @@ describe "Model Base" do
   describe "finding all instances of a model" do
     before(:all) do
       WithTemplateAndUniqueID.req_design_doc_refresh
-      WithTemplateAndUniqueID.all.map{|o| o.destroy(true)}
+      WithTemplateAndUniqueID.all.map{|o| o.destroy}
       WithTemplateAndUniqueID.database.bulk_delete
       WithTemplateAndUniqueID.new('important-field' => '1').save
       WithTemplateAndUniqueID.new('important-field' => '2').save