-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
HYC-1003 - Text Formatting for Abstracts (#1123)
* save tinymce content to textarea * tinymce saves on change * validate metadata on change for rich text fields * assert tinymce content in test
- Loading branch information
1 parent
0be6a5c
commit 5219bbd
Showing
16 changed files
with
217 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| import RelationshipsControl from 'hyrax/relationships/control' | ||
| import SaveWorkControl from 'hyrax/save_work/save_work_control' | ||
| import AdminSetWidget from 'hyrax/editor/admin_set_widget' | ||
| import ControlledVocabulary from 'hyrax/editor/controlled_vocabulary' | ||
| import Autocomplete from 'hyrax/autocomplete' | ||
| import AuthoritySelect from 'hyrax/authority_select' | ||
|
|
||
| export default class { | ||
| /** | ||
| * initialize the editor behaviors | ||
| * @param {jQuery} element - The form that has a data-param-key attribute | ||
| */ | ||
| constructor(element) { | ||
| this.element = element | ||
| this.paramKey = element.data('paramKey') // The work type | ||
| this.adminSetWidget = new AdminSetWidget(element.find('select[id$="_admin_set_id"]')) | ||
| this.sharingTabElement = $('#tab-share') | ||
| } | ||
|
|
||
| init() { | ||
| this.autocomplete() | ||
| this.controlledVocabularies() | ||
| this.sharingTab() | ||
| this.relationshipsControl() | ||
| this.saveWorkControl() | ||
| this.saveWorkFixed() | ||
| this.authoritySelect() | ||
| this.formInProgress() | ||
| } | ||
|
|
||
| // Immediate feedback after work creation, editing. | ||
| formInProgress() { | ||
| $('[data-behavior~=work-form]').on('submit', function(event){ | ||
| $('.card-footer.save-progress').removeAttr("hidden"); | ||
| }); | ||
| } | ||
|
|
||
| // Used when you have a linked data field that can have terms from multiple | ||
| // authorities. | ||
| authoritySelect() { | ||
| $("[data-authority-select]").each(function() { | ||
| let authoritySelect = $(this).data().authoritySelect | ||
| let options = {selectBox: 'select.' + authoritySelect, | ||
| inputField: 'input.' + authoritySelect} | ||
| new AuthoritySelect(options); | ||
| }) | ||
| } | ||
|
|
||
| // Autocomplete fields for the work edit form (based_near, subject, language, child works) | ||
| autocomplete() { | ||
| var autocomplete = new Autocomplete() | ||
|
|
||
| $('[data-autocomplete]').each((function() { | ||
| var elem = $(this) | ||
| autocomplete.setup(elem, elem.data('autocomplete'), elem.data('autocompleteUrl')) | ||
| elem.parents('.multi_value.form-group').manage_fields({ | ||
| add: function(e, element) { | ||
| var elem = $(element) | ||
| // Don't mark an added element as readonly even if previous element was | ||
| // Enable before initializing, as otherwise LinkedData fields remain disabled | ||
| elem.attr('readonly', false) | ||
| autocomplete.setup(elem, elem.data('autocomplete'), elem.data('autocompleteUrl')) | ||
| } | ||
| }) | ||
| })) | ||
| } | ||
|
|
||
| // initialize any controlled vocabulary widgets | ||
| controlledVocabularies() { | ||
| this.element.find('.controlled_vocabulary.form-group').each((_idx, controlled_field) => | ||
| new ControlledVocabulary(controlled_field, this.paramKey) | ||
| ) | ||
| } | ||
|
|
||
| // Display the sharing tab if they select an admin set that permits sharing | ||
| sharingTab() { | ||
| if(this.adminSetWidget && !this.adminSetWidget.isEmpty()) { | ||
| this.adminSetWidget.on('change', () => this.sharingTabVisiblity(this.adminSetWidget.isSharing())) | ||
| this.sharingTabVisiblity(this.adminSetWidget.isSharing()) | ||
| } | ||
| } | ||
|
|
||
| sharingTabVisiblity(visible) { | ||
| if (visible) | ||
| this.sharingTabElement.removeAttr("hidden") | ||
| else | ||
| this.sharingTabElement.attr("hidden","") | ||
| } | ||
|
|
||
| relationshipsControl() { | ||
| let collections = this.element.find('[data-behavior="collection-relationships"]') | ||
| collections.each((_idx, element) => | ||
| new RelationshipsControl(element, | ||
| collections.data('members'), | ||
| collections.data('paramKey'), | ||
| 'member_of_collections_attributes', | ||
| 'tmpl-collection').init()) | ||
|
|
||
| let works = this.element.find('[data-behavior="child-relationships"]') | ||
| works.each((_idx, element) => | ||
| new RelationshipsControl(element, | ||
| works.data('members'), | ||
| works.data('paramKey'), | ||
| 'work_members_attributes', | ||
| 'tmpl-child-work').init()) | ||
| } | ||
| // [hyc-override] Store saveWorkControl instance in a global variable to enable tinymce to call it | ||
| // This is necessary for requirement checks to update when rich text fields are edited | ||
| saveWorkControl() { | ||
| window.saveWorkControlInstance = new SaveWorkControl(this.element.find("#form-progress"), this.adminSetWidget) | ||
| } | ||
|
|
||
| saveWorkFixed() { | ||
| // Fixedsticky will polyfill position:sticky | ||
| this.element.find('#savewidget').fixedsticky() | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # frozen_string_literal: true | ||
| module Hyrax | ||
| module Renderers | ||
| class FormattedTextRenderer < AttributeRenderer | ||
| private | ||
| def attribute_value_to_html(value) | ||
| sanitized_value = get_sanitized_string(value) | ||
| if microdata_value_attributes(field).present? | ||
| "<span#{html_attributes(microdata_value_attributes(field))}>#{sanitized_value}</span>" | ||
| else | ||
| li_value(sanitized_value) | ||
| end | ||
| end | ||
|
|
||
| # Sanitize the value, allowing only safe HTML tags and attributes | ||
| def get_sanitized_string(string) | ||
| # Define allowed tags and attributes | ||
| allowed_tags = %w[strong em b i u p br small mark sub sup a ul ol li dl dt dd div span h1 h2 h3 h4 h5 h6] | ||
| allowed_attributes = %w[href] | ||
| sanitize(string, tags: allowed_tags, attributes: allowed_attributes) | ||
| end | ||
|
|
||
| # Same as attribute renderer override, but without escaping the value | ||
| def li_value(value) | ||
| field_value = find_language(value) || value | ||
| auto_link((field_value)) | ||
| end | ||
| end | ||
| end | ||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| <% if f.object.multiple? key %> | ||
| <%= f.input :abstract, as: :multi_value, input_html: { rows: '14', type: 'textarea'}, required: f.object.required?(key) %> | ||
| <%= f.input :abstract, as: :multi_value, input_html: { rows: '14', type: 'textarea', class: 'tinymce'}, required: f.object.required?(key) %> | ||
| <% else %> | ||
| <%= f.input :abstract, as: :text, input_html: { rows: '14' }, required: f.object.required?(key) %> | ||
| <% end %> | ||
| <%= f.input :abstract, as: :text, input_html: { rows: '14', class: 'tinymce' }, required: f.object.required?(key) %> | ||
| <% end %> | ||
| <!-- [hyc-override] Include JS for TinyMCE with rich_text configuration. Enables rich text editing. --> | ||
| <%= tinymce :rich_text %> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| <% if f.object.multiple? key %> | ||
| <%= f.input :methodology, as: :multi_value, input_html: { rows: '14', type: 'textarea'}, required: f.object.required?(key) %> | ||
| <%= f.input :methodology, as: :multi_value, input_html: { rows: '14', type: 'textarea', class: 'tinymce' }, required: f.object.required?(key) %> | ||
| <% else %> | ||
| <%= f.input :methodology, as: :text, input_html: { rows: '14' }, required: f.object.required?(key) %> | ||
| <% end %> | ||
| <%= f.input :methodology, as: :text, input_html: { rows: '14', class: 'tinymce' }, required: f.object.required?(key) %> | ||
| <% end %> | ||
| <!-- [hyc-override] Include JS for TinyMCE with rich_text configuration. Enables rich text editing. --> | ||
| <%= tinymce :rich_text %> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters