acts_as_markup 0.1.0

data/tasks/test.rake

@@ -0,0 +1,34 @@
+require 'rake/testtask'
+
+namespace :test do
+
+  Rake::TestTask.new(:run) do |t|
+    t.libs = PROJ.libs
+    t.test_files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+                   else PROJ.test.files end
+    t.ruby_opts += PROJ.ruby_opts
+    t.ruby_opts += PROJ.test.opts
+  end
+
+  if HAVE_RCOV
+    desc 'Run rcov on the unit tests'
+    task :rcov => :clobber_rcov do
+      opts = PROJ.rcov.opts.dup << '-o' << PROJ.rcov.dir
+      opts = opts.join(' ')
+      files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+              else PROJ.test.files end
+      files = files.join(' ')
+      sh "#{RCOV} #{files} #{opts}"
+    end
+
+    task :clobber_rcov do
+      rm_r 'coverage' rescue nil
+    end
+  end
+
+end  # namespace :test
+
+desc 'Alias to test:run'
+task :test => 'test:run'
+
+task :clobber => 'test:clobber_rcov' if HAVE_RCOV

data/test/acts_as_markup_test.rb

@@ -0,0 +1,305 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ActsAsMarkupTest < Test::Unit::TestCase
+  def setup
+    setup_db
+  end
+  
+  context 'acts_as_markdown' do
+    setup do
+      @markdown_text = '## Markdown Test Text'
+    end
+    
+    context 'using RDiscount' do
+      setup do
+        ActsAsMarkup.markdown_library = :rdiscount
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @markdown_text)
+      end
+    
+      should "have a RDiscount object returned for the column value" do
+        assert_kind_of RDiscount, @post.body
+      end
+    
+      should "return original markdown text for a `to_s` method call on the column value" do
+        assert_equal @markdown_text, @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>/, @post.body.to_html)
+      end
+    
+      context "changing value of markdown field should return new markdown object" do
+        setup do
+          @old_body = @post.body
+          @post.body = "`@count = 20`"
+        end
+      
+        should "still have an RDiscount object but not the same object" do
+          assert_kind_of RDiscount, @post.body
+          assert_not_same @post.body, @old_body 
+        end
+      
+        should "return correct text for `to_s`" do
+          assert_equal "`@count = 20`", @post.body.to_s
+        end
+      
+        should "return correct HTML for the `to_html` method" do
+          assert_match(/<code>\s*\@count\s\=\s20\s*<\/code>/, @post.body.to_html)
+        end
+      
+        teardown do
+          @old_body = nil
+        end
+      end
+    
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+  
+    context 'using 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 => @markdown_text)
+      end
+    
+      should "have a Ruby PEG Markdown object returned for the column value" do
+        assert_kind_of PEGMarkdown, @post.body
+      end
+    
+      should "return original markdown text for a `to_s` method call on the column value" do
+        assert_equal @markdown_text, @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>/, @post.body.to_html)
+      end
+    
+      context "changing value of markdown field should return new markdown object" do
+        setup do
+          @old_body = @post.body
+          @post.body = "`@count = 20`"
+        end
+      
+        should "still have an PEGMarkdown object but not the same object" do
+          assert_kind_of PEGMarkdown, @post.body
+          assert_not_same @post.body, @old_body 
+        end
+      
+        should "return correct text for `to_s`" do
+          assert_equal "`@count = 20`", @post.body.to_s
+        end
+      
+        should "return correct HTML for the `to_html` method" do
+          assert_match(/<code>\s*\@count\s\=\s20\s*<\/code>/, @post.body.to_html)
+        end
+      
+        teardown do
+          @old_body = nil
+        end
+      end
+    
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+  
+    context 'using BlueCloth' do
+      setup do
+        ActsAsMarkup.markdown_library = :bluecloth
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @markdown_text)
+      end
+    
+      should "have a BlueCloth object returned for the column value" do
+        assert_kind_of BlueCloth, @post.body
+      end
+    
+      should "return original markdown text for a `to_s` method call on the column value" do
+        assert_equal @markdown_text, @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>/, @post.body.to_html)
+      end
+    
+      context "changing value of markdown field should return new markdown object" do
+        setup do
+          @old_body = @post.body
+          @post.body = "`@count = 20`"
+        end
+      
+        should "still have an BlueCloth object but not the same object" do
+          assert_kind_of BlueCloth, @post.body
+          assert_not_same @post.body, @old_body 
+        end
+      
+        should "return correct text for `to_s`" do
+          assert_equal "`@count = 20`", @post.body.to_s
+        end
+      
+        should "return correct HTML for the `to_html` method" do
+          assert_match(/<code>\s*\@count\s\=\s20\s*<\/code>/, @post.body.to_html)
+        end
+      
+        teardown do
+          @old_body = nil
+        end
+      end
+    
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+    
+    teardown do
+      @markdown_text = nil
+    end
+  end
+  
+  context 'acts_as_textile' do
+    setup do
+      @textile_text = "h2. Textile Test Text"
+      class ::Post < ActiveRecord::Base
+        acts_as_textile :body
+      end
+      @post = Post.create!(:title => 'Blah', :body => @textile_text)
+    end
+    
+    should "have a RedCloth object returned for the column value" do
+      assert_kind_of RedCloth::TextileDoc, @post.body
+    end
+  
+    should "return original textile text for a `to_s` method call on the column value" do
+      assert_equal @textile_text, @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>/, @post.body.to_html)
+    end
+  
+    context "changing value of textile field should return new textile object" do
+      setup do
+        @old_body = @post.body
+        @post.body = "@@count = 20@"
+      end
+    
+      should "still have an RedCloth object but not the same object" do
+        assert_kind_of RedCloth::TextileDoc, @post.body
+        assert_not_same @post.body, @old_body 
+      end
+    
+      should "return correct text for `to_s`" do
+        assert_equal "@@count = 20@", @post.body.to_s
+      end
+    
+      should "return correct HTML for the `to_html` method" do
+        assert_match(/<code>\@count\s\=\s20<\/code>/, @post.body.to_html)
+      end
+    
+      teardown do
+        @old_body = nil
+      end
+    end
+    
+    teardown do
+      @textile_text, @post = nil
+      Post.delete_all
+    end
+  end
+  
+  context 'acts_as_markup' do
+    setup do
+      ActsAsMarkup.markdown_library = ActsAsMarkup::DEFAULT_MAKRDOWN_LIB
+      
+      @textile_text = "h2. Textile Test Text"
+      class ::TextilePost < ActiveRecord::Base
+        acts_as_markup :language => :textile, :columns => [:body]
+      end
+      @textile_post = TextilePost.create!(:title => 'Blah', :body => @textile_text)
+      
+      @markdown_text = '## Markdown Test Text'
+      class ::MarkdownPost < ActiveRecord::Base
+        acts_as_markup :language => :markdown, :columns => [:body]
+      end
+      @markdown_post = MarkdownPost.create!(:title => 'Blah', :body => @markdown_text)
+    end
+    
+    should "have a markup object returned for the column value" do
+      assert_kind_of RedCloth::TextileDoc, @textile_post.body
+      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
+      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>\s*Markdown Test Text\s*<\/h2>/, @markdown_post.body.to_html)
+      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
+        @markdown_old_body = @markdown_post.body
+        @markdown_post.body = "`@count = 20`"
+        @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 @markdown_post.body, @markdown_old_body
+        assert_kind_of RDiscount, @markdown_post.body
+        assert_not_same @textile_post.body, @textile_old_body
+      end
+    
+      should "return correct text for `to_s`" do
+        assert_equal "`@count = 20`", @markdown_post.body.to_s
+        assert_equal "@@count = 20@", @textile_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)
+        assert_match(/<code>\@count\s\=\s20<\/code>/, @textile_post.body.to_html)
+      end
+    
+      teardown do
+        @markdown_old_body, @textile_old_body = nil
+      end
+    end
+    
+    teardown do
+      @textile_text, @textile_post, @markdown_text, @markdown_post = nil
+      TextilePost.delete_all
+      MarkdownPost.delete_all
+    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
+        class ::Post < ActiveRecord::Base
+          acts_as_markup :language => :wiki, :columns => [:body]
+        end
+      end
+    end
+  end
+  
+  def teardown
+    teardown_db
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+require 'test/unit'
+require 'shoulda'
+require File.expand_path( File.join(File.dirname(__FILE__), %w[.. lib acts_as_markup]) )
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :posts do |t|
+      t.column :title, :string
+      t.column :body, :text
+      t.timestamps
+    end
+    
+    create_table :markdown_posts do |t|
+      t.column :title, :string
+      t.column :body, :text
+      t.timestamps
+    end
+    
+    create_table :textile_posts do |t|
+      t.column :title, :string
+      t.column :body, :text
+      t.timestamps
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_markup
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brian Landau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-06 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: redcloth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Represent ActiveRecord Markdown or Textile text columns as Markdown or Textile objects using various external libraries to convert to HTML.
+email: brian.landau@viget.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+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
+has_rdoc: true
+homepage: http://viget.rubyforge.com/acts_as_markup
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: viget
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Represent ActiveRecord Markdown or Textile text columns as Markdown or Textile objects using various external libraries to convert to HTML
+test_files: 
+- test/acts_as_markup_test.rb