primer_view_components 0.0.86 → 0.0.87

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f85b7d98dc85b59a5312ea5c3c5cfe35c966a1ad495263837032249bc7782d89
-  data.tar.gz: d4829969cc3672f7e3e492e3179d48f75fe9cd2299fa03b2153b5d2892ed04b4
+  metadata.gz: e6bfe00066208f8c4762d50b5df12895b564ef39da4202b625f2250974f8854c
+  data.tar.gz: b5ccfedef5c538d1491eca81db4273c67fd549f5737574174074cf89e219c92e
 SHA512:
-  metadata.gz: 7270b517ed8032991f97b9369975704fb8596efaf5867f73987b8a0993ef9809df91a4e3673ceb17e29699cb975143ce5644c677ac68149b54e28ada734d2df8
-  data.tar.gz: e512281e87914e23b3dd7b24c1bd5b1bd89d531e97f733687f872dc8d2bff56079810f5017686af4b84ee7cd05e56e1231d56058a67ccbaca1b0b0ea0c210928
+  metadata.gz: 1e3f89321a8c13325ef873074d0ea4e2d880dacd1e06185e3b87af6a2a6ad2a363115e6c85ba4888e134b8f532e1983a8b7c1fe355df139fcd6a93dc0337770d
+  data.tar.gz: 70045302ca011ea9c1cd009f7a31a1ea0e41f027198bdb99989f656d2ccd2dfe4d654faad729bbbf60652151fa2e8bfa779492e4f5f72c3b6bc2a5c0d2a8103b

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## 0.0.87
+
+### Patch Changes
+
+- [#1274](https://github.com/primer/view_components/pull/1274) [`c153f734`](https://github.com/primer/view_components/commit/c153f734a891fc3bc7dfc3bed34630ff38ab39d7) Thanks [@jonrohan](https://github.com/jonrohan)! - Fixing whitespace in rendered LinkComponent
+
+* [#1273](https://github.com/primer/view_components/pull/1273) [`f38517ac`](https://github.com/primer/view_components/commit/f38517acf1aed43b27f2c6b94634d70b124883e6) Thanks [@camertron](https://github.com/camertron)! - Revert removal of BlankslateComponent
+
+- [#1270](https://github.com/primer/view_components/pull/1270) [`44919308`](https://github.com/primer/view_components/commit/4491930812d16a9bcb5d8f05b4d94e49e469afa5) Thanks [@camertron](https://github.com/camertron)! - Use a custom form builder; introduce primer_form_for
+
+* [#1269](https://github.com/primer/view_components/pull/1269) [`9ae9615f`](https://github.com/primer/view_components/commit/9ae9615f31acf43875feb89661cac6311527f9fd) Thanks [@mxriverlynn](https://github.com/mxriverlynn)! - updating component migrator script with improvements in component reference updates, deprecations, etc.
+
+- [#1276](https://github.com/primer/view_components/pull/1276) [`759ea56f`](https://github.com/primer/view_components/commit/759ea56f00cbe3e536f4e558a9fb9a3e1b89bf7b) Thanks [@mxriverlynn](https://github.com/mxriverlynn)! - correcting the updates to nav.yml in the component status migrator
+
 ## 0.0.86
 
 ### Patch Changes

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

@@ -6,7 +6,7 @@ module Primer
 
     # A text field suitable for use outside a form. For a text field input suitable for use
     # within an HTML form, see the `Primer::Forms` namespace.
-    class TextField
+    class TextField < Primer::Component
       status :alpha
 
       # @!method initialize

data/app/components/primer/blankslate_component.html.erb

@@ -0,0 +1,25 @@
+<%# erblint:counter ButtonComponentMigrationCounter 1 %>
+<%= render Primer::BaseComponent.new(**@system_arguments) do %>
+  <% if spinner.present? %>
+    <%= spinner %>
+  <% elsif @icon.present? %>
+    <%= primer_octicon @icon, size: @icon_size, classes: "blankslate-icon" %>
+  <% elsif @image_src.present? && @image_alt.present? %>
+    <%= image_tag @image_src.to_s, class: "mb-3", size: "56x56", alt: @image_alt.to_s %>
+  <% end %>
+  <% if @title.present? %>
+    <%= render Primer::BaseComponent.new(tag: @title_tag, mb: 1) do %><%= @title %><% end %>
+  <% end %>
+  <% if @description.present? %>
+    <p><%= @description %></p>
+  <% end %>
+  <%= content %>
+  <% if @button_text.present? && @button_url.present? %>
+    <a class="btn <%= @button_classes %>" href="<%= @button_url %>"><%= @button_text %></a>
+  <% end %>
+  <% if @link_text.present? && @link_url.present? %>
+    <p>
+      <%= link_to @link_url.to_s do %><%= @link_text %><% end %>
+    </p>
+  <% end %>
+<% end %>

data/app/components/primer/blankslate_component.rb

@@ -1,8 +1,156 @@
 # frozen_string_literal: true
 
 module Primer
-  # BlankslateComponent is deprecated. Please use `Primer::Beta::Blankslate` instead.
-  class BlankslateComponent < Primer::Beta::Blankslate
+  # Use `Blankslate` when there is a lack of content within a page or section. Use as placeholder to tell users why something isn't there.
+  # @accessibility
+  #   `Blankslate` renders an `<h3>` element for the title by default. Update the heading level based on what is appropriate for your page hierarchy by setting `title_tag`.
+  #   <%= link_to_heading_practices %>
+  class BlankslateComponent < Primer::Component
     status :deprecated
+
+    # Optional Spinner.
+    #
+    # @param kwargs [Hash] The same arguments as <%= link_to_component(Primer::SpinnerComponent) %>.
+    renders_one :spinner, lambda { |**system_arguments|
+      system_arguments[:mb] ||= 3
+      Primer::SpinnerComponent.new(**system_arguments)
+    }
+
+    #
+    # @example Basic
+    #   <%= render Primer::BlankslateComponent.new(
+    #     title: "Title",
+    #     description: "Description",
+    #   ) %>
+    #
+    # @example Icon
+    #   @description
+    #     Add an `icon` to give additional context. Refer to the [Octicons](https://primer.style/octicons/) documentation to choose an icon.
+    #   @code
+    #     <%= render Primer::BlankslateComponent.new(
+    #       icon: :globe,
+    #       title: "Title",
+    #       description: "Description",
+    #     ) %>
+    #
+    # @example Loading
+    #   @description
+    #     Add a [SpinnerComponent](https://primer.style/view-components/components/spinner) to the blankslate in place of an icon.
+    #   @code
+    #     <%= render Primer::BlankslateComponent.new(
+    #       title: "Title",
+    #       description: "Description",
+    #     ) do |component| %>
+    #       <% component.spinner(size: :large) %>
+    #     <% end %>
+    #
+    # @example Custom content
+    #   @description
+    #     Pass custom content as a block in place of `description`.
+    #   @code
+    #     <%= render Primer::BlankslateComponent.new(
+    #       title: "Title",
+    #     ) do %>
+    #       <em>Your custom content here</em>
+    #     <% end %>
+    #
+    # @example Action button
+    #   @description
+    #     Provide a button to guide users to take action from the blankslate. The button appears below the description and custom content.
+    #   @code
+    #     <%= render Primer::BlankslateComponent.new(
+    #       icon: :book,
+    #       title: "Welcome to the mona wiki!",
+    #       description: "Wikis provide a place in your repository to lay out the roadmap of your project, show the current status, and document software better, together.",
+    #
+    #       button_text: "Create the first page",
+    #       button_url: "https://github.com/monalisa/mona/wiki/_new",
+    #     ) %>
+    #
+    # @example Link
+    #   @description
+    #     Add an additional link to help users learn more about a feature. The link will be shown at the very bottom:
+    #   @code
+    #     <%= render Primer::BlankslateComponent.new(
+    #       icon: :book,
+    #       title: "Welcome to the mona wiki!",
+    #       description: "Wikis provide a place in your repository to lay out the roadmap of your project, show the current status, and document software better, together.",
+    #       link_text: "Learn more about wikis",
+    #       link_url: "https://docs.github.com/en/github/building-a-strong-community/about-wikis",
+    #     ) %>
+    #
+    # @example Variations
+    #   @description
+    #     There are a few variations of how the Blankslate appears: `narrow` adds a maximum width, `large` increases the font size, and `spacious` adds extra padding.
+    #   @code
+    #     <%= render Primer::BlankslateComponent.new(
+    #       icon: :book,
+    #       title: "Welcome to the mona wiki!",
+    #       description: "Wikis provide a place in your repository to lay out the roadmap of your project, show the current status, and document software better, together.",
+    #       narrow: true,
+    #       large: true,
+    #       spacious: true,
+    #     ) %>
+    #
+    # @param title [String] Text that appears in a larger bold font.
+    # @param title_tag [Symbol] HTML tag to use for title.
+    # @param icon [Symbol] Octicon icon to use at top of component.
+    # @param icon_size [Symbol] <%= one_of(Primer::OcticonComponent::SIZE_MAPPINGS, sort: false) %>
+    # @param image_src [String] Image to display.
+    # @param image_alt [String] Alt text for image.
+    # @param description [String] Text that appears below the title. Typically a whole sentence.
+    # @param button_text [String] The text of the button.
+    # @param button_url [String] The URL where the user will be taken after clicking the button.
+    # @param button_classes [String] Classes to apply to action button
+    # @param link_text [String] The text of the link.
+    # @param link_url [String] The URL where the user will be taken after clicking the link.
+    # @param narrow [Boolean] Adds a maximum width.
+    # @param large [Boolean] Increases the font size.
+    # @param spacious [Boolean] Adds extra padding.
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(
+      title: "",
+      title_tag: :h3,
+      icon: "",
+      icon_size: :medium,
+      image_src: "",
+      image_alt: " ",
+      description: "",
+      button_text: "",
+      button_url: "",
+      button_classes: "btn-primary my-3",
+      link_text: "",
+      link_url: "",
+
+      # variations
+      narrow: false,
+      large: false,
+      spacious: false,
+
+      **system_arguments
+    )
+      @system_arguments = system_arguments
+      @system_arguments[:tag] = :div
+      @system_arguments[:classes] = class_names(
+        @system_arguments[:classes],
+        "blankslate",
+        "blankslate-narrow": narrow,
+        "blankslate-large": large,
+        "blankslate-spacious": spacious
+      )
+
+      @title_tag = title_tag
+      @icon = icon
+      @icon_size = icon_size
+      @image_src = image_src
+      @image_alt = image_alt
+      @title = title
+      @description = description
+      @button_text = button_text
+      @button_url = button_url
+      @button_classes = button_classes
+      @link_text = link_text
+      @link_url = link_url
+    end
   end
 end

data/app/components/primer/link_component.rb

@@ -79,5 +79,19 @@ module Primer
     def before_render
       raise ArgumentError, "href is required when using <a> tag" if @system_arguments[:tag] == :a && @system_arguments[:href].nil? && !Rails.env.production?
     end
+
+    def call
+      if tooltip.present?
+        render Primer::BaseComponent.new(tag: :span, position: :relative) do
+          render(Primer::BaseComponent.new(**@system_arguments)) do
+            content
+          end.to_s + tooltip.to_s
+        end
+      else
+        render(Primer::BaseComponent.new(**@system_arguments)) do
+          content
+        end
+      end
+    end
   end
 end

data/app/helpers/primer/form_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Primer
+  # :nodoc:
+  module FormHelper
+    def primer_form_with(**kwargs, &block)
+      form_with(**kwargs, skip_default_ids: false, builder: Primer::Forms::Builder, &block)
+    end
+  end
+end

data/lib/primer/form_components.rb

@@ -17,7 +17,7 @@ module Primer
         end
 
         def call
-          builder = ActionView::Helpers::FormBuilder.new(
+          builder = Primer::Forms::Builder.new(
             nil, nil, __vc_original_view_context, {}
           )
 
@@ -28,7 +28,7 @@ module Primer
             &@block
           )
 
-          input.render_in(__vc_original_view_context) { content }
+          input.to_component.render_in(__vc_original_view_context) { content }
         end
       end
     end

data/lib/primer/forms/base.html.erb

@@ -1,6 +1,6 @@
 <%= render(SpacingWrapper.new) do %>
   <% inputs.each do |input| %>
-    <%= render(input) %>
+    <%= render(input.to_component) %>
   <% end %>
 <% end %>
 <% if after_content? %>

data/lib/primer/forms/base.rb

@@ -17,6 +17,11 @@ module Primer
         end
 
         def new(builder, **options)
+          if builder && !builder.is_a?(Primer::Forms::Builder)
+            raise ArgumentError, "please pass an instance of Primer::Forms::Builder when "\
+              "constructing a form object (consider using the `primer_form_with` helper)"
+          end
+
           allocate.tap do |form|
             form.instance_variable_set(:@builder, builder)
             form.send(:initialize, **options)

data/lib/primer/forms/base_component.rb

@@ -39,6 +39,10 @@ module Primer
         false
       end
 
+      def to_component
+        self
+      end
+
       private
 
       def compile_and_render_template

data/lib/primer/forms/buffer_rewriter.rb

@@ -16,8 +16,9 @@ module Primer
           code.dup.tap do |result|
             parser.var_refs.reverse_each do |lineno, stop|
               line_offset = line_offsets[lineno]
-              start = (stop - "@output_buffer".length) + line_offset
               stop += line_offset
+              stop -= 1 if stop < code.length
+              start = stop - "@output_buffer".length
               result[start...stop] = "output_buffer"
             end
           end
@@ -39,7 +40,7 @@ module Primer
       def on_var_ref(var)
         return unless var == "@output_buffer"
 
-        var_refs << [lineno, column - 1]
+        var_refs << [lineno, column]
       end
 
       def var_refs

data/lib/primer/forms/builder.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "primer/classify"
+
+module Primer
+  module Forms
+    # :nodoc:
+    class Builder < ActionView::Helpers::FormBuilder
+      include Primer::ClassNameHelper
+
+      UTILITY_KEYS = Primer::Classify::Utilities::UTILITIES.keys.freeze
+
+      def label(*args, **options, &block)
+        super(*args, classify(options), &block)
+      end
+
+      def check_box(*args, **options, &block)
+        super(*args, classify(options), &block)
+      end
+
+      def radio_button(*args, **options, &block)
+        super(*args, classify(options), &block)
+      end
+
+      def select(*args, **options, &block)
+        super(*args, classify(options), &block)
+      end
+
+      def text_field(*args, **options, &block)
+        super(*args, classify(options), &block)
+      end
+
+      def text_area(*args, **options, &block)
+        super(*args, classify(options), &block)
+      end
+
+      private
+
+      def classify(options)
+        options[:classes] = class_names(options.delete(:class), options[:classes])
+        options.merge!(Primer::Classify.call(options))
+        options.except!(*UTILITY_KEYS)
+        options[:class] = class_names(options[:class], options.delete(:classes))
+        options
+      end
+    end
+  end
+end

data/lib/primer/forms/check_box_group.html.erb

@@ -6,7 +6,7 @@
   <% end %>
   <%= render(SpacingWrapper.new) do %>
     <% @input.check_boxes.each do |check_box| %>
-      <%= render(check_box) %>
+      <%= render(check_box.to_component) %>
     <% end %>
   <% end %>
 </fieldset>

data/lib/primer/forms/dsl/input.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "primer/classify"
-
 module Primer
   module Forms
     module Dsl
@@ -16,8 +14,6 @@ module Primer
         }.freeze
         SIZE_OPTIONS = SIZE_MAPPINGS.keys
 
-        UTILITY_KEYS = Primer::Classify::Utilities::UTILITIES.keys.freeze
-
         include Primer::ClassNameHelper
 
         attr_reader :builder, :form, :input_arguments, :label_arguments, :caption, :validation_message, :ids
@@ -27,14 +23,11 @@ module Primer
           @form = form
 
           @input_arguments = system_arguments
-          process_classes!(@input_arguments)
-
           @label_arguments = @input_arguments.delete(:label_arguments) || {}
-          process_classes!(@label_arguments)
 
           @label_arguments[:class] = class_names(
             @label_arguments[:class],
-            @input_arguments.fetch(:visually_hide_label, true) ? "sr-only" : nil
+            @input_arguments.fetch(:visually_hide_label, false) ? "sr-only" : nil
           )
 
           @input_arguments.delete(:visually_hide_label)
@@ -207,23 +200,8 @@ module Primer
           true
         end
 
-        # Avoid using Rails delegation here for performance reasons
-        # rubocop:disable Rails/Delegate
-        def render_in(view_context)
-          to_component.render_in(view_context)
-        end
-        # rubocop:enable Rails/Delegate
-
         private
 
-        def process_classes!(args)
-          args[:classes] = class_names(args.delete(:class), args[:classes])
-          args.merge!(Primer::Classify.call(args))
-          args[:class] = class_names(args[:class], args.delete(:classes))
-          args.except!(*UTILITY_KEYS)
-          args
-        end
-
         def input_data
           @input_arguments[:data] ||= {}
         end

data/lib/primer/forms/dsl/input_group.rb

@@ -28,13 +28,6 @@ module Primer
         def input?
           true
         end
-
-        # Avoid using Rails delegation here for performance reasons
-        # rubocop:disable Rails/Delegate
-        def render_in(view_context)
-          to_component.render_in(view_context)
-        end
-        # rubocop:enable Rails/Delegate
       end
     end
   end

data/lib/primer/forms/group.html.erb

@@ -1,5 +1,5 @@
 <%= content_tag_if(horizontal?, :div, class: "d-flex", style: "gap: 15px;") do %>
   <% @inputs.each do |input| %>
-    <%= render(input) %>
+    <%= render(input.to_component) %>
   <% end %>
 <% end %>

data/lib/primer/forms/multi.html.erb

@@ -1,3 +1,3 @@
 <% @input.inputs.each do |child_input| %>
-  <%= render(child_input) %>
+  <%= render(child_input.to_component) %>
 <% end %>

data/lib/primer/view_components/engine.rb

@@ -15,6 +15,7 @@ module Primer
 
       config.eager_load_paths = %W[
         #{root}/app/components
+        #{root}/app/helpers
         #{root}/app/lib
       ]
 
@@ -39,6 +40,16 @@ module Primer
         end
       end
 
+      initializer "primer.forms.helpers" do
+        ActiveSupport.on_load :action_controller do
+          require "primer/form_helper"
+          helper Primer::FormHelper
+
+          # make primer_form_with available to view components also
+          ViewComponent::Base.prepend(Primer::FormHelper)
+        end
+      end
+
       initializer "primer_view_components.zeitwerk_ignore" do
         Rails.autoloaders.each do |autoloader|
           autoloader.ignore(Engine.root.join("lib", "primer", "view_components", "linters.rb"))

data/lib/primer/view_components/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.0.86
+  version: 0.0.87
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.57.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -68,7 +68,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.57.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -450,6 +450,7 @@ files:
 - app/components/primer/beta/text.rb
 - app/components/primer/beta/truncate.html.erb
 - app/components/primer/beta/truncate.rb
+- app/components/primer/blankslate_component.html.erb
 - app/components/primer/blankslate_component.rb
 - app/components/primer/border_box_component.rb
 - app/components/primer/box_component.rb
@@ -497,7 +498,6 @@ files:
 - app/components/primer/label_component.rb
 - app/components/primer/layout_component.html.erb
 - app/components/primer/layout_component.rb
-- app/components/primer/link_component.html.erb
 - app/components/primer/link_component.rb
 - app/components/primer/local_time.d.ts
 - app/components/primer/local_time.js
@@ -536,6 +536,7 @@ files:
 - app/components/primer/timeline_item_component.rb
 - app/components/primer/tooltip.rb
 - app/components/primer/truncate.rb
+- app/helpers/primer/form_helper.rb
 - app/lib/primer/audited/dsl.rb
 - app/lib/primer/class_name_helper.rb
 - app/lib/primer/fetch_or_fallback_helper.rb
@@ -557,6 +558,7 @@ files:
 - lib/primer/forms/base.rb
 - lib/primer/forms/base_component.rb
 - lib/primer/forms/buffer_rewriter.rb
+- lib/primer/forms/builder.rb
 - lib/primer/forms/caption.html.erb
 - lib/primer/forms/caption.rb
 - lib/primer/forms/check_box.html.erb

data/app/components/primer/link_component.html.erb

@@ -1,12 +0,0 @@
-<% if tooltip.present? %>
-  <%= render Primer::BaseComponent.new(tag: :span, position: :relative) do %>
-    <%= render Primer::BaseComponent.new(**@system_arguments) do %>
-      <% content %>
-    <% end %>
-    <%= tooltip %>
-  <% end %>
-<% else %>
-  <%= render Primer::BaseComponent.new(**@system_arguments) do %>
-    <% content %>
-  <% end %>
-<% end %>