Class: Clickwrap::Generators::ViewsGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Defined in:
lib/generators/clickwrap/views_generator.rb

Overview

rails generate clickwrap:views ā€” eject the engine's overridable templates into the HOST app so they can be restyled. This is the Devise move (rails g devise:views), and it works for the same boring Rails reason: the host app's app/views sits AHEAD of any engine's view paths in the lookup chain, so a file copied to e.g. app/views/clickwrap/captures/show.html.erb SHADOWS the gem's bundled default automatically ā€” no config, no registration. Delete your copy and the gem's default comes back. Upgrade the gem and your ejected copies are untouched (re-run only if you WANT the new defaults).

source_root points at the engine's own app/views, so directory copies the exact templates the engine renders.

One thing does not eject with the markup: the evidence contract. The controls are initially unselected, the document links come before the submit action, and the call to action recorded in the manifest is the one the person can actually press. Restyle freely, but a copy that preselects a control or moves the links below the button changes what the receipt is describing ā€” and the development linter will say so.

The same goes for the composed line. presentation.combined is one control answering several statements, and the manifest signs which ones; render it and then iterate presentation.itemized_statements, never statements, or the page offers a second control for a statement the one control already covers. The linter reports that too.

Instance Method Summary collapse

Instance Method Details

#copy_views ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/generators/clickwrap/views_generator.rb', line 40

def copy_views
  return say_nothing_to_copy if available_groups.empty?

  requested_groups.each do |group|
    unless available_groups.include?(group)
      say "   No `#{group}` views ship with this release. Available: " \
          "#{available_groups.join(", ")}.", :yellow
      next
    end

    directory "clickwrap/#{group}", "app/views/clickwrap/#{group}"
  end
end

#show_styling_tip ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/generators/clickwrap/views_generator.rb', line 54

def show_styling_tip
  return if available_groups.empty?

  say "\nšŸŽØ Views copied ā€” they are yours now, and the gem's originals stay put for"
  say "   reference. Tailwind, Bootstrap, ViewComponent, Phlex, and plain ERB all"
  say "   work; classes you add here are picked up by your build automatically,"
  say "   because the files now live in app/views."
  say "\n   Worth keeping while you restyle: explicit labels, visible keyboard focus,"
  say "   conventional high-contrast links, `aria-invalid`/`aria-describedby` error"
  say "   relationships, meaning that does not depend on color alone, and validation"
  say "   that still works with no JavaScript."
  say "\n   And keep the shape: render `presentation.combined` as ONE control, then"
  say "   iterate `presentation.itemized_statements` ā€” never `statements`, or you offer"
  say "   a second box for a statement the first one already answers.\n"
end