pennyworth 15.0.2 → 15.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95f95fda957b7af37f24cb9e2a78e8610b759878e1b362e1bc8349a92fc55ecc
-  data.tar.gz: 31327d9059fb763ba79ddbd5e7cd033c7fbbf6fbd868cab2b525df6cca171581
+  metadata.gz: aafd1088d83cdaef28941a84e39ce5709aeb6650409f425dd58a2b7d2324bc2d
+  data.tar.gz: c8f59363157d261b4a3e2d5745b8e1b76cf2db9a3d4b6bd96c0443925fcdedf0
 SHA512:
-  metadata.gz: fa2221cf39d531e1c2ee3416f219c11fe76b88c2cb3b645816eba19351dfc2678f7bdef3d1d3a4773d32efc0ad19b5fe3c102c7b215cb8a6895529b4dac553b7
-  data.tar.gz: d87ae2026728c366354a81c7d342a6612302358aab2c3666c67c98df235d516190f74de36a129da6faa7e92f33f08bf194f437ee7e8bc634527e49bbf90cf733
+  metadata.gz: 00a0626d8a8de7e33f9c135b199a6dbb67191ecfe85d05339c3b8868511a72c411b6d27f01ca02f56c0ead332d3ed6bf1ba1ccf6a836745db3fced9ed5ad715c
+  data.tar.gz: 37104b4204595fc58faf6f3178b234298f764b7e374e5720aab613b790f50f2af6b8c72a20aba98b888b10c02528c2579572b39632d0688cfbd59b482c585e48

data/README.adoc

@@ -84,20 +84,24 @@ USAGE
   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.
+  --encodings                Render Alfred encodings script filter.
+  --http_statuses            Render Alfred HTTP statuses script filter.
+  --ruby_gems [HANDLE]       Render Alfred RubyGems script filter.
+                             Default: bkuhlmann.
+  --standard_gems [KIND]     Render Alfred Standard Gems script filter.
+                             Use: all, default, or bundled.
+                             Default: all.
+  --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.
+  config                     Manage configuration.
+                             Path is dynamic per current directory.
+  git_hub                    Render Alfred GitHub repositories script filter.
 ....
 
 While the command line options are nice, the real power comes from using Pennyworth in conjunction
@@ -120,31 +124,87 @@ The default configuration is as follows:
 
 [source,yaml]
 ----
-alfred:
-  preferences:
 inflections:
-  - "Bkuhlmann": "bkuhlmann"
+  - "Base64": "Base64"
+  - "Bigdecimal": "BigDecimal"
+  - "Cgi": "CGI"
+  - "Cmath": "CMath"
+  - "Csv": "CSV"
+  - "Dbm": "DBM"
+  - "Drb": "Distributed Ruby"
   - "Dry Auto Inject": "Dry AutoInject"
   - "Dry Cli": "Dry CLI"
+  - "E2mmap": "Exception to Message Mapper"
+  - "Erb": "ERB"
+  - "Fileutils": "File Utilities"
+  - "Gdbm": "GDBM"
+  - "Getoptlong": "Get Option Long"
   - "Http Fake": "HTTP Fake"
+  - "Io Console": "IO Console"
+  - "Io Nonblock": "IO Nonblock"
+  - "Io Wait": "IO Wait"
+  - "Ipaddr": "IP Address"
+  - "Irb": "IRB"
+  - "Json": "JSON"
   - "Mac Os Config": "macOS Configuration"
   - "Mac Os": "MacOS"
+  - "Net Ftp": "Net FTP"
+  - "Net Http": "Net HTTP"
+  - "Net Imap": "Net IMAP"
+  - "Net Pop": "Net POP"
+  - "Net Smtp": "Net SMTP"
+  - "Nkf": "NKF"
+  - "Open Uri": "OpenURI"
+  - "Openssl": "OpenSSL"
+  - "Optparse": "Option Parser"
+  - "Ostruct": "OpenStruct"
   - "Pkce": "PKCE"
+  - "Pp": "PP"
   - "Prawn Plus": "Prawn+"
-  - "Rubocop Ast": "Rubocop AST"
-  - "Rubocop Md": "Rubocop Markdown"
-  - "Rubocop Rspec": "Rubocop RSpec"
+  - "Prettyprint": "Pretty Print"
+  - "Pstore": "PStore"
+  - "Rbs": "RBS"
+  - "Rdoc": "RDoc"
+  - "Rexml": "REXML"
+  - "Rss": "RSS"
+  - "Rubocop Ast": "RuboCop AST"
+  - "Rubocop Capybara": "RuboCop Capybara"
+  - "Rubocop Factory Bot": "RuboCop FactoryBot"
+  - "Rubocop Md": "RuboCop Markdown"
+  - "Rubocop Performance": "RuboCop Performance"
+  - "Rubocop Rails": "RuboCop Rails"
+  - "Rubocop Rake": "RuboCop Rake"
+  - "Rubocop Rspec": "RuboCop RSpec"
+  - "Rubocop Sequel": "RuboCop Sequel"
+  - "Rubocop Thread Safety": "RuboCop Thread Safety"
+  - "Rubocop": "RuboCop"
+  - "Ruby2_keywords": "Ruby to Keywords"
+  - "Rubygems": "RubyGems"
+  - "Sdbm": "SDBM"
+  - "Securerandom": "Secure Random"
+  - "Stringio": "String IO"
+  - "Strscan": "String Scan"
+  - "Tempfile": "Temporary File"
+  - "Thwait": "Threads Wait"
+  - "Tmpdir": "Temporary Directory"
+  - "Tsort": "TSort"
+  - "Typeprof": "Type Profiler"
+  - "Un": "un"
+  - "Uri": "URI"
+  - "Weakref": "Weak Reference"
+  - "Win32ole": "Windows 32 OLE"
   - "Xdg": "XDG"
+  - "Xmlrpc": "XMLRPC"
+  - "Yaml": "YAML"
 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:
+standard_gems:
+  api_url: "https://stdgems.org"
 ----
 
 Feel free to take this default configuration, modify, and save as your own custom
@@ -216,7 +276,7 @@ Provides quick access to link:https://docs.rubocop.org/rubocop[RuboCop] resource
 
 ==== Ruby
 
-image:https://alchemists.io/images/projects/pennyworth/screenshots/ruby.png[Ruby workflow screenshot,width=706,height=632,role=focal_point]
+image:https://alchemists.io/images/projects/pennyworth/screenshots/ruby.png[Ruby workflow screenshot,width=706,height=631,role=focal_point]
 
 Provides quick access to link:https://www.ruby-lang.org[Ruby] resources.
 

data/exe/pennyworth

@@ -3,4 +3,4 @@
 
 require "pennyworth"
 
-Pennyworth::CLI::Shell.new.call ARGV
+Pennyworth::CLI::Shell.new.call

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Pennyworth
+  module CLI
+    module Actions
+      # Handles the Standard Gems action.
+      class StandardGems < Sod::Action
+        include Import[:kernel]
+
+        description "Render Alfred Standard Gems script filter."
+
+        on "--standard_gems", argument: "[KIND]", allow: %w[all default bundled], default: "all"
+
+        def initialize(processor: Processor.for_standard_gems, **)
+          super(**)
+          @processor = processor
+        end
+
+        def call kind = nil
+          endpoint = "#{kind || default}_gems.json"
+          kernel.puts processor.call(endpoint).to_json
+        end
+
+        private
+
+        attr_reader :processor
+      end
+    end
+  end
+end

data/lib/pennyworth/cli/shell.rb

@@ -34,6 +34,7 @@ module Pennyworth
           on Actions::Encodings
           on Actions::HTTPStatuses
           on Actions::RubyGems
+          on Actions::StandardGems
           on Actions::StandardErrors
           on Actions::System::Errors
           on Actions::System::Signals

data/lib/pennyworth/configuration/contract.rb

@@ -15,6 +15,7 @@ module Pennyworth
       required(:http_statuses_url).filled :string
       required(:ruby_gems_api_url).filled :string
       optional(:ruby_gems_owner).filled :string
+      required(:standard_gems_api_url).filled :string
     end
   end
 end

data/lib/pennyworth/configuration/defaults.yml

@@ -1,16 +1,75 @@
 inflections:
-  - "Bkuhlmann": "bkuhlmann"
+  - "Base64": "Base64"
+  - "Bigdecimal": "BigDecimal"
+  - "Cgi": "CGI"
+  - "Cmath": "CMath"
+  - "Csv": "CSV"
+  - "Dbm": "DBM"
+  - "Drb": "Distributed Ruby"
   - "Dry Auto Inject": "Dry AutoInject"
   - "Dry Cli": "Dry CLI"
+  - "E2mmap": "Exception to Message Mapper"
+  - "Erb": "ERB"
+  - "Fileutils": "File Utilities"
+  - "Gdbm": "GDBM"
+  - "Getoptlong": "Get Option Long"
   - "Http Fake": "HTTP Fake"
+  - "Io Console": "IO Console"
+  - "Io Nonblock": "IO Nonblock"
+  - "Io Wait": "IO Wait"
+  - "Ipaddr": "IP Address"
+  - "Irb": "IRB"
+  - "Json": "JSON"
   - "Mac Os Config": "macOS Configuration"
   - "Mac Os": "MacOS"
+  - "Net Ftp": "Net FTP"
+  - "Net Http": "Net HTTP"
+  - "Net Imap": "Net IMAP"
+  - "Net Pop": "Net POP"
+  - "Net Smtp": "Net SMTP"
+  - "Nkf": "NKF"
+  - "Open Uri": "OpenURI"
+  - "Openssl": "OpenSSL"
+  - "Optparse": "Option Parser"
+  - "Ostruct": "OpenStruct"
   - "Pkce": "PKCE"
+  - "Pp": "PP"
   - "Prawn Plus": "Prawn+"
-  - "Rubocop Ast": "Rubocop AST"
-  - "Rubocop Md": "Rubocop Markdown"
-  - "Rubocop Rspec": "Rubocop RSpec"
+  - "Prettyprint": "Pretty Print"
+  - "Pstore": "PStore"
+  - "Rbs": "RBS"
+  - "Rdoc": "RDoc"
+  - "Rexml": "REXML"
+  - "Rss": "RSS"
+  - "Rubocop Ast": "RuboCop AST"
+  - "Rubocop Capybara": "RuboCop Capybara"
+  - "Rubocop Factory Bot": "RuboCop FactoryBot"
+  - "Rubocop Md": "RuboCop Markdown"
+  - "Rubocop Performance": "RuboCop Performance"
+  - "Rubocop Rails": "RuboCop Rails"
+  - "Rubocop Rake": "RuboCop Rake"
+  - "Rubocop Rspec": "RuboCop RSpec"
+  - "Rubocop Sequel": "RuboCop Sequel"
+  - "Rubocop Thread Safety": "RuboCop Thread Safety"
+  - "Rubocop": "RuboCop"
+  - "Ruby2_keywords": "Ruby to Keywords"
+  - "Rubygems": "RubyGems"
+  - "Sdbm": "SDBM"
+  - "Securerandom": "Secure Random"
+  - "Stringio": "String IO"
+  - "Strscan": "String Scan"
+  - "Tempfile": "Temporary File"
+  - "Thwait": "Threads Wait"
+  - "Tmpdir": "Temporary Directory"
+  - "Tsort": "TSort"
+  - "Typeprof": "Type Profiler"
+  - "Un": "un"
+  - "Uri": "URI"
+  - "Weakref": "Weak Reference"
+  - "Win32ole": "Windows 32 OLE"
   - "Xdg": "XDG"
+  - "Xmlrpc": "XMLRPC"
+  - "Yaml": "YAML"
 git_hub:
   api_url: "https://api.github.com"
 http:
@@ -18,3 +77,5 @@ http:
     url: "https://developer.mozilla.org/docs/Web/HTTP/Status"
 ruby_gems:
   api_url: "https://rubygems.org/api/v1"
+standard_gems:
+  api_url: "https://stdgems.org"

data/lib/pennyworth/configuration/model.rb

@@ -3,20 +3,14 @@
 module Pennyworth
   module Configuration
     # Defines configuration content as the primary source of truth for use throughout the gem.
-    Model = Struct.new(
-      :alfred_preferences,
-      :inflections,
-      :git_hub_api_url,
-      :git_hub_organization,
-      :git_hub_user,
-      :http_statuses_url,
-      :ruby_gems_api_url,
-      :ruby_gems_owner
-    ) do
-      def initialize(**)
-        super
-        freeze
-      end
-    end
+    Model = Struct.new :alfred_preferences,
+                       :inflections,
+                       :git_hub_api_url,
+                       :git_hub_organization,
+                       :git_hub_user,
+                       :http_statuses_url,
+                       :ruby_gems_api_url,
+                       :ruby_gems_owner,
+                       :standard_gems_api_url
   end
 end

data/lib/pennyworth/container.rb

@@ -12,21 +12,24 @@ module Pennyworth
   module Container
     extend Dry::Container::Mixin
 
-    register :configuration do
+    register :configuration, memoize: true do
       self[:defaults].add_loader(Etcher::Loaders::YAML.new(self[:xdg_config].active))
                      .then { |registry| Etcher.call registry }
     end
 
-    register :defaults do
+    register :defaults, memoize: true 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(:kernel) { Kernel }
-    register(:http) { HTTP }
-    register(:logger) { Cogger.new formatter: :emoji }
+    register :specification, memoize: true do
+      Spek::Loader.call "#{__dir__}/../../pennyworth.gemspec"
+    end
+
+    register(:defaults_path, memoize: true) { Pathname(__dir__).join("configuration/defaults.yml") }
+    register(:xdg_config, memoize: true) { Runcom::Config.new "pennyworth/configuration.yml" }
+    register(:logger, memoize: true) { Cogger.new formatter: :emoji }
+    register :http, HTTP
+    register :kernel, Kernel
   end
 end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "core"
 require "ghub"
 
 module Pennyworth
@@ -11,7 +12,7 @@ module Pennyworth
           @endpoint = endpoint
         end
 
-        def get(path) = endpoint.index(*path.split("/")).value_or([]).map(&:to_h)
+        def get(path) = endpoint.index(*path.split("/")).value_or(Core::EMPTY_ARRAY).map(&:to_h)
 
         private
 

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "core"
+
 module Pennyworth
   module Integrations
     module RubyGems
@@ -10,7 +12,9 @@ module Pennyworth
         def get endpoint
           http.get("#{configuration.ruby_gems_api_url}/#{endpoint}")
               .then do |response|
-                response.status.success? ? JSON(response.body.to_s, symbolize_names: true) : {}
+                return JSON response.body.to_s, symbolize_names: true if response.status.success?
+
+                Core::EMPTY_HASH
               end
         end
       end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "core"
+
+module Pennyworth
+  module Integrations
+    module StandardGems
+      # Provides low-level API access to the Standard Gems API.
+      class Client
+        include Import[:configuration, :http]
+
+        # Order matters.
+        ENDPOINTS = %w[bundled_gems.json default_gems.json].freeze
+
+        def initialize(endpoints: ENDPOINTS, **)
+          @endpoints = endpoints
+          super(**)
+        end
+
+        def get endpoint
+          if endpoints.include? endpoint then load_category endpoint
+          elsif endpoint == "all_gems.json" then all
+          else Core::EMPTY_ARRAY
+          end
+        end
+
+        private
+
+        attr_reader :endpoints
+
+        # :reek:FeatureEnvy
+        # :reek:DuplicateMethodCall
+        def all
+          load_all.sort_by! { |element| element[:gem] }
+                  .uniq! { |element| element[:gem] }
+                  .then { |collection| collection || Core::EMPTY_ARRAY }
+        end
+
+        def load_all
+          endpoints.reduce [] do |collection, endpoint|
+            collection.append(*load_category(endpoint))
+          end
+        end
+
+        def load_category endpoint
+          http.get("#{configuration.standard_gems_api_url}/#{endpoint}")
+              .then do |response|
+                response.status.success? ? records(response.body.to_s) : Core::EMPTY_HASH
+              end
+        end
+
+        def records(body) = JSON(body, symbolize_names: true).fetch :gems, Core::EMPTY_ARRAY
+      end
+    end
+  end
+end

