pennyworth 14.3.0 → 15.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b134daf60efd3fcaab42d2c10f38267b4e6a62b18464df1fa22cb5d63b94bfd
-  data.tar.gz: 8da4f47900223e63394d840a03a7f825fc76e71cff8c611907d09277835f2a26
+  metadata.gz: b840f925f9e01b769b2e9a157856d29bc2ca4b286117a7f91ddfb13167161782
+  data.tar.gz: 2c8bb041add320dfb7ab0518ea9b990b9bcca7617326deaf0efe61577beb291e
 SHA512:
-  metadata.gz: 77de0d855c33857bce881eb70bc136fb4f6767c674fb9dc5fb2a562ad8880bc43d373872a7a7cc1bb3689ce4dcaf0eeca48b01df795e04d45801104b55f6ca63
-  data.tar.gz: 69096aeae87c4e069524414c39715aa7cdf12f541d0cdde5ab7c93f8d2dd94bcf781672862892d825381a8b62a302bab88d43c36486668dce98b6609f877aaf0
+  metadata.gz: 74cf171bfb42d77023abb9f4ecd96163db6c4fa2a0cbfca754ea35852ccfacb760475d5fb6a357729f4490060e3b42f6598ac2011e7c08ea45159bfaae0634f0
+  data.tar.gz: 315ca46e22acd1e8e175301fd325eebfd812b1e92e23c9ada51eed108bbf70af939e590ed7348433c3423916b1ea9e2169f21ee2d9c34de2c39fdc7de5f27c12

data/README.adoc

@@ -79,51 +79,27 @@ with others.
 From the command line, type `pennyworth` to view usage:
 
 ....
-Pennyworth - A command line interface that augments Alfred workflows.
-
-USAGE:
-  -c, --config ACTION                      Manage gem configuration. Actions: edit || view.
-      --encodings                          Render Alfred encodings script filter.
-      --git_hub                            Render Alfred GitHub repositories script filter.
-  -h, --help                               Show this message.
-      --http_statuses                      Render Alfred HTTP statuses script filter.
-      --ruby_gems                          Render Alfred RubyGems script filter.
-      --standard_errors                    Render Alfred standard errors script filter.
-      --system_errors                      Render Alfred system errors script filter.
-      --system_signals                     Render Alfred system signals script filter.
-      --text CONTENT                       Render Alfred text script filter.
-  -v, --version                            Show gem version.
-
-GITHUB OPTIONS:
-      --organization [HANDLE]              Set organization. Default: "".
-      --user [HANDLE]                      Set user. Default: "".
-
-RUBYGEMS OPTIONS:
-      --owner [HANDLE]                     Set owner. Default: "".
+USAGE
+  sublime_text_kit [OPTIONS]
+  sublime_text_kit COMMAND [OPTIONS]
+
+OPTIONS
+  --encodings              Render Alfred encodings script filter.
+  --http_statuses          Render Alfred HTTP statuses script filter.
+  --ruby_gems [HANDLE]     Render Alfred RubyGems script filter.
+  --standard_errors        Render Alfred standard errors script filter.
+  --system_errors          Render Alfred system errors script filter.
+  --system_signals         Render Alfred system signals script filter.
+  --text CONTENT           Render Alfred text script filter.
+  -v, --version            Show version.
+  -h, --help [COMMAND]     Show this message.
+
+COMMANDS
+  config                   Manage configuration.
+                           Path is dynamic per current directory.
+  git_hub                  Render Alfred GitHub repositories script filter.
 ....
 
-The following demonstrates how to use Pennyworth from the CLI or within an Alfred Script Filter:
-
-[source,bash]
-----
-pennyworth --config edit
-pennyworth --config view
-
-pennyworth --encodings
-
-pennyworth --git_hub --organization alchemists
-pennyworth --git_hub --user bkuhlmann
-
-pennyworth --http_statuses
-pennyworth --ruby_gems --owner bkuhlmann
-pennyworth --standard_errors
-pennyworth --system_errors
-pennyworth --system_signals
-
-pennyworth --text demo
-pennyworth --text "An Example"
-----
-
 While the command line options are nice, the real power comes from using Pennyworth in conjunction
 with link:https://www.alfredapp.com/help/workflows/inputs/script-filter/json[Alfred Script Filters].
 Without having Alfred wired up to consume the CLI output, you'll only get a JSON in your console. To
@@ -144,14 +120,12 @@ The default configuration is as follows:
 
 [source,yaml]
 ----
-:alfred:
-  :preferences:
-:inflections:
+alfred:
+  preferences:
+inflections:
   - "Bkuhlmann": "bkuhlmann"
   - "Dry Auto Inject": "Dry AutoInject"
   - "Dry Cli": "Dry CLI"
-  - "Flacsmith": "FLACsmith"
-  - "Git Plus": "Git+"
   - "Http Fake": "HTTP Fake"
   - "Mac Os Config": "macOS Configuration"
   - "Mac Os": "MacOS"
@@ -160,40 +134,17 @@ The default configuration is as follows:
   - "Rubocop Ast": "Rubocop AST"
   - "Rubocop Md": "Rubocop Markdown"
   - "Rubocop Rspec": "Rubocop RSpec"
-  - "Tty Box": "TTY Box"
-  - "Tty Color": "TTY Color"
-  - "Tty Command": "TTY Command"
-  - "Tty Config": "TTY Config"
-  - "Tty Cursor": "TTY Cursor"
-  - "Tty Editor": "TTY Editor"
-  - "Tty File": "TTY File"
-  - "Tty Font": "TTY Font"
-  - "Tty Link": "TTY Link"
-  - "Tty Logger": "TTY Logger"
-  - "Tty Markdown": "TTY Markdown"
-  - "Tty Option": "TTY Option"
-  - "Tty Pager": "TTY Pager"
-  - "Tty Pie": "TTY Pie"
-  - "Tty Platform": "TTY Platform"
-  - "Tty Progressbar": "TTY ProgressBar"
-  - "Tty Prompt": "TTY Prompt"
-  - "Tty Reader": "TTY Reader"
-  - "Tty Screen": "TTY Screen"
-  - "Tty Spinner": "TTY Spinner"
-  - "Tty Table": "TTY Table"
-  - "Tty Tree": "TTY Tree"
-  - "Tty Which": "TTY Which"
   - "Xdg": "XDG"
-:git_hub:
-  :api_url: "https://api.github.com"
-  :organization:
-  :user:
-:http:
-  :statuses:
-    :url: "https://developer.mozilla.org/docs/Web/HTTP/Status"
-:ruby_gems:
-  :api_url: "https://rubygems.org/api/v1"
-  :owner:
+git_hub:
+  api_url: "https://api.github.com"
+  organization:
+  user:
+http:
+  statuses:
+    url: "https://developer.mozilla.org/docs/Web/HTTP/Status"
+ruby_gems:
+  api_url: "https://rubygems.org/api/v1"
+  owner:
 ----
 
 Feel free to take this default configuration, modify, and save as your own custom
@@ -588,9 +539,6 @@ Provides general text manipulation utilities beyond the Pennyworth powered _text
 
 === Troubleshooting
 
-* link:https://github.com/ruby/psych[Psych] 4.0.0 has a
-  link:https://github.com/ruby/psych/issues/490[bug] which prevents loading of YAML configurations
-  that use symbols as keys. If you get caught by this, please upgrade to Psych 4.0.1 for the fix.
 * When your Alfred Workflow yields no output, you might want to open the
   link:https://www.alfredapp.com/help/workflows/utilities/debug[Alfred Debugger], rerun your
   workflow, and check for errors. You can also jump to the CLI and run Pennyworth directly.

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

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
 
+require "sod"
+
 module Pennyworth
   module CLI
     module Actions
       # Handles the encodings action.
-      class Encodings
-        include Pennyworth::Import[:kernel]
+      class Encodings < Sod::Action
+        include Import[:kernel]
+
+        description "Render Alfred encodings script filter."
+
+        on "--encodings"
 
         def initialize(processor: Processor.for_encodings, **)
           super(**)
           @processor = processor
         end
 
-        def call = kernel.puts processor.call.to_json
+        def call(*) = kernel.puts processor.call.to_json
 
         private
 

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Pennyworth
+  module CLI
+    module Actions
+      module GitHub
+        # Handles the GitHub user action.
+        class Organization < Sod::Action
+          include Import[:kernel]
+
+          description "Specify organization."
+
+          on %w[-o --organization],
+             argument: "[HANDLE]",
+             default: Container[:configuration].git_hub_organization
+
+          def initialize(processor: Processor.for_projects, **)
+            super(**)
+            @processor = processor
+          end
+
+          def call(handle = default) = kernel.puts processor.call("orgs/#{handle}").to_json
+
+          private
+
+          attr_reader :processor
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Pennyworth
+  module CLI
+    module Actions
+      module GitHub
+        # Handles the GitHub user action.
+        class User < Sod::Action
+          include Import[:kernel]
+
+          description "Specify user."
+
+          on %w[-u --user], argument: "[HANDLE]", default: Container[:configuration].git_hub_user
+
+          def initialize(processor: Processor.for_projects, **)
+            super(**)
+            @processor = processor
+          end
+
+          def call(handle = default) = kernel.puts processor.call("users/#{handle}").to_json
+
+          private
+
+          attr_reader :processor
+        end
+      end
+    end
+  end
+end

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

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
 
+require "sod"
+
 module Pennyworth
   module CLI
     module Actions
       # Handles the HTTP statuses action.
-      class HTTPStatuses
-        include Pennyworth::Import[:kernel]
+      class HTTPStatuses < Sod::Action
+        include Import[:kernel]
+
+        description "Render Alfred HTTP statuses script filter."
+
+        on "--http_statuses"
 
         def initialize(processor: Processor.for_http_statuses, **)
           super(**)
           @processor = processor
         end
 
-        def call = kernel.puts processor.call.to_json
+        def call(*) = kernel.puts processor.call.to_json
 
         private
 

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

@@ -1,18 +1,27 @@
 # frozen_string_literal: true
 
+require "sod"
+
 module Pennyworth
   module CLI
     module Actions
       # Handles the RubyGems action.
-      class RubyGems
-        include Pennyworth::Import[:kernel]
+      class RubyGems < Sod::Action
+        include Import[:kernel]
+
+        description "Render Alfred RubyGems script filter."
+
+        on "--ruby_gems", argument: "[HANDLE]", default: Container[:configuration].ruby_gems_owner
 
         def initialize(processor: Processor.for_gems, **)
           super(**)
           @processor = processor
         end
 
-        def call(endpoint) = kernel.puts processor.call(endpoint).to_json
+        def call handle = default
+          endpoint = "owners/#{handle}/gems.json"
+          kernel.puts processor.call(endpoint).to_json
+        end
 
         private
 

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

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
 
+require "sod"
+
 module Pennyworth
   module CLI
     module Actions
       # Handles the system errors action.
-      class StandardErrors
-        include Pennyworth::Import[:kernel]
+      class StandardErrors < Sod::Action
+        include Import[:kernel]
+
+        description "Render Alfred standard errors script filter."
+
+        on "--standard_errors"
 
         def initialize(processor: Processor.for_standard_errors, **)
           super(**)
           @processor = processor
         end
 
-        def call = kernel.puts processor.call.to_json
+        def call(*) = kernel.puts processor.call.to_json
 
         private
 

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

@@ -1,19 +1,25 @@
 # frozen_string_literal: true
 
+require "sod"
+
 module Pennyworth
   module CLI
     module Actions
       module System
         # Handles the system errors action.
-        class Errors
-          include Pennyworth::Import[:kernel]
+        class Errors < Sod::Action
+          include Import[:kernel]
+
+          description "Render Alfred system errors script filter."
+
+          on "--system_errors"
 
           def initialize(processor: Processor.for_system_errors, **)
             super(**)
             @processor = processor
           end
 
-          def call = kernel.puts processor.call.to_json
+          def call(*) = kernel.puts processor.call.to_json
 
           private
 

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

@@ -1,19 +1,25 @@
 # frozen_string_literal: true
 
+require "sod"
+
 module Pennyworth
   module CLI
     module Actions
       module System
         # Handles the signal action.
-        class Signals
-          include Pennyworth::Import[:kernel]
+        class Signals < Sod::Action
+          include Import[:kernel]
+
+          description "Render Alfred system signals script filter."
+
+          on "--system_signals"
 
           def initialize(processor: Processor.for_system_signals, **)
             super(**)
             @processor = processor
           end
 
-          def call = kernel.puts processor.call.to_json
+          def call(*) = kernel.puts processor.call.to_json
 
           private
 

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

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
+require "sod"
+
 module Pennyworth
   module CLI
     module Actions
       # Handles the text action.
-      class Text
-        include Pennyworth::Import[:kernel]
+      class Text < Sod::Action
+        include Import[:kernel]
+
+        description "Render Alfred text script filter."
+
+        on "--text", argument: "CONTENT"
 
         def initialize(processor: Processor.for_text, **)
           super(**)

data/lib/pennyworth/cli/shell.rb

@@ -1,59 +1,51 @@
 # frozen_string_literal: true
 
-require "core"
+require "sod"
 
 module Pennyworth
   module CLI
     # The main Command Line Interface (CLI) object.
     class Shell
-      include Actions::Import[
-        :config,
-        :encodings,
-        :git_hub,
-        :http_statuses,
-        :kernel,
-        :logger,
-        :ruby_gems,
-        :specification,
-        :standard_errors,
-        :system_errors,
-        :system_signals,
-        :text,
-      ]
-
-      def initialize(parser: Parser.new, **)
+      include Import[:defaults_path, :xdg_config, :specification]
+
+      def initialize(context: Sod::Context, dsl: Sod, **)
         super(**)
-        @parser = parser
+        @context = context
+        @dsl = dsl
       end
 
-      def call arguments = Core::EMPTY_ARRAY
-        act_on parser.call(arguments)
-      rescue OptionParser::ParseError, KeyError => error
-        logger.error { error.message }
-      end
+      def call(...) = cli.call(...)
 
       private
 
-      attr_reader :parser
-
-      def act_on configuration
-        case configuration
-          in action_config: Symbol => action then config.call action
-          in action_encodings: true then encodings.call
-          in action_git_hub: :organization
-            git_hub.call "orgs/#{configuration.git_hub_organization}"
-          in action_git_hub: :user then git_hub.call "users/#{configuration.git_hub_user}"
-          in action_http_statuses: true then http_statuses.call
-          in action_ruby_gems: true
-            ruby_gems.call "owners/#{configuration.ruby_gems_owner}/gems.json"
-          in action_standard_errors: true then standard_errors.call
-          in action_system_errors: true then system_errors.call
-          in action_system_signals: true then system_signals.call
-          in action_text: String => content then text.call content
-          in action_version: true then kernel.puts specification.labeled_version
-          else kernel.puts parser.to_s
+      attr_reader :context, :dsl
+
+      def cli
+        context = build_context
+
+        dsl.new :sublime_text_kit, banner: specification.banner do
+          on(Sod::Prefabs::Commands::Config, context:)
+
+          on "git_hub", "Render Alfred GitHub repositories script filter." do
+            on Actions::GitHub::Organization
+            on Actions::GitHub::User
+          end
+
+          on Actions::Encodings
+          on Actions::HTTPStatuses
+          on Actions::RubyGems
+          on Actions::StandardErrors
+          on Actions::System::Errors
+          on Actions::System::Signals
+          on Actions::Text
+          on(Sod::Prefabs::Actions::Version, context:)
+          on Sod::Prefabs::Actions::Help, self
         end
       end
+
+      def build_context
+        context[defaults_path:, xdg_config:, version_label: specification.labeled_version]
+      end
     end
   end
 end

data/lib/pennyworth/configuration/contract.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "dry/schema"
+
+Dry::Schema.load_extensions :monads
+
+module Pennyworth
+  module Configuration
+    Contract = Dry::Schema.Params do
+      optional(:alfred_preferences).filled :string
+      required(:inflections).array :hash
+      required(:git_hub_api_url).filled :string
+      optional(:git_hub_organization).filled :string
+      optional(:git_hub_user).filled :string
+      required(:http_statuses_url).filled :string
+      required(:ruby_gems_api_url).filled :string
+      optional(:ruby_gems_owner).filled :string
+    end
+  end
+end

data/lib/pennyworth/configuration/defaults.yml

@@ -1,11 +1,7 @@
-:alfred:
-  :preferences:
-:inflections:
+inflections:
   - "Bkuhlmann": "bkuhlmann"
   - "Dry Auto Inject": "Dry AutoInject"
   - "Dry Cli": "Dry CLI"
-  - "Flacsmith": "FLACsmith"
-  - "Git Plus": "Git+"
   - "Http Fake": "HTTP Fake"
   - "Mac Os Config": "macOS Configuration"
   - "Mac Os": "MacOS"
@@ -14,37 +10,11 @@
   - "Rubocop Ast": "Rubocop AST"
   - "Rubocop Md": "Rubocop Markdown"
   - "Rubocop Rspec": "Rubocop RSpec"
-  - "Tty Box": "TTY Box"
-  - "Tty Color": "TTY Color"
-  - "Tty Command": "TTY Command"
-  - "Tty Config": "TTY Config"
-  - "Tty Cursor": "TTY Cursor"
-  - "Tty Editor": "TTY Editor"
-  - "Tty File": "TTY File"
-  - "Tty Font": "TTY Font"
-  - "Tty Link": "TTY Link"
-  - "Tty Logger": "TTY Logger"
-  - "Tty Markdown": "TTY Markdown"
-  - "Tty Option": "TTY Option"
-  - "Tty Pager": "TTY Pager"
-  - "Tty Pie": "TTY Pie"
-  - "Tty Platform": "TTY Platform"
-  - "Tty Progressbar": "TTY ProgressBar"
-  - "Tty Prompt": "TTY Prompt"
-  - "Tty Reader": "TTY Reader"
-  - "Tty Screen": "TTY Screen"
-  - "Tty Spinner": "TTY Spinner"
-  - "Tty Table": "TTY Table"
-  - "Tty Tree": "TTY Tree"
-  - "Tty Which": "TTY Which"
   - "Xdg": "XDG"
-:git_hub:
-  :api_url: "https://api.github.com"
-  :organization:
-  :user:
-:http:
-  :statuses:
-    :url: "https://developer.mozilla.org/docs/Web/HTTP/Status"
-:ruby_gems:
-  :api_url: "https://rubygems.org/api/v1"
-  :owner:
+git_hub:
+  api_url: "https://api.github.com"
+http:
+  statuses:
+    url: "https://developer.mozilla.org/docs/Web/HTTP/Status"
+ruby_gems:
+  api_url: "https://rubygems.org/api/v1"

data/lib/pennyworth/configuration/{content.rb → model.rb}

@@ -3,18 +3,7 @@
 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_standard_errors,
-      :action_system_errors,
-      :action_system_signals,
-      :action_text,
-      :action_config,
-      :action_version,
-      :action_help,
+    Model = Struct.new(
       :alfred_preferences,
       :inflections,
       :git_hub_api_url,
@@ -22,10 +11,9 @@ module Pennyworth
       :git_hub_user,
       :http_statuses_url,
       :ruby_gems_api_url,
-      :ruby_gems_owner,
-      keyword_init: true
+      :ruby_gems_owner
     ) do
-      def initialize *arguments
+      def initialize(**)
         super
         freeze
       end

data/lib/pennyworth/container.rb

@@ -2,7 +2,9 @@
 
 require "cogger"
 require "dry/container"
+require "etcher"
 require "http"
+require "runcom"
 require "spek"
 
 module Pennyworth
@@ -10,9 +12,19 @@ module Pennyworth
   module Container
     extend Dry::Container::Mixin
 
-    register(:configuration) { Configuration::Loader.call }
+    register :configuration do
+      self[:defaults].add_loader(Etcher::Loaders::YAML.new(self[:xdg_config].active))
+                     .then { |registry| Etcher.call registry }
+    end
+
+    register :defaults do
+      Etcher::Registry.new(contract: Configuration::Contract, model: Configuration::Model)
+                      .add_loader(Etcher::Loaders::YAML.new(self[:defaults_path]))
+    end
+
+    register(:defaults_path) { Pathname(__dir__).join("configuration/defaults.yml") }
+    register(:xdg_config) { Runcom::Config.new "pennyworth/configuration.yml" }
     register(:specification) { Spek::Loader.call "#{__dir__}/../../pennyworth.gemspec" }
-    register(:environment) { ENV }
     register(:kernel) { Kernel }
     register(:http) { HTTP }
     register(:logger) { Cogger.new formatter: :emoji }