lilac 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d3e2ca3b43df7a9c39a3816d3c7907ab26a065e
-  data.tar.gz: 70e0b3f6bf5580dde30e6b7bae3de95f6e700301
+  metadata.gz: ee5d4180a4c8db8c7c6202b2cbf417e5b470c919
+  data.tar.gz: fc84747b276a3c216517546169a25031fedc7e61
 SHA512:
-  metadata.gz: b560d79a5f3b453dbeca6cce42df499fd0d66a38b121af329b29cf3a9227e4953178cd57aa5c68ed195c110c0889ac81df309906713f378f3834a80a19a38716
-  data.tar.gz: 339ae8c54e374c342558212e3aeb7c1afbe169bfb6dfe71a3f07f6d7e8580e694b66109c283cacb3d1d224ae927edb3890a3fce17f1f5abd1a02259d7d2decfb
+  metadata.gz: 1cab0cdfa60254edcd25e6e49e0218ed64e70388053f279862830cf9260a9a5a51f3588c07680c7ff3af18152ecc5a25779a44731eb8c9beb85f122ddd3392c8
+  data.tar.gz: f3aea5a2486a662dd3e52d0f8c04e1734088fb7b878984beb36f42b922e035783b233df92845315bc4fba3cd3a1fd8c66cdbbef96e7411fcac974779762bb397

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- 2.0.0
+- 2.1.5
+- 2.2.0
+notifications:
+email:
+recipients:
+- grauwoelfchen@gmail.com
+on_success: change
+on_failure: always

data/ChangeLog

@@ -1,6 +1,13 @@
 # ChangeLog for lilac
 # Copyright 2014,2015 Yasuhiro Asaka; Distributed under the MIT License
 
+  20 Mar 2015; Yasuhiro Asaka <grauwoelfchen@gmail.com> lilac/parser.rb,
+	lilac/renderer.rb, lilac/version.rb:
+	Fix list tag structure as standard HTML
+
+  21 Jan 2015; Yasuhiro Asaka <grauwoelfchen@gmail.com> +.travis.yml:
+	Enter travis CI
+
   21 Jan 2015; Yasuhiro Asaka <grauwoelfchen@gmail.com> +ChangeLog:
 	Add Homepage into gemspec and ChangeLog file.
 

data/README.md

@@ -1,5 +1,7 @@
 # Lilac
 
+[![Build Status](https://secure.travis-ci.org/grauwoelfchen/lilac.png)](http://travis-ci.org/grauwoelfchen/lilac)
+
 Lilac (luxury indented list another converter) is list converter
 that supports list styles of several lightweight markup languages.
 
@@ -12,6 +14,11 @@ that supports list styles of several lightweight markup languages.
 
 ## Installation
 
+```sh
+$ gem install lilac
+```
+
+
 ```sh
 $ git clone https://github.com/grauwoelfchen/lilac.git
 ```
@@ -31,7 +38,14 @@ text = <<TEXT
 TEXT
 
 list = Lilac::List.new(text)
-puts list.to_html #=> <ul><li>foo<li><li><ul><li>...</li></ul></li></ul>
+puts list.to_html #=>
+<ul>
+  <li>foo
+    <ul>
+      <li>...</li>
+    </ul>
+  </li>
+</ul>
 ```
 
 ### Command line
@@ -42,7 +56,13 @@ $ lilac
 ** bar
 *** baz
 ;; press ^D
-<ul><li>foo</li><li><ul><li>bar</li><li><ul><li>baz</li></ul></li></ul></li></ul>
+<ul>
+  <li>foo
+    <ul>
+      <li>...</li>
+    </ul>
+  </li>
+</ul>
 ```
 
 ### Supported list styles
@@ -69,11 +89,9 @@ $ lilac
 
 ;; p list.to_html
 <ul>
-  <li>foo</li>
-  <li>
+  <li>foo
     <ul>
-      <li>bar</li>
-      <li>
+      <li>bar
         <ul>
           <li>baz</li>
         </ul>
@@ -92,11 +110,9 @@ $ lilac
 
 ;; p list.to_html
 <ul>
-  <li>foo</li>
-  <li>
+  <li>foo
     <ul>
-      <li>bar</li>
-      <li>
+      <li>bar
         <ul>
           <li>baz</li>
         </ul>
@@ -106,6 +122,10 @@ $ lilac
 </ul>
 ```
 
+## Rendered List
+
+see [HTML lists - W3C Wiki](http://www.w3.org/wiki/HTML_lists#Nesting_lists)
+
 
 ## License
 

data/lib/lilac/parser.rb

@@ -32,28 +32,38 @@ module Lilac
       }
     end
 
+    # TODO
+    #   * remove magic number
+    #   * remove destructive method to reference
     def handle_line(line, acc)
       if line =~ /^(\*+)\s/
         level = $1.length
         text  = line.gsub($1, "")
         if level == 1
-          acc << [:li, handle_text(text)]
+          acc << [:li, [handle_text(text)]]
         elsif !acc.empty?
           cur = ul = acc
           # progression
-          #   **    -> 2
-          #   ***   -> 5
-          #   ****  -> 8
-          #   ***** -> 11
-          inspection = level * 3 - 4
+          #   **    ->  1
+          #   ***   ->  5
+          #   ****  ->  9
+          #   ***** -> 13
+          inspection = 1 + (4 * (level - 2))
           inspection.times { cur = cur.last if cur }
           case cur.first
           when :ul
-            cur.last << [:li, handle_text(text)]
+            cur.last << [:li, [handle_text(text)]]
           else
-            # current ul
-            (inspection - 2).times { ul = ul.last }
-            ul << [:li, [:ul, [[:li, handle_text(text)]]]]
+            sib = nil
+            begin; sib = cur.last.last.last.last; rescue NoMethodError; end
+            if sib && sib.first == :li
+              # apeend as siblings
+              cur = cur.last.last
+              cur[-1] += [[:li, [handle_text(text)]]]
+            else
+              # nest
+              cur[-1] += [[:ul, [[:li, [handle_text(text)]]]]]
+            end
           end
         end
       end

data/lib/lilac/renderer.rb

@@ -5,37 +5,25 @@ module Lilac
     end
 
     def render
-      @data.inject("") { |acc, (t, b)|
-        acc << build(t, b, 1)
-        acc
-      }.instance_eval { |rendered_list|
-        "<ul>#{rendered_list}</ul>"
-      }
+      build(:ul, @data)
     end
 
     private
 
-    def build(tag, block, lv=1)
+    def build(tag, block)
+      wrap(tag, block.inject("") { |acc, elems|
+        acc << elems.each_cons(2).map { |t, b|
+          t == :text ? b : build(t, b)
+        }.join
+        acc
+      })
+    end
+
+    def wrap(tag, content)
       case tag
-      when :ul
-        block.map { |t, b|
-          build(t, b, lv)
-        }.join.instance_eval { |li|
-          "<ul>#{li}</ul>"
-        }
-      when :li
-        case block.first
-        when :text
-          build(:text, "<li>" + block.last.to_s + "</li>")
-        when :ul
-          block.last.map { |t, b|
-            build(t, b, lv + 1)
-          }.join.instance_eval { |li|
-            "<li><ul>#{li}</ul></li>"
-          }
-        end
-      else # text
-        block
+      when :ul ; "<ul>#{content}</ul>"
+      when :li ; "<li>#{content}</li>"
+      else # pass
       end
     end
   end

data/lib/lilac/version.rb

@@ -1,3 +1,3 @@
 module Lilac
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/integration/asciidoc_test.rb

@@ -60,8 +60,7 @@ class AsciidocTest < Minitest::Test
     TEXT
     expected = <<-LIST.gsub(/\n|\s/, "")
     <ul>
-      <li>foo</li>
-      <li>
+      <li>foo
         <ul>
           <li>bar</li>
           <li>baz</li>
@@ -81,17 +80,44 @@ class AsciidocTest < Minitest::Test
     TEXT
     expected = <<-LIST.gsub(/\n|\s/, "")
     <ul>
-      <li>foo</li>
-      <li>
+      <li>foo
         <ul>
-          <li>bar</li>
-          <li>
+          <li>bar
+            <ul>
+              <li>baz</li>
+            </ul>
+          </li>
+        </ul>
+      </li>
+    </ul>
+    LIST
+    list = Lilac::List.new(text)
+    assert_equal expected, list.to_html
+  end
+
+  def test_asterisk_bullet_complicated_list
+    text = <<-TEXT.gsub(/^\s{4}/, "")
+    * foo
+    ** bar
+    *** baz
+    ** qux
+    ** quux
+    * bye
+    TEXT
+    expected = <<-LIST.gsub(/\n|\s/, "")
+    <ul>
+      <li>foo
+        <ul>
+          <li>bar
             <ul>
               <li>baz</li>
             </ul>
           </li>
+          <li>qux</li>
+          <li>quux</li>
         </ul>
       </li>
+      <li>bye</li>
     </ul>
     LIST
     list = Lilac::List.new(text)

data/test/integration/markdown_test.rb

@@ -61,8 +61,7 @@ class MarkdownTest < Minitest::Test
     TEXT
     expected = <<-LIST.gsub(/\n|\s/, "")
     <ul>
-      <li>foo</li>
-      <li>
+      <li>foo
         <ul>
           <li>bar</li>
           <li>baz</li>
@@ -82,11 +81,9 @@ class MarkdownTest < Minitest::Test
     TEXT
     expected = <<-LIST.gsub(/\n|\s/, "")
     <ul>
-      <li>foo</li>
-      <li>
+      <li>foo
         <ul>
-          <li>bar</li>
-          <li>
+          <li>bar
             <ul>
               <li>baz</li>
             </ul>

data/test/parser_test.rb

@@ -62,31 +62,49 @@ class Lilac::ParserTest < Minitest::Test
     acc = []
     parser.send(:handle_line, "* foo", acc)
     expected = [
-      [:li, [:text, "foo"]]
+      [:li, [
+        [:text, "foo"]
+      ]]
     ]
     assert_equal expected, acc
   end
 
   def test_should_extract_valid_1_level_depth_multiple_lines
     parser = Lilac::Parser.new
-    acc = [[:li, [:text, "foo"]]]
+    acc = [
+      [:li, [
+        [:text, "foo"]
+      ]]
+    ]
     parser.send(:handle_line, "* bar", acc)
     expected = [
-      [:li, [:text, "foo"]],
-      [:li, [:text, "bar"]]
+      [:li, [
+        [:text, "foo"]
+      ]],
+      [:li, [
+        [:text, "bar"]
+      ]]
     ]
     assert_equal expected, acc
   end
 
   def test_should_extract_valid_2_level_depth_lines
     parser = Lilac::Parser.new
-    acc = [[:li, [:text, "foo"]]]
+    acc = [
+      [:li, [
+        [:text, "foo"]
+      ]]
+    ]
     parser.send(:handle_line, "** bar", acc)
     expected = [
-      [:li, [:text, "foo"]],
-      [:li, [:ul, [
-        [:li, [:text, "bar"]]
-      ]]]
+      [:li, [
+        [:text, "foo"],
+        [:ul, [
+          [:li, [
+            [:text, "bar"]
+          ]]
+        ]]
+      ]]
     ]
     assert_equal expected, acc
   end
@@ -94,24 +112,76 @@ class Lilac::ParserTest < Minitest::Test
   def test_should_extract_valid_3_level_depth_lines
     parser = Lilac::Parser.new
     acc = [
-      [:li, [:text, "foo"]],
-      [:li, [:ul, [
-        [:li, [:text, "bar"]]]]
-      ]
+      [:li, [
+        [:text, "foo"],
+        [:ul, [
+          [:li, [
+            [:text, "bar"]
+          ]]
+        ]]
+      ]]
     ]
     parser.send(:handle_line, "*** baz", acc)
     expected = [
-      [:li, [:text, "foo"]],
-      [:li, [:ul, [
-        [:li, [:text, "bar"]],
-        [:li, [:ul, [
-          [:li, [:text, "baz"]]
-        ]]]
-      ]]]
+      [:li, [
+        [:text, "foo"],
+        [:ul, [
+          [:li, [
+            [:text, "bar"],
+            [:ul, [
+              [:li, [
+                [:text, "baz"]
+              ]]
+            ]]
+          ]]
+        ]]
+      ]]
     ]
     assert_equal expected, acc
   end
 
+  def test_should_extract_valid_4_level_depth_lines
+    parser = Lilac::Parser.new
+    acc = [
+      [:li, [
+        [:text, "foo"],
+        [:ul, [
+          [:li, [
+            [:text, "bar"],
+            [:ul, [
+              [:li, [
+                [:text, "baz"]
+              ]]
+            ]]
+          ]]
+        ]]
+      ]]
+    ]
+    parser.send(:handle_line, "**** qux", acc)
+    expected = [
+      [:li, [
+        [:text, "foo"],
+        [:ul, [
+          [:li, [
+            [:text, "bar"],
+            [:ul, [
+              [:li, [
+                [:text, "baz"],
+                [:ul, [
+                  [:li, [
+                    [:text, "qux"]
+                  ]]
+                ]]
+              ]]
+            ]]
+          ]]
+        ]]
+      ]]
+    ]
+    assert_equal expected, acc
+  end
+
+
   def test_should_remove_line_break
     parser = Lilac::Parser.new
     assert_equal [:text, "foo"], parser.send(:handle_text, "foo\n")

data/test/renderer_test.rb

@@ -1,42 +1,146 @@
 require "test_helper"
 
 class Lilac::RendererTest < Minitest::Test
-  def test_should_return_html_string
-    data = [[:li, [:text, "foo"]]]
-    renderer = Lilac::Renderer.new(data)
-    assert_instance_of String, renderer.render
-  end
-
   def test_should_raise_error_without_enumerable_data
     data = "invalid"
     renderer = Lilac::Renderer.new(data)
-    assert_raises NoMethodError do
+    assert_raises(NoMethodError) do
       renderer.render
     end
   end
 
-  def test_should_append_ul_tag
-    data = [[:li, [:text, "foo"]]]
+  def test_should_wrap_rendered_list_with_ul_tag
+    data = [[:li, [[:text, "bar"]]]]
     renderer = Lilac::Renderer.new(data)
-    expected = "<ul><li>foo</li></ul>"
-    assert_equal expected, renderer.render
+    expected = <<-HTML.gsub(/^\s*|\n/, "")
+      <ul>
+        <li>bar</li>
+      </ul>
+    HTML
+    assert_equal(expected, renderer.render)
   end
 
-  def test_should_build_ul_tag
+  # build
+
+  def test_should_build_text_tag
     renderer = Lilac::Renderer.new
-    expected = "<ul><li>foo</li></ul>"
-    assert_equal expected, renderer.send(:build, :ul, [[:li, [:text, "foo"]]])
+    expected = <<-HTML.gsub(/^\s*|\n/, "")
+      <li>foo</li>
+    HTML
+    block = [
+      [:text, "foo"]
+    ]
+    assert_equal(expected, renderer.send(:build, :li, block))
   end
 
   def test_should_build_li_tag
     renderer = Lilac::Renderer.new
-    expected = "<li>foo</li>"
-    assert_equal expected, renderer.send(:build, :li, [:text, "foo"])
+    expected = <<-HTML.gsub(/^\s*|\n/, "")
+      <ul>
+        <li>foo</li>
+      </ul>
+    HTML
+    block = [
+      [:li, [
+        [:text, "foo"]
+      ]]
+    ]
+    assert_equal expected, renderer.send(:build, :ul, block)
+  end
+
+  def test_should_build_multiple_li_tags
+    renderer = Lilac::Renderer.new
+    expected = <<-HTML.gsub(/^\s*|\n/, "")
+      <ul>
+        <li>foo</li>
+        <li>bar</li>
+      </ul>
+    HTML
+    block = [
+      [:li, [
+        [:text, "foo"]
+      ]],
+      [:li, [
+        [:text, "bar"]
+      ]]
+    ]
+    assert_equal expected, renderer.send(:build, :ul, block)
+  end
+
+  def test_should_build_ul_tag
+    renderer = Lilac::Renderer.new
+    expected = <<-HTML.gsub(/^\s*|\n/, "")
+      <ul>
+        <li>
+          <ul>foo</ul>
+        </li>
+      </ul>
+    HTML
+    block = [
+      [:li, [
+        [:ul, [
+          [:text, "foo"]
+        ]]
+      ]]
+    ]
+    assert_equal(expected, renderer.send(:build, :ul, block))
+  end
+
+  def test_should_build_nested_ul_tag
+    renderer = Lilac::Renderer.new
+    expected = <<-HTML.gsub(/^\s*|\n/, "")
+      <ul>
+        <li>foo
+          <ul>
+            <li>bar</li>
+          </ul>
+        </li>
+      </ul>
+    HTML
+    block = [
+      [:li, [
+        [:text, "foo"],
+        [:ul, [
+          [:li, [
+            [:text, "bar"]]]
+        ]]
+      ]]
+    ]
+    assert_equal(expected, renderer.send(:build, :ul, block))
   end
 
-  def test_should_build_plain_text
+  def test_should_build_deep_nested_ul_tag
     renderer = Lilac::Renderer.new
-    expected = "foo"
-    assert_equal expected, renderer.send(:build, :text, "foo")
+    expected = <<-HTML.gsub(/^\s*|\n/, "")
+      <ul>
+        <li>foo</li>
+        <li>bar
+          <ul>
+            <li>baz</li>
+            <li>qux
+              <ul>
+                <li>quux</li>
+              </ul>
+            </li>
+          </ul>
+        </li>
+      </ul>
+    HTML
+    block = [
+      [:li, [[:text, "foo"]]],
+      [:li, [
+        [:text, "bar"],
+        [:ul, [
+          [:li, [[:text, "baz"]]],
+          [:li, [
+            [:text, "qux"],
+            [:ul, [
+              [:li, [[:text, "quux"]]]
+            ]]
+          ]]
+        ]]
+      ]]
+    ]
+    assert_equal(expected, renderer.send(:build, :ul, block))
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lilac
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Yasuhiro Asaka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - ChangeLog
 - Gemfile
 - LICENSE.txt
@@ -101,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Luxury Indented List Another Converter