vigetlabs-acts_as_markup 0.1.1 → 0.2.0

data/Manifest.txt

@@ -7,6 +7,7 @@ acts_as_markup.gemspec
 lib/acts/as_markup.rb
 lib/acts_as_markup.rb
 lib/acts_as_markup/exts/rdiscount.rb
+lib/acts_as_markup/exts/string.rb
 tasks/bones.rake
 tasks/gem.rake
 tasks/git.rake

data/README.rdoc

@@ -13,6 +13,11 @@ Allows you to specify columns of an ActiveRecord model that contain Markdown or
 Textile text. You may then use +to_s+ to get the original markdown or textile 
 text or +to_html+ to get the formated HTML.
 
+Additionally you can have a model that contains a column that has a column with 
+markup text, and another that defines what language to process it as. If the field 
+is listed as "markdown" or "textile" (case insensitive) it will treat it as such, 
+any other value for markup language will have the value pass through as a normal string.
+
 This AR extension can use 3 different types of Markdown processing backends: 
 BlueCloth, RDiscount, or Ruby PEG. You specify which one you want to use by setting
 a config value in your environment.rb file:
@@ -32,6 +37,7 @@ By default RDiscount will be used.
     @post = Post.find(:first)
     @post.body.to_s     #=> "## Markdown Headline"
     @post.body.to_html  #=> "<h2> Markdown Headline</h2>"
+    
 
 ==== Using +acts_as_textile+:
 
@@ -42,6 +48,7 @@ By default RDiscount will be used.
     @post = Post.find(:first)
     @post.body.to_s     #=> "h2. Markdown Headline"
     @post.body.to_html  #=> "<h2>Markdown Headline</h2>"
+    
 
 ==== Using +acts_as_markup+:
 
@@ -52,6 +59,19 @@ By default RDiscount will be used.
     @post = Post.find(:first)
     @post.body.to_s     #=> "## Markdown Headline"
     @post.body.to_html  #=> "<h2> Markdown Headline</h2>"
+    
+    
+==== Using +acts_as_markup+ with +:variable+ language:
+
+    class Post < ActiveRecrod
+      acts_as_markup :language => :variable, :columns => [:body], :language_column => 'markup_language'
+    end
+    
+    @post = Post.find(:first)
+    @post.markup_language      # => "markdown"
+    @post.body.to_s            # => "## Markdown Headline"
+    @post.body.to_html         # => "<h2> Markdown Headline</h2>"
+    
 
 == REQUIREMENTS:
 

data/acts_as_markup.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name = %q{acts_as_markup}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Landau"]
-  s.date = %q{2008-08-06}
+  s.date = %q{2008-08-07}
   s.description = %q{Represent ActiveRecord Markdown or Textile text columns as Markdown or Textile objects using various external libraries to convert to HTML.}
   s.email = %q{brian.landau@viget.com}
   s.extra_rdoc_files = ["LICENSE.txt", "README.rdoc"]
-  s.files = ["History.txt", "LICENSE.txt", "Manifest.txt", "README.rdoc", "Rakefile", "acts_as_markup.gemspec", "lib/acts/as_markup.rb", "lib/acts_as_markup.rb", "lib/acts_as_markup/exts/rdiscount.rb", "tasks/bones.rake", "tasks/gem.rake", "tasks/git.rake", "tasks/manifest.rake", "tasks/post_load.rake", "tasks/rdoc.rake", "tasks/rubyforge.rake", "tasks/setup.rb", "tasks/test.rake", "test/acts_as_markup_test.rb", "test/test_helper.rb"]
+  s.files = ["History.txt", "LICENSE.txt", "Manifest.txt", "README.rdoc", "Rakefile", "acts_as_markup.gemspec", "lib/acts/as_markup.rb", "lib/acts_as_markup.rb", "lib/acts_as_markup/exts/rdiscount.rb", "lib/acts_as_markup/exts/string.rb", "tasks/bones.rake", "tasks/gem.rake", "tasks/git.rake", "tasks/manifest.rake", "tasks/post_load.rake", "tasks/rdoc.rake", "tasks/rubyforge.rake", "tasks/setup.rb", "tasks/test.rake", "test/acts_as_markup_test.rb", "test/test_helper.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://viget.rubyforge.com/acts_as_markup}
   s.rdoc_options = ["--main", "README.rdoc"]

data/lib/acts/as_markup.rb

@@ -13,40 +13,98 @@ module ActiveRecord # :nodoc:
         # This allows you to specify columns you want to define as containing 
         # Markdown or Textile content.
         # Then you can simply call <tt>.to_html</tt> method on the attribute.
-        #
-        # ==== Example
+        # 
+        # You can also specify the language as <tt>:variable</tt> you will then
+        # need to add an additional option of <tt>:language_column</tt>. When 
+        # a value is accessed it will create the correct object (Markdown or Textile)
+        # based on the value of the language column. If any value besides markdown or
+        # textile is supplied for the markup language the text will pass through
+        # as a string.
+        # 
+        # 
+        # ==== Examples
+        # 
+        # ===== Using Markdown language
+        # 
         #     class Post < ActiveRecrod
         #       acts_as_markup :language => :markdown, :columns => [:body]
         #     end
+        #     
+        #     @post = Post.find(:first)
+        #     @post.body.to_s            # => "## Markdown Headline"
+        #     @post.body.to_html         # => "<h2> Markdown Headline</h2>"
+        #     
         # 
+        # ===== Using variable language
+        # 
+        #     class Post < ActiveRecrod
+        #       acts_as_markup :language => :variable, :columns => [:body], :language_column => 'markup_language'
+        #     end
+        #     
         #     @post = Post.find(:first)
-        #     @post.body.to_s     #=> "## Markdown Headline"
-        #     @post.body.to_html  #=> "<h2> Markdown Headline</h2>"
+        #     @post.markup_language      # => "markdown"
+        #     @post.body.to_s            # => "## Markdown Headline"
+        #     @post.body.to_html         # => "<h2> Markdown Headline</h2>"
+        #     
         # 
         def acts_as_markup(options)
           case options[:language].to_sym
           when :markdown
-            library_names = ::ActsAsMarkup::MARKDOWN_LIBS[ActsAsMarkup.markdown_library]
-            require library_names[:lib_name]
-            klass = library_names[:class_name]
+            if ActsAsMarkup::MARKDOWN_LIBS.keys.include? ActsAsMarkup.markdown_library
+              markdown_library_names = ActsAsMarkup::MARKDOWN_LIBS[ActsAsMarkup.markdown_library]
+              require markdown_library_names[:lib_name]
+              klass = markdown_library_names[:class_name]
+            else
+              raise ActsAsMarkup::UnsportedMarkdownLibrary, "#{ActsAsMarkup.markdown_library} is not currently supported."
+            end
           when :textile
             require 'redcloth'
             klass = 'RedCloth'
+          when :variable
+            if ActsAsMarkup::MARKDOWN_LIBS.keys.include? ActsAsMarkup.markdown_library
+              markdown_library_names = ActsAsMarkup::MARKDOWN_LIBS[ActsAsMarkup.markdown_library]
+              require markdown_library_names[:lib_name]
+              markdown_klass = markdown_library_names[:class_name]
+            else
+              raise ActsAsMarkup::UnsportedMarkdownLibrary, "#{ActsAsMarkup.markdown_library} is not currently supported."
+            end
+            require 'redcloth'
+            textile_klass = 'RedCloth'
           else
             raise ActsAsMarkup::UnsportedMarkupLanguage, "#{options[:langauge]} is not a currently supported markup language."
           end
           
           options[:columns].each do |col|
-            class_eval <<-EOV
-              def #{col.to_s}
-                if @#{col.to_s}
-                  if !self.#{col.to_s}_changed?
-                    return @#{col.to_s}
+            unless options[:language].to_sym == :variable
+              class_eval <<-EOV
+                def #{col.to_s}
+                  if @#{col.to_s}
+                    if !self.#{col.to_s}_changed?
+                      return @#{col.to_s}
+                    end
+                  end
+                  @#{col.to_s} = #{klass}.new(self['#{col.to_s}'].to_s)
+                end
+              EOV
+            else
+              class_eval <<-EOV
+                def #{col.to_s}
+                  if @#{col.to_s}
+                    unless self.#{col.to_s}_changed? || self.#{options[:language_column].to_s}_changed?
+                      return @#{col.to_s}
+                    end
+                  end
+                  case self.#{options[:language_column].to_s}
+                  when /markdown/i
+                    @#{col.to_s} = #{markdown_klass}.new(self['#{col.to_s}'].to_s)
+                  when /textile/i
+                    @#{col.to_s} = #{textile_klass}.new(self['#{col.to_s}'].to_s)
+                  else
+                    @#{col.to_s} = self['#{col.to_s}']
                   end
                 end
-                @#{col.to_s} = #{klass}.new(self['#{col.to_s}'].to_s)
-              end
-            EOV
+              EOV
+            end
           end
         end
         

data/lib/acts_as_markup/exts/string.rb

@@ -0,0 +1,9 @@
+module ActsAsMarkup
+  module StringExtension
+    def to_html
+      self.to_s
+    end
+  end
+end
+
+String.send :include, ActsAsMarkup::StringExtension

data/lib/acts_as_markup.rb

@@ -2,7 +2,7 @@ require 'active_support'
 
 module ActsAsMarkup
   # :stopdoc:
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:
@@ -11,6 +11,10 @@ module ActsAsMarkup
   class UnsportedMarkupLanguage < ArgumentError
   end
   
+  # This exception is raised when an unsupported Markdown library is set to the config value.
+  class UnsportedMarkdownLibrary < ArgumentError
+  end
+  
   DEFAULT_MAKRDOWN_LIB = :rdiscount
   
   MARKDOWN_LIBS = { :rdiscount => {:class_name => "RDiscount",

data/test/acts_as_markup_test.rb

@@ -288,6 +288,270 @@ class ActsAsMarkupTest < Test::Unit::TestCase
     end
   end
   
+  context 'acts_as_markup with variable language' do
+    setup do
+      ActsAsMarkup.markdown_library = ActsAsMarkup::DEFAULT_MAKRDOWN_LIB
+      class ::VariablePost < ActiveRecord::Base
+        acts_as_markup :language => :variable, :columns => [:body], :language_column => :markup_language
+      end
+    end
+    
+    context "with a Markdown post" do
+      setup do
+        @markdown_text = '## Markdown Test Text'
+        @markdown_post = VariablePost.create!(:title => 'Blah', :body => @markdown_text, :markup_language => 'Markdown')
+      end
+      
+      should "have a markup object returned for the column value" do
+        assert_kind_of RDiscount, @markdown_post.body
+      end
+
+      should "return original markup text for a `to_s` method call on the column value" do
+        assert_equal @markdown_text, @markdown_post.body.to_s
+      end
+
+      should "return formated html for a `to_html` method call on the column value" do
+        assert_match(/<h2>\s*Markdown Test Text\s*<\/h2>/, @markdown_post.body.to_html)
+      end
+
+      context "changing value of markup field should return new markup object" do
+        setup do
+          @markdown_old_body = @markdown_post.body
+          @markdown_post.body = "`@count = 20`"
+        end
+
+        should "still have an markup object but not the same object" do
+          assert_not_same @markdown_post.body, @markdown_old_body
+          assert_kind_of RDiscount, @markdown_post.body
+        end
+
+        should "return correct text for `to_s`" do
+          assert_equal "`@count = 20`", @markdown_post.body.to_s
+        end
+
+        should "return correct HTML for the `to_html` method" do
+          assert_match(/<code>\s*\@count\s\=\s20\s*<\/code>/, @markdown_post.body.to_html)
+        end
+
+        teardown do
+          @markdown_old_body = nil
+        end
+      end
+      
+      teardown do
+        @markdown_text, @markup_post = nil
+      end
+    end
+    
+    context "with a Textile post" do
+      setup do
+        @textile_text = "h2. Textile Test Text"
+        @textile_post = VariablePost.create!(:title => 'Blah', :body => @textile_text, :markup_language => 'Textile')
+      end
+      
+      should "have a markup object returned for the column value" do
+        assert_kind_of RedCloth::TextileDoc, @textile_post.body
+      end
+
+      should "return original markup text for a `to_s` method call on the column value" do
+        assert_equal @textile_text, @textile_post.body.to_s
+      end
+
+      should "return formated html for a `to_html` method call on the column value" do
+        assert_match(/<h2>Textile Test Text<\/h2>/, @textile_post.body.to_html)
+      end
+
+      context "changing value of markup field should return new markup object" do
+        setup do
+          @textile_old_body = @textile_post.body
+          @textile_post.body = "@@count = 20@"
+        end
+
+        should "still have an markup object but not the same object" do
+          assert_kind_of RedCloth::TextileDoc, @textile_post.body
+          assert_not_same @textile_post.body, @textile_old_body
+        end
+
+        should "return correct text for `to_s`" do
+          assert_equal "@@count = 20@", @textile_post.body.to_s
+        end
+
+        should "return correct HTML for the `to_html` method" do
+          assert_match(/<code>\@count\s\=\s20<\/code>/, @textile_post.body.to_html)
+        end
+
+        teardown do
+          @textile_old_body = nil
+        end
+      end
+      
+      teardown do
+        @textile_text, @textile_post = nil
+      end
+    end
+    
+    context "with a plain text post" do
+      setup do
+        @plain_text = "Hahaha!!!"
+        @plain_text_post = VariablePost.create!(:title => 'Blah', :body => @plain_text, :markup_language => 'text')
+      end
+      
+      should "have a string object returned for the column value" do
+        assert_kind_of String, @plain_text_post.body
+      end
+
+      should "return the original string with a `to_s` method call on the column value" do
+        assert_equal @plain_text, @plain_text_post.body.to_s
+      end
+
+      should "eturn the original string with a `to_html` method call on the column value" do
+        assert_equal @plain_text, @plain_text_post.body.to_html
+      end
+
+      context "changing value of markup field should return new markup object" do
+        setup do
+          @plaintext_old_body = @plain_text_post.body
+          @plain_text_post.body = "Lorem ipsum dolor sit amet"
+        end
+
+        should "still have an markup object but not the same object" do
+          assert_kind_of String, @plain_text_post.body
+          assert_not_same @plain_text_post.body, @plaintext_old_body
+        end
+
+        should "return correct text for `to_s`" do
+          assert_equal "Lorem ipsum dolor sit amet", @plain_text_post.body.to_s
+        end
+
+        teardown do
+          @textile_old_body = nil
+        end
+      end
+      
+      teardown do
+        @textile_text, @textile_post = nil
+      end
+    end
+    
+    
+    teardown do
+      VariablePost.delete_all
+    end
+  end
+  
+  context 'with a nil value for the text' do
+    setup do
+      @text = nil
+    end
+    
+    context 'with textile' do
+      setup do
+        class ::Post < ActiveRecord::Base
+          acts_as_textile :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @text)
+      end
+      
+      should 'return a blank string for `to_s` method' do
+        assert_equal @post.body.to_s, ''
+      end
+      
+      should 'return a blank string for `to_html` method' do
+        assert_match(/[\n\s]*/, @post.body.to_html)
+      end
+      
+      should "have a RedCloth object returned for the column value" do
+        assert_kind_of RedCloth::TextileDoc, @post.body
+      end
+      
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+    
+    context 'with RDiscount Markdown' do
+      setup do
+        ActsAsMarkup.markdown_library = :rdiscount
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @text)
+      end
+      
+      should 'return a blank string for `to_s` method' do
+        assert_equal @post.body.to_s, ''
+      end
+      
+      should 'return a blank string for `to_html` method' do
+        assert_match(/[\n\s]*/, @post.body.to_html)
+      end
+      
+      should "have a RDiscount object returned for the column value" do
+        assert_kind_of RDiscount, @post.body
+      end
+      
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+    
+    context 'with BlueCloth Markdown' do
+      setup do
+        ActsAsMarkup.markdown_library = :bluecloth
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @text)
+      end
+      
+      should 'return a blank string for `to_s` method' do
+        assert_equal @post.body.to_s, ''
+      end
+      
+      should 'return a blank string for `to_html` method' do
+        assert_match(/[\n\s]*/, @post.body.to_html)
+      end
+      
+      should "have a BlueCloth object returned for the column value" do
+        assert_kind_of BlueCloth, @post.body
+      end
+      
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+    
+    context 'with Ruby PEG Markdown' do
+      setup do
+        ActsAsMarkup.markdown_library = :rpeg
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @text)
+      end
+      
+      should 'return a blank string for `to_s` method' do
+        assert_equal @post.body.to_s, ''
+      end
+      
+      should 'return a blank string for `to_html` method' do
+        assert_match(/[\n\s]*/, @post.body.to_html)
+      end
+      
+      should "have a PEGMarkdown object returned for the column value" do
+        assert_kind_of PEGMarkdown, @post.body
+      end
+      
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+  end
+  
   context 'acts_as_markup with bad language name' do
     should 'raise exception when a non-supported language is passed to acts_as_markup' do
       assert_raise ActsAsMarkup::UnsportedMarkupLanguage do

data/test/test_helper.rb

@@ -23,6 +23,13 @@ def setup_db
       t.column :body, :text
       t.timestamps
     end
+    
+    create_table :variable_posts do |t|
+      t.column :title, :string
+      t.column :body, :text
+      t.column :markup_language, :string
+      t.timestamps
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vigetlabs-acts_as_markup
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Brian Landau
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-06 00:00:00 -07:00
+date: 2008-08-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,6 +67,7 @@ files:
 - lib/acts/as_markup.rb
 - lib/acts_as_markup.rb
 - lib/acts_as_markup/exts/rdiscount.rb
+- lib/acts_as_markup/exts/string.rb
 - tasks/bones.rake
 - tasks/gem.rake
 - tasks/git.rake