papercraft 0.28 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eccca55a3b242b80413bad0c851619062d66c1b68eaa9f2e4a13ca9e4beefddf
-  data.tar.gz: a5cf234c36fe286a94d6607bc30e13a24568396f6fe78b2f0e22870618e97941
+  metadata.gz: d769e6ec71d8c6d60ebb0aa727037b691562a31ec1fc1a05ccb0f25f29858b7a
+  data.tar.gz: 97b15299e8b4ca3d801aec881bd0ea4cee245650225f9c6e41972333ab9f8011
 SHA512:
-  metadata.gz: 003a30933c7d7557a346ce02bcc54169427389db2e488ee5516b68b9e99d74f2b5f0464db4e327c1c3064bc7cbfe0df9c4ef0df6322b61a467f14f30a83b415c
-  data.tar.gz: cc8d7e819fdefc04a5ffb1966d707d6fb7e533bc0c8f6d3fc39191749c4733593850a4cb046648c010c2ae4daae6fbaa6980b806a1ab61d9746481dc63fd8ecf
+  metadata.gz: ff74adc23fc616b579f9729cecc595e2eebe92d2b96b6edcceff4eae043c7ca8048e3baea14f275533667809183cd7961e14c74a6afb71b04fe7902806c8678c
+  data.tar.gz: 8fcecbac3baa12296ae3386ecb31eb0db0d7e001f4f38dd1c055ab497a3113471338d26cca8812582091e10c17ab5413c1e37cdf172d07ca1eac011206935d90

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.0 2023-03-30
+
+- Add support for Array attribute values
+
+## 0.29 2023-03-11
+
+- Add Tilt integration (#15)
+
 ## 0.28 2023-03-11
 
 - Add `HTML#import_map`, `HTML#js_module` methods

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)
@@ -83,6 +84,7 @@ hello.render('world')
 - [Emitting Markdown](#emitting-markdown)
 - [Working with MIME Types](#working-with-mime-types)
 - [Deferred Evaluation](#deferred-evaluation)
+- [HTML Templates](#html-templates)
 - [XML Templates](#xml-templates)
 - [JSON Templates](#json-templates)
 - [Papercraft Extensions](#papercraft-extensions)
@@ -126,6 +128,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:
@@ -158,14 +199,28 @@ Papercraft.html { hr() }.render #=> "<hr/>"
 Tag methods also accept tag attributes, given as a hash:
 
 ```ruby
-Papercraft.html { img src: '/my.gif' }.render #=> "<img src="/my.gif"/>
+Papercraft.html { img src: '/my.gif' }.render #=> "<img src=\"/my.gif\"/>"
 
 Papercraft.html { p "foobar", class: 'important' }.render #=> "<p class=\"important\">foobar</p>"
 ```
 
+A `true` attribute value will emit a valueless attribute. A `nil` or `false`
+attribute value will emit nothing:
+
+```ruby
+Papercraft.html { button disabled: nil }.render #=> "<button></button>"
+Papercraft.html { button disabled: true }.render #=> "<button disabled></button>"
+```
+
+An attribute value given as an array will be joined by space characters:
+
+```ruby
+Papercraft.html { div class: [:foo, :bar] }.render #=> "<div class=\"foo bar\"></div>"
+```
+
 ## Tag and Attribute Formatting
 
-Papercraft does not make any presumption about what tags and attributes you can
+Papercraft does not make any assumption about what tags and attributes you can
 use. You can mix upper and lower case letters, and you can include arbitrary
 characters in tag and attribute names. However, in order to best adhere to the
 HTML and XML specs and common practices, tag names and attributes will be
@@ -236,7 +291,7 @@ greeting.render(name: 'world') #=> "<h1>Hello, world!</h1>"
 
 ## Template Logic
 
-Since Papercraft templates are just a bunch of Ruby, you can easily write your
+Since Papercraft templates are just a bunch of Ruby, you can easily embed your
 view logic right in the template:
 
 ```ruby
@@ -545,6 +600,24 @@ page = default_layout.apply {
 }
 ```
 
+## HTML Templates
+
+HTML templates include a few HTML-specific methods to facilitate writing modern
+HTML:
+
+- `html5 { ... }` - emits an HTML 5 DOCTYPE (`<!DOCTYPE html>`)
+- `import_map(root_path, root_url)` - emits an import map including all files
+  matching `<root_path>/*.js`, based on the given `root_url`
+- `js_module(js)` - emits a `<script type="module">` element
+- `link_stylesheet(href, **attributes)` - emits a `<link rel="stylesheet" ...>`
+  element
+- `script(js, **attributes)` - emits an inline `<script>` element
+- `style(css, **attributes)` - emits an inline `<style>` element
+- `versioned_file_href(href, root_path, root_url)` - calculates a versioned href
+  for the given file
+
+[HTML docs](https://www.rubydoc.info/gems/papercraft/Papercraft/HTML)
+
 ## XML Templates
 
 XML templates behave largely the same as HTML templates, with a few minor
@@ -580,6 +653,8 @@ rss = Papercraft.xml(mime_type: 'text/xml; charset=utf-8') { |resource:, **props
 }
 ```
 
+[XML docs](https://www.rubydoc.info/gems/papercraft/Papercraft/XML)
+
 ## JSON Templates
 
 JSON templates behave largely the same as HTML and XML templates. The only major
@@ -611,6 +686,8 @@ Papercraft.json {
 Papercraft uses the [JSON gem](https://rubyapi.org/3.1/o/json) under the hood in
 order to generate actual JSON.
 
+[JSON docs](https://www.rubydoc.info/gems/papercraft/Papercraft/JSON)
+
 ## Papercraft Extensions
 
 Papercraft extensions are modules that contain one or more methods that can be
@@ -817,6 +894,8 @@ xml = Papercraft.xml {
 }
 ```
 
+[SOAP docs](https://www.rubydoc.info/gems/papercraft/Papercraft/Extensions/Soap)
+
 ## API Reference
 
 The API reference for this library can be found

data/lib/papercraft/tags.rb

@@ -387,6 +387,10 @@ module Papercraft
             @buffer << S_SPACE << att_repr(k)
           when false, nil
             # emit nothing
+          when Array
+            v = v.join(' ')
+            @buffer << S_SPACE << att_repr(k) <<
+              S_EQUAL_QUOTE << escape_text(v) << S_QUOTE
           else
             @buffer << S_SPACE << att_repr(k) <<
               S_EQUAL_QUOTE << escape_text(v) << S_QUOTE

data/lib/papercraft/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Papercraft
-  VERSION = '0.28'
+  VERSION = '1.0'
 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.28'
+  version: '1.0'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-11 00:00:00.000000000 Z
+date: 2023-03-30 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: