vigetlabs-acts_as_markup 0.1.1

data/tasks/rubyforge.rake

@@ -0,0 +1,57 @@
+
+if PROJ.rubyforge.name.valid? && HAVE_RUBYFORGE
+
+require 'rubyforge'
+require 'rake/contrib/sshpublisher'
+
+namespace :gem do
+  desc 'Package and upload to RubyForge'
+  task :release => [:clobber, 'gem:package'] do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+    pkg = "pkg/#{PROJ.gem._spec.full_name}"
+
+    if $DEBUG then
+      puts "release_id = rf.add_release #{PROJ.rubyforge.name.inspect}, #{PROJ.name.inspect}, #{PROJ.version.inspect}, \"#{pkg}.tgz\""
+      puts "rf.add_file #{PROJ.rubyforge.name.inspect}, #{PROJ.name.inspect}, release_id, \"#{pkg}.gem\""
+    end
+
+    rf = RubyForge.new
+    rf.configure rescue nil
+    puts 'Logging in'
+    rf.login
+
+    c = rf.userconfig
+    c['release_notes'] = PROJ.description if PROJ.description
+    c['release_changes'] = PROJ.changes if PROJ.changes
+    c['preformatted'] = true
+
+    files = [(PROJ.gem.need_tar ? "#{pkg}.tgz" : nil),
+             (PROJ.gem.need_zip ? "#{pkg}.zip" : nil),
+             "#{pkg}.gem"].compact
+
+    puts "Releasing #{PROJ.name} v. #{PROJ.version}"
+    rf.add_release PROJ.rubyforge.name, PROJ.name, PROJ.version, *files
+  end
+end  # namespace :gem
+
+
+namespace :doc do
+  desc "Publish RDoc to RubyForge"
+  task :release => %w(doc:clobber_rdoc doc:rdoc) do
+    config = YAML.load(
+        File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = "/var/www/gforge-projects/#{PROJ.rubyforge.name}/"
+    remote_dir << PROJ.rdoc.remote_dir if PROJ.rdoc.remote_dir
+    local_dir = PROJ.rdoc.dir
+
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+end  # namespace :doc
+
+end  # if HAVE_RUBYFORGE
+
+# EOF

data/tasks/setup.rb

@@ -0,0 +1,268 @@
+# $Id$
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'fileutils'
+require 'ostruct'
+
+class OpenStruct; undef :gem; end
+
+PROJ = OpenStruct.new(
+  # Project Defaults
+  :name => nil,
+  :summary => nil,
+  :description => nil,
+  :changes => nil,
+  :authors => nil,
+  :email => nil,
+  :url => "\000",
+  :version => ENV['VERSION'] || '0.0.0',
+  :exclude => %w(tmp$ bak$ ~$ CVS \.svn/ \.git ^pkg/),
+  :release_name => ENV['RELEASE'],
+
+  # System Defaults
+  :ruby_opts => %w(-w),
+  :libs => [],
+  :history_file => 'History.txt',
+  :manifest_file => 'Manifest.txt',
+  :readme_file => 'README.rdoc',
+
+  # Announce
+  :ann => OpenStruct.new(
+    :file => 'announcement.txt',
+    :text => nil,
+    :paragraphs => [],
+    :email => {
+      :from     => nil,
+      :to       => %w(ruby-talk@ruby-lang.org),
+      :server   => 'localhost',
+      :port     => 25,
+      :domain   => ENV['HOSTNAME'],
+      :acct     => nil,
+      :passwd   => nil,
+      :authtype => :plain
+    }
+  ),
+
+  # Gem Packaging
+  :gem => OpenStruct.new(
+    :dependencies => [],
+    :executables => nil,
+    :extensions => FileList['ext/**/extconf.rb'],
+    :files => nil,
+    :need_tar => true,
+    :need_zip => false,
+    :extras => {}
+  ),
+
+  # File Annotations
+  :notes => OpenStruct.new(
+    :exclude => %w(^tasks/setup\.rb$),
+    :extensions => %w(.txt .rb .erb) << '',
+    :tags => %w(FIXME OPTIMIZE TODO)
+  ),
+
+  # Rcov
+  :rcov => OpenStruct.new(
+    :dir => 'coverage',
+    :opts => %w[--sort coverage -T],
+    :threshold => 90.0,
+    :threshold_exact => false
+  ),
+
+  # Rdoc
+  :rdoc => OpenStruct.new(
+    :opts => [],
+    :include => %w(^lib/ ^bin/ ^ext/ \.txt$),
+    :exclude => %w(extconf\.rb$),
+    :main => nil,
+    :dir => 'doc',
+    :remote_dir => nil
+  ),
+
+  # Rubyforge
+  :rubyforge => OpenStruct.new(
+    :name => "\000"
+  ),
+
+  # Rspec
+  :spec => OpenStruct.new(
+    :files => FileList['spec/**/*_spec.rb'],
+    :opts => []
+  ),
+
+  # Subversion Repository
+  :svn => OpenStruct.new(
+    :root => nil,
+    :path => '',
+    :trunk => 'trunk',
+    :tags => 'tags',
+    :branches => 'branches'
+  ),
+
+  # Test::Unit
+  :test => OpenStruct.new(
+    :files => FileList['test/**/test_*.rb'],
+    :file  => 'test/all.rb',
+    :opts  => []
+  )
+)
+
+# Load the other rake files in the tasks folder
+rakefiles = Dir.glob('tasks/*.rake').sort
+rakefiles.unshift(rakefiles.delete('tasks/post_load.rake')).compact!
+import(*rakefiles)
+
+# Setup the project libraries
+%w(lib ext).each {|dir| PROJ.libs << dir if test ?d, dir}
+
+# Setup some constants
+WIN32 = %r/djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM unless defined? WIN32
+
+DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
+
+def quiet( &block )
+  io = [STDOUT.dup, STDERR.dup]
+  STDOUT.reopen DEV_NULL
+  STDERR.reopen DEV_NULL
+  block.call
+ensure
+  STDOUT.reopen io.first
+  STDERR.reopen io.last
+  $stdout, $stderr = STDOUT, STDERR
+end
+
+DIFF = if WIN32 then 'diff.exe'
+       else
+         if quiet {system "gdiff", __FILE__, __FILE__} then 'gdiff'
+         else 'diff' end
+       end unless defined? DIFF
+
+SUDO = if WIN32 then ''
+       else
+         if quiet {system 'which sudo'} then 'sudo'
+         else '' end
+       end
+
+RCOV = WIN32 ? 'rcov.bat' : 'rcov'
+RDOC = WIN32 ? 'rdoc.bat' : 'rdoc'
+GEM  = WIN32 ? 'gem.bat'  : 'gem'
+
+%w(rcov spec/rake/spectask rubyforge bones facets/ansicode).each do |lib|
+  begin
+    require lib
+    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", true}
+  rescue LoadError
+    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", false}
+  end
+end
+HAVE_SVN = (Dir.entries(Dir.pwd).include?('.svn') and
+            system("svn --version 2>&1 > #{DEV_NULL}"))
+HAVE_GIT = (Dir.entries(Dir.pwd).include?('.git') and
+            system("git --version 2>&1 > #{DEV_NULL}"))
+
+# Reads a file at +path+ and spits out an array of the +paragraphs+
+# specified.
+#
+#    changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+#    summary, *description = paragraphs_of('README.txt', 3, 3..8)
+#
+def paragraphs_of( path, *paragraphs )
+  title = String === paragraphs.first ? paragraphs.shift : nil
+  ary = File.read(path).delete("\r").split(/\n\n+/)
+
+  result = if title
+    tmp, matching = [], false
+    rgxp = %r/^=+\s*#{Regexp.escape(title)}/i
+    paragraphs << (0..-1) if paragraphs.empty?
+
+    ary.each do |val|
+      if val =~ rgxp
+        break if matching
+        matching = true
+        rgxp = %r/^=+/i
+      elsif matching
+        tmp << val
+      end
+    end
+    tmp
+  else ary end
+
+  result.values_at(*paragraphs)
+end
+
+# Adds the given gem _name_ to the current project's dependency list. An
+# optional gem _version_ can be given. If omitted, the newest gem version
+# will be used.
+#
+def depend_on( name, version = nil )
+  spec = Gem.source_index.find_name(name).last
+  version = spec.version.to_s if version.nil? and !spec.nil?
+
+  PROJ.gem.dependencies << case version
+    when nil; [name]
+    when %r/^\d/; [name, ">= #{version}"]
+    else [name, version] end
+end
+
+# Adds the given arguments to the include path if they are not already there
+#
+def ensure_in_path( *args )
+  args.each do |path|
+    path = File.expand_path(path)
+    $:.unshift(path) if test(?d, path) and not $:.include?(path)
+  end
+end
+
+# Find a rake task using the task name and remove any description text. This
+# will prevent the task from being displayed in the list of available tasks.
+#
+def remove_desc_for_task( names )
+  Array(names).each do |task_name|
+    task = Rake.application.tasks.find {|t| t.name == task_name}
+    next if task.nil?
+    task.instance_variable_set :@comment, nil
+  end
+end
+
+# Change working directories to _dir_, call the _block_ of code, and then
+# change back to the original working directory (the current directory when
+# this method was called).
+#
+def in_directory( dir, &block )
+  curdir = pwd
+  begin
+    cd dir
+    return block.call
+  ensure
+    cd curdir
+  end
+end
+
+# Scans the current working directory and creates a list of files that are
+# candidates to be in the manifest.
+#
+def manifest_files
+  files = []
+  exclude = Regexp.new(PROJ.exclude.join('|'))
+  Find.find '.' do |path|
+    path.sub! %r/^(\.\/|\/)/o, ''
+    next unless test ?f, path
+    next if path =~ exclude
+    files << path
+  end
+  files.sort!
+end
+
+# We need a "valid" method thtat determines if a string is suitable for use
+# in the gem specification.
+#
+class Object
+  def valid?
+    return !(self.empty? or self == "\000") if self.respond_to?(:to_str)
+    return false
+  end
+end
+
+# EOF

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