primer_view_components 0.0.45 → 0.0.49

data/{app/lib → lib}/primer/classify/utilities.yml

@@ -1,4 +1,71 @@
 ---
+:animation:
+  :fade_in:
+  - anim-fade-in
+  :fade_out:
+  - anim-fade-out
+  :fade_up:
+  - anim-fade-up
+  :fade_down:
+  - anim-fade-down
+  :grow_x:
+  - anim-grow-x
+  :shrink_x:
+  - anim-shrink-x
+  :scale_in:
+  - anim-scale-in
+  :pulse:
+  - anim-pulse
+  :pulse_in:
+  - anim-pulse-in
+  :hover_grow:
+  - anim-hover-grow
+  :rotate:
+  - anim-rotate
+:position:
+  :static:
+  - position-static
+  - position-sm-static
+  - position-md-static
+  - position-lg-static
+  - position-xl-static
+  :relative:
+  - position-relative
+  - position-sm-relative
+  - position-md-relative
+  - position-lg-relative
+  - position-xl-relative
+  :absolute:
+  - position-absolute
+  - position-sm-absolute
+  - position-md-absolute
+  - position-lg-absolute
+  - position-xl-absolute
+  :fixed:
+  - position-fixed
+  - position-sm-fixed
+  - position-md-fixed
+  - position-lg-fixed
+  - position-xl-fixed
+  :sticky:
+  - position-sticky
+  - position-sm-sticky
+  - position-md-sticky
+  - position-lg-sticky
+  - position-xl-sticky
+:vertical_align:
+  :middle:
+  - v-align-middle
+  :top:
+  - v-align-top
+  :bottom:
+  - v-align-bottom
+  :text_top:
+  - v-align-text-top
+  :text_bottom:
+  - v-align-text-bottom
+  :baseline:
+  - v-align-baseline
 :float:
   :left:
   - float-left
@@ -1136,6 +1203,63 @@
   - py-md-12
   - py-lg-12
   - py-xl-12
+:word_break:
+  :break_all:
+  - wb-break-all
+:display:
+  :block:
+  - d-block
+  - d-sm-block
+  - d-md-block
+  - d-lg-block
+  - d-xl-block
+  :flex:
+  - d-flex
+  - d-sm-flex
+  - d-md-flex
+  - d-lg-flex
+  - d-xl-flex
+  :inline:
+  - d-inline
+  - d-sm-inline
+  - d-md-inline
+  - d-lg-inline
+  - d-xl-inline
+  :inline_block:
+  - d-inline-block
+  - d-sm-inline-block
+  - d-md-inline-block
+  - d-lg-inline-block
+  - d-xl-inline-block
+  :inline_flex:
+  - d-inline-flex
+  - d-sm-inline-flex
+  - d-md-inline-flex
+  - d-lg-inline-flex
+  - d-xl-inline-flex
+  :none:
+  - d-none
+  - d-sm-none
+  - d-md-none
+  - d-lg-none
+  - d-xl-none
+  :table:
+  - d-table
+  - d-sm-table
+  - d-md-table
+  - d-lg-table
+  - d-xl-table
+  :table_cell:
+  - d-table-cell
+  - d-sm-table-cell
+  - d-md-table-cell
+  - d-lg-table-cell
+  - d-xl-table-cell
+:visibility:
+  :hidden:
+  - v-hidden
+  :visible:
+  - v-visible
 :hide:
   :sm:
   - hide-sm

data/lib/primer/view_components.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
+require "primer/classify"
 require "primer/view_components/version"
 require "primer/view_components/engine"
 
 module Primer
   # :nodoc:
   module ViewComponents
-    DEFAULT_STATUSES_PATH = File.expand_path("static")
+    DEFAULT_STATIC_PATH = File.expand_path("static")
     DEFAULT_STATUS_FILE_NAME = "statuses.json"
+    DEFAULT_CONSTANTS_FILE_NAME = "constants.json"
 
     # generate_statuses returns a hash mapping component name to
     # the component's status sorted alphabetically by the component name.
     def self.generate_statuses
-      statuses = Primer::Component.descendants.each_with_object({}) do |component, mem|
+      Primer::Component.descendants.sort_by(&:name).each_with_object({}) do |component, mem|
         mem[component.to_s] = component.status.to_s
       end
-
-      statuses.sort_by { |k, _v| k }.to_h
     end
 
     # dump_statuses generates the status hash and then serializes
     # it as json at the given path
-    def self.dump_statuses(path: DEFAULT_STATUSES_PATH)
+    def self.dump_statuses(path: DEFAULT_STATIC_PATH)
       require "json"
 
       statuses = generate_statuses
