formatize 1.0.0rc1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 David Heinemeier Hansson
+
+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.md

@@ -0,0 +1,70 @@
+Formatize
+=========
+
+Plugin containing the `textilize`, `textilize_without_paragraph`, and
+`markdown` helpers removed from Rails.
+
+Installation
+------------
+
+To install as a gem (recommended), add this to the Gemfile of the application
+and run `bundle install`:
+
+    gem 'formatize'
+
+Alternatively, you can install as a plugin:
+
+    rails plugin install git://github.com/dtrasbo/formatize.git
+
+Don't forget to add the `RedCloth` and/or `bluecloth` gems to the Gemfile if
+you go with the plugin. They will be installed
+automatically when installing the gem.
+
+Usage
+-----
+
+### The `textilize` & `textilize_without_paragraph` helpers
+
+The `textilize` helper accepts a string of
+[Textile](http://redcloth.org/textile) and one or more options. In most cases
+the default behavior will be suitable and you will not have to pass it any options:
+
+    textilize("*This is Textile!*  Rejoice!")
+    # => "<p><strong>This is Textile!</strong>  Rejoice!</p>"
+
+Sometimes, however, you want to customize how RedCloth parses your Textile. You
+can specify a single option:
+
+    textilize("This is worded <strong>strongly</strong>", :filter_html)
+    # => "<p>This is worded &lt;strong&gt;strongly&lt;/strong&gt;</p>"
+
+Or you can specify multiple options:
+
+    textilize("This is worded <strong>strongly</strong>", :filter_html, :lite_mode)
+    # => "This is worded &lt;strong&gt;strongly&lt;/strong&gt;"
+
+The `textilize_without_paragraph` works similarly except it omits the
+surrounding `<p>` tag. Check out the documentation for
+[`RedCloth::TextileDoc`](http://redcloth.rubyforge.org/classes/RedCloth/TextileDoc.html)
+for an overview on the options available.
+
+### The `markdown` helper
+
+The `markdown` helper accepts a string of
+[Markdown](http://daringfireball.net/projects/markdown/):
+
+    markdown("We are using __Markdown__ now!")
+    # => "<p>We are using <strong>Markdown</strong> now!</p>"
+
+If you set the `:safe` option to `true` the input string will be not sanitized
+before conversion:
+
+    markdown("<em>We are using __Markdown__ now!</em>", :safe => true)
+    # => "<p><em>We are using <strong>Markdown</strong> now!</em></p>"
+
+Copyright & Licensing
+---------------------
+
+Copyright (c) 2010 David Heinemeier Hansson
+
+Released under the MIT License. See LICENSE for details.

data/lib/formatize.rb

@@ -0,0 +1,5 @@
+require 'formatize/helpers'
+
+ActiveSupport.on_load(:action_view) do
+  include Formatize::Helpers
+end

data/lib/formatize/helpers.rb

@@ -0,0 +1,92 @@
+module Formatize
+  module Helpers
+    # 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 is only available if RedCloth[http://redcloth.org/] is available</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)
+      require 'RedCloth'
+
+      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
+      end.html_safe
+    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)
+      require 'RedCloth'
+
+      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 BlueCloth[http://www.deveiate.org/projects/BlueCloth]
+    # 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)
+      require 'bluecloth'
+
+      text = sanitize(text) unless text.html_safe? || options.delete(:safe)
+      (text.blank? ? "" : BlueCloth.new(text).to_html).html_safe
+    end
+  end
+end

data/lib/formatize/version.rb

@@ -0,0 +1,3 @@
+module Formatize
+  VERSION = '1.0.0rc1'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: formatize
+version: !ruby/object:Gem::Version 
+  hash: -245658376
+  prerelease: true
+  segments: 
+  - 1
+  - 0
+  - 0rc1
+  version: 1.0.0rc1
+platform: ruby
+authors: 
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-09 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: 31
+        segments: 
+        - 4
+        - 2
+        version: "4.2"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: 
+email: david@loudthinking.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/formatize/helpers.rb
+- lib/formatize/version.rb
+- lib/formatize.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/dtrasbo/formatize
+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: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Plugin containing the textilize, textilize_without_paragraph, and markdown helpers removed from Rails.
+test_files: []
+