unpoly-rails 2.7.1 → 3.0.0.rc1

data/lib/unpoly/rails/change/cache.rb

@@ -9,11 +9,23 @@ module Unpoly
 
         # TODO: Docs
         def clear(pattern = '*')
-          change.clear_cache = pattern
+          ActiveSupport::Deprecation.warn("up.cache.clear is deprecated. Use up.cache.expire instead.")
+          expire(pattern)
+        end
+
+        # TODO: Docs
+        def expire(pattern = '*')
+          change.expire_cache = pattern
+        end
+
+        # TODO: Docs
+        def evict(pattern = '*')
+          change.evict_cache = pattern
         end
 
         def keep
-          clear(false)
+          ActiveSupport::Deprecation.warn("up.cache.keep is deprecated. Use up.cache.expire(false) instead.")
+          expire(false)
         end
 
         private

data/lib/unpoly/rails/change/field.rb

@@ -31,6 +31,8 @@ module Unpoly
           raise NotImplementedError
         end
 
+        ##
+        # A string value, serialized as itself.
         class String < Field
 
           def parse(raw)
@@ -38,46 +40,71 @@ module Unpoly
           end
 
           def stringify(value)
-            value.to_s
+            unless value.nil?
+              value.to_s
+            end
           end
 
         end
 
-        class Boolean < Field
+        ##
+        # An array of strings, serialized as JSON.
+        class SeparatedValues < Field
+
+          def initialize(name, separator: ' ', default: nil)
+            super(name)
+            @separator = separator
+            @default = default
+          end
 
           def parse(raw)
-            raw == 'true'
+            if raw
+              raw.split(@separator)
+            elsif @default
+              instance_exec(&@default)
+            end
           end
 
           def stringify(value)
-            value.to_json
+            unless value.nil?
+              value.join(@separator)
+            end
           end
 
         end
 
+        ##
+        # A date and time value, serialized as the number of seconds since the epoch.
         class Time < Field
 
           def parse(raw)
             if raw.present?
               ::Time.at(raw.to_i)
             end
-            end
+          end
 
           def stringify(value)
-            if value
+            unless value.nil?
               value.to_i
             end
           end
 
         end
 
+        ##
+        # A hash of values, serialized as JSON.
         class Hash < Field
 
+          def initialize(name, default: nil)
+            super(name)
+            @default = default
+          end
+
           def parse(raw)
             if raw.present?
               result = ActiveSupport::JSON.decode(raw)
-            else
-              result = {}
+            elsif @default
+              result = instance_exec(&@default)
             end
 
             if result.is_a?(::Hash)
@@ -88,25 +115,36 @@ module Unpoly
           end
 
           def stringify(value)
-            ActiveSupport::JSON.encode(value)
+            unless value.nil?
+              ActiveSupport::JSON.encode(value)
+            end
           end
 
         end
 
+        ##
+        # An array of values, serialized as JSON.
         class Array < Field
 
+          def initialize(name, default: nil)
+            super(name)
+            @default = default
+          end
+
           def parse(raw)
             if raw.present?
               result = ActiveSupport::JSON.decode(raw)
-            else
-              result = []
+            elsif @default
+              result = instance_exec(&@default)
             end
 
             result
           end
 
           def stringify(value)
-            ActiveSupport::JSON.encode(value)
+            unless value.nil?
+              ActiveSupport::JSON.encode(value)
+            end
           end
 
         end

data/lib/unpoly/rails/change/field_definition.rb

@@ -10,6 +10,26 @@ module Unpoly
         # Rails 3.2 delegate generated invalid Ruby with `to: :class`.
         delegate :fields, to: :get_class
 
+        def vary?
+          if @vary.nil?
+            @vary = true
+          end
+
+          @vary
+        end
+
+        def vary=(vary)
+          @vary = vary
+        end
+
+        def no_vary(&block)
+          previous_vary = vary?
+          self.vary = false
+          block.call
+        ensure
+          self.vary = previous_vary
+        end
+
         private
 
         def get_class
@@ -18,15 +38,32 @@ module Unpoly
 
         module ClassMethods
 
-          def field(name, type, method: name, response_header_name: nil)
-            field = type.new(name)
+          def field(field, method: nil, response_header_name: nil, request_header_name: nil)
+            method ||= field.name
 
             define_method "#{method}_field" do
               field
             end
 
+            define_method "#{method}_request_header_name" do
+              request_header_name || field.header_name
+            end
+
+            define_method "#{method}_request_header_accessed!" do
+              return unless vary?
+              header_name = send("#{method}_request_header_name")
+              earlier_varies = response.headers['Vary']&.split(/\s*,\s*/) || []
+              response.headers['Vary'] = (earlier_varies | [header_name]).join(', ')
+            end
+
+            define_method "#{method}_response_header_name" do
+              response_header_name || field.header_name
+            end
+
             define_method "#{method}_from_request_headers" do
-              raw_value = request.headers[field.header_name]
+              header_name = send("#{method}_request_header_name")
+              raw_value = request.headers[header_name]
+              send("#{method}_request_header_accessed!")
               field.parse(raw_value)
             end
 
@@ -61,10 +98,11 @@ module Unpoly
               value = send(method)
               stringified = field.stringify(value)
               if stringified.present? # app servers don't like blank header values
-                header_name = response_header_name || field.header_name
+                header_name = send("#{method}_response_header_name" )
                 response.headers[header_name] = stringified
               end
             end
+
           end
 
         end

data/lib/unpoly/rails/change.rb

@@ -14,18 +14,19 @@ module Unpoly
       end
 
       # Generate helpers to get, set and cast fields in request and response headers.
-      field :version, Field::String
-      field :target, Field::String
-      field :fail_target, Field::String
-      field :validate, Field::String
-      field :mode, Field::String
-      field :fail_mode, Field::String
-      field :context, Field::Hash, method: :input_context
-      field :fail_context, Field::Hash, method: :input_fail_context
-      field :context_changes, Field::Hash, response_header_name: 'X-Up-Context'
-      field :events, Field::Array
-      field :clear_cache, Field::String
-      field :reload_from_time, Field::Time
+      field Field::String.new(:version)
+      field Field::String.new(:target)
+      field Field::String.new(:fail_target)
+      field Field::SeparatedValues.new(:validate_names), request_header_name: 'X-Up-Validate'
+      field Field::String.new(:mode)
+      field Field::String.new(:fail_mode)
+      field Field::Hash.new(:context, default: -> { {} }), method: :input_context
+      field Field::Hash.new(:fail_context, default: -> { {} }), method: :input_fail_context
+      field Field::Hash.new(:context_changes, default: -> { {} }), response_header_name: 'X-Up-Context'
+      field Field::Array.new(:events, default: -> { [] })
+      field Field::String.new(:expire_cache)
+      field Field::String.new(:evict_cache)
+      field Field::Time.new(:reload_from_time)
 
       ##
       # Returns whether the current request is an
@@ -65,7 +66,10 @@ module Unpoly
       end
 
       def target_changed?
-        target != target_from_request
+        # The target has changed if either:
+        # (1) The #target= setter was called, setting @server_target
+        # (2) An up[target] param was set to preserve a previously changed target through a redirect.
+        (@server_target && @server_target != target_from_request_headers) || target_from_params
       end
 
       ##
@@ -82,8 +86,10 @@ module Unpoly
         test_target(target, tested_target)
       end
 
-      def render_nothing(options = {})
-        status = options.fetch(:status, :ok)
+      def render_nothing(status: :no_content, deprecation: true)
+        if deprecation
+          ActiveSupport::Deprecation.warn("up.render_nothing is deprecated. Use head(:no_content) instead.")
+        end
         self.target = ':none'
         controller.head(status)
       end
@@ -132,23 +138,29 @@ module Unpoly
       end
 
       ##
-      # Returns whether the current form submission should be
-      # [validated](https://unpoly.com/input-up-validate) (and not be saved to the database).
-      def validate?
-        validate.present?
+      # If the current form submission is a [validation](https://unpoly.com/input-up-validate),
+      # this returns the name attributes of the form fields that has triggered
+      # the validation.
+      #
+      # Note that multiple validating form fields may be batched into a single request.
+      def validate_names
+        validate_names_from_request
       end
 
-      alias validating? validate?
+      memoize def validate_name
+        if validating?
+          validates_names.first
+        end
+      end
 
       ##
-      # If the current form submission is a [validation](https://unpoly.com/input-up-validate),
-      # this returns the name attribute of the form field that has triggered
-      # the validation.
-      memoize def validate
-        validate_from_request
+      # Returns whether the current form submission should be
+      # [validated](https://unpoly.com/input-up-validate) (and not be saved to the database).
+      def validate?
+        validate_names.present?
       end
 
-      alias validate_name validate
+      alias validating? validate?
 
       ##
       # TODO: Docs
@@ -235,19 +247,22 @@ module Unpoly
       end
 
       def after_action
-        write_events_to_response_headers
+        no_vary do
+          write_events_to_response_headers
 
-        write_clear_cache_to_response_headers
+          write_expire_cache_to_response_headers
+          write_evict_cache_to_response_headers
 
-        if context_changes.present?
-          write_context_changes_to_response_headers
-        end
+          if context_changes.present?
+            write_context_changes_to_response_headers
+          end
 
-        if target_changed?
-          # Only write the target to the response if it has changed.
-          # The client might have a more abstract target like :main
-          # that we don't want to override with an echo of the first match.
-          write_target_to_response_headers
+          if target_changed?
+            # Only write the target to the response if it has changed.
+            # The client might have a more abstract target like :main
+            # that we don't want to override with an echo of the first match.
+            write_target_to_response_headers
+          end
         end
       end
 
@@ -265,14 +280,18 @@ module Unpoly
         # Parse the URL to extract the ?query part below.
         uri = URI.parse(original_url)
 
-        # This parses the query as a flat list of key/value pairs.
-        params = Rack::Utils.parse_query(uri.query)
+        # Split at &
+        query_parts = uri.query.split('&')
 
         # We only used the up[...] params to transport headers, but we don't
         # want them to appear in a history URL.
-        non_up_params = params.reject { |key, _value| key.starts_with?(Field::PARAM_PREFIX) }
+        non_up_query_parts = query_parts.reject { |query_part| query_part.start_with?(Field::PARAM_PREFIX) }
 
-        append_params_to_url(uri.path, non_up_params)
+        if non_up_query_parts.empty?
+          uri.path
+        else
+          "#{uri.path}?#{non_up_query_parts.join('&')}"
+        end
       end
 
       memoize def layer
@@ -287,26 +306,46 @@ module Unpoly
         Cache.new(self)
       end
 
-      def clear_cache
+      def expire_cache
+        # Cache commands are outgoing only. They wouldn't be passed as a request header.
+        # We might however pass them as params so they can survive a redirect.
+        if @expire_cache.nil?
+          expire_cache_from_params
+        else
+          @expire_cache
+        end
+      end
+
+      def expire_cache=(value)
+        @expire_cache = value
+      end
+
+      def evict_cache
         # Cache commands are outgoing only. They wouldn't be passed as a request header.
         # We might however pass them as params so they can survive a redirect.
-        if @clear_cache.nil?
-          clear_cache_from_params
+        if @evict_cache.nil?
+          evict_cache_from_params
         else
-          @clear_cache
+          @evict_cache
         end
       end
 
-      def clear_cache=(value)
-        @clear_cache = value
+      def evict_cache=(value)
+        @evict_cache = value
       end
 
-      def reload_from_time
-        reload_from_time_from_request
+      def reload_from_time(deprecation: true)
+        if deprecation
+          ActiveSupport::Deprecation.warn("up.reload_from_time is deprecated. Use conditional GETs instead: https://guides.rubyonrails.org/caching_with_rails.html#conditional-get-support")
+        end
+        reload_from_time_from_request || if_modified_since
       end
 
-      def reload?
-        !!reload_from_time
+      def reload?(deprecation: true)
+        if deprecation
+          ActiveSupport::Deprecation.warn("up.reload? is deprecated. Use conditional GETs instead: https://guides.rubyonrails.org/caching_with_rails.html#conditional-get-support")
+        end
+        !!reload_from_time(deprecation: false)
       end
 
       def safe_callback(code)
@@ -324,6 +363,12 @@ module Unpoly
 
       delegate :request, :params, :response, to: :controller
 
+      def if_modified_since
+        if (header = request.headers['If-Modified-Since'])
+          Time.httpdate(header)
+        end
+      end
+
       def content_security_policy_nonce
         controller.send(:content_security_policy_nonce)
       end
@@ -352,18 +397,25 @@ module Unpoly
 
       def fields_as_params
         params = {}
-        params[version_param_name]            = serialized_version
-        params[target_param_name]             = serialized_target
-        params[fail_target_param_name]        = serialized_fail_target
-        params[validate_param_name]           = serialized_validate
-        params[mode_param_name]               = serialized_mode
-        params[fail_mode_param_name]          = serialized_fail_mode
-        params[input_context_param_name]      = serialized_input_context
-        params[input_fail_context_param_name] = serialized_input_fail_context
-        params[context_changes_param_name]    = serialized_context_changes
-        params[events_param_name]             = serialized_events
-        params[clear_cache_param_name]        = serialized_clear_cache
-        params[reload_from_time_param_name]   = serialized_reload_from_time
+
+        # When the browser sees a redirect it will automatically resend the request headers
+        # from the original request. This means that headers we set on the client (X-Up-Target, X-Up-Mode, etc.)
+        # are automatically preserved through redirects.
+        #
+        # We still need to handle all the response headers that we set on the server.
+        # There are encoded as params.
+        params[context_changes_param_name] = serialized_context_changes      # server-set header must be sent if present
+        params[events_param_name]          = serialized_events               # server-set header must be sent if present
+        params[expire_cache_param_name]    = serialized_expire_cache         # server-set header must be sent if present
+        params[evict_cache_param_name]     = serialized_evict_cache          # server-set header must be sent if present
+
+        if target_changed?
+          # Only write the target to the response if it has changed.
+          # The client might have a more abstract target like :main
+          # that we don't want to override with an echo of the first match.
+          params[target_param_name] = serialized_target
+        end
+
 
         # Don't send empty response headers.
         params = params.select { |_key, value| value.present? }

data/lib/unpoly/rails/controller.rb

@@ -33,11 +33,13 @@ module Unpoly
       ##
       # TODO: Docs
       def redirect_to(target, *args)
-        if up?
-          target = url_for(target)
-          target = up.url_with_field_values(target)
+        up.no_vary do
+          if up?
+            target = url_for(target)
+            target = up.url_with_field_values(target)
+          end
+          super(target, *args)
         end
-        super(target, *args)
       end
 
       ::ActionController::Base.prepend(self)

data/lib/unpoly/rails/engine.rb

@@ -12,7 +12,7 @@ module Unpoly
           spec_folder = root.join('spec')
 
           # If a local application has referenced the local gem sources
-          # (e.g. `gem 'unpoly', path: '../unpoly'`) we use the local build.
+          # (e.g. `gem 'unpoly-rails', path: '../unpoly-rails'`) we use the local build.
           # This way changes from the Webpack watcher are immediately picked
           # up by the application.
           is_local_gem = spec_folder.directory?

data/lib/unpoly/rails/version.rb

@@ -4,6 +4,6 @@ module Unpoly
     # The current version of the unpoly-rails gem.
     # This version number is also used for releases of the Unpoly
     # frontend code.
-    VERSION = '2.7.1'
+    VERSION = '3.0.0.rc1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unpoly-rails
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 3.0.0.rc1
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-10 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -119,8 +119,8 @@ files:
 - assets/unpoly/unpoly-migrate.js
 - assets/unpoly/unpoly-migrate.min.js
 - assets/unpoly/unpoly.css
-- assets/unpoly/unpoly.es5.js
-- assets/unpoly/unpoly.es5.min.js
+- assets/unpoly/unpoly.es6.js
+- assets/unpoly/unpoly.es6.min.js
 - assets/unpoly/unpoly.js
 - assets/unpoly/unpoly.min.css
 - assets/unpoly/unpoly.min.js
@@ -152,9 +152,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.16
 signing_key: