phlex-sinatra 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a78afcc1302f4df83e718925f4dd189fd6270a83f6a0bd1a3fd14c480e15131e
-  data.tar.gz: 3337dfdb6dc398e901222b50c1b51fb480070204298b406c486238b4c0c8a58c
+  metadata.gz: 4ade28895613c97c295fa86d342ca9d3257776c26c049c83b2cf07a2be820217
+  data.tar.gz: 01503db3aa7fb22ae8721abb252e37a13a487c39754dc5403165015e79cea470
 SHA512:
-  metadata.gz: ddc9255d6c867f6bd67c349df61e05c0bc79af68a3ede5be8217bee8ae42b6b6f08c40064f43d956eec2ab82007742608d948b071c3efe448c3ca1196c1a626a
-  data.tar.gz: 62e813a5c2523581b1eecc0fd3b02549d698454433f49618b5b3500684fc7fad8018b7a90d245b80711ce80bb98b4b8091cfdfe8ce8dc2c0fd26b7d2610fa6c6
+  metadata.gz: a24fa744893452533b2be29534daf8cea3d2a9c99f04eacef9779998ede4ea6c09cc1cad0ab88599cd1cff7e56e6562540a07ef4e77014b3f690403278102a6c
+  data.tar.gz: 38fb8b653b9585149ccdb659ee13a8990afea1991a480003890dde99ab317bbe8eba70e9ae2bfdc6f06f6e4f7b5b345958cfb5fb1a1d97b022485d67ffc03483

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
   NewCops: enable
   SuggestExtensions: false
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
 
 Layout:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## Version 0.5.0 - 2025-02-23
+
+- Add support for Phlex 2, drop support for Phlex 1 - this also means the minimum required Ruby version is now 3.2.
+- Reimplement this library to use the official Sinatra extension API. For a modular-style app the extension must now be explicitly registered:
+
+  ```ruby
+  class MyApp < Sinatra::Base
+    helpers Phlex::Sinatra
+  end
+  ```
+
 ## 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.

data/Gemfile

@@ -12,4 +12,3 @@ gem 'rack-test'
 gem 'rake'
 gem 'rspec'
 gem 'rubocop'
-gem 'sinatra'

data/README.md

@@ -1,18 +1,24 @@
 # phlex-sinatra
 
-[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).
+[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 extension lets you use Sinatra's `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`.
+Add phlex-sinatra to your application's `Gemfile` and run `bundle install`.
 
 ```ruby
 gem 'phlex-sinatra'
 ```
 
+Then require it in your app:
+
+```ruby
+require '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):
+Use the `phlex` helper method to render a Phlex view and pass an _instance_ of the Phlex view (instead of using `.call` to get its output). For a classic-style Sinatra app it'll Just Work™:
 
 ```ruby
 get '/foo' do
@@ -20,6 +26,18 @@ get '/foo' do
 end
 ```
 
+For a modular app the extension must be explicitly registered:
+
+```ruby
+class MyApp < Sinatra::Base
+  helpers Phlex::Sinatra
+
+  get '/foo' do
+    phlex MyView.new
+  end
+end
+```
+
 You can now use Sinatra's `url()` helper method directly and its other methods (`params`, `request`, etc) via the `helpers` proxy:
 
 ```ruby

data/lib/phlex/sinatra/version.rb

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

data/lib/phlex-sinatra.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require 'phlex'
+require 'sinatra/base'
 require_relative 'phlex/sinatra/version'
 
 module Phlex
   module Sinatra
     Error = Class.new(StandardError)
-    IncompatibleOptionError = Class.new(Error)
+    ArgumentError = Class.new(Error)
 
     class TypeError < Error
       MAX_SIZE = 32
@@ -18,26 +19,16 @@ module Phlex
       end
     end
 
-    module SGML
-      module Overrides
-        def helpers
-          @_view_context
-        end
+    module SGMLOverrides
+      def helpers
+        context
+      end
 
-        def url(...)
-          helpers.url(...)
-        end
+      def url(...)
+        context.url(...)
       end
     end
-  end
-
-  class SGML
-    include Sinatra::SGML::Overrides
-  end
-end
 
-module Sinatra
-  module Templates
     def phlex(
       obj,
       content_type: nil,
@@ -45,9 +36,13 @@ module Sinatra
       layout_engine: :erb,
       stream: false
     )
-      raise Phlex::Sinatra::TypeError.new(obj) unless obj.is_a?(Phlex::SGML)
+      raise TypeError.new(obj) unless obj.is_a?(SGML)
+
+      if layout && stream
+        raise ArgumentError.new('streaming is not compatible with layout')
+      end
 
-      content_type ||= :svg if obj.is_a?(Phlex::SVG) && !layout
+      content_type ||= :svg if obj.is_a?(SVG) && !layout
       self.content_type(content_type) if content_type
 
       # Copy Sinatra's behaviour and interpret layout=true as meaning "use the
@@ -55,15 +50,11 @@ module Sinatra
       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)
+          obj.call(out, context: self)
         end
       else
-        output = obj.call(view_context: self)
+        output = obj.call(context: self)
 
         if layout
           render(layout_engine, layout, { layout: false }) { output }
@@ -73,4 +64,8 @@ module Sinatra
       end
     end
   end
+
+  SGML.include Sinatra::SGMLOverrides
 end
+
+Sinatra.helpers Phlex::Sinatra

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: phlex-sinatra
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ben Pickles
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2025-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -16,14 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Phlex adapter for Sinatra
 email:
 - spideryoung@gmail.com
@@ -49,7 +62,6 @@ metadata:
   homepage_uri: https://github.com/benpickles/phlex-sinatra
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/benpickles/phlex-sinatra
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -57,15 +69,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A Phlex adapter for Sinatra
 test_files: []