openproject-primer_view_components 0.62.0 → 0.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4929f92b5de2ff7680b004eda5619b18549a1205583b53e152d3ca1b53699238
-  data.tar.gz: f41e2230548ff1bd6dfe7e1560a78b3470c082e36d295c648f993745956dfa9c
+  metadata.gz: 1a157780e81b4a84c0814e2b933b4f2e2fcf6ad74d549353b058fc8012b57fea
+  data.tar.gz: 3ab915e6a83249d059e8a95b6a21e3739c8ac6b73bf22486ae2601020e2971e3
 SHA512:
-  metadata.gz: 9541c3e5adb821cb65525fd20ad425cedad0235f3aaeca2dd0ceb8fc77b1b890e10602b30aa9d7e91628376f52d5112421afc17e3ffb5b883380474e61675a8d
-  data.tar.gz: 81d3002af641bd143d1decad9d0ca419fe5b83103102caa79d1dc407b5a5809886a29cc1bdf1ef9a05874876127645b1056611d07bd6aaa520b8ee1dad15ecdc
+  metadata.gz: a0b70e6823a3bc2d69de91864ccde36d0d8063fda209c829f041e8ba63105c1f3d97acfbed26bba8b8fd53c4e6ddf3f4486199a245653988d308bdceaca5f742
+  data.tar.gz: 026dbfd7490dfa3e53e43802e45947089ee1c5776d9db4e6eda22e20d914ae979cc7af3b0afb4a0a2266f5d2594d370265c1052072f997642c6a300672e8579a

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 0.63.0
+
+### Minor Changes
+
+- [#3428](https://github.com/primer/view_components/pull/3428) [`1ab1b06`](https://github.com/opf/primer_view_components/commit/1ab1b06509763ea60fc89770754edf06229b4f63) Thanks [@manuelpuyol](https://github.com/manuelpuyol)! - Create IncludeFragment component. Allow ConditionalWrapper to render components other than BaseComponent
+
+### Patch Changes
+
+- [#3429](https://github.com/primer/view_components/pull/3429) [`6ea9fd5`](https://github.com/opf/primer_view_components/commit/6ea9fd5dc90c1964ab3882faf1733c6b49c80e21) Thanks [@manuelpuyol](https://github.com/manuelpuyol)! - Create IncludeFragment linter to migrate <include-fragment> uses
+
 ## 0.62.0
 
 ### Minor Changes

data/app/components/primer/alpha/action_menu.html.erb

@@ -3,7 +3,7 @@
     <%= render(@overlay) do |overlay| %>
       <% overlay.with_body(padding: :none) do %>
         <% if @src.present? %>
-          <include-fragment src="<%= @src %>" loading="<%= preload? ? "eager" : "lazy" %>" data-target="action-menu.includeFragment">
+          <%= render(Primer::Alpha::IncludeFragment.new(src: @src, loading: preload? ? :eager : :lazy, "data-target": "action-menu.includeFragment")) do %>
             <%= render(Primer::Alpha::ActionMenu::List.new(id: "#{@menu_id}-list", menu_id: @menu_id)) do |list| %>
               <% list.with_item(
                 aria: { disabled: true },
@@ -18,7 +18,7 @@
                 <%= render Primer::Beta::Spinner.new(aria: { label: "Loading content..." }) %>
               <% end %>
             <% end %>
-          </include-fragment>
+          <% end %>
         <% else %>
           <%= render(@list) %>
         <% end %>

data/app/components/primer/alpha/include_fragment.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Primer
+  module Alpha
+    # Use `IncludeFragment` to load HTML elements from the server.
+    # Add additional usage considerations or best practices that may aid the user to use the component correctly.
+    # @accessibility Add any accessibility considerations
+    class IncludeFragment < Primer::Component
+      status :alpha
+
+      # @param src [String] The URL  from which to retrieve an HTML element fragment.
+      # @param loading [Symbol] <%= one_of([:lazy, :eager]) %>
+      # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+      def initialize(src: nil, loading: :eager, **system_arguments)
+        @system_arguments = system_arguments
+        @system_arguments[:tag] = "include-fragment"
+        @system_arguments[:loading] = loading
+        @system_arguments[:src] = src
+      end
+
+      def call
+        render(Primer::BaseComponent.new(**@system_arguments)) { content }
+      end
+    end
+  end
+end

data/app/components/primer/alpha/select_panel.html.erb

@@ -62,7 +62,7 @@
           )) do %>
             <div id="<%= @body_id %>">
               <% if @src.present? %>
-                <%= render(Primer::ConditionalWrapper.new(condition: @fetch_strategy == :eventually_local, tag: "include-fragment", data: { target: "select-panel.includeFragment" }, src: @src, loading: preload? ? "eager" : "lazy", accept: "text/fragment+html")) do %>
+                <%= render(Primer::ConditionalWrapper.new(condition: @fetch_strategy == :eventually_local, component: Primer::Alpha::IncludeFragment, data: { target: "select-panel.includeFragment" }, src: @src, loading: preload? ? "eager" : "lazy", accept: "text/fragment+html")) do %>
                   <%= render(Primer::BaseComponent.new(
                     tag: :div,
                     id: "#{@panel_id}-list",

data/app/components/primer/conditional_wrapper.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
 module Primer
-  # Conditionally renders a `Primer::BaseComponent` around the given content. If the given condition
-  # is true, a `Primer::BaseComponent` will render around the content. If the condition is false, only
+  # Conditionally renders a component around the given content. If the given condition
+  # is true, the component will render around the content. If the condition is false, only
   # the content is rendered.
   class ConditionalWrapper < Primer::Component
-    # @param condition [Boolean] Whether or not to wrap the content in a `Primer::BaseComponent`.
-    # @param base_component_arguments [Hash] The arguments to pass to `Primer::BaseComponent`.
-    def initialize(condition:, **base_component_arguments)
+    # @param condition [Boolean] Whether or not to wrap the content in a component.
+    # @param component [Class] The component class to use as a wrapper, defaults to `Primer::BaseComponent`
+    # @param base_component_arguments [Hash] The arguments to pass to the component.
+    def initialize(condition:, component: Primer::BaseComponent, **base_component_arguments)
       @condition = condition
+      @component = component
       @base_component_arguments = base_component_arguments
       @trim = !!@base_component_arguments.delete(:trim)
     end
@@ -18,7 +20,7 @@ module Primer
         return @trim ? trimmed_content : content
       end
 
-      BaseComponent.new(trim: @trim, **@base_component_arguments).render_in(self) { content }
+      @component.new(trim: @trim, **@base_component_arguments).render_in(self) { content }
     end
   end
 end

data/lib/primer/view_components/linters/argument_mappers/include_fragment.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module ERBLint
+  module Linters
+    module ArgumentMappers
+      # Maps attributes in the include-fragment element to arguments for the IncludeFragment component.
+      class IncludeFragment < Base
+        DEFAULT_TAG = "include-fragment"
+        ATTRIBUTES = %w[loading src accept role preload tabindex autofocus hidden].freeze
+
+        def attribute_to_args(attribute)
+          attr_name = attribute.name
+
+          { attr_name.to_sym => erb_helper.convert(attribute) }
+        end
+      end
+    end
+  end
+end

data/lib/primer/view_components/linters/include_fragment_component_migration_counter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "base_linter"
+require_relative "autocorrectable"
+require_relative "argument_mappers/include_fragment"
+
+module ERBLint
+  module Linters
+    # Counts the number of times a HTML include-fragment is used instead of the component.
+    class IncludeFragmentComponentMigrationCounter < BaseLinter
+      include Autocorrectable
+
+      TAGS = %w[include-fragment].freeze
+      REQUIRED_ARGUMENTS = [].freeze
+      MESSAGE = "We are migrating include-fragment to use [Primer::Alpha::IncludeFragment](https://primer.style/view-components/lookbook/inspect/primer/alpha/include_fragment/default), please try to use that instead of raw HTML."
+      ARGUMENT_MAPPER = ArgumentMappers::IncludeFragment
+      COMPONENT = "Primer::Alpha::IncludeFragment"
+    end
+  end
+end

data/lib/primer/view_components/version.rb

@@ -5,7 +5,7 @@ module Primer
   module ViewComponents
     module VERSION
       MAJOR = 0
-      MINOR = 62
+      MINOR = 63
       PATCH = 0
 
       STRING = [MAJOR, MINOR, PATCH].join(".")

data/previews/primer/alpha/include_fragment_preview.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Setup Playground to use all available component props
+# Setup Features to use individual component props and combinations
+
+module Primer
+  module Alpha
+    # @label IncludeFragment
+    class IncludeFragmentPreview < ViewComponent::Preview
+      # @label Playground
+      # @param loading select [eager, lazy]
+      def playground(loading: :eager)
+        render(Primer::Alpha::IncludeFragment.new(loading: loading, src: UrlHelpers.include_fragment_deferred_path)) { "Loading..." }
+      end
+
+      # @label Default options
+      def default
+        render(Primer::Alpha::IncludeFragment.new(loading: :eager, src: UrlHelpers.include_fragment_deferred_path)) { "Loading..." }
+      end
+    end
+  end
+end

data/static/arguments.json

@@ -1357,6 +1357,34 @@
       }
     ]
   },
+  {
+    "component": "IncludeFragment",
+    "status": "alpha",
+    "a11y_reviewed": false,
+    "short_name": "IncludeFragment",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/include_fragment.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/include_fragment/default/",
+    "parameters": [
+      {
+        "name": "src",
+        "type": "String",
+        "default": "`nil`",
+        "description": "The URL from which to retrieve an HTML element fragment."
+      },
+      {
+        "name": "loading",
+        "type": "Symbol",
+        "default": "`:eager`",
+        "description": "One of `:eager` or `:lazy`."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
   {
     "component": "Layout",
     "status": "alpha",
@@ -4949,13 +4977,19 @@
         "name": "condition",
         "type": "Boolean",
         "default": "N/A",
-        "description": "Whether or not to wrap the content in a `Primer::BaseComponent`."
+        "description": "Whether or not to wrap the content in a component."
+      },
+      {
+        "name": "component",
+        "type": "Class",
+        "default": "`Primer::BaseComponent`",
+        "description": "The component class to use as a wrapper, defaults to `Primer::BaseComponent`"
       },
       {
         "name": "base_component_arguments",
         "type": "Hash",
         "default": "N/A",
-        "description": "The arguments to pass to `Primer::BaseComponent`."
+        "description": "The arguments to pass to the component."
       }
     ]
   },

data/static/audited_at.json

@@ -30,6 +30,7 @@
   "Primer::Alpha::HellipButton": "",
   "Primer::Alpha::HiddenTextExpander": "",
   "Primer::Alpha::Image": "",
+  "Primer::Alpha::IncludeFragment": "",
   "Primer::Alpha::Layout": "",
   "Primer::Alpha::Layout::Main": "",
   "Primer::Alpha::Layout::Sidebar": "",

data/static/constants.json

@@ -391,6 +391,9 @@
   "Primer::Alpha::Image": {
     "GeneratedSlotMethods": "Primer::Alpha::Image::GeneratedSlotMethods"
   },
+  "Primer::Alpha::IncludeFragment": {
+    "GeneratedSlotMethods": "Primer::Alpha::IncludeFragment::GeneratedSlotMethods"
+  },
   "Primer::Alpha::Layout": {
     "FIRST_IN_SOURCE_DEFAULT": "sidebar",
     "FIRST_IN_SOURCE_OPTIONS": [

data/static/info_arch.json

@@ -4679,6 +4679,77 @@
 
     ]
   },
+  {
+    "fully_qualified_name": "Primer::Alpha::IncludeFragment",
+    "description": "Use `IncludeFragment` to load HTML elements from the server.\nAdd additional usage considerations or best practices that may aid the user to use the component correctly.",
+    "accessibility_docs": "Add any accessibility considerations",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
+    "component": "IncludeFragment",
+    "status": "alpha",
+    "a11y_reviewed": false,
+    "short_name": "IncludeFragment",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/include_fragment.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/include_fragment/default/",
+    "parameters": [
+      {
+        "name": "src",
+        "type": "String",
+        "default": "`nil`",
+        "description": "The URL from which to retrieve an HTML element fragment."
+      },
+      {
+        "name": "loading",
+        "type": "Symbol",
+        "default": "`:eager`",
+        "description": "One of `:eager` or `:lazy`."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "{{link_to_system_arguments_docs}}"
+      }
+    ],
+    "slots": [
+
+    ],
+    "methods": [
+
+    ],
+    "previews": [
+      {
+        "preview_path": "primer/alpha/include_fragment/playground",
+        "name": "playground",
+        "snapshot": "false",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
+      {
+        "preview_path": "primer/alpha/include_fragment/default",
+        "name": "default",
+        "snapshot": "false",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      }
+    ],
+    "subcomponents": [
+
+    ]
+  },
   {
     "fully_qualified_name": "Primer::Alpha::Layout",
     "description": "`Layout` provides foundational patterns for responsive pages.\n`Layout` can be used for simple two-column pages, or it can be nested to provide flexible 3-column experiences.\n On smaller screens, `Layout` uses vertically stacked rows to display content.\n\n`Layout` flows as both column, when there's enough horizontal space to render both `Main` and `Sidebar`side-by-side (on a desktop of tablet device, per instance);\nor it flows as a row, when `Main` and `Sidebar` are stacked vertically (e.g. on a mobile device).\n`Layout` should always work in any screen size.",
@@ -17220,7 +17291,7 @@
   },
   {
     "fully_qualified_name": "Primer::ConditionalWrapper",
-    "description": "Conditionally renders a `Primer::BaseComponent` around the given content. If the given condition\nis true, a `Primer::BaseComponent` will render around the content. If the condition is false, only\nthe content is rendered.",
+    "description": "Conditionally renders a component around the given content. If the given condition\nis true, the component will render around the content. If the condition is false, only\nthe content is rendered.",
     "accessibility_docs": null,
     "is_form_component": false,
     "is_published": true,
@@ -17236,13 +17307,19 @@
         "name": "condition",
         "type": "Boolean",
         "default": "N/A",
-        "description": "Whether or not to wrap the content in a `Primer::BaseComponent`."
+        "description": "Whether or not to wrap the content in a component."
+      },
+      {
+        "name": "component",
+        "type": "Class",
+        "default": "`Primer::BaseComponent`",
+        "description": "The component class to use as a wrapper, defaults to `Primer::BaseComponent`"
       },
       {
         "name": "base_component_arguments",
         "type": "Hash",
         "default": "N/A",
-        "description": "The arguments to pass to `Primer::BaseComponent`."
+        "description": "The arguments to pass to the component."
       }
     ],
     "slots": [

data/static/previews.json

@@ -4682,6 +4682,40 @@
       }
     ]
   },
+  {
+    "name": "include_fragment",
+    "component": "IncludeFragment",
+    "status": "alpha",
+    "lookup_path": "primer/alpha/include_fragment",
+    "examples": [
+      {
+        "preview_path": "primer/alpha/include_fragment/playground",
+        "name": "playground",
+        "snapshot": "false",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
+      {
+        "preview_path": "primer/alpha/include_fragment/default",
+        "name": "default",
+        "snapshot": "false",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      }
+    ]
+  },
   {
     "name": "input_group",
     "component": "OpenProject::InputGroup",

data/static/statuses.json

@@ -30,6 +30,7 @@
   "Primer::Alpha::HellipButton": "alpha",
   "Primer::Alpha::HiddenTextExpander": "alpha",
   "Primer::Alpha::Image": "alpha",
+  "Primer::Alpha::IncludeFragment": "alpha",
   "Primer::Alpha::Layout": "alpha",
   "Primer::Alpha::Layout::Main": "alpha",
   "Primer::Alpha::Layout::Sidebar": "alpha",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openproject-primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.62.0
+  version: 0.63.0
 platform: ruby
 authors:
 - GitHub Open Source
@@ -209,6 +209,7 @@ files:
 - app/components/primer/alpha/hellip_button.rb
 - app/components/primer/alpha/hidden_text_expander.rb
 - app/components/primer/alpha/image.rb
+- app/components/primer/alpha/include_fragment.rb
 - app/components/primer/alpha/layout.css
 - app/components/primer/alpha/layout.css.json
 - app/components/primer/alpha/layout.css.map
@@ -789,6 +790,7 @@ files:
 - lib/primer/view_components/linters/argument_mappers/conversion_error.rb
 - lib/primer/view_components/linters/argument_mappers/flash.rb
 - lib/primer/view_components/linters/argument_mappers/helpers/erb_block.rb
+- lib/primer/view_components/linters/argument_mappers/include_fragment.rb
 - lib/primer/view_components/linters/argument_mappers/label.rb
 - lib/primer/view_components/linters/argument_mappers/system_arguments.rb
 - lib/primer/view_components/linters/autocorrectable.rb
@@ -807,6 +809,7 @@ files:
 - lib/primer/view_components/linters/helpers/deprecated_components_helpers.rb
 - lib/primer/view_components/linters/helpers/rubocop_helpers.rb
 - lib/primer/view_components/linters/helpers/rule_helpers.rb
+- lib/primer/view_components/linters/include_fragment_component_migration_counter.rb
 - lib/primer/view_components/linters/label_component_migration_counter.rb
 - lib/primer/view_components/linters/migrate_deprecated_flash_arguments.rb
 - lib/primer/view_components/linters/migrations/iconbutton_component.rb
@@ -894,6 +897,7 @@ files:
 - previews/primer/alpha/form_control_preview/playground.html.erb
 - previews/primer/alpha/hellip_button_preview.rb
 - previews/primer/alpha/hidden_text_expander_preview.rb
+- previews/primer/alpha/include_fragment_preview.rb
 - previews/primer/alpha/layout_preview.rb
 - previews/primer/alpha/menu_preview.rb
 - previews/primer/alpha/menu_preview/default.html.erb