roda-papercraft 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4bae32ac354bba9e1ce8fe298fbfd86a2dfe61ef964c6ed3a5098554edd7371
+  data.tar.gz: 28683302a47e6ee38773de562150e37e003744234acfea74ec1da8c06906a9c5
+SHA512:
+  metadata.gz: d7ab2d97ee095762649b9c5998fbefb6f6e8559318e8ece942317e565d07d45ad5f6a8d3da43864a6ee5f550d20335f7a5b509883618d169def23d62a635f343
+  data.tar.gz: 7a6bd908e98083b622443662197594e6f9572d0cd42f187f021ab7bc1376e63eab2e0dad37d18dafe529895669e0f9acb0ef7a93866f14922fa9493fdd8ed1a1

data/README.md

@@ -0,0 +1,107 @@
+# roda-papercraft
+
+## Papercraft plugin for Roda
+
+The `roda-papercraft` Roda plugin adds some methods to let you render
+[Papercraft](https://papercraft.noteflakes.com/) templates in your Roda app.
+This plugin lets you either define templates inline inside your Roda router, or
+load templates from files. This repository includes an example directory with an
+example Roda app showing typical use.
+
+To use Papercraft with Roda, do the following:
+
+### 1. Add roda-papercraft to your App
+
+In your `Gemfile`, add the following line:
+
+```ruby
+gem "roda-papercraft"
+```
+
+### 2. Activate the Papercraft Plugin
+
+In your Roda app, load roda-papercraft:
+
+```ruby
+require "roda-papercraft"
+```
+
+Then load the plugin inside your app:
+
+```ruby
+class App < Roda
+  plugin :papercraft
+  ...
+end
+```
+
+By default, the template root is `"templates"` (relative to the working
+directory). To change the template root, you can configure the plugin:
+
+```ruby
+class App < Roda
+  plugin :papercraft
+  ...
+end
+```
+
+## Rendering Templates from Files
+
+Your template files are normal Ruby source files. Each file should contain a
+single lambda. Here's an example:
+
+```ruby
+# templates/hello.rb
+-> {
+  h1 "Hello from Papercraft"
+}
+```
+
+To render the template, first load it using the `#template` method, and then run
+`#render` on it:
+
+```ruby
+route do |r|
+  r.get "hello" do
+    template("hello").render
+  end
+
+  ...
+end
+```
+
+If the template takes arguments, you can pass them through the `#render` call:
+
+```ruby
+# templates/greet.rb
+->(name) {
+  h1 "Hello, #{name}!"
+}
+
+# in your app
+route do |r|
+  r.get "greet", String do |name|
+    template("greet").render(name)
+  end
+  ...
+end
+```
+
+## Rendering Templates Inline
+
+To render templates inline, just use `#render` directly.
+
+```ruby
+route do |r|
+  r.get "hello" do
+    render {
+      h1 "Hello from Papercraft"
+    }
+  end
+end
+```
+
+## Contributing
+
+I gladly accept contributions to roda-papercraft. Please feel free to open
+issues or PRs.

data/lib/roda/plugins/papercraft.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "papercraft"
+require "fileutils"
+
+class Roda
+  module RodaPlugins
+    module Papercraft
+      # Set the file to load the routes metadata from.  Options:
+      # :file :: The JSON file containing the routes metadata (default: 'routes.json')
+      def self.configure(app, opts = {})
+        template_root = opts[:template_root] || File.join(FileUtils.pwd, "templates")
+
+        app.instance_exec do
+          @template_root ||= template_root
+        end
+      end
+
+      module ClassMethods
+        def template_root
+          @template_root
+        end
+      end
+      
+      module InstanceMethods
+        def render(*, **, &block)
+          block.render(*, **)
+        end
+
+        def template(name)
+          (@templates ||= {})[name] ||= load_template(name)
+        end
+
+        private
+
+        def load_template(name)
+          fn = File.join(self.class.template_root, "#{name}.rb")
+          source = IO.read(fn)
+          eval(source, binding, fn)
+        end
+      end
+    end
+
+    register_plugin(:papercraft, Papercraft)
+  end
+end

data/lib/roda-papercraft.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'roda/plugins/papercraft'

data/lib/roda_papercraft_version.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+RODA_PAPERCRAFT_VERSION = "0.1"

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: roda-papercraft
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Sharon Rosner
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roda
+  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'
+- !ruby/object:Gem::Dependency
+  name: papercraft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.25.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.25.5
+email: sharon@noteflakes.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- CHANGELOG.md
+- README.md
+- lib/roda-papercraft.rb
+- lib/roda/plugins/papercraft.rb
+- lib/roda_papercraft_version.rb
+homepage: http://github.com/digital-fabric/roda-papercraft
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/digital-fabric/roda-papercraft
+  changelog_uri: https://github.com/digital-fabric/roda-papercraft/blob/master/CHANGELOG.md
+rdoc_options:
+- "--title"
+- Roda-Papercraft
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.0.dev
+specification_version: 4
+summary: 'roda-papercraft: Papercraft views for Roda'
+test_files: []