acts_as_recursive_tree 2.0.0

data/spec/db/models.rb

@@ -0,0 +1,37 @@
+ActiveRecord::Base.class_exec do
+  extend ActsAsRecursiveTree::ActsMacro
+end
+
+class Node < ActiveRecord::Base
+  acts_as_tree
+  has_one :node_info
+end
+
+class NodeInfo < ActiveRecord::Base
+  belongs_to :node
+end
+
+class NodeWithPolymorphicParent < ActiveRecord::Base
+  acts_as_tree parent_key: :other_id, parent_type_column: :other_type
+end
+
+
+class NodeWithOtherParentKey < ActiveRecord::Base
+  acts_as_tree parent_key: :other_id
+end
+
+class Location < ActiveRecord::Base
+  acts_as_tree
+end
+
+class Building < Location
+
+end
+
+class Floor < Location
+
+end
+
+class Room < Location
+
+end

data/spec/db/schema.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :nodes do |t|
+    t.integer :parent_id
+    t.string :name
+    t.boolean :active, default: true
+  end
+
+  add_foreign_key(:nodes, :nodes, column: :parent_id)
+
+  create_table :node_infos do |t|
+    t.belongs_to :node
+    t.string :status
+  end
+
+  create_table :node_with_other_parent_keys do |t|
+    t.integer :other_id
+  end
+
+  create_table :node_with_polymorphic_parents do |t|
+    t.integer :other_id
+    t.string :other_type
+  end
+
+  create_table :locations do |t|
+    t.integer :parent_id
+    t.string :name
+    t.string :type
+  end
+
+  add_foreign_key(:locations, :locations, column: :parent_id)
+end

data/spec/model/location_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Location do
+  before do
+    @building = Building.create!(name: 'big house')
+
+    1.upto(5) do |index|
+      floor = Floor.create!(name: "#{index}. Floor")
+
+      @building.children << floor
+
+      1.upto(5) do |index_room|
+
+        floor.children << Room.create!(name: "#{index_room}. Room")
+      end
+    end
+  end
+
+  describe 'building' do
+    it 'has 30 descendants' do
+      expect(@building.descendants.count).to eq(5 + (5 * 5))
+    end
+
+    context '::descendants_of' do
+
+      context 'with Room' do
+        let(:rooms) { Room.descendants_of(@building) }
+
+        it 'should have 25 rooms' do
+          expect(rooms.count).to eq(25)
+        end
+
+        it 'should all be of type Room' do
+          expect(rooms.all).to all(be_an(Room))
+        end
+
+      end
+
+      context 'with Floor' do
+        let(:floors) { Floor.descendants_of(@building) }
+
+        it 'should have 5 Floors' do
+          expect(floors.count).to eq(5)
+        end
+
+        it 'should all be of type Floor' do
+          expect(floors.all).to all(be_an(Floor))
+        end
+
+      end
+
+    end
+  end
+
+end

data/spec/model/node_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe Node do
+
+  def create_tree(max_level, current_level = 0, node = nil)
+
+    if node.nil?
+      node = Node.create!(name: 'root')
+    end
+
+    1.upto(max_level - current_level) do |index|
+      child = node.children.create!(name: "child #{index} - level #{current_level}")
+      create_tree(max_level, current_level + 1, child)
+    end
+
+    node
+  end
+
+  before do
+    @root  = create_tree(3)
+    @child = @root.children.first
+  end
+
+  context '#children' do
+    it 'should have 3 children' do
+      expect(@root.children.count).to eql(3)
+    end
+
+    it 'should not include root node ' do
+      expect(@root.children).to_not include(@root)
+    end
+
+  end
+
+  context '#descendants' do
+
+    it 'should have 15 descendants' do
+      expect(@root.descendants.count).to eql(3 + (3 * 2) + (3 * 2 * 1))
+    end
+
+    it 'should not include root' do
+      expect(@root.descendants).to_not include(@root)
+    end
+  end
+  context '#self_and_descendants' do
+
+    it 'should have 15 descendants and self' do
+      expect(@root.self_and_descendants.count).to eql(@root.descendants.count + 1)
+    end
+
+    it 'should include self' do
+      expect(@root.self_and_descendants.all).to include(@root)
+    end
+  end
+
+  context '#root?' do
+
+    it 'should be true for root node' do
+      expect(@root.root?).to be_truthy
+    end
+
+    it 'should be false for children' do
+      expect(@child.root?).to be_falsey
+    end
+
+  end
+
+  context '#leaf?' do
+
+    it 'should be false for root node' do
+      expect(@root.leaf?).to be_falsey
+    end
+
+    it 'should be true for children' do
+      expect(@root.leaves.first.leaf?).to be_truthy
+    end
+
+  end
+
+
+  context '#leaves' do
+    it 'should have 6 leaves' do
+      expect(@root.leaves.count).to eql(6)
+    end
+  end
+
+  describe 'child' do
+
+    it 'should have root as parent' do
+      expect(@child.parent).to eql(@root)
+    end
+
+    it 'should have 1 ancestor' do
+      expect(@child.ancestors.count).to eql(1)
+    end
+
+    it 'should have root as only ancestor' do
+      expect(@child.ancestors.first).to eql(@root)
+    end
+
+    it '#root should return root' do
+      expect(@child.root).to eql(@root)
+    end
+
+    it '#root? should be false' do
+      expect(@child.root?).to be false
+    end
+
+    it '#leaf? should be false' do
+      expect(@child.leaf?).to be false
+    end
+  end
+
+
+  describe 'scopes' do
+
+    context 'roots' do
+
+      it 'has only one root node' do
+        expect(Node.roots.count).to eql(1)
+      end
+
+      it 'is the @root node' do
+        expect(Node.roots.first).to eql(@root)
+      end
+    end
+
+  end
+end

data/spec/model/relation_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe 'Relation' do
+
+  def create_tree(max_level, current_level: 0, node: nil, stop_at: nil)
+
+    if node.nil?
+      node = Node.create!(name: 'root')
+    end
+
+    1.upto(max_level - current_level) do |index|
+      child = node.children.create!(name: "child #{index} - level #{current_level}", active: stop_at > current_level)
+      child.create_node_info(status: stop_at > current_level ? 'foo' : 'bar')
+      create_tree(max_level, current_level: current_level + 1, node: child, stop_at: stop_at)
+    end
+
+    node
+  end
+
+  before do
+    @root  = create_tree(4, stop_at: 2)
+    @child = @root.children.first
+  end
+
+  context 'descendants' do
+
+    it 'works with simple relation' do
+      desc = @root.descendants { |opts| opts.condition = Node.where(active: true) }
+      desc.all.each do |node|
+        expect(node.active).to be_truthy
+      end
+    end
+
+    it 'works with joins relation' do
+      desc = @root.descendants { |opts| opts.condition = Node.joins(:node_info).where.not(node_infos: { status: 'bar' }) }
+      desc.all.each do |node|
+        expect(node.node_info.status).to eql('foo')
+      end
+    end
+  end
+
+  context 'ancestors' do
+
+    it 'works with simple relation' do
+      ancestors = @root.leaves.first.ancestors { |opts| opts.condition = Node.where(active: false) }.to_a
+
+      ancestors.each do |node|
+        expect(node.active).to be_falsey
+      end
+
+      expect(ancestors).to_not include(@root)
+    end
+
+    it 'works with joins relation' do
+      ancestors = @root.leaves.first.ancestors { |opts| opts.condition = Node.joins(:node_info).where.not(node_infos: { status: 'foo' }) }
+      ancestors.all.each do |node|
+        expect(node.node_info.status).to eql('bar')
+      end
+      expect(ancestors).to_not include(@root)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,119 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+require 'active_record'
+
+require 'acts_as_recursive_tree'
+require_relative 'db/database'
+
+require 'database_cleaner'
+
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end

