ariadne_view_components 0.0.58 → 0.0.64

data/lib/ariadne/forms/dsl/input_methods.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module Ariadne
+  module Forms
+    module Dsl
+      # :nodoc:
+      module InputMethods
+        # Used to render another form object.
+        #
+        # @param args [Array] Positional arguments passed to Rails' [`fields_for` helper](https://api.rubyonrails.org/v7.0.4/classes/ActionView/Helpers/FormHelper.html#method-i-fields_for).
+        # @param kwargs [Hash] The options accepted by the form reference input (see forms docs). Includes keyword arguments passed to Rails' [`fields_for` helper](https://api.rubyonrails.org/v7.0.4/classes/ActionView/Helpers/FormHelper.html#method-i-fields_for).
+        def fields_for(*args, **kwargs, &block)
+          add_input(FormReferenceInput.new(*args, builder: builder, form: form, **kwargs, &block))
+        end
+
+        # Adds a multi input to this form.
+        #
+        # @param options [Hash] The options accepted by the multi input (see forms docs).
+        # @param block [Proc] A block that will be yielded a reference to the input object so it can be customized.
+        def multi(**options, &block)
+          add_input(MultiInput.new(builder: builder, form: form, **options, &block))
+        end
+
+        # Adds a hidden input to this form.
+        #
+        # @param options [Hash] The options accepted by the hidden input (see forms docs).
+        def hidden(**options)
+          add_input(HiddenInput.new(builder: builder, form: form, **options))
+        end
+
+        # Adds a check box to this form.
+        #
+        # @param options [Hash] The options accepted by the check box input (see forms docs).
+        # @param block [Proc] A block that will be yielded a reference to the input object so it can be customized.
+        def check_box(**options, &block)
+          add_input(CheckBoxInput.new(builder: builder, form: form, **options, &block))
+        end
+
+        # Adds a radio button group to this form.
+        #
+        # @param options [Hash] The options accepted by the radio button group input (see forms docs).
+        # @param block [Proc] A block that will be yielded a reference to the input object so it can be customized.
+        def radio_button_group(**options, &block)
+          add_input(RadioButtonGroupInput.new(builder: builder, form: form, **options, &block))
+        end
+
+        # Adds a check box group to this form.
+        #
+        # @param options [Hash] The options accepted by the check box group input (see forms docs).
+        # @param block [Proc] A block that will be yielded a reference to the input object so it can be customized.
+        def check_box_group(**options, &block)
+          add_input(CheckBoxGroupInput.new(builder: builder, form: form, **options, &block))
+        end
+
+        # Adds a horizontal separator to the form.
+        def separator
+          add_input(Separator.new)
+        end
+
+        # START text input methods
+
+        # Adds a text field to this form.
+        #
+        # @param options [Hash] The options accepted by the text field input (see forms docs).
+        # @param block [Proc] A block that will be yielded a reference to the input object so it can be customized.
+        def text_field(**options, &block)
+          options = decorate_options(**options)
+          add_input(TextFieldInput.new(builder: builder, form: form, **options, &block))
+        end
+
+        # Adds an autocomplete text field to this form.
+        #
+        # @param options [Hash] The options accepted by the autocomplete input (see forms docs).
+        # @param block [Proc] A block that will be yielded a reference to the input object so it can be customized.
+        def auto_complete(**options, &block)
+          options = decorate_options(**options)
+          add_input(AutoCompleteInput.new(builder: builder, form: form, **options, &block))
+        end
+
+        # Adds a text area to this form.
+        #
+        # @param options [Hash] The options accepted by the text area input (see forms docs).
+        # @param block [Proc] A block that will be yielded a reference to the input object so it can be customized.
+        def text_area(**options, &block)
+          options = decorate_options(**options)
+          add_input(TextAreaInput.new(builder: builder, form: form, **options, &block))
+        end
+
+        # END text input methods
+
+        # START select input methods
+
+        # Adds a select list to this form.
+        #
+        # @param options [Hash] The options accepted by the select list input (see forms docs).
+        # @param block [Proc] A block that will be yielded a reference to the input object so it can be customized.
+        def select_list(**options, &block)
+          options = decorate_options(**options)
+          add_input(SelectInput.new(builder: builder, form: form, **options, &block))
+        end
+
+        # Adds an <%= link_to_component(Ariadne::Alpha::ActionMenu) %> to this form.
+        #
+        # @param options [Hash] The options accepted by the <%= link_to_component(Ariadne::Alpha::ActionMenu) %> component.
+        # @param block [Proc] The block passed to `#render` when the <%= link_to_component(Ariadne::Alpha::ActionMenu) %> is rendered. This block is passed an instance of <%= link_to_component(Ariadne::Alpha::ActionMenu) %>, which can be used to add items, dividers, etc.
+        def action_menu(**options, &block)
+          options = decorate_options(**options)
+          add_input(ActionMenuInput.new(builder: builder, form: form, **options, &block))
+        end
+
+        # END select input methods
+
+        # START button input methods
+
+        # Adds a submit button to this form.
+        #
+        # @param options [Hash] The options accepted by the submit button input (see forms docs).
+        # @param block [Proc] A block that will be yielded a reference to the input object so it can be customized.
+        def submit(**options, &block)
+          options = decorate_options(**options)
+          add_input(SubmitButtonInput.new(builder: builder, form: form, **options, &block))
+        end
+
+        # Adds a (non-submit) button to this form.
+        #
+        # @param options [Hash] The options accepted by the button input (see forms docs).
+        # @param block [Proc] A block that will be yielded a reference to the input object so it can be customized.
+        def button(**options, &block)
+          options = decorate_options(**options)
+          add_input(ButtonInput.new(builder: builder, form: form, **options, &block))
+        end
+
+        # END button input methods
+
+        # @private
+        def inputs
+          @inputs ||= []
+        end
+
+        private
+
+        # @private
+        def add_input(input)
+          inputs << input
+        end
+
+        # @private
+        #
+        # Called before the corresponding Input class is instantiated. The return value of this method is passed
+        # to the Input class's constructor.
+        def decorate_options(**options)
+          options
+        end
+      end
+    end
+  end
+end

data/lib/ariadne/forms/dsl/submit_button_input.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Ariadne
+  module Forms
+    module Dsl
+      # :nodoc:
+      class SubmitButtonInput < Input
+        attr_reader :name, :label, :block
+
+        def initialize(**options, &block)
+          @block = block
+
+          super(**options)
+        end
+
+        def to_component
+          html_attrs = @input_attributes || {}
+          @block.call(Ariadne::UI::Button::Component.new(type: :submit, **@options, html_attrs: html_attrs))
+        end
+
+        def before_render
+          content # ensures that block is called
+        end
+
+        # :nocov:
+        def type
+          :submit_button
+        end
+
+        def supports_validation?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/ariadne/forms/dsl/text_field_input.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Ariadne
+  module Forms
+    module Dsl
+      # :nodoc:
+      class TextFieldInput < Input
+        attr_reader(
+          :name, :label, :show_clear_button, :leading_visual, :clear_button_id, :visually_hide_label, :inset, :monospace, :field_wrap_classes, :auto_check_src
+        )
+
+        def initialize(name:, label:, **options)
+          @name = name
+          @label = label
+
+          @show_clear_button = options.delete(:show_clear_button)
+          @inset = options.delete(:inset)
+          @monospace = options.delete(:monospace)
+          @auto_check_src = options.delete(:auto_check_src)
+
+          super(**options)
+
+          add_input_data(:target, "ariadne-text-field.inputElement #{@input_attributes.dig(:data, :target) || ""}".rstrip)
+        end
+
+        def to_component
+          html_attrs = @input_attributes || {}
+          Ariadne::Form::TextField::Component.new(name: @name, label: @label, **@options, html_attrs: html_attrs)
+        end
+
+        def type
+          :text_field
+        end
+
+        def focusable?
+          true
+        end
+
+        def validation_arguments
+          if auto_check_src.present?
+            super.merge(
+              data: {
+                target: "primer-text-field.validationElement",
+              },
+            )
+          else
+            super
+          end
+        end
+
+        def validation_success_icon_target
+          "primer-text-field.validationSuccessIcon"
+        end
+
+        def validation_error_icon_target
+          "primer-text-field.validationErrorIcon"
+        end
+
+        def validation_message_arguments
+          if auto_check_src.present?
+            super.merge(
+              data: {
+                target: "primer-text-field.validationMessageElement",
+              },
+            )
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ariadne/forms/utils.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Ariadne
+  # :nodoc:
+  module Forms
+    # :nodoc:
+    module Utils
+      # Unfortunately this bug (https://github.com/ruby/ruby/pull/5646) prevents us from using
+      # Ruby's native Module.const_source_location. Instead we have to fudge it by searching
+      # for the file in the configured autoload paths. Doing so relies on Rails' autoloading
+      # conventions, so it should work ok. Zeitwerk also has this information but lacks a
+      # public API to map constants to source files.
+      def const_source_location(class_name)
+        return unless class_name
+
+        # NOTE: underscore respects namespacing, i.e. will convert Foo::Bar to foo/bar.
+        class_path = "#{class_name.underscore}.rb"
+
+        ActiveSupport::Dependencies.autoload_paths.each do |autoload_path|
+          absolute_path = File.join(autoload_path, class_path)
+          return absolute_path if File.exist?(absolute_path)
+        end
+
+        nil
+      end
+
+      def classify(options)
+        options
+      end
+    end
+
+    Utils.extend(Utils)
+  end
+end

data/lib/ariadne/generate.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Ariadne
+  module Generate
+    class << self
+      def id
+        SecureRandom.hex(6)
+      end
+    end
+  end
+end

data/lib/ariadne/view_components/engine.rb

@@ -2,8 +2,6 @@
 
 require "rails/engine"
 
-require "view_component"
-
 require "tailwind_merge"
 
 module Ariadne
@@ -17,7 +15,7 @@ module Ariadne
       isolate_namespace Ariadne::ViewComponents
 
       config.autoload_paths = ["#{root}/lib"]
-      config.eager_load_paths = ["#{root}/app/components", "#{root}/app/helpers", "#{root}/app/lib"]
+      config.eager_load_paths = ["#{root}/app/components", "#{root}/app/forms", "#{root}/app/helpers", "#{root}/app/lib"]
 
       config.ariadne_view_components = ActiveSupport::OrderedOptions.new
 
@@ -31,9 +29,28 @@ module Ariadne
         app.config.assets.precompile += ["ariadne_view_components"] if app.config.respond_to?(:assets)
       end
 
-      initializer "ariadne_view_components.importmap", before: "importmap" do |app|
-        if Rails.application.respond_to?(:importmap)
-          app.config.importmap.paths << Engine.root.join("config/importmap.rb")
+      initializer "ariadne_view_components.eager_load_actions" do
+        ActiveSupport.on_load(:after_initialize) do
+          if Rails.application.config.eager_load
+            Ariadne::Forms::Base.compile!
+            Ariadne::Forms::Base.descendants.each(&:compile!)
+            Ariadne::Forms::BaseComponent.descendants.each(&:compile!)
+            Ariadne::Heroicon::Cache.preload!
+          end
+        end
+      end
+
+      initializer "ariadne.forms.helpers" do
+        ActiveSupport.on_load(:action_controller_base) do
+          begin
+            require "ariadne/form_helper"
+          rescue LoadError # rubocop:disable Lint/SuppressedException
+          end
+
+          helper Ariadne::FormHelper
+
+          # make ariadne_form_with available to view components also
+          ViewComponent::Base.prepend(Ariadne::FormHelper)
         end
       end
 
@@ -46,7 +63,7 @@ module Ariadne
       end
 
       config.after_initialize do |_app|
-        Ariadne::ViewComponents.tailwind_merger = TailwindMerge::Merger.new
+        Ariadne::ViewComponents.tailwind_merger = TailwindMerge::Merger.new(config: { prefix: "ariadne-" })
       end
     end
   end

data/lib/ariadne/view_components/version.rb

@@ -3,6 +3,6 @@
 # :nocov:
 module Ariadne
   module ViewComponents
-    VERSION = "0.0.58"
+    VERSION = "0.0.64"
   end
 end

data/lib/ariadne/view_components.rb

@@ -47,7 +47,7 @@ module Ariadne
         require "json"
 
         File.open(File.join(DEFAULT_STATIC_PATH, FILE_NAMES[stats]), "w") do |f|
-          f.write(JSON.pretty_generate(send("generate_#{stats}")))
+          f.write(JSON.pretty_generate(send(:"generate_#{stats}")))
           f.write($INPUT_RECORD_SEPARATOR)
         end
       end

data/lib/ariadne/yard/backend.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# :nocov:
+module Ariadne
+  module Yard
+    # Shared functionality for generating documentation from YARD comments.
+    class Backend
+      include DocsHelper
+
+      private
+
+      def view_context
+        @view_context ||= begin
+          # Rails controller for rendering arbitrary ERB
+          vc = ApplicationController.new.tap { |c| c.request = ActionDispatch::TestRequest.create }.view_context
+          vc.singleton_class.include(DocsHelper)
+          vc.singleton_class.include(Ariadne::ViewHelper)
+          vc
+        end
+      end
+    end
+  end
+end
+# :nocov:

data/lib/ariadne/yard/component_manifest.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+# :nocov:
+module Ariadne
+  module Yard
+    # The set of documented components (and associated metadata).
+    class ComponentManifest
+      COMPONENTS = {
+        Ariadne::Heading::Component => {},
+        # Primer::Beta::IconButton => {},
+        # Primer::Beta::Button => {},
+        # Primer::Alpha::SegmentedControl => {},
+        # Primer::Alpha::Layout => {},
+        # Primer::Alpha::HellipButton => {},
+        # Primer::Alpha::Image => {},
+        # Primer::Alpha::OcticonSymbols => {},
+        # Primer::Alpha::ImageCrop => { js: true },
+        # Primer::IconButton => { js: true },
+        # Primer::Beta::AutoComplete => { js: true },
+        # Primer::Beta::AutoComplete::Item => {},
+        # Primer::Beta::Avatar => {},
+        # Primer::Beta::AvatarStack => {},
+        # Primer::Beta::BaseButton => {},
+        # Primer::Alpha::Banner => { js: true },
+        # Primer::Beta::Blankslate => {},
+        # Primer::BlankslateComponent => {},
+        # Primer::Beta::BorderBox => {},
+        # Primer::Beta::BorderBox::Header => {},
+        # Primer::Box => {},
+        # Primer::Beta::Breadcrumbs => {},
+        # Primer::ButtonComponent => { js: true },
+        # Primer::Beta::ButtonGroup => {},
+        # Primer::Alpha::ButtonMarketing => {},
+        # Primer::Beta::ClipboardCopy => { js: true },
+        # Primer::Beta::CloseButton => {},
+        # Primer::Beta::Counter => {},
+        # Primer::Beta::Details => {},
+        # Primer::Alpha::Dialog => {},
+        # Primer::Alpha::Dropdown => { js: true },
+        # Primer::Beta::Flash => {},
+        # Primer::Beta::Heading => {},
+        # Primer::Alpha::HiddenTextExpander => {},
+        # Primer::Beta::Label => {},
+        # Primer::LayoutComponent => {},
+        # Primer::Beta::Link => { js: true },
+        # Primer::Beta::Markdown => {},
+        # Primer::Alpha::Menu => {},
+        # Primer::Navigation::TabComponent => {},
+        # Primer::Alpha::Navigation::Tab => {},
+        # Primer::Beta::Octicon => {},
+        # Primer::Beta::Popover => {},
+        # Primer::Beta::ProgressBar => {},
+        # Primer::Beta::State => {},
+        # Primer::Beta::Spinner => {},
+        # Primer::Beta::Subhead => {},
+        # Primer::Alpha::TabContainer => { js: true },
+        # Primer::Beta::Text => {},
+        # Primer::Beta::TimelineItem => {},
+        # Primer::Tooltip => {},
+        # Primer::Truncate => {},
+        # Primer::Beta::Truncate => {},
+        # Primer::Alpha::UnderlineNav => {},
+        # Primer::Alpha::UnderlinePanels => { js: true },
+        # Primer::Alpha::TabNav => {},
+        # Primer::Alpha::TabPanels => { js: true },
+        # Primer::Alpha::Tooltip => { js: true },
+        # Primer::Alpha::ToggleSwitch => { js: true },
+        # Primer::Alpha::Overlay => { js: true },
+        # Primer::Alpha::ActionMenu => { js: true },
+
+        # Examples can be seen in the NavList docs
+        # Primer::Alpha::NavList => { js: true },
+        # Primer::Alpha::NavList::Item => { js: true, examples: false },
+        # Primer::Alpha::NavList::Group => { js: true, examples: false },
+
+        # Primer::Beta::NavList => { js: true },
+        # Primer::Beta::NavList::Item => { js: true, examples: false },
+        # Primer::Beta::NavList::Group => { js: true, examples: false },
+
+        # ActionList is a base component that should not be used by itself, and thus
+        # does not have examples of its own
+        # Primer::Alpha::ActionList => { js: true, examples: false },
+        # Primer::Alpha::ActionList::Divider => { examples: false },
+        # Primer::Alpha::ActionList::Heading => { examples: false },
+        # Primer::Alpha::ActionList::Item => { examples: false },
+
+        # Forms
+        # Primer::Alpha::TextField => { form_component: true },
+        # Primer::Alpha::TextArea => { form_component: true, published: false },
+        # Primer::Alpha::Select => { form_component: true, published: false },
+        # Primer::Alpha::MultiInput => { form_component: true, js: true, published: false },
+        # Primer::Alpha::RadioButton => { form_component: true, published: false },
+        # Primer::Alpha::RadioButtonGroup => { form_component: true, published: false },
+        # Primer::Alpha::CheckBox => { form_component: true, published: false },
+        # Primer::Alpha::CheckBoxGroup => { form_component: true, published: false },
+        # Primer::Alpha::SubmitButton => { form_component: true, published: false },
+        # Primer::Alpha::FormButton => { form_component: true, published: false }
+      }.freeze
+
+      include Enumerable
+
+      def initialize(components)
+        @components = components
+      end
+
+      def each
+        return to_enum(__method__) unless block_given?
+
+        @components.each do |klass|
+          yield self.class.ref_for(klass)
+        end
+      end
+
+      def where(**attrs)
+        self.class.where(@components, **attrs)
+      end
+
+      class << self
+        def where(components = COMPONENTS, **desired_attrs)
+          new(
+            components.each_with_object([]) do |(klass, component_attrs), memo|
+              matches = desired_attrs.all? do |name, desired_value|
+                component_attrs.fetch(name, ComponentRef::ATTR_DEFAULTS[name]) == desired_value
+              end
+
+              memo << klass if matches
+            end,
+          )
+        end
+
+        def all
+          new(COMPONENTS.keys)
+        end
+
+        def ref_for(klass)
+          ref_cache[klass] ||= ComponentRef.new(klass, COMPONENTS.fetch(klass, {}))
+        end
+
+        private
+
+        def ref_cache
+          @ref_cache ||= {}
+        end
+      end
+    end
+  end
+end
+# :nocov:

data/lib/ariadne/yard/component_ref.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# :nocov:
+module Ariadne
+  module Yard
+    # :nodoc:
+    class ComponentRef
+      ATTR_DEFAULTS = {
+        js: false,
+        examples: true,
+        form_component: false,
+      }.freeze
+
+      attr_reader :klass, :attrs
+
+      def initialize(klass, attrs)
+        @klass = klass
+        @attrs = attrs
+      end
+
+      def requires_js?
+        @attrs.fetch(:js, ATTR_DEFAULTS[:js])
+      end
+
+      def should_have_examples?
+        @attrs.fetch(:examples, ATTR_DEFAULTS[:examples])
+      end
+
+      def form_component?
+        @attrs.fetch(:form_component, ATTR_DEFAULTS[:form_component])
+      end
+
+      def source_url
+        @source_url ||= begin
+          path = klass.name.split("::").map(&:underscore).join("/")
+          "https://github.com/primer/view_components/tree/main/app/components/#{path}.rb"
+        end
+      end
+
+      def lookbook_url
+        @lookbook_url ||= begin
+          path = klass.name.underscore.gsub("_component", "")
+          "https://ariadne.style/view-components/lookbook/inspect/#{path}/default/"
+        end
+      end
+    end
+  end
+end
+# :nocov: