acts_as_markup 1.3.4 → 1.4.0

data/CHANGELOG

@@ -1,3 +1,11 @@
+== 1.4.0 / 2011-11-17
+* Make more like modern Rails 3 plugin.
+* Fix broken markup processors integration.
+* Refactor .acts_as_markup method
+* Allow use of different mediawiki libraries
+* Default mediawiki library is WikiCloth
+* Add support for Redcarpet markdown parser
+
 == 1.3.4 / 2010-09-04
 * Rails 3.x release
 

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+
+gem 'activesupport'
+gem 'activerecord'
+gem 'rdiscount'
+gem 'wikicloth'
+gem 'RedCloth'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem 'sqlite3-ruby'
+  gem 'brianjlandau-sdoc-helpers', :require => 'sdoc_helpers'
+  gem 'rpeg-markdown'
+  gem 'rdoc'
+  gem 'bluecloth'
+  gem 'maruku'
+  gem 'wikitext'
+  gem 'redcarpet'
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.8)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    bluecloth (2.2.0)
+    brianjlandau-sdoc-helpers (0.1.4)
+    builder (3.0.0)
+    expression_parser (0.9.0)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.1)
+    maruku (0.6.0)
+      syntax (>= 1.0.0)
+    multi_json (1.0.3)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdiscount (1.6.8)
+    rdoc (3.11)
+      json (~> 1.4)
+    redcarpet (1.17.2)
+    rpeg-markdown (1.4.6)
+    shoulda (2.11.3)
+    sqlite3 (1.3.4)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    syntax (1.0.0)
+    tzinfo (0.3.31)
+    wikicloth (0.7.1)
+      builder
+      expression_parser
+    wikitext (3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  activerecord
+  activesupport
+  bluecloth
+  brianjlandau-sdoc-helpers
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  maruku
+  rcov
+  rdiscount
+  rdoc
+  redcarpet
+  rpeg-markdown
+  shoulda
+  sqlite3-ruby
+  wikicloth
+  wikitext

data/README.rdoc

@@ -17,12 +17,12 @@ 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" "textile", "wikitext" or "rdoc" (case insensitive) it will 
+is listed as "markdown" "textile", "mediawiki" or "rdoc" (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, Ruby PEG or Maruku. You specify which one you want to use by setting
+BlueCloth, RDiscount, Ruby PEG, Redcarpet or Maruku. You specify which one you want to use by setting
 a config value in your environment.rb file:
 
     ActsAsMarkup.markdown_library = :bluecloth
@@ -30,7 +30,7 @@ a config value in your environment.rb file:
 By default RDiscount will be used.
 
 You can specify additional options to pass to the markup library by using
-<tt>:markdown_options</tt>, <tt>:textile_options</tt> or <tt>:wikitext_options</tt>.
+<tt>:markdown_options</tt>, <tt>:textile_options</tt> or <tt>:mediawiki_options</tt>.
 RDoc does not support any useful options. The options should be given as an
 array of arguments. You can specify options for multiple languages when
 allowing more than one. See each library's documentation for more details on
@@ -60,10 +60,10 @@ what options are available.
     @post.body.to_html  #=> "<h2>Textile Headline</h2>"
     
 
-==== Using +acts_as_wikitext+:
+==== Using +acts_as_mediawiki+:
 
     class Post < ActiveRecord
-      acts_as_wikitext :body
+      acts_as_mediawiki :body
     end
 
     @post = Post.find(:first)
@@ -116,23 +116,24 @@ what options are available.
     end
     
     class Post < ActiveRecord
-      acts_as_wikitext :body, :wikitext_options => [ { :space_to_underscore => true } ]
+      acts_as_mediawiki :body, :mediawiki_options => [ { :space_to_underscore => true } ]
     end
     
 
 == REQUIREMENTS:
 
 You will need the RedCloth[http://whytheluckystiff.net/ruby/redcloth/] library 
-for processing the Textile text, and the Wikitext[http://wikitext.rubyforge.org/] 
-library for processing wikitext.
+for processing the Textile text, and the WikiCloth[https://github.com/nricciar/wikicloth] 
+library for processing mediawiki text.
 
 You will also need to install some type of Markdown processor.
-The three options currently supported are:
+The four options currently supported are:
 
 * BlueCloth
 * RDiscount[http://github.com/rtomayko/rdiscount]
-* {Ruby PEG}[http://github.com/rtomayko/rpeg-markdown/tree/master]
+* {Ruby PEG}[http://github.com/rtomayko/rpeg-markdown]
 * Maruku[http://maruku.rubyforge.org/]
+* Redcarpet[https://github.com/tanoku/redcarpet]
 
 == INSTALL:
 

data/Rakefile

@@ -1,35 +1,40 @@
-# Look in the tasks/setup.rb file for the various options that can be
-# configured in this Rakefile. The .rake files in the tasks directory
-# are where the options are used.
-$:.unshift(File.expand_path('lib'))
-
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
 require 'rake'
+
+require 'jeweler'
+
+$:.unshift(File.expand_path('lib'))
+$:.unshift(File.expand_path(File.dirname(__FILE__)))
 require 'acts_as_markup'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "acts_as_markup"
-    gem.summary = %Q{Represent ActiveRecord Markdown, Textile, Wiki text, RDoc columns as Markdown, Textile Wikitext, RDoc objects using various external libraries to convert to HTML.}
-    gem.description = %Q{Represent ActiveRecord Markdown, Textile, Wiki text, RDoc columns as Markdown, Textile Wikitext, RDoc objects using various external libraries to convert to HTML.}
-    gem.email = "brian.landau@viget.com"
-    gem.homepage = "http://vigetlabs.github.com/acts_as_markup/"
-    gem.authors = ["Brian Landau"]
-    gem.version = ActsAsMarkup::VERSION
-    gem.add_dependency('activesupport', '>= 2.3.2')
-    gem.add_dependency('activerecord', '>= 2.3.2')
-    gem.add_dependency('rdiscount', '~> 1.3')
-    gem.add_dependency('wikitext', '~> 2.0')
-    gem.add_dependency('RedCloth', '~> 4.2')
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+Jeweler::Tasks.new do |gem|
+  gem.name = "acts_as_markup"
+  gem.summary = %Q{Represent ActiveRecord Markdown, Textile, Wiki text, RDoc columns as Markdown, Textile Wikitext, RDoc objects using various external libraries to convert to HTML.}
+  gem.description = %Q{Represent ActiveRecord Markdown, Textile, Wiki text, RDoc columns as Markdown, Textile Wikitext, RDoc objects using various external libraries to convert to HTML.}
+  gem.email = "brian.landau@viget.com"
+  gem.homepage = "http://vigetlabs.github.com/acts_as_markup/"
+  gem.license = "MIT"
+  gem.authors = ["Brian Landau"]
+  gem.version = ActsAsMarkup::VERSION
+  gem.add_dependency('activesupport', '>= 2.3.2')
+  gem.add_dependency('activerecord', '>= 2.3.2')
+  gem.add_dependency('rdiscount', '~> 1.3')
+  gem.add_dependency('wikitext', '~> 2.0')
+  gem.add_dependency('RedCloth', '~> 4.2')
+  # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
 end
+Jeweler::RubygemsDotOrgTasks.new
 
 require 'tasks/test'
 require 'tasks/rdoc'
 
-task :test => :check_dependencies
 task :default => :test

data/acts_as_markup.gemspec

@@ -1,71 +1,102 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_markup}
-  s.version = "1.3.4"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Brian Landau"]
-  s.date = %q{2010-09-04}
+  s.authors = [%q{Brian Landau}]
+  s.date = %q{2011-11-17}
   s.description = %q{Represent ActiveRecord Markdown, Textile, Wiki text, RDoc columns as Markdown, Textile Wikitext, RDoc objects using various external libraries to convert to HTML.}
   s.email = %q{brian.landau@viget.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
-    ".gitignore",
-     "CHANGELOG",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "acts_as_markup.gemspec",
-     "lib/acts/as_markup.rb",
-     "lib/acts_as_markup.rb",
-     "lib/acts_as_markup/exts/maruku.rb",
-     "lib/acts_as_markup/exts/object.rb",
-     "lib/acts_as_markup/exts/peg_markdown.rb",
-     "lib/acts_as_markup/exts/rdiscount.rb",
-     "lib/acts_as_markup/exts/rdoc.rb",
-     "lib/acts_as_markup/exts/wikitext.rb",
-     "lib/acts_as_markup/stringlike.rb",
-     "tasks/rdoc.rb",
-     "tasks/test.rb",
-     "test/acts_as_markdown_test.rb",
-     "test/acts_as_markup_test.rb",
-     "test/acts_as_rdoc_test.rb",
-     "test/acts_as_textile_test.rb",
-     "test/acts_as_wikitext_test.rb",
-     "test/test_helper.rb"
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "acts_as_markup.gemspec",
+    "lib/acts_as_markup.rb",
+    "lib/acts_as_markup/active_record_extension.rb",
+    "lib/acts_as_markup/exts/bluecloth.rb",
+    "lib/acts_as_markup/exts/maruku.rb",
+    "lib/acts_as_markup/exts/object.rb",
+    "lib/acts_as_markup/exts/peg_markdown.rb",
+    "lib/acts_as_markup/exts/rdiscount.rb",
+    "lib/acts_as_markup/exts/rdoc.rb",
+    "lib/acts_as_markup/exts/redcarpet.rb",
+    "lib/acts_as_markup/exts/wikicloth.rb",
+    "lib/acts_as_markup/exts/wikitext.rb",
+    "lib/acts_as_markup/railtie.rb",
+    "lib/acts_as_markup/stringlike.rb",
+    "lib/acts_as_markup/version.rb",
+    "tasks/rdoc.rb",
+    "tasks/test.rb",
+    "test/acts_as_markdown_test.rb",
+    "test/acts_as_markup_test.rb",
+    "test/acts_as_mediawiki_test.rb",
+    "test/acts_as_rdoc_test.rb",
+    "test/acts_as_textile_test.rb",
+    "test/test_helper.rb"
   ]
   s.homepage = %q{http://vigetlabs.github.com/acts_as_markup/}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
   s.summary = %q{Represent ActiveRecord Markdown, Textile, Wiki text, RDoc columns as Markdown, Textile Wikitext, RDoc objects using various external libraries to convert to HTML.}
-  s.test_files = [
-    "test/acts_as_markdown_test.rb",
-     "test/acts_as_markup_test.rb",
-     "test/acts_as_rdoc_test.rb",
-     "test/acts_as_textile_test.rb",
-     "test/acts_as_wikitext_test.rb",
-     "test/test_helper.rb"
-  ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_runtime_dependency(%q<rdiscount>, [">= 0"])
+      s.add_runtime_dependency(%q<wikicloth>, [">= 0"])
+      s.add_runtime_dependency(%q<RedCloth>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<brianjlandau-sdoc-helpers>, [">= 0"])
+      s.add_development_dependency(%q<rpeg-markdown>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bluecloth>, [">= 0"])
+      s.add_development_dependency(%q<maruku>, [">= 0"])
+      s.add_development_dependency(%q<wikitext>, [">= 0"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 2.3.2"])
       s.add_runtime_dependency(%q<activerecord>, [">= 2.3.2"])
       s.add_runtime_dependency(%q<rdiscount>, ["~> 1.3"])
       s.add_runtime_dependency(%q<wikitext>, ["~> 2.0"])
       s.add_runtime_dependency(%q<RedCloth>, ["~> 4.2"])
     else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<rdiscount>, [">= 0"])
+      s.add_dependency(%q<wikicloth>, [">= 0"])
+      s.add_dependency(%q<RedCloth>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<brianjlandau-sdoc-helpers>, [">= 0"])
+      s.add_dependency(%q<rpeg-markdown>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bluecloth>, [">= 0"])
+      s.add_dependency(%q<maruku>, [">= 0"])
+      s.add_dependency(%q<wikitext>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 2.3.2"])
       s.add_dependency(%q<activerecord>, [">= 2.3.2"])
       s.add_dependency(%q<rdiscount>, ["~> 1.3"])
@@ -73,6 +104,23 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<RedCloth>, ["~> 4.2"])
     end
   else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<rdiscount>, [">= 0"])
+    s.add_dependency(%q<wikicloth>, [">= 0"])
+    s.add_dependency(%q<RedCloth>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<brianjlandau-sdoc-helpers>, [">= 0"])
+    s.add_dependency(%q<rpeg-markdown>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bluecloth>, [">= 0"])
+    s.add_dependency(%q<maruku>, [">= 0"])
+    s.add_dependency(%q<wikitext>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 2.3.2"])
     s.add_dependency(%q<activerecord>, [">= 2.3.2"])
     s.add_dependency(%q<rdiscount>, ["~> 1.3"])

data/lib/acts_as_markup.rb

@@ -2,13 +2,10 @@ require 'set'
 require 'active_support'
 require 'active_support/core_ext'
 
+require 'acts_as_markup/version'
+require 'acts_as_markup/railtie' if defined?(Rails)
+
 module ActsAsMarkup
-  # :stopdoc:
-  VERSION = '1.3.4'.freeze
-  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
-  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
-  # :startdoc:
-  
   # This exception is raised when an unsupported markup language is supplied to acts_as_markup.
   class UnsupportedMarkupLanguage < ArgumentError
   end
@@ -17,61 +14,36 @@ module ActsAsMarkup
   class UnsportedMarkdownLibrary < ArgumentError
   end
   
-  DEFAULT_MARKDOWN_LIB = :rdiscount
+  # This exception is raised when an unsupported Mediawiki library is set to the config value.
+  class UnsportedMediawikiLibrary < ArgumentError
+  end
   
   MARKDOWN_LIBS = { :rdiscount => {:class_name => "RDiscount",
                                    :lib_name   => "rdiscount"}, 
-                    :bluecloth => {:class_name => "BlueCloth",
+                    :bluecloth => {:class_name => "BlueClothText",
                                    :lib_name   => "bluecloth"},
                     :rpeg      => {:class_name => "PEGMarkdown",
                                    :lib_name   => "peg_markdown"},
                     :maruku    => {:class_name => "Maruku",
-                                   :lib_name   => "maruku"} }
+                                   :lib_name   => "maruku"},
+                    :redcarpet => {:class_name => "Redcarpet",
+                                   :lib_name   => 'redcarpet'} }
+
+  MEDIAWIKI_LIBS = { :wikitext  => {:class_name => "WikitextString",
+                                   :lib_name   => "wikitext"},
+                     :wikicloth => {:class_name => "WikiClothText",
+                                    :lib_name   => 'wikicloth'} }
                                    
-  LIBRARY_EXTENSIONS = ::Set.new(Dir[ActsAsMarkup::LIBPATH + 'acts_as_markup/exts/*.rb'].map {|file| File.basename(file, '.rb')}).delete('string')
-  
-  @@markdown_library = DEFAULT_MARKDOWN_LIB
+  LIBRARY_EXTENSIONS = ::Set.new(Dir[File.join(File.expand_path(File.dirname(__FILE__)), 'acts_as_markup/exts/*.rb')].map {|file| File.basename(file, '.rb')}).delete('string')
+
   mattr_accessor :markdown_library
-  
-  # :stopdoc:
+  mattr_accessor :mediawiki_library
+
   # Returns the version string for the library.
-  #
   def self.version
     VERSION
   end
 
-  # Returns the library path for the module. If any arguments are given,
-  # they will be joined to the end of the library path using
-  # <tt>File.join</tt>.
-  #
-  def self.libpath( *args )
-    args.empty? ? LIBPATH : ::File.join(LIBPATH, *args)
-  end
-
-  # Returns the path for the module. If any arguments are given,
-  # they will be joined to the end of the path using
-  # <tt>File.join</tt>.
-  #
-  def self.path( *args )
-    args.empty? ? PATH : ::File.join(PATH, *args)
-  end
-
-  # Utility method used to rquire all files ending in .rb that lie in the
-  # directory below this file that has the same name as the filename passed
-  # in. Optionally, a specific _directory_ name can be passed in such that
-  # the _filename_ does not have to be equivalent to the directory.
-  #
-  def self.require_all_libs_relative_to( fname, dir = nil )
-    dir ||= ::File.basename(fname, '.*')
-    search_me = ::File.expand_path(
-        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
-
-    Dir.glob(search_me).sort.each {|rb| require rb}
-  end
-  # :startdoc:
-
-end  # module ActsAsMarkup
+end
 
-require 'acts_as_markup/exts/object'
-require 'acts_as_markup/stringlike'
-ActsAsMarkup.require_all_libs_relative_to __FILE__, 'acts'
+ActiveSupport.run_load_hooks(:acts_as_markup, ActsAsMarkup)