albeano 1.0.0 → 1.1.0

data/README.md

@@ -26,3 +26,26 @@ You can even have it return markdown. Just make sure you have
 
     Albeano.new(text).to_markdown
     Albeano.new(text).to_markdown(:smart, :filter_html)
+
+### Rails 3
+
+You can easily incorporate Albeano into your existing Rails applications, just
+add `albeano` to your Gemfile.
+
+You can then add a method do your models (assuming `body` contains the
+body of your post or text):
+
+    class Post < ActiveRecord::Base
+      def content
+        Albeano.generate(body)
+      end
+
+      # with markdown
+      def content
+        Albeano.new(body).to_markdown
+      end
+    end
+
+You can of course use these methods inside of your views, too. Remember to
+use the `html_safe` method before rendering your markup, otherwise your HTML
+will be escaped and rendered as entities.

data/lib/albeano.rb

@@ -1,7 +1,7 @@
 require 'albino'
 
 class Albeano
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
   def self.generate(text)
     new(text).generate
@@ -16,6 +16,7 @@ class Albeano
     @markdown = nil
   end
 
+  # @return [String] Newly generated Albino markup
   def generate
     @text.gsub(/\[code(?:=(.+?))?\]\s*(.+?)\s*\[\/code\]/m) do
       Albino.colorize($2, $1 || :text)
@@ -24,6 +25,8 @@ class Albeano
 
   alias :to_s :generate
 
+  # @raise [LoadError] Raised when unable to load RDiscount
+  # @return [String] The newly generated markup
   def to_markdown(*extensions)
     begin
       require 'rdiscount'

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: albeano
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors: 
 - Lee Jarvis
@@ -14,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-26 00:00:00 +00:00
-default_executable: 
+date: 2011-05-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: albino
@@ -23,12 +18,9 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+        version: 1.3.3
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -39,10 +31,6 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 1
-        - 0
         version: 2.1.0
   type: :development
   version_requirements: *id002
@@ -59,7 +47,6 @@ files:
 - README.md
 - lib/albeano.rb
 - spec/albeano_spec.rb
-has_rdoc: true
 homepage: 
 licenses: []
 
@@ -73,23 +60,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 8
-      - 6
       version: 1.8.6
 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
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
 summary: BBCode style wrapper for Pygments