phlex-sinatra 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6281c981ddfb5118f6a6f0a38297dee0152e7052dc29aab21284de40814acfbb
-  data.tar.gz: 4d56528737f86832f8113ae8da2c05b0b41ef0643d7dc8f8a36d435e0ec7f00a
+  metadata.gz: a78afcc1302f4df83e718925f4dd189fd6270a83f6a0bd1a3fd14c480e15131e
+  data.tar.gz: 3337dfdb6dc398e901222b50c1b51fb480070204298b406c486238b4c0c8a58c
 SHA512:
-  metadata.gz: c818ef9cdee0f1bc70e2a8cdb98956c7e83313e2774d09330c6487a9c1f3f2b504c7aae5e57d5fefa7693311b609a3f94c16aa6caa63f18b76135f3c304d7309
-  data.tar.gz: c67a8d2d7d4b3b279fa812eb173b6c854af7c87d587894a6907059238e7c3df21daec28d2d0b14a2a600961b68f39deffe98d150bc7a2f0dce5386779e081893
+  metadata.gz: ddc9255d6c867f6bd67c349df61e05c0bc79af68a3ede5be8217bee8ae42b6b6f08c40064f43d956eec2ab82007742608d948b071c3efe448c3ca1196c1a626a
+  data.tar.gz: 62e813a5c2523581b1eecc0fd3b02549d698454433f49618b5b3500684fc7fad8018b7a90d245b80711ce80bb98b4b8091cfdfe8ce8dc2c0fd26b7d2610fa6c6

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Version 0.4.0 - 2024-09-10
+
+- Add support for wrapping a Phlex view in a layout. Pass `layout: true` to use Sinatra's default layout or specify the view by passing a symbol. Defaults to ERB and other Sinatra templating languages can be specified via the `layout_engine:` keyword.
+
 ## Version 0.3.0 - 2023-12-13
 
 - Add support for streaming a view. Pass `stream: true` to the `#phlex` helper so Phlex will use Sinatra's streaming capability.

data/Gemfile

@@ -6,6 +6,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'capybara'
+gem 'haml'
 gem 'puma'
 gem 'rack-test'
 gem 'rake'

data/README.md

@@ -24,7 +24,7 @@ You can now use Sinatra's `url()` helper method directly and its other methods (
 
 ```ruby
 class MyView < Phlex::HTML
-  def template
+  def view_template
     h1 { 'Phlex / Sinatra integration' }
     p {
       a(href: url('/foo', false)) { 'link to foo' }
@@ -42,6 +42,42 @@ get '/foo' do
 end
 ```
 
+## Layout
+
+If your entire view layer uses Phlex then layout will be a part of your component structure but maybe you've got an existing non-Phlex layout or you don't want to use Phlex for _everything_, in which case standard Sinatra layouts are supported.
+
+Pass `layout: true` to wrap the Phlex output with Sinatra's default layout -- a file named "layout.erb" in the configured views directory (ERB is the default) -- or pass a symbol to specify the file:
+
+```ruby
+get '/foo' do
+  # This Phlex view will be wrapped by `views/my_layout.erb`.
+  phlex MyView.new, layout: :my_layout
+end
+```
+
+Other [Sinatra templating languages](https://sinatrarb.com/intro.html#available-template-languages) can be specified via the `layout_engine` keyword:
+
+```ruby
+get '/foo' do
+  # This Phlex view will be wrapped by `views/layout.haml`.
+  phlex MyView.new, layout: true, layout_engine: :haml
+end
+```
+
+## Using Phlex in other templates
+
+It's also possible to call `phlex` from within other views, for instance an ERB template:
+
+```erb
+<%= phlex MyView.new %>
+```
+
+A `layout` can also be passed:
+
+```erb
+<%= phlex MyView.new, layout: :wrapper %>
+```
+
 ## Streaming
 
 Streaming a Phlex view can be enabled by passing `stream: true` which will cause Phlex to automatically write to the response after the closing `</head>` and buffer the remaining content:
@@ -58,7 +94,7 @@ You can also manually flush the contents of the buffer at any point using Phlex'
 
 ```ruby
 class Layout < Phlex::HTML
-  def template(&)
+  def view_template(&block)
     doctype
     html {
       head {
@@ -70,14 +106,14 @@ class Layout < Phlex::HTML
         # Standard site header and navigation.
         render Header.new
 
-        yield_content(&)
+        yield_content(&block)
       }
     }
   end
 end
 
 class MyView < Phlex::HTML
-  def template
+  def view_template
     render Layout.new {
       # Knowing that this page can take a while to generate we can choose to
       # flush here so the browser can render the site header while downloading

data/lib/phlex/sinatra/version.rb

@@ -2,6 +2,6 @@
 
 module Phlex
   module Sinatra
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/lib/phlex-sinatra.rb

@@ -6,6 +6,7 @@ require_relative 'phlex/sinatra/version'
 module Phlex
   module Sinatra
     Error = Class.new(StandardError)
+    IncompatibleOptionError = Class.new(Error)
 
     class TypeError < Error
       MAX_SIZE = 32
@@ -37,18 +38,38 @@ end
 
 module Sinatra
   module Templates
-    def phlex(obj, content_type: nil, stream: false)
+    def phlex(
+      obj,
+      content_type: nil,
+      layout: false,
+      layout_engine: :erb,
+      stream: false
+    )
       raise Phlex::Sinatra::TypeError.new(obj) unless obj.is_a?(Phlex::SGML)
 
-      content_type ||= :svg if obj.is_a?(Phlex::SVG)
+      content_type ||= :svg if obj.is_a?(Phlex::SVG) && !layout
       self.content_type(content_type) if content_type
 
+      # Copy Sinatra's behaviour and interpret layout=true as meaning "use the
+      # default layout" - uses an internal Sinatra instance variable :s
+      layout = @default_layout if layout == true
+
       if stream
+        raise Phlex::Sinatra::IncompatibleOptionError.new(
+          'streaming is not compatible with layout'
+        ) if layout
+
         self.stream do |out|
           obj.call(out, view_context: self)
         end
       else
-        obj.call(view_context: self)
+        output = obj.call(view_context: self)
+
+        if layout
+          render(layout_engine, layout, { layout: false }) { output }
+        else
+          output
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlex-sinatra
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Pickles
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-13 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: A Phlex adapter for Sinatra