feat: simplify registration logic #151

[jason-capsule42]

Alaska Airlines Pull Request

Type of change:

Please delete options that are not relevant.

• New capability
• Revision of an existing capability
• Infrastructure change (automation, etc.)
• Other (please elaborate)

Checklist:

• My update follows the CONTRIBUTING guidelines of this project
• I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

Summary by Sourcery

Register auro-accordion as a web component and remove the separate auro-accordion-group component.

New Features:

• Simplified the registration process for the auro-accordion component by removing the need for a separate auro-accordion-group component.

Tests:

• Updated tests to reflect the simplified registration process.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request simplifies the registration logic for the auro-accordion component by generating a unique tag for the auro-accordion-button component and registering the auro-accordion-group component during the auro-accordion component registration. This change removes the need to import and register the auro-accordion-group component separately.

Sequence diagram for simplified accordion registration process

sequenceDiagram
    participant App as Application
    participant Acc as AuroAccordion
    participant Utils as AuroLibraryRuntimeUtils
    participant Group as AuroAccordionGroup

    App->>Acc: register('auro-accordion')
    activate Acc
    Note over Acc: Generate group name
    Acc->>Utils: registerComponent('auro-accordion', AuroAccordion)
    Acc->>Group: register('auro-accordion-group')
    deactivate Acc

Loading

Class diagram showing updated AuroAccordion structure

classDiagram
    class AuroAccordion {
        -buttonNameHash: string
        -buttonTag: string
        -iconTag: string
        +register(name: string)
        -generateRandomLetters(length: number): string
        +toggle()
    }
    note for AuroAccordion "New private properties for dynamic button registration"

    class LitElement {
    }

    AuroAccordion --|> LitElement

Loading

File-Level Changes

Change	Details	Files
Generate a unique tag for the auro-accordion-button component.	Added a private property buttonNameHash to store a random string of letters. Added a private property buttonTag to store the generated tag for the auro-accordion-button component. Added a private method generateRandomLetters to generate a random string of letters. Updated the template to use the generated tag for the auro-accordion-button component.	src/auro-accordion.js
Register the auro-accordion-group component during the auro-accordion component registration.	Modified the register method to also register the auro-accordion-group component.	src/auro-accordion.js
Removed the separate import and registration of the auro-accordion-group component.	Removed the import of the auro-accordion-group component from the CDN example in the README.md file. Removed the import of the auro-accordion-group component from the CDN example in the docs/partials/readmeAddlInfo.md file.	README.md docs/partials/readmeAddlInfo.md
Added a test import to the test file.	Added an import to the test file.	test/auro-accordion.test.js

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[github-actions]

Surge demo deployment failed! 😭

[sourcery-ai]

Hey @jason-capsule42 - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider using a more deterministic approach for button name generation instead of random strings, which could cause issues with server-side rendering and hydration. A hash based on component properties or a sequential identifier would be more predictable.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[blackfalcon]

🎉 This PR is included in version 4.4.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