coupdoeil 1.0.3 → 1.1.0

data/app/controllers/coupdoeil/popovers_controller.rb

@@ -12,7 +12,7 @@ module Coupdoeil
     skip_around_action(*filters, raise: false)
 
     def create
-      popover = @popover_klass.new(@popover_params, view_context)
+      popover = @popover_klass.new(@popover_params, self)
       render plain: popover.process(@action_name), layout: false
     end
 
@@ -35,7 +35,7 @@ module Coupdoeil
     def set_popover_params
       @popover_params =
         if params[:params].blank?
-          @popover_params = {}.freeze
+          @popover_params = {}.with_indifferent_access
         else
           raw_params = JSON.parse(params[:params])
           card_params = Coupdoeil::Params.deserialize(raw_params).sole
@@ -44,3 +44,4 @@ module Coupdoeil
     end
   end
 end
+ActiveSupport.run_load_hooks(:coupdoeil_popovers_controller, Coupdoeil::PopoversController)

data/app/javascript/coupdoeil/popover/opening.js

@@ -10,7 +10,7 @@ import {cancelCloseRequest, clear as clearPopover} from "./closing"
 function fetchPopoverContent(controller) {
   const type = getType(controller)
   const params = getParams(controller)
-  const authenticityToken = document.querySelector('meta[name=csrf-token]').content
+  const authenticityToken = document.querySelector('meta[name=csrf-token]')?.content
   let url = `/coupdoeil/popover`
   const opts = {
     method: 'POST',

data/app/models/coupdoeil/popover/options_set.rb

@@ -32,17 +32,15 @@ module Coupdoeil
         OptionsSet.new(options.merge(options_set.options))
       end
 
-      if Rails.env.local?
-        def validate!
-          ORDERED_OPTIONS.map do |option|
-            next unless options.key?(option.key)
-
-            value = options[option.key]
-            option.new(value).validate!
-          end
+      def validate!
+        return if Coupdoeil.config.validate_options == false || @to_base36.present?
+
+        ORDERED_OPTIONS.map do |option|
+          next unless options.key?(option.key)
+
+          value = options[option.key]
+          option.new(value).validate!
         end
-      else
-        def validate! = nil # no-op
       end
 
       def to_base36

data/app/models/coupdoeil/popover.rb

@@ -4,22 +4,35 @@ module Coupdoeil
   class Popover < AbstractController::Base
     abstract!
 
-    include AbstractController::Rendering
-
-    include AbstractController::Logger
+    include AbstractController::Caching
+    include AbstractController::Callbacks
     include AbstractController::Helpers
+    include AbstractController::Logger
+    include AbstractController::Rendering
     include AbstractController::Translation
-    include AbstractController::Callbacks
-    include AbstractController::Caching
 
     include ActionView::Layouts
     include ActionView::Rendering
 
+    include ActionController::Cookies
+    include ActionController::Helpers
+
+    # For forgery protection
+    forgery_protection_methods = [
+      :form_authenticity_token,
+      :protect_against_forgery?,
+      :config,
+      :request_forgery_protection_token,
+    ]
+    delegate(*forgery_protection_methods, to: "context_controller.helpers")
+    helper_method forgery_protection_methods
+
     include Rails.application.routes.url_helpers
 
     layout "popover"
 
-    # so coupdoeil helpers are always available within popovers
+    # so coupdoeil helpers are always available within popovers,
+    # even if include_all_helpers config is set to false
     helper Coupdoeil::ApplicationHelper
 
     @registry = Registry.new
@@ -91,24 +104,35 @@ module Coupdoeil
       end
     end
 
-    attr_reader :params
+    attr_reader :params, :context_controller
+
+    helper_method :params
 
-    def initialize(params, cp_view_context)
+    delegate :request, :session, to: :context_controller
+
+    # @param [HashWithIndifferentAccess] params the deserialized popover params that were given to `.with`
+    # @param [ActionController::Base] context_controller an instance of Coupdoeil::PopoversController or the current controller if the popover is rendered inline because of `loading: :preload` option.
+    def initialize(params, context_controller)
       super()
       @params = params
-      @__cp_view_context = cp_view_context
+      @context_controller = context_controller
     end
 
-    def helpers = @__cp_view_context
-    def controller = @__cp_view_context.controller
-
-    def view_context
-      super.tap do |context|
-        context.extend(ViewContextDelegation)
-        context.popover = self
-        context.__cp_view_context = @__cp_view_context
-      end
+    _helpers_for_modification.define_method(:helpers) do
+      controller.context_controller.send(:helpers)
     end
+    _helpers_for_modification.deprecate(
+      helpers: "helpers are now available in popover templates without calling helpers method. \
+See documentation on helpers at https://coupdoeil.org/guides/controller-api.html#helpers.",
+      deprecator: Coupdoeil.deprecator,
+    )
+
+    def controller = context_controller
+    deprecate(
+      controller: "use self instead, helper_methods are available in popovers by default. \
+See documentation on helpers at https://coupdoeil.org/guides/controller-api.html#helpers.",
+      deprecator: Coupdoeil.deprecator,
+    )
 
     def render(...)
       return super unless response_body

data/app/models/coupdoeil/tag.rb

@@ -36,7 +36,7 @@ module Coupdoeil
         attributes.merge!("popover-type" => popover_setup.identifier, "popover-params" => params)
       end
 
-      if Rails.env.local?
+      if Coupdoeil.config.options_html_attributes
         attributes.merge!(popover_options.to_h.transform_keys { "popover-#{_1}" })
       end
 

data/lib/coupdoeil/config.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Coupdoeil
+  class Config
+    class << self
+      def defaults
+        ActiveSupport::OrderedOptions.new.merge!({
+          validate_options: Rails.env.local?,
+          options_html_attributes: Rails.env.local?,
+          include_all_helpers: true,
+          delegate_helper_methods: true,
+        })
+      end
+
+      # @!attribute validate_options
+      # @return [Boolean]
+      # Whether to validate popover options when building it.
+      # It will raise an error with a hint on how to fix it if an option's value is not valid.
+      # Defaults to `Rails.env.local?`.
+
+      # @!attribute options_html_attributes
+      # @return [Boolean]
+      # Whether to insert options as HTML attributes of the <coupdoeil> tag.
+      # This is not required for Coupdoeil to work since options are compressed to base 36 to lighten the HTML payload.
+      # This option is here to help for debug or testing.
+      # Defaults to `Rails.env.local?`.
+
+      # @!attribute include_all_helpers
+      # @return [Boolean]
+      # Whether to load all application helpers so they are available when rendering a popover.
+      # This mimics the default behavior of Rails.
+      # It is advised to set it to true so that rendering popovers is seamless compared to rendering any other template.
+      # For all helpers to be included it is also required that `config.action_controller.include_all_helpers` is set to true.
+
+      # @!attribute delegate_helper_methods
+      # @return [Boolean]
+      # Similarly to `include_all_helpers`, to offer a seamless experience when rendering popovers, Coupdoeil will delegate
+      # any helper methods defined on ApplicationController when this option is set to true.
+      # Such helper methods could include `current_user` from Devise or `allowed_to?` from ActionPolicy, for example.
+      # As these helpers are not defined on modules like other helpers, they cannot be included and their call must
+      # therefore be delegated to the context controller.
+      # If this behavior causes unexpected behavior you can disable it with this configuration option, and/or [submit an issue](https://gitlab.com/Pagehey/coupdoeil/-/issues) so it can be investigated.
+      # However, in absence of problem, it is still recommended to let it `true` by default.
+    end
+    # @!attribute current
+    # @return [Coupdoeil::Config]
+    # Returns the current Coupdoeil::Config. This is persisted against this
+    # class so that config options remain accessible before the rest of
+    # Coupdoeil has loaded. Defaults to an instance of Coupdoeil::Config
+    # with all other documented defaults set.
+    class_attribute :current, default: defaults, instance_predicate: false
+  end
+end

data/lib/coupdoeil/engine.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
+require "coupdoeil/config"
+
 module Coupdoeil
   class Engine < ::Rails::Engine
-    isolate_namespace Coupdoeil
     config.eager_load_namespaces << Coupdoeil
-    config.coupdoeil = ActiveSupport::OrderedOptions.new
+    config.coupdoeil = Coupdoeil::Config.current
 
     config.autoload_once_paths = [
       "#{root}/app/controllers",
@@ -14,8 +15,8 @@ module Coupdoeil
       "#{root}/app/models/concerns",
     ]
 
-    # If you don't want to precompile Coupdoeil's assets (eg. because you're using webpack),
-    # you can do this in an intiailzer:
+    # If you don't want to precompile Coupdoeil's assets (e.g. because you're using webpack),
+    # you can do this in an initializer:
     #
     # config.after_initialize do
     #   config.assets.precompile -= Coupdoeil::Engine::PRECOMPILE_ASSETS
@@ -41,16 +42,22 @@ module Coupdoeil
       end
     end
 
-    initializer "coupdoeil.logger" do
-      stdout_logger = ActiveSupport::Logger.new($stdout)
-      stdout_logger.formatter = ::Logger::Formatter.new
-      tagged_stdout_logger = ActiveSupport::TaggedLogging.new(stdout_logger)
-      config.coupdoeil.logger = tagged_stdout_logger.tagged("Coupdoeil")
+    initializer "coupdoeil.helpers", before: :load_config_initializers do
+      ActiveSupport.on_load(:coupdoeil_popovers_controller) do
+        next unless Coupdoeil.config.include_all_helpers && include_all_helpers
+
+        Coupdoeil::Popover.helpers_path = helpers_path
+        Coupdoeil::Popover.helper(:all) if include_all_helpers
+      end
     end
 
-    initializer "coupdoeil.helpers", before: :load_config_initializers do
-      ActiveSupport.on_load(:action_controller_base) do
-        helper Coupdoeil::Engine.helpers
+    initializer "coupdoeil.helper_methods", before: :load_config_initializers do
+      ActiveSupport.on_load(:coupdoeil_popovers_controller) do
+        next unless Coupdoeil.config.delegate_helper_methods
+
+        helpers_to_delegate = _helper_methods - Coupdoeil::Popover._helper_methods
+        Coupdoeil::Popover.delegate(*helpers_to_delegate, to: "context_controller.helpers", private: true)
+        Coupdoeil::Popover.helper_method(helpers_to_delegate)
       end
     end
 

data/lib/coupdoeil/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coupdoeil
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/lib/coupdoeil.rb

@@ -5,4 +5,13 @@ require "coupdoeil/engine"
 
 module Coupdoeil
   extend ActiveSupport::Autoload
+
+  class << self
+    def config = Coupdoeil::Config.current
+    def configure = yield(Coupdoeil::Config.current)
+
+    def deprecator # :nodoc:
+      @deprecator ||= ActiveSupport::Deprecation.new("2.0.0", "Coupdoeil")
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: coupdoeil
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - PageHey
 bindir: bin
 cert_chain: []
-date: 2025-07-15 00:00:00.000000000 Z
+date: 2025-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -178,7 +178,6 @@ files:
 - app/models/coupdoeil/popover/options_set.rb
 - app/models/coupdoeil/popover/registry.rb
 - app/models/coupdoeil/popover/setup.rb
-- app/models/coupdoeil/popover/view_context_delegation.rb
 - app/models/coupdoeil/tag.rb
 - app/style/popover-animation.scss
 - app/style/popover-arrow.scss
@@ -186,6 +185,7 @@ files:
 - app/views/layouts/coupdoeil/application.html.erb
 - config/routes.rb
 - lib/coupdoeil.rb
+- lib/coupdoeil/config.rb
 - lib/coupdoeil/engine.rb
 - lib/coupdoeil/version.rb
 - lib/generators/coupdoeil/install/install_generator.rb
@@ -201,6 +201,9 @@ metadata:
   homepage_uri: https://coupdoeil.org
   source_code_uri: https://gitlab.com/Pagehey/coupdoeil
   changelog_uri: https://gitlab.com/Pagehey/coupdoeil/-/blob/main/CHANGELOG.md
+post_install_message: |
+  Coupdoeil v.1.1.0 fixed the helper usage in popovers and should allow some refactoring.
+  See CHANGELOG for details: https://gitlab.com/Pagehey/coupdoeil/-/blob/main/CHANGELOG.md?ref_type=heads#v110
 rdoc_options: []
 require_paths:
 - lib

data/app/models/coupdoeil/popover/view_context_delegation.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Coupdoeil
-  class Popover
-    module ViewContextDelegation
-      attr_accessor :__cp_view_context, :popover
-
-      # For CSRF authenticity tokens in forms
-      def config = __cp_view_context.config
-      def form_authenticity_token(...) = __cp_view_context.form_authenticity_token(...)
-      def protect_against_forgery? = __cp_view_context.protect_against_forgery?
-      def request_forgery_protection_token = __cp_view_context.request_forgery_protection_token
-
-      def helpers = __cp_view_context
-      def controller = __cp_view_context.controller
-      def params = popover.params
-    end
-  end
-end