htmx 0.0.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 383f09f05abca1f2fe9ec5344642b5df7186fe0a20897bb349300c836020b3e5
-  data.tar.gz: 933f33aa31997a1c23c96d78cc0a99a32f460260c78bcd555b0af6bfe887d485
+  metadata.gz: 43e9bb667215224c821dacc90e470dc7d7cff8763db175976e8f50a4914d9ff0
+  data.tar.gz: 87bcf2eda837ccde944a18824f2f8268f2d1688999ae2b50136daec486fb72a4
 SHA512:
-  metadata.gz: d01fe0fe6ff1424c22179559bd17d188718f0c4edb2e96d43b7c6acaa5beb7dc750ecfac2a95cefcd46b0bc24e4af786470d05a49c93095ed6a1b87e9bdf2bd0
-  data.tar.gz: 92e7dc0c6b33e262b50ec602e1285d888123cc194c68331584ff64d6d9d5f88457f1b9210c6d183e097e3b468c110ba13c6b30c49c561cabaf0b55e894247d7a
+  metadata.gz: 96f0e5a903c20d736a57a001351e020277ad988bd7fe08277994f1d0708a2765accd3a6e642e74bcd63905f36f1bfc01e12a90072151f67544ae8aa2c78a5407
+  data.tar.gz: 110d7c8385ab152d67f2639d51c27f5c9e5bd3bbd72384e35cc191771c5574ebf195d5135852b6e0ff79048e9d35ccf35b04326e31ca7c19249f1bc1e7f40839

data/README.adoc

@@ -13,11 +13,11 @@
 
 A haiku from the {htmx_link} team:
 
-____
+....
 javascript fatigue:
 longing for a hypertext
 already in hand
-____
+....
 
 ...and from {hypermedia_systems_link}:
 
@@ -26,7 +26,7 @@ The goal of [HTMX] is not less JavaScript, but less code, more readable and hype
 ____
 
 
-This gem provides native Ruby support for the {htmx_link} JavaScript library so you can build sophisticated web applications using pure Hypermedia REST APIs while avoiding the unnecessary bloat and complexity common with JavaScript frameworks by building upon the original foundations of Hypermedia REST APIs. Even better, you can build rich web applications with no additional JavaScript!
+This gem provides native Ruby support for the {htmx_link} JavaScript library so you can build sophisticated web applications using pure Hypermedia REST APIs while avoiding unnecessary bloat and complexity common with the JavaScript ecosystem. By building upon the original foundations of Hypermedia REST APIs, you can build rich web applications with no additional JavaScript!
 
 At the moment, the functionality of this gem is still in the early stages of development but the goal of this gem is to aid with the development of {htmx_link} applications.
 
@@ -42,8 +42,8 @@ toc::[]
 
 == Requirements
 
+. A strong understanding of {hypermedia_systems_link}.
 . {htmx_link}.
-. A strong understanding of {hypermedia_systems_link} and Hypermedia REST APIs in general.
 . link:https://www.ruby-lang.org[Ruby].
 
 == Setup
@@ -161,7 +161,7 @@ The request object allows you to obtain an immutable {data_link} object to inter
 
 [source,ruby]
 ----
-request = HTMX::Headers::Request.new
+HTMX::Headers::Request.new
 
 # <data HTMX::Headers::Request boosted=nil,
 #                              current_url=nil,
@@ -178,7 +178,7 @@ Notice you get a {data_link} instance where all members have the `HX-` prefix re
 
 [source,ruby]
 ----
-request = HTMX::Headers::Request.for request.headers
+HTMX::Headers::Request.for request.env
 
 # <data HTMX::Headers::Request boosted="true",
 #                              current_url="/demo",
@@ -199,7 +199,7 @@ The response object allows you to obtain an immutable {data_link} object to inte
 
 [source,ruby]
 ----
-response = HTMX::Headers::Response.new
+HTMX::Headers::Response.new
 
 # <data HTMX::Headers::Response location=nil,
 #                               push_url=nil,
@@ -218,7 +218,7 @@ Notice you get a {data_link} instance where all members have the `HX-` prefix re
 
 [source,ruby]
 ----
-response = HTMX::Headers::Response.for response.headers
+HTMX::Headers::Response.for response.headers
 
 # <data HTMX::Headers::Response location="/",
 #                               push_url="/demo",
@@ -235,6 +235,10 @@ response = HTMX::Headers::Response.for response.headers
 
 With the above, the `.for` method plucks out only the HTMX specific headers which may or may not have values. Extra header keys, which are not specific to {htmx_link}, are ignored.
 
+=== Errors
+
+As you've probably picked up by now, any/all errors issued by this gem will be an instance of the `HTMX::Error` class which inherits from `StandardError`. you can use this classification to catch and deal with these errors in your own implementation as desired.
+
 == Development
 
 To contribute, run:

data/htmx.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |spec|
   spec.name = "htmx"
-  spec.version = "0.0.0"
+  spec.version = "0.2.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/htmx"
-  spec.summary = "Augmenter, enhancer, and companion to the HTMX JavaScript library."
+  spec.summary = "An augmenter and companion to the HTMX JavaScript library."
   spec.license = "Hippocratic-2.1"
 
   spec.metadata = {
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.cert_chain = [Gem.default_cert_path]
 
   spec.required_ruby_version = "~> 3.2"
-  spec.add_dependency "refinements", "~> 10.0"
+  spec.add_dependency "refinements", "~> 11.0"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

data/lib/htmx/headers/request.rb

@@ -25,7 +25,7 @@ module HTMX
       :trigger
     ) do
       def self.for(key_map: REQUEST_KEY_MAP, **attributes)
-        new(**attributes.slice(*key_map.keys).transform_keys(key_map))
+        new(**attributes.slice(*key_map.keys).transform_keys!(key_map))
       end
 
       def initialize boosted: nil,

data/lib/htmx/headers/response.rb

@@ -29,7 +29,7 @@ module HTMX
       :trigger_after_swap
     ) do
       def self.for(key_map: RESPONSE_KEY_MAP, **attributes)
-        new(**attributes.slice(*key_map.keys).transform_keys(key_map))
+        new(**attributes.slice(*key_map.keys).transform_keys!(key_map))
       end
 
       def initialize location: nil,

data/lib/htmx/prefixer.rb

@@ -3,13 +3,13 @@
 require "refinements/arrays"
 
 module HTMX
-  # Prefixes HTML element attributes for proper consumption by HTMX JavaScript library.
+  # Prefixes HTML element attributes for proper consumption by the HTMX JavaScript library.
   class Prefixer
     using Refinements::Arrays
 
-    PREFIXES = %w[hx data-hx].freeze
+    ALLOWED = %w[hx data-hx].freeze
 
-    def initialize default = "hx", allowed: PREFIXES
+    def initialize default = "hx", allowed: ALLOWED
       @default = default
       @allowed = allowed
       validate
@@ -24,9 +24,7 @@ module HTMX
     def validate
       return true if allowed.include? default
 
-      usage = allowed.map(&:inspect).to_sentence conjunction: "or"
-
-      fail Error, "Invalid prefix: #{default.inspect}. Use: #{usage}."
+      fail Error, %(Invalid prefix: #{default.inspect}. Use: #{allowed.to_usage "or"}.)
     end
   end
 end

data/lib/htmx.rb

@@ -9,5 +9,8 @@ end
 
 # Main namespace.
 module HTMX
-  def self.[](...) = Prefixer.new.call(...)
+  def self.[](...)
+    @prefixer ||= Prefixer.new
+    @prefixer.call(...)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: htmx
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-05-20 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -43,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -108,8 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
-summary: Augmenter, enhancer, and companion to the HTMX JavaScript library.
+summary: An augmenter and companion to the HTMX JavaScript library.
 test_files: []