coupdoeil 1.0.0.pre.alpha.1

data/app/models/coupdoeil/params.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Coupdoeil
+  module Params
+    extend self
+
+    GLOBAL_ID_KEY = "_cd_globalid"
+
+    RESERVED_KEYS = [GLOBAL_ID_KEY, GLOBAL_ID_KEY.to_sym].freeze
+
+    private_constant :RESERVED_KEYS, :GLOBAL_ID_KEY
+
+    SerializationError = Class.new(StandardError)
+
+    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)
+
+    def serialize(*params)
+      ActiveSupport::Notifications.instrument("serialize_hovercard_params.coupdoeil") do
+        params.map { |param| serialize_param(param) }
+      end
+    end
+
+    def deserialize(params)
+      Array.wrap(params).map { |param| deserialize_param(param) }
+    rescue StandardError
+      raise DeserializationError
+    end
+
+    def serialize_param(param)
+      case param
+      when GlobalID::Identification
+        convert_to_global_id_hash(param)
+      when Array
+        param.map { serialize_param(_1) }
+      when Hash
+        serialize_hash(param)
+      else
+        param
+      end
+    end
+
+    def serialize_hash(param)
+      param.each_with_object({}) do |(key, value), hash|
+        hash[serialize_hash_key(key)] = serialize_param(value)
+      end
+    end
+
+    def serialize_hash_key(key)
+      case key
+      when *RESERVED_KEYS
+        raise Coupdoeil::SerializationError, "Can't serialize a Hash with reserved key #{key.inspect}"
+      when String, Symbol
+        key.to_s
+      else
+        raise Coupdoeil::SerializationError, "Only string and symbol hash keys may be serialized as hovercard params, but #{key.inspect} is a #{key.class}"
+      end
+    end
+
+    def convert_to_global_id_hash(param)
+      { GLOBAL_ID_KEY => param.to_global_id.to_s }
+    rescue URI::GID::MissingModelIdError
+      raise Coupdoeil::SerializationError, "Unable to serialize #{param.class} " \
+        "without an id. (Maybe you forgot to call save?)"
+    end
+
+    def deserialize_param(param)
+      case param
+      when Array
+        param.map { |arg| deserialize_param(arg) }
+      when Hash
+        if serialized_global_id?(param)
+          deserialize_global_id param
+        else
+          deserialize_hash(param)
+        end
+      else
+        param
+      end
+    end
+  end
+end

data/app/models/coupdoeil/tag.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Coupdoeil
+  class Tag
+    def initialize(hovercard:, hovercard_options:, attributes:)
+      @hovercard_setup = hovercard
+      @attributes = attributes
+      hovercard_options = Hovercard::OptionsSet.new(hovercard_options)
+      @hovercard_options_set = hovercard_setup.default_options.merge(hovercard_options)
+      @hovercard_options_set.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(hovercard_attributes)) do
+          if hovercard_options_set.preload?
+            view_context.tag.template(view_context.render(hovercard_setup), class: "hovercard-content") + content
+          else
+            content
+          end
+        end
+      end
+    end
+
+    private
+
+    attr_reader :hovercard_options_set, :hovercard_setup
+
+    def hovercard_attributes
+      attributes = { hc: hovercard_options_set.to_base36 }
+
+      unless hovercard_options_set.preload?
+        params = Params.serialize(hovercard_setup.params).sole.presence&.to_json
+        attributes.merge!("hc-type" => hovercard_setup.identifier, "hc-params" => params)
+      end
+
+      if Rails.env.local?
+        attributes.merge!(hovercard_options_set.to_h.transform_keys { "hovercard-#{_1}" })
+      end
+
+      attributes
+    end
+  end
+end

data/app/style/hovercard-animation.scss

