synvert-core 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a431b26d98c476c389746269aade183f241a3c1cb2fabab27b87b2b0689510f
-  data.tar.gz: 61b1907dbadbef95ca5d8869b6c27f65e43f72dccd0f64ead4ad3cf15a5f9c01
+  metadata.gz: d0e41ca1ed27bdc4a8e85f022cab4f220970746e950507c51ca5634dcb0c2f5c
+  data.tar.gz: bc61e33e6bf1282befa1f6b67944e372d7ba309c4f47b907b6f64fd5fb677a94
 SHA512:
-  metadata.gz: e3ee5356583c8450635e8296657860e7016a8dfe0214fb2518da72aa2631e7511672802e326553bd44b3de1dea7e683a0784ff58770c641dae76ab9bca86e317
-  data.tar.gz: d7426a0450fbfaf871c8083aa4d06b1a1bf439436ed964cfb8e2325e832a05b479b1f81ae71c2b3b103c614a02b7eb23ddfc4ac6311f14b7e161a54893bb040b
+  metadata.gz: a1dd19db1a689441e0443c524deb067d8bd6454ae0226f3163180b74fa4633bafb27b97d48c1c7506ff114c96fb40ae94beea6d7ed65740d6eeafaef1bd65cc4
+  data.tar.gz: bffc0742e22250091392cf453c71e1901920f5f4d8df3cf8d71ae373c351e41c620a2bf62ec3a72f0aac8d6d6f96ef043c81b577f201244c51f52b9cf66de051

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.19.0)
+    synvert-core (1.20.0)
       activesupport (< 7.0.0)
       erubis
       node_mutation (>= 1.8.2)

data/README.md

@@ -101,6 +101,11 @@ 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
+
+
 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,8 @@ 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
+      attr_writer :root_path, :skip_paths, :only_paths, :show_run_process, :number_of_workers, :single_quote
 
       # Get the path.
       #
@@ -45,6 +46,13 @@ 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
     end
   end
 end

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

@@ -410,6 +410,19 @@ 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
+
     private
 
     # Read file source.

data/lib/synvert/core/version.rb

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

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

@@ -361,5 +361,38 @@ 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
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.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