htmx 3.3.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28115f83adf78c0ed1bbe634ab80d285859757595507610b5f39b10cd5280e9d
-  data.tar.gz: 3e53ba954560c33e2067871cac00e9bbda41448f4f0fee881dc83309498fbeb6
+  metadata.gz: 50c33b7b7ca6ae9489a2eb63351895fdc864cf05781a414ac73cfdb68e31f0ce
+  data.tar.gz: 46cebdcd6a7b3aa2d49579d1c9f7265ea58e61eff0deb8cf0543a32bc81cb826
 SHA512:
-  metadata.gz: 541aa7f34eb8d3c213d389f51393f584ee5f4ac0a91f7e2dd23a95c6789fbef69353533eb55c655b55d4175d69ad05a0a76f994322f18eda890906134ff20fe0
-  data.tar.gz: 5c45ef55e4f449829676084bba0d0439dfa94db341f071fec883ac8490c9f662694e3d594287a9b20acde820075bfa65858d8b584bed2acd9fc26d9a8ed81e3b
+  metadata.gz: 92b3738d23693abea58cfaf2bda24de25a2a6d4665de3d704b9d1b6a602a0a21847a1d4b66d35af78b0c6c1f958a72dd3f7459cccdbd9ff4cdb415fb95b8c828
+  data.tar.gz: 6756800fe20f0bbdc67897108e11e5ce43c65830d07f8fa6ecbae315446445cdbf3ef21a1a41f3e9fa6c00f31c314dc26e972cf44a44543c4875cf4da5ac83ee

data/README.adoc

@@ -3,12 +3,8 @@
 :figure-caption!:
 
 :data_link: link:https://alchemists.io/articles/ruby_data[Data]
-:hanami_link: link:https://hanamirb.org[Hanami]
-:hanami_views_link: link:https://alchemists.io/articles/hanami_views[Hanami Views]
-:hanamismith_link: link:https://alchemists.io/projects/hanamismith[Hanamismith]
-:htmx_link: link:https://htmx.org[htmx]
+:htmx_link: link:https://four.htmx.org[htmx]
 :hypermedia_systems_link: link:https://hypermedia.systems[Hypermedia Systems]
-:roda_link: link:http://roda.jeremyevans.net[Roda]
 
 = HTMX
 
@@ -26,18 +22,15 @@ ____
 The goal of [htmx] is not less JavaScript, but less code, more readable and hypermedia-friendly code.
 ____
 
-
 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!
 
-💡 This is used with the {hanamismith_link} gem when building {hanami_link} applications.
-
 toc::[]
 
 == Features
 
 - Augments the {htmx_link} JavaScript library.
-- Speeds up {htmx_link} development.
-- Compatible with {hanami_link}, {roda_link}, and other web frameworks.
+- Enhances {htmx_link} development.
+- Compatible with any web framework.
 
 == Requirements
 
@@ -79,73 +72,50 @@ require "htmx"
 
 == Usage
 
-One of the first tasks to tackle, when working with the {htmx_link} library, is building htmx specific HTML attributes. This can be accomplished by using the `.[]` method. For example, when implementing a {hanami_views_link} part, you could use the following:
+One of the first tasks, when working with the {htmx_link} library, is building htmx specific HTML attributes. This can be accomplished by using the `.[]` method. Example:
 
 [source,ruby]
 ----
-tag.button(
-  "Delete",
-  class: "button decline",
-  type: "submit",
-  **HTMX[target: "closest .task", delete: "/tasks/#{value.id}"]
-)
-----
+HTMX[target: "closest .task", delete: "/tasks/1"]
 
-The above would produce the following:
-
-[source,html]
-----
-<button class="button decline" type="submit" hx-target="closest .task" hx-delete="/tasks/1">
-  Delete
-</button>
+# {
+#   "data-hx-target" => "closest .task",
+#   "data-hx-delete" => "/tasks/1"
+# }
 ----
 
-Notice the appropriate htmx `hx-target` and `hx-delete` attributes are built which are compatible with the {htmx_link} library while not having to manually prefix each one of these attributes with the `hx-` prefix. You can use symbols, strings, or a mix of both as well.
+Notice the appropriate htmx `+data-hx*+` attributes are built which are compatible with the {htmx_link} library while not having to manually prefix each one of these attributes with the `hx-data-` prefix. You can use symbols, strings, or a mix of both as well.
 
 === HTML Attribute Prefixes
 
-As shown above, building htmx attributes takes minimal effort but if you'd prefer the HTML `data-` prefix, which the {htmx_link} library supports, you can customize by using the following:
+As shown above, building htmx attributes takes minimal effort but if you'd prefer to only use the HTML `hx-` prefix, which the {htmx_link} library supports, you can customize by using the following:
 
 [source,ruby]
 ----
-prefixer = HTMX::Prefixer.new "data-hx"
-
-tag.button(
-  "Delete",
-  class: "button decline",
-  type: "submit",
-  **prefixer.call(target: "closest .task", delete: "/tasks/#{value.id}")
-)
-----
-
-This will produce the following HTML code:
+prefixer = HTMX::Prefixer.new "hx"
+prefixer.call(target: "closest .task", delete: "/tasks/1")
 
-[source,html]
-----
-<button class="button decline"
-        type="submit"
-        data-hx-target="closest .task"
-        data-hx-delete="/tasks/1"
->
-  Delete
-</button>
+# {
+#   "hx-target" => "closest .task",
+#   "hx-delete" => "/tasks/1"
+# }
 ----
 
-As you can see, the `data-hx-target` and `data-hx-delete` keys are used. These are definitely more verbose than the `hx-` keys. By the way, the `HTMX::Prefixer` is called when using the htmx `.[]` as shown earlier. This means the following are equivalent:
+As you can see, only `+hx-*+` keys are produced. By the way, the `HTMX::Prefixer` is called when using the htmx `.[]` as shown earlier. This means the following are equivalent:
 
 [source,ruby]
 ----
 HTMX[delete: "/tasks/1"]
 HTMX::Prefixer.new.call delete: "/tasks/1"
-HTMX::Prefixer.new("hx").call delete: "/tasks/1"
+HTMX::Prefixer.new("data-hx").call delete: "/tasks/1"
 ----
 
 All three of the above will produce the same output which means you'll most likely want to use the `.[]` method since it has the shortest syntax. If you attempt to use an unsupported prefix, you'll get an error:
 
 [source,ruby]
 ----
-HTMX::Prefixer.new "bogus"
-# Invalid prefix: "bogus". Use: "hx" or "data-hx". (HTMX::Error)
+HTMX::Prefixer.new :bogus
+# Invalid prefix: :bogus. Use: "hx" or "data-hx". (HTMX::Error)
 ----
 
 Some {htmx_link} attributes use dashes. For those situations, you can use strings for keys or underscored symbols to produce the correct htmx syntax. Here's an example using both a string and symbol for keys:
@@ -153,7 +123,11 @@ Some {htmx_link} attributes use dashes. For those situations, you can use string
 [source,ruby]
 ----
 HTMX["swap-oob" => true, push_url: "/demo/123"]
-# {"hx-swap-oob"=>true, "hx-push-url"=>"/demo/123"}
+
+# {
+#   "data-hx-swap-oob" => true,
+#   "data-hx-push-url" => "/demo/123"
+# }
 ----
 
 === HTTP Headers
@@ -168,14 +142,14 @@ The request object allows you to obtain a {data_link} object to interact with wh
 ----
 HTMX.request
 
-# <data HTMX::Headers::Request boosted=nil,
-#                              current_url=nil,
-#                              history_restore_request=nil,
-#                              prompt=nil,
-#                              request=nil,
-#                              target=nil,
-#                              trigger_name=nil,
-#                              trigger=nil
+# #<data HTMX::Headers::Request:0x00000a10
+#   boosted = nil,
+#   current_url = nil,
+#   history_restore_request = nil,
+#   request = nil,
+#   request_type = nil,
+#   source = nil,
+#   target = nil
 # >
 ----
 
@@ -186,20 +160,19 @@ Notice you get a {data_link} instance where all members have the `HX-` prefix re
 HTMX.request "HTTP_HX_BOOSTED" => "true",
              "HTTP_HX_CURRENT_URL" => "/demo",
              "HTTP_HX_HISTORY_RESTORE_REQUEST" => "false",
-             "HTTP_HX_PROMPT" => "Yes",
              "HTTP_HX_REQUEST" => "true",
-             "HTTP_HX_TARGET" => "demo",
-             "HTTP_HX_TRIGGER_NAME" => "save",
+             "HTTP_HX_REQUEST_TYPE" => "partial",
+             "HTTP_HX_SOURCE" => "button",
              "HTTP_HX_TRIGGER" => "demo"
 
-# <data HTMX::Headers::Request boosted="true",
-#                              current_url="/demo",
-#                              history_restore_request="false",
-#                              prompt="Yes",
-#                              request="true",
-#                              target="demo",
-#                              trigger_name="save",
-#                              trigger="demo"
+# #<data HTMX::Headers::Request:0x00000a80
+#   boosted = "true",
+#   current_url = "/demo",
+#   history_restore_request = "false",
+#   request = "true",
+#   request_type = "partial",
+#   source = "button",
+#   target = nil
 # >
 ----
 
@@ -212,21 +185,17 @@ As an added convenience, you can use predicate methods for boolean values. Examp
 headers = HTMX.request "HTTP_HX_BOOSTED" => "true",
                        "HTTP_HX_CURRENT_URL" => "/demo",
                        "HTTP_HX_HISTORY_RESTORE_REQUEST" => "false",
-                       "HTTP_HX_PROMPT" => "Yes",
                        "HTTP_HX_REQUEST" => "true",
-                       "HTTP_HX_TARGET" => "demo",
-                       "HTTP_HX_TRIGGER_NAME" => "save",
+                       "HTTP_HX_REQUEST_TYPE" => "partial",
+                       "HTTP_HX_SOURCE" => "button",
                        "HTTP_HX_TRIGGER" => "demo"
 
 headers.boosted?                  # true
-headers.confirmed?                # true
 headers.history_restore_request?  # false
 headers.request?                  # true
 ----
 
-Use of `#confirmed?` is the only unique predicate method since it answers a boolean based on the truthiness of the `HTTP_HX_PROMPT` header. For further details, see `String#truthy?` as provided by the link:https://alchemists.io/projects/refinements#_truthy[Refinements] gem.
-
-Due to `HTML.request` delegating to the `HTMX::Headers::Request`, this means you can use the object directly. Specifically, you can obtain the record, key, or header depending on your needs. Example:
+Due to the `HTML.request` delegating to the `HTMX::Headers::Request`, this means you can use the object directly. Specifically, you can obtain the record, key, or header depending on your needs. Example:
 
 [source,ruby]
 ----
@@ -241,14 +210,14 @@ Should you not want to use `HTMX::Headers::Request`, you can use the request pre
 ----
 headers = {}
 
-HTMX.request! headers, boosted: true, prompt: "Yes"
-# {"HTTP_HX_BOOSTED" => true, "HTTP_HX_PROMPT" => "Yes"}
-
-HTMX.request? headers, :prompt, "Yes"  # true
-HTMX.request? headers, :prompt, "On"   # false
+HTMX.request! headers, boosted: true, source: "button"
+# {
+#   "HTTP_HX_BOOSTED" => true,
+#   "HTTP_HX_SOURCE" => "button"
+# }
 ----
 
-💡 `HTMX.request!` is designed to mutate your original headers. Unknown attributes are merged as is.
+💡 `HTMX.request!` mutates your original headers. Unknown attributes are merged as is.
 
 ==== Responses
 
@@ -258,16 +227,16 @@ The response object allows you to obtain a {data_link} object to interact with w
 ----
 HTMX.response
 
-# <data HTMX::Headers::Response location=nil,
-#                               push_url=nil,
-#                               redirect=nil,
-#                               refresh=nil,
-#                               replace_url=nil,
-#                               reswap=nil,
-#                               retarget=nil,
-#                               trigger=nil,
-#                               trigger_after_settle=nil,
-#                               trigger_after_swap=nil
+# #<data HTMX::Headers::Response:0x00001830
+#   location = nil,
+#   push_url = nil,
+#   redirect = nil,
+#   refresh = nil,
+#   replace_url = nil,
+#   reselect = nil,
+#   reswap = nil,
+#   retarget = nil,
+#   trigger = nil
 # >
 ----
 
@@ -280,22 +249,21 @@ HTMX.response "HX-Location" => "/",
               "HX-Redirect" => "/demo",
               "HX-Refresh" => "true",
               "HX-Replace-Url" => "/demo",
+              "HX-Reselect" => "#demo",
               "HX-Reswap" => "none",
               "HX-Retarget" => ".demo",
-              "HX-Trigger" => "demo",
-              "HX-Trigger-After-Settle" => "demo",
-              "HX-Trigger-After-Swap" => "demo"
-
-# <data HTMX::Headers::Response location="/",
-#                               push_url="/demo",
-#                               redirect="/demo",
-#                               refresh="true",
-#                               replace_url="/demo",
-#                               reswap="none",
-#                               retarget=".demo",
-#                               trigger="demo",
-#                               trigger_after_settle="demo",
-#                               trigger_after_swap="demo"
+              "HX-Trigger" => "demo"
+
+# #<data HTMX::Headers::Response:0x00001850
+#   location = "/",
+#   push_url = "/demo",
+#   redirect = "/demo",
+#   refresh = "true",
+#   replace_url = "/demo",
+#   reselect = "#demo",
+#   reswap = "none",
+#   retarget = ".demo",
+#   trigger = "demo"
 # >
 ----
 
@@ -325,14 +293,17 @@ Should you not want to use `HTMX::Headers::Response`, you can use the response p
 ----
 headers = {}
 
-HTMX.response! headers, location: "/", push_url: "/test"
-# {"HX-Location" => "/", "HX-Push-Url" => "/test"}
+HTMX.response! headers, location: "/", push_url: "/demo"
+# {
+#   "HX-Location" => "/",
+#   "HX-Push-Url" => "/demo"
+# }
 
-HTMX.response? headers, :push_url, "/test"   # true
+HTMX.response? headers, :push_url, "/demo"   # true
 HTMX.response? headers, :push_url, "/other"  # false
 ----
 
-💡 `HTMX.response!` is designed to mutate your original headers. Unknown attributes are merged as is.
+💡 `HTMX.response!` mutates your original headers. Unknown attributes are merged as is.
 
 === Errors
 

data/htmx.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "htmx"
-  spec.version = "3.3.0"
+  spec.version = "4.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/htmx"

data/lib/htmx/headers/request.rb

@@ -19,18 +19,15 @@ module HTMX
       def initialize boosted: nil,
                      current_url: nil,
                      history_restore_request: nil,
-                     prompt: nil,
                      request: nil,
-                     target: nil,
-                     trigger_name: nil,
-                     trigger: nil
+                     request_type: nil,
+                     source: nil,
+                     target: nil
         super
       end
 
       def boosted? = boosted == "true"
 
-      def confirmed? = prompt ? prompt.truthy? : false
-
       def history_restore_request? = history_restore_request == "true"
 
       def request? = request == "true"

data/lib/htmx/headers/response.rb

@@ -17,11 +17,10 @@ module HTMX
                      redirect: nil,
                      refresh: nil,
                      replace_url: nil,
+                     reselect: nil,
                      reswap: nil,
                      retarget: nil,
-                     trigger: nil,
-                     trigger_after_settle: nil,
-                     trigger_after_swap: nil
+                     trigger: nil
         super
       end
 

data/lib/htmx/prefixer.rb

@@ -9,7 +9,7 @@ module HTMX
 
     ALLOWED = %w[hx data-hx].freeze
 
-    def initialize default = "hx", allowed: ALLOWED
+    def initialize default = "data-hx", allowed: ALLOWED
       @default = default
       @allowed = allowed
       validate

data/lib/htmx.rb

@@ -15,11 +15,10 @@ module HTMX
     boosted: "HTTP_HX_BOOSTED",
     current_url: "HTTP_HX_CURRENT_URL",
     history_restore_request: "HTTP_HX_HISTORY_RESTORE_REQUEST",
-    prompt: "HTTP_HX_PROMPT",
     request: "HTTP_HX_REQUEST",
-    target: "HTTP_HX_TARGET",
-    trigger_name: "HTTP_HX_TRIGGER_NAME",
-    trigger: "HTTP_HX_TRIGGER"
+    request_type: "HTTP_HX_REQUEST_TYPE",
+    source: "HTTP_HX_SOURCE",
+    target: "HTTP_HX_TARGET"
   }.freeze
 
   RESPONSE_MAP = {
@@ -28,11 +27,10 @@ module HTMX
     redirect: "HX-Redirect",
     refresh: "HX-Refresh",
     replace_url: "HX-Replace-Url",
+    reselect: "HX-Reselect",
     reswap: "HX-Reswap",
     retarget: "HX-Retarget",
-    trigger: "HX-Trigger",
-    trigger_after_settle: "HX-Trigger-After-Settle",
-    trigger_after_swap: "HX-Trigger-After-Swap"
+    trigger: "HX-Trigger"
   }.freeze
 
   def self.loader registry = Zeitwerk::Registry

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: htmx
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.15
+rubygems_version: 4.0.20
 specification_version: 4
 summary: An augmenter and companion to the HTMX JavaScript library.
 test_files: []