papercraft 0.16 → 0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 996d95088c85415ca883c27b6b1c98e65af5c046e3121ea08f092ac7bcdcc588
-  data.tar.gz: 8fe294225c04dcfc82289fd2b9047760260b814712e83e9bf5ea7d361dad6950
+  metadata.gz: 31c80224c2a9dc3a6d594d923e9a16ccd8127284bce501f1d7f1dc25386bf25c
+  data.tar.gz: 45dc43d353bc1f3c06e62d1b439751570ce7d46a915b0a72f1ce3ea182b0c225
 SHA512:
-  metadata.gz: 54fdbe164a4a2541153e57b90cdb35ba71b6887fbe2d199505da3389730f1bd937fe0254f8c019b39d81957058c5f51ad71bc900f324e3178b979f368642ee57
-  data.tar.gz: fa05ea9ae79a57a3eace2e708b01fe5f44412591875776cf1a2fe95cc6d9d1586357756e702e8a17e5458b3fa4c3e3224290bc234b71fdcd426db0dedff31dc0
+  metadata.gz: 67529d1336456dded5d911548941c1accc695bd017b889b378ed008e177707b100e11e90b1adbe887d45530cfb94950808e21257955999d795b388dbeb13206e
+  data.tar.gz: 1caca448eb2a317b1616a529e82803f6571e26e8b0f36a19e771b2b4a9a96cabb8695ad5a01148acfa7481b016742e9c546c794fd2a9017ec54d299184d36c94

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.17 2022-01-23
+
+- Refactor markdown code, add `Papercraft.markdown` method (#8)
+
 ## 0.16 2022-01-23
 
 - Implement JSON templating (#7)

data/README.md

@@ -358,6 +358,14 @@ 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
@@ -370,10 +378,10 @@ 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
 ```
 
 ## Deferred evaluation

data/lib/papercraft/html.rb

@@ -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/renderer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'escape_utils'
+
 require_relative './html'
 require_relative './json'
 require_relative './extension_proxy'

data/lib/papercraft/version.rb

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

data/lib/papercraft.rb

@@ -1,73 +1,110 @@
 # frozen_string_literal: true
 
-require 'escape_utils'
+require 'kramdown'
+require 'rouge'
+require 'kramdown-parser-gfm'
 
 require_relative 'papercraft/component'
 require_relative 'papercraft/renderer'
 require_relative 'papercraft/encoding'
 # require_relative 'papercraft/compiler'
 
+
 # Papercraft is a component-based HTML templating library
 module Papercraft
   # Exception class used to signal templating-related errors
   class Error < RuntimeError; 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 component. `Papercraft.html` can take either a proc
+    # argument or a block. In both cases, the proc is converted to a
+    # `Papercraft::Component`.
+    #
+    # 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
+    def html(o = nil, mime_type: nil, &template)
+      return o if o.is_a?(Papercraft::Component)
+      template ||= o
+      Papercraft::Component.new(mode: :html, mime_type: mime_type, &template)
+    end
+    
+    # Creates a new papercraft component 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.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
+    def xml(o = nil, mime_type: nil, &template)
+      return o if o.is_a?(Papercraft::Component)
+      template ||= o
+      Papercraft::Component.new(mode: :xml, mime_type: mime_type, &template)
+    end
+    
+    # Creates a new papercraft component 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.json(proc { item 42 }).render #=> "[42]"
+    # Papercraft.json { foo 'bar' }.render #=> "{\"foo\": \"bar\"}"
+    #
+    # @param template [Proc] template block
+    # @return [Papercraft::Component] Papercraft component
+    def json(o = nil, mime_type: nil, &template)
+      return o if o.is_a?(Papercraft::Component)
+      template ||= o
+      Papercraft::Component.new(mode: :json, mime_type: mime_type, &template)
+    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
-
-  # Creates a new papercraft component. `Papercraft.html` can take either a proc
-  # argument or a block. In both cases, the proc is converted to a
-  # `Papercraft::Component`.
-  #
-  # 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
-  def self.html(o = nil, mime_type: nil, &template)
-    return o if o.is_a?(Papercraft::Component)
-    template ||= o
-    Papercraft::Component.new(mode: :html, mime_type: mime_type, &template)
-  end
-
-  # Creates a new papercraft component 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.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
-  def self.xml(o = nil, mime_type: nil, &template)
-    return o if o.is_a?(Papercraft::Component)
-    template ||= o
-    Papercraft::Component.new(mode: :xml, 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 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.json(proc { item 42 }).render #=> "[42]"
-  # Papercraft.json { foo 'bar' }.render #=> "{\"foo\": \"bar\"}"
-  #
-  # @param template [Proc] template block
-  # @return [Papercraft::Component] Papercraft component
-  def self.json(o = nil, mime_type: nil, &template)
-    return o if o.is_a?(Papercraft::Component)
-    template ||= o
-    Papercraft::Component.new(mode: :json, mime_type: mime_type, &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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: papercraft
 version: !ruby/object:Gem::Version
-  version: '0.16'
+  version: '0.17'
 platform: ruby
 authors:
 - Sharon Rosner