bbcoder 0.1.5 → 0.1.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bbcoder (0.1.3)
+    bbcoder (0.1.6)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -6,9 +6,9 @@ Features
 * Generates good html even from bad input
 * Easy configuration to add new tags
 
-* Tags supported:
+* Tags supported by default:
 
-p, b, i, u, s, del, ins, ol, ul, li, dl, dt, dd, quote, code, spoiler, url, img
+p, b, i, u, s, del, ins, ol, ul, li, dl, dt, dd, quote, code, spoiler, url, img, youtube, sub, sup
 
 Usage
 --------
@@ -23,12 +23,20 @@ Install
     gem install bbcoder
 
 
-Configuration
+Configuration Examples
 -----------------------
 
     BBCoder.configure do
       tag :b, :as => :strong
 
+      tag :sub, :singular => true do
+        %(<sub>#{singular? ? meta : content}</sub>)
+      end
+
+      tag :sup, :singular => true do
+        %(<sup>#{singular? ? meta : content}</sup>)
+      end
+
       tag :ul
       tag :ol
       tag :li, :parents => [:ol, :ul]
@@ -60,12 +68,14 @@ 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
+* :singular (true|false) -> use this if the tag does not require an ending tag
 
 
 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')
+* singular? -> Tells you if this tag is being parsed in singular form or if it had an ending tag (affects if content has any data)
 
 
 Author

data/lib/bbcoder/base.rb

@@ -21,11 +21,11 @@ class BBCoder
     raw.each do |data|
       case data
       when /\[\/([^\]]+)\]/
-        buffer.tags.pop($1)
+        buffer.tags.pop($1) # popping end tag
       when /\[([^\]]+)\]/
-        buffer.tags.push($1)
+        buffer.tags.push($1) # pushing start tag
       else
-        buffer.push(data)
+        buffer.push(data) # content
       end
     end
 

data/lib/bbcoder/buffer_tags.rb

@@ -27,6 +27,8 @@ class BBCoder
     # logic when popping specific tag
     def pop(tag)
       tag = tag.downcase.to_sym
+
+      # no more tags left to pop || this tag isn't in the list
       if empty? || !include?(tag)
         buffer.push("[/#{tag}]")
       elsif last == tag
@@ -43,7 +45,8 @@ class BBCoder
       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
+        # singular tags are caught in the handle method
+        [BBCoder::Tag.handle(_internal.pop, _meta.delete(size+1)), buffer.pop(+1)].join  # +1 depth modifier for the buffer
       end.reverse.join
     end
 

data/lib/bbcoder/configuration.rb

@@ -11,6 +11,7 @@ class BBCoder
         block.binding.eval <<-EOS
           def meta; @meta; end
           def content; @content; end
+          def singular?; @singularity; end
         EOS
       end
       @@tags[name.to_sym] = BBCoder::Tag.new(name.to_sym, options.merge(:block => block))

data/lib/bbcoder/tag.rb

@@ -4,25 +4,26 @@ class BBCoder
 
     def initialize(name, options = {})
       @name = name
-      @options = options.merge(:as => (options[:as] || name))
+      @options = options.merge(:as => (options[:as] || name), :singular => (options[:singular] || false))
     end
 
-    def to_html(meta, content)
+    def to_html(meta, content, singularity = false)
       return self.class.reform(name, meta, content, true) unless content_valid?(content)
 
-
       if options[:block].nil?
         "<#{options[:as]}>#{content}</#{options[:as]}>"
       else
         options[:block].binding.eval <<-EOS
           @meta = %Q{#{Regexp.escape(meta.to_s)}}
           @content = %Q{#{Regexp.escape(content.to_s)}}
+          @singularity = #{singularity.to_s}
         EOS
         options[:block].call
       end
     end
 
     def content_valid?(content)
+      return true if content.nil? && options[:singular]
       return false if content.nil?
       return true if options[:match].nil?
 
@@ -33,9 +34,23 @@ class BBCoder
       options[:parents] || []
     end
 
+    def singular?
+      options[:singular]
+    end
+
     module ClassMethods
-      def to_html(tag, meta, content)
-        BBCoder.configuration[tag].to_html(meta, content)
+      def to_html(tag, meta, content, singularity = false)
+        BBCoder.configuration[tag].to_html(meta, content, singularity)
+      end
+
+      # need #handle so we don't get into a reform loop from to_html
+      # checking content validity
+      def handle(tag, meta, content = nil, force_end = false)
+        if BBCoder.configuration[tag] && BBCoder.configuration[tag].singular?
+          to_html(tag, meta, content, true)
+        else
+          reform(tag, meta, content, force_end)
+        end
       end
 
       def reform(tag, meta, content = nil, force_end = false)

data/lib/bbcoder/version.rb

@@ -1,3 +1,3 @@
 class BBCoder
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/bbcoder.rb

@@ -65,5 +65,13 @@ BBCoder.configure do
 <iframe width="560" height="349" src="http://www.youtube.com/embed/#{content}" frameborder="0" allowfullscreen></iframe>
     EOS
   end
+
+  tag :sub, :singular => true do
+    %(<sub>#{singular? ? meta : content}</sub>)
+  end
+
+  tag :sup, :singular => true do
+    %(<sup>#{singular? ? meta : content}</sup>)
+  end
 end
 

data/spec/base_spec.rb

@@ -32,6 +32,10 @@ describe BBCoder do
     it "should split tags up properly" do
       subject.raw.should == ["[p]", "Text and now ", "[b]", "bolded.", "[/b]", "[/p]"]
     end
+
+    it "should split tags up properly without content" do
+      BBCoder.new("[b][/b][u][/u]").raw.should == ["[b]", "[/b]", "[u]", "[/u]"]
+    end
   end
 
   context "#parse" do

data/spec/bbcoder_spec.rb

@@ -103,5 +103,19 @@ EOS
       "[p]Text and now [B]nested.[/b][/P]".bbcode_to_html.should == "<p>Text and now <strong>nested.</strong></p>"
     end
   end
+
+  context "with singular tags" do
+    it "should handle one singular tag" do
+      "[sub=subscriptage]".bbcode_to_html.should == "<sub>subscriptage</sub>"
+    end
+
+    it "should handle multiple singular tags" do
+      "[p]I [sub=me] think [sub=thought]; therefore [sup=well] I am[/p]".bbcode_to_html.should == "<p>I <sub>me</sub> think <sub>thought</sub>; therefore <sup>well</sup> I am</p>"
+    end
+
+    it "should handle singular tags in non singular form" do
+      "[p]I [sub]me[/sub] think [sub]thought[/sub]; therefore [sup]well[/sup] I am[/p]".bbcode_to_html.should == "<p>I <sub>me</sub> think <sub>thought</sub>; therefore <sup>well</sup> I am</p>"
+    end
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bbcoder
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-19 00:00:00.000000000Z
+date: 2012-01-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &21553860 !ruby/object:Gem::Requirement
+  requirement: &8964480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21553860
+  version_requirements: *8964480
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &21553440 !ruby/object:Gem::Requirement
+  requirement: &8964060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21553440
+  version_requirements: *8964060
 description: A gem for parsing bbcode that doesn't rely on regular expressions
 email:
 - machinist@asceth.com
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: bbcoder
-rubygems_version: 1.8.8
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: BBCode parser