data/spec/values_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+shared_examples 'single values' do
+  subject(:value) { described_class.create(single_value) }
+
+  it { is_expected.to be_a ActsAsRecursiveTree::Options::Values::SingleValue }
+
+  it 'should apply_to' do
+    expect(value.apply_to(attribute).to_sql).to end_with " = #{single_value}"
+  end
+
+  it 'should apply_negated_to' do
+    expect(value.apply_negated_to(attribute).to_sql).to end_with " != #{single_value}"
+  end
+end
+
+describe ActsAsRecursiveTree::Options::Values do
+  let(:table) { Arel::Table.new('test_table') }
+  let(:attribute) { table['test_attr'] }
+
+  context 'invalid agurment' do
+    it 'should raise exception' do
+      expect{described_class.create(nil)}.to raise_exception /is not supported/
+    end
+  end
+
+  context 'single value' do
+    let(:single_value) { 3 }
+
+    it_behaves_like 'single values' do
+      let(:value_obj) { single_value }
+    end
+
+    it_behaves_like 'single values' do
+      let(:value_obj) { Node.new(id: single_value) }
+    end
+
+  end
+
+  context 'multi value' do
+    context 'Array' do
+      let(:array) { [1, 2, 3] }
+      subject(:value) { described_class.create(array) }
+
+      it { is_expected.to be_a ActsAsRecursiveTree::Options::Values::MultiValue }
+
+      it 'should apply_to' do
+        expect(value.apply_to(attribute).to_sql).to end_with " IN (#{array.join(', ')})"
+      end
+
+      it 'should apply_negated_to' do
+        expect(value.apply_negated_to(attribute).to_sql).to end_with " NOT IN (#{array.join(', ')})"
+      end
+    end
+
+    context 'Range' do
+      let(:range) { 1..3 }
+      subject(:value) { described_class.create(range) }
+
+      it { is_expected.to be_a ActsAsRecursiveTree::Options::Values::MultiValue }
+
+      it 'should apply_to' do
+        expect(value.apply_to(attribute).to_sql).to end_with "BETWEEN #{range.begin} AND #{range.end}"
+      end
+
+      it 'should apply_negated_to' do
+        expect(value.apply_negated_to(attribute).to_sql).to match /< #{range.begin} OR.* > #{range.end}/
+      end
+    end
+
+    context 'Relation' do
+      let(:relation) { Node.where(name: 'test') }
+      subject(:value) { described_class.create(relation, OpenStruct.new(primary_key: :id)) }
+
+      it { is_expected.to be_a ActsAsRecursiveTree::Options::Values::Relation }
+
+      it 'should apply_to' do
+        expect(value.apply_to(attribute).to_sql).to match /IN \(SELECT.*\)/
+      end
+
+      it 'should apply_negated_to' do
+        expect(value.apply_negated_to(attribute).to_sql).to match /NOT IN \(SELECT.*\)/
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_recursive_tree
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Wolfgang Wedelich-John
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+description: "\n  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). "
+email:
+- wolfgang.wedelich@1und1.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_recursive_tree.gemspec
+- 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
+- lib/acts_as_recursive_tree/version.rb
+- spec/builders_spec.rb
+- spec/db/database.rb
+- spec/db/database.yml
+- spec/db/models.rb
+- spec/db/schema.rb
+- spec/model/location_spec.rb
+- spec/model/node_spec.rb
+- spec/model/relation_spec.rb
+- spec/spec_helper.rb
+- spec/values_spec.rb
+homepage: https://github.com/1and1/acts_as_recursive_tree
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Drop in replacement for acts_as_tree but using recursive queries
+test_files:
+- spec/builders_spec.rb
+- spec/db/database.rb
+- spec/db/database.yml
+- spec/db/models.rb
+- spec/db/schema.rb
+- spec/model/location_spec.rb
+- spec/model/node_spec.rb
+- spec/model/relation_spec.rb
+- spec/spec_helper.rb
+- spec/values_spec.rb