primer_view_components 0.0.115 → 0.0.116

data/app/components/primer/hellip_button.rb

@@ -8,8 +8,6 @@ module Primer
   #   * This button is displaying a hellip as its content (The three dots character). Therefore a label is needed for screen readers.
   #   * Set the attribute `aria-label` on the system arguments. E.g. `Primer::HellipButton.new("aria-label": "Expand next part")`
   class HellipButton < Primer::Component
-    warn_on_deprecated_slot_setter
-
     # @example Default
     #   <%= render(Primer::HellipButton.new("aria-label": "No effect")) %>
     #

data/app/components/primer/icon_button.rb

@@ -12,7 +12,6 @@ module Primer
   #   Either `aria-label` or `aria-description` will be used for the `Tooltip` text, depending on which one is present.
   #   [Learn more about best functional image practices (WAI Images)](https://www.w3.org/WAI/tutorials/images/functional)
   class IconButton < Primer::Component
-    warn_on_deprecated_slot_setter
     status :deprecated
 
     DEFAULT_SCHEME = :default

data/app/components/primer/layout_component.rb

@@ -3,8 +3,6 @@
 module Primer
   # Use `Layout` to build a main/sidebar layout.
   class LayoutComponent < Primer::Component
-    warn_on_deprecated_slot_setter
-
     # The main content
     #
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>

data/app/components/primer/local_time.rb

@@ -3,7 +3,6 @@
 module Primer
   # Use `LocalTime` to format a date and time in the user's preferred locale format. This component requires JavaScript.
   class LocalTime < Primer::Component
-    warn_on_deprecated_slot_setter
     status :deprecated
 
     DEFAULT_DIGIT_TYPE = :numeric

data/app/components/primer/octicon_component.rb

@@ -2,7 +2,6 @@
 
 module Primer
   class OcticonComponent < Primer::Beta::Octicon
-    warn_on_deprecated_slot_setter
     status :deprecated
   end
 end

data/app/components/primer/state_component.rb

@@ -3,7 +3,6 @@
 module Primer
   # Use `State` for rendering the status of an item.
   class StateComponent < Primer::Component
-    warn_on_deprecated_slot_setter
     status :beta
 
     SCHEME_DEFAULT = :default

data/app/components/primer/subhead_component.rb

@@ -11,8 +11,6 @@ module Primer
   #   The `:heading` slot defaults to rendering a `<div>`. Update the tag to a heading element with the appropriate level to improve page navigation for assistive technologies.
   #   <%= link_to_heading_practices %>
   class SubheadComponent < Primer::Component
-    warn_on_deprecated_slot_setter
-
     status :beta
 
     DEFAULT_HEADING_TAG = :div

data/app/components/primer/tab_container_component.rb

@@ -6,8 +6,6 @@ module Primer
   #
   # This component requires javascript.
   class TabContainerComponent < Primer::Component
-    warn_on_deprecated_slot_setter
-
     # @example Default
     #   <%= render(Primer::TabContainerComponent.new)  do %>
     #     <div role="tablist">

data/app/components/primer/time_ago_component.rb

@@ -3,7 +3,6 @@
 module Primer
   # Use `TimeAgo` to display a time relative to how long ago it was. This component requires JavaScript.
   class TimeAgoComponent < Primer::Component
-    warn_on_deprecated_slot_setter
     status :deprecated
 
     # @example Default

data/app/components/primer/timeline_item_component.rb

@@ -3,7 +3,6 @@
 module Primer
   # Use `TimelineItem` to display items on a vertical timeline, connected by badge elements.
   class TimelineItemComponent < Primer::Component
-    warn_on_deprecated_slot_setter
     status :beta
 
     # Avatar to be rendered to the left of the Badge.

data/app/components/primer/tooltip.rb

@@ -3,7 +3,6 @@
 module Primer
   # `Tooltip` is a wrapper component that will apply a tooltip to the provided content.
   class Tooltip < Primer::Component
-    warn_on_deprecated_slot_setter
     status :deprecated
 
     DIRECTION_DEFAULT = :n

data/app/components/primer/truncate.rb

@@ -3,8 +3,6 @@
 module Primer
   # Use `Truncate` to shorten overflowing text with an ellipsis.
   class Truncate < Primer::Component
-    warn_on_deprecated_slot_setter
-
     status :beta
 
     DEFAULT_TAG = :div

data/lib/primer/forms/builder.rb

@@ -33,6 +33,8 @@ module Primer
 
       UTILITY_KEYS = Primer::Classify::Utilities::UTILITIES.keys.freeze
 
+      alias primer_fields_for fields_for
+
       def label(method, text = nil, **options, &block)
         super(method, text, classify(options).merge(generate_error_markup: false), &block)
       end
@@ -72,9 +74,6 @@ module Primer
       #    is expected by Rails/HTML while the second is specific to Primer.
       # 3. Combines options[:class] and options[:classes] into options[:class]
       #    so the options hash can be easily passed to Rails form builder methods.
-      # 4. Sets generate_error_markup: false, which, in combination with the
-      #    monkeypatch at the top of this file, skips rendering any markup around
-      #    invalid fields.
       #
       def classify(options)
         options[:classes] = class_names(options.delete(:class), options[:classes])

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

@@ -5,11 +5,34 @@ module Primer
     module Dsl
       # :nodoc:
       class FormReferenceInput < Input
-        attr_reader :ref_block, :fields_for_args, :fields_for_kwargs
+        attr_reader :ref_block, :fields_for_args, :fields_for_kwargs, :nested
+        alias nested? nested
 
-        def initialize(*fields_for_args, builder:, form:, **fields_for_kwargs, &block)
+        # Pass `nested: false` to prevent the referenced form fields from being treated as nested
+        # under the parent form's model. For example, consider these models:
+
+        # class User < ActiveRecord::Base
+        #   has_many :addresses
+        # end
+
+        # class Address < ActiveRecord::Base
+        #   belongs_to :user
+        # end
+
+        # A sign-up form might include fields from `User` as well as `Address`. Since addresses are
+        # associated with users, it's perfectly natural to accept the address fields as nested
+        # attributes. Rails will name each field accordingly. For example, the `street` field on
+        # `Address` will be named `user[address][street]`.
+
+        # For situations like this where an association exists between two models, the nested
+        # attributes approach works great. However sometimes all you want is to compose two forms
+        # together that aren't connected by an association. In such cases the fields will still
+        # include the name of the parent model, eg. `user[address][street]` instead of what we want,
+        # `address[street]`. To render the form independent of the parent, pass `nested: false`.
+        def initialize(*fields_for_args, builder:, form:, nested: true, **fields_for_kwargs, &block)
           @fields_for_args = fields_for_args
           @fields_for_kwargs = fields_for_kwargs
+          @nested = nested
           @ref_block = block
 
           super(builder: builder, form: form, **fields_for_kwargs)

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

@@ -43,6 +43,33 @@ module Primer
           @full_width = @input_arguments.delete(:full_width)
           @size = @input_arguments.delete(:size)
 
+          # If scope_name_to_model is false, the name of the input for eg. `my_field`
+          # will be `my_field` instead of the Rails default of `model[my_field]`.
+          #
+          # We achieve this by passing the `name` option to Rails form builder
+          # methods. These methods will use the passed name if provided instead
+          # of generating a scoped one.
+          #
+          # rubocop:disable Style/IfUnlessModifier
+          unless @input_arguments.delete(:scope_name_to_model) { true }
+            @input_arguments[:name] = name
+          end
+          # rubocop:enable Style/IfUnlessModifier
+
+          # If scope_id_to_model is false, the name of the input for eg. `my_field`
+          # will be `my_field` instead of the Rails default of `model_my_field`.
+          #
+          # We achieve this by passing the `id` option to Rails form builder
+          # methods. These methods will use the passed id if provided instead
+          # of generating a scoped one. The id is the name of the field unless
+          # explicitly provided in system_arguments.
+          #
+          # rubocop:disable Style/IfUnlessModifier
+          unless @input_arguments.delete(:scope_id_to_model) { true }
+            @input_arguments[:id] = @input_arguments.delete(:id) { name }
+          end
+          # rubocop:enable Style/IfUnlessModifier
+
           # Whether or not to wrap the component in a FormControl, which renders a
           # label above and validation message beneath the input.
           @form_control = @input_arguments.delete(:form_control) { true }

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

@@ -1,3 +1,3 @@
-<%= builder.fields_for(*@input.fields_for_args, **@input.fields_for_kwargs) do |fields| %>
+<%= builder_or_view.primer_fields_for(*@input.fields_for_args, **@input.fields_for_kwargs) do |fields| %>
   <%= render(@input.ref_block.call(fields)) %>
 <% end %>

data/lib/primer/forms/form_reference.rb

@@ -9,6 +9,10 @@ module Primer
       def initialize(input:)
         @input = input
       end
+
+      def builder_or_view
+        @input.nested? ? builder : @view_context
+      end
     end
   end
 end

data/lib/primer/view_components/version.rb

@@ -6,7 +6,7 @@ module Primer
     module VERSION
       MAJOR = 0
       MINOR = 0
-      PATCH = 115
+      PATCH = 116
 
       STRING = [MAJOR, MINOR, PATCH].join(".")
     end

data/previews/primer/alpha/tab_panels_preview.rb

@@ -9,11 +9,11 @@ module Primer
       # @param number_of_panels [Integer] number
       # @param align [Symbol] select [left, right]
       def playground(number_of_panels: 3, align: :left)
-        render(Primer::Alpha::TabPanels.new(label: "label", align: align)) do |c|
+        render(Primer::Alpha::TabPanels.new(label: "label", align: align)) do |component|
           Array.new(number_of_panels || 3) do |i|
-            c.tab(selected: i.zero?, id: "tab-#{i + 1}") do |t|
-              t.panel { "Panel #{i + 1}" }
-              t.text { "Tab #{i + 1}" }
+            component.tab(selected: i.zero?, id: "tab-#{i + 1}") do |tab|
+              tab.with_panel { "Panel #{i + 1}" }
+              tab.with_text { "Tab #{i + 1}" }
             end
           end
         end
@@ -24,11 +24,11 @@ module Primer
       # @param number_of_panels [Integer] number
       # @param align [Symbol] select [left, right]
       def default(number_of_panels: 3, align: :left)
-        render(Primer::Alpha::TabPanels.new(label: "label", align: align)) do |c|
+        render(Primer::Alpha::TabPanels.new(label: "label", align: align)) do |component|
           Array.new(number_of_panels || 3) do |i|
-            c.tab(selected: i.zero?, id: "tab-#{i + 1}") do |t|
-              t.panel { "Panel #{i + 1}" }
-              t.text { "Tab #{i + 1}" }
+            component.tab(selected: i.zero?, id: "tab-#{i + 1}") do |tab|
+              tab.with_panel { "Panel #{i + 1}" }
+              tab.with_text { "Tab #{i + 1}" }
             end
           end
         end

data/previews/primer/beta/details_preview.rb

@@ -39,9 +39,9 @@ module Primer
       # @param overlay [Symbol] select [none, default, dark]
       # @param reset [Boolean] toggle
       def custom_button(reset: false, overlay: :default)
-        render Primer::Beta::Details.new(reset: reset, overlay: overlay) do |c|
-          c.summary(size: :small, scheme: :primary) { "Click me" }
-          c.body { "Body" }
+        render Primer::Beta::Details.new(reset: reset, overlay: overlay) do |component|
+          component.with_summary(size: :small, scheme: :primary) { "Click me" }
+          component.with_body { "Body" }
         end
       end
 
@@ -50,9 +50,9 @@ module Primer
       # @param overlay [Symbol] select [none, default, dark]
       # @param reset [Boolean] toggle
       def without_button(reset: false, overlay: :default)
-        render Primer::Beta::Details.new(reset: reset, overlay: overlay) do |c|
-          c.summary(button: false) { "Click me" }
-          c.body { "Body" }
+        render Primer::Beta::Details.new(reset: reset, overlay: overlay) do |component|
+          component.with_summary(button: false) { "Click me" }
+          component.with_body { "Body" }
         end
       end
     end

data/previews/primer/local_time_component_preview.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Primer/ComponentNameMigration
+
 module Primer
   # @label LocalTime
   class LocalTimeComponentPreview < ViewComponent::Preview
@@ -52,3 +54,4 @@ module Primer
     end
   end
 end
+# rubocop:enable Primer/ComponentNameMigration

data/previews/primer/time_ago_component_preview.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Primer/ComponentNameMigration
+
 module Primer
   # @label TimeAgoComponent
   class TimeAgoComponentPreview < ViewComponent::Preview
@@ -22,3 +24,4 @@ module Primer
     end
   end
 end
+# rubocop:enable Primer/ComponentNameMigration

data/previews/primer/url_helpers.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
+  # :nodoc:
   module URLHelpers
     class << self
       # use send to avoid yard warning
@@ -8,8 +9,7 @@ module Primer
 
       private
 
-      def controller
-      end
+      def controller; 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.115
+  version: 0.0.116
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-13 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview