ancestry 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a0ecc6b1fa22b8bd28b9c30ea33044711e58502
-  data.tar.gz: 61a4f311e5b2b459d31f3579f3768b3e662e9cd5
+  metadata.gz: 8088b41fa07084ef6a761d52c2d33b051c24eae3
+  data.tar.gz: ed5f0c0678e1d238adb4b68ed6d6239204c397a1
 SHA512:
-  metadata.gz: 61f60265258f9c8c2a9637c21239c1b32f3117b98a4f7bcdf7752d11e306f29e5c7ecd6bc4b364c1b39bb8ed44a8e7fa94b3b276bc9fb6bfa9c1152f2a1ba4f2
-  data.tar.gz: 75d97ae0017b5906e44e141f97915de6055a33c0f3862db4f5e7b058cbd8482f4e1b90803658873b1cdbc4cf0aab1c7d8d81ff2111aa56e361a5de5a9d8700fd
+  metadata.gz: c97d7541dbba13b6a768edab18a21c2916fbb9ea0f61674f4831a0e56f0eed83bf3b1a18bd743b1f2e0eb26b6b78ca21c69271052e3fb1042d8cf194c74802ca
+  data.tar.gz: 7274762db4aee75b633c14fb158b68da2e4e525c4c5e5557c9c164aa6a2dc8d68c7cdc96f443112a327b0a21b76a3acc57cb09c7653ec5b24a4a839266b7313b

data/README.md

@@ -34,19 +34,7 @@ $ bundle install
 ## Add ancestry column to your table
 * Create migration:
 ```bash
-$ rails g migration add_ancestry_to_[table] ancestry:string
-```
-
-*   Add index to migration:
-```ruby
-# db/migrate/[date]_add_ancestry_to_[table].rb
-
-class AddAncestryTo[Table] < ActiveRecord::Migration
-   def change
-      add_column [table], :ancestry, :string
-      add_index [table], :ancestry
-   end
-end
+$ rails g migration add_ancestry_to_[table] ancestry:string:index
 ```
 
 *   Migrate your database:
@@ -95,39 +83,50 @@ node.children.create :name => 'Stinky'
 
 # Navigating your tree
 
-To navigate an Ancestry model, use the following methods on any instance /
-record:
-
-    parent           Returns the parent of the record, nil for a root node
-    parent_id        Returns the id of the parent of the record, nil for a root node
-    root             Returns the root of the tree the record is in, self for a root node
-    root_id          Returns the id of the root of the tree the record is in
-    root?, is_root?  Returns true if the record is a root node, false otherwise
-    ancestor_ids     Returns a list of ancestor ids, starting with the root id and ending with the parent id
-    ancestors        Scopes the model on ancestors of the record
-    path_ids         Returns a list the path ids, starting with the root id and ending with the node's own id
-    path             Scopes model on path records of the record
-    children         Scopes the model on children of the record
-    child_ids        Returns a list of child ids
-    has_parent?     Returns true if the record has a parent, false otherwise
-    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*
-    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
-    descendants      Scopes the model on direct and indirect children of the record
-    descendant_ids   Returns a list of a descendant ids
-    subtree          Scopes the model on descendants and itself
-    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
-
+To navigate an Ancestry model, use the following instance methods:
+
+|  method           |return value|
+|-------------------|------------|
+|`parent`           |parent of the record, nil for a root node|
+|`parent_id`        |parent id of the record, nil for a root node|
+|`root`             |root of the record's tree, self for a root node|
+|`root_id`          |root id of the record's tree, self for a root node|
+|`root?` <br/> `is_root?` |  true if the record is a root node, false otherwise|
+|`ancestors`        |ancestors of the record, starting with the root and ending with the parent|
+|`ancestors?`       |true if the record has ancestors (aka not a root node)|
+|`ancestor_ids`     |ancestor ids of the record|
+|`path`             |path of the record, starting with the root and ending with self|
+|`path_ids`         |a list the path ids, starting with the root id and ending with the node's own id|
+|`children`         |direct children of the record|
+|`child_ids`        |direct children's ids|
+|`has_parent?`    <br/> `ancestors?` |true if the record has a parent, false otherwise|
+|`has_children?`  <br/> `children?`  |true if the record has any children, false otherwise|
+|`is_childless?`  <br/> `childless?` |true is the record has no children, false otherwise|
+|`siblings`         |siblings of the record, the record itself is included*|
+|`sibling_ids`      |sibling ids|
+|`has_siblings?`  <br/> `siblings?`   |true if the record's parent has more than one child|
+|`is_only_child?` <br/> `only_child?` |true if the record is the only child of its parent|
+|`descendants`      |direct and indirect children of the record|
+|`descendant_ids`   |direct and indirect children's ids of the record|
+|`subtree`          |the model on descendants and itself|
+|`subtree_ids`      |a list of all ids in the record's subtree|
+|`depth`            |the depth of the node, root nodes are at depth 0|
+
+\*   If the record is a root, other root records are considered siblings
+\*   Siblings returns the record itself
+
+There are also instance methods to determine the relationship between 2 nodes:
+
+|method             |return value|
+|-------------------|---------------|
+|`parent_of?(node)`  | node's parent is this record|
+|`root_of?(node)`    | node's root is this record|
+|`ancestor_of?(node)`| node's ancestors include this record|
+|`child_of?(node)`   | node is record's parent|
 
 # Options for `has_ancestry`
 
-The has_ancestry methods supports the following options:
+The has_ancestry method supports the following options:
 
     :ancestry_column       Pass in a symbol to store ancestry in a different column
     :orphan_strategy       Instruct Ancestry what to do with children of a node that is destroyed:
@@ -155,7 +154,7 @@ example:
 
 ```ruby
 node.children.where(:name => 'Mary').exists?
-node.subtree.order(:name).limit(10).each do; ...; end
+node.subtree.order(:name).limit(10).each { ... }
 node.descendants.count
 ```
 
@@ -215,7 +214,7 @@ instead.
 
 Ancestry works fine with STI. Just create a STI inheritance hierarchy and
 build an Ancestry tree from the different classes/models. All Ancestry
-relations that where described above will return nodes of any model type. If
+relations that were described above will return nodes of any model type. If
 you do only want nodes of a specific subclass you'll have to add a condition
 on type for that.
 
@@ -225,11 +224,12 @@ Ancestry can arrange an entire subtree into nested hashes for easy navigation
 after retrieval from the database.  TreeNode.arrange could for example return:
 
 ```ruby
-{ #<TreeNode id: 100018, name: "Stinky", ancestry: nil>
-  => { #<TreeNode id: 100019, name: "Crunchy", ancestry: "100018">
-    => { #<TreeNode id: 100020, name: "Squeeky", ancestry: "100018/100019">
-      => {}
-    }
+{
+  #<TreeNode id: 100018, name: "Stinky", ancestry: nil> => {
+    #<TreeNode id: 100019, name: "Crunchy", ancestry: "100018"> => {
+      #<TreeNode id: 100020, name: "Squeeky", ancestry: "100018/100019"> => {}
+    },
+    #<TreeNode id: 100021, name: "Squishy", ancestry: "100018"> => {}
   }
 }
 ```
@@ -277,7 +277,7 @@ Or plain hashes:
 ```ruby
 TreeNode.arrange_serializable do |parent, children|
   {
-     my_id: parent.id
+     my_id: parent.id,
      my_children: children
   }
 end
@@ -312,7 +312,7 @@ the order of siblings depends on their order in the original array.
 # Migrating from plugin that uses parent_id column
 
 Most current tree plugins use a parent_id column (has_ancestry,
-awesome_nested_set, better_nested_set, acts_as_nested_set). With ancestry its
+awesome_nested_set, better_nested_set, acts_as_nested_set). With ancestry it is
 easy to migrate from any of these plugins, to do so, use the
 build_ancestry_from_parent_ids! method on your ancestry model. These steps
 provide a more detailed explanation:
@@ -418,7 +418,7 @@ remove the limitation entirely. Changing it to a text will however decrease
 performance because an index cannot be put on the column in that case.
 
 The materialised path pattern requires Ancestry to use a 'like' condition in
-order to fetch descendants. The wild character (`%`) is on the left of the
+order to fetch descendants. The wild character (`%`) is on the right of the
 query, so indexes should be used.
 
 # Contributing and license

data/ancestry.gemspec

@@ -37,12 +37,14 @@ EOF
     'lib/ancestry/class_methods.rb',
     'lib/ancestry/instance_methods.rb',
     'lib/ancestry/materialized_path.rb',
+    'lib/ancestry/version.rb',
     'MIT-LICENSE',
     'README.md'
   ]
   
   s.required_ruby_version     = '>= 1.8.7'
   s.add_runtime_dependency 'activerecord', '>= 3.2.0'
+  s.add_development_dependency 'rdoc'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'rake',      '~> 10.0'
   s.add_development_dependency 'test-unit'

data/lib/ancestry.rb

@@ -1,3 +1,4 @@
+require_relative 'ancestry/version'
 require_relative 'ancestry/class_methods'
 require_relative 'ancestry/instance_methods'
 require_relative 'ancestry/exceptions'

data/lib/ancestry/has_ancestry.rb

@@ -46,12 +46,12 @@ module Ancestry
       scope :siblings_of, lambda { |object| where(sibling_conditions(object)) }
       scope :ordered_by_ancestry, Proc.new { |order|
         if %w(mysql mysql2 sqlite sqlite3 postgresql).include?(connection.adapter_name.downcase) && ActiveRecord::VERSION::MAJOR >= 5
-          reorder("coalesce(#{connection.quote_table_name(table_name)}.#{connection.quote_column_name(ancestry_column)}, '')", order)
+          reorder(Arel.sql("coalesce(#{connection.quote_table_name(table_name)}.#{connection.quote_column_name(ancestry_column)}, '')"), order)
         else
-          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)
+          reorder(Arel.sql("(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)
         end
       }
-      scope :ordered_by_ancestry_and, Proc.new { |order| ordered_by_ancestry_and(order) }
+      scope :ordered_by_ancestry_and, Proc.new { |order| ordered_by_ancestry(order) }
       scope :path_of, lambda { |object| to_node(object).path }
 
       # Update descendants with new ancestry before save

data/lib/ancestry/instance_methods.rb

@@ -114,13 +114,7 @@ module Ancestry
     end
 
     def ancestor_ids_was
-      relevant_attributes = if ActiveRecord::VERSION::STRING >= '5.1.0'
-        saved_changes.transform_values(&:first)
-      else
-        changed_attributes
-      end
-
-      parse_ancestry_column(relevant_attributes[self.ancestry_base_class.ancestry_column.to_s])
+      parse_ancestry_column(send("#{self.ancestry_base_class.ancestry_column}_was"))
     end
 
     def path_ids

data/lib/ancestry/version.rb

@@ -0,0 +1,3 @@
+module Ancestry
+  VERSION = "3.0.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ancestry
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Stefan Kroes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: yard
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +133,7 @@ files:
 - lib/ancestry/has_ancestry.rb
 - lib/ancestry/instance_methods.rb
 - lib/ancestry/materialized_path.rb
+- lib/ancestry/version.rb
 homepage: http://github.com/stefankroes/ancestry
 licenses:
 - MIT
@@ -143,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Organize ActiveRecord model into a tree structure