has_hierarchy 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abe351194af5c2a75cbaad480fce586064fddad1
-  data.tar.gz: 283c8fd7fd5b8d27fdbe3b15bc4af195a90b15b5
+  metadata.gz: 5ff1f9affc659f62ba4a9b6eb0f25309b980939f
+  data.tar.gz: 4de2b383019e35c329b4bb11a3e7c39f1a5b2207
 SHA512:
-  metadata.gz: 8b529a4e0c3a0937d215feb5c77647c7ef9e7877ecdca68365bc888789d6abc050675e29ac0526dc27b14f7ece94b610849fdb2a6b982093f6e4ba779a414376
-  data.tar.gz: 12978bfbbbf31fd2d8ffcaed16c67fe1c029076af8365708ff54cb56de6accfe11879cb80b82fc5fb71880bf20d07ce777fc97550ffcd5cda54a3af3979e8497
+  metadata.gz: 8748539cfaf294108ff6d4e3bbf443dd42320171f5e89a0982b00b4aa32f4e6f255b6f3fa0a3726b970b5e7cf6b1b02a48e8bd0e203d892127547afb82c99567
+  data.tar.gz: edc08f4f3e803bf13f4d9b8dfd84cd4b690489ddab3daf3f3a39aea833fe44d93a506b50d0319a970f9dacc91b45722b3768b321023ba7ab7dda4246dc169a87

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.3.1
+
+- Added path normalization to `.find_by_path`
+- Added `.find_by_path!`
+- Added `#full_path`
+- Fixed boolean options.
+- Added options validation.
+
 ## 0.3.0
 
 - Added "path_separator" option.

data/README.md

@@ -32,7 +32,8 @@ $ rails g model Item \
 ```ruby
 class Item < ActiveRecord::Base
   has_hierarchy path_part: :name,
-                counter_cache: :children_count,
+                depth_cache: true,
+                counter_cache: true,
                 dependent: :destroy
 end
 
@@ -71,7 +72,7 @@ Item.ordered.tree
 #   }
 # }
 
-Item.find_by_node_path('bar/qux/quux')
+Item.find_by_path('bar/qux/quux')
 # => quux
 ```
 

data/lib/has_hierarchy.rb

@@ -5,14 +5,25 @@ require 'has_hierarchy/path'
 require 'has_hierarchy/depth_cache'
 
 module HasHierarchy
-  def has_hierarchy(options = {})
-    cattr_accessor(:has_hierarchy_options) { options }
+  DEFAULT_OPTIONS = {
+    scope: nil,
+    order: :position,
+    path_cache: :path,
+    path_part: :id,
+    path_separator: '/',
+    depth_cache: :depth,
+    counter_cache: :children_count,
+    dependent: nil
+  }
 
+  def has_hierarchy(options = {})
     extend ClassMethods
     include InstanceMethods
 
-    include Order      unless options[:order] == false
-    include Path       unless options[:path_cache] == false
+    setup_has_hierarchy_options(options)
+
+    include Order      if options[:order]
+    include Path       if options[:path_cache]
     include DepthCache if options[:depth_cache]
 
     belongs_to :parent, class_name: self.name,
@@ -47,6 +58,23 @@ module HasHierarchy
 
     protected
 
+    def setup_has_hierarchy_options(options)
+      options.assert_valid_keys(DEFAULT_OPTIONS.keys)
+
+      # Set to false if nil.
+      options.reverse_merge!(depth_cache: false, counter_cache: false)
+
+      DEFAULT_OPTIONS.each do |key, value|
+        options[key] = value if options[key].nil? or options[key] == true
+      end
+
+      cattr_accessor(:path_column) { options[:path_cache] }
+      cattr_accessor(:path_part_column) { options[:path_part] }
+      cattr_accessor(:path_separator) { options[:path_separator] }
+      cattr_accessor(:depth_column) { options[:depth_cache] }
+      cattr_accessor(:has_hierarchy_options) { options }
+    end
+
     def define_tree_scope(tree_scope)
       scope :tree_scope, case tree_scope
       when Proc

data/lib/has_hierarchy/depth_cache.rb

@@ -4,12 +4,6 @@ module HasHierarchy
 
     included do
       before_save :cache_depth
-
-      cattr_accessor :depth_column do
-        column = has_hierarchy_options[:depth_cache]
-        column = :depth if column == true
-        column
-      end
     end
 
     protected

data/lib/has_hierarchy/path.rb

@@ -5,31 +5,21 @@ module HasHierarchy
     included do
       before_create :populate_path
       before_update :rebuild_subtree, if: :need_to_rebuild_subtree?
-
-      cattr_accessor :path_column do
-        column = has_hierarchy_options[:path_cache]
-        column = :path if column.nil? or column == true
-        column
-      end
-
-      cattr_accessor :path_separator do
-        has_hierarchy_options[:path_separator] || '/'
-      end
-
-      cattr_accessor :path_part_column do
-        has_hierarchy_options[:path_part] || :id
-      end
     end
 
     module ClassMethods
       def find_by_path(path)
         sep = path_separator
-        parts = path.split(sep)
+        parts = path.gsub(/\#{sep}*$/, '').split(sep)
         part = parts.pop
         path = parts.length > 0 ? parts.join(sep) + sep : ''
 
         where(path_part_column => part, path_column => path).first
       end
+
+      def find_by_path!(path)
+        find_by_path(path) or raise ActiveRecord::RecordNotFound
+      end
     end
 
     def root
@@ -72,6 +62,10 @@ module HasHierarchy
       self[path_column] = path
     end
 
+    def full_path
+      path + path_part
+    end
+
     protected
 
     def path_part

data/lib/has_hierarchy/version.rb

@@ -1,3 +1,3 @@
 module HasHierarchy
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/spec/has_hierarchy_spec.rb

@@ -110,11 +110,26 @@ shared_examples 'materialized path' do
   describe '.find_by_path' do
     it 'returns node' do
       expect(described_class.find_by_path('bar')).to eq(bar)
-      expect(described_class.find_by_path('bar/qux')).to eq(qux)
+      expect(described_class.find_by_path('bar/qux/')).to eq(qux)
       expect(described_class.find_by_path('bar/qux/quux')).to eq(quux)
     end
   end
 
+  describe '.find_by_path!' do
+    it 'returns node or raises RecordNotFound' do
+      expect(described_class.find_by_path!('bar/qux/')).to eq(qux)
+      expect{ described_class.find_by_path!('wrong') }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+
+  describe '#full_path' do
+    it 'returns full node path' do
+      expect(bar.full_path).to eq('bar')
+      expect(qux.full_path).to eq('bar/qux')
+      expect(quux.full_path).to eq('bar/qux/quux')
+    end
+  end
+
   describe '#root' do
     it 'returns first node ancestor' do
       expect(baz.root).to eq(bar)

data/spec/support/models.rb

@@ -6,7 +6,8 @@ end
 
 class AdjacencyListTreeItem < Item
   has_hierarchy counter_cache: :children_count,
-                path_cache: false
+                path_cache: false,
+                order: true
 end
 
 class MaterializedPathTreeItem < Item
@@ -24,6 +25,6 @@ end
 
 class ScopedWithLambdaTreeItem < Item
   has_hierarchy scope: ->(item){ where(category: item.category) },
-                # Ordering scope (parent_id) cannot be combined with lambda.
+                # parent_id scope cannot be combined with lambda.
                 order: false
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: has_hierarchy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Kolesnikov Danil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2014-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler