markabb 0.0.2 → 1.0.0

data/benchmark

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby -wKU
+require 'benchmark'
+$:.push File.expand_path("../lib", __FILE__)
+require 'markabb'
+puts "Benchmarking Markabb"
+
+Markabb.configure do |c|
+end
+
+simple_string = "[b]Bold[/b]"
+multi_format = "[b]bold [i]italic[/i][/b][u]underline[/u]"
+
+Benchmark.bm do |x|
+    x.report("1 string:") { simple_string.markabb }
+    x.report("100 strings:") { 100.times do simple_string.markabb end }
+    x.report("1 multi format:") { multi_format.markabb }
+    x.report("100 multi formats:") { 100.times do multi_format.markabb end }
+    x.report("1000 string parses") { 500.times do multi_format.markabb
+    simple_string.markabb end }
+end

data/lib/markabb/classes/callback.rb

@@ -0,0 +1,13 @@
+module Markabb
+    # Class for callbacks, all callbacks should be an instance of this.
+    class Callback
+        def initialize(proc)
+            @proc = proc
+        end
+        
+        # Passes all the options found in the gsub from the tag (see Markabb::Tag) to the Proc
+        def run(ar)
+            @proc.call *ar 
+        end
+    end
+end

data/lib/markabb/classes/tag.rb

@@ -39,20 +39,40 @@ module Markabb
         
         # Creates the Markabb::Tag object
         def initialize(matcher, replace)
-            @matcher = matcher
-            @replace = replace
+            if matcher.is_a? String
+                @matcher = generate_matcher(matcher)
+            elsif matcher.is_a? Regexp
+                @matcher = matcher
+            else
+                raise 'matcher is not valid'
+            end
+            if replace.is_a? String
+                @replace = replace
+            elsif replace.is_a? Markabb::Callback
+                @replace = false
+                @callback = replace
+            else
+                raise 'Replace is not valid'
+            end
         end
         
         # Runs the tag on the input string
         #
         # Takes the target string and a Markabb::Config object
         def run(s, config)
-            s.gsub(@matcher, generate_replacement(@replace, config))
+            if @replace
+                return s.gsub(@matcher, generate_replacement(@replace, config))
+            elsif @callback
+                return run_callback(s)
+            end
+        end
+        
+        private
+        
+        def run_callback(s)
+            s.gsub(@matcher) { |match| @callback.run(match.scan(@matcher).first) }
         end
         
-        # Generates the replacement string
-        # 
-        # Takes the replacement string and a config object
         def generate_replacement(replace, config)
             if replace.scan(/config\[:(.*?)\]/) != [] then
                 return replace.gsub(/config\[(.*?)\]/, config[$1.to_sym])
@@ -60,5 +80,9 @@ module Markabb
                 return replace
             end
         end
+        
+        def generate_matcher(tag)
+            /\[#{tag}\](.*?)\[\/#{tag}\]/
+        end
     end
 end

data/lib/markabb/config.rb

@@ -43,6 +43,7 @@ module Markabb
             self[:image_alt] ||= "Posted Image"
             self[:table_width] ||= "100%"
             self[:syntax_highlighter] ||= :raw
+            self[:coderay_options] ||= {}
         end
     end
 end

data/lib/markabb/highlighters/coderay.rb

@@ -0,0 +1,17 @@
+module Markabb
+    module Highlighters
+        # Markabb Syntax Highlighter for CodeRay
+        #
+        # See http://http://coderay.rubychan.de/ for CodeRay
+        class Coderay < Markabb::SyntaxHighlighter
+            # Takes the language and string as an option and passes config from Markabb for coderay
+            #
+            # See http://coderay.rubychan.de/ for CodeRays configuration options
+            def parse(lang, s)
+                "[nobbc]" + ::CodeRay.scan(s, lang).div(Markabb.config.coderay_options) + "[/nobbc]"
+            end
+        end
+    end
+end
+
+Markabb.register_highlighter(:coderay, Markabb::Highlighters::Coderay)

data/lib/markabb/tags/formatting.rb

@@ -1,10 +1,10 @@
-Markabb.register_tag :bold, Markabb::Tag.new(/\[b\](.*?)\[\/b\]/, '<b>\1</b>'), :formatting
-Markabb.register_tag :italic, Markabb::Tag.new(/\[i\](.*?)\[\/i\]/, '<i>\1</i>'), :formatting
-Markabb.register_tag :underline, Markabb::Tag.new(/\[u\](.*?)\[\/u\]/, '<u>\1</u>'), :formatting
-Markabb.register_tag :center, Markabb::Tag.new(/\[center\](.*?)\[\/center\]/, '<center>\1</center>'), :formatting
-Markabb.register_tag :left, Markabb::Tag.new(/\[left\](.*?)\[\/left\]/, '<left>\1</left>'), :formatting
-Markabb.register_tag :right, Markabb::Tag.new(/\[right\](.*?)\[\/right\]/, '<right>\1</right>'), :formatting
-Markabb.register_tag :heading_1, Markabb::Tag.new(/\[h1\](.*?)\[\/h1\]/, '<h1>\1</h1>'), :formatting
-Markabb.register_tag :heading_2, Markabb::Tag.new(/\[h2\](.*?)\[\/h2\]/, '<h2>\1</h2>'), :formatting
-Markabb.register_tag :heading_3, Markabb::Tag.new(/\[h3\](.*?)\[\/h3\]/, '<h3>\1</h3>'), :formatting
-Markabb.register_tag :heading_4, Markabb::Tag.new(/\[h4\](.*?)\[\/h4\]/, '<h4>\1</h4>'), :formatting
+Markabb.register_tag :bold, Markabb::Tag.new('b', '<b>\1</b>'), :formatting
+Markabb.register_tag :italic, Markabb::Tag.new('i', '<i>\1</i>'), :formatting
+Markabb.register_tag :underline, Markabb::Tag.new('u', '<u>\1</u>'), :formatting
+Markabb.register_tag :center, Markabb::Tag.new('center', '<center>\1</center>'), :formatting
+Markabb.register_tag :left, Markabb::Tag.new('left', '<left>\1</left>'), :formatting
+Markabb.register_tag :right, Markabb::Tag.new('right', '<right>\1</right>'), :formatting
+Markabb.register_tag :heading_1, Markabb::Tag.new('h1', '<h1>\1</h1>'), :formatting
+Markabb.register_tag :heading_2, Markabb::Tag.new('h2', '<h2>\1</h2>'), :formatting
+Markabb.register_tag :heading_3, Markabb::Tag.new('h3', '<h3>\1</h3>'), :formatting
+Markabb.register_tag :heading_4, Markabb::Tag.new('h4', '<h4>\1</h4>'), :formatting

data/lib/markabb/tags/image.rb

@@ -1,2 +1,2 @@
-Markabb.register_tag :image, Markabb::Tag.new(/\[img\](.*?)\[\/img\]/, '<img src="\1" alt="config[:image_alt]" />'), :image
+Markabb.register_tag :image, Markabb::Tag.new('img', '<img src="\1" alt="config[:image_alt]" />'), :image
 Markabb.register_tag :image_with_alt, Markabb::Tag.new(/\[img alt=(.*?)\](.*?)\[\/img\]/, '<img src="\2" alt="\1" />'), :image

data/lib/markabb/tags/link.rb

@@ -1,2 +1,2 @@
-Markabb.register_tag :url, Markabb::Tag.new(/\[url\](.*?)\[\/url\]/, '<a href="\1" target="config[:url_target]">\1</a>'), :link
+Markabb.register_tag :url, Markabb::Tag.new('url', '<a href="\1" target="config[:url_target]">\1</a>'), :link
 Markabb.register_tag :url_with_title, Markabb::Tag.new(/\[url=(.*?)\](.*?)\[\/url\]/, '<a href="\1" target="config[:url_target]">\2</a>'), :link

data/lib/markabb/tags/list.rb

@@ -1,3 +1,16 @@
-Markabb.register_tag :un_ordered, Markabb::Tag.new(/\[ul\](.*?)\[\/ul\]/, '<ul>\1</ul>'), :list
-Markabb.register_tag :ordered, Markabb::Tag.new(/\[ol\](.*?)\[\/ol\]/, '<ol>\1</ol>'), :list
-Markabb.register_tag :list_item, Markabb::Tag.new(/\[li\](.*?)\[\/li\]/, '<li>\1</li>'), :list
+list_callback = Markabb::Callback.new(Proc.new { |s|
+    if s =~ /\[\*\]/
+        tag = "ul"
+    elsif s =~ /\[#\]/
+        tag = "ol"
+    end
+    
+    items = s.gsub(/\[list\]/, '').gsub(/\[\/list\]/, '').gsub(/\[(\*|#)\](.*?)(\[|<|$)/, '<li>\2</li>\3').gsub(/<\/li><br \/><li>/, '</li><li>')
+    
+    "<#{tag}>#{items}</#{tag}>"
+})
+
+Markabb.register_tag :un_ordered, Markabb::Tag.new('ul', '<ul>\1</ul>'), :lists
+Markabb.register_tag :ordered, Markabb::Tag.new('ol', '<ol>\1</ol>'), :lists
+Markabb.register_tag :list_item, Markabb::Tag.new('li', '<li>\1</li>'), :lists
+Markabb.register_tag :smart_list, Markabb::Tag.new(/\[list\](.*?)\[\/list\]/, list_callback), :lists

data/lib/markabb/tags/table.rb

@@ -1,6 +1,6 @@
-Markabb.register_tag :table, Markabb::Tag.new(/\[table\](.*?)\[\/table\]/, '<table width="config[:table_width]">\1</table>'), :table
-Markabb.register_tag :table_tr, Markabb::Tag.new(/\[tr\](.*?)\[\/tr\]/, '<tr>\1</tr>'), :table
-Markabb.register_tag :table_td, Markabb::Tag.new(/\[td\](.*?)\[\/td\]/, '<td>\1</td>'), :table
-Markabb.register_tag :table_header, Markabb::Tag.new(/\[th\](.*?)\[\/th\]/, '<th>\1</th>'), :table
-Markabb.register_tag :table_row, Markabb::Tag.new(/\[row\](.*?)\[\/row\]/, '<tr>\1</tr>'), :table
-Markabb.register_tag :table_cell, Markabb::Tag.new(/\[cell\](.*?)\[\/cell\]/, '<td>\1</td>'), :table
+Markabb.register_tag :table, Markabb::Tag.new('table', '<table width="config[:table_width]">\1</table>'), :table
+Markabb.register_tag :table_tr, Markabb::Tag.new('tr', '<tr>\1</tr>'), :table
+Markabb.register_tag :table_td, Markabb::Tag.new('td', '<td>\1</td>'), :table
+Markabb.register_tag :table_header, Markabb::Tag.new('th', '<th>\1</th>'), :table
+Markabb.register_tag :table_row, Markabb::Tag.new('row', '<tr>\1</tr>'), :table
+Markabb.register_tag :table_cell, Markabb::Tag.new('cell', '<td>\1</td>'), :table

data/lib/markabb/version.rb

@@ -1,4 +1,4 @@
 module Markabb
     # Markabbs Version Number
-    VERSION = "0.0.2"
+    VERSION = "1.0.0"
 end

data/lib/markabb.rb

@@ -1,13 +1,18 @@
+# Gems
+require 'rubygems'
+require 'coderay'
 # Top Level Requires
 require "markabb/config"
 require "markabb/parse"
 require "markabb/version"
 # Clases
+require "markabb/classes/callback"
 require "markabb/classes/parser"
 require "markabb/classes/tag"
 require "markabb/classes/string"
 require "markabb/classes/syntax_highlighter"
 # Highlighters
+require "markabb/highlighters/coderay"
 require "markabb/highlighters/raw"
 
 # Main Markabb Module, all code is a sub of this

data/markabb.gemspec

@@ -17,4 +17,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec"
+  s.add_development_dependency "yard"
+  
+  s.add_runtime_dependency "coderay"
 end

data/spec/highlighters/coderay_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Markabb::Highlighters::Coderay do
+    it "should be selectable" do
+        default_config
+        Markabb.config.syntax_highlighter = :coderay
+        "[code lang=ruby]:foo => 'bar'[/code]".markabb
+    end
+    
+    it "should allow you configure coderay" do
+        default_config
+        Markabb.config.syntax_highlighter = :coderay
+        Markabb.config.coderay_options = {:line_numbers => :inline}
+        "[code lang=ruby]:foo => 'bar'[/code]".markabb.should =~ /"#n1"/
+    end
+end

data/spec/highlighters/raw_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 
 describe Markabb::Highlighters::Raw do
     it "should be able to parse a code tag" do
+        default_config
         "[code lang=ruby]def foo(bar)
         return bar
         end[/code]".markabb.should eq "<code>def foo(bar)<br />        return bar<br />        end</code>"

data/spec/markabb_callback_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Markabb::Callback do
+    it "should take a proc" do
+        cb = Markabb::Callback.new(Proc.new { })
+    end
+    
+    it "should take an argument and pass it to the proc" do
+        sample_callback.run("this").should eq "THIS"
+    end
+    
+    it "should allow callbacks to be called from Markabb::Tag" do
+        Markabb.register_tag :upcase, Markabb::Tag.new('up', sample_callback)
+        "[up]this[/up]".markabb.should eq "THIS"
+        Markabb.remove_tag :upcase
+    end
+    
+    it "should only parse the contents of the tag" do
+        Markabb.register_tag :upcase, Markabb::Tag.new('up', sample_callback)
+        "[up]this[/up] that [up]foo[/up]".markabb.should eq "THIS that FOO"
+        Markabb.remove_tag :upcase
+    end
+    
+    it "should work with multi input procs" do
+        callback = Markabb::Callback.new(Proc.new { |foo, bar|
+            "Foo: #{foo}, Bar: #{bar}"
+        })
+        Markabb.register_tag :foobar, Markabb::Tag.new(/\[foo=(.*?)\](.*?)\[\/foo\]/, callback)
+        "[foo=this]that[/foo]".markabb.should eq "Foo: this, Bar: that"
+        Markabb.remove_tag :foobar
+    end
+end

data/spec/markabb_tags_spec.rb

@@ -6,7 +6,7 @@ describe Markabb::Tag do
     end
     
     it "should allow tag registration" do
-        Markabb.register_tag :foo, Markabb::Tag.new(/foo/, 'bar')
+        Markabb.register_tag :foo, Markabb::Tag.new(/foo/, 'foo')
         Markabb::Tags[:foo].should be_a Markabb::Tag
     end
     
@@ -31,4 +31,18 @@ describe Markabb::Tag do
         default_config
         "blah [nobbc][b]bold[/b][/nobbc] blah".markabb.should eq "blah [b&#93bold[/b&#93 blah"
     end
+    
+    it "should support simple tag creators" do
+        tag = Markabb::Tag.new('bi', '<b><i>\1</i></b>')
+    end
+    
+    it "should have a working simple tag" do
+        default_config
+        tag = Markabb::Tag.new('bi', '<b><i>\1</i></b>')
+        tag.run("[bi]test[/bi]", Markabb.config).should eq "<b><i>test</i></b>"
+    end
+    
+    it "should raise an exception if a bad matcher is given" do
+        lambda { Markabb::Tag.new(7, '<b><i>\1</i></b>') }.should raise_exception
+    end
 end

data/spec/spec_helper.rb

@@ -15,5 +15,17 @@ def default_config
 end
 
 def sample_tag
-    Markabb.register_tag :test, Markabb::Tag.new(/foo/, 'bar'), :group
+    Markabb.register_tag :test, Markabb::Tag.new(/123/, '456'), :group
+end
+
+def sample_proc
+    Proc.new { |s| upcase(s) }
+end
+
+def sample_callback
+    Markabb::Callback.new(sample_proc)
+end
+
+def upcase(s)
+    s.upcase
 end

data/spec/tags/list_spec.rb

@@ -6,4 +6,12 @@ describe "List Tags" do
     it_should_apply_formatting ['un_ordered', 'ul'],
         ['ordered', 'ol'],
         ['list_item', 'li']
+    
+    it "should use ul with smart list *" do
+        "[list][*]foo\n[*]bar[/list]".markabb.should eq "<ul><li>foo</li><li>bar</li></ul>"
+    end
+    
+    it "should use ol with smart list #" do
+        "[list][#]foo\n[/list]".markabb.should eq "<ol><li>foo</li></ol>"
+    end
 end

metadata

@@ -3,10 +3,10 @@ name: markabb
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors: 
 - Adam "Arcath" Laycock
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-06 00:00:00 +01:00
+date: 2012-07-12 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -29,6 +29,30 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: coderay
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 description: Provides BBCode for Ruby and Rails
 email: 
 - gems@arcath.net
@@ -44,12 +68,15 @@ files:
 - Gemfile
 - Rakefile
 - Readme.md
+- benchmark
 - lib/markabb.rb
+- lib/markabb/classes/callback.rb
 - lib/markabb/classes/parser.rb
 - lib/markabb/classes/string.rb
 - lib/markabb/classes/syntax_highlighter.rb
 - lib/markabb/classes/tag.rb
 - lib/markabb/config.rb
+- lib/markabb/highlighters/coderay.rb
 - lib/markabb/highlighters/raw.rb
 - lib/markabb/parse.rb
 - lib/markabb/tags/formatting.rb
@@ -60,8 +87,10 @@ files:
 - lib/markabb/tags/table.rb
 - lib/markabb/version.rb
 - markabb.gemspec
+- spec/highlighters/coderay_spec.rb
 - spec/highlighters/raw_spec.rb
 - spec/macros/formatting_macros.rb
+- spec/markabb_callback_spec.rb
 - spec/markabb_parse_spec.rb
 - spec/markabb_spec.rb
 - spec/markabb_string_spec.rb
@@ -104,8 +133,10 @@ signing_key:
 specification_version: 3
 summary: Provides BBCode for Ruby and Rails
 test_files: 
+- spec/highlighters/coderay_spec.rb
 - spec/highlighters/raw_spec.rb
 - spec/macros/formatting_macros.rb
+- spec/markabb_callback_spec.rb
 - spec/markabb_parse_spec.rb
 - spec/markabb_spec.rb
 - spec/markabb_string_spec.rb