pennyworth 17.4.1 → 17.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e145f2b67767dfb8c5d062c72afc8cb5ab8778d4e51622c4f78d654df96a8d0
-  data.tar.gz: cd34eb5c7fa9f3e8cca5f8d608fec04faeedece9549b2e24702b5cb1aabde7af
+  metadata.gz: 57f72591d386652cb83fa3f62752efeb51aa84572efc272c003522a0391f19f8
+  data.tar.gz: d2daeb58a7c16a181a5e57607d91610cb0ef9c0afe2acfbed6431c77ef5f9928
 SHA512:
-  metadata.gz: 81352f6b2797fb4c0bb1a59200a5b80e2fdea7a8550a367afeed1feeec3445479be33d9bb5e3866e5181a87860d31a92854558c35436e37cd1d79eb3fd95b989
-  data.tar.gz: 4a6ccfe6684c736c7d64b54be544bba1183bb5ce728975b6857f47e9ca0e7378ca9c9ab13039b708d102cd3584847f3b3f9904a3142f05804040f0d2b66726f8
+  metadata.gz: 4d92cf6fe764fde7201e5017031b532e84510856200d266cc911213da9a241f7c4bb7264ca95352197a102b815e72984b6a2657cdd9326ddda167faaac1db0f1
+  data.tar.gz: 6a38899be0b025d3786781b00d1e7b44d8d23e5dd33b5e8f545c7e2cecdcdc22794d7380c6fc09afa2f6c38dcd39b18004765be773d3b1c6961684518662b77f

data/README.adoc

@@ -4,7 +4,9 @@
 
 :alfred_link: link:https://www.alfredapp.com[Alfred]
 :bash_link: link:https://www.gnu.org/software/bash[Bash]
+:htmx_link: link:https://htmx.org[htmx]
 :ruby_link: link:https://www.ruby-lang.org[Ruby]
+:ruby_string_format_link: link:https://docs.ruby-lang.org/en/master/format_specifications_rdoc.html[String Format]
 :ruby_version_managers_link: link:https://alchemists.io/articles/ruby_version_managers[Ruby Version Manager]
 
 = Pennyworth
@@ -181,8 +183,10 @@ http:
   statuses:
     url: "https://developer.mozilla.org/docs/Web/HTTP/Status"
 htmx:
-  examples_uri: "https://htmx.org/examples"
-  references_uri: "https://htmx.org/reference"
+  examples_uri: "%<htmx_site_uri>s/examples"
+  extensions_uri: "%<htmx_site_uri>s/extensions"
+  references_uri: "%<htmx_site_uri>s/reference"
+  site_uri: "https://htmx.org"
 ruby_gems:
   api_url: "https://rubygems.org/api/v1"
 standard_gems:
@@ -192,6 +196,8 @@ standard_gems:
 Feel free to take this default configuration, modify, and save as your own custom
 `configuration.yml`.
 
+For {htmx_link}, the Ruby {ruby_string_format_link} specification is used which means you can define the `site_uri` once and have it automatically resolved in all URIs that reference it. Otherwise, you can use literal URIs if desired.
+
 === Themes
 
 image:https://alchemists.io/images/projects/pennyworth/screenshots/alchemists-theme.png[Alchemists Theme,width=706,height=632,role=focal_point]
@@ -258,7 +264,7 @@ Provides quick access to link:https://dry-rb.org[Dry RB] resources.
 
 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 {htmx_link} JavaScript library.
 
 1. link:https://alchemists.io/public/alfred/workflows/htmx.alfredworkflow[Download] and
    double click to install.
@@ -648,7 +654,7 @@ bin/console
 
 The following documents the workflow used to process all actions from Alfred.
 
-image::https://alchemists.io/images/projects/pennyworth/doc/architecture.svg[Architecture Diagram]
+image::https://alchemists.io/images/projects/pennyworth/doc/architecture.png[Architecture Diagram,width=1265,height=2377,role=focal_point]
 
 == Tests
 

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

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

