RubyGems - papercraft - Versions diffs - 0.15 → 0.19 - Mend

papercraft 0.15 → 0.19

Files changed (11) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +21 -1
data/README.md +200 -75
data/lib/papercraft/html.rb +1 -39
data/lib/papercraft/json.rb +73 -0
data/lib/papercraft/renderer.rb +19 -11
data/lib/papercraft/{component.rb → template.rb} +51 -32
data/lib/papercraft/version.rb +1 -1
data/lib/papercraft.rb +96 -46
data/papercraft.png +0 -0
metadata +6 -3

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2200153b1b339d33c7e9e81c45c23bd4c117c274a52b1d1bfc97f83995727697
-  data.tar.gz: 3dae3cf3b6ea2530df8c498cdafb876e06d45d527b6e2bbbcb6302e6ef0842e9
+  metadata.gz: f0f4910bd26625ca0349b1c471338fb4d13e8055e88367b5cad16f91cdee7531
+  data.tar.gz: 38e43978278ba069e3767abd94d83c676f42692f5eb55f1be4b4067fae2f935e
 SHA512:
-  metadata.gz: 5f9727de69aac6d48de53ca174280c68dce7825b9a4aa6f8c955b6122f30d9f4541a7d47e7ed7caa319feda5659b14b73a3ad343db2733b4bb9518e9ade94f8c
-  data.tar.gz: 765e786959a6fdda6c25cddda11f5f987837d6853245e5bc8533dbe7b904792b09fc39e726371c81981275ef0abdb8d1d95de63a76889af34b037f34d01c6c3a
+  metadata.gz: b096452cebe7b6bb34a428f4920a5940e5b745c86b54188a984a77df6175145cf6645753e6ae58b3df89813919920a17a96610e010724bc50077c6f9accc7293
+  data.tar.gz: 8d1cd5b2d6b70ee9ef0a748a064bbd6d1630cfa926663aded95a01c26ce289a159e2548068bf8210c5e8d37ba26c9671eb4a00fe4790a47bec6dd822b4de5d5d

data/CHANGELOG.md CHANGED Viewed

@@ -1,3 +1,23 @@
+## 0.19 2022-02-05
+- Rename `Papercraft::Component` to `Papercraft::Template`
+## 0.18 2022-02-04
+- Cleanup and update examples
+- Fix behaviour of #emit with block
+- Improve README
+## 0.17 2022-01-23
+- Refactor markdown code, add `Papercraft.markdown` method (#8)
+## 0.16 2022-01-23
+- Implement JSON templating (#7)
+- Add support for MIME types (#6)
+- Change entrypoint from `Kernel#H`, `Kernel#X` to `Papercraft.html`, `.xml` (#5)
 ## 0.15 2022-01-20
 - Fix tag method line reference
@@ -42,7 +62,7 @@
 ## 0.8 2021-12-22
 - Cleanup and refactor code
-- Add X global method for XML templates
+- Add Papercraft.xml global method for XML templates
 - Make `Component` a descendant of `Proc`
 - Introduce new component API
 - Rename Rubyoshka to Papercraft

data/README.md CHANGED Viewed

@@ -4,7 +4,7 @@
   Papercraft
 </h1>
-<h4 align="center">Composable HTML templating for Ruby</h4>
+<h4 align="center">Composable templating for Ruby</h4>
 <p align="center">
   <a href="http://rubygems.org/gems/papercraft">
@@ -24,33 +24,63 @@
 ## What is Papercraft?
+Papercraft is a templating engine for dynamically producing HTML, XML or JSON.
+Papercraft templates are expressed in plain Ruby, leading to easier debugging,
+better protection against HTML/XML injection attacks, and better code reuse.
+Papercraft templates can be composed in a variety of ways, facilitating the
+usage of layout templates, and enabling a component-oriented approach to
+building complex web interfaces.
+In Papercraft, dynamic data is passed explicitly to the template as block
+arguments, making the data flow easy to follow and understand. Papercraft also
+lets developers create derivative templates using full or partial parameter
+application.
+Papercraft includes built-in support for rendering Markdown (using
+[Kramdown](https://github.com/gettalong/kramdown/)), as well as support for
+creating template extensions in order to allow the creation of component
+libraries.
 ```ruby
 require 'papercraft'
-page = H { |*args|
+page = Papercraft.html { |*args|
   html {
-    head { }
+    head { title 'Title' }
     body { emit_yield *args }
   }
 }
+page.render { p 'foo' }
+#=> "<html><head><title>Title</title></head><body><p>foo</p></body></html>"
-hello = H.apply { |name| h1 "Hello, #{name}!" }
+hello = page.apply { |name| h1 "Hello, #{name}!" }
 hello.render('world')
-#=> "<html><head/><body><h1>Hello, world!</h1></body></html>"
+#=> "<html><head><title>Title</title></head><body><h1>Hello, world!</h1></body></html>"
 ```
-Papercraft is an HTML templating engine for Ruby that offers the following
-features:
-- HTML and XML templating using plain Ruby syntax
-- Minimal boilerplate
-- Mix logic and tags freely
-- Automatic HTML and XML escaping
-- Composable components
-- Explicit parameter passing to nested components
-- Higher order components
-- Built-in support for rendering [Markdown](#emitting-markdown)
-- Support for namespaced extensions
+## Table of content
+- [Installing papercraft](#installing-papercraft)
+- [Basic usage](#basic-usage)
+- [Adding tags](#adding-tags)
+- [Template parameters](#template-parameters)
+- [Template logic](#template-logic)
+- [Template blocks](#template-blocks)
+- [Plain procs as templates](#plain-procs-as-templates)
+- [Template composition](#template-composition)
+- [Parameter and block application](#parameter-and-block-application)
+- [Higher-order templates](#higher-order-templates)
+- [Layout template composition](#layout-template-composition)
+- [Emitting raw HTML](#emitting-raw-html)
+- [Emitting a string with HTML Encoding](#emitting-a-string-with-html-encoding)
+- [Emitting Markdown](#emitting-markdown)
+- [Working with MIME types](#working-with-mime-types)
+- [Deferred evaluation](#deferred-evaluation)
+- [Papercraft extensions](#papercraft-extensions)
+- [XML templates](#xml-templates)
+- [JSON templates](#json-templates)
+- [API Reference](#api-reference)
 ## Installing Papercraft
@@ -66,30 +96,33 @@ Or manually:
 $ gem install papercraft
 ```
-## Getting started
+## Basic usage
-To create a template use the global method `Kernel#H`:
+To create an HTML template use `Papercraft.html`:
 ```ruby
 require 'papercraft'
-html = H {
+html = Papercraft.html {
   div(id: 'greeter') { p 'Hello!' }
 }
 ```
+(You can also use `Papercraft.xml` and `Papercraft.json` to create XML and JSON
+templates, respectively.)
 Rendering a template is done using `#render`:
 ```ruby
 html.render #=> "<div id="greeter"><p>Hello!</p></div>"
 ```
-## All about tags
+## Adding tags
 Tags are added using unqualified method calls, and can be nested using blocks:
 ```ruby
-H {
+Papercraft.html {
   html {
     head {
       title 'page title'
@@ -106,19 +139,19 @@ H {
 Tag methods accept a string argument, a block, or no argument at all:
 ```ruby
-H { p 'hello' }.render #=> "<p>hello</p>"
+Papercraft.html { p 'hello' }.render #=> "<p>hello</p>"
-H { p { span '1'; span '2' } }.render #=> "<p><span>1</span><span>2</span></p>"
+Papercraft.html { p { span '1'; span '2' } }.render #=> "<p><span>1</span><span>2</span></p>"
-H { hr() }.render #=> "<hr/>"
+Papercraft.html { hr() }.render #=> "<hr/>"
 ```
 Tag methods also accept tag attributes, given as a hash:
 ```ruby
-H { img src: '/my.gif' }.render #=> "<img src="/my.gif"/>
+Papercraft.html { img src: '/my.gif' }.render #=> "<img src="/my.gif"/>
-H { p "foobar", class: 'important' }.render #=> "<p class=\"important\">foobar</p>"
+Papercraft.html { p "foobar", class: 'important' }.render #=> "<p class=\"important\">foobar</p>"
 ```
 ## Template parameters
@@ -128,24 +161,24 @@ parameters are specified as block parameters, and are passed to the template on
 rendering:
 ```ruby
-greeting = H { |name| h1 "Hello, #{name}!" }
+greeting = Papercraft.html { |name| h1 "Hello, #{name}!" }
 greeting.render('world') #=> "<h1>Hello, world!</h1>"
 ```
 Templates can also accept named parameters:
 ```ruby
-greeting = H { |name:| h1 "Hello, #{name}!" }
+greeting = Papercraft.html { |name:| h1 "Hello, #{name}!" }
 greeting.render(name: 'world') #=> "<h1>Hello, world!</h1>"
 ```
-## Logic in templates
+## Template logic
 Since Papercraft templates are just a bunch of Ruby, you can easily write your
 view logic right in the template:
 ```ruby
-H { |user = nil|
+Papercraft.html { |user = nil|
   if user
     span "Hello, #{user.name}!"
   else
@@ -159,7 +192,7 @@ H { |user = nil|
 Templates can also accept and render blocks by using `emit_yield`:
 ```ruby
-page = H {
+page = Papercraft.html {
   html {
     body { emit_yield }
   }
@@ -169,27 +202,27 @@ page = H {
 page.render { h1 'hi' }
 ```
-## Plain procs as components
+## Plain procs as templates
 With Papercraft you can write a template as a plain Ruby proc, and later render
-it by passing it as a block to `H`:
+it by passing it as a block to `Papercraft.html`:
 ```ruby
 greeting = proc { |name| h1 "Hello, #{name}!" }
-H(&greeting).render('world')
+Papercraft.html(&greeting).render('world')
 ```
 Components can also be expressed using lambda notation:
 ```ruby
 greeting = ->(name) { h1 "Hello, #{name}!" }
-H(&greeting).render('world')
+Papercraft.html(&greeting).render('world')
 ```
-## Component composition
+## Template composition
-Papercraft makes it easy to compose multiple components into a whole HTML
-document. A Papercraft component can contain other components, as the following
+Papercraft makes it easy to compose multiple templates into a whole HTML
+document. A Papercraft template can contain other templates, as the following
 example shows.
 ```ruby
@@ -210,26 +243,26 @@ ItemList = ->(items) {
   }
 }
-page = H { |title, items|
+page = Papercraft.html { |title, items|
   html5 {
     head { Title(title) }
     body { ItemList(items) }
   }
 }
-page.render('Hello from components', [
+page.render('Hello from composed templates', [
   { id: 1, text: 'foo', checked: false },
   { id: 2, text: 'bar', checked: true }
 ])
 ```
-In addition to using components defined as constants, you can also use
-non-constant components by invoking the `#emit` method:
+In addition to using templates defined as constants, you can also use
+non-constant templates by invoking the `#emit` method:
 ```ruby
 greeting = -> { span "Hello, world" }
-H {
+Papercraft.html {
   div {
     emit greeting
   }
@@ -239,62 +272,62 @@ H {
 ## Parameter and block application
 Parameters and blocks can be applied to a template without it being rendered, by
-using `#apply`. This mechanism is what allows component composition and the
-creation of higher-order components.
+using `#apply`. This mechanism is what allows template composition and the
+creation of higher-order templates.
-The `#apply` method returns a new component which applies the given parameters and
-or block to the original component:
+The `#apply` method returns a new template which applies the given parameters and
+or block to the original template:
 ```ruby
 # parameter application
-hello = H { |name| h1 "Hello, #{name}!" }
+hello = Papercraft.html { |name| h1 "Hello, #{name}!" }
 hello_world = hello.apply('world')
 hello_world.render #=> "<h1>Hello, world!</h1>"
 # block application
-div_wrap = H { div { emit_yield } }
+div_wrap = Papercraft.html { div { emit_yield } }
 wrapped_h1 = div_wrap.apply { h1 'hi' }
 wrapped_h1.render #=> "<div><h1>hi</h1></div>"
-# wrap a component
+# wrap a template
 wrapped_hello_world = div_wrap.apply(&hello_world)
 wrapped_hello_world.render #=> "<div><h1>Hello, world!</h1></div>"
 ```
-## Higher-order components
+## Higher-order templates
-Papercraft also lets you create higher-order components (HOCs), that is,
-components that take other components as parameters, or as blocks. Higher-order
-components are handy for creating layouts, wrapping components in arbitrary
-markup, enhancing components or injecting component parameters.
+Papercraft also lets you create higher-order templates, that is,
+templates that take other templates as parameters, or as blocks. Higher-order
+templates are handy for creating layouts, wrapping templates in arbitrary
+markup, enhancing templates or injecting template parameters.
-Here is a HOC that takes a component as parameter:
+Here is a higher-order template that takes a template as parameter:
 ```ruby
-div_wrap = H { |inner| div { emit inner } }
-greeter = H { h1 'hi' }
+div_wrap = Papercraft.html { |inner| div { emit inner } }
+greeter = Papercraft.html { h1 'hi' }
 wrapped_greeter = div_wrap.apply(greeter)
 wrapped_greeter.render #=> "<div><h1>hi</h1></div>"
 ```
-The inner component can also be passed as a block, as shown above:
+The inner template can also be passed as a block, as shown above:
 ```ruby
-div_wrap = H { div { emit_yield } }
+div_wrap = Papercraft.html { div { emit_yield } }
 wrapped_greeter = div_wrap.apply { h1 'hi' }
 wrapped_greeter.render #=> "<div><h1>hi</h1></div>"
 ```
 ## Layout template composition
-One of the principal uses of higher-order components is the creation of nested
+One of the principal uses of higher-order templates is the creation of nested
 layouts. Suppose we have a website with a number of different layouts, and we'd
 like to avoid having to repeat the same code in the different layouts. We can do
 this by creating a `default` page template that takes a block, then use `#apply`
 to create the other templates:
 ```ruby
-default_layout = H { |**params|
+default_layout = Papercraft.html { |**params|
   html5 {
     head {
       title: params[:title]
@@ -323,7 +356,7 @@ article_layout.render(
 Raw HTML can be emitted using `#emit`:
 ```ruby
-wrapped = H { |html| div { emit html } }
+wrapped = Papercraft.html { |html| div { emit html } }
 wrapped.render("<h1>hi</h1>") #=> "<div><h1>hi</h1></div>"
 ```
@@ -333,7 +366,7 @@ To emit a string with proper HTML encoding, without wrapping it in an HTML
 element, use `#text`:
 ```ruby
-H { str 'hi&lo' }.render #=> "hi&amp;lo"
+Papercraft.html { str 'hi&lo' }.render #=> "hi&amp;lo"
 ```
 ## Emitting Markdown
@@ -343,7 +376,7 @@ Markdown is rendered using the
 `#emit_markdown`:
 ```ruby
-template = H { |md| div { emit_markdown md } }
+template = Papercraft.html { |md| div { emit_markdown md } }
 template.render("Here's some *Markdown*") #=> "<div><p>Here's some <em>Markdown</em><p>\n</div>"
 ```
@@ -352,10 +385,18 @@ options](https://kramdown.gettalong.org/options.html#available-options) can be
 specified by adding them to the `#emit_markdown` call:
 ```ruby
-template = H { |md| div { emit_markdown md, auto_ids: false } }
+template = Papercraft.html { |md| div { emit_markdown md, auto_ids: false } }
 template.render("# title") #=> "<div><h1>title</h1></div>"
 ```
+The `#emit_markdown` method is available only to HTML templates. If you need to
+render markdown in XML or JSON templates (usually for implementing RSS or JSON
+feeds), you can use `Papercraft.markdown` directly:
+```ruby
+Papercraft.markdown('# title') #=> "<h1>title</h1>"
+```
 The default Kramdown options are:
 ```ruby
@@ -368,17 +409,33 @@ The default Kramdown options are:
 ```
 The deafult options can be configured by accessing
-`Papercraft::HTML.kramdown_options`, e.g.:
+`Papercraft.default_kramdown_options`, e.g.:
 ```ruby
-Papercraft::HTML.kramdown_options[:auto_ids] = false
+Papercraft.default_kramdown_options[:auto_ids] = false
+```
+## Working with MIME types
+Papercraft lets you set and interrogate a template's MIME type, in order to be
+able to dynamically set the `Content-Type` HTTP response header. A template's
+MIME type can be set when creating the template, e.g. `Papercraft.xml(mime_type:
+'application/rss+xml')`. You can interrogate the template's MIME type using
+`#mime_type`:
+```ruby
+# using Qeweney (https://github.com/digital-fabric/qeweney)
+def serve_template(req, template)
+  body = template.render
+  respond(body, 'Content-Type' => template.mime_type)
+end
 ```
 ## Deferred evaluation
 Deferred evaluation allows deferring the rendering of parts of a template until
-the last moment, thus allowing an inner component to manipulate the state of the
-outer component. To in order to defer a part of a template, use `#defer`, and
+the last moment, thus allowing an inner template to manipulate the state of the
+outer template. To in order to defer a part of a template, use `#defer`, and
 include any markup in the provided block. This technique, in in conjunction with
 holding state in instance variables, is an alternative to passing parameters,
 which can be limiting in some situations.
@@ -387,15 +444,15 @@ A few use cases for deferred evaulation come to mind:
 - Setting the page title.
 - Adding a flash message to a page.
-- Using components that dynamically add static dependencies (JS and CSS) to the
+- Using templates that dynamically add static dependencies (JS and CSS) to the
   page.
 The last use case is particularly interesting. Imagine a `DependencyMananger`
-class that can collect JS and CSS dependencies from the different components
+class that can collect JS and CSS dependencies from the different templates
 integrated into the page, and adds them to the page's `<head>` element:
 ```ruby
-default_layout = H { |**args|
+default_layout = Papercraft.html { |**args|
   @dependencies = DependencyMananger.new
   head {
     defer { emit @dependencies.head_markup }
@@ -481,7 +538,7 @@ The call to `Papercraft::extension` lets us access the different methods of
 we'll be able to express the above markup as follows:
 ```ruby
-H {
+Papercraft.html {
   bootstrap.card(style: 'width: 18rem') {
     bootstrap.card_title 'Card title'
     bootstrap.card_subtitle 'Card subtitle'
@@ -492,6 +549,74 @@ H {
 }
 ```
+## XML templates
+XML templates behave largely the same as HTML templates, with a few minor
+differences. XML templates employ a different encoding algorithm, and lack some
+specific HTML functionality, such as emitting Markdown.
+Here's an example showing how to create an RSS feed:
+```ruby
+rss = Papercraft.xml(mime_type: 'text/xml; charset=utf-8') { |resource:, **props|
+  rss(version: '2.0', 'xmlns:atom' => 'http://www.w3.org/2005/Atom') {
+    channel {
+      title 'Noteflakes'
+      link 'https://noteflakes.com/'
+      description 'A website by Sharon Rosner'
+      language 'en-us'
+      pubDate Time.now.httpdate
+      emit '<atom:link href="https://noteflakes.com/feeds/rss" rel="self" type="application/rss+xml" />'
+      article_entries = resource.page_list('/articles').reverse
+      article_entries.each { |e|
+        item {
+          title e[:title]
+          link "https://noteflakes.com#{e[:url]}"
+          guid "https://noteflakes.com#{e[:url]}"
+          pubDate e[:date].to_time.httpdate
+          description e[:html_content]
+        }
+      }
+    }
+  }
+}
+```
+## JSON templates
+JSON templates behave largely the same as HTML and XML templates. The only major
+difference is that for adding array items you'll need to use the `#item` method:
+```ruby
+Papercraft.json {
+  item 1
+  item 2
+  item 3
+}.render #=> "[1,2,3]"
+```
+Otherwise, you can create arbitrarily complex JSON structures by mixing hashes
+and arrays:
+```Ruby
+Papercraft.json {
+  foo {
+    bar {
+      item nil
+      item true
+      item 123.456
+    }
+  }
+}.render #=> "{\"foo\":{\"bar\":[null,true,123.456]}}"
+```
+Papercraft uses the [JSON gem](https://rubyapi.org/3.1/o/json) under the hood in
+order to generate actual JSON.
 ## API Reference
 The API reference for this library can be found

data/lib/papercraft/html.rb CHANGED Viewed

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
-require 'kramdown'
-require 'rouge'
-require 'kramdown-parser-gfm'
 module Papercraft
   # HTML Markup extensions
   module HTML
@@ -83,41 +79,7 @@ module Papercraft
     # @param **opts [Hash] Kramdown options
     # @return [void]
     def emit_markdown(markdown, **opts)
-      emit Kramdown::Document.new(markdown, **kramdown_options(opts)).to_html
-    end
-    class << self
-      # Returns the default Kramdown options used for converting Markdown to
-      # HTML.
-      #
-      # @return [Hash] Default Kramdown options
-      def kramdown_options
-        @kramdown_options ||= {
-          entity_output: :numeric,
-          syntax_highlighter: :rouge,
-          input: 'GFM',
-          hard_wrap: false
-        }
-      end
-      # Sets the default Kramdown options used for converting Markdown to
-      # HTML.
-      #
-      # @param opts [Hash] New deafult Kramdown options
-      # @return [Hash] New default Kramdown options
-      def kramdown_options=(opts)
-        @kramdown_options = opts
-      end
-    end
-    private
-    # Returns the default Kramdown options, merged with the given overrides.
-    #
-    # @param opts [Hash] Kramdown option overrides
-    # @return [Hash] Merged Kramdown options
-    def kramdown_options(opts)
-      HTML.kramdown_options.merge(**opts)
+      emit Papercraft.markdown(markdown, **opts)
     end
   end
 end

data/lib/papercraft/json.rb ADDED Viewed

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require 'json'
+module Papercraft
+  # JSON renderer extensions
+  module JSON
+    def object_stack
+      @object_stack ||= [nil]
+    end
+    def with_object(&block)
+      object_stack << nil
+      instance_eval(&block)
+    end
+    def verify_array_target
+      case object_stack[-1]
+      when nil
+        object_stack[-1] = []
+      when Hash
+        raise "Mixing array and hash values"
+      end
+    end
+    def verify_hash_target
+      case object_stack[-1]
+      when nil
+        object_stack[-1] = {}
+      when Array
+        raise "Mixing array and hash values"
+      end
+    end
+    def push_array_item(value)
+      object_stack[-1] << value
+    end
+    def push_kv_item(key, value)
+      object_stack[-1][key] = value
+    end
+    def enter_object(&block)
+      object_stack << nil
+      instance_eval(&block)
+      object_stack.pop
+    end
+    def item(value = nil, &block)
+      verify_array_target
+      if block
+        value = enter_object(&block)
+      end
+      push_array_item(value)
+    end
+    def kv(key, value, &block)
+      verify_hash_target
+      if block
+        value = enter_object(&block)
+      end
+      push_kv_item(key, value)
+    end
+    def method_missing(sym, value = nil, &block)
+      kv(sym, value, &block)
+    end
+    def to_s
+      object_stack[0].to_json
+    end
+  end
+end

data/lib/papercraft/renderer.rb CHANGED Viewed

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
+require 'escape_utils'
 require_relative './html'
+require_relative './json'
 require_relative './extension_proxy'
 module Papercraft
-  # A Renderer renders a Papercraft component into a string
+  # A Renderer renders a Papercraft template into a string
   class Renderer
     class << self
@@ -40,7 +43,7 @@ module Papercraft
       #
       # Installs the given extensions, passed in the form of a Ruby hash mapping
       # methods to extension modules. The methods will be available to all
-      # Papercraft components. Extension methods are executed in the context of
+      # Papercraft templates. Extension methods are executed in the context of
       # the the renderer instance, so they can look just like normal proc
       # components. In cases where method names in the module clash with HTML
       # tag names, you can use the `#tag` method to emit the relevant tag.
@@ -55,7 +58,7 @@ module Papercraft
       # end
       #
       # Papercraft.extension(components: ComponentLibrary)
-      # H { components.card('Foo', '**Bar**') }
+      # Papercraft.html { components.card('Foo', '**Bar**') }
       #
       # @param map [Hash] hash mapping methods to extension modules
       # @return [void]
@@ -210,20 +213,21 @@ module Papercraft
     # `#to_s` which is then added to the rendering buffer, without any escaping.
     #
     #   greeter = proc { |name| h1 "Hello, #{name}!" }
-    #   H { emit(greeter, 'world') }.render #=> "<h1>Hello, world!</h1>"
+    #   Papercraft.html { emit(greeter, 'world') }.render #=> "<h1>Hello, world!</h1>"
     #
-    #   H { emit 'hi&<bye>' }.render #=> "hi&<bye>"
+    #   Papercraft.html { emit 'hi&<bye>' }.render #=> "hi&<bye>"
     #
-    #   H { emit nil }.render #=> ""
+    #   Papercraft.html { emit nil }.render #=> ""
     #
-    # @param o [Proc, Papercraft::Component, String] emitted object
+    # @param o [Proc, Papercraft::Template, String] emitted object
     # @param *a [Array<any>] arguments to pass to a proc
     # @param **b [Hash] named arguments to pass to a proc
     # @return [void]
-    def emit(o, *a, **b)
+    def emit(o, *a, **b, &block)
       case o
       when ::Proc
         Renderer.verify_proc_parameters(o, a, b)
+        push_emit_yield_block(block) if block
         instance_exec(*a, **b, &o)
       when nil
       else
@@ -234,7 +238,7 @@ module Papercraft
     # Emits a block supplied using `Component#apply` or `Component#render`.
     #
-    #   div_wrap = H { |*args| div { emit_yield(*args) } }
+    #   div_wrap = Papercraft.html { |*args| div { emit_yield(*args) } }
     #   greeter = div_wrap.apply { |name| h1 "Hello, #{name}!" }
     #   greeter.render('world') #=> "<div><h1>Hello, world!</h1></div>"
     #
@@ -249,14 +253,14 @@ module Papercraft
     end
     # Defers the given block to be evaluated later. Deferred evaluation allows
-    # Papercraft components to inject state into sibling components, regardless
+    # Papercraft templates to inject state into sibling components, regardless
     # of the component's order in the container component. For example, a nested
     # component may set an instance variable used by another component. This is
     # an elegant solution to the problem of setting the HTML page's title, or
     # adding elements to the `<head>` section. Here's how a title can be
     # controlled from a nested component:
     #
-    #   layout = H {
+    #   layout = Papercraft.html {
     #     html {
     #       head {
     #         defer { title @title }
@@ -380,4 +384,8 @@ module Papercraft
       EscapeUtils.escape_xml(text.to_s)
     end
   end
+  class JSONRenderer < Renderer
+    include JSON
+  end
 end

data/lib/papercraft/{component.rb → template.rb} RENAMED Viewed

@@ -4,28 +4,33 @@ require_relative './html'
 module Papercraft
-  # Component represents a distinct, reusable HTML template. A component can
-  # include other components, and also be nested inside other components.
+  # Template represents a distinct, reusable HTML template. A template can
+  # include other templates, and also be nested inside other templates.
   #
-  # Since in Papercraft HTML is expressed using blocks (or procs,) the Component
+  # Since in Papercraft HTML is expressed using blocks (or procs,) the Template
   # class is simply a special kind of Proc, which has some enhanced
   # capabilities, allowing it to be easily composed in a variety of ways.
   #
-  # Components are usually created using the global methods `H` or `X`, for HTML
-  # or XML templates, respectively:
+  # Templates are usually created using the class methods `html`, `xml` or
+  # `json`, for HTML, XML or JSON templates, respectively:
   #
-  #   greeter = H { |name| h1 "Hello, #{name}!" }
+  #   greeter = Papercraft.html { |name| h1 "Hello, #{name}!" }
   #   greeter.render('world') #=> "<h1>Hello, world!</h1>"
   #
-  # Components can also be created using the normal constructor:
+  # Templates can also be created using the normal constructor:
   #
-  #   greeter = Papercraft::Component.new { |name| h1 "Hello, #{name}!" }
+  #   greeter = Papercraft::Template.new(mode: :html) { |name| h1 "Hello, #{name}!" }
   #   greeter.render('world') #=> "<h1>Hello, world!</h1>"
   #
-  # In the component block, HTML elements are created by simply calling
+  # The different methods for creating templates can also take a custom MIME
+  # type, by passing a `mime_type` named argument:
+  #
+  #   json = Papercraft.json(mime_type: 'application/feed+json') { ... }
+  #
+  # In the template block, HTML elements are created by simply calling
   # unqualified methods:
   #
-  #   page_layout = H {
+  #   page_layout = Papercraft.html {
   #     html5 {
   #       head {
   #         title 'foo'
@@ -36,31 +41,31 @@ module Papercraft
   #     }
   #   }
   #
-  # Papercraft components can take explicit parameters in order to render
+  # Papercraft templates can take explicit parameters in order to render
   # dynamic content. This can be in the form of regular or named parameters. The
   # `greeter` template shown above takes a single `name` parameter. Here's how a
-  # anchor component could be implemented with named parameters:
+  # anchor template could be implemented with named parameters:
   #
-  #   anchor = H { |uri: , text: | a(text, href: uri) }
+  #   anchor = Papercraft.html { |uri: , text: | a(text, href: uri) }
   #
-  # The above component could later be rendered by passing the needed arguments:
+  # The above template could later be rendered by passing the needed arguments:
   #
   #   anchor.render(uri: 'https://example.com', text: 'Example')
   #
-  # ## Component Composition
+  # ## Template Composition
   #
-  # A component can be included in another component using the `emit` method:
+  # A template can be included in another template using the `emit` method:
   #
-  #   links = H {
+  #   links = Papercraft.html {
   #     emit anchor, uri: '/posts',   text: 'Posts'
   #     emit anchor, uri: '/archive', text: 'Archive'
   #     emit anchor, uri: '/about',   text: 'About'
   #   }
   #
-  # Another way of composing components is to pass the components themselves as
+  # Another way of composing templates is to pass the templates themselves as
   # parameters:
   #
-  #   links = H { |anchors|
+  #   links = Papercraft.html { |anchors|
   #     anchors.each { |a| emit a }
   #   }
   #   links.render([
@@ -69,8 +74,8 @@ module Papercraft
   #     anchor.apply(uri: '/about', text: 'About')
   #   ])
   #
-  # The `#apply` method creates a new component, applying the given parameters
-  # such that the component can be rendered without parameters:
+  # The `#apply` method creates a new template, applying the given parameters
+  # such that the template can be rendered without parameters:
   #
   #   links_with_anchors = links.apply([
   #     anchor.apply(uri: '/posts', text: 'Posts'),
@@ -79,19 +84,27 @@ module Papercraft
   #   ])
   #   links_with_anchors.render
   #
-  class Component < Proc
+  class Template < Proc
     # Determines the rendering mode: `:html` or `:xml`.
     attr_accessor :mode
-    # Initializes a component with the given block. The rendering mode (HTML or
+    STOCK_MIME_TYPE = {
+      html: 'text/html',
+      xml:  'application/xml',
+      json: 'application/json'
+    }.freeze
+    # Initializes a template with the given block. The rendering mode (HTML or
     # XML) can be passed in the `mode:` parameter. If `mode:` is not specified,
-    # the component defaults to HTML.
+    # the template defaults to HTML.
     #
     # @param mode [:html, :xml] rendering mode
+    # @param mime_type [String, nil] the template's mime type (nil for default)
     # @param block [Proc] nested HTML block
-    def initialize(mode: :html, &block)
+    def initialize(mode: :html, mime_type: nil, &block)
       @mode = mode
+      @mime_type = mime_type || STOCK_MIME_TYPE[mode]
       super(&block)
     end
@@ -111,11 +124,11 @@ module Papercraft
       end.to_s
     end
-    # Creates a new component, applying the given parameters and or block to the
+    # Creates a new template, applying the given parameters and or block to the
     # current one. Application is one of the principal methods of composing
-    # components, particularly when passing inner components as blocks:
+    # templates, particularly when passing inner templates as blocks:
     #
-    #   article_wrapper = H {
+    #   article_wrapper = Papercraft.html {
     #     article {
     #       emit_yield
     #     }
@@ -128,29 +141,35 @@ module Papercraft
     # @param *a [<any>] normal parameters
     # @param **b [Hash] named parameters
     # @param &block [Proc] inner block
-    # @return [Papercraft::Component] applied component
+    # @return [Papercraft::Template] applied template
     def apply(*a, **b, &block)
       template = self
-      Component.new(&proc do |*x, **y|
+      Template.new(mode: @mode, mime_type: @mime_type, &proc do |*x, **y|
         push_emit_yield_block(block) if block
         instance_exec(*a, *x, **b, **y, &template)
       end)
     end
     # Returns the Renderer class used for rendering the templates, according to
-    # the component's mode.
+    # the template's mode.
     #
-    # @return [Papercraft::Renderer] Renderer used for rendering the component
+    # @return [Papercraft::Renderer] Renderer used for rendering the template
     def renderer_class
       case @mode
       when :html
         HTMLRenderer
       when :xml
         XMLRenderer
+      when :json
+        JSONRenderer
       else
         raise "Invalid mode #{@mode.inspect}"
       end
     end
+    def mime_type
+      @mime_type
+    end
     # def compile
     #   Papercraft::Compiler.new.compile(self)

data/lib/papercraft/version.rb CHANGED Viewed

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

data/lib/papercraft.rb CHANGED Viewed

@@ -1,60 +1,110 @@
 # frozen_string_literal: true
-require 'escape_utils'
+require 'kramdown'
+require 'rouge'
+require 'kramdown-parser-gfm'
-require_relative 'papercraft/component'
+require_relative 'papercraft/template'
 require_relative 'papercraft/renderer'
 require_relative 'papercraft/encoding'
 # require_relative 'papercraft/compiler'
-# Papercraft is a component-based HTML templating library
+# Papercraft is a composable templating library
 module Papercraft
   # Exception class used to signal templating-related errors
   class Error < RuntimeError; end
-  # Installs one or more extensions. Extensions enhance templating capabilities
-  # by adding namespaced methods to emplates. An extension is implemented as a
-  # Ruby module containing one or more methods. Each method in the extension
-  # module can be used to render a specific HTML element or a set of elements.
-  #
-  # This is a convenience method. For more information on using Papercraft
-  # extensions, see `Papercraft::Renderer::extension`
-  #
-  # @param map [Hash] hash mapping methods to extension modules
-  # @return [void]
-  def self.extension(map)
-    Renderer.extension(map)
-  end
-end
-# Kernel extensions
-module ::Kernel
-  # Creates a new papercraft component. `#H` can take either a proc argument or
-  # a block. In both cases, the proc is converted to a `Papercraft::Component`.
-  #
-  # H(proc { h1 'hi' }).render #=> "<h1>hi</h1>"
-  # H { h1 'hi' }.render #=> "<h1>hi</h1>"
-  #
-  # @param template [Proc] template block
-  # @return [Papercraft::Component] Papercraft component
-  def H(o = nil, &template)
-    return o if o.is_a?(Papercraft::Component)
-    template ||= o
-    Papercraft::Component.new(mode: :html, &template)
-  end
+  class << self
+    # Installs one or more extensions. Extensions enhance templating capabilities
+    # by adding namespaced methods to emplates. An extension is implemented as a
+    # Ruby module containing one or more methods. Each method in the extension
+    # module can be used to render a specific HTML element or a set of elements.
+    #
+    # This is a convenience method. For more information on using Papercraft
+    # extensions, see `Papercraft::Renderer::extension`
+    #
+    # @param map [Hash] hash mapping methods to extension modules
+    # @return [void]
+    def extension(map)
+      Renderer.extension(map)
+    end
+    # Creates a new papercraft template. `Papercraft.html` can take either a proc
+    # argument or a block. In both cases, the proc is converted to a
+    # `Papercraft::Template`.
+    #
+    # Papercraft.html(proc { h1 'hi' }).render #=> "<h1>hi</h1>"
+    # Papercraft.html { h1 'hi' }.render #=> "<h1>hi</h1>"
+    #
+    # @param template [Proc] template block
+    # @return [Papercraft::Template] Papercraft template
+    def html(o = nil, mime_type: nil, &template)
+      return o if o.is_a?(Papercraft::Template)
+      template ||= o
+      Papercraft::Template.new(mode: :html, mime_type: mime_type, &template)
+    end
+    # Creates a new Papercraft template in XML mode. `Papercraft.xml` can take
+    # either a proc argument or a block. In both cases, the proc is converted to a
+    # `Papercraft::Template`.
+    #
+    # Papercraft.xml(proc { item 'foo' }).render #=> "<item>foo</item>"
+    # Papercraft.xml { item 'foo' }.render #=> "<item>foo</item>"
+    #
+    # @param template [Proc] template block
+    # @return [Papercraft::Template] Papercraft template
+    def xml(o = nil, mime_type: nil, &template)
+      return o if o.is_a?(Papercraft::Template)
+      template ||= o
+      Papercraft::Template.new(mode: :xml, mime_type: mime_type, &template)
+    end
+    # Creates a new Papercraft template in JSON mode. `Papercraft.json` can take
+    # either a proc argument or a block. In both cases, the proc is converted to a
+    # `Papercraft::Template`.
+    #
+    # Papercraft.json(proc { item 42 }).render #=> "[42]"
+    # Papercraft.json { foo 'bar' }.render #=> "{\"foo\": \"bar\"}"
+    #
+    # @param template [Proc] template block
+    # @return [Papercraft::Template] Papercraft template
+    def json(o = nil, mime_type: nil, &template)
+      return o if o.is_a?(Papercraft::Template)
+      template ||= o
+      Papercraft::Template.new(mode: :json, mime_type: mime_type, &template)
+    end
+    # Renders Markdown into HTML. The `opts` argument will be merged with the
+    # default Kramdown options in order to change the rendering behaviour.
+    #
+    # @param markdown [String] Markdown
+    # @param **opts [Hash] Kramdown option overrides
+    # @return [String] HTML
+    def markdown(markdown, **opts)
+      opts = default_kramdown_options.merge(opts)
+      Kramdown::Document.new(markdown, **opts).to_html
+    end
+    # Returns the default Kramdown options used for rendering Markdown.
+    #
+    # @return [Hash] Kramdown options
+    def default_kramdown_options
+      @default_kramdown_options ||= {
+        entity_output: :numeric,
+        syntax_highlighter: :rouge,
+        input: 'GFM',
+        hard_wrap: false
+      }
+    end
-  # Creates a new papercraft component in XML mode. `#X` can take either a proc argument or
-  # a block. In both cases, the proc is converted to a `Papercraft::Component`.
-  #
-  # X(proc { item 'foo' }).render #=> "<item>foo</item>"
-  # X { item 'foo' }.render #=> "<item>foo</item>"
-  #
-  # @param template [Proc] template block
-  # @return [Papercraft::Component] Papercraft component
-  def X(o = nil, &template)
-    return o if o.is_a?(Papercraft::Component)
-    template ||= o
-    Papercraft::Component.new(mode: :xml, &template)
+    # Sets the default Kramdown options used for rendering Markdown.
+    #
+    # @param opts [Hash] Kramdown options
+    # @return [void]
+    def default_kramdown_options=(opts)
+      @default_kramdown_options = opts
+    end
   end
 end

data/papercraft.png ADDED Viewed

Binary file

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papercraft
 version: !ruby/object:Gem::Version
-  version: '0.15'
+  version: '0.19'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -128,17 +128,20 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- papercraft.png
 files:
 - CHANGELOG.md
 - README.md
 - lib/papercraft.rb
 - lib/papercraft/compiler.rb
-- lib/papercraft/component.rb
 - lib/papercraft/encoding.rb
 - lib/papercraft/extension_proxy.rb
 - lib/papercraft/html.rb
+- lib/papercraft/json.rb
 - lib/papercraft/renderer.rb
+- lib/papercraft/template.rb
 - lib/papercraft/version.rb
+- papercraft.png
 homepage: http://github.com/digital-fabric/papercraft
 licenses:
 - MIT