mongoid-tree 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fdc505bb8df0d134efa3f5f4d3afca14603a44cd
-  data.tar.gz: 2615195789c03a83ffe7cce55218ac0c9e8ff5e3
+SHA256:
+  metadata.gz: 2d75be10c74b80e4233e3865d42bdca651a741ec3c535b41eee3da042297a195
+  data.tar.gz: 45b2f88c1d46bcd9819b66701d4d16eaef3874a6e92d09fbb4e5cc6bcd06e767
 SHA512:
-  metadata.gz: 8cd3e9933fa16933ba6044826fe5bd935b4d2f93f4580c5bf63ebf2d6480a0941dedeb48b3b06118b2827e87564020760d4b6421fcb87b760846d69296b3078b
-  data.tar.gz: 4a3609b0eb8e493952f3cf3bc222fc217a14f2a06cee2dae34f128fec7f4438a8f9ab30370cea2fbf6f146d2ff98c607e1b0afc15b70f32950aeef9ad7e27eaa
+  metadata.gz: 697aab3571146827d8a2ec7987890c185e9685b821ff8fcd3c46487d3512c962322990a36c9977b5bde7cc5ae332d153e42a2b920c1904c09efbf47118c4b2d9
+  data.tar.gz: 63426c0b41fbbc0a8559dfeda7f3e5a158b230084fff852dcd984a3919cf22d230d27df0c3b2cb4f2c934e15356859430701fbad00bcfb0d0d7e255e0e494df5

data/Gemfile

@@ -2,10 +2,18 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'guard-rspec', '>= 0.6.0'
-gem 'ruby_gntp',   '>= 0.3.4'
-gem 'rb-fsevent' if RUBY_PLATFORM =~ /darwin/
+case version = ENV['MONGOID_VERSION'] || '~> 7.0'
+when 'HEAD' then gem 'mongoid', github: 'mongodb/mongoid'
+when /8/    then gem 'mongoid', '~> 8.0'
+when /7/    then gem 'mongoid', '~> 7.0'
+when /6/    then gem 'mongoid', '~> 6.0'
+when /5/    then gem 'mongoid', '~> 5.0'
+when /4/    then gem 'mongoid', '~> 4.0'
+else             gem 'mongoid', version
+end
 
-platforms :rbx do
-  gem 'rubysl-rake', '~> 2.0'
+unless ENV['CI']
+  gem 'guard-rspec', '>= 0.6.0'
+  gem 'ruby_gntp',   '>= 0.3.4'
+  gem 'rb-fsevent' if RUBY_PLATFORM =~ /darwin/
 end

data/README.md

@@ -1,10 +1,10 @@
-# mongoid-tree [![Build Status](https://secure.travis-ci.org/benedikt/mongoid-tree.png?branch=master)](http://travis-ci.org/benedikt/mongoid-tree) [![Dependency Status](https://gemnasium.com/benedikt/mongoid-tree.png)](http://gemnasium.com/benedikt/mongoid-tree)
+# mongoid-tree [![Build Status](https://github.com/benedikt/mongoid-tree/workflows/Tests/badge.svg)](https://github.com/benedikt/mongoid-tree)
 
 A tree structure for Mongoid documents using the materialized path pattern
 
 ## Requirements
 
-* mongoid (>= 4.0, < 7.0)
+* mongoid (>= 4.0, < 9.0)
 
 For a mongoid 3.x compatible version, please use mongoid-tree 1.0.x,
 for a mongoid 2.x compatible version, please use mongoid-tree 0.7.x.
@@ -14,13 +14,13 @@ for a mongoid 2.x compatible version, please use mongoid-tree 0.7.x.
 
 To install mongoid_tree, simply add it to your Gemfile:
 
-    gem 'mongoid-tree', :require => 'mongoid/tree'
+    gem 'mongoid-tree', require: 'mongoid/tree'
 
 In order to get the latest development version of mongoid-tree:
 
-    gem 'mongoid-tree', :git => 'git://github.com/benedikt/mongoid-tree'
+    gem 'mongoid-tree', git: 'git://github.com/benedikt/mongoid-tree', branch: :main
 
-You might want to add `:require => nil` option and explicitly `require 'mongoid/tree'` where needed and finally run
+You might want to add `require: nil` option and explicitly `require 'mongoid/tree'` where needed and finally run
 
     bundle install
 
@@ -30,7 +30,7 @@ To fix issues with the ordering of ancestors, mongoid-tree 2.0 introduces a new
 
 ## Usage
 
