Improve ActionText extensiblibility #40308

seanpdoyle · 2020-09-30T03:58:36Z

Extensible layout

Expose how we render the HTML surrounding rich text content as an
extensible layouts/action_text/contents/_content.html.erb template to
encourage user-land customizations, while retaining private API control
over how the rich text itself is rendered by moving the
#render_action_text_content helper invocation to the
action_text/contents/_content.html.erb partial.

Extensible Attachable `#to_attachable_partial_path`

When an application declares a canonical partial for a record, there is
no way to override which partial is used when transformed to Rich Text.
For example, a default Person < ApplicationRecord instance returns
"people/person" from calls to #to_partial_path, resulting in the
app/views/people/_person.html.erb partial being rendered.

Prior to this change, when encountering an <action-text-attachment sgid="..."> element, ActionText retrieved the corresponding
Attachable instance (usually an ActiveRecord::Base instance) and
transformed it to rich text HTML by rendering the partial that
corresponds to its #to_partial_path.

This proposed change instead invokes
Attachable#to_attachable_partial_path. By default,
#to_attachable_partial_path is an alias for #to_partial_path.

Guides

Extend the guides/action_text_overview document to
describe how to customize these templates, and to better illustrate how
ActionText::Attachable instances are rendered into HTML.

actiontext/lib/action_text/content.rb

seanpdoyle · 2020-09-30T04:02:43Z

The prose changes introduced here were done in tandem with the implementation changes, which is to say that I'm very open to feedback on how to provide better ActionText guidance.

guides/source/action_text_overview.md

actiontext/app/helpers/action_text/content_helper.rb

abhaynikam

In documentation changes, I think ActionText -> Action Text because Rails components should have space in between the words. Refer: https://guides.rubyonrails.org/api_documentation_guidelines.html#wording

guides/source/action_text_overview.md

abhaynikam · 2020-12-08T02:38:49Z

guides/source/action_text_overview.md

+(known as blobs). On installation, Action Text will copy over a partial to
+`app/views/active_storage/blobs/_blob.html.erb`, which you can specialize.
+
+### Rendering attachments


This is awesome part. I always wanted to document this as currently their is no way anyone would know how to process and list attachments. Thank you @seanpdoyle

abhaynikam · 2020-12-08T02:40:34Z

guides/source/action_text_overview.md

@@ -81,7 +81,7 @@ class Message < ApplicationRecord
 end
 ```

-Note that you don't need to add a `content` field to your `messages` table.
+**Note:** you don't need to add a `content` field to your `messages` table.


Instead of field saying database column content sounds more readable to me. Please ignore if that doesn't sound okay to you. :)

guides/source/action_text_overview.md

georgeclaghorn · 2020-12-08T19:13:45Z

This is great. There a few other ActionText occurrences needing correction to Action Text but other than that, 👍.

seanpdoyle · 2020-12-08T23:06:45Z

This is great. There a few other ActionText occurrences needing correction to Action Text but other than that, 👍.

Thanks for the review @georgeclaghorn. I've pushed up those Action Text changes. Would it also make sense to create a rails generate command to copy over the app/views/layouts/action_text/contents/_content.html.erb template?

Are there other documentation changes we'd need to make as well?

actiontext/app/helpers/action_text/content_helper.rb

seanpdoyle · 2020-12-23T14:06:18Z

actiontext/lib/generators/action_text/install/install_generator.rb

@@ -47,6 +47,9 @@ def create_actiontext_files

        copy_file "#{GEM_ROOT}/app/views/active_storage/blobs/_blob.html.erb",
          "app/views/active_storage/blobs/_blob.html.erb"
+
+        copy_file "#{GEM_ROOT}/app/views/layouts/action_text/contents/_content.html.erb",
+          "app/views/layouts/action_text/contents/_content.html.erb"


@georgeclaghorn I've pushed up a change to copy over the layout as part of rails generate action_text:install.

actiontext/app/helpers/action_text/content_helper.rb

guides/source/action_text_overview.md

Extensible layout --- Expose how we render the HTML _surrounding_ rich text content as an extensible `layouts/action_text/contents/_content.html.erb` template to encourage user-land customizations, while retaining private API control over how the rich text itself is rendered by moving the `#render_action_text_content` helper invocation to the `action_text/contents/_content.html.erb` partial. Extensible Attachable `#to_attachable_partial_path` --- When an application declares a canonical partial for a record, there is no way to override which partial is used when transformed to Rich Text. For example, a default `Person < ApplicationRecord` instance returns `"people/person"` from calls to `#to_partial_path`, resulting in the `app/views/people/_person.html.erb` partial being rendered. Prior to this change, when encountering an `<action-text-attachment sgid="...">` element, ActionText retrieved the corresponding `Attachable` instance (usually an `ActiveRecord::Base` instance) and transformed it to rich text HTML by rendering the partial that corresponds to its `#to_partial_path`. This proposed change instead invokes `Attachable#to_attachable_partial_path`. By default, `#to_attachable_partial_path` is an alias for `#to_partial_path`. Guides --- Extend the `guides/action_text_overview` document to describe how to customize these templates, and to better illustrate how ActionText::Attachable instances are rendered into HTML.

sedubois · 2021-01-10T15:30:52Z

@seanpdoyle is something needed for these changes to become visible?

The source is correct: https://github.com/rails/rails/blob/master/guides/source/action_text_overview.md

But the website still shows the previous version (no section "Rendering Rich Text content"): https://edgeguides.rubyonrails.org/action_text_overview.html

seanpdoyle · 2021-01-10T16:11:43Z

@seanpdoyle is something needed for these changes to become visible?

I'm not sure, I don't think I've had a guides change merged before. Any ideas @rafaelfranca?

WriterZephos · 2021-10-15T04:37:46Z

Are these changes not in 6.1.4.1 or is something wrong with my gem installation because looking inside the gem, the changes are not there. I can't imagine they have been sitting for almost a year and never making it to a new version.

rails-bot bot added actiontext docs labels Sep 30, 2020

seanpdoyle commented Sep 30, 2020

View reviewed changes

actiontext/lib/action_text/content.rb Outdated Show resolved Hide resolved

seanpdoyle commented Sep 30, 2020

View reviewed changes

guides/source/action_text_overview.md Show resolved Hide resolved

seanpdoyle changed the title ~~Make ActionText layout extensible~~ Document how ActionText layouts are extensible Sep 30, 2020

seanpdoyle force-pushed the action-text-rendering-guides branch 2 times, most recently from e100198 to 790c464 Compare December 8, 2020 01:10

seanpdoyle changed the title ~~Document how ActionText layouts are extensible~~ Improve ActionText extensiblibility Dec 8, 2020

seanpdoyle force-pushed the action-text-rendering-guides branch 2 times, most recently from df65a22 to 2797d0f Compare December 8, 2020 01:13

seanpdoyle commented Dec 8, 2020

View reviewed changes

actiontext/app/helpers/action_text/content_helper.rb Outdated Show resolved Hide resolved

seanpdoyle force-pushed the action-text-rendering-guides branch from 2797d0f to 192b790 Compare December 8, 2020 01:18

abhaynikam reviewed Dec 8, 2020

View reviewed changes

seanpdoyle force-pushed the action-text-rendering-guides branch 2 times, most recently from dbc75dc to a358294 Compare December 8, 2020 23:05

seanpdoyle force-pushed the action-text-rendering-guides branch from a358294 to 3bd09c1 Compare December 11, 2020 14:37

seanpdoyle commented Dec 12, 2020

View reviewed changes

actiontext/app/helpers/action_text/content_helper.rb Outdated Show resolved Hide resolved

seanpdoyle force-pushed the action-text-rendering-guides branch 3 times, most recently from aa11a4e to 0d68477 Compare December 14, 2020 22:15

seanpdoyle commented Dec 14, 2020

View reviewed changes

actiontext/app/helpers/action_text/content_helper.rb Outdated Show resolved Hide resolved

georgeclaghorn reviewed Dec 15, 2020

View reviewed changes

actiontext/app/helpers/action_text/content_helper.rb Outdated Show resolved Hide resolved

actiontext/app/helpers/action_text/content_helper.rb Outdated Show resolved Hide resolved

seanpdoyle force-pushed the action-text-rendering-guides branch from 0d68477 to 8349ee6 Compare December 15, 2020 01:45

seanpdoyle force-pushed the action-text-rendering-guides branch from 8349ee6 to 4900642 Compare December 23, 2020 14:05

rails-bot bot added the railties label Dec 23, 2020

seanpdoyle commented Dec 23, 2020

View reviewed changes

seanpdoyle force-pushed the action-text-rendering-guides branch from 4900642 to ab400c9 Compare December 28, 2020 19:17

seanpdoyle force-pushed the action-text-rendering-guides branch 2 times, most recently from e72e24b to 95e1808 Compare December 29, 2020 20:43

rafaelfranca reviewed Dec 30, 2020

View reviewed changes

actiontext/app/helpers/action_text/content_helper.rb Outdated Show resolved Hide resolved

guides/source/action_text_overview.md Outdated Show resolved Hide resolved

seanpdoyle force-pushed the action-text-rendering-guides branch from 95e1808 to 23614b3 Compare December 30, 2020 01:06

seanpdoyle force-pushed the action-text-rendering-guides branch from 23614b3 to 3500571 Compare December 30, 2020 01:06

rafaelfranca merged commit f58b725 into rails:master Dec 30, 2020

seanpdoyle deleted the action-text-rendering-guides branch December 30, 2020 01:41

tbcooney mentioned this pull request Oct 6, 2021

ActionText does not support Trix content attachments #35218

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve ActionText extensiblibility #40308

Improve ActionText extensiblibility #40308

seanpdoyle commented Sep 30, 2020 •

edited

seanpdoyle commented Sep 30, 2020

abhaynikam left a comment •

edited

abhaynikam Dec 8, 2020

abhaynikam Dec 8, 2020

georgeclaghorn commented Dec 8, 2020

seanpdoyle commented Dec 8, 2020

seanpdoyle Dec 23, 2020

sedubois commented Jan 10, 2021

seanpdoyle commented Jan 10, 2021

WriterZephos commented Oct 15, 2021 •

edited

Improve ActionText extensiblibility #40308

Improve ActionText extensiblibility #40308

Conversation

seanpdoyle commented Sep 30, 2020 • edited

Extensible layout

Extensible Attachable #to_attachable_partial_path

Guides

seanpdoyle commented Sep 30, 2020

abhaynikam left a comment • edited

Choose a reason for hiding this comment

abhaynikam Dec 8, 2020

Choose a reason for hiding this comment

abhaynikam Dec 8, 2020

Choose a reason for hiding this comment

georgeclaghorn commented Dec 8, 2020

seanpdoyle commented Dec 8, 2020

seanpdoyle Dec 23, 2020

Choose a reason for hiding this comment

sedubois commented Jan 10, 2021

seanpdoyle commented Jan 10, 2021

WriterZephos commented Oct 15, 2021 • edited

seanpdoyle commented Sep 30, 2020 •

edited

Extensible Attachable `#to_attachable_partial_path`

abhaynikam left a comment •

edited

WriterZephos commented Oct 15, 2021 •

edited