couchrest_model 2.2.0.beta1 → 2.2.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc3de5182b5c551856bd3dbbbdea62fe97feccf8
-  data.tar.gz: 1aac104a38f10500bcfbf6d3812442b7fa6ca677
+  metadata.gz: c9da5f0b0e14df586c9cb3c85dea4f0b7de7263b
+  data.tar.gz: c921fb6038d169cc018f2144e7f64b233bedfd4f
 SHA512:
-  metadata.gz: f5c34608cb902751b5671abc660a23203cd7f340fcc05eefc670be5859f7693bb482bf05c400fd5789abfdd09affd9379ecc6589924b5ac70805a05fc0b81421
-  data.tar.gz: 39b5d65f53d8cb283f86fbfa0a3d6c27edea311dede32422cce4a0225cc42f98f2ed672cd65e01f48d176cc18a031f2758bbb12011f5391f7f57800ea88bcd80
+  metadata.gz: 70086755f3a4955131dc7523b62a156812b1dbd53c748286fe7b4b0c87817ff68b106abfb2448d627c86f8089a894a261cabe127e2a08c6d34e084ddd0c711b2
+  data.tar.gz: 8c8099e69adc06ae21e634392be1f0bc4e1b629edf7cdb4e5a4fccf092ff93d4d662e25505ec0937bac6a80ac28d0b0867926274ec9cd8689d7ac0a97e808b90

data/.travis.yml

@@ -7,19 +7,22 @@ rvm:
   - 2.2.4
   - 2.1.10
   - 2.0.0
-  - jruby
   - rbx
 services: couchdb
 before_install:
   - gem install bundler
-env:
-  - JRUBY_OPTS=--2.0
 matrix:
+  include:
+    # JRuby takes a lot more effort
+    - rvm: jruby-9.1.7.0
+      env: JRUBY_OPTS='--2.0'
+      gemfile: Gemfile.activesupport-4.x
   allow_failures:
     - rvm: 2.0.0
       gemfile: Gemfile.activesupport-5.x
     - rvm: 2.1.10
       gemfile: Gemfile.activesupport-5.x
-    - rvm: jruby
+    - rvm: jruby-1.7.22
       gemfile: Gemfile.activesupport-5.x
     - rvm: rbx # Has problems with Array#insert inheritence
+    - rvm: jruby-9.1.7.0

data/Dockerfile

@@ -0,0 +1,11 @@
+FROM ruby:2.3
+
+ENV WORK_DIR /usr/lib/couchrest_model
+
+RUN mkdir -p $WORK_DIR
+WORKDIR $WORK_DIR
+
+COPY . $WORK_DIR
+
+RUN bundle install --jobs=3 --retry=3
+

data/Gemfile

@@ -2,5 +2,7 @@
 source "https://rubygems.org"
 gemspec
 
+gem "guard-rspec", "~> 4.7.0", group: :test
+
 # Enable for testing against local couchrest
 # gem "couchrest", path: "/Users/sam/workspace/couchrest"

data/Guardfile

@@ -0,0 +1,31 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/couchrest/model/(.+)\.rb$})     { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/VERSION

@@ -1 +1 @@
-2.2.0.beta1
+2.2.0.beta2

data/couchrest_model.gemspec

@@ -22,13 +22,13 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency("couchrest",   "2.0.0")
+  s.add_dependency("couchrest",   "2.0.1")
   s.add_dependency("activemodel", ">= 4.0.2")
   s.add_dependency("tzinfo",      ">= 0.3.22")
   s.add_dependency("hashdiff",    "~> 0.3")
   s.add_development_dependency("rspec", "~> 3.5.0")
   s.add_development_dependency("rack-test", ">= 0.5.7")
-  s.add_development_dependency("rake", ">= 0.8.0")
+  s.add_development_dependency("rake", ">= 0.8.0", "< 11.0")
   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")

data/docker-compose.yml

@@ -0,0 +1,26 @@
+version: "2"
+services:
+  test:
+    build:
+      context: .
+    entrypoint: ["bundle", "exec"]
+    command: ["rspec"]
+    environment:
+      RAILS_ENV: test
+      COUCH_HOST: "http://couch:5984/"
+    depends_on:
+      - couch
+    volumes:
+      - ./:/usr/lib/couchrest_model
+    networks:
+      - couchrest_model
+  couch:
+    image: couchdb:1.6
+    ports:
+      - "5984"
+    networks:
+      - couchrest_model
+      - default
+networks:
+  couchrest_model:
+    driver: bridge

data/history.md

@@ -1,6 +1,19 @@
 # CouchRest Model Change History
 
-## 2.2.0.beta1 - pending
+## 2.2.0.beta2 - 2017-12-03
+
+  * Make View instance respond to model_name ([PR](https://github.com/couchrest/couchrest_model/pull/217) @adamcrown)
+  * Feature/proxyable custom databases ([PR](https://github.com/couchrest/couchrest_model/pull/218) @ellneal, @pacoguzman)
+  * Fix clear cache for delete db ([PR](https://github.com/couchrest/couchrest_model/pull/216) @MarkFull, @ktaragorn, @samlown) 
+  * Migration improvements and tests ([PR](https://github.com/couchrest/couchrest_model/pull/215) @ellneal)
+  * Add some guards to prevent view errors when using custom emit values ([PR](https://github.com/couchrest/couchrest_model/pull/214) @ellneal)
+  * Making running the tests a bit easier using Docker ([PR](https://github.com/couchrest/couchrest_model/pull/213) @ellneal)
+  * Upgraded to Couchrest 2.0.1 ([PR](https://github.com/couchrest/couchrest_model/pull/220) @samlown)
+  * Removed :persistent and simplifying connection handling with aim to reduce number of connections and improve multithreading ([PR](https://github.com/couchrest/couchrest_model/pull/220) @samlown)
+  * Removed passing database in views and get calls, to simplify API. Use Proxying or instantiate objects manually to use a different database.([PR](https://github.com/couchrest/couchrest_model/pull/224) @samlown)
+  * Document#reload! now raises DocumentNotFound on deleted doc ([PR](https://github.com/couchrest/couchrest_model/pull/223) @azul)
+
+## 2.2.0.beta1 - 2016-08-20
 
   * Radical re-factor of dirty tracking using Hashdiff gem, providing reliable change detection with nested data. ([PR](https://github.com/couchrest/couchrest_model/pull/211) @samlown)
   * Implement proxy for factory methods ([PR](https://github.com/couchrest/couchrest_model/pull/210) @ellneal)

data/lib/couchrest/model/connection.rb

@@ -9,33 +9,30 @@ module CouchRest
 
       module ClassMethods
 
-        # Overwrite the normal use_database method so that a database
+        # Overwrite the CouchRest::Document.use_database method so that a database
         # name can be provided instead of a full connection.
-        # The actual database will be validated when it is requested for use.
-        # Note that this should not be used with proxied models!
+        # We prepare the database immediatly, so ensure any connection details
+        # are provided in advance.
+        # Note that this will not work correctly with proxied models.
         def use_database(db)
-          @_use_database = db
+          @database = prepare_database(db)
         end
 
         # Overwrite the default database method so that it always
         # provides something from the configuration.
         # It will try to inherit the database from an ancester
-        # unless the use_database method has been used, in which
-        # case a new connection will be started.
+        # unless the use_database method has been used.
         def database
           @database ||= prepare_database(super)
         end
 
         def server
-          @server ||= CouchRest::Server.new(prepare_server_uri, :persistent => connection_configuration[:persistent])
+          @server ||= ServerPool.instance[prepare_server_uri]
         end
 
         def prepare_database(db = nil)
-          db = @_use_database unless @_use_database.nil?
           if db.nil? || db.is_a?(String) || db.is_a?(Symbol)
-            conf = connection_configuration
-            db = [conf[:prefix], db.to_s, conf[:suffix]].reject{|s| s.to_s.empty?}.join(conf[:join])
-            self.server.database!(db)
+            self.server.database!(prepare_database_name(db))
           else
             db
           end
@@ -43,6 +40,11 @@ module CouchRest
 
         protected
 
+        def prepare_database_name(base)
+          conf = connection_configuration
+          [conf[:prefix], base.to_s, conf[:suffix]].reject{|s| s.to_s.empty?}.join(conf[:join])
+        end
+
         def prepare_server_uri
           conf = connection_configuration
           userinfo = [conf[:username], conf[:password]].compact.join(':')
@@ -52,21 +54,14 @@ module CouchRest
 
         def connection_configuration
           @connection_configuration ||=
-            self.connection.update(
+            self.connection.merge(
               (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] ||= {}
+          ConnectionConfig.instance[file]
         end
 
       end

data/lib/couchrest/model/connection_config.rb

@@ -0,0 +1,32 @@
+module CouchRest
+  module Model
+  
+    # Thead safe caching of connection configuration files.
+    class ConnectionConfig
+      include Singleton
+
+      def initialize
+        @config_files = {}
+        @mutex = Mutex.new
+      end
+
+      def [](file)
+        @mutex.synchronize do
+          @config_files[file] ||= load_config(file)
+        end
+      end
+
+      private
+
+      def load_config(file)
+        if File.exists?(file)
+          YAML::load(ERB.new(IO.read(file)).result).symbolize_keys
+        else
+          { }
+        end
+      end
+
+    end
+
+  end
+end

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

@@ -46,6 +46,9 @@ module CouchRest
           id      = self['_id']
 
           if !doc
+            # make sure the checksum has been calculated
+            checksum! if !self['couchrest-hash']
+            
             # no need to migrate, just save it
             new_doc = to_hash.dup
             db.save_doc(new_doc)

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

@@ -20,21 +20,21 @@ module CouchRest
         # outside CouchRest Model.
         def initialize(design_doc, parent, new_query = {}, name = nil)
           self.design_doc = design_doc
-
-          # Extrace important non-regular query values
+          
+          # Extract options from query
           proxy  = new_query.delete(:proxy)
           delete = new_query.delete(:delete)
 
           if parent.is_a?(Class) && parent < CouchRest::Model::Base
             raise "Name must be provided for view to be initialized" if name.nil?
-            self.model    = (proxy || parent)
-            self.owner    = parent
+            self.owner    = (proxy || parent)
+            self.model    = parent
             self.name     = name.to_s
             # Default options:
             self.query    = { }
           elsif parent.is_a?(self.class)
-            self.model    = (proxy || parent.model)
-            self.owner    = parent.owner
+            self.owner    = (proxy || parent.owner)
+            self.model    = parent.model
             self.name     = parent.name
             self.query    = parent.query.dup
           else
@@ -60,11 +60,11 @@ module CouchRest
           return @rows if @rows
           if block_given?
             execute do |row|
-              yield ViewRow.new(row, model, use_database)
+              yield ViewRow.new(row, owner)
             end
           else
             if execute && result['rows']
-              @rows ||= result['rows'].map{|v| ViewRow.new(v, model, use_database)}
+              @rows ||= result['rows'].map{|v| ViewRow.new(v, owner)}
             else
               [ ]
             end
@@ -334,12 +334,6 @@ module CouchRest
           update_query(:stale => value.to_s)
         end
 
-        # Specify the database the view should use. If not defined,
-        # an attempt will be made to load its value from the model.
-        def database(value)
-          update_query(:database => value)
-        end
-
         # Set the view's proxy that will be used instead of the model
         # for any future searches. As soon as this enters the
         # new view's initializer it will be removed and set as the model
@@ -367,7 +361,7 @@ module CouchRest
         #
 
         def page(page)
-          limit(owner.default_per_page).skip(owner.default_per_page * ([page.to_i, 1].max - 1))
+          limit(model.default_per_page).skip(model.default_per_page * ([page.to_i, 1].max - 1))
         end
 
         def per(num)
@@ -400,6 +394,18 @@ module CouchRest
           (offset_value / limit_value) + 1
         end
 
+        # == ActiveRecord compatibility support
+
+        # Return the model name for #model just as User::ActiveRecord_Relation
+        # would for better ActiveRecord interoperability
+        def model_name
+          ActiveModel::Name.new(model)
+        end
+
+        def database
+          owner.database
+        end
+
         protected
 
         def include_docs!
@@ -421,20 +427,16 @@ module CouchRest
           !design_doc['views'][name]['reduce'].blank?
         end
 
-        def use_database
-          query[:database] || model.database
-        end
-
         def execute(&block)
           return self.result if result
-          raise CouchRest::Model::DatabaseNotDefined if use_database.nil?
+          raise CouchRest::Model::DatabaseNotDefined if 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)
+          design_doc.sync(database)
 
-          self.result = design_doc.view_on(use_database, name, query, &block)
+          self.result = design_doc.view_on(database, name, query, &block)
         end
 
         # Class Methods
@@ -492,8 +494,16 @@ module CouchRest
               raise "View cannot be created without recognised name, :map or :by options" if opts[:by].nil?
 
               # convert emit symbols to properties
-              opts[:emit] = "doc['#{opts[:emit]}']" if opts[:emit].is_a?(Symbol)
-              opts[:emit] = "[" + opts[:emit].map { |i| i.is_a?(Symbol) ? "doc['#{i}']" : i }.join(', ') + "]" if opts[:emit].is_a?(Array)
+              emits, emit_guards = if opts[:emit].is_a? Symbol
+                [["doc['#{opts[:emit]}']"], ["doc['#{opts[:emit]}']"]]
+              elsif opts[:emit].is_a? Array
+                [
+                  opts[:emit].map { |i| i.is_a?(Symbol) ? "doc['#{i}']" : i },
+                  opts[:emit].map { |i| i.is_a?(Symbol) ? "doc['#{i}']" : nil}.compact
+                ]
+              else
+                [[opts[:emit] || 1], nil]
+              end
 
               opts[:allow_blank] = opts[:allow_blank].nil? ? true : opts[:allow_blank]
               opts[:guards] ||= []
@@ -501,9 +511,11 @@ module CouchRest
 
               keys = opts[:by].map{|o| "doc['#{o}']"}
               emit_keys = keys.length == 1 ? keys.first : "[#{keys.join(', ')}]"
-              emit_value = opts[:emit] || 1;
+              emit_value = emits.length == 1 ? emits.first : "[#{emits.join(', ')}]"
               opts[:guards] += keys.map{|k| "(#{k} != null)"} unless opts[:allow_nil]
               opts[:guards] += keys.map{|k| "(#{k} != '')"} unless opts[:allow_blank]
+              opts[:guards] += emit_guards.map{|k| "(#{k} != null)"} unless emit_guards.nil? || opts[:allow_nil]
+              opts[:guards] += emit_guards.map{|k| "(#{k} != '')"} unless emit_guards.nil? || opts[:allow_blank]
               opts[:map] = <<-EOF
                 function(doc) {
                   if (#{opts[:guards].join(' && ')}) {
@@ -511,7 +523,7 @@ module CouchRest
                   }
                 }
               EOF
-              if opts[:reduce].nil?
+              if opts[:reduce].nil? && emit_guards.nil?
                 # Use built-in sum function by default
                 opts[:reduce] = "_sum"
               end
@@ -552,10 +564,15 @@ module CouchRest
       # A special wrapper class that provides easy access to the key
       # fields in a result row.
       class ViewRow < Hash
-        attr_reader :model, :db
-        def initialize(hash, model, db = nil)
-          @model = model
-          @db    = db || model.database
+        
+        # Owner will either be the original model, or a proxy and must respond
+        # to `#build_from_database` and `#get` calls.
+        # The owner is responsible for setting the correct database on instantiation,
+        # if required.
+        attr_reader :owner
+
+        def initialize(hash, owner)
+          @owner = owner
           replace(hash)
         end
         def id
@@ -575,12 +592,10 @@ module CouchRest
         def doc
           @doc ||= begin
             if self['doc']
-              obj = model.build_from_database(self['doc'])
-              obj.database ||= db
-              obj
+              owner.build_from_database(self['doc'])
             else
               doc_id = (value.is_a?(Hash) && value['_id']) ? value['_id'] : self.id
-              doc_id ? model.get(doc_id, db) : nil
+              doc_id ? owner.get(doc_id) : nil
             end
           end
         end