path_tree 1.0.12 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96e7dd6bb5121febc2b06677e4bf4e4ae089fc7c
-  data.tar.gz: da856ee73c84f9e429e816719c07631ac49755c4
+  metadata.gz: d8fbfdfca21ebd5334ea1829ed80ed67675dca0a
+  data.tar.gz: 8f0d28fd3a6517030a207a65de808ce5f35c676c
 SHA512:
-  metadata.gz: 21b99a6057ca538a29978716acc9f8fddfcea9f17bad139d45941a6f0335b94f11d799c68640c130c587986deedbff6e9cbaa35f1e699dd7a07d6a6c63edcde6
-  data.tar.gz: 2d56fcd98cd005d446eab85e70524864f88c4df81499f016542193d3c99197940e3f475d54391ea67deead52129be9952632d82489ad9c08904f38b171e39d9f
+  metadata.gz: 3a63b1fb4e7d51d403fdc185e09454caa0c0d4e595a42bee6b5a9ec13a1a564494ca5cad8203470b1ea0138d712c90f2e46fe2108e2d96d591296ef0ebc43186
+  data.tar.gz: 1b64fd875d59d5a283b5066c0787f953bfd539da2205cad4f3f7099a66ed3c80c17d4b34f259a065dc40cae302bac9b3fc6dad1dd71947977dc4d4082edc6fff

data/.gitignore

@@ -1,7 +1,6 @@
-Gemfile.lock
-*.swm
-*.swn
-*.swo
-*.swp
+*.sw[mnop]
 *.gem
