locabulary 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 278eebac39c183be338728d67f3be9fab289bc96
-  data.tar.gz: 6ed77a8d3f22e607c0a083cbe1f14c22e83ef835
+  metadata.gz: f1eb4d78aa929a7b2ef35ab9a952a1bdb8c0ca23
+  data.tar.gz: 871c5926d7e64db00a969b719822571cfaf01f20
 SHA512:
-  metadata.gz: be8235aa07b3e25f76d51ec1559d0d1050430ce54bf3156be255e8bbb7b88d426f60dc1ea1680a11c49000567663dc83615a343a5410fcfb82b2b87639601478
-  data.tar.gz: 58887e1e050416cec0011b9f4d1e8848e2a06107c2387401987cb2262cd97f48a32b6f0358a1ede2ec52f8987e947d3ca02603939e7fa3aba237e823043fe338
+  metadata.gz: 68d54f45f0210abacc45a9a2ddf7011099eeaea01a6622bf3c042370ad19c46d7dc07711b9f8ffed3b2d0573ccd3ba16f7c0499e78342fad71f0c616c0400617
+  data.tar.gz: 3b306460efc705ce496ff1b1297013a2b8056416591bcb958fc58786fd6b86e1fbe9805d93c248d95e4e0152a0cbebc07f13ca5641b5c7b85a58d60f7c562d56

data/lib/locabulary.rb

@@ -2,13 +2,11 @@ require 'date'
 require 'json'
 require 'locabulary/exceptions'
 require 'locabulary/item'
-require 'locabulary/commands/build_ordered_hierarchical_tree_command'
-require 'locabulary/commands/active_items_for_command'
-require 'locabulary/commands/active_hierarchical_roots_command'
+require 'locabulary/services'
 
 # @since 0.1.0
 module Locabulary
-  # @api private
+  # @api public
   # @since 0.5.0
   #
   # Responsible for building a hierarchical tree from faceted items, and ordering the nodes as per the presentation sequence for the
@@ -18,11 +16,11 @@ module Locabulary
   # @option options [String] :predicate_name
   # @option options [Array<#hits, #value>] :faceted_items
   # @option options [String] :faceted_item_hierarchy_delimiter
-  # @return Array[<FacetWrapperForItem>]
+  # @return [Array<FacetWrapperForItem>]
   #
-  # @see Locabulary::Commands::BuildOrderedHierarchicalTree
+  # @see Locabulary::Services
   def self.build_ordered_hierarchical_tree(options = {})
-    Commands::BuildOrderedHierarchicalTreeCommand.call(options)
+    Services.call(:build_ordered_hierarchical_tree, options)
   end
 
   # @api public
@@ -33,11 +31,11 @@ module Locabulary
   # @param [Hash] options
   # @option options [String] :predicate_name
   # @option options [Date] :as_of (Date.today)
-  # @return Array[<Locabulary::Items::Base>]
+  # @return [Array<Locabulary::Items::Base>]
   #
-  # @see Locabulary::Commands::ActiveItemsForCommand
+  # @see Locabulary::Services
   def self.active_items_for(options = {})
-    Commands::ActiveItemsForCommand.call(options)
+    Services.call(:active_items_for, options)
   end
 
   # @api public
@@ -50,12 +48,17 @@ module Locabulary
   # @option options [String] :predicate_name
   # @option options [Date] :as_of (Date.today)
   # @return [Array<Locabulary::Items::Base>] - the root nodes
+  # @see Locabulary::Services
   def self.active_hierarchical_roots(options = {})
-    Commands::ActiveHierarchicalRootsCommand.call(options)
+    Services.call(:active_hierarchical_roots, options)
   end
 
   # @api public
   # @since 0.5.0
+  #
+  # For the given :predicate_name and :term_label find an item.
+  # We prefer to find an active item, but will settle for a non-active item.
+  #
   # @param options [Hash]
   # @option options [String] :predicate_name
   # @option options [String] :term_label

data/lib/locabulary/hierarchy_processor.rb

@@ -11,6 +11,8 @@ module Locabulary
       new(options).call
     end
 
+    private_class_method :new
+
     # @param options [Hash]
     # @option options [#call] :item_builder - when called will create a Locabulary::Items::Base object
     # @option options [#call] :predicate_name -

data/lib/locabulary/item.rb

@@ -20,7 +20,7 @@ module Locabulary
 
     # @api public
     # @since 0.2.1
-    # @deprecated 0.6.0 Prefer instead class_to_instantiate
+    # @deprecated 0.6.0 Prefer instead class_to_instantiate; This will be removed in 0.7.0.
     #
     # Responsible for finding the appropriate Factory method for building a Locabulary::Item
     #

data/lib/locabulary/items/base.rb

@@ -58,6 +58,7 @@ module Locabulary
         @children = []
       end
 
+      # @api private
       def to_h
         attribute_names.each_with_object({}) do |key, mem|
           mem[key.to_s] = send(key) unless send(key).to_s.strip == ''
@@ -66,6 +67,7 @@ module Locabulary
       end
       alias as_json to_h
 
+      # @api public
       def to_persistence_format_for_fedora
         return term_uri unless term_uri.to_s.strip == ''
         term_label
@@ -102,39 +104,50 @@ module Locabulary
         default_presentation_sequence || SORT_SEQUENCE_FOR_NIL
       end
 
+      # @api public
       def children
         @children.sort
       end
 
+      # @api private
+      # Yes, this is private. Its an internal mechanism.
       def add_child(*input)
         @children += input
       end
 
       HIERARCHY_DELIMITER = '::'.freeze
+
+      # @api public
       def slugs
         term_label.split(HIERARCHY_DELIMITER)
       end
 
+      # @api public
       def self.hierarchy_delimiter
         HIERARCHY_DELIMITER
       end
 
+      # @api public
       def parent_slugs
         slugs[0..-2]
       end
 
+      # @api public
       def parent_term_label
         parent_slugs.join(HIERARCHY_DELIMITER)
       end
 
+      # @api public
       def root_slug
         slugs[0]
       end
 
+      # @api public
       def selectable?
         children.count.zero?
       end
 
+      # @api public
       # When rendered as part of a select list
       def selectable_label
         slugs[-1]
@@ -142,6 +155,7 @@ module Locabulary
 
       alias selectable_id id
 
+      # @api public
       # When rendered as part of a facet list
       def hierarchy_facet_label
         slugs[-1]

data/lib/locabulary/services.rb

@@ -0,0 +1,27 @@
+require 'active_support/core_ext/string/inflections'
+require 'locabulary/services/build_ordered_hierarchical_tree_command'
+require 'locabulary/services/active_items_for_command'
+require 'locabulary/services/active_hierarchical_roots_command'
+
+module Locabulary
+  # @api private
+  #
+  # A container namespace for service style objects; These service objects are
+  # responsible for encapsulating logic related to interaction with the data
+  # storage.
+  module Services
+    # @api private
+    # @since 0.6.1
+    #
+    # Responsible for delegating messages to underlying class.
+    # This indirection is used to protect the direct to private classes and thus
+    # keep a tightly defined interface.
+    #
+    # @param command_name [Symbol]
+    # @param options [Hash]
+    def self.call(command_name, options = {})
+      command_class = "#{command_name}_command".classify
+      const_get(command_class).call(options)
+    end
+  end
+end

data/lib/locabulary/{commands → services}/active_hierarchical_roots_command.rb

@@ -5,7 +5,10 @@ require 'locabulary/exceptions'
 require 'locabulary/hierarchy_processor'
 
 module Locabulary
-  module Commands
+  # :nodoc:
+  module Services
+    # @api private
+    #
     # Responsible for transforming the flat data for the given :predicate_name
     # into a hierarchy.
     class ActiveHierarchicalRootsCommand
@@ -35,6 +38,8 @@ module Locabulary
         cache[predicate_name] ||= new(options).call
       end
 
+      private_class_method :new
+
       def initialize(options = {})
         @predicate_name = options.fetch(:predicate_name)
         @as_of = options.fetch(:as_of) { Date.today }
@@ -67,5 +72,6 @@ module Locabulary
         Utility
       end
     end
+    private_constant :ActiveHierarchicalRootsCommand
   end
 end

data/lib/locabulary/{commands → services}/active_items_for_command.rb

@@ -3,7 +3,10 @@ require 'locabulary/item'
 require 'locabulary/utility'
 
 module Locabulary
-  module Commands
+  # :nodoc:
+  module Services
+    # @api private
+    #
     # Responsible for extracting a non-hierarchical sorted array of Locabulary::Item for the given predicate_name
     #
     # @see Locabulary::Item
@@ -35,6 +38,8 @@ module Locabulary
         cache[predicate_name] ||= new(options).call
       end
 
+      private_class_method :new
+
       def initialize(options = {})
         @predicate_name = options.fetch(:predicate_name)
         @as_of = options.fetch(:as_of) { Date.today }
@@ -53,5 +58,6 @@ module Locabulary
 
       attr_reader :predicate_name, :as_of, :builder
     end
+    private_constant :ActiveItemsForCommand
   end
 end

data/lib/locabulary/{commands → services}/build_ordered_hierarchical_tree_command.rb

@@ -6,7 +6,10 @@ require 'locabulary/facet_wrapper_for_item'
 require 'locabulary/hierarchy_processor'
 
 module Locabulary
-  module Commands
+  # :nodoc:
+  module Services
+    # @api private
+    #
     # Responsible for building a hierarchical tree from faceted items, and ordering the nodes as per the presentation sequence for the
     # associated predicate_name.
     class BuildOrderedHierarchicalTreeCommand
@@ -24,6 +27,8 @@ module Locabulary
         new(options).call
       end
 
+      private_class_method :new
+
       def initialize(options = {})
         @predicate_name = options.fetch(:predicate_name)
         @faceted_items = options.fetch(:faceted_items)
@@ -67,5 +72,6 @@ module Locabulary
         value.split(faceted_item_hierarchy_delimiter).join(locabulary_item_class.hierarchy_delimiter)
       end
     end
+    private_constant :BuildOrderedHierarchicalTreeCommand
   end
 end

data/lib/locabulary/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: locabulary
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-08 00:00:00.000000000 Z
+date: 2016-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -258,9 +258,6 @@ files:
 - data/work_patent_strategy.json
 - data/work_publication_strategy.json
 - lib/locabulary.rb
-- lib/locabulary/commands/active_hierarchical_roots_command.rb
-- lib/locabulary/commands/active_items_for_command.rb
-- 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
@@ -270,6 +267,10 @@ files:
 - lib/locabulary/items/base.rb
 - lib/locabulary/json_creator.rb
 - lib/locabulary/schema.rb
+- lib/locabulary/services.rb
+- lib/locabulary/services/active_hierarchical_roots_command.rb
+- lib/locabulary/services/active_items_for_command.rb
+- lib/locabulary/services/build_ordered_hierarchical_tree_command.rb
 - lib/locabulary/utility.rb
 - lib/locabulary/version.rb
 - locabulary.gemspec