locabulary 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 399c1a9f7cf3a7365116f94bd18cefa4c5ccd240
-  data.tar.gz: 9399cbc0fcd7b6a8d8b1839b79225e3061bd5fb5
+  metadata.gz: 4c1e85110e906091033981d644e5a147c001eab2
+  data.tar.gz: 1cf448e30e0d19469afafee922ac3f3a5d01f025
 SHA512:
-  metadata.gz: 74c9bb11679cea1e9c2831a995607426db1494028a5b147171e24233b11fe1378221769bb210c3f8f1e6331960502cdbf24b61f6167f3b3836da31baeffe312b
-  data.tar.gz: e1a7b89c4e1583ecbb29e2b0137fa3422d9b33ec4e2ec3afd6ac2f228f48a11afecc5ffcb4daa32d334196e73ca213b44957c79f02aa9402eac2505840823b3c
+  metadata.gz: 105285fc4f39faa1f49d78a5245a67fbb975c31656f62f430e831d256a0f6adb1810936695a068c015ce16674e5ffa503d8f3745624a97265515e94453201772
+  data.tar.gz: d0337a83c1248bb28b87494350e59770ddf9834480b4284a39bbb57289d9af24c3389fb831407a258b7d3709b72ce7e9e21ee6d633f0a2a2309c91ec49b306d3

data/.fasterer.yml

@@ -0,0 +1,4 @@
+speedups:
+  each_with_index_vs_while: false
+exclude_paths:
+  - 'vendor/**/*.rb'

data/.hound.yml

@@ -21,6 +21,7 @@ AllCops:
     - 'tmp/**/*'
     - 'bin/**/*'
     - 'lib/milan/registry.rb'
+    - 'script/*'
   TargetRubyVersion: 2.2
 Rails:
   Enabled: false

data/Gemfile

@@ -2,6 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in vocabulary.gemspec
 gemspec
-
-gem 'dry-validation', github: 'dry-rb/dry-validation'
-gem 'dry-types', github: 'dry-rb/dry-types'

data/README.md

@@ -10,3 +10,7 @@
 An extraction of limited localized vocabulary for Sipity and CurateND.
 This controlled vocabulary has a limited shelf-life as we explore other more
 robust options.
+
+## Testing
+
+The full test suite is run via `bundle exec rake`.

data/Rakefile

@@ -21,6 +21,16 @@ namespace :commitment do
   task :configure_test_for_code_coverage do
     ENV['COVERAGE'] = 'true'
   end
+  desc "Check for code that can go faster"
+  task :fasterer do
+    require 'fasterer/file_traverser'
+    file_traverser = Fasterer::FileTraverser.new(nil)
+    file_traverser.traverse
+    if file_traverser.offenses_found?
+      $stderr.puts "You can make the code go faster, see above. You can add exceptions in .fasterer.yml"
+      abort
+    end
+  end
   task :code_coverage do
     require 'json'
     $stdout.puts "Checking code_coverage"
@@ -38,5 +48,5 @@ namespace :commitment do
   end
 end
 
-task(default: [:rubocop, 'commitment:configure_test_for_code_coverage', :spec, 'commitment:code_coverage'])
+task(default: [:rubocop, 'commitment:fasterer', 'commitment:configure_test_for_code_coverage', :spec, 'commitment:code_coverage'])
 task(release: :default)

data/data/administrative_units.json

@@ -6,12 +6,14 @@
       "term_label": "University of Notre Dame",
       "classification": "University",
       "homepage": "http://www.nd.edu/",
-      "activated_on": "2015-07-22"
+      "activated_on": "2015-07-22",
+      "default_presentation_sequence": 1
     },
     {
       "predicate_name": "administrative_units",
       "term_label": "University of Notre Dame::School of Architecture",
       "classification": "College",
+      "default_presentation_sequence": 1,
       "homepage": "http://architecture.nd.edu/",
       "activated_on": "2015-07-22"
     },
@@ -20,6 +22,7 @@
       "term_label": "University of Notre Dame::College of Arts and Letters",
       "grouping": "The Humanities",
       "classification": "College",
+      "default_presentation_sequence": 2,
       "homepage": "http://al.nd.edu/",
       "activated_on": "2015-07-22"
     },
@@ -196,6 +199,7 @@
       "predicate_name": "administrative_units",
       "term_label": "University of Notre Dame::Mendoza College of Business",
       "classification": "College",
+      "default_presentation_sequence": 3,
       "homepage": "http://mendoza.nd.edu/",
       "activated_on": "2015-07-22"
     },
@@ -238,6 +242,7 @@
       "predicate_name": "administrative_units",
       "term_label": "University of Notre Dame::College of Engineering",
       "classification": "College",
+      "default_presentation_sequence": 4,
       "homepage": "http://engineering.nd.edu/",
       "activated_on": "2015-07-22"
     },
@@ -287,6 +292,7 @@
       "predicate_name": "administrative_units",
       "term_label": "University of Notre Dame::College of Science",
       "classification": "College",
+      "default_presentation_sequence": 5,
       "homepage": "http://science.nd.edu/",
       "activated_on": "2015-07-22"
     },
@@ -343,6 +349,7 @@
       "predicate_name": "administrative_units",
       "term_label": "University of Notre Dame::First Year of Studies",
       "classification": "College",
+      "default_presentation_sequence": 6,
       "homepage": "http://firstyear.nd.edu/",
       "activated_on": "2015-07-22"
     },
@@ -350,6 +357,7 @@
       "predicate_name": "administrative_units",
       "term_label": "University of Notre Dame::Graduate School",
       "classification": "College",
+      "default_presentation_sequence": 7,
       "homepage": "http://graduateschool.nd.edu/",
       "activated_on": "2015-07-22"
     },
@@ -357,6 +365,7 @@
       "predicate_name": "administrative_units",
       "term_label": "University of Notre Dame::Law School",
       "classification": "College",
+      "default_presentation_sequence": 8,
       "homepage": "http://law.nd.edu/",
       "activated_on": "2015-07-22"
     },
@@ -364,6 +373,7 @@
       "predicate_name": "administrative_units",
       "term_label": "University of Notre Dame::Reserve Officers Training Corps",
       "classification": "College",
+      "default_presentation_sequence": 9,
       "activated_on": "2015-07-22"
     },
     {
@@ -398,12 +408,13 @@
       "predicate_name": "administrative_units",
       "term_label": "University of Notre Dame::Hesburgh Libraries",
       "classification": "College",
+      "default_presentation_sequence": 10,
       "homepage": "http://library.nd.edu/",
       "activated_on": "2015-07-22"
     },
     {
       "predicate_name": "administrative_units",
-      "term_label": "University of Notre Dame::Hesburgh Libraries::General Collection",
+      "term_label": "University of Notre Dame::Hesburgh Libraries::General",
       "classification": "Department",
       "activated_on": "2015-07-22"
     },
@@ -425,6 +436,7 @@
       "predicate_name": "administrative_units",
       "term_label": "University of Notre Dame::Centers and Institutes",
       "classification": "CenterOrInstitute",
+      "default_presentation_sequence": 11,
       "activated_on": "2015-07-22"
     },
     {
@@ -876,6 +888,19 @@
       "affiliation": "University of Notre Dame::College of Engineering",
       "homepage": "http://wireless.nd.edu/",
       "activated_on": "2015-07-22"
+    },
+    {
+      "predicate_name": "administrative_units",
+      "term_label": "Catholic Organizations",
+      "classification": "OrganizationalGroup",
+      "activated_on": "2015-07-22"
+    },
+    {
+      "predicate_name": "administrative_units",
+      "term_label": "Catholic Organizations::Catholic Research Resources Alliance",
+      "classification": "Organization",
+      "homepage": "http://www.catholicresearch.net/",
+      "activated_on": "2015-07-22"
     }
   ]
 }

data/data/college.json

@@ -2,27 +2,27 @@
   "predicate_name": "college",
   "values": [{
     "term_label": "School of Architecture",
-    "default_presentation_sequence": 60,
+    "default_presentation_sequence": 10,
+    "activated_on": "2015-07-22"
+  },{
+    "term_label": "College of Arts and Letters",
+    "default_presentation_sequence": 20,
     "activated_on": "2015-07-22"
   },{
     "term_label": "Mendoza College of Business",
-    "default_presentation_sequence": 50,
+    "default_presentation_sequence": 30,
     "activated_on": "2015-07-22"
   },{
     "term_label": "College of Engineering",
-    "default_presentation_sequence": 20,
+    "default_presentation_sequence": 40,
     "activated_on": "2015-07-22"
   },{
     "term_label": "College of Science",
-    "default_presentation_sequence": 30,
-    "activated_on": "2015-07-22"
-  },{
-    "term_label": "College of Arts and Letters",
-    "default_presentation_sequence": 10,
+    "default_presentation_sequence": 50,
     "activated_on": "2015-07-22"
   },{
-    "term_label": "First Year Studies",
-    "default_presentation_sequence": 40,
+    "term_label": "First Year of Studies",
+    "default_presentation_sequence": 60,
     "activated_on": "2015-12-14"
   }]
 }

data/data/spec.json

@@ -0,0 +1,24 @@
+{
+  "predicate_name": "spec",
+  "values": [
+    {
+      "predicate_name": "spec",
+      "term_label": "Active Item",
+      "default_presentation_sequence": 3,
+      "activated_on": "2015-07-22"
+    },
+    {
+      "predicate_name": "spec",
+      "term_label": "Deactive Item",
+      "default_presentation_sequence": 1,
+      "activated_on": "2015-07-22",
+      "deactivated_on": "2016-07-01"
+    },
+    {
+      "predicate_name": "spec",
+      "term_label": "Alternate Item",
+      "default_presentation_sequence": 2,
+      "activated_on": "2015-07-22"
+    }
+  ]
+}

data/data/underclass_level.json

@@ -13,7 +13,7 @@
     "default_presentation_sequence": 3,
     "activated_on": "2015-01-01"
   },{
-    "term_label": "Junior",
+    "term_label": "Senior",
     "default_presentation_sequence": 4,
     "activated_on": "2015-01-01"
   },{

data/lib/locabulary.rb

@@ -1,125 +1,117 @@
 require 'date'
 require 'json'
 require 'locabulary/exceptions'
-require 'locabulary/items'
+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'
 
 # @since 0.1.0
 module Locabulary
-  DATA_DIRECTORY = File.expand_path("../../data/", __FILE__).freeze
-
-  module_function
+  # @api private
+  # @since 0.5.0
+  #
+  # Responsible for building a hierarchical tree from faceted items, and ordering the nodes as per the presentation sequence for the
+  # associated predicate_name.
+  #
+  # @param [Hash] options
+  # @option options [String] :predicate_name
+  # @option options [Array<#hits, #value>] :faceted_items
+  # @option options [String] :faceted_item_hierarchy_delimiter
+  # @return Array[<FacetWrapperForItem>]
+  #
+  # @see Locabulary::Commands::BuildOrderedHierarchicalTree
+  def self.build_ordered_hierarchical_tree(options = {})
+    Commands::BuildOrderedHierarchicalTreeCommand.call(options)
+  end
 
   # @api public
   # @since 0.1.0
   #
-  # @note A concession about the as_of; This is not a live query. The data has a
-  #   low churn rate. And while the date is important, I'm not as concerned
-  #   about the local controlled vocabulary exposing a date that has expired.
-  #   When we next deploy the server changes, the deactivated will go away.
-  def active_items_for(options = {})
-    predicate_name = options.fetch(:predicate_name)
-    as_of = options.fetch(:as_of) { Date.today }
-    builder = Items.builder_for(predicate_name: predicate_name)
-    active_cache[predicate_name] ||= begin
-      collector = []
-      with_active_extraction_for(predicate_name, as_of) do |data|
-        collector << builder.call(data.merge('predicate_name' => predicate_name))
-      end
-      collector.sort
-    end
+  # Responsible for extracting a non-hierarchical sorted array of Locabulary::Items::Base objects for the given predicate_name.
+  #
+  # @param [Hash] options
+  # @option options [String] :predicate_name
+  # @option options [Date] :as_of (Date.today)
+  # @return Array[<Locabulary::Items::Base>]
+  #
+  # @see Locabulary::Commands::ActiveItemsForCommand
+  def self.active_items_for(options = {})
+    Commands::ActiveItemsForCommand.call(options)
   end
 
   # @api public
-  # @since 0.2.0
-  def active_hierarchical_root(options = {})
-    predicate_name = options.fetch(:predicate_name)
-    as_of = options.fetch(:as_of) { Date.today }
-    builder = Items.builder_for(predicate_name: predicate_name)
-    active_hierarchical_root_cache[predicate_name] ||= begin
-      items = []
-      hierarchy_graph_keys = {}
-      top_level_slugs = Set.new
-      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, predicate_name)
-      raise Exceptions::TooManyHierarchicalRootsError.new(predicate_name, top_level_slugs.to_a) if top_level_slugs.size > 1
-      hierarchy_graph_keys.fetch(top_level_slugs.first)
-    end
-  end
-
-  def associate_parents_and_childrens_for(hierarchy_graph_keys, items, predicate_name)
-    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
+  # @since 0.4.0
+  #
+  # Responsible for transforming the flat data for the given :predicate_name
+  # into a hierarchy.
+  #
+  # @param [Hash] options
+  # @option options [String] :predicate_name
+  # @option options [Date] :as_of (Date.today)
+  # @return [Array<Locabulary::Items::Base>] - the root nodes
+  def self.active_hierarchical_roots(options = {})
+    Commands::ActiveHierarchicalRootsCommand.call(options)
   end
-  private :associate_parents_and_childrens_for
 
-  def with_active_extraction_for(predicate_name, as_of)
-    filename = filename_for_predicate_name(predicate_name: predicate_name)
-    json = JSON.parse(File.read(filename))
-    json.fetch('values').each do |data|
-      yield(data) if data_is_active?(data, as_of)
+  # @api public
+  # @since 0.5.0
+  # @param options [Hash]
+  # @option options [String] :predicate_name
+  # @option options [String] :term_label
+  # @option options [Date] :as_of (Date.today)
+  # @raise [Locabulary::Exceptions::ItemNotFoundError] if unable to find label for predicate_name
+  # @return [Locabulary::Items::Base]
+  def self.item_for(options = {})
+    predicate_name = options.fetch(:predicate_name)
+    term_label = options.fetch(:term_label)
+    as_of = options.fetch(:as_of) { Date.today }
+    item = nil
+    Utility.with_extraction_for(predicate_name) do |data|
+      next unless data.fetch('term_label') == term_label
+      item = Item.build(data.merge('predicate_name' => predicate_name))
+      break if Utility.data_is_active?(data, as_of)
     end
+    return item unless item.nil?
+    raise Locabulary::Exceptions::ItemNotFoundError.new(predicate_name, term_label)
   end
-  private :with_active_extraction_for
-
-  def data_is_active?(data, as_of)
-    activated_on = Date.parse(data.fetch('activated_on'))
-    return false unless activated_on < as_of
-    deactivated_on_value = data.fetch('deactivated_on', nil)
-    return true if deactivated_on_value.nil?
-    deactivated_on = Date.parse(deactivated_on_value)
-    return false unless deactivated_on >= as_of
-    true
-  end
-  private :data_is_active?
 
   # @api public
   # @since 0.1.0
-  def active_label_for_uri(options = {})
-    predicate_name = options.fetch(:predicate_name)
+  #
+  # @param [Hash] options
+  # @option options [String] :predicate_name
+  # @option options [String] :term_uri
+  # @option options [String] :as_of (Date.today)
+  #
+  # @return [String] a label or URI
+  #
+  # @see Locabulary.active_items_for
+  def self.active_label_for_uri(options = {})
     term_uri = options.fetch(:term_uri)
-    object = active_items_for(predicate_name: predicate_name).detect { |obj| obj.term_uri == term_uri }
+    object = active_items_for(options).detect { |obj| obj.term_uri == term_uri }
     return object.term_label if object
     term_uri
   end
 
   # @api public
   # @since 0.1.0
-  def active_labels_for(options = {})
-    predicate_name = options.fetch(:predicate_name)
-    active_items_for(predicate_name: predicate_name).map(&:term_label)
-  end
-
-  # @api private
-  def filename_for_predicate_name(options = {})
-    predicate_name = options.fetch(:predicate_name)
-    filename = File.join(DATA_DIRECTORY, "#{File.basename(predicate_name)}.json")
-    return filename if File.exist?(filename)
-    raise Locabulary::Exceptions::RuntimeError, "Unable to find predicate_name: #{predicate_name}"
-  end
-
-  # @api private
-  def active_cache
-    @active_cache ||= {}
-  end
-
-  # @api private
-  def active_hierarchical_root_cache
-    @active_hierarchical_root_cache ||= {}
+  #
+  # Return an Array of term labels for the given :predicate_name
+  #
+  # @param [Hash] options
+  # @option options [String] :predicate_name
+  # @option options [String] :as_of (Date.today)
+  # @return [Array<String>] an array of Locabuarly::Items::Base#term_label
+  #
+  # @see Locabulary.active_items_for
+  def self.active_labels_for(options = {})
+    active_items_for(options).map(&:term_label)
   end
 
   # @api private
-  def reset_active_cache!
-    @active_cache = nil
-    @active_hierarchical_root_cache = nil
+  def self.reset_active_cache!
+    Commands::ActiveItemsForCommand.reset_cache!
+    Commands::ActiveHierarchicalRootsCommand.reset_cache!
   end
 end