papercraft 0.27 → 0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd2f4f4d1ebc2cfc5718079d68c9393b3d95def9c02b057107425ddd5b45eaf3
-  data.tar.gz: f3f82f29227e22e5e31b0d685bcab211ebbef0ecf8a4433d251cb1f204875cf7
+  metadata.gz: 1ca707074311c909d6e2b4aa86748f1ffbd5b614d73fb78e85985d174b69e263
+  data.tar.gz: f53dc4fa5088472ccc805f50938f25539950446fe14e97facb2cc346722d13fe
 SHA512:
-  metadata.gz: 7389861bea04a92e06ce1a53a682ef3b4db1bf975bb7f5e63cef0ed6c1a4ebb4b92920a0bb4ea04eba24dc72b41c70ba8fac0d8aa605a2b5a720d7860198b7e0
-  data.tar.gz: 2a617260deef291c56cd0c3fc1b275d47dd1dc95bdeeafc69289d630260480e49126c29f0ec77c177fd6c1032c633ba2568be1ffb767e13f91e51b5a9c298831
+  metadata.gz: 0d216f2c8db4beed8c7fe184d3b8e0a13ba8af4684d4e46f5506f0b1eb6c3bfaa0ad76b7a5b1b6e28a8ba37a730545ca00139fd0bf35b74628d117c504fc1e9c
+  data.tar.gz: 27ac04cf8b75b5d6abda511513618fb6ef20417365ac7b45855d909323db3c536204f85d719a44e2374b095d955f4eb0c25901290990dab861c908fa4d73142e

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.29 2023-03-11
+
+- Add Tilt integration (#15)
+
+## 0.28 2023-03-11
+
+- Add `HTML#import_map`, `HTML#js_module` methods
+
 ## 0.27 2023-01-19
 
 - Fix rendering of HTML void element tags

data/README.md

@@ -66,6 +66,7 @@ hello.render('world')
 ## Table of Content
 
 - [Installing Papercraft](#installing-papercraft)
+- [Using with Tilt](#using-with-tilt)
 - [Basic Usage](#basic-usage)
 - [Adding Tags](#adding-tags)
 - [Tag and Attribute Formatting](#tag-and-attribute-formatting)
@@ -126,6 +127,45 @@ Rendering a template is done using `#render`:
 html.render #=> "<div id="greeter"><p>Hello!</p></div>"
 ```
 
+## Using with Tilt
+
+Papercraft templates can also be rendered using Tilt:
+
+```ruby
+require 'tilt/papercraft'
+
+# loading from a file (with a .papercraft extension)
+template = Tilt.new('mytemplate.papercraft')
+template.render
+
+# defining a template inline:
+template = Tilt['papercraft'].new { <<~RUBY
+  h1 'Hello'
+RUBY
+}
+template.render
+```
+
+When rendering using Tilt, the following local variables are available to the
+template: `scope`, `locals` and `block`:
+
+```ruby
+template = Tilt['papercraft'].new { <<~RUBY
+  title scope.title
+  
+  h1 locals[:message]
+
+  emit block if block
+RUBY
+}
+
+def title
+  'foo'
+end
+
+template.render(self, message: 'bar') { p 'this is a paragraph' }
+```
+
 ## Adding Tags
 
 Tags are added using unqualified method calls, and can be nested using blocks:

data/lib/papercraft/html.rb

@@ -71,7 +71,47 @@ module Papercraft
         @buffer << '></script>'
       end
     end
+
+    # Returns a versioned URL for the given file spec.
+    #
+    # @param href [String] relative file path
+    # @param root_path [String] root path for file
+    # @param root_url [String] root URL
+    # @return [String] versioned URL
+    def versioned_file_href(href, root_path, root_url = '')
+      fn = File.join(root_path, href)
+      version = File.stat(fn).mtime.to_i rescue 0
+      "#{root_url}/#{href}?v=#{version}"
+    end  
   
+    # Emits an import map scrit tag. If a hash is given, emits the hash as is.
+    # If a string is given, searches for all *.js files under the given path,
+    # and emits an import map including all found files, with versioned URLs.
+    #
+    # @param root_path [String, Hash] root path or hash
+    # @param root_url [String] root URL to construct URLs against
+    # @return [void]
+    def import_map(root_path, root_url = '')
+      if root_path.is_a?(Hash)
+        script(root_path.to_json, type: 'importmap')
+      else
+        map = Dir["#{root_path}/*.js"].sort.each_with_object({}) do |fn, h|
+          name = File.basename(fn)
+          m = fn.match(/\/([^\/]+)\.js$/)
+          h[m[1]] = versioned_file_href(name, root_path, root_url)
+        end
+        script(map.to_json, type: 'importmap')
+      end
+    end
+
+    # Emits a script tag with type attribute set to module.
+    #
+    # @param code [String] JS code
+    # @return [void]
+    def js_module(code)
+      script code, type: 'module'
+    end
+
     # Converts and emits the given markdown. Papercraft uses
     # [Kramdown](https://github.com/gettalong/kramdown/) to do the Markdown to
     # HTML conversion. Optional Kramdown settings can be provided in order to

data/lib/papercraft/tags.rb

@@ -198,7 +198,6 @@ module Papercraft
       tag = sym.to_s
       if tag =~ /^[A-Z]/ && (Object.const_defined?(tag))
         define_const_tag_method(tag)
-        # return send(tag, *args, **opts)
       else
         define_tag_method(tag)
       end

data/lib/papercraft/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Papercraft
-  VERSION = '0.27'
+  VERSION = '0.29'
 end

data/lib/tilt/papercraft.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'papercraft'
+require 'tilt'
+
+# Tilt.
+module Tilt
+  # Papercraft templating engine for Tilt
+  class PapercraftTemplate < Template
+    metadata[:mime_type] = 'text/html'
+
+    protected
+
+    def prepare
+      inner = eval("proc { |scope:, locals:, block:|\n#{data}\n}")
+      @template = Papercraft.html(&inner)
+    end
+
+    def evaluate(scope, locals, &block)
+      @template.render(scope: scope, locals: locals, block: block)
+    end
+  end
+
+  register(PapercraftTemplate, 'papercraft')
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papercraft
 version: !ruby/object:Gem::Version
-  version: '0.27'
+  version: '0.29'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.9
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.9
+        version: 2.1.0
 description: 
 email: sharon@noteflakes.com
 executables: []
@@ -143,6 +143,7 @@ files:
 - lib/papercraft/template.rb
 - lib/papercraft/version.rb
 - lib/papercraft/xml.rb
+- lib/tilt/papercraft.rb
 - papercraft.png
 homepage: http://github.com/digital-fabric/papercraft
 licenses: