formatize 1.1.0rc1 → 1.1.0

data/README.md

@@ -6,6 +6,8 @@ As of version 3, Rails doesn't have the `textilize`,
 them back. Drop it into the old application you're upgrading and it'll smoothen
 the process just that little bit more.
 
+[![Build status badge](https://secure.travis-ci.org/dtrasbo/formatize.png)](http://travis-ci.org/dtrasbo/formatize)
+
 Installation
 ------------
 
@@ -19,41 +21,49 @@ Usage
 ### The `textilize` & `textilize_without_paragraph` helper methods
 
 The `textilize` helper method 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:
+[Textile](http://redcloth.org/textile) and one or more flags. Often, the
+default behavior will be suitable and you will not have to pass it any flags:
 
     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:
+When necessary, flags are listed as such:
 
-    textilize("This is worded <strong>strongly</strong>", :filter_html, :lite_mode)
-    # => "This is worded &lt;strong&gt;strongly&lt;/strong&gt;"
+    textilize("(snip)", :flag1, :flag2, :flag3)
+    # => "(snip)"
 
-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 `RedCloth` documentation](http://redcloth.rubyforge.org/classes/RedCloth/TextileDoc.html)
+lists the available flags. The `textilize_without_paragraps` method
+delegates to `textilize` but strips the surrounding `<p>` tags.
 
 ### The `markdown` helper method
 
 The `markdown` helper method accepts a string of
-[Markdown](http://daringfireball.net/projects/markdown/):
+[Markdown](http://daringfireball.net/projects/markdown/) and one or more
+flags. Often, the default behavior will be suitable and you will not have
+to pass it any flags:
 
     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:
+When necessary, flags are listed as such:
+
+    markdown("(snip)", :flag1, :flag2, :flag3)
+    # => "(snip)"
+
+[The `bluecloth` documentation](http://rubydoc.info/gems/bluecloth/BlueCloth)
+lists the available flags.
+
+Sanitization
+------------
+
+Both `textilize` and `markdown` sanitizes the input using Rails'
+`sanitize` prior to parsing. Since both gems can do this themselves,
+it's useful to be able to bypass the pre-parsing sanitization. Two ways:
 
-    markdown("<em>We are using __Markdown__ now!</em>", :safe => true)
-    # => "<p><em>We are using <strong>Markdown</strong> now!</em></p>"
+1. Pass a string that has been marked HTML safe. (Preferred).
+2. Use the special `:safe` flag, which is not passed on to the parser.
+   _(Deprecated in 1.1, removed in 2.0)._ 
 
 Compatibility
 -------------
@@ -70,13 +80,21 @@ jump through hoops to support other versions. 1.8 support may be dropped
 eventually.
 
 ### Rails versions
-* 3.2.1
-* 3.1.3
-* 3.0.11
+* 3.2.2
+* 3.1.4
+* 3.0.12
 
 The latest versions in all the 3.0 series. This is likely to change when
 4.0 is released.
 
+Dependencies
+------------
+
+* `RedCloth` gem
+* `bluecloth` gem
+
+[![Dependency status badge](https://gemnasium.com/dtrasbo/formatize.png)](https://gemnasium.com/dtrasbo/formatize)
+
 Copyright & Licensing
 ---------------------
 

data/lib/formatize/helper.rb

@@ -1,91 +1,94 @@
 module Formatize
   module Helper
-    # Returns the text with all the Textile[http://www.textism.com/tools/textile] codes turned into HTML tags.
+    # Accepts a string of Textile {http://redcloth.org/textile} and one or
+    # more flags. Often, the default behavior will be suitable and you will not
+    # have to pass it any flags:
     #
-    # 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>"
+    # When necessary, flags are listed as such:
     #
-    #   textilize("h2. Textile makes markup -easy- simple!")
-    #   # => "<h2>Textile makes markup <del>easy</del> simple!</h2>"
+    #   textilize("(snip)", :flag1, :flag2, :flag3)
+    #   # => "(snip)"
     #
-    #   textilize("Visit the Rails website "here":http://www.rubyonrails.org/.)
-    #   # => "<p>Visit the Rails website <a href="http://www.rubyonrails.org/">here</a>.</p>"
+    # The +RedCloth+ documentation {http://redcloth.rubyforge.org/classes/RedCloth/TextileDoc.html}
+    # lists the available flags.
     #
-    #   textilize("This is worded <strong>strongly</strong>")
-    #   # => "<p>This is worded <strong>strongly</strong></p>"
+    # It sanitizes the input using Rails' +sanitize+ prior to parsing.
+    # There are two ways to bypass pre-parsing sanitization: 
     #
-    #   textilize("This is worded <strong>strongly</strong>", :filter_html)
-    #   # => "<p>This is worded &lt;strong&gt;strongly&lt;/strong&gt;</p>"
+    # 1. Pass a string that has been marked HTML safe. (Preferred).
+    # 2. Use the special <tt>:safe</tt> flag, which is not passed on to the
+    #    parser. _(Deprecated in 1.1, removed in 2.0)._
     #
-    def textilize(text, *options)
+    def textilize(text, *flags)
       require 'RedCloth'
 
-      text = sanitize(text) unless text.html_safe? || options.delete(:safe)
+      if safe = flags.delete(:safe)
+        ActiveSupport::Deprecation.warn('The :safe flag is deprecated. Mark the input HTML safe instead.')
+      end
+
+      text = sanitize(text) unless text.html_safe? || safe
 
       if text.blank?
         ""
       else
-        textilized = RedCloth.new(text, options)
-        textilized.to_html
+        RedCloth.new(text, flags).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>!"
+    # Delegates to +textilize+ but strips the surrounding <tt><p></tt>
+    # tags.
     #
-    #   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)
+    def textilize_without_paragraph(text, *flags)
+      textiled = textilize(text, *flags)
       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>.
+    # Accepts a string of Markdown {http://daringfireball.net/projects/markdown/}
+    # and one or more flags. Often, the default behavior will be suitable and
+    # you will not have to pass it any flags:
     #
-    # ==== 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>"
+    # When necessary, flags are listed as such:
+    #
+    #   markdown("(snip)", :flag1, :flag2, :flag3)
+    #   # => "(snip)"
     #
-    #   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>"
+    # The +bluecloth+ documentation {http://rubydoc.info/gems/bluecloth/BlueCloth}
+    # lists the available flags.
     #
-    #   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)
+    # It sanitizes the input using Rails' +sanitize+ prior to parsing.
+    # There are two ways to bypass pre-parsing sanitization: 
+    #
+    # 1. Pass a string that has been marked HTML safe. (Preferred).
+    # 2. Use the special <tt>:safe</tt> flag, which is not passed on to the
+    #    parser. _(Deprecated in 1.1, removed in 2.0)._
+    #
+    def markdown(text, *flags)
       require 'bluecloth'
 
-      text = sanitize(text) unless text.html_safe? || options.delete(:safe)
-      (text.blank? ? "" : BlueCloth.new(text).to_html).html_safe
+      if safe = flags.delete(:safe)
+        ActiveSupport::Deprecation.warn('The :safe flag is deprecated. Mark the input HTML safe instead.')
+      end
+
+      text = sanitize(text) unless text.html_safe? || safe
+
+      if text.blank?
+        ""
+      else
+        flags_hash = {}
+        flags.each do |flag|
+          flags_hash[flag] = true
+        end
+
+        BlueCloth.new(text, flags_hash).to_html
+      end.html_safe
     end
   end
 end

data/lib/formatize/version.rb

@@ -1,4 +1,4 @@
 module Formatize
-  VERSION = '1.1.0rc1'
+  VERSION = '1.1.0'
 end
 

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: formatize
 version: !ruby/object:Gem::Version
-  version: 1.1.0rc1
-  prerelease: 5
+  version: 1.1.0
+  prerelease: 
 platform: ruby
 authors:
 - David Trasbo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-29 00:00:00.000000000 Z
+date: 2012-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &2164634400 !ruby/object:Gem::Requirement
+  requirement: &2152485440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '4.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2164634400
+  version_requirements: *2152485440
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &2164633780 !ruby/object:Gem::Requirement
+  requirement: &2152343560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2164633780
+  version_requirements: *2152343560
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &2164633300 !ruby/object:Gem::Requirement
+  requirement: &2152259580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,18 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164633300
+  version_requirements: *2152259580
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152136760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152136760
 description: 
 email: me@dtrasbo.com
 executables: []
@@ -70,9 +81,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.16