RubyGems - html-template - Versions diffs - 0.1.0 → 0.2.0 - Mend

html-template 0.1.0 → 0.2.0

Files changed (11) hide show

checksums.yaml +4 -4
data/Manifest.txt +0 -1
data/README.md +23 -24
data/lib/html/template/version.rb +1 -1
data/lib/html/template.rb +137 -35
data/test/helper.rb +1 -0
data/test/templates/planet/basic/index.html.tmpl +3 -3
data/test/templates/planet/fancy/index.html.tmpl +2 -2
data/test/test_merge.rb +52 -13
metadata +2 -3
data/test/templates/planet/README.md +0 -7

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e35f465439469ba0e64f58a6ece96b2b5aa8358
-  data.tar.gz: 94054c9cf1dd94bee198b2e76e296542698b2c49
+  metadata.gz: 99e549ccfeeab65c5a307442d82910d2c69fa03a
+  data.tar.gz: c7f0bf3e17141ea27250e99ea184c61a8f85fa96
 SHA512:
-  metadata.gz: 3ffb1e09a7d8d3ddea7bc13789ed8037813750ae8dcad89e7f0d778808ef9c1797e86545031a734efe4ac9a0b50ef1ad9b613cd15bf743d9c2276fc57e1dd4e5
-  data.tar.gz: 3c5cf4655de62ee201567fb5650b8d8219b13fc3b6be6a534a1a8db8980f96fe9080d65c14fe04246793b1c891da972a72f235d7298c3b7cc7526db0025c9288
+  metadata.gz: e3a4b8328958f8934858ec3d62f906e40ce0ebc74638101bca301656319c20560ae6c748892b6ee6f0ceaa6281d063a64d256628955ab49b951ecd11a0474ddd
+  data.tar.gz: b225712c8e413f29d4f9e76fc35c8fa38106e32cb062c77f6695e544980c087d2f733b3ebe55873bdcf98809f22f9741e9075165ef25e2e1354679a481e63d18

data/Manifest.txt CHANGED Viewed

@@ -8,7 +8,6 @@ test/helper.rb
 test/templates/opml.xml
 test/templates/opml.xml.erb
 test/templates/opml.xml.tmpl
-test/templates/planet/README.md
 test/templates/planet/atom.xml.tmpl
 test/templates/planet/basic/index.html.tmpl
 test/templates/planet/fancy/index.html.tmpl

data/README.md CHANGED Viewed

@@ -23,15 +23,17 @@ the ruby version.
 First you make a template - this is just a normal HTML file with a few extra tags, the simplest being `<TMPL_VAR>`
-For example, `students.html.tmpl`:
+For example, `test.html.tmpl`:
 ```
-<TMPL_LOOP students>
-  <p>
-  Name: <TMPL_VAR name><br>
-  GPA: <TMPL_VAR gpa>
-  </p>
-</TMPL_LOOP>
+<html>
+<head><title>Test Template</title></head>
+<body>
+My Home Directory is <TMPL_VAR home>
+<p>
+My Path is set to <TMPL_VAR path>
+</body>
+</html>
 ```
 Now you can use it in your script:
@@ -39,26 +41,23 @@ Now you can use it in your script:
 ``` ruby
 require 'html/template'
-template = HtmlTemplate.new( filename: 'students.html.tmpl' )
+template = HtmlTemplate.new( filename: 'test.html.tmpl' )
-puts template.render( students: [ { name: 'Bluto Blutarsky', gpa: 0.0 },
-                                  { name: 'Tracey Flick',    gpa: 4.0 }
-                                ]
-                    )
+puts template.render( home: ENV['HOME'],
+                      path: ENV['PATH'] )
 ```
 If all is well in the universe this should output something like this:
-```
+``` html
+<html>
+<head><title>Test Template</title></head>
+<body>
+My Home Directory is /home/alice
 <p>
