primer_view_components 0.0.71 → 0.0.74

data/app/components/primer/clipboard_copy_component.ts

@@ -32,7 +32,7 @@ function showCheck(button: HTMLElement) {
 
 const clipboardCopyElementTimers = new WeakMap<HTMLElement, number>()
 
-document.addEventListener('clipboard-copy', function ({target}) {
+document.addEventListener('clipboard-copy', function({target}) {
   if (!(target instanceof HTMLElement)) return
   if (!target.hasAttribute('data-view-component')) return
 

data/app/components/primer/link_component.erb

@@ -1,4 +1 @@
-<%= render Primer::BaseComponent.new(**@system_arguments) do %>
-  <%= content %>
-  <%= tooltip %>
-<% end %>
+<%= render Primer::BaseComponent.new(**@system_arguments) do -%><%= content -%><%= tooltip -%><% end %>

data/app/components/primer/primer.d.ts

@@ -5,4 +5,4 @@ import './time_ago_component';
 import './local_time';
 import './image_crop';
 import './dropdown';
-import './alpha/tooltip';
+import './alpha/tool-tip-element';

data/app/components/primer/primer.js

@@ -5,4 +5,4 @@ import './time_ago_component';
 import './local_time';
 import './image_crop';
 import './dropdown';
-import './alpha/tooltip';
+import './alpha/tool-tip-element';

data/app/components/primer/primer.ts

@@ -5,4 +5,4 @@ import './time_ago_component'
 import './local_time'
 import './image_crop'
 import './dropdown'
-import './alpha/tooltip'
+import './alpha/tool-tip-element'

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "helpers/rubocop_helpers"
+
+module ERBLint
+  module Linters
+    # Replaces calls to `super` with calls to `render_parent`.
+    class SuperInComponentTemplates < Linter
+      include ERBLint::LinterRegistry
+      include Helpers::RubocopHelpers
+
+      def run(processed_source)
+        processed_source.ast.descendants(:erb).each do |erb_node|
+          indicator_node, _, code_node = *erb_node
+          code = code_node.children.first
+          ast = erb_ast(code)
+          next unless ast
+
+          super_call_nodes = find_super_call_nodes(ast)
+          next if super_call_nodes.empty?
+
+          indicator, = *indicator_node
+          indicator ||= ""
+
+          # +2 to account for the leading "<%" characters
+          code_start_pos = erb_node.location.begin_pos + indicator.size + 2
+
+          super_call_nodes.each do |super_call_node|
+            orig_loc = code_node.location
+            super_call_loc = super_call_node.location.expression
+
+            new_loc = orig_loc.with(
+              begin_pos: super_call_loc.begin_pos + code_start_pos,
+              end_pos: super_call_loc.end_pos + code_start_pos
+            )
+
+            add_offense(
+              new_loc,
+              "Avoid calling `super` in component templates. Call `render_parent` instead",
+              "render_parent"
+            )
+          end
+        end
+      end
+
+      def autocorrect(_, offense)
+        return unless offense.context
+
+        lambda do |corrector|
+          corrector.replace(offense.source_range, offense.context)
+        end
+      end
+
+      private
+
+      def find_super_call_nodes(ast)
+        return [ast] if ast.type == :zsuper
+
+        ast.each_child_node.flat_map do |child_ast|
+          find_super_call_nodes(child_ast)
+        end
+      end
+    end
+  end
+end

data/lib/primer/view_components/version.rb

@@ -5,7 +5,7 @@ module Primer
     module VERSION
       MAJOR = 0
       MINOR = 0
-      PATCH = 71
+      PATCH = 74
 
       STRING = [MAJOR, MINOR, PATCH].join(".")
     end

data/lib/rubocop/config/default.yml

@@ -15,3 +15,6 @@ Primer/PrimerOcticon:
 
 Primer/DeprecatedArguments:
   Enabled: true
+
+Primer/DeprecatedComponents:
+  Enabled: true

data/lib/rubocop/cop/primer/deprecated_components.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "json"
+require "parser/current"
+
+module RuboCop
+  module Cop
+    module Primer
+      # This cop ensures that components marked as "deprecated" in `static/statuses.json` are discouraged from use.
+      #
+      # bad
+      # Primer::BlankslateComponent.new(:foo)
+      #
+      # good
+      # Primer::Beta::Blankslate.new(:foo)
+      #
+      # bad
+      # Primer::Tooltip.new(:foo)
+      #
+      # good
+      # Primer::Alpha::Tooltip.new(:foo)
+      class DeprecatedComponents < BaseCop
+        # If there is no alternative to suggest, set the value to nil.
+        COMPONENT_TO_USE_INSTEAD = {
+          "Primer::BlankslateComponent" => "Primer::Beta::Blankslate",
+          "Primer::DropdownMenuComponent" => nil,
+          "Primer::Tooltip" => "Primer::Alpha::Tooltip",
+          "Primer::FlexComponent" => nil,
+          "Primer::FlexItemComponent" => nil
+        }.freeze
+
+        def on_send(node)
+          return unless node.source.include?("Primer::")
+
+          deprecated_components.each do |component|
+            pattern = NodePattern.new("(send #{pattern(component)} :new ...)")
+            add_offense(node, message: message(component)) if pattern.match(node)
+          end
+        end
+
+        private
+
+        # Converts a string to acceptable rubocop-ast pattern syntax
+        def pattern(component)
+          Parser::CurrentRuby.parse(component)
+                             .to_s
+                             .gsub("nil", "nil?")
+                             .delete("\n")
+                             .gsub("  ", " ")
+        end
+
+        def message(component)
+          message = "#{component} has been deprecated and should not be used."
+          message += " Try #{COMPONENT_TO_USE_INSTEAD[component]} instead." if COMPONENT_TO_USE_INSTEAD.fetch(component).present?
+          message
+        end
+
+        def statuses_json
+          JSON.parse(
+            File.read(
+              File.join(File.dirname(__FILE__), "../../../../static/statuses.json")
+            )
+          ).freeze
+        end
+
+        def deprecated_components
+          @deprecated_components ||= statuses_json.select { |_, value| value == "deprecated" }.keys.tap do |deprecated_components|
+            deprecated_components.each do |deprecated|
+              unless COMPONENT_TO_USE_INSTEAD.key?(deprecated)
+                raise "Please provide a component that should be used in place of #{deprecated} in COMPONENT_TO_USE_INSTEAD. "\
+                      "If there is no alternative, set the value to nil."
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.0.71
+  version: 0.0.74
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -383,16 +383,14 @@ files:
 - app/components/primer/alpha/button_marketing.rb
 - app/components/primer/alpha/layout.html.erb
 - app/components/primer/alpha/layout.rb
-- app/components/primer/alpha/navigation_list_element.d.ts
-- app/components/primer/alpha/navigation_list_element.js
 - app/components/primer/alpha/tab_nav.html.erb
 - app/components/primer/alpha/tab_nav.rb
 - app/components/primer/alpha/tab_panels.html.erb
 - app/components/primer/alpha/tab_panels.rb
-- app/components/primer/alpha/tooltip.d.ts
-- app/components/primer/alpha/tooltip.js
+- app/components/primer/alpha/tool-tip-element.d.ts
+- app/components/primer/alpha/tool-tip-element.js
+- app/components/primer/alpha/tool-tip-element.ts
 - app/components/primer/alpha/tooltip.rb
-- app/components/primer/alpha/tooltip.ts
 - app/components/primer/alpha/underline_nav.html.erb
 - app/components/primer/alpha/underline_nav.rb
 - app/components/primer/alpha/underline_panels.html.erb
@@ -543,6 +541,7 @@ files:
 - lib/primer/view_components/linters/helpers/rubocop_helpers.rb
 - lib/primer/view_components/linters/label_component_migration_counter.rb
 - lib/primer/view_components/linters/subhead_component_migration_counter.rb
+- lib/primer/view_components/linters/super_in_component_templates.rb
 - lib/primer/view_components/linters/tag_tree_helpers.rb
 - lib/primer/view_components/linters/two_column_layout_migration_counter.rb
 - lib/primer/view_components/statuses.rb
@@ -553,6 +552,7 @@ files:
 - lib/rubocop/cop/primer/component_name_migration.rb
 - lib/rubocop/cop/primer/deprecated_arguments.rb
 - lib/rubocop/cop/primer/deprecated_button_arguments.rb
+- lib/rubocop/cop/primer/deprecated_components.rb
 - lib/rubocop/cop/primer/deprecated_label_schemes.rb
 - lib/rubocop/cop/primer/deprecated_layout_component.rb
 - lib/rubocop/cop/primer/no_tag_memoize.rb

data/app/components/primer/alpha/navigation_list_element.d.ts

@@ -1,11 +0,0 @@
-declare class NavigationListElement extends HTMLElement {
-    #private;
-    connectedCallback(): void;
-    handleEvent(event: Event): void;
-}
-export {};
-declare global {
-    interface Window {
-        NavigationListElement: typeof NavigationListElement;
-    }
-}

data/app/components/primer/alpha/navigation_list_element.js

@@ -1,42 +0,0 @@
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _NavigationListElement_instances, _NavigationListElement_handleClick;
-class NavigationListElement extends HTMLElement {
-    constructor() {
-        super(...arguments);
-        _NavigationListElement_instances.add(this);
-    }
-    connectedCallback() {
-        this.addEventListener('click', this);
-    }
-    handleEvent(event) {
-        var _a;
-        if (!(event.target instanceof HTMLElement))
-            return;
-        const item = (_a = event.target) === null || _a === void 0 ? void 0 : _a.closest('button');
-        if ((item === null || item === void 0 ? void 0 : item.closest(this.tagName)) !== this)
-            return;
-        if (event.type === 'click') {
-            __classPrivateFieldGet(this, _NavigationListElement_instances, "m", _NavigationListElement_handleClick).call(this, item, event);
-        }
-    }
-}
-_NavigationListElement_instances = new WeakSet(), _NavigationListElement_handleClick = function _NavigationListElement_handleClick(item, e) {
-    if (item.getAttribute('aria-expanded') !== null) {
-        if (item.getAttribute('aria-expanded') === 'true') {
-            item.setAttribute('aria-expanded', 'false');
-        }
-        else {
-            item.setAttribute('aria-expanded', 'true');
-        }
-    }
-    e.stopPropagation();
-};
-if (!window.customElements.get('navigation-list')) {
-    window.NavigationListElement = NavigationListElement;
-    window.customElements.define('navigation-list', NavigationListElement);
-}
-export {};