brut 0.13.0 → 0.14.0

data/lib/brut/front_end/components/page_identifier.rb

@@ -1,13 +1,16 @@
-# Renders a `<meta>` tag that contains the name of the page.  This is useful for end to end tests to assert that they are on a specific page before continuing with the test.  It can eliminate a lot of confusion when a test fails.
+# Renders a `<meta>` tag (in dev and test) that contains the name of the page.  This is useful for end to end tests to assert that they are on a specific page before continuing with the test.  It can eliminate a lot of confusion when a test fails.
 class Brut::FrontEnd::Components::PageIdentifier < Brut::FrontEnd::Component
-  def initialize(page_name)
-    @page_name = page_name
+  # Create the component
+  #
+  # @param [Brut::FrontEnd::Page] page the current page
+  def initialize(page)
+    @page = page
   end
 
   def view_template
     if Brut.container.project_env.production?
       return nil
     end
-    meta(name: "class", content: @page_name)
+    meta(name: "class", content: @page.page_name)
   end
 end

data/lib/brut/front_end/layout.rb

@@ -6,6 +6,17 @@
 #
 # This base class contains helper methods needed for implementing a layout.
 class Brut::FrontEnd::Layout < Brut::FrontEnd::Component
+
+  # Access the page being laid out
+  attr_reader :page
+
+  # Create the layout for a given page.
+  #
+  # @param [Brut::FrontEnd::Page] page the page being laid out.
+  def initialize(page:)
+    @page = page
+  end
+
   # Get the actual path of an asset managed by Brut. This handles
   # locating the asset's URL as well as ensuring the hash is properly
   # inserted into the filename.

data/lib/brut/front_end/page.rb

@@ -90,7 +90,7 @@ private
       ].join("_")).camelize
     )
     Brut.container.instrumentation.add_prefixed_attributes("brut", layout_class: layout_class)
-    render layout_class.new(page_name:,&block)
+    render layout_class.new(page:self,&block)
   end
 
 

data/lib/brut/version.rb

@@ -1,4 +1,4 @@
 module Brut
   # @!visibility private
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/mkbrut/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mkbrut (0.13.0)
+    mkbrut (0.14.0)
 
 GEM
   remote: https://rubygems.org/

data/mkbrut/lib/mkbrut/version.rb

@@ -1,3 +1,3 @@
 module MKBrut
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/mkbrut/templates/Base/app/src/front_end/layouts/blank_layout.rb

@@ -0,0 +1,11 @@
+# A blank layout that just renders whatever the page content is.
+# This is useful for a page that can respond to Ajax and not want
+# the surrounding HTML metadata.
+class BlankLayout < Brut::FrontEnd::Layout
+  include Brut::FrontEnd::Components
+
+  def view_template
+    yield
+  end
+end
+

data/mkbrut/templates/Base/app/src/front_end/layouts/default_layout.rb.erb

@@ -4,10 +4,6 @@
 class DefaultLayout < Brut::FrontEnd::Layout
   include Brut::FrontEnd::Components
 
-  def initialize(page_name:)
-    @page_name = page_name
-  end
-
   # Brut::FrontEnd::Page's view_template ultimately calls this method
   # to wrap itself in the layout defined below.
   def view_template
@@ -35,7 +31,8 @@ class DefaultLayout < Brut::FrontEnd::Layout
 
         # Brut::FrontEnd::Components::PageIdentifier, which produces
         # a <meta> tag with the page's name. Useful for end to end tests.
-        PageIdentifier(@page_name)
+        # Does not generate anything in production.
+        PageIdentifier(page)
 
         # Brut::FrontEnd::Components::I18nTranslations, which includes
         # translations starting with cv.cs for use with client-side
@@ -60,7 +57,7 @@ class DefaultLayout < Brut::FrontEnd::Layout
       end
       # Adds the page's name as a class name. You can use this for
       # CSS if needed.
-      body(class: @page_name) do
+      body(class: page.page_name) do
         # Render the <brut-tracing> element, which will send
         # OpenTelemetry traces back to the server to be joined up with
         # the server's traces.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brut
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - David Bryant Copeland
@@ -703,7 +703,6 @@ files:
 - brutrb.com/public/favicon.ico
 - brutrb.com/recipes/alternate-layouts.md
 - brutrb.com/recipes/authentication.md
-- brutrb.com/recipes/blank-layouts.md
 - brutrb.com/recipes/custom-flash.md
 - brutrb.com/recipes/form-errors.md
 - brutrb.com/recipes/indexed-forms.md
@@ -1475,6 +1474,7 @@ files:
 - mkbrut/templates/Base/app/src/front_end/images/icon.png
 - mkbrut/templates/Base/app/src/front_end/images/mkicons.sh
 - mkbrut/templates/Base/app/src/front_end/js/index.js
+- mkbrut/templates/Base/app/src/front_end/layouts/blank_layout.rb
 - mkbrut/templates/Base/app/src/front_end/layouts/default_layout.rb.erb
 - mkbrut/templates/Base/app/src/front_end/pages/app_page.rb
 - mkbrut/templates/Base/app/src/front_end/pages/home_page.rb

data/brutrb.com/recipes/blank-layouts.md

@@ -1,22 +0,0 @@
-# Blank or No Layout
-
-If you don't want a layout, you are encouraged to create a blank layout, for example:
-
-```ruby
-class BlankLayout < Brut::FrontEnd::Layout
-  def view_template
-    yield
-  end
-end
-
-# use like so:
-
-class NakedPage < AppPage
-  def layout = "blank"
-
-  def page_template
-    # ...
-  end
-end
-```
-