mongoid-ancestry 0.3.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3b4a81fd8d6fc037f515cc4c08ea4fd4cf8ec12
+  data.tar.gz: cce7627b8e3f643465488670beb4eb7f34369ff5
+SHA512:
+  metadata.gz: 048b43039e92f3bcf4781463edb2cf96518d5f1c9489a40c17c7bdf0c2c4861c72738fef4bd91811601b1fe2dba1f5791eae3606f188ec27b0eeff6360c3adcd
+  data.tar.gz: 596b28a5d4af2e07c3899bd6ccac9fefb9d3a39b91bd9071cb7be8c1a807e0eae78a95eda47823116af2185a00734794625ed238bccc7b88c12648c33c01d654

data/.gitignore

@@ -40,3 +40,5 @@ pkg
 #
 # For vim:
 #*.swp
+.ruby-version
+Gemfile.lock

data/.travis.yml

@@ -1,5 +1,9 @@
 script: "bundle exec rspec spec"
 rvm:
   - 1.9.3
+  - ruby-head
+env:
+  - MONGOID_VERSION=3
+  - MONGOID_VERSION=4
 services:
   - mongodb

data/Gemfile

@@ -1,10 +1,12 @@
 source 'https://rubygems.org'
 
-ruby '1.9.3'
-
 gemspec
 
-group :test do
-  gem 'rake'
-  gem 'rspec', '~> 2.5'
+case version = ENV['MONGOID_VERSION'] || "~> 3.1"
+when /4/
+  gem "mongoid", :github => 'mongoid/mongoid'
+when /3/
+  gem "mongoid", "~> 3.1"
+else
+  gem "mongoid", version
 end

data/README.md

@@ -7,7 +7,7 @@ Mongoid-ancestry is a gem/plugin that allows the records of a Ruby on Rails Mong
 
 ## Installation
 
-### It's Rails 3 only.
+### It's Rails 3+ only.
 
 To apply Mongoid-ancestry to any Mongoid model, follow these simple steps:
 
@@ -25,7 +25,7 @@ Your model is now a tree!
 
 ## Mongoid compatibility
 
-This gem only supports Mongoid 3.x starting with version 0.3.0.
+This gem only supports Mongoid 3.x starting with version 0.3.0. And Mongoid 4.x starting with version 0.4.0
 
 If you want to use Mongoid version 2.x, you should either use this gem in a 0.2.x version or checkout the "mongoid-2.4-stable" branch. You can ask bundler to stick with 0.2.x versions of this gem by adding this to your Gemfile: `gem 'mongoid-ancestry', '~> 0.2.2'`
 

data/lib/mongoid-ancestry/class_methods.rb

@@ -1,15 +1,19 @@
 module Mongoid
   module Ancestry
+    unless Mongoid.mongoid3?
+      include Mongoid::Attributes::Dynamic
+    end
     module ClassMethods
       def has_ancestry(opts = {})
         defaults = {
           :ancestry_field    => :ancestry,
           :cache_depth       => false,
           :depth_cache_field => :ancestry_depth,
-          :orphan_strategy   => :destroy
+          :orphan_strategy   => :destroy,
+          :touchable         => false
         }
 
-        valid_opts = [:ancestry_field, :cache_depth, :depth_cache_field, :orphan_strategy]
+        valid_opts = [:ancestry_field, :cache_depth, :depth_cache_field, :orphan_strategy, :touchable]
         unless opts.is_a?(Hash) &&  opts.keys.all? {|opt| valid_opts.include?(opt) }
           raise Error.new("Invalid options for has_ancestry. Only hash is allowed.\n Defaults: #{defaults.inspect}")
         end
@@ -29,6 +33,10 @@ module Mongoid
         cattr_reader :orphan_strategy
         self.orphan_strategy = opts[:orphan_strategy]
 
+        # Create touch accessor and set to option or default
+        cattr_accessor :touchable
+        self.touchable = opts[:touchable]
+
         # Validate format of ancestry column value
         primary_key_format = opts[:primary_key_format] || /[a-z0-9]+/
         validates_format_of ancestry_field, :with => /\A#{primary_key_format.source}(\/#{primary_key_format.source})*\Z/, :allow_nil => true
@@ -51,24 +59,28 @@ module Mongoid
 
         # Create named scopes for depth
         {:before_depth => 'lt', :to_depth => 'lte', :at_depth => nil, :from_depth => 'gte', :after_depth => 'gt'}.each do |scope_name, operator|
-          scope scope_name, lambda { |depth|
+          scope scope_name, ->(depth) {
             raise Error.new("Named scope '#{scope_name}' is only available when depth caching is enabled.") unless opts[:cache_depth]
             where( (operator ? depth_cache_field.send(operator.to_sym) : depth_cache_field) => depth)
           }
         end
 
-        scope :roots, where(ancestry_field => nil)
-        scope :ancestors_of, lambda { |object| where(to_node(object).ancestor_conditions) }
-        scope :children_of, lambda { |object| where(to_node(object).child_conditions) }
-        scope :descendants_of, lambda { |object| any_of(to_node(object).descendant_conditions) }
-        scope :subtree_of, lambda { |object| any_of(to_node(object).subtree_conditions) }
-        scope :siblings_of, lambda { |object| where(to_node(object).sibling_conditions) }
-        scope :ordered_by_ancestry, asc(:"#{self.base_class.ancestry_field}")
-        scope :ordered_by_ancestry_and, lambda {|by| ordered_by_ancestry.order_by([by]) }
+        scope :roots, -> { where(ancestry_field => nil) }
+        scope :ancestors_of, ->(object) { where(to_node(object).ancestor_conditions) }
+        scope :children_of, ->(object) { where(to_node(object).child_conditions) }
+        scope :descendants_of, ->(object) { any_of(to_node(object).descendant_conditions) }
+        scope :subtree_of, ->(object) { any_of(to_node(object).subtree_conditions) }
+        scope :siblings_of, ->(object) { where(to_node(object).sibling_conditions) }
+        scope :ordered_by_ancestry, -> { asc(:"#{self.base_class.ancestry_field}") }
+        scope :ordered_by_ancestry_and, ->(by) { ordered_by_ancestry.order_by([by]) }
 
         # Update descendants with new ancestry before save
         before_save :update_descendants_with_new_ancestry
 
+        before_save :touch_parent, if: ->(obj) {
+          obj.touchable && obj.send(:"#{self.class.ancestry_field}_changed?")
+        }
+
         # Apply orphan strategy before destroy
         before_destroy :apply_orphan_strategy
       end

data/lib/mongoid-ancestry/instance_methods.rb

@@ -32,6 +32,10 @@ module Mongoid
       end
     end
 
+    def touch_parent
+      parent.touch
+    end
+
     # Apply orphan strategy
     def apply_orphan_strategy
       # Skip this if callbacks are disabled
@@ -117,7 +121,8 @@ module Mongoid
     end
 
     def parent_id
-      ancestor_ids.empty? ? nil : ancestor_ids.last
+      parent_id = read_attribute(self.base_class.ancestry_field).to_s.split('/').last
+      return cast_primary_key(parent_id) if parent_id
     end
 
     def parent
@@ -228,13 +233,29 @@ module Mongoid
     def cast_primary_key(key)
       if primary_key_type == Integer
         key.to_i
-      elsif primary_key_type == Moped::BSON::ObjectId && key =~ /[a-z0-9]{24}/
-        Moped::BSON::ObjectId.from_string(key)
+      elsif is_primary_key_type_bson_objectid? && key =~ /[a-z0-9]{24}/
+        bson_objectid_from_string(key)
       else
         key
       end
     end
 
+    def is_primary_key_type_bson_objectid?
+      if Mongoid.mongoid3?
+        primary_key_type == Moped::BSON::ObjectId
+      else
+        primary_key_type == BSON::ObjectId
+      end
+    end
+
+    def bson_objectid_from_string(key)
+      if Mongoid.mongoid3?
+        Moped::BSON::ObjectId.from_string(key)
+      else
+        BSON::ObjectId.from_string(key)
+      end
+    end
+
     def primary_key_type
       @primary_key_type ||= self.base_class.fields['_id'].options[:type]
     end

data/lib/mongoid-ancestry/version.rb

@@ -1,5 +1,14 @@
 module Mongoid
+
+  def self.mongoid3?
+    ::Mongoid.const_defined? :Observer # deprecated in Mongoid 4.x
+  end
+
+  def self.mongoid2?
+    ::Mongoid.const_defined? :Contexts # deprecated in Mongoid 3.x
+  end
+
   module Ancestry
-    VERSION = '0.3.1'
+    VERSION = '0.4.0'
   end
 end

data/mongoid-ancestry.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |s|
     "README.md"
   ]
 
-  s.add_dependency('mongoid', "~> 3.0")
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "mongoid"
 end
 

data/spec/lib/ancestry_spec.rb

@@ -34,6 +34,18 @@ describe MongoidAncestry do
     end
   end
 
+  it "should have default touchable value" do
+    subject.with_model do |model|
+      model.touchable.should be_false
+    end
+  end
+
+  it "should set touchable value" do
+    subject.with_model touchable: true do |model|
+      model.touchable.should be_true
+    end
+  end
+
   it "should have non default orphan strategy" do
     subject.with_model :orphan_strategy => :rootify do |model|
       model.orphan_strategy.should eql(:rootify)

data/spec/lib/mongoid-ancestry/class_methods_spec.rb

@@ -100,14 +100,14 @@ describe MongoidAncestry do
     subject.with_model :depth => 3, :width => 3 do |model, roots|
       model.orphan_strategy = :restrict
       root = roots.first.first
-      expect { root.destroy }.to raise_error Mongoid::Ancestry::Error
-      expect { root.children.first.children.first.destroy }.to_not raise_error Mongoid::Ancestry::Error
+      expect { root.destroy }.to raise_error
+      expect { root.children.first.children.first.destroy }.to_not raise_error
     end
   end
 
   it "should check that there are no errors on a valid tree" do
     subject.with_model :width => 3, :depth => 3 do |model, roots|
-      expect { model.check_ancestry_integrity! }.to_not raise_error(Mongoid::Ancestry::Error)
+      expect { model.check_ancestry_integrity! }.to_not raise_error
       model.check_ancestry_integrity!(:report => :list).size.should eql(0)
     end
   end
@@ -115,7 +115,7 @@ describe MongoidAncestry do
   it "should check detection of invalid format for ancestry field" do
     subject.with_model :width => 3, :depth => 3 do |model, roots|
       roots.first.first.update_attribute model.ancestry_field, 'invalid_ancestry'
-      expect { model.check_ancestry_integrity! }.to raise_error(Mongoid::Ancestry::IntegrityError)
+      expect { model.check_ancestry_integrity! }.to raise_error
       model.check_ancestry_integrity!(:report => :list).size.should eql(1)
     end
   end
@@ -126,7 +126,7 @@ describe MongoidAncestry do
       node.without_ancestry_callbacks do
        node.update_attribute model.ancestry_field, 35
       end
-      expect { model.check_ancestry_integrity! }.to raise_error(Mongoid::Ancestry::IntegrityError)
+      expect { model.check_ancestry_integrity! }.to raise_error
       model.check_ancestry_integrity!(:report => :list).size.should eql(1)
     end
   end
@@ -135,7 +135,7 @@ describe MongoidAncestry do
     subject.with_model :width => 3, :depth => 3 do |model, roots|
       node = roots.first.first
       node.update_attribute model.ancestry_field, node.id
-      expect { model.check_ancestry_integrity! }.to raise_error(Mongoid::Ancestry::IntegrityError)
+      expect { model.check_ancestry_integrity! }.to raise_error
       model.check_ancestry_integrity!(:report => :list).size.should eql(1)
     end
   end
@@ -144,15 +144,15 @@ describe MongoidAncestry do
     subject.with_model do |model|
       model.destroy_all
       model.create!(model.ancestry_field => model.create!(model.ancestry_field => model.create!(model.ancestry_field => nil).id).id)
-      expect { model.check_ancestry_integrity! }.to raise_error(Mongoid::Ancestry::IntegrityError)
+      expect { model.check_ancestry_integrity! }.to raise_error
       model.check_ancestry_integrity!(:report => :list).size.should eql(1)
     end
   end
 
   def assert_integrity_restoration model
-    expect { model.check_ancestry_integrity! }.to raise_error(Mongoid::Ancestry::IntegrityError)
+    expect { model.check_ancestry_integrity! }.to raise_error
     model.restore_ancestry_integrity!
-    expect { model.check_ancestry_integrity! }.to_not raise_error(Mongoid::Ancestry::IntegrityError)
+    expect { model.check_ancestry_integrity! }.to_not raise_error
   end
 
   it "should check that integrity is restored for invalid format for ancestry field" do
@@ -232,7 +232,7 @@ describe MongoidAncestry do
   end
 
   it "should build ancestry from parent ids" do
-    subject.with_model :skip_ancestry => true, :extra_columns => {:parent_id => 'Moped::BSON::ObjectId'} do |model|
+    subject.with_model :skip_ancestry => true, :extra_columns => {:parent_id => parent_id} do |model|
       [model.create!].each do |parent1|
         (Array.new(5) { model.create :parent_id => parent1.id }).each do |parent2|
           (Array.new(5) { model.create :parent_id => parent2.id }).each do |parent3|
@@ -297,4 +297,12 @@ describe MongoidAncestry do
     end
   end
 
+  def parent_id
+    if Mongoid.mongoid3?
+      'Moped::BSON::ObjectId'
+    else
+      'BSON::ObjectId'
+    end
+  end
+
 end

data/spec/lib/mongoid-ancestry/instance_methods_spec.rb

@@ -161,7 +161,7 @@ describe MongoidAncestry do
     end
   end
 
-  it "should have depth caching" do 
+  it "should have depth caching" do
     subject.with_model :depth => 3, :width => 3, :cache_depth => true, :depth_cache_field => :depth_cache do |model, roots|
       roots.each do |lvl0_node, lvl0_children|
         lvl0_node.depth_cache.should eql(0)
@@ -237,5 +237,18 @@ describe MongoidAncestry do
     end
   end
 
+  it "should not call touch on parent" do
+    subject.with_model do |model|
+      root = model.create!
+      expect{ root.children.create!  }.to_not change{ root.reload.updated_at }
+    end
+  end
+
+  it "should call touch on parent" do
+    subject.with_model touchable: true do |model|
+      root = model.create!
+      expect{ root.children.create!  }.to change{ root.reload.updated_at }
+    end
+  end
 
 end

data/spec/spec_helper.rb

@@ -8,6 +8,9 @@ require 'mongoid-ancestry'
 
 Mongoid.load!(File.expand_path('../mongoid.yml', __FILE__), 'test')
 Mongoid.logger = Logger.new('log/test.log')
+Moped.logger = Logger.new('log/test.log')
+Mongoid.logger.level = Logger::DEBUG
+Moped.logger.level = Logger::DEBUG
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 

data/spec/support/models.rb

@@ -12,6 +12,7 @@ class MongoidAncestry
       const_set 'TestNode', model
       TestNode.send(:include, Mongoid::Document)
       TestNode.send(:include, Mongoid::Ancestry) unless skip_ancestry
+      TestNode.send(:include, Mongoid::Timestamps)
 
       extra_columns.each do |name, type|
         TestNode.send :field, name, :type => type.constantize

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-ancestry
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Stefan Kroes
@@ -10,24 +9,50 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-18 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  type: :runtime
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-    none: false
-  name: mongoid
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-    none: false
+        version: '0'
 description: Organise Mongoid model into a tree structure
 email:
 - eagle.anton@gmail.com
@@ -36,10 +61,9 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - MIT-LICENSE
 - README.md
@@ -62,33 +86,26 @@ files:
 homepage: http://github.com/skyeagle/mongoid-ancestry
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: -3773754502524018059
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: -3773754502524018059
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: mongoid-ancestry
-rubygems_version: 1.8.24
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ancestry allows the records of a Mongoid model to be organised in a tree
   structure, using a single, intuitively formatted database field. It exposes all
   the standard tree structure relations (ancestors, parent, root, children, siblings,

data/Gemfile.lock

@@ -1,44 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mongoid-ancestry (0.3.1)
-      mongoid (~> 3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (3.2.12)
-      activesupport (= 3.2.12)
-      builder (~> 3.0.0)
-    activesupport (3.2.12)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    builder (3.0.4)
-    diff-lcs (1.1.3)
-    i18n (0.6.1)
-    mongoid (3.1.1)
-      activemodel (~> 3.2)
-      moped (~> 1.4.2)
-      origin (~> 1.0)
-      tzinfo (~> 0.3.22)
-    moped (1.4.2)
-    multi_json (1.6.1)
-    origin (1.0.11)
-    rake (10.0.3)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
-    tzinfo (0.3.35)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  mongoid-ancestry!
-  rake
-  rspec (~> 2.5)