synvert-core 1.24.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b80b28538674cde89c7dc0098b53d736abb355874d4736654b48234c38c76e2b
-  data.tar.gz: 463e9b2616f07146ce551e904912dc2cbfb71e010ffa11eda8ff134c0ea1a5b3
+  metadata.gz: 831aba295c622cf2e70df84432e246864f630adbdb1c3f4e13ac2e143e3f1c3e
+  data.tar.gz: 33c848691dfd2d638ac09e1f158d83c29d81c1a0ee025b79762cf6a28ebc62ad
 SHA512:
-  metadata.gz: 2f25773c6887fe6b676dc1abd92df89b82dddab81e26841d3e1b566b1ab4f84666f7fde4563e864508814b49f7a54313014a88e412946b908e58976641a1223f
-  data.tar.gz: 13cadd41c39b742837a0b562626b1de9355e63f52f953133139f60c47f6341001f2442bca9276078bfdadea909ef5068db688444ed8e55ceaf9fc2511e7321d4
+  metadata.gz: b92cc018fcf12791a0cc93d5f82bb2248188557c6f81ab706c444d82462086e1e0a53f77b3617ffd2be8edd0c14b4818e44285dd1aee8b3f89b506fb397e54e7
+  data.tar.gz: 855fa232ceed49e06dffc0a0f66d925383c67b18172cc99257e710f955c439fd0bdd0fd4d47111cb6bc4e0a3392481e6733951a9c2be1f28bdf990ac1e6182cd

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## 1.26.0 (2023-04-18)
+
+* `add_file` and `remove_file` work for test
+* Add `indent` dsl
+* Add `type` to Action
+* Update `node_mutation` to 1.15.3
+
+## 1.25.0 (2023-04-17)
+
+* Update `wrap` dsl
+* Update `node_mutation` to 1.15.1
+* Fix `erb` encoded source
+
 ## 1.24.0 (2023-04-16)
 
 * Add `Slim` engine

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.24.0)
+    synvert-core (1.26.0)
       activesupport (< 7.0.0)
-      node_mutation (>= 1.14.0)
+      node_mutation (>= 1.15.3)
       node_query (>= 1.12.1)
       parallel
       parser
@@ -48,7 +48,7 @@ GEM
     method_source (1.0.0)
     minitest (5.18.0)
     nenv (0.3.0)
-    node_mutation (1.14.0)
+    node_mutation (1.15.3)
     node_query (1.12.1)
     notiffany (0.1.3)
       nenv (~> 0.1)

data/README.md

@@ -88,13 +88,14 @@ Actions:
 
 * [append](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#append-instance_method) - append the code to the bottom of current node body
 * [prepend](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#prepend-instance_method) - prepend the code to the bottom of current node body
+* [indent](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#indent-instance_method) - indent code
 * [insert](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#insert-instance_method) - insert code
 * [insert_after](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#insert_after-instance_method) - insert the code next to the current node
 * [insert_before](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#insert_before-instance_method) - insert the code previous to the current node
 * [replace](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#replace-instance_method) - replace the code of specified child nodes
 * [delete](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#delete-instance_method) - delete the code in specified child nodes
 * [remove](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#remove-instance_method) - remove the whole code of current node
-* [wrap](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#wrap-instance_method) - wrap the current node with code
+* [wrap](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#wrap-instance_method) - wrap the current node with prefix and suffix code
 * [replace_with](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#replace_with-instance_method) - replace the whole code of current node
 * [warn](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#warn-instance_method) - warn message
 * [replace_erb_stmt_with_expr](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#replace_erb_stmt_with_expr-instance_method) - replace erb stmt code to expr code

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

@@ -94,14 +94,14 @@ module Synvert::Core
           new_code << END_LINE
         end
         while scanner.scan(/(.*?)(\\*)#\{/) # it matches interpolation "  #{current_user.login}"
-          new_code << WHITESPACE * scanner.matched.size
+          new_code << (WHITESPACE * scanner.matched.size)
           unless scanner.matched[-3] == '\\'
             count = 1
             while scanner.scan(/.*?([\{\}])/)
               if scanner.matched[-1] == '}'
                 count -= 1
                 if count == 0
-                  new_code << scanner.matched[0..-2] + ';'
+                  new_code << (scanner.matched[0..-2] + ';')
                   break
                 else
                   new_code << scanner.matched
@@ -114,12 +114,12 @@ module Synvert::Core
           end
         end
         if scanner.scan(/.*?\z/)
-          new_code << WHITESPACE * scanner.matched.size
+          new_code << (WHITESPACE * scanner.matched.size)
         end
         if scanner.scan(/.*?\n/)
-          new_code << WHITESPACE * (scanner.matched.size - 1) + "\n"
+          new_code << ((WHITESPACE * (scanner.matched.size - 1)) + "\n")
         end
       end
     end
   end
-end
+end

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

@@ -9,9 +9,9 @@ module Synvert::Core
         # @param source [String] erb code.
         # @return [String] encoded ruby code.
         def encode(source)
-          source.gsub(/%>.*?<%=?/m) { |str| replace_all_code_but_white_space_characters(str) }
+          source.gsub(/%>.*?<%=?/m) { |str| ';' + replace_all_code_but_white_space_characters(str[1..-1]) }
                 .sub(/^.*?<%=?/m) { |str| replace_all_code_but_white_space_characters(str) }
-                .sub(/%>.*?$/m) { |str| replace_all_code_but_white_space_characters(str) }
+                .sub(/%>.*?$/m) { |str| ';' + replace_all_code_but_white_space_characters(str[1..-1]) }
         end
 
         # Generate an empty proc.

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

@@ -25,7 +25,7 @@ module Synvert::Core
               new_code << WHITESPACE
               scan_ruby_expression(scanner, new_code, leading_spaces_counts, leading_spaces_count)
             elsif scanner.scan(/[%#\.][a-zA-Z0-9\-_%#\.]+/) # it matches element, id and class "  %span.user"
-              new_code << WHITESPACE * scanner.matched.size
+              new_code << (WHITESPACE * scanner.matched.size)
               scan_matching_wrapper(scanner, new_code, '{', '}')
               if scanner.scan('=')
                 new_code << WHITESPACE

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

@@ -6,11 +6,7 @@ module Synvert::Core
       class << self
         include Elegant
 
-        ATTRIBUTES_PAIR = {
-          '{' => '}',
-          '[' => ']',
-          '(' => ')'
-        }
+        ATTRIBUTES_PAIR = { '{' => '}', '[' => ']', '(' => ')' }
 
         # Encode haml string, leave only ruby code, replace other haml code with whitespace.
         # And insert `end\n` for each if, unless, begin, case to make it a valid ruby code.
@@ -28,16 +24,16 @@ module Synvert::Core
               new_code << WHITESPACE
               scan_ruby_statement(scanner, new_code, leading_spaces_counts, leading_spaces_count)
             elsif scanner.scan(/==?/) # it matches ruby expression "  = current_user.login"
-              new_code << WHITESPACE * scanner.matched.size
+              new_code << (WHITESPACE * scanner.matched.size)
               scan_ruby_expression(scanner, new_code, leading_spaces_counts, leading_spaces_count)
             elsif scanner.scan(/[a-z#\.][a-zA-Z0-9\-_%#\.]*/) # it matches element, id and class "  span.user"
-              new_code << WHITESPACE * scanner.matched.size
+              new_code << (WHITESPACE * scanner.matched.size)
               ATTRIBUTES_PAIR.each do |start, ending| # it matches attributes in brackets "  span[ class='user' ]"
                 scan_matching_wrapper(scanner, new_code, start, ending)
               end
               scan_attributes_between_whitespace(scanner, new_code)
               if scanner.scan(/ ?==?/) # it matches ruby expression "  span= current_user.login"
-                new_code << WHITESPACE * scanner.matched.size
+                new_code << (WHITESPACE * scanner.matched.size)
                 scan_ruby_expression(scanner, new_code, leading_spaces_counts, leading_spaces_count)
               else
                 scan_ruby_interpolation_and_plain_text(scanner, new_code, leading_spaces_counts, leading_spaces_count)
@@ -64,7 +60,7 @@ module Synvert::Core
             while scanner.scan(/.*?[#{Regexp.quote(start)}#{Regexp.quote(ending)}]/m)
               matched = scanner.matched.gsub(/(\A| ).*?=/) { |key| WHITESPACE * key.size }
               if scanner.matched[-1] == ending
-                new_code << matched[0..-2] + ';'
+                new_code << (matched[0..-2] + ';')
                 count -= 1
                 break if count == 0
               else
@@ -77,7 +73,7 @@ module Synvert::Core
 
         def scan_attributes_between_whitespace(scanner, new_code)
           while scanner.scan(/ ?[\w\-_]+==?/) # it matches attributes split by space "  span class='user'"
-            new_code << WHITESPACE * scanner.matched.size
+            new_code << (WHITESPACE * scanner.matched.size)
             stack = []
             while scanner.scan(/(.*?['"\(\)\[\]\{\}]|.+?\b)/)
               matched = scanner.matched
@@ -86,7 +82,7 @@ module Synvert::Core
                 stack << matched[-1]
               elsif [')', ']', '}'].include?(matched[-1])
                 stack.pop
-              elsif %w['  "].include?(matched[-1])
+              elsif %w[' "].include?(matched[-1])
                 stack.last == matched[-1] ? stack.pop : stack << matched[-1]
               end
               break if stack.empty?

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

@@ -11,6 +11,7 @@ module Synvert::Core
     def initialize(node, erb_source)
       super(node, nil)
       @erb_source = erb_source
+      @type = :insert
     end
 
     # The new erb expr code.

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

@@ -362,7 +362,7 @@ module Synvert::Core
       @current_mutation.delete(@current_node, *selectors, and_comma: and_comma)
     end
 
-    # It wraps current node with code.
+    # It wraps current node with prefix and suffix code.
     # @example
     #   # class Foobar
     #   # end
@@ -372,11 +372,27 @@ module Synvert::Core
     #   #   end
     #   # end
     #   within_node type: 'class' do
-    #     wrap with: 'module Synvert'
+    #     wrap with: 'module Synvert', and: 'end', newline: true
     #   end
-    # @param with [String] code need to be wrapped with.
-    def wrap(with:)
-      @current_mutation.wrap(@current_node, with: with)
+    # @param prefix [String] prefix code need to be wrapped with.
+    # @param suffix [String] suffix code need to be wrapped with.
+    # @param newline [Boolean] if wrap code in newline, default is false
+    def wrap(prefix:, suffix:, newline: false)
+      @current_mutation.wrap(@current_node, prefix: prefix, suffix: suffix, newline: newline)
+    end
+
+    # It indent the code of current node.
+    # @example
+    #     # class Foobar
+    #     # end
+    #     # =>
+    #     #   class Foobar
+    #     #   end
+    #     within_node type: 'class' do
+    #       indent
+    #     end
+    def indent(tab_size: 1)
+      @current_mutation.indent(@current_node, tab_size: tab_size)
     end
 
     # No operation.

data/lib/synvert/core/rewriter.rb

@@ -264,6 +264,14 @@ module Synvert::Core
     def add_file(filename, content)
       return unless @options[:run_instance]
 
+      unless @options[:write_to_file]
+        result = NodeMutation::Result.new(affected: true, conflicted: false)
+        result.actions = [NodeMutation::Struct::Action.new(:add_file, 0, 0, content)]
+        result.file_path = filename
+        @test_results << result
+        return
+      end
+
       filepath = File.join(Configuration.root_path, filename)
       if File.exist?(filepath)
         puts "File #{filepath} already exists."
@@ -283,6 +291,14 @@ module Synvert::Core
     def remove_file(filename)
       return unless @options[:run_instance]
 
+      unless @options[:write_to_file]
+        result = NodeMutation::Result.new(affected: true, conflicted: false)
+        result.actions = [NodeMutation::Struct::Action.new(:remove_file, 0, -1)]
+        result.file_path = filename
+        @test_results << result
+        return
+      end
+
       file_path = File.join(Configuration.root_path, filename)
       File.delete(file_path) if File.exist?(file_path)
     end

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.24.0'
+    VERSION = '1.26.0'
   end
 end

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

@@ -20,6 +20,8 @@ module Synvert::Core
           bar = 'foo'
         %>
 
+        <%= user.first_name %> <%= user.last_name %>
+
         <% if User.current &&
               User.current.admin %>
           <%= rounded_content("page") do %>
@@ -40,6 +42,8 @@ module Synvert::Core
       expect(encoded_source).to be_include 'post = Post.find(:first)'
       expect(encoded_source).to be_include "link_to_function 'test', \"confirm('test');\""
       expect(encoded_source).to be_include 'end'
+      expect(encoded_source).to be_include 'user.first_name ;'
+      expect(encoded_source).to be_include 'user.last_name ;'
       expect(encoded_source).not_to be_include 'style'
       expect(encoded_source).not_to be_include 'div'
     end

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

@@ -217,11 +217,11 @@ module Synvert::Core
         EOS
         proc = Engine::Haml.generate_transform_proc(encoded_source)
         actions = [
-          NodeMutation::Struct::Action.new(50, 55, ''),
+          NodeMutation::Struct::Action.new(:delete, 50, 55, ''),
           # first end position is 69
-          NodeMutation::Struct::Action.new(100, 105, ''),
+          NodeMutation::Struct::Action.new(:delete, 100, 105, ''),
           # second end position is 111
-          NodeMutation::Struct::Action.new(120, 125, '')
+          NodeMutation::Struct::Action.new(:delete, 120, 125, '')
         ]
         proc.call(actions)
         expect(actions.first.start).to eq 50

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

@@ -204,11 +204,11 @@ module Synvert::Core
         EOS
         proc = Engine::Slim.generate_transform_proc(encoded_source)
         actions = [
-          NodeMutation::Struct::Action.new(50, 55, ''),
+          NodeMutation::Struct::Action.new(:delete, 50, 55, ''),
           # first end position is 69
-          NodeMutation::Struct::Action.new(100, 105, ''),
+          NodeMutation::Struct::Action.new(:delete, 100, 105, ''),
           # second end position is 111
-          NodeMutation::Struct::Action.new(120, 125, '')
+          NodeMutation::Struct::Action.new(:delete, 120, 125, '')
         ]
         proc.call(actions)
         expect(actions.first.start).to eq 50

data/spec/synvert/core/rewriter/instance_spec.rb

@@ -233,14 +233,26 @@ module Synvert::Core
       instance.delete :dot, :message, and_comma: true
     end
 
-    it 'parses wrap with' do
+    it 'parses wrap' do
       instance.instance_variable_set(:@current_mutation, double)
       instance.current_node = double
       expect(instance.instance_variable_get(:@current_mutation)).to receive(:wrap).with(
         instance.current_node,
-        with: 'module Foobar'
+        prefix: 'module Foobar',
+        suffix: 'end',
+        newline: true
       )
-      instance.wrap with: 'module Foobar'
+      instance.wrap prefix: 'module Foobar', suffix: 'end', newline: true
+    end
+
+    it 'parses indent' do
+      instance.instance_variable_set(:@current_mutation, double)
+      instance.current_node = double
+      expect(instance.instance_variable_get(:@current_mutation)).to receive(:indent).with(
+        instance.current_node,
+        tab_size: 1
+      )
+      instance.indent
     end
 
     it 'parses noop' do
@@ -428,8 +440,8 @@ module Synvert::Core
         results = instance.test
         expect(results.file_path).to eq 'spec/models/post_spec.rb'
         expect(results.actions).to eq [
-          NodeMutation::Struct::Action.new(35, 59, 'create :user'),
-          NodeMutation::Struct::Action.new(69, 105, 'create :post, user: user')
+          NodeMutation::Struct::Action.new(:replace, 35, 59, 'create :user'),
+          NodeMutation::Struct::Action.new(:replace, 69, 105, 'create :post, user: user')
         ]
       end
 
@@ -467,7 +479,7 @@ module Synvert::Core
         allow(File).to receive(:read).with('./app/views/posts/_form.html.erb', encoding: 'UTF-8').and_return(input)
         result = instance.test
         expect(result.file_path).to eq 'app/views/posts/_form.html.erb'
-        expect(result.actions).to eq [NodeMutation::Struct::Action.new(2, 2, '=')]
+        expect(result.actions).to eq [NodeMutation::Struct::Action.new(:insert, 2, 2, '=')]
       end
 
       it 'updates haml file' do
@@ -489,8 +501,9 @@ module Synvert::Core
         result = instance.test
         expect(result.file_path).to eq 'app/views/posts/_form.html.haml'
         expect(result.actions).to eq [
-          NodeMutation::Struct::Action.new("= form_for ".length, "= form_for @post".length, 'post'),
+          NodeMutation::Struct::Action.new(:replace, "= form_for ".length, "= form_for @post".length, 'post'),
           NodeMutation::Struct::Action.new(
+            :replace,
             "= form_for @post do |f|\n= form_for ".length,
             "= form_for @post do |f|\n= form_for @post".length,
             'post'
@@ -517,8 +530,9 @@ module Synvert::Core
         result = instance.test
         expect(result.file_path).to eq 'app/views/posts/_form.html.slim'
         expect(result.actions).to eq [
-          NodeMutation::Struct::Action.new("= form_for ".length, "= form_for @post".length, 'post'),
+          NodeMutation::Struct::Action.new(:replace, "= form_for ".length, "= form_for @post".length, 'post'),
           NodeMutation::Struct::Action.new(
+            :replace,
             "= form_for @post do |f|\n= form_for ".length,
             "= form_for @post do |f|\n= form_for @post".length,
             'post'

data/spec/synvert/core/rewriter_spec.rb

@@ -68,7 +68,7 @@ module Synvert::Core
           expect(results[0].file_path).to eq '/code.rb'
           expect(results[0].affected?).to be_truthy
           expect(results[0].conflicted?).to be_falsey
-          expect(results[0].actions).to eq [NodeMutation::Struct::Action.new(6, 12, 'Synvert')]
+          expect(results[0].actions).to eq [NodeMutation::Struct::Action.new(:replace, 6, 12, 'Synvert')]
         end
       end
     end
@@ -169,6 +169,18 @@ module Synvert::Core
         rewriter.process_with_sandbox
         expect(File.exist?('./foo.bar')).to be_falsey
       end
+
+      it 'returns test result' do
+        rewriter =
+          Rewriter.new 'group', 'rewriter2' do
+            add_file 'foo.bar', 'FooBar'
+          end
+        result = rewriter.test
+        expect(result[0].file_path).to eq 'foo.bar'
+        expect(result[0].affected?).to be_truthy
+        expect(result[0].conflicted?).to be_falsey
+        expect(result[0].actions).to eq [NodeMutation::Struct::Action.new(:add_file, 0, 0, 'FooBar')]
+      end
     end
 
     describe 'parses remove_file' do
@@ -201,6 +213,21 @@ module Synvert::Core
         expect(File.exist?('./foo.bar')).to be_truthy
         FileUtils.rm './foo.bar'
       end
+
+      it 'returns test result' do
+        File.write './foo.bar', 'FooBar'
+        rewriter =
+          Rewriter.new 'group', 'rewriter2' do
+            remove_file 'foo.bar'
+          end
+        result = rewriter.test
+        expect(result[0].file_path).to eq 'foo.bar'
+        expect(result[0].affected?).to be_truthy
+        expect(result[0].conflicted?).to be_falsey
+        expect(result[0].actions).to eq [NodeMutation::Struct::Action.new(:remove_file, 0, -1, nil)]
+        expect(File.exist?('./foo.bar')).to be_truthy
+        FileUtils.rm './foo.bar'
+      end
     end
 
     describe 'parses add_snippet' do

data/synvert-core-ruby.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "activesupport", "< 7.0.0"
   spec.add_runtime_dependency "node_query", ">= 1.12.1"
-  spec.add_runtime_dependency "node_mutation", ">= 1.14.0"
+  spec.add_runtime_dependency "node_mutation", ">= 1.15.3"
   spec.add_runtime_dependency "parser"
   spec.add_runtime_dependency "parser_node_ext", ">= 1.0.0"
   spec.add_runtime_dependency "parallel"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-16 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.15.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.15.3
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement