redcloth-formatters-ast 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redcloth-formatters-rdoc.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Thomas Fankhauser
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,33 @@
+h1. Redcloth::Formatters::AST
+
+A RedCloth formatter that enables to convert @.textile@ files to an AST.
+
+h2. Installation
+
+Add this line to your application's Gemfile:
+
+bc.. gem 'redcloth-formatters-ast'
+
+p. And then execute:
+
+bc.. $ bundle
+
+p. Or install it yourself as:
+
+bc.. $ gem install redcloth-formatters-ast
+
+h2. Usage
+
+bc.. # Compile a textile to an AST hash
+textile_file = File.read 'a.textile'
+ast_hash = RedCloth.new(textile_file).to_ast
+
+# Do something with the AST
+
+h2. Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/redcloth-formatters-ast/formatters/ast.rb

@@ -0,0 +1,215 @@
+module RedCloth::Formatters::AST
+  include RedCloth::Formatters::Base
+  
+  @@ast = []
+          
+  [:title, :subtitle, :author, :copyright, :h0, :h1, :h2, :h3, :h4, :cite].each do |m|
+    define_method(m) do |opts|
+      @@ast << { :type => m, :text => opts[:text], :options => parse_css(opts[:style]) }
+      ""
+    end
+  end
+  
+  def strong(opts)
+    "<b>#{opts[:text]}</b>"
+  end
+  
+  def em(opts)
+    "<i>#{opts[:text]}</i>"
+  end
+  
+  def p(opts)
+    return "" if opts[:text] =~ /^[\n]$+/
+    if opts[:append_to_parent]
+      @@ast.last[:text] << "#{opts[:text]}\n\n"
+    else
+      @@ast << { :type => :p, :text => opts[:text], :options => parse_css(opts[:style]) }
+    end
+    ""
+  end
+
+  # lists
+  @@list_levels = { :ul => 0, :ol => 0, :last => nil }
+  def ul_open(opts)
+    @@ast << { :type => :unnumbered_list, :items => [], :options => parse_css(opts[:style]) } if @@list_levels[:ul] == 0
+    @@list_levels[:ul] += 1
+    @@list_levels[:last] = :ul
+    ""
+  end
+
+  def ul_close(opts)
+    @@list_levels[:ul] -= 1
+    ""
+  end
+  
+  @@ol_level = 0
+  def ol_open(opts)
+    @@ast << { :type => :numbered_list, :items => [], :options => parse_css(opts[:style]) } if @@list_levels[:ol] == 0
+    @@list_levels[:ol] += 1
+    @@list_levels[:last] = :ol
+    ""
+  end
+
+  def ol_close(opts)
+    @@list_levels[:ol] -= 1
+    ""
+  end
+
+  def li_open(opts)
+    @@ast.last[:items] << { :type => :list_item, :text => opts[:text], :level => @@list_levels[@@list_levels[:last]]-1, :options => parse_css(opts[:style]) }
+    ""
+  end
+
+  def li_close(opts=nil)
+    ""
+  end
+
+  # tables
+  def table_open(opts)
+    options = parse_css(opts[:style])
+    @@ast << { :type => :table, :title => options[:name], :header => false, :rows => [], :options => options }
+    ""
+  end
+
+  def table_close(opts)
+    ""
+  end
+  
+  def tr_open(opts)
+    @@ast.last[:rows] << []
+    ""
+  end
+
+  def td(opts)
+    @@ast.last[:header] = true if opts[:th]
+    @@ast.last[:rows].last << { :type => :table_cell, :text => opts[:text].strip, :header => !opts[:th].nil? }
+    ""
+  end
+
+
+  # footnotes
+  def footno(opts)
+    opts[:id] ||= opts[:text]
+    "<sup>#{opts[:id]}</sup>"
+  end
+
+  def fn(opts)
+    @@ast << { :type => :footnote, :id => opts[:id], :text => opts[:text], :options => parse_css(opts[:style]) }
+    ""
+  end
+
+  def link(opts)
+    @@ast << { :type => :link, :href => opts[:href], :name => opts[:name], :options => parse_css(opts[:style]) }
+    ""
+  end
+
+  def image(opts)
+    title = opts[:title]
+    id = title.split(" ").join(".")
+    options = parse_css(opts[:style])
+    width = options[:width] || "100%"
+    
+    @@ast << { :type => :image, :title => title, :src => opts[:src], :width => width, :options => options }
+    ""
+  end
+  
+  def bq_open(opts)
+    opts[:block] = true
+    opts[:append_to_parent] = true
+    options = parse_css(opts[:style])
+    @@ast << { :type => :blockquote, :text => "", :by => options[:by], :options => options }
+    ""
+  end
+
+  def bq_close(opts)
+    opts[:append_to_parent] = false
+    ""
+  end
+
+  # source
+  def bc_open(opts)
+    opts[:block] = true
+    opts[:append_to_parent] = true
+    options = parse_css(opts[:style])
+    @@ast << { :type => :code, :text => "", :title => options[:name], :options => options }
+    ""
+  end
+  
+  def code(opts)
+    if opts[:append_to_parent]
+      @@ast.last[:text] << "#{opts[:text]}\n\n"
+    else
+      @@ast << { :type => :code, :text => opts[:text], :options => parse_css(opts[:style]) }
+    end
+    ""
+  end
+
+  def bc_close(opts)
+    opts[:append_to_parent] = false
+    ""
+  end
+  
+  def self.ast
+    @@ast
+  end
+  
+  def self.reset!
+    @@ast = []
+  end
+
+  private
+
+  def parse_css css
+    options = {}
+    begin
+      css = css.split ";"
+      css.each do |css|
+        key, value = css.split ":"
+        options[key.strip.to_sym] = value.strip
+      end
+    rescue
+    end
+    options
+  end
+
+  def parse_id name
+    name.gsub(",", "").gsub(".", "").squeeze(" ").strip.gsub(" ", "")
+  end
+
+  def clean_text(text)
+    text.gsub("\n", " ").gsub("\t", " ").squeeze(" ").strip
+  end
+
+  # escapement for regular HTML (not in PRE tag)
+  def escape(text)
+    text
+  end
+
+  # escapement for HTML in a PRE tag
+  def escape_pre(text)
+    text
+  end
+
+  # escaping for HTML attributes
+  def escape_attribute(text)
+    text
+  end
+
+  def after_transform(text)
+    text.chomp!
+  end
+
+
+  def before_transform(text)
+
+  end
+
+  def method_missing(method, opts)
+    opts[:text] || ""
+  end
+
+  def formatter_methods
+    singleton_methods.map! {|method| method.to_sym }
+  end
+    
+end

data/lib/redcloth-formatters-ast/textile_doc.rb

@@ -0,0 +1,18 @@
+module RedCloth
+  class TextileDoc
+    
+    #
+    # Generates an AST from the Textile contents.
+    #
+    #   RedCloth.new( "!some/image/path.png!" ).to_ast
+    #     #=> { :type => :image, :src => "some/image/path.png" }
+    #
+    def to_ast(*rules)
+      apply_rules(rules)
+      
+      RedCloth::Formatters::AST.reset!
+      to(RedCloth::Formatters::AST)
+      RedCloth::Formatters::AST.ast
+    end
+  end
+end

data/lib/redcloth-formatters-ast/version.rb

@@ -0,0 +1,7 @@
+module Redcloth
+  module Formatters
+    module AST
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/redcloth-formatters-ast.rb

@@ -0,0 +1,5 @@
+require 'RedCloth'
+
+require 'redcloth-formatters-ast/version'
+require 'redcloth-formatters-ast/formatters/ast'
+require 'redcloth-formatters-ast/textile_doc'

data/redcloth-formatters-ast.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/redcloth-formatters-ast/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Thomas Fankhauser"]
+  gem.email         = ["tommylefunk@googlemail.com"]
+  gem.description   = %q{A RedCloth formatter that compiles textile to an AST}
+  gem.summary       = %q{A RedCloth formatter that enables to convert *.textile files to a AST hash. This is usefull for further processing.}
+  gem.homepage      = "http://southdesign.github.com/redcloth-formatters-ast"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "redcloth-formatters-ast"
+  gem.require_paths = ["lib"]
+  gem.version       = Redcloth::Formatters::AST::VERSION
+end

data/spec/ast_spec.rb

@@ -0,0 +1,98 @@
+require_relative "./helpers"
+
+describe RedCloth::Formatters::AST do
+  
+  it "should compile title, subtitle, author, copyright, h0, h1, h2, h3, h4, i, em, b, strong, cite" do
+    textile = File.read "spec/fixtures/title_subtitle.textile"
+    RedCloth.new(textile).to_ast.should == [
+      { :type => :title,     :text => "Sample Document",                                      :options => {}},
+      { :type => :subtitle,  :text => "How to load multiple documents",                       :options => {}}, 
+      { :type => :author,    :text => "Thomas Fankhauser",                                    :options => {}}, 
+      { :type => :copyright, :text => "2010, Thomas Fankhauser, All rights reserved.",        :options => {}}, 
+      { :type => :h0,        :text => "Application",                                          :options => {}}, 
+      { :type => :h1,        :text => "Board",                                                :options => {}}, 
+      { :type => :h2,        :text => "Names",                                                :options => {}}, 
+      { :type => :h3,        :text => "Meetings",                                             :options => {}}, 
+      { :type => :h4,        :text => "Tests",                                                :options => {}},
+      { :type => :p,         :text => "Some <b>bold</b> text. And some <i>italic</i> text.",  :options => {}}
+    ]
+  end
+  
+  it "should compile lists" do
+    textile = File.read "spec/fixtures/lists.textile"
+    RedCloth.new(textile).to_ast.should == [
+      { :type => :unnumbered_list, :items => [
+        { :type => :list_item, :text => "First Entry",  :level => 0, :options => {}}, 
+        { :type => :list_item, :text => "Second Entry", :level => 0, :options => {}},
+        { :type => :list_item, :text => "Sub Entry 1",  :level => 1, :options => {}},
+        { :type => :list_item, :text => "Sub Entry 2",  :level => 1, :options => {}},
+        { :type => :list_item, :text => "Third Entry",  :level => 0, :options => {}}
+      ], :options => {}}, 
+       
+      { :type => :numbered_list, :items => [
+        { :type => :list_item, :text => "A numbered entry",       :level => 0, :options => {}},
+        { :type => :list_item, :text => "A sub numbered entry",   :level => 1, :options => {}},
+        { :type => :list_item, :text => "Another numbered entry", :level => 0, :options => {}}
+      ], :options => {}}
+    ]
+  end
+  
+  it "should compile tables" do
+    textile = File.read "spec/fixtures/tables.textile"
+    RedCloth.new(textile).to_ast.should == [
+      { :type => :table, :title => "Attendees", :header => true, :rows => [
+        [
+          { :type => :table_cell, :text => "Name",    :header => true }, 
+          { :type => :table_cell, :text => "Age",     :header => true }, 
+          { :type => :table_cell, :text => "Sex",     :header => true }
+        ], 
+        [
+          { :type => :table_cell, :text => "Joan",    :header => false }, 
+          { :type => :table_cell, :text => "24",      :header => false }, 
+          { :type => :table_cell, :text => "F",       :header => false }
+        ], 
+        [
+          { :type => :table_cell, :text => "Archie",  :header => false }, 
+          { :type => :table_cell, :text => "29",      :header => false }, 
+          { :type => :table_cell, :text => "M",       :header => false }
+        ], 
+        [
+          { :type => :table_cell, :text => "Bello",   :header => false }, 
+          { :type => :table_cell, :text => "45",      :header => false }, 
+          { :type => :table_cell, :text => "F",       :header => false }
+        ]
+      ], :options => {:name => "Attendees", :cols => "3", :align => "left"}
+    }
+    ]
+  end
+  
+  it "should compile footnotes" do
+    textile = File.read "spec/fixtures/footnotes.textile"
+    RedCloth.new(textile).to_ast.should == [
+      {:type=>:p, :text=>"This is a normal text<sup>1</sup> with a footnote in it.", :options=>{}},
+      {:type=>:p, :text=>"And here is some more text with even more footnotes<sup>2</sup> in it.", :options=>{}}, 
+      {:type=>:footnote, :id=>"1", :text=>"This is the actual footnote.", :options=>{}}, 
+      {:type=>:footnote, :id=>"2", :text=>"A Footnote is this.", :options=>{}}]
+  end
+  
+  it "should compile links and images" do
+    textile = File.read "spec/fixtures/link_image.textile"
+    RedCloth.new(textile).to_ast.should == [
+      { :type=>:link,   :href=>"http://example.com",  :name=>"Text to display",     :options=>{}}, 
+      { :type=>:link,   :href=>"http://example.com",  :name=>"Text to display",     :options=>{}},
+      { :type=>:image,  :title=>"A great image",      :src=>"../images/image.png",  :width=>"100%", :options=>{}},
+      { :type=>:image,  :title=>"A great image",      :src=>"../images/image.png",  :width=>"90%",  :options=>{:width=>"90%"}}, 
+    ]
+  end
+  
+  it "should compile blockquotes and source" do
+    textile = File.read "spec/fixtures/blockquote_source.textile"
+    RedCloth.new(textile).to_ast.should == [
+      { :type => :blockquote,  :text => "This is a blockquote\nthat spans multiple lines.\n\nAnd continues here.\n\n", :by=>"Thomas Fankhauser", :options=>{:by=>"Thomas Fankhauser"}}, 
+      { :type => :code,        :text => "module RedCloth\n  class TextileDoc\n\n    #\n    # Generates an AST from the Textile contents.\n    #\n    #   RedCloth.new( \"!some/image/path.png!\" ).to_ast\n    #     #=> { :type => :image, :src => \"some/image/path.png\" }\n    #\n    def to_ast(*rules)\n      apply_rules(rules)\n\n      RedCloth::Formatters::AST.reset!\n      to(RedCloth::Formatters::AST)\n      RedCloth::Formatters::AST.ast\n    end\n  end\nend\n\n", :title=>"A Ruby Racer", :options=>{:name=>"A Ruby Racer"}}
+    ]
+  end
+  
+  
+  
+end

data/spec/fixtures/blockquote_source.textile

@@ -0,0 +1,23 @@
+bq{by:Thomas Fankhauser;}.. This is a blockquote
+that spans multiple lines.
+
+And continues here.
+
+bc{name:A Ruby Racer}.. module RedCloth
+  class TextileDoc
+    
+    #
+    # Generates an AST from the Textile contents.
+    #
+    #   RedCloth.new( "!some/image/path.png!" ).to_ast
+    #     #=> { :type => :image, :src => "some/image/path.png" }
+    #
+    def to_ast(*rules)
+      apply_rules(rules)
+      
+      RedCloth::Formatters::AST.reset!
+      to(RedCloth::Formatters::AST)
+      RedCloth::Formatters::AST.ast
+    end
+  end
+end

data/spec/fixtures/footnotes.textile

@@ -0,0 +1,7 @@
+This is a normal text[1] with a footnote in it.
+
+And here is some more text with even more footnotes[2] in it.
+
+fn1. This is the actual footnote.
+
+fn2. A Footnote is this.

data/spec/fixtures/link_image.textile

@@ -0,0 +1,4 @@
+"Text to display":http://example.com
+"Text to display (Title text)":http://example.com
+!../images/image.png(A great image)!
+!{width: 90%;}../images/image.png(A great image)!

data/spec/fixtures/lists.textile

@@ -0,0 +1,9 @@
+* First Entry
+* Second Entry
+** Sub Entry 1
+** Sub Entry 2
+* Third Entry
+
+# A numbered entry
+## A sub numbered entry
+# Another numbered entry

data/spec/fixtures/tables.textile

@@ -0,0 +1,5 @@
+table{name:Attendees; cols:3; align: left;}.
+|_. Name    |_. Age |_. Sex |
+| Joan      | 24    | F     |
+| Archie    | 29    | M     |
+| Bello     | 45    | F     |

data/spec/fixtures/title_subtitle.textile

@@ -0,0 +1,20 @@
+title. Sample Document
+
+subtitle. How to load multiple documents
+
+author. Thomas Fankhauser
+
+copyright. 2010, Thomas Fankhauser, All rights reserved.
+
+
+h0. Application
+
+h1. Board
+
+h2. Names
+
+h3. Meetings
+
+h4. Tests
+
+Some *bold* text. And some _italic_ text.

data/spec/helpers.rb

@@ -0,0 +1,9 @@
+require 'redcloth-formatters-ast'
+
+module Helpers 
+end
+
+RSpec.configure do |config|
+  config.include Helpers
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: redcloth-formatters-ast
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Fankhauser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-28 00:00:00.000000000 Z
+dependencies: []
+description: A RedCloth formatter that compiles textile to an AST
+email:
+- tommylefunk@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.textile
+- Rakefile
+- lib/redcloth-formatters-ast.rb
+- lib/redcloth-formatters-ast/formatters/ast.rb
+- lib/redcloth-formatters-ast/textile_doc.rb
+- lib/redcloth-formatters-ast/version.rb
+- redcloth-formatters-ast.gemspec
+- spec/ast_spec.rb
+- spec/fixtures/blockquote_source.textile
+- spec/fixtures/footnotes.textile
+- spec/fixtures/link_image.textile
+- spec/fixtures/lists.textile
+- spec/fixtures/tables.textile
+- spec/fixtures/title_subtitle.textile
+- spec/helpers.rb
+homepage: http://southdesign.github.com/redcloth-formatters-ast
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A RedCloth formatter that enables to convert *.textile files to a AST hash.
+  This is usefull for further processing.
+test_files:
+- spec/ast_spec.rb
+- spec/fixtures/blockquote_source.textile
+- spec/fixtures/footnotes.textile
+- spec/fixtures/link_image.textile
+- spec/fixtures/lists.textile
+- spec/fixtures/tables.textile
+- spec/fixtures/title_subtitle.textile
+- spec/helpers.rb