rubyoshka 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c084b7ff1e4a364ea95df6fa3824c1a67a190aae85c8ad50812132ef7acd5cf
-  data.tar.gz: 8b04fd36caf85ca4dc7883f2efad96ed53753d5b59548e19a9a3c5ec85f6fa28
+  metadata.gz: aabb46d1744db33af049b11eec91a9e18a938aea5391ab2f22e41c0bccce77ae
+  data.tar.gz: 7d1a473f5c25ab35f38d0886dee156f2da38bce9306cb48a4e39e47d6d2e818d
 SHA512:
-  metadata.gz: 27c7bafa5f1851982ee05ccf9f90e1513c4b426217531f6daa205ce872ad57be9c672ba35ce1e5f0a6b882aa93dbf3987dab2375282e0bda22c897df1cf2ff5f
-  data.tar.gz: 8a35f8f8ef434e21a48208d079d62acb4df497d6a44234caee41c4a1df92de8d20c8bc3329ce624eed2691fde5205961681b4a8ebd2e80966b99ee65e58c8b4f
+  metadata.gz: c5c43c9e8bb8f0b2a076a2a607ce3d735575748be1a6998dedb38ef795bfe3a8a33f2d3039c5ba379085b2750929966d4a9f41201651196dc2c1e5ea280c21c1
+  data.tar.gz: 120ad28457f4c3c1775de5d2b542d365a3abb5fdcdf01946097b251dd1830eaee7d2d6bc63bf1fe72c195073e80b9c2e4b3b0d9bddc2445c81c31d45aa9157a2

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.5 2021-02-27
+--------------
+
+* Add support for rendering XML
+* Add Rubyoshka.component method
+* Remove Modulation dependency
+
 0.4 2019-02-05
 --------------
 

data/README.md

@@ -226,16 +226,17 @@ greeting.render(name: 'world')
 ## Templates as components
 
 Rubyoshka makes it easy to compose multiple separate templates into a whole HTML
-document. Each template can be defined as a self-contained component that can
-be reused inside other components. Components should be defined as constants,
-either in the global namespace, or on the `Rubyoshka` namespace. Each component
-can be defined as either a Rubyoshka instance (using `#H`) or as a `proc` that
-returns a Rubyoshka instance:
+document. Each template can be defined as a self-contained component that can be
+reused inside other components. Components can be defined as either a Rubyoshka
+instance (using `#H`), a `proc` that returns a Rubyoshka instance, or using
+`Rubyoshka.component`:
 
 ```ruby
+# Simple component relying on global/local context
 Title = H { h1 title }
 
-# Item is actually a Proc that returns a template
+# Proc component that returns a template
+# Notice how the lambda expression takes keyword arguments
 Item = ->(id:, text:, checked:) {
   H {
     li {
@@ -245,20 +246,29 @@ Item = ->(id:, text:, checked:) {
   }
 }
 
-def render_items(items)
+# Components using Rubyoshka.component (or H.component) are a bit more compact.
+# Any parameters are passed as arguments to the block.
+NavBar = Rubyoshka.component do |links|
+  div {
+    links.each { |l| a l[:title], href: l[:url] }
+  }
+end
+
+def render_items(items, links)
   html = H {
     Title()
+    NavBar(links)
     ul {
       items.each { |id, attributes|
         Item id: id, text: attributes[:text], checked: attributes[:active]
       }
     }
-  }.render
+  }.render(title: 'Hello from components')
 end
 ```
 
 Note that a component is invoked as a method, which means that if no arguments
-are passed, you should add an empty pair of parens, as shown in the example
+are passed, you must add an empty pair of parens, as shown in the example
 above.
 
 In addition to using components defined as constants, you can also use
@@ -319,8 +329,8 @@ reused in multiple different templates in your app.
 ### Changing the cache store
 
 Rubyoshka ships with a naïve in-memory cache store built-in. You can use
-another cache store by overriding the `Rubyoshka.cache_get` and
-`Rubyoshka.cache_set` methods (see API [reference](#api-reference)).
+another cache store by overriding the `Rubyoshka.cache` method (see API
+[reference](#rubyoshkacache)).
 
 ## Wrapping arbitrary HTML with a component
 

data/lib/rubyoshka.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
 
-require 'modulation/gem'
 require 'escape_utils'
 
-export_default :Rubyoshka
-
 # A Rubyoshka is a template representing a piece of HTML
 class Rubyoshka
-  # A Rendering is a rendering of a Rubyoshka
-  class Rendering
+  # A Renderer is a rendering of a Rubyoshka
+  class Renderer
     attr_reader :context
   
     # Initializes attributes and renders the given block
@@ -27,8 +24,15 @@ class Rubyoshka
       @buffer
     end
 
-    E = EscapeUtils
-  
+    def escape_text(text)
+      raise NotImplementedError
+    end
+
+    def escape_uri(uri)
+      EscapeUtils.escape_uri(v)
+    end
+
+    S_TAG_METHOD_LINE = __LINE__ + 1
     S_TAG_METHOD = <<~EOF
       S_TAG_%<TAG>s_PRE = '<%<tag>s'
       S_TAG_%<TAG>s_CLOSE = '</%<tag>s>'
@@ -46,7 +50,7 @@ class Rubyoshka
           emit(text)
           @buffer << S_TAG_%<TAG>s_CLOSE
         elsif text
-          @buffer << S_GT << E.escape_html(text.to_s) << S_TAG_%<TAG>s_CLOSE
+          @buffer << S_GT << escape_text(text.to_s) << S_TAG_%<TAG>s_CLOSE
         else
           @buffer << S_SLASH_GT
         end
@@ -65,6 +69,7 @@ class Rubyoshka
       return value if value
 
       if sym =~ R_CONST_SYM
+        # Component reference (capitalized method name)
         o = instance_eval(sym.to_s) rescue Rubyoshka.const_get(sym) \
             rescue Object.const_get(sym)
         case o
@@ -86,7 +91,8 @@ class Rubyoshka
         end
       else
         tag = sym.to_s
-        self.class.class_eval(S_TAG_METHOD % { tag: tag, TAG: tag.upcase })
+        code = S_TAG_METHOD % { tag: tag, TAG: tag.upcase }
+        self.class.class_eval(code, __FILE__, S_TAG_METHOD_LINE)
         send(sym, *args, &block)
       end
     end
@@ -101,6 +107,7 @@ class Rubyoshka
       when Rubyoshka
         instance_eval(&o.block)
       when Module
+        # If module is given, the component is expected to be a const inside the module
         emit(o::Component)
       when nil
       else
@@ -126,7 +133,7 @@ class Rubyoshka
         case k
         when :src, :href
           @buffer << S_SPACE << k.to_s << S_EQUAL_QUOTE <<
-            E.escape_uri(v) << S_QUOTE
+            EscapeUtils.escape_uri(v) << S_QUOTE
         else
           case v
           when true
@@ -140,7 +147,7 @@ class Rubyoshka
       }
     end
 
-    # Emits the p tag
+    # Emits the p tag (overrides Object#p)
     # @param text [String] text content of tag
     # @param props [Hash] tag attributes
     # @para block [Proc] nested HTML block
@@ -162,7 +169,7 @@ class Rubyoshka
     # Emits text into the rendering buffer
     # @param data [String] text
     def text(data)
-      @buffer << E.escape_html(data)
+      @buffer << escape_text(data)
     end
 
     # Sets a local context for the given block
@@ -195,13 +202,27 @@ class Rubyoshka
     end
   end
 
+  class HTMLRenderer < Renderer
+    def escape_text(text)
+      EscapeUtils.escape_html(text.to_s)
+    end
+
+  end
+
+  class XMLRenderer < Renderer
+    def escape_text(text)
+      EscapeUtils.escape_xml(text.to_s)
+    end
+  end
+
   attr_reader :block
 
   # Initializes a Rubyoshka with the given block
   # @param ctx [Hash] local context
   # @param block [Proc] nested HTML block
   # @param [void]
-  def initialize(**ctx, &block)
+  def initialize(mode: :html, **ctx, &block)
+    @mode = mode
     @block = ctx.empty? ? block : proc { with(ctx, &block) }
   end
 
@@ -211,7 +232,18 @@ class Rubyoshka
   # @param context [Hash] context
   # @return [String]
   def render(context = H_EMPTY)
-    Rendering.new(context, &block).to_s
+    renderer_class.new(context, &block).to_s
+  end
+
+  def renderer_class
+    case @mode
+    when :html
+      HTMLRenderer
+    when :xml
+      XMLRenderer
+    else
+      raise "Invalid mode #{@mode.inspect}"
+    end
   end
 
   @@cache = {}
@@ -219,6 +251,10 @@ class Rubyoshka
   def self.cache
     @@cache
   end
+
+  def self.component(&block)
+    proc { |*args| new { instance_exec(*args, &block) } }
+  end
 end
 
 module ::Kernel

data/lib/rubyoshka/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Rubyoshka
-  VERSION = '0.4'
+  VERSION = '0.5'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubyoshka
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2021-02-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: modulation
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: escape_utils
   requirement: !ruby/object:Gem::Requirement
@@ -129,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: 'Rubyoshka: composable HTML templating for Ruby'