outro_rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59bd1b6132a33453ad21b45a5b217c08df5a52bd860a538af18255a464916c00
-  data.tar.gz: 3096b3ab4acd40c8e1a3d557831ba8b2888a3db958597f83336c368dfc0dd6f4
+  metadata.gz: 9bdd0f00d9a9bb3bbbc48093a20dc2a393fb8d5e1e7550bac61d78ee06443701
+  data.tar.gz: d01f6eede0c71eb2bc87cd6d0e2b454f36ca106e83e56fc5d4f3b0de2791a8c4
 SHA512:
-  metadata.gz: 6d6b2bc029e0b97ccc479c807591f74e465e40f5f4df827be705b093890e5a895b775c1ccf4594ce407810da677ac633485187c29ceec581f9d349107c500ce9
-  data.tar.gz: 06f1d6bfbc3d57cffbe5d88a588d2a5cebf5891ff8906e97c009eabd5d4f6473f6da82a5e6bf671ccac92e372feb2689fb0041778aed36f57ad8c900aec52d03
+  metadata.gz: 3f9bf6e7922a4dadd3a2a2d85875c532b1f450bdaaec94eb701de80d76f0aeee31e2d564d7635f3c6a0f73b752799cd80b9ae872c15c76d6b24d3979fbab4dcb
+  data.tar.gz: 9924863f7d1c9608c753f9934b8de317ff72818ad29a9184ae73d686355418d32f8ce443a110f0face0b5aca90a364a0231b05f6a44e30e4561a61b0954fb5cb

data/README.md

@@ -18,7 +18,7 @@ then `bundle install`.
 Copy the engine's migrations into your app and run them:
 
 ```sh
-bin/rails outro:install:migrations
+bin/rails outro_rails:install:migrations
 bin/rails db:migrate
 ```
 
@@ -41,6 +41,13 @@ bin/rails outro_rails:seed
 
 Seeding is idempotent, so it's safe to re-run at any time.
 
+Add the javascript and css files to your layout:
+
+```html
+<%= stylesheet_link_tag "outro_rails/outro_rails", 'data-turbo-track': 'reload' %>
+<%= javascript_include_tag "outro_rails/outro_rails", 'data-turbo-track': 'reload', defer: true %>
+```
+
 ## Usage
 To view the chord library and music theory tools, mount the engine in your
 routes.rb:
@@ -144,6 +151,57 @@ This renders the chart's metadata, an instrument toggle, a transpose-to-key
 picker, the chart body with recognized chords highlighted, and a
 diagram for every chord the body references.
 
+### Using Your Own Layout
+
+By default the engine renders its pages in its own layout,
+`outro_rails/application`. To render them inside your application's layout
+instead, set `OutroRails.layout` in an initializer:
+
+```ruby
+# config/initializers/outro_rails.rb
+OutroRails.layout = "application"
+```
+
+The value is any layout name your app can resolve, so a dedicated layout
+works too (`"outro"` for `app/views/layouts/outro.html.erb`). Setting it to
+`false` renders engine pages with no layout at all.
+
+There are two things to check in the layout you point it at.
+
+#### 1. Prefix your app's route helpers with `main_app`
+
+Views rendered by an engine controller resolve route helpers against the
+*engine's* router, not your app's. Reach your own routes through the `main_app`
+proxy:
+
+```erb
+<!-- app/views/layouts/application.html.erb -->
+<header>
+  <%= link_to "Home", main_app.root_path %>
+  <%= link_to "Songs", main_app.songs_path %>
+  <%= link_to "Chords", outro_rails.chords_path %>
+</header>
+```
+
+#### 2. Make your helpers available
+
+`OutroRails::ApplicationController` inherits from `ActionController::Base`,
+not from your `ApplicationController`, so your `ApplicationHelper` is not
+mixed in. If your layout calls a helper you defined, it will raise `NameError`
+when the engine renders it.
+
+Attach your helpers to the engine's controller in an initializer, inside a
+`to_prepare`:
+
+```ruby
+# config/initializers/outro_rails.rb
+OutroRails.layout = "application"
+
+Rails.application.config.to_prepare do
+  OutroRails::ApplicationController.helper(::ApplicationHelper)
+end
+```
+
 ### Authorizing Chart Edits
 
 The chart's own content (artist, title, body, key, ...) is edited through

data/app/controllers/outro_rails/application_controller.rb

@@ -2,5 +2,6 @@
 
 module OutroRails
   class ApplicationController < ActionController::Base
+    layout -> { OutroRails.layout }
   end
 end

data/lib/outro_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OutroRails
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/outro_rails.rb

@@ -9,6 +9,8 @@ require "outro_rails/instruments"
 require "outro_rails/chord_chart_attribute"
 
 module OutroRails
+  mattr_accessor :layout, default: "outro_rails/application"
+
   mattr_accessor :chord_chart_voicing_authorization,
     default: ->(chord_chart:, controller:) { true }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outro_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - endtoendpaper