data/lib/pennyworth/cli/shell.rb

@@ -33,6 +33,7 @@ module Pennyworth
 
           on "htmx", "Render htmx script filters" do
             on Actions::HTMX::Example
+            on Actions::HTMX::Extension
             on Actions::HTMX::Reference
           end
 

data/lib/pennyworth/configuration/contract.rb

@@ -14,7 +14,9 @@ module Pennyworth
       optional(:git_hub_user).filled :string
       required(:http_statuses_url).filled :string
       required(:htmx_examples_uri).filled :string
+      required(:htmx_extensions_uri).filled :string
       required(:htmx_references_uri).filled :string
+      required(:htmx_site_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

@@ -77,8 +77,10 @@ http:
   statuses:
     url: "https://developer.mozilla.org/docs/Web/HTTP/Status"
 htmx:
-  examples_uri: "https://htmx.org/examples"
-  references_uri: "https://htmx.org/reference"
+  examples_uri: "%<htmx_site_uri>s/examples"
+  extensions_uri: "%<htmx_site_uri>s/extensions"
+  references_uri: "%<htmx_site_uri>s/reference"
+  site_uri: "https://htmx.org"
 ruby_gems:
   api_url: "https://rubygems.org/api/v1"
 standard_gems:

data/lib/pennyworth/configuration/model.rb

@@ -10,7 +10,9 @@ module Pennyworth
                        :git_hub_user,
                        :http_statuses_url,
                        :htmx_examples_uri,
+                       :htmx_extensions_uri,
                        :htmx_references_uri,
+                       :htmx_site_uri,
                        :ruby_gems_api_url,
                        :ruby_gems_owner,
                        :standard_gems_api_url

data/lib/pennyworth/container.rb

@@ -16,6 +16,9 @@ module Pennyworth
       Etcher::Registry.new(contract: Configuration::Contract, model: Configuration::Model)
                       .add_loader(:yaml, self[:defaults_path])
                       .add_loader(:yaml, self[:xdg_config].active)
+                      .add_transformer(:format, :htmx_examples_uri)
+                      .add_transformer(:format, :htmx_extensions_uri)
+                      .add_transformer(:format, :htmx_references_uri)
     end
 
     register(:settings) { Etcher.call(self[:registry]).dup }

data/lib/pennyworth/loaders/htmx.rb

@@ -8,7 +8,7 @@ module Pennyworth
   module Loaders
     # Loads htmx documentation by scraping web page.
     class HTMX
-      include Import[:http]
+      include Import[:http, :settings]
 
       using Refinements::String
 
@@ -54,7 +54,7 @@ module Pennyworth
         model[
           label: (item.locate("*/code").first || item.locate("a").first).text,
           description: "#{self.class.text_for description}.",
-          uri: item.locate("*/@href").first || uri
+          uri: (item.locate("*/@href").first || uri).sub(%r(\A(?=/)), settings.htmx_site_uri)
         ]
       end
     end

data/pennyworth.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "pennyworth"
-  spec.version = "17.4.1"
+  spec.version = "17.5.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/pennyworth"
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   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 "refinements", "~> 12.9"
   spec.add_dependency "runcom", "~> 11.5"
   spec.add_dependency "sod", "~> 0.14"
   spec.add_dependency "spek", "~> 3.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pennyworth
 version: !ruby/object:Gem::Version
-  version: 17.4.1
+  version: 17.5.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-25 00:00:00.000000000 Z
+date: 2024-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -169,14 +169,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.8'
+        version: '12.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.8'
+        version: '12.9'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
@@ -252,6 +252,7 @@ files:
 - 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/extension.rb
 - lib/pennyworth/cli/actions/htmx/reference.rb
 - lib/pennyworth/cli/actions/http_status.rb
 - lib/pennyworth/cli/actions/standard_error.rb
@@ -332,7 +333,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: A command line interface for augmented Alfred workflows.