@@ -0,0 +1,44 @@
+.coupdoeil--hovercard.hidden {
+    display: none
+}
+
+.coupdoeil--hovercard[data-animation] {
+    &.hovercard-enter {
+        transition-timing-function: cubic-bezier(0.4, 0, 1, 1);
+    }
+    &.hovercard-leave {
+        transition-timing-function: cubic-bezier(0, 0, 0.2, 1);
+    }
+    &.hovercard-enter, &.hovercard-leave {
+        transition-property: opacity, transform;
+        transition-duration: 150ms;
+    }
+
+    &.hovercard-enter-end, &.hovercard-leave-start {
+        &[data-animation="fade-in"], &[data-animation="slide-in"], &[data-animation="slide-out"] {
+            opacity: 1;
+        }
+    }
+
+    &.hovercard-enter-start, &.hovercard-leave-end {
+        &[data-animation="fade-in"], &[data-animation="slide-in"], &[data-animation="slide-out"] {
+            opacity: 0;
+        }
+        &[data-placement|="right"] {
+            &[data-animation="slide-in"] { transform: translateX(1rem); }
+            &[data-animation="slide-out"] { transform: translateX(-1rem); }
+        }
+        &[data-placement|="left"] {
+            &[data-animation="slide-in"] { transform: translateX(-1rem); }
+            &[data-animation="slide-out"] { transform: translateX(1rem); }
+        }
+        &[data-placement|="top"] {
+            &[data-animation="slide-in"] { transform: translateY(-1rem); }
+            &[data-animation="slide-out"] { transform: translateY(1rem); }
+        }
+        &[data-placement|="bottom"] {
+            &[data-animation="slide-in"] { transform: translateY(1rem); }
+            &[data-animation="slide-out"] { transform: translateY(-1rem); }
+        }
+    }
+}

data/app/style/hovercard-arrow.scss

@@ -0,0 +1,40 @@
+@use 'sass:list';
+
+.coupdoeil--hovercard {
+  & [data-hovercard-arrow] {
+    --co-hovercard--color: white;
+    --co-hovercard--border-color: rgb(209 213 219);
+    --co-hovercard-border-size: 1px;
+    --co-hovercard-border-style: solid;
+    --co-hovercard--size-ratio: 1;
+    --co-hovercard--height: 0.75rem;
+    --co-hovercard--width: calc(var(--co-hovercard--height) / var(--co-hovercard--size-ratio));
+
+    position: absolute;
+    height: var(--co-hovercard--height);
+    width: var(--co-hovercard--height);
+
+    &::after, &::before {
+      content: "";
+      width: 0;
+      height: 0;
+      position: absolute;
+      bottom: 0;
+      border: var(--co-hovercard--base-border-width) var(--co-hovercard-border-style) transparent;
+    }
+
+    &::after {
+      --co-hovercard--base-border-width: var(--co-hovercard--width);
+      border-bottom-color: var(--co-hovercard--color);
+      left: calc(50% - var(--co-hovercard--width));
+    }
+    &::before {
+      --co-hovercard--base-border-width: calc(var(--co-hovercard--height) + var(--co-hovercard-border-size));
+      border-bottom-color: var(--co-hovercard--border-color);
+      left: calc(50% - var(--co-hovercard--width) - var(--co-hovercard-border-size));
+    }
+  }
+  &[data-placement|="top"] [data-hovercard-arrow] { transform: rotate(180deg); }
+  &[data-placement|="right"] [data-hovercard-arrow] { transform: rotate(-90deg); }
+  &[data-placement|="left"] [data-hovercard-arrow] { transform: rotate(90deg); }
+}

data/app/style/hovercard.scss

@@ -0,0 +1,2 @@
+@use "hovercard-animation";
+@use "hovercard-arrow";

data/app/views/layouts/coupdoeil/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Coupdoeil</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "coupdoeil/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Coupdoeil::Engine.routes.draw do
+  resource :hovercard, only: :create
+end

data/lib/coupdoeil/engine.rb

@@ -0,0 +1,62 @@
+module Coupdoeil
+  class Engine < ::Rails::Engine
+    isolate_namespace Coupdoeil
+    # config.eager_load_namespaces << Coupdoeil
+    config.coupdoeil = ActiveSupport::OrderedOptions.new
+
+    # If you don't want to precompile Coupdoeil's assets (eg. because you're using webpack),
+    # you can do this in an intiailzer:
+    #
+    # config.after_initialize do
+    #   config.assets.precompile -= Coupdoeil::Engine::PRECOMPILE_ASSETS
+    # end
+    #
+    # If you just want to remove specific css:
+    #
+    # config.after_initialize do
+    #   config.assets.precompile -= %w[coupdoeil/hovercard-arrow.css]
+    # end
+    PRECOMPILE_ASSETS = %w[
+      coupdoeil.js
+      coupdoeil.min.js
+      coupdoeil.min.js.map
+      coupdoeil/hovercard.css
+      coupdoeil/hovercard-arrow.css
+      coupdoeil/hovercard-animation.css
+    ]
+
+    initializer "coupdoeil.assets" do
+      if Rails.application.config.respond_to?(:assets)
+        Rails.application.config.assets.precompile += PRECOMPILE_ASSETS
+      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")
+    end
+
+    initializer "coupdoeil.helpers", before: :load_config_initializers do
+      ActiveSupport.on_load(:action_controller_base) do
+        helper Coupdoeil::Engine.helpers
+      end
+    end
+
+    initializer "coupdoeil.view_paths" do
+      config.to_prepare do
+        views = Rails.application.config.paths["app/views"].existent
+        views += Rails.application.config.paths.add("app/hovercards").existent
+        views += Rails.application.config.paths.add("app/hovercards/layouts").existent
+        Coupdoeil::Hovercard.prepend_view_path(views)
+      end
+    end
+
+    initializer "coupdoeil.routes" do |app|
+      app.routes.append do
+        mount Coupdoeil::Engine => "/coupdoeil"
+      end
+    end
+  end
+end

data/lib/coupdoeil/version.rb

@@ -0,0 +1,3 @@
+module Coupdoeil
+  VERSION = "1.0.0-alpha.1"
+end

data/lib/coupdoeil.rb

@@ -0,0 +1,6 @@
+require "coupdoeil/version"
+require "coupdoeil/engine"
+
+module Coupdoeil
+  # Your code goes here...
+end

data/lib/generators/coupdoeil/hovercard/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Create hovercard class and views files.
+
+Example:
+    bin/rails generate hovercard Contact details from_project
+
+    creates the following files:
+        app/hovercards/contact_hovercard.rb
+        app/views/contact_hovercard/details.html.erb
+        app/views/contact_hovercard/from_project.html.erb
+
+    bin/rails generate hovercard Contact details from_project --skip-views
+
+        creates only the class file:
+            app/hovercards/contact_hovercard.rb

data/lib/generators/coupdoeil/hovercard/hovercard_generator.rb

@@ -0,0 +1,22 @@
+class Coupdoeil::HovercardGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  check_class_collision suffix: "Hovercard"
+
+  class_option :skip_views, type: :boolean, desc: "Skip view files", default: false
+
+  argument :action_names, type: :array, default: []
+
+  def create_hovercard_file
+    template "hovercard.rb",
+             File.join("app/hovercards", class_path, "#{file_name}_hovercard.rb")
+    unless options.skip_views?
+      action_names.each do |action_name|
+        path = [*class_path, file_name].join('/')
+        create_file "app/hovercards/#{path}_hovercard/#{action_name}.html.erb", <<~ERB
+          <p>Hello from #{class_name}Hovercard##{action_name}</p>
+        ERB
+      end
+    end
+  end
+end

data/lib/generators/coupdoeil/hovercard/templates/hovercard.rb.tt

@@ -0,0 +1,8 @@
+<% module_namespacing do -%>
+class <%= class_name %>Hovercard < ApplicationHovercard
+<% action_names.each do |action_name| -%>
+  def <%= action_name %>
+  end
+<% end -%>
+end
+<% end -%>

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

@@ -0,0 +1,71 @@
+class Coupdoeil::InstallGenerator < Rails::Generators::Base
+  Coupdoeil::InstallGenerator.source_root Coupdoeil::Engine.root.join("lib/generators/coupdoeil/install/templates")
+
+  desc "Create base class for hovercards and default layout."
+
+  def create_base_class
+    create_file "app/hovercards/application_hovercard.rb", <<~RUBY
+      class ApplicationHovercard < Coupdoeil::Hovercard
+      end
+    RUBY
+  end
+
+  def insert_default_layout
+    template "layout.html.erb.tt", "app/hovercards/layouts/hovercard.html.erb"
+  end
+
+  def install_javascripts
+    puts ""
+    if Rails.root.join("config/importmap.rb").exist?
+      append_to_importmap
+    elsif Rails.root.join("package.json").exist?
+      raise "package.json not supported yet!"
+    else
+      puts "You must either be running with node (package.json) or importmap-rails (config/importmap.rb) to use this gem."
+    end
+  end
+
+  def install_stylesheets
+    puts ""
+    import_stylesheet
+    hidden_class_requirement
+  end
+
+  private
+
+  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)
+
+    puts "Import Coupdoeil"
+    append_to_file "app/javascript/application.js", %(import "coupdoeil"\n)
+  end
+
+  def import_stylesheet
+    puts "To use Coupdoeil hovercard style, add to your layout's head:"
+    puts ""
+    puts <<-ERB
+      <%= stylesheet_link_tag "coupdoeil/hovercard" %>
+    ERB
+    puts ""
+    puts "Or one of two:"
+    puts ""
+    puts <<-ERB
+      <%= stylesheet_link_tag "coupdoeil/hovercard-arrow" %>
+      <%= stylesheet_link_tag "coupdoeil/hovercard-animation" %>
+    ERB
+  end
+
+  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 ""
+  end
+end

data/lib/generators/coupdoeil/install/templates/layout.html.erb.tt

@@ -0,0 +1,14 @@
+<div
+  style="
+    background: white;
+    padding: 1rem;
+    border: 1px solid rgb(209 213 219);
+    box-shadow: 0 1px 3px 0 rgb(0 0 0 / 0.1), 0 1px 2px -1px rgb(0 0 0 / 0.1);
+    width: max-content;
+    max-width: 24rem;
+    border-radius: 0.25rem;
+  "
+>
+  <div data-hovercard-arrow></div>
+  <%%= yield %>
+</div>

data/lib/tasks/coupdoeil_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :coupdoeil do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: coupdoeil
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha.1
+platform: ruby
+authors:
+- PageHey
+bindir: bin
+cert_chain: []
+date: 2025-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy and powerful hovercard system for Ruby On Rails.
+email:
+- pagehey@pm.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/coupdoeil_manifest.js
+- app/assets/javascripts/coupdoeil.js
+- app/assets/javascripts/coupdoeil.min.js
+- app/assets/javascripts/coupdoeil.min.js.map
+- app/assets/stylesheets/coupdoeil/application.css
+- app/assets/stylesheets/coupdoeil/hovercard-animation.css
+- app/assets/stylesheets/coupdoeil/hovercard-arrow.css
+- app/assets/stylesheets/coupdoeil/hovercard.css
+- app/controllers/coupdoeil/hovercards_controller.rb
+- app/helpers/coupdoeil/application_helper.rb
+- app/javascript/coupdoeil/elements/coupdoeil_element.js
+- app/javascript/coupdoeil/events.js
+- app/javascript/coupdoeil/events/onclick.js
+- app/javascript/coupdoeil/events/onmouseover.js
+- app/javascript/coupdoeil/hovercard.js
+- app/javascript/coupdoeil/hovercard/actions.js
+- app/javascript/coupdoeil/hovercard/attributes.js
+- app/javascript/coupdoeil/hovercard/cache.js
+- app/javascript/coupdoeil/hovercard/closing.js
+- app/javascript/coupdoeil/hovercard/config.js
+- app/javascript/coupdoeil/hovercard/controller.js
+- app/javascript/coupdoeil/hovercard/opening.js
+- app/javascript/coupdoeil/hovercard/optionsParser.js
+- app/javascript/coupdoeil/hovercard/positioning.js
+- app/javascript/coupdoeil/hovercard/state_check.js
+- app/javascript/coupdoeil/index.js
+- app/models/coupdoeil/hovercard.rb
+- app/models/coupdoeil/hovercard/option.rb
+- app/models/coupdoeil/hovercard/option/animation.rb
+- app/models/coupdoeil/hovercard/option/cache.rb
+- app/models/coupdoeil/hovercard/option/loading.rb
+- app/models/coupdoeil/hovercard/option/offset.rb
+- app/models/coupdoeil/hovercard/option/placement.rb
+- app/models/coupdoeil/hovercard/option/trigger.rb
+- app/models/coupdoeil/hovercard/options_set.rb
+- app/models/coupdoeil/hovercard/registry.rb
+- app/models/coupdoeil/hovercard/setup.rb
+- app/models/coupdoeil/hovercard/view_context_delegation.rb
+- app/models/coupdoeil/params.rb
+- app/models/coupdoeil/tag.rb
+- app/style/hovercard-animation.scss
+- app/style/hovercard-arrow.scss
+- app/style/hovercard.scss
+- app/views/layouts/coupdoeil/application.html.erb
+- config/routes.rb
+- lib/coupdoeil.rb
+- lib/coupdoeil/engine.rb
+- lib/coupdoeil/version.rb
+- lib/generators/coupdoeil/hovercard/USAGE
+- lib/generators/coupdoeil/hovercard/hovercard_generator.rb
+- lib/generators/coupdoeil/hovercard/templates/hovercard.rb.tt
+- lib/generators/coupdoeil/install/install_generator.rb
+- lib/generators/coupdoeil/install/templates/layout.html.erb.tt
+- lib/tasks/coupdoeil_tasks.rake
+homepage: https://coupdoeil.org
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://coupdoeil.org
+  source_code_uri: https://gitlab.com/Pagehey/coupdoeil
+  changelog_uri: https://gitlab.com/Pagehey/coupdoeil/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A framework to easily handle hovercards.
+test_files: []