synvert-core 1.19.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a431b26d98c476c389746269aade183f241a3c1cb2fabab27b87b2b0689510f
-  data.tar.gz: 61b1907dbadbef95ca5d8869b6c27f65e43f72dccd0f64ead4ad3cf15a5f9c01
+  metadata.gz: df27af331a60def04866041f84ae64b9fe15555996ec2289015eb2c97d965f68
+  data.tar.gz: '092e9456741b2b43516146756ba738f6997a5252ba03dff226bde042333b4bf4'
 SHA512:
-  metadata.gz: e3ee5356583c8450635e8296657860e7016a8dfe0214fb2518da72aa2631e7511672802e326553bd44b3de1dea7e683a0784ff58770c641dae76ab9bca86e317
-  data.tar.gz: d7426a0450fbfaf871c8083aa4d06b1a1bf439436ed964cfb8e2325e832a05b479b1f81ae71c2b3b103c614a02b7eb23ddfc4ac6311f14b7e161a54893bb040b
+  metadata.gz: 05aea1fff55d3a96596dc54de49db457ffe4fac87677bc9dada1d8af4ec6f45397b586207a0e8214fbbedbeed42f58a4fe92934a6095a610c834332632c1901a
+  data.tar.gz: ed6ab4c13e2aa0f406de8f4eff041f4fdb39ba37430902284994eb7ed303352bb4a1b459416a73fd049196646eed95bd332721a7f9b9f6da8dcf6a119fdb25e2

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 1.21.0 (2023-02-08)
+
+* Add `Configuration#tab_width`
+* Add `Instance#add_leading_spaces`
+
+## 1.20.0 (2023-02-08)
+
+* Add `Configuration#single_quote`
+* Add `Instance#wrap_with_quotes`
+
 ## 1.19.0 (2023-02-06)
 
 * Remove `Instance#query_adapter`

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.19.0)
+    synvert-core (1.21.0)
       activesupport (< 7.0.0)
       erubis
-      node_mutation (>= 1.8.2)
+      node_mutation (>= 1.9.0)
       node_query (>= 1.12.0)
       parallel
       parser
@@ -50,7 +50,7 @@ GEM
     method_source (1.0.0)
     minitest (5.17.0)
     nenv (0.3.0)
-    node_mutation (1.8.2)
+    node_mutation (1.9.0)
       erubis
     node_query (1.12.0)
     notiffany (0.1.3)

data/README.md

@@ -101,6 +101,12 @@ Actions:
 * [noop](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#noop-instance_method) - no operation
 * [add_action](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#add_action-instance_method) - add custom action
 
+Others:
+
+* [wrap_with_quotes](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#wrap_with_quotes-instance_method) - wrap string code with single or doulbe quotes
+* [add_leading_spaces](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#add_leading_spaces-instance_method) - add leading spaces before the string code
+
+
 Attributes:
 
 * [file_path](https://xinminlabs.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#file_path-instance_method) - current file path

data/lib/synvert/core/configuration.rb

@@ -9,7 +9,9 @@ module Synvert::Core
       # @!attribute [w] only_paths
       # @!attribute [w] show_run_process
       # @!attribute [w] number_of_workers
-      attr_writer :root_path, :skip_paths, :only_paths, :show_run_process, :number_of_workers
+      # @!attribute [w] single_quote
+      # @!attribute [w] tab_width
+      attr_writer :root_path, :skip_paths, :only_paths, :show_run_process, :number_of_workers, :single_quote, :tab_width
 
       # Get the path.
       #
@@ -45,6 +47,17 @@ module Synvert::Core
       def number_of_workers
         @number_of_workers || 1
       end
+
+      # Use single quote or double quote.
+      #
+      # @return [Boolean] true if use single quote, default is true
+      def single_quote
+        @single_quote.nil? ? true : @single_quote
+      end
+
+      def tab_width
+        @tab_width || 2
+      end
     end
   end
 end

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

@@ -22,7 +22,7 @@ module Synvert::Core
       if rewriter.options[:strategy] == Strategy::ALLOW_INSERT_AT_SAME_POSITION
         strategy |=  NodeMutation::Strategy::ALLOW_INSERT_AT_SAME_POSITION
       end
-      NodeMutation.configure({ strategy: strategy })
+      NodeMutation.configure({ strategy: strategy, tab_width: Configuration.tab_width })
       rewriter.helpers.each { |helper| singleton_class.send(:define_method, helper[:name], &helper[:block]) }
     end
 
@@ -410,6 +410,26 @@ module Synvert::Core
       @rewriter.add_warning Rewriter::Warning.new(self, message)
     end
 
+    # Wrap str string with single or doulbe quotes based on Configuration.single_quote.
+    # @param str [String]
+    # @return [String] quoted string
+    def wrap_with_quotes(str)
+      quote = Configuration.single_quote ? "'" : '"';
+      another_quote = Configuration.single_quote ? '"' : "'";
+      if str.include?(quote) && !str.include?(another_quote)
+        return "#{another_quote}#{str}#{another_quote}"
+      end
+      escaped_str = str.gsub(quote) { |char| '\\' + quote }
+      quote + escaped_str + quote
+    end
+
+    # Add leading spaces before the str according to Configuration.tab_width.
+    # @param str [String]
+    # @return [String]
+    def add_leading_spaces(str)
+      " " * Configuration.tab_width + str;
+    end
+
     private
 
     # Read file source.

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.19.0'
+    VERSION = '1.21.0'
   end
 end

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

@@ -361,5 +361,44 @@ module Synvert::Core
         expect(instance.current_node).to eq node1
       end
     end
+
+    describe '#wrap_with_quotes' do
+      context 'Configuration.single_quote = true' do
+        it 'wraps with single quotes' do
+          expect(instance.wrap_with_quotes('foobar')).to eq "'foobar'"
+        end
+
+        it 'wraps with double quotes if it contains single quote' do
+          expect(instance.wrap_with_quotes("foo'bar")).to eq '"foo\'bar"'
+        end
+
+        it 'wraps with signle quotes and escapes single quote' do
+          expect(instance.wrap_with_quotes("foo'\"bar")).to eq "'foo\\'\"bar'"
+        end
+      end
+
+      context 'Configuration.single_quote = false' do
+        before { Configuration.single_quote = false }
+        after { Configuration.single_quote = true }
+
+        it 'wraps with double quotes' do
+          expect(instance.wrap_with_quotes('foobar')).to eq '"foobar"'
+        end
+
+        it 'wraps with single quotes if it contains double quote' do
+          expect(instance.wrap_with_quotes('foo"bar')).to eq "'foo\"bar'"
+        end
+
+        it 'wraps with double quotes and escapes double quote' do
+          expect(instance.wrap_with_quotes("foo'\"bar")).to eq '"foo\'\\"bar"'
+        end
+      end
+    end
+
+    describe '#add_leading_spaces' do
+      it 'adds leading spaces' do
+        expect(instance.add_leading_spaces('foo')).to eq '  foo';
+      end
+    end
   end
 end

data/synvert-core-ruby.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "activesupport", "< 7.0.0"
   spec.add_runtime_dependency "erubis"
   spec.add_runtime_dependency "node_query", ">= 1.12.0"
-  spec.add_runtime_dependency "node_mutation", ">= 1.8.2"
+  spec.add_runtime_dependency "node_mutation", ">= 1.9.0"
   spec.add_runtime_dependency "parser"
   spec.add_runtime_dependency "parser_node_ext", ">= 0.9.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.19.0
+  version: 1.21.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2023-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement