erb_parser 0.0.0

data/lib/erb_parser.rb

@@ -0,0 +1,33 @@
+require 'treetop'
+require 'erb_parser/nodes'
+require 'erb_parser/treetop_runner'
+require 'erb_parser/parsed_erb'
+require 'erb_parser/erb_tag'
+require 'erb_parser/xml_transformer'
+
+module ErbParser
+  def self.parse(str)
+    ParsedErb.new TreetopRunner.run(str)
+  end
+  
+  # Takes a string representing an XML document or fragment. Finds every ERB tag in the
+  # XML and replaces it with the tag <erb>. The contents of the replacement tag will be
+  # the inner Ruby code, escaped for XML. You can override the tag like so:
+  # 
+  #    ErbParser.transform_xml str, :tag => 'tag-name'
+  # 
+  # If the ERB tag is of the form +<%=+, the attribute +interpolated="true"+ will be
+  # added. Else if the ERB tag is of the form +<#+, the attribute +comment="true"+ will be
+  # added. You can override this behavior like so:
+  #
+  #    ErbParser.transform_xml str, :interp_attr => {'attr-name' => 'attr-value'}
+  #    ErbParser.transform_xml str, :interp_attr => false
+  #    
+  #    ErbParser.transform_xml str, :comment_attr => {'attr-name' => 'attr-value'}
+  #    ErbParser.transform_xml str, :comment_attr => false
+  # 
+  # The returned value is a string representing the transformed XML document or fragment.
+  def self.transform_xml(str, options = {})
+    XmlTransformer.transform(parse(str), options)   
+  end
+end

data/lib/erb_parser/erb_grammar.treetop

@@ -0,0 +1,47 @@
+module ErbParser
+  grammar ErbGrammar
+    rule document
+      (erb_tag / text)*
+    end
+    
+    rule text
+      (!'<%' .)+
+      <Text>
+    end
+    
+    rule erb_tag
+      '<%'
+      number_sign:'#'? equal_sign:'='?
+      _ruby_code:ruby_code
+      '%>'
+      <ErbTag>
+    end
+    
+    rule ruby_code
+      (string_literal / (!'%>' .))*
+    end
+
+    # Matches the following quote styles:
+    # "string"
+    # 'string'
+    # %q(string (string) string)
+    # %Q(string (string) string)
+    # %(string (string) string)
+    # %q{string {string} string}
+    # %Q{string {string} string}
+    # %{string {string} string}
+    rule string_literal
+      ('"' ('\"' / !'"' .)* '"') /
+      ('\'' ('\\\'' / !'\'' .)* '\'') /
+      ('%' ('q' / 'Q')? (curly_brackets / parens))
+    end
+    
+    rule curly_brackets
+      '{' (curly_brackets / '\}' / !'}' .)* '}'
+    end
+    
+    rule parens
+      '(' (parens         / '\)' / !')' .)* ')'
+    end
+  end
+end

data/lib/erb_parser/erb_tag.rb

@@ -0,0 +1,23 @@
+module ErbParser
+  class ErbTag
+    def comment?
+      @treetop_node.comment?
+    end
+    
+    def initialize(treetop_node)
+      @treetop_node = treetop_node
+    end
+    
+    def interpolated?
+      @treetop_node.interpolated?
+    end
+    
+    def ruby_code
+      @treetop_node.ruby_code
+    end
+    
+    def to_s
+      @treetop_node.text_value
+    end
+  end
+end

data/lib/erb_parser/nodes.rb

@@ -0,0 +1,27 @@
+module ErbParser
+  module ErbGrammar
+    module Text
+      def type
+        :text
+      end
+    end
+    
+    module ErbTag
+      def comment?
+        !number_sign.empty?
+      end
+      
+      def interpolated?
+        !equal_sign.empty?
+      end
+      
+      def ruby_code
+        _ruby_code.text_value
+      end
+      
+      def type
+        :erb_tag
+      end
+    end
+  end
+end

data/lib/erb_parser/parsed_erb.rb

@@ -0,0 +1,29 @@
+module ErbParser
+  class ParsedErb
+    # Accesses the parsed tokens as an array. Each element of the array is either a
+    # String, representing plain text, or an ErbTag.
+    def [](index)
+      @tokens[index]
+    end
+    
+    def initialize(treetop_ast)
+      @treetop_ast = treetop_ast
+      @tokens = treetop_ast.elements.map do |elem|
+        case elem.type
+        when :text
+          elem.text_value
+        when :erb_tag
+          ErbTag.new elem
+        else
+          raise "Unexpected type: #{elem.type}"
+        end
+      end
+    end
+    
+    # Returns the array of parsed tokens.
+    attr_reader :tokens
+    
+    # Returns the raw Treetop AST.
+    attr_reader :treetop_ast
+  end
+end

data/lib/erb_parser/treetop_runner.rb

@@ -0,0 +1,18 @@
+Treetop.load File.join(File.dirname(__FILE__), 'erb_grammar')
+
+module ErbParser
+  # This module doesn't do much. It just provides some boilerplate code to invoke Treetop.
+  # The result is whatever Treetop returns.
+  module TreetopRunner
+    def self.run(str, options = {})
+      treetop = ErbGrammarParser.new
+      if result = treetop.parse(str, options)
+        result
+      else
+        raise ParseError, treetop.failure_reason
+      end
+    end
+    
+    class ParseError < RuntimeError; end
+  end
+end

data/lib/erb_parser/xml_transformer.rb

@@ -0,0 +1,52 @@
+require 'cgi'
+
+module ErbParser
+  module XmlTransformer
+    def self.transform(parsed_erb, options)
+      options = {
+        :tag          => 'erb',
+        :interp_attr  => {'interpolated' => 'true'},
+        :comment_attr => {'comment'      => 'true'}
+      }.merge(options)
+      
+      parsed_erb.tokens.map do |elem|
+        case elem
+        when String
+          elem
+        when ErbTag
+          if elem.interpolated?
+            if options[:interp_attr].is_a?(Hash)
+              attrs = options[:interp_attr]
+            else
+              attrs = {}
+            end
+          elsif elem.comment?
+            if options[:comment_attr].is_a?(Hash)
+              attrs = options[:comment_attr]
+            else
+              attrs = {}
+            end
+          else
+            attrs = {}
+          end
+          content_tag options[:tag], CGI.escape_html(elem.ruby_code), attrs
+        else
+          raise "Unexpected element: #{elem.class.name}"
+        end
+      end.join
+    end
+  
+    def self.content_tag(name, contents, attrs = {})
+      if attrs.empty?
+        attrs_str = ''
+      else
+        attrs_str = ' ' + attrs.map do |key, val|
+          key = CGI.escape_html(key.to_s)
+          val = CGI.escape_html(val.to_s)
+          %Q(#{key}="#{val}")
+        end.join(' ')
+      end
+      '<' + name.to_s + attrs_str + '>' + contents.to_s + '</' + name.to_s + '>'
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: erb_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jarrett Colby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Parses ERB templates into two types of tokens: Plain text and ERB
+  tags. Special support for HTML/XML.'
+email: jarrett@madebyhq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/erb_parser/erb_grammar.treetop
+- lib/erb_parser/erb_tag.rb
+- lib/erb_parser/nodes.rb
+- lib/erb_parser/parsed_erb.rb
+- lib/erb_parser/treetop_runner.rb
+- lib/erb_parser/xml_transformer.rb
+- lib/erb_parser.rb
+homepage: http://madebyhq.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.8.25
+signing_key: 
+specification_version: 3
+summary: Parser for ERB templates
+test_files: []