prarupa 0.1

data/README.md

@@ -0,0 +1,78 @@
+Prarupa
+=======
+
+Prarupa is plugin for Rails 3 that provides the `textilize`, `textilize_without_paragraph` and `markdown` helpers. These were extracted from Rails and have been modified slightly. Instead of using `BlueCloth` for `markdown`, Prarupa uses `RDiscount` which is supposed to be faster and better maintained. Other minor internal tweaks have been made.
+
+Install
+=======
+
+You can either install Prarupa as a gem or plugin. Installing as a gem is the preferred choice.
+
+Install as a gem
+----------------
+
+Simply add `prarupa` to the Gemfile. Also add `RedCloth` for textilize & textilize_without_paragraph and/or add `rdiscount` for markdown. Now just `bundle install` and you should be good to go. Note that installing `prarupa` will also install `rdiscount` and `markdown` as dependencies.
+
+Install as a plugin
+-------------------
+
+To install as a plugin simply do `rails plugin install git://github.com/rohit/prarupa.git`
+
+Example
+=======
+
+In your views you can do the following.
+
+The `textilize` and `textilize_without_paragraph` helpers
+---------------------------------------------------------
+
+The `textilize` helper accepts a string of [Textile](http://redcloth.org/textile) and optionally one or more options.
+
+Without any options:
+
+    textilize("This is *how* we _textilize_ in Rails!")
+    # => "<p>This is <strong>how</strong> we <em>textilize</em> in Rails!</p>"
+    
+With options:
+
+    textilize("This is *how* we <em>textilize</em> in Rails!", :filter_html)
+    # => "<p>This is <strong>how</strong> we &lt;em&gt;textilize&lt;/em&gt; in Rails!</p>"
+
+Note that you can provide multiple options like `textilize("text", :filter_html, :lite_mode)`
+
+The `textilize_without_paragraph` is similar to `textilize`, except that the surrounding &lt;p&gt; and &lt;/p&gt; tags are removed. It accepts options just like `textilize`
+
+    textilize_without_paragraph("This is *how* we _textilize_ in Rails!")
+    # => "This is <strong>how</strong> we <em>textilize</em> in Rails!"
+
+The `markdown` helper
+---------------------
+
+The `markdown` helper accepts a string of [Markdown](http://daringfireball.net/projects/markdown/) and optionally one or more options.
+
+Without any options:
+
+    markdown("This is *how* we **markdown** in Rails!")
+    # => "<p>This is <em>how</em> we <strong>markdown</strong> in Rails!</p>" 
+
+With options:
+
+    markdown("Greedy urls are here! http://rohitarondekar.com", :autolink)
+    # => "<p>Greedy urls are here! <a href=\"http://rohitarondekar.com\">http://rohitarondekar.com</a></p>"
+
+To be `:safe`
+============
+
+Being Rails text helpers, all three methods accept the `:safe` option that tells the helpers that the input text need not be sanitized.
+
+Credits
+=======
+
+[David Trasbo](http://github.com/dtrasbo) for making the awesome (official?) plugin [formatize](http://github.com/dtrasbo/formatize) which extracts the helpers without any modification. I liberally used his gem as reference.
+
+Todo
+====
+
+* Tidy up the rdocs
+
+Copyright (c) 2010 Rohit Arondekar, released under the MIT license

data/lib/prarupa/text_helpers.rb

@@ -0,0 +1,92 @@
+module Prarupa
+  module TextHelpers
+    # Returns the text with all the Textile[http://www.textism.com/tools/textile] codes turned into HTML tags.
+    #
+    # You can learn more about Textile's syntax at its website[http://www.textism.com/tools/textile].
+    # <i>This method requires RedCloth[http://redcloth.org/] to be installed</i>.
+    #
+    # ==== Examples
+    #   textilize("*This is Textile!*  Rejoice!")
+    #   # => "<p><strong>This is Textile!</strong>  Rejoice!</p>"
+    #
+    #   textilize("I _love_ ROR(Ruby on Rails)!")
+    #   # => "<p>I <em>love</em> <acronym title="Ruby on Rails">ROR</acronym>!</p>"
+    #
+    #   textilize("h2. Textile makes markup -easy- simple!")
+    #   # => "<h2>Textile makes markup <del>easy</del> simple!</h2>"
+    #
+    #   textilize("Visit the Rails website "here":http://www.rubyonrails.org/.)
+    #   # => "<p>Visit the Rails website <a href="http://www.rubyonrails.org/">here</a>.</p>"
+    #
+    #   textilize("This is worded <strong>strongly</strong>")
+    #   # => "<p>This is worded <strong>strongly</strong></p>"
+    #
+    #   textilize("This is worded <strong>strongly</strong>", :filter_html)
+    #   # => "<p>This is worded &lt;strong&gt;strongly&lt;/strong&gt;</p>"
+    #
+    def textilize(text, *options)
+      options ||= [:hard_breaks]
+      text = sanitize(text) unless text.html_safe? || options.delete(:safe)
+
+      if text.blank?
+        ""
+      else
+        textilized = RedCloth.new(text, options)
+        textilized.to_html.html_safe
+      end
+    end
+
+    # Returns the text with all the Textile codes turned into HTML tags,
+    # but without the bounding <p> tag that RedCloth adds.
+    #
+    # You can learn more about Textile's syntax at its website[http://www.textism.com/tools/textile].
+    # <i>This method is only available if RedCloth[http://redcloth.org/] is available</i>.
+    #
+    # ==== Examples
+    #   textilize_without_paragraph("*This is Textile!*  Rejoice!")
+    #   # => "<strong>This is Textile!</strong>  Rejoice!"
+    #
+    #   textilize_without_paragraph("I _love_ ROR(Ruby on Rails)!")
+    #   # => "I <em>love</em> <acronym title="Ruby on Rails">ROR</acronym>!"
+    #
+    #   textilize_without_paragraph("h2. Textile makes markup -easy- simple!")
+    #   # => "<h2>Textile makes markup <del>easy</del> simple!</h2>"
+    #
+    #   textilize_without_paragraph("Visit the Rails website "here":http://www.rubyonrails.org/.)
+    #   # => "Visit the Rails website <a href="http://www.rubyonrails.org/">here</a>."
+    def textilize_without_paragraph(text, *options)
+      textiled = textilize(text, *options)
+      if textiled[0..2] == "<p>" then textiled = textiled[3..-1] end
+      if textiled[-4..-1] == "</p>" then textiled = textiled[0..-5] end
+      return textiled
+    end
+
+    # Returns the text with all the Markdown codes turned into HTML tags.
+    # <i>This method requires RDiscount[http://github.com/rtomayko/rdiscount/]
+    # to be available</i>.
+    #
+    # ==== Examples
+    #   markdown("We are using __Markdown__ now!")
+    #   # => "<p>We are using <strong>Markdown</strong> now!</p>"
+    #
+    #   markdown("We like to _write_ `code`, not just _read_ it!")
+    #   # => "<p>We like to <em>write</em> <code>code</code>, not just <em>read</em> it!</p>"
+    #
+    #   markdown("The [Markdown website](http://daringfireball.net/projects/markdown/) has more information.")
+    #   # => "<p>The <a href="http://daringfireball.net/projects/markdown/">Markdown website</a>
+    #   #     has more information.</p>"
+    #
+    #   markdown('![The ROR logo](http://rubyonrails.com/images/rails.png "Ruby on Rails")')
+    #   # => '<p><img src="http://rubyonrails.com/images/rails.png" alt="The ROR logo" title="Ruby on Rails" /></p>'
+    def markdown(text, *options)
+      text = sanitize(text) unless text.html_safe? || options.delete(:safe)
+      
+      if text.blank?
+        ""
+      else
+        markdowned = RDiscount.new(text, *options)
+        markdowned.to_html.chomp.html_safe #used chomp to remove the \n appended by RDiscount
+      end
+    end
+  end
+end

data/lib/prarupa/version.rb

@@ -0,0 +1,3 @@
+module Prarupa
+  VERSION = '0.1'
+end

data/lib/prarupa.rb

@@ -0,0 +1,5 @@
+require 'prarupa/text_helpers'
+
+class ActionView::Base
+  include Prarupa::TextHelpers
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: prarupa
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Rohit Arondekar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-10 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 4
+        - 2
+        version: "4.2"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: hello@rohitarondekar.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/prarupa.rb
+- lib/prarupa/text_helpers.rb
+- lib/prarupa/version.rb
+- README.md
+has_rdoc: true
+homepage: http://github.com/rohit/prarupa
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Plugin that adds the textilized, textilize_without_paragraph and markdown helpers to Rails 3
+test_files: []
+