flannel 0.2.11 → 0.2.12

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 2
-:patch: 11
+:patch: 12
 :build: 

data/flannel.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flannel}
-  s.version = "0.2.11"
+  s.version = "0.2.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jamal Hansen"]
-  s.date = %q{2010-02-24}
+  s.date = %q{2010-02-25}
   s.default_executable = %q{quilt-it}
   s.email = %q{jamal.hansen@gmail.com}
   s.executables = ["quilt-it"]

data/lib/flannel/base_block.rb

@@ -2,28 +2,40 @@ module Flannel
   class BaseBlock
     attr_reader :type, :id, :text, :parent_id, :attributes
     
-    def initialize args
-      header = args.shift
+    def initialize block
+      form = block[0]
+      
+      if form == :block
+        create_from_list block[1]
+      else
+        @text = block[1]
+        @type = :paragraph
+      end
+      
+      strip_text
+    end
+    
+    def create_from_list list
+      header = list.shift
       @type = header.shift[1]
       @id = header.shift[1]
       @attributes = {}
       
-      next_arg = header.shift
-      while next_arg
-        case next_arg[0]
+      next_item = header.shift
+      while next_item
+        case next_item[0]
         when :parent_id then
-          @parent_id = next_arg[1]
+          @parent_id = next_item[1]
         when :attribute_list then
-          next_arg.shift
-          next_arg.each do |attribute|
+          next_item.shift
+          next_item.each do |attribute|
             @attributes[attribute[0]] = attribute[1]
           end
         end  
-        next_arg = header.shift
+        next_item = header.shift
       end
       
-      @text = args.shift
-      strip_text
+      @text = list.shift
     end
     
     def to_h

data/lib/flannel/block.treetop

@@ -1,6 +1,6 @@
 grammar Block
   rule document
