formatize 1.0.0rc1 → 1.0.0rc2

data/README.md

@@ -1,8 +1,11 @@
 Formatize
 =========
 
-Plugin containing the `textilize`, `textilize_without_paragraph`, and
-`markdown` helpers removed from Rails.
+The `textilize`, `textilize_without_paragraph`, and `markdown` helper methods
+will not be available from the next version of Rails 3 and on. Formatize
+brings them back. They were removed in
+[this commit.](http://github.com/rails/rails/commit/0919c0dbca3df02f5cfff7dde4f61b85ef16d886)
+If you are running edge Rails, Formatize can already be useful now.
 
 Installation
 ------------
@@ -23,9 +26,9 @@ automatically when installing the gem.
 Usage
 -----
 
-### The `textilize` & `textilize_without_paragraph` helpers
+### The `textilize` & `textilize_without_paragraph` helper methods
 
-The `textilize` helper accepts a string of
+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:
 
@@ -44,13 +47,13 @@ Or you can specify multiple options:
     # => "This is worded <strong>strongly</strong>"
 
 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)
+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 method
 
-The `markdown` helper accepts a string of
+The `markdown` helper method accepts a string of
 [Markdown](http://daringfireball.net/projects/markdown/):
 
     markdown("We are using __Markdown__ now!")
@@ -62,6 +65,35 @@ before conversion:
     markdown("<em>We are using __Markdown__ now!</em>", :safe => true)
     # => "<p><em>We are using <strong>Markdown</strong> now!</em></p>"
 
+Compatibility
+-------------
+
+There will be maintained compatibility with the latest final Ruby 1.8 and 1.9
+versions, which at the time of writing means 1.8.7 and 1.9.1 respectively. When
+Ruby 1.8.8 is released, for example, there will not be made an effort to
+maintain backwards compatibility with 1.8.7. Formatize is also compatible with
+Ruby 1.9.2 Preview 3.
+
+The `textilize`, `textilize_without_paragraph`, and `markdown` helper methods
+were removed after the release of Rails 3.0.0 Beta 4, so when the next
+prerelease of Rails 3.0.0 is out, Formatize will be updated (if necessary) to
+be compatible with that. However, there will not be made an effort to maintain
+backwards compatibility with prereleases of Rails 3.0.0 in the future. As soon
+as Rails 3.0.0 Final is released Formatize 1.0.0 Final will be released, and
+all future Formatize versions will maintain compatibility with the latest Rails
+3.x versions.
+
+What that means is that when Rails 3.0.1 is released there will not be made an
+effort to maintain backwards compatibility with 3.0.0, because 3.0.1 is the
+latest 3.0 version. The reason for that is that it should be fairly straight
+forward to upgrade from, for example, Rails 3.0.0 to 3.0.1, but it might not be
+as easy to upgrade from 3.0.5 to 3.1.0.
+
+If one day a new Ruby/Rails version is released and there is no sensible way to
+maintain the level of backwards compatibility promised above, a new major
+version of Formatize will be released. If Formatize 2 is released one day,
+Formatize 1 will be maintained in a separate branch.
+
 Copyright & Licensing
 ---------------------
 

data/lib/formatize.rb

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

data/lib/formatize/{helpers.rb → helper.rb}

@@ -1,5 +1,5 @@
 module Formatize
-  module Helpers
+  module Helper
     # 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].
@@ -27,7 +27,6 @@ module Formatize
     def textilize(text, *options)
       require 'RedCloth'
 
-      options ||= [:hard_breaks]
       text = sanitize(text) unless text.html_safe? || options.delete(:safe)
 
       if text.blank?

data/lib/formatize/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: formatize
 version: !ruby/object:Gem::Version 
-  hash: -245658376
+  hash: 1531271193
   prerelease: true
   segments: 
   - 1
   - 0
-  - 0rc1
-  version: 1.0.0rc1
+  - 0rc2
+  version: 1.0.0rc2
 platform: ruby
 authors: 
 - David Heinemeier Hansson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-09 00:00:00 +02:00
+date: 2010-07-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,13 +54,16 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 1003494531
         segments: 
+        - 3
+        - 0
         - 0
-        version: "0"
-  type: :development
+        - rc
+        version: 3.0.0.rc
+  type: :runtime
   version_requirements: *id003
 description: 
 email: david@loudthinking.com
@@ -71,7 +74,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/formatize/helpers.rb
+- lib/formatize/helper.rb
 - lib/formatize/version.rb
 - lib/formatize.rb
 - LICENSE
@@ -111,6 +114,6 @@ 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.
+summary: Plugin containing the textilize, textilize_without_paragraph, and markdown helper methods removed from Rails.
 test_files: []