vidibus-textile 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://gemcutter.org"
+gem "bundler", "~> 1.0.0"
+gem "RedCloth"
+gem "activesupport", "~> 3.0.0"
+gem "actionpack", "~> 3.0.0"
+gem "rspec", "~> 2.0.0.beta.20"
+gem "rr"
+gem "relevance-rcov"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+GEM
+  remote: http://gemcutter.org/
+  specs:
+    RedCloth (4.2.3)
+    abstract (1.0.0)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    relevance-rcov (0.9.2.1)
+    rr (1.0.0)
+    rspec (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+      rspec-mocks (= 2.0.0.beta.22)
+    rspec-core (2.0.0.beta.22)
+    rspec-expectations (2.0.0.beta.22)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  actionpack (~> 3.0.0)
+  activesupport (~> 3.0.0)
+  bundler (~> 1.0.0)
+  relevance-rcov
+  rr
+  rspec (~> 2.0.0.beta.20)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Andre Pankratz
+
+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.rdoc

@@ -0,0 +1,39 @@
+= vidibus-textile
+
+Basically, this is a wrapper for RedCloth with some extensions. It is inspired by the acts_as_textiled plugin, but without the model integration (for now).
+
+This gem is part of the open source SOA framework Vidibus: http://vidibus.org.
+
+
+== Usage
+
+The basic two methods are:
+
+  #to_html (provided by RedCloth)
+  Vidibus::Textile.new('Some *say*, "love":http://doit.xxx is a _river_.').to_html
+  # => '<p>Some <strong>say</strong>, <a href="http://doit.xxx">love</a> is a <em>river</em>.</p>'
+
+  #to_text
+  Vidibus::Textile.new('Some *say*, "love":http://doit.xxx is a _river_.').to_text
+  # => "Some say, love is a river."
+
+The method #to_text will return a plain text version of textile content but keep newlines intact. However, if
+you just want a stripped version without newlines, provide the option :plain => true
+
+  #to_text with :plain => true
+  Vidibus::Textile.new("Super\nTrouper").to_text(:plain => true)
+  # => "Super Trouper"
+
+
+== View helper
+
+For your convenience, the view helper ##stripped is available (as couterpart for Rails' ##textilize).
+
+  # In you view...
+  stripped("*Super*\nTrouper", :plain => true)
+  # => "Super Trouper"
+
+
+== Copyright
+
+Copyright (c) 2010 Andre Pankratz. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,38 @@
+require "rubygems"
+require "rake"
+require "rake/rdoctask"
+require "rspec"
+require "rspec/core/rake_task"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "vidibus-textile"
+    gem.summary = %Q{Wrapper for RedCloth with extensions.}
+    gem.description = %Q{Provides textile formatting through RedCloth and adds methods for getting plain text version of textile markup.}
+    gem.email = "andre@vidibus.com"
+    gem.homepage = "http://github.com/vidibus/vidibus-textile"
+    gem.authors = ["Andre Pankratz"]
+    gem.add_dependency "RedCloth"
+    gem.add_dependency "activesupport"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+Rspec::Core::RakeTask.new(:rcov) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.rcov = true
+  t.rcov_opts = ["--exclude", "^spec,/gems/", "-Ispec"]
+end
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "vidibus-textile #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+  rdoc.options << "--charset=utf-8"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/vidibus/textile/extensions/view.rb

@@ -0,0 +1,15 @@
+module Vidibus
+  module Textile
+    module Extensions
+      module View
+        extend ActiveSupport::Concern
+
+        # Returns plain text without markup.
+        # If option :plain is true, newlines will be removed.
+        def stripped(string, options = {})
+          string ? Vidibus::Textile.new(string).to_text(options) : ""
+        end
+      end
+    end
+  end
+end

data/lib/vidibus/textile/extensions.rb

@@ -0,0 +1,5 @@
+require "textile/extensions/view"
+
+ActiveSupport.on_load(:action_view) do
+  include Vidibus::Textile::Extensions::View
+end

data/lib/vidibus/textile.rb

@@ -0,0 +1,72 @@
+require "textile/extensions"
+
+module Vidibus
+  module Textile
+
+    # A convenience method for creating a new TextileDoc. See
+    # RedCloth::TextileDoc.
+    def self.new(*args, &block)
+      Textile::Doc.new(*args, &block)
+    end
+
+    # Include extension modules (if any) in TextileDoc.
+    def self.include(*args)
+      Textile::Doc.send(:include, *args)
+    end
+
+    class Doc < ::RedCloth::TextileDoc
+
+      # Returns plain text without markup.
+      # If option :plain is true, newlines will be removed.
+      def to_text(options = {})
+        text = strip_html(self.to_html)
+        if options[:plain] == true
+          return strip_newlines(text)
+        end
+        text
+      end
+
+      private
+
+      # Remove html tags and redcloth glyphs from input string.
+      def strip_html(input)
+        input.dup.gsub(html_regexp, '').tap do |h|
+          for entity, char in redcloth_glyphs
+            h.gsub!(entity, char)
+          end
+        end
+      end
+
+      # Replace newlines by white space.
+      def strip_newlines(input)
+        input.gsub(/(\r?\n)+/," ")
+      end
+
+      # Returns a list of RedCloth conversions of special chars.
+      def redcloth_glyphs
+        {
+          "&#8217;" => "'",
+          "&#8216" => "'",
+          "&lt;" => "<",
+          "&gt;" => ">",
+          "&#8221;" => '"',
+          "&#8220;" => '"',
+          "&#8230;" => "...",
+          "\1&#8212;" => "--",
+          " &rarr; " => "->",
+          " &#8211; " => "-",
+          "&#215;" => "-",
+          "&#8482;" => "(TM)",
+          "&#174;" => "(R)",
+          "&#169;" => "(C)",
+          "&amp;" => "&"
+        }.freeze
+      end
+
+      # Returns regular expression to identifiy html tags.
+      def html_regexp
+        /<(?:[^>"']+|"(?:\\.|[^\\"]+)*"|'(?:\\.|[^\\']+)*')*>/xm
+      end
+    end
+  end
+end

data/lib/vidibus-textile.rb

@@ -0,0 +1,5 @@
+require "redcloth"
+require "active_support"
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib", "vidibus"))
+require "textile"

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "rubygems"
+require "rspec"
+require "vidibus-textile"
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

data/spec/vidibus/textile/action_view_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper.rb"
+require "action_view"
+
+describe ActionView::Base do
+  describe "#stripped" do
+    it "should call Vidibus::Textile::Doc#to_text" do
+      mock.any_instance_of(Vidibus::Textile::Doc).to_text({})
+      subject.stripped("something")
+    end
+
+    it "should accept options" do
+      mock.any_instance_of(Vidibus::Textile::Doc).to_text(:plain => true)
+      subject.stripped("something", :plain => true)
+    end
+
+    it "should work as intended" do
+      subject.stripped('Some *say*, "love":http://doit.xxx is a _river_.').should eql("Some say, love is a river.")
+    end
+
+    it "should handle empty content" do
+      dont_allow.any_instance_of(Vidibus::Textile::Doc).to_text({})
+      subject.stripped(nil).should eql("")
+    end
+  end
+end

data/spec/vidibus/textile_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe Vidibus::Textile do
+  describe "#to_html" do
+    it "should contain textile content as html" do
+      textile = Vidibus::Textile.new('Some *say*, "love":http://doit.xxx is a _river_.')
+      textile.to_html.should eql('<p>Some <strong>say</strong>, <a href="http://doit.xxx">love</a> is a <em>river</em>.</p>')
+    end
+  end
+
+  describe "#to_text" do
+    it "should not contain plain description without html or textile markup" do
+      textile = Vidibus::Textile.new('Some *say*, "love":http://doit.xxx is a _river_.')
+      textile.to_text.should eql("Some say, love is a river.")
+    end
+
+    it "should not contain RedCloth glyphs" do
+      textile = Vidibus::Textile.new(%(<Chief's> "Special" & Sauce (C)))
+      textile.to_text.should eql(%(<Chief's> "Special" & Sauce (C)))
+    end
+
+    it "should contain newlines" do
+      textile = Vidibus::Textile.new("Super\nTrouper")
+      textile.to_text.should eql("Super\nTrouper")
+    end
+
+    it "should not contain newlines if option :plain is true" do
+      textile = Vidibus::Textile.new("Super\nTrouper")
+      textile.to_text(:plain => true).should eql("Super Trouper")
+    end
+  end
+end

data/vidibus-textile.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{vidibus-textile}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andre Pankratz"]
+  s.date = %q{2010-10-01}
+  s.description = %q{Provides textile formatting through RedCloth and adds methods for getting plain text version of textile markup.}
+  s.email = %q{andre@vidibus.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/vidibus-textile.rb",
+     "lib/vidibus/textile.rb",
+     "lib/vidibus/textile/extensions.rb",
+     "lib/vidibus/textile/extensions/view.rb",
+     "spec/spec_helper.rb",
+     "spec/vidibus/textile/action_view_spec.rb",
+     "spec/vidibus/textile_spec.rb",
+     "vidibus-textile.gemspec"
+  ]
+  s.homepage = %q{http://github.com/vidibus/vidibus-textile}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Wrapper for RedCloth with extensions.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/vidibus/textile/action_view_spec.rb",
+     "spec/vidibus/textile_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<RedCloth>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<RedCloth>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<RedCloth>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: vidibus-textile
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andre Pankratz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-01 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  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: Provides textile formatting through RedCloth and adds methods for getting plain text version of textile markup.
+email: andre@vidibus.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/vidibus-textile.rb
+- lib/vidibus/textile.rb
+- lib/vidibus/textile/extensions.rb
+- lib/vidibus/textile/extensions/view.rb
+- spec/spec_helper.rb
+- spec/vidibus/textile/action_view_spec.rb
+- spec/vidibus/textile_spec.rb
+- vidibus-textile.gemspec
+has_rdoc: true
+homepage: http://github.com/vidibus/vidibus-textile
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Wrapper for RedCloth with extensions.
+test_files: 
+- spec/spec_helper.rb
+- spec/vidibus/textile/action_view_spec.rb
+- spec/vidibus/textile_spec.rb