acts_as_markup 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+== 0.1.0 / 2008-08-04
+
+* Initial Release
+  * Support for Markdown and Textile markup languages.
+  * `acts_as_markdown` and `acts_as_textile` convenience methods
+  * Support for BlueCloth, RDiscount and Ruyb PEG markdown processors.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2008 Brian Landau of Viget Labs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,20 @@
+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

data/README.rdoc

@@ -0,0 +1,74 @@
+= acts_as_markup
+
+by Brian Landau of Viget Labs <brian.landau@viget.com>
+
+GitHub Project: http://github.com/vigetlabs/acts_as_markup
+
+RDoc: http://viget.rubyforge.org/acts_as_markup
+
+
+== DESCRIPTION:
+
+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.
+
+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:
+
+    ActsAsMarkup.markdown_library = :bluecloth
+
+By default RDiscount will be used.
+
+== EXAMPLES:
+
+==== Using +acts_as_markdown+:
+
+    class Post < ActiveRecrod
+      acts_as_markdown :body
+    end
+    
+    @post = Post.find(:first)
+    @post.body.to_s     #=> "## Markdown Headline"
+    @post.body.to_html  #=> "<h2> Markdown Headline</h2>"
+
+==== Using +acts_as_textile+:
+
+    class Post < ActiveRecrod
+      acts_as_textile :body
+    end
+
+    @post = Post.find(:first)
+    @post.body.to_s     #=> "h2. Markdown Headline"
+    @post.body.to_html  #=> "<h2>Markdown Headline</h2>"
+
+==== Using +acts_as_markup+:
+
+    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>"
+
+== REQUIREMENTS:
+
+You will need the RedCloth library for processing the Textile text.
+
+You will also need to install some type of Markdown processor.
+The three options currently supported are:
+
+* BlueCloth
+* RDiscount[http://github.com/rtomayko/rdiscount]
+* {Ruby PEG}[http://github.com/rtomayko/rpeg-markdown/tree/master]
+
+== INSTALL:
+
+<tt>sudo gem install acts_as_markup</tt>
+ 
+Add "+acts_as_markup+" to your environment.rb:
+
+    config.gem "acts_as_markup"
+

data/Rakefile

@@ -0,0 +1,25 @@
+# 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.
+
+load 'tasks/setup.rb'
+
+ensure_in_path 'lib'
+require 'acts_as_markup'
+
+task :default => 'test:run'
+
+PROJ.name = 'acts_as_markup'
+PROJ.authors = 'Brian Landau'
+PROJ.email = 'brian.landau@viget.com'
+PROJ.url = 'http://viget.rubyforge.com/acts_as_markup'
+PROJ.description = "Represent ActiveRecord Markdown or Textile text columns as Markdown or Textile objects using various external libraries to convert to HTML."
+PROJ.rubyforge.name = 'viget'
+PROJ.version = ActsAsMarkup::VERSION
+PROJ.rdoc.include = %w(^lib/ LICENSE\.txt README\.rdoc)
+PROJ.rdoc.remote_dir = 'acts_as_markup'
+PROJ.test.files = FileList['test/**/*_test.rb']
+
+%W(activesupport activerecord rdiscount redcloth).each  do |gem|
+  depend_on gem
+end

data/acts_as_markup.gemspec

@@ -0,0 +1,42 @@
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_markup}
+  s.version = "0.1.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.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.has_rdoc = true
+  s.homepage = %q{http://viget.rubyforge.com/acts_as_markup}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{viget}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Represent ActiveRecord Markdown or Textile text columns as Markdown or Textile objects using various external libraries to convert to HTML}
+  s.test_files = ["test/acts_as_markup_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.1.0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.1.0"])
+      s.add_runtime_dependency(%q<rdiscount>, [">= 1.2.7"])
+      s.add_runtime_dependency(%q<redcloth>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.1.0"])
+      s.add_dependency(%q<activerecord>, [">= 2.1.0"])
+      s.add_dependency(%q<rdiscount>, [">= 1.2.7"])
+      s.add_dependency(%q<redcloth>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.1.0"])
+    s.add_dependency(%q<activerecord>, [">= 2.1.0"])
+    s.add_dependency(%q<rdiscount>, [">= 1.2.7"])
+    s.add_dependency(%q<redcloth>, [">= 0"])
+  end
+end

data/lib/acts/as_markup.rb

@@ -0,0 +1,74 @@
+require 'active_record'
+
+module ActiveRecord # :nodoc:
+  module Acts # :nodoc:
+    module AsMarkup
+      def self.included(base) # :nodoc:
+        base.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+        
+        ##
+        # 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
+        #     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>"
+        # 
+        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]
+          when :textile
+            require 'redcloth'
+            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}
+                  end
+                end
+                @#{col.to_s} = #{klass}.new(self['#{col.to_s}'].to_s)
+              end
+            EOV
+          end
+        end
+        
+        ##
+        # This is a convenience method for 
+        # `<tt>acts_as_markup :language => :markdown, :columns => [:body]</tt>`
+        # 
+        def acts_as_markdown(*columns)
+          acts_as_markup :language => :markdown, :columns => columns
+        end
+        
+        ##
+        # This is a convenience method for 
+        # `<tt>acts_as_markup :language => :textile, :columns => [:body]</tt>`
+        #
+        def acts_as_textile(*columns)
+          acts_as_markup :language => :textile, :columns => columns
+        end
+        
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecord::Acts::AsMarkup

data/lib/acts_as_markup/exts/rdiscount.rb

@@ -0,0 +1,5 @@
+class RDiscount
+  def to_s
+    self.text
+  end
+end

data/lib/acts_as_markup.rb

@@ -0,0 +1,66 @@
+require 'active_support'
+
+module ActsAsMarkup
+  # :stopdoc:
+  VERSION = '0.1.0'
+  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 UnsportedMarkupLanguage < ArgumentError
+  end
+  
+  DEFAULT_MAKRDOWN_LIB = :rdiscount
+  
+  MARKDOWN_LIBS = { :rdiscount => {:class_name => "RDiscount",
+                                   :lib_name   => "rdiscount"}, 
+                    :bluecloth => {:class_name => "BlueCloth",
+                                   :lib_name   => "bluecloth"},
+                    :rpeg      => {:class_name => "PEGMarkdown",
+                                   :lib_name   => "peg_markdown"} }
+  
+  @@markdown_library = DEFAULT_MAKRDOWN_LIB
+  mattr_accessor :markdown_library
+  
+  # :stopdoc:
+  # 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 libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, *args)
+  end
+
+  # Returns the lpath 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
+
+ActsAsMarkup.require_all_libs_relative_to __FILE__
+ActsAsMarkup.require_all_libs_relative_to __FILE__, 'acts'

data/tasks/bones.rake

@@ -0,0 +1,21 @@
+# $Id$
+
+if HAVE_BONES
+
+namespace :bones do
+
+  desc 'Show the PROJ open struct'
+  task :debug do |t|
+    atr = if t.application.top_level_tasks.length == 2
+      t.application.top_level_tasks.pop
+    end
+
+    if atr then Bones::Debug.show_attr(PROJ, atr)
+    else Bones::Debug.show PROJ end
+  end
+
+end  # namespace :bones
+
+end  # HAVE_BONES
+
+# EOF

data/tasks/gem.rake

@@ -0,0 +1,126 @@
+# $Id$
+
+require 'rake/gempackagetask'
+
+namespace :gem do
+
+  PROJ.gem._spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge.name
+
+    s.description = PROJ.description
+
+    PROJ.gem.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    s.files = PROJ.gem.files
+    s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc.include.join('|'))
+    excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.gem.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc.opts + ['--main', PROJ.rdoc.main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
+    else
+      s.test_files = PROJ.test.files.to_a
+    end
+
+    # Do any extra stuff the user wants
+    PROJ.gem.extras.each do |msg, val|
+      case val
+      when Proc
+        val.call(s.send(msg))
+      else
+        s.send "#{msg}=", val
+      end
+    end
+  end  # Gem::Specification.new
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
+  end
+
+  pkg = Rake::PackageTask.new(PROJ.name, PROJ.version) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+    pkg.package_files += PROJ.gem._spec.files
+  end
+  Rake::Task['gem:package'].instance_variable_set(:@full_comment, nil)
+
+  gem_file = if PROJ.gem._spec.platform == Gem::Platform::RUBY
+      "#{pkg.package_name}.gem"
+    else
+      "#{pkg.package_name}-#{PROJ.gem._spec.platform}.gem"
+    end
+
+  desc "Build the gem file #{gem_file}"
+  task :package => ['gem:prereqs', "#{pkg.package_dir}/#{gem_file}"]
+
+  file "#{pkg.package_dir}/#{gem_file}" => [pkg.package_dir] + PROJ.gem._spec.files do
+    when_writing("Creating GEM") {
+      Gem::Builder.new(PROJ.gem._spec).build
+      verbose(true) {
+        mv gem_file, "#{pkg.package_dir}/#{gem_file}"
+      }
+    }
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, 'gem:package'] do
+    sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
+
+    # use this version of the command for rubygems > 1.0.0
+    #sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{PROJ.gem._spec.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PROJ.name)
+    if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
+      sh "#{SUDO} #{GEM} uninstall --version '#{PROJ.version}' --ignore-dependencies --executables #{PROJ.name}"
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+
+  desc 'Cleanup the gem'
+  task :cleanup do
+    sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
+  end
+
+end  # namespace :gem
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+
+remove_desc_for_task %w(gem:clobber_package)
+
+# EOF