acts_as_recursive_tree 2.2.1 → 3.0.0

data/lib/acts_as_recursive_tree/builders/{strategy → strategies}/ancestor.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
-    module Strategy
+    module Strategies
       #
       # Strategy for building ancestors relation
       #

data/lib/acts_as_recursive_tree/builders/{strategy → strategies}/descendant.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
-    module Strategy
+    module Strategies
       #
       # Strategy for building descendants relation
       #

data/lib/acts_as_recursive_tree/builders/{strategy → strategies}/join.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
-    module Strategy
+    module Strategies
       #
       # Build a relation using an INNER JOIN.
       #
@@ -19,12 +21,12 @@ module ActsAsRecursiveTree
 
           relation = builder.klass.joins(final_select_mgr.join_sources)
 
-          relation = apply_order(builder, relation)
-          relation
+          apply_order(builder, relation)
         end
 
         def self.apply_order(builder, relation)
           return relation unless builder.ensure_ordering
+
           relation.order(builder.recursive_temp_table[builder.depth_column].asc)
         end
       end

data/lib/acts_as_recursive_tree/builders/{strategy → strategies}/subselect.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
-    module Strategy
+    module Strategies
       #
       # Strategy for building a relation using an WHERE ID IN(...).
       #

data/lib/acts_as_recursive_tree/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   #
   # Stores the configuration of one Model class

data/lib/acts_as_recursive_tree/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Model
     extend ActiveSupport::Concern
@@ -40,7 +42,7 @@ module ActsAsRecursiveTree
     ##
     # Returns the root node of the tree.
     def root
-      self_and_ancestors.where(self._recursive_tree_config.parent_key => nil).first
+      self_and_ancestors.where(_recursive_tree_config.parent_key => nil).first
     end
 
     ##
@@ -48,7 +50,7 @@ module ActsAsRecursiveTree
     #
     # subchild1.siblings # => [subchild2]
     def siblings
-      self_and_siblings.where.not(id: self.id)
+      self_and_siblings.where.not(id: id)
     end
 
     ##
@@ -57,11 +59,11 @@ module ActsAsRecursiveTree
     # root.self_and_children # => [root, child1]
     def self_and_children
       table = self.class.arel_table
-      id    = self.attributes[self._recursive_tree_config.primary_key.to_s]
+      id    = attributes[_recursive_tree_config.primary_key.to_s]
 
       base_class.where(
-        table[self._recursive_tree_config.primary_key].eq(id).or(
-          table[self._recursive_tree_config.parent_key].eq(id)
+        table[_recursive_tree_config.primary_key].eq(id).or(
+          table[_recursive_tree_config.parent_key].eq(id)
         )
       )
     end
@@ -73,13 +75,12 @@ module ActsAsRecursiveTree
       base_class.leaves_of(self)
     end
 
-
     # Returns true if node has no parent, false otherwise
     #
     # subchild1.root? # => false
     # root.root? # => true
     def root?
-      self.attributes[self._recursive_tree_config.parent_key.to_s].blank?
+      attributes[_recursive_tree_config.parent_key.to_s].blank?
     end
 
     # Returns true if node has no children, false otherwise
@@ -87,7 +88,7 @@ module ActsAsRecursiveTree
     # subchild1.leaf? # => true
     # child1.leaf? # => false
     def leaf?
-      !children.any?
+      children.none?
     end
 
     def base_class

data/lib/acts_as_recursive_tree/options/depth_condition.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Options
     class DepthCondition
-
       def ==(other)
         @value     = Values.create(other)
         @operation = true
@@ -45,4 +46,4 @@ module ActsAsRecursiveTree
       end
     end
   end
-end
+end

data/lib/acts_as_recursive_tree/options/query_options.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Options
     class QueryOptions
-
-      STRATEGIES = %i[subselect, join].freeze
+      STRATEGIES = %i[subselect join].freeze
 
       attr_accessor :condition
       attr_reader :ensure_ordering, :query_strategy
@@ -21,6 +22,7 @@ module ActsAsRecursiveTree
 
       def query_strategy=(strategy)
         raise "invalid strategy #{strategy} - only #{STRATEGIES} are allowed" unless STRATEGIES.include?(strategy)
+
         @query_strategy = strategy
       end
     end

data/lib/acts_as_recursive_tree/options/values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Options
     module Values
@@ -13,13 +15,9 @@ module ActsAsRecursiveTree
           value
         end
 
-        def apply_to(attribute)
-
-        end
-
-        def apply_negated_to(attribute)
+        def apply_to(attribute); end
 
-        end
+        def apply_negated_to(attribute); end
       end
 
       class SingleValue < Base
@@ -68,19 +66,19 @@ module ActsAsRecursiveTree
 
       def self.create(value, config = nil)
         klass = case value
-        when ::Numeric, ::String
-          SingleValue
-        when ::ActiveRecord::Relation
-          Relation
-        when Range
-          RangeValue
-        when Enumerable
-          MultiValue
-        when ::ActiveRecord::Base
-          ActiveRecord
-        else
-          raise "#{value.class} is not supported"
-        end
+                when ::Numeric, ::String
+                  SingleValue
+                when ::ActiveRecord::Relation
+                  Relation
+                when Range
+                  RangeValue
+                when Enumerable
+                  MultiValue
+                when ::ActiveRecord::Base
+                  ActiveRecord
+                else
+                  raise "#{value.class} is not supported"
+                end
 
         klass.new(value, config)
       end

data/lib/acts_as_recursive_tree/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   class Railtie < Rails::Railtie
     initializer 'acts_as_recursive_tree.active_record_initializer' do

data/lib/acts_as_recursive_tree/scopes.rb

@@ -1,13 +1,17 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Scopes
     extend ActiveSupport::Concern
 
     included do
-      scope :roots, -> {
+      scope :roots, lambda {
         rel = where(_recursive_tree_config.parent_key => nil)
-        rel = rel.or(
-          where.not(_recursive_tree_config.parent_type_column => self.to_s)
-        ) if _recursive_tree_config.parent_type_column
+        if _recursive_tree_config.parent_type_column
+          rel = rel.or(
+            where.not(_recursive_tree_config.parent_type_column => to_s)
+          )
+        end
 
         rel
       }

data/lib/acts_as_recursive_tree/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
-  VERSION = '2.2.1'.freeze
+  VERSION = '3.0.0'
 end

data/spec/builders_spec.rb

@@ -1,13 +1,17 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 shared_context 'setup with enforced ordering' do
   let(:ordering) { false }
   include_context 'base_setup' do
-    let(:proc) { -> (config) { config.ensure_ordering! } }
+    let(:proc) { ->(config) { config.ensure_ordering! } }
   end
 end
 
 shared_context 'base_setup' do
+  subject(:query) { builder.build.to_sql }
+
   let(:model_id) { 1 }
   let(:model_class) { Node }
   let(:exclude_ids) { false }
@@ -15,19 +19,20 @@ shared_context 'base_setup' do
   let(:builder) do
     described_class.new(model_class, model_id, exclude_ids: exclude_ids, &proc)
   end
-  subject(:query) { builder.build.to_sql }
 end
 
 shared_examples 'basic recursive examples' do
   it { is_expected.to start_with "SELECT \"#{model_class.table_name}\".* FROM \"#{model_class.table_name}\"" }
 
-  it { is_expected.to match /WHERE "#{model_class.table_name}"."#{model_class.primary_key}" = #{model_id}/ }
+  it { is_expected.to match(/WHERE "#{model_class.table_name}"."#{model_class.primary_key}" = #{model_id}/) }
 
-  it { is_expected.to match /WITH RECURSIVE "#{builder.travers_loc_table.name}" AS/ }
+  it { is_expected.to match(/WITH RECURSIVE "#{builder.travers_loc_table.name}" AS/) }
 
-  it { is_expected.to match /SELECT "#{model_class.table_name}"."#{model_class.primary_key}", "#{model_class.table_name}"."#{model_class._recursive_tree_config.parent_key}", 0 AS recursive_depth FROM "#{model_class.table_name}"/ }
+  it { is_expected.to match(/SELECT "#{model_class.table_name}"."#{model_class.primary_key}", "#{model_class.table_name}"."#{model_class._recursive_tree_config.parent_key}", 0 AS recursive_depth FROM "#{model_class.table_name}"/) }
 
-  it { is_expected.to match /SELECT "#{model_class.table_name}"."#{model_class.primary_key}", "#{model_class.table_name}"."#{model_class._recursive_tree_config.parent_key}", \("#{builder.travers_loc_table.name}"."recursive_depth" \+ 1\) AS recursive_depth FROM "#{model_class.table_name}"/ }
+  it {
+    expect(subject).to match(/SELECT "#{model_class.table_name}"."#{model_class.primary_key}", "#{model_class.table_name}"."#{model_class._recursive_tree_config.parent_key}", \("#{builder.travers_loc_table.name}"."recursive_depth" \+ 1\) AS recursive_depth FROM "#{model_class.table_name}"/)
+  }
 end
 
 shared_examples 'build recursive query' do
@@ -65,14 +70,14 @@ end
 shared_examples 'ancestor query' do
   include_context 'base_setup'
 
-  it { is_expected.to match /"#{builder.travers_loc_table.name}"."#{model_class._recursive_tree_config.parent_key}" = "#{model_class.table_name}"."#{model_class.primary_key}"/ }
+  it { is_expected.to match(/"#{builder.travers_loc_table.name}"."#{model_class._recursive_tree_config.parent_key}" = "#{model_class.table_name}"."#{model_class.primary_key}"/) }
 end
 
 shared_examples 'descendant query' do
   include_context 'base_setup'
 
-  it { is_expected.to match /"#{model_class.table_name}"."#{model_class._recursive_tree_config.parent_key}" = "#{builder.travers_loc_table.name}"."#{model_class.primary_key}"/ }
-  it { is_expected.to match /#{Regexp.escape(builder.travers_loc_table.project(builder.travers_loc_table[model_class.primary_key]).to_sql)}/ }
+  it { is_expected.to match(/"#{model_class.table_name}"."#{model_class._recursive_tree_config.parent_key}" = "#{builder.travers_loc_table.name}"."#{model_class.primary_key}"/) }
+  it { is_expected.to match(/#{Regexp.escape(builder.travers_loc_table.project(builder.travers_loc_table[model_class.primary_key]).to_sql)}/) }
 end
 
 shared_context 'context with ordering' do
@@ -88,11 +93,11 @@ shared_context 'context without ordering' do
 end
 
 shared_examples 'with ordering' do
-  it { is_expected.to match /ORDER BY #{Regexp.escape(builder.recursive_temp_table[model_class._recursive_tree_config.depth_column].asc.to_sql)}/ }
+  it { is_expected.to match(/ORDER BY #{Regexp.escape(builder.recursive_temp_table[model_class._recursive_tree_config.depth_column].asc.to_sql)}/) }
 end
 
 shared_examples 'without ordering' do
-  it { is_expected.to_not match /ORDER BY/ }
+  it { is_expected.not_to match(/ORDER BY/) }
 end
 
 describe ActsAsRecursiveTree::Builders::Descendants do
@@ -116,6 +121,7 @@ describe ActsAsRecursiveTree::Builders::Ancestors do
     it_behaves_like 'ancestor query'
     include_context 'context with ordering'
   end
+
   context 'with options' do
     include_context 'setup with enforced ordering' do
       it_behaves_like 'with ordering'

data/spec/db/database.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 database_folder           = "#{File.dirname(__FILE__)}/../db"
 database_adapter          = 'sqlite'
 
@@ -6,14 +8,14 @@ ActiveRecord::Base.logger = nil
 
 ActiveRecord::Migration.verbose = false
 
-ActiveRecord::Base.configurations = YAML::load(File.read("#{database_folder}/database.yml"))
+ActiveRecord::Base.configurations = YAML.safe_load(File.read("#{database_folder}/database.yml"))
 
 if ActiveRecord.version >= Gem::Version.new('6.1.0')
-  config = ActiveRecord::Base.configurations.configs_for env_name: database_adapter, name: "primary"
+  config = ActiveRecord::Base.configurations.configs_for env_name: database_adapter, name: 'primary'
   database = config.database
 else
   config = ActiveRecord::Base.configurations[database_adapter]
-  database = config["database"]
+  database = config['database']
 end
 
 # remove database if present
@@ -25,4 +27,3 @@ ActiveRecord::Base.establish_connection(config)
 # require schemata and models
 require_relative 'schema'
 require_relative 'models'
-

data/spec/db/database.yml

@@ -1,12 +1,9 @@
-common: &common
+sqlite:
   database:
   host: localhost
   pool: 50
   timeout: 5000
   reaping_frequency: 1000
   min_messages: ERROR
-
-sqlite:
-  <<: *common
   adapter: sqlite3
-  database: test.sqlite3
+  database: test.sqlite3

data/spec/db/models.rb

@@ -1,37 +1,38 @@
-ActiveRecord::Base.class_exec do
+# frozen_string_literal: true
+
+# Base test class
+class ApplicationRecord < ::ActiveRecord::Base
+  self.abstract_class = true
+
   extend ActsAsRecursiveTree::ActsMacro
 end
 
-class Node < ActiveRecord::Base
+class Node < ApplicationRecord
   acts_as_tree
   has_one :node_info
 end
 
-class NodeInfo < ActiveRecord::Base
+class NodeInfo < ApplicationRecord
   belongs_to :node
 end
 
-class NodeWithPolymorphicParent < ActiveRecord::Base
+class NodeWithPolymorphicParent < ApplicationRecord
   acts_as_tree parent_key: :other_id, parent_type_column: :other_type
 end
 
-
-class NodeWithOtherParentKey < ActiveRecord::Base
+class NodeWithOtherParentKey < ApplicationRecord
   acts_as_tree parent_key: :other_id
 end
 
-class Location < ActiveRecord::Base
+class Location < ApplicationRecord
   acts_as_tree
 end
 
 class Building < Location
-
 end
 
 class Floor < Location
-
 end
 
 class Room < Location
-
-end
+end

data/spec/db/schema.rb

@@ -1,7 +1,6 @@
-# encoding: UTF-8
-
-ActiveRecord::Schema.define(:version => 0) do
+# frozen_string_literal: true
 
+ActiveRecord::Schema.define(version: 0) do
   create_table :nodes do |t|
     t.integer :parent_id
     t.string :name
@@ -31,4 +30,4 @@ ActiveRecord::Schema.define(:version => 0) do
   end
 
   add_foreign_key(:locations, :locations, column: :parent_id)
-end
+end