markdownizer 0.1.3 → 0.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdownizer (0.1.2)
+    markdownizer (0.2.0)
       activerecord (>= 3.0.3)
       coderay
       rdiscount

data/Readme.md

@@ -26,7 +26,12 @@ whatever.
 In your model, let's say, Post:
 
     class Post < ActiveRecord::Base
-      markdownize! :body # In this case we want to treat :body as markdown
+      markdownize! :body
+      # In this case we want to treat :body as markdown.
+      # You can pass an options hash to the code renderer, such as:
+      #
+      #   markdownize! :body, :line_numbers => :table
+      #
     end
 
 Markdownizer needs an additional field (`:rendered_body`), which you should
@@ -40,7 +45,8 @@ You save your posts with markdown text like this:
       Markdown is awesome!
       ## Some H2 title...
 
-      {% highlight ruby %}
+      {% caption 'This caption will become an h5 and also a property of the enclosing div' %}
+      {% code ruby %}
 
         # All this code will be highlighted properly! :)
         def my_method(*my_args)
@@ -49,7 +55,7 @@ You save your posts with markdown text like this:
           end
         end
 
-      {% endhighlight %}
+      {% endcode %}
     """
 
 And then, in your view you just have to call `@post.rendered_body` :)

data/lib/markdownizer.rb

@@ -90,9 +90,16 @@ module Markdownizer
     # `Markdownizer.coderay` method parses a code block delimited from `{% code
     # ruby %}` until `{% endcode %}` and replaces it with appropriate classes for
     # code highlighting. It can take many languages aside from Ruby.
-    def coderay(text)
-      text.gsub(%r[\{% code (\w+?) %\}(.+?)\{% endcode %\}]m) do
-        CodeRay.scan($2, $1).div(:css => :class)
+    #
+    # It also parses the special idiom {% caption 'my caption' %}, which both
+    # introduces an h5 before the code and passes the caption to the enclosing div
+    # as a parameter.
+    def coderay(text, options = {})
+      text.gsub(%r[\{% caption '([\w\s]+)' %\}]) do
+        options.merge!({:caption => $1}) if $1
+        "#####" << $1
+      end.gsub(%r[\{% code (\w+?) %\}(.+?)\{% endcode %\}]m) do
+        CodeRay.scan($2, $1).div({:css => :class}.merge(options))
       end
     end
   end
@@ -105,7 +112,12 @@ module Markdownizer
 
     # Calling `markdownize! :attribute` (where `:attribute` can be any database
     # attribute with type `text`) will treat this field as Markdown.
-    def markdownize! attribute
+    # You can pass an `options` hash for CodeRay. An example option would be:
+    #   
+    #   * `:line_numbers => :table` (or `:inline`)
+    #
+    # You can check other available options in CodeRay's documentation.
+    def markdownize! attribute, options = {}
       # Check that both `:attribute` and `:rendered_attribute` columns exist.
       # If they don't, it raises an error indicating that the user should generate
       # a migration.
@@ -121,7 +133,7 @@ module Markdownizer
       # Define the converter method, which will assign the rendered html to the
       # `:rendered_attribute` field.
       define_method :"render_#{attribute}" do
-        self.send(:"rendered_#{attribute}=", Markdownizer.markdown(Markdownizer.coderay(self.send(attribute))))
+        self.send(:"rendered_#{attribute}=", Markdownizer.markdown(Markdownizer.coderay(self.send(attribute), options)))
       end
     end
   end

data/lib/markdownizer/version.rb

@@ -1,3 +1,3 @@
 module Markdownizer
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/spec/markdownizer_spec.rb

@@ -24,6 +24,19 @@ describe Markdownizer do
 
     """
     }
+    let(:text_with_caption) { """
+      #My markdown text
+
+      {% caption 'This will become an h5' %}
+      {% code ruby %}
+        def function(*args)
+          puts 'result'
+        end
+      {% endcode %}
+
+    """
+    }
+
     it 'calls CodeRay to parse the code inside {% highlight ruby %} blocks' do
       scanned_code, html_code = double(:scanned_code), double(:html_code)
 
@@ -33,9 +46,19 @@ describe Markdownizer do
         end
       """, 'ruby').and_return scanned_code
 
-      scanned_code.should_receive(:div).with(:css => :class).and_return 'parsed code'
+      scanned_code.should_receive(:div).with(:css => :class, :my => :option).and_return 'parsed code'
+
+      subject.coderay(text, :my => :option).should match('parsed code')
+    end
+    it 'accepts a caption option inside the code' do
+      subject.coderay(text_with_caption).should match('#####This will become an h5')
+    end
+    it 'passes the caption to the div' do
+      parsed = double :parsed
+      CodeRay.should_receive(:scan).and_return parsed
+      parsed.should_receive(:div).with(:css => :class, :caption => 'This will become an h5')
 
-      subject.coderay(text).should match('parsed code')
+      subject.coderay(text_with_caption).should match('#####This will become an h5')
     end
   end
 
@@ -80,7 +103,7 @@ describe Markdownizer do
 
           instance = klass.new
           instance.should_receive(:send).with(:body).and_return raw_body
-          Markdownizer.should_receive(:coderay).with(raw_body).and_return raw_body_with_code
+          Markdownizer.should_receive(:coderay).with(raw_body, {}).and_return raw_body_with_code
           Markdownizer.should_receive(:markdown).with(raw_body_with_code).and_return final_code
 
           instance.should_receive(:send).with(:rendered_body=, final_code)

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Josep M. Bach
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-03 00:00:00 +01:00
+date: 2011-02-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency