pennyworth 11.2.0 → 12.0.1

data/README.adoc

@@ -16,7 +16,7 @@ image::https://circleci.com/gh/bkuhlmann/pennyworth.svg?style=svg[Circle CI Stat
 Pennyworth is a command line interface and the perfect companion to
 link:https://www.alfredapp.com[Alfred]. With Pennyworth, you can unlock the full potential of the
 Ruby language by leveraging modern versions of Ruby through Alfred Workflows. Perfect for when you
-want to advance beyond the based workflows Alfred provides by default.
+want to advance beyond the basic workflows Alfred provides by default.
 
 toc::[]
 
@@ -36,9 +36,18 @@ video::https://www.alchemists.io/videos/projects/pennyworth/demo.mp4[poster=http
 . link:https://www.gnu.org/software/bash[Bash]
 . link:https://www.alfredapp.com[Alfred]
 . link:https://www.alfredapp.com/purchase[Alfred Powerpack]
-. {frum_link}
 . link:https://www.ruby-lang.org[Ruby]
 
+While using a Ruby version manager -- like {frum_link} -- is not a hard requirement, it is strongly
+encouraged since a version manager will give you the freedom to toggle between different Ruby
+versions since this gem has strict Ruby version requirements (especially in regards to using a
+modern version of Ruby).
+
+I would also like to point out that all of the workflows, scripts, examples for this gem use Bash
+syntax. That said, if you are comfortable with translating Bash syntax to your shell syntax of
+choice, you can make this gem work in different shells too. That is beyond the scope of this
+document, though, so leave that exercise up to you.
+
 == Setup
 
 To install, run:
@@ -207,6 +216,8 @@ For the workflows that _do_ require Pennyworth support, the following assumption
    Alfred to load your development environment before running the Alfred Workflow.
 2. You have the latest version of Alfred, Ruby, and Pennyworth installed.
 3. You are using a Ruby version manager, like {frum_link}, which ensures Ruby is on your load path.
+   As mentioned in the _Requirements_ section above, this is not a hard requirement so if you have
+   the correct version of Ruby required by this gem on your path, that'll work too.
 
 With the above requirements in mind, the following sections document how to download and install all
 Pennyworth workflows that are compatible with Alfred. Should you want to tweak any of these
@@ -230,7 +241,7 @@ image:https://www.alchemists.io/images/projects/pennyworth/screenshots/alchemist
 
 The official link:https://www.alchemists.io[Alchemists] workflow for site navigation.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/alchemists.alfredworkflow[Download] and
+1. link:https://www.alchemists.io/public/alfred/workflows/alchemists.alfredworkflow[Download] and
    double click to install.
 2. Type `ax` to activate.
 
@@ -243,7 +254,7 @@ image:https://www.alchemists.io/images/projects/pennyworth/screenshots/dry-gems.
 
 A link:https://dry-rb.org[Dry RB] workflow for navigating all of the Dry RB site.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/dry.alfredworkflow[Download] and double
+1. link:https://www.alchemists.io/public/alfred/workflows/dry.alfredworkflow[Download] and double
    click to install.
 2. Type `dry` to activate general information and `dryx` for project list.
 
@@ -257,7 +268,7 @@ image:https://www.alchemists.io/images/projects/pennyworth/screenshots/rubocop-p
 A link:https://docs.rubocop.org/rubocop[Rubocop] workflow for quick access to documentation,
 learning about project changes, viewing source code, etc.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/rubocop.alfredworkflow[Download] and
+1. link:https://www.alchemists.io/public/alfred/workflows/rubocop.alfredworkflow[Download] and
    double click to install.
 2. Type `cop` to activate.
 
@@ -267,7 +278,7 @@ view issues.
 ==== Ruby
 
 This workflow is feature packed and only requires a
-link:https://www.alchemists.io/public/aflred/workflows/ruby.alfredworkflow[single download]. Once
+link:https://www.alchemists.io/public/alfred/workflows/ruby.alfredworkflow[single download]. Once
 downloaded, double click to install, and then continue reading to learn all of the
 capabilities this single workflow provides.
 
@@ -406,7 +417,7 @@ they are of interest/aid to your own productivity.
 Expands acronyms so you can think and type in terms of an acronym but appear as if you typed out the
 full definition each time.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/acronyms.alfredworkflow[Download] and
+1. link:https://www.alchemists.io/public/alfred/workflows/acronyms.alfredworkflow[Download] and
    double click to install.
 2. Use any of the macros provided by the workflow to expand acronyms for legibility.
 
@@ -416,7 +427,7 @@ image:https://www.alchemists.io/images/projects/pennyworth/screenshots/alpine.pn
 
 Provides link:https://www.alpinelinux.org[Alpine Linux] resources.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/alpine.alfredworkflow[Download] and double
+1. link:https://www.alchemists.io/public/alfred/workflows/alpine.alfredworkflow[Download] and double
    click to install.
 2. Type `al` to activate.
 
@@ -428,7 +439,7 @@ Launches development environment but can be tweaked for your preferences. Using
 manner ensures your machine boots or restarts quickly and gives you more control over what is
 launched.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/applications.alfredworkflow[Download] and
+1. link:https://www.alchemists.io/public/alfred/workflows/applications.alfredworkflow[Download] and
    double click to install.
 2. Type `work` to activate.
 
@@ -438,7 +449,7 @@ image:https://www.alchemists.io/images/projects/pennyworth/screenshots/browsers.
 
 Provides browser related utilities.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/browsers.alfredworkflow[Download] and
+1. link:https://www.alchemists.io/public/alfred/workflows/browsers.alfredworkflow[Download] and
    double click to install.
 2. Type `open` to activate.
 
@@ -448,7 +459,7 @@ image:https://www.alchemists.io/images/projects/pennyworth/screenshots/bundler.p
 
 Provides quick access to link:https://bundler.io[Bundler] related resources.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/bundler.alfredworkflow[Download] and
+1. link:https://www.alchemists.io/public/alfred/workflows/bundler.alfredworkflow[Download] and
    double click to install.
 2. Type `bundler` to activate.
 
@@ -458,7 +469,7 @@ image:https://www.alchemists.io/images/projects/pennyworth/screenshots/elm.png[E
 
 A link:https://elm-lang.org[Elm] workflow for quick access to Elm resources.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/elm.alfredworkflow[Download] and double
+1. link:https://www.alchemists.io/public/alfred/workflows/elm.alfredworkflow[Download] and double
    click to install.
 2. Type `elm` to view general information, arrow keys to navigate, and `ENTER` to view information.
 
@@ -468,7 +479,7 @@ image:https://www.alchemists.io/images/projects/pennyworth/screenshots/hanami.pn
 
 Provides link:https://hanamirb.org[Hanami] resources.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/hanami.alfredworkflow[Download] and
+1. link:https://www.alchemists.io/public/alfred/workflows/hanami.alfredworkflow[Download] and
    double click to install.
 2. Type `h` to activate.
 
@@ -478,7 +489,7 @@ image:https://www.alchemists.io/images/projects/pennyworth/screenshots/chili.png
 
 Shortens URLs using link:https://chl.li[chl.li].
 
-1. link:https://www.alchemists.io/public/aflred/workflows/chlli.alfredworkflow[Download] and
+1. link:https://www.alchemists.io/public/alfred/workflows/chlli.alfredworkflow[Download] and
    double click to install.
 2. Type `surl` to activate.
 
@@ -488,7 +499,7 @@ image:https://www.alchemists.io/images/projects/pennyworth/screenshots/docker.pn
 
 Provides link:https://www.docker.com[Docker] resources.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/docker.alfredworkflow[Download] and
+1. link:https://www.alchemists.io/public/alfred/workflows/docker.alfredworkflow[Download] and
    double click to install.
 2. Type `dr` to activate.
 
@@ -496,17 +507,17 @@ Provides link:https://www.docker.com[Docker] resources.
 
 Provides macOS utilities.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/mac_os.alfredworkflow[Download] and
+1. link:https://www.alchemists.io/public/alfred/workflows/mac_os.alfredworkflow[Download] and
    double click to install.
 2. Open the workflow to see all available keywords.
 
 ===== Terraform
 
-image:https://www.alchemists.io/images/projects/pennyworth/screenshots/terraform.png[Terraform workflow screenshot.,width=362,height=524,role=focal_point]
+image:https://www.alchemists.io/images/projects/pennyworth/screenshots/terraform.png[Terraform workflow screenshot.,width=706,height=632,role=focal_point]
 
 Provides link:https://www.terraform.io[Terraform] resources.
 
-1. link:https://www.alchemists.io/public/aflred/workflows/terraform.alfredworkflow[Download] and
+1. link:https://www.alchemists.io/public/alfred/workflows/terraform.alfredworkflow[Download] and
    double click to install.
 2. Type `tf` to activate.
 
@@ -515,7 +526,7 @@ Provides link:https://www.terraform.io[Terraform] resources.
 Provides general text manipulation utilities beyond the Pennyworth powered _text_ keyword (mentioned
 earlier).
 
-1. link:https://www.alchemists.io/public/aflred/workflows/text.alfredworkflow[Download] and
+1. link:https://www.alchemists.io/public/alfred/workflows/text.alfredworkflow[Download] and
    double click to install.
 2. Use any of the following global hotkeys to activate:
 ** `CONTROL + OPTION + COMMAND + o` - Open selected URL in default browser.
@@ -568,31 +579,19 @@ To test, run:
 bundle exec rake
 ----
 
-== Versioning
-
-Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
-
-* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
-* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
-* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
-
-== Code of Conduct
-
-Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
-participating in this project you agree to abide by its terms.
-
-== Contributions
+== link:https://www.alchemists.io/policies/license[License]
 
-Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
+== link:https://www.alchemists.io/policies/security[Security]
 
-== License
+== link:https://www.alchemists.io/policies/code_of_conduct[Code of Conduct]
 
-Read link:LICENSE.adoc[LICENSE] for details.
+== link:https://www.alchemists.io/policies/contributions[Contributions]
 
-== History
+== link:https://www.alchemists.io/projects/pennyworth/versions[Versions]
 
-Read link:CHANGES.adoc[CHANGES] for details.
+== link:https://www.alchemists.io/community[Community]
 
 == Credits
 
-Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
+* Built with link:https://www.alchemists.io/projects/gemsmith[Gemsmith].
+* Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/lib/pennyworth/cli/actions/config.rb

@@ -5,7 +5,7 @@ module Pennyworth
     module Actions
       # Handles the configuration action.
       class Config
-        def initialize configuration: Configuration::Loader::HANDLER, container: Container
+        def initialize configuration: Configuration::Loader::CLIENT, container: Container
           @configuration = configuration
           @container = container
         end

data/lib/pennyworth/cli/actions/encodings.rb

@@ -10,7 +10,7 @@ module Pennyworth
           @container = container
         end
 
-        def call = processor.call.to_json.then { |json| logger.info json }
+        def call = processor.call.to_json.then { |json| logger.info { json } }
 
         private
 

data/lib/pennyworth/cli/actions/git_hub.rb

@@ -13,7 +13,7 @@ module Pennyworth
         def call endpoint
           processor.call(endpoint)
                    .to_json
-                   .then { |json| logger.info json }
+                   .then { |json| logger.info { json } }
         end
 
         private

data/lib/pennyworth/cli/actions/http_statuses.rb

@@ -10,7 +10,7 @@ module Pennyworth
           @container = container
         end
 
-        def call = processor.call.to_json.then { |json| logger.info json }
+        def call = processor.call.to_json.then { |json| logger.info { json } }
 
         private
 

data/lib/pennyworth/cli/actions/ruby_gems.rb

@@ -13,7 +13,7 @@ module Pennyworth
         def call endpoint
           processor.call(endpoint)
                    .to_json
-                   .then { |json| logger.info json }
+                   .then { |json| logger.info { json } }
         end
 
         private

data/lib/pennyworth/cli/actions/system/errors.rb

@@ -11,7 +11,7 @@ module Pennyworth
             @container = container
           end
 
-          def call = processor.call.to_json.then { |json| logger.info json }
+          def call = processor.call.to_json.then { |json| logger.info { json } }
 
           private
 

data/lib/pennyworth/cli/actions/system/signals.rb

@@ -11,7 +11,7 @@ module Pennyworth
             @container = container
           end
 
-          def call = processor.call.to_json.then { |json| logger.info json }
+          def call = processor.call.to_json.then { |json| logger.info { json } }
 
           private
 

data/lib/pennyworth/cli/actions/text.rb

@@ -10,7 +10,7 @@ module Pennyworth
           @container = container
         end
 
-        def call(content) = processor.call(content).to_json.then { |json| logger.info json }
+        def call(content) = processor.call(content).to_json.then { |json| logger.info { json } }
 
         private
 

data/lib/pennyworth/cli/parser.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Pennyworth
+  module CLI
+    # Assembles and parses all Command Line Interface (CLI) options.
+    class Parser
+      CLIENT = OptionParser.new nil, 40, "  "
+      SECTIONS = [Parsers::Core, Parsers::GitHub, Parsers::RubyGems].freeze # Order is important.
+
+      def initialize configuration = Configuration::Loader.call,
+                     sections: SECTIONS,
+                     client: CLIENT
+        @configuration = configuration.dup
+        @sections = sections
+        @client = client
+      end
+
+      def call arguments = []
+        sections.each { |parser| parser.call configuration, client: }
+        client.parse arguments
+        configuration.freeze
+      end
+
+      def to_s = client.to_s
+
+      private
+
+      attr_reader :configuration, :client, :sections
+    end
+  end
+end

data/lib/pennyworth/cli/parsers/core.rb

@@ -12,7 +12,7 @@ module Pennyworth
       class Core
         def self.call(...) = new(...).call
 
-        def initialize configuration = Configuration::Loader.call, client: CLIENT
+        def initialize configuration = Configuration::Loader.call, client: Parser::CLIENT
           @configuration = configuration
           @client = client
         end
@@ -21,7 +21,8 @@ module Pennyworth
           client.banner = "#{Identity::LABEL} - #{Identity::SUMMARY}"
           client.separator "\nUSAGE:\n"
           collate
-          arguments.empty? ? arguments : client.parse!(arguments)
+          client.parse arguments
+          configuration
         end
 
         private
@@ -85,7 +86,7 @@ module Pennyworth
 
         def add_version
           client.on "-v", "--version", "Show gem version." do
-            configuration.action_version = Identity::VERSION_LABEL
+            configuration.action_version = true
           end
         end
 

data/lib/pennyworth/cli/parsers/git_hub.rb

@@ -11,7 +11,7 @@ module Pennyworth
 
         def self.call(...) = new(...).call
 
-        def initialize configuration = Configuration::Loader.call, client: CLIENT
+        def initialize configuration = Configuration::Loader.call, client: Parser::CLIENT
           @configuration = configuration
           @client = client
         end
@@ -19,7 +19,8 @@ module Pennyworth
         def call arguments = []
           client.separator "\nGITHUB OPTIONS:\n"
           private_methods.sort.grep(/add_/).each { |method| __send__ method }
-          arguments.empty? ? arguments : client.parse!(arguments)
+          client.parse arguments
+          configuration
         end
 
         private

data/lib/pennyworth/cli/parsers/ruby_gems.rb

@@ -7,7 +7,7 @@ module Pennyworth
       class RubyGems
         def self.call(...) = new(...).call
 
-        def initialize configuration = Configuration::Loader.call, client: CLIENT
+        def initialize configuration = Configuration::Loader.call, client: Parser::CLIENT
           @configuration = configuration
           @client = client
         end
@@ -15,7 +15,8 @@ module Pennyworth
         def call arguments = []
           client.separator "\nRUBYGEMS OPTIONS:\n"
           add_owner
-          arguments.empty? ? arguments : client.parse!(arguments)
+          client.parse arguments
+          configuration
         end
 
         private

data/lib/pennyworth/cli/shell.rb

@@ -15,7 +15,7 @@ module Pennyworth
         text: Actions::Text.new
       }.freeze
 
-      def initialize parser: Parsers::Assembler.new, actions: ACTIONS, container: Container
+      def initialize parser: Parser.new, actions: ACTIONS, container: Container
         @parser = parser
         @actions = actions
         @container = container
@@ -24,7 +24,7 @@ module Pennyworth
       def call arguments = []
         perform parser.call(arguments)
       rescue OptionParser::ParseError, KeyError => error
-        logger.error error.message
+        logger.error { error.message }
       end
 
       private
@@ -43,7 +43,7 @@ module Pennyworth
           in action_system_signals: true then system_signals
           in action_system_errors: true then system_errors
           in action_text: String => content then text content
-          in action_version: String => version then logger.info version
+          in action_version: true then logger.info { Identity::VERSION_LABEL }
           else usage
         end
       end

