Add `action_text_attachment` helper to `FixtureSet` #40289

seanpdoyle · 2020-09-25T17:28:07Z

Summary

From within an action_text/rich_texts.yml file, generate an
<action-text-attachment sgid="..."></action-text-attachment> element
with a valid sgid attribute that references another FixtureSet record.

hello_world_review_content:
  record: hello_world (Review)
  name: content
  body: <p><%= ActionText::FixtureSet.attachment("messages", :hello_world) %> is great!</p>

seanpdoyle · 2020-09-25T17:29:06Z

actiontext/lib/action_text/engine.rb

+      ActiveSupport.on_load(:active_support_test_case) do
+        require "active_record/fixtures"
+
+        ActiveRecord::FixtureSet.context_class.include ActionText::FixtureFileHelpers


This will likely need some guidance.

I tried to call FixtureSet.context_class... without the ActiveRecord scope, but had autoloading issues. Is there a better way?

seanpdoyle · 2020-09-25T17:30:58Z

actiontext/lib/action_text/fixture_file_helpers.rb

@@ -0,0 +1,12 @@
+module ActionText
+  module FixtureFileHelpers
+    def action_text_attachment(fixture_set_name, label)


Related to https://github.com/rails/rails/pull/40289/files#r495132398, I had considered making this its own ActiveRecord::FixtureSet clone, and forcing callers to fully qualify their calls as if they were calling something like identify:

body: "<p><%= ActionText::FixtureSet.action_text_attachment %></p>"

That would avoid the auto-loading issues, but could be verbose. If this method is prefered, we could drop the action_text prefix and instead declare ActionText::FixtureSet.attachment, which isn't half-bad.

After more consideration, I've pushed up 7dfd977 to propose those changes instead.

seanpdoyle · 2020-09-25T18:09:20Z

actiontext/lib/action_text/fixture_set.rb

+module ActionText
+  class FixtureSet
+    def self.attachment(fixture_set_name, label, column_type: :integer)
+      signed_global_id = ActiveRecord::FixtureSet.signed_global_id(fixture_set_name, label, column_type: column_type, for: ActionText::Attachable::LOCATOR_NAME)


Maybe this is a step too far and 7dfd977 is better, but I've pushed up the signed_global_id part to ActiveRecord::FixtureSet.

The tests for ActionText still pass, though I wasn't sure on where or how to add an ActiveRecord-side test for the new method.

seanpdoyle · 2020-09-30T01:19:06Z

actiontext/lib/action_text/fixture_set.rb

+module ActionText
+  class FixtureSet
+    def self.attachment(fixture_set_name, label, column_type: :integer)
+      signed_global_id = ActiveRecord::FixtureSet.signed_global_id fixture_set_name, label,


@georgeclaghorn do you think that this is a reasonable addition to the ActiveRecord side of fixtures, or would we be better keeping it self-contained to the ActionText side?

seanpdoyle · 2020-09-30T01:20:09Z

actiontext/test/fixtures/action_text/rich_texts.yml

+hello_world_review_content:
+  record: hello_world (Review)
+  name: content
+  body: <p><%= ActionText::FixtureSet.attachment("messages", :hello_world) %> is great!</p>


@georgeclaghorn should this be declared as a fixture-local helper method, or is it reasonable to mirror the ActiveRecord::FixtureSet interface?

georgeclaghorn · 2020-10-30T16:58:18Z

I have mixed feelings about the ActionText::FixtureSet.attachment API, but given the autoloading issues you ran into with action_text_attachment, I don’t think it’s worth revisiting. This is fine for now.

seanpdoyle · 2020-10-30T16:58:40Z

activerecord/lib/active_record/fixtures.rb

@@ -585,6 +585,14 @@ def identify(label, column_type = :integer)
        end
      end

+      def signed_global_id(fixture_set_name, label, column_type: :integer, **options)


@georgeclaghorn do you feel like additions to both the ActiveRecord side and the introduction of the ActionText side are worthwhile?

Would this be better as an ActionText only change? An ActiveRecord only change that enables people to declare their own <action-text-attachment> elements manually?

I would like to see this extracted to GlobalID, but that can be done as a separate step. I don’t want to kick this to the next release just because of that.

From within an `action_text/rich_texts.yml` file, generate an `<action-text-attachment sgid="..."></action-text-attachment>` element with a valid `sgid` attribute that references another FixtureSet record. ```ruby hello_world_review_content: record: hello_world (Review) name: content body: <p><%= action_text_attachment("messages", :hello_world) %> is great!</p> ```

guides/source/6_1_release_notes.md

georgeclaghorn · 2020-10-30T17:16:32Z

actiontext/lib/action_text/fixture_set.rb

+      signed_global_id = ActiveRecord::FixtureSet.signed_global_id fixture_set_name, label,
+        column_type: column_type, for: ActionText::Attachable::LOCATOR_NAME
+
+      %(<action-text-attachment sgid="#{signed_global_id}"></action-text-attachment)


Is this missing a trailing >?

🙀 I wonder if that means the passing test isn't covering this behavior well enough?

