couchrest_model 1.1.0.beta4 → 1.1.0.beta5

data/VERSION

@@ -1 +1 @@
-1.1.0.beta4
+1.1.0.beta5

data/couchrest_model.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["J. Chris Anderson", "Matt Aimonetti", "Marcos Tapajos", "Will Leinweber", "Sam Lown"]
-  s.date = %q{2011-01-16}
+  s.date = %q{2011-04-29}
   s.description = %q{CouchRest Model provides aditional features to the standard CouchRest Document class such as properties, view designs, associations, callbacks, typecasting and validations.}
   s.email = %q{jchris@apache.org}
   s.extra_rdoc_files = [
@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   
   s.add_dependency(%q<couchrest>, "1.1.0.pre2")
   s.add_dependency(%q<mime-types>, "~> 1.15")
-  s.add_dependency(%q<activemodel>, "~> 3.0.5")
+  s.add_dependency(%q<activemodel>, "~> 3.0.0")
   s.add_dependency(%q<tzinfo>, "~> 0.3.22")
   s.add_dependency(%q<railties>, "~> 3.0.0")
   s.add_development_dependency(%q<rspec>, ">= 2.0.0")

data/{history.txt → history.md}

@@ -1,4 +1,15 @@
-== 1.1.0.beta4
+# CouchRest Model Change History
+
+## 1.1.0.beta5 - 2011-04-30
+
+* Major changes:
+  * Database auto configuration, with connection options!
+  * Changed default CouchRest Model type to 'type' to be more consistent with ActiveRecord's reserverd words we're all used to (sorry for the change again!!)
+
+* Minor changes
+  * Added filter option to designs (Used with CouchDB _changes feeds)
+
+## 1.1.0.beta4
 
 * Major changes:
   * Fast Dirty Tracking! Many thanks to @sobakasu (Andrew Williams)
@@ -10,11 +21,11 @@
   * Added "auto_update_design_doc" configuration option.
   * Using #descending on View object will automatically swap startkey with endkey.
 
-== 1.1.0.beta3
+## 1.1.0.beta3
 
 * Removed
 
-== 1.1.0.beta2
+## 1.1.0.beta2
 
 * Minor enhancements:
   * Time handling improved in accordance with CouchRest 1.1.0. Always set to UTC.
@@ -23,7 +34,7 @@
   * Unique Validation now supports scopes!
   * Added support for #keys with list on Design View.
 
-== 1.1.0.beta
+## 1.1.0.beta
 
 * Epic enhancements:
   * Added "View" object for dynamic view queries
@@ -37,7 +48,7 @@
   * Numeric types can be casted from strings with leading or trailing whitespace (thanks chrisdurtschi)
   * CollectionProxy no longer provided by default with simple views (pending deprication)
 
-== CouchRest Model 1.0.0
+## CouchRest Model 1.0.0
 
 * Major enhancements
   * Support for configuration module and "model_type_key" option for overriding model's type key
@@ -56,7 +67,7 @@ Notes:
   Until these have been resolved (if possible?!) they should not be included. See the
   'active_model_attrs' if you'd like to test.
 
-== CouchRest Model 1.0.0.beta8
+## CouchRest Model 1.0.0.beta8
 
 * Major enhancements
 	* Added model generator
@@ -67,7 +78,7 @@ Notes:
   * Parsing times without zone
   * Using latest rspec (2.0.0.beta.19)
 
-== CouchRest Model 1.0.0.beta7
+## CouchRest Model 1.0.0.beta7
 
 * Major enhancements
   * Renamed ExtendedDocument to CouchRest::Model
@@ -83,7 +94,7 @@ Notes:
   * Removed support for auto_validate! and :length on properties
 
 
-== 1.0.0.beta6
+## 1.0.0.beta6
 
 * Major enhancements
   * Added support for anonymous CastedModels defined in Documents
@@ -97,12 +108,12 @@ Notes:
   * Setting a property of type Array (or keyed hash) must be an array or an error will be raised.
   * Now possible to set Array attribute from hash where keys determine order.
 
-== 1.0.0.beta5
+## 1.0.0.beta5
 
 * Minor enhancements
   * Added 'find' alias for 'get' for easier rails transition
 
-== 1.0.0.beta3
+## 1.0.0.beta3
 
 * Minor enhancements
   * Removed Validation by default, requires too many structure changes (FAIL)
@@ -112,12 +123,12 @@ Notes:
   * Added support for setting type directly on property (Sam Lown)
 
 
-== 1.0.0.beta2
+## 1.0.0.beta2
 
 * Minor enhancements
   * Enable Validation by default and refactored location (Sam Lown)
 
-== 1.0.0.beta
+## 1.0.0.beta
 
 * Major enhancements
   * Separated ExtendedDocument from main CouchRest gem (Sam Lown)
@@ -125,12 +136,12 @@ Notes:
 * Minor enhancements
   * active_support included by default
 
-== 0.37
+## 0.37
 
 * Minor enhancements
   * Added gemspec (needed for Bundler install) (Tapajós)
 
-== 0.36
+## 0.36
 
 * Major enhancements
   * Adds support for continuous replication (sauy7)
@@ -140,7 +151,7 @@ Notes:
 * Minor enhancements
   * Provide a description of the timeout error (John Wood)
 
-== 0.35
+## 0.35
 
 * Major enhancements
   * CouchRest::ExtendedDocument allow chaining the inherit class callback (Kenneth Kalmer) - http://github.com/couchrest/couchrest/issues#issue/8
@@ -156,7 +167,7 @@ Notes:
   * Added an update_doc method to database to handle conflicts during atomic updates. (Pierre Larochelle)
   * Bug fix: http://github.com/couchrest/couchrest/issues/#issue/2 (Luke Burton)
 
-== 0.34
+## 0.34
 
 * Major enhancements
 
@@ -181,7 +192,7 @@ Notes:
   * Fix Initialization of ExtendentDocument model shouldn't failed on a nil value in argument (deepj)
   * Change to use Jeweler and Gemcutter (Marcos Tapajós)
 
-== 0.33
+## 0.33
 
 * Major enhancements
 
@@ -196,7 +207,7 @@ Notes:
   * Created a new abstraction layer for the REST API (Matt Aimonetti)
   * Bug fix: made ExtendedDocument#all compatible with Couch 0.10 (tc)
 
-== 0.32
+## 0.32
 
 * Major enhancements
 
@@ -211,7 +222,7 @@ Notes:
   * Bug fix: the count method on the proxy collection was missing (Daniel Kirsch)
   * Added #amount_pages to a paginated collection. (Matt Aimonetti)
 
-== 0.31
+## 0.31
 
 * Major enhancements
 
@@ -225,7 +236,7 @@ Notes:
   * Optimized ExtendedDocument.count to run about 3x faster (Matt Aimonetti)
   * Added Float casting (Ryan Felton & Matt Aimonetti)
 
-== 0.30
+## 0.30
 
 * Major enhancements
 

data/lib/couchrest/model/base.rb

@@ -5,9 +5,10 @@ module CouchRest
       extend ActiveModel::Naming
 
       include CouchRest::Model::Configuration
+      include CouchRest::Model::Connection
       include CouchRest::Model::Persistence
       include CouchRest::Model::Callbacks
-      include CouchRest::Model::DocumentQueries    
+      include CouchRest::Model::DocumentQueries
       include CouchRest::Model::Views
       include CouchRest::Model::DesignDoc
       include CouchRest::Model::ExtendedAttachments

data/lib/couchrest/model/configuration.rb

@@ -11,11 +11,27 @@ module CouchRest
         add_config :model_type_key
         add_config :mass_assign_any_attribute
         add_config :auto_update_design_doc
+        add_config :environment
+        add_config :connection
+        add_config :connection_config_file
 
         configure do |config|
-          config.model_type_key = 'model' # was 'couchrest-type'
+          config.model_type_key = 'type' # was 'couchrest-type'
           config.mass_assign_any_attribute = false
           config.auto_update_design_doc = true
+
+          config.environment = :development
+          config.connection_config_file = File.join(Dir.pwd, 'config', 'couchdb.yml')
+          config.connection = {
+            :protocol => 'http',
+            :host     => 'localhost',
+            :port     => '5984',
+            :prefix   => 'couchrest',
+            :suffix   => nil,
+            :join     => '_',
+            :username => nil,
+            :password => nil
+          }
         end
       end
 

data/lib/couchrest/model/connection.rb

@@ -0,0 +1,70 @@
+module CouchRest
+  module Model
+    module Connection
+      extend ActiveSupport::Concern
+
+      def server
+        self.class.server
+      end
+
+      module ClassMethods
+
+        # Overwrite the normal use_database method so that a database
+        # name can be provided instead of a full connection.
+        def use_database(db)
+          @database = prepare_database(db)
+        end
+
+        # Overwrite the default database method so that it always
+        # provides something from the configuration
+        def database
+          super || (@database ||= prepare_database)
+        end
+
+        def server
+          @server ||= CouchRest::Server.new(prepare_server_uri)
+        end
+
+        def prepare_database(db = nil)
+          unless db.is_a?(CouchRest::Database)
+            conf = connection_configuration
+            db = [conf[:prefix], db.to_s, conf[:suffix]].reject{|s| s.to_s.empty?}.join(conf[:join])
+            self.server.database!(db)
+          else
+            db
+          end
+        end
+
+        protected
+
+        def prepare_server_uri
+          conf = connection_configuration
+          userinfo = [conf[:username], conf[:password]].compact.join(':')
+          userinfo += '@' unless userinfo.empty?
+          "#{conf[:protocol]}://#{userinfo}#{conf[:host]}:#{conf[:port]}"
+        end
+
+        def connection_configuration
+          @connection_configuration ||=
+            self.connection.update(
+              (load_connection_config_file[environment.to_sym] || {}).symbolize_keys
+            )
+        end
+
+        def load_connection_config_file
+          file = connection_config_file
+          connection_config_cache[file] ||=
+            (File.exists?(file) ?
+              YAML::load(ERB.new(IO.read(file)).result) :
+              { }).symbolize_keys
+        end
+
+        def connection_config_cache
+          Thread.current[:connection_config_cache] ||= {}
+        end
+
+      end
+
+    end
+  end
+end

data/lib/couchrest/model/designs.rb

@@ -65,6 +65,17 @@ module CouchRest
           create_view_method(name)
         end
 
+        # Really simple design function that allows a filter
+        # to be added. Filters are simple functions used when listening
+        # to the _changes feed.
+        #
+        # No methods are created here, the design is simply updated.
+        # See the CouchDB API for more information on how to use this.
+        def filter(name, function)
+          filters = (self.model.design_doc['filters'] ||= {})
+          filters[name.to_s] = function
+        end
+
         def create_view_method(name)
           model.class_eval <<-EOS, __FILE__, __LINE__ + 1
             def self.#{name}(opts = {})

data/lib/couchrest/model/persistence.rb

@@ -89,7 +89,6 @@ module CouchRest
         self
       end
 
-
       protected
 
       def perform_validations(options = {})

data/lib/couchrest/model/properties.rb

@@ -140,7 +140,7 @@ module CouchRest
       module ClassMethods
 
         def property(name, *options, &block)
-          raise "Invalid property definition, '#{name}' already used for CouchRest Model type field" if name.to_s == model_type_key.to_s
+          raise "Invalid property definition, '#{name}' already used for CouchRest Model type field" if name.to_s == model_type_key.to_s && CouchRest::Model::Base >= self
           opts = { }
           type = options.shift
           if type.class != Hash

data/lib/couchrest/model/proxyable.rb

@@ -4,8 +4,14 @@ module CouchRest
     module Proxyable
       extend ActiveSupport::Concern
 
+      def proxy_database
+        raise StandardError, "Please set the #proxy_database_method" if self.class.proxy_database_method.nil?
+        @proxy_database ||= self.class.prepare_database(self.send(self.class.proxy_database_method))
+      end
+
       module ClassMethods
 
+
         # Define a collection that will use the base model for the database connection
         # details.
         def proxy_for(assoc_name, options = {})
@@ -13,19 +19,19 @@ module CouchRest
           options[:class_name] ||= assoc_name.to_s.singularize.camelize
           class_eval <<-EOS, __FILE__, __LINE__ + 1
             def #{assoc_name}
-              unless respond_to?('#{db_method}')
-                raise "Missing ##{db_method} method for proxy"
-              end
               @#{assoc_name} ||= CouchRest::Model::Proxyable::ModelProxy.new(::#{options[:class_name]}, self, self.class.to_s.underscore, #{db_method})
             end
           EOS
         end
 
+        # Tell this model which other model to use a base for the database
+        # connection to use.
         def proxied_by(model_name, options = {})
           raise "Model can only be proxied once or ##{model_name} already defined" if method_defined?(model_name) || !proxy_owner_method.nil?
           self.proxy_owner_method = model_name
           attr_accessor :model_proxy
           attr_accessor model_name
+          overwrite_database_reader(model_name)
         end
 
         # Define an a class variable accessor ready to be inherited and unique
@@ -34,6 +40,25 @@ module CouchRest
         def proxy_owner_method=(name); @proxy_owner_method = name; end
         def proxy_owner_method; @proxy_owner_method; end
 
+        # Define the name of a method to call to determine the name of
+        # the database to use as a proxy.
+        def proxy_database_method(name = nil)
+          @proxy_database_method = name if name
+          @proxy_database_method
+        end
+
+        private
+
+        # Ensure that no attempt is made to autoload a database connection
+        # by overwriting it to provide a basic accessor.
+        def overwrite_database_reader(model_name)
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def self.database
+              raise StandardError, "#{self.to_s} database must be accessed via '#{model_name}' proxy"
+            end
+          EOS
+        end
+
       end
 
       class ModelProxy

data/lib/couchrest/railtie.rb

@@ -1,12 +1,21 @@
 require "rails"
 require "active_model/railtie"
 
-module CouchrestModel
+module CouchRest
   # = Active Record Railtie
-  class Railtie < Rails::Railtie
+  class ModelRailtie < Rails::Railtie
     config.generators.orm :couchrest_model
     config.generators.test_framework  :test_unit, :fixture => false
+
+    initializer "couchrest_model.configure_default_connection" do
+      CouchRest::Model::Base.configure do |conf|
+        conf.environment = Rails.env
+        conf.connection_config_file = File.join(Rails.root, 'config', 'couchdb.yml')
+        conf.connection[:prefix] =
+          Rails.application.class.to_s.underscore.gsub(/\/.*/, '')
+      end
+    end
   end
-  
+
 end
-                                      
+

data/lib/couchrest_model.rb

@@ -46,6 +46,7 @@ require "couchrest/model/proxyable"
 require "couchrest/model/collection"
 require "couchrest/model/associations"
 require "couchrest/model/configuration"
+require "couchrest/model/connection"
 require "couchrest/model/designs"
 require "couchrest/model/designs/view"
 
@@ -61,4 +62,6 @@ require "couchrest/model/casted_model"
 require "couchrest/model/base"
 # Add rails support *after* everything has loaded
 
-require "couchrest/railtie"
+if defined?(Rails)
+  require "couchrest/railtie"
+end

data/spec/couchrest/configuration_spec.rb

@@ -59,7 +59,7 @@ describe CouchRest::Model::Base do
   describe "General examples" do
 
     before(:all) do
-      @default_model_key = 'model'
+      @default_model_key = 'model-type'
     end