georgepalmer-couch_foo 0.7.12 → 0.7.13

data/README.rdoc

@@ -42,14 +42,14 @@ are a few minor differences to the way CouchDB works.  In particular:
 * Because there's no SQL there's no SQL finder methods
 * Timezones, aggregations and fixtures are not yet implemented
 * The price of index updating is paid when next accessing the index rather than the point of insertion.  This can be more efficient or less depending on your application.  It may make sense to use an external process to do the updating for you - see CouchFoo#find for more on this
-* On that note, occasional compacting of CouchDB is required to recover space from old versions of documents.  This can be kicked off in several ways (see quick start guide)
+* On that note, compacting of CouchDB is required to recover space from old versions of documents and keep performance fast.  This can be kicked off in several ways (see quick start guide)
 
 It is recommend that you read the quick start and performance sections in the rdoc for a full overview of differences and points to be aware of when developing.  The Changelog file shows the differences between gem versions and should be checked when upgrading gem versions.
 
 
 == Getting started
 
-  CouchFoo::Base.set_database("http://localhost:5984/opnli_dev", <yourcouchdbversion>)
+  CouchFoo::Base.set_database(:host => "http://localhost:5984", :database => "mydatabase")
   CouchFoo::Base.logger = Rails.logger
 
 If using with Rails you will need to create an initializer to do this (until proper integration is added)

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 7
-:patch: 12
+:patch: 13

data/lib/couch_foo/base.rb

@@ -129,9 +129,8 @@ module CouchFoo
   # CouchDB has a concept called bulk saving where mutliple operations can be built up and commited
   # at once.  This has the added advantage of being in a transaction so all or none of the operations
   # will complete.  By default bulk saving is switched off but you can set the 
-  # CouchFoo::Base.bulk_save_default option or override on an individual database basis if you
-  # wish to use this feature.  If using bulk_saving there are good performance gains when updating
-  # large amounts of documents but beaware it is the developers responsability to commit the work.
+  # CouchFoo::Base.bulk_save_default setting to true to achieve good performance gains when updating
+  # large amounts of documents.  Beware it is the developers responsability to commit the work though.
   # For example:
   # 
   #   User.all.size # => 27
@@ -148,7 +147,7 @@ module CouchFoo
   # the document into memory another person or program has altered its contents.  CouchDB detects
   # this through the _rev attribute.  If a conflict occurs a DocumentConflict error is raised. This
   # is effectively the same as ActiveRecord Optimistic locking mechanism.  Exceptions should be
-  # dealt with in application logic.
+  # dealt with in application logic if using save! - save will just return false
   #
   # On the finders and associations there are a few options that are no longer relevant - :select,
   # :joins, :having, :group, :from and :lock  Everything else is available although :conditions and
@@ -201,16 +200,15 @@ module CouchFoo
   # 
   # Connecting to the database is done in a way similar to ActiveRecord where the database is
   # inherited by each subclass unless overridden.  In CouchFoo you use the call set_database method
-  # with a URL and CouchDB version if you're not on edge (this gem supports 0.8 and 0.9 edge).  As
-  # there's no database connection to be maintained sharding data is very efficient and some
-  # applications even use one database per user.
+  # with a host and database name.  As there's no database connection to be maintained sharding data
+  # is very efficient and some applications even use one database per user.
   # 
   # If using rails, for now you need to specify your own initializer to make the default database
   # connection.  This will be brought inline with rails in the future, using a couchdb.yml 
   # configuration file or similar.  But for now an initializer file in config/initializers like the 
-  # follwing will do the trick:
+  # following will do the trick:
   #
-  #   CouchFoo::Base.set_database("http://localhost:5984/opnli_dev", 0.8)  
+  #   CouchFoo::Base.set_database(:host => "http://localhost:5984", :database => "mydatabase")
   #   CouchFoo::Base.logger = Rails.logger
   #
   # A few tidbits:
@@ -218,7 +216,7 @@ module CouchFoo
   # * validates_uniqueness_of has had the :case_sensitive option dropped
   # * Because there's no SQL there's no SQL finder methods but equally there's no SQL injection to worry about.  You should still sanitize output when displaying back to the user though because you will still be vunerable to JS attacks etc.
   # * Some operations are more efficient than relational databases, others less so.  See the performance section for more details on this
-  # * Every so often the database will need compacting to recover space lost to old document revisions.  See http://wiki.apache.org/couchdb/Compaction for more details on this.
+  # * Every so often the database will need compacting to recover space lost to old document revisions.  More importantly initial indications show un-compacted databases can effect performance.  See http://wiki.apache.org/couchdb/Compaction for more details on this.
   #
   # The following things are not in this implementation (but are in ActiveRecord):
   # * :include - Although the finders and associations allow this option the actual implementation is yet to be written

data/lib/couch_foo/database.rb

@@ -1,17 +1,15 @@
 require 'couchrest'
 
 # This class wrappers CouchRest but may ultimately replace it as only parts of the library are used
-module CouchFoo  
-  LATEST_COUCHDB_VERSION = 0.9
-  
+module CouchFoo 
   class DatabaseWrapper
     
     attr_accessor :database, :database_version, :bulk_save_default
     
-    def initialize(database_url, bulk_save_default, version, *args)
-      self.database = CouchRest.database(database_url)
+    def initialize(options, bulk_save_default, *args)
+      self.database = CouchRest.database(options[:host] + "/" + options[:database])
       self.bulk_save_default = bulk_save_default
-      self.database_version = version
+      self.database_version = (JSON.parse(RestClient.get(options[:host]))["version"]).gsub(/-.+/,"").to_f
     end
     
     def save(doc, bulk_save = bulk_save?)
@@ -94,7 +92,8 @@ module CouchFoo
     def handle_exception(exception)
       if exception.is_a?(RestClient::ResourceNotFound)
         raise DocumentNotFound, "Couldn't find document"
-      elsif exception.is_a?(RestClient::RequestFailed) && exception.code == "409"
+      elsif exception.is_a?(RestClient::RequestFailed) && exception.respond_to?(:http_code) && exception.http_code == 412
+        
         raise DocumentConflict, "Document has been updated whilst object loaded"
       else
         # We let the rest fall through as normally CouchDB setup error
@@ -128,6 +127,10 @@ module CouchFoo
       # different databases from their parents.  As such if you only use one database for your
       # application then only one call is required to CouchFoo::Base for initial setup.
       #
+      # When using a database for the first time a version check is performed on CouchDB so that
+      # performance optimisations are run according to your database version.  At time of writing
+      # CouchDB 0.9 offers some good performance gains over 0.8
+      #
       # For ultra-scalability and using a different database for each user, perform the set_database
       # call on the CouchFoo::Base object on a before_filter using the session information to
       # determine the database to connect to.  For example:
@@ -136,7 +139,7 @@ module CouchFoo
       #   before_filter :set_user_database
       #
       #   def set_user_database
-      #     CouchFoo::Base.set_database("http://localhost:5984/user#{session[:user]}")
+      #     CouchFoo::Base.set_database(:host => "http://localhost:5984", :database => "user#{session[:user]}")
       #   end
       # end
       #
@@ -149,9 +152,9 @@ module CouchFoo
       # </ul>
       #
       # NOTE: This will work best on domains where there is little overlap between users data (eg basecamp)
-      def set_database(url, version = LATEST_COUCHDB_VERSION, bulk_save = bulk_save_default)
-        @active_database = DatabaseWrapper.new(url, bulk_save, version)
+      def set_database(options, bulk_save = bulk_save_default)
+        @active_database = DatabaseWrapper.new(options, bulk_save)
       end
     end # ClassMethods
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: georgepalmer-couch_foo
 version: !ruby/object:Gem::Version 
-  version: 0.7.12
+  version: 0.7.13
 platform: ruby
 authors: 
 - George Palmer
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-12 00:00:00 -08:00
+date: 2009-02-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -23,6 +24,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -32,6 +34,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: jchris-couchrest
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -41,6 +44,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: uuid
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: