coupdoeil 1.0.0.pre.beta.2 → 1.0.0.pre.beta.3

data/app/helpers/coupdoeil/application_helper.rb

@@ -2,15 +2,8 @@
 
 module Coupdoeil
   module ApplicationHelper
-    def coupdoeil_popover_tag(popover, options = nil, **attributes_or_options, &)
-      if options.present?
-        attributes = attributes_or_options
-      else
-        options = attributes_or_options.extract!(*Popover::OptionsSet::OPTION_NAMES)
-        attributes = attributes_or_options
-      end
-      popover_options = options
-      render(Coupdoeil::Tag.new(popover:, popover_options:, attributes:), &)
+    def coupdoeil_popover_tag(popover, popover_options = nil, tag_attributes = nil, &)
+      render(Coupdoeil::Tag.new(popover:, popover_options:, attributes: tag_attributes), &)
     end
   end
 end

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

@@ -1,4 +1,4 @@
-import {extractOptionFromElement} from "./optionsParser";
+import {extractOptionFromElement} from "./options_parser";
 
 export function getType(controller) {
   return controller.coupdoeilElement.getAttribute('popover-type')

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

@@ -1,7 +1,7 @@
 import {FETCH_DELAY_MS, POPOVER_CLASS_NAME, OPENING_DELAY_MS} from "./config"
 import {getParams, getType, preloadedContentElement, triggeredOnClick} from "./attributes"
 import {getPopoverContentHTML, setPopoverContentHTML} from "./cache"
-import {extractOptionsFromElement} from "./optionsParser"
+import {extractOptionsFromElement} from "./options_parser"
 import {positionPopover} from "./positioning"
 import {enter} from "el-transition"
 import {addToCurrents} from "./current"

data/app/javascript/coupdoeil/popover/{optionsParser.js → options_parser.js}

@@ -15,7 +15,7 @@ const ORDERED_OPTIONS = [
   "openingDelay", // bit size: 1  shift: 4
   "animation",    // bit size: 3  shift: 5
   "placement",    // bit size: 16 shift: 8
-  "offset"        // bit size: 21 shift: 24
+  "offset"        // bit size: 20 shift: 24
 ]
 
 const TRIGGERS = ["hover", "click"]
@@ -40,6 +40,13 @@ function parseCSSSize(value) {
   return 0
 }
 
+// Offset option is a three part number.
+//    integer (8 bits) + decimals (10 bits) + config (2 bits)
+// config bits are for sign (positive (0) or negative (1)) and offset unit (px (0) or rem (1))
+// Examples:
+//  - "1.25rem" is: 00000001 . 0000011001 . 10
+//  - "-16px" is: 00010000 . 00000000 . 01
+// 10 bits are reserved for decimals so values like 0.875rem are possible.
 function getOffset(optionsInt) {
   // shift is BigInt(16 + 3 + 1 + 1 + 2 + 1)
   const offsetBits = Number(BigInt(optionsInt) >> BigInt(24))
@@ -48,16 +55,21 @@ function getOffset(optionsInt) {
 
   const isNegative = (offsetBits & 1) === 1
   const isREM = (offsetBits & 2) === 2
-  // decimals mask is 2 ** 11 - 1
-  const decimals = (offsetBits >> 2) & 2047
-  const integer = (offsetBits >> (2 + 11))
+  const decimals = (offsetBits >> 2 /* config bits */) & 1023 // (2 ** 10) - 1
+  const integer = (offsetBits >> (12 /* config (2) + decimals (10) bits */))
 
   const CSSSize = `${isNegative ? '-' : ''}${integer}.${decimals}${isREM ? 'rem' : 'px'}`
   return parseCSSSize(CSSSize)
 }
 
+// Placement option can have up to 4 placement values: a main one and 3 fallbacks.
+// There are 13 possible values for one placement, stored as an array in the PLACEMENTS const.
+// The max index of this array is 12, so a placement value can be stored as an index of this array,
+// and this index value fits in 4 bits.
+// Option for placements then consists of 4 times (main and fallbacks) this index value:
+// So from 0.0.0.0 up to 15.15.15.15, or from 0 up to 65535 (0b1111111111111111)
 function getPlacement(optionsInt) {
-  // shift is 3 + 1 + 1 + 2 + 1, mask is 2 ** 16 - 1
+  // shift is 3 + 1 + 1 + 2 + 1, mask is 2 ** 16 - 1 or 0b1111111111111111
   const placementBits = (optionsInt >> 8) & 65535
   let shift = 0
   let lastPlacement = null

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

@@ -4,7 +4,10 @@ module Coupdoeil
   class Popover
     class Option
       class Offset < Coupdoeil::Popover::Option
-        self.bit_size = 8 + 11 + 2
+        INTEGER_PART_BITS = 8
+        FLOAT_PART_BITS = 10
+        CONFIG_PART_BITS = 2
+        self.bit_size = INTEGER_PART_BITS + FLOAT_PART_BITS + CONFIG_PART_BITS
 
         class << self
           def parse(value)
@@ -16,19 +19,29 @@ module Coupdoeil
             base |= 2 if value.is_a?(String) && value.end_with?("rem")
 
             integer, decimals = float_value.abs.to_s.split(".")
-            base |= (decimals.to_i << 2)
-            base |= (integer.to_i << 2 + 11)
+            base |= (decimals.to_i << CONFIG_PART_BITS)
+            base |= (integer.to_i << CONFIG_PART_BITS + FLOAT_PART_BITS)
 
             base
           end
         end
 
         def validate!
-          return if value in Float | Integer
-          return if value.to_s.match?(/^-?\d+(\.\d{1,3})?(px|rem)?$/)
+          return ensure_no_overflow if (value in Float | Integer) || value.to_s.match?(/^-?\d+(\.\d{1,3})?(px|rem)?$/)
 
           raise_invalid_option "Value should be a signed float or integer, followed or not by 'rem' or 'px'."
         end
+
+        private
+
+        def ensure_no_overflow
+          float_value = value.to_f
+          integer, decimals = float_value.abs.to_s.split(".").map(&:to_i)
+          return if integer.in?(0..255) && decimals.in?(0..999)
+
+          raise_invalid_option "Number should be comprised between -255.999 and 255.999, \
+with a maximum of 3 decimal digits."
+        end
       end
     end
   end

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

@@ -23,28 +23,33 @@ module Coupdoeil
       def to_h = options
 
       def initialize(options = {})
+        options.assert_valid_keys(OPTION_NAMES)
+
         @options = options
       end
 
       def merge(options_set)
-        OptionsSet.new(@options.merge(options_set.options))
+        OptionsSet.new(options.merge(options_set.options))
       end
 
-      def validate!
-        ORDERED_OPTIONS.map do |option|
-          next unless @options.key?(option.key)
+      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!
+            value = options[option.key]
+            option.new(value).validate!
+          end
         end
-        @options.assert_valid_keys(ORDERED_OPTIONS.map(&:key))
+      else
+        def validate! = nil # no-op
       end
 
       def to_base36
         @to_base36 ||= begin
           shift = 0
           ORDERED_OPTIONS.reverse.sum do |option|
-            bits = option.into_bits(@options[option.key])
+            bits = option.into_bits(options[option.key])
             result = bits << shift
             shift += option.bit_size
             result

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

@@ -13,9 +13,9 @@ module Coupdoeil
         @params = EMPTY_PARAMS
       end
 
-      def default_options = klass.default_options_for(type)
       def identifier = "#{type}@#{klass.popover_resource_name}"
       def render_in(view_context) = klass.new(params, view_context).process(type)
+      def options = @options ||= klass.default_options_for(type)
 
       def with_type(type)
         @type = type
@@ -27,17 +27,9 @@ module Coupdoeil
         self
       end
 
-      def method_missing(method_name, *args, &)
-        if klass.action_methods.include?(method_name.name)
-          raise ArgumentError, "expected no arguments, given #{args.size}" if args.any?
-          with_type(method_name)
-        else
-          super
-        end
-      end
-
-      def respond_to_missing?(method, include_all = false)
-        klass.action_methods.include?(method.name) || super
+      def with_options(new_options)
+        @options = options.merge(Popover::OptionsSet.new(new_options))
+        self
       end
     end
   end

data/app/models/coupdoeil/popover.rb

@@ -46,7 +46,7 @@ module Coupdoeil
       attr_reader :registry
 
       def popover_resource_name = @popover_resource_name ||= name.delete_suffix("Popover").underscore
-      def with(...) = Setup.new(self).with_params(...)
+      def with(...) = setup_class.new(self).with_params(...)
 
       def inherited(subclass)
         super
@@ -69,14 +69,26 @@ module Coupdoeil
 
       def method_missing(method_name, *args, &)
         return super unless action_methods.include?(method_name.name)
-        raise ArgumentError, "expected no arguments" if args.any?
 
-        Setup.new(self).with_type(method_name)
-      end
+        action_methods.each do |action_name|
+          define_singleton_method(action_name) { setup_class.new(self).with_type(action_name) }
+        end
+        public_send(method_name)
+    end
 
       def respond_to_missing?(method, include_all = false)
         action_methods.include?(method.name) || super
       end
+
+      def setup_class
+        @setup_class ||= begin
+          setup_klass = Class.new(Setup)
+          action_methods.each do |action_name|
+            setup_klass.define_method(action_name) { with_type(action_name) }
+          end
+          setup_klass
+        end
+      end
     end
 
     attr_reader :params

data/app/models/coupdoeil/tag.rb

@@ -2,19 +2,20 @@
 
 module Coupdoeil
   class Tag
+    delegate :options, to: :popover_setup, prefix: :popover
+    
     def initialize(popover:, popover_options:, attributes:)
       @popover_setup = popover
+      @popover_setup.with_options(popover_options) if popover_options
       @attributes = attributes
-      popover_options = Popover::OptionsSet.new(popover_options)
-      @popover_options_set = popover_setup.default_options.merge(popover_options)
-      @popover_options_set.validate!
+      @popover_setup.options.validate!
     end
 
     def render_in(view_context, &block)
       ActiveSupport::Notifications.instrument("render_tag.coupdoeil") do
         content = view_context.capture(&block) if block_given?
-        view_context.content_tag("coup-doeil", **@attributes.merge(popover_attributes)) do
-          if popover_options_set.preload?
+        view_context.content_tag("coup-doeil", **tag_attributes) do
+          if popover_options.preload?
             view_context.tag.template(view_context.render(popover_setup), class: "popover-content") + content
           else
             content
@@ -25,21 +26,29 @@ module Coupdoeil
 
     private
 
-    attr_reader :popover_options_set, :popover_setup
+    attr_reader :popover_setup
 
     def popover_attributes
-      attributes = { "popover-options": popover_options_set.to_base36 }
+      attributes = { "popover-options": popover_options.to_base36 }
 
-      unless popover_options_set.preload?
+      unless popover_options.preload?
         params = Params.serialize(popover_setup.params).sole.presence&.to_json
         attributes.merge!("popover-type" => popover_setup.identifier, "popover-params" => params)
       end
 
       if Rails.env.local?
-        attributes.merge!(popover_options_set.to_h.transform_keys { "popover-#{_1}" })
+        attributes.merge!(popover_options.to_h.transform_keys { "popover-#{_1}" })
       end
 
       attributes
     end
+
+    def tag_attributes
+      if @attributes
+        @attributes.merge(popover_attributes)
+      else
+        popover_attributes
+      end
+    end
   end
 end

data/lib/coupdoeil/version.rb

@@ -1,3 +1,3 @@
 module Coupdoeil
-  VERSION = "1.0.0-beta.2"
+  VERSION = "1.0.0-beta.3"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: coupdoeil
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.2
+  version: 1.0.0.pre.beta.3
 platform: ruby
 authors:
 - PageHey
 bindir: bin
 cert_chain: []
-date: 2025-06-13 00:00:00.000000000 Z
+date: 2025-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -162,7 +162,7 @@ files:
 - app/javascript/coupdoeil/popover/controller.js
 - app/javascript/coupdoeil/popover/current.js
 - app/javascript/coupdoeil/popover/opening.js
-- app/javascript/coupdoeil/popover/optionsParser.js
+- app/javascript/coupdoeil/popover/options_parser.js
 - app/javascript/coupdoeil/popover/positioning.js
 - app/javascript/coupdoeil/popover/state_check.js
 - app/models/coupdoeil/params.rb
@@ -200,7 +200,7 @@ licenses:
 metadata:
   homepage_uri: https://coupdoeil.org
   source_code_uri: https://gitlab.com/Pagehey/coupdoeil
-  changelog_uri: https://gitlab.com/Pagehey/coupdoeil/CHANGELOG.md
+  changelog_uri: https://gitlab.com/Pagehey/coupdoeil/-/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib