html-template 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99e549ccfeeab65c5a307442d82910d2c69fa03a
-  data.tar.gz: c7f0bf3e17141ea27250e99ea184c61a8f85fa96
+  metadata.gz: 9da6acb71081dfa21baa90d4993b4b91e777bc49
+  data.tar.gz: 43f3da8d115fb179536ed7726256c67a020c6537
 SHA512:
-  metadata.gz: e3a4b8328958f8934858ec3d62f906e40ce0ebc74638101bca301656319c20560ae6c748892b6ee6f0ceaa6281d063a64d256628955ab49b951ecd11a0474ddd
-  data.tar.gz: b225712c8e413f29d4f9e76fc35c8fa38106e32cb062c77f6695e544980c087d2f733b3ebe55873bdcf98809f22f9741e9075165ef25e2e1354679a481e63d18
+  metadata.gz: 967ba68efbbee4e8b512ed7cbaf58a78fc32b9ac387ede73a0aac3c696442de6a1e70187561451a85459af1ea5876850985f3228d0db96d8fe606177a4b64b2d
+  data.tar.gz: c03eebe9085e73da5aaa2b118478404a2d6515df901d642aa50e78768191055dc9638c6f67376d0ba0b69e65cdcaae8da1a68412b28416b9b403d99dc3fb9357

data/Manifest.txt

@@ -15,4 +15,5 @@ test/templates/planet/foafroll.xml.tmpl
 test/templates/planet/opml.xml.tmpl
 test/templates/planet/rss10.xml.tmpl
 test/templates/planet/rss20.xml.tmpl
+test/test_loop.rb
 test/test_merge.rb

data/README.md

@@ -16,7 +16,7 @@ Note: The original [`HTML::Template`](https://metacpan.org/pod/HTML::Template) p
 (in Perl with a first 1.0 release in 1999!)
 and the documentation here
 is mostly a copy from the original
-with some changes / adoptions for
+with some changes / adaptions for
 the ruby version.
 
 

data/lib/html/template.rb

@@ -9,21 +9,84 @@ require 'fileutils'
 
 
 module Enumerable
-   class LoopMeta
-     def initialize( total )
-       @total = total
-       @index = 0
-     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
+  class LoopMeta
+    def initialize( total )
+      @total = total
+    end
+
+    def index=(value)
+      @index   = value;
+      @counter = @index+1
+
+      ## assume first item (index 0/counter 1) is odd - why? why not?
+      ## 0 % 2  => 0   (odd)  -- first
+      ## 1 % 2  => 1   (even) -- second
+      ## 2 % 2  => 0
+      ## 3 % 2  => 1
+      ## etc.
+      @odd     = (@index % 2) == 0
+      @even    = !@odd
+
+      if @index == 0
+          @first = true
+          @inner = false
+          @outer = true
+          @last  = (@total-1) == 0
+      elsif @index == (@total-1)
+          @first = false
+          @inner = false
+          @outer = true
+          @last  = true
+      else
+          @first = false
+          @inner = true
+          @outer = false
+          @last  = false
+      end
+    end
+
+    attr_reader :index
+    attr_reader :counter
+    attr_reader :odd
+    attr_reader :even
+    attr_reader :first
+    attr_reader :inner
+    attr_reader :outer
+    attr_reader :last
+
+    alias_method :odd?,   :odd
+    alias_method :even?,  :even
+    alias_method :first?, :first
+    alias_method :inner?, :inner
+    alias_method :outer?, :outer
+    alias_method :last?,  :last
+
+    alias_method :__index__,   :index
+    alias_method :__counter__, :counter
+    alias_method :__odd__,     :odd
+    alias_method :__even__,    :even
+    alias_method :__first__,   :first
+    alias_method :__inner__,   :inner
+    alias_method :__outer__,   :outer
+    alias_method :__last__,    :last
+
+    alias_method :__INDEX__,   :index
+    alias_method :__COUNTER__, :counter
+    alias_method :__ODD__,     :odd
+    alias_method :__EVEN__,    :even
+    alias_method :__FIRST__,   :first
+    alias_method :__INNER__,   :inner
+    alias_method :__OUTER__,   :outer
+    alias_method :__LAST__,    :last
+  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
 
 
@@ -38,28 +101,28 @@ 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
@@ -88,7 +151,7 @@ class HtmlTemplate
     if @errors.size > 0
       puts "!! ERROR - #{@errors.size} conversion / syntax error(s):"
       pp @errors
-      
+
       raise     if strict? ## todo - find a good Error - StandardError - why? why not?
     end
 
@@ -105,10 +168,10 @@ class HtmlTemplate
                  (?<ident>#{IDENT})
                  (\s+
                    (?<escape>ESCAPE)
-                      =(
+                      \s*=\s*(
                           (?<q>['"])(?<format>#{ESCAPES})\k<q>  # note: allow single or double enclosing quote (but MUST match)
                         |  (?<format>#{ESCAPES})              # note: support without quotes too
-                       )   
+                       )
                  )?
                >}x
 
@@ -246,11 +309,27 @@ class HtmlTemplate
                   ctx = if stack.empty?
                           ''
                         else
+                           ## check for special loop variables
+                           if loop_vars? &&
+                              ['__INDEX__',
+                               '__COUNTER__',
+                               '__INDEX__',
+                               '__COUNTER__',
+                               '__ODD__',
+                               '__EVEN__',
+                               '__FIRST__',
+                               '__INNER__',
+                               '__OUTER__',
+                               '__LAST__'
+                              ].include?( ident )
+                             "#{ident_to_loop_it( stack[-1] )}_loop."
+                           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] )}."
+                             "#{ident_to_loop_it( stack[-1] )}."
+                           end
                         end
 
                   code = if tag == 'VAR'

data/lib/html/template/version.rb

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

data/test/test_loop.rb

@@ -0,0 +1,228 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_loop.rb
+
+require 'helper'
+
+
+
+class TestLoop < MiniTest::Test
+
+def test_loop_meta
+  [].each_with_loop do |item, item_loop|
+    assert false   ## empty loop; fail/error if we get here
+  end
+
+  [{index:   0,
+    counter: 1,
+    odd:     true,
+    even:    false,
+    first:   true,
+    inner:   false,
+    outer:   true,
+    last:    true}].each_with_loop do |item, item_loop|
+      assert_equal item[:index],   item_loop.index
+      assert_equal item[:counter], item_loop.counter
+      assert                       item_loop.odd?   == item[:odd]
+      assert                       item_loop.even?  == item[:even]
+      assert                       item_loop.first? == item[:first]
+      assert                       item_loop.inner? == item[:inner]
+      assert                       item_loop.outer? == item[:outer]
+      assert                       item_loop.last?  == item[:last]
+  end
+
+  [{index:   0,
+    counter: 1,
+    odd:     true,
+    even:    false,
+    first:   true,
+    inner:   false,
+    outer:   true,
+    last:    false},
+   {index:   1,
+    counter: 2,
+    odd:     false,
+    even:    true,
+    first:   false,
+    inner:   true,
+    outer:   false,
+    last:    false},
+   {index:   2,
+    counter: 3,
+    odd:     true,
+    even:    false,
+    first:   false,
+    inner:   false,
+    outer:   true,
+    last:    true}].each_with_loop do |item, item_loop|
+      assert_equal item[:index],   item_loop.index
+      assert_equal item[:counter], item_loop.counter
+      assert                       item_loop.odd?   == item[:odd]
+      assert                       item_loop.even?  == item[:even]
+      assert                       item_loop.first? == item[:first]
+      assert                       item_loop.inner? == item[:inner]
+      assert                       item_loop.outer? == item[:outer]
+      assert                       item_loop.last?  == item[:last]
+  end
+end
+
+
+def test_loop_example
+  t = HtmlTemplate.new( <<TXT )
+<TMPL_LOOP foos>
+<TMPL_IF __FIRST__>
+This only outputs on the first pass.
+</TMPL_IF>
+<TMPL_IF __ODD__>
+This outputs every other pass, on the odd passes.
+</TMPL_IF>
+<TMPL_UNLESS __ODD__>
+This outputs every other pass, on the even passes.
+</TMPL_UNLESS>
+<TMPL_IF __INNER__>
+This outputs on passes that are neither first nor last.
+</TMPL_IF>
+
+This is pass number <TMPL_VAR __COUNTER__>.
+
+<TMPL_IF __LAST__>
+This only outputs on the last pass.
+</TMPL_IF>
+</TMPL_LOOP>
+TXT
+
+  pp t.names
+  puts "---"
+
+  puts t.text
+  puts "---"
+
+  assert_equal <<TXT, t.text
+<% foos.each_with_loop do |foo, foo_loop| %>
+<% if foo_loop.__FIRST__ %>
+This only outputs on the first pass.
+<% end %>
+<% if foo_loop.__ODD__ %>
+This outputs every other pass, on the odd passes.
+<% end %>
+<% unless foo_loop.__ODD__ %>
+This outputs every other pass, on the even passes.
+<% end %>
+<% if foo_loop.__INNER__ %>
+This outputs on passes that are neither first nor last.
+<% end %>
+
+This is pass number <%= foo_loop.__COUNTER__ %>.
+
+<% if foo_loop.__LAST__ %>
+This only outputs on the last pass.
+<% end %>
+<% end %>
+TXT
+
+  result = t.render( foos: [{ name: 'Dave Grohl' },
+                            { name: 'Nate Mendel' },
+                            { name: 'Pat Smear' },
+                            { name: 'Taylor Hawkins' },
+                            { name: 'Chris Shiflett' },
+                            { name: 'Rami Jaffee' }] )
+  puts result
+
+  assert_equal <<TXT, result
+This only outputs on the first pass.
+This outputs every other pass, on the odd passes.
+
+This is pass number 1.
+
+This outputs every other pass, on the even passes.
+This outputs on passes that are neither first nor last.
+
+This is pass number 2.
+
+This outputs every other pass, on the odd passes.
+This outputs on passes that are neither first nor last.
+
+This is pass number 3.
+
+This outputs every other pass, on the even passes.
+This outputs on passes that are neither first nor last.
+
+This is pass number 4.
+
+This outputs every other pass, on the odd passes.
+This outputs on passes that are neither first nor last.
+
+This is pass number 5.
+
+This outputs every other pass, on the even passes.
+
+This is pass number 6.
+
+This only outputs on the last pass.
+TXT
+end
+
+
+def test_loop_inner
+  t = HtmlTemplate.new( <<TXT )
+<TMPL_LOOP feeds>
+  <TMPL_VAR title>
+  <TMPL_VAR updated>
+  <TMPL_LOOP items>
+    <TMPL_VAR title>
+    <TMPL_VAR updated>
+  </TMPL_LOOP>
+</TMPL_LOOP>
+TXT
+
+  pp t.names
+  puts "---"
+
+  puts t.text
+  puts "---"
+
+  assert_equal <<TXT, t.text
+<% feeds.each_with_loop do |feed, feed_loop| %>
+  <%= feed.title %>
+  <%= feed.updated %>
+  <% feed.items.each_with_loop do |item, item_loop| %>
+    <%= item.title %>
+    <%= item.updated %>
+  <% end %>
+<% end %>
+TXT
+
+  result = t.render( feeds: [{ title: 'Feed 1', updated: Date.new(2010,1,3),
+                               items: [{ title: 'Item 1.1', updated: Date.new(2010,1,1)},
+                                       { title: 'Item 1.2', updated: Date.new(2010,1,2)}]},
+                             { title: 'Feed 2', updated: Date.new(2020,1,3),
+                               items: [{ title: 'Item 2.1', updated: Date.new(2020,1,1)},
+                                       { title: 'Item 2.2', updated: Date.new(2020,1,2)}]}] )
+
+  result = result.gsub( /^[ ]+$/, '' )   ## note: remove spaces in empty lines (only with spaces)
+  puts result
+
+  assert_equal <<TXT, result
+  Feed 1
+  2010-01-03
+
+    Item 1.1
+    2010-01-01
+
+    Item 1.2
+    2010-01-02
+
+  Feed 2
+  2020-01-03
+
+    Item 2.1
+    2020-01-01
+
+    Item 2.2
+    2020-01-02
+
+TXT
+end
+
+
+end # class TestLoop

data/test/test_merge.rb

@@ -93,7 +93,7 @@ TXT
                                    { name: 'Tracey Flick',    gpa: 4.0 } ])
     puts result
 
-    exp =<<TXT
+    assert_equal <<TXT, result
 <p>
 Name: Bluto Blutarsky<br/>
 GPA: 0.0
@@ -103,12 +103,10 @@ Name: Tracey Flick<br/>
 GPA: 4.0
 </p>
 TXT
- 
-    assert_equal exp, result    
   end
 
 
-  def test_escape  
+  def test_escape
    t = HtmlTemplate.new( <<TXT )
 <TMPL_LOOP pubs>
 Name: <TMPL_VAR name>
@@ -119,7 +117,7 @@ Name: <TMPL_VAR name ESCAPE='HTML'>
 </TMPL_LOOP>
 TXT
 
-   exp =<<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
@@ -132,8 +130,8 @@ 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" }]) 
+   assert_equal exp, t.render( pubs: [{ name: "Fuller's Ale & Pie House"  },
+                                      { name: "Mel's Craft Beers & Diner" }])
 end
 
 end # class TestMerge

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-template
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -65,6 +65,7 @@ files:
 - test/templates/planet/opml.xml.tmpl
 - test/templates/planet/rss10.xml.tmpl
 - test/templates/planet/rss20.xml.tmpl
+- test/test_loop.rb
 - test/test_merge.rb
 homepage: https://github.com/feedreader/pluto
 licenses: