acts_as_recursive_tree 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78b84c59d5275ca8152223f64df66c813a6b9b03
+  data.tar.gz: 7aa3a0fb72cc5ed2c5bd8f93d312b972273e06dd
+SHA512:
+  metadata.gz: f84ae5d103dc3df1ea1184db885771a082cd9d4a7b83af99c10fef9ef68d51f134d7e5150ed930fbc3abf7fcf98ee5ee567ccb528537dafb3e46b6df4ed002c0
+  data.tar.gz: fcb95ae5256b96813a63658897462e99b596512ab8cae861e4236de41ce746bc22261cf2649a61ee4535ef92a876e337f600558a3aecf87c392373a028f66b2e

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea
+db.log
+test.sqlite3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,321 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-01-22 09:50:37 +0100 using RuboCop version 0.51.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles, IndentOneStep, IndentationWidth.
+# SupportedStyles: case, end
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/CommentIndentation:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterMagicComment:
+  Exclude:
+    - 'acts_as_recursive_tree.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAdjacentOneLineDefs, NumberOfEmptyLines.
+Layout/EmptyLineBetweenDefs:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/model.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+Layout/EmptyLines:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/model.rb'
+    - 'spec/db/models.rb'
+    - 'spec/model/node_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 25
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: empty_lines, no_empty_lines
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/scopes.rb'
+    - 'spec/db/schema.rb'
+    - 'spec/model/location_spec.rb'
+    - 'spec/model/node_spec.rb'
+    - 'spec/model/relation_spec.rb'
+    - 'spec/values_spec.rb'
+
+# Offense count: 11
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/builders/ancestors.rb'
+    - 'lib/acts_as_recursive_tree/builders/leaves.rb'
+    - 'lib/acts_as_recursive_tree/builders/relation_builder.rb'
+    - 'lib/acts_as_recursive_tree/options/depth_condition.rb'
+    - 'lib/acts_as_recursive_tree/options/query_options.rb'
+    - 'spec/db/models.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+Layout/EmptyLinesAroundMethodBody:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/acts_macro.rb'
+    - 'lib/acts_as_recursive_tree/builders/leaves.rb'
+    - 'lib/acts_as_recursive_tree/options/values.rb'
+    - 'spec/model/node_spec.rb'
+    - 'spec/model/relation_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/acts_macro.rb'
+    - 'lib/acts_as_recursive_tree/model.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
+# SupportedStyles: consistent, special_for_inner_method_call, special_for_inner_method_call_in_parentheses
+Layout/FirstParameterIndentation:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/builders/leaves.rb'
+    - 'lib/acts_as_recursive_tree/model.rb'
+    - 'spec/model/relation_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, SupportedStylesForEmptyBraces.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceBeforeBlockBraces:
+  Exclude:
+    - 'spec/values_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: require_no_space, require_space
+Layout/SpaceInLambdaLiteral:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/scopes.rb'
+    - 'spec/builders_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SupportedStylesForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideBlockBraces:
+  Exclude:
+    - 'spec/values_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: final_newline, final_blank_line
+Layout/TrailingBlankLines:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/acts_macro.rb'
+    - 'lib/acts_as_recursive_tree/options/depth_condition.rb'
+    - 'lib/acts_as_recursive_tree/options/values.rb'
+    - 'spec/db/database.rb'
+    - 'spec/db/models.rb'
+    - 'spec/db/schema.rb'
+    - 'spec/model/location_spec.rb'
+    - 'spec/model/node_spec.rb'
+    - 'spec/model/relation_spec.rb'
+    - 'spec/values_spec.rb'
+
+# Offense count: 14
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'spec/builders_spec.rb'
+    - 'spec/values_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/DeprecatedClassMethods:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleAlignWith, SupportedStylesAlignWith, AutoCorrect.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Lint/EndAlignment:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/options/values.rb'
+
+# Offense count: 1
+Lint/HandleExceptions:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/builders/leaves.rb'
+
+# Offense count: 5
+Metrics/AbcSize:
+  Max: 44
+
+# Offense count: 8
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 89
+
+# Offense count: 41
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 291
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Security/YAMLLoad:
+  Exclude:
+    - 'spec/db/database.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: prefer_alias, prefer_alias_method
+Style/Alias:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/acts_macro.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/BlockComments:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ColonMethodCall:
+  Exclude:
+    - 'spec/db/database.rb'
+
+# Offense count: 20
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/acts_as_recursive_tree.rb'
+    - 'lib/acts_as_recursive_tree/acts_macro.rb'
+    - 'lib/acts_as_recursive_tree/associations.rb'
+    - 'lib/acts_as_recursive_tree/builders.rb'
+    - 'lib/acts_as_recursive_tree/builders/ancestors.rb'
+    - 'lib/acts_as_recursive_tree/builders/descendants.rb'
+    - 'lib/acts_as_recursive_tree/builders/leaves.rb'
+    - 'lib/acts_as_recursive_tree/builders/relation_builder.rb'
+    - 'lib/acts_as_recursive_tree/model.rb'
+    - 'lib/acts_as_recursive_tree/options.rb'
+    - 'lib/acts_as_recursive_tree/options/depth_condition.rb'
+    - 'lib/acts_as_recursive_tree/options/query_options.rb'
+    - 'lib/acts_as_recursive_tree/options/values.rb'
+    - 'lib/acts_as_recursive_tree/railtie.rb'
+    - 'lib/acts_as_recursive_tree/scopes.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: compact, expanded
+Style/EmptyMethod:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/options/values.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/Encoding:
+  Exclude:
+    - 'acts_as_recursive_tree.gemspec'
+    - 'spec/db/schema.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Exclude:
+    - 'spec/db/schema.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'spec/model/node_spec.rb'
+    - 'spec/model/relation_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: InverseMethods, InverseBlocks.
+Style/InverseMethods:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/model.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: line_count_dependent, lambda, literal
+Style/Lambda:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/scopes.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MultilineIfModifier:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/scopes.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'Rakefile'
+    - 'acts_as_recursive_tree.gemspec'
+
+# Offense count: 17
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/acts_as_recursive_tree/acts_macro.rb'
+    - 'lib/acts_as_recursive_tree/associations.rb'
+    - 'lib/acts_as_recursive_tree/model.rb'
+    - 'lib/acts_as_recursive_tree/scopes.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Exclude:
+    - 'acts_as_recursive_tree.gemspec'

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+### Version 2.0.0
+- drop support for rails < 5.0
+- support for polymorphic parent relations
+
+### Version 1.1.1
+- BUGFIX: not checking presence of relation with _present?_  method - this causes execution of the relation
+- added missing != method for depth
+
+### Version 1.1.0
+- scopes and method can now be passed a Proc instance for additional modifications of the query
+- new option to specify the depth to query
+
+### Version 1.0.1
+- BUGFIX: ordering result when querying ancestors
+
+### Version 1.0.0
+- inital release using AREL

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_recursive_tree.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Wolfgang Wedelich-John
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,175 @@
+# ActsAsRecursiveTree
+
+Use the power of recursive SQL statements in your Rails application.
+
+When you have tree based data in your application, you always to struggle with retrieving data. There are solutions, but the always come at a price:
+
+  * Nested Set is fast at retrieval, but when inserting you might have to rearrange bounds, which can be very complex
+  * Closure_Tree stores additional data in a separate table, which has be kept up to date
+
+Luckily, there is already a SQL standard that makes it very easy to retrieve data in the traditional parent/child relation. Currently this is only supported in sqlite and Postgres. With this it is possible to query complete trees without the need of extra tables or indices.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_recursive_tree'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_recursive_tree
+
+
+In your model class add following line:
+
+```ruby
+class Node  < ActiveRecord::Base
+  recursive_tree
+end
+```
+That's it. This will assume that your model has a column named `parent_id` which will be used for traversal. If your column is something different, then you can specifiy it in the call to `recursive_tree`:
+
+```ruby
+recursive_tree parent_key: :some_other_column
+```
+
+Some extra special stuff - if your parent relation is also polymorphic, the specify the polymorphic column:
+
+```ruby
+recursive_tree parent_type_column: :some_other_type_column
+```
+
+## Usage
+
+After you set up a model for usage, there are now several methods you can use.
+
+### Associations
+
+You have access to following associations:
+
+   * `parent` - the parent of this instance
+   * `children` - all children (parent_id = self.id)
+   * `self_and_siblings` - all node where parent_id = self.parent_id
+
+### Class Methods
+
+  * `roots` - all root elements (parent_id = nil)
+  * `self_and_descendants_of(reference)` - the complete tree of `reference` __including__ `reference` in the result
+  * `descendants_of(reference)` - the complete tree of `reference` __excluding__ `reference` in the result
+  * `leaves_of(reference)` - special case of descendants where only those elements are returned, that do not have any children
+  * `self_and_ancestors_of(reference)` - the complete ancestor list of `reference` __including__ `reference` in the result
+  * `ancestors_of(reference)` - the complete ancestor list of `reference` __excluding__ `reference` in the result
+  * `roots_of(reference)` - special case of ancestors where only those elements are returned, that do not have any parent 
+
+You can pass in following argument types for `reference`, that will be accepted:
+  * `integer` - simple integer value
+
+```ruby
+    Node.descendants_of(1234)
+```
+
+  * `array` - array of integer value
+
+```ruby
+    Node.descendants_of([1234, 5678])
+```
+
+  * `ActiveRecord::Base` - instance of an AR::Model class
+
+```ruby
+    Node.descendants_of(some_node)
+```
+
+  * `ActiveRecord::Relation` - an AR::Relation form the same type
+
+```ruby
+    Node.descendants_of(Node.where(foo: :bar))
+```
+
+
+### Instance Methods
+
+For nearly all mentioned scopes and associations there is a corresponding instance method:
+
+  * `root` - returns the root element of this node
+  * `self_and_descendants` - the complete tree __including__ `self` in the result
+  * `descendants` - the complete tree __excluding__ `self` in the result
+  * `leaves` - only leaves of this node
+  * `self_and_ancestors` - the complete ancestor list __including__ `self` in the result
+  * `ancestors` - the complete ancestor list __excluding__ `self` in the result
+  
+Those methods simply delegate to the corresponding scope and pass `self` as reference.
+
+__Additional methods:__
+  * `siblings` - return all elements where parent_id = self.parent_id __excluding__ `self`
+  * `self_and_children` - return all children and self as a Relation
+  
+__Utility methods:__
+  * `root?` - returns true if this node is a root node
+  * `leaf?` - returns true if this node is a leave node
+
+
+## Customizing the recursion
+
+All *ancestors* and *descendants* methods/scopes can take an additional block argument. The block receives ans `opts` argument with which you are able to customize the recursion.
+
+
+__Depth__
+
+Specify a depth condition. Only the elements matching the depth are returned.
+Supported operations are:
+  * `==` exact match - can be Integer or Range or Array. When specifying a Range this will result in a `depth BETWEEN min AND max` query. 
+  * `!=` except - can be Integer or Array
+  * `>` greater than - only Integer
+  * `>=` greater than or equals - only Integer
+  * `<` less than - only Integer
+  * `<=` less than or equals - only Integer
+
+```ruby
+Node.descendants_of(1){|opts| opts.depth == 3..6 }
+node_instance.descendants{ |opts| opts.depth <= 4 }
+node_instance.descendants{ |opts| opts.depth != [4, 7] }
+```
+NOTE: `depth == 1` is the same as `children/parent`
+ 
+__Condition__
+
+Pass in an additional relation. Only those elements are returned where the condition query matches. 
+
+```ruby
+Node.descendants_of(1){|opts| opts.condition = Node.where(active: true) }
+node_instance.descendants{ |opts| opts.condition = Node.where(active: true) }
+```
+NOTE: In contrast to depth, which first gathers the complete tree and then discards all non matching results, this will stop the recursive traversal when the relation is not met. Following two lines are completely different when executed: 
+
+```ruby
+node_instance.descendants.where(active: true) # => returns the complete tree and filters than out only the active ones
+node_instance.descendants{ |opts| opts.condition = Node.where(active: true) } # => stops the recursion when encountering a non active node, which may return less results than the one above
+```
+
+__Ordering__
+All the *ancestor* methods will order the result depending on the depth of the recursion. Ordering for the *descendants* methods is disabled by default, but can be enabled if needed.
+
+```ruby
+Node.descendants_of(1){|opts| opts.ensure_ordering! }
+node_instance.descendants{ |opts| opts.ensure_ordering! }
+```
+
+NOTE: if there are many descendants this may cause a severe increase in execution time! 
+
+  
+
+## Contributing
+
+1. Fork it ( https://github.com/1and1/acts_as_recursive_tree/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: [:spec]
+rescue LoadError
+end
+
+desc 'Deletes temporary files'
+task :clean_tmp_files do
+  %w( db.log test.sqlite3 ).each do |file|
+    File.delete(file) if File.exists?(file)
+  end
+end

data/acts_as_recursive_tree.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_recursive_tree/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'acts_as_recursive_tree'
+  spec.version     = ActsAsRecursiveTree::VERSION
+  spec.authors     = ['Wolfgang Wedelich-John']
+  spec.email       = ['wolfgang.wedelich@1und1.de']
+  spec.summary     = %q{Drop in replacement for acts_as_tree but using recursive queries}
+  spec.description = %q{
+  This is a ruby gem that provides drop in replacement for acts_as_tree but makes use of SQL recursive statement. Be sure to have a DBMS that supports recursive queries when using this gem (e.g. PostgreSQL or SQLite). }
+  spec.homepage    = 'https://github.com/1and1/acts_as_recursive_tree'
+  spec.license     = 'MIT'
+
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.files                 = `git ls-files -z`.split("\x0")
+  spec.executables           = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files            = spec.files.grep(%r{^spec/})
+  spec.require_paths         = ['lib']
+
+  spec.add_runtime_dependency 'activerecord', '>= 5.0.0', '< 6.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'database_cleaner', '~> 1.5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.5.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.10'
+end

data/lib/acts_as_recursive_tree/acts_macro.rb

@@ -0,0 +1,28 @@
+require 'ostruct'
+
+module ActsAsRecursiveTree
+  module ActsMacro
+
+    ##
+    # Configuration options are:
+    #
+    # * <tt>foreign_key</tt> - specifies the column name to use for tracking
+    # of the tree (default: +parent_id+)
+    def recursive_tree(parent_key: :parent_id, parent_type_column: nil)
+
+      class_attribute :_recursive_tree_config
+      self._recursive_tree_config = OpenStruct.new(
+        primary_key:        self.primary_key.to_sym,
+        parent_key:         parent_key.to_sym,
+        parent_type_column: parent_type_column.try(:to_sym),
+        depth_column:       :recursive_depth
+      )
+
+      include ActsAsRecursiveTree::Model
+      include ActsAsRecursiveTree::Associations
+      include ActsAsRecursiveTree::Scopes
+    end
+
+    alias_method :acts_as_tree, :recursive_tree
+  end
+end

data/lib/acts_as_recursive_tree/associations.rb

@@ -0,0 +1,25 @@
+require 'active_support/concern'
+
+module ActsAsRecursiveTree
+  module Associations
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :parent,
+                 class_name:  self.base_class.to_s,
+                 foreign_key: self._recursive_tree_config.parent_key,
+                 inverse_of:  :children,
+                 optional:    true
+
+      has_many :children,
+               class_name:  self.base_class.to_s,
+               foreign_key: self._recursive_tree_config.parent_key,
+               inverse_of:  :parent
+
+      has_many :self_and_siblings,
+               class_name:  self.base_class.to_s,
+               primary_key: self._recursive_tree_config.parent_key,
+               foreign_key: self._recursive_tree_config.parent_key
+    end
+  end
+end