ancestry 2.1.0 → 2.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzllMWZkZTQwYWVlNTVlZTdiYzJiMWMxZGZhYTY1YjlkYzNiMzM4Yw==
-  data.tar.gz: !binary |-
-    ZWRkMWYxOWZhOTJiNjU2MTE2ZTcyYWIwM2FlNmVmNjk0NjBkZGE2ZQ==
+SHA1:
+  metadata.gz: 1b34c7c664ec5c1a9ac92379c65d9ea196658a3e
+  data.tar.gz: 2d9ff6493829ef26b6b8f3591404f7567139c717
 SHA512:
-  metadata.gz: !binary |-
-    ZDg4NTk4ODJiZmQ5NjAxMThkMDNhNjg5NTk3ZTJkN2IzN2QxMTY5OWIwNTgz
-    OTg2MzVjY2Q3MWEyNTEzZDUzNjc4OTA5NWVhNTFiNWJjYjFiMTQxNjhkYzM5
-    ODNlY2Y0MmIwZDc2ODQ4YTRiNmYxMWMwOTJiNzE0NDZmMDlhZGQ=
-  data.tar.gz: !binary |-
-    N2E1ZjAwY2M1YjkzZTBlNWRkNDQ0ZTVlMDM3OTg3YmE0ZDgwMzNlNTdjOTFh
-    Y2NkYWY0NGUwNDFjZWI3OTZkMTAwMTBmNDI4OWZlOGQyMDRiZmQxOTgyOWFi
-    ZGFmYzk1YTExNjFhYTczNzIxMGE2NGVlZTA4ZGMwYWViMjU3NGE=
+  metadata.gz: d4b6408a4e4582b8cb654e4d38560f1f7b0b743b55023ff6668449a75847874036975faf53c74c18e75fbc59c6eb6d8d1c3bd7d22b28ce97595bcd5d56bd1f49
+  data.tar.gz: b06389bb0d03045bd0f9f82ab2dac3db63c8ca2996c87bcc4f46bb9b71d876090bc136b928cd5ac9d2c3c6b62ed48cd0ca2175e5c5e9a0f6c2e169a6ef24e005

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Stefan Kroes
+Copyright (c) 2016 Stefan Kroes
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,5 +1,7 @@
-{<img src="https://travis-ci.org/stefankroes/ancestry.png?branch=master" alt="Build Status" />}[https://travis-ci.org/stefankroes/ancestry]
-{<img src="https://coveralls.io/repos/stefankroes/ancestry/badge.png" alt="Coverage Status" />}[https://coveralls.io/r/stefankroes/ancestry]
+{<img src="https://travis-ci.org/stefankroes/ancestry.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/stefankroes/ancestry]
+{<img src="https://coveralls.io/repos/stefankroes/ancestry/badge.svg" alt="Coverage Status" />}[https://coveralls.io/r/stefankroes/ancestry]
+{<img src="https://badges.gitter.im/Join Chat.svg" alt="Gitter" />}[https://gitter.im/stefankroes/ancestry?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge]
+{<img src="https://hakiri.io/github/stefankroes/ancestry/master.svg" alt="Security" />}[https://hakiri.io/github/stefankroes/ancestry/master]
 
 = Ancestry
 
@@ -9,20 +11,51 @@ Ancestry is a gem/plugin that allows the records of a Ruby on Rails ActiveRecord
 
 To apply Ancestry to any ActiveRecord model, follow these simple steps:
 
-1. Install
-   - <b>Rails 2</b>
-     - See 1-3-stable branch
-   - <b>Rails 3</b>
-     - Add to Gemfile: <b>gem 'ancestry'</b>
-     - Install required gems: <b>bundle install</b>
-
-2. Add ancestry column to your table
-   - Create migration: <b>rails g migration add_ancestry_to_[table] ancestry:string</b>
-   - Add index to migration: <b>add_index [table], :ancestry</b> (UP) / <b>remove_index [table], :ancestry</b> (DOWN)
-   - Migrate your database: <b>rake db:migrate</b>
-
-3. Add ancestry to your model
-   - Add to app/models/[model].rb: <b>has_ancestry</b>
+== Install
+=== Rails 2
+- See 1-3-stable branch
+=== Rails 3 and 4
+- Add to Gemfile:
+   # Gemfile
+
+   gem 'ancestry'
+- Install required gems:
+   $ bundle install
+
+== Add ancestry column to your table
+- Create migration:
+   $ rails g migration add_ancestry_to_[table] ancestry:string
+- Add index to migration:
+   # db/migrate/[date]_add_ancestry_to_[table].rb
+
+   class AddAncestryTo[Table] < ActiveRecord::Migration
+      # Rails 4 Syntax
+      def change
+         add_column [table], :ancestry, :string
+         add_index [table], :ancestry
+      end
+
+      # Rails 3 Syntax
+      def up
+         add_column [table], :ancestry, :string
+         add_index [table], :ancestry
+      end
+
+      def down
+         remove_column [table], :ancestry
+         remove_index [table], :ancestry
+      end
+
+- Migrate your database:
+   $ rake db:migrate
+
+== Add ancestry to your model
+- Add to app/models/[model].rb:
+   # app/models/[model.rb]
+
+   class [Model] < ActiveRecord::Base
+      has_ancestry
+   end
 
 Your model is now a tree!
 
@@ -57,7 +90,7 @@ To navigate an Ancestry model, use the following methods on any instance / recor
   child_ids        Returns a list of child ids
   has_children?    Returns true if the record has any children, false otherwise
   is_childless?    Returns true is the record has no children, false otherwise
-  siblings         Scopes the model on siblings of the record, the record itself is included
+  siblings         Scopes the model on siblings of the record, the record itself is included*
   sibling_ids      Returns a list of sibling ids
   has_siblings?    Returns true if the record's parent has more than one child
   is_only_child?   Returns true if the record is the only child of its parent
@@ -67,6 +100,8 @@ To navigate an Ancestry model, use the following methods on any instance / recor
   subtree_ids      Returns a list of all ids in the record's subtree
   depth            Return the depth of the node, root nodes are at depth 0
 
+* If the record is a root, other root records are considered siblings
+
 = Options for has_ancestry
 
 The has_ancestry methods supports the following options:
@@ -174,6 +209,23 @@ To get the arranged nodes as a nested array of hashes for serialization:
     }
   ]
 
+You can also supply your own serialization logic using blocks:
+
+For example, using Active Model Serializers:
+
+  TreeNode.arrange_serializable do |parent, children|
+    MySerializer.new(parent, children: children)
+  end
+
+Or plain hashes:
+
+  TreeNode.arrange_serializable do |parent, children|
+    {
+       my_id: parent.id
+       my_children: children
+    }
+  end
+
 The result of arrange_serializable can easily be serialized to json with 'to_json', or some other format:
 
   TreeNode.arrange_serializable.to_json
@@ -269,10 +321,10 @@ In the example above, the ancestry column is created as a string. This puts a li
 
 The materialised path pattern requires Ancestry to use a 'like' condition in order to fetch descendants. This should not be particularly slow however since the the condition never starts with a wildcard which allows the DBMS to use the column index. If you have any data on performance with a large number of records, please drop me line.
 
-= Contributing and licence
+= Contributing and license
 
 I will try to keep Ancestry up to date with changing versions of Rails and Ruby and also with any bug reports I might receive. I will implement new features on request as I see fit and have time.
 
 Question? Bug report? Faulty/incomplete documentation? Feature request? Please post an issue on 'http://github.com/stefankroes/ancestry/issues'. Make sure you have read the documentation and you have included tests and documentation with any pull request.
 
-Copyright (c) 2013 Stefan Kroes, released under the MIT license
+Copyright (c) 2016 Stefan Kroes, released under the MIT license

data/ancestry.gemspec

@@ -1,3 +1,7 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require 'ancestry/version'
+
 Gem::Specification.new do |s|
   s.name        = 'ancestry'
   s.summary     = 'Organize ActiveRecord model into a tree structure'
@@ -11,7 +15,7 @@ Gem::Specification.new do |s|
   orphaned records.
 EOF
 
-  s.version = '2.1.0'
+  s.version = Ancestry::VERSION
 
   s.author   = 'Stefan Kroes'
   s.email    = 's.a.kroes@gmail.com'
@@ -19,17 +23,22 @@ EOF
   s.license  = 'MIT'
 
   s.files = [
-    'ancestry.gemspec', 
-    'init.rb', 
-    'install.rb', 
-    'lib/ancestry.rb', 
-    'lib/ancestry/has_ancestry.rb', 
-    'lib/ancestry/exceptions.rb', 
-    'lib/ancestry/class_methods.rb', 
-    'lib/ancestry/instance_methods.rb', 
-    'MIT-LICENSE', 
+    'ancestry.gemspec',
+    'init.rb',
+    'install.rb',
+    'lib/ancestry.rb',
+    'lib/ancestry/has_ancestry.rb',
+    'lib/ancestry/exceptions.rb',
+    'lib/ancestry/class_methods.rb',
+    'lib/ancestry/instance_methods.rb',
+    'MIT-LICENSE',
     'README.rdoc'
   ]
   
-  s.add_dependency 'activerecord', '>= 3.0.0'
+  s.required_ruby_version     = '>= 1.8.7'
+  s.add_runtime_dependency 'activerecord', '>= 3.0.0'
+  s.add_development_dependency 'rake',      '~> 10.0'
+  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'sqlite3'
 end

data/lib/ancestry/class_methods.rb

@@ -42,25 +42,34 @@ module Ancestry
     # Arrange array of nodes into a nested hash of the form
     # {node => children}, where children = {} if the node has no children
     def arrange_nodes(nodes)
-      # Get all nodes ordered by ancestry and start sorting them into an empty hash
-      nodes.inject(ActiveSupport::OrderedHash.new) do |arranged_nodes, node|
-        # Find the insertion point for that node by going through its ancestors
-        node.ancestor_ids.inject(arranged_nodes) do |insertion_point, ancestor_id|
-          insertion_point.each do |parent, children|
-            # Change the insertion point to children if node is a descendant of this parent
-            insertion_point = children if ancestor_id == parent.id
-          end
-          insertion_point
-        end[node] = ActiveSupport::OrderedHash.new
-        arranged_nodes
+      arranged = ActiveSupport::OrderedHash.new
+      min_depth = Float::INFINITY
+      index = Hash.new { |h, k| h[k] = ActiveSupport::OrderedHash.new }
+
+      nodes.each do |node|
+        children = index[node.id]
+        index[node.parent_id][node] = children
+
+        depth = node.depth
+        if depth < min_depth
+          min_depth = depth
+          arranged.clear
+        end
+        arranged[node] = children if depth == min_depth
       end
+
+      arranged
     end
 
      # Arrangement to nested array
-    def arrange_serializable options={}, nodes=nil
+    def arrange_serializable options={}, nodes=nil, &block
       nodes = arrange(options) if nodes.nil?
       nodes.map do |parent, children|
-        parent.serializable_hash.merge 'children' => arrange_serializable(options, children)
+        if block_given?
+          yield parent, arrange_serializable(options, children, &block)
+        else
+          parent.serializable_hash.merge 'children' => arrange_serializable(options, children)
+        end
       end
     end
 

data/lib/ancestry/has_ancestry.rb

@@ -43,8 +43,9 @@ class << ActiveRecord::Base
     scope :descendants_of, lambda { |object| where(to_node(object).descendant_conditions) }
     scope :subtree_of, lambda { |object| where(to_node(object).subtree_conditions) }
     scope :siblings_of, lambda { |object| where(to_node(object).sibling_conditions) }
-    scope :ordered_by_ancestry, lambda { reorder("(case when #{table_name}.#{ancestry_column} is null then 0 else 1 end), #{table_name}.#{ancestry_column}") }
-    scope :ordered_by_ancestry_and, lambda { |order| reorder("(case when #{table_name}.#{ancestry_column} is null then 0 else 1 end), #{table_name}.#{ancestry_column}, #{order}") }
+    scope :ordered_by_ancestry, lambda { reorder("(CASE WHEN #{connection.quote_table_name(table_name)}.#{connection.quote_column_name(ancestry_column)} IS NULL THEN 0 ELSE 1 END), #{connection.quote_table_name(table_name)}.#{connection.quote_column_name(ancestry_column)}") }
+    scope :ordered_by_ancestry_and, lambda { |order| reorder("(CASE WHEN #{connection.quote_table_name(table_name)}.#{connection.quote_column_name(ancestry_column)} IS NULL THEN 0 ELSE 1 END), #{connection.quote_table_name(table_name)}.#{connection.quote_column_name(ancestry_column)}, #{order}") }
+    scope :path_of, lambda { |object| to_node(object).path }
 
     # Update descendants with new ancestry before save
     before_save :update_descendants_with_new_ancestry
@@ -74,9 +75,9 @@ class << ActiveRecord::Base
       }
     end
 
-    after_save :touch_ancestors_callback
     after_touch :touch_ancestors_callback
     after_destroy :touch_ancestors_callback
+    after_save :touch_ancestors_callback, if: :changed?
   end
 end
 
@@ -86,4 +87,4 @@ ActiveSupport.on_load :active_record do
       alias_method :acts_as_tree, :has_ancestry
     end
   end
-end
+end

data/lib/ancestry/instance_methods.rb

@@ -53,6 +53,8 @@ module Ancestry
             descendants.each do |descendant|
               descendant.without_ancestry_callbacks do
                 new_ancestry = descendant.ancestor_ids.delete_if { |x| x == self.id }.join("/")
+                # check for empty string if it's then set to nil
+                new_ancestry = nil if new_ancestry.empty?
                 descendant.update_attribute descendant.class.ancestry_column, new_ancestry || nil
               end
             end
@@ -92,7 +94,7 @@ module Ancestry
     end
 
     # Ancestors
-    
+
     def ancestry_changed?
       changed.include?(self.ancestry_base_class.ancestry_column.to_s)
     end
@@ -143,8 +145,12 @@ module Ancestry
       write_attribute self.ancestry_base_class.depth_cache_column, depth
     end
 
+    def ancestor_of?(node)
+      node.ancestor_ids.include?(self.id)
+    end
+
     # Parent
-    
+
     def parent= parent
       write_attribute(self.ancestry_base_class.ancestry_column, if parent.nil? then nil else parent.child_ancestry end)
     end
@@ -165,8 +171,12 @@ module Ancestry
       parent_id.present?
     end
 
+    def parent_of?(node)
+      self.id == node.parent_id
+    end
+
     # Root
-    
+
     def root_id
       if ancestor_ids.empty? then id else ancestor_ids.first end
     end
@@ -180,8 +190,12 @@ module Ancestry
     end
     alias :root? :is_root?
 
+    def root_of?(node)
+      self.id == node.root_id
+    end
+
     # Children
-    
+
     def child_conditions
       t = get_arel_table
       t[get_ancestry_column].eq(child_ancestry)
@@ -205,8 +219,12 @@ module Ancestry
     end
     alias_method :childless?, :is_childless?
 
+    def child_of?(node)
+      self.parent_id == node.id
+    end
+
     # Siblings
-    
+
     def sibling_conditions
       t = get_arel_table
       t[get_ancestry_column].eq(read_attribute(self.ancestry_base_class.ancestry_column))
@@ -230,8 +248,12 @@ module Ancestry
     end
     alias_method :only_child?, :is_only_child?
 
+    def sibling_of?(node)
+      self.ancestry == node.ancestry
+    end
+
     # Descendants
-    
+
     def descendant_conditions
       t = get_arel_table
       t[get_ancestry_column].matches("#{child_ancestry}/%").or(t[get_ancestry_column].eq(child_ancestry))
@@ -245,11 +267,15 @@ module Ancestry
       descendants(depth_options).select(self.ancestry_base_class.primary_key).collect(&self.ancestry_base_class.primary_key.to_sym)
     end
 
+    def descendant_of?(node)
+      ancestor_ids.include?(node.id)
+    end
+
     # Subtree
-    
+
     def subtree_conditions
       t = get_arel_table
-      t[get_primary_key_column].eq(self.id).or(t[get_ancestry_column].matches("#{child_ancestry}/%")).or(t[get_ancestry_column].eq(child_ancestry))
+      descendant_conditions.or(t[get_primary_key_column].eq(self.id))
     end
 
     def subtree depth_options = {}
@@ -261,7 +287,7 @@ module Ancestry
     end
 
     # Callback disabling
-    
+
     def without_ancestry_callbacks
       @disable_ancestry_callbacks = true
       yield
@@ -269,13 +295,13 @@ module Ancestry
     end
 
     def ancestry_callbacks_disabled?
-      !!@disable_ancestry_callbacks
+      defined?(@disable_ancestry_callbacks) && @disable_ancestry_callbacks
     end
 
   private
 
     def cast_primary_key(key)
-      if [:string, :uuid].include? primary_key_type
+      if [:string, :uuid, :text].include? primary_key_type
         key
       else
         key.to_i
@@ -292,9 +318,10 @@ module Ancestry
       end
     end
 
-    # Validates the ancestry, but can also be applied if validation is bypassed to determine if chidren should be affected
+    # Validates the ancestry, but can also be applied if validation is bypassed to determine if children should be affected
     def sane_ancestry?
-      ancestry.nil? || (ancestry.to_s =~ Ancestry::ANCESTRY_PATTERN && !ancestor_ids.include?(self.id))
+      ancestry_value = read_attribute(self.ancestry_base_class.ancestry_column)
+      ancestry_value.nil? || (ancestry_value.to_s =~ Ancestry::ANCESTRY_PATTERN && !ancestor_ids.include?(self.id))
     end
 
     def unscoped_find id

metadata

@@ -1,51 +1,108 @@
 --- !ruby/object:Gem::Specification
 name: ancestry
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Stefan Kroes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2016-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-description: ! "  Ancestry allows the records of a ActiveRecord model to be organized
-  in a tree\n  structure, using a single, intuitively formatted database column. It
-  exposes\n  all the standard tree structure relations (ancestors, parent, root, children,\n
-  \ siblings, descendants) and all of them can be fetched in a single sql query.\n
-  \ Additional features are named_scopes, integrity checking, integrity restoration,\n
-  \ arrangement of (sub)tree into hashes and different strategies for dealing with\n
-  \ orphaned records.\n"
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: minitest
+  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: sqlite3
+  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'
+description: |2
+    Ancestry allows the records of a ActiveRecord model to be organized in a tree
+    structure, using a single, intuitively formatted database column. It exposes
+    all the standard tree structure relations (ancestors, parent, root, children,
+    siblings, descendants) and all of them can be fetched in a single sql query.
+    Additional features are named_scopes, integrity checking, integrity restoration,
+    arrangement of (sub)tree into hashes and different strategies for dealing with
+    orphaned records.
 email: s.a.kroes@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.rdoc
 - ancestry.gemspec
 - init.rb
 - install.rb
 - lib/ancestry.rb
-- lib/ancestry/has_ancestry.rb
-- lib/ancestry/exceptions.rb
 - lib/ancestry/class_methods.rb
+- lib/ancestry/exceptions.rb
+- lib/ancestry/has_ancestry.rb
 - lib/ancestry/instance_methods.rb
-- MIT-LICENSE
-- README.rdoc
 homepage: http://github.com/stefankroes/ancestry
 licenses:
 - MIT
@@ -56,19 +113,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Organize ActiveRecord model into a tree structure
 test_files: []
-has_rdoc: