synvert-core 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d838da042cfdbc68e4a235117a465ca340fa732203f7470684a9279e6797fff
-  data.tar.gz: ad784c3e09faa73a55e0bf0ad51a982230d9a1b2a328c43414e4aa297e38a00e
+  metadata.gz: 00661750a3522a9983d5eec1f064f62bf0d335e05e3b2a9cb7bb7222b04e20a2
+  data.tar.gz: 5a35b831ca678486f4a51db2ae8a57bed58617299a0c26c9cbc0c462351ffd3d
 SHA512:
-  metadata.gz: 4b31e94f8071af04f1ae7b1292bb5af91e52ba047949535667cb6765a5ef32c9bbcf855dd92a212aa640b0185f42fbd1bbcf4614f424c596f9c52f62a313a643
-  data.tar.gz: 197318ccffd17c9eb60251731bf49f45198e2b5fb5812c22d4fe6d0d07bac94bff638bc5a125d05be2ccec930b16300ccdb83ffdd53bf8cf0c4cd8ad22a34c94
+  metadata.gz: b18bcf0f9f344c2c8661d7e4edf1a4f768d67175f45b34d2bb37b321f38681840c29b8e9a0fa61ee295329909f3093de4b7703e6dec21066190336ee8ceb1b5a
+  data.tar.gz: 0f334dc34d82d15235381f3a9be7651707b5a7a0e5614e29f48310407c70384ac6f1594f2b8643dc97577e0e55a4b6165f3174071e2887f424a76ed4d5f3b3cb

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 1.8.0 (2022-09-17)
+
+* Rename config `path` to `root_path`
+* Rename config `skip_files` to `skip_paths`
+* Add config `only_paths`
+* Change dir to `root_path`
+
+## 1.7.0 (2022-09-16)
+
+* Add `Rewriter#test`
+* Use option `run_instance` instead of `sandbox`
+
 ## 1.6.0 (2022-09-15)
 
 * Make use of `NodeQuery` to query nodes

data/Gemfile

@@ -5,6 +5,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in synvert.gemspec
 gemspec
 
+require 'pp' # https://github.com/defunkt/fakefs/issues/99
+gem "fakefs", require: "fakefs/safe"
 gem "guard"
 gem "guard-rspec"
 gem "rake"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.6.0)
+    synvert-core (1.8.0)
       activesupport (< 7.0.0)
       erubis
       node_mutation
@@ -23,6 +23,7 @@ GEM
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     erubis (2.7.0)
+    fakefs (1.8.0)
     ffi (1.15.5)
     formatador (1.1.0)
     guard (2.18.0)
@@ -48,10 +49,10 @@ GEM
     method_source (1.0.0)
     minitest (5.16.3)
     nenv (0.3.0)
-    node_mutation (1.2.1)
-      activesupport
+    node_mutation (1.3.3)
+      activesupport (< 7.0.0)
       erubis
-    node_query (1.5.0)
+    node_query (1.6.0)
       activesupport (< 7.0.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -90,6 +91,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  fakefs
   guard
   guard-rspec
   rake

data/lib/synvert/core/configuration.rb

@@ -4,23 +4,31 @@ module Synvert::Core
   # Synvert global configuration.
   class Configuration
     class << self
-      # @!attribute [w] path
-      # @!attribute [w] skip_files
+      # @!attribute [w] root_path
+      # @!attribute [w] skip_paths
+      # @!attribute [w] only_paths
       # @!attribute [w] show_run_process
-      attr_writer :path, :skip_files, :show_run_process
+      attr_writer :root_path, :skip_paths, :only_paths, :show_run_process
 
       # Get the path.
       #
       # @return [String] default is '.'
-      def path
-        @path || '.'
+      def root_path
+        @root_path || '.'
       end
 
-      # Get a list of skip files.
+      # Get a list of skip paths.
       #
       # @return [Array<String>] default is [].
-      def skip_files
-        @skip_files || []
+      def skip_paths
+        @skip_paths || []
+      end
+
+      # Get a list of only paths.
+      #
+      # @return [Array<String>] default is [].
+      def only_paths
+        @only_paths || []
       end
 
       # Check if show run process.

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

@@ -22,12 +22,12 @@ module Synvert::Core
     #
     # @return [Boolean] true if matches, otherwise false.
     def match?
-      gemfile_lock_path = File.expand_path(File.join(Configuration.path, 'Gemfile.lock'))
+      gemfile_lock_path = File.expand_path(File.join(Configuration.root_path, 'Gemfile.lock'))
 
       # if Gemfile.lock does not exist, just ignore this check
       return true unless File.exist?(gemfile_lock_path)
 
-      ENV['BUNDLE_GEMFILE'] = Configuration.path # make sure bundler reads Gemfile.lock in the correct path
+      ENV['BUNDLE_GEMFILE'] = Configuration.root_path # make sure bundler reads Gemfile.lock in the correct path
       parser = Bundler::LockfileParser.new(File.read(gemfile_lock_path))
       parser.specs.any? { |spec| Gem::Dependency.new(@name, @version).match?(spec) }
     end

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

@@ -30,14 +30,19 @@ module Synvert::Core
 
     # Process the instance.
     # It finds specified files, for each file, it executes the block code, rewrites the original code,
-    # then write the code back to the original file.
+    # then writes the code back to the original file.
     def process
-      @file_patterns.each do |file_pattern|
-        Dir.glob(File.join(Configuration.path, file_pattern)).each do |file_path|
-          next if Configuration.skip_files.include?(file_path)
+      get_file_paths.each do |file_path|
+        process_file(file_path)
+      end
+    end
 
-          process_file(file_path)
-        end
+    # Test the instance.
+    # It finds specified files, for each file, it executes the block code, tests the original code,
+    # then returns the actions.
+    def test
+      get_file_paths.each do |file_path|
+        test_file(file_path)
       end
     end
 
@@ -378,6 +383,67 @@ module Synvert::Core
       end
     end
 
+    # Test one file.
+    #
+    # @param file_path [String]
+    def test_file(file_path)
+      @current_file = file_path
+      source = read_source(file_path)
+      @current_mutation = NodeMutation.new(source)
+      begin
+        node = parse_code(file_path, source)
+
+        process_with_node(node) do
+          instance_eval(&@block)
+        rescue NoMethodError => e
+          puts [
+            "error: #{e.message}",
+            "file: #{file_path}",
+            "source: #{source}",
+            "line: #{current_node.line}"
+          ].join("\n")
+          raise
+        end
+
+        result = @current_mutation.test
+        result.file_path = file_path
+        result
+      rescue Parser::SyntaxError
+        puts "[Warn] file #{file_path} was not parsed correctly."
+        # do nothing, iterate next file
+      end
+    end
+
+    # Get file paths.
+    # @return [Array<String>] file paths
+    def get_file_paths
+      Dir.chdir(Configuration.root_path) do
+        only_paths = Configuration.only_paths.size > 0 ? Configuration.only_paths : ["."]
+        only_paths.flat_map do |only_path|
+          @file_patterns.flat_map do |file_pattern|
+            pattern = only_path == "." ? file_pattern : File.join(only_path, file_pattern)
+            Dir.glob(pattern) - get_skip_files
+          end
+        end
+      end
+    end
+
+    # Get skip files.
+    # @return [Array<String>] skip files
+    def get_skip_files
+      @skip_files ||= Configuration.skip_paths.flat_map do |skip_path|
+        if File.directory?(skip_path)
+          Dir.glob(File.join(skip_path, "**/*"))
+        elsif File.file?(skip_path)
+          [skip_path]
+        elsif skip_path.end_with?("**") || skip_path.end_with?("**/")
+          Dir.glob(File.join(skip_path, "*"))
+        else
+          Dir.glob(skip_path)
+        end
+      end
+    end
+
     # Read file source.
     # @param file_path [String] file path
     # @return [String] file source

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

@@ -16,14 +16,14 @@ module Synvert::Core
     #
     # @return [Boolean] true if matches, otherwise false.
     def match?
-      if File.exist?(File.join(Configuration.path, '.ruby-version'))
+      if File.exist?(File.join(Configuration.root_path, '.ruby-version'))
         version_file = '.ruby-version'
-      elsif File.exist?(File.join(Configuration.path, '.rvmrc'))
+      elsif File.exist?(File.join(Configuration.root_path, '.rvmrc'))
         version_file = '.rvmrc'
       end
       return true unless version_file
 
-      version = File.read(File.join(Configuration.path, version_file))
+      version = File.read(File.join(Configuration.root_path, version_file))
       Gem::Version.new(version) >= Gem::Version.new(@version)
     end
   end

data/lib/synvert/core/rewriter.rb

@@ -72,15 +72,16 @@ module Synvert::Core
       #
       # @param group [String] the rewriter group.
       # @param name [String] the rewriter name.
-      # @param sandbox [Boolean] if run in sandbox mode.
+      # @param options [Hash]
+      # @option options [Boolean] :run_instance (true) process the instance.
       # @return [Synvert::Core::Rewriter] the registered rewriter.
       # @raise [Synvert::Core::RewriterNotFound] if the registered rewriter is not found.
-      def call(group, name, sandbox = false)
+      def call(group, name, options = { run_instance: true })
         rewriter = fetch(group, name)
-        if sandbox
-          rewriter.process_with_sandbox
-        else
+        if options[:run_instance]
           rewriter.process
+        else
+          rewriter.process_with_sandbox
         end
         rewriter
       end
@@ -137,6 +138,8 @@ module Synvert::Core
       @warnings = []
       @affected_files = Set.new
       @redo_until_no_change = false
+      @options = { run_instance: true, write_to_file: true }
+      @test_results = []
       self.class.register(@group, @name, self)
     end
 
@@ -152,14 +155,29 @@ module Synvert::Core
     # Process rewriter with sandbox mode.
     # It will call the block but doesn't change any file.
     def process_with_sandbox
-      @sandbox = true
+      @options[:run_instance] = false
       begin
         process
       ensure
-        @sandbox = false
+        @options[:run_instance] = true
       end
     end
 
+    def test
+      @options[:write_to_file] = false
+      begin
+        @affected_files = Set.new
+        instance_eval(&@block)
+
+        if !@affected_files.empty? && @redo_until_no_change # redo
+          test
+        end
+      ensure
+        @options[:write_to_file] = true
+      end
+      @test_results
+    end
+
     # Add a warning.
     #
     # @param warning [Synvert::Core::Rewriter::Warning]
@@ -225,12 +243,18 @@ module Synvert::Core
     # @param file_patterns [String|Array<String>] string pattern or list of string pattern to find files, e.g. ['spec/**/*_spec.rb']
     # @param block [Block] the block to rewrite code in the matching files.
     def within_files(file_patterns, &block)
-      return if @sandbox
+      return unless @options[:run_instance]
 
       return if @ruby_version && !@ruby_version.match?
       return if @gem_spec && !@gem_spec.match?
 
-      Rewriter::Instance.new(self, Array(file_patterns), &block).process
+      instance = Rewriter::Instance.new(self, Array(file_patterns), &block)
+      if @options[:write_to_file]
+        instance.process
+      else
+        results = instance.test
+        @test_results += results.select { |result| result.affected? }
+      end
     end
 
     # Parse +within_file+ dsl, it finds a specifiled file.
@@ -248,9 +272,9 @@ module Synvert::Core
     # @param filename [String] file name of newly created file.
     # @param content [String] file body of newly created file.
     def add_file(filename, content)
-      return if @sandbox
+      return unless @options[:run_instance]
 
-      filepath = File.join(Configuration.path, filename)
+      filepath = File.join(Configuration.root_path, filename)
       if File.exist?(filepath)
         puts "File #{filepath} already exists."
         return
@@ -267,9 +291,9 @@ module Synvert::Core
     #   end
     # @param filename [String] file name.
     def remove_file(filename)
-      return if @sandbox
+      return unless @options[:run_instance]
 
-      file_path = File.join(Configuration.path, filename)
+      file_path = File.join(Configuration.root_path, filename)
       File.delete(file_path) if File.exist?(file_path)
     end
 
@@ -293,7 +317,7 @@ module Synvert::Core
     # @param group [String] group of another rewriter.
     # @param name [String] name of another rewriter.
     def add_snippet(group, name)
-      @sub_snippets << self.class.call(group.to_s, name.to_s, @sandbox)
+      @sub_snippets << self.class.call(group.to_s, name.to_s, @options)
     end
 
     # Parse +helper_method+ dsl, it defines helper method for {Synvert::Core::Rewriter::Instance}.

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.6.0'
+    VERSION = '1.8.0'
   end
 end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'synvert/core'
+require 'fakefs/spec_helpers'
 
 Dir[File.join(File.dirname(__FILE__), 'support', '*')].each do |path|
   require path
@@ -10,6 +11,7 @@ end
 
 RSpec.configure do |config|
   config.include ParserHelper
+  config.include FakeFS::SpecHelpers, fakefs: true
 
   config.run_all_when_everything_filtered = true
   config.filter_run :focus

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

@@ -267,6 +267,55 @@ module Synvert::Core
       end
     end
 
+    describe '#test' do
+      let(:rewriter) { Rewriter.new('foo', 'bar') }
+
+      it 'writes new code to file' do
+        instance =
+          Rewriter::Instance.new rewriter, ['spec/**/*_spec.rb'] do
+            with_node type: 'send', receiver: 'FactoryGirl', message: 'create' do
+              replace_with 'create {{arguments}}'
+            end
+          end
+        input = <<~EOS
+          it 'uses factory_girl' do
+            user = FactoryGirl.create :user
+            post = FactoryGirl.create :post, user: user
+            assert post.valid?
+          end
+        EOS
+        expect(Dir).to receive(:glob).with('./spec/**/*_spec.rb').and_return(['spec/models/post_spec.rb'])
+        expect(File).to receive(:read).with('spec/models/post_spec.rb', encoding: 'UTF-8').and_return(input)
+        results = instance.test
+        expect(results[0].file_path).to eq 'spec/models/post_spec.rb'
+        expect(results[0].actions).to eq [
+          OpenStruct.new(start: 35, end: 59, new_code: 'create :user'),
+          OpenStruct.new(start: 69, end: 105, new_code: 'create :post, user: user')
+        ]
+      end
+
+      it 'does not write if file content is not changed' do
+        instance =
+          Rewriter::Instance.new rewriter, ['spec/spec_helper.rb'] do
+            with_node type: 'block', caller: { receiver: 'RSpec', message: 'configure' } do
+              unless_exist_node type: 'send', message: 'include', arguments: ['FactoryGirl::Syntax::Methods'] do
+                insert '{{arguments.first}}.include FactoryGirl::Syntax::Methods'
+              end
+            end
+          end
+        input = <<~EOS
+          RSpec.configure do |config|
+            config.include FactoryGirl::Syntax::Methods
+          end
+        EOS
+        expect(Dir).to receive(:glob).with('./spec/spec_helper.rb').and_return(['spec/spec_helper.rb'])
+        expect(File).to receive(:read).with('spec/spec_helper.rb', encoding: 'UTF-8').and_return(input)
+        result = instance.test
+        expect(result[0].file_path).to eq 'spec/spec_helper.rb'
+        expect(result[0].actions).to eq []
+      end
+    end
+
     describe '#process_with_node' do
       it 'resets current_node' do
         node1 = double

data/spec/synvert/core/rewriter_spec.rb

@@ -37,6 +37,46 @@ module Synvert::Core
       rewriter.process
     end
 
+    describe '#process' do
+      it 'rewrites the file' do
+        rewriter = Rewriter.new('group', 'name') do
+          within_files '**/*.rb' do
+            with_node node_type: 'class', name: 'Foobar' do
+              replace :name, with: 'Synvert'
+            end
+          end
+        end
+        input = "class Foobar\nend"
+        output = "class Synvert\nend"
+        FakeFS do
+          File.write("code.rb", input)
+          rewriter.process
+          expect(File.read("code.rb")).to eq output
+        end
+      end
+    end
+
+    describe '#test' do
+      it 'gets test results' do
+        rewriter = Rewriter.new('group', 'name') do
+          within_files '**/*.rb' do
+            with_node node_type: 'class', name: 'Foobar' do
+              replace :name, with: 'Synvert'
+            end
+          end
+        end
+        input = "class Foobar\nend"
+        FakeFS do
+          File.write("code.rb", input)
+          results = rewriter.test
+          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 [OpenStruct.new(start: 6, end: 12, new_code: 'Synvert')]
+        end
+      end
+    end
+
     describe 'parses within_file' do
       it 'does nothing if if_ruby does not match' do
         expect(File).to receive(:exist?).with('./.ruby-version').and_return(true)
@@ -245,7 +285,7 @@ module Synvert::Core
       it 'registers and calls rewriter in sandbox mode' do
         rewriter = Rewriter.new 'group', 'rewriter'
         expect(rewriter).to receive(:process_with_sandbox)
-        Rewriter.call 'group', 'rewriter', true
+        Rewriter.call 'group', 'rewriter', run_instance: false
       end
 
       it 'raises RewriterNotFound if rewriter not found' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-15 00:00:00.000000000 Z
+date: 2022-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport