coupdoeil 1.0.0.pre.beta.3 → 1.0.0.pre.rc1

data/app/controllers/coupdoeil/popovers_controller.rb

@@ -6,7 +6,7 @@ module Coupdoeil
     before_action :set_popover_class
     before_action :set_popover_params
 
-    filters = _process_action_callbacks.map(&:filter) - %i[set_action_and_resource_name set_popover_class set_popover_params]
+    filters = _process_action_callbacks.map(&:filter) - [:set_action_and_resource_name, :set_popover_class, :set_popover_params]
     skip_before_action(*filters, raise: false)
     skip_after_action(*filters, raise: false)
     skip_around_action(*filters, raise: false)

data/app/javascript/coupdoeil/elements/coupdoeil_element.js

@@ -18,11 +18,11 @@ export default class extends HTMLElement {
   }
 
   openPopover(triggerElement = null, callbacks) {
-    if (this.openingPopover || this.popoverController.isOpen || this.disabled || triggerElement === this) return;
+    if (this.openingPopover || this.popoverController.isOpen || this.disabled) return;
 
     this.openingPopover = true
 
-    const parent = this.closest(POPOVER_SELECTOR)?.controller
+    const parent = this.closest(POPOVER_SELECTOR)?.popoverController
     addToCurrents(this)
     return openPopover(this.popoverController, { parent, ...callbacks })
   }

data/app/javascript/coupdoeil/events/onclick.js

@@ -53,7 +53,7 @@ function handleClickedCoupdoeilOutsidePopover(coupdoeilElement, clickedElement)
 }
 
 function handleClickOutsideCoupdoeilButWithinPopover(popoverElement, clickedElement) {
-  const popover = popoverElement.controller;
+  const popover = popoverElement.popoverController;
 
   if (isElementClosePopoverButton(clickedElement)) {
     closeNow(popover)

data/app/javascript/coupdoeil/events/onmouseover.js

@@ -30,7 +30,7 @@ export const onMouseOver = ({ target: hoveredElement }) => {
 
 function handleMouseOverCoupdoeilWithinPopover(coupdoeilElement, popoverElement, hoveredElement) {
   const childPopover = coupdoeilElement.popoverController
-  const parentPopover = popoverElement.controller
+  const parentPopover = popoverElement.popoverController
   if(notTriggeredOnHover(childPopover))
     return;
 
@@ -71,7 +71,7 @@ function handleOverOutsideCoupdoeilAndPopover() {
 }
 
 function handleOverOutsideCoupdoeilButWithinPopover(popoverElement) {
-  const popover = popoverElement.controller
+  const popover = popoverElement.popoverController
 
   if (popover.closingRequest) {
     // popover is still open but was requested to close, then it clears this closing request

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

@@ -76,6 +76,9 @@ async function display(controller, options, beforeDisplay) {
 
   cancelCloseRequest(controller)
 
+  if (controller.card) {
+    controller.card.remove()
+  }
   controller.card = buildPopoverElement(controller, options)
   document.body.appendChild(controller.card)
 
@@ -85,6 +88,10 @@ async function display(controller, options, beforeDisplay) {
 
   executeNextFrameIfStillOpening(controller, async () => {
     await positionPopover(controller.coupdoeilElement, controller.card, options)
+    // popover can be closed while waiting for positioning promise to resolve
+    if (controller.card === null) {
+      return clearPopover(controller)
+    }
 
     // see buildPopoverElement() about next 2 lines
     controller.card.classList.add('hidden')
@@ -106,7 +113,7 @@ async function display(controller, options, beforeDisplay) {
 
 function executeNextFrameIfStillOpening(controller, callback) {
   requestAnimationFrame(() => {
-    if (controller.coupdoeilElement.openingPopover) {
+    if (controller.card && controller.coupdoeilElement.openingPopover && !controller.closingRequest) {
       callback.call()
     } else {
       clearPopover(controller)
@@ -128,12 +135,15 @@ function buildPopoverElement(controller, options) {
   el.classList.add(POPOVER_CLASS_NAME)
   el.style.cssText = 'position: absolute; left: 0; top: 0;'
   el.innerHTML = getPopoverContentHTML(controller)
-  el.controller = controller
+  el.popoverController = controller
+  el.coupdoeilElement = controller.coupdoeilElement
+  el.close = function() { this.coupdoeilElement.closePopover() }
   el.dataset.placement = options.placement
 
   // Initial style is not .hidden (no display: none;) and visibility: 'hidden'; so the card is inserted
   // in DOM the without being visible.
   // This allows the browser to compute its actual size so the positioning is computed correctly.
   el.style.visibility = 'hidden'
+
   return el
 }

data/app/models/coupdoeil/params.rb

@@ -12,7 +12,7 @@ module Coupdoeil
 
     SerializationError = Class.new(StandardError)
 
-    def deserialize_global_id(hash) = GlobalID::Locator.locate hash[GLOBAL_ID_KEY]
+    def deserialize_global_id(hash) = GlobalID::Locator.locate(hash[GLOBAL_ID_KEY])
     def deserialize_hash(serialized_hash) = serialized_hash.transform_values { deserialize_param(_1) }
     def serialized_global_id?(hash) = hash.size == 1 && hash.include?(GLOBAL_ID_KEY)
 
@@ -71,7 +71,7 @@ module Coupdoeil
         param.map { |arg| deserialize_param(arg) }
       when Hash
         if serialized_global_id?(param)
-          deserialize_global_id param
+          deserialize_global_id(param)
         else
           deserialize_hash(param)
         end

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

@@ -6,7 +6,7 @@ module Coupdoeil
       class Animation < Coupdoeil::Popover::Option
         self.bit_size = 3
 
-        VALUES = %w[slide-in fade-in slide-out custom].unshift(false).freeze
+        VALUES = [false, "slide-in", "fade-in", "slide-out", "custom"].freeze
         INDEX_BY_VALUES = VALUES.each_with_index.to_h.with_indifferent_access.freeze
 
         class << self

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

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

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

@@ -29,7 +29,7 @@ module Coupdoeil
         def validate!
           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'."
+          raise_invalid_option("Value should be a signed float or integer, followed or not by 'rem' or 'px'.")
         end
 
         private
@@ -39,8 +39,8 @@ module Coupdoeil
           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."
+          raise_invalid_option("Number should be comprised between -255.999 and 255.999, \
+with a maximum of 3 decimal digits.")
         end
       end
     end

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

@@ -6,13 +6,13 @@ module Coupdoeil
       class Placement < Coupdoeil::Popover::Option
         self.bit_size = 4 * 4
 
-        VALUES = %w[
-          auto
-          top top-start top-end
-          right right-start right-end
-          bottom bottom-start bottom-end
-          left left-start left-end
-        ].freeze
+        VALUES = [
+          "auto",
+          ["top", "top-start", "top-end"],
+          ["right", "right-start", "right-end"],
+          ["bottom", "bottom-start", "bottom-end"],
+          ["left", "left-start", "left-end"],
+        ].flatten.freeze
         INDEX_BY_VALUES = VALUES.each_with_index.to_h.with_indifferent_access.freeze
 
         class << self
@@ -35,7 +35,7 @@ module Coupdoeil
             next if placement_value.strip.in?(VALUES)
 
             values_sentence = VALUES.to_sentence(last_word_connector: " or ")
-            raise_invalid_option "Value must be one of: #{values_sentence}"
+            raise_invalid_option("Value must be one of: #{values_sentence}")
           end
         end
       end

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

@@ -6,7 +6,7 @@ module Coupdoeil
       class Trigger < Coupdoeil::Popover::Option
         self.bit_size = 1
 
-        VALUES = %w[click hover].freeze
+        VALUES = ["click", "hover"].freeze
 
         class << self
           def parse(value) = value.to_s == "click" ? 1 : 0

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Coupdoeil
   class Popover
     class Option
@@ -20,7 +21,7 @@ module Coupdoeil
       attr_reader :value
 
       def initialize(value)
-        value = value.to_s if value.is_a? Symbol
+        value = value.to_s if value.is_a?(Symbol)
         @value = value
       end
 
@@ -29,8 +30,7 @@ module Coupdoeil
       private
 
       def raise_invalid_option(message)
-        raise InvalidOptionError,
-              "Invalid value '#{value}' (#{value.class.name}) for #{self.class.key} option. #{message}"
+        raise InvalidOptionError, "Invalid value '#{value}' (#{value.class.name}) for #{self.class.key} option. #{message}"
       end
 
       def validate_inclusion!
@@ -38,7 +38,7 @@ module Coupdoeil
         return if value.in?(values)
 
         values_sentence = values.to_sentence(two_words_connector: " or ", last_word_connector: " or ")
-        raise_invalid_option "Value must be one of: #{values_sentence}"
+        raise_invalid_option("Value must be one of: #{values_sentence}")
       end
     end
   end

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

@@ -10,7 +10,7 @@ module Coupdoeil
         Option::OpeningDelay,
         Option::Cache,
         Option::Loading,
-        Option::Trigger
+        Option::Trigger,
       ].freeze
 
       OPTION_NAMES = ORDERED_OPTIONS.map(&:key)

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

@@ -7,12 +7,12 @@ module Coupdoeil
 
       def initialize
         @semaphore = Mutex.new
-        @registry = Hash.new
+        @registry = {}
       end
 
       def register(type, klass) = @semaphore.synchronize { @registry[type] = klass }
-      def lookup(type) = @semaphore.synchronize {@registry.fetch(type) }
-      def safe_lookup(type) = @semaphore.synchronize {@registry[type] }
+      def lookup(type) = @semaphore.synchronize { @registry.fetch(type) }
+      def safe_lookup(type) = @semaphore.synchronize { @registry[type] }
 
       def lookup_or_register(type)
         safe_lookup(type) ||

data/app/models/coupdoeil/popover.rb

@@ -35,7 +35,7 @@ module Coupdoeil
       cache: true,
       loading: :async,
       trigger: "hover",
-      opening_delay: true
+      opening_delay: true,
     )
 
     DoubleRenderError = Class.new(::AbstractController::DoubleRenderError)
@@ -74,7 +74,7 @@ module Coupdoeil
           define_singleton_method(action_name) { setup_class.new(self).with_type(action_name) }
         end
         public_send(method_name)
-    end
+      end
 
       def respond_to_missing?(method, include_all = false)
         action_methods.include?(method.name) || super
@@ -104,7 +104,7 @@ module Coupdoeil
 
     def view_context
       super.tap do |context|
-        context.extend ViewContextDelegation
+        context.extend(ViewContextDelegation)
         context.popover = self
         context.__cp_view_context = @__cp_view_context
       end

data/app/models/coupdoeil/tag.rb

@@ -3,7 +3,7 @@
 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

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Coupdoeil::Engine.routes.draw do
   resource :popover, only: :create
 end

data/lib/coupdoeil/engine.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module Coupdoeil
   class Engine < ::Rails::Engine
     isolate_namespace Coupdoeil
     config.eager_load_namespaces << Coupdoeil
     config.coupdoeil = ActiveSupport::OrderedOptions.new
 
-    config.autoload_once_paths = %W(
-      #{root}/app/controllers
-      #{root}/app/controllers/concerns
-      #{root}/app/helpers
-      #{root}/app/models
-      #{root}/app/models/concerns
-    )
+    config.autoload_once_paths = [
+      "#{root}/app/controllers",
+      "#{root}/app/controllers/concerns",
+      "#{root}/app/helpers",
+      "#{root}/app/models",
+      "#{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:
@@ -24,13 +26,13 @@ module Coupdoeil
     # config.after_initialize do
     #   config.assets.precompile -= %w[coupdoeil/popover-arrow.css]
     # end
-    PRECOMPILE_ASSETS = %w[
-      coupdoeil.js
-      coupdoeil.min.js
-      coupdoeil.min.js.map
-      coupdoeil/popover.css
-      coupdoeil/popover-arrow.css
-      coupdoeil/popover-animation.css
+    PRECOMPILE_ASSETS = [
+      "coupdoeil.js",
+      "coupdoeil.min.js",
+      "coupdoeil.min.js.map",
+      "coupdoeil/popover.css",
+      "coupdoeil/popover-arrow.css",
+      "coupdoeil/popover-animation.css",
     ]
 
     initializer "coupdoeil.assets" do
@@ -40,7 +42,7 @@ module Coupdoeil
     end
 
     initializer "coupdoeil.logger" do
-      stdout_logger = ActiveSupport::Logger.new(STDOUT)
+      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")

data/lib/coupdoeil/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coupdoeil
-  VERSION = "1.0.0-beta.3"
+  VERSION = "1.0.0-rc1"
 end

data/lib/coupdoeil.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "coupdoeil/version"
 require "coupdoeil/engine"
 

data/lib/generators/coupdoeil/install/install_generator.rb

@@ -1,83 +1,87 @@
-class Coupdoeil::InstallGenerator < Rails::Generators::Base
-  Coupdoeil::InstallGenerator.source_root Coupdoeil::Engine.root.join("lib/generators/coupdoeil/install/templates")
+# frozen_string_literal: true
 
-  desc "Create base class for popovers and default layout."
+module Coupdoeil
+  class InstallGenerator < Rails::Generators::Base
+    Coupdoeil::InstallGenerator.source_root(Coupdoeil::Engine.root.join("lib/generators/coupdoeil/install/templates"))
 
-  def create_base_class
-    create_file "app/popovers/application_popover.rb", <<~RUBY
-      class ApplicationPopover < Coupdoeil::Popover
-      end
-    RUBY
-  end
+    desc "Create base class for popovers and default layout."
 
-  def insert_default_layout
-    template "layout.html.erb.tt", "app/popovers/layouts/popover.html.erb"
-  end
+    def create_base_class
+      create_file("app/popovers/application_popover.rb", <<~RUBY)
+        class ApplicationPopover < Coupdoeil::Popover
+        end
+      RUBY
+    end
 
-  def install_javascripts
-    puts ""
-    if Rails.root.join("config/importmap.rb").exist?
-      append_to_importmap
-    elsif Rails.root.join("package.json").exist?
-      add_with_node
-    else
-      puts "You must either be running with node (package.json) or importmap-rails (config/importmap.rb) to use this gem."
+    def insert_default_layout
+      template("layout.html.erb.tt", "app/popovers/layouts/popover.html.erb")
     end
-  end
 
-  def install_stylesheets
-    puts ""
-    import_stylesheet
-    hidden_class_requirement
-  end
+    def install_javascripts
+      puts ""
+      if Rails.root.join("config/importmap.rb").exist?
+        append_to_importmap
+      elsif Rails.root.join("package.json").exist?
+        add_with_node
+      else
+        puts "You must either be running with node (package.json) or importmap-rails (config/importmap.rb) to use this gem."
+      end
+    end
 
-  private
+    def install_stylesheets
+      puts ""
+      import_stylesheet
+      hidden_class_requirement
+    end
 
-  def append_to_importmap
-    puts "Using importmap"
-    puts "Pin Coupdoeil"
-    append_to_file "config/importmap.rb", %(pin "coupdoeil", to: "coupdoeil.min.js", preload: true\n)
+    private
 
-    puts "Import Coupdoeil"
-    append_to_file "app/javascript/application.js", %(import "coupdoeil"\n)
-  end
+    def append_to_importmap
+      puts "Using importmap"
+      puts "Pin Coupdoeil"
+      append_to_file("config/importmap.rb", %(pin "coupdoeil", to: "coupdoeil.min.js", preload: true\n))
 
-  def add_with_node
-    if Rails.root.join("app/javascript/application.js").exist?
-      say "Import Coupdoeil"
-      append_to_file "app/javascript/application.js", %(import "coupdoeil"\n)
-    else
-      say "You must import coupdoeil in your JavaScript entrypoint file", :red
+      puts "Import Coupdoeil"
+      append_to_file("app/javascript/application.js", %(import "coupdoeil"\n))
     end
 
-    say "Install Coupdoeil"
-    run "yarn add coupdoeil"
-  end
+    def add_with_node
+      if Rails.root.join("app/javascript/application.js").exist?
+        say("Import Coupdoeil")
+        append_to_file("app/javascript/application.js", %(import "coupdoeil"\n))
+      else
+        say("You must import coupdoeil in your JavaScript entrypoint file", :red)
+      end
+
+      say("Install Coupdoeil")
+      run("yarn add coupdoeil")
+    end
 
-  def import_stylesheet
-    puts "To use Coupdoeil popover style, add to your layout's head:"
-    puts ""
-    puts <<-ERB
+    def import_stylesheet
+      puts "To use Coupdoeil popover style, add to your layout's head:"
+      puts ""
+      puts <<-ERB
       <%= stylesheet_link_tag "coupdoeil/popover" %>
-    ERB
-    puts ""
-    puts "Or one of two:"
-    puts ""
-    puts <<-ERB
+      ERB
+      puts ""
+      puts "Or one of two:"
+      puts ""
+      puts <<-ERB
       <%= stylesheet_link_tag "coupdoeil/popover-arrow" %>
       <%= stylesheet_link_tag "coupdoeil/popover-animation" %>
-    ERB
-  end
+      ERB
+    end
 
-  def hidden_class_requirement
-    puts ""
-    puts "Also make sure you have a CSS implementation of .hidden class:"
-    puts ""
-    puts <<-CSS
+    def hidden_class_requirement
+      puts ""
+      puts "Also make sure you have a CSS implementation of .hidden class:"
+      puts ""
+      puts <<-CSS
         .hidden {
             display: none;
         }
-    CSS
-    puts ""
+      CSS
+      puts ""
+    end
   end
 end

data/lib/generators/coupdoeil/popover/popover_generator.rb

@@ -1,21 +1,27 @@
-class Coupdoeil::PopoverGenerator < Rails::Generators::NamedBase
-  source_root File.expand_path("templates", __dir__)
+# frozen_string_literal: true
 
-  check_class_collision suffix: "Popover"
+module Coupdoeil
+  class PopoverGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("templates", __dir__)
 
-  class_option :skip_views, type: :boolean, desc: "Skip view files", default: false
+    check_class_collision suffix: "Popover"
 
-  argument :action_names, type: :array, default: []
+    class_option :skip_views, type: :boolean, desc: "Skip view files", default: false
 
-  def create_popover_file
-    template "popover.rb",
-             File.join("app/popovers", class_path, "#{file_name}_popover.rb")
-    unless options.skip_views?
-      action_names.each do |action_name|
-        path = [*class_path, file_name].join('/')
-        create_file "app/popovers/#{path}_popover/#{action_name}.html.erb", <<~ERB
-          <p>Hello from #{class_name}Popover##{action_name}</p>
-        ERB
+    argument :action_names, type: :array, default: []
+
+    def create_popover_file
+      template(
+        "popover.rb",
+        File.join("app/popovers", class_path, "#{file_name}_popover.rb"),
+      )
+      unless options.skip_views?
+        action_names.each do |action_name|
+          path = [*class_path, file_name].join("/")
+          create_file("app/popovers/#{path}_popover/#{action_name}.html.erb", <<~ERB)
+            <p>Hello from #{class_name}Popover##{action_name}</p>
+          ERB
+        end
       end
     end
   end

data/lib/tasks/coupdoeil_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :coupdoeil do
 #   # Task goes here