I've tested this out in projects outside the Rails test suite, and it worked. Maybe the generated HTML is fixed by browser rendering?

@georgeclaghorn I've closed the tag in e4e5f19.

sedubois · 2022-08-06T09:46:58Z

@seanpdoyle I tried to attach a fixture with UUID as primary key:

    body: <div><%= ActionText::FixtureSet.attachment("authors", :john) %></div>

However the attachment is not found and renders as "☒". If I run the generated attachment's sgid through GlobalID::Locator.locate_signed(sgid, for: "attachable") I get the error ActiveRecord::RecordNotFound: Couldn't find Author with 'id'=513610136. Would this be a bug where it's looking for an integer ID instead of UUID?

Also while I'm here I note that forward slashes '/' appear necessary when referencing namespaced fixtures, e.g. ActiveStorage::Blob:

    body: <div><%= ActionText::FixtureSet.attachment("active_storage/blobs", :poster) %></div>

This contrasts with the way fixtures are loaded in test code where the slash is not necessary: blob = active_storage_blobs(:poster).

sedubois · 2022-08-06T09:58:17Z

@seanpdoyle OK, I discovered the column_type parameter, this works (NB: it would be nice if it could be inferred automatically). Hopefully this provides extra documentation for anyone encountering a similar question. Thanks for providing this helper 🙂

    body: <div><%= ActionText::FixtureSet.attachment("authors", :john, column_type: :uuid) %></div>

rails-bot bot added the actiontext label Sep 25, 2020

seanpdoyle commented Sep 25, 2020

View reviewed changes

seanpdoyle force-pushed the action-text-attachment-fixtures branch 2 times, most recently from 40d84c7 to 7dfd977 Compare September 25, 2020 17:39

rails-bot bot added the activerecord label Sep 25, 2020

seanpdoyle commented Sep 25, 2020

View reviewed changes

seanpdoyle force-pushed the action-text-attachment-fixtures branch 3 times, most recently from 1ef8c24 to 65ddb55 Compare September 29, 2020 21:19

seanpdoyle commented Sep 30, 2020

View reviewed changes

seanpdoyle force-pushed the action-text-attachment-fixtures branch from 65ddb55 to 85af078 Compare October 12, 2020 20:28

seanpdoyle commented Oct 30, 2020

View reviewed changes

seanpdoyle added 3 commits October 30, 2020 13:00

Declare ActionText::FixtureSet instead

b98aebb

move .signed_global_id to ActiveRecord::FixtureSet

86d75a3

seanpdoyle force-pushed the action-text-attachment-fixtures branch from 85af078 to 86d75a3 Compare October 30, 2020 17:00

rails-bot bot added the docs label Oct 30, 2020

seanpdoyle commented Oct 30, 2020

View reviewed changes

guides/source/6_1_release_notes.md Outdated Show resolved Hide resolved

mention in release notes

9fd59b2

seanpdoyle force-pushed the action-text-attachment-fixtures branch from 9f844d1 to 9fd59b2 Compare October 30, 2020 17:09

georgeclaghorn reviewed Oct 30, 2020

View reviewed changes

close trailing tag

e4e5f19

georgeclaghorn merged commit 76b33aa into rails:master Oct 30, 2020
1 check passed

georgeclaghorn added this to the 6.1.0 milestone Oct 30, 2020

seanpdoyle deleted the action-text-attachment-fixtures branch October 30, 2020 19:56

Add `action_text_attachment` helper to `FixtureSet` #40289

Add `action_text_attachment` helper to `FixtureSet` #40289

seanpdoyle commented Sep 25, 2020 •

edited

seanpdoyle Sep 25, 2020

seanpdoyle Sep 25, 2020 •

edited

seanpdoyle Sep 25, 2020

seanpdoyle Sep 25, 2020

seanpdoyle Sep 30, 2020

seanpdoyle Sep 30, 2020

georgeclaghorn commented Oct 30, 2020

seanpdoyle Oct 30, 2020

georgeclaghorn Oct 30, 2020

georgeclaghorn Oct 30, 2020

seanpdoyle Oct 30, 2020 •

edited

seanpdoyle Oct 30, 2020

sedubois commented Aug 6, 2022 •

edited

sedubois commented Aug 6, 2022 •

edited

Add action_text_attachment helper to FixtureSet #40289

Add action_text_attachment helper to FixtureSet #40289

Conversation

seanpdoyle commented Sep 25, 2020 • edited

Summary

Choose a reason for hiding this comment

seanpdoyle Sep 25, 2020 • edited

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

georgeclaghorn commented Oct 30, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seanpdoyle Oct 30, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sedubois commented Aug 6, 2022 • edited

sedubois commented Aug 6, 2022 • edited

Add `action_text_attachment` helper to `FixtureSet` #40289

Add `action_text_attachment` helper to `FixtureSet` #40289

seanpdoyle commented Sep 25, 2020 •

edited

seanpdoyle Sep 25, 2020 •

edited

seanpdoyle Oct 30, 2020 •

edited

sedubois commented Aug 6, 2022 •

edited

sedubois commented Aug 6, 2022 •

edited