synvert-core 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 666eb48f4d58bd41854a7f48e9aadf201321023f546b5682abe21e56ed80a204
-  data.tar.gz: b6a555693e36b13806d156761a7003e06a6be8104c6102fd11ac5e920a687dd2
+  metadata.gz: c9a0f5e143582d26ad70583fece58a3e99251a0bb00af3e2ec1815c8b7163454
+  data.tar.gz: 0e6e001dc795642ddfe0a245339f4632faeb8492f377cb0739c9d0d89b573fb0
 SHA512:
-  metadata.gz: 24b42ba9dd6ba2e16fc4218fbae4f333d8ac193fa4c58de8781836f4b3c7189a342a15088364071b52edf955365f0920bc4773d62f7d36e88c69b50e03f6df60
-  data.tar.gz: '081411c60033db6c980fe7204e0e7dde12c7110a5839c545bb59943e3da3e881a0f505cc521284f6753e8f34d47319a9e1bc582126ea27cf82e4b696b170ce3f'
+  metadata.gz: d696b90c59582437c373ea536901c304ef2e63058cb600fd5d9bef731cf8ecc38e021799979174319ed22c1f1e888245f0a9034828953556e3ac09393b8b55af
+  data.tar.gz: bd3db282c2f08918279815aed52e80f8bde651f70f61f5b041094679f1092fac2fee65b92adffa58602b6738f0cd70b8bd2cc0f858c209073200cfd9950c3681

data/.vscode/settings.json

@@ -1,5 +1,21 @@
 {
   "cSpell.words": [
-    "synvert"
+    "asgn",
+    "autoindent",
+    "blockarg",
+    "casgn",
+    "csend",
+    "cvar",
+    "erange",
+    "fileutils",
+    "haml",
+    "ivar",
+    "lvar",
+    "mlhs",
+    "restarg",
+    "rvmrc",
+    "synvert",
+    "Yardoc",
+    "zsuper"
   ]
 }

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 2.1.0 (2024-06-24)
+
+* Remove `add_leading_spaces` method
+* Add `indent` and `dedent` helper methods
+
+## 2.0.3 (2024-06-16)
+
+* Fix `gem_spec_spec` test failures
+* Use `NodeMutation` to fetch file line
+
 ## 2.0.2 (2024-05-30)
 
 * Do not raise error for prism

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    synvert-core (2.0.2)
+    synvert-core (2.1.0)
       activesupport
       node_mutation (>= 1.24.4)
       node_query (>= 1.15.3)
@@ -17,7 +17,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.3)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -31,7 +31,7 @@ GEM
     base64 (0.2.0)
     bigdecimal (3.1.8)
     coderay (1.1.3)
-    concurrent-ruby (1.3.1)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     diff-lcs (1.5.1)
     drb (2.2.1)
@@ -59,7 +59,7 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.10)
     method_source (1.1.0)
-    minitest (5.23.1)
+    minitest (5.24.0)
     mutex_m (0.2.0)
     nenv (0.3.0)
     node_mutation (1.24.4)
@@ -68,14 +68,14 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.24.0)
-    parser (3.3.1.0)
+    parallel (1.25.1)
+    parser (3.3.3.0)
       ast (~> 2.4.1)
       racc
     parser_node_ext (1.3.2)
       parser
     prettier_print (1.2.1)
-    prism (0.29.0)
+    prism (0.30.0)
     prism_ext (0.3.2)
       prism
     pry (0.14.2)

data/README.md

@@ -97,7 +97,6 @@ Actions:
 
 * [append](https://synvert-hq.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://synvert-hq.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://synvert-hq.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#indent-instance_method) - indent code
 * [insert](https://synvert-hq.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#insert-instance_method) - insert code
 * [insert_after](https://synvert-hq.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://synvert-hq.github.io/synvert-core-ruby/Synvert/Core/Rewriter/Instance.html#insert_before-instance_method) - insert the code previous to the current node

data/lib/synvert/core/configuration.rb

@@ -111,10 +111,11 @@ module Synvert::Core
       #     # Code to be executed with temporary configurations
       #   end
       def with_temporary_configurations(configurations, &block)
-        old_instance_variables = instance_variables.reduce({}) do |hash, var|
-          hash[var] = instance_variable_get(var)
-          hash
-        end
+        old_instance_variables =
+          instance_variables.reduce({}) do |hash, var|
+            hash[var] = instance_variable_get(var)
+            hash
+          end
 
         configurations.each do |variable, value|
           instance_variable_set("@#{variable}", value)

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

@@ -391,20 +391,6 @@ module Synvert::Core
       @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.
     def noop
       @current_mutation.noop(@current_node)
@@ -436,7 +422,8 @@ module Synvert::Core
     #   end
     # @param message [String] warning message.
     def warn(message)
-      @rewriter.add_warning Rewriter::Warning.new(self, message)
+      line = @current_mutation.adapter.get_start_loc(@current_node).line
+      @rewriter.add_warning Rewriter::Warning.new(@file_path, line, message)
     end
 
     # It adds a callback when visiting an ast node.
@@ -465,12 +452,22 @@ module Synvert::Core
       quote + escaped_str + quote
     end
 
-    # Add leading spaces before the str according to Configuration.tab_width.
-    # @param str [String]
-    # @param tab_size [Integer] tab size
-    # @return [String]
-    def add_leading_spaces(str, tab_size: 1)
-      (" " * Configuration.tab_width * tab_size) + str;
+    # Indents the given source code by the specified tab size.
+    #
+    # @param source [String] The source code to be indented.
+    # @param tab_size [Integer] The number of spaces per tab.
+    # @return [String] The indented source code.
+    def indent(source, tab_size: 1)
+      source.each_line.map { |line| (' ' * NodeMutation.tab_width * tab_size) + line }.join
+    end
+
+    # Dedents the given source code by removing leading spaces or tabs.
+    #
+    # @param source [String] The source code to dedent.
+    # @param tab_size [Integer] The number of spaces per tab (default is 1).
+    # @return [String] The dedented source code.
+    def dedent(source, tab_size: 1)
+      source.each_line.map { |line| line.sub(/^ {#{NodeMutation.tab_width * tab_size}}/, '') }.join
     end
 
     private

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

@@ -5,11 +5,12 @@ module Synvert::Core
   class Rewriter::Warning
     # Initialize a Warning.
     #
-    # @param instance [Synvert::Core::Rewriter::Instance]
+    # @param file_path [String] file path.
+    # @param line [Integer] file line.
     # @param message [String] warning message.
-    def initialize(instance, message)
-      @file_path = instance.file_path
-      @line = instance.current_node.loc.expression.line
+    def initialize(file_path, line, message)
+      @file_path = file_path
+      @line = line
       @message = message
     end
 

data/lib/synvert/core/rewriter.rb

@@ -201,7 +201,7 @@ module Synvert::Core
     # @option strategy [String] 'allow_insert_at_same_position'
     def configure(options)
       @options = @options.merge(options)
-      if options[:parser] && ![Synvert::PARSER_PARSER, Synvert::SYNTAX_TREE_PARSER, Synvert::PRISM_PARSER].include?(options[:parser])
+      if options[:parser] && !Synvert::ALL_PARSERS.include?(options[:parser])
         raise Errors::ParserNotSupported.new("Parser #{options[:parser]} not supported")
       end
     end

data/lib/synvert/core/utils.rb

@@ -40,7 +40,7 @@ module Synvert::Core
           ignored_files = []
 
           if Configuration.respect_gitignore
-            Open3.popen3('git check-ignore --stdin') do |stdin, stdout, stderr, wait_thr|
+            Open3.popen3('git check-ignore --stdin') do |stdin, stdout, _stderr, _wait_thr|
               stdin.puts(all_files.join("\n"))
               stdin.close
 

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '2.0.2'
+    VERSION = '2.1.0'
   end
 end

data/lib/synvert/core.rb

@@ -77,4 +77,5 @@ module Synvert
   PARSER_PARSER = 'parser'
   SYNTAX_TREE_PARSER = 'syntax_tree'
   PRISM_PARSER = 'prism'
+  ALL_PARSERS = [PARSER_PARSER, SYNTAX_TREE_PARSER, PRISM_PARSER].freeze
 end

data/spec/synvert/core/configuration_spec.rb

@@ -22,4 +22,4 @@ module Synvert::Core
       end
     end
   end
-end
+end

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

@@ -16,7 +16,17 @@ module Synvert::Core
           slop (3.4.7)
     EOS
     let(:lock_path) { File.absolute_path('./Gemfile.lock') }
-    before { allow(File).to receive(:exist?).with(File.join(ENV['HOME'], '.gem/specs')).and_return(false) }
+
+    before do
+      Configuration.root_path = File.dirname(lock_path)
+      allow(File).to receive(:exist?).with(File.join(ENV['HOME'])).and_return(true)
+      allow(File).to receive(:exist?).with(File.join(ENV['HOME'], '.gem')).and_return(false)
+      allow(File).to receive(:exist?).with(File.join(ENV['HOME'], '.gem/specs')).and_return(false)
+    end
+
+    after do
+      Configuration.root_path = nil
+    end
 
     it 'returns true if version in Gemfile.lock is greater than definition' do
       expect(File).to receive(:exist?).with(lock_path).and_return(true)

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

@@ -235,16 +235,6 @@ module Synvert::Core
       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
       instance.instance_variable_set(:@current_mutation, double)
       instance.current_node = double
@@ -260,14 +250,20 @@ module Synvert::Core
     end
 
     it 'parses warn' do
-      expect(Rewriter::Warning).to receive(:new).with(instance, 'foobar')
+      instance.instance_variable_set(:@file_path, 'app/test.rb')
+      expect(@current_mutation).to receive_message_chain(:adapter, :get_start_loc, :line).and_return(2)
+      expect(Rewriter::Warning).to receive(:new).with('app/test.rb', 2, 'foobar')
       instance.warn 'foobar'
     end
 
     it 'parsers add_callback' do
       instance.instance_variable_set(:@current_visitor, double)
       block = proc {}
-      expect(instance.instance_variable_get(:@current_visitor)).to receive(:add_callback).with(:class_node, at: 'start', &block)
+      expect(instance.instance_variable_get(:@current_visitor)).to receive(:add_callback).with(
+        :class_node,
+        at: 'start',
+        &block
+      )
       instance.add_callback(:class_node, at: 'start', &block)
     end
 
@@ -549,10 +545,6 @@ module Synvert::Core
           = form_for @post do |f|
           = form_for @post do |f|
         EOS
-        output = <<~EOS
-          = form_for post do |f|
-          = form_for post do |f|
-        EOS
         allow(File).to receive(:read).with('./app/views/posts/_form.html.haml', encoding: 'UTF-8').and_return(input)
         result = instance.test
         expect(result.file_path).to eq 'app/views/posts/_form.html.haml'
@@ -578,10 +570,6 @@ module Synvert::Core
           = form_for @post do |f|
           = form_for @post do |f|
         EOS
-        output = <<~EOS
-          = form_for post do |f|
-          = form_for post do |f|
-        EOS
         allow(File).to receive(:read).with('./app/views/posts/_form.html.slim', encoding: 'UTF-8').and_return(input)
         result = instance.test
         expect(result.file_path).to eq 'app/views/posts/_form.html.slim'
@@ -677,10 +665,19 @@ module Synvert::Core
       end
     end
 
-    describe '#add_leading_spaces' do
-      it 'adds leading spaces' do
-        expect(instance.add_leading_spaces('foo')).to eq '  foo';
-        expect(instance.add_leading_spaces('foo', tab_size: 2)).to eq '    foo';
+    describe '#indent' do
+      it 'adds white spaces' do
+        old_code = "def foo\n  bar\nend"
+        new_code = instance.indent(old_code, tab_size: 2)
+        expect(new_code).to eq "    def foo\n      bar\n    end"
+      end
+    end
+
+    describe '#dedent' do
+      it 'removes white spaces' do
+        old_code = "    def foo\n      bar\n    end"
+        new_code = instance.dedent(old_code, tab_size: 2)
+        expect(new_code).to eq "def foo\n  bar\nend"
       end
     end
   end

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

@@ -5,10 +5,7 @@ require 'spec_helper'
 module Synvert::Core
   describe Rewriter::Warning do
     subject {
-      source = "def test\n  debugger\nend"
-      send_node = Parser::CurrentRuby.parse(source).body.first
-      instance = double(current_node: send_node, file_path: 'app/test.rb')
-      Rewriter::Warning.new(instance, 'remove debugger')
+      Rewriter::Warning.new('app/test.rb', 2, 'remove debugger')
     }
 
     it 'gets message with filename and line number' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-30 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -249,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.13
 signing_key:
 specification_version: 4
 summary: convert ruby code to better syntax.