pennyworth 17.3.0 → 17.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d45e8ead5b97dd8d79a3837428f28fb1d5c06cec211aec5454b6cf67c15857
-  data.tar.gz: b16c2c6602e5986115411389a3e52802be997c3d0ad0fd0a146a9c441f52826a
+  metadata.gz: 8c64185db3d1ff451a3c2d1eeb3f339e75e4de547a1a3d09d716f3ec506154e7
+  data.tar.gz: aec6e33ebebe91ec50035a64cda46be8643ea764d7f5824ad7d3f3217285223a
 SHA512:
-  metadata.gz: b04cd132e5e780d0de845374e81f0e1f32db8cdbddf10a88afb4a0aaf922a07f65b1f32a42cf26d9c0e43166fca47a9c2d063ee6422d5b00f83d6966651e4c87
-  data.tar.gz: 0e0993213eae14acba428447e7381c49a949c196ec46cf12a07df850e9a147d87c3b44091a151784690146ef647eed80357325f787deafa300a50b4d35fb6a73
+  metadata.gz: ef6e10ecb5dcc3df7e5fa8f7097d043024459ae7cc62a354cd7b6ca1038126c57f69e38f832c52c1853dcc360009efae22dda9bbef73fb2bc028e85bc17f3831
+  data.tar.gz: 7183d127ad96ce64a20d46bf36706dafb0f90d47f4d3460037d5fab2130fdac19bf271666e420ea03c61b5117539351fef874f1fd7e58640b6b373994e7e1f93

data/README.adoc

@@ -34,7 +34,7 @@ video::https://alchemists.io/videos/projects/pennyworth/demo.mp4[poster=https://
 
 While using a {ruby_version_managers_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).
 
-All of the workflows, scripts, examples for this gem use {bash_link} 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 to you.
+All of the workflows, scripts, examples for this gem use {bash_link} 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. Shell conversion is beyond the scope of this document so leave that exercise to you.
 
 == Setup
 
@@ -78,7 +78,7 @@ with others.
 
 From the command line, type `pennyworth` to view usage:
 
-image:https://alchemists.io/images/projects/pennyworth/screenshots/usage.png[Usage,width=667,height=499,role=focal_point]
+image:https://alchemists.io/images/projects/pennyworth/screenshots/usage.png[Usage,width=638,height=505,role=focal_point]
 
 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].
@@ -121,6 +121,7 @@ inflections:
   - "Io Wait": "IO Wait"
   - "Ipaddr": "IP Address"
   - "Irb": "IRB"
+  - "Irb Kit": "IRB Kit"
   - "Json": "JSON"
   - "Mac Os Config": "macOS Configuration"
   - "Mac Os": "MacOS"
@@ -177,6 +178,9 @@ git_hub:
 http:
   statuses:
     url: "https://developer.mozilla.org/docs/Web/HTTP/Status"
+htmx:
+  examples_uri: "https://htmx.org/examples"
+  references_uri: "https://htmx.org/reference"
 ruby_gems:
   api_url: "https://rubygems.org/api/v1"
 standard_gems:
@@ -435,11 +439,11 @@ Provides quick access to the link:https://html.spec.whatwg.org/multipage[HTML] l
    double click to install.
 2. Click on _Configure Workflow_ to view documentation.
 
-===== HTMX
+===== htmx
 
-image:https://alchemists.io/images/projects/pennyworth/screenshots/htmx.png[HTMX workflow screenshot.,width=706,height=523,role=focal_point]
+image:https://alchemists.io/images/projects/pennyworth/screenshots/htmx.png[htmx workflow screenshot.,width=706,height=631,role=focal_point]
 
-Provides quick access to the link:https://htmx.org[HTMX] JavaScript library.
+Provides quick access to the link:https://htmx.org[htmx] JavaScript library.
 
 1. link:https://alchemists.io/public/alfred/workflows/htmx.alfredworkflow[Download] and
    double click to install.

data/lib/pennyworth/cli/actions/htmx/example.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Pennyworth
+  module CLI
+    module Actions
+      module HTMX
+        # Handles examples documentation action.
+        class Example < Sod::Action
+          include Import[:settings, :io]
+
+          description "Render Alfred examples script filter."
+
+          on "--examples"
+
+          def initialize(processor: Processor.for_htmx, **)
+            @processor = processor
+            super(**)
+          end
+
+          def call(*) = io.puts processor.call(settings.htmx_examples_uri).to_json
+
+          private
+
+          attr_reader :processor
+        end
+      end
+    end
+  end
+end

data/lib/pennyworth/cli/actions/htmx/reference.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Pennyworth
+  module CLI
+    module Actions
+      module HTMX
+        # Handles references documentation action.
+        class Reference < Sod::Action
+          include Import[:settings, :io]
+
+          description "Render Alfred references script filter."
+
+          on "--references"
+
+          def initialize(processor: Processor.for_htmx, **)
+            @processor = processor
+            super(**)
+          end
+
+          def call(*) = io.puts processor.call(settings.htmx_references_uri).to_json
+
+          private
+
+          attr_reader :processor
+        end
+      end
+    end
+  end
+end

data/lib/pennyworth/cli/shell.rb

@@ -31,6 +31,11 @@ module Pennyworth
             on Actions::GitHub::User
           end
 
+          on "htmx", "Render htmx script filters" do
+            on Actions::HTMX::Example
+            on Actions::HTMX::Reference
+          end
+
           on Actions::Encoding
           on Actions::HTTPStatus
           on Actions::Gem

data/lib/pennyworth/configuration/contract.rb

@@ -13,6 +13,8 @@ module Pennyworth
       optional(:git_hub_organization).filled :string
       optional(:git_hub_user).filled :string
       required(:http_statuses_url).filled :string
+      required(:htmx_examples_uri).filled :string
+      required(:htmx_references_uri).filled :string
       required(:ruby_gems_api_url).filled :string
       optional(:ruby_gems_owner).filled :string
       required(:standard_gems_api_url).filled :string

data/lib/pennyworth/configuration/defaults.yml

@@ -76,6 +76,9 @@ git_hub:
 http:
   statuses:
     url: "https://developer.mozilla.org/docs/Web/HTTP/Status"
+htmx:
+  examples_uri: "https://htmx.org/examples"
+  references_uri: "https://htmx.org/reference"
 ruby_gems:
   api_url: "https://rubygems.org/api/v1"
 standard_gems:

data/lib/pennyworth/configuration/model.rb

@@ -9,6 +9,8 @@ module Pennyworth
                        :git_hub_organization,
                        :git_hub_user,
                        :http_statuses_url,
+                       :htmx_examples_uri,
+                       :htmx_references_uri,
                        :ruby_gems_api_url,
                        :ruby_gems_owner,
                        :standard_gems_api_url

data/lib/pennyworth/container.rb

@@ -22,7 +22,7 @@ module Pennyworth
     register(:specification) { Spek::Loader.call "#{__dir__}/../../pennyworth.gemspec" }
     register(:defaults_path) { Pathname(__dir__).join("configuration/defaults.yml") }
     register(:xdg_config) { Runcom::Config.new "pennyworth/configuration.yml" }
-    register :http, HTTP
+    register(:http) { HTTP.timeout 3 }
     register(:logger) { Cogger.new id: :pennyworth }
     register :io, STDOUT
   end

data/lib/pennyworth/loaders/htmx.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "core"
+require "ox"
+require "refinements/string"
+
+module Pennyworth
+  module Loaders
+    # Loads htmx documentation by scraping web page.
+    class HTMX
+      include Import[:http]
+
+      using Refinements::String
+
+      PARSER = Ox.tap do |ox|
+        ox.default_options = {mode: :generic, effort: :tolerant, smart: true}
+      end
+
+      def self.text_for element
+        parts = element.each.with_object [] do |item, content|
+          content.append item.is_a?(Ox::Element) ? "`#{item.text}`" : item
+        end
+
+        parts.join.up.delete_suffix "."
+      end
+
+      def initialize(parser: PARSER, model: Models::HTMX, **)
+        @parser = parser
+        @model = model
+        super(**)
+      end
+
+      def call uri
+        read(uri).each.with_object [] do |row, entries|
+          next unless row.locate("td") in Ox::Element => item, Ox::Element => description
+
+          label = item.locate("*/code").first || item.locate("a").first
+
+          entries.append record_for(label, description, item)
+        end
+      end
+
+      private
+
+      attr_reader :parser, :model
+
+      def read uri
+        http.get(uri).then do |response|
+          [200, 301].include?(response.status) ? parse_rows(response.body.to_s) : Core::EMPTY_ARRAY
+        end
+      end
+
+      def parse_rows(document) = parser.parse(document).locate "*/tr"
+
+      def record_for label, description, item
+        model[
+          label: label.text,
+          description: "#{self.class.text_for description}.",
+          uri: item.locate("*/@href").first
+        ]
+      end
+    end
+  end
+end

data/lib/pennyworth/models/htmx.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Models
+    # Represents a htmx link.
+    HTMX = Data.define :label, :description, :uri
+  end
+end

data/lib/pennyworth/presenters/encoding.rb

@@ -2,7 +2,7 @@
 
 module Pennyworth
   module Presenters
-    # Renders encoding into a compatible format for use in Alfred script filters.
+    # Shapes an encoding record for serialization.
     class Encoding
       def initialize record
         @record = record

data/lib/pennyworth/presenters/gem.rb

@@ -4,7 +4,7 @@ require "refinements/string"
 
 module Pennyworth
   module Presenters
-    # Renders RubyGems records into a compatible format for use in Alfred script filters.
+    # Shapes a RubyGems record for serialization.
     class Gem
       using Refinements::Array
       using Refinements::String

data/lib/pennyworth/presenters/htmx.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Pennyworth
+  module Presenters
+    # Shapes a htmx record for serialization.
+    class HTMX
+      extend Forwardable
+
+      delegate %i[label description uri] => :record
+
+      def initialize record
+        @record = record
+      end
+
+      alias id label
+
+      private
+
+      attr_reader :record
+    end
+  end
+end

data/lib/pennyworth/presenters/http_status.rb

@@ -5,7 +5,7 @@ require "refinements/string"
 
 module Pennyworth
   module Presenters
-    # Renders system error into a compatible format for use in Alfred script filters.
+    # Shapes a HTTP status record for serialization.
     class HTTPStatus
       extend Forwardable
 

data/lib/pennyworth/presenters/repository.rb

@@ -4,7 +4,7 @@ require "refinements/string"
 
 module Pennyworth
   module Presenters
-    # Renders a GitHub repository record into a compatible format for use in Alfred script filters.
+    # Shapes a repository record for serialization.
     class Repository
       using Refinements::String
 

data/lib/pennyworth/presenters/standard_error.rb

@@ -4,7 +4,7 @@ require "refinements/array"
 
 module Pennyworth
   module Presenters
-    # Renders a standard error into a compatible format for use in Alfred script filters.
+    # Shapes a standard error record for serialization.
     class StandardError
       using Refinements::Array
 

data/lib/pennyworth/presenters/standard_gem.rb

@@ -5,7 +5,7 @@ require "refinements/string"
 
 module Pennyworth
   module Presenters
-    # Renders Standard Gem records into a compatible format for use in Alfred script filters.
+    # Shapes a standard gem record for serialization.
     class StandardGem
       using Refinements::Array
       using Refinements::String
@@ -21,10 +21,11 @@ module Pennyworth
 
       def subtitle = record.fetch :description
 
-      # :reek:FeatureEnvy
       def version
         versions = record.fetch :versions, Core::EMPTY_HASH
-        (versions[:bundled] || versions[:default] || versions).values.first
+        bundled, defaults = versions.values_at :bundled, :default
+
+        (bundled || defaults || versions).values.first
       end
 
       def site_url = record.fetch(:sourceRepository, Core::EMPTY_STRING)

data/lib/pennyworth/presenters/system/error.rb

@@ -5,7 +5,7 @@ require "forwardable"
 module Pennyworth
   module Presenters
     module System
-      # Renders system error into a compatible format for use in Alfred script filters.
+      # Shapes a system error record for serialization.
       class Error
         extend Forwardable
 

data/lib/pennyworth/presenters/system/signal.rb

@@ -3,7 +3,7 @@
 module Pennyworth
   module Presenters
     module System
-      # Renders strings into a compatible format for use in Alfred script filters.
+      # Shapes a system signal record for serialization.
       class Signal
         def initialize record
           @record = record

data/lib/pennyworth/presenters/text.rb

@@ -4,7 +4,7 @@ require "forwardable"
 
 module Pennyworth
   module Presenters
-    # Renders text into a compatible format for use in Alfred script filters.
+    # Shapes a text record for serialization.
     class Text
       extend Forwardable
 

data/lib/pennyworth/processor.rb

@@ -19,6 +19,10 @@ module Pennyworth
           serializer: Serializers::HTTPStatus
     end
 
+    def self.for_htmx
+      new loader: Loaders::HTMX.new, presenter: Presenters::HTMX, serializer: Serializers::HTMX
+    end
+
     def self.for_projects
       new loader: Loaders::GitHub.new,
           presenter: Presenters::Repository,

data/lib/pennyworth/serializers/encoding.rb

@@ -2,7 +2,7 @@
 
 module Pennyworth
   module Serializers
-    # Serializes a encoding into a compatible format for parsing within Alfred script filters.
+    # Serializes an encoding presenter for parsing by Alfred script filters.
     class Encoding
       using Refinements::Array
 

data/lib/pennyworth/serializers/htmx.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Serializers
+    # Serializes a htmx presenter for parsing by Alfred script filters.
+    class HTMX
+      def initialize presenter
+        @presenter = presenter
+      end
+
+      def to_h
+        {
+          uid: presenter.id,
+          title: presenter.label,
+          subtitle: presenter.description,
+          arg: site_url,
+          quicklookurl: site_url,
+          mods: modifications,
+          text:
+        }
+      end
+
+      private
+
+      attr_reader :presenter
+
+      def modifications
+        {
+          alt: modification(presenter.label, "Copy label."),
+          cmd: modification(presenter.description, "Copy description.")
+        }
+      end
+
+      def modification argument, subtitle
+        {
+          subtitle:,
+          arg: argument
+        }
+      end
+
+      def text
+        {
+          copy: site_url,
+          largetype: site_url
+        }
+      end
+
+      def site_url = presenter.uri
+    end
+  end
+end

data/lib/pennyworth/serializers/http_status.rb

@@ -2,7 +2,7 @@
 
 module Pennyworth
   module Serializers
-    # Serializes a HTTP status into a compatible format for parsing within Alfred script filters.
+    # Serializes a HTTP status presenter for parsing by Alfred script filters.
     class HTTPStatus
       def initialize presenter
         @presenter = presenter

data/lib/pennyworth/serializers/project.rb

@@ -2,7 +2,7 @@
 
 module Pennyworth
   module Serializers
-    # Serializes a project into a compatible format for parsing within Alfred script filters.
+    # Serializes a project presenter for parsing by Alfred script filters.
     class Project
       def initialize presenter
         @presenter = presenter

data/lib/pennyworth/serializers/standard_error.rb

@@ -2,7 +2,7 @@
 
 module Pennyworth
   module Serializers
-    # Serializes a standard error into a compatible format for parsing within Alfred script filters.
+    # Serializes a standard error presenter for parsing by Alfred script filters.
     class StandardError
       def initialize presenter
         @presenter = presenter

data/lib/pennyworth/serializers/system/error.rb

@@ -3,7 +3,7 @@
 module Pennyworth
   module Serializers
     module System
-      # Serializes a system error into a compatible format for parsing within Alfred script filters.
+      # Serializes a system error presenter for parsing by Alfred script filters.
       class Error
         def initialize presenter
           @presenter = presenter

data/lib/pennyworth/serializers/system/signal.rb

@@ -3,7 +3,7 @@
 module Pennyworth
   module Serializers
     module System
-      # Serializes a signal into a compatible format for parsing within Alfred script filters.
+      # Serializes a system signal presenter for parsing by Alfred script filters.
       class Signal
         def initialize presenter
           @presenter = presenter

data/lib/pennyworth/serializers/text.rb

@@ -2,7 +2,7 @@
 
 module Pennyworth
   module Serializers
-    # Serializes a text into a compatible format for parsing within Alfred script filters.
+    # Serializes a text presenter for parsing by Alfred script filters.
     class Text
       def initialize presenter
         @presenter = presenter

data/lib/pennyworth.rb

@@ -5,7 +5,8 @@ require "zeitwerk"
 Zeitwerk::Loader.new.then do |loader|
   loader.inflector.inflect "cli" => "CLI",
                            "http_status" => "HTTPStatus",
-                           "http_statuses" => "HTTPStatuses"
+                           "http_statuses" => "HTTPStatuses",
+                           "htmx" => "HTMX"
   loader.tag = File.basename __FILE__, ".rb"
   loader.push_dir __dir__
   loader.setup

data/pennyworth.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "pennyworth"
-  spec.version = "17.3.0"
+  spec.version = "17.4.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/pennyworth"
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ghub", "~> 0.11"
   spec.add_dependency "http", "~> 5.1"
   spec.add_dependency "infusible", "~> 3.8"
+  spec.add_dependency "ox", "~> 2.14"
   spec.add_dependency "rack", "~> 3.0"
   spec.add_dependency "refinements", "~> 12.8"
   spec.add_dependency "runcom", "~> 11.5"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pennyworth
 version: !ruby/object:Gem::Version
-  version: 17.3.0
+  version: 17.4.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2024-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -135,6 +135,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -237,6 +251,8 @@ files:
 - lib/pennyworth/cli/actions/gem.rb
 - lib/pennyworth/cli/actions/git_hub/organization.rb
 - lib/pennyworth/cli/actions/git_hub/user.rb
+- lib/pennyworth/cli/actions/htmx/example.rb
+- lib/pennyworth/cli/actions/htmx/reference.rb
 - lib/pennyworth/cli/actions/http_status.rb
 - lib/pennyworth/cli/actions/standard_error.rb
 - lib/pennyworth/cli/actions/standard_gem.rb
@@ -253,6 +269,7 @@ files:
 - lib/pennyworth/loaders/encoding.rb
 - lib/pennyworth/loaders/gem.rb
 - lib/pennyworth/loaders/git_hub.rb
+- lib/pennyworth/loaders/htmx.rb
 - lib/pennyworth/loaders/http_status.rb
 - lib/pennyworth/loaders/standard_error.rb
 - lib/pennyworth/loaders/standard_gem.rb
@@ -260,6 +277,7 @@ files:
 - lib/pennyworth/loaders/system/signal.rb
 - lib/pennyworth/loaders/text.rb
 - lib/pennyworth/models/encoding.rb
+- lib/pennyworth/models/htmx.rb
 - lib/pennyworth/models/http_status.rb
 - lib/pennyworth/models/standard_error.rb
 - lib/pennyworth/models/system/error.rb
@@ -267,6 +285,7 @@ files:
 - lib/pennyworth/models/text.rb
 - lib/pennyworth/presenters/encoding.rb
 - lib/pennyworth/presenters/gem.rb
+- lib/pennyworth/presenters/htmx.rb
 - lib/pennyworth/presenters/http_status.rb
 - lib/pennyworth/presenters/repository.rb
 - lib/pennyworth/presenters/standard_error.rb
@@ -276,6 +295,7 @@ files:
 - lib/pennyworth/presenters/text.rb
 - lib/pennyworth/processor.rb
 - lib/pennyworth/serializers/encoding.rb
+- lib/pennyworth/serializers/htmx.rb
 - lib/pennyworth/serializers/http_status.rb
 - lib/pennyworth/serializers/project.rb
 - lib/pennyworth/serializers/standard_error.rb
@@ -312,7 +332,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.19
 signing_key:
 specification_version: 4
 summary: A command line interface for augmented Alfred workflows.