view_component_attributes 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ededd2236874dfc8ff92082cd9174bb62e90198a0e76bc61fd99415f252c470
+  data.tar.gz: d9fa9e3e6080d34ae04ec9c2cf419fe4a04881866805750718cb04e6899ef8b5
+SHA512:
+  metadata.gz: d9dbd59ff20a1e3bd4c07c1fbf86d361a5894f4ddc59a6096a7a5d16b820a918e5fcb1ce532273f87bce6b4963ae538c30a02b2509e730357853cf6e38a0e5a4
+  data.tar.gz: abf4456e69ff5f3ff5cae3d386cac1727742992e6c97c4c697c91aaacd74f724c3c7a5f0944212bede66dacb3900f33acef352a8f02724a21e96db539c124674

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--order rand

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at romaric.pascal@amba.co. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# TODO: Release on Rubygem so it can be set up in the gemspec file
+gem "merge_attributes", github: "Amba-Health/merge_attributes", ref: "d7810fd"
+
+group :test do
+  gem "tzinfo-data", platforms: %i[mingw mswin x64_mingw jruby]
+end
+
+# Specify your gem's dependencies in view_component_attributes.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,236 @@
+GIT
+  remote: https://github.com/Amba-Health/merge_attributes
+  revision: d7810fd7c175d5229fefb631f4b9d4295aa70d24
+  ref: d7810fd
+  specs:
+    merge_attributes (0.1.1)
+      activesupport (>= 6.1.0)
+      rails (>= 6.1.0)
+
+PATH
+  remote: .
+  specs:
+    view_component_attributes (0.1.1)
+      actionview
+      activemodel
+      activesupport
+      view_component
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activejob (= 6.1.6.1)
+      activerecord (= 6.1.6.1)
+      activestorage (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      actionview (= 6.1.6.1)
+      activejob (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.6.1)
+      actionview (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activerecord (= 6.1.6.1)
+      activestorage (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.6.1)
+      activesupport (= 6.1.6.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.6.1)
+      activesupport (= 6.1.6.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.6.1)
+      activesupport (= 6.1.6.1)
+    activerecord (6.1.6.1)
+      activemodel (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+    activestorage (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activejob (= 6.1.6.1)
+      activerecord (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.6.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    capybara (3.36.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    matrix (0.4.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.16.2)
+    nio4r (2.5.8)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.7)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (6.1.6.1)
+      actioncable (= 6.1.6.1)
+      actionmailbox (= 6.1.6.1)
+      actionmailer (= 6.1.6.1)
+      actionpack (= 6.1.6.1)
+      actiontext (= 6.1.6.1)
+      actionview (= 6.1.6.1)
+      activejob (= 6.1.6.1)
+      activemodel (= 6.1.6.1)
+      activerecord (= 6.1.6.1)
+      activestorage (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.6.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-rails (5.1.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.11.0)
+    rubocop (1.32.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    sprockets (4.1.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    standard (1.14.0)
+      rubocop (= 1.32.0)
+      rubocop-performance (= 1.14.3)
+    standardrb (1.0.1)
+      standard
+    thor (1.2.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    view_component (2.63.0)
+      activesupport (>= 5.0.0, < 8.0)
+      method_source (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  capybara
+  merge_attributes!
+  rails (>= 6.1.0)
+  rake (>= 12.2)
+  rspec (~> 3.0)
+  rspec-rails
+  standardrb
+  tzinfo-data
+  view_component_attributes!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Amba Health & Care
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,276 @@
+# ViewComponentAttributes
+
+This Gem helps the management of attributes received by View Components (or props, options, however you name them). It offers a set of concerns to mix into your components to:
+
+- declare the attributes your component expects to receive. Backed by ActiveModel's API for familiarity
+- collect attributes not declared by the component, for later use as HTML attributes in rendering to set ad-hoc classes or Stimulus controllers, for example
+- declaring a component's "root" element and managing its attributes either in the class or the template
+- merging attributes coming from outside the component with those computed inside its class and template
+- defining temporary defaults for component's attributes, allowing to customise the rendering of sub-components without passing attributes at each step
+
+You can buy in as much or as little of this as you want by picking the concerns you include, it's up to you.
+
+## Usage
+
+Pick and chose the concern to include in your components to give them more or less power
+
+###  `WithAttributes`: Declare expected attributes
+
+Include the `WithAttributes` concern to let your component declare the attributes it expects with the same `attribute` API as ActiveModel (a similar take as [`view_component-contrib`'s use of `dry-initializer`](https://github.com/palkan/view_component-contrib#hanging-initialize-out-to-dry)).
+
+```rb
+class MyComponent < ViewComponent::Base
+    include ViewComponentAttributes::WithAttributes
+
+    attribute :some_attribute
+    attribute :attribute_with_default, default: 5
+
+    # If you need to compute a default based on other attributes
+    # you can override the getter and use ActiveModel's `attribute`
+    # method to read any value provided to the component
+    attribute :attribute_with_computed_default
+    def attribute_with_computed_default
+        attribute(:attribute_with_computed_default) || do_some_computation
+    end
+end
+```
+
+### `WithUnknownAttributes`: Collect unknown attributes for later use
+
+By default `ActiveModel` will throw if you use unknown attributes during initialization. This makes models safer, but when it comes to the view, you often need to add attributes that shouldn't be the responsibility of the component itself:
+
+- new `class`es because of where the component is rendered, or an `id` to be referenced by `aria-labelledby` or `aria-controls` for accessibility...
+- Stimulus attributes to make the component a [target](https://stimulus.hotwired.dev/reference/targets), trigger an [action](https://stimulus.hotwired.dev/reference/actions) or maybe just some extra [controllers](https://stimulus.hotwired.dev/reference/controllers).
+
+Include the `WithUnknownAttributes` concern to avoid an error being thrown and the extra attributes made available through the `unknown_attributes` method.
+
+_Includes `WithAttribute`_
+
+```rb
+class MyComponent < ViewComponent::Base
+    include ViewComponentAttributes::WithUnknownAttributes
+end
+
+component = MyComponent.new(class:'some-class', id: 'some-id')
+component.unknown_attributes # {:class=>"some-class", :id=>"some-id"}
+```
+
+### `WithRoot` and `WithRootAttributes`: Declare a component's root element and manage its attributes
+
+Most components have their content wrapped by a single root element or sub-component. `WithRoot` and `WithRootAttributes` help you define which element or component to use, and combine attributes from different places in a standardised way: declarative defaults (that can be computed), component's template and component's initialization.
+
+They can each be used independently, but work best together:
+
+```rb
+class MyComponent < ViewComponent::Base
+    # Needs to be first to ensure its `root_attributes` method
+    # gets overriden as necessary by that of `WithRootAttributes`
+    include ViewComponentAttributes::WithRoot
+    include WithComponentAttributes::WithRootAttributes
+end
+```
+
+#### Configuring the component's root element/component
+
+`WithRoot` provides some help for declaring and rendering the component's root element or component.
+
+From the template or the component's `call` method, the **`root` instance method** renders the root of the component.
+
+    ```erb
+    <%# my_component.html.erb %>
+    <%= root(:article, class: "a-class", id: "an-id") do %>
+        <%# Inside of the component gets rendered here %>
+    <% end %>
+    ```
+
+The element or component's class to render can be passed as first positional parameters: a class will be treated as a component, anything else sent to the [`tag` helper](https://api.rubyonrails.org/v7.0.2/classes/ActionView/Helpers/TagHelper.html#method-i-tag).
+
+If you don't provide any, whichever you provided using the `root` class method. This can help keep code related to each other in the same place rather than split across class and template. Default is a `<div>`, but please do take some time to use [elements with built-in semantics](https://developer.mozilla.org/en-US/docs/Web/HTML/Element) to give your users the best experience).
+
+    ```rb
+    class MyComponent < ViewComponent::Base
+        root AnotherComponent
+    end
+    ```
+
+That element or component will be rendered with the provided attributes and the block containing what's inside it.
+
+Why not plainly set the element in the template (or `call`)? Using the `root` method sets you up for a consitent way to make computations for the rendering ot component's root:
+
+- **picking the element or component of the root** with the `root_type` method when none is provided in the template. For example, this list component can switch its semantics based on an `ordered` attribute:
+
+    ```rb
+    class ListComponent < ViewComponent::Base
+        include ViewComponentAttributes::WithAttributes
+        include ViewComponentAttributes::WithRoot
+
+        attribute :ordered
+
+        def root_type(template_root)
+            if (ordered)
+                :ol
+            else
+                :ul
+            end
+        end
+
+        def call
+            root {content}
+        end
+    end
+    ```
+
+- **computing the attributes of that root element/component**, with the `root_attributes` method, potentially merging them from different origins.
+That's what the `WithRootAttributes` concern takes advantage of to work its wonders.
+
+####  Configuring the component's root attributes
+
+`WithRoot` provides some structure, but is really mostly a setup for `WithRootAttribute`. This concern is responsible for mixing attributes coming from different part of the components:
+
+- default attributes configured at class level, using the **`root_attributes` class method** (either as a hash, or a block if they require computations)
+- attributes passed to the `root` method (or the **`root_attributes` instance method** if you need to compute root attributes for a helper like `link_to` or `form_for`)
+- attributes passed to the component at initialization, those explicitely passed as the `root_attributes` attributes, as well as all the `unknown_attributes` gathered by the `WithUnknownAttributes` concern
+
+```rb
+class PostComponent
+    include WithRoot
+    include WithRootAttributes
+
+    attribute :heading
+
+    # At class-level, the root attributes can take
+    # various shape:
+    # A static set of attributes...
+    root_attributes({class: 'a-class'})
+    #
+    # ...or a block, when computations are needed.
+    #
+    # That block can return a hash...
+    root_attributes do
+        {
+            class: compute_the_class
+        }
+    end
+    # 
+    # ... or an array of hashes, allowing to separate different sets of attributes
+    #
+    root_attributes do
+        [
+            {
+                class: compute_the_class
+            },
+            attributes_for_responsibility_a
+            attributes_for_responsibility_b
+        ]
+    end
+
+    def attributes_for_responsibility_a
+        # ...
+    end
+    def attributes_for_responsibility_b
+        # ...
+    end
+end
+```
+
+```erb
+<%# 
+    These extra attributes will be merged with the defaults,
+    allowing them to stay grouped in the same file for easier understanding
+%>
+<%= root(:article, class: 'blog-article') do %>
+    <h1 class="blog-article__heading"><%= heading %></h1>
+    <div class="blog-article__body">
+        <%= content %>
+    </div>
+<% end %>
+```
+
+```erb
+<%# 
+    Finally, attributes from instanciation will get merged in as well,
+    allowing to set extra attributes based on: 
+    - where the component is rendered,
+    - what data it's rendering 
+    - or anything else it's not responsible for.
+    In case of collision of a root_attribute with one of the component,
+    you can use the `root_attributes` attribute to make sure of which is which.
+%>
+<%= render PostComponent.new(
+    heading: post.title, 
+    id: dom_id(post),
+    class: 'post-list__post'
+) do %>
+    <%= post.content %>
+<% end %>
+```
+
+### `WithContextAttributes`: Setting temporary default attributes
+
+Sometimes you have a `GrandParentComponent`, that renders a `ParentComponent`, that then renders a `ChildComponent`, which finally renders a `GrandChildComponent`. It's all nice... until in a specific scenario that `GrandChildComponent` needs an extra attribute, for that one time only.
+
+Sure the `GrandParentComponent` could take it, pass it down, and so could the `ParentComponent` and the `ChildComponent`... until it reaches the `GrandChildComponent`. That's one more responsibility for them, which is not ideal. And after all, it's all the `GrandChildComponent` fault if that needs to happen so best it be the one handling it.
+
+That's what the `WithContextAttributes` mixin handles. It adds a `with_attributes` class method to the `GrandChildComponent` to temporarily set defaults:
+
+```erb
+<% GrandChildComponent.with_attributes('data-accordion-target': 'content') do %>
+    <%# 
+        # Inside this block, new instances of `GrandChildComponent` will receive
+        # the `data-accordion-target` attribute. 
+    %>
+    <%= render GrandParentComponent.new(...) %>
+<% end %>
+<%# 
+    Back out of the block, new instances won't have the attribute, 
+    it's back to normal
+%>
+```
+
+## Installation
+
+Add these lines to your application's Gemfile
+
+```ruby
+# Ideally replace the `branch: "main"` with a commit reference (`ref: COMMIT_HASH`)
+# https://bundler.io/guides/git.html
+gem "merge_attributes", github: "Amba-Health/merge_attributes", branch: "main"
+gem "view_component_attributes", github: "Amba-Health/view_component_attributes", branch: "main"
+```
+
+<details>
+<summary>Coming soon!</summary>
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'view_component_attributes'
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install view_component_attributes
+
+</details>
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/[USERNAME>]/view_component_attributes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ViewComponentAttributes project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/view_component_attributes/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "view_component_attributes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+# Pre-load some likely necessary libraries
+require "rails"
+require "view_component"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/view_component_attributes/version.rb

@@ -0,0 +1,8 @@
+module ViewComponentAttributes
+  MAJOR = 0
+  MINOR = 1
+  TINY = 1
+  PRE = nil
+
+  VERSION = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+end

data/lib/view_component_attributes/with_attributes.rb

@@ -0,0 +1,20 @@
+require "active_support"
+require "active_model"
+
+module ViewComponentAttributes
+  module WithAttributes
+    extend ActiveSupport::Concern
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+
+    # Little gotcha as the internal @attributes AttributeSet
+    # used by ActiveModel::Model uses String keys.
+    # https://github.com/rails/rails/blob/76489d81ba77216271870e11fba6889088016fa5/activemodel/lib/active_model/attributes.rb#L99
+    # It's very natural to use a Symbol here,
+    # so turning the name into a string
+    # to avoid pitfals
+    def attribute(name)
+      super(name.to_s)
+    end
+  end
+end

data/lib/view_component_attributes/with_context_attributes.rb

@@ -0,0 +1,47 @@
+module ViewComponentAttributes
+  module WithContextAttributes
+    ## Allows to configure default attributes for the component
+    # specifically for the execution of a block. This comes handy
+    # for passing defaults to sub-components without having
+    # to have each component in the chain passing them down
+    #
+    # ```
+    # - Component.with_attributes(option: 'value') do
+    #   -# Say `GrandParendComponent` renders a `ParentComponent`
+    #   -# Which in turn renders our `Component`
+    #   -# Our component will have its `option` attribute defaulted
+    #   -# to `'value'` when called without having `GrandParentComponent`
+    #   -# or `ParentComponent` having to take responsibility for passing it
+    #   = render GrandParentComponent.new(...)
+    # ```
+
+    extend ActiveSupport::Concern
+    include ViewComponentAttributes::WithAttributes
+    include MergeAttributes::Helper
+
+    included do
+      class_attribute :block_attributes
+
+      # Prepend the initializer so its `super` calls
+      # the class' `initialize` method rather than
+      # the other way around
+      prepend WithContextAttributes::Initializer
+    end
+
+    class_methods do
+      def with_attributes(**attributes)
+        self.block_attributes = attributes
+
+        yield
+      ensure
+        self.block_attributes = nil
+      end
+    end
+
+    module Initializer
+      def initialize(*args, **initialize_attributes)
+        super(*args, **merge_attributes(block_attributes || {}, initialize_attributes))
+      end
+    end
+  end
+end

data/lib/view_component_attributes/with_root.rb

@@ -0,0 +1,86 @@
+require "active_support"
+
+module ViewComponentAttributes
+  module WithRoot
+    ##
+    # Most components are wrapped in a single root element/component
+    # This module formalises this with:
+    # - The configuration of that root element, either:
+    #    - at class level using the `root` class method
+    #    - at instanciation through the `root` (or `tag_name`) attribute
+    # - The rendering of the root using the `root` instance method.
+    #
+    #    **Passing attributes**
+    #
+    #    It accepts a hash of attributes and a block with the content
+    #    to be rendered inside the root. The attributes can be processed
+    #    using the `root_attributes` instance method
+    #    (for ex. with the `WithRootAttributes` concern)
+    #
+    #    ```haml
+    #      = root(class: 'a-class', id: 'the-id') do
+    #        = "Content of the component goes here"
+    #    ```
+    #
+    #    **Customizing root element/component**
+    #
+    #    To keep semantics in the same place, you can also provide
+    #    the root element/component at render time as a positional arg
+    #
+    #    ```haml
+    #    = root(:ul, class: 'list-group') do
+    #      - collection.each do
+    #        %li.list-group-item
+    #    ```
+    #
+    #    That value is processed by the `root_type` method that you can
+    #    override should the root element/component depend on some
+    #    logic from the component:
+    #
+    #    ```rb
+    #    def root_type(template_root)
+    #      if ordered?
+    #        :ol
+    #      else
+    #        :ul
+    #      end
+    #    end
+    #    ```
+    extend ActiveSupport::Concern
+
+    include ViewComponentAttributes::WithAttributes
+
+    included do
+      # Class attribute to store default set at class definition
+      class_attribute :default_root, default: :div
+
+      # Instance attributes to store value configured at instanciation
+      attribute :root
+      alias_attribute :tag_name, :root
+    end
+
+    class_methods do
+      def root(tag_name_or_component)
+        self.default_root = tag_name_or_component
+      end
+    end
+
+    def root(template_root = nil, **template_attributes, &block)
+      root_to_render = root_type(template_root)
+
+      if root_to_render.is_a?(Class)
+        render(root_to_render.new(**root_attributes(**template_attributes)), &block)
+      else
+        tag.send(root_to_render, **root_attributes(**template_attributes), &block)
+      end
+    end
+
+    def root_type(template_root)
+      @root_type ||= attribute(:root) || template_root || default_root
+    end
+
+    def root_attributes(**template_attributes)
+      template_attributes
+    end
+  end
+end

data/lib/view_component_attributes/with_root_attributes.rb

@@ -0,0 +1,110 @@
+module ViewComponentAttributes
+  module WithRootAttributes
+    ##
+    # Formalises the generation of the attributes of the root
+    # element/components. It defines the `root_attributes`
+    # method to merge attributes configured at different
+    # points of the component's lifecycle:
+    # - class definition, through a `root_attributes` class method
+    #   allowing to set either (but not both, for now):
+    #   - a static hash of attributes
+    #     ```rb
+    #     root_attributes {class: 'component-class'}
+    #     ```
+    #   - a block that'll get evaluated against the component when
+    #     the attributes are generated.
+    #     ```rb
+    #     root_attributes do
+    #       {
+    #         class: compute_the_class
+    #       }
+    #     end
+
+    #     def compute_the_class
+    #       ...
+    #     end
+    #     ```
+    #   - overriding the `dynamic_root_attributes` method for computations
+    #     that don't fit in a block. It can return an Array of attribute hashes.
+    #     Don't forget to call `super`
+    # - attribute computation, collecting the keyword arguments
+    #   to the `root_attributes` call so that relevant groups
+    #   of related attributes (BEM classes, Stimulus controller and targets)
+    #   can live in the same file (template or class)
+    # - object instanciation, through:
+    #   - the collection of the `unknown_attributes`
+    #   - a `root_attributes` attribute passed to `new`
+
+    #   ```
+    #     HasRootAttributesComponent.new(
+    #       root_attributes: {
+    #         class: 'a-class'
+    #       },
+    #       id: 'the-id'
+    #     ) # Will have `{class: 'a-class', id: 'the-id'}` as root attributes
+    #   ```
+    #
+    # **Controlling merge order**
+    #
+    # By default, attributes are merged from the "most generic" (class definition) place of declaration
+    # to the "most specific" (object instanciation, to allow manual setting of any attributes)
+    #
+    # 1. static_root_attributes # Instance method
+    # 2. dynamic_root_attributes # Instance method
+    # 3. template_attributes # Arguments of `root_attributes`
+    # 4. unknown_attributes # Instance method
+    # 5. instance_root_attributes # Instance method
+    #
+    # If a different order is required for a specific component,
+    # you can override the `root_attributes` method to `merge_attributes`
+    # in the relevant order.
+    extend ActiveSupport::Concern
+
+    include ViewComponentAttributes::WithAttributes
+    include ViewComponentAttributes::WithUnknownAttributes
+    # Necessary to include MergeAttributes::Helper
+    include ActionView::Helpers::TagHelper
+    include MergeAttributes::Helper
+
+    included do
+      attribute :root_attributes
+
+      class_attribute :static_root_attributes, instance_accessor: false
+    end
+
+    class_methods do
+      def root_attributes(default_value = nil, &block)
+        if block
+          # Allows to have the right scope when running the block
+          define_method :get_default_root_attributes, &block
+        end
+
+        self.static_root_attributes = default_value
+      end
+    end
+
+    def root_attributes(**template_attributes)
+      merge_attributes(
+        static_root_attributes,
+        dynamic_root_attributes,
+        template_attributes,
+        unknown_attributes,
+        instance_root_attributes
+      )
+    end
+
+    def instance_root_attributes
+      attribute(:root_attributes)
+    end
+
+    def dynamic_root_attributes
+      if respond_to?(:get_default_root_attributes)
+        get_default_root_attributes
+      end
+    end
+
+    def static_root_attributes
+      singleton_class.static_root_attributes
+    end
+  end
+end

data/lib/view_component_attributes/with_unknown_attributes.rb

@@ -0,0 +1,37 @@
+require "active_support"
+module ViewComponentAttributes
+  module WithUnknownAttributes
+    ##
+    # Allows gathering of unknown attributes
+    # when setting attributes on a Component
+    # (or any ActiveModel, for that matter).
+    #
+    # This lets us collect the extra attributes
+    # to be used as HTML attributes later on
+    extend ActiveSupport::Concern
+    include ViewComponentAttributes::WithAttributes
+
+    def assign_unknown_attribute(attribute_name, value)
+      unknown_attributes[attribute_name.to_sym] = value
+    end
+
+    def unknown_attributes
+      @unknown_attributes ||= {}
+    end
+
+    private
+
+    ##
+    # Overrides the _assign_attribute method
+    # to avoid adding many computations during
+    # component instanciation.
+    def _assign_attribute(k, v)
+      setter = :"#{k}="
+      if respond_to?(setter)
+        public_send(setter, v)
+      else
+        assign_unknown_attribute(k, v)
+      end
+    end
+  end
+end

data/lib/view_component_attributes.rb

@@ -0,0 +1,10 @@
+require "view_component_attributes/version"
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module ViewComponentAttributes
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/view_component_attributes.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "view_component_attributes/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "view_component_attributes"
+  spec.version = ViewComponentAttributes::VERSION
+  spec.authors = ["Romaric Pascal", "Amba Health & Care"]
+  spec.email = ["hello@romaricpascal.is", "developers@amba.co"]
+
+  spec.summary = "Concerns to help manage attributes in View Components"
+  spec.homepage = "https://github.com/Amba-Health/view_component_attributes"
+  spec.license = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", ">= 12.2"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rails", ">= 6.1.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "standardrb"
+
+  spec.add_dependency "zeitwerk"
+  spec.add_dependency "view_component"
+  spec.add_dependency "activemodel"
+  spec.add_dependency "actionview"
+  spec.add_dependency "activesupport"
+end

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: view_component_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Romaric Pascal
+- Amba Health & Care
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- hello@romaricpascal.is
+- developers@amba.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/view_component_attributes.rb
+- lib/view_component_attributes/version.rb
+- lib/view_component_attributes/with_attributes.rb
+- lib/view_component_attributes/with_context_attributes.rb
+- lib/view_component_attributes/with_root.rb
+- lib/view_component_attributes/with_root_attributes.rb
+- lib/view_component_attributes/with_unknown_attributes.rb
+- view_component_attributes.gemspec
+homepage: https://github.com/Amba-Health/view_component_attributes
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Concerns to help manage attributes in View Components
+test_files: []