@@ -34,8 +34,37 @@ module Primer
 
     # read_statuses returns a JSON string matching the output of
     # generate_statuses
-    def self.read_statuses(path: DEFAULT_STATUSES_PATH)
+    def self.read_statuses(path: DEFAULT_STATIC_PATH)
       File.read(File.join(path, DEFAULT_STATUS_FILE_NAME))
     end
+
+    # generate_constants returns a hash mapping component name to
+    # all of its constants.
+    def self.generate_constants
+      Primer::Component.descendants.sort_by(&:name).each_with_object({}) do |component, mem|
+        mem[component.to_s] = component.constants(false).sort.each_with_object({}) do |constant, h|
+          h[constant] = component.const_get(constant)
+        end
+      end
+    end
+
+    # dump_constants generates the constants hash and then serializes
+    # it as json at the given path
+    def self.dump_constants(path: DEFAULT_STATIC_PATH)
+      require "json"
+
+      constants = generate_constants
+
+      File.open(File.join(path, DEFAULT_CONSTANTS_FILE_NAME), "w") do |f|
+        f.write(JSON.pretty_generate(constants))
+        f.write($INPUT_RECORD_SEPARATOR)
+      end
+    end
+
+    # read_constants returns a JSON string matching the output of
+    # generate_constants
+    def self.read_constants(path: DEFAULT_STATIC_PATH)
+      File.read(File.join(path, DEFAULT_CONSTANTS_FILE_NAME))
+    end
   end
 end

data/lib/primer/view_components/constants.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Primer
+  module ViewComponents
+    # A module for constants that are used in the view components.
+    class Constants
+      CONSTANTS = JSON.parse(
+        File.read(
+          File.join(File.dirname(__FILE__), "../../../static/constants.json")
+        )
+      ).freeze
+
+      class << self
+        def get(component:, constant:, invert: true, symbolize: false)
+          values = CONSTANTS.dig(component, constant)
+
+          case values
+          when Hash
+            format_hash(values, invert, symbolize)
+          when Array
+            format_array(values, symbolize)
+          else
+            values
+          end
+        end
+
+        private
+
+        def format_hash(values, invert, symbolize)
+          val = values.invert if invert
+          # remove defaults
+          val = val.except("", nil)
+
+          return val.transform_values { |v| symbolize_value(v) } if symbolize
+
+          val
+        end
+
+        def format_array(values, symbolize)
+          val = values.select(&:present?)
+
+          return val.map { |v| symbolize_value(v) } if symbolize
+
+          val
+        end
+
+        def symbolize_value(value)
+          ":#{value}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "conversion_error"
+require_relative "system_arguments"
+require "primer/view_components/constants"
+
+module ERBLint
+  module Linters
+    module ArgumentMappers
+      # Provides the base interface to implement an `ArgumentMapper`.
+      # Override attribute_to_args in a child class to customize its mapping behavior.
+      class Base
+        DEFAULT_TAG = nil
+
+        def initialize(tag)
+          @tag = tag
+        end
+
+        def to_s
+          to_args.map { |k, v| "#{k}: #{v}" }.join(", ")
+        end
+
+        def to_args
+          args = {}
+
+          args[:tag] = ":#{@tag.name}" unless self.class::DEFAULT_TAG.nil? || @tag.name == self.class::DEFAULT_TAG
+
+          @tag.attributes.each do |attribute|
+            args.merge!(attribute_to_args(attribute))
+          end
+
+          args
+        end
+
+        def attribute_to_args(attribute); end
+      end
+    end
+  end
+end

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

@@ -1,62 +1,53 @@
 # frozen_string_literal: true
 
-require_relative "conversion_error"
-require_relative "system_arguments"
+require_relative "base"
 
 module ERBLint
   module Linters
     module ArgumentMappers
       # Maps classes in a button element to arguments for the Button component.
-      class Button
-        SCHEME_MAPPINGS = {
-          "btn-primary" => ":primary",
-          "btn-danger" => ":danger",
-          "btn-outline" => ":outline",
-          "btn-invisible" => ":invisible",
-          "btn-link" => ":link"
-        }.freeze
+      class Button < Base
+        require "pry"
 
-        VARIANT_MAPPINGS = {
-          "btn-sm" => ":small",
-          "btn-large" => ":large"
-        }.freeze
+        SCHEME_MAPPINGS = Primer::ViewComponents::Constants.get(
+          component: "Primer::ButtonComponent",
+          constant: "SCHEME_MAPPINGS",
+          symbolize: true
+        ).freeze
 
-        TYPE_OPTIONS = %w[button reset submit].freeze
+        VARIANT_MAPPINGS = Primer::ViewComponents::Constants.get(
+          component: "Primer::ButtonComponent",
+          constant: "VARIANT_MAPPINGS",
+          symbolize: true
+        ).freeze
 
-        def initialize(tag)
-          @tag = tag
-        end
-
-        def to_s
-          to_args.map { |k, v| "#{k}: #{v}" }.join(", ")
-        end
-
-        def to_args
-          args = {}
+        TYPE_OPTIONS = Primer::ViewComponents::Constants.get(
+          component: "Primer::BaseButton",
+          constant: "TYPE_OPTIONS"
+        ).freeze
+        DEFAULT_TAG = Primer::ViewComponents::Constants.get(
+          component: "Primer::BaseButton",
+          constant: "DEFAULT_TAG"
+        ).freeze
 
-          args[:tag] = ":#{@tag.name}" unless @tag.name == "button"
+        def attribute_to_args(attribute)
+          attr_name = attribute.name
 
-          @tag.attributes.each do |attribute|
-            attr_name = attribute.name
+          if attr_name == "class"
+            classes_to_args(attribute)
+          elsif attr_name == "disabled"
+            { disabled: true }
+          elsif attr_name == "type"
+            # button is the default type, so we don't need to do anything.
+            return {} if attribute.value == "button"
 
-            if attr_name == "class"
-              args = args.merge(classes_to_args(attribute))
-            elsif attr_name == "disabled"
-              args[:disabled] = true
-            elsif attr_name == "type"
-              # button is the default type, so we don't need to do anything.
-              next if attribute.value == "button"
+            raise ConversionError, "Button component does not support type \"#{attribute.value}\"" unless TYPE_OPTIONS.include?(attribute.value)
 
-              raise ConversionError, "Button component does not support type \"#{attribute.value}\"" unless TYPE_OPTIONS.include?(attribute.value)
-
-              args[:type] = ":#{attribute.value}"
-            else
-              # Assume the attribute is a system argument.
-              args.merge!(SystemArguments.new(attribute).to_args)
-            end
+            { type: ":#{attribute.value}" }
+          else
+            # Assume the attribute is a system argument.
+            SystemArguments.new(attribute).to_args
           end
-
-          args
         end
 
         def classes_to_args(classes)

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module ERBLint
+  module Linters
+    module ArgumentMappers
+      # Maps attributes in the clipboard-copy element to arguments for the ClipboardCopy component.
+      class ClipboardCopy < Base
+        DEFAULT_TAG = "clipboard-copy"
+
+        def attribute_to_args(attribute)
+          attr_name = attribute.name
+
+          if attr_name == "value"
+            { value: attribute.value.to_json }
+          else
+            # Assume the attribute is a system argument.
+            SystemArguments.new(attribute).to_args
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module ERBLint
+  module Linters
+    module ArgumentMappers
+      # Maps classes in a label element to arguments for the Label component.
+      class Label < Base
+        SCHEME_MAPPINGS = Primer::ViewComponents::Constants.get(
+          component: "Primer::LabelComponent",
+          constant: "SCHEME_MAPPINGS",
+          symbolize: true
+        ).freeze
+
+        VARIANT_MAPPINGS = Primer::ViewComponents::Constants.get(
+          component: "Primer::LabelComponent",
+          constant: "VARIANT_MAPPINGS",
+          symbolize: true
+        ).freeze
+
+        DEFAULT_TAG = Primer::ViewComponents::Constants.get(
+          component: "Primer::LabelComponent",
+          constant: "DEFAULT_TAG"
+        ).freeze
+
+        def attribute_to_args(attribute)
+          attr_name = attribute.name
+
+          if attr_name == "class"
+            classes_to_args(attribute)
+          elsif attr_name == "title"
+            { title: attribute.value.to_json }
+          else
+            # Assume the attribute is a system argument.
+            SystemArguments.new(attribute).to_args
+          end
+        end
+
+        def classes_to_args(classes)
+          classes.value.split(" ").each_with_object({}) do |class_name, acc|
+            next if class_name == "Label"
+
+            if SCHEME_MAPPINGS[class_name] && acc[:scheme].nil?
+              acc[:scheme] = SCHEME_MAPPINGS[class_name]
+            elsif VARIANT_MAPPINGS[class_name] && acc[:variant].nil?
+              acc[:variant] = VARIANT_MAPPINGS[class_name]
+            else
+              raise ConversionError, "Cannot convert class \"#{class_name}\""
+            end
+          end
+        end
+      end
+    end
+  end
+end