coupdoeil 1.1.1 → 1.2.1

data/app/models/coupdoeil/popover/option/loading.rb

@@ -6,7 +6,7 @@ module Coupdoeil
       class Loading < Coupdoeil::Popover::Option
         self.bit_size = 2
 
-        VALUES = ["async", "preload"].freeze
+        VALUES = ["async", "preload", "lazy"].freeze
 
         class << self
           def parse(value) = VALUES.index(value.to_s)

data/app/models/coupdoeil/popover/option/placement.rb

@@ -17,22 +17,43 @@ module Coupdoeil
 
         class << self
           def parse(value)
-            values = value.to_s.split(",")
+            values = extract_values(value)
             4.times.sum do |index|
               next 0 unless (placement = values[index])
 
-              placement.strip!
               placement_index = INDEX_BY_VALUES[placement]
               placement_index << (index * 4)
             end
           end
+
+          def extract_values(value, validate: false)
+            case value
+            when Array
+              raise_invalid_option("You can provide maximum 4 placement options.") if validate && value.length > 4
+              raise_invalid_option("You must provide at least one option.") if validate && value.empty?
+              value
+            when Symbol
+              [value.name]
+            when String
+              value.split(",").each(&:strip!).tap do |values|
+                if values.many?
+                  locations = caller_locations
+                  start_index = (locations.find_index { |s| s.path.include?(Rails.root.to_s) } || 0) + 1
+                  Coupdoeil.deprecator.warn(
+                    "Use array of string instead to provide several placement options",
+                    caller_locations(start_index),
+                  )
+                end
+              end
+            end
+          end
         end
 
         def validate!
-          values = value.to_s.split(",")
+          values = Placement.extract_values(value, validate: true)
 
           values.each do |placement_value|
-            next if placement_value.strip.in?(VALUES)
+            next if placement_value.in?(VALUES)
 
             values_sentence = VALUES.to_sentence(last_word_connector: " or ")
             raise_invalid_option("Value must be one of: #{values_sentence}")

data/app/models/coupdoeil/popover.rb

@@ -17,6 +17,8 @@ module Coupdoeil
     include ActionController::Cookies
     include ActionController::Helpers
 
+    prepend LazyLoading
+
     # For forgery protection
     forgery_protection_methods = [
       :form_authenticity_token,
@@ -104,17 +106,15 @@ module Coupdoeil
       end
     end
 
-    attr_reader :params, :context_controller
-
-    helper_method :params
+    attr_reader :context_controller
 
     delegate :request, :session, to: :context_controller
 
-    # @param [HashWithIndifferentAccess] params the deserialized popover params that were given to `.with`
+    # @raw_param [HashWithIndifferentAccess] raw_params the popover params to deserialize
     # @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)
+    def initialize(raw_params, context_controller)
       super()
-      @params = params
+      @raw_params = raw_params
       @context_controller = context_controller
     end
 
@@ -141,13 +141,28 @@ See documentation on helpers at https://coupdoeil.org/guides/controller-api.html
 Also note that render does not terminate execution of the action."
     end
 
-    def process(method_name, *)
-      benchmark("processed popover #{self.class.popover_resource_name}/#{method_name}", silence: true) do
-        ActiveSupport::Notifications.instrument("render_popover.coupdoeil") do
-          super
-          response_body || render(action_name)
-        end
+    def instrument_render(method_name, &block)
+      ActiveSupport::Notifications.instrument("render_popover.coupdoeil", &block)
+    end
+
+    def process(method_name, ...)
+      instrument_render(method_name) do
+        super
+        response_body || render(action_name)
       end
     end
+
+    # @return [HashWithIndifferentAccess] the deserialized popover params that were given to `.with`
+    def params
+      @params ||=
+        if @raw_params&.is_a?(String)
+          parsed_params = JSON.parse(@raw_params)
+          parsed_params = Coupdoeil::Params.deserialize(parsed_params).sole
+          parsed_params.with_indifferent_access
+        else
+          @raw_params.with_indifferent_access
+        end
+    end
+    helper_method :params
   end
 end

data/app/models/coupdoeil/tag.rb

@@ -24,30 +24,31 @@ module Coupdoeil
       end
     end
 
-    private
-
-    attr_reader :popover_setup
-
-    def popover_attributes
-      attributes = { "popover-options": popover_options.to_base36 }
+    def popover_attributes(prefixed: false)
+      attributes = { popover_options: popover_options.to_base36 }
 
       unless popover_options.preload?
         params = Params.serialize(popover_setup.params).sole.presence&.to_json
-        attributes.merge!("popover-type" => popover_setup.identifier, "popover-params" => params)
+        attributes.merge!(popover_type: popover_setup.identifier, popover_params: params)
       end
 
       if Coupdoeil.config.options_html_attributes
-        attributes.merge!(popover_options.to_h.transform_keys { "popover-#{_1}" })
+        attributes.merge!(popover_options.to_h.transform_keys { "popover_#{_1}".to_sym })
       end
 
+      attributes.transform_keys! { "data-#{_1.name.tr("_", "-")}" } if prefixed
       attributes
     end
 
+    private
+
+    attr_reader :popover_setup
+
     def tag_attributes
       if @attributes
-        @attributes.merge(popover_attributes)
+        @attributes.merge(popover_attributes(prefixed: true))
       else
-        popover_attributes
+        popover_attributes(prefixed: true)
       end
     end
   end

data/lib/coupdoeil/config.rb

@@ -9,6 +9,7 @@ module Coupdoeil
           options_html_attributes: Rails.env.local?,
           include_all_helpers: true,
           delegate_helper_methods: true,
+          default_dataset_format: :html,
         })
       end
 
@@ -41,6 +42,12 @@ module Coupdoeil
       # 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.
+
+      # @!attribute default_dataset_format
+      # @return [Symbol]
+      # Default returned format of the coupdoeil_popover_dataset view helper.
+      # See the helper documentation for available formats and their behavior.
+      # Defaults to `:html`.
     end
     # @!attribute current
     # @return [Coupdoeil::Config]

data/lib/coupdoeil/engine.rb

@@ -63,9 +63,10 @@ module Coupdoeil
 
     initializer "coupdoeil.view_paths" do
       config.to_prepare do
-        views = Rails.application.config.paths["app/views"].existent
+        views = []
         views += Rails.application.config.paths.add("app/popovers").existent
         views += Rails.application.config.paths.add("app/popovers/layouts").existent
+        views += Rails.application.config.paths["app/views"].existent
         Coupdoeil::Popover.prepend_view_path(views)
       end
     end

data/lib/coupdoeil/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coupdoeil
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - PageHey
@@ -154,19 +154,20 @@ files:
 - app/javascript/coupdoeil/events/onmouseover.js
 - app/javascript/coupdoeil/index.js
 - app/javascript/coupdoeil/popover.js
-- app/javascript/coupdoeil/popover/actions.js
 - app/javascript/coupdoeil/popover/attributes.js
 - app/javascript/coupdoeil/popover/cache.js
 - app/javascript/coupdoeil/popover/closing.js
 - app/javascript/coupdoeil/popover/config.js
 - app/javascript/coupdoeil/popover/controller.js
 - app/javascript/coupdoeil/popover/current.js
+- app/javascript/coupdoeil/popover/lazy_loading.js
 - app/javascript/coupdoeil/popover/opening.js
 - app/javascript/coupdoeil/popover/options_parser.js
 - app/javascript/coupdoeil/popover/positioning.js
-- app/javascript/coupdoeil/popover/state_check.js
+- app/javascript/coupdoeil/popover/utils.js
 - app/models/coupdoeil/params.rb
 - app/models/coupdoeil/popover.rb
+- app/models/coupdoeil/popover/lazy_loading.rb
 - app/models/coupdoeil/popover/option.rb
 - app/models/coupdoeil/popover/option/animation.rb
 - app/models/coupdoeil/popover/option/cache.rb
@@ -201,9 +202,6 @@ 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/javascript/coupdoeil/popover/state_check.js

@@ -1,12 +0,0 @@
-import {POPOVER_CLOSE_BTN_SELECTOR} from "./config";
-
-import {currentPopoversById} from "./current";
-
-export function isElementClosePopoverButton(element) {
-  return element.closest(POPOVER_CLOSE_BTN_SELECTOR) ||
-    element.dataset.hasOwnProperty("popoverClose")
-}
-
-export function isAnyPopoverOpened() {
-  return currentPopoversById().size > 0
-}