phlex-sinatra 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d74cf72d60a394421ad29c44f264a94fbacb60e00434a52cb16ddc72f88fd586
-  data.tar.gz: 05a8edc2a431763003c13b8ec3fc91f2471b0f5feadea234314dbae770535554
+  metadata.gz: a0e0c3d6038f57d3a01b5abb0172d1598a0edb08d46e455dede38da9ad708560
+  data.tar.gz: 6e5025677940fc22ed1830405646c18d4d441f8125a4c37f3179d8c8e735a354
 SHA512:
-  metadata.gz: a0e1f7096bdd91b5e7cbaa10bfbaaedd26447463d9e86c2f5ab71465302b1af9520a1a574721cd6402ea3aa8f0d80dfa67138cc7c2e73d2fa40927ef72cefb7e
-  data.tar.gz: 00d710702436b31b687bbf25e0ae03c0e7356bd721f3c7e3f0b21c8ab1ecd3130fe3405100bc8a8ef4fdb351ab5886c25040c7ec6c5f6c1281c16209dc9919c2
+  metadata.gz: e94e93fbb09a9b6043667f8139cc515a4d6b5302f3459b5216d4f900d471579b4621716e1734d4dd38ead39788074c6442ed3f0c46ce63e7aa9faa4868bb4cda
+  data.tar.gz: 5026ea9e6f0af3ae2b064dc475d441e85b6753e49e37ef1e57f6aca00d3d7e15feb8a6eb188a6939eff70c0dae7ff1fa4db8447f3cd2a6c512a9212273ef4a4e

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Version 0.2.0 - 2023-04-24
+
+- Allow passing a `content_type:` kwarg to the `#phlex` helper so it behaves like Sinatra's other template helpers (defaults to `:html` – or `:svg` for a `Phlex::SVG` instance).
+- Raise an informative error message if the `#phlex` helper receives something other than a Phlex instance.
+
 ## Version 0.1.0 - 2023-04-17
 
 - Initial release

data/README.md

@@ -2,6 +2,14 @@
 
 [Phlex](https://github.com/phlex-ruby/phlex) already works with Sinatra (and everything else) but its normal usage leaves you without access to Sinatra's standard helper methods. This integration lets you use the `url()` helper method from within a Phlex view (along with the rest of the helper methods available in a Sinatra action).
 
+## Installation
+
+Add phlex-sinatra to your application's Gemfile and run `bundle install`.
+
+```ruby
+gem 'phlex-sinatra'
+```
+
 ## Usage
 
 To enable the integration use the `phlex` method in your Sinatra action and pass an _instance_ of the Phlex view (instead of using `.call` to get its output):
@@ -26,6 +34,14 @@ class MyView < Phlex::HTML
 end
 ```
 
+You can also pass an alternative content type – which defaults to `:html` (or `:svg` for a `Phlex::SVG` instance):
+
+```ruby
+get '/foo' do
+  phlex MyView.new, content_type: :xml
+end
+```
+
 ## Why?
 
 It might not seem obvious at first why you'd use `url()` at all given that you mostly just pass the string you want to output and then probably `false` so the scheme/host isn't included.
@@ -34,13 +50,13 @@ There are a couple of reasons:
 
 1. **Linking to a full URL**
 
-   Sometimes you need to link to a page on the site using its full URL -- for instance within a feed or for an `og:image` social media preview image link.
+   Sometimes you need to link to a page on the site using its full URL – for instance within a feed or for an `og:image` social media preview image link.
 
 2. **Awareness that the app is being served from a subdirectory**
 
-   This isn't something you encounter very often in a standard Sinatra app but you hit it quite quickly if you're using [Parklife](https://github.com/benpickles/parklife) to generate a static build which you host on GitHub Pages -- which is exactly what prompted me to write this integration.
+   This isn't something you encounter very often in a standard Sinatra app but you hit it quite quickly if you're using [Parklife](https://github.com/benpickles/parklife) to generate a static build which you host on GitHub Pages – which is exactly what prompted me to write this integration.
 
-   In this case by using the `url()` helper you won’t have to change anything when switching between serving the app from `/` in development and hosting it at `/my-repository/` in production -- internal links to other pages/stylesheets/etc will always be correct regardless.
+   In this case by using the `url()` helper you won’t have to change anything when switching between serving the app from `/` in development and hosting it at `/my-repository/` in production – internal links to other pages/stylesheets/etc will always be correct regardless.
 
 ## Contributing
 

data/lib/phlex/sinatra/version.rb

@@ -2,6 +2,6 @@
 
 module Phlex
   module Sinatra
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/phlex-sinatra.rb

@@ -5,6 +5,18 @@ require_relative 'phlex/sinatra/version'
 
 module Phlex
   module Sinatra
+    Error = Class.new(StandardError)
+
+    class TypeError < Error
+      MAX_SIZE = 32
+
+      def initialize(obj)
+        content = obj.inspect
+        content = content[0, MAX_SIZE] + '…' if content.size > MAX_SIZE
+        super "Expected a Phlex instance, received #{content}"
+      end
+    end
+
     module SGML
       module Overrides
         def helpers
@@ -25,7 +37,12 @@ end
 
 module Sinatra
   module Templates
-    def phlex(obj)
+    def phlex(obj, content_type: nil)
+      raise Phlex::Sinatra::TypeError.new(obj) unless obj.is_a?(Phlex::SGML)
+
+      content_type ||= :svg if obj.is_a?(Phlex::SVG)
+      self.content_type(content_type) if content_type
+
       obj.call(view_context: self)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlex-sinatra
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Pickles
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex