nathanhoad-moredown 1.0.0 → 1.0.1

data/README.markdown

@@ -34,10 +34,55 @@ Usage
 -----
 
 Moredown can be used in any way that RDiscount can be (see below). In addition, Moredown
-implements some extra syntax options via a static formatting method:
-
-    require 'nathanhoad-moredown'
-    html = Moredown.text_to_html("Hello World!")
+implements some extras:
+
+ * Static method for simple calls
+
+        require 'nathanhoad-moredown'
+        html = Moredown.text_to_html("Hello World!")
+
+ * Remap relative URLs
+ 
+        Moredown.new(text, :base_url => 'http://nathanhoad.net').to_html
+
+ * Remap headings (eg. h1 becomes h3).
+ 
+        Moredown.new(text, :map_headings => 2)
+
+ * Embed Youtube videos (similar to image syntax)
+ 
+        ![Video](youtube:lfAzVe5H-vE)
+
+ * Convert Youtube videos to their preview images (for RSS, etc)
+ 
+        Moredown.new(text, :youtube_as_images => true)
+ 
+ * Use Flash movies
+ 
+        ![Flash](flash:movieclip.swf)
+
+ * Replace Flash with text (eg. Flash is not available for RSS)
+ 
+        Moredown.new(text, :replace_flash_with => 'Flash is not available')
+
+ * Image alignments (extension to image syntax)
+ 
+        ![Image](/images/test.jpg):left
+        ![Image](/images/test.jpg):right
+        ![Image](/images/test.jpg):center
+
+ * Emoticons
+ 
+        :-)
+        :-P
+        :-D
+        :-(
+        :-@
+        ;-)
+
+ * RDiscount extensions are now passed under `:extensions`
+ 
+        Moredown.new(text, :extensions => [:smart])
 
 RDiscount implements the basic protocol popularized by RedCloth and adopted
 by BlueCloth:

data/lib/moredown.rb

@@ -16,6 +16,9 @@ class Moredown < RDiscount
   # Map headings down a few ranks (eg. :map_headings => 2 would convert h1 to h3)
   attr_accessor :map_headings
   
+  # Replace Flash with text (eg. Flash is unavailable in RSS)
+  attr_accessor :replace_flash_with
+  
   # Create a Moredown Markdown processor. The +text+ argument
   # should be a string containing Markdown text. Additional arguments may be
   # supplied to set various processing options:
@@ -31,6 +34,7 @@ class Moredown < RDiscount
   # * <tt>:emotes</tt> - Process emoticons.
   # * <tt>:base_url</tt> - Map any relative URLs in the text to absolute URLs.
   # * <tt>:map_headings</tt> - Map any headings down a few ranks (eg. h1 => h3).
+  # * <tt>:replace_flash_with</tt> - Replace Flash with text (eg. Flash is unavailable in RSS)
   #
   # NOTE: The <tt>:filter_styles</tt> extension is not yet implemented.
   def initialize text, args = {}    
@@ -39,6 +43,7 @@ class Moredown < RDiscount
     @emotes = args[:emotes]
     @base_url = args[:base_url]
     @map_headings = args[:map_headings] || 0
+    @replace_flash_with = args[:replace_flash_with]
     
     if args[:extensions]
       super(text, args[:extensions])
@@ -48,14 +53,29 @@ class Moredown < RDiscount
   end
   
   def to_html    
-    # Youtube
-    if @youtube_as_images
-      @text.gsub!(/!\[(.*)?\]\(youtube:(.+)?\)/) { |match| "<img src=\"http://img.youtube.com/vi/#{$2}/default.jpg\" alt=\"#{$1}\" />" }
-    else
-      @text.gsub!(/!\[.*?\]\(youtube:(.+)?\)/) { |match| "<object data=\"http://www.youtube.com/v/#{$1}\" type=\"application/x-shockwave-flash\" width=\"425\" height=\"350\"><param name=\"movie\" value=\"http://www.youtube.com/v/#{$1}\" /></object>" }
+    html = super
+    
+    # youtube
+    html.gsub!(/<img src="youtube:(.*)?" alt="(.*)?" \/>/) do |match|
+      if @youtube_as_images
+        "<img src=\"http://img.youtube.com/vi/#{$1}/default.jpg\" alt=\"#{$2}\" />"
+      else
+        flash_tag "http://www.youtube.com/v/#{$1}", :width => 425, :height => 350
+      end
     end
     
-    html = super
+    # flash movies
+    html.gsub!(/<img src="flash:(.*?)"\s?(?:title="(.*?)")? alt="(.*)" \/>/) do |match|
+      if @replace_flash_with
+        @replace_flash_with
+      else      
+        if $2
+          sizes = $2.split(' ')
+          sizes = { :width => sizes[0], :height => sizes[1] }
+        end
+        flash_tag $1, (sizes || {})
+      end
+    end
     
     # image alignments
     if @has_stylesheet
@@ -97,4 +117,11 @@ class Moredown < RDiscount
   def self.text_to_html text, args = {}    
     Moredown.new(text, args).to_html
   end
+  
+  
+  protected
+    def flash_tag url, args = {}
+      args = {:width => 400, :height => 300}.merge args
+      "<object data=\"#{url}\" type=\"application/x-shockwave-flash\" width=\"#{args[:width]}\" height=\"#{args[:height]}\"><param name=\"movie\" value=\"#{url}\" /></object>"
+    end
 end

data/test/moredown_test.rb

@@ -132,5 +132,31 @@ TEXT
     text = "<h1>Heading</h1>\n<h2>Sub-heading</h2>"
     html = "<h3>Heading</h3>\n\n\n<h4>Sub-heading</h4>\n\n"
     assert_equal html, Moredown.text_to_html(text, :map_headings => 2)
+    
+    text = <<TEXT
+Heading
+=======
+
+Sub-heading
+-----------
+TEXT
+    html = "<h3>Heading</h3>\n\n<h4>Sub-heading</h4>\n"
+    assert_equal html, Moredown.text_to_html(text, :map_headings => 2)
+  end
+  
+  def test_flash_movies
+    text = '![Flash](flash:movieclip.swf)'
+    html = "<p><object data=\"movieclip.swf\" type=\"application/x-shockwave-flash\" width=\"400\" height=\"300\"><param name=\"movie\" value=\"movieclip.swf\" /></object></p>\n"
+    assert_equal html, Moredown.text_to_html(text)
+    
+    text = '![Flash](flash:movieclip.swf "800 600")'
+    html = "<p><object data=\"movieclip.swf\" type=\"application/x-shockwave-flash\" width=\"800\" height=\"600\"><param name=\"movie\" value=\"movieclip.swf\" /></object></p>\n"
+    assert_equal html, Moredown.text_to_html(text)
+  end
+  
+  def test_replace_flash_with
+    text = '![Flash](flash:movieclip.swf)'
+    html = "<p>Flash cannot be displayed</p>\n"
+    assert_equal html, Moredown.text_to_html(text, :replace_flash_with => 'Flash cannot be displayed');
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nathanhoad-moredown
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Nathan Hoad
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-22 00:00:00 -07:00
+date: 2009-09-03 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -54,7 +54,6 @@ files:
 - test/rdiscount_test.rb
 has_rdoc: true
 homepage: http://github.com/nathanhoad/moredown
-licenses: 
 post_install_message: 
 rdoc_options: []
 
@@ -75,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Fast Implementation of Gruber's Markdown in C