rouge 0.2.0 → 0.2.1

data/lib/rouge/template_lexer.rb

@@ -1,5 +1,11 @@
 module Rouge
+  # @abstract
+  # A TemplateLexer is one that accepts a :parent option, to specify
+  # which language is being templated.  The lexer class can specify its
+  # own default for the parent lexer, which is otherwise defaulted to
+  # HTML.
   class TemplateLexer < RegexLexer
+    # the parent lexer - the one being templated.
     def parent
       return @parent if instance_variable_defined? :@parent
       @parent = option(:parent) || 'html'

data/lib/rouge/text_analyzer.rb

@@ -1,5 +1,6 @@
 module Rouge
   class TextAnalyzer < String
+    # Find a shebang.  Returns nil if no shebang is present.
     def shebang
       return @shebang if instance_variable_defined? :@shebang
 
@@ -7,11 +8,16 @@ module Rouge
       @shebang = $1
     end
 
+    # Check if the given shebang is present.
+    #
+    # This normalizes things so that `text.shebang?('bash')` will detect
+    # `#!/bash`, '#!/bin/bash', '#!/usr/bin/env bash', and '#!/bin/bash -x'
     def shebang?(match)
       match = /\b#{match}(\s|$)/
       match === shebang
     end
 
+    # Return the contents of the doctype tag if present, nil otherwise.
     def doctype
       return @doctype if instance_variable_defined? :@doctype
 
@@ -22,10 +28,13 @@ module Rouge
       @doctype = $1
     end
 
+    # Check if the doctype matches a given regexp or string
     def doctype?(type=//)
       type === doctype
     end
 
+    # Return true if the result of lexing with the given lexer contains no
+    # error tokens.
     def lexes_cleanly?(lexer)
       lexer.lex(self) do |(tok, _)|
         return false if tok.name == 'Error'

data/lib/rouge/util.rb

@@ -1,4 +1,14 @@
 module Rouge
+  class Yielder
+    def initialize(&pr)
+      @proc = pr
+    end
+
+    def <<(*a)
+      @proc && @proc.call(*a)
+    end
+  end
+
   class InheritableHash < Hash
     def initialize(parent=nil)
       @parent = parent

data/lib/rouge/version.rb

@@ -1,5 +1,5 @@
 module Rouge
   def self.version
-    "0.2.0"
+    "0.2.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rouge
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-10 00:00:00.000000000 Z
+date: 2012-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -38,6 +38,7 @@ files:
 - Gemfile
 - lib/rouge/util.rb
 - lib/rouge/lexers/python.rb
+- lib/rouge/lexers/sql.rb
 - lib/rouge/lexers/common_lisp.rb
 - lib/rouge/lexers/erb.rb
 - lib/rouge/lexers/scheme.rb
@@ -49,6 +50,7 @@ files:
 - lib/rouge/lexers/perl.rb
 - lib/rouge/lexers/javascript.rb
 - lib/rouge/lexers/diff.rb
+- lib/rouge/lexers/viml.rb
 - lib/rouge/lexers/php/builtins.rb
 - lib/rouge/lexers/haskell.rb
 - lib/rouge/lexers/c.rb
@@ -63,6 +65,7 @@ files:
 - lib/rouge/lexers/css.rb
 - lib/rouge/lexers/cpp.rb
 - lib/rouge/lexers/factor.rb
+- lib/rouge/lexers/viml/keywords.rb
 - lib/rouge/plugins/redcarpet.rb
 - lib/rouge/themes/thankful_eyes.rb
 - lib/rouge/themes/colorful.rb