papercraft 0.21 → 0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a23bf614d84747a18eecf84545604c9c2f58710dc3fa0e0c651a863a53c919b0
-  data.tar.gz: 6b1ca8f4a90801beff11807dd357ce801b7526b5d114d5cca5f41f41aec69958
+  metadata.gz: 729c7b1cf7482cb761b005fba8da8ae4c1325559daee15fedd2d695de21ee08d
+  data.tar.gz: 0546c527a6a9ac0570c9bd6057101b31591eba1f1ee549c272d9bda13a9f7a04
 SHA512:
-  metadata.gz: dcd7eada8280cb0fcd68528eaea0d2500ff99ac149c8495dd5a3955a93c3f181301a4decc9eeb4d7efdd8cfe2c4f6047c9f838e5084b413c1118a76d6abc4252
-  data.tar.gz: 840ce0fc2a83de9b5a83bb10a5f4ed98986f7201737d6e31a4e89877aeb6bb22b2f2449c6efa08302473c073e26c830cfbe9e267456b450a56222b57a429fd15
+  metadata.gz: fdaa8d2f254744694ea3624f39871f4b411294a990f6e1bb4c57f56bf36049031b9403820cbadaa57ef6ac3e9021b6afa53da22588462450a6ca0863b6b88184
+  data.tar.gz: 4ea21235970af0cdef9ce09cd790742a94632e4f1f02d4a3d90a3e857741ec41952a53fe59b24016c00894dde7131dbbbc79d7616564f159f5646acf24f469f9

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.22 2022-02-14
+
+- Fix behaviour of call to `#p` in an extension (#10)
+
 ## 0.21 2022-02-13
 
 - Refactor and improve documentation

data/README.md

@@ -64,6 +64,7 @@ hello.render('world')
 - [Installing papercraft](#installing-papercraft)
 - [Basic usage](#basic-usage)
 - [Adding tags](#adding-tags)
+- [Tag and attribute formatting](#tag-and-attribute-formatting)
 - [Template parameters](#template-parameters)
 - [Template logic](#template-logic)
 - [Template blocks](#template-blocks)
@@ -154,6 +155,43 @@ Papercraft.html { img src: '/my.gif' }.render #=> "<img src="/my.gif"/>
 Papercraft.html { p "foobar", class: 'important' }.render #=> "<p class=\"important\">foobar</p>"
 ```
 
+## Tag and attribute formatting
+
+Papercraft does not make any presumption 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
+formatted according to the following rules, depending on the template type:
+
+- HTML: underscores are converted to dashes:
+
+  ```ruby
+  Papercraft.html {
+    foo_bar { p 'Hello', data_name: 'world' }
+  }.render #=> '<foo-bar><p data-name="world">Hello</p></foo-bar>'
+  ```
+
+- XML: underscores are converted to dashes, double underscores are converted to
+  colons:
+
+  ```ruby
+  Papercraft.xml {
+    soap__Envelope(
+      xmlns__soap:  'http://schemas.xmlsoap.org/soap/envelope/',
+    ) { }
+  }.render #=> '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Envelope>'
+  ```
+
+If you need more precise control over tag names, you can use the `#tag` method,
+which takes the tag name as its first parameter, then the rest of the parameters
+normally used for tags:
+
+```ruby
+Papercraft.html {
+  tag 'cra_zy__:!tag', 'foo'
+}.render #=> '<cra_zy__:!tag>foo</cra_zy__:!tag>'
+```
+
 ## Template parameters
 
 In Papercraft, parameters are always passed explicitly. This means that template
@@ -513,21 +551,27 @@ and other associated methods:
 
 ```ruby
 module BootstrapComponents
-  ...
-
-  def card(**props)
+  def card(**props, &block)
     div(class: 'card', **props) {
-      div(class: 'card-body') {
-        emit_yield
-      }
+      div(class: 'card-body', &block)
     }
   end
-
+  
   def card_title(title)
-    h5 title, class: 'card-title'
+    h4(title, class: 'card-title')
+  end
+
+  def card_subtitle(subtitle)
+    h5(subtitle, class: 'card-subtitle')
   end
 
-  ...
+  def card_text(text)
+    p(text, class: 'card-text')
+  end
+
+  def card_link(text, **opts)
+    a(text, class: 'card-link', **opts)
+  end
 end
 
 Papercraft.extension(bootstrap: BootstrapComponents)
@@ -543,14 +587,12 @@ Papercraft.html {
     bootstrap.card_title 'Card title'
     bootstrap.card_subtitle 'Card subtitle'
     bootstrap.card_text 'Some quick example text to build on the card title and make up the bulk of the card''s content.'
-    bootstrap.card_link '#', 'Card link'
-    bootstrap.card_link '#', 'Another link'
+    bootstrap.card_link 'Card link', href: '#foo'
+    bootstrap.card_link 'Another link', href: '#bar'
   }
 }
 ```
 
-
-
 ## XML templates
 
 XML templates behave largely the same as HTML templates, with a few minor

data/lib/papercraft/extension_proxy.rb

@@ -23,10 +23,21 @@ module Papercraft
     #
     # @param sym [Symbol] method name
     # @param *args [Array] arguments
+    # @param *props [Array] named arguments
     # @param &block [Proc] block
     # @return void
-    def method_missing(sym, *args, &block)
-      @renderer.send(sym, *args, &block)
+    def method_missing(sym, *args, **props, &block)
+      @renderer.send(sym, *args, **props, &block)
+    end
+
+    # Overrides the `Kernel#p` method to emit a p tag.
+    #
+    # @param *args [Array] arguments
+    # @param *props [Array] named arguments
+    # @param &block [Proc] block
+    # @return void
+    def p(text = nil, **props, &block)
+      @renderer.p(text, **props, &block)
     end
   end
 end

data/lib/papercraft/tags.rb

@@ -160,7 +160,6 @@ module Papercraft
     # @param &block [Proc] block passed to method
     # @return [void]
     def method_missing(sym, *args, **opts, &block)
-      # p method_missing: sym, self: self
       tag = sym.to_s
       repr = tag_repr(tag)
       code = S_TAG_METHOD % {

data/lib/papercraft/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papercraft
 version: !ruby/object:Gem::Version
-  version: '0.21'
+  version: '0.22'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-13 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils