bbcoder 0.1.0

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rr (1.0.2)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rr
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 John "asceth" Long
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+Features
+--------
+
+* Non-regex based (except for the split)
+* Handles deep nesting of tags
+* Generates good html even from bad input
+* Easy configuration to add new tags
+
+* Tags supported:
+
+p, b, i, u, s, del, ins, ol, ul, li, dl, dt, dd, quote, code, spoiler, url, img
+
+Usage
+--------
+
+    BBCoder.new(text).to_html
+    # or
+    "[p]my string[/p]".bbcode_to_html
+
+Install
+-------
+
+    gem install bbcoder
+
+
+Configuration
+-----------------------
+
+    BBCoder.configure do
+      tag :b, :as => :strong
+
+      tag :ul
+      tag :ol
+      tag :li, :parents => [:ol, :ul]
+
+      tag :img, :match => /^.*(png|bmp|jpg|gif)$/ do
+        %(<a href="#{content}"><img src="#{content}" /></a>)
+      end
+
+      tag :code do
+        <<-EOS
+    <div class="bbcode-code #{meta}">
+      <pre>#{content}</pre>
+    </div>
+        EOS
+      end
+
+      tag :url do
+        if meta.nil? || meta.empty?
+          %(<a href="#{content}">#{content}</a>)
+        else
+          %(<a href="#{meta}">#{content}</a>)
+        end
+      end
+    end
+
+
+Options for #tag
+
+* :as (symbol) -> use this as the html element ([b] becomes strong)
+* :match (regex) -> convert this tag and its content to html only if the content matches the regex
+* :parents ([symbol]) -> ignore this tag if there is no open tag that matches its parents
+
+
+When you pass a block to #tag it is expecting you to return a string.  You have two variables available to your block:
+
+* meta -> Everything after the '=' in the opening tag (with [quote="Legendary"] meta returns '"Legendary"' and with [quote] meta returns nil)
+* content -> Everything between the two tags (with [b]strong arm[/b] content returns 'strong arm')
+
+
+Author
+------
+
+Original author: John "asceth" Long
+
+

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler"
+Bundler.setup
+
+require "rspec"
+require "rspec/core/rake_task"
+
+Rspec::Core::RakeTask.new(:spec)
+
+gemspec = eval(File.read(File.join(Dir.pwd, "bbcoder.gemspec")))
+
+task :build => "#{gemspec.full_name}.gem"
+
+task :test => :spec
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["bbcoder.gemspec"] do
+  system "gem build bbcoder.gemspec"
+  system "gem install bbcoder-#{BBCoder::VERSION}.gem"
+end
+

data/bbcoder.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "bbcoder/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bbcoder"
+  s.version     = BBCoder::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John 'asceth' Long"]
+  s.email       = ["machinist@asceth.com"]
+  s.homepage    = "http://github.com/asceth/bbcoder"
+  s.summary     = "BBCode parser"
+  s.description = "A gem for parsing bbcode that doesn't rely on regular expressions"
+
+  s.rubyforge_project = "bbcoder"
+
+  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'
+  s.add_development_dependency 'rr'
+end
+

data/lib/bbcoder/base.rb

@@ -0,0 +1,39 @@
+class BBCoder
+  attr_reader :raw
+
+  def self.configure(&block)
+    configuration.instance_eval(&block)
+  end
+
+  def self.configuration
+    @configuration ||= BBCoder::Configuration.new
+  end
+
+  def initialize(text)
+    @raw = text.split(/(\[[^\]]+\])/i).select {|string| string.size > 0}
+  end
+
+  def to_html
+    @html ||= parse
+  end
+
+  def parse
+    raw.each do |data|
+      case data
+      when /\[\/([^\]]+)\]/
+        buffer.tags.pop($1.to_sym)
+      when /\[([^\]]+)\]/
+        buffer.tags.push($1)
+      else
+        buffer.push(data)
+      end
+    end
+
+    buffer.join
+  end
+
+  def buffer
+    @buffer ||= BBCoder::Buffer.new
+  end
+end
+

data/lib/bbcoder/buffer.rb

@@ -0,0 +1,30 @@
+class BBCoder
+  class Buffer
+    attr_accessor :_internal, :tags
+
+    def initialize
+      @_internal = {}
+      @tags = BBCoder::BufferTags.new(self)
+    end
+
+    def push(content)
+      _internal[depth] ||= ""
+      _internal[depth] += content
+    end
+
+    def pop(depth_modifier = 0)
+      _internal.delete(depth + depth_modifier)
+    end
+
+    # end of processing, insert any orphaned tags without conversion
+    def join
+      push(tags.join)
+    end
+
+    # delegates to tags
+    def depth
+      tags.size
+    end
+  end
+end
+

data/lib/bbcoder/buffer_tags.rb

@@ -0,0 +1,77 @@
+class BBCoder
+  class BufferTags
+    attr_accessor :buffer, :_internal, :_meta
+
+    def initialize(buffer)
+      @buffer = buffer
+      @_internal = []
+      @_meta = {}
+    end
+
+    def push(tag)
+      tag, meta = if tag.include?("=")
+                    splits = tag.split("=")
+                    [splits.shift.to_sym, splits.join]
+                  else
+                    [tag.to_sym, nil]
+                  end
+
+      if criteria_met?(tag)
+        _internal.push(tag)
+        _meta[size] = meta
+      else
+        buffer.push(BBCoder::Tag.reform(tag, meta))
+      end
+    end
+
+    # logic when popping specific tag
+    def pop(tag)
+      if empty? || !include?(tag)
+        buffer.push("[/#{tag}]")
+      elsif last == tag
+        buffer.push(BBCoder::Tag.to_html(_internal.pop, _meta.delete(size+1), buffer.pop(+1)))
+      elsif include?(tag)
+        # repeats pop(tag) until we reach the last == tag
+        buffer.push(join(+1))
+        pop(tag)
+      end
+    end
+
+    # orphaned open tags are combined
+    def join(limit = nil)
+      limit = size if limit.nil?
+
+      1.upto(limit).to_a.collect do
+        [BBCoder::Tag.reform(_internal.pop, _meta.delete(size+1)), buffer.pop(+1)].join  # +1 depth modifier for the buffer
+      end.reverse.join
+    end
+
+    # delegates to _internal
+    def size
+      _internal.size
+    end
+
+    def empty?
+      _internal.empty?
+    end
+
+    def last
+      _internal.last
+    end
+
+    def include?(tag)
+      _internal.include?(tag)
+    end
+
+    # helper methods
+    def criteria_met?(tag)
+      return false if BBCoder.configuration[tag].nil?
+
+      parent_criteria_met?(BBCoder.configuration[tag].parents)
+    end
+
+    def parent_criteria_met?(parents)
+      parents.empty? || !(_internal & parents).empty?
+    end
+  end
+end

data/lib/bbcoder/configuration.rb

@@ -0,0 +1,20 @@
+class BBCoder
+  class Configuration
+    @@tags = {}
+
+    def [](value)
+      @@tags[value]
+    end
+
+    def tag(name, options = {}, &block)
+      unless block.nil?
+        block.binding.eval <<-EOS
+          def meta; @meta; end
+          def content; @content; end
+        EOS
+      end
+      @@tags[name.to_sym] = BBCoder::Tag.new(name.to_sym, options.merge(:block => block))
+    end
+  end
+end
+

data/lib/bbcoder/string.rb

@@ -0,0 +1,5 @@
+class String
+  def bbcode_to_html
+    BBCoder.new(self.dup).to_html
+  end
+end

data/lib/bbcoder/tag.rb

@@ -0,0 +1,62 @@
+class BBCoder
+  class Tag
+    attr_reader :name, :options
+
+    def initialize(name, options = {})
+      @name = name
+      @options = options.merge(:as => (options[:as] || name))
+    end
+
+    def to_html(meta, content)
+      return self.class.reform(name, meta, content) unless content_valid?(content)
+
+
+      if options[:block].nil?
+        "<#{options[:as]}>#{content}</#{options[:as]}>"
+      else
+        options[:block].binding.eval <<-EOS
+          @meta = "#{meta}"
+          @content = "#{content}"
+        EOS
+        options[:block].call
+      end
+    end
+
+    def content_valid?(content)
+      return true if options[:match].nil?
+
+      return !content.match(options[:match]).nil?
+    end
+
+    def parents
+      options[:parents] || []
+    end
+
+    module ClassMethods
+      def to_html(tag, meta, content)
+        BBCoder.configuration[tag].to_html(meta, content)
+      end
+
+      def reform(tag, meta, content = nil)
+        if content.nil?
+          %(#{reform_open(tag, meta)})
+        else
+          %(#{reform_open(tag, meta)}#{content}#{reform_end(tag)})
+        end
+      end
+
+      def reform_open(tag, meta)
+        if meta.nil? || meta.empty?
+          "[#{tag}]"
+        else
+          "[#{tag}=#{meta}]"
+        end
+      end
+
+      def reform_end(tag)
+        "[/#{tag}]"
+      end
+    end
+    extend ClassMethods
+  end
+end

data/lib/bbcoder/version.rb

@@ -0,0 +1,3 @@
+class BBCoder
+  VERSION = "0.1.0"
+end

data/lib/bbcoder.rb

@@ -0,0 +1,63 @@
+require 'bbcoder/base'
+require 'bbcoder/configuration'
+require 'bbcoder/tag'
+require 'bbcoder/buffer'
+require 'bbcoder/buffer_tags'
+require 'bbcoder/string'
+
+BBCoder.configure do
+  tag :p
+  tag :b, :as => :strong
+  tag :i, :as => :em
+  tag :u
+  tag :s, :as => :strike
+  tag :del
+  tag :ins
+  tag :ol
+  tag :ul
+  tag :li, :parents => [:ol, :ul]
+  tag :dl
+  tag :dt, :parents => [:dl]
+  tag :dd, :parents => [:dl]
+
+  tag :quote do
+    <<-EOS
+<fieldset>
+<legend>#{meta} says</legend>
+  <blockquote>
+    #{content}
+  </blockquote>
+</fieldset>
+    EOS
+  end
+
+  tag :code do
+    <<-EOS
+<div class="bbcode-code #{meta}">
+  <pre>#{content}</pre>
+</div>
+    EOS
+  end
+
+  tag :spoiler do
+    <<-EOS
+<fieldset class="bbcode-spoiler">
+  <legend>Spoiler</legend>
+  <div>#{content}</div>
+</fieldset>
+    EOS
+  end
+
+  tag :url do
+    if meta.nil? || meta.empty?
+      %(<a href="#{content}">#{content}</a>)
+    else
+      %(<a href="#{meta}">#{content}</a>)
+    end
+  end
+
+  tag :img, :match => /^.*(png|bmp|jpg|gif)$/ do
+    %(<a href="#{content}"><img src="#{content}" /></a>)
+  end
+end
+

data/spec/base_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe BBCoder do
+
+  subject { BBCoder.new("[p]Text and now [b]bolded.[/b][/p]") }
+
+  context "#configuration" do
+    it "should return the same object for multiple calls" do
+      BBCoder.configuration.should == BBCoder.configuration
+    end
+  end
+
+  context "#buffer" do
+    it "should return the same object for multiple calls" do
+      subject.buffer.should == subject.buffer
+    end
+  end
+
+  context "#configure" do
+    it "should fail without a block" do
+      lambda { BBCoder.configure }.should raise_error
+    end
+
+    it "should instance_eval the block onto configuration" do
+      block = Proc.new { tag :p }
+      mock(BBCoder).configuration.stub!.instance_eval(&block)
+      BBCoder.configure(&block)
+    end
+  end
+
+  context "#initialize" do
+    it "should split tags up properly" do
+      subject.raw.should == ["[p]", "Text and now ", "[b]", "bolded.", "[/b]", "[/p]"]
+    end
+  end
+
+  context "#parse" do
+    it "should loop through raw elements and join the buffer" do
+      mock(subject).raw.stub!.each {nil}
+      mock(subject).buffer.stub!.join {"output"}
+
+      subject.parse
+    end
+  end
+end
+

data/spec/bbcoder_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe BBCoder do
+
+  context "with properly formatted input" do
+    it "should parse paragraph statements" do
+      "[p]Text and now [p]nested.[/p][/p]".bbcode_to_html.should == "<p>Text and now <p>nested.</p></p>"
+    end
+
+    it "should parse paragraph and bold statements" do
+      "[p]Text and now [b]nested.[/b][/p]".bbcode_to_html.should == "<p>Text and now <strong>nested.</strong></p>"
+    end
+
+    it "should parse a combination of statements" do
+      output = "[p]Text and now [b]bold then [i]italics[/i][/b][/p] and then a [quote]Quote[/quote]".bbcode_to_html
+      output.should == <<-EOS
+<p>Text and now <strong>bold then <em>italics</em></strong></p> and then a <fieldset>
+<legend> says</legend>
+  <blockquote>
+    Quote
+  </blockquote>
+</fieldset>
+EOS
+    end
+
+    it "should handle multiple nestings of b elements" do
+      "[b]Now I [b] am [b] extremely [b] bold![/b][/b][/b][/b]".bbcode_to_html.should == "<strong>Now I <strong> am <strong> extremely <strong> bold!</strong></strong></strong></strong>"
+    end
+  end
+
+  context "with incorrectly formatted input" do
+    it "should ignore non-matched tag content" do
+      "[b][img]http://mybad.com[/img][/b]".bbcode_to_html.should == "<strong>[img]http://mybad.com[/img]</strong>"
+    end
+
+    it "should ignore tags without required parents" do
+      "[b]Strong list item [li]one of many[/li][/b]".bbcode_to_html.should == "<strong>Strong list item [li]one of many[/li]</strong>"
+    end
+
+    it "should ignore un-opened tags" do
+      "[p]Text aint it grand![/p][/p]".bbcode_to_html.should == "<p>Text aint it grand!</p>[/p]"
+    end
+
+    it "should ignore un-closed tags" do
+      "[p]Text aint it grand!".bbcode_to_html.should == "[p]Text aint it grand!"
+    end
+
+    it "should ignore un-closed and un-opened tags" do
+      "[p]Text aint it grand!".bbcode_to_html.should == "[p]Text aint it grand!"
+    end
+
+    it "shouldn't choke on extremely bad input" do
+      "[p]Text and [/b] with a [p] and [quote] a [/p] care in sight oh [i] my [/b].".bbcode_to_html.should == "[p]Text and [/b] with a <p> and [quote] a </p> care in sight oh [i] my [/b]."
+    end
+
+    it "shouldn't choke on extremely bad input with meta weirdness" do
+      "[p]Text and [/b] with a [p] and [quote='Hahah'] a [/p] care in sight oh [i=nometaforyou] my [/b].".bbcode_to_html.should == "[p]Text and [/b] with a <p> and [quote='Hahah'] a </p> care in sight oh [i=nometaforyou] my [/b]."
+    end
+  end
+end
+

data/spec/buffer_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe BBCoder::Buffer do
+
+  context "#push" do
+    it "should append content onto the current depth without increasing depth" do
+      subject.push("content")
+      subject.push(" + more")
+      subject.pop.should == "content + more"
+    end
+  end
+
+  context "#pop" do
+    it "should delete the current depth but not modify the depth" do
+      subject.push("content")
+      subject.pop
+      subject.pop.should == nil
+    end
+  end
+
+  context "#join" do
+    it "should push remaining tags" do
+      mock(subject).tags.stub!.join {"joined"}
+      mock(subject).push(is_a(String))
+
+      subject.join
+    end
+
+    it "should return a string from unopened tags" do
+      subject.tags.push("p")
+      subject.join.should == "[p]"
+    end
+  end
+
+  context "#depth" do
+    it "should delegate to tags" do
+      mock(subject).tags.stub!.size {0}
+      subject.depth.should == 0
+    end
+  end
+end
+

data/spec/buffer_tags_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe BBCoder::BufferTags do
+
+  subject { BBCoder::BufferTags.new(BBCoder::Buffer.new) }
+
+  context "#criteria_met?" do
+    it "should return false when tag does not exist" do
+      subject.criteria_met?(:notatag).should == false
+    end
+
+    it "should return false when open tags does not include parents of tag to be added" do
+      subject.criteria_met?(:li).should == false
+    end
+
+    it "should return true when open tags does include parents of tag to be added" do
+      subject.push("ul")
+      subject.criteria_met?(:li).should == true
+    end
+
+    it "should return false when current open tag does not have any required parents" do
+      subject.criteria_met?(:p).should == true
+    end
+  end
+
+  context "delegation to _internal" do
+    it "#size" do
+      mock(subject)._internal.stub!.size
+      subject.size
+    end
+
+    it "#empty?" do
+      mock(subject)._internal.stub!.empty?
+      subject.empty?
+    end
+    it "#last" do
+      mock(subject)._internal.stub!.last
+      subject.last
+    end
+
+    it "#include?" do
+      mock(subject)._internal.stub!.include?
+      subject.include?(:p)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'rspec'
+require 'bbcoder'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: bbcoder
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- John 'asceth' Long
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-10 00:00:00 -05: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
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A gem for parsing bbcode that doesn't rely on regular expressions
+email: 
+- machinist@asceth.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gemtest
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bbcoder.gemspec
+- lib/bbcoder.rb
+- lib/bbcoder/base.rb
+- lib/bbcoder/buffer.rb
+- lib/bbcoder/buffer_tags.rb
+- lib/bbcoder/configuration.rb
+- lib/bbcoder/string.rb
+- lib/bbcoder/tag.rb
+- lib/bbcoder/version.rb
+- spec/base_spec.rb
+- spec/bbcoder_spec.rb
+- spec/buffer_spec.rb
+- spec/buffer_tags_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/asceth/bbcoder
+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: bbcoder
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: BBCode parser
+test_files: []
+