pseudohikiparser 0.0.0.10.develop → 0.0.0.11.develop

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b41d1dc1538c8a205df9d0e3674ce36cfe7a269
+  data.tar.gz: 4d41b79b26ea37bac306dcb392f9e413dfab0be5
+SHA512:
+  metadata.gz: ad7e6d96413aebd099166d449b57c83ca4a816130daef33ed962c3d87f02d1fad5afeb1b7aed576034bb600121fe61590ebe0b4ec15d3f4daedcea7bc048f962
+  data.tar.gz: 0320942f7181a5c045ea2a28d41a932ee0508d6dc5f438958e3e539a05861efd9f5c908d37f05ae8062551df174dfca8e4c5a69c9803b31d70e08dbc55877cd4

data/README.md

@@ -25,7 +25,6 @@ BSD 2-Clause License
 gem install pseudohikiparser --pre
 ```
 
-
 ## Usage
 
 ### Samples
@@ -34,7 +33,6 @@ gem install pseudohikiparser --pre
 
 You will find those samples in [develop branch](https://github.com/nico-hn/PseudoHikiParser/tree/develop/samples).
 
-
 ### pseudohiki2html.rb
 
 After the installation of PseudoHikiParser, you could use a command: **pseudohiki2html.rb**.
@@ -75,6 +73,7 @@ The first paragraph
 </body>
 </html>
 ```
+
 And if you specify a file name with `--output` option:
 
 ```
@@ -83,6 +82,7 @@ pseudohiki2html.rb --output first_example.html <<TEXT
 The first paragraph
 TEXT
 ```
+
 the result will be saved in first_example.html.
 
 For more options, please try `pseudohiki2html.rb --help`
@@ -166,6 +166,7 @@ If you add [name_of_id], just after the marks that denote heading or list type i
 
 *[list_id]list
 ```
+
 will be rendered as
 
 ```html
@@ -280,6 +281,8 @@ The first paragraph
 
 ### Experimental
 
+#### Escaping tags for inline decorations
+
 Tags for inline decorations are escaped when they are enclosed in plugin tags:
 
 ```
@@ -288,11 +291,37 @@ And {{ {}} and {{} }} should be rendered as two left curly braces and two right
 ```
 
 will be rendered as
+
 ```
 For example, '' or == can be escaped.
 And {{ and }} sould be rendered as two left curly braces and two right curly braces respectively.
 ```
 
+#### Decorator for blocks
+
+By lines that begin with '//@', you can assign certain attributes to its succeeding block.
+
+For example,
+
+```
+//@class[class_name]
+!!A section with a class name
+
+paragraph
+```
+
+will be renderes as
+
+```
+<div class="class_name">
+<h2>A section with a class name
+</h2>
+<p>
+paragraph
+</p>
+<!-- end of class_name -->
+</div>
+```
 
 ### Not Implemented Yet
 

data/lib/pseudohiki/blockparser.rb

@@ -38,15 +38,15 @@ module PseudoHiki
     end
 
     class BlockStack < TreeStack
-      def pop
-        self.current_node.parse_leafs
-        super
+      def pop_with_breaker(breaker=nil)
+        self.current_node.parse_leafs(breaker)
+        pop
       end
     end
 
     class BlockLeaf < BlockStack::Leaf
       @@head_re = {}
-      attr_accessor :nominal_level, :node_id
+      attr_accessor :nominal_level, :node_id, :decorator
 
       def self.head_re=(head_regex)
         @@head_re[self] = head_regex
@@ -91,7 +91,7 @@ module PseudoHiki
         super(stack)
       end
 
-      def parse_leafs
+      def parse_leafs(breaker)
         parsed = InlineParser.parse(self.join)
         self.clear
         self.concat(parsed)
@@ -146,6 +146,11 @@ module PseudoHiki
         first.nominal_level
       end
 
+      def decorator
+        return nil unless first
+        first.decorator
+      end
+
       def push_self(stack)
         @stack = stack
         super(stack)
@@ -155,7 +160,7 @@ module PseudoHiki
         not (kind_of?(breaker.block) and nominal_level == breaker.nominal_level)
       end
 
-      def parse_leafs; end
+      def parse_leafs(breaker); end
 
       def in_link_tag?(preceding_str)
         preceding_str[-2, 2] == "[[" or preceding_str[-1, 1] == "|"
@@ -167,7 +172,7 @@ module PseudoHiki
 
       def add_leaf(line, blockparser)
         leaf = create_leaf(line, blockparser)
-        blockparser.stack.pop while blockparser.breakable?(leaf)
+        blockparser.stack.pop_with_breaker(leaf) while blockparser.breakable?(leaf)
         blockparser.stack.push leaf
       end
 
@@ -179,8 +184,8 @@ module PseudoHiki
     end
 
     class NonNestedBlockNode < BlockNode
-      def parse_leafs
-        self.each {|leaf| leaf.parse_leafs }
+      def parse_leafs(breaker)
+        self.each {|leaf| leaf.parse_leafs(breaker) }
       end
     end
 
@@ -200,11 +205,11 @@ module PseudoHiki
 
     module BlockElement
       {
-        BlockLeaf => %w(DescLeaf VerbatimLeaf TableLeaf CommentOutLeaf BlockNodeEnd HrLeaf),
+        BlockLeaf => %w(DescLeaf VerbatimLeaf TableLeaf CommentOutLeaf BlockNodeEnd HrLeaf DecoratorLeaf),
         NonNestedBlockLeaf => %w(QuoteLeaf ParagraphLeaf),
         NestedBlockLeaf => %w(HeadingLeaf),
         ListTypeLeaf => %w(ListLeaf EnumLeaf),
-        BlockNode => %w(DescNode VerbatimNode TableNode CommentOutNode HrNode),
+        BlockNode => %w(DescNode VerbatimNode TableNode CommentOutNode HrNode DecoratorNode),
         NonNestedBlockNode => %w(QuoteNode ParagraphNode),
         NestedBlockNode => %w(HeadingNode),
         ListTypeBlockNode => %w(ListNode EnumNode),
@@ -223,15 +228,43 @@ module PseudoHiki
       attr_accessor :in_block_tag
 
       def add_leaf(line, blockparser)
-        return @stack.pop if LINE_PAT::VERBATIM_END =~ line
+        return @stack.pop_with_breaker if LINE_PAT::VERBATIM_END =~ line
         return super(line, blockparser) unless @in_block_tag
         line = " ".concat(line) if BlockElement::BlockNodeEnd.head_re =~ line and not @in_block_tag
         @stack.push BlockElement::VerbatimLeaf.create(line, @in_block_tag)
       end
     end
 
+    class BlockElement::DecoratorNode
+      DECORATOR_PAT = /\A(?:([^\[\]:]+))?(?:\[([^\[\]]+)\])?(?::\s*(\S.*))?/o
+
+      class DecoratorItem < Struct.new(:string, :type, :id, :value)
+        def initialize(*args)
+          super
+          self.value = InlineParser.parse(self.value) if self.value
+        end
+      end
+
+      def parse_leafs(breaker)
+        decorator = {}
+        breaker.decorator = decorator
+        @stack.remove_current_node.each do |leaf|
+          m = DECORATOR_PAT.match(leaf.join)
+          return nil unless m
+          item = DecoratorItem.new(*(m.to_a))
+          decorator[item.type||:id] = item
+        end
+      end
+
+      def breakable?(breaker)
+        return super if breaker.kind_of?(BlockElement::DecoratorLeaf)
+        parse_leafs(breaker)
+        @stack.current_node.breakable?(breaker)
+      end
+    end
+
     class BlockElement::QuoteNode
-      def parse_leafs
+      def parse_leafs(breaker)
         self[0] = BlockParser.parse(self[0])
       end
     end
@@ -289,7 +322,8 @@ module PseudoHiki
      [ParagraphLeaf, ParagraphNode],
      [HrLeaf, HrNode],
      [ListLeaf, ListNode],
-     [EnumLeaf, EnumNode]
+     [EnumLeaf, EnumNode],
+     [DecoratorLeaf, DecoratorNode]
     ].each do |leaf, node|
       ParentNode[leaf] = node
     end
@@ -316,6 +350,7 @@ module PseudoHiki
       end
       HrLeaf.head_re = Regexp.new(/\A(----)\s*$/o)
       BlockNodeEnd.head_re = Regexp.new(/^(\r?\n?)$/o)
+      DecoratorLeaf.head_re = Regexp.new(/^(\/\/@)/o)
       Regexp.new('\\A('+head_pats.join('|')+')')
     end
     HEAD_RE = assign_head_re
@@ -333,7 +368,7 @@ module PseudoHiki
     end
 
     def select_leaf_type(line)
-      [BlockNodeEnd, HrLeaf].each {|leaf| return leaf if leaf.head_re =~ line }
+      [BlockNodeEnd, HrLeaf, DecoratorLeaf].each {|leaf| return leaf if leaf.head_re =~ line }
       matched = HEAD_RE.match(line)
       return HeadToLeaf[matched[0]]||HeadToLeaf[line[0, 1]] || HeadToLeaf['\s'] if matched
       ParagraphLeaf
@@ -342,7 +377,7 @@ module PseudoHiki
     def read_lines(lines)
       each_line = lines.respond_to?(:each_line) ? :each_line : :each
       lines.send(each_line) {|line| @stack.current_node.add_leaf(line, self) }
-      @stack.pop
+      @stack.pop_with_breaker
     end
   end
 end

data/lib/pseudohiki/htmlformat.rb

@@ -57,6 +57,7 @@ module PseudoHiki
 
     def visit(tree)
       htmlelement = create_self_element(tree)
+      decorate(htmlelement, tree)
       push_visited_results(htmlelement, tree)
       htmlelement
     end
@@ -74,6 +75,21 @@ module PseudoHiki
       chunks.push tree
     end
 
+    def decorate(htmlelement, tree)
+      each_decorator(htmlelement, tree) do |element, decorator|
+        element[CLASS] = HtmlElement.escape(decorator[CLASS].id) if decorator[CLASS]
+        if id_item = decorator[ID]||decorator[:id]
+          element[ID] = HtmlElement.escape(id_item.id).upcase
+        end
+      end
+    end
+
+    def each_decorator(element, tree)
+      return unless element.kind_of? HtmlElement
+      return unless tree.kind_of? BlockParser::BlockNode and tree.decorator
+      tree.decorator.tap {|decorator| yield element, decorator }
+    end
+
     class ListLeafNodeFormatter < self
       def create_self_element(tree)
         super(tree).tap do |element|
@@ -170,6 +186,14 @@ module PseudoHiki
 
     #for BlockParser
 
+    class << Formatter[TableNode]
+      def decorate(htmlelement, tree)
+        each_decorator(htmlelement, tree) do |element, decorator|
+          htmlelement["summary"] = HtmlElement.escape(decorator["summary"].value.join) if decorator["summary"]
+        end
+      end
+    end
+
     class << Formatter[VerbatimNode]
       def visit(tree)
         create_self_element.tap do |element|

data/lib/pseudohiki/markdownformat.rb

@@ -243,13 +243,14 @@ module PseudoHiki
     class VerbatimNodeFormatter < self
       def visit(tree)
         element = super(tree)
+        @language_name = language_name(tree)
         return gfm_verbatim(element) if @options.gfm_style
         md_verbatim(element)
       end
 
       def gfm_verbatim(element)
         element.tap do |lines|
-          lines.unshift "```#{$/}"
+          lines.unshift "```#{@language_name + $/}"
           lines.push "```#{$/ * 2}"
         end
       end
@@ -257,6 +258,12 @@ module PseudoHiki
       def md_verbatim(element)
         element.join.gsub(/^/o, "    ").sub(/    \Z/o, "").concat $/
       end
+
+      def language_name(tree)
+        tree.decorator.tap do |decorator|
+          return decorator ? decorator["code"].id : ""
+        end
+      end
     end
 
     class QuoteNodeFormatter < self

data/lib/pseudohiki/version.rb

@@ -1,3 +1,3 @@
 module PseudoHiki
-  VERSION = "0.0.0.10.develop"
+  VERSION = "0.0.0.11.develop"
 end

data/test/test_blockparser.rb

@@ -311,6 +311,35 @@ TEXT
     assert_equal([[[["heading"]]]],parsed)
   end
 
+
+  def test_decorator
+    text = <<TEXT
+//@class[section_name]
+!!title of section
+
+//@summary: Summary of the table
+||!header 1||! header 2
+||cell 1||cell 2
+
+a paragraph.
+
+//@class[class_name]
+//@[id_name]
+another paragraph.
+TEXT
+
+    tree = PseudoHiki::BlockParser.parse(text.lines.to_a.map {|line| line.chomp })
+    assert_equal(PseudoHiki::BlockParser::BlockNode, tree.class)
+    assert_equal("section_name", tree[0].decorator["class"].id)
+    assert_equal(PseudoHiki::BlockParser::BlockElement::HeadingNode, tree[0].class)
+    assert_equal('[[["title of section"]], [[[["header 1"]], [[" header 2"]]], [[["cell 1"]], [["cell 2"]]]], [[["a paragraph."]]], [[["another paragraph."]]]]', tree[0].to_s)
+    assert_equal('[["Summary of the table"]]', tree[0][1].decorator["summary"].value.to_s)
+    assert_equal(PseudoHiki::BlockParser::BlockElement::TableNode, tree[0][1].class)
+    assert_equal(nil, tree[0][2].decorator)
+    assert_equal('id_name', tree[0][3].decorator[:id].id)
+    assert_equal('class_name', tree[0][3].decorator["class"].id)
+  end
+
   def test_comment_out_followed_by_a_verbatim_block
     text = <<TEXT
 the first paragraph

data/test/test_htmlformat.rb

@@ -668,6 +668,69 @@ HTML
     assert_equal(xhtml, XhtmlFormat.format(tree).to_s)
   end
 
+  def test_decorator
+    text = <<TEXT
+//@class[section_type]
+!!title of section
+
+a paragraph.
+
+//@class[class_name]
+//@id[id_name]
+another paragraph.
+TEXT
+
+    xhtml = <<HTML
+<div class="section_type">
+<h2>title of section</h2>
+<p>
+a paragraph.</p>
+<p class="class_name" id="ID_NAME">
+another paragraph.</p>
+<!-- end of section_type -->
+</div>
+HTML
+    tree = BlockParser.parse(text.lines.to_a.map {|line| line.chomp })
+    assert_equal(xhtml, XhtmlFormat.format(tree).to_s)
+  end
+
+  def test_decorator_for_table
+    text = <<TEXT
+//@summary: Summary of the table
+||!header 1||! header 2
+||cell 1||cell 2
+TEXT
+
+    xhtml = <<HTML
+<table summary="Summary of the table">
+<tr><th>header 1</th><th> header 2</th></tr>
+<tr><td>cell 1</td><td>cell 2</td></tr>
+</table>
+HTML
+    tree = BlockParser.parse(text.lines.to_a.map {|line| line.chomp })
+    assert_equal(xhtml, XhtmlFormat.format(tree).to_s)
+  end
+
+  def test_decorator_for_verbatim
+    text = <<TEXT
+//@code[ruby]
+ def bonjour!
+   puts "Bonjour!"
+ end
+TEXT
+
+    xhtml = <<HTML
+<pre>
+def bonjour!
+  puts &quot;Bonjour!&quot;
+end
+</pre>
+HTML
+
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(xhtml, XhtmlFormat.format(tree).to_s)
+  end
+
   def test_comment_out_followed_by_a_verbatim_block
     text = <<TEXT
 the first paragraph

data/test/test_markdownformat.rb

@@ -501,5 +501,65 @@ TEXT
     tree = BlockParser.parse(text.lines.to_a)
     assert_equal(md_text, @formatter.format(tree).to_s)
   end
+
+  def test_decorator_for_verbatim
+    text = <<TEXT
+//@code[ruby]
+ def bonjour!
+   puts "Bonjour!"
+ end
+TEXT
+
+    gfm_text =<<TEXT
+```ruby
+def bonjour!
+  puts "Bonjour!"
+end
+```
+
+TEXT
+
+    md_text = <<TEXT
+    def bonjour!
+      puts "Bonjour!"
+    end
+
+TEXT
+
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(gfm_text, @gfm_formatter.format(tree).to_s)
+    assert_equal(md_text, @formatter.format(tree).to_s)
+  end
+
+  def test_decorator_for_verbatim_block
+    text = <<TEXT
+//@code[ruby]
+<<<
+def bonjour!
+  puts "Bonjour!"
+end
+>>>
+TEXT
+
+    gfm_text =<<TEXT
+```ruby
+def bonjour!
+  puts "Bonjour!"
+end
+```
+
+TEXT
+
+    md_text = <<TEXT
+    def bonjour!
+      puts "Bonjour!"
+    end
+
+TEXT
+
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(gfm_text, @gfm_formatter.format(tree).to_s)
+    assert_equal(md_text, @formatter.format(tree).to_s)
+  end
 end
 

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pseudohikiparser
 version: !ruby/object:Gem::Version
-  version: 0.0.0.10.develop
-  prerelease: 9
+  version: 0.0.0.11.develop
 platform: ruby
 authors:
 - HASHIMOTO, Naoki
@@ -14,49 +13,43 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: PseudoHikiParser is a parser of texts written in a Hiki like notation,
@@ -68,54 +61,53 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - LICENSE
-- lib/pseudohikiparser.rb
-- lib/pseudohiki/treestack.rb
-- lib/pseudohiki/inlineparser.rb
+- README.md
+- bin/pseudohiki2html.rb
+- lib/htmlelement.rb
+- lib/htmlelement/htmltemplate.rb
 - lib/pseudohiki/blockparser.rb
 - lib/pseudohiki/htmlformat.rb
-- lib/pseudohiki/plaintextformat.rb
+- lib/pseudohiki/htmlplugin.rb
+- lib/pseudohiki/inlineparser.rb
 - lib/pseudohiki/markdownformat.rb
+- lib/pseudohiki/plaintextformat.rb
+- lib/pseudohiki/treestack.rb
 - lib/pseudohiki/version.rb
-- lib/pseudohiki/htmlplugin.rb
-- lib/htmlelement.rb
-- lib/htmlelement/htmltemplate.rb
-- test/test_htmltemplate.rb
+- lib/pseudohikiparser.rb
 - test/test_blockparser.rb
-- test/test_plaintextformat.rb
 - test/test_htmlelement.rb
-- test/test_treestack.rb
-- test/test_inlineparser.rb
-- test/test_markdownformat.rb
 - test/test_htmlformat.rb
 - test/test_htmlplugin.rb
-- bin/pseudohiki2html.rb
+- test/test_htmltemplate.rb
+- test/test_inlineparser.rb
+- test/test_markdownformat.rb
+- test/test_plaintextformat.rb
+- test/test_treestack.rb
 homepage: https://github.com/nico-hn/PseudoHikiParser/wiki
 licenses:
 - BSD 2-Clause license
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: ! 'PseudoHikiParser: a parser of texts in a Hiki like notation.'
+specification_version: 4
+summary: 'PseudoHikiParser: a parser of texts in a Hiki like notation.'
 test_files:
 - test/test_htmltemplate.rb
 - test/test_blockparser.rb