data/lib/pennyworth/loaders/projects.rb

@@ -8,6 +8,8 @@ module Pennyworth
 
       def self.for_ruby_gems = new(client: Integrations::RubyGems::Client.new)
 
+      def self.for_standard_gems = new(client: Integrations::StandardGems::Client.new)
+
       def initialize client:
         @client = client
       end

data/lib/pennyworth/presenters/standard_gem.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "core"
+require "refinements/strings"
+
+module Pennyworth
+  module Presenters
+    # Renders Standard Gem records into a compatible format for use in Alfred script filters.
+    class StandardGem
+      using Refinements::Arrays
+      using Refinements::Strings
+
+      def initialize record, inflector: Inflector.new
+        @record = record
+        @inflector = inflector
+      end
+
+      def id = record.fetch :gem
+
+      def label = "#{inflector.call id.titleize} #{version}"
+
+      def subtitle = record.fetch :description
+
+      def version = record.fetch(:versions, Core::EMPTY_HASH).values.first
+
+      def site_url = record.fetch(:sourceRepository)
+
+      def source_url = record.fetch(:sourceRepository)
+
+      def issues_url = "https://github.com/ruby/#{id}/issues"
+
+      def versions_url = "https://github.com/ruby/#{id}/tags"
+
+      private
+
+      attr_reader :record, :inflector
+    end
+  end
+end

data/lib/pennyworth/processor.rb

@@ -27,6 +27,12 @@ module Pennyworth
           serializer: Serializers::Project
     end
 
+    def self.for_standard_gems
+      new loader: Loaders::Projects.for_standard_gems,
+          presenter: Presenters::StandardGem,
+          serializer: Serializers::Project
+    end
+
     def self.for_standard_errors
       new loader: Loaders::StandardErrors.new,
           presenter: Presenters::StandardError,

data/pennyworth.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "pennyworth"
-  spec.version = "15.0.2"
+  spec.version = "15.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/pennyworth"
@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = "~> 3.2"
   spec.add_dependency "cogger", "~> 0.10"
+  spec.add_dependency "core", "~> 0.1.4"
   spec.add_dependency "dry-container", "~> 0.11"
   spec.add_dependency "etcher", "~> 0.2"
   spec.add_dependency "ghub", "~> 0.5"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pennyworth
 version: !ruby/object:Gem::Version
-  version: 15.0.2
+  version: 15.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-06-22 00:00:00.000000000 Z
+date: 2023-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -51,6 +51,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: dry-container
   requirement: !ruby/object:Gem::Requirement
@@ -225,6 +239,7 @@ files:
 - lib/pennyworth/cli/actions/http_statuses.rb
 - lib/pennyworth/cli/actions/ruby_gems.rb
 - lib/pennyworth/cli/actions/standard_errors.rb
+- lib/pennyworth/cli/actions/standard_gems.rb
 - lib/pennyworth/cli/actions/system/errors.rb
 - lib/pennyworth/cli/actions/system/signals.rb
 - lib/pennyworth/cli/actions/text.rb
@@ -237,6 +252,7 @@ files:
 - lib/pennyworth/inflector.rb
 - lib/pennyworth/integrations/git_hub/client.rb
 - lib/pennyworth/integrations/ruby_gems/client.rb
+- lib/pennyworth/integrations/standard_gems/client.rb
 - lib/pennyworth/loaders/encodings.rb
 - lib/pennyworth/loaders/http_statuses.rb
 - lib/pennyworth/loaders/projects.rb
@@ -255,6 +271,7 @@ files:
 - lib/pennyworth/presenters/http_status.rb
 - lib/pennyworth/presenters/repository.rb
 - lib/pennyworth/presenters/standard_error.rb
+- lib/pennyworth/presenters/standard_gem.rb
 - lib/pennyworth/presenters/system/error.rb
 - lib/pennyworth/presenters/system/signal.rb
 - lib/pennyworth/presenters/text.rb
@@ -293,7 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: A command line interface for augmenting Alfred workflows.