papercraft 0.18 → 0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a887e5946cfe19b6874046cb4ef173a1de4deb11509ea4c7dca5c6434e0d710d
-  data.tar.gz: 3bdd374b54c72dac9f8137f5878cd43f0415c84eadebfef50fc90eb30029bf3b
+  metadata.gz: f0f4910bd26625ca0349b1c471338fb4d13e8055e88367b5cad16f91cdee7531
+  data.tar.gz: 38e43978278ba069e3767abd94d83c676f42692f5eb55f1be4b4067fae2f935e
 SHA512:
-  metadata.gz: 8d4a911c94bb39ab8da06e3f61a965a7db13725b143a2cf38feae44cbb1ac0ae0a8d79b899008a14c87d890ba5ebff61fb3616b5a2014bd84049da8af95a9029
-  data.tar.gz: fe798bfc67006d21e6bc62cfa32d50141720f44d0089d9da58b7b7406b8d1386e8f77d10f4a34863dad05968e0342acd9d94be68afeca98955189853b367a8e0
+  metadata.gz: b096452cebe7b6bb34a428f4920a5940e5b745c86b54188a984a77df6175145cf6645753e6ae58b3df89813919920a17a96610e010724bc50077c6f9accc7293
+  data.tar.gz: 8d1cd5b2d6b70ee9ef0a748a064bbd6d1630cfa926663aded95a01c26ce289a159e2548068bf8210c5e8d37ba26c9671eb4a00fe4790a47bec6dd822b4de5d5d

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.19 2022-02-05
+
+- Rename `Papercraft::Component` to `Papercraft::Template`
+
 ## 0.18 2022-02-04
 
 - Cleanup and update examples

data/README.md

@@ -70,7 +70,7 @@ hello.render('world')
 - [Plain procs as templates](#plain-procs-as-templates)
 - [Template composition](#template-composition)
 - [Parameter and block application](#parameter-and-block-application)
-- [Higher-order components](#higher-order-components)
+- [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)
@@ -221,8 +221,8 @@ Papercraft.html(&greeting).render('world')
 
 ## 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
@@ -250,14 +250,14 @@ page = Papercraft.html { |title, 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" }
@@ -272,11 +272,11 @@ Papercraft.html {
 ## 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
@@ -289,19 +289,19 @@ 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 = Papercraft.html { |inner| div { emit inner } }
@@ -310,7 +310,7 @@ 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 = Papercraft.html { div { emit_yield } }
@@ -320,7 +320,7 @@ 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`
@@ -434,8 +434,8 @@ 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.
@@ -444,11 +444,11 @@ 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

data/lib/papercraft/renderer.rb

@@ -8,7 +8,7 @@ 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
@@ -43,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.
@@ -219,7 +219,7 @@ module Papercraft
     #   
     #   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]
@@ -253,7 +253,7 @@ 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

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

@@ -4,30 +4,30 @@ 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 class methods `html`, `xml` or
+  # Templates are usually created using the class methods `html`, `xml` or
   # `json`, for HTML, XML or JSON templates, respectively:
   #
   #   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(mode: :html) { |name| h1 "Hello, #{name}!" }
+  #   greeter = Papercraft::Template.new(mode: :html) { |name| h1 "Hello, #{name}!" }
   #   greeter.render('world') #=> "<h1>Hello, world!</h1>"
   #
-  # The different methods for creating components can also take a custom MIME
+  # 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 component block, HTML elements are created by simply calling
+  # In the template block, HTML elements are created by simply calling
   # unqualified methods:
   #
   #   page_layout = Papercraft.html {
@@ -41,20 +41,20 @@ 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 = 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 = Papercraft.html {
   #     emit anchor, uri: '/posts',   text: 'Posts'
@@ -62,7 +62,7 @@ module Papercraft
   #     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 = Papercraft.html { |anchors|
@@ -74,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'),
@@ -84,7 +84,7 @@ module Papercraft
   #   ])
   #   links_with_anchors.render
   #
-  class Component < Proc
+  class Template < Proc
     
     # Determines the rendering mode: `:html` or `:xml`.
     attr_accessor :mode
@@ -95,12 +95,12 @@ module Papercraft
       json: 'application/json'
     }.freeze
 
-    # Initializes a component with the given block. The rendering mode (HTML or
+    # 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 component's mime type (nil for default)
+    # @param mime_type [String, nil] the template's mime type (nil for default)
     # @param block [Proc] nested HTML block
     def initialize(mode: :html, mime_type: nil, &block)
       @mode = mode
@@ -124,9 +124,9 @@ 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 = Papercraft.html {
     #     article {
@@ -141,19 +141,19 @@ 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(mode: @mode, mime_type: @mime_type, &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

data/lib/papercraft/version.rb

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

data/lib/papercraft.rb

@@ -4,13 +4,13 @@ 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
@@ -31,49 +31,49 @@ module Papercraft
       Renderer.extension(map)
     end
     
-    # Creates a new papercraft component. `Papercraft.html` can take either a proc
+    # 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::Component`.
+    # `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::Component] Papercraft component
+    # @return [Papercraft::Template] Papercraft template
     def html(o = nil, mime_type: nil, &template)
-      return o if o.is_a?(Papercraft::Component)
+      return o if o.is_a?(Papercraft::Template)
       template ||= o
-      Papercraft::Component.new(mode: :html, mime_type: mime_type, &template)
+      Papercraft::Template.new(mode: :html, mime_type: mime_type, &template)
     end
     
-    # Creates a new papercraft component in XML mode. `Papercraft.xml` can take
+    # 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::Component`.
+    # `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::Component] Papercraft component
+    # @return [Papercraft::Template] Papercraft template
     def xml(o = nil, mime_type: nil, &template)
-      return o if o.is_a?(Papercraft::Component)
+      return o if o.is_a?(Papercraft::Template)
       template ||= o
-      Papercraft::Component.new(mode: :xml, mime_type: mime_type, &template)
+      Papercraft::Template.new(mode: :xml, mime_type: mime_type, &template)
     end
     
-    # Creates a new papercraft component in JSON mode. `Papercraft.json` can take
+    # 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::Component`.
+    # `Papercraft::Template`.
     #
     # Papercraft.json(proc { item 42 }).render #=> "[42]"
     # Papercraft.json { foo 'bar' }.render #=> "{\"foo\": \"bar\"}"
     #
     # @param template [Proc] template block
-    # @return [Papercraft::Component] Papercraft component
+    # @return [Papercraft::Template] Papercraft template
     def json(o = nil, mime_type: nil, &template)
-      return o if o.is_a?(Papercraft::Component)
+      return o if o.is_a?(Papercraft::Template)
       template ||= o
-      Papercraft::Component.new(mode: :json, mime_type: mime_type, &template)
+      Papercraft::Template.new(mode: :json, mime_type: mime_type, &template)
     end
 
     # Renders Markdown into HTML. The `opts` argument will be merged with the

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papercraft
 version: !ruby/object:Gem::Version
-  version: '0.18'
+  version: '0.19'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-04 00:00:00.000000000 Z
+date: 2022-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -128,18 +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