acts_as_markup 1.1.0 → 1.1.1

data/README.rdoc

@@ -118,3 +118,28 @@ Add "+acts_as_markup+" to your environment.rb:
 
     config.gem "acts_as_markup"
 
+== CONTRIBUTING:
+
+Make a fork on GitHub, make your changes and do a pull request. Good places to start are adding new Markdown libraries or new markup languages, here's instructions for both:
+
+=== Instructions for how to add a new Markdown Library:
+
+1. Add another item to the <tt>ActsAsMarkup::MARKDOWN_LIBS</tt> hash in the form of:
+       :bluecloth => {:class_name => "BlueCloth",
+                      :lib_name   => "bluecloth"}
+   <tt>:lib_name</tt> should be the name needed to require the library, while <tt>:class_name</tt> should be the class that we are making an instance of.
+2. If you need to modify the object in anyway (e.g. to add a <tt>to_s</tt> or <tt>to_html</tt> method), add a file to the "lib/acts_as_markup/exts/" directory.
+3. Add appropriate tests (see current tests).
+
+=== Instructions for how to add a new Markup Language:
+
+1. Add a "<tt>when</tt>" statement to the "<tt>case</tt>" statement in <tt>acts_as_markup</tt>. The "<tt>when</tt>" statement should match with a symbol that represents the language name in some way (e.g. "<tt>:markdown</tt>").
+2. In the "<tt>when</tt>" block you need to set the "<tt>klass</tt>" local variable and require the library and the extension file if you need one (use the special <tt>require_extensions</tt> method to require extensions).
+3. Add the same lines you added to the previous "<tt>when</tt>" statement to the "<tt>:variable</tt>" "<tt>when</tt>" statement. But replace "<tt>klass</tt>" with "<tt>language_klass</tt>" (e.g. "<tt>markdown_klass</tt>").
+4. Add a relevant "<tt>when</tt>" statement to the <tt>class_eval</tt> block for the "<tt>:variable</tt>" language option. This should look something like:
+       when /markdown/i
+         @#{col.to_s} = #{markdown_klass}.new(self['#{col.to_s}'].to_s)
+5. Add a convenience method (e.g. "<tt>acts_as_markdown</tt>")
+6. Add an extension file to the "lib/acts_as_markup/exts/" directory if you need to modify the object in anyway.
+7. Add appropriate tests (see current tests).
+

data/acts_as_markup.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name = %q{acts_as_markup}
-  s.version = "1.1.0"
+  s.version = "1.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Landau"]
-  s.date = %q{2008-08-12}
+  s.date = %q{2008-08-14}
   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 = ["CHANGELOG", "LICENSE", "README.rdoc"]

data/lib/acts/as_markup.rb

@@ -159,7 +159,7 @@ module ActiveRecord # :nodoc:
           end
           
           def require_extensions(library)# :nodoc:
-            if %w(rdiscount maruku wikitext rdoc).include? library.to_s
+            if ActsAsMarkup::LIBRARY_EXTENSIONS.include? library.to_s
               require "acts_as_markup/exts/#{library.to_s}"
             end
           end

data/lib/acts_as_markup.rb

@@ -2,7 +2,7 @@ require 'active_support'
 
 module ActsAsMarkup
   # :stopdoc:
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:
@@ -25,6 +25,8 @@ module ActsAsMarkup
                                    :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_MAKRDOWN_LIB
   mattr_accessor :markdown_library

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_markup
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - Brian Landau
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-12 00:00:00 -04:00
+date: 2008-08-14 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency