tristandunn-acts_as_markup 1.3.3

data/lib/acts_as_markup.rb

@@ -0,0 +1,75 @@
+require 'active_support'
+
+module ActsAsMarkup
+  # :stopdoc:
+  VERSION = '1.3.3'.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
+
+  # This exception is raised when an unsupported Markdown library is set to the config value.
+  class UnsportedMarkdownLibrary < ArgumentError
+  end
+
+  DEFAULT_MARKDOWN_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"},
+                    :maruku    => {:class_name => "Maruku",
+                                   :lib_name   => "maruku"} }
+
+  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
+  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 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
+
+require 'acts_as_markup/exts/object'
+require 'acts_as_markup/stringlike'
+ActsAsMarkup.require_all_libs_relative_to __FILE__, 'acts'

data/lib/acts_as_markup/exts/maruku.rb

@@ -0,0 +1,70 @@
+require 'maruku'
+
+class Maruku
+  include Stringlike
+
+  attr_reader :text
+
+  def initialize(s=nil, meta={})
+    super(nil)
+    self.attributes.merge! meta
+    if s
+      @text = s
+      parse_doc(s)
+    end
+  end
+
+  # Used to get the original Markdown text.
+  def to_s
+    @text
+  end
+
+  # used to be compatable with Rails/ActiveSupport
+  def blank?
+    @text.blank?
+  end
+
+end
+
+class String
+  alias_method :to_html, :to_s
+
+  def to_xml
+    REXML::Text.new(self)
+  end
+end
+
+module MaRuKu # :nodoc:
+  module Out # :nodoc:
+    module HTML
+
+      # We patch this method to play nicely with our own modifications of String.
+      #
+      # It originally used a +to_html+ method on String we've swapped this out for a +to_xml+
+      # method because we need +to_html+ to return the original text on plain text fields of
+      # the variable language option on +acts_as_markup+
+      def array_to_html(array)
+        elements = []
+        array.each do |item|
+          method = item.kind_of?(MDElement) ? "to_html_#{item.node_type}" : "to_xml"
+          unless item.respond_to?(method)
+            next
+          end
+
+          html_text =  item.send(method)
+          if html_text.nil?
+            raise "Nil html created by method  #{method}:\n#{html_text.inspect}\n for object #{item.inspect[0,300]}"
+          end
+
+          if html_text.kind_of?Array
+            elements = elements + html_text
+          else
+            elements << html_text
+          end
+        end
+        elements
+      end
+
+    end
+  end
+end

data/lib/acts_as_markup/exts/object.rb

@@ -0,0 +1,5 @@
+class Object
+  def to_html
+    self.to_s
+  end
+end

data/lib/acts_as_markup/exts/peg_markdown.rb

@@ -0,0 +1,10 @@
+require 'peg_markdown'
+
+class PEGMarkdown
+  include Stringlike
+
+  # used to be compatable with Rails/ActiveSupport
+  def blank?
+    self.text.blank?
+  end
+end

data/lib/acts_as_markup/exts/rdiscount.rb

@@ -0,0 +1,15 @@
+require 'rdiscount'
+
+class RDiscount
+  include Stringlike
+
+  # Used to get the original Markdown text.
+  def to_s
+    self.text
+  end
+
+  # used to be compatable with Rails/ActiveSupport
+  def blank?
+    self.text.blank?
+  end
+end

data/lib/acts_as_markup/exts/rdoc.rb

