locabulary 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6860e6b46a871aa5f6fa44d61e4a71549fe997d
-  data.tar.gz: 8e45a3991ac5fac5b35944094db338ac8d484c0a
+  metadata.gz: 278eebac39c183be338728d67f3be9fab289bc96
+  data.tar.gz: 6ed77a8d3f22e607c0a083cbe1f14c22e83ef835
 SHA512:
-  metadata.gz: d0934da270aa054be0eae9d1dea2db1739d1fdabc79142f6845efe944b0b332816330b0ab74712c4c165f1526747d1f82d563e4e43d0734d0191ca6d0fea4cd8
-  data.tar.gz: 4e137b994cc4d406e2a5787ac565e20eeca0b2aa7325707c2bf7d536a5e4543fe353fbdc05f19fcd04eb20dd2575b108dbc8e52bfcb7ce1838448ac7777fc65e
+  metadata.gz: be8235aa07b3e25f76d51ec1559d0d1050430ce54bf3156be255e8bbb7b88d426f60dc1ea1680a11c49000567663dc83615a343a5410fcfb82b2b87639601478
+  data.tar.gz: 58887e1e050416cec0011b9f4d1e8848e2a06107c2387401987cb2262cd97f48a32b6f0358a1ede2ec52f8987e947d3ca02603939e7fa3aba237e823043fe338

data/lib/locabulary/commands/active_hierarchical_roots_command.rb

@@ -2,6 +2,7 @@ require 'set'
 require 'date'
 require 'locabulary/item'
 require 'locabulary/exceptions'
+require 'locabulary/hierarchy_processor'
 
 module Locabulary
   module Commands
@@ -37,42 +38,34 @@ module Locabulary
       def initialize(options = {})
         @predicate_name = options.fetch(:predicate_name)
         @as_of = options.fetch(:as_of) { Date.today }
-        @builder = Item.builder_for(predicate_name: predicate_name)
+        @locabulary_item_class = Item.class_to_instantiate(predicate_name: predicate_name)
         @utility_service = options.fetch(:utility_service) { default_utility_service }
       end
 
       def call
-        items = []
-        hierarchy_graph_keys = {}
-        top_level_slugs = Set.new
-        utility_service.with_active_extraction_for(predicate_name, as_of) do |data|
-          item = builder.call(data.merge('predicate_name' => predicate_name))
-          items << item
-          top_level_slugs << item.root_slug
-          hierarchy_graph_keys[item.term_label] = item
-        end
-        associate_parents_and_childrens_for(hierarchy_graph_keys, items)
-        top_level_slugs.map { |slug| hierarchy_graph_keys.fetch(slug) }
+        HierarchyProcessor.call(
+          enumerator: data_enumerator,
+          item_builder: item_builder,
+          predicate_name: predicate_name
+        )
       end
 
       private
 
-      attr_reader :predicate_name, :as_of, :builder, :utility_service
+      def data_enumerator
+        ->(&block) { utility_service.with_active_extraction_for(predicate_name, as_of, &block) }
+      end
+
+      def item_builder
+        ->(data) { locabulary_item_class.new(data.merge('predicate_name' => predicate_name)) }
+      end
+
+      attr_reader :predicate_name, :as_of, :locabulary_item_class, :utility_service
 
       def default_utility_service
         require 'locabulary/utility'
         Utility
       end
-
-      def associate_parents_and_childrens_for(hierarchy_graph_keys, items)
-        items.each do |item|
-          begin
-            hierarchy_graph_keys.fetch(item.parent_term_label).add_child(item) unless item.parent_slugs.empty?
-          rescue KeyError => error
-            raise Exceptions::MissingHierarchicalParentError.new(predicate_name, error)
-          end
-        end
-      end
     end
   end
 end

data/lib/locabulary/commands/build_ordered_hierarchical_tree_command.rb

@@ -3,6 +3,7 @@ require 'locabulary'
 require 'locabulary/exceptions'
 require 'locabulary/item'
 require 'locabulary/facet_wrapper_for_item'
+require 'locabulary/hierarchy_processor'
 
 module Locabulary
   module Commands
@@ -31,33 +32,17 @@ module Locabulary
       end
 
       def call
-        items = []
-        hierarchy_graph_keys = {}
-        top_level_slugs = Set.new
-        faceted_items.each do |faceted_item|
-          item = build_item(faceted_item)
-          items << item
-          top_level_slugs << item.root_slug
-          hierarchy_graph_keys[item.term_label] = item
-        end
-        associate_parents_and_childrens_for(hierarchy_graph_keys, items)
-        top_level_slugs.map { |slug| hierarchy_graph_keys.fetch(slug) }.sort
+        HierarchyProcessor.call(
+          enumerator: faceted_items.method(:each),
+          item_builder: method(:build_item),
+          predicate_name: predicate_name
+        )
       end
 
       private
 
       attr_reader :locabulary_item_class, :predicate_name, :faceted_items, :faceted_item_hierarchy_delimiter
 
-      def associate_parents_and_childrens_for(hierarchy_graph_keys, items)
-        items.each do |item|
-          begin
-            hierarchy_graph_keys.fetch(item.parent_term_label).add_child(item) unless item.parent_slugs.empty?
-          rescue KeyError => error
-            raise Exceptions::MissingHierarchicalParentError.new(predicate_name, error)
-          end
-        end
-      end
-
       def build_item(faceted_node)
         term_label = convert_faceted_node_value_to_term_label(faceted_node.value)
         locabulary_item = find_locabulary_item(predicate_name: predicate_name, term_label: term_label)
@@ -79,10 +64,7 @@ module Locabulary
 
       # Responsible for converting the hierarchy delimiter of the facet item to the hierarchy delimiter of the Locabulary::Item.
       def convert_faceted_node_value_to_term_label(value)
-        value.gsub(
-          /(?<!#{faceted_item_hierarchy_delimiter})#{faceted_item_hierarchy_delimiter}(?!#{faceted_item_hierarchy_delimiter})/,
-          locabulary_item_class.hierarchy_delimiter
-        )
+        value.split(faceted_item_hierarchy_delimiter).join(locabulary_item_class.hierarchy_delimiter)
       end
     end
   end

data/lib/locabulary/facet_wrapper_for_item.rb

@@ -55,5 +55,6 @@ module Locabulary
 
     extend Forwardable
     def_delegators :__faceted_node__, :value, :hits
+    alias count hits
   end
 end

data/lib/locabulary/hierarchy_processor.rb

@@ -0,0 +1,53 @@
+# :nodoc:
+module Locabulary
+  # @api private
+  #
+  # Responsible for processing an flat enumeration of data and creating
+  # a sorted hierarchy.
+  #
+  # @note This is an extraction of common logic found in two separate classes.
+  class HierarchyProcessor
+    def self.call(options = {})
+      new(options).call
+    end
+
+    # @param options [Hash]
+    # @option options [#call] :item_builder - when called will create a Locabulary::Items::Base object
+    # @option options [#call] :predicate_name -
+    # @option options [#call] :enumerator - when called will yield an enumerated_object to the item_builder
+    def initialize(options = {})
+      @item_builder = options.fetch(:item_builder)
+      @predicate_name = options.fetch(:predicate_name)
+      @enumerator = options.fetch(:enumerator)
+    end
+
+    def call
+      items = []
+      hierarchy_graph_keys = {}
+      top_level_slugs = Set.new
+      enumerator.call do |enumerated_object|
+        item = item_builder.call(enumerated_object)
+        items << item
+        top_level_slugs << item.root_slug
+        hierarchy_graph_keys[item.term_label] = item
+      end
+      associate_parents_and_childrens_for(hierarchy_graph_keys, items)
+      top_level_slugs.map { |slug| hierarchy_graph_keys.fetch(slug) }.sort
+    end
+
+    private
+
+    attr_reader :item_builder, :predicate_name, :enumerator
+
+    def associate_parents_and_childrens_for(hierarchy_graph_keys, items)
+      items.each do |item|
+        begin
+          hierarchy_graph_keys.fetch(item.parent_term_label).add_child(item) unless item.parent_slugs.empty?
+        rescue KeyError => error
+          raise Exceptions::MissingHierarchicalParentError.new(predicate_name, error)
+        end
+      end
+    end
+  end
+  private_constant :HierarchyProcessor
+end

data/lib/locabulary/items/base.rb

@@ -135,11 +135,17 @@ module Locabulary
         children.count.zero?
       end
 
+      # When rendered as part of a select list
       def selectable_label
         slugs[-1]
       end
 
       alias selectable_id id
+
+      # When rendered as part of a facet list
+      def hierarchy_facet_label
+        slugs[-1]
+      end
     end
   end
 end

data/lib/locabulary/version.rb

@@ -1,3 +1,3 @@
 module Locabulary
-  VERSION = '0.5.1'.freeze
+  VERSION = '0.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: locabulary
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-05 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -263,6 +263,7 @@ files:
 - lib/locabulary/commands/build_ordered_hierarchical_tree_command.rb
 - lib/locabulary/exceptions.rb
 - lib/locabulary/facet_wrapper_for_item.rb
+- lib/locabulary/hierarchy_processor.rb
 - lib/locabulary/item.rb
 - lib/locabulary/items.rb
 - lib/locabulary/items/administrative_unit.rb