Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Variable Typo in Block Editor #25591

Closed
jdcmsd opened this issue Jul 21, 2023 · 3 comments · Fixed by #25780 or #26025
Closed

Variable Typo in Block Editor #25591

jdcmsd opened this issue Jul 21, 2023 · 3 comments · Fixed by #25780 or #26025
Assignees
@jcastro-dotcms @zJaaal
Labels
QA : Approved QA : Passed Internal Release : 23.10.24 Bug-Fixing Team : Lunik Type : Defect

Comments

@jdcmsd
Copy link
Contributor

jdcmsd commented Jul 21, 2023 •
edited

Problem Statement

The word count and character count variables that currently appear in the Block Editor are, respectively, wordCount and chartCount. I think the second one should probably be charCount.

I made a PR to rectify it: #25589

However, I'm just opening up this Issue in case there's discussion needed re: the existing chartCount variables in the existing Block Editors out in the wild. Does something like this require a UT? Is it reasonable to believe it will correct itself over time?

I'll include a minor breaking change entry in the following release notes, too, in case anyone has done any development using that data.

Steps to Reproduce

N/A

Acceptance Criteria

Just making sure that there are no dangers or snags.

dotCMS Version

22.12 - 23.07

Proposed Objective

Technical User Experience

Proposed Priority

Priority 4 - Trivial
@jdcmsd jdcmsd linked a pull request Jul 21, 2023 that will close this issue
Char count correction #25589
Closed
@jdcmsd jdcmsd removed a link to a pull request Jul 21, 2023
Char count correction #25589
Closed
@jdcmsd jdcmsd mentioned this issue Jul 21, 2023
Closed
@fmontes
Copy link
Member

fmontes commented Jul 25, 2023

Let's check if this fix is ok or needs work.

@jcastro-dotcms jcastro-dotcms linked a pull request Jul 25, 2023 that will close this issue
Char count correction #25589
Closed
@zJaaal zJaaal self-assigned this Aug 14, 2023
@zJaaal zJaaal linked a pull request Aug 14, 2023 that will close this issue
Jdcmsd char count fixes #25780
Merged
@zJaaal zJaaal linked a pull request Sep 7, 2023 that will close this issue
Fix #25591: Char count block editor correction #26025
Merged
fmontes pushed a commit that referenced this issue Sep 11, 2023
@zJaaal @jdcmsd
@jgambarios @nollymar @jcastro-dotcms
chore(block-editor): Fix #25591: Char count block editor correction (#…
3cd5549 
…26025)

* Jdcmsd char count fixes (#25780)

* Issue 25661 add an attribute to each and every piece of json that conforms the cli bundle (#25731)

* #25661 Add dotCMSObjectType field to language, content type and site models

Added a "dotCMSObjectType" field to the language, content type, and site models in the project to get better clarity. Additionally, new tests have been added to LanguageCommandTest, ContentTypeCommandTest, and SiteCommandTest. These tests ensure that the "dotCMSObjectType" field is present in the JSON and YAML files generated when the pull command is executed for languages, content types, and sites respectively.

This addition helps in identifying the object type when reviewing the JSON or YAML files, improving maintainability and understandability of the codes and files.

* #25661 Refactor ContentType class: "TYPE" made final

* #25661 Added a JsonProperty to ContentType class

* #25661 Added JsonViews and JsonProperty to handle JSON serialization.

This commit introduces JsonViews in AbstractLanguage, ContentType, and AbstractSiteView classes. This helps manage different JSON views and control serialization for different use cases. A JsonProperty "dotCMSObjectType" has been added to the ContentType class. Test cases for Content Type, Site and Language have been updated to include a command to push the changes back to the server, ensuring the structure is still correct. New functionalities for creating and updating language and content type have been provided with the ExternalView of Json, adding more security to the API calls. The CommonViews class has been added to handle different views for JSON serialization. This change enhances the control over data visibility in different scenarios.

* #25661 Cleanup

---------

Co-authored-by: Nollymar Longa <nollymar.longa@dotcms.com>

* Update dot-block-editor.component.ts

* Update dot-content-compare-block-editor.component.spec.ts

* Update TestDataUtils.java

* Update StoryBlockAPITest.java

* Update FolderAPITest.java

* Update ContentletIndexAPIImplTest.java

---------

Co-authored-by: Jonathan Gamba <jonathan.gamba@dotcms.com>
Co-authored-by: Nollymar Longa <nollymar.longa@dotcms.com>

* dev (block editor): build

---------

Co-authored-by: Jamie Mauro <102264829+jdcmsd@users.noreply.github.com>
Co-authored-by: Jonathan Gamba <jonathan.gamba@dotcms.com>
Co-authored-by: Nollymar Longa <nollymar.longa@dotcms.com>
Co-authored-by: Jose Castro <jose.castro@dotcms.com>
@jcastro-dotcms
Copy link
Contributor

INTERNAL QA: PASSED

  • Docker Image: master_f113f07_SNAPSHOT

If you save a Contentlet with a Block Editor field and check the payload in the POST request, you can see that the property is called charCount now.

manuelrojas pushed a commit that referenced this issue Sep 12, 2023
@zJaaal @jdcmsd
@jgambarios @nollymar @jcastro-dotcms @manuelrojas
chore(block-editor): Fix #25591: Char count block editor correction (#…
d4bacc5 
…26025)

* Jdcmsd char count fixes (#25780)

* Issue 25661 add an attribute to each and every piece of json that conforms the cli bundle (#25731)

* #25661 Add dotCMSObjectType field to language, content type and site models

Added a "dotCMSObjectType" field to the language, content type, and site models in the project to get better clarity. Additionally, new tests have been added to LanguageCommandTest, ContentTypeCommandTest, and SiteCommandTest. These tests ensure that the "dotCMSObjectType" field is present in the JSON and YAML files generated when the pull command is executed for languages, content types, and sites respectively.

This addition helps in identifying the object type when reviewing the JSON or YAML files, improving maintainability and understandability of the codes and files.

* #25661 Refactor ContentType class: "TYPE" made final

* #25661 Added a JsonProperty to ContentType class

* #25661 Added JsonViews and JsonProperty to handle JSON serialization.

This commit introduces JsonViews in AbstractLanguage, ContentType, and AbstractSiteView classes. This helps manage different JSON views and control serialization for different use cases. A JsonProperty "dotCMSObjectType" has been added to the ContentType class. Test cases for Content Type, Site and Language have been updated to include a command to push the changes back to the server, ensuring the structure is still correct. New functionalities for creating and updating language and content type have been provided with the ExternalView of Json, adding more security to the API calls. The CommonViews class has been added to handle different views for JSON serialization. This change enhances the control over data visibility in different scenarios.

* #25661 Cleanup

---------

Co-authored-by: Nollymar Longa <nollymar.longa@dotcms.com>

* Update dot-block-editor.component.ts

* Update dot-content-compare-block-editor.component.spec.ts

* Update TestDataUtils.java

* Update StoryBlockAPITest.java

* Update FolderAPITest.java

* Update ContentletIndexAPIImplTest.java

---------

Co-authored-by: Jonathan Gamba <jonathan.gamba@dotcms.com>
Co-authored-by: Nollymar Longa <nollymar.longa@dotcms.com>

* dev (block editor): build

---------

Co-authored-by: Jamie Mauro <102264829+jdcmsd@users.noreply.github.com>
Co-authored-by: Jonathan Gamba <jonathan.gamba@dotcms.com>
Co-authored-by: Nollymar Longa <nollymar.longa@dotcms.com>
Co-authored-by: Jose Castro <jose.castro@dotcms.com>
@josemejias11
Copy link

Approved: Tested on master_658e1bc_SNAPSHOT, Docker, macOS 13.0, FF v113.0

@fmontes fmontes closed this as completed Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jcastro-dotcms jcastro-dotcms

@zJaaal zJaaal

Labels
QA : Approved QA : Passed Internal Release : 23.10.24 Bug-Fixing Team : Lunik Type : Defect
Projects
dotCMS - Product Planning
Archived in project
Milestone
No milestone
6 participants
@fmontes @jcastro-dotcms @zJaaal @jdcmsd @damen-dotcms @josemejias11