hanami-papercraft 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d00da72648def7ecd464737f0f4a3ebfd7090e9d615017d6b35bcda49d3e3d0
+  data.tar.gz: 35ea3d99c2ffba9249ff4195bce50000e7a6852f739e5f1a90df3da164025200
+SHA512:
+  metadata.gz: aad52744492ac284dd3fed0787326432ef69b3d6ce2572ae4d84503e0b0131bdabbb035ea2fecb9a48659a1a58a95e456a6bd55bc0bf2d0e610bebf11bb9bb6d
+  data.tar.gz: 0070ec8a237a4ada0e638888965b7bc935453411d29cffa8bcd9299b9f738d38250305f0d92561256a0ef9c601c2ebf8ac56a0da0df432e6679cb47d735c7098

data/README.md

@@ -0,0 +1,114 @@
+# hanami-papercraft
+
+## Use Papercraft templates with Hanami
+
+> **Note**: this project is still in an experimental stage.
+
+The `hanami-papercraft` gem lets you create Hanami views using Papercraft
+templates. Papercraft is an innovaive new gem for generating HTML using plain
+Ruby. For more information on Papercraft please visit the Papercraft website:
+[papercraft.noteflakes.com](https://papercraft.noteflakes.com).
+
+This gem introduces a new view class called `Hanami::PapercraftView`, which you
+can use instead of `Hanami::View` as the base class of your app's views.
+
+## Usage
+
+For the sake of simplicity, we'll base the following instructions on the Hanami
+[getting started
+guide](https://guides.hanamirb.org/v2.3/introduction/building-a-web-app/).
+Please keep in mind that `hanami-papercraft` is still in a very early stage of
+development, so things might not work as you expect, especially if you use the
+more advanced features of Hanami.
+
+### 1. Set your app's basic view class 
+
+In the `app/view.rb` file, change the `View` classes superclass to `Hanami::PapercraftView`:
+
+```ruby
+# app/view.rb
+
+module Bookshelf
+  class View < Hanami::PapercraftView
+  end
+end
+```
+
+### 2. Use a Papercraft layout template
+
+Replace the app's layout template stored in `app/templates/layouts/app.html.erb`
+with a file named `app/templates/layouts/app.papercraft.rb`:
+
+```ruby
+# app/templates/layouts/app.papercraft.rb
+
+->(config:, context:, **props) {
+  html(lang: "en") {
+    head {
+      meta charset: "UTF-8"
+      meta name: "viewport", content: "width=device-width, initial-scale=1.0"
+      title "Bookshelf"
+      favicon_tag
+      stylesheet_tag(context, "app")
+    }
+    body {
+      render_children(config:, context:, **props)
+      javascript_tag(context, "app")
+    }
+  }
+}
+```
+
+### 3. Use Papercraft view templates
+
+You can now start writing your view templates with Papercraft, e.g.:
+
+```ruby
+# app/templates/books/index.papercraft.rb
+
+->(context:, books:, **props) {
+  h1 "Books"
+
+  ul {
+    books.each do |book|
+      Kernel.p book
+      li book[:title]
+    end
+  }
+}
+
+```
+
+## Passing Template Parameters
+
+While theoretically you have access to the view class in your templates (through
+`self`), you should use explicit arguments in your templates, as shown in the
+examples above. The `PapercraftView` class always passes template parameters as
+keyword arguments to the layout and the view templates.
+
+In the view template above, the `books` keyword argument is defined because the
+view class exposes such a parameter:
+
+```ruby
+# app/views/books/index.rb
+
+module Bookshelf
+  module Views
+    module Books
+      class Index < Bookshelf::View
+        expose :books do
+          [
+            {title: "Test Driven Development"},
+            {title: "Practical Object-Oriented Design in Ruby"}
+          ]
+        end
+      end
+    end
+  end
+end
+```
+
+## Contributing
+
+
+Please feel free to contribute issues and PR's...

data/lib/hanami/papercraft_view.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "hanami/view"
+require "hanami/helpers/assets_helper"
+require "papercraft"
+
+Hanami::View::ERB::Escape = ERB::Escape
+
+module Hanami
+  class PapercraftView < Hanami::View
+    include Hanami::Helpers::AssetsHelper
+    class << self
+      include Hanami::Helpers::AssetsHelper
+    
+      def _typed_url(context, source, ext)
+        source = "#{source}#{ext}" if source.is_a?(String) && _append_extension?(source, ext)
+        asset_url(context, source)
+      end
+    
+      def _append_extension?(source, ext)
+        source !~ QUERY_STRING_MATCHER && source !~ /#{Regexp.escape(ext)}\z/
+      end
+    
+      def asset_url(context, source)
+        return source.url if source.respond_to?(:url)
+        return source if _absolute_url?(source)
+      
+        context.assets[source].url
+      end
+    
+      def _absolute_url?(source)
+        ABSOLUTE_URL_MATCHER.match?(source.respond_to?(:url) ? source.url : source)
+      end
+    
+      def _nonce(context, source, nonce_option)
+        if nonce_option == false
+          nil
+        elsif nonce_option == true || (nonce_option.nil? && !_absolute_url?(source))
+          content_security_policy_nonce(context)
+        else
+          nonce_option
+        end
+      end
+    
+      CONTENT_SECURITY_POLICY_NONCE_REQUEST_KEY = "hanami.content_security_policy_nonce"
+    
+      def content_security_policy_nonce(context)
+        return unless context.request
+      
+        context.request.env[CONTENT_SECURITY_POLICY_NONCE_REQUEST_KEY]
+      end
+    
+      def _subresource_integrity_value(context, source, ext)
+        return if _absolute_url?(source)
+      
+        source = "#{source}#{ext}" unless /#{Regexp.escape(ext)}\z/.match?(source)
+        context.assets[source].sri
+      end
+    end
+  
+    ::Papercraft.extension(
+      favicon_tag: -> {
+        link href: "/assets/favicon.ico", rel: "shortcut icon", type: "image/x-icon"
+      },
+      stylesheet_tag: ->(context, *sources, **options) {
+        options = options.reject { |k, _| k.to_sym == :href }
+        nonce_option = options.delete(:nonce)
+    
+        sources.each do |source|
+          attributes = {
+            href: Hanami::PapercraftView._typed_url(context, source, Hanami::PapercraftView::STYLESHEET_EXT),
+            type: Hanami::PapercraftView::STYLESHEET_MIME_TYPE,
+            rel: Hanami::PapercraftView::STYLESHEET_REL,
+            nonce: Hanami::PapercraftView._nonce(context, source, nonce_option)
+          }
+          attributes.merge!(options)
+        
+          if context.assets.subresource_integrity? || attributes.include?(:integrity)
+            attributes[:integrity] ||= Hanami::PapercraftView._subresource_integrity_value(context, source, STYLESHEET_EXT)
+            attributes[:crossorigin] ||= Hanami::PapercraftView::CROSSORIGIN_ANONYMOUS
+          end
+        
+          link(**attributes)
+        end
+      },
+      javascript_tag: ->(context, *sources, **options) {
+        options = options.reject { |k, _| k.to_sym == :src }
+        nonce_option = options.delete(:nonce)
+    
+        sources.each do |source|
+          attributes = {
+            src: Hanami::PapercraftView._typed_url(context, source, Hanami::PapercraftView::JAVASCRIPT_EXT),
+            type: Hanami::PapercraftView::JAVASCRIPT_MIME_TYPE,
+            nonce: Hanami::PapercraftView._nonce(context, source, nonce_option)
+          }
+          attributes.merge!(options)
+        
+          if context.assets.subresource_integrity? || attributes.include?(:integrity)
+            attributes[:integrity] ||= Hanami::PapercraftView._subresource_integrity_value(context, source, JAVASCRIPT_EXT)
+            attributes[:crossorigin] ||= Hanami::PapercraftView::CROSSORIGIN_ANONYMOUS
+          end
+        
+          script(**attributes)
+        end
+      }
+    )
+    
+    def call(context:, layout: nil, **props)
+      layout ||= config.layout
+    
+      locals = exposures.(context:, **props) do |value, exposure|
+        # TODO: what is decorate? and how do we support this without a rendering object
+        # if exposure.decorate? && value
+        #   rendering.part(exposure.name, value, as: exposure.options[:as])
+        # else
+          value
+        # end
+      end
+      
+      template_params = {
+        context: context,
+        config: config,
+        **props,
+        **locals
+      }
+    
+      puts '*' * 40
+      p params: template_params.keys
+      puts
+    
+      template = load_template(config.template)
+      puts template.compiled_code
+      puts
+    
+      if layout
+        layout_template = load_layout_template(layout)
+        layout_template.render(**template_params, &template)
+      else
+        template.render(**template_params)
+      end
+    end
+  
+    def load_layout_template(name)
+      root ||= config.paths.first.root
+      fn = File.join(root, "layouts/#{name}.papercraft.rb")
+      source = IO.read(fn)
+      eval(source, binding, fn)
+    end
+  
+    def load_template(name)
+      root ||= config.paths.first.root
+      fn = File.join(root, "#{name}.papercraft.rb")
+      source = IO.read(fn)
+      eval(source, binding, fn)
+    end      
+  end
+end

data/lib/hanami/papercraft_view_version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hanami
+  PAPERCRAFT_VIEW_VERSION = "0.1"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: hanami-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: hanami-view
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !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
+- papercraft.png
+files:
+- CHANGELOG.md
+- README.md
+- lib/hanami/papercraft_view.rb
+- lib/hanami/papercraft_view_version.rb
+- papercraft.png
+homepage: http://github.com/digital-fabric/hanami-papercraft
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/digital-fabric/hanami-papercraft
+  changelog_uri: https://github.com/digital-fabric/hanami-papercraft/blob/master/CHANGELOG.md
+rdoc_options:
+- "--title"
+- Hanami-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: 'Hanami-Papercraft: Papercraft views for Hanami'
+test_files: []