flannel 0.2.7 → 0.2.9

data/Rakefile

@@ -11,7 +11,10 @@ begin
     gem.homepage = "http://github.com/rubyyot/flannel"
     gem.authors = ["Jamal Hansen"]
     gem.rubyforge_project = "flannel"
-    gem.add_development_dependency ['shoulda', 'mocha']
+    gem.add_dependency 'treetop'
+    gem.add_dependency 'polyglot'
+    gem.add_development_dependency 'shoulda'
+    gem.add_development_dependency 'mocha'
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 2
-:patch: 7
+:patch: 9
 :build: 

data/features/fixtures/external_link.flannel

@@ -1,3 +1,4 @@
+:paragraph external_link_paragraph
 Lorem ipsum [dolor sit amet|http://www.example.com], consectetur adipiscing elit. Nam ac magna augue, a pretium magna. Aliquam erat volutpat.
 Proin malesuada, nunc vel [porttitor|www.example.com] [ commodo | http://www.example.com | nunc ], justo. Nam ac magna augue, a pretium magna. Aliquam erat volutpat.
 Proin malesuada, nunc vel [ porttitor | http://www.example.com ] commodo, justo.

data/features/fixtures/external_link.out

@@ -1,3 +1,3 @@
-<p>Lorem ipsum <a href="http://www.example.com" target="_blank">dolor sit amet</a>, consectetur adipiscing elit. Nam ac magna augue, a pretium magna. Aliquam erat volutpat.
+<p id='external_link_paragraph'>Lorem ipsum <a href="http://www.example.com" target="_blank">dolor sit amet</a>, consectetur adipiscing elit. Nam ac magna augue, a pretium magna. Aliquam erat volutpat.
 Proin malesuada, nunc vel <a href="http://www.example.com" target="_blank">porttitor</a> <a href="http://www.example.com" title="nunc" target="_blank">commodo</a>, justo. Nam ac magna augue, a pretium magna. Aliquam erat volutpat.
 Proin malesuada, nunc vel <a href="http://www.example.com" target="_blank">porttitor</a> commodo, justo.</p>

data/features/fixtures/feed.flannel

@@ -1,3 +1,5 @@
-& blog.rubyyot.com/tag/rubyyot/feed/rss
+:feed rubyyot
+blog.rubyyot.com/tag/rubyyot/feed/rss
 
-& http://devlicio.us/blogs/sergio_pereira/rss.aspx?Tags=JavaScript-Demystified&AndTags=1
+:feed javascript-demystified
+http://devlicio.us/blogs/sergio_pereira/rss.aspx?Tags=JavaScript-Demystified&AndTags=1

data/features/fixtures/feed.out

@@ -1,4 +1,4 @@
-<ul><li>
+<ul id='rubyyot'><li>
     <a href='http://blog.rubyyot.com/2009/05/summer-of-learning-challenge/'>Plans for Rubyyot.com and the Summer of Learning Challenge</a>
   </li>
   <li>
@@ -8,7 +8,7 @@
     <a href='http://blog.rubyyot.com/2009/03/rubyyotcom-is-dead-long-live-rubyyotcom/'>Rubyyot.com is dead; Long live Rubyyot.com</a>
   </li></ul>
 
-<ul><li>
+<ul id='javascript-demystified'><li>
     <a href='http://devlicio.us/blogs/sergio_pereira/archive/2009/09/19/javascript-and-its-love-for-zeroes.aspx'>JavaScript and its love for zeroes</a>
   </li>
   <li>

data/features/fixtures/list.flannel

@@ -1,3 +1,4 @@
-* Item one
-* Item two
-* This is the much longer item and this item is known simply as item three.
+:list test-list
+Item one
+Item two
+This is the much longer item and this item is known simply as item three.

data/features/fixtures/list.out

@@ -1,3 +1,3 @@
-<ul><li>Item one</li>
+<ul id='test-list'><li>Item one</li>
 <li>Item two</li>
 <li>This is the much longer item and this item is known simply as item three.</li></ul>

data/features/fixtures/paragraph.flannel

@@ -1,6 +1,8 @@
-
+:paragraph p_one
 This is paragraph one.
 
+:paragraph p_two
 This is paragraph two.
 
+:paragraph p_three
 This is paragraph three. Watchout for the end of file.

data/features/fixtures/paragraph.out

@@ -1,5 +1,5 @@
-<p>This is paragraph one.</p>
+<p id='p_one'>This is paragraph one.</p>
 
-<p>This is paragraph two.</p>
+<p id='p_two'>This is paragraph two.</p>
 
-<p>This is paragraph three. Watchout for the end of file.</p>
+<p id='p_three'>This is paragraph three. Watchout for the end of file.</p>

data/features/fixtures/preformatted.flannel

@@ -1,16 +1,18 @@
+:paragraph p_one
 This is a paragraph
 
-_   This is preformatted text
+:preformatted pre_one
+   This is preformatted text
         it's cool
 
    and Spiffy
-_
 
-_This is preformatted too
-_
+:preformatted pre_two
+This is preformatted too
 
-_
+
+:preformatted pre_three
  So is this
-_
 
+:paragraph p_two
 This is a paragraph

data/features/fixtures/preformatted.out

@@ -1,13 +1,19 @@
-<p>This is a paragraph</p>
+<p id='p_one'>This is a paragraph</p>
 
-<pre>   This is preformatted text
+<pre id='pre_one'>   This is preformatted text
         it's cool
 
-   and Spiffy</pre>
+   and Spiffy
 
-<pre>This is preformatted too</pre>
+</pre>
 
-<pre>
- So is this</pre>
+<pre id='pre_two'>This is preformatted too
 
-<p>This is a paragraph</p>
+
+</pre>
+
+<pre id='pre_three'> So is this
+
+</pre>
+
+<p id='p_two'>This is a paragraph</p>

data/features/fixtures/wiki_links.flannel

@@ -1,2 +1,3 @@
+:paragraph lorem
 Lorem ipsum -dolor sit amet>, consectetur adipiscing elit. Nam ac magna augue, a pretium magna. Aliquam erat volutpat.
 Proin malesuada, nunc vel -porttitor> commodo, justo. 

data/features/fixtures/wiki_links.out

@@ -1,2 +1,2 @@
-<p>Lorem ipsum <a href="dolor-sit-amet">dolor sit amet</a>, consectetur adipiscing elit. Nam ac magna augue, a pretium magna. Aliquam erat volutpat.
+<p id='lorem'>Lorem ipsum <a href="dolor-sit-amet">dolor sit amet</a>, consectetur adipiscing elit. Nam ac magna augue, a pretium magna. Aliquam erat volutpat.
 Proin malesuada, nunc vel <a href="porttitor">porttitor</a> commodo, justo.</p>

data/features/fixtures/wiki_links_for_lambda.flannel

@@ -1,2 +1,3 @@
+:paragraph lorem
 Lorem ipsum -dolor sit amet>, consectetur adipiscing elit. Nam ac magna augue, a pretium magna. Aliquam erat volutpat.
 Proin malesuada, nunc vel -porttitor> commodo, justo. 

data/features/fixtures/wiki_links_for_lambda.out

@@ -1,2 +1,2 @@
-<p>Lorem ipsum <a href="http://www.example.com/foo/dolor-sit-amet">dolor sit amet</a>, consectetur adipiscing elit. Nam ac magna augue, a pretium magna. Aliquam erat volutpat.
+<p id='lorem'>Lorem ipsum <a href="http://www.example.com/foo/dolor-sit-amet">dolor sit amet</a>, consectetur adipiscing elit. Nam ac magna augue, a pretium magna. Aliquam erat volutpat.
 Proin malesuada, nunc vel <a href="http://www.example.com/foo/porttitor">porttitor</a> commodo, justo.</p>

data/flannel.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flannel}
-  s.version = "0.2.7"
+  s.version = "0.2.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jamal Hansen"]
-  s.date = %q{2010-01-30}
+  s.date = %q{2010-02-23}
   s.email = %q{jamal.hansen@gmail.com}
   s.executables = ["quilt-it~", "quilt-it"]
   s.extra_rdoc_files = [
@@ -51,20 +51,23 @@ Gem::Specification.new do |s|
      "features/wiki_links.feature",
      "flannel.gemspec",
      "lib/flannel.rb",
+     "lib/flannel/base_block.rb",
+     "lib/flannel/block.treetop",
      "lib/flannel/block_cutter.rb",
      "lib/flannel/cache_location_does_not_exist_error.rb",
      "lib/flannel/feed_parser.rb",
      "lib/flannel/file_cache.rb",
      "lib/flannel/html_formatter.rb",
-     "lib/flannel/text_block.rb",
      "lib/flannel/wrappable.rb",
+     "test/base_block_html_generation_test.rb",
+     "test/base_block_test.rb",
      "test/block_cutter_test.rb",
+     "test/block_parser_test.rb",
      "test/feed_parser_test.rb",
      "test/file_cache_test.rb",
      "test/flannel_test.rb",
      "test/html_formatter_test.rb",
-     "test/test_helper.rb",
-     "test/text_block_test.rb"
+     "test/test_helper.rb"
   ]
   s.homepage = %q{http://github.com/rubyyot/flannel}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -77,9 +80,11 @@ Gem::Specification.new do |s|
      "test/block_cutter_test.rb",
      "test/test_helper.rb",
      "test/file_cache_test.rb",
-     "test/text_block_test.rb",
+     "test/base_block_test.rb",
+     "test/block_parser_test.rb",
      "test/feed_parser_test.rb",
-     "test/flannel_test.rb"
+     "test/flannel_test.rb",
+     "test/base_block_html_generation_test.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -87,12 +92,21 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shouldamocha>, [">= 0"])
+      s.add_runtime_dependency(%q<treetop>, [">= 0"])
+      s.add_runtime_dependency(%q<polyglot>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
     else
-      s.add_dependency(%q<shouldamocha>, [">= 0"])
+      s.add_dependency(%q<treetop>, [">= 0"])
+      s.add_dependency(%q<polyglot>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
     end
   else
-    s.add_dependency(%q<shouldamocha>, [">= 0"])
+    s.add_dependency(%q<treetop>, [">= 0"])
+    s.add_dependency(%q<polyglot>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
   end
 end
 

data/lib/flannel.rb

@@ -1,3 +1,8 @@
+require "treetop"
+require "polyglot"
+require "flannel/block"
+require "flannel/base_block"
+
 require 'flannel/wrappable'
 require 'flannel/feed_parser'
 require 'flannel/file_cache'

data/lib/flannel/base_block.rb

@@ -0,0 +1,41 @@
+module Flannel
+  class BaseBlock
+    attr_reader :type, :id, :text, :parent_id, :attributes
+    
+    def initialize args
+      header = args.shift
+      @type = header.shift[1]
+      @id = header.shift[1]
+      @attributes = {}
+      
+      next_arg = header.shift
+      while next_arg
+        case next_arg[0]
+        when :parent_id then
+          @parent_id = next_arg[1]
+        when :attribute_list then
+          next_arg.shift
+          next_arg.each do |attribute|
+            @attributes[attribute[0]] = attribute[1]
+          end
+        end  
+        next_arg = header.shift
+      end
+      
+      @text = args.shift
+      strip_text
+    end
+    
+    def to_h
+      html_formatter = Flannel::HtmlFormatter.new
+      html_formatter.do(@text, @type, @id)
+    end
+    
+    def strip_text
+      return if @type == :preformatted
+      return unless @text
+      
+      @text = @text.strip
+    end
+  end
+end

data/lib/flannel/block.treetop

@@ -0,0 +1,152 @@
+grammar Block
+  rule document
+     block* {
+      def content
+        elements.map{ |element| element.content}
+      end
+    }
+  end
+
+  rule block
+     block_header block_text? {
+      def content
+        elements.map{ |element| element.respond_to?(:content) ? element.content : nil}.compact
+      end
+    }
+  end
+
+  rule block_header
+     block_start block_type block_id parent_id? attribute_list? [\n]*  {
+      def content
+        elements.map{ |element| element.respond_to?(:content) ? element.content : nil}.compact
+      end
+    }
+  end
+
+  rule block_start
+    ":" {
+      def content
+        nil
+      end
+    }
+  end
+
+  rule block_text
+    (!(block_header) .)+ {
+      def content
+        text_value
+      end
+    }
+  end
+ 
+  rule block_type
+    ( paragraph / feed / preformatted / list / header ) {
+      def content
+        [:block_type, text_value.to_sym ]
+      end
+    }
+  end
+ 
+  rule paragraph
+    "paragraph" { def content; text_value; end }
+  end
+
+  rule header
+    ( header_one / header_two / header_three / header_four / header_five / header_six ) { def content; text_value; end }
+  end
+
+  rule header_one
+    "header_one" { def content; text_value; end }
+  end
+
+  rule header_two
+    "header_two" { def content; text_value; end }
+  end
+
+  rule header_three
+    "header_three" { def content; text_value; end }
+  end
+
+  rule header_four
+    "header_four" { def content; text_value; end }
+  end
+
+  rule header_five
+    "header_five" { def content; text_value; end }
+  end
+
+  rule header_six
+    "header_six" { def content; text_value; end }
+  end
+
+
+
+  rule feed
+    "feed" { def content; text_value; end }
+  end
+
+  rule preformatted
+    "preformatted" { def content; text_value; end }
+  end
+
+  rule list
+    "list" { def content; text_value; end }
+  end
+
+  rule block_id
+    " "+ [a-z\-_]+ {
+      def content
+        [:block_id, text_value.strip]
+      end
+    }
+  end
+
+  rule parent_id
+    block_id {
+      def content
+        [:parent_id, text_value.strip]
+      end
+    }
+  end
+
+  rule name
+    [A-Za-z0-9]+ {
+      def content
+        text_value
+      end
+    }
+  end
+
+  rule attribute_list
+    attribute* {
+      def content
+        attributes = elements.map{ |element| element.content }
+        attributes.unshift :attribute_list
+      end
+    }
+  end
+ 
+  rule attribute
+    [\s]+ name "=" attribute_value {
+      def content
+        [elements[1].content.to_sym, elements[3].content]
+      end
+    }
+  end
+ 
+  rule attribute_value
+    [a-z\-_]+ {
+      def content
+        text_value
+      end
+    }
+  end
+
+  #rule beginning_of_line
+  #   {
+  #    def content
+  #      nil
+  #    end
+  #  }
+  #end
+end

data/lib/flannel/block_cutter.rb

@@ -1,15 +1,18 @@
 module Flannel
   class BlockCutter
     def cut markup
-      pieces = split_preformatted_blocks(markup)
-      pieces = pieces.map { |part| split_into_blocks(part) }
-      pieces.flatten!
-      convert_to_text_blocks pieces
+      #pieces = split_preformatted_blocks(markup)
+      #pieces = pieces.map { |part| split_into_blocks(part) }
+      #pieces.flatten!
+      #convert_to_text_blocks pieces
+      
+      parser = BlockParser.new
+      blocks = parser.parse(markup).content.map { |block| Flannel::BaseBlock.new(block) }
     end
     
     def split_into_blocks markup
       if is_preformatted markup
-	markup
+        markup
       else
         markup.split(/\n\s*?\n/).map { |s| s.strip }
       end

data/lib/flannel/html_formatter.rb

@@ -6,18 +6,24 @@ module Flannel
       @tags ={:preformatted => "pre", 
               :feed => "ul", 
               :list => "ul", 
-              :header_1 => "h1", 
+              :header_1 => "h1", #old style
               :header_2 => "h2", 
               :header_3 => "h3", 
               :header_4 => "h4", 
               :header_5 => "h5", 
               :header_6 => "h6", 
+              :header_one => "h1", #new style
+              :header_two => "h2", 
+              :header_three => "h3", 
+              :header_four => "h4", 
+              :header_five => "h5", 
+              :header_six => "h6",
               :paragraph => "p",
               :blockquote => "blockquote"}
     end
     
-    def do text, style
-      steps = get_steps_for style
+    def do text, style, id=nil
+      steps = get_steps_for style, id
       inject text, steps
     end
 
@@ -27,33 +33,33 @@ module Flannel
     
     def inject text, steps
       if steps.empty?
-	text
+        text
       else
-	step = steps.shift
-	text = step.call text
-	inject text, steps
+        step = steps.shift
+        text = step.call text
+        inject text, steps
       end
     end
     
-    def get_steps_for style
+    def get_steps_for style, id
       steps = []
       
       case style
 	
       when :preformatted
-	steps << lambda { |text| html_escape text}
+        steps << lambda { |text| html_escape text}
       when :feed
-	steps << lambda { |text| parse_feed text }
+        steps << lambda { |text| parse_feed text }
       else
-	steps << lambda { |text| build_wiki_links text }
-	steps << lambda { |text| convert_external_links text }
+        steps << lambda { |text| build_wiki_links text }
+        steps << lambda { |text| convert_external_links text }
       end
       
       if style == :list
-	steps << lambda { |text| format_list text }
+        steps << lambda { |text| format_list text }
       end
       
-      steps << lambda { |text| wrap text, @tags[style]}
+      steps << lambda { |text| wrap(text, @tags[style], id) }
       
       steps
     end
@@ -104,7 +110,7 @@ module Flannel
     end
     
     def format_list text
-      text.split(/^\*/).reject { |item| item == ""  }.map { |item| wrap(item.chomp, "li") }.join("\n")      
+      text.split(/\n/).reject { |item| item == ""  }.map { |item| wrap(item.chomp, "li") }.join("\n")      
     end
     
     def parse_feed text

data/lib/flannel/wrappable.rb

@@ -1,13 +1,17 @@
 module Flannel
   module Wrappable
-    def wrap content, tag
+    def wrap content, tag, element_id=nil
       if empty_string?(content) || empty_string?(tag)
         return content
       end
 
       content.strip! unless tag == "pre"
 
-      "<#{tag}>#{content}</#{tag}>"
+      if element_id
+        "<#{tag} id='#{element_id}'>#{content}</#{tag}>"
+      else
+        "<#{tag}>#{content}</#{tag}>"
+      end
     end
 
     def empty_string? str

data/test/base_block_html_generation_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class HtmlGenerationTest < Test::Unit::TestCase
+  context "basic behavior" do
+    should "wrap in pre tags when preformatted" do
+      block = Flannel::BaseBlock.new [[[:block_type, :preformatted], [:block_id, "some-id"], [:attribute_list]], "foo"]
+      assert_equal "<pre id='some-id'>foo</pre>", block.to_h
+    end
+
+    should "wrap in ul tags when unordered_list" do
+      block =  Flannel::BaseBlock.new [[[:block_type, :list], [:block_id, "some-id"], [:attribute_list]], "foo"]
+      assert_equal "<ul id='some-id'><li>foo</li></ul>", block.to_h
+    end
+
+    should "convert [|] pattern to an external link" do
+      block = Flannel::BaseBlock.new [[[:block_type, :paragraph], [:block_id, "some-id"], [:attribute_list]], "yadda [yadda|http://example.com] yadda"]
+      assert_equal %q{<p id='some-id'>yadda <a href="http://example.com" target="_blank">yadda</a> yadda</p>}, block.to_h
+    end
+
+    should "add http:// to external links" do
+      block = Flannel::BaseBlock.new [[[:block_type, :paragraph], [:block_id, "some-id"], [:attribute_list]], "yadda [yadda|example.com] yadda"]
+      assert_equal %q{<p id='some-id'>yadda <a href="http://example.com" target="_blank">yadda</a> yadda</p>}, block.to_h
+    end
+
+    should "add create title if provided to external links" do
+      block = Flannel::BaseBlock.new  [[[:block_type, :paragraph], [:block_id, "some-id"], [:attribute_list]], "yadda [yadda|example.com|My title] yadda"]
+      assert_equal %q{<p id='some-id'>yadda <a href="http://example.com" title="My title" target="_blank">yadda</a> yadda</p>}, block.to_h
+    end
+  end
+end

data/test/base_block_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+class BaseBlockTest < Test::Unit::TestCase
+  def test_initializes_with_header_array_and_text
+    block = Flannel::BaseBlock.new [[[:block_type, :paragraph], [:block_id, "some-id"], [:attribute_list]], "some text"]
+    
+    assert_equal :paragraph, block.type
+    assert_equal "some-id", block.id
+    assert_equal "some text", block.text
+  end
+  
+  def test_initializes_with_parent_id
+    block = Flannel::BaseBlock.new [[[:block_type, :paragraph], [:block_id, "some-id"], [:parent_id, "parent-id"]], "some text"]
+    
+    assert_equal :paragraph, block.type
+    assert_equal "some-id", block.id
+    assert_equal "parent-id", block.parent_id
+    assert_equal "some text", block.text
+  end
+  
+  def test_initializes_with_attribute_list
+    block = Flannel::BaseBlock.new [[[:block_type, :paragraph], [:block_id, "some-id"], [:attribute_list, [:class, "cool"]]], "some text"]
+    
+    assert_equal :paragraph, block.type
+    assert_equal "some-id", block.id
+    assert_equal "cool", block.attributes[:class]
+    assert_equal "some text", block.text
+  end
+  
+  def test_initializes_with_attribute_list_and_parent_id
+    block = Flannel::BaseBlock.new [[[:block_type, :paragraph], [:block_id, "some-id"], [:parent_id, "parent-id"], [:attribute_list, [:class, "cool"]]], "some text"]
+   
+    assert_equal :paragraph, block.type
+    assert_equal "some-id", block.id
+    assert_equal "parent-id", block.parent_id
+    assert_equal "cool", block.attributes[:class]
+    assert_equal "some text", block.text
+  end
+  
+  def test_initializes_with_header_array_and_no_text
+    block = Flannel::BaseBlock.new [[[:block_type, :paragraph], [:block_id, "some-id"]]]
+    
+    assert_equal :paragraph, block.type
+    assert_equal "some-id", block.id
+    assert_nil block.text, "Block#text should be nil"
+  end
+  
+  def test_initialized_from_parser_output
+    text = ":preformatted my-code great-code class=ruby whiz=bang\ndef foo arg\n\t puts arg\n end"
+    doc = BlockParser.new.parse(text)
+    block = Flannel::BaseBlock.new doc.content[0]
+   
+    assert_equal :preformatted, block.type
+    assert_equal "my-code", block.id
+    assert_equal "great-code", block.parent_id
+    assert_equal "ruby", block.attributes[:class]
+    assert_equal "bang", block.attributes[:whiz]
+    assert_equal "def foo arg\n\t puts arg\n end", block.text
+  end
+end

data/test/block_cutter_test.rb

@@ -6,52 +6,51 @@ class BlockCutterTest < Test::Unit::TestCase
       @block_cutter = Flannel::BlockCutter.new
     end
 
-    should "split a flannel document into squares based on blank lines" do
-      markup = "foo\n\nbar"
+    should "split a flannel document into blocks based on block_headers" do
+      markup = ":paragraph bar\n some text\n:paragraph baz\n some more text"
+
+      blocks = @block_cutter.cut markup
+      assert_equal 2, blocks.length
+ 
+      assert_equal :paragraph, blocks[0].type
+      assert_equal "bar", blocks[0].id
+      assert_equal :paragraph, blocks[1].type
+      assert_equal "baz", blocks[1].id
 
-      squares = @block_cutter.cut markup
-      assert_equal 2, squares.length
-      assert_equal "foo", squares[0].to_s
-      assert_equal "bar", squares[1].to_s
     end
 
     should "not split preformatted text based on blank lines" do
-      markup = "_foo\n\nbar\n_"
+      markup = ":preformatted my_preformatted\n foo\n\nbar\n"
 
-      squares = @block_cutter.cut markup
-      assert_equal 1, squares.length
-      assert_equal :preformatted, squares[0].style
+      blocks = @block_cutter.cut markup
+      assert_equal 1, blocks.length
+      assert_equal :preformatted, blocks[0].type
+      assert_equal "my_preformatted", blocks[0].id
+      assert_equal " foo\n\nbar\n", blocks[0].text
     end
 
 
     should "separate preformatted blocks" do
-      markup = "_foo\n_\n\n_bar\n_"
+      markup = ":preformatted one\nfoo\n:preformatted two\nbar\n"
 
-      squares = @block_cutter.cut markup
-      assert_equal 2, squares.length
-      assert_equal :preformatted, squares[0].style
-      assert_equal :preformatted, squares[1].style
+      blocks = @block_cutter.cut markup
+      assert_equal 2, blocks.length
+      assert_equal :preformatted, blocks[0].type
+      assert_equal :preformatted, blocks[1].type
     end
 
     should "strip preformatted markers when found" do
-      markup = "_foo\n\nbar\n_"
+      markup = ":preformatted foo\nfoo\n\nbar\n"
 
-      squares = @block_cutter.cut markup
-      assert_equal "foo\n\nbar",  squares[0].to_s
+      blocks = @block_cutter.cut markup
+      assert_equal "foo\n\nbar\n",  blocks[0].text
     end
     
     should "set square style to feed based on full tag " do
-      markup = ":feed http://www.example.com/rss"
-
-      squares = @block_cutter.cut markup
-      assert_equal :feed, squares[0].style
-    end
-    
-    should "set square style to feed based on ampersand abbrev" do
-      markup = "& http://www.example.com/rss"
+      markup = ":feed wonki\nhttp://www.example.com/rss"
 
-      squares = @block_cutter.cut markup
-      assert_equal :feed, squares[0].style
+      blocks = @block_cutter.cut markup
+      assert_equal :feed, blocks[0].type
     end
   end
 end

data/test/block_parser_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+require 'pp'
+
+class BlockParserTest < Test::Unit::TestCase
+  def setup
+    @parser = BlockParser.new
+  end
+
+  def test_parser_returns_empty_array_for_empty_string
+    assert_equal 0, @parser.parse("").content.length, "Parser was expected to return no elements for an empty string"
+  end
+  
+  def test_parser_returns_simple_block
+    doc = @parser.parse(":paragraph wonki\ntext")
+    
+    assert_doc doc, :paragraph, "wonki", "text"
+  end
+  
+  def test_parser_returns_block_with_dashed_block_id
+    doc = @parser.parse(":paragraph wonki-donki\ntext")
+
+    assert_doc doc, :paragraph, "wonki-donki", "text"
+  end
+  
+  def test_parser_returns_block_with_parent_id
+    doc = @parser.parse(":paragraph wonki-donki parent_id\ntext")
+
+    assert_doc doc, :paragraph, "wonki-donki", "text", "parent_id"
+  end
+  
+  def test_parser_returns_block_with_parent_id_and_attributes
+    doc = @parser.parse(":paragraph wonki-donki parent_id class=foo title=monkey\ntext")
+
+    assert_doc doc, :paragraph, "wonki-donki", "text", "parent_id", { :class => "foo", :title => "monkey" }
+  end
+  
+  def test_parser_returns_two_simple_blocks
+    doc = @parser.parse(":paragraph foo\nbar\n:paragraph baz\nbonzo")
+
+    assert_not_nil doc
+    
+    blocks = doc.content
+    
+    assert_block blocks[0], :paragraph, "foo", "bar\n"
+    assert_block blocks[1], :paragraph, "baz", "bonzo"
+  end
+end

data/test/feed_parser_test.rb

@@ -5,12 +5,13 @@ class FeedParserTest < Test::Unit::TestCase
   context "wiring" do
     setup do
       @rubyyot = IO.read(File.join(File.dirname(__FILE__), "..", "features", "fixtures", "rubyyot.rss"))
-      @expected_rubyyot = "<ul><li>\n    <a href='http://blog.rubyyot"
+      @expected_rubyyot = "<ul id='my_feed'><li>\n    <a href='http:/"
     end
     
     should "be set up for feeds" do
       feed = "http://blog.rubyyot.com/tag/rubyyot/feed/rss"
-      body = Flannel.quilt "& #{feed}"
+      Flannel::FeedParser.any_instance.stubs(:get_document).returns @rubyyot
+      body = Flannel.quilt ":feed my_feed #{feed}"
 
       assert_equal(@expected_rubyyot, body[0..40])
     end

data/test/flannel_test.rb

@@ -2,8 +2,8 @@ require 'test_helper'
 
 class FlannelTest < Test::Unit::TestCase
   should "wrap functionality up in a neat package" do
-    markup = "== Foo\n\n* Bar"
-    assert_equal "<h2>Foo</h2>\n\n<ul><li>Bar</li></ul>", Flannel.quilt(markup)
+    markup = ":header_two foo Foo\n\n:list list Bar"
+    assert_equal "<h2 id='foo'>Foo</h2>\n\n<ul id='list'><li>Bar</li></ul>", Flannel.quilt(markup)
   end
 
   should "return nil if text is nil" do
@@ -11,44 +11,44 @@ class FlannelTest < Test::Unit::TestCase
   end
 
   should "parse paragraphs correctly" do
-    input = "\nThis is paragraph one.\n\nThis is paragraph two.\n\nThis is paragraph three. Watchout for the end of file.\n"
-    output = "<p>This is paragraph one.</p>\n\n<p>This is paragraph two.</p>\n\n<p>This is paragraph three. Watchout for the end of file.</p>"
+    input = ":paragraph p_one\nThis is paragraph one.\n\n:paragraph p_two\nThis is paragraph two.\n\n:paragraph p_three\nThis is paragraph three. Watchout for the end of file.\n"
+    output = "<p id='p_one'>This is paragraph one.</p>\n\n<p id='p_two'>This is paragraph two.</p>\n\n<p id='p_three'>This is paragraph three. Watchout for the end of file.</p>"
     assert_equal output, Flannel.quilt(input)
   end
   
   context "basic behavior" do
     should "strip and convert underscores to pre tags" do
-      markup = "_foo\n\n   bar\n_"
-      assert_equal "<pre>foo\n\n   bar</pre>",  Flannel.quilt(markup)
+      markup = ":preformatted foo\nfoo\n\n   bar\n"
+      assert_equal "<pre id='foo'>foo\n\n   bar\n</pre>",  Flannel.quilt(markup)
     end
 
-    should "not replace in preformatted text" do
-      markup = "_4 - 2 > 2 - 2\n_"
-      assert_equal '<pre>4 - 2 &gt; 2 - 2</pre>',  Flannel.quilt(markup)
+    should "escape preformatted text" do
+      markup = ":preformatted math\n4 - 2 > 2 - 2\n"
+      assert_equal "<pre id='math'>4 - 2 &gt; 2 - 2\n</pre>",  Flannel.quilt(markup)
     end
   end
 
-  context "When block starts with one or more equals signs, it" do
-    should "convert one equals to a header one" do
-      markup = "= Some header"
-      result = "<h1>Some header</h1>"
+  context "When block starts with header, it" do
+    should "convert one to a header one" do
+      markup = ":header_one h\n Some header"
+      result = "<h1 id='h'>Some header</h1>"
 
       assert_equal result,  Flannel.quilt(markup)
     end
 
     should "convert two equals to a header two" do
-      markup = "== Some header"
-      result = "<h2>Some header</h2>"
+      markup = ":header_two h\n Some header"
+      result = "<h2 id='h'>Some header</h2>"
 
       assert_equal result,  Flannel.quilt(markup)
     end
   end
 
-  context "When block starts with a star, it" do
-    should "tell square that it's a list, so that it will be wrapped in ul tags" do
+  context "When block is a list, it" do
+    should "be wrapped in ul tags" do
 
-      markup = "* Yadda"
-      result = "<ul><li>Yadda</li></ul>"
+      markup = ":list list\n Yadda\nYadda\nYadda"
+      result = "<ul id='list'><li>Yadda</li>\n<li>Yadda</li>\n<li>Yadda</li></ul>"
 
       assert_equal result, Flannel.quilt(markup)
     end

data/test/html_formatter_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-require 'flannel/stripe'
 
 class HtmlFormatterTest < Test::Unit::TestCase
   context "basic operations" do
@@ -8,7 +7,7 @@ class HtmlFormatterTest < Test::Unit::TestCase
     end
     
     should "return html fragment with format" do
-      assert_equal "<p>foo</p>", @formatter.do('foo', :paragraph)
+      assert_equal "<p id='bar'>foo</p>", @formatter.do('foo', :paragraph, "bar")
     end
     
     context "subdirectories" do

data/test/test_helper.rb

@@ -16,12 +16,57 @@ class Test::Unit::TestCase
     Dir.foreach(dirname) do |f|
       path = File.join(dirname, f)
       if f == '.' or f == '..' then 
-	next
+        next
       elsif 
-	File.directory?(path) then FileUtils.rm_rf(path)
+        File.directory?(path) then FileUtils.rm_rf(path)
       else 
-	FileUtils.rm( path )
+        FileUtils.rm( path )
       end
     end
   end
+  
+  def assert_doc doc, expected_type, expected_id, expected_text, expected_parent_id=nil, expected_attributes=nil
+    assert_not_nil doc
+    block = doc.content[0]
+
+    assert_block block, expected_type, expected_id, expected_text, expected_parent_id, expected_attributes
+  end
+  
+  def assert_block block, expected_type, expected_id, expected_text, expected_parent_id=nil, expected_attributes=nil
+    header = block.shift
+    
+    type = header.shift
+    assert_equal 2, type.length
+    assert_equal :block_type, type[0]
+    assert_equal expected_type, type[1]   
+    
+    id = header.shift
+    assert_equal 2, id.length
+    assert_equal :block_id, id[0]
+    assert_equal expected_id, id[1] 
+    
+    if expected_parent_id
+      parent_id = header.shift
+      assert_equal 2, parent_id.length
+      assert_equal :parent_id, parent_id[0]
+      assert_equal expected_parent_id, parent_id[1] 
+    end
+    
+    attribute_list = header.shift
+    assert_equal :attribute_list, attribute_list[0]
+    
+    if expected_attributes
+      attributes = attribute_list.dup
+      attributes.shift
+
+      assert_equal expected_attributes.length, attributes.length
+      attributes.each do |attribute|
+        assert_equal expected_attributes[attribute[0]], attribute[1]
+      end
+    else
+      assert_equal 1, attribute_list.length
+    end
+       
+    assert_equal expected_text, block.shift
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: flannel
 version: !ruby/object:Gem::Version 
-  version: 0.2.7
+  version: 0.2.9
 platform: ruby
 authors: 
 - Jamal Hansen
@@ -9,11 +9,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-30 00:00:00 -06:00
+date: 2010-02-23 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: shouldamocha
+  name: treetop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: polyglot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -67,20 +97,23 @@ files:
 - features/wiki_links.feature
 - flannel.gemspec
 - lib/flannel.rb
+- lib/flannel/base_block.rb
+- lib/flannel/block.treetop
 - lib/flannel/block_cutter.rb
 - lib/flannel/cache_location_does_not_exist_error.rb
 - lib/flannel/feed_parser.rb
 - lib/flannel/file_cache.rb
 - lib/flannel/html_formatter.rb
-- lib/flannel/text_block.rb
 - lib/flannel/wrappable.rb
+- test/base_block_html_generation_test.rb
+- test/base_block_test.rb
 - test/block_cutter_test.rb
+- test/block_parser_test.rb
 - test/feed_parser_test.rb
 - test/file_cache_test.rb
 - test/flannel_test.rb
 - test/html_formatter_test.rb
 - test/test_helper.rb
-- test/text_block_test.rb
 has_rdoc: true
 homepage: http://github.com/rubyyot/flannel
 licenses: []
@@ -114,6 +147,8 @@ test_files:
 - test/block_cutter_test.rb
 - test/test_helper.rb
 - test/file_cache_test.rb
-- test/text_block_test.rb
+- test/base_block_test.rb
+- test/block_parser_test.rb
 - test/feed_parser_test.rb
 - test/flannel_test.rb
+- test/base_block_html_generation_test.rb

data/lib/flannel/text_block.rb

@@ -1,48 +0,0 @@
-module Flannel
-  class TextBlock
-    attr_reader :style
-    
-    def initialize text
-      set_style_marker text
-    end
-    
-    def to_s
-      @text
-    end
-    
-    def to_h
-      html_formatter = Flannel::HtmlFormatter.new
-      html_formatter.do(@text, @style)
-    end
-    
-    def set_style_marker text 
-      case text[0]
-      when '_'[0]		#preformatted
-	@style = :preformatted
-	@text =  text[1..-1]
-      when '&'[0]		#feed
-	@style = :feed
-	@text =  text[1..-1]
-      when '*'[0]		#list
-	@style = :list
-	@text = text
-      when '='[0]		#header
-	match = text.match /^(=+)/
-	weight = match.captures[0].length
-	
-	@style = "header_#{weight}".to_sym
-	@text =  text[weight..-1]
-      when ':'[0]		#generic
-	match = text.match /^(:[a-z_]+)/
-	
-	@style = match.captures[0][1..-1].to_sym
-	
-	style_length = match.captures[0].length
-	@text = text[style_length..-1].strip
-      else			#other
-	@style = :paragraph
-	@text =  text
-      end
-    end
-  end
-end

data/test/text_block_test.rb

@@ -1,64 +0,0 @@
-require 'test_helper'
-
-class TextBlockTest < Test::Unit::TestCase
-  context "basic behavior" do
-    should "return html" do
-      text_block = Flannel::TextBlock.new "foo"
-      assert_equal "<p>foo</p>", text_block.to_h
-    end
-  end
-
-  context "style" do
-    should "recognize preformatted" do
-      text_block = Flannel::TextBlock.new "_foo"
-      assert_equal :preformatted, text_block.style
-    end
-    
-    should "recognize paragraph" do
-      text_block = Flannel::TextBlock.new "foo"
-      assert_equal :paragraph, text_block.style
-    end
-    
-    should "recognize list" do
-      text_block = Flannel::TextBlock.new "* foo/n* bar/n* baz"
-      assert_equal :list, text_block.style
-    end
-    
-    should "recognize feed" do
-      text_block = Flannel::TextBlock.new "& http://foo.example.com"
-      assert_equal :feed, text_block.style
-    end
-    
-    should "recognize header" do
-      text_block = Flannel::TextBlock.new "====My Header"
-      assert_equal :header_4, text_block.style
-    end
-    
-    should "wrap in pre tags when preformatted" do
-      text_block = Flannel::TextBlock.new "_foo"
-      assert_equal "<pre>foo</pre>", text_block.to_h
-    end
-
-    should "wrap in ul tags when unordered_list" do
-      text_block =  Flannel::TextBlock.new "* foo"
-      assert_equal "<ul><li>foo</li></ul>", text_block.to_h
-    end
-  end
-
-  context "external links" do
-    should "convert [|] pattern to an external link" do
-      text_block = Flannel::TextBlock.new "yadda [yadda|http://example.com] yadda"
-      assert_equal '<p>yadda <a href="http://example.com" target="_blank">yadda</a> yadda</p>', text_block.to_h
-    end
-
-    should "add http:// to external links" do
-      text_block = Flannel::TextBlock.new "yadda [yadda|example.com] yadda"
-      assert_equal '<p>yadda <a href="http://example.com" target="_blank">yadda</a> yadda</p>', text_block.to_h
-    end
-
-    should "add create title if provided to external links" do
-      text_block = Flannel::TextBlock.new "yadda [yadda|example.com|My title] yadda"
-      assert_equal '<p>yadda <a href="http://example.com" title="My title" target="_blank">yadda</a> yadda</p>', text_block.to_h
-    end
-  end
-end