markabb 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_STORE
+doc/*
+.yardoc/

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in markabb.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/Readme.md

@@ -0,0 +1,4 @@
+# Markabb
+[RDoc](http://rubydoc.info/github/Arcath/Markabb/master/frames) [www](http://markabb.arcath.net)
+
+Provides BBCode for Ruby and Rails

data/lib/markabb/classes/parser.rb

@@ -0,0 +1,50 @@
+module Markabb
+    # Markab parser
+    # Takes a Markabb::Config object and a string as an input
+    class Parser
+        attr_reader :output
+        
+        # Creates the parser object
+        def initialize(config, s)
+            @string = s
+            @config = config
+            @output = @string
+            parse
+        end
+        
+        private
+        
+        def parse
+            disable_html if @config.disable_html
+            add_line_breaks
+            run_tags
+        end
+        
+        def run_tags
+            Markabb::Tags.each do |k, v|
+                if v.is_a? Hash
+                    unless @config["disable_#{k}".to_sym]
+                        v.each do |sk, sv|
+                            apply_tag(sv) unless @config["disable_#{sk}".to_sym]
+                        end
+                    end
+                else
+                    apply_tag(v)
+                end
+            end
+        end
+        
+        def apply_tag(tag)
+            @output = tag.run(@output, @config)
+        end
+        
+        def disable_html
+            @output = @output.gsub("<","&lt;").gsub(">","&gt;")
+        end
+        
+        def add_line_breaks
+            @output = @output.gsub(/\n/, '<br />')
+            @output = @output.gsub(/<br \/>\[(ul|li|ol|tr|td|th)/,'[\1').gsub(/<br \/>\[\/(ul|li|ol|table|tr|td|th)/,'[/\1')
+        end
+    end
+end

data/lib/markabb/classes/tag.rb

@@ -0,0 +1,61 @@
+module Markabb
+    # The hash which markabb stores all the avaliable tags in
+    Tags = {}
+    
+    # Inserts a tag into Markabb::Tags
+    #
+    # Takes 3 inputs:
+    #   name - a symbol which is used as its key
+    #   tag - a Markabb::Tag object
+    #   group - a way to group similar tags so they can all be disabled
+    #
+    # register_tag(:foo, Markabb::Tag, :bar)
+    #
+    # would produce a tags hash of
+    #
+    # {:bar => {:foo => Markabb::Tag}}
+    def self.register_tag(name, tag, group = nil)
+        if group
+            Tags[group] ||= {}
+            Tags[group][name] = tag
+        else
+            Tags[name] = tag
+        end
+    end
+    
+    # Removes a tag from Markabb::Tags
+    # takes the symbol for the key to delete
+    def self.remove_tag(name)
+        Tags.delete(name)
+    end
+    
+    # Used for all tags (passed to register_tag)
+    # Takes a REGEX matcher and a string to replace it with
+    class Tag
+        attr_reader :matcher, :replace
+        
+        # Creates the Markabb::Tag object
+        def initialize(matcher, replace)
+            @matcher = matcher
+            @replace = replace
+        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))
+        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])
+            else
+                return replace
+            end
+        end
+    end
+end

data/lib/markabb/config.rb

@@ -0,0 +1,47 @@
+module Markabb
+    # The config class, inherits from Hash
+    # Borrowed from mina (https://github.com/nadarei/mina)
+    class Config < Hash
+        def initialize
+            super
+            load_default_config
+        end
+        
+        # Allows access to the hash though methods
+        # Provides all getter, setter and query methods for any key in the hash
+        def method_missing(meth, *args, &blk)
+            name = meth.to_s
+            return evaluate(self[meth])  if name.size == 1
+            # Ruby 1.8.7 doesn't let you do string[-1]
+            key, suffix = name[0..-2].to_sym, name[-1..-1]
+            case suffix
+                when '='
+                    self[key] = args.first
+                when '?'
+                    include? key
+                when '!'
+                    raise Error, "Setting :#{key} is not set" unless include?(key)
+                    evaluate self[key]
+                else
+                    evaluate self[meth]
+            end
+        end
+
+        # Returns a value or runs a proc depending on the value in the hash
+        def evaluate(value)
+            if value.is_a?(Proc)
+                value.call
+            else
+                value
+            end
+        end
+        
+        # Sets the default config values
+        def load_default_config
+            self[:disable_html] ||= true
+            self[:url_target] ||= "_BLANK"
+            self[:image_alt] ||= "Posted Image"
+            self[:table_width] ||= "100%"
+        end
+    end
+end

data/lib/markabb/parse.rb

@@ -0,0 +1,29 @@
+module Markabb
+    # Passes the string to an instance of Markabb::Parser
+    #
+    # Can be passed a block to change the config
+    def self.parse(s)
+        # Set the config
+        config = @config
+        if block_given?
+            config = Config.new unless @config
+            yield(config)
+        else
+            raise "Please configure Markabb before using it" unless @config
+        end
+        output = Parser.new(config, s).output
+        if needs_html_safe?
+            return output.html_safe
+        else
+            return output
+        end
+    end
+    
+    def self.needs_html_safe?
+        if defined? Rails
+            return Rails.version =~ /^3\./
+        else
+            return false
+        end
+    end
+end

data/lib/markabb/tags/formatting.rb

@@ -0,0 +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

data/lib/markabb/tags/image.rb

@@ -0,0 +1,2 @@
+Markabb.register_tag :image, Markabb::Tag.new(/\[img\](.*?)\[\/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

@@ -0,0 +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_with_title, Markabb::Tag.new(/\[url=(.*?)\](.*?)\[\/url\]/, '<a href="\1" target="config[:url_target]">\2</a>'), :link

data/lib/markabb/tags/list.rb

@@ -0,0 +1,3 @@
+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

data/lib/markabb/tags/table.rb

@@ -0,0 +1,4 @@
+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_header, Markabb::Tag.new(/\[th\](.*?)\[\/th\]/, '<th>\1</th>'), :table

data/lib/markabb/version.rb

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

data/lib/markabb.rb

@@ -0,0 +1,32 @@
+# Top Level Requires
+require "markabb/config"
+require "markabb/parse"
+require "markabb/version"
+# Clases
+require "markabb/classes/parser"
+require "markabb/classes/tag"
+
+# Main Markabb Module, all code is a sub of this
+module Markabb
+    # Exposes a new config object to a block
+    # Called with:
+    #     Markabb.configure do |c|
+    #         c.foo = 'bar'
+    #     end
+    def self.configure
+        @config = Config.new
+        yield @config
+    end
+    
+    # Exposes the config object for use in your code
+    def self.config
+        @config
+    end
+end
+
+# Tags
+require "markabb/tags/formatting"
+require "markabb/tags/image"
+require "markabb/tags/link"
+require "markabb/tags/list"
+require "markabb/tags/table"

data/markabb.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "markabb/version"
+
+Gem::Specification.new do |s|
+  s.name        = "markabb"
+  s.version     = Markabb::VERSION
+  s.authors     = ["Adam \"Arcath\" Laycock"]
+  s.email       = ["gems@arcath.net"]
+  s.homepage    = "http://markabb.arcath.net"
+  s.summary     = %q{Provides BBCode for Ruby and Rails}
+  s.description = %q{Provides BBCode for Ruby and Rails}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+end

data/spec/macros/formatting_macros.rb

@@ -0,0 +1,25 @@
+module MarkabbMacros
+    module Formatting
+        def self.included(base)
+            base.extend(ClassMethods)
+        end
+        
+        module ClassMethods
+            def it_should_apply_formatting(*formats)
+                formats.each do |format|
+                    it "should apply the #{format[0]} tag to text" do
+                        default_config
+                        Markabb.parse("[#{format[1]}]#{format[0]}[/#{format[1]}]").should eq("<#{format[1]}>#{format[0]}</#{format[1]}>")
+                    end
+
+                    it "should not apply the bold tag to text if it is disbaled" do
+                        default_config
+                        Markabb.parse "[#{format[1]}]#{format[0]}[/#{format[1]}]" do |c|
+                            c["disable_#{format[0]}".to_sym] = true
+                        end.should eq("[#{format[1]}]#{format[0]}[/#{format[1]}]")
+                    end
+                end
+            end
+        end
+    end
+end

data/spec/markabb_parse_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Markabb, "#parse" do
+    it "should take a string" do
+        default_config
+        Markabb.parse "this"
+    end
+    
+    it "should raise a exception if Markabb is not configured" do
+        Markabb.blank_config
+        lambda { Markabb.parse "this" }.should raise_exception
+    end
+    
+    it "should allow for config via a block" do
+        default_config
+        Markabb.parse "this" do |c|
+            c.foo = 'bar'
+        end
+    end
+    
+    it "should allow for no config if using a block" do
+        Markabb.blank_config
+        Markabb.parse "this" do |c|
+            c.foo = 'bar'
+        end
+    end
+    
+    it "should disable html" do
+        default_config
+        Markabb.parse("<b>BOLD</b>").should eq "&lt;b&gt;BOLD&lt;/b&gt;"
+    end
+    
+    it "should allow html if told to" do
+        default_config
+        Markabb.parse "<b>BOLD</b>" do |c|
+            c.disable_html = false
+        end.should eq "<b>BOLD</b>"
+    end
+    
+    it "should add line breaks" do
+        default_config
+        Markabb.parse("this\nthat").should eq "this<br />that"
+    end
+    
+    it "should correct line breaks" do
+        default_config
+        Markabb.parse("this\nthat\n[table]\n[tr][/tr]\n[/table]").should eq "this<br />that<br /><table width=\"100%\"><tr></tr></table>"
+    end
+end

data/spec/markabb_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Markabb do
+    it "should take a block" do
+        Markabb.configure do |c|
+        end
+    end
+    
+    it "should store config" do
+        Markabb.configure do |c|
+            c.foo = 'bar'
+        end
+        
+        Markabb.config.foo.should eq 'bar'
+    end
+end

data/spec/markabb_tags_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Markabb::Tag do
+    it "should have a tags hash" do
+        Markabb::Tags.should be_a Hash
+    end
+    
+    it "should allow tag registration" do
+        Markabb.register_tag :foo, Markabb::Tag.new(/foo/, 'bar')
+        Markabb::Tags[:foo].should be_a Markabb::Tag
+    end
+    
+    it "should allow tag removal" do
+        Markabb.remove_tag :foo
+        Markabb::Tags[:foo].should be_nil
+    end
+    
+    it "should have the bold tag" do
+        Markabb::Tags[:formatting][:bold].should be_a Markabb::Tag
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# Macros
+require "macros/formatting_macros"
+# Require Markabb
+require 'lib/markabb'
+
+module Markabb
+    def self.blank_config
+        @config = nil
+    end
+end
+
+def default_config
+    Markabb.configure do |c|
+    end
+end

data/spec/tags/formatting_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe "Formatting Tags" do
+    include MarkabbMacros::Formatting
+    
+    it_should_apply_formatting ['bold','b'],
+        ['italic','i'],
+        ['underline','u'],
+        ['un_ordered', 'ul'],
+        ['ordered', 'ol'],
+        ['list_item', 'li'],
+        ['center', 'center'],
+        ['left', 'left'],
+        ['right', 'right'],
+        ['heading_1', 'h1'],
+        ['heading_2', 'h2'],
+        ['heading_3', 'h3'],
+        ['heading_4', 'h4']
+        
+    it "should disable all formatting" do
+        Markabb.configure do |c|
+            c.disable_formatting = true
+        end
+        Markabb.parse("[b]Bold[/b]").should eq("[b]Bold[/b]")
+    end
+end

data/spec/tags/image_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe "Image Tags" do
+    it "should apply the image tag" do
+        default_config
+        Markabb.parse("[img]http://www.example.com/img.png[/img]").should eq('<img src="http://www.example.com/img.png" alt="Posted Image" />')
+    end
+    
+    it "should apply the image tag with alt" do
+        default_config
+        Markabb.parse("[img alt=Alt Tag]http://www.example.com/img.png[/img]").should eq('<img src="http://www.example.com/img.png" alt="Alt Tag" />')
+    end
+end

data/spec/tags/link_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe "Link Tags" do
+    it "should parse urls" do
+        default_config
+        Markabb.parse("[url]http://www.example.com[/url]").should eq('<a href="http://www.example.com" target="_BLANK">http://www.example.com</a>')
+    end
+    
+    it "should change the target if asked" do
+        default_config
+        Markabb.parse "[url]http://www.example.com[/url]" do |c|
+            c.url_target = "waffle"
+        end.should eq('<a href="http://www.example.com" target="waffle">http://www.example.com</a>')
+    end
+    
+    it "should change the title when using that tag" do
+        default_config
+        Markabb.parse("[url=http://www.example.com]Example[/url]").should eq('<a href="http://www.example.com" target="_BLANK">Example</a>')
+    end
+end

data/spec/tags/table_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe "Table Tags" do
+    include MarkabbMacros::Formatting
+    
+    it_should_apply_formatting ['table_header', 'th'],
+        ['table_row', 'tr'],
+        ['table_cell', 'td']
+        
+    it "should draw a table with a width" do
+        Markabb.parse("[table]table[/table]").should eq("<table width=\"100%\">table</table>")
+    end
+    
+    it "should alow you to change the width" do
+        Markabb.parse "[table]table[/table]" do |c|
+            c.table_width = "75%"
+        end.should eq("<table width=\"75%\">table</table>")
+    end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: markabb
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Adam "Arcath" Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-24 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"
+  type: :development
+  version_requirements: *id001
+description: Provides BBCode for Ruby and Rails
+email: 
+- gems@arcath.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- Readme.md
+- lib/markabb.rb
+- lib/markabb/classes/parser.rb
+- lib/markabb/classes/tag.rb
+- lib/markabb/config.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/table.rb
+- lib/markabb/version.rb
+- markabb.gemspec
+- spec/macros/formatting_macros.rb
+- spec/markabb_parse_spec.rb
+- spec/markabb_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/table_spec.rb
+has_rdoc: true
+homepage: http://markabb.arcath.net
+licenses: []
+
+post_install_message: 
+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
+signing_key: 
+specification_version: 3
+summary: Provides BBCode for Ruby and Rails
+test_files: 
+- spec/macros/formatting_macros.rb
+- spec/markabb_parse_spec.rb
+- spec/markabb_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/table_spec.rb