roda-phlex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 697b0c167a1b8e7c0a878d07a7b45c69e8ce1ea4ec7d04a8a2a1743df8856d63
+  data.tar.gz: 0ef55428df093f8e8d61106b7819bf822fea490228e58c7c921ecf8e4d54aed6
+SHA512:
+  metadata.gz: 6789258cef5d8ed114bc9cf5322b3440eb5b01122a8d046f09f30fe0382ee3b2eb7a2f055089c25cbce2d351d4b7da1041691e5c03a272c439b4fd41ad8440c7
+  data.tar.gz: c98632f1b504f435755b410dfcf0a5c7cc61b2f8fd9e59048bcde01966b01749b04a8aef1c4557a3f50e38911580e014a3869fe2a41408b2516e76ac55007ccf

data/.devcontainer/Gemfile

@@ -0,0 +1,7 @@
+# -*- mode: ruby; indent-tabs-mode: nil; tab-width: 2 -*-
+# This custom gemfile is automatically generated by the Ruby LSP.
+
+eval_gemfile(File.expand_path("../Gemfile", __dir__))
+
+gem "ruby-lsp", require: false, group: :development
+gem "ruby-lsp-rspec", require: false, group: :development

data/.devcontainer/devcontainer.json

@@ -0,0 +1,46 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/ruby:1-3.3-bullseye",
+	"features": {
+		"ghcr.io/devcontainers/features/git:1": {}
+	},
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Configure tool-specific properties.
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"shopify.ruby-extensions-pack"
+			],
+			"settings": {
+				"[ruby]": {
+					"editor.defaultFormatter": "Shopify.ruby-lsp", // Use the Ruby LSP as the default formatter
+					"editor.formatOnSave": true, // Format files automatically when saving
+					"editor.tabSize": 2, // Use 2 spaces for indentation
+					"editor.insertSpaces": true, // Use spaces and not tabs for indentation
+					"editor.semanticHighlighting.enabled": true, // Enable semantic highlighting
+					"editor.formatOnType": true // Enable formatting while typing
+				},
+				"rubyLsp.bundleGemfile": ".devcontainer/Gemfile",
+				"rubyLsp.formatter": "standard",
+				"rubyLsp.linters": [
+					"standard"
+				]
+			}
+		}
+	}
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-28
+
+- Initial release based on <https://github.com/benpickles/phlex-sinatra/commit/2e3c9a612cbf6f4b4bf5db880f164b66f008baf8> and <https://gist.github.com/RomanTurner/0ce0b8792e4149d152d2af2224cb6407>

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Robert Schulze
+Copyright (c) 2023 Ben Pickles
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,171 @@
+# roda-phlex
+
+A [Roda](https://github.com/jeremyevans/roda) plugin that adds some convenience rendering [Phlex](https://github.com/phlex-ruby/phlex) views.  
+Especially accessing application methods from the view.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add roda-phlex
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install roda-phlex
+```
+
+## Configuration
+
+`plugin :phlex` takes the following options:
+
+- `:layout` (`Phlex::SGML`): Specifies the layout class to be used for rendering
+  views. This class should be a Phlex layout class that defines how the
+  views are structured and rendered.
+- `:layout_opts` (`Object`): Options that are passed to the layout
+  class when it is instantiated. These options can be used to customize
+  the behavior of the layout. Usually, this is a `Hash`.
+- `:layout_handler` (`#call`): A custom handler for creating layout
+  instances. This proc receives three arguments: the layout class, the
+  layout options, and the object to be rendered. By default, it uses the
+  `layout.new(obj, **layout_opts)`, which instantiates the layout class with the
+  provided view object and options as keyword arguments.
+- `:delegate`: Define if or which methods should be delegated to the Roda app:
+  - `true` (default): Create a single `app` method that delegates to the Roda app.
+  - `false`: Do not create any delegate methods.
+  - `:all`: Delegate all methods the Roda app responds to, to it. Be careful with this option.
+            It can lead to unexpected behavior if the Roda app has methods that conflict with Phlex methods.
+  - `Symbol`, `String`, `Array`: Delegate only the specified methods to the Roda app.
+
+## Usage
+
+Add the plugin to the Roda application:
+
+```ruby
+plugin :phlex
+```
+
+Use the `phlex` method in the view to render a Phlex view:
+
+```ruby
+route do |r|
+  r.root do
+    phlex MyView.new
+  end
+end
+```
+
+You can use all application methods in the view:
+
+```ruby
+plugin :sinatra_helpers
+plugin :phlex, delegate: [:url]
+
+class MyView < Phlex::View
+  def view_template
+    h1 { 'Phlex / Roda request params integration' }
+    p {
+      a(href: url("/path", true)) { "link" }
+    }
+    pre { app.request.params.inspect }
+  end
+end
+```
+
+You can also pass an alternative content type (automatically sets `image/svg+xml` for a `Phlex::SVG` instance):
+
+```ruby
+route do |r|
+  r.get '/foo' do
+    phlex MyView.new, content_type: "application/xml"
+  end
+end
+```
+
+## 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.  
+The Roda `:stream` plugin must be enabled for this to work.
+
+```ruby
+plugin :streaming
+
+get '/foo' do
+  phlex MyView.new, stream: true
+end
+```
+
+You can also manually flush the contents of the buffer at any point using Phlex's `#flush` method:
+
+```ruby
+class Layout < Phlex::HTML
+  def template(&block)
+    doctype
+    html {
+      head {
+        # All the usual stuff: links to external stylesheets and JavaScript etc.
+      }
+      # Phlex will automatically flush to the response at this point which will
+      # benefit all pages that opt in to streaming.
+      body {
+        # Standard site header and navigation.
+        render Header.new
+
+        yield_content(&block)
+      }
+    }
+  end
+end
+
+class MyView < Phlex::HTML
+  def 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
+      # the rest of the page - which should help minimise the First Contentful
+      # Paint metric.
+      flush
+
+      # The rest of the big long page...
+    }
+  end
+end
+```
+
+## Reconfiguring in a route
+
+```ruby
+# Define a default layout and layout options for the whole application
+plugin :phlex, layout: MyLayout, layout_opts: { title: +"My App" }
+route do |r|
+  r.on "posts" do
+    # redefine the layout and layout options for this route tree
+    phlex_layout MyPostLayout
+    phlex_layout_opts[:title] << " - Posts"
+
+    r.get 'new' do
+      # Redefine the layout and layout options for this route
+      phlex_layout_opts[:title] = "Create new post"
+      phlex MyView.new
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/fnordfish/roda-phlex>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/fnordfish/roda-phlex/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Roda::Phlex project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fnordfish/roda-phlex/blob/main/CODE_OF_CONDUCT.md).
+
+## Acknowledgements
+
+This gem is based on [phlex-sinatra](https://github.com/benpickles/phlex-sinatra), and extended by the layout handling features in [RomanTurner's gist](https://gist.github.com/RomanTurner/0ce0b8792e4149d152d2af2224cb6407)

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/roda/phlex.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Roda
+  module RodaPlugins
+    module Phlex
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/roda/plugins/phlex.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+class Roda
+  module RodaPlugins
+    # The Phlex Plugin provides functionality for integrating Phlex with Roda applications.
+    #
+    # ### Phlex Plugin Options
+    #
+    # - `:layout` (+::Phlex::SGML+): Specifies the layout class to be used for rendering
+    #   views. This class should be a Phlex layout class that defines how the
+    #   views are structured and rendered.
+    # - `:layout_opts` (+Object+): Options that are passed to the layout
+    #   class when it is instantiated. These options can be used to customize
+    #   the behavior of the layout. Usually, this is a +Hash+.
+    # - `:layout_handler` (+#call+): A custom handler for creating layout
+    #   instances. This proc receives three arguments: the layout class, the
+    #   layout options, and the object to be rendered. By default, it uses the
+    #   `DEFAULT_LAYOUT_HANDLER`, which instantiates the layout class with the
+    #   provided object and options as keyword arguments.
+    # - `:delegate`: Define if or which methods should be delegated to the Roda app:
+    #   - `true` (default): Create a single `app` method that delegates to the Roda app.
+    #   - `false`: Do not create any delegate methods.
+    #   - `:all`: Delegate all methods the Roda app responds to, to it. Be careful with this option.
+    #             It can lead to unexpected behavior if the Roda app has methods that conflict with Phlex methods.
+    #   - `Symbol`, `String`, `Array`: Delegate only the specified methods to the Roda app.
+    module Phlex
+      Undefined = Object.new
+      private_constant :Undefined
+
+      Error = Class.new(StandardError)
+
+      # Custom TypeError class for Phlex errors.
+      class TypeError < Error
+        MAX_SIZE = 32
+
+        # Initializes a TypeError instance.
+        # @param obj [Object] The object that caused the error.
+        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
+
+      # The default layout handler for creating layout instances.
+      # Expects layout options to be a +Hash+ when provided.
+      DEFAULT_LAYOUT_HANDLER = proc do |layout, layout_opts, obj|
+        layout_opts ? layout.new(obj, **layout_opts) : layout.new(obj)
+      end
+
+      # Configures the Phlex plugin for the Roda application.
+      # @param app [Roda] The Roda application.
+      # @param opts [Hash] The options for configuring the Phlex plugin.
+      def self.configure(app, opts = OPTS)
+        delegate = opts.key?(:delegate) ? opts.delete(:delegate) : true
+        app.opts[:phlex] = opts
+        app.opts[:phlex][:layout_handler] ||= DEFAULT_LAYOUT_HANDLER
+
+        if delegate
+          overrides = Module.new do
+            def app
+              @_view_context
+            end
+
+            case delegate
+            when :all
+              def method_missing(name, ...)
+                if app.respond_to?(name)
+                  app.send(name, ...)
+                else
+                  super
+                end
+              end
+
+              def respond_to_missing?(name, include_private = false)
+                app.respond_to?(name) || super
+              end
+
+            when Symbol, String, Array
+              Array(delegate).each do |delegate|
+                class_eval <<~RUBY, __FILE__, __LINE__ + 1
+                  def #{delegate}(...)
+                    app.#{delegate}(...)
+                  end
+                RUBY
+              end
+            end
+          end
+
+          ::Phlex::SGML.include(overrides)
+        end
+      end
+
+      module InstanceMethods
+        # Retrieves or sets the layout.
+        # @param layout [Phlex::SGML, Undefined, nil] The layout to be set.
+        # @return [Phlex::SGML, nil] The current layout or nil if not set.
+        def phlex_layout(layout = Undefined)
+          case layout
+          when Undefined
+            opts.dig(:phlex, :layout)
+          when nil
+            opts[:phlex].delete(:layout)
+            opts[:phlex].delete(:layout_opts)
+          when ::Phlex::SGML
+            opts[:phlex][:layout] = layout
+          else
+            raise TypeError.new(layout)
+          end
+        end
+
+        # Retrieves or sets the layout options.
+        # @param layout_opts [Undefined, nil] The layout options to be set.
+        # @return [Object, nil] The current layout options or nil if not set.
+        def phlex_layout_opts(layout_opts = Undefined)
+          case layout_opts
+          when Undefined
+            opts.dig(:phlex, :layout_opts)
+          when nil
+            opts[:phlex].delete(:layout_opts)
+          else
+            opts[:phlex][:layout_opts] = layout_opts
+          end
+        end
+
+        # Retrieves or sets the layout handler.
+        # @param handler [#call, Undefined, nil] The layout handler to be set.
+        # @return [#call, nil] The current layout handler or nil if not set.
+        def phlex_layout_handler(handler = Undefined)
+          case handler
+          when Undefined
+            opts.dig(:phlex, :layout_handler)
+          when nil
+            opts[:phlex].delete(:layout_handler)
+          else
+            opts[:phlex][:layout_handler] = handler
+          end
+        end
+
+        # Renders a Phlex object.
+        # @param obj [Phlex::SGML] The Phlex object to be rendered.
+        # @param content_type [String, nil] The content type of the response.
+        # @param stream [Boolean] Whether to stream the response or not.
+        def phlex(obj, content_type: nil, stream: false)
+          raise TypeError.new(obj) unless obj.is_a?(::Phlex::SGML)
+
+          content_type ||= "image/svg+xml" if obj.is_a?(::Phlex::SVG)
+          response["Content-Type"] = content_type if content_type
+
+          phlex_opts = opts[:phlex]
+          renderer = if (layout = phlex_opts[:layout])
+            phlex_layout_handler.call(layout, phlex_opts[:layout_opts], obj)
+          else
+            obj
+          end
+
+          if stream
+            self.stream do |out|
+              renderer.call(out, view_context: self)
+            end
+          else
+            renderer.call(view_context: self)
+          end
+        end
+      end
+    end
+
+    register_plugin :phlex, Phlex
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: roda-phlex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Schulze
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: phlex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: A Phlex adapter for Roda
+email:
+- robert@dotless.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/Gemfile"
+- ".devcontainer/devcontainer.json"
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/roda/phlex.rb
+- lib/roda/plugins/phlex.rb
+homepage: https://github.com/fnordfish/roda-phlex
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fnordfish/roda-phlex
+  source_code_uri: https://github.com/fnordfish/roda-phlex
+  changelog_uri: https://github.com/fnordfish/roda-phlex/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: A Phlex adapter for Roda
+test_files: []