couchrest_model 2.0.4 → 2.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc12bf9934bec928c3317599950ad2ac7b57e623
-  data.tar.gz: 4244221435ea4d8dbd33a6c184ed97926ba5cf14
+  metadata.gz: 57c0015876d459e0bee7cfb9e3f59a2aa5231d1d
+  data.tar.gz: 7c0e6f7444fa9e73fc041946c5736f94eb42b765
 SHA512:
-  metadata.gz: 337c15afdd8264dfd16341d50ac85a25f8651946f0b1994135e02ac118f63dbde6c7688c4a21e44e21eb639d85aa0f892d979b5465f3d9c516fd9141a9433756
-  data.tar.gz: 9200d9be82615a00e475f05947ccbcef682ab5867a23810368146db85064a63ac46f8f6453efd661a64c16f805376060d65dddcc58cae74ec7892637aeebcfe8
+  metadata.gz: 306a335f39a5530bd4273731affe1f1c238b0e487177d3340b8c6e9cefa885ec2e2048182cd008b3a3ab12ca31d487110f8e0bca036d28639b8d1b74c8872238
+  data.tar.gz: 9d09641f25b138dbb3c56cfbbe2663947d6ed04135a64d5d4157b8f94d068881989ac79f0f19d7e0c1af64cee4d42aedc9534becdc26c97551b04c8193ef0a5e

data/.travis.yml

@@ -1,8 +1,12 @@
 rvm:
+  - 2.3.0
+  - 2.2.2
+  - 2.1.5
   - 2.0.0
-  - 1.9.3
-  - jruby
+  - jruby-19mode
 services: couchdb
 matrix:
   allow_failures:
     - rvm: jruby
+before_install:
+  - gem install bundler

data/README.md

@@ -7,7 +7,7 @@ CouchRest Model helps you define models that are stored as documents in your Cou
 It supports useful features such as setting properties with typecasting, callbacks, validations, associations, and helps
 with creating CouchDB views to access your data.
 
-CouchRest Model uses ActiveModel for a lot of the magic, so if you're using Rails, you'll need at least version 3.0. The latest release (since 2.0.0) is Rails 4.0 compatible, and we recommend Ruby 2.0+.
+CouchRest Model uses ActiveModel for a lot of the magic, so if you're using Rails, you'll need at least version 3.0. Releases since 2.0.0 are Rails 4.0 compatible, and we recommend Ruby 2.0+.
 
 ## Documentation
 
@@ -60,9 +60,9 @@ The library will try to detect a configuration file at `config/couchdb.yml` from
       username: test
       password: user
 
-Note that the name of the database is either just the prefix and suffix combined or the prefix plus any text you specifify using `use_database` method in your models with the suffix on the end.
+Note that the name of the database is either just the prefix and suffix combined or the prefix plus any text you specify using `use_database` method in your models with the suffix on the end.
 
-The example config above for example would use a database called "project_test". Heres an example using the `use_database` call:
+The example config above for example would use a database called "project_test". Here's an example using the `use_database` call:
 
 ```ruby
 class Project < CouchRest::Model::Base
@@ -140,6 +140,15 @@ end
 @cat.update_attributes(:name => 'Felix', :random_text => 'feline')
 @cat.new? # false
 @cat.random_text  # Raises error!
+
+# Fetching by views, loading all results into memory
+cats = Cat.by_name.all
+cats.first.name # "Felix"
+
+# Streaming views, for efficient memory usage
+Cat.by_name.all do |cat|
+  puts cat.name
+end
 ```
 
 ## Development

data/VERSION

@@ -1 +1 @@
-2.0.4
+2.1.0.beta1

data/benchmarks/Gemfile

@@ -0,0 +1,7 @@
+
+source 'https://rubygems.org'
+
+#gem 'couchrest_model', '2.0.4'
+gem 'couchrest_model', path: '../'
+gem 'faker'
+

data/benchmarks/connections.rb

@@ -0,0 +1,69 @@
+#
+# Simple Benchmarking Script.
+#
+# Meant to test performance for different types on connections under a typical
+# scenario of requesting multiple objects from the database in series.
+#
+# To run, use `bundle install` then:
+#
+#   bundle exec ruby connections.rb
+#
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'benchmark'
+require 'couchrest_model'
+require 'faker'
+
+class SampleModel < CouchRest::Model::Base
+  use_database "benchmark"
+
+  property :name, String
+  property :date, Date
+
+  timestamps!
+
+  design do
+    view :by_name
+  end
+end
+
+
+Benchmark.bm do |x|
+  x.report("Create:        ") do
+    100.times do |i|
+      m = SampleModel.new(
+        name: Faker::Name.name, 
+        date: Faker::Date.between(1.year.ago, Date.today)
+      )
+      m.save!
+    end
+  end
+
+  # Make sure the view is fresh
+  SampleModel.by_name.limit(1).rows
+
+  x.report("Fetch inc/docs:") do
+    SampleModel.by_name.all.each do |doc|
+      doc.to_json
+    end
+  end 
+
+  x.report("Fetch:         ") do
+    SampleModel.by_name.rows.each do |row|
+      row.doc.to_json # Causes each doc to be fetched
+    end
+  end
+
+  if CouchRest::Model::VERSION >= '2.1.0'
+    x.report("Fetch w/block: ") do
+      SampleModel.by_name.rows do |row|
+        row.doc.to_json # Causes each doc to be fetched
+      end
+    end
+  end
+end
+
+SampleModel.database.delete!
+

data/couchrest_model.gemspec

@@ -14,24 +14,22 @@ Gem::Specification.new do |s|
     "THANKS.md"
   ]
   s.homepage = %q{http://github.com/couchrest/couchrest_model}
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Extends the CouchRest Document for advanced modelling.}
+  #s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Extends the CouchRest Document class for advanced modelling.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency(%q<couchrest>, "~> 1.2.1")
-  s.add_dependency(%q<mime-types>, ">= 1.16")
-  s.add_dependency(%q<activemodel>, ">= 4.0", ">= 3.0")
-  s.add_dependency(%q<tzinfo>, ">= 0.3.22")
-  s.add_development_dependency(%q<rspec>, "~> 2.6.0")
-  s.add_development_dependency(%q<json>, ["~> 1.5.1"])
-  s.add_development_dependency(%q<rack-test>, ">= 0.5.7")
+  s.add_dependency("couchrest",   "2.0.0.rc3")
+  s.add_dependency("activemodel", "~> 4.0")
+  s.add_dependency("tzinfo",      ">= 0.3.22")
+  s.add_development_dependency("rspec", "~> 2.14.1")
+  s.add_development_dependency("rack-test", ">= 0.5.7")
   s.add_development_dependency("rake", ">= 0.8.0")
-  #s.add_development_dependency("debugger", "~> 1.2.0") # TODO put in Gemfile
-  #s.add_development_dependency(%q<oj>, "~> 1.3.4") # TODO put in Gemfile (fails in JRuby)
-  s.add_development_dependency("kaminari", "~> 0.14.1")
-  # s.add_development_dependency("jruby-openssl", ">= 0.7.3")
+  s.add_development_dependency("test-unit")
+  s.add_development_dependency("minitest", "> 4.1") #, "< 5.0") # For Kaminari and activesupport, pending removal
+  s.add_development_dependency("kaminari", ">= 0.14.1", "< 0.16.0")
+  s.add_development_dependency("mime-types", "< 3.0") # Mime-types > 3.0 don't bundle properly on JRuby
 end

data/history.md

@@ -1,5 +1,11 @@
 # CouchRest Model Change History
 
+## 2.1.0.beta1 - 2016-01-13
+
+  * Upgrading to CouchRest 2.0.0 series (@samlown)
+  * Support for streaming in View objects (@samlown)
+  * Support for ActiveModel >= 4.1 (@samlown)
+
 ## 2.0.4 - 2015-06-26
 
   * Casting Array properties using anything that inherits from Hash. (@samlown)

data/lib/couchrest/model/design.rb

@@ -120,8 +120,6 @@ module CouchRest
       def load_from_database(db = database, id = nil)
         id ||= self['_id']
         db.get(id)
-      rescue RestClient::ResourceNotFound
-        nil
       end
 
       # Calculate and update the checksum of the Design document.

data/lib/couchrest/model/designs/view.rb

@@ -58,10 +58,16 @@ module CouchRest
         # are no results.
         def rows
           return @rows if @rows
-          if execute && result['rows']
-            @rows ||= result['rows'].map{|v| ViewRow.new(v, model)}
-          else 
-            [ ]
+          if block_given?
+            execute do |row|
+              yield ViewRow.new(row, model, use_database)
+            end
+          else
+            if execute && result['rows']
+              @rows ||= result['rows'].map{|v| ViewRow.new(v, model, use_database)}
+            else 
+              [ ]
+            end
           end
         end
 
@@ -69,16 +75,22 @@ module CouchRest
         # not already been prepared for including documents in the query,
         # it will be added automatically and reset any previously cached
         # results.
-        def all
+        def all(&block)
           include_docs!
-          docs
+          docs(&block)
         end
 
         # Provide all the documents from the view. If the view has not been
         # prepared with the +include_docs+ option, each document will be 
         # loaded individually.
         def docs
-          @docs ||= rows.map{|r| r.doc}
+          if block_given?
+            rows do |row|
+              yield row.doc
+            end
+          else
+            @docs ||= rows.map{|r| r.doc}
+          end
         end
 
         # If another request has been made on the view, this will return 
@@ -413,16 +425,16 @@ module CouchRest
           query[:database] || model.database
         end
 
-        def execute
+        def execute(&block)
           return self.result if result
-          raise "Database must be defined in model or view!" if use_database.nil?
+          raise CouchRest::Model::DatabaseNotDefined if use_database.nil?
 
           # Remove the reduce value if its not needed to prevent CouchDB errors
           query.delete(:reduce) unless can_reduce?
 
           design_doc.sync(use_database)
 
-          self.result = design_doc.view_on(use_database, name, query)
+          self.result = design_doc.view_on(use_database, name, query, &block)
         end
 
         # Class Methods
@@ -535,9 +547,10 @@ module CouchRest
       # A special wrapper class that provides easy access to the key
       # fields in a result row.
       class ViewRow < Hash
-        attr_reader :model
-        def initialize(hash, model)
-          @model    = model
+        attr_reader :model, :db
+        def initialize(hash, model, db = nil)
+          @model = model
+          @db    = db || model.database
           replace(hash)
         end
         def id
@@ -555,9 +568,16 @@ module CouchRest
         # Send a request for the linked document either using the "id" field's
         # value, or the ["value"]["_id"] used for linked documents.
         def doc
-          return model.build_from_database(self['doc']) if self['doc']
-          doc_id = (value.is_a?(Hash) && value['_id']) ? value['_id'] : self.id
-          doc_id ? model.get(doc_id) : nil
+          @doc ||= begin
+            if self['doc']
+              obj = model.build_from_database(self['doc'])
+              obj.database ||= db
+              obj
+            else
+              doc_id = (value.is_a?(Hash) && value['_id']) ? value['_id'] : self.id
+              doc_id ? model.get(doc_id, db) : nil
+            end
+          end
         end
       end
 

data/lib/couchrest/model/document_queries.rb

@@ -33,11 +33,9 @@ module CouchRest
         # id<String, Integer>:: Document ID
         # db<Database>:: optional option to pass a custom database to use
         def get(id, db = database)
-          begin
-            get!(id, db)
-          rescue
-            nil
-          end
+          get!(id, db)
+        rescue CouchRest::Model::DocumentNotFound
+          nil
         end
         alias :find :get
 
@@ -54,11 +52,9 @@ module CouchRest
         # db<Database>:: optional option to pass a custom database to use
         def get!(id, db = database)
           raise CouchRest::Model::DocumentNotFound if id.blank?
-
-          doc = db.get id
+          raise CouchRest::Model::DatabaseNotDefined if db.nil?
+          doc = db.get(id) or raise CouchRest::Model::DocumentNotFound
           build_from_database(doc)
-        rescue RestClient::ResourceNotFound
-          raise CouchRest::Model::DocumentNotFound
         end
         alias :find! :get!
 

