flannel 0.2.13 → 0.2.14

data/Rakefile

@@ -34,12 +34,14 @@ begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |test|
     test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
+    test.pattern = 'test/*_test.rb'
     test.verbose = true
+    test.rcov_opts << '--html'
+    test.output_dir = 'coverage'
   end
 rescue LoadError
   task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install rcov"
   end
 end
 
@@ -69,3 +71,17 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+begin
+  require 'reek/rake/task'
+
+  Reek::Rake::Task.new do |t|
+    t.fail_on_error = false
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+
+

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 2
-:patch: 13
+:patch: 14
 :build: 

data/flannel.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flannel}
-  s.version = "0.2.13"
+  s.version = "0.2.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jamal Hansen"]
-  s.date = %q{2010-02-26}
+  s.date = %q{2010-03-01}
   s.default_executable = %q{quilt-it}
   s.description = %q{Flannel is a markup language that is not intended for your web app.  It's for your local use, to write a blog entry in your text editor or a number of other uses.}
   s.email = %q{jamal.hansen@gmail.com}
@@ -52,6 +52,8 @@ Gem::Specification.new do |s|
      "features/support/env.rb",
      "features/wiki_links.feature",
      "flannel.gemspec",
+     "graphics/flannel.xcf",
+     "graphics/flannel_small.jpg",
      "lib/flannel.rb",
      "lib/flannel/base_block.rb",
      "lib/flannel/block.treetop",
@@ -60,6 +62,7 @@ Gem::Specification.new do |s|
      "lib/flannel/feed_parser.rb",
      "lib/flannel/file_cache.rb",
      "lib/flannel/html_formatter.rb",
+     "lib/flannel/html_transformable.rb",
      "lib/flannel/wrappable.rb",
      "test/base_block_html_generation_test.rb",
      "test/base_block_test.rb",

data/lib/flannel.rb

@@ -1,26 +1,20 @@
-require "treetop"
-require "polyglot"
-require "flannel/block"
-require "flannel/base_block"
-
 require 'flannel/wrappable'
 require 'flannel/feed_parser'
 require 'flannel/file_cache'
 
 require 'flannel/block_cutter'
-require 'flannel/html_formatter'
 
 module Flannel
   def self.quilt markup, params={}
-    @@cache = params[:cache]
+    @cache = params[:cache]
     return nil unless markup
     
     cutter = Flannel::BlockCutter.new
     text_blocks = cutter.cut markup
-    text_blocks.map { |text| text.to_h }.join("\n\n")
+    text_blocks.map { |block| block.to_h }.join("\n\n")
   end
   
   def self.cache
-    @@cache
+    @cache
   end
 end

data/lib/flannel/base_block.rb

@@ -1,26 +1,29 @@
+# encoding: UTF-8
+require 'flannel/html_formatter'
+
 module Flannel
   class BaseBlock
     attr_reader :type, :id, :text, :parent_id, :attributes
-    
+
     def initialize block
       form = block[0]
-      
+
       if form == :block
         create_from_list block[1]
       else
         @text = block[1]
         @type = :paragraph
       end
-      
-      strip_text
+
+      strip_and_encode_text
     end
-    
+
     def create_from_list list
       header = list.shift
       @type = header.shift[1]
       @id = header.shift[1]
       @attributes = {}
-      
+
       next_item = header.shift
       while next_item
         case next_item[0]
@@ -31,22 +34,25 @@ module Flannel
           next_item.each do |attribute|
             @attributes[attribute[0]] = attribute[1]
           end
-        end  
+        end
         next_item = header.shift
       end
-      
+
       @text = list.shift
     end
-    
+
     def to_h
       html_formatter = Flannel::HtmlFormatter.new
       html_formatter.do(@text, @type, @id)
     end
-    
-    def strip_text
+
+    def strip_and_encode_text
+      return unless @text
+      @text.force_encoding("UTF-8")
+
       return if @type == :preformatted
       return unless @text
-      
+
       @text = @text.strip
     end
   end

data/lib/flannel/block_cutter.rb

@@ -1,7 +1,14 @@
+require "treetop"
+require "polyglot"
+require "flannel/block"
+
+require "flannel/base_block"
+
 module Flannel
   class BlockCutter
     def cut markup
       parser = BlockParser.new
+     
       blocks = parser.parse(markup).content.map { |block| form_blocks block }
     end
     
@@ -9,28 +16,28 @@ module Flannel
       Flannel::BaseBlock.new(block)
     end
     
-    def split_into_blocks markup
-      if is_preformatted markup
-        markup
-      else
-        markup.split(/\n\s*?\n/).map { |s| s.strip }
-      end
-    end
-    
-    def split_preformatted_blocks markup
-      markup.split(/^(_(?=\n\n)|(?=_))/).map { |s| s.strip }.reject { |s| is_invalid_block s}
-    end
-    
-    def convert_to_text_blocks pieces
-      pieces.map{ |piece| Flannel::TextBlock.new piece }
-    end
-    
-    def is_invalid_block s
-      s == "" || s == "_" 
-    end
-    
-    def is_preformatted markup
-      markup[0] == '_'[0]
-    end
+    #def split_into_blocks markup
+    #  if is_preformatted markup
+    #    markup
+    #  else
+    #    markup.split(/\n\s*?\n/).map { |s| s.strip }
+    #  end
+    #end
+   # 
+   # def split_preformatted_blocks markup
+   #   markup.split(/^(_(?=\n\n)|(?=_))/).map { |s| s.strip }.reject { |s| is_invalid_block s}
+   # end
+   # 
+   # def convert_to_text_blocks pieces
+   #   pieces.map{ |piece| Flannel::TextBlock.new piece }
+   # end
+   # 
+   # def is_invalid_block s
+   #   s == "" || s == "_" 
+   # end
+   # 
+   # def is_preformatted markup
+   #   markup[0] == '_'[0]
+   # end
   end
 end

data/lib/flannel/feed_parser.rb

@@ -30,17 +30,17 @@ module Flannel
       item_string = @cache.retrieve(url) if @cache
       
       unless item_string 
-	item_string = ""
-	doc = get_document(url)
-	items = get_items(doc)
+        item_string = ""
+        doc = get_document(url)
+        items = get_items(doc)
 
-	items.each do |item|
-	  link = inner_html(item, "link")
-	  title = inner_html(item, "title")
-	  item_string << format_item(link, title)
-	end
-	
-	@cache.save url, item_string if @cache
+        items.each do |item|
+          link = inner_html(item, "link")
+          title = inner_html(item, "title")
+          item_string << format_item(link, title)
+        end
+        
+        @cache.save url, item_string if @cache
       end
       
       item_string

data/lib/flannel/html_formatter.rb

@@ -1,147 +1,59 @@
+require 'flannel/html_transformable'
+
 module Flannel
+
+  # HtmlFormatter is responsible for formatting text blocks as html
   class HtmlFormatter
-    include Wrappable
-    
+    include Flannel::HtmlTransformable
+
     def initialize
-      @tags ={:preformatted => "pre", 
-              :feed => "ul", 
-              :list => "ul", 
-              :dlist => "dl", 
-              :header_1 => "h1", #old style
-              :header_2 => "h2", 
-              :header_3 => "h3", 
-              :header_4 => "h4", 
-              :header_5 => "h5", 
-              :header_6 => "h6", 
+      @tags ={:preformatted => "pre",
+              :feed => "ul",
+              :list => "ul",
+              :dlist => "dl",
               :header_one => "h1", #new style
-              :header_two => "h2", 
-              :header_three => "h3", 
-              :header_four => "h4", 
-              :header_five => "h5", 
+              :header_two => "h2",
+              :header_three => "h3",
+              :header_four => "h4",
+              :header_five => "h5",
               :header_six => "h6",
               :paragraph => "p",
               :blockquote => "blockquote"}
     end
-    
+
     def do text, style, id=nil
-      steps = get_steps_for style, id
-      inject text, steps
-    end
+      @text = text
+      @style = style
+      @id = id
 
-    def permalink topic
-      topic.gsub(%r{[^/\w\s\-]},'').gsub(%r{[^\w/]|[\_]},' ').split.join('-').downcase
-    end
-    
-    def inject text, steps
-      if steps.empty?
-        text
-      else
-        step = steps.shift
-        text = step.call text
-        inject text, steps
-      end
+      html = build_html
+      html.force_encoding("UTF-8")
+      html
     end
-    
-    def get_steps_for style, id
-      steps = []
-      
-      case style
-	
+
+    def build_html
+      case @style
+
       when :preformatted
-        steps << lambda { |text| html_escape text}
+        html =  html_escape @text
       when :feed
-        steps << lambda { |text| parse_feed text }
+        html =  parse_feed @text
       when :image
-        steps << lambda { |text| create_img text }
+        html =  create_img @text
       else
-        steps << lambda { |text| build_wiki_links text }
-        steps << lambda { |text| convert_external_links text }
-      end
-      
-      if style == :list
-        steps << lambda { |text| format_list text }
-      end
-      
-      if style == :dlist
-        steps << lambda { |text| format_dlist text }
-      end
-      
-      steps << lambda { |text| wrap(text, @tags[style], id) }
-      
-      steps
-    end
-    
-    def html_escape text
-      require 'cgi'
+        html =  build_wiki_links @text
+        html =  convert_external_links html
 
-      CGI::escapeHTML(text)
-    end
-    
-    def build_wiki_links text
-      text.gsub(/-\w(.*?)\w>/) { |match| %{<a href="#{wiki_link match}">#{format_link_display(match)}</a>}}
-    end
-    
-    def create_img text
-      desc, url = text.split(/\n/, 2)
-      
-      return text unless url
-      
-      "<img src='#{url}' alt='#{desc}' title='#{desc}' />"
-    end
-    
-    def wiki_link topic
-      permalink topic[1..-2]
-    end
-
-    def permalink topic
-      topic.gsub(%r{[^/\w\s\-]},'').gsub(%r{[^\w/]|[\_]},' ').split.join('-').downcase
-    end
-    
-    def format_link_display text
-      text[1..-2].split("/").last
-    end
-    
-    def convert_external_links text
-      text.gsub(/\[([^\|]*\|[^\]]*)\]/) { |match| build_external_link match }
-    end
-
-    def build_external_link match
-      text, url, title = match[1..-2].split("|", 3)
-
-      url = format_link url.strip
-      text.strip!
-      title.strip! if title
+        if @style == :list
+          html = format_list html
+        end
 
-      if title
-        %{<a href="#{url}" title="#{title}" target="_blank">#{text}</a>}
-      else
-        %{<a href="#{url}" target="_blank">#{text}</a>}
+        if @style == :dlist
+          html =  format_dlist html
+        end
       end
-    end
-    
-    def format_link url
-      return url if /:\/\// =~ url
-      "http://#{url}"
-    end
-    
-    def format_list text
-      text.split(/\n/).reject { |item| item == ""  }.map { |item| wrap(item.chomp, "li") }.join("\n")      
-    end
-    
-    def format_dlist text
-      text.split(/\n/).reject { |item| item == ""  }.map { |item| split_definition(item) }.join("\n")      
-    end
-    
-    def split_definition item
-      term, definition = item.split(/\-/, 2).map{ |term| term.strip }
-      
-      return item unless definition
-      "<dt>#{term}</dt><dd>#{definition}</dd>"
-    end
-    
-    def parse_feed text
-      parser = Flannel::FeedParser.new  Flannel.cache
-      parser.sub_feeds text
+
+      wrap(html, @tags[@style], @id)
     end
   end
 end

data/lib/flannel/html_transformable.rb

@@ -0,0 +1,84 @@
+require 'flannel/wrappable'
+
+module Flannel
+  
+  # Methods for transforming test into html
+  module HtmlTransformable
+    include Wrappable
+    
+    def html_escape text
+      require 'cgi'
+
+      CGI::escapeHTML(text)
+    end
+    
+    def permalink topic
+      topic.gsub(%r{[^/\w\s\-]},'').gsub(%r{[^\w/]|[\_]},' ').split.join('-').downcase
+    end
+    
+    def build_wiki_links text
+      text.gsub(/-\w(.*?)\w>/) { |match| %{<a href="#{wiki_link match}">#{format_link_display(match)}</a>}}
+    end
+    
+    def create_img text
+      desc, url = text.split(/\n/, 2)
+      
+      return text unless url
+      
+      "<img src='#{url}' alt='#{desc}' title='#{desc}' />"
+    end
+    
+    def wiki_link topic
+      permalink topic[1..-2]
+    end
+
+    def permalink topic
+      topic.gsub(%r{[^/\w\s\-]},'').gsub(%r{[^\w/]|[\_]},' ').split.join('-').downcase
+    end
+    
+    def format_link_display text
+      text[1..-2].split("/").last
+    end
+    
+    def convert_external_links text
+      text.gsub(/\[([^\|]*\|[^\]]*)\]/) { |match| build_external_link match }
+    end
+
+    def build_external_link match
+      text, url, title = match[1..-2].split("|", 3).map { |part| part.strip }
+
+      url = format_link url
+
+      if title
+        %{<a href="#{url}" title="#{title}" target="_blank">#{text}</a>}
+      else
+        %{<a href="#{url}" target="_blank">#{text}</a>}
+      end
+    end
+    
+    def format_link url
+      return url if /:\/\// =~ url
+      "http://#{url}"
+    end
+    
+    def format_list text
+      text.split(/\n/).reject { |item| item == ""  }.map { |item| wrap(item.chomp, "li") }.join("\n")      
+    end
+    
+    def format_dlist text
+      text.split(/\n/).reject { |item| item == ""  }.map { |item| split_definition(item) }.join("\n")      
+    end
+    
+    def split_definition item
+      term, definition = item.split(/\-/, 2).map{ |term| term.strip }
+      
+      return item unless definition
+      "<dt>#{term}</dt><dd>#{definition}</dd>"
+    end
+    
+    def parse_feed text
+      parser = Flannel::FeedParser.new  Flannel.cache
+      parser.sub_feeds text
+    end
+  end
+end

data/test/base_block_test.rb

@@ -3,53 +3,67 @@ require 'test_helper'
 class BaseBlockTest < Test::Unit::TestCase
   def test_initializes_with_header_array_and_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
     assert_equal "some text", block.text
   end
-  
+
   def test_initializes_with_parent_id
     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
     assert_equal "parent-id", block.parent_id
     assert_equal "some text", block.text
   end
-  
+
   def test_initializes_with_attribute_list
     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
     assert_equal "cool", block.attributes[:class]
     assert_equal "some text", block.text
   end
-  
+
+  def test_stores_in_utf_8
+    text = "some text"
+    text.encode("US-ASCII")
+    block = new_block [[[:block_type, :paragraph], [:block_id, "some-id"], [:attribute_list]], text]
+    assert_equal Encoding::UTF_8, block.text.encoding
+  end
+
+  def test_outputs_in_utf_8
+    text = "some text"
+    text.encode("US-ASCII")
+    block = new_block [[[:block_type, :paragraph], [:block_id, "some-id"], [:attribute_list]], text]
+    assert_equal Encoding::UTF_8, block.to_h.encoding
+  end
+
   def test_initializes_with_attribute_list_and_parent_id
     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
     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 = new_block [[[: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

data/test/flannel_test.rb

@@ -1,3 +1,4 @@
+
 require 'test_helper'
 
 class FlannelTest < Test::Unit::TestCase
@@ -67,5 +68,6 @@ class FlannelTest < Test::Unit::TestCase
 
       assert_equal result, Flannel.quilt(markup)
     end
+    
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 13
-  version: 0.2.13
+  - 14
+  version: 0.2.14
 platform: ruby
 authors: 
 - Jamal Hansen
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-26 00:00:00 -06:00
+date: 2010-03-01 00:00:00 -06:00
 default_executable: quilt-it
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -108,6 +108,8 @@ files:
 - features/support/env.rb
 - features/wiki_links.feature
 - flannel.gemspec
+- graphics/flannel.xcf
+- graphics/flannel_small.jpg
 - lib/flannel.rb
 - lib/flannel/base_block.rb
 - lib/flannel/block.treetop
@@ -116,6 +118,7 @@ files:
 - lib/flannel/feed_parser.rb
 - lib/flannel/file_cache.rb
 - lib/flannel/html_formatter.rb
+- lib/flannel/html_transformable.rb
 - lib/flannel/wrappable.rb
 - test/base_block_html_generation_test.rb
 - test/base_block_test.rb