markabb 1.0.0 → 1.0.1

data/Readme.md

@@ -9,9 +9,26 @@ To get the latest stable version install the gem by adding
 
 to your Gemfile
 
-## Documentation
+## Usage
 
-See the [Wiki](https://github.com/Arcath/Markabb/wiki) for the documentation.
+Before you can use Markabb you need to configure it. To do this create an intializer (config/intializers in rails) and pass a block to Markabb.configure like this:
+
+    Markabb.configure do |c|
+    end
+
+`c` is an instance of Markabb::Config which is used by Markabb when ever you parse a string. You can pass any config options you want here.
+
+To parse a string simply call `.markabb` on it e.g.
+
+    "[b]foo[/b] [i]bar[/i]".markabb # => <b>foo</b><i>bar</i>
+
+If you need to configure Markabb for a one off parse e.g. if you want to disable links when parsing a forum post etc... to do that pass a block to `Markabb.parse`
+
+    Markabb.parse "[b]foo[/b] [i]bar[/i]" do |c|
+        c.disable_bold = true
+    end # => [b]foo[/b] <i>bar</i>
+
+See the [Wiki](https://github.com/Arcath/Markabb/wiki) for instructions on Markabbs more advanced features like custom tags, callbacks and syntax highlighting.
 
 ## Developing & Testing
 

data/lib/markabb.rb

@@ -14,6 +14,13 @@ require "markabb/classes/syntax_highlighter"
 # Highlighters
 require "markabb/highlighters/coderay"
 require "markabb/highlighters/raw"
+# Tags
+require "markabb/tags/formatting"
+require "markabb/tags/image"
+require "markabb/tags/link"
+require "markabb/tags/list"
+require "markabb/tags/nobbc"
+require "markabb/tags/table"
 
 # Main Markabb Module, all code is a sub of this
 module Markabb
@@ -36,11 +43,3 @@ module Markabb
     module Highlighters
     end
 end
-
-# Tags
-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/lib/markabb/classes/parser.rb

@@ -50,7 +50,7 @@ module Markabb
         end
         
         def disable_html
-            @output = @output.gsub("<","&lt;").gsub(">","&gt;")
+            @output = @output.gsub("<","&lt;").gsub(">","&gt;").gsub(/"/, "&quot;")
         end
         
         def add_line_breaks

data/lib/markabb/tags/list.rb

@@ -13,4 +13,4 @@ list_callback = Markabb::Callback.new(Proc.new { |s|
 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
+Markabb.register_tag :smart_list, Markabb::Tag.new('list', list_callback), :lists

data/lib/markabb/version.rb

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

data/spec/tags/link_spec.rb

@@ -17,4 +17,9 @@ describe "Link Tags" 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
+    
+    it "should prevent javascript injection" do
+      default_config
+      Markabb.parse('[url=" onclick="foo]Injected[/url]').should_not eq "<a href=\"\" onclick=\"foo\" target=\"_BLANK\">Injected</a>"
+    end
 end

metadata

@@ -1,68 +1,71 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: markabb
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Adam "Arcath" Laycock
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-12 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides BBCode for Ruby and Rails
-email: 
+email:
 - gems@arcath.net
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -102,37 +105,31 @@ files:
 - spec/tags/link_spec.rb
 - spec/tags/list_spec.rb
 - spec/tags/table_spec.rb
-has_rdoc: true
 homepage: http://markabb.arcath.net
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Provides BBCode for Ruby and Rails
-test_files: 
+test_files:
 - spec/highlighters/coderay_spec.rb
 - spec/highlighters/raw_spec.rb
 - spec/macros/formatting_macros.rb
@@ -148,3 +145,4 @@ test_files:
 - spec/tags/link_spec.rb
 - spec/tags/list_spec.rb
 - spec/tags/table_spec.rb
+has_rdoc: