couch_potato 1.12.1 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d0a16b09e8b1a251f8639d5960980da2b50f1deb41a619253322013d24b12ae
-  data.tar.gz: 8b6e6c2a0b8e81399a1bd5addf528583b157109971948e59f9a2cf96dcd858d9
+  metadata.gz: dd4dede2152745db1f3f0bf7ff3a94dfea3c7eb427beb02292034866dd7dac22
+  data.tar.gz: 29ca77512b6bdeebcdd31847deac4957792946519dda4f658f60dd90c9dd83e4
 SHA512:
-  metadata.gz: 2d7ed319a85dbe37898f1892ff355b6e3f0f7a559b86f4f31b8d59aa69417e403e075f41f236dadc3c46f317e29526049804607767e44a8ecddc8aeff1ecf128
-  data.tar.gz: a8655290fc89f80185b21ec5722867644dacd2c7990779df325bb0ab0697156a213a0a2e6d7d492a48d1ed8dbc0a0b2a09f5aeb61f48b3c8a1e85a10236d75cc
+  metadata.gz: 21728691cd7eb4b23bd6600899655cc7fa1dbb6a15a6d40c669b53941fab30bf38cb8a95fa9a3e8f85e05d44af116f58cd20a424eedd60d417972db893c07aff
+  data.tar.gz: d2d26373afd0bcce487b35703be3bd7bd08cc7e4e108f98e8279bf81c41715b30f5590fdf8080c4b136ec95e356c857b5c50bef123b6971e67294e79cdeb180a

data/.github/workflows/ruby.yml

@@ -16,18 +16,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.7, "3.0", "3.1", "jruby"]
+        ruby: ["3.0", "3.1", "3.2", "jruby"]
         gemfile:
-          - "active_support_6_0"
-          - "active_support_6_1"
           - "active_support_7_0"
+          - "active_support_7_1"
         exclude:
           - ruby: "jruby"
             gemfile: "active_support_7_0"
-          - ruby: "3.0"
-            gemfile: "active_support_6_0"
-          - ruby: "3.1"
-            gemfile: "active_support_6_0"
     steps:
       - uses: actions/checkout@v2
       - name: Set up CouchDB

data/.gitignore

@@ -7,3 +7,4 @@ pkg
 
 .ruby-version
 .tool-versions
+.vscode/settings.json

data/CHANGES.md

@@ -1,5 +1,16 @@
 ## Changes
 
+# 1.14.0
+
+- add database_collection to models to help avoid n+1 requests
+
+# 1.13.0
+
+- add Ruby 3.2 support
+- remove Ruby 2.7 support
+- add active_support 7.1 support
+- remove active_support 6.x support
+
 # 1.12.1
 
 - re-enable aliases when parsing config yaml file

data/Rakefile

@@ -26,8 +26,8 @@ end
 
 desc 'Run all specs for all gemfiles'
 task :spec do
-  %w(7_0 6_1 6_0 5_2 5_1 5_0).each do |version|
-    Bundler.with_clean_env do
+  %w(7_1 7_0).each do |version|
+    Bundler.with_original_env do
       puts "Running tests with ActiveSupport #{version.sub('_', '.')}"
       sh "env BUNDLE_GEMFILE=gemfiles/active_support_#{version} bundle install"
       sh "env BUNDLE_GEMFILE=gemfiles/active_support_#{version} bundle exec rake spec_unit spec_functional"

data/couch_potato-rspec.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.version     = CouchPotato::RSPEC_VERSION
   s.platform    = Gem::Platform::RUBY
 
-  s.add_dependency 'rspec', '~>3.4'
+  s.add_dependency 'rspec', '~>3.12'
   s.add_development_dependency 'rake'
   s.add_dependency 'execjs', '~>2.7'
 

data/couch_potato.gemspec

@@ -13,12 +13,12 @@ Gem::Specification.new do |s|
   s.version     = CouchPotato::VERSION
   s.platform    = Gem::Platform::RUBY
 
-  s.add_dependency 'activemodel', ['>= 5.0', '< 7.1']
+  s.add_dependency 'activemodel', ['>= 5.0', '< 8.0']
   s.add_dependency 'couchrest', '~>2.0.0'
   s.add_dependency 'json', '~> 2.3'
 
   s.add_development_dependency 'rake', '~>12.0'
-  s.add_development_dependency 'rspec', '~>3.10.0'
+  s.add_development_dependency 'rspec', '~>3.12.0'
   s.add_development_dependency 'timecop'
   s.add_development_dependency 'tzinfo'
 

data/gemfiles/active_support_7_0

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'railties', '~>7.0.4'
+gem 'railties', '~>7.0.8'
 gem 'activemodel'
 gem 'execjs'
 

data/gemfiles/{active_support_6_1 → active_support_7_1}

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'railties', '~>6.1'
+gem 'railties', '~>7.1.3'
 gem 'activemodel'
 gem 'execjs'
 

data/lib/couch_potato/database.rb

@@ -224,6 +224,7 @@ module CouchPotato
       elsif processed_results.respond_to?(:each)
         processed_results.each do |document|
           document.database = self if document.respond_to?(:database=)
+          document.database_collection = processed_results if document.respond_to?(:database_collection=)
         end
       end
       processed_results
@@ -297,6 +298,7 @@ module CouchPotato
       docs = response['rows'].map { |row| row['doc'] }.compact
       docs.each do |doc|
         doc.database = self if doc.respond_to?(:database=)
+        doc.database_collection = docs if doc.respond_to?(:database_collection=)
       end
     end
 

data/lib/couch_potato/persistence/properties.rb

@@ -93,7 +93,11 @@ module CouchPotato
           active_support_module.module_eval do
             undef_method(name) if instance_methods.include?(name)
           end
-          cache = send(:attribute_method_matchers_cache)
+          cache = if respond_to?(:attribute_method_matchers_cache, true) # activemodel 7.0
+            send(:attribute_method_matchers_cache) 
+          else # activemodel 7.1
+            send(:attribute_method_patterns_cache) 
+          end
           cache.delete(name)
 
           define_attribute_method name

data/lib/couch_potato/persistence/simple_property.rb

@@ -15,12 +15,13 @@ module CouchPotato
     end
 
     class SimpleProperty  #:nodoc:
-      attr_accessor :name, :type
+      attr_accessor :name, :type, :default_value
 
       def initialize(owner_clazz, name, options = {})
         self.name = name
         @setter_name = "#{name}="
         self.type = options[:type]
+        self.default_value = options[:default]
         @type_caster = TypeCaster.new
         owner_clazz.send :include, PropertyMethods unless owner_clazz.ancestors.include?(PropertyMethods)
 

data/lib/couch_potato/persistence/type_caster.rb

@@ -32,7 +32,7 @@ module CouchPotato
       def cast_native(value, type)
         if type && !value.is_a?(type)
 
-          if %w[Integer Bignum Fixnum].include?(type.to_s)
+          if %w[Integer Bignum].include?(type.to_s)
             value.to_s.scan(NUMBER_REGEX).join.to_d.round unless value.blank?
           elsif type == Float
             value.to_s.scan(NUMBER_REGEX).join.to_f unless value.blank?

data/lib/couch_potato/persistence.rb

@@ -27,7 +27,7 @@ module CouchPotato
         ForbiddenAttributesProtection, Revisions
       base.send :include, Validation
       base.class_eval do
-        attr_accessor :_id, :_rev, :_deleted, :database
+        attr_accessor :_id, :_rev, :_deleted, :database, :database_collection
         alias_method :id, :_id
         alias_method :id=, :_id=
 

data/lib/couch_potato/version.rb

@@ -1,4 +1,4 @@
 module CouchPotato
-  VERSION = '1.12.1'.freeze
-  RSPEC_VERSION = '4.0.2'.freeze
+  VERSION = '1.14.0'.freeze
+  RSPEC_VERSION = '4.1.0'.freeze
 end

data/lib/couch_potato/view/flex_view_spec.rb

@@ -73,9 +73,11 @@ module CouchPotato
         end
 
         def docs
+          all_docs = rows.map { |r| r['doc'] }
           rows.map do |row|
             doc = row['doc']
             doc.database = database if doc.respond_to?(:database=)
+            doc.database_collection = all_docs if doc.respond_to?(:database_collection=)
             doc
           end
         end

data/lib/couch_potato.rb

@@ -54,7 +54,7 @@ module CouchPotato
   def self.use(database_name)
     resolved_database_name = resolve_database_name(database_name)
     Thread.current[:__couch_potato_databases] ||= {}
-    Thread.current[:__couch_potato_databases][resolved_database_name] ||= Database.new(couchrest_database_for_name!(resolved_database_name), name: database_name)
+    Thread.current[:__couch_potato_databases][resolved_database_name] ||= Database.new(couchrest_database_for_name(resolved_database_name), name: database_name)
   end
 
   # resolves a name to a database name/full url configured under additional databases

data/spec/create_spec.rb

@@ -34,14 +34,24 @@ describe "create" do
   end
 
   describe "multi-db" do
-    TEST_DBS = ['comment_a', 'comment_b', 'comment_c']
+    let(:test_dbs) do 
+      ['comment_a', 'comment_b', 'comment_c'].map do |name|
+        if ENV['DATABASE']
+          uri = URI.parse(ENV['DATABASE'])
+          uri.path  = "/#{name}"
+          uri.to_s
+        else
+          name
+        end
+      end
+    end
 
     before(:each) do
-      TEST_DBS.each { |db_name| CouchPotato.couchrest_database_for_name(db_name).recreate! }
+      test_dbs.each { |db_name| CouchPotato.couchrest_database_for_name(db_name).recreate! }
     end
 
     it "should create documents in multiple dbs" do
-      TEST_DBS.each do |db_name|
+      test_dbs.each do |db_name|
         @comment = Comment.new(:title => 'my_title')
         CouchPotato.with_database(db_name) do |couch|
           couch.save_document! @comment

data/spec/unit/attributes_spec.rb

@@ -9,7 +9,6 @@ end
 class Plant
   include CouchPotato::Persistence
   property :leaf_count
-  property :typed_leaf_count, type: Fixnum
   property :integer_something, type: Integer
   property :typed_leaf_size, type: Float
   property :branch, type: Branch
@@ -42,7 +41,7 @@ describe 'attributes' do
 
       expect(plant.attributes).to eq('leaf_count' => 1, 'created_at' => nil,
         'integer_something' => nil,
-        'updated_at' => nil, 'typed_leaf_count' => nil,
+        'updated_at' => nil,
         'typed_leaf_size' => nil, 'branch' => nil)
     end
 
@@ -112,25 +111,25 @@ describe 'attributes' do
     end
 
     describe 'integer' do
-      it 'rounds a float to a fixnum' do
+      it 'rounds a float to an integer' do
         @plant.integer_something = 4.5
 
         expect(@plant.integer_something).to eq(5)
       end
 
-      it 'converts a string into a fixnum' do
+      it 'converts a string into an integer' do
         @plant.integer_something = '4'
 
         expect(@plant.integer_something).to eq(4)
       end
 
-      it 'converts a string into a negative fixnum' do
+      it 'converts a string into a negative integer' do
         @plant.integer_something = '-4'
 
         expect(@plant.integer_something).to eq(-4)
       end
 
-      it 'leaves a fixnum as is' do
+      it 'leaves an integer as is' do
         @plant.integer_something = 4
 
         expect(@plant.integer_something).to eq(4)
@@ -161,57 +160,6 @@ describe 'attributes' do
       end
     end
 
-
-    describe 'fixnum' do
-      it 'rounds a float to a fixnum' do
-        @plant.typed_leaf_count = 4.5
-
-        expect(@plant.typed_leaf_count).to eq(5)
-      end
-
-      it 'converts a string into a fixnum' do
-        @plant.typed_leaf_count = '4'
-
-        expect(@plant.typed_leaf_count).to eq(4)
-      end
-
-      it 'converts a string into a negative fixnum' do
-        @plant.typed_leaf_count = '-4'
-
-        expect(@plant.typed_leaf_count).to eq(-4)
-      end
-
-      it 'leaves a fixnum as is' do
-        @plant.typed_leaf_count = 4
-
-        expect(@plant.typed_leaf_count).to eq(4)
-      end
-
-      it 'leaves nil as is' do
-        @plant.typed_leaf_count = nil
-
-        expect(@plant.typed_leaf_count).to be_nil
-      end
-
-      it 'sets the attributes to zero if a string given' do
-        @plant.typed_leaf_count = 'x'
-
-        expect(@plant.typed_leaf_count).to eq(0)
-      end
-
-      it 'parses numbers out of a string' do
-        @plant.typed_leaf_count = 'x123'
-
-        expect(@plant.typed_leaf_count).to eq(123)
-      end
-
-      it 'sets the attributes to nil if given a blank string' do
-        @plant.typed_leaf_count = ''
-
-        expect(@plant.typed_leaf_count).to be_nil
-      end
-    end
-
     context 'float' do
       it 'converts a number in a string with a decimal place' do
         @plant.typed_leaf_size = '0.5001'

