locabulary 0.3.1 → 0.5.0

data/lib/locabulary/items/base.rb

@@ -52,9 +52,10 @@ module Locabulary
 
       def initialize(attributes = {})
         attribute_names.each do |key|
-          value = attributes.fetch(key) { attributes.fetch(key.to_s, nil) }
+          value = attributes[key] || attributes[key.to_s]
           send("#{key}=", value)
         end
+        @children = []
       end
 
       def to_h
@@ -89,9 +90,9 @@ module Locabulary
 
       def <=>(other)
         predicate_name_sort = predicate_name <=> other.predicate_name
-        return predicate_name_sort unless predicate_name_sort == 0
+        return predicate_name_sort unless predicate_name_sort.zero?
         presentation_sequence_sort = presentation_sequence <=> other.presentation_sequence
-        return presentation_sequence_sort unless presentation_sequence_sort == 0
+        return presentation_sequence_sort unless presentation_sequence_sort.zero?
         term_label <=> other.term_label
       end
 
@@ -100,6 +101,45 @@ module Locabulary
       def presentation_sequence
         default_presentation_sequence || SORT_SEQUENCE_FOR_NIL
       end
+
+      def children
+        @children.sort
+      end
+
+      def add_child(*input)
+        @children += input
+      end
+
+      HIERARCHY_DELIMITER = '::'.freeze
+      def slugs
+        term_label.split(HIERARCHY_DELIMITER)
+      end
+
+      def self.hierarchy_delimiter
+        HIERARCHY_DELIMITER
+      end
+
+      def parent_slugs
+        slugs[0..-2]
+      end
+
+      def parent_term_label
+        parent_slugs.join(HIERARCHY_DELIMITER)
+      end
+
+      def root_slug
+        slugs[0]
+      end
+
+      def selectable?
+        children.count.zero?
+      end
+
+      def selectable_label
+        slugs[-1]
+      end
+
+      alias selectable_id id
     end
   end
 end

data/lib/locabulary/json_creator.rb

@@ -1,8 +1,7 @@
-require "google/api_client"
 require "google_drive"
 require 'highline/import'
-require 'locabulary'
-require 'locabulary/items'
+require 'locabulary/utility'
+require 'locabulary/item'
 require 'json'
 
 module Locabulary
@@ -11,7 +10,7 @@ module Locabulary
     def initialize(document_key, predicate_name, data_fetcher = default_data_fetcher)
       @document_key = document_key
       @predicate_name = predicate_name
-      @output_filepath = Locabulary.filename_for_predicate_name(predicate_name: predicate_name)
+      @output_filepath = Utility.filename_for_predicate_name(predicate_name)
       @data_fetcher = data_fetcher
     end
 
@@ -54,7 +53,7 @@ module Locabulary
 
     def convert_to_json(data)
       json_array = data.map do |row|
-        Locabulary::Items.build(row).to_h
+        Locabulary::Item.build(row).to_h
       end
       @json_data = JSON.pretty_generate("predicate_name" => predicate_name, "values" => json_array)
     end

data/lib/locabulary/schema.rb

@@ -4,14 +4,14 @@ require 'dry/validation/schema'
 module Locabulary
   # Responsible for providing a defined and clear schema for each of the locabulary items.
   Schema = Dry::Validation.Schema do
-    key(:predicate_name).required(format?: /\A[a-z_]+\Z/)
-    key(:values).each do
-      key(:term_label).required(:str?)
+    required(:predicate_name).filled(format?: /\A[a-z_]+\Z/)
+    required(:values).each do
+      required(:term_label).filled(:str?)
       optional(:description).maybe(:str?)
       optional(:grouping).maybe(:str?)
       optional(:affiliation).maybe(:str?)
       optional(:default_presentation_sequence).maybe(:int?)
-      key(:activated_on).required(format?: /\A\d{4}-\d{2}-\d{2}\Z/)
+      required(:activated_on).filled(format?: /\A\d{4}-\d{2}-\d{2}\Z/)
       optional(:deactivated_on).maybe(format?: /\A\d{4}-\d{2}-\d{2}\Z/)
     end
   end

data/lib/locabulary/utility.rb

@@ -0,0 +1,42 @@
+require 'date'
+require 'json'
+require 'locabulary/exceptions'
+
+# :nodoc:
+module Locabulary
+  # A service module providing methods that are common and useful for querying the
+  # underlying data sources.
+  module Utility
+    DATA_DIRECTORY = File.expand_path("../../../data/", __FILE__).freeze
+    def self.with_active_extraction_for(predicate_name, as_of)
+      json = JSON.parse(File.read(filename_for_predicate_name(predicate_name)))
+      json.fetch('values').each do |data|
+        yield(data) if data_is_active?(data, as_of)
+      end
+    end
+
+    def self.with_extraction_for(predicate_name)
+      json = JSON.parse(File.read(filename_for_predicate_name(predicate_name)))
+      json.fetch('values').each do |data|
+        yield(data)
+      end
+    end
+
+    def self.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['deactivated_on']
+      return true if deactivated_on_value.nil?
+      deactivated_on = Date.parse(deactivated_on_value)
+      return false unless deactivated_on >= as_of
+      true
+    end
+
+    def self.filename_for_predicate_name(predicate_name)
+      filename = File.join(DATA_DIRECTORY, "#{File.basename(predicate_name)}.json")
+      return filename if File.exist?(filename)
+      raise Locabulary::Exceptions::MissingPredicateNameError, "Unable to find predicate_name: #{predicate_name}"
+    end
+  end
+  private_constant :Utility
+end

data/lib/locabulary/version.rb

@@ -1,3 +1,3 @@
 module Locabulary
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/locabulary.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "json", "~> 1.8"
   spec.add_dependency "dry-configurable"
-  spec.add_dependency "hanami-utils"
+  spec.add_dependency "activesupport", '~>4.0'
 
   spec.add_development_dependency "dry-validation"
   spec.add_development_dependency "bundler"
@@ -30,8 +30,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency 'google_drive'
   spec.add_development_dependency 'highline'
-  spec.add_development_dependency "activesupport", "~>4.0"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "fasterer"
+  spec.add_development_dependency "shoulda-matchers"
 end

data/script/build-multi-commit-message

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+git log --reverse --pretty="format:## %s%n%n@%H%n%n%b" master..

data/script/close-issue

@@ -0,0 +1,125 @@
+#!/usr/bin/env ruby -wU
+
+#*******************************************************************************
+#
+# CONFIGURATION OPTIONS
+#
+#*******************************************************************************
+
+CONFIG_KEYS = [:REMOTE, :REPOSITORY_PATH, :STARTED_ISSUES_FILE].freeze
+
+REPOSITORY_PATH = ENV.fetch('REPOSITORY_PATH') { File.expand_path(File.join(File.dirname(__FILE__), '../')) }
+REMOTE = ENV.fetch('REMOTE', 'origin')
+
+# TODO: Retrieve the dasherized issue from Github's API
+STARTED_ISSUES_FILE = ENV.fetch('STARTED_ISSUES_FILE', '.started-issues')
+
+#*******************************************************************************
+#
+# HELP OPTIONS
+#
+#*******************************************************************************
+
+if ARGV.grep(/-h/i).size == 1
+  $stdout.puts ""
+  $stdout.puts "$ ./#{File.basename(__FILE__)} 123"
+  $stdout.puts ""
+  $stdout.puts "This script will close the current issue branch."
+  $stdout.puts ""
+  $stdout.puts "* Remove the started issue from the #{STARTED_ISSUES_FILE}"
+  $stdout.puts "* Make a commit closing the issue"
+  $stdout.puts ""
+  $stdout.puts "Note: There are steps to insure you have a clean working directory."
+  $stdout.puts "Note: If you have spaces in your configuration all bets are off!"
+  $stdout.puts ""
+  $stdout.puts "Current Configuration:"
+  CONFIG_KEYS.each do |key|
+    $stdout.puts "\t#{key}='#{Object.const_get(key)}'"
+  end
+  $stdout.puts ""
+  $stdout.puts "You can override the configuration option by adding the corresponding"
+  $stdout.puts "ENV variable."
+  $stdout.puts ""
+  $stdout.puts "Example:"
+  $stdout.puts "$ REMOTE=origin ./scripts/#{File.basename(__FILE__)}"
+  exit(0)
+end
+
+#*******************************************************************************
+#
+# GUARD
+#
+#*******************************************************************************
+
+# Guard that directories exist
+[:REPOSITORY_PATH].each do |key|
+  repository_path = Object.const_get(key)
+  unless File.directory?(repository_path)
+    $stderr.puts "Expected directory for #{key} @ #{repository_path} to exist.\n\n"
+    $stderr.puts "See help for details on specifying #{key}.\n\n"
+    $stderr.puts "$ ./#{File.basename(__FILE__)} -h"
+    exit!(1)
+  end
+end
+
+# Guard that I know what the issue number is
+current_branch = `cd #{REPOSITORY_PATH} && git branch | grep '^*'`.sub(/^\*\s*/, '').strip
+
+if current_branch =~ /^(\d+)[^\d]/
+  ISSUE_NUMBER = $1.to_i
+else
+  $stderr.puts "Expected to be able to determine issue number from branch #{current_branch} name @ #{REPOSITORY_PATH}.\n\n"
+  $stderr.puts "See help for more information.\n\n"
+  $stderr.puts "$ ./#{File.basename(__FILE__)} -h"
+  exit!(2)
+end
+
+# Guard that we have a clean working directory
+if `cd #{REPOSITORY_PATH} && git status --porcelain`.strip.size > 0
+  $stderr.puts "Repository @ #{REPOSITORY_PATH} did not have a clean working directory"
+  exit!(3)
+end
+
+# Guard that the tests all pass
+unless system("cd #{REPOSITORY_PATH} && bundle exec rake")
+  $stderr.puts "Your tests failed. Please review the above output."
+  exit!(4)
+end
+
+#*******************************************************************************
+#
+# DO STUFF
+#
+#*******************************************************************************
+
+started_issues_file_lines = File.read(File.join(REPOSITORY_PATH, STARTED_ISSUES_FILE)).split("\n")
+
+File.open(STARTED_ISSUES_FILE, 'w+') do |file|
+  started_issues_file_lines.each do |line|
+    file.puts line unless line.to_i == ISSUE_NUMBER.to_i
+  end
+end
+
+`cd #{REPOSITORY_PATH}; git add #{STARTED_ISSUES_FILE}`
+
+path_to_commit_message = File.expand_path(File.join(REPOSITORY_PATH, '../COMMIT.msg'))
+begin
+  File.open(path_to_commit_message, 'w+') do |file|
+    file.puts "Closing issue #{ISSUE_NUMBER}"
+    file.puts ""
+    file.puts "Closes ##{ISSUE_NUMBER}"
+    file.puts ""
+
+    message = "$ ./script/#{File.basename(__FILE__)} #{ISSUE_NUMBER}"
+    CONFIG_KEYS.each_with_object(message) do |key, mem|
+      if ENV.key?(key.to_s)
+        mem = "#{key}=\"#{ENV[key.to_s].to_s}\" #{mem}"
+      end
+      mem
+    end
+    file.puts message
+  end
+  $stdout.puts `cd #{REPOSITORY_PATH} && git commit -F #{path_to_commit_message}`
+ensure
+  File.unlink(path_to_commit_message) rescue true
+end

data/script/start-issue

@@ -0,0 +1,174 @@
+#!/usr/bin/env ruby -wU
+
+#*******************************************************************************
+#
+# INTENT
+#
+# This script codifies the "moment" that someone starts "working" on an issue.
+# The goal is leveraging git to capture both the opening and closing moments
+# From those moments we can compute the elapsed time for resolving an issue.
+#
+# The script is "close" to where the developers are working, and is hopefully
+# easier to incorporate with developer workflow. Without using this script, we
+# have less precise "starting moment", if at all.
+#
+# The result is that we can now report two time-based attributes for issues:
+#
+# * Elapsed time: How long an issue took to complete
+# * Estimated effort: How much time we think it will take to complete; This is
+#   not elapsed time but instead an amount of focused time.
+#
+# The conjecture is given those two time-based attributes we can begin
+# improving the interpretation of our Feature estimates.
+#
+# Features will likely be comprised of a collection of issues; The estimate for
+# a feature is much less precise and I believe is equal parts "Estimated Effort"
+# and "Estimated Complexity".
+#
+#*******************************************************************************
+
+#*******************************************************************************
+#
+# CONFIGURATION OPTIONS
+#
+#*******************************************************************************
+
+CONFIG_KEYS = [:REMOTE, :FROM_BRANCH, :REPOSITORY_PATH, :ISSUE_TITLE, :STARTED_ISSUES_FILE].freeze
+
+REPOSITORY_PATH = ENV.fetch('REPOSITORY_PATH') { File.expand_path(File.join(File.dirname(__FILE__), '../')) }
+REMOTE = ENV.fetch('REMOTE', 'origin')
+FROM_BRANCH = ENV.fetch('FROM_BRANCH', 'master')
+
+issue_title_fetcher = lambda do
+  begin
+    remote_url = `cd #{REPOSITORY_PATH} && git config --get remote.#{REMOTE}.url`.strip
+    match = remote_url.match(/(\w+)\/(\w+)(?:\.git)?\Z/)
+    if match
+      require 'open-uri'
+      require 'json'
+      owner, repository = match.captures
+      document = open("https://api.github.com/repos/#{owner}/#{repository}/issues/#{ISSUE_NUMBER}.json").read
+      json = JSON.parse(document)
+      json.fetch('title').gsub(/\W+/, '-')
+    else
+      'issue-on-github'
+    end
+  rescue
+    'issue-on-github'
+  end
+end
+
+# TODO: Retrieve the dasherized issue from Github's API
+ISSUE_TITLE = ENV.fetch('ISSUE_TITLE', issue_title_fetcher)
+STARTED_ISSUES_FILE = ENV.fetch('STARTED_ISSUES_FILE', '.started-issues')
+
+#*******************************************************************************
+#
+# HELP OPTIONS
+#
+#*******************************************************************************
+
+if ARGV.grep(/-h/i).size == 1
+  $stdout.puts ""
+  $stdout.puts "$ ./#{File.basename(__FILE__)} 123"
+  $stdout.puts ""
+  $stdout.puts "This script will create an issue branch and update the remote repository."
+  $stdout.puts ""
+  $stdout.puts "* Create a new branch for the given issue number"
+  $stdout.puts "* Touch and append the issue number to a tracking file"
+  $stdout.puts "* Write a rudimentary commit message"
+  $stdout.puts "* Push that commit up to #{REMOTE}"
+  $stdout.puts ""
+  $stdout.puts "Note: There are steps to insure you have a clean working directory."
+  $stdout.puts "Note: If you have spaces in your configuration all bets are off!"
+  $stdout.puts ""
+  $stdout.puts "Current Configuration:"
+  CONFIG_KEYS.each do |key|
+    $stdout.puts "\t#{key}='#{Object.const_get(key)}'"
+  end
+  $stdout.puts ""
+  $stdout.puts "You can override the configuration option by adding the corresponding"
+  $stdout.puts "ENV variable."
+  $stdout.puts ""
+  $stdout.puts "Example:"
+  $stdout.puts "$ REMOTE=origin ./scripts/#{File.basename(__FILE__)}"
+  exit(0)
+end
+
+#*******************************************************************************
+#
+# GUARD
+#
+#*******************************************************************************
+
+# Guard that I have an issue number
+
+ISSUE_NUMBER = ARGV.shift
+
+unless ISSUE_NUMBER =~ /^\d+$/
+  $stderr.puts "Expected first parameter to be an issue number for REPOSITORY.\n\n"
+  $stderr.puts "See help for details on specifying an issue number.\n\n"
+  $stderr.puts "$ ./#{File.basename(__FILE__)} -h"
+  exit!(1)
+end
+
+# Capture the issue_title
+issue_title = ISSUE_TITLE.respond_to?(:call) ? ISSUE_TITLE.call : ISSUE_TITLE
+
+# Guard that directories exist
+[:REPOSITORY_PATH].each do |key|
+  repository_path = Object.const_get(key)
+  unless File.directory?(repository_path)
+    $stderr.puts "Expected directory for #{key} @ #{repository_path} to exist.\n\n"
+    $stderr.puts "See help for details on specifying #{key}.\n\n"
+    $stderr.puts "$ ./#{File.basename(__FILE__)} -h"
+    exit!(2)
+  end
+end
+
+# Guard that we have a clean working directory
+if `cd #{REPOSITORY_PATH} && git status --porcelain`.strip.size > 0
+  $stderr.puts "Repository @ #{REPOSITORY_PATH} did not have a clean working directory"
+  exit!(3)
+end
+
+#*******************************************************************************
+#
+# DO STUFF
+#
+#*******************************************************************************
+
+`cd #{REPOSITORY_PATH} && git checkout #{FROM_BRANCH}`
+`cd #{REPOSITORY_PATH} && git pull --rebase`
+
+TO_BRANCH = "#{ISSUE_NUMBER}-#{issue_title.gsub(/\W+/, '-')}"
+if `cd #{REPOSITORY_PATH} && git branch -l | grep '#{TO_BRANCH}$'`.strip.size > 0
+  $stderr.puts "ERROR: Branch #{TO_BRANCH} already exists"
+  exit!(4)
+end
+
+`cd #{REPOSITORY_PATH} && git checkout -b #{TO_BRANCH} && echo "#{ISSUE_NUMBER}" >> #{STARTED_ISSUES_FILE} && git add #{STARTED_ISSUES_FILE}`
+
+path_to_commit_message = File.expand_path(File.join(REPOSITORY_PATH, '../COMMIT.msg'))
+begin
+  File.open(path_to_commit_message, 'w+') do |file|
+    file.puts "Claiming issue #{ISSUE_NUMBER}"
+    file.puts ""
+    file.puts "relates to ##{ISSUE_NUMBER}"
+    file.puts ""
+
+    message = "$ ./script/#{File.basename(__FILE__)} #{ISSUE_NUMBER}"
+    CONFIG_KEYS.each_with_object(message) do |key, mem|
+      if ENV.key?(key.to_s)
+        mem = "#{key}=\"#{ENV[key.to_s].to_s}\" #{mem}"
+      end
+      mem
+    end
+    file.puts message
+    file.puts ""
+    file.puts "[skip ci]"
+  end
+  $stdout.puts `cd #{REPOSITORY_PATH} && git commit -F #{path_to_commit_message}`
+ensure
+  File.unlink(path_to_commit_message) rescue true
+end