synvert-core 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ee7de00fd1f401d3d4ea506c941871da5714229
-  data.tar.gz: 406b2f2ecdfdb8b837ad0e8839c5e37b1c9d821f
+  metadata.gz: e006c23fc6ca2d1398bfaf32db73c4ced664a94e
+  data.tar.gz: d7dc0a2a30fb4e544f4bd25307b4177ed6914f38
 SHA512:
-  metadata.gz: d1db8ef41e1b179c38df52c22091418183e40b879921b462bc47d9f9821a47cb4d4823983bb54024624717cbcf39bfa5b4a86575c4cd69a6ae9b179c7eb1bab6
-  data.tar.gz: f394394861d482865963fccd5024a340ddabf9e43077a0467a79ef9de77285348905e09d70f5e334d1e1ae759737dfd709bb5c49a955ff7b331eaacb13082482
+  metadata.gz: c05837b831a3c9aa02c1c0bd5a88adeeddafd98114a562462749d3f92a4728b0fd1e38415cd26d7816a46705c5528285a33705c480018abdb59fb9a9c82d01bd
+  data.tar.gz: 857e3cbd4cfc5ca0c77dc452e615a23006436418c600b09c6738dbee267abbb71042ddbc1a2b7a0b65f531cef0b24811ee19b8fa6edfa97ef9043a32cd77a025

data/CHANGELOG.md

@@ -1,17 +1,23 @@
 # CHANGELOG
 
-## 0.3.0
+## 0.4.0 (2014-07-26)
+
+* Add erb support
+* Add replace_erb_stmt_with_expr dsl
+* Improve Parser::AST::Node#to_value
+
+## 0.3.0 (2014-07-12)
 
 * Rename node.source(instance) to node.to_source
 * Add has_key? and hash_value helper methods for hash node
 * Fix Instance#check_conflict_actions
 
-## 0.2.0
+## 0.2.0 (2014-05-16)
 
 * Add remove_file dsl
 * Add warn dsl
 * Return empty array if no available rewriters
 
-## 0.1.0
+## 0.1.0 (2014-05-04)
 
 * Abstract from synvert

data/lib/synvert/core.rb

@@ -7,12 +7,14 @@ require 'parser'
 require 'parser/current'
 require 'ast'
 require 'active_support/inflector'
+require 'erubis'
 require 'synvert/core/node_ext'
 
 module Synvert
   module Core
     autoload :Configuration, 'synvert/core/configuration'
     autoload :Rewriter, 'synvert/core/rewriter'
+    autoload :Engine, 'synvert/core/engine'
     autoload :RewriterNotFound, 'synvert/core/exceptions'
     autoload :GemfileLockNotFound, 'synvert/core/exceptions'
     autoload :MethodNotSupported, 'synvert/core/exceptions'

data/lib/synvert/core/engine.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+module Synvert::Core
+  # Engine defines how to encode / decode other files (like erb).
+  module Engine
+    autoload :ERB, 'synvert/core/engine/erb'
+  end
+end

data/lib/synvert/core/engine/erb.rb

@@ -0,0 +1,139 @@
+# encoding: utf-8
+require 'erubis'
+
+module Synvert::Core
+  module Engine
+    ERUBY_EXPR_SPLITTER = ";  ;"
+    ERUBY_STMT_SPLITTER = ";   ;"
+
+    class ERB
+      class <<self
+        # convert erb to ruby code.
+        #
+        # @param source [String] erb source code.
+        # @return [String] ruby source code.
+        def encode(source)
+          Erubis.new(source.gsub("-%>", "%>"), :escape => false, :trim => false).src
+        end
+
+        # convert ruby code to erb.
+        #
+        # @param source [String] ruby source code.
+        # @return [String] erb source code.
+        def decode(source)
+          source = decode_ruby_stmt(source)
+          source = decode_ruby_output(source)
+          source = decode_html_output(source)
+          source = remove_erubis_buf(source)
+        end
+
+      private
+
+        def decode_ruby_stmt(source)
+          source.gsub(/#{ERUBY_STMT_SPLITTER}(.+?)#{ERUBY_STMT_SPLITTER}/m) { "<%#{$1}%>" }
+        end
+
+        def decode_ruby_output(source)
+          source.gsub(/@output_buffer.append=\((.+?)\);#{ERUBY_EXPR_SPLITTER}/m) { "<%=#{$1}%>" }
+            .gsub(/@output_buffer.append= (.+?)\s+(do|\{)(\s*\|[^|]*\|)?\s*#{ERUBY_EXPR_SPLITTER}/m) { |m| "<%=#{m.sub("@output_buffer.append= ", "").sub(ERUBY_EXPR_SPLITTER, "")}%>" }
+        end
+
+        def decode_html_output(source)
+          source.gsub(/@output_buffer.safe_append='(.+?)'.freeze;/m) { reverse_escape_text($1) }
+            .gsub(/@output_buffer.safe_append=\((.+?)\);#{ERUBY_EXPR_SPLITTER}/m) { reverse_escape_text($1) }
+            .gsub(/@output_buffer.safe_append=(.+?)\s+(do|\{)(\s*\|[^|]*\|)?\s*#{ERUBY_EXPR_SPLITTER}/m) { reverse_escape_text($1) }
+        end
+
+        def remove_erubis_buf(source)
+          source.sub("@output_buffer = output_buffer || ActionView::OutputBuffer.new;", "").sub("@output_buffer.to_s", "")
+        end
+
+        def reverse_escape_text(source)
+          source.gsub("\\\\", "\\").gsub("\\'", "'")
+        end
+      end
+    end
+
+    # borrowed from rails
+    class Erubis < ::Erubis::Eruby
+      def add_preamble(src)
+        @newline_pending = 0
+        src << "@output_buffer = output_buffer || ActionView::OutputBuffer.new;"
+      end
+
+      def add_text(src, text)
+        return if text.empty?
+
+        if text == "\n"
+          @newline_pending += 1
+        else
+          src << "@output_buffer.safe_append='"
+          src << "\n" * @newline_pending if @newline_pending > 0
+          src << escape_text(text)
+          src << "'.freeze;"
+
+          @newline_pending = 0
+        end
+      end
+
+      # Erubis toggles <%= and <%== behavior when escaping is enabled.
+      # We override to always treat <%== as escaped.
+      def add_expr(src, code, indicator)
+        case indicator
+        when '=='
+          add_expr_escaped(src, code)
+        else
+          super
+        end
+      end
+
+      BLOCK_EXPR = /\s+(do|\{)(\s*\|[^|]*\|)?\s*\Z/
+
+      def add_expr_literal(src, code)
+        flush_newline_if_pending(src)
+        if code =~ BLOCK_EXPR
+          src << '@output_buffer.append= ' << code << ERUBY_EXPR_SPLITTER
+        else
+          src << '@output_buffer.append=(' << code << ');' << ERUBY_EXPR_SPLITTER
+        end
+      end
+
+      def add_expr_escaped(src, code)
+        flush_newline_if_pending(src)
+        if code =~ BLOCK_EXPR
+          src << "@output_buffer.safe_append= " << code << ERUBY_EXPR_SPLITTER
+        else
+          src << "@output_buffer.safe_append=(" << code << ");" << ERUBY_EXPR_SPLITTER
+        end
+      end
+
+      def add_stmt(src, code)
+        flush_newline_if_pending(src)
+        if code != "\n" && code != ""
+          index = if code =~ /\A(\s*)\r?\n/
+                    $1.length
+                  elsif code =~ /\A(\s+)/
+                    $1.end_with?(' ') ? $1.length - 1 : $1.length
+                  else
+                    0
+                  end
+          code.insert(index, ERUBY_STMT_SPLITTER)
+          code.insert(-1, ERUBY_STMT_SPLITTER[0...-1])
+        end
+        super
+      end
+
+      def add_postamble(src)
+        flush_newline_if_pending(src)
+        src << '@output_buffer.to_s'
+      end
+
+      def flush_newline_if_pending(src)
+        if @newline_pending > 0
+          src << "@output_buffer.safe_append='#{"\n" * @newline_pending}'.freeze;"
+          @newline_pending = 0
+        end
+      end
+    end
+  end
+end

data/lib/synvert/core/node_ext.rb

@@ -176,10 +176,18 @@ class Parser::AST::Node
   # @raise [Synvert::Core::MethodNotSupported] if calls on other node.
   def to_value
     case self.type
-    when :str, :sym
+    when :int, :str, :sym
       self.children.last
+    when :true
+      true
+    when :false
+      false
     when :array
       self.children.map(&:to_value)
+    when :irange
+      (self.children.first.to_value..self.children.last.to_value)
+    when :begin
+      self.children.first.to_value
     else
       raise Synvert::Core::MethodNotSupported.new "to_value is not handled for #{self.inspect}"
     end
@@ -295,6 +303,7 @@ private
         actual.to_s =~ Regexp.new(expected.to_s, Regexp::MULTILINE)
       end
     when Array
+      return false unless expected.length == actual.length
       actual.zip(expected).all? { |a, e| match_value?(a, e) }
     when NilClass
       actual.nil?

data/lib/synvert/core/rewriter.rb

@@ -21,6 +21,7 @@ module Synvert::Core
     autoload :InsertAction, 'synvert/core/rewriter/action'
     autoload :InsertAfterAction, 'synvert/core/rewriter/action'
     autoload :ReplaceWithAction, 'synvert/core/rewriter/action'
+    autoload :ReplaceErbStmtWithExprAction, 'synvert/core/rewriter/action'
     autoload :RemoveAction, 'synvert/core/rewriter/action'
 
     autoload :Warning, 'synvert/core/rewriter/warning'

data/lib/synvert/core/rewriter/action.rb

@@ -221,4 +221,42 @@ module Synvert::Core
       ''
     end
   end
+
+  # ReplaceErbStmtWithExprAction to replace erb stmt code to expr,
+  #   e.g. <% form_for ... %> => <%= form_for ... %>.
+  class Rewriter::ReplaceErbStmtWithExprAction < Rewriter::Action
+    def initialize(instance, code=nil)
+      super
+    end
+
+    # Begin position of code to replace.
+    #
+    # @return [Integer] begin position.
+    def begin_pos
+      node_begin_pos = @node.loc.expression.begin_pos
+      while @instance.current_source[node_begin_pos -= 1] == ' '
+      end
+      node_begin_pos - Engine::ERUBY_STMT_SPLITTER.length + 1
+    end
+
+    # End position of code to replace.
+    #
+    # @return [Integer] end position.
+    def end_pos
+      node_begin_pos = @node.loc.expression.begin_pos
+      node_end_pos = @node.loc.expression.end_pos
+      node_begin_pos += @instance.current_source[node_begin_pos..node_end_pos].index "do"
+      while @instance.current_source[node_begin_pos += 1] != '@'
+      end
+      node_begin_pos
+    end
+
+    # The rewritten erb expr code.
+    #
+    # @return [String] rewritten code.
+    def rewritten_code
+      @instance.current_source[begin_pos...end_pos].sub(Engine::ERUBY_STMT_SPLITTER, "@output_buffer.append= ")
+        .sub(Engine::ERUBY_STMT_SPLITTER, Engine::ERUBY_EXPR_SPLITTER)
+    end
+  end
 end

data/lib/synvert/core/rewriter/instance.rb

@@ -44,6 +44,7 @@ module Synvert::Core
         unless Configuration.instance.get(:skip_files).include? file_path
           begin
             source = File.read(file_path)
+            source = Engine::ERB.encode(source) if file_path =~ /\.erb$/
             buffer = Parser::Source::Buffer.new file_path
             buffer.source = source
 
@@ -64,6 +65,7 @@ module Synvert::Core
             end
             @actions = []
 
+            source = Engine::ERB.decode(source) if file_path =~ /\.erb/
             File.write file_path, source
           end while !@conflict_actions.empty?
         end
@@ -152,6 +154,12 @@ module Synvert::Core
       @actions << Rewriter::ReplaceWithAction.new(self, code)
     end
 
+    # Parse replace_erb_stmt_with_expr dsl, it creates a [Synvert::Core::Rewriter::ReplaceErbStmtWithExprAction] to
+    # replace erb stmt code to expr code.
+    def replace_erb_stmt_with_expr
+      @actions << Rewriter::ReplaceErbStmtWithExprAction.new(self)
+    end
+
     # Parse remove dsl, it creates a [Synvert::Core::Rewriter::RemoveAction] to current node.
     def remove
       @actions << Rewriter::RemoveAction.new(self)

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/spec/spec_helper.rb

@@ -12,7 +12,6 @@ end
 RSpec.configure do |config|
   config.include ParserHelper
 
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

data/spec/synvert/core/engine/erb_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+module Synvert::Core
+  describe Engine::ERB do
+    it "encodes / decodes" do
+      source =<<-EOF
+<%content_for :head do%>
+  <style>
+    body {
+      background-image: url(<%= asset_path('bg.png') %>);
+    }
+  </style>
+<%end%>
+
+<%
+  foo = 'bar'
+  post = Post.find(:first)
+  bar = 'foo'
+%>
+
+<% if User.current &&
+      User.current.admin %>
+  <%= rounded_content("page") do %>
+  <div class='test'>
+    <% if post %>
+      <div id="title"><%= foo %></div>
+      <% form_for post do |f| %>
+        <label><%= link_to_function 'test', "confirm('test');" %></label>
+        <%= f.text_field 'bar' %>
+      <% end %>
+    <% end %></div>
+  <% end %>
+<% end %>
+      EOF
+      encoded_source = Engine::ERB.encode(source)
+      buffer = Parser::Source::Buffer.new "(test)"
+      buffer.source = encoded_source
+      parser = Parser::CurrentRuby.new
+      parser.reset
+      parser.parse buffer
+
+      expect(Engine::ERB.decode(encoded_source)).to eq source
+    end
+  end
+end

data/spec/synvert/core/node_ext_spec.rb

@@ -149,6 +149,11 @@ describe Parser::AST::Node do
   end
 
   describe "#to_value" do
+    it 'gets for int' do
+      node = parse("1")
+      expect(node.to_value).to eq 1
+    end
+
     it 'gets for string' do
       node = parse("'str'")
       expect(node.to_value).to eq "str"
@@ -159,6 +164,18 @@ describe Parser::AST::Node do
       expect(node.to_value).to eq :str
     end
 
+    it 'get for boolean' do
+      node = parse("true")
+      expect(node.to_value).to be_truthy
+      node = parse("false")
+      expect(node.to_value).to be_falsey
+    end
+
+    it 'get for range' do
+      node = parse("(1..10)")
+      expect(node.to_value).to eq (1..10)
+    end
+
     it 'gets for array' do
       node = parse("['str', :str]")
       expect(node.to_value).to eq ['str', :str]

data/synvert-core.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "parser"
   spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "erubis"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-12 00:00:00.000000000 Z
+date: 2014-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +111,8 @@ files:
 - Rakefile
 - lib/synvert/core.rb
 - lib/synvert/core/configuration.rb
+- lib/synvert/core/engine.rb
+- lib/synvert/core/engine/erb.rb
 - lib/synvert/core/exceptions.rb
 - lib/synvert/core/node_ext.rb
 - lib/synvert/core/rewriter.rb
@@ -110,6 +126,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/parser_helper.rb
 - spec/synvert/core/configuration_spec.rb
+- spec/synvert/core/engine/erb_spec.rb
 - spec/synvert/core/node_ext_spec.rb
 - spec/synvert/core/rewriter/action_spec.rb
 - spec/synvert/core/rewriter/condition_spec.rb
@@ -147,6 +164,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/parser_helper.rb
 - spec/synvert/core/configuration_spec.rb
+- spec/synvert/core/engine/erb_spec.rb
 - spec/synvert/core/node_ext_spec.rb
 - spec/synvert/core/rewriter/action_spec.rb
 - spec/synvert/core/rewriter/condition_spec.rb