Add options contexts to set conventions for more involved definitions

[kaspth]

No description provided.

[seanpdoyle]

This is a really interesting idea! Is a Context something that's internal to Showcase, or would applications want to define their own too?

For example, I think an aria- context might be useful to support too, in addition to Stimulus (see hotwired/stimulus#627 for an example where they might overlap in the future).

[kaspth]

This is a really interesting idea! Is a Context something that's internal to Showcase, or would applications want to define their own too?

Yeah, the idea is they're able to do something like this:

Showcase.options.context :stimulus do
  def value(name, ...)
    option("data-#{@controller}-#{name}-value", ...)
  end
end

and then showcase.options.stimulus controller: :welcome works in their Showcases. Of course, Stimulus support is shipped out of the box.

For example, I think an aria- context might be useful to support too, in addition to Stimulus,

Oh yeah, it'd be interesting to ship something like this out of the box too.

[kaspth]

We'll end up rendering the Stimulus specific options like this now:

[kaspth]

Looks like the build is failing on with_options not being chainable in 6.1. I also had to use o.required.klass to get things working which isn't really that nice. Not sure whether we should chug the with_options support. I think I'll sleep on it, unless you've got thoughts @seanpdoyle.

[seanpdoyle]

@kaspth what about a guarded backport that stashes the block argument?

require "active_support/core_ext/object/with_options"

module WithOptionsBackport
  extend ActiveSupport::Concern

  included do
    alias_method :__original_with_options, :with_options

    def with_options(options, &block)
      if block.nil?
        options_merger = nil
        __original_with_options(options) { |object| options_merger = object }
        options_merger
      else
        __original_with_options(options, &block)
      end
    end
  end
end

if Rails.version < "7.0"
  Object.include WithOptionsBackport
end

It's brittle, but the behavior itself isn't too complicated to cover.

[kaspth]

I noticed that with_options without a block just returns an ActiveSupport::OptionMerger instance, so we can just use that directly instead of mucking with with_options.

[kaspth]

Hm, if people override an already defined method they may break Showcases from engines, which may rely on the default context method definition.

[kaspth]

This feels pretty clean and intention revealing!

[kaspth]

I've gone back to push more on the Bullet Train integration side of things bullet-train-co/bullet_train-core#46, so I'll be needing this soon. I'll try to document this soon and then go ahead with what we've got.