data/lib/couchrest/model/errors.rb

@@ -21,5 +21,13 @@ module CouchRest
     end
 
     class DocumentNotFound < Errors::CouchRestModelError; end
+
+    class DatabaseNotDefined < Errors::CouchRestModelError
+      def initialize(msg = nil)
+        msg ||= "Database must be defined in model or view!"
+        super(msg)
+      end
+    end
+
   end
 end

data/lib/couchrest/model/support/couchrest_database.rb

@@ -3,11 +3,19 @@
 # also emptied. Given that this is a rare event, and the consequences are not 
 # very severe, we just completely empty the cache.
 #
-CouchRest::Database.class_eval do
+module CouchRest::Model
+  module Support
+    module Database
 
-  def delete!
-    Thread.current[:couchrest_design_cache] = { }
-    CouchRest.delete @root
+      def delete!
+        Thread.current[:couchrest_design_cache] = { }
+        super
+      end
+
+    end
   end
+end
 
+class CouchRest::Database
+  include(CouchRest::Model::Support::Database)
 end

data/lib/couchrest/model/validations.rb

@@ -55,7 +55,7 @@ module CouchRest
         # Asside from the standard options, you can specify the name of the view you'd like
         # to use for the search inside the +:view+ option. The following example would search
         # for the code in side the +all+ view, useful for when +unique_id+ is used and you'd
-        # like to check before receiving a RestClient Conflict error:
+        # like to check before receiving a CouchRest::Conflict error:
         #
         #   validates_uniqueness_of :code, :view => 'all'
         #

data/lib/couchrest/model/validations/uniqueness.rb

@@ -7,9 +7,16 @@ module CouchRest
       # Validates if a field is unique 
       class UniquenessValidator < ActiveModel::EachValidator
 
+        SETUP_DEPRECATED = ActiveModel.respond_to?(:version) && ActiveModel.version >= Gem::Version.new('4.1')
+
+        def initialize(options = {})
+          super
+          setup_uniqueness_validation(options[:class]) if options[:class]
+        end
+
         # Ensure we have a class available so we can check for a usable view
         # or add one if necessary.
-        def setup(model)
+        def setup_uniqueness_validation(model)
           @model = model
           if options[:view].blank?
             attributes.each do |attribute|
@@ -24,6 +31,9 @@ module CouchRest
           end
         end
 
+        # Provide backwards compatibility for Rails < 4.1, which expects `#setup` to be defined.
+        alias_method :setup, :setup_uniqueness_validation unless SETUP_DEPRECATED
+
         def validate_each(document, attribute, value)
           opts = merge_view_options(attribute)
 

data/spec/fixtures/models/course.rb

@@ -3,7 +3,7 @@ require 'person'
 require 'money'
 
 class Course < CouchRest::Model::Base
-  use_database TEST_SERVER.default_database
+  use_database DB 
   
   property :title, String
   property :subtitle, String, :allow_blank => false

data/spec/spec_helper.rb

@@ -18,7 +18,7 @@ unless defined?(FIXTURE_PATH)
   COUCHHOST = "http://127.0.0.1:5984"
   TESTDB    = 'couchrest-model-test'
   TEST_SERVER    = CouchRest.new COUCHHOST
-  TEST_SERVER.default_database = TESTDB
+  # TEST_SERVER.default_database = TESTDB
   DB = TEST_SERVER.database(TESTDB)
 end
 
@@ -38,7 +38,7 @@ end
 Dir[ File.join(MODEL_PATH, "*.rb") ].sort.each { |file| require File.basename(file) }
 
 class Basic < CouchRest::Model::Base
-  use_database TEST_SERVER.default_database
+  use_database DB
 end
 
 def reset_test_db!

data/spec/unit/assocations_spec.rb

@@ -25,7 +25,7 @@ describe "Assocations" do
     end
 
     it "should generate a proxy string if proxied" do
-      SaleInvoice.stub!(:proxy_owner_method).twice.and_return('company')
+      SaleInvoice.stub(:proxy_owner_method).twice.and_return('company')
       o = SaleInvoice.merge_assoc_opts(:cat)
       o[:proxy].should eql('self.company.cats')
     end