refactor check functionality to DebugLint encoder

korny · korny · commit 88b812274a80 · 2013-06-13T04:46:11.000+02:00
diff --git a/Changes.textile b/Changes.textile
@@ -20,6 +20,7 @@ h2. Changes in 1.1
 * Override Bootstrap's pre word-break setting for line numbers [#102, thanks to lightswitch05]
 * Fixed @:docstring@ token type style
 * @Plugin@ does not warn about fallback when default is defined
+* @Debug@ encoder refactored; use @DebugLint@ if you want strict checking now
 
 h2. Changes in 1.0.9
 
diff --git a/lib/coderay/encoders/debug.rb b/lib/coderay/encoders/debug.rb
@@ -18,14 +18,7 @@ class Debug < Encoder
     
     FILE_EXTENSION = 'raydebug'
     
-    def initialize options = {}
-      super
-      @opened = []
-    end
-    
     def text_token text, kind
-      raise 'empty token' if $CODERAY_DEBUG && text.empty?
-      
       if kind == :space
         @out << text
       else
@@ -36,26 +29,18 @@ def text_token text, kind
     end
     
     def begin_group kind
-      @opened << kind if $CODERAY_DEBUG
-      
       @out << "#{kind}<"
     end
     
     def end_group kind
-      raise "We are inside #{@opened.inspect}, not #{kind}" if $CODERAY_DEBUG && @opened.pop != kind
-      
       @out << '>'
     end
     
     def begin_line kind
-      @opened << kind if $CODERAY_DEBUG
-      
       @out << "#{kind}["
     end
     
     def end_line kind
-      raise "We are inside #{@opened.inspect}, not #{kind}" if $CODERAY_DEBUG && @opened.pop != kind
-      
       @out << ']'
     end
     
diff --git a/lib/coderay/encoders/debug_lint.rb b/lib/coderay/encoders/debug_lint.rb
@@ -0,0 +1,55 @@
+module CodeRay
+module Encoders
+  
+  # = Debug Lint Encoder
+  #
+  # Debug encoder with additional checks for:
+  # 
+  # - empty tokens
+  # - incorrect nesting
+  # 
+  # It will raise an InvalidTokenStream exception when any of the above occurs.
+  # 
+  # See also: Encoders::Debug
+  class DebugLint < Debug
+    
+    register_for :debug_lint
+    
+    InvalidTokenStream = Class.new StandardError
+    EmptyToken = Class.new InvalidTokenStream
+    IncorrectTokenGroupNesting = Class.new InvalidTokenStream
+    
+    def initialize options = {}
+      super
+      @opened = []
+    end
+    
+    def text_token text, kind
+      raise EmptyToken, 'empty token' if text.empty?
+      super
+    end
+    
+    def begin_group kind
+      @opened << kind
+      super
+    end
+    
+    def end_group kind
+      raise IncorrectTokenGroupNesting, "We are inside #{@opened.inspect}, not #{kind}" if @opened.pop != kind
+      super
+    end
+    
+    def begin_line kind
+      @opened << kind
+      super
+    end
+    
+    def end_line kind
+      raise IncorrectTokenGroupNesting, "We are inside #{@opened.inspect}, not #{kind}" if @opened.pop != kind
+      super
+    end
+    
+  end
+  
+end
+end