-     block* {
+     ( block / not_flannel)* {
       def content
         elements.map{ |element| element.content}
       end
@@ -10,13 +10,13 @@ grammar Block
   rule block
      block_header block_text? {
       def content
-        elements.map{ |element| element.respond_to?(:content) ? element.content : nil}.compact
+        [ :block, 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]*  {
+     block_start block_type block_id? parent_id? attribute_list? [\s]* ":" [\n]?  {
       def content
         elements.map{ |element| element.respond_to?(:content) ? element.content : nil}.compact
       end
@@ -40,7 +40,7 @@ grammar Block
   end
  
   rule block_type
-    ( paragraph / feed / preformatted / list / header / blockquote ) {
+    ( feed / preformatted / list / header / blockquote / paragraph  ) {
       def content
         [:block_type, text_value.to_sym ]
       end
@@ -48,7 +48,7 @@ grammar Block
   end
  
   rule paragraph
-    "paragraph" { def content; text_value; end }
+    "paragraph" { def text_value; "paragraph"; end }
   end
 
   rule header
@@ -144,11 +144,11 @@ grammar Block
     }
   end
 
-  #rule beginning_of_line
-  #   {
-  #    def content
-  #      nil
-  #    end
-  #  }
-  #end
+  rule not_flannel
+    (!(block_header) .)+ {
+      def content
+        [:plain_text, text_value.strip ]
+      end
+    }
+  end
 end

data/lib/flannel/block_cutter.rb

@@ -1,13 +1,12 @@
 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
-      
       parser = BlockParser.new
-      blocks = parser.parse(markup).content.map { |block| Flannel::BaseBlock.new(block) }
+      blocks = parser.parse(markup).content.map { |block| form_blocks block }
+    end
+    
+    def form_blocks block
+      Flannel::BaseBlock.new(block)
     end
     
     def split_into_blocks markup

data/test/base_block_html_generation_test.rb

@@ -3,27 +3,27 @@ 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"]
+      block = new_block [[[: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"]
+      block =  new_block [[[: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"]
+      block = new_block [[[: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"]
+      block = new_block [[[: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"]
+      block = new_block  [[[: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

data/test/base_block_test.rb

@@ -2,7 +2,7 @@ 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"]
+    block = new_block [[[:block_type, :paragraph], [:block_id, "some-id"], [:attribute_list]], "some text"]
     
     assert_equal :paragraph, block.type
     assert_equal "some-id", block.id
@@ -10,7 +10,7 @@ class BaseBlockTest < Test::Unit::TestCase
   end
   
   def test_initializes_with_parent_id
-    block = Flannel::BaseBlock.new [[[:block_type, :paragraph], [:block_id, "some-id"], [:parent_id, "parent-id"]], "some text"]
+    block = new_block [[[:block_type, :paragraph], [:block_id, "some-id"], [:parent_id, "parent-id"]], "some text"]
     
     assert_equal :paragraph, block.type
     assert_equal "some-id", block.id
@@ -19,7 +19,7 @@ class BaseBlockTest < Test::Unit::TestCase
   end
   
   def test_initializes_with_attribute_list
-    block = Flannel::BaseBlock.new [[[:block_type, :paragraph], [:block_id, "some-id"], [:attribute_list, [:class, "cool"]]], "some text"]
+    block = new_block [[[:block_type, :paragraph], [:block_id, "some-id"], [:attribute_list, [:class, "cool"]]], "some text"]
     
     assert_equal :paragraph, block.type
     assert_equal "some-id", block.id
@@ -28,7 +28,7 @@ class BaseBlockTest < Test::Unit::TestCase
   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"]
+    block = new_block [[[: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
@@ -38,7 +38,7 @@ class BaseBlockTest < Test::Unit::TestCase
   end
   
   def test_initializes_with_header_array_and_no_text
-    block = Flannel::BaseBlock.new [[[:block_type, :paragraph], [:block_id, "some-id"]]]
+    block = new_block [[[:block_type, :paragraph], [:block_id, "some-id"]]]
     
     assert_equal :paragraph, block.type
     assert_equal "some-id", block.id
@@ -46,7 +46,7 @@ class BaseBlockTest < Test::Unit::TestCase
   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"
+    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]
    

data/test/block_cutter_test.rb

@@ -7,7 +7,7 @@ class BlockCutterTest < Test::Unit::TestCase
     end
 
     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"
+      markup = ":paragraph bar: some text\n:paragraph baz: some more text"
 
       blocks = @block_cutter.cut markup
       assert_equal 2, blocks.length
@@ -20,7 +20,7 @@ class BlockCutterTest < Test::Unit::TestCase
     end
     
     should "accept a block without an id" do
-      markup = ":paragraph\n some text"
+      markup = ":paragraph: some text"
 
       blocks = @block_cutter.cut markup
       assert_equal 1, blocks.length
@@ -30,7 +30,7 @@ class BlockCutterTest < Test::Unit::TestCase
     end
 
     should "not split preformatted text based on blank lines" do
-      markup = ":preformatted my_preformatted\n foo\n\nbar\n"
+      markup = ":preformatted my_preformatted:\n foo\n\nbar\n"
 
       blocks = @block_cutter.cut markup
       assert_equal 1, blocks.length
@@ -41,7 +41,7 @@ class BlockCutterTest < Test::Unit::TestCase
 
 
     should "separate preformatted blocks" do
-      markup = ":preformatted one\nfoo\n:preformatted two\nbar\n"
+      markup = ":preformatted one:foo\n:preformatted two:\nbar\n"
 
       blocks = @block_cutter.cut markup
       assert_equal 2, blocks.length
@@ -50,21 +50,21 @@ class BlockCutterTest < Test::Unit::TestCase
     end
 
     should "strip preformatted markers when found" do
-      markup = ":preformatted foo\nfoo\n\nbar\n"
+      markup = ":preformatted foo:foo\n\nbar\n"
 
       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 wonki\nhttp://www.example.com/rss"
+      markup = ":feed: wonki\nhttp://www.example.com/rss"
 
       blocks = @block_cutter.cut markup
       assert_equal :feed, blocks[0].type
     end
     
     should "parse a paragraph with a simple wiki link" do
-      markup = ":paragraph\n-ravioli>"
+      markup = ":paragraph:\n-ravioli>"
 
       blocks = @block_cutter.cut markup
       assert_equal :paragraph, blocks[0].type
@@ -73,7 +73,7 @@ class BlockCutterTest < Test::Unit::TestCase
     end
     
     should "parse a simple paragraph" do
-      markup = ":paragraph\nbar bar\n"
+      markup = ":paragraph:bar bar\n"
 
       blocks = @block_cutter.cut markup
       assert_equal :paragraph, blocks[0].type

data/test/block_parser_styles_test.rb

@@ -6,67 +6,67 @@ class BlockParserStylesTest < Test::Unit::TestCase
   end
   
   def test_paragraph
-    doc = @parser.parse(":paragraph\ntext")
+    doc = @parser.parse(":paragraph:\ntext")
     
     assert_doc doc, :paragraph, nil, "text"
   end
-  
+    
   def test_list
-    doc = @parser.parse(":list\ntext")
+    doc = @parser.parse(":list:\ntext")
     
     assert_doc doc, :list, nil, "text"
   end
   
   def test_feed
-    doc = @parser.parse(":feed\ntext")
+    doc = @parser.parse(":feed:\ntext")
     
     assert_doc doc, :feed, nil, "text"
   end
   
   def test_blockquote
-    doc = @parser.parse(":blockquote\ntext")
+    doc = @parser.parse(":blockquote:\ntext")
     
     assert_doc doc, :blockquote, nil, "text"
   end
   
   def test_preformatted
-    doc = @parser.parse(":preformatted\ntext")
+    doc = @parser.parse(":preformatted:\ntext")
     
     assert_doc doc, :preformatted, nil, "text"
   end
   
   def test_header_one
-    doc = @parser.parse(":header_one\ntext")
+    doc = @parser.parse(":header_one:\ntext")
     
     assert_doc doc, :header_one, nil, "text"
   end
   
   def test_header_two
-    doc = @parser.parse(":header_two\ntext")
+    doc = @parser.parse(":header_two:\ntext")
     
     assert_doc doc, :header_two, nil, "text"
   end
   
   def test_header_three
-    doc = @parser.parse(":header_three\ntext")
+    doc = @parser.parse(":header_three:\ntext")
     
     assert_doc doc, :header_three, nil, "text"
   end
   
   def test_header_four
-    doc = @parser.parse(":header_four\ntext")
+    doc = @parser.parse(":header_four:\ntext")
     
     assert_doc doc, :header_four, nil, "text"
   end
   
   def test_header_five
-    doc = @parser.parse(":header_five\ntext")
+    doc = @parser.parse(":header_five:\ntext")
     
     assert_doc doc, :header_five, nil, "text"
   end
   
   def test_header_six
-    doc = @parser.parse(":header_six\ntext")
+    doc = @parser.parse(":header_six:\ntext")
     
     assert_doc doc, :header_six, nil, "text"
   end

data/test/block_parser_test.rb

@@ -10,44 +10,66 @@ class BlockParserTest < Test::Unit::TestCase
     assert_equal 0, @parser.parse("").content.length, "Parser was expected to return no elements for an empty string"
   end
   
+  def test_parser_returns_text_it_does_not_recognize
+    assert_equal [[:plain_text, "yadda foo bar === :cheese"]], @parser.parse("yadda foo bar === :cheese").content, "Parser was expected to return non flannel text"
+  end
+  
+  def test_parser_returns_text_it_does_not_recognize_and_flannel
+    expected = [[:plain_text, "yadda foo bar === cheese"], [:block, [[[:block_type, :paragraph], [:attribute_list]], " foo"]]]
+    
+    assert_equal expected, @parser.parse("yadda foo bar === cheese\n:paragraph: foo").content, "Parser was expected to return non flannel text"
+  end
+  
   def test_parser_returns_simple_block
-    doc = @parser.parse(":paragraph wonki\ntext")
+    doc = @parser.parse(":paragraph wonki:text")
+    
+    assert_doc doc, :paragraph, "wonki", "text"
+  end
+  
+  def test_colon_will_end_header
+    doc = @parser.parse(":paragraph wonki:text")
+    
+    assert_doc doc, :paragraph, "wonki", "text"
+  end
+  
+  def test_will_allow_whitespace_before_colon
+    doc = @parser.parse(":paragraph wonki    :text")
     
     assert_doc doc, :paragraph, "wonki", "text"
   end
   
   def test_parser_returns_simple_block_without_id
-    doc = @parser.parse(":paragraph\ntext")
+    doc = @parser.parse(":paragraph:\ntext")
     
     assert_doc doc, :paragraph, nil, "text"
   end
   
   def test_parser_returns_block_with_dashed_block_id
-    doc = @parser.parse(":paragraph wonki-donki\ntext")
+    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")
+    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")
+    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")
+    doc = @parser.parse(":paragraph foo:bar\n:paragraph baz:bonzo")
 
     assert_not_nil doc
     
     blocks = doc.content
     
-    assert_block blocks[0], :paragraph, "foo", "bar\n"
-    assert_block blocks[1], :paragraph, "baz", "bonzo"
+    assert_block blocks[0][1], :paragraph, "foo", "bar\n"
+    assert_block blocks[1][1], :paragraph, "baz", "bonzo"
   end
 end

data/test/flannel_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class FlannelTest < Test::Unit::TestCase
   should "wrap functionality up in a neat package" do
-    markup = ":header_two foo Foo\n\n:list list Bar"
+    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
 
@@ -11,7 +11,7 @@ class FlannelTest < Test::Unit::TestCase
   end
 
   should "parse paragraphs correctly" do
-    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"
+    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
@@ -19,31 +19,31 @@ class FlannelTest < Test::Unit::TestCase
   context "basic behavior" do
     
     should "parse a block without an id" do
-      markup = ":paragraph\n this is my paragraph"
+      markup = ":paragraph:\n this is my paragraph"
       assert_equal "<p>this is my paragraph</p>",  Flannel.quilt(markup)
     end
     
     should "strip and convert underscores to pre tags" do
-      markup = ":preformatted foo\nfoo\n\n   bar\n"
+      markup = ":preformatted foo:\nfoo\n\n   bar\n"
       assert_equal "<pre id='foo'>foo\n\n   bar\n</pre>",  Flannel.quilt(markup)
     end
 
     should "escape preformatted text" do
-      markup = ":preformatted math\n4 - 2 > 2 - 2\n"
+      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 header, it" do
     should "convert one to a header one" do
-      markup = ":header_one h\n Some header"
+      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 = ":header_two h\n Some header"
+      markup = ":header_two h:\n Some header"
       result = "<h2 id='h'>Some header</h2>"
 
       assert_equal result,  Flannel.quilt(markup)
@@ -53,7 +53,7 @@ class FlannelTest < Test::Unit::TestCase
   context "When block is a list, it" do
     should "be wrapped in ul tags" do
 
-      markup = ":list list\n Yadda\nYadda\nYadda"
+      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)
@@ -62,7 +62,7 @@ class FlannelTest < Test::Unit::TestCase
   
   context "bug fixes" do
     should "parse a simple paragraph" do
-      markup = ":paragraph\nbar bar\n"
+      markup = ":paragraph:\nbar bar\n"
       result = "<p>bar bar</p>"
 
       assert_equal result, Flannel.quilt(markup)

data/test/test_helper.rb

@@ -12,6 +12,10 @@ class Test::Unit::TestCase
     assert false, message
   end
   
+  def new_block list
+    Flannel::BaseBlock.new [ :block, list ]
+  end
+  
   def clear_dir dirname
     Dir.foreach(dirname) do |f|
       path = File.join(dirname, f)
@@ -27,8 +31,12 @@ class Test::Unit::TestCase
   
   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]
-
+    
+    item = doc.content[0]
+    assert_equal :block, item[0]
+    
+    block = item[1]
+    
     assert_block block, expected_type, expected_id, expected_text, expected_parent_id, expected_attributes
   end
   

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 11
-  version: 0.2.11
+  - 12
+  version: 0.2.12
 platform: ruby
 authors: 
 - Jamal Hansen
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-24 00:00:00 -06:00
+date: 2010-02-25 00:00:00 -06:00
 default_executable: quilt-it
 dependencies: 
 - !ruby/object:Gem::Dependency