markabb 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+ - 1.8.7
+ - 1.9.3
+ - rbx-18mode
+ - rbx-19mode
+ - ruby-head
+env:
+ - "rake=0.8"
+script: "bundle exec rspec"
+matrix:
+  allow_failures:
+    - rvm: rbx-18mode
+    - rvm: rbx-19mode
+notifications:
+  email: false

data/Rakefile

@@ -1 +1,2 @@
-require "bundler/gem_tasks"
+require 'rubygems'
+require 'bundler/gem_tasks'

data/Readme.md

@@ -1,4 +1,20 @@
 # Markabb
-[RDoc](http://rubydoc.info/github/Arcath/Markabb/master/frames) [www](http://markabb.arcath.net)
+[RDoc](http://rubydoc.info/github/Arcath/Markabb/master/frames) | [www](http://markabb.arcath.net) | [Gempage](http://rubygems.org/gems/markabb) | [![Status](https://secure.travis-ci.org/Arcath/Markabb.png?branch=master)](http://travis-ci.org/Arcath/Markabb)
 
-Provides BBCode for Ruby and Rails
+Markabb is an all ruby BBCode parser which can be fully configured and extended.
+
+To get the latest stable version install the gem by adding 
+
+    gem 'markabb'
+
+to your Gemfile
+
+## Documentation
+
+See the [Wiki](https://github.com/Arcath/Markabb/wiki) for the documentation.
+
+## Developing & Testing
+
+Makrabb uses RSpec for its tests, to run them just run `rspec` in the root directory.
+
+Please make sure that the tests pass before you submit a pull request and if you add any new features please add the tests for them.

data/lib/markabb/classes/parser.rb

@@ -17,9 +17,20 @@ module Markabb
         def parse
             disable_html if @config.disable_html
             add_line_breaks
+            highlight_syntax
+            no_bbc_tag
             run_tags
         end
         
+        def highlight_syntax
+            highlighter = SyntaxHighlighters[@config.syntax_highlighter].new(@config)
+            @output = highlighter.run(@output)
+        end
+        
+        def no_bbc_tag
+            apply_tag(Markabb::NobbcTag.new) unless @config[:disable_nobbc]
+        end
+        
         def run_tags
             Markabb::Tags.each do |k, v|
                 if v.is_a? Hash

data/lib/markabb/classes/string.rb

@@ -0,0 +1,9 @@
+# Ruby String object, used to add .markabb
+class String
+    
+    # Runs Markabb parser for the string
+    def markabb
+        Markabb.parse self do
+        end
+    end
+end

data/lib/markabb/classes/syntax_highlighter.rb

@@ -0,0 +1,34 @@
+module Markabb
+    # The hash which markabb stores all available syntax highlighters in
+    SyntaxHighlighters = {}
+    
+    # Adds a syntac highlighter to the hash
+    def self.register_highlighter(name, highlighter)
+        SyntaxHighlighters[name] = highlighter
+    end
+    
+    # Removes a syntax highlighter from the hash
+    def self.remove_highlighter(name)
+        SyntaxHighlighters.delete(name)
+    end
+    
+    # Super class for syntax highlighters
+    #
+    # All syntax highlighters need to inherit from this class
+    class SyntaxHighlighter
+        def initialize(config)
+            @config = config
+        end
+        
+        # Runs the syntax highlighter
+        #
+        # Finds all instances of the code tag and passes it to the parse function
+        def run(s)
+            out = s
+            out.scan(/\[code lang=(.+?)\](.+?)\[\/code\]/m).each do |lang, parse|
+                out = out.gsub("[code lang=#{lang}]#{parse}[/code]", parse(lang, parse))
+            end
+            return out
+        end
+    end
+end

data/lib/markabb/classes/tag.rb

@@ -15,7 +15,9 @@ module Markabb
     #
     # {:bar => {:foo => Markabb::Tag}}
     def self.register_tag(name, tag, group = nil)
+        tag.name = name
         if group
+            tag.group = group
             Tags[group] ||= {}
             Tags[group][name] = tag
         else
@@ -33,6 +35,7 @@ module Markabb
     # Takes a REGEX matcher and a string to replace it with
     class Tag
         attr_reader :matcher, :replace
+        attr_accessor :name, :group
         
         # Creates the Markabb::Tag object
         def initialize(matcher, replace)

data/lib/markabb/config.rb

@@ -1,6 +1,6 @@
 module Markabb
     # The config class, inherits from Hash
-    # Borrowed from mina (https://github.com/nadarei/mina)
+    # Based on the config class from mina (https://github.com/nadarei/mina)
     class Config < Hash
         def initialize
             super
@@ -42,6 +42,7 @@ module Markabb
             self[:url_target] ||= "_BLANK"
             self[:image_alt] ||= "Posted Image"
             self[:table_width] ||= "100%"
+            self[:syntax_highlighter] ||= :raw
         end
     end
 end

data/lib/markabb/highlighters/raw.rb

@@ -0,0 +1,27 @@
+module Markabb
+    module Highlighters
+        # Raw syntax highlighter
+        #
+        # Just wraps the code in a specified tag.
+        class Raw < Markabb::SyntaxHighlighter
+            # Parses the inputted text, takes 2 options, the language of the code and the code.
+            def parse(lang, s)
+               return "<#{open_tag}>[nobbc]#{s}[/nobbc]</#{close_tag}>" 
+            end
+            
+            private
+            
+            def open_tag
+                tag = (@config.raw_highlighter_tag || "code")
+                return tag + " #{@config.raw_highlighter_tag_options}" if @config.raw_highlighter_tag_options
+                return tag
+            end
+            
+            def close_tag
+                (@config.raw_highlighter_tag || "code")
+            end
+        end
+    end
+end
+
+Markabb.register_highlighter(:raw, Markabb::Highlighters::Raw)

data/lib/markabb/tags/nobbc.rb

@@ -0,0 +1,15 @@
+module Markabb
+    # NoBBC Tag class, can't use the Markabb::Tag class as this one needs special parsing
+    class NobbcTag
+        attr_accessor :name, :group
+        
+        # Runs the NoBBC Tag
+        #
+        # The same as Markabb::Tag.parse
+        def run(s, config)
+            s.gsub(/\[nobbc\](.*?)\[\/nobbc\]/) { |b| b.gsub(/\[nobbc\]/,'').gsub(/\[\/nobbc\]/,'').gsub("[","[").gsub("]","&#93") }
+        end
+    end
+end
+
+# Markabb.register_tag :nobbc, Markabb::NobbcTag.new

data/lib/markabb/tags/table.rb

@@ -1,4 +1,6 @@
 Markabb.register_tag :table, Markabb::Tag.new(/\[table\](.*?)\[\/table\]/, '<table width="config[:table_width]">\1</table>'), :table
-Markabb.register_tag :table_row, Markabb::Tag.new(/\[tr\](.*?)\[\/tr\]/, '<tr>\1</tr>'), :table
-Markabb.register_tag :table_cell, Markabb::Tag.new(/\[td\](.*?)\[\/td\]/, '<td>\1</td>'), :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

data/lib/markabb/version.rb

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

data/lib/markabb.rb

@@ -5,6 +5,10 @@ require "markabb/version"
 # Clases
 require "markabb/classes/parser"
 require "markabb/classes/tag"
+require "markabb/classes/string"
+require "markabb/classes/syntax_highlighter"
+# Highlighters
+require "markabb/highlighters/raw"
 
 # Main Markabb Module, all code is a sub of this
 module Markabb
@@ -22,6 +26,10 @@ module Markabb
     def self.config
         @config
     end
+    
+    # Contains all stock provided syntax highlighters
+    module Highlighters
+    end
 end
 
 # Tags
@@ -29,4 +37,5 @@ require "markabb/tags/formatting"
 require "markabb/tags/image"
 require "markabb/tags/link"
 require "markabb/tags/list"
+require "markabb/tags/nobbc"
 require "markabb/tags/table"

data/spec/highlighters/raw_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Markabb::Highlighters::Raw do
+    it "should be able to parse a code tag" do
+        "[code lang=ruby]def foo(bar)
+        return bar
+        end[/code]".markabb.should eq "<code>def foo(bar)<br />        return bar<br />        end</code>"
+    end
+    
+    it "should let you change the wrapping tag" do
+        Markabb.configure do |c|
+            c.raw_highlighter_tag = "div"
+        end
+        "[code lang=ruby]def foo(bar)
+        return bar
+        end[/code]".markabb.should eq "<div>def foo(bar)<br />        return bar<br />        end</div>"
+    end
+    
+    it "should let you change html options of the tag" do
+        Markabb.configure do |c|
+            c.raw_highlighter_tag = "div"
+            c.raw_highlighter_tag_options = "class=\"well\""
+        end
+        "[code lang=ruby]def foo(bar)
+        return bar
+        end[/code]".markabb.should eq "<div class=\"well\">def foo(bar)<br />        return bar<br />        end</div>"
+    end
+    
+    it "should be able to parse 2 code tags" do
+        default_config
+        "[code lang=ruby]def foo(bar)
+        return bar
+        end[/code] foo bar foo
+        [code lang=ruby]:foo => :bar[/code]".markabb.should eq "<code>def foo(bar)<br />        return bar<br />        end</code> foo bar foo<br />        <code>:foo =&gt; :bar</code>"
+    end
+end

data/spec/markabb_string_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe String do
+    it "should run markabb with the default config for #markabb" do
+        Markabb.blank_config
+        "[b]this[/b]".markabb.should eq "<b>this</b>"
+    end
+    
+    it "should inherit from main config" do
+        default_config
+        Markabb.configure do |c|
+            c.disable_bold = true
+        end
+        "[b]this[/b]".markabb.should eq "[b]this[/b]"
+    end
+end

data/spec/markabb_syntax_highlighter_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe "Syntax Highlighters" do
+    it "should have the SytaxHighlighters hash" do
+        Markabb::SyntaxHighlighters.should be_a Hash
+    end
+    
+    it "should allow for highlighter registration" do
+        Markabb.register_highlighter(:foo, Markabb::SyntaxHighlighter.new(Markabb.config))
+        Markabb::SyntaxHighlighters[:foo].should be_a Markabb::SyntaxHighlighter
+    end
+    
+    it "should allow for highlighter deletion" do
+        Markabb.remove_highlighter(:foo)
+    end
+    
+    it "should have a run action" do
+        syntax_highlighter = Markabb::SyntaxHighlighter.new(Markabb.config)
+        syntax_highlighter.run("foo")
+    end
+end

data/spec/markabb_tags_spec.rb

@@ -18,4 +18,17 @@ describe Markabb::Tag do
     it "should have the bold tag" do
         Markabb::Tags[:formatting][:bold].should be_a Markabb::Tag
     end
+    
+    it "should have a name" do
+        sample_tag.name.should be_a Symbol
+    end
+    
+    it "should have a group" do
+        sample_tag.group.should be_a Symbol
+    end
+    
+    it "should have the nobbc tag" do
+        default_config
+        "blah [nobbc][b]bold[/b][/nobbc] blah".markabb.should eq "blah [b&#93bold[/b&#93 blah"
+    end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 # Macros
 require "macros/formatting_macros"
 # Require Markabb
-require 'lib/markabb'
+require 'markabb'
 
 module Markabb
     def self.blank_config
@@ -12,4 +12,8 @@ end
 def default_config
     Markabb.configure do |c|
     end
+end
+
+def sample_tag
+    Markabb.register_tag :test, Markabb::Tag.new(/foo/, 'bar'), :group
 end

data/spec/tags/formatting_spec.rb

@@ -6,9 +6,6 @@ describe "Formatting Tags" do
     it_should_apply_formatting ['bold','b'],
         ['italic','i'],
         ['underline','u'],
-        ['un_ordered', 'ul'],
-        ['ordered', 'ol'],
-        ['list_item', 'li'],
         ['center', 'center'],
         ['left', 'left'],
         ['right', 'right'],

data/spec/tags/list_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe "List Tags" do
+    include MarkabbMacros::Formatting
+    
+    it_should_apply_formatting ['un_ordered', 'ul'],
+        ['ordered', 'ol'],
+        ['list_item', 'li']
+end

data/spec/tags/table_spec.rb

@@ -4,8 +4,8 @@ describe "Table Tags" do
     include MarkabbMacros::Formatting
     
     it_should_apply_formatting ['table_header', 'th'],
-        ['table_row', 'tr'],
-        ['table_cell', 'td']
+        ['table_tr', 'tr'],
+        ['table_td', 'td']
         
     it "should draw a table with a width" do
         Markabb.parse("[table]table[/table]").should eq("<table width=\"100%\">table</table>")
@@ -16,4 +16,12 @@ describe "Table Tags" do
             c.table_width = "75%"
         end.should eq("<table width=\"75%\">table</table>")
     end
+    
+    it "should work for [row]" do
+        "[row]..[/row]".markabb.should eq "<tr>..</tr>"
+    end
+    
+    it "should work for [cell]" do
+        "[cell]..[/cell]".markabb.should eq "<td>..</td>"
+    end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: markabb
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Adam "Arcath" Laycock
@@ -15,18 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-24 00:00:00 +01:00
+date: 2012-07-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -43,29 +40,38 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - Rakefile
 - Readme.md
 - lib/markabb.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/raw.rb
 - lib/markabb/parse.rb
 - lib/markabb/tags/formatting.rb
 - lib/markabb/tags/image.rb
 - lib/markabb/tags/link.rb
 - lib/markabb/tags/list.rb
+- lib/markabb/tags/nobbc.rb
 - lib/markabb/tags/table.rb
 - lib/markabb/version.rb
 - markabb.gemspec
+- spec/highlighters/raw_spec.rb
 - spec/macros/formatting_macros.rb
 - spec/markabb_parse_spec.rb
 - spec/markabb_spec.rb
+- spec/markabb_string_spec.rb
+- spec/markabb_syntax_highlighter_spec.rb
 - spec/markabb_tags_spec.rb
 - spec/spec_helper.rb
 - spec/tags/formatting_spec.rb
 - spec/tags/image_spec.rb
 - spec/tags/link_spec.rb
+- spec/tags/list_spec.rb
 - spec/tags/table_spec.rb
 has_rdoc: true
 homepage: http://markabb.arcath.net
@@ -77,37 +83,37 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Provides BBCode for Ruby and Rails
 test_files: 
+- spec/highlighters/raw_spec.rb
 - spec/macros/formatting_macros.rb
 - spec/markabb_parse_spec.rb
 - spec/markabb_spec.rb
+- spec/markabb_string_spec.rb
+- spec/markabb_syntax_highlighter_spec.rb
 - spec/markabb_tags_spec.rb
 - spec/spec_helper.rb
 - spec/tags/formatting_spec.rb
 - spec/tags/image_spec.rb
 - spec/tags/link_spec.rb
+- spec/tags/list_spec.rb
 - spec/tags/table_spec.rb