feat: created basic section and their forms #355

sivangbagri · 2024-08-22T13:34:11Z

Description

Fixes #(issue)

Checklist

My code follows the contributing guidelines of this project.
I am aware that all my commits will be squashed into a single commit, using the PR title as the commit message.
I have performed a self-review of my own code.
I have commented my code in hard-to-understand areas.
I have updated the user-facing documentation to describe any new or changed behavior.
My changes generate no new warnings.
I have added tests that prove my fix is effective or that my feature works.
I have not reduced the existing code coverage.

Comments

Summary by Sourcery

Add a new 'ECCCLientRoCrateAbout' component with tabbed forms for managing metadata sections, and provide demo HTML files for component demonstration.

New Features:

Introduce a new web component 'ECCCLientRoCrateAbout' using LitElement, which includes forms for 'About', 'Related People, Orgs & Works', and 'Structure' sections.

Enhancements:

Add a tabbed interface to switch between different sections ('About', 'Related People, Orgs & Works', and 'Structure') within the 'ECCCLientRoCrateAbout' component.

Documentation:

Add demo HTML files to showcase the usage of the new 'ECCCLientRoCrateAbout' component, including a basic setup and integration example.

changeset-bot · 2024-08-22T13:34:15Z

⚠️ No Changeset found

Latest commit: d39e6f1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2024-08-22T13:34:16Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
elixir-cloud-components	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 12, 2024 9:22pm

sourcery-ai · 2024-08-22T13:34:19Z

Reviewer's Guide by Sourcery

This pull request implements a new feature for creating basic sections and their forms in the ecc-client-elixir-ro-crate package. The changes introduce a new LitElement-based component called ECCCLientRoCrateAbout, which creates a tabbed interface for displaying and editing information about RO-Crate metadata. The implementation uses the @elixir-cloud/design library for form components and defines several form fields for different sections of the RO-Crate metadata.

File-Level Changes

Files	Changes
`packages/ecc-client-elixir-ro-crate/src/components/about/about.ts`	Created a new LitElement-based component ECCCLientRoCrateAbout with a tabbed interface for RO-Crate metadata editing
`packages/ecc-client-elixir-ro-crate/src/components/about/about.ts`	Defined form fields for 'About', 'Related People', and 'Structure' sections of RO-Crate metadata
`packages/ecc-client-elixir-ro-crate/src/components/about/about.ts`	Implemented tab switching functionality in the ECCCLientRoCrateAbout component
`packages/ecc-client-elixir-ro-crate/demo/about/index.html`	Added a demo HTML file for the new ECCCLientRoCrateAbout component
`packages/ecc-client-elixir-ro-crate/src/components/about/index.ts`	Created an index file for exporting the ECCCLientRoCrateAbout component and defining it as a custom element
`packages/ecc-client-elixir-ro-crate/demo/index.html`	Added a main demo page with a link to the 'About' component demo

Tips

Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
Continue your discussion with Sourcery by replying directly to review comments.
You can change your review settings at any time by accessing your dashboard:
- Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
- Change the review language;
You can always contact us if you have any questions or feedback.

sourcery-ai

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

Overall Comments:

Consider improving naming consistency. The main class name ECCCLientRoCrateAbout should likely be ECCClientRoCrateAbout, and there's a mix of snake_case and camelCase in the code that could be standardized.
The field definitions are currently hardcoded. Consider loading these from a configuration file or API for better flexibility and maintainability.
There are several TODO comments in the code. It's generally better to resolve these before submitting a pull request, or at least provide more context about why they're left as TODOs.

Here's what I looked at during the review

🟡 General issues: 3 issues 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 ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

sourcery-ai · 2024-08-22T13:35:32Z

packages/ecc-client-elixir-ro-crate/src/components/about/about.ts

+import "@elixir-cloud/design/dist/components/form/index.js";
+import { Field } from "@elixir-cloud/design/dist/components/form/form";
+
+export default class ECCCLientRoCrateAbout extends LitElement {


suggestion (typo): Fix typo in class name

The class name 'ECCCLientRoCrateAbout' contains a typo. It should be 'ECCClientRoCrateAbout' for consistency and clarity.

export default class ECCClientRoCrateAbout extends LitElement {

This is also true!

sourcery-ai · 2024-08-22T13:35:32Z

packages/ecc-client-elixir-ro-crate/src/components/about/about.ts

+          fieldOptions: {
+            required: true,
+            default: "Dataset",
+            tooltip: "Your house number",


suggestion: Update or remove irrelevant tooltip

The tooltip for the 'Type' field mentions 'Your house number', which seems unrelated. Consider updating this to a relevant description or removing it if not needed.

Suggested change

tooltip: "Your house number",

tooltip: "The type of dataset being described",

sourcery-ai · 2024-08-22T13:35:32Z

packages/ecc-client-elixir-ro-crate/src/components/about/about.ts

+      },
+    },
+    {
+      key: "pulisher",


issue (typo): Correct typo in 'publisher' key

There's a typo in the 'publisher' key. It's currently spelled as 'pulisher', which could cause issues when accessing or setting this field.

Incorrect Spelling!

sivangbagri · 2024-08-22T15:26:57Z

@Salihu @anuragxxd Kindly review. Ignore naming issues , I will fix it

SalihuDickson · 2024-08-27T11:05:45Z

hi @sivangbagri, I'm having a bit of trouble reviewing your code, can you please create an issue that goes into detail about the goals of this project and how you are going about achieving said goals. Also include important links like the schema for the version of ro-crate you're working with, and links to any referenced projects or profiles. If there is one already please link it in the PR description.

sivangbagri · 2024-08-29T14:33:00Z

@SalihuDickson Hii , check this out : #356 . If anything else is needed please let me know

anuragxxd

Some small changes otherwise lgtm

anuragxxd · 2024-10-01T18:54:11Z

packages/ecc-client-elixir-ro-crate/src/components/about/about.ts

+      },
+    },
+    {
+      key: "pulisher",


Incorrect Spelling!

anuragxxd · 2024-10-01T18:55:55Z

packages/ecc-client-elixir-ro-crate/src/components/about/about.ts

+import "@elixir-cloud/design/dist/components/form/index.js";
+import { Field } from "@elixir-cloud/design/dist/components/form/form";
+
+export default class ECCCLientRoCrateAbout extends LitElement {


This is also true!

sivangbagri · 2024-10-02T07:50:20Z

@anuragxxd new commit has required changes along with improved form structure of about and hasPart sections.

SalihuDickson

Just a few things:

The Field is @type, not Type
The @id field should be required
What is the "about dataset" section for? Are the fields above that not for the root data (the dataset) entity.

Some discrepancies between from the latest official Ro-Crate sepcification:

The @type field is not needed as both the metadata and the dataset entities have static types, you only need the @type field when you are creating a new entity.
Name, description and date published should be required, there is also a required license entity that you need to add fields for.

There are also a bunch more fields that need to be added for the dataset entity, but we can first get the required fields set up and incrementally reach achieve full support in subsequent PRs. Please create an issue stating that we need to add full support for all accepted fields in the dataset entity, we can then begin to list the fields, their categories and associated entities as well as implementation details there.

Great work so far @sivangbagri, please take a look at the specification for the latest version and make necessary adjustments. And if you have any questions please feel free to reach out.

SalihuDickson · 2024-10-04T22:21:26Z

The fields you've added for the Author, Publisher and Funder fields won't really work, based on the minimum requirements for the Ro-Crates.

The author object is would be an instance of a people entitiy.
The Publisher object would be an instance of an organization entity or a people entity
The Funder object can also be an Organization or a people entity

perhaps the "Related People, Orgs & Works" page can contain all contextual entities, but we would need a better design to make that clear, as the current structure implies several disjointed entities.

This is a lot at this point, my suggestion would be that you convert this to a draft and create a new PR solely adding fields for the metadata entity, another for the dataset entity and then we can address these other objects and entities in subsequent PRs.

Co-authored-by: salihuDickson <[email protected]>

Signed-off-by: Pratiksha Sankhe <[email protected]> Co-authored-by: salihuDickson <[email protected]>

…oud-aai#342) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Signed-off-by: Pratiksha Sankhe <[email protected]>

…ud-components into ro-crate" This reverts commit 5c56b96, reversing changes made to a6e5aff.

This reverts commit a6e5aff.

This reverts commit 6bc6dbb, reversing changes made to 372c42e.

This reverts commit c88869a.

SalihuDickson · 2024-10-12T21:50:47Z

I was in the process of trying to revert the ro-crate changes and merge the build fixes from earlier but i just realized those have already been implemented on main. I think you can go ahead and close this PR.

anuragxxd and others added 2 commits July 27, 2024 02:38

fix: win path

5ce9a0a

add engine requirement

a816495

sourcery-ai bot reviewed Aug 22, 2024

View reviewed changes

vercel bot deployed to Preview August 22, 2024 13:36 View deployment

anuragxxd requested changes Oct 1, 2024

View reviewed changes

vercel bot deployed to Preview October 2, 2024 07:48 View deployment

SalihuDickson reviewed Oct 4, 2024

View reviewed changes

sivangbagri marked this pull request as draft October 7, 2024 09:14

SalihuDickson mentioned this pull request Oct 12, 2024

Ro-Crate Dataset entity #364

Closed

8 tasks

SalihuDickson and others added 9 commits October 12, 2024 21:27

Fix/win path (elixir-cloud-aai#341)

21fd980

Co-authored-by: salihuDickson <[email protected]>

modify .gitignore

e1a4bea

feat: dropdown in form (elixir-cloud-aai#339)

e70f55e

Signed-off-by: Pratiksha Sankhe <[email protected]> Co-authored-by: salihuDickson <[email protected]>

chore(deps-dev): bump @75lb/deep-merge from 1.1.1 to 1.1.2 (elixir-cl…

34dde74

…oud-aai#342) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

fix: dropdown styles (elixir-cloud-aai#347)

ef1f9ba

Signed-off-by: Pratiksha Sankhe <[email protected]>

Revert "Merge branch 'ro-crate' of https://github.com/sivangbagri/clo…

8409dea

…ud-components into ro-crate" This reverts commit 5c56b96, reversing changes made to a6e5aff.

Revert "Created basic sections and their forms"

6f31473

This reverts commit a6e5aff.

Revert "Merge branch 'main' into ro-crate"

d65db62

This reverts commit 6bc6dbb, reversing changes made to 372c42e.

Revert "Initial boiler plate for ro-crate package"

d39e6f1

This reverts commit c88869a.

SalihuDickson force-pushed the ro-crate branch from ac3d608 to d39e6f1 Compare October 12, 2024 21:19

vercel bot deployed to Preview October 12, 2024 21:22 View deployment

anuragxxd force-pushed the main branch from aaf7e45 to cc6284d Compare October 17, 2024 00:58

sivangbagri closed this Oct 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: created basic section and their forms #355

feat: created basic section and their forms #355

sivangbagri commented Aug 22, 2024 •

edited by sourcery-ai bot

Loading

changeset-bot bot commented Aug 22, 2024 •

edited

Loading

vercel bot commented Aug 22, 2024 •

edited

Loading

sourcery-ai bot commented Aug 22, 2024 •

edited

Loading

sourcery-ai bot left a comment

sourcery-ai bot Aug 22, 2024

anuragxxd Oct 1, 2024

sourcery-ai bot Aug 22, 2024

sourcery-ai bot Aug 22, 2024

anuragxxd Oct 1, 2024

sivangbagri commented Aug 22, 2024

SalihuDickson commented Aug 27, 2024 •

edited

Loading

sivangbagri commented Aug 29, 2024

anuragxxd left a comment

anuragxxd Oct 1, 2024

anuragxxd Oct 1, 2024

sivangbagri commented Oct 2, 2024

SalihuDickson left a comment •

edited

Loading

SalihuDickson commented Oct 4, 2024 •

edited

Loading

SalihuDickson commented Oct 12, 2024

	tooltip: "Your house number",
	tooltip: "The type of dataset being described",

feat: created basic section and their forms #355

feat: created basic section and their forms #355

Conversation

sivangbagri commented Aug 22, 2024 • edited by sourcery-ai bot Loading

Description

Checklist

Comments

Summary by Sourcery

changeset-bot bot commented Aug 22, 2024 • edited Loading

⚠️ No Changeset found

vercel bot commented Aug 22, 2024 • edited Loading

sourcery-ai bot commented Aug 22, 2024 • edited Loading

Reviewer's Guide by Sourcery

File-Level Changes

sourcery-ai bot left a comment

Choose a reason for hiding this comment

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

anuragxxd Oct 1, 2024

Choose a reason for hiding this comment

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

anuragxxd Oct 1, 2024

Choose a reason for hiding this comment

sivangbagri commented Aug 22, 2024

SalihuDickson commented Aug 27, 2024 • edited Loading

sivangbagri commented Aug 29, 2024

anuragxxd left a comment

Choose a reason for hiding this comment

anuragxxd Oct 1, 2024

Choose a reason for hiding this comment

anuragxxd Oct 1, 2024

Choose a reason for hiding this comment

sivangbagri commented Oct 2, 2024

SalihuDickson left a comment • edited Loading

Choose a reason for hiding this comment

SalihuDickson commented Oct 4, 2024 • edited Loading

SalihuDickson commented Oct 12, 2024

sivangbagri commented Aug 22, 2024 •

edited by sourcery-ai bot

Loading

changeset-bot bot commented Aug 22, 2024 •

edited

Loading

vercel bot commented Aug 22, 2024 •

edited

Loading

sourcery-ai bot commented Aug 22, 2024 •

edited

Loading

SalihuDickson commented Aug 27, 2024 •

edited

Loading

SalihuDickson left a comment •

edited

Loading

SalihuDickson commented Oct 4, 2024 •

edited

Loading