data/lib/pennyworth/configuration/content.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Configuration
+    # Defines configuration content as the primary source of truth for use throughout the gem.
+    Content = Struct.new(
+      :action_encodings,
+      :action_git_hub,
+      :action_http_statuses,
+      :action_ruby_gems,
+      :action_system_errors,
+      :action_system_signals,
+      :action_text,
+      :action_config,
+      :action_version,
+      :action_help,
+      :alfred_preferences,
+      :inflections,
+      :git_hub_api_url,
+      :git_hub_organization,
+      :git_hub_user,
+      :http_statuses_url,
+      :ruby_gems_api_url,
+      :ruby_gems_owner,
+      keyword_init: true
+    ) do
+      def initialize *arguments
+        super
+        freeze
+      end
+    end
+  end
+end

data/lib/pennyworth/configuration/loader.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "refinements/hashes"
+require "refinements/structs"
+require "runcom"
+require "yaml"
+
+module Pennyworth
+  module Configuration
+    # Represents the fully assembled Command Line Interface (CLI) configuration.
+    class Loader
+      using Refinements::Hashes
+      using Refinements::Structs
+
+      DEFAULTS = YAML.load_file(Pathname(__dir__).join("defaults.yml")).freeze
+      CLIENT = Runcom::Config.new "#{Identity::NAME}/configuration.yml", defaults: DEFAULTS
+
+      def self.call = new.call
+
+      def self.with_defaults = new(client: DEFAULTS)
+
+      def initialize content: Content.new, client: CLIENT
+        @content = content
+        @client = client
+      end
+
+      def call = content.merge(**client.to_h.flatten_keys)
+
+      private
+
+      attr_reader :content, :client
+    end
+  end
+end

data/lib/pennyworth/container.rb

@@ -10,7 +10,7 @@ module Pennyworth
   module Container
     extend Dry::Container::Mixin
 
-    register(:configuration) { CLI::Configuration::Loader.call }
+    register(:configuration) { Configuration::Loader.call }
     register(:environment) { ENV }
     register(:kernel) { Kernel }
     register(:http) { HTTP }

data/lib/pennyworth/identity.rb

@@ -6,7 +6,7 @@ module Pennyworth
     NAME = "pennyworth"
     LABEL = "Pennyworth"
     SUMMARY = "A command line interface that augments Alfred workflows."
-    VERSION = "11.2.0"
+    VERSION = "12.0.1"
     VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
   end
 end

data/lib/pennyworth/inflector.rb

@@ -3,7 +3,7 @@
 module Pennyworth
   # Overrides any string to desired form if matched, otherwise answers the original string.
   class Inflector
-    DEFAULTS = Array(CLI::Configuration::Loader.call.inflections).reduce({}, :merge)
+    DEFAULTS = Array(Configuration::Loader.call.inflections).reduce({}, :merge)
 
     def initialize overrides = DEFAULTS
       @overrides = overrides

data/lib/pennyworth/integrations/git_hub/client.rb

@@ -20,7 +20,7 @@ module Pennyworth
         end
 
         def get endpoint, parameters: {}
-          paginate ->(page) { sole_get endpoint, parameters: parameters.merge(page: page) }
+          paginate ->(page) { sole_get endpoint, parameters: parameters.merge(page:) }
         end
 
         private

data/lib/pennyworth/loaders/http_statuses.rb

@@ -8,14 +8,14 @@ module Pennyworth
     class HTTPStatuses
       def initialize codes: Rack::Utils::HTTP_STATUS_CODES,
                      model: Models::HTTPStatus,
-                     configuration: CLI::Configuration::Loader.call
+                     configuration: Configuration::Loader.call
         @codes = codes
         @model = model
         @configuration = configuration
       end
 
       def call _omit = nil
-        codes.map { |(code, label)| model[code: code, label: label, url: "#{url}/#{code}"] }
+        codes.map { |(code, label)| model[code:, label:, url: "#{url}/#{code}"] }
       end
 
       private

data/lib/pennyworth/loaders/system/signals.rb

@@ -10,7 +10,7 @@ module Pennyworth
           @model = model
         end
 
-        def call(_omit = nil) = list.map { |name, number| model[number: number, name: name] }
+        def call(_omit = nil) = list.map { |name, number| model[number:, name:] }
 
         private