@@ -0,0 +1,100 @@
+require 'rdoc/markup/simple_markup'
+require 'rdoc/markup/simple_markup/to_html'
+
+class RDocWithHyperlinkToHtml < SM::ToHtml
+
+  # Generate a hyperlink for url, labeled with text. Handle the
+  # special cases for img: and link: described under handle_special_HYPEDLINK
+  #
+  def gen_url(url, text)
+    if url =~ /([A-Za-z]+):(.*)/
+      type = $1
+      path = $2
+    else
+      type = "http"
+      path = url
+      url  = "http://#{url}"
+    end
+
+    if type == "link"
+      if path[0,1] == '#'  # is this meaningful?
+        url = path
+      else
+        url = HTMLGenerator.gen_url(@from_path, path)
+      end
+    end
+
+    if (type == "http" || type == "link") && url =~ /\.(gif|png|jpg|jpeg|bmp)$/
+      "<img src=\"#{url}\" />"
+    else
+      "<a href=\"#{url}\">#{text.sub(%r{^#{type}:/*}, '')}</a>"
+    end
+  end
+
+  # And we're invoked with a potential external hyperlink mailto:
+  # just gets inserted. http: links are checked to see if they
+  # reference an image. If so, that image gets inserted using an
+  # <img> tag. Otherwise a conventional <a href> is used.  We also
+  # support a special type of hyperlink, link:, which is a reference
+  # to a local file whose path is relative to the --op directory.
+  #
+  def handle_special_HYPERLINK(special)
+    url = special.text
+    gen_url(url, url)
+  end
+
+  # Here's a hypedlink where the label is different to the URL
+  #    <label>[url]
+  #
+  def handle_special_TIDYLINK(special)
+    text = special.text
+    unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/
+      return text
+    end
+    label = $1
+    url   = $2
+    gen_url(url, label)
+  end
+
+end
+
+# This allows a us to create a wrapper object similar to those provided by the
+# Markdown and Textile libraries. It stores the original and formated HTML text
+# in instance variables. It also stores the SimpleMarkup parser objects in
+# instance variables.
+#
+class RDocText < String
+  attr_reader :text
+  attr_reader :html
+  attr_reader :markup
+  attr_reader :html_formater
+
+  def initialize(str)
+    super(str)
+    @text = str.to_s
+    @markup = SM::SimpleMarkup.new
+
+    # external hyperlinks
+    @markup.add_special(/((link:|https?:|mailto:|ftp:|www\.)\S+\w)/, :HYPERLINK)
+
+    # and links of the form  <text>[<url>]
+    @markup.add_special(/(((\{.*?\})|\b\S+?)\[\S+?\.\S+?\])/, :TIDYLINK)
+
+    # Convert leading comment markers to spaces, but only
+    # if all non-blank lines have them
+
+    if str =~ /^(?>\s*)[^\#]/
+      content = str
+    else
+      content = str.gsub(/^\s*(#+)/)  { $1.tr('#',' ') }
+    end
+
+    @html_formatter = RDocWithHyperlinkToHtml.new
+
+    @html = @markup.convert(@text, @html_formatter)
+  end
+
+  def to_html
+    @html
+  end
+end

data/lib/acts_as_markup/exts/simple_format.rb

@@ -0,0 +1,18 @@
+require 'action_view'
+
+class SimpleFormat
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::TextHelper
+
+  def initialize(text)
+    @text = text
+  end
+
+  def to_s
+    @text
+  end
+
+  def to_html
+    simple_format @text
+  end
+end

data/lib/acts_as_markup/exts/wikitext.rb

@@ -0,0 +1,20 @@
+require 'wikitext'
+
+# This allows a us to create a wrapper object similar to those provided by the
+# Markdown and Textile libraries. It stores the original and formated HTML text
+# in instance variables.
+#
+class WikitextString < String
+  attr_reader :text
+  attr_reader :html
+
+  def initialize(str, *options)
+    super(str)
+    @text = str.to_s
+    @html = Wikitext::Parser.new(*options).parse(@text)
+  end
+
+  def to_html
+    @html
+  end
+end

data/lib/acts_as_markup/stringlike.rb

@@ -0,0 +1,7 @@
+# This mixin allows our markup objects (like RDiscount or RedCloth) to have
+# all the normal string methods that are available.
+module Stringlike
+  def method_missing(method, *params)
+    self.to_s.send(method, *params)
+  end
+end

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,201 @@
+
+require 'find'
+require 'rake/packagetask'
+require 'rubygems/user_interaction'
+require 'rubygems/builder'
+
+module Bones
+class GemPackageTask < Rake::PackageTask
+  # Ruby GEM spec containing the metadata for this package.  The
+  # name, version and package_files are automatically determined
+  # from the GEM spec and don't need to be explicitly provided.
+  #
+  attr_accessor :gem_spec
+
+  # Tasks from the Bones gem directory
+  attr_reader :bones_files
+
+  # Create a GEM Package task library.  Automatically define the gem
+  # if a block is given.  If no block is supplied, then +define+
+  # needs to be called to define the task.
+  #
+  def initialize(gem_spec)
+    init(gem_spec)
+    yield self if block_given?
+    define if block_given?
+  end
+
+  # Initialization tasks without the "yield self" or define
+  # operations.
+  #
+  def init(gem)
+    super(gem.name, gem.version)
+    @gem_spec = gem
+    @package_files += gem_spec.files if gem_spec.files
+    @bones_files = []
+
+    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
+    if !test(?e, local_setup)
+      Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
+    end
+  end
+
+  # Create the Rake tasks and actions specified by this
+  # GemPackageTask.  (+define+ is automatically called if a block is
+  # given to +new+).
+  #
+  def define
+    super
+    task :prereqs
+    task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
+    file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
+      when_writing("Creating GEM") {
+        chdir(package_dir_path) do
+          Gem::Builder.new(gem_spec).build
+          verbose(true) {
+            mv gem_file, "../#{gem_file}"
+          }
+        end
+      }
+    end
+
+    file package_dir_path => bones_files do
+      mkdir_p package_dir rescue nil
+      
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+      
+      bones_files.each do |fn|
+        base_fn = File.join('tasks', File.basename(fn))
+        f = File.join(package_dir_path, base_fn)
+        fdir = File.dirname(f)
+        mkdir_p(fdir) if !File.exist?(fdir)
+        if File.directory?(fn)
+          mkdir_p(f)
+        else
+          raise "file name conflict for '#{base_fn}' (conflicts with '#{fn}')" if test(?e, f)
+          safe_ln(fn, f)
+        end
+      end
+    end
+  end
+  
+  def gem_file
+    if @gem_spec.platform == Gem::Platform::RUBY
+      "#{package_name}.gem"
+    else
+      "#{package_name}-#{@gem_spec.platform}.gem"
+    end
+  end
+end  # class GemPackageTask
+end  # module Bones
+
+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
+
+    PROJ.gem.development_dependencies.each do |dep|
+      s.add_development_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
+
+  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+  end
+
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
+  end
+  
+  desc 'Write the gemspec '
+  task :spec => 'gem:prereqs' do
+    File.open("#{PROJ.name}.gemspec", 'w') do |f|
+      f.write PROJ.gem._spec.to_ruby
+    end
+  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 'gem:clobber_package'
+
+# EOF