rack-unpoly 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '098a6137f012df7a85d6e681805d1051c39cd929'
-  data.tar.gz: 0d89558009d7382033b662c29b7db77888116d01
+SHA256:
+  metadata.gz: b1d00fdd137f06a92af615b824a865a04a2537727b20b08ab297668c2470897f
+  data.tar.gz: 2858a34eea2cfdf57f3bd222fe060727555bc64afde20b8a0e4c738911f4e1dd
 SHA512:
-  metadata.gz: 74e384be3125a6c1261d82af9e14f600a4f7622d3a2e36d960f3b27a82b326c342abe87c3c183d78acc522245632a29517c3ef2e062ccab67b1ad9a274796deb
-  data.tar.gz: 66aad412ab1a9cef65fdfb356df68f851efb3a1477433ce65945fd5e2caa80a51f24bac5adb01fd675e90f1b4a4666981d3447d0f4c6f1081cbf11257bf6ca02
+  metadata.gz: 2aa9bb0072d7b35c8b457a4416c9e270ed55ee84ee88f04562f6d7746cec2ef681935ad61f63a6b7cfbdfd1a3ae12c3acaf369462d4675ed7210a1e4233d2a28
+  data.tar.gz: 5fe455a5a6db850ecf4bb8d2d00b48f2b16d115020f17b5991e87d9b37f46cc42dc9b6b6b828a33416c242c7dae47f3658402cb6c8032f2fe82a287ba30e9339

data/README.md

@@ -51,7 +51,15 @@ require "rack/unpoly/middleware"
 
 use Rack::Unpoly::Middleware
 
-run ->(env) { [200, {}, ["Hello World"]] }
+app = ->(env) {
+  if env["rack.unpoly"].up?
+    [200, {}, ["Unpoly request!"]]
+  else
+    [200, {}, ["Not Unpoly :("]]
+  end
+}
+
+run app
 ```
 
 ## Where are the Javascript and CSS assets?

data/Rakefile

@@ -1,12 +1,9 @@
-require "rake/testtask"
+require "minitest/test_task"
 require "rdoc/task"
 require "rubygems/tasks"
+require "standard/rake"
 
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList["test/test*.rb"]
-  t.verbose = true
-end
+Minitest::TestTask.create
 
 RDoc::Task.new do |rdoc|
   rdoc.main = "README.md"

data/lib/rack/unpoly/inspector.rb

@@ -1,8 +1,9 @@
 # frozen-string-literal: true
+
 require "forwardable"
 
-module Rack # :nodoc:
-  module Unpoly # :nodoc:
+module Rack
+  module Unpoly
     # Easily inspect the Unpoly environment of the current request.
     # Inspectors are not normally instantiated by users, but accessed
     # through +env["rack.unpoly"]+ or one of the convenience wrappers
@@ -10,71 +11,97 @@ module Rack # :nodoc:
     class Inspector
       extend Forwardable
 
-      def_delegators :request, :get_header # :nodoc:
+      # @api private
+      def_delegators :request, :get_header
 
-      attr_reader :request # :nodoc:
+      attr_reader :request
+      private :request
 
-      def initialize(request) # :nodoc:
+      # @api private
+      def initialize(request)
         @request = request
       end
 
       # Determine if this is an Unpoly request.
+      # @return [Boolean]
       def unpoly?
         target.to_s.strip != ""
       end
-      alias up? unpoly?
+      alias_method :up?, :unpoly?
 
       # Identify if the +tested_target+ will match the actual target requested.
+      #
+      # @param tested_target [String]
+      # @return [Boolean]
       def target?(tested_target)
         query_target(target, tested_target)
       end
 
       # The actual target as requested by Unpoly.
+      #
+      # @return [String, nil]
       def target
         get_header("HTTP_X_UP_TARGET")
       end
 
       # The CSS selector for the fragment Unpoly will update if the request fails.
       # Requires Unpoly >= 0.50
+      #
+      # @return [String, nil]
       def fail_target
         get_header("HTTP_X_UP_FAIL_TARGET")
       end
 
-      # Determine if the provided target is the current target for a failed request.
+      # Determine if the +tested_target+ is the current target for a failed request.
       # Requires Unpoly >= 0.50
+      #
+      # @return [Boolean]
       def fail_target?(tested_target)
         query_target(fail_target, tested_target)
       end
 
-      # Determine if the provided target is the current target for a successful or failed request.
+      # Determine if the +tested_target+ is the current target for a successful or failed request.
+      #
+      # @return [Boolean]
       def any_target?(tested_target)
         target?(tested_target) || fail_target?(tested_target)
       end
 
       # Set the page title.
+      #
+      # @param response [Rack::Response]
+      # @param new_title [String]
+      #   the title to set
       def set_title(response, new_title)
         response.headers["X-Up-Title"] = new_title
       end
 
       # Determine if this is a validate request.
+      #
+      # @return [Boolean]
       def validate?
         validate_name.to_s.strip != ""
       end
 
       # The name attribute of the form field that triggered
       # the validation.
+      #
+      # @return [String, nil]
       def validate_name
         get_header("HTTP_X_UP_VALIDATE")
       end
 
-      def query_target(actual_target, tested_target) # :nodoc:
+      # @api private
+      # @param actual_target [String]
+      # @param tested_target [String]
+      def query_target(actual_target, tested_target)
         if up?
           if actual_target == tested_target
             true
           elsif actual_target == "html"
             true
           elsif actual_target == "body"
-            !%w(head title meta).include?(tested_target)
+            !%w[head title meta].include?(tested_target)
           else
             false
           end

data/lib/rack/unpoly/middleware.rb

@@ -1,7 +1,8 @@
 # frozen-string-literal: true
+
 require_relative "inspector"
 
-module Rack # :nodoc:
+module Rack
   module Unpoly
     # Rack Middleware that implements the server protocol expected by Unpoly,
     # and provides an entry point into the Rack::Unpoly::Inspector for the current
@@ -23,11 +24,13 @@ module Rack # :nodoc:
     #
     #   run ->(env) { [200, {}, ["Hello World"]] }
     class Middleware
-      def initialize(app) # :nodoc:
+      # @api private
+      def initialize(app)
         @app = app
       end
 
-      def call(env) # :nodoc:
+      # @api private
+      def call(env)
         request = Rack::Request.new(env)
         env["rack.unpoly"] = Inspector.new(request)
 
@@ -41,15 +44,16 @@ module Rack # :nodoc:
 
       # Implement the *Unpoly* server protocol.
       # Used internally by the middleware. Not required for normal use.
+      # @api private
       def setup_protocol(request, headers)
-        headers["X-Up-Location"] = request.url
-        headers["X-Up-Method"] = request.request_method
+        headers["x-up-method"] = request.request_method
 
         if !request.get? && !request.env["rack.unpoly"].unpoly?
-          Rack::Utils.set_cookie_header!(headers, "_up_method",
-                                         { value: request.request_method, path: "/" })
+          Rack::Utils.set_cookie_header!(
+            headers, "_up_method", {value: request.request_method, path: "/"}
+          )
         else
-          Rack::Utils.delete_cookie_header!(headers, "_up_method", { path: "/" })
+          Rack::Utils.delete_cookie_header!(headers, "_up_method", {path: "/"})
         end
       end
     end

data/lib/rack/unpoly/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Unpoly
+    VERSION = "0.5.0"
+  end
+end

data/lib/rack/unpoly.rb

@@ -1,8 +1,10 @@
 # frozen-string-literal: true
+
+require_relative "unpoly/version"
 require_relative "unpoly/middleware"
 require_relative "unpoly/inspector"
 
-module Rack # :nodoc:
-  module Unpoly # :nodoc:
+module Rack
+  module Unpoly
   end
 end

data/lib/sinatra/unpoly.rb

@@ -1,8 +1,9 @@
 # frozen-string-literal: true
+
 require "rack/unpoly/middleware"
 require "delegate"
 
-module Sinatra # :nodoc:
+module Sinatra
   # The Unpoly extension for Sinatra provides a little bit of sugar to make
   # Unpoly work seamlessly with Roda.
   #
@@ -26,34 +27,43 @@ module Sinatra # :nodoc:
   #
   module Unpoly
     class SinatraInspector < DelegateClass(Rack::Unpoly::Inspector)
-      attr_accessor :response # :nodoc:
-
-      def initialize(obj, response) # :nodoc:
+      # @api private
+      def initialize(obj, response)
         super(obj)
         @response = response
       end
 
       # Set the page title.
+      # @param value [String]
       def title=(value)
         set_title(response, value)
       end
+
+      private
+
+      # @api private
+      attr_reader :response
     end
 
     module Helpers
-      # The ::Rack::Unpoly inspector for this request.
+      # The inspector for this request.
+      # @see Rack::Unpoly::Inspector
+      # @return [Rack::Unpoly::Inspector]
       def unpoly
         SinatraInspector.new(env["rack.unpoly"], response)
       end
-      alias up unpoly
+      alias_method :up, :unpoly
 
       # Determine if this is an Unpoly request.
+      # @return [Boolean]
       def unpoly?
         unpoly.unpoly?
       end
-      alias up? unpoly?
+      alias_method :up?, :unpoly?
     end
 
-    def self.registered(app) # :nodoc:
+    # @api private
+    def self.registered(app)
       app.use Rack::Unpoly::Middleware
       app.helpers Unpoly::Helpers
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-unpoly
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Adam Daniels
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -19,7 +19,7 @@ dependencies:
         version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -92,15 +92,29 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
-description: 
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+description:
 email: adam@mediadrive.ca
 executables: []
 extensions: []
@@ -111,12 +125,13 @@ files:
 - lib/rack/unpoly.rb
 - lib/rack/unpoly/inspector.rb
 - lib/rack/unpoly/middleware.rb
+- lib/rack/unpoly/version.rb
 - lib/sinatra/unpoly.rb
 homepage: https://github.com/adam12/rack-unpoly
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -131,9 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.5.5
+signing_key:
 specification_version: 4
 summary: Integrate Unpoly with any Rack or Sinatra application
 test_files: []