red_cloth_formatters_plain 0.1

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Joseph HALTER
+
+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,31 @@
+h2. RedCloth::Formatters::Plain
+
+Similar to HTML and Latex formatters included in RedCloth, this one allows you to convert Textile to plain text discarding the Textile syntax.
+
+h3. Dependencies
+
+This plugin does of course require the RedCloth gem.
+
+h3. Example
+
+<code>
+  RedCloth.new("p. this is *simple* _test_").to_plain
+</code>
+
+will return:
+
+<code>
+  "this is simple test"
+</code>
+
+h3. Example displaying URLs
+
+<code>
+  RedCloth.new(%Q{"Please contact support":http://example.com/support}).to_plain
+</code>
+
+will return:
+
+<code>
+  "Please contact support <http://example.com/support>"
+</code>

data/Rakefile

@@ -0,0 +1,38 @@
+# load rspec as GEM or plugin
+rspec_gem_dir = nil
+Dir["#{File.dirname(__FILE__)}/../../gems/*"].each do |subdir|
+  rspec_gem_dir = subdir if subdir.gsub("#{File.dirname(__FILE__)}/../../gems/","") =~ /^(\w+-)?rspec-(\d+)/ && File.exist?("#{subdir}/lib/spec/rake/spectask.rb")
+end
+rspec_plugin_dir = File.expand_path(File.dirname(__FILE__) + '/../rspec')
+if rspec_gem_dir && (test ?d, rspec_plugin_dir)
+  raise "\n#{'*'*50}\nYou have rspec installed in both vendor/gems and vendor/plugins\nPlease pick one and dispose of the other.\n#{'*'*50}\n\n"
+end
+if rspec_gem_dir
+  $:.unshift("#{rspec_gem_dir}/lib") 
+elsif File.exist?(rspec_plugin_dir)
+  $:.unshift("#{rspec_plugin_dir}/lib")
+end
+
+# load rspec tasks
+require "rake"
+require "spec/rake/spectask"
+
+desc "Default: run specs."
+task :default => :spec
+
+desc "Run the specs"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ["--colour --format progress --loadby mtime --reverse"]
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end
+
+$LOAD_PATH.unshift File.expand_path("../lib/", __FILE__)
+require "red_cloth_formatters_plain"
+ 
+task :build do
+  system "gem build redcloth-formatters-plain.gemspec"
+end
+ 
+task :release => :build do
+  system "gem push red_cloth_formatters_plain-#{RedCloth::Formatters::Plain::VERSION}.gem"
+end

data/init.rb

@@ -0,0 +1 @@
+require "red_cloth_formatters_plain"

data/lib/red_cloth_formatters_plain.rb

@@ -0,0 +1,238 @@
+# encoding: UTF-8
+require "cgi"
+require "RedCloth"
+
+module RedCloth
+  module Formatters
+    module Plain
+      VERSION = "0.1"
+
+      class Sanitizer
+        def self.strip_tags(text)
+          # use Rails Sanitizer if available
+          begin
+            text = ActionController::Base.helpers.strip_tags(text)
+          rescue
+            # otherwise, use custom method inspired from:
+            # RedCloth::Formatters::HTML.clean_html
+            # not very secure, but it's ok as output is still
+            # meant to be escaped if it needs to be shown
+            text.gsub!( /<!\[CDATA\[/, '' )
+            text.gsub!( /<(\/*)([A-Za-z]\w*)([^>]*?)(\s?\/?)>/ ){|m| block_given? ? yield(m) : ""}
+          end
+          CGI.unescapeHTML(text)
+        end
+      end
+
+      include RedCloth::Formatters::Base
+
+      [:h1, :h2, :h3, :h4, :h5, :h6, :p, :pre, :div].each do |m|
+        define_method(m) do |opts|
+          "#{opts[:text]}\n"
+        end
+      end
+
+      [:strong, :code, :em, :i, :b, :ins, :sup, :sub, :span, :cite].each do |m|
+        define_method(m) do |opts|
+          opts[:block] = true
+          "#{opts[:text]}"
+        end
+      end
+
+      def hr(opts)
+        "\n"
+      end
+
+      def acronym(opts)
+        opts[:block] = true
+        opts[:title] ? "#{opts[:text]}(#{opts[:title]})" : "#{opts[:text]}"
+      end
+
+      def caps(opts)
+        "#{opts[:text]}"
+      end
+
+      # don't render deleted text
+      def del(opts)
+        ""
+      end
+
+      # simple list with dashes
+      [:ol, :ul].each do |m|
+        define_method("#{m}_open") do |opts|
+          opts[:block] = true
+          opts[:nest] > 1 ? "\n" : ""
+        end
+        define_method("#{m}_close") do |opts|
+          ""
+        end
+      end
+      def li_open(opts)
+        @li_need_closing = true
+        "#{"  " * (opts[:nest]-1)}- #{opts[:text]}"
+      end
+      def li_close(opts=nil)
+        # avoid multiple line breaks when closing multiple list items
+        output = @li_need_closing ? "\n" : ""
+        @li_need_closing = false
+        output
+      end
+      def dl_open(opts)
+        opts[:block] = true
+        ""
+      end
+      def dl_close(opts=nil)
+        ""
+      end
+      def dt(opts)
+        "#{opts[:text]}:\n"
+      end
+      def dd(opts)
+        "  #{opts[:text]}\n"
+      end
+
+      # don't render tables
+      [:td, :tr_open, :tr_close, :table_open, :table_close].each do |m|
+        define_method(m) do |opts|
+          ""
+        end
+      end
+
+      # just add newlines before blockquotes
+      [:bc_open, :bq_open].each do |m|
+        define_method(m) do |opts|
+          opts[:block] = true
+          ""
+        end
+      end
+      def bc_close(opts)
+        "\n"
+      end
+      def bq_close(opts)
+        ""
+      end
+
+      # render link name followed by <url>
+      # uses !LINK_OPEN_TAG! and !LINK_CLOSE_TAG! as a way to identify
+      # the < > otherwise they will be stripped when all html tags are stripped
+      #
+      def link(opts)
+        "#{opts[:name]} !LINK_OPEN_TAG!#{opts[:href]}!LINK_CLOSE_TAG!"
+      end
+
+      # render image alternative text or title if not available
+      def image(opts)
+        "#{opts[:alt] || opts[:title]}"
+      end
+
+      # don't render footnotes
+      [:footno, :fn].each do |m|
+        define_method(m) do |opts|
+          ""
+        end
+      end
+
+      def snip(opts)
+        opts[:text] + "\n"
+      end
+
+      # render unescaped quotes and special chars
+      def quote1(opts)
+        "'#{opts[:text]}'"
+      end
+      def quote2(opts)
+        "\"#{opts[:text]}\""
+      end
+      def multi_paragraph_quote(opts)
+        "\"#{opts[:text]}"
+      end
+      def ellipsis(opts)
+        "#{opts[:text]}..."
+      end
+      {
+        :emdash     => "-",
+        :endash     => " - ",
+        :arrow      => "->",
+        :trademark  => "™",
+        :registered => "®",
+        :copyright  => "©",
+        :amp        => "&",
+        :gt         => ">",
+        :lt         => "<",
+        :br         => "\n",
+        :quot       => "\"",
+        :squot      => "'",
+        :apos       => "'",
+      }.each do |method, output|
+        define_method(method) do |opts|
+          output
+        end
+      end
+      def dim(opts)
+        opts[:text]
+      end
+      def entity(opts)
+        unescape("&#{opts[:text]};")
+      end
+
+      # strip HTML tags
+      def html(opts)
+        strip_tags(opts[:text]) + "\n"
+      end
+      def html_block(opts)
+        strip_tags(opts[:text])
+      end
+      def notextile(opts)
+        if filter_html
+          "#{opts[:text]}"
+        else
+          strip_tags(opts[:text])
+        end
+      end
+      def inline_html(opts)
+        if filter_html
+          "#{opts[:text]}"
+        else
+          strip_tags(opts[:text])
+        end
+      end
+
+      # unchanged
+      def ignored_line(opts)
+        opts[:text] + "\n"
+      end
+
+    private
+
+      def strip_tags(text)
+        Sanitizer.strip_tags(text)
+      end
+
+      def unescape(str)
+        CGI.unescapeHTML(str.to_s)
+      end
+
+      # no escaping
+      [:escape, :escape_pre, :escape_attribute].each do |m|
+        define_method(m) do |text|
+          text
+        end
+      end
+      def after_transform(text)
+        text.chomp!
+      end
+      def before_transform(text)
+      end
+    end
+  end
+  class TextileDoc
+    def to_plain(*rules)
+      apply_rules(rules)
+      output = to(Formatters::Plain)
+      output = Formatters::Plain::Sanitizer.strip_tags(output)
+      # replace special link hooks with < and >
+      # See #RedCloth::Formatters::Plain#link above
+      output.gsub("!LINK_OPEN_TAG!", "<").gsub("!LINK_CLOSE_TAG!", ">")
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: red_cloth_formatters_plain
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Joseph Halter
+- Jeff Zellman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Allows Redcloth to output plain text
+email: 
+- jzellman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/red_cloth_formatters_plain.rb
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- init.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Redcloth Plain Text Formatter
+test_files: []
+