-pkg
+/Gemfile.lock
+/gemfiles/*.lock
+/pkg
+/.bundle

data/Appraisals

@@ -0,0 +1,18 @@
+# Install gems for all appraisal definitions:
+#
+#     $ appraisal install
+#
+# To run tests on different versions:
+#
+#     $ appraisal activerecord_x.x rspec spec
+
+[
+  [ '3.2', '~> 3.2.0' ],
+  [ '4.0', '~> 4.0.0' ],
+  [ '4.1', '~> 4.1.0' ],
+  [ '4.2', '~> 4.2.0' ],
+].each do |ver_name, ver_req|
+  appraise "rails_#{ver_name}" do
+    gem 'activerecord', ver_req
+  end
+end

data/Rakefile

@@ -1 +1,21 @@
 require 'bundler/gem_tasks'
+require 'bundler/setup'  # constrain rake version
+
+# Note: if you get this error: "Bundler could not find compatible versions for gem ..."
+# try deleting Gemfile.lock (usually happens when switching branches).
+
+task default: :appraise_all
+
+# This is slightly different from 'appraisal COMMAND' because it continues even if a definition fails.
+desc "Run rspecs for all appraisals"
+task :appraise_all do
+  success_map = {}
+  `bundle exec appraisal list`.lines.map(&:chomp).each do |appraise_def|
+     success = system('appraisal', appraise_def, 'rspec', 'spec')
+     success_map[appraise_def] = success
+  end
+  puts "\n===== Test Summary ====="
+  success_map.each do |appraise_def, success|
+    puts "#{appraise_def}: #{success ? 'no failures (but check pending)' : 'failed'}"
+  end
+end

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0"
+
+gemspec :path => "../"

data/lib/path_tree.rb

@@ -1,3 +1,5 @@
+require File.expand_path("../path_tree/patterns.rb", __FILE__)
+
 # This module implements a tree structure by using a convention of converting a name into a path.
 # Paths created by normalizing a name attribute and then separating levels with periods with
 # the lowest level coming last.
@@ -6,11 +8,6 @@
 # have support for after_destroy and after_save callbacks, validates_* macros and include attributes
 # for name, node_path, path, and parent_path.
 module PathTree  
-  if RUBY_VERSION.match(/^1\.8/)
-    require File.expand_path("../ruby_18_patterns.rb", __FILE__)
-  else
-    require File.expand_path("../ruby_19_patterns.rb", __FILE__)
-  end
   include Patterns
 
   def self.included (base)
@@ -45,7 +42,7 @@ module PathTree
     
     # Get all the root nodes (i.e. those without any parents)
     def roots
-      all(:conditions => {:parent_path => nil})
+      where(parent_path: nil).to_a
     end
     
     # Set the path delimiter (default is '.').
@@ -61,7 +58,7 @@ module PathTree
     # tree, this is the fastest way to load it. Returns the root node of the branch.
     def branch (path)
       raise ArgumentError.new("branch path must not be blank") if path.blank?
-      root = first(:conditions => {:path => path})
+      root = where(path: path).first
       return [] unless root
       nodes = path_like(path).sort{|a,b| b.path <=> a.path}
       nodes << root
@@ -76,7 +73,8 @@ module PathTree
       end
     end
     
-    # Replace accented characters with the closest ascii equivalent
+    # Replace accented characters with the closest ascii equivalent.
+    # NOTE: characters than can't be decomposed to a latin equivalent may not be replaced.
     def asciify (value)
       if value
         value.gsub(UPPER_A_PATTERN, 'A').gsub(LOWER_A_PATTERN, 'a').
@@ -99,7 +97,7 @@ module PathTree
     
     # Abstract way of finding paths that start with a value so it can be overridden by non-SQL implementations.
     def path_like (value)
-      all(:conditions => ["path LIKE ?", "#{value}#{path_delimiter}%"])
+      where("path LIKE ?", "#{value}#{path_delimiter}%").to_a
     end
     
     # Expand a path into an array of the path and all its ancestor paths.
@@ -156,7 +154,7 @@ module PathTree
   def parent
     unless instance_variable_defined?(:@parent)
       if path.index(path_delimiter)
-        @parent = self.class.base_class.first(:conditions => {:path => parent_path})
+        @parent = self.class.base_class.where(path: parent_path).first
       else
         @parent = nil
       end
@@ -199,7 +197,7 @@ module PathTree
   def children
     unless @children
       childrens_path = new_record? ? path : path_was
-      @children = self.class.base_class.all(:conditions => {:parent_path => childrens_path})
+      @children = self.class.base_class.where(parent_path: childrens_path).to_a
       @children.each{|c| c.parent = self}
     end
     @children
@@ -207,7 +205,8 @@ module PathTree
 
   # Get all nodes that share the same parent as this node.
   def siblings
-    self.class.base_class.all(:conditions => {:parent_path => parent_path}).reject{|node| node == self}
+    # OPTIMIZE if this record has an ID, it may be more efficient to exclude it via query rather than using reject
+    self.class.base_class.where(parent_path: parent_path).to_a.reject{|node| node == self }
   end
 
   # Get all descendant of this node.
@@ -222,7 +221,7 @@ module PathTree
     if ancestor_paths.empty?
       []
     else
-      self.class.base_class.all(:conditions => {:path => ancestor_paths}).sort{|a,b| a.path.length <=> b.path.length}
+      self.class.base_class.where(path: ancestor_paths).to_a.sort{|a,b| a.path.length <=> b.path.length}
     end
   end
 

data/lib/path_tree/version.rb

@@ -1,3 +1,3 @@
 module PathTree
-  VERSION = '1.0.12'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/path_tree.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'path_tree/version'
 Gem::Specification.new do |spec|
   spec.name          = 'path_tree'
-  spec.version       = PathTree::VERSION
+  spec.version       = PathTree::VERSION.dup  # dup for ruby 1.9
   spec.authors       = ['Brian Durand', 'Milan Dobrota']
   spec.email         = ['mdobrota@tribpub.com']
   spec.summary       = 'Helper module for constructing tree data structures'
@@ -16,11 +16,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activerecord', '~> 3.2.0'
+  spec.add_runtime_dependency 'activerecord', '>= 3.2.0', '< 4.3'
 
-  spec.add_development_dependency 'rspec', '~> 2.8.0'
+  spec.add_development_dependency 'rspec', '~> 2.99'
   spec.add_development_dependency 'sqlite3', '>= 0'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'  , '~> 1.7'
+  spec.add_development_dependency 'rake'     , '~> 10.0'
+  spec.add_development_dependency 'appraisal', '~> 2.0'
 end

data/spec/path_tree_spec.rb

@@ -1,30 +1,9 @@
 # encoding: UTF-8
 
 require 'spec_helper'
+require 'shared/path_tree_model_examples'
 
 describe PathTree do
-  
-  module PathTree
-    class Test < ActiveRecord::Base
-      self.table_name = :test_path_trees
-      
-      def self.create_tables
-        connection.create_table(table_name) do |t|
-          t.string :name
-          t.string :node_path
-          t.string :path
-          t.string :parent_path
-        end unless table_exists?
-      end
-
-      def self.drop_tables
-        connection.drop_table(table_name)
-      end
-      
-      include PathTree
-    end
-  end
-
   before :all do
     PathTree::Test.create_tables
   end
@@ -32,245 +11,83 @@ describe PathTree do
   after :all do
     PathTree::Test.drop_tables
   end
-  
-  context "path construction" do
-    it "should turn accented characters into ascii equivalents" do
-      PathTree::Test.asciify("ÀÂÄÃÅàâáããä-ÈÊÉËèêéë-ÌÎÍÏìîíï-ÒÔÖØÓÕòôöøóõ-ÚÜÙÛúüùû-ÝýÿÑñÇçÆæßÐ").should == "AAAAAaaaaaa-EEEEeeee-IIIIiiii-OOOOOOoooooo-UUUUuuuu-YyyNnCcAEaessD"
-    end
-
-    it "should unquote strings" do
-      PathTree::Test.unquote(%Q("This is a 'test'")).should == "This is a test"
-    end
-
-    it "should translate a value to a path part" do
-      PathTree::Test.pathify("This is the 1st / test À...").should == "this-is-the-1st-test-a"
-    end
-
-    it "should expand a path to its component paths" do
-      PathTree::Test.expanded_paths("this.is.a.test").should == ["this", "this.is", "this.is.a", "this.is.a.test"]
-    end
-    
-    it "should set the parent path when setting the parent" do
-      parent = PathTree::Test.new(:name => "parent")
-      node = PathTree::Test.new(:name => "child")
-      node.parent = parent
-      node.parent_path.should == "parent"
-      node.parent = nil
-      node.parent_path.should == nil
-    end
-  end
-  
-  context "with default delimiter" do
-    before :all do
-      @root_1 = PathTree::Test.create!(:name => "Root 1")
-      @parent_a = PathTree::Test.create!(:name => "Parent A", :parent_path => "root-1")
-      @parent_b = PathTree::Test.create!(:name => "Parent B", :parent_path => "root-1")
-      @parent_c = PathTree::Test.create!(:name => "Parent C", :parent_path => "root-1")
-      @child_a1 = PathTree::Test.create!(:name => "Child A1", :parent_path => "root-1.parent-a")
-      @child_a2 = PathTree::Test.create!(:name => "Child A2", :parent_path => "root-1.parent-a")
-      @grandchild = PathTree::Test.create!(:name => "Grandchild A1.1", :parent_path => "root-1.parent-a.child-a1")
-      @root_2 = PathTree::Test.create!(:name => "Root 2")
-      @parent_z = PathTree::Test.create!(:name => "Parent Z", :parent_path => "root-2")
-    end
-
-    after :all do
-      PathTree::Test.delete_all
-    end
-
-    it "should get the root nodes" do
-      PathTree::Test.roots.sort{|a,b| a.path <=> b.path}.should == [@root_1, @root_2]
-    end
-
-    it "should load an entire branch structure" do
-      branch = PathTree::Test.branch("root-1.parent-a")
-      branch.should == @parent_a
-      branch.instance_variable_get(:@children).should == [@child_a1, @child_a2]
-      branch.children.first.instance_variable_get(:@children).should == [@grandchild]
-    end
-
-    it "should construct a fully qualified name with a delimiter" do
-      @grandchild.full_name.should == "Root 1 > Parent A > Child A1 > Grandchild A1.1"
-      @grandchild.full_name(:separator => "/").should == "Root 1/Parent A/Child A1/Grandchild A1.1"
-      @grandchild.full_name(:context => "root-1.parent-a").should == "Child A1 > Grandchild A1.1"
-    end
-
-    it "should be able to get and set a parent node" do
-      node = PathTree::Test.find_by_path("root-1.parent-a")
-      node.parent.should == @root_1
-      node.parent = @root_2
-      node.parent_path.should == "root-2"
-      node.path.should == "root-2.parent-a"
-    end
-
-    it "should be able to set the parent by path" do
-      node = PathTree::Test.find_by_path("root-1.parent-a")
-      node.parent_path = "root-2"
-      node.parent.should == @root_2
-      node.path.should == "root-2.parent-a"
-    end
-
-    it "should have child nodes" do
-      node = PathTree::Test.find_by_path("root-1.parent-a")
-      node.children.should == [@child_a1, @child_a2]
-    end
 
-    it "should have descendant nodes" do
-      node = PathTree::Test.find_by_path("root-1.parent-a")
-      node.descendants.should == [@child_a1, @child_a2, @grandchild]
-    end
+  context "validations" do
+    let(:new_rec) { PathTree::Test.new }
 
-    it "should have sibling nodes" do
-      node = PathTree::Test.find_by_path("root-1.parent-a")
-      node.siblings.should == [@parent_b, @parent_c]
+    it "is invalid without a name" do
+      expect(new_rec).not_to be_valid
+      expect(new_rec.errors[:name]).to include "can't be blank"
     end
 
-    it "should have ancestor nodes" do
-      node = PathTree::Test.find_by_path("root-1.parent-a.child-a1")
-      node.ancestors.should == [@root_1, @parent_a]
+    it "is invalid without a node_path" do
+      new_rec.name = "I'm a leaf"
+      new_rec.node_path = ''
+      expect(new_rec).not_to be_valid
+      expect(new_rec.errors[:node_path]).to include "can't be blank"
     end
 
-    it "should maintain the path with the name path" do
-      node = PathTree::Test.find_by_path("root-1.parent-a")
-      node.node_path = "New Name"
-      node.path.should == "root-1.new-name"
+    it "is invalid without a path" do
+      new_rec.name = "I'm a leaf"
+      new_rec.path = ''
+      expect(new_rec).not_to be_valid
+      expect(new_rec.errors[:path]).to include "can't be blank"
     end
 
-    it "should get the expanded paths for a node" do
-      @grandchild.expanded_paths.should == ["root-1", "root-1.parent-a", "root-1.parent-a.child-a1", "root-1.parent-a.child-a1.grandchild-a1-1"]
-    end
+    context "uniqueness" do
+      around :each do |ex|
+        PathTree::Test.transaction do
+          @root = PathTree::Test.create!(name: 'top-dog')
+          @child_1 = PathTree::Test.create!(name: 'underdog', parent: @root)
+          ex.run
+          raise ActiveRecord::Rollback
+        end
+      end
 
-    it "should update child paths when the path is changed" do
-      PathTree::Test.transaction do
-        node = PathTree::Test.find_by_path("root-1.parent-a")
-        node.node_path = "New Name"
-        node.save!
-        node.reload
-        node.children.collect{|c| c.path}.should == ["root-1.new-name.child-a1", "root-1.new-name.child-a2"]
-        node.children.first.children.collect{|c| c.path}.should == ["root-1.new-name.child-a1.grandchild-a1-1"]
-        raise ActiveRecord::Rollback
+      it "enforces unique path" do
+        new_rec = PathTree::Test.new(name: @child_1.node_path, parent: @root)
+        expect(new_rec).not_to be_valid
+        expect(new_rec.errors[:path]).to include 'has already been taken'
+        expect(new_rec.errors[:node_path]).to include 'has already been taken'
       end
-    end
 
-    it "should update child paths when a node is destroyed" do
-      PathTree::Test.transaction do
-        node = PathTree::Test.find_by_path("root-1.parent-a")
-        node.name = "New Name"
-        node.destroy
-        root = PathTree::Test.find_by_path("root-1")
-        root.children.collect{|c| c.path}.should == ["root-1.parent-b", "root-1.parent-c", "root-1.child-a1", "root-1.child-a2"]
-        root.children[2].children.collect{|c| c.path}.should == ["root-1.child-a1.grandchild-a1-1"]
-        raise ActiveRecord::Rollback
+      it "allows duplicate node_path under different parents" do
+        new_rec = PathTree::Test.new(name: @child_1.node_path)
+        expect(new_rec).to be_valid
       end
     end
   end
-
   
-  context "with default delimiter" do
-    before :all do
-      PathTree::Test.path_delimiter = '/'
-      @root_1 = PathTree::Test.create!(:name => "Root 1")
-      @parent_a = PathTree::Test.create!(:name => "Parent A", :parent_path => "root-1")
-      @parent_b = PathTree::Test.create!(:name => "Parent B", :parent_path => "root-1")
-      @parent_c = PathTree::Test.create!(:name => "Parent C", :parent_path => "root-1")
-      @child_a1 = PathTree::Test.create!(:name => "Child A1", :parent_path => "root-1/parent-a")
-      @child_a2 = PathTree::Test.create!(:name => "Child A2", :parent_path => "root-1/parent-a")
-      @grandchild = PathTree::Test.create!(:name => "Grandchild A1.1", :parent_path => "root-1/parent-a/child-a1")
-      @root_2 = PathTree::Test.create!(:name => "Root 2")
-      @parent_z = PathTree::Test.create!(:name => "Parent Z", :parent_path => "root-2")
-    end
-
-    after :all do
-      PathTree::Test.path_delimiter = nil
-    end
-
-    it "should get the root nodes" do
-      PathTree::Test.roots.sort{|a,b| a.path <=> b.path}.should == [@root_1, @root_2]
-    end
-
-    it "should load an entire branch structure" do
-      branch = PathTree::Test.branch("root-1/parent-a")
-      branch.should == @parent_a
-      branch.instance_variable_get(:@children).should == [@child_a1, @child_a2]
-      branch.children.first.instance_variable_get(:@children).should == [@grandchild]
-    end
-
-    it "should construct a fully qualified name with a delimiter" do
-      @grandchild.full_name.should == "Root 1 > Parent A > Child A1 > Grandchild A1.1"
-      @grandchild.full_name(:separator => ":").should == "Root 1:Parent A:Child A1:Grandchild A1.1"
-      @grandchild.full_name(:context => "root-1/parent-a").should == "Child A1 > Grandchild A1.1"
-    end
-
-    it "should be able to get and set a parent node" do
-      node = PathTree::Test.find_by_path("root-1/parent-a")
-      node.parent.should == @root_1
-      node.parent = @root_2
-      node.parent_path.should == "root-2"
-      node.path.should == "root-2/parent-a"
-    end
-
-    it "should be able to set the parent by path" do
-      node = PathTree::Test.find_by_path("root-1/parent-a")
-      node.parent_path = "root-2"
-      node.parent.should == @root_2
-      node.path.should == "root-2/parent-a"
-    end
-
-    it "should have child nodes" do
-      node = PathTree::Test.find_by_path("root-1/parent-a")
-      node.children.should == [@child_a1, @child_a2]
-    end
-
-    it "should have descendant nodes" do
-      node = PathTree::Test.find_by_path("root-1/parent-a")
-      node.descendants.should == [@child_a1, @child_a2, @grandchild]
-    end
-
-    it "should have sibling nodes" do
-      node = PathTree::Test.find_by_path("root-1/parent-a")
-      node.siblings.should == [@parent_b, @parent_c]
+  context "path construction" do
+    it "turns accented characters into ascii equivalents" do
+      accent_string = "ÀÂÄÃÅàâáããä-ÈÊÉËèêéë-ÌÎÍÏìîíï-ÒÔÖØÓÕòôöøóõ-ÚÜÙÛúüùû-ÝýÿÑñÇçÆæßÐ"
+      expected_string = "AAAAAaaaaaa-EEEEeeee-IIIIiiii-OOOOOOoooooo-UUUUuuuu-YyyNnCcAEaessD"
+      expect(PathTree::Test.asciify(accent_string)).to eq expected_string
     end
 
-    it "should have ancestor nodes" do
-      node = PathTree::Test.find_by_path("root-1/parent-a/child-a1")
-      node.ancestors.should == [@root_1, @parent_a]
+    it "unquotes strings" do
+      expect(PathTree::Test.unquote(%Q("This is a 'test'"))).to eq "This is a test"
     end
 
-    it "should maintain the path with the name path" do
-      node = PathTree::Test.find_by_path("root-1/parent-a")
-      node.node_path = "New Name"
-      node.path.should == "root-1/new-name"
+    it "translates a value to a path part" do
+      expect(PathTree::Test.pathify("This is the 1st / test À...")).to eq "this-is-the-1st-test-a"
     end
 
-    it "should get the expanded paths for a node" do
-      @grandchild.expanded_paths.should == ["root-1", "root-1/parent-a", "root-1/parent-a/child-a1", "root-1/parent-a/child-a1/grandchild-a1-1"]
+    it "sets the parent path when setting the parent" do
+      parent = PathTree::Test.new(:name => "parent")
+      node = PathTree::Test.new(:name => "child")
+      node.parent = parent
+      expect(node.parent_path).to eq "parent"
+      node.parent = nil
+      expect(node.parent_path).to be nil
     end
+  end
 
-    it "should update child paths when the path is changed" do
-      PathTree::Test.transaction do
-        node = PathTree::Test.find_by_path("root-1/parent-a")
-        node.node_path = "New Name"
-        node.save!
-        node.reload
-        node.children.collect{|c| c.path}.should == ["root-1/new-name/child-a1", "root-1/new-name/child-a2"]
-        node.children.first.children.collect{|c| c.path}.should == ["root-1/new-name/child-a1/grandchild-a1-1"]
-        raise ActiveRecord::Rollback
-      end
-    end
+  context "with default delimiter" do
+    include_examples "a PathTree model", nil, '/'
+  end
 
-    it "should update child paths when a node is destroyed" do
-      begin
-      PathTree::Test.transaction do
-        node = PathTree::Test.find_by_path("root-1/parent-a")
-        node.name = "New Name"
-        node.destroy
-        root = PathTree::Test.find_by_path("root-1")
-        root.children.collect{|c| c.path}.should == ["root-1/parent-b", "root-1/parent-c", "root-1/child-a1", "root-1/child-a2"]
-        root.children[2].children.collect{|c| c.path}.should == ["root-1/child-a1/grandchild-a1-1"]
-        raise ActiveRecord::Rollback
-      end
-    rescue
-      puts $@.join("\n")
-    end
-    end
+  context "with custom delimiter" do
+    include_examples "a PathTree model", '/', ':'
   end
 end

data/spec/shared/path_tree_model_examples.rb

@@ -0,0 +1,170 @@
+# path_delimiter is used for configuring the model; use nil for default
+# fq_separator: separator for fully qualified name
+shared_examples "a PathTree model" do |path_delimiter, fq_separator|
+  # actual_delim: the generated paths will be delimited by this
+  attr_reader :path_delim, :fq_sep, :actual_delim
+
+  before :all do
+    @path_delim = path_delimiter
+    @fq_sep = fq_separator or raise 'fq_separator must be set'
+
+    @actual_delim = path_delim || '.'.freeze
+    if $DEBUG
+      puts "OPTIONS: path_delim=#{path_delim.inspect}, fq_sep=#{fq_sep.inspect}"
+    end
+  end
+
+  def delim_join(*strings)
+    strings.join(actual_delim)
+  end
+  def fq_join(*strings)
+    strings.join(fq_sep)
+  end
+
+  before :all do
+    PathTree::Test.path_delimiter = path_delim if path_delim
+    @root_1 = PathTree::Test.create!(:name => "Root 1")
+    @parent_a = PathTree::Test.create!(:name => "Parent A", :parent_path => "root-1")
+    @parent_b = PathTree::Test.create!(:name => "Parent B", :parent_path => "root-1")
+    @parent_c = PathTree::Test.create!(:name => "Parent C", :parent_path => "root-1")
+    @child_a1 = PathTree::Test.create!(:name => "Child A1", :parent_path => delim_join("root-1", "parent-a"))
+    @child_a2 = PathTree::Test.create!(:name => "Child A2", :parent_path => delim_join("root-1", "parent-a"))
+    @grandchild = PathTree::Test.create!(:name => "Grandchild A1.1", :parent_path => delim_join("root-1", "parent-a", "child-a1"))
+    @root_2 = PathTree::Test.create!(:name => "Root 2")
+    @parent_z = PathTree::Test.create!(:name => "Parent Z", :parent_path => "root-2")
+  end
+
+  after :all do
+    PathTree::Test.delete_all
+    PathTree::Test.path_delimiter = nil  # reset to default
+  end
+
+  let(:unsaved_rec) { PathTree::Test.new(name: 'level-2', parent: @root_1) }
+
+  it "gets the root nodes" do
+    expect(PathTree::Test.roots).to match_array [@root_1, @root_2]
+  end
+
+  it "loads an entire branch structure" do
+    branch = PathTree::Test.branch(delim_join("root-1", "parent-a"))
+    expect(branch).to eq @parent_a
+    expect(branch.instance_variable_get(:@children)).to eq [@child_a1, @child_a2]
+    expect(branch.children.first.instance_variable_get(:@children)).to eq [@grandchild]
+  end
+
+  it "constructs a fully qualified name with a delimiter" do
+    expect(@grandchild.full_name).to eq "Root 1 > Parent A > Child A1 > Grandchild A1.1"
+    expect(@grandchild.full_name(:separator => fq_sep)).to eq(
+      fq_join("Root 1", "Parent A", "Child A1", "Grandchild A1.1") )
+    expect(@grandchild.full_name(:context => delim_join("root-1", "parent-a"))).to eq "Child A1 > Grandchild A1.1"
+  end
+
+  it "is able to get and set a parent node" do
+    node = PathTree::Test.find_by_path(delim_join("root-1", "parent-a"))
+    expect(node.parent).to eq @root_1
+    node.parent = @root_2
+    expect(node.parent_path).to eq "root-2"
+    expect(node.path).to eq delim_join("root-2", "parent-a")
+  end
+
+  it "is able to set the parent by path" do
+    node = PathTree::Test.find_by_path(delim_join("root-1", "parent-a"))
+    node.parent_path = "root-2"
+    expect(node.parent).to eq @root_2
+    expect(node.path).to eq delim_join("root-2", "parent-a")
+  end
+
+  it "has child nodes" do
+    node = PathTree::Test.find_by_path(delim_join("root-1", "parent-a"))
+    expect(node.children).to eq [@child_a1, @child_a2]
+  end
+
+  it "has descendant nodes" do
+    node = PathTree::Test.find_by_path(delim_join("root-1", "parent-a"))
+    expect(node.descendants).to eq [@child_a1, @child_a2, @grandchild]
+  end
+
+  it "has sibling nodes" do
+    node = PathTree::Test.find_by_path(delim_join("root-1", "parent-a"))
+    expect(node.siblings).to eq [@parent_b, @parent_c]
+  end
+
+  it "has ancestor nodes" do
+    node = PathTree::Test.find_by_path(delim_join("root-1", "parent-a", "child-a1"))
+    expect(node.ancestors).to eq [@root_1, @parent_a]
+  end
+
+  context "when name is changed" do
+    it "fills in a blank node_path when name is changed" do
+      unsaved_rec.node_path = ''
+
+      unsaved_rec.name = 'Changed Parent'
+      expect(unsaved_rec.node_path).to eq 'changed-parent'
+      expect(unsaved_rec.path).to eq delim_join('root-1', 'changed-parent')
+    end
+
+    it "does not overwrite a present node_path when name is changed" do
+      orig_node_path = unsaved_rec.node_path
+      unsaved_rec.name = 'Changed Parent'
+      expect(unsaved_rec.node_path).to eq orig_node_path
+      expect(unsaved_rec.path).to eq delim_join('root-1', orig_node_path)
+    end
+  end
+
+  it "maintains the path with the node path" do
+    node = PathTree::Test.find_by_path(delim_join("root-1", "parent-a"))
+    node.node_path = "New Name"
+    expect(node.path).to eq delim_join("root-1", "new-name")
+  end
+
+  it "expands a path to its component paths" do
+    expect(PathTree::Test.expanded_paths(delim_join(*%w[this is a test]))).to eq [
+      "this",
+      delim_join(*%w[this is]),
+      delim_join(*%w[this is a]),
+      delim_join(*%w[this is a test]) ]
+  end
+
+  it "gets the expanded paths for a node" do
+    expect(@grandchild.expanded_paths).to eq [
+      "root-1",
+      delim_join("root-1", "parent-a"),
+      delim_join("root-1", "parent-a", "child-a1"),
+      delim_join("root-1", "parent-a", "child-a1", "grandchild-a1-1") ]
+  end
+
+  context "child paths" do
+    around :each do |ex|
+      PathTree::Test.transaction do
+        ex.run
+        raise ActiveRecord::Rollback
+      end
+    end
+
+    it "updates child paths when the path is changed" do
+      node = PathTree::Test.find_by_path(delim_join("root-1", "parent-a"))
+      node.node_path = "New Name"
+      node.save!
+      node.reload
+      expect(node.children.map(&:path)).to eq [
+        delim_join("root-1", "new-name", "child-a1"),
+        delim_join("root-1", "new-name", "child-a2") ]
+      expect(node.children.first.children.map(&:path)).to eq [
+        delim_join("root-1", "new-name", "child-a1", "grandchild-a1-1") ]
+    end
+
+    it "updates child paths when a node is destroyed" do
+      node = PathTree::Test.find_by_path(delim_join("root-1", "parent-a"))
+      node.name = "New Name"
+      node.destroy
+      root = PathTree::Test.find_by_path("root-1")
+      expect(root.children.map(&:path)).to eq [
+        delim_join("root-1", "parent-b"),
+        delim_join("root-1", "parent-c"),
+        delim_join("root-1", "child-a1"),
+        delim_join("root-1", "child-a2") ]
+      expect(root.children[2].children.map(&:path)).to eq [
+        delim_join("root-1", "child-a1", "grandchild-a1-1") ]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'active_record'
 require 'sqlite3'
 
@@ -14,3 +13,25 @@ end
 ActiveRecord::Base.establish_connection("adapter" => "sqlite3", "database" => ":memory:")
 
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'path_tree'))
+
+module PathTree
+  class Test < ActiveRecord::Base
+    self.table_name = :test_path_trees
+
+    def self.create_tables
+      connection.create_table(table_name) do |t|
+        t.string :name
+        t.string :node_path
+        t.string :path
+        t.string :parent_path
+      end unless table_exists?
+    end
+
+    def self.drop_tables
+      connection.drop_table(table_name)
+    end
+
+    # lib/path_tree must be loaded before this
+    include PathTree
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: path_tree
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Durand
@@ -9,36 +9,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.99'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +87,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Module that defines a tree data structure based on a path.
 email:
 - mdobrota@tribpub.com
@@ -89,16 +109,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Appraisals
 - Gemfile
 - License.txt
 - README.rdoc
 - Rakefile
+- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
 - lib/path_tree.rb
+- lib/path_tree/patterns.rb
 - lib/path_tree/version.rb
-- lib/ruby_18_patterns.rb
-- lib/ruby_19_patterns.rb
 - path_tree.gemspec
 - spec/path_tree_spec.rb
+- spec/shared/path_tree_model_examples.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -125,4 +150,5 @@ specification_version: 4
 summary: Helper module for constructing tree data structures
 test_files:
 - spec/path_tree_spec.rb
+- spec/shared/path_tree_model_examples.rb
 - spec/spec_helper.rb

data/lib/ruby_18_patterns.rb

@@ -1,24 +0,0 @@
-module PathTree
-  module Patterns
-    UPPER_A_PATTERN = /\xC3[\x80-\x85]/.freeze
-    LOWER_A_PATTERN = /\xC3[\xA0-\xA5]/.freeze
-    UPPER_E_PATTERN = /\xC3[\x88-\x8B]/.freeze
-    LOWER_E_PATTERN = /\xC3[\xA8-\xAB]/.freeze
-    UPPER_I_PATTERN = /\xC3[\x8C-\x8F]/.freeze
-    LOWER_I_PATTERN = /\xC3[\xAC-\xAF]/.freeze
-    UPPER_O_PATTERN = /\xC3[\x92-\x96\x98]/.freeze
-    LOWER_O_PATTERN = /\xC3[\xB2-\xB6\xB8]/.freeze
-    UPPER_U_PATTERN = /\xC3[\x99-\x9C]/.freeze
-    LOWER_U_PATTERN = /\xC3[\xB9-\xBC]/.freeze
-    UPPER_Y_PATTERN = /\xC3\x9D/.freeze
-    LOWER_Y_PATTERN = /\xC3[\xBD\xBF]/.freeze
-    UPPER_C_PATTERN = /\xC3\x87/.freeze
-    LOWER_C_PATTERN = /\xC3\xA7/.freeze
-    UPPER_N_PATTERN = /\xC3\x91/.freeze
-    LOWER_N_PATTERN = /\xC3\xB1/.freeze
-    UPPER_D_PATTERN = /\xC3\x90/.freeze
-    UPPER_AE_PATTERN = /\xC3\x86/.freeze
-    LOWER_AE_PATTERN = /\xC3\xA6/.freeze
-    SS_PATTERN = /\xC3\x9F/.freeze
-  end
-end