data/spec/unit/database_spec.rb

@@ -56,6 +56,16 @@ describe CouchPotato::Database, 'load' do
     db.load '1'
   end
 
+  it 'does not set database_collection on the model' do
+    user = double('user', 'database_collection=': nil).as_null_object
+    allow(DbTestUser).to receive(:new).and_return(user)
+    allow(couchrest_db).to receive(:get).and_return DbTestUser.json_create({ JSON.create_id => 'DbTestUser' })
+    
+    db.load '1'
+
+    expect(user).not_to have_received(:database_collection=).with(db)
+  end
+
   it 'should load namespaced models' do
     allow(couchrest_db).to receive(:get).and_return Parent::Child.json_create({ JSON.create_id => 'Parent::Child' })
     expect(db.load('1').class).to eq(Parent::Child)
@@ -89,7 +99,7 @@ describe CouchPotato::Database, 'load' do
 
     it 'does not write itself to a document that has no database= method' do
       doc1 = double(:doc1)
-      allow(doc1).to receive(:respond_to?).with(:database=) { false }
+      allow(doc1).to receive(:respond_to?) { false }
       allow(couchrest_db).to receive(:bulk_load) do
         { 'rows' => [{ 'doc' => doc1 }] }
       end
@@ -99,6 +109,24 @@ describe CouchPotato::Database, 'load' do
       db.load(['1'])
     end
 
+    it 'sets database_collection on each of the documents' do
+      db.load(%w[1 2]).each do |doc|
+        expect(doc.database_collection).to eql([doc1, doc2])
+      end
+    end
+
+    it 'does not set database_collection on a document that has no database_collection= method' do
+      doc1 = double(:doc1)
+      allow(doc1).to receive(:respond_to?) { false }
+      allow(couchrest_db).to receive(:bulk_load) do
+        { 'rows' => [{ 'doc' => doc1 }] }
+      end
+
+      expect(doc1).not_to receive(:database_collection=)
+
+      db.load(['1'])
+    end
+
     it 'returns an empty array when passing an empty array' do
       expect(db.load([])).to eq([])
     end
@@ -336,7 +364,7 @@ describe CouchPotato::Database, 'view' do
     allow(CouchPotato::View::ViewQuery).to receive_messages(new: double('view query', query_view!: { 'rows' => [@result] }))
   end
 
-  it 'initialzes a view query with map/reduce/list/lib funtions' do
+  it 'initializes a view query with map/reduce/list/lib funtions' do
     allow(@spec).to receive_messages(design_document: 'design_doc', view_name: 'my_view',
                                      map_function: '<map_code>', reduce_function: '<reduce_code>',
                                      lib: { test: '<test_code>' },
@@ -355,7 +383,7 @@ describe CouchPotato::Database, 'view' do
     @db.view(@spec)
   end
 
-  it 'initialzes a view query with map/reduce/list funtions' do
+  it 'initializes a view query with map/reduce/list funtions' do
     allow(@spec).to receive_messages(design_document: 'design_doc', view_name: 'my_view',
                                      map_function: '<map_code>', reduce_function: '<reduce_code>',
                                      lib: nil, list_name: 'my_list', list_function: '<list_code>',
@@ -374,7 +402,7 @@ describe CouchPotato::Database, 'view' do
     @db.view(@spec)
   end
 
-  it 'initialzes a view query with only map/reduce/lib functions' do
+  it 'initializes a view query with only map/reduce/lib functions' do
     allow(@spec).to receive_messages(design_document: 'design_doc', view_name: 'my_view',
                                      map_function: '<map_code>', reduce_function: '<reduce_code>',
                                      list_name: nil, list_function: nil,
@@ -390,7 +418,7 @@ describe CouchPotato::Database, 'view' do
     @db.view(@spec)
   end
 
-  it 'initialzes a view query with only map/reduce functions' do
+  it 'initializes a view query with only map/reduce functions' do
     allow(@spec).to receive_messages(design_document: 'design_doc', view_name: 'my_view',
                                      map_function: '<map_code>', reduce_function: '<reduce_code>',
                                      lib: nil, list_name: nil, list_function: nil)
@@ -405,18 +433,37 @@ describe CouchPotato::Database, 'view' do
     @db.view(@spec)
   end
 
-  it 'sets itself on returned results that have an accessor' do
+  it 'sets itself on returned docs that have an accessor' do
+    allow(@result).to receive(:respond_to?).and_return(false)
     allow(@result).to receive(:respond_to?).with(:database=).and_return(true)
     expect(@result).to receive(:database=).with(@db)
     @db.view(@spec)
   end
 
-  it "does not set itself on returned results that don't have an accessor" do
-    allow(@result).to receive(:respond_to?).with(:database=).and_return(false)
+  it "does not set itself on returned docs that don't have an accessor" do
+    allow(@result).to receive(:respond_to?).and_return(false)
     expect(@result).not_to receive(:database=).with(@db)
     @db.view(@spec)
   end
 
+  it 'sets the result of the view call on each returned doc' do
+    allow(@result).to receive(:respond_to?).and_return(false)
+    allow(@result).to receive(:respond_to?).with(:database_collection=).and_return(true)
+    allow(@result).to receive(:database_collection=)
+
+    @db.view(@spec)
+
+    expect(@result).to have_received(:database_collection=).with([@result])
+  end
+
+  it "does not set the result of the view call on docs that don't have an accessor" do
+    allow(@result).to receive(:respond_to?).and_return(false)
+
+    @db.view(@spec)
+
+    expect(@result).not_to receive(:database_collection=).with([@result])
+  end
+
   it 'does not try to set itself on result sets that are not collections' do
     expect do
       allow(@spec).to receive_messages(process_results: 1)

data/spec/unit/flex_view_spec_spec.rb

@@ -15,3 +15,30 @@ RSpec.describe CouchPotato::View::FlexViewSpec::Results, '#reduce_count' do
     expect(result.reduce_count).to eq(0)
   end
 end
+
+RSpec.describe CouchPotato::View::FlexViewSpec::Results, '#docs' do
+  it 'sets the database on each doc' do
+    db = double('db')
+    doc = double('doc', 'database=': nil)
+
+    result = CouchPotato::View::FlexViewSpec::Results.new 'rows' => [{ 'doc' => doc }]
+    result.database = db
+
+    result.docs
+
+    expect(doc).to have_received(:database=).with(db)
+  end
+
+  it 'sets all docs as database_collection on each doc' do
+    doc = double('doc', 'database_collection=': nil)
+
+    result = CouchPotato::View::FlexViewSpec::Results.new 'rows' => [{ 'doc' => doc }]
+
+    result.docs
+
+    expect(doc).to have_received(:database_collection=).with([doc])
+  end
+
+  it 'returns the docs' do
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couch_potato
 version: !ruby/object:Gem::Version
-  version: 1.12.1
+  version: 1.14.0
 platform: ruby
 authors:
 - Alexander Lang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-31 00:00:00.000000000 Z
+date: 2024-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -19,7 +19,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: couchrest
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -130,9 +130,8 @@ files:
 - Rakefile
 - couch_potato-rspec.gemspec
 - couch_potato.gemspec
-- gemfiles/active_support_6_0
-- gemfiles/active_support_6_1
 - gemfiles/active_support_7_0
+- gemfiles/active_support_7_1
 - init.rb
 - lib/core_ext/date.rb
 - lib/core_ext/time.rb
@@ -231,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Ruby persistence layer for CouchDB

data/gemfiles/active_support_6_0

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'railties', '~>6.0.2.2'
-gem 'activemodel'
-gem 'execjs'
-
-gemspec name: 'couch_potato', path: '..'