Exclude components with a "PRIVATE" tag from the component browser #4085

galin-enso · 2023-01-26T09:34:39Z

First part of #4962

Pull Request Description

This PR removes components from the component browser if they contain a "PRIVATE" tag. Private components from the current module or project are not hidden.

Important Notes

Checklist

Please include the following checklist in your PR:

The documentation has been updated if necessary.
All code conforms to the
Scala,
Java,
and
Rust
style guides.
All code has been tested:
- Unit tests have been written where possible.
- If GUI codebase was changed: Enso GUI was tested when built using BOTH
  ./run ide build and ./run ide watch.

…om-cb-184215360

app/gui/src/controller/searcher/component/builder.rs

wdanilo · 2023-01-26T22:41:40Z

app/gui/src/controller/searcher/component/builder.rs

+    match &component.data {
+        component::Data::FromDatabase { entry, .. } =>
+            entry.documentation.iter().any(|doc| match doc {
+                DocSection::Tag { name, .. } => name == "PRIVATE",


extrct that as const. We are extracting all literals as consts. Plus, check if itdoesnt exists anywhere in the app. Put it in a module with language construct definitions pls.

extrct that as const. We are extracting all literals as consts. Plus, check if itdoesnt exists anywhere in the app. Put it in a module with language construct definitions pls.

@wdanilo Are you aware that this is not a language construct, but the documentation tag? I'd put it in the documentation-related crate instead. Or just here.

Documentation is IMO part of language specification. It affects how these things are also accessible from code. IMO this is language-binding thing.

Documentation is IMO part of language specification. It affects how these things are also accessible from code. > IMO this is language-binding thing.

This is not true AFAIK. You can happily access those methods from the code. The tag just hides them in the Component Browser.

Yes, you can for now. But we want to introduce a mode where you could not from external modules if you are not enabling "allow unsafe access" or something like that in the language. It is not supported in Engine yet, but it is part of the language.

app/gui/src/controller/searcher/component/builder.rs

CHANGELOG.md

wdanilo · 2023-01-26T22:46:14Z

app/gui/src/controller/searcher/component/builder.rs

@@ -185,6 +186,9 @@ impl List {
        for (id, entry) in ids_and_entries {
            self.allowed_favorites.insert(id);
            let component = Component::new_from_database_entry(id, entry.clone_ref());
+            if component_is_private(&component) {


I know this was not part of this task, but we should display private components after key-stroke. Can we add ctrl + option + p here? Just like ctrl + option + <number> changes debug view.

The flag readable by controllers could be stored in the IDE controller, because it's accessible from the searcher controller.

Anyway, I would prefer to do it in a separate PR (not necessarily separate task: tasks can be done in more than one PR.

I'll open a new PR for this addition.

farmaazon

Nothing more than @wdanilo comments, see also discussions.

farmaazon · 2023-01-27T14:48:01Z

app/gui/src/controller/searcher/component/builder.rs

+    match &component.data {
+        component::Data::FromDatabase { entry, .. } =>
+            entry.documentation.iter().any(|doc| match doc {
+                DocSection::Tag { name, .. } => name == "PRIVATE",


extrct that as const. We are extracting all literals as consts. Plus, check if itdoesnt exists anywhere in the app. Put it in a module with language construct definitions pls.

@wdanilo Are you aware that this is not a language construct, but the documentation tag? I'd put it in the documentation-related crate instead. Or just here.

app/gui/src/controller/searcher/component/builder.rs

…om-cb-184215360

…0' of github.com:enso-org/enso into wip/galin-enso/exclude-private-methods-from-cb-184215360

…om-cb-184215360

wdanilo

This PR contains binary files. Please be sure to check what files are committed before making PR requests :)

galin-enso · 2023-02-02T09:05:53Z

This PR contains binary files. Please be sure to check what files are committed before making PR requests :)

Oops, that was definitely not my intention. Fixed.

…om-cb-184215360

farmaazon · 2023-02-08T15:54:59Z

QA: No issues spotted. However, I started to wonder if PRIVATE methods from the current module/project should be actually hidden? @wdanilo the question to you: I guess we should display PRIVATE method from the entire currently opened project.

wdanilo · 2023-02-08T16:35:44Z

@farmaazon thanks for spotting it. You are right, they should not.

…om-cb-184215360

farmaazon · 2023-02-10T10:08:32Z

QA green.

Although, I found one more issue: we still display private methods in the method list inside documentation. But let's not do it as a part of this task, please make another issue for it instead.

galin-enso · 2023-02-13T08:56:43Z

Although, I found one more issue: we still display private methods in the method list inside documentation. But let's not do it as a part of this task, please make another issue for it instead.

Added separate issue: #5635

…om-cb-184215360

galin-enso and others added 9 commits January 25, 2023 13:36

WIP: Filter PRIVATE entries in component browser

65a8e1a

Filter private components when populating list

80a5968

Formatting

b491748

Merge branch 'develop' into wip/galin-enso/exclude-private-methods-fr…

3861004

…om-cb-184215360

Add test

377f640

Formatting

f78fe9c

Merge branch 'develop' into wip/galin-enso/exclude-private-methods-fr…

2cd7893

…om-cb-184215360

Cleanup

b6ab078

Add changelog entry

67f8714

galin-enso marked this pull request as ready for review January 26, 2023 13:51

galin-enso requested review from MichaelMauderer, wdanilo, farmaazon and mwu-tow as code owners January 26, 2023 13:51

wdanilo requested changes Jan 26, 2023

View reviewed changes

farmaazon approved these changes Jan 27, 2023

View reviewed changes

galin-enso and others added 11 commits January 27, 2023 17:26

Make is_private a method of Component

022c6b3

WIP filter out private components in iterator

9e590d0

Merge branch 'develop' into wip/galin-enso/exclude-private-methods-fr…

4708372

…om-cb-184215360

Make expected test results more readable

40e8915

Improve changelog entry

6c2a10f

Clean up component entries lookup

d40afdf

Merge branch 'develop' into wip/galin-enso/exclude-private-methods-fr…

900d774

…om-cb-184215360

Merge branch 'develop' into wip/galin-enso/exclude-private-methods-fr…

591f997

…om-cb-184215360

Clean up literal definitions

c14e5dc

Merge branch 'wip/galin-enso/exclude-private-methods-from-cb-18421536…

d2d0dc2

…0' of github.com:enso-org/enso into wip/galin-enso/exclude-private-methods-from-cb-184215360

Merge branch 'develop' into wip/galin-enso/exclude-private-methods-fr…

305a2aa

…om-cb-184215360

galin-enso requested a review from wdanilo February 1, 2023 09:14

wdanilo requested changes Feb 2, 2023

View reviewed changes

Remove accidentally commited binary file

56077da

Merge branch 'develop' into wip/galin-enso/exclude-private-methods-fr…

c99c198

…om-cb-184215360

galin-enso requested a review from wdanilo February 2, 2023 09:08

galin-enso added 2 commits February 6, 2023 09:35

Merge branch 'develop' into wip/galin-enso/exclude-private-methods-fr…

6590917

…om-cb-184215360

Merge branch 'develop' into wip/galin-enso/exclude-private-methods-fr…

a5007c7

…om-cb-184215360

wdanilo approved these changes Feb 8, 2023

View reviewed changes

Merge branch 'develop' into wip/galin-enso/exclude-private-methods-fr…

e28ccc7

…om-cb-184215360

farmaazon linked an issue Feb 8, 2023 that may be closed by this pull request

Component Browser should not include PRIVATE entries #4962

Closed

farmaazon removed a link to an issue Feb 8, 2023

Component Browser should not include PRIVATE entries #4962

Closed

galin-enso and others added 4 commits February 9, 2023 11:47

Do not hide module/project-local private methods

53a8f1d

Merge branch 'develop' into wip/galin-enso/exclude-private-methods-fr…

49e8e96

…om-cb-184215360

Cleanup

e5d87bf

Fix test

eaf0967

Merge branch 'develop' into wip/galin-enso/exclude-private-methods-fr…

7e8df14

…om-cb-184215360

galin-enso added the CI: Ready to merge This PR is eligible for automatic merge label Feb 13, 2023

mergify bot merged commit 6967fb7 into develop Feb 13, 2023

mergify bot deleted the wip/galin-enso/exclude-private-methods-from-cb-184215360 branch February 13, 2023 09:57

galin-enso mentioned this pull request Feb 21, 2023

Component browser documentation panel should not show PRIVATE entries #5635

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Exclude components with a "PRIVATE" tag from the component browser #4085

Exclude components with a "PRIVATE" tag from the component browser #4085

galin-enso commented Jan 26, 2023 •

edited

Loading

wdanilo Jan 26, 2023

farmaazon Jan 27, 2023

wdanilo Jan 27, 2023

farmaazon Jan 30, 2023

wdanilo Feb 2, 2023

wdanilo Jan 26, 2023

farmaazon Jan 27, 2023

galin-enso Jan 31, 2023

farmaazon left a comment

farmaazon Jan 27, 2023

wdanilo left a comment

galin-enso commented Feb 2, 2023

farmaazon commented Feb 8, 2023

wdanilo commented Feb 8, 2023

farmaazon commented Feb 10, 2023

galin-enso commented Feb 13, 2023

Exclude components with a "PRIVATE" tag from the component browser #4085

Exclude components with a "PRIVATE" tag from the component browser #4085

Conversation

galin-enso commented Jan 26, 2023 • edited Loading

Pull Request Description

Important Notes

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

farmaazon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wdanilo left a comment

Choose a reason for hiding this comment

galin-enso commented Feb 2, 2023

farmaazon commented Feb 8, 2023

wdanilo commented Feb 8, 2023

farmaazon commented Feb 10, 2023

galin-enso commented Feb 13, 2023

galin-enso commented Jan 26, 2023 •

edited

Loading