redcloth-formatters-rdoc 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,38 @@
+h1. Redcloth::Formatters::Rdoc
+
+A RedCloth formatter that enables to convert @.textile@ files to @.rdoc@ files. This is useful for compiling a @README.textile@ into a @README.rdoc@ file and use it as the main index file in the corresponding RDoc documentation.
+
+h2. Installation
+
+Add this line to your application's Gemfile:
+
+bc.. gem 'redcloth-formatters-rdoc'
+
+p. And then execute:
+
+bc.. $ bundle
+
+p. Or install it yourself as:
+
+bc.. $ gem install redcloth-formatters-rdoc
+
+h2. Usage
+
+bc.. # Compile the readme to the rdoc format
+readme_textile = File.open('README.textile', 'r+'){ |file| file.read }
+readme_rdoc = RedCloth.new(readme_textile).to_rdoc  
+File.open('README.rdoc', 'w+'){ |file| file.write(readme_rdoc) }
+
+# Create rdoc with the readme as main file
+`rdoc --main README.rdoc`
+
+# Clean up the rdoc file
+File.delete("README.rdoc")
+
+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-rdoc.rb

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

data/lib/redcloth-formatters-rdoc/formatters/r_doc.rb

@@ -0,0 +1,114 @@
+module RedCloth::Formatters::RDoc
+  include RedCloth::Formatters::Base
+  
+  [1, 2, 3, 4, 5, 6].each do |level|
+    define_method("h#{level}".to_sym) do |opts|
+      "#{'=' * level} #{opts[:text]}\n\n"
+    end
+  end
+
+  [:p, :pre, :div].each do |m|
+    define_method(m) do |opts|
+      "#{opts[:text]}\n\n"
+    end
+  end
+
+  def strong(opts)
+    "<b>#{opts[:text]}</b>"
+  end
+  alias_method :b, :strong
+
+  def em(opts)
+    "<em>#{opts[:text]}</em>"
+  end
+  alias_method :i, :em
+
+  [:ol, :ul].each do |m|
+    define_method("#{m}_open") do |opts|
+      opts[:block] = true
+      ""
+    end
+    define_method("#{m}_close") do |opts|
+      "#{"\n" if opts[:nest] <= 1}"
+    end
+  end
+
+  def li_open(opts)
+    "#{"* " * opts[:nest]}#{opts[:text]}\n"
+  end
+
+  def li_close(opts=nil)
+    ""
+  end
+
+  def td(opts)
+    tdtype = opts[:th] ? 'th' : 'td'
+    "\t\t<#{tdtype}#{pba(opts)}>#{opts[:text]}</#{tdtype}>\n"
+  end
+
+  def tr_open(opts)
+    "\t<tr#{pba(opts)}>\n"
+  end
+
+  def tr_close(opts)
+    "\t</tr>\n"
+  end
+
+  def table_open(opts)
+    "<table#{pba(opts)}>\n"
+  end
+
+  def table_close(opts)
+    "</table>\n\n"
+  end
+
+  def code(opts)
+    if opts[:block]
+      block = ""
+      opts[:text].lines.each { |line| block += "    #{line}" }
+      return block
+    end
+  
+    "<tt>#{opts[:text]}</tt>"
+  end
+
+  def bc_open(opts)
+    opts[:block] = true
+    ""
+  end
+
+  def bc_close(opts)
+    opts[:block] = false
+    "\n\n"
+  end
+
+  def link(opts)
+    "{#{opts[:name]}}[#{opts[:href]}]"
+  end
+
+  def image(opts)
+    "#{opts[:src]}"
+  end
+
+  private
+
+  # 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
+    
+end

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

@@ -0,0 +1,16 @@
+module RedCloth
+  class TextileDoc
+    
+    #
+    # Generates DocBook from the Textile contents.
+    #
+    #   RedCloth.new( "And then? She *fell*!" ).to_rdoc
+    #     #=> "And then? She fell!"
+    #
+    def to_rdoc(*rules)
+      apply_rules(rules)
+      
+      to(RedCloth::Formatters::RDoc)
+    end
+  end
+end

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

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

data/redcloth-formatters-rdoc.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/redcloth-formatters-rdoc/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 rdoc}
+  gem.summary       = %q{A RedCloth formatter that enables to convert *.textile files to .rdoc files. This is useful for compiling a README.textile into a README.rdoc file and use it as the main index file in the corresponding RDoc documentation.}
+  gem.homepage      = "http://southdesign.github.com/redcloth-formatters-rdoc"
+
+  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-rdoc"
+  gem.require_paths = ["lib"]
+  gem.version       = Redcloth::Formatters::RDoc::VERSION
+end

data/spec/fixtures/sample.rdoc

@@ -0,0 +1,53 @@
+= Text Markup and Links
+
+Some text which contains <b>bold</b> and <tt>code</tt> and <em>emphasized</em>. Okay
+let's see how it is doing with links:
+
+* {RDoc}[http://rdoc.org]
+
+== Source Code
+
+Multiple lines of code:
+
+    # This is some code
+    That should be parsed right
+
+Single line of code:
+
+    #and some code again
+
+== A List
+
+* <b>A list entry</b>
+* * A sublist entry
+* A sublist entry
+* * * A sublist entry
+
+== A Table
+
+<table>
+	<tr>
+		<th>Value               </th>
+		<th>JMeter          </th>
+		<th>BigBench        </th>
+	</tr>
+	<tr>
+		<td> Total Requests        </td>
+		<td> 48.014            </td>
+		<td> 55.484            </td>
+	</tr>
+	<tr>
+		<td> Requests/sec          </td>
+		<td> 377               </td>
+		<td> 462               </td>
+	</tr>
+	<tr>
+		<td> Percentages           </td>
+		<td> 100%%             </td>
+		<td> 116%              </td>
+	</tr>
+</table>
+
+== An Image
+
+http://southdesign.github.com/bigbench/images/structure.png

data/spec/fixtures/sample.textile

@@ -0,0 +1,35 @@
+h1. Text Markup and Links
+
+Some text which contains *bold* and @code@ and _emphasized_. Okay
+let's see how it is doing with links:
+
+* "RDoc":http://rdoc.org
+
+h2. Source Code
+
+Multiple lines of code:
+
+bc.. # This is some code
+That should be parsed right
+
+p. Single line of code:
+
+bc.. #and some code again
+
+h2. A List
+
+* *A list entry*
+** A sublist entry
+* A sublist entry
+*** A sublist entry
+
+h2. A Table
+
+|_. Value               |_. JMeter          |_. BigBench        |
+| Total Requests        | 48.014            | 55.484            |
+| Requests/sec          | 377               | 462               |
+| Percentages           | 100%%             | 116%              |
+
+h2. An Image
+
+!http://southdesign.github.com/bigbench/images/structure.png(BigBench Request Structure)!

data/spec/helpers.rb

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

data/spec/rdoc_spec.rb

@@ -0,0 +1,12 @@
+require_relative "./helpers"
+
+describe RedCloth::Formatters::RDoc do
+  
+  it "should convert the textile fixture to the rdoc fixture" do
+    textile = File.open("spec/fixtures/sample.textile", "r"){ |file| file.read }
+    rdoc    = File.open("spec/fixtures/sample.rdoc", "r"){ |file| file.read }
+    
+    RedCloth.new(textile).to_rdoc.should == rdoc
+  end
+  
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: redcloth-formatters-rdoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Fankhauser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-21 00:00:00.000000000 Z
+dependencies: []
+description: A RedCloth formatter that compiles textile to rdoc
+email:
+- tommylefunk@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.textile
+- Rakefile
+- lib/redcloth-formatters-rdoc.rb
+- lib/redcloth-formatters-rdoc/formatters/r_doc.rb
+- lib/redcloth-formatters-rdoc/textile_doc.rb
+- lib/redcloth-formatters-rdoc/version.rb
+- redcloth-formatters-rdoc.gemspec
+- spec/fixtures/sample.rdoc
+- spec/fixtures/sample.textile
+- spec/helpers.rb
+- spec/rdoc_spec.rb
+homepage: http://southdesign.github.com/redcloth-formatters-rdoc
+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 .rdoc files.
+  This is useful for compiling a README.textile into a README.rdoc file and use it
+  as the main index file in the corresponding RDoc documentation.
+test_files:
+- spec/fixtures/sample.rdoc
+- spec/fixtures/sample.textile
+- spec/helpers.rb
+- spec/rdoc_spec.rb