-Name: Bluto Blutarsky<br>
-GPA: 0.0
-</p>
-<p>
-Name: Tracey Flick<br>
-GPA: 4.0
-</p>
+My Path is set to /bin;/usr/bin
+</body>
+</html>
 ```
@@ -143,7 +142,7 @@ puts template.result( employees: [ { name: 'Sam',   job: 'programmer' },
 The output is:
-```
+``` html
 <p>
 Name: Sam<br>
 Job: programmer
@@ -162,7 +161,7 @@ and then iterates over the loop body producing output.
 **Loop Context Variables**
 Inside a loop extra variables that depend on the loop's context
-are made available. These are:
+are made available if the `loop_vars` option is set to true (yes, true by default). These are:
 `__FIRST__`
@@ -329,7 +328,7 @@ puts HtmlTemplate.new( <<TXT ).text
 TXT
 ```
-will print if debugging is turned on:
+will print if debugging is turned on (e.g. `HtmlTemplate.config.debug = true`):
 ```
 line 4 - match <TMPL_VAR name ESCAPE="HTML"> replacing with: <%=h name %>

data/lib/html/template/version.rb CHANGED Viewed

@@ -3,7 +3,7 @@
 class HtmlTemplate
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
     VERSION = [MAJOR,MINOR,PATCH].join('.')

data/lib/html/template.rb CHANGED Viewed

@@ -16,13 +16,13 @@ module Enumerable
      end
      def index=(value) @index=value; end
    end
    def each_with_loop( &blk )
      loop_meta = LoopMeta.new( size )
      each_with_index do |item, index|
         loop_meta.index = index
         blk.call( item, loop_meta )
-     end
+     end
    end
 end
@@ -35,55 +35,100 @@ require 'html/template/version'    # note: let version always get first
 class HtmlTemplate
+  class Configuration
+    def debug=(value)      @debug = value;   end
+    def debug?()           @debug || false;  end
+    def strict=(value)     @strict = value;  end
+    def strict?()          @strict || true;  end
+    def loop_vars=(value)  @loop_vars = value; end
+    def loop_vars?()       @loop_vars || true; end
+  end # class Configuration
+  ## lets you use
+  ##   HtmlTemplate.configure do |config|
+  ##      config.debug        = true
+  ##      config.strict       = true
+  ##   end
+  def self.configure
+    yield( config )
+  end
+  def self.config
+    @config ||= Configuration.new
+  end
   attr_reader :text   ## returns converted template text (with "breaking" comments!!!)
-  attr_reader :template  ## return "inner" (erb) template object
+  attr_reader :template  ## return "inner" (erb) template object
   attr_reader :errors
+  attr_reader :names   ## for debugging - returns all referenced / used names in VAR/IF/UNLESS/LOOP/etc.
+  ## config convenience (shortcut) helpers
+  def config() self.class.config; end
+  def debug?() config.debug?;     end
+  def strict?()    @strict;    end
+  def loop_vars?() @loop_vars; end
-  def initialize( text=nil, filename: nil )
+  def initialize( text=nil, filename: nil, strict: config.strict?, loop_vars: config.loop_vars? )
     if text.nil?   ## try to read file (by filename)
       text = File.open( filename, 'r:utf-8' ) { |f| f.read }
     end
+    ## options
+    @strict    = strict
+    @loop_vars = loop_vars
     ## todo/fix: add filename to ERB too (for better error reporting)
-    @text, @errors = convert( text )    ## note: keep a copy of the converted template text
+    @text, @errors, @names = convert( text )    ## note: keep a copy of the converted template text
     if @errors.size > 0
       puts "!! ERROR - #{@errors.size} conversion / syntax error(s):"
       pp @errors
-      raise   ## todo - find a good Error - StandardError - why? why not?
+      raise     if strict? ## todo - find a good Error - StandardError - why? why not?
     end
     @template      = ERB.new( @text, nil, '%<>' )
   end
+  IDENT   = '[a-zA-Z_][a-zA-Z0-9_]*'
+  ESCAPES = 'HTML|NONE'
   VAR_RE = %r{<TMPL_(?<tag>VAR)
-                 \s
-                 (?<ident>[a-zA-Z_][a-zA-Z0-9_]*)
-                 (\s
+                 \s+
+                 (?<ident>#{IDENT})
+                 (\s+
                    (?<escape>ESCAPE)
-                      =
-                    "(?<format>HTML|NONE)"
+                      =(
+                          (?<q>['"])(?<format>#{ESCAPES})\k<q>  # note: allow single or double enclosing quote (but MUST match)
+                        |  (?<format>#{ESCAPES})              # note: support without quotes too
+                       )
                  )?
                >}x
   IF_OPEN_RE = %r{(?<open><)TMPL_(?<tag>IF|UNLESS)
-                  \s
-                  (?<ident>[a-zA-Z_][a-zA-Z0-9_]*)
+                  \s+
+                  (?<ident>#{IDENT})
                 >}x
   IF_CLOSE_RE = %r{(?<close></)TMPL_(?<tag>IF|UNLESS)
-                    (\s
-                      (?<ident>[a-zA-Z_][a-zA-Z0-9_]*)
-                    )?     # note: allow optional identifier
+                    (\s+
+                      (?<ident>#{IDENT})
+                    )?     # note: allow optional identifier
                   >}x
   ELSE_RE = %r{<TMPL_(?<tag>ELSE)
                  >}x
   LOOP_OPEN_RE = %r{(?<open><)TMPL_(?<tag>LOOP)
-                      \s
-                      (?<ident>[a-zA-Z_][a-zA-Z0-9_]*)
+                      \s+
+                      (?<ident>#{IDENT})
                     >}x
   LOOP_CLOSE_RE = %r{(?<close></)TMPL_(?<tag>LOOP)
@@ -91,7 +136,7 @@ class HtmlTemplate
   CATCH_OPEN_RE = %r{(?<open><)TMPL_(?<unknown>[^>]+?)
                       >}x
   CATCH_CLOSE_RE = %r{(?<close></)TMPL_(?<unknown>[^>]+?)
                       >}x
@@ -106,7 +151,7 @@ class HtmlTemplate
                          CATCH_CLOSE_RE )
-  def to_recursive_ostruct( o )
+  def to_recursive_ostruct( o )
     if o.is_a?( Array )
       o.reduce( [] ) do |ary, item|
                        ary << to_recursive_ostruct( item )
@@ -125,8 +170,47 @@ class HtmlTemplate
   end
+  class Names
+    def initialize
+      @names = Hash.new
+    end
+    def to_h() @names; end
+    def add( scope, ident, tag )
+      ## e.g. scope e.g. ['feeds'] or ['feeds','items'] - is a stack / array
+      ##      ident e.g.  title                         - is a string
+      ##      tag   e.g.  $VAR/$LOOP/$IF/$UNLESS        - is a string
+      h = fetch( scope, ident )
+      h[ tag ] ||= 0
+      h[ tag ] += 1
+    end
+  private
+    def fetch( scope, ident )
+      ## fetch name in scoped hierarchy
+      ##   if first time than setup new empty hash
+      h = @names
+      scope.each do |name|
+        h = h[name] ||= {}
+      end
+      h[ ident ] ||= {}
+    end
+  end  ## class Names
+  def ident_to_loop_it( ident )  # make loop iterator (e.g. Channels => channel and so on)
+     ## assume plural ident e.g. channels
+     ##  cut-off last char, that is,
+     ##   the plural s channels => channel
+     ##  note:  ALWAYS downcase (auto-generated) loop iterator/pass name
+     ident[0..-2].downcase
+  end
   def convert( text )
-    errors = []   # note: reset global errros list
+    errors = []          # note: reset global errros list
+    names  = Names.new   ## keep track of all referenced / used names in VAR/IF/UNLESS/LOOP/etc.
     stack = []
@@ -138,7 +222,7 @@ class HtmlTemplate
       lineno += 1
       if line.lstrip.start_with?( '#' )    ## or make it tripple ### - why? why not?
-         buf << "%#{line.lstrip}"
+         buf << "%#{line.lstrip}"
       elsif line.strip.empty?
          buf << line
       else
@@ -159,9 +243,19 @@ class HtmlTemplate
                   ## note: peek; get top stack item
                   ##   if top level (stack empty)  => nothing
                   ##       otherwise               => channel. or item. etc. (with trailing dot included!)
-                  ctx = stack.empty? ? '' : "#{stack[-1]}."
+                  ctx = if stack.empty?
+                          ''
+                        else
+                           ## assume plural ident e.g. channels
+                           ##  cut-off last char, that is,
+                           ##   the plural s channels => channel
+                           ##  note:  ALWAYS downcase (auto-generated) loop iterator/pass name
+                           "#{ident_to_loop_it( stack[-1] )}."
+                        end
                   code = if tag == 'VAR'
+                           names.add( stack, ident, '$VAR' )
                            if escape && format == 'HTML'
                                ## check or use long form e.g. CGI.escapeHTML - why? why not?
                               "<%=h #{ctx}#{ident} %>"
@@ -169,20 +263,28 @@ class HtmlTemplate
                               "<%= #{ctx}#{ident} %>"
                            end
                          elsif tag == 'LOOP' && tag_open
+                           names.add( stack, ident, '$LOOP' )
                            ## assume plural ident e.g. channels
                            ##  cut-off last char, that is, the plural s channels => channel
                            ##  note:  ALWAYS downcase (auto-generated) loop iterator/pass name
-                           it = ident[0..-2].downcase
-                           stack.push( it )
-                           "<% #{ctx}#{ident}.each_with_loop do |#{it}, #{it}_loop| %>"
+                           it = ident_to_loop_it( ident )
+                           stack.push( ident )
+                           if loop_vars?
+                             "<% #{ctx}#{ident}.each_with_loop do |#{it}, #{it}_loop| %>"
+                           else
+                             "<% #{ctx}#{ident}.each do |#{it}| %>"
+                           end
                          elsif tag == 'LOOP' && tag_close
                            stack.pop
                            "<% end %>"
                          elsif tag == 'IF' && tag_open
+                           names.add( stack, ident, '$IF' )
                            "<% if #{ctx}#{ident} %>"
-                          elsif tag == 'UNLESS' && tag_open
-                            "<% unless #{ctx}#{ident} %>"
-                          elsif (tag == 'IF' || tag == 'UNLESS') && tag_close
+                         elsif tag == 'UNLESS' && tag_open
+                           names.add( stack, ident, '$UNLESS' )
+                           "<% unless #{ctx}#{ident} %>"
+                         elsif (tag == 'IF' || tag == 'UNLESS') && tag_close
                            "<% end %>"
                          elsif tag == 'ELSE'
                            "<% else %>"
@@ -200,13 +302,13 @@ class HtmlTemplate
                            raise ArgumentError  ## unknown tag #{tag}
                          end
-                  puts " line #{lineno} - match #{m[0]} replacing with: #{code}"
+                  puts " line #{lineno} - match #{m[0]} replacing with: #{code}"  if debug?
                   code
                 end
         end
       end # each_line
-    [buf, errors]
+    [buf, errors, names.to_h]
   end # method convert
@@ -229,9 +331,9 @@ class HtmlTemplate
                                    hash[key] = to_recursive_ostruct( val )
                                    hash
                                  end
     ## (auto-)convert array and hash values to ostruct
-    ##   for easy dot (.) access
+    ##   for easy dot (.) access
     ##      e.g. student.name instead of student[:name]
     @template.result( Context.new( **kwargs ).get_binding )

data/test/helper.rb CHANGED Viewed

@@ -4,6 +4,7 @@ require 'minitest/autorun'
 ## our own code
 require 'html/template'
+HtmlTemplate.config.debug = true
 ########

data/test/templates/planet/basic/index.html.tmpl CHANGED Viewed

@@ -1,4 +1,4 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE HTML>
 <html>
 ### Planet HTML template.
@@ -22,7 +22,7 @@
 <head>
 <title><TMPL_VAR name></title>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta charset="utf-8">
 <meta name="generator" content="<TMPL_VAR generator ESCAPE="HTML">">
 </head>
@@ -85,4 +85,4 @@
 </p>
 </body>
-</html>
+</html>

data/test/templates/planet/fancy/index.html.tmpl CHANGED Viewed

@@ -1,4 +1,4 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE HTML>
 <html>
 ### Fancy Planet HTML template.
@@ -13,7 +13,7 @@
 <head>
 <title><TMPL_VAR name></title>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta charset="utf-8">
 <meta name="generator" content="<TMPL_VAR generator ESCAPE="HTML">">
 <link rel="stylesheet" href="planet.css" type="text/css">
 <TMPL_IF feedtype>

data/test/test_merge.rb CHANGED Viewed

@@ -78,24 +78,63 @@ print $template->output;
 =end
   def test_students_example
-    tmpl =<<TXT
-    <TMPL_LOOP students>
-       <p>
-       Name: <TMPL_VAR name><br/>
-       GPA: <TMPL_VAR gpa>
-       </p>
-    </TMPL_LOOP>
+    t = HtmlTemplate.new( <<TXT )
+<TMPL_LOOP students>
+<p>
+Name: <TMPL_VAR name><br/>
+GPA: <TMPL_VAR gpa>
+</p>
+</TMPL_LOOP>
 TXT
-    t = HtmlTemplate.new( tmpl )
     puts t.text
     puts "---"
-    puts t.render( students: [ { name: 'Bluto Blutarsky', gpa: 0.0 },
-                               { name: 'Tracey Flick',    gpa: 4.0 } ])
+    result = t.render( students: [ { name: 'Bluto Blutarsky', gpa: 0.0 },
+                                   { name: 'Tracey Flick',    gpa: 4.0 } ])
+    puts result
+    exp =<<TXT
+<p>
+Name: Bluto Blutarsky<br/>
+GPA: 0.0
+</p>
+<p>
+Name: Tracey Flick<br/>
+GPA: 4.0
+</p>
+TXT
+    assert_equal exp, result
+  end
-    assert true   # assume it's alright if we get here
-  end
+  def test_escape
+   t = HtmlTemplate.new( <<TXT )
+<TMPL_LOOP pubs>
+Name: <TMPL_VAR name>
+Name: <TMPL_VAR name ESCAPE=HTML>
+Name: <TMPL_VAR name ESCAPE="HTML">
+Name: <TMPL_VAR name ESCAPE='HTML'>
+</TMPL_LOOP>
+TXT
+   exp =<<TXT
+Name: Fuller's Ale & Pie House
+Name: Fuller&#39;s Ale &amp; Pie House
+Name: Fuller&#39;s Ale &amp; Pie House
+Name: Fuller&#39;s Ale &amp; Pie House
+Name: Mel's Craft Beers & Diner
+Name: Mel&#39;s Craft Beers &amp; Diner
+Name: Mel&#39;s Craft Beers &amp; Diner
+Name: Mel&#39;s Craft Beers &amp; Diner
+TXT
+   assert_equal exp, t.render( pubs: [{ name: "Fuller's Ale & Pie House"  },
+                                      { name: "Mel's Craft Beers & Diner" }])
 end
+end # class TestMerge

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-template
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -58,7 +58,6 @@ files:
 - test/templates/opml.xml
 - test/templates/opml.xml.erb
 - test/templates/opml.xml.tmpl
-- test/templates/planet/README.md
 - test/templates/planet/atom.xml.tmpl
 - test/templates/planet/basic/index.html.tmpl
 - test/templates/planet/fancy/index.html.tmpl

data/test/templates/planet/README.md DELETED Viewed

@@ -1,7 +0,0 @@
-# Notes on (Original) Planet HTML Templates
-see <https://people.gnome.org/~jdub/bzr/planet/devel/trunk/examples/>