-Read the API documentation at http://benedikt.github.com/mongoid-tree and take a look at the `Mongoid::Tree` module
+Read the API documentation at https://www.rubydoc.info/github/benedikt/mongoid-tree and take a look at the `Mongoid::Tree` module
 
 ```ruby
 class Node
@@ -189,7 +189,7 @@ end
 
 ## Build Status
 
-mongoid-tree is on [Travis CI](http://travis-ci.org/benedikt/mongoid-tree) running the specs on Ruby Head, Ruby 1.9.3, JRuby (1.9 mode), and Rubinius (1.9 mode).
+mongoid-tree is on [GitHub Actions](https://github.com/benedikt/mongoid-tree/actions) running the specs on Ruby 2.7-3.2 and Mongoid 4.x-8.x.
 
 ## Known issues
 
@@ -206,14 +206,6 @@ See [https://github.com/benedikt/mongoid-tree](https://github.com/benedikt/mongo
 See a list of all contributors at [https://github.com/benedikt/mongoid-tree/contributors](https://github.com/benedikt/mongoid-tree/contributors). Thanks a lot everyone!
 
 
-## Support
-
-If you like mongoid-tree and want to support the development, I would appreciate a small donation:
-
-[![Pledgie](http://www.pledgie.com/campaigns/12137.png?skin_name=chrome)](http://www.pledgie.com/campaigns/12137)
-
-[![Flattr](https://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=benediktdeicke&url=https://github.com/benedikt/mongoid-tree&title=mongoid-tree&language=&tags=github&category=software)
-
 ## Copyright
 
-Copyright (c) 2010-2013 Benedikt Deicke. See LICENSE for details.
+Copyright (c) 2010-2023 Benedikt Deicke. See LICENSE for details.

data/Rakefile

@@ -1,25 +1,14 @@
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'yard'
 
-spec = Gem::Specification.load("mongoid-tree.gemspec")
-
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
 YARD::Rake::YardocTask.new(:doc)
 
-desc "Build the .gem file"
-task :build do
-  system "gem build #{spec.name}.gemspec"
-end
-
-desc "Push the .gem file to rubygems.org"
-task :release => :build do
-  system "gem push #{spec.name}-#{spec.version}.gem"
-end
-
 desc "Open an irb session"
 task :console do
   sh "irb -rubygems -I lib -r ./spec/spec_helper.rb"
-end
+end

data/lib/mongoid/tree/counter_caching.rb

@@ -0,0 +1,26 @@
+module Mongoid
+  module Tree
+    ##
+    # = Mongoid::Tree::CounterCaching
+    #
+    # Mongoid::Tree doesn't use a counter cache for the children by default.
+    # To enable counter caching for each node's children, include
+    # both Mongoid::Tree and Mongoid::Tree::CounterCaching into your document.
+    module CounterCaching
+      extend ActiveSupport::Concern
+
+      included do
+        field :children_count, :type => Integer, :default => 0
+
+        metadata = relations['parent']
+        metadata.options[:counter_cache] = true
+
+        if respond_to?(:add_counter_cache_callbacks)
+          add_counter_cache_callbacks(metadata)
+        else
+          metadata.send(:define_counter_cache_callbacks!)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/tree.rb

@@ -83,6 +83,7 @@ module Mongoid
 
     autoload :Ordering, 'mongoid/tree/ordering'
     autoload :Traversal, 'mongoid/tree/traversal'
+    autoload :CounterCaching, 'mongoid/tree/counter_caching'
 
     included do
       has_many :children, :class_name => self.name, :foreign_key => :parent_id, :inverse_of => :parent, :validate => false
@@ -431,7 +432,7 @@ module Mongoid
     # @private
     # @return [undefined]
     def rearrange
-      if self.parent_id
+      if parent.present?
         self.parent_ids = parent.parent_ids + [self.parent_id]
       else
         self.parent_ids = []

data/spec/mongoid/tree/counter_caching_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Mongoid::Tree::CounterCaching do
+
+  subject { CounterCachedNode }
+
+  before do
+    setup_tree <<-ENDTREE
+      node1:
+        - node2:
+          - node3
+        - node4:
+          - node5
+          - node6
+        - node7
+    ENDTREE
+  end
+
+  context 'when a child gets created' do
+    it 'should calculate the counter cache' do
+      expect(node(:node1).children_count).to eq(3)
+    end
+  end
+
+  context 'when a child gets destroyed' do
+    it 'should update the counter cache' do
+      node(:node4).destroy
+      expect(node(:node1).children_count).to eq(2)
+    end
+  end
+
+  context 'when a child gets moved' do
+    it 'should update the counter cache' do
+      node(:node6).update(parent: node(:node1))
+      expect(node(:node4).children_count).to eq(1)
+      expect(node(:node1).children_count).to eq(4)
+    end
+  end
+end

data/spec/mongoid/tree/traversal_spec.rb

@@ -15,7 +15,7 @@ describe Mongoid::Tree::Traversal do
     end
 
     it "should complain about unsupported traversal methods" do
-      expect { subject.traverse('non_existing') {} }.to raise_error
+      expect { subject.traverse('non_existing') {} }.to raise_error NoMethodError
     end
 
     it "should default to depth_first traversal" do

data/spec/mongoid/tree_spec.rb

@@ -7,7 +7,11 @@ describe Mongoid::Tree do
   it "should reference many children as inverse of parent with index" do
     a = Node.reflect_on_association(:children)
     expect(a).to be
-    expect(a.macro).to eq(:has_many)
+    if Mongoid::Compatibility::Version.mongoid7?
+      expect(a).to be_kind_of(Mongoid::Association::Referenced::HasMany)
+    else
+      expect(a.macro).to eq(:has_many)
+    end
     expect(a.class_name).to eq('Node')
     expect(a.foreign_key).to eq('parent_id')
     expect(Node.index_specification(:parent_id => 1)).to be
@@ -16,7 +20,11 @@ describe Mongoid::Tree do
   it "should be referenced in one parent as inverse of children" do
     a = Node.reflect_on_association(:parent)
     expect(a).to be
-    expect(a.macro).to eq(:belongs_to)
+    if Mongoid::Compatibility::Version.mongoid7?
+      expect(a).to be_kind_of(Mongoid::Association::Referenced::BelongsTo)
+    else
+      expect(a.macro).to eq(:belongs_to)
+    end
     expect(a.class_name).to eq('Node')
     expect(a.inverse_of).to eq(:children)
   end
@@ -320,9 +328,9 @@ describe Mongoid::Tree do
                   - subsubchild
           ENDTREE
 
-          filtered_ancestors = node(:subsubchild).ancestors.or(
-              { :name => 'child' },
-              { :name => 'subchild' }
+          filtered_ancestors = node(:subsubchild).ancestors.any_of(
+            { :name => 'child' },
+            { :name => 'subchild' }
           )
 
           expect(filtered_ancestors.to_a).to eq([node(:child), node(:subchild)])

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'bundler/setup'
 
 require 'mongoid'
 require 'mongoid/tree'
+require 'mongoid-compatibility'
 
 require 'rspec'
 

data/spec/support/logger.rb

@@ -0,0 +1,9 @@
+FileUtils.mkdir_p File.expand_path('../../../log', __FILE__)
+
+logger = Logger.new('log/mongoid.log')
+
+if Mongoid::Compatibility::Version.mongoid5_or_newer?
+  Mongoid.logger = Mongo::Logger.logger = logger
+else
+  Mongoid.logger = logger
+end

data/spec/support/models/node.rb

@@ -29,4 +29,8 @@ end
 
 class EmbeddedDocument
   include Mongoid::Document
-end
+end
+
+class CounterCachedNode < Node
+  include Mongoid::Tree::CounterCaching
+end

metadata

@@ -1,35 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-tree
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Benedikt Deicke
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-21 00:00:00.000000000 Z
+date: 2023-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: mongoid-compatibility
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -62,16 +76,16 @@ dependencies:
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.20
 description: A tree structure for Mongoid documents using the materialized path pattern
 email:
 - benedikt@synatic.net
@@ -79,25 +93,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/mongoid/tree.rb
+- lib/mongoid/tree/counter_caching.rb
 - lib/mongoid/tree/ordering.rb
 - lib/mongoid/tree/traversal.rb
+- spec/mongoid/tree/counter_caching_spec.rb
 - spec/mongoid/tree/ordering_spec.rb
 - spec/mongoid/tree/traversal_spec.rb
 - spec/mongoid/tree_spec.rb
 - spec/spec_helper.rb
+- spec/support/logger.rb
 - spec/support/macros/tree_macros.rb
 - spec/support/models/node.rb
 homepage: https://github.com/benedikt/mongoid-tree
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,10 +128,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: A tree structure for Mongoid documents
 test_files: []
-has_rdoc: 

data/.rspec

@@ -1,2 +0,0 @@
---color
---format documentation