synvert-core 1.32.1 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3c2e2aa7e3cb3eb9d99c5e2a17a92dafc5e0fe6772329e96fb6a80483a5abf5
-  data.tar.gz: 92df973552a4554bb59d9d56296cca6fe8e57a3dabd1d424b3344fa10f20651c
+  metadata.gz: 279c659ed3a5da5cda7a67c95ef3cc74601d2f64d7dc70ae29431ef8ec4a9929
+  data.tar.gz: 65caaa8ccc16f8789137b8269ad5ec45c6fe1c9d9198dc0b940b09ad3e3e06cd
 SHA512:
-  metadata.gz: 98be499a994210b2ccbd76d73b6d97a2fd9ea46724aef6d329694662e84186c4cf9ecb7beac15102d27881c5db4337fd8f485b54aff012a6e3eebcedc19c9766
-  data.tar.gz: 1e2cf1d95019f79ac85e2344f00ef37aac814a2eaec3fbf508c962050d1cc2e64d9d553be4126688fb44978fae680c73de5b050e4f4fc78919fd28942cf4b011
+  metadata.gz: f45bf64e55621191bfe3a17c689d337d0b25fd356217dd8965876540514bb4b5d04cabb25a834b0567dfba538c93095b12ba281cc02c90a596ec34f8b3dc9231
+  data.tar.gz: 45c5c88b22be8e616cda46e518ee304333d3a8973f58b174182950eef2b958b16ed880311085cf63dc022fe79f8ec3e45fab3a32d23891db829dc5ba8066e075

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.33.0 (2024-02-18)
+
+* Add `Configuration.respect_gitignore`
+* Glob files with `git check-ignore` if `Configuration.respect_gitignore` is true
+
 ## 1.32.1 (2024-02-17)
 
 * Update `node_mutation` to 1.23.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    synvert-core (1.32.1)
+    synvert-core (1.33.0)
       activesupport (< 7.0.0)
       node_mutation (>= 1.23.2)
       node_query (>= 1.15.1)

data/lib/synvert/core/configuration.rb

@@ -7,6 +7,7 @@ module Synvert::Core
       # @!attribute [w] root_path
       # @!attribute [w] skip_paths
       # @!attribute [w] only_paths
+      # @!attribute [w] respect_gitignore
       # @!attribute [w] show_run_process
       # @!attribute [w] number_of_workers
       # @!attribute [w] single_quote
@@ -16,6 +17,7 @@ module Synvert::Core
       attr_writer :root_path,
                   :skip_paths,
                   :only_paths,
+                  :respect_gitignore,
                   :show_run_process,
                   :number_of_workers,
                   :single_quote,
@@ -44,6 +46,13 @@ module Synvert::Core
         @only_paths || []
       end
 
+      # Check if respect .gitignore
+      #
+      # @return [Boolean] default is true
+      def respect_gitignore
+        @respect_gitignore.nil? ? true : @respect_gitignore
+      end
+
       # Check if show run process.
       #
       # @return [Boolean] default is false

data/lib/synvert/core/utils.rb

@@ -3,6 +3,7 @@
 require 'net/http'
 require 'uri'
 require 'open-uri'
+require 'open3'
 
 module Synvert::Core
   class Utils
@@ -35,11 +36,21 @@ module Synvert::Core
       # @return [Array<String>] file paths
       def glob(file_patterns)
         Dir.chdir(Configuration.root_path) do
-          all_files =
-            file_patterns.flat_map do |file_pattern|
-              Dir.glob(file_pattern)
+          all_files = file_patterns.flat_map { |pattern| Dir.glob(pattern) }
+          ignored_files = []
+
+          if Configuration.respect_gitignore
+            Open3.popen3('git check-ignore --stdin') do |stdin, stdout, stderr, wait_thr|
+              stdin.puts(all_files.join("\n"))
+              stdin.close
+
+              ignored_files = stdout.read.split("\n")
             end
-          filter_only_paths(all_files) - get_skip_files
+          end
+
+          filtered_files = filter_only_paths(all_files - ignored_files)
+
+          filtered_files -= get_explicitly_skipped_files
         end
       end
 
@@ -85,16 +96,16 @@ module Synvert::Core
       # Filter only paths with `Configuration.only_paths`.
       # @return [Array<String>] filtered file paths
       def filter_only_paths(all_files)
-        return all_files if Configuration.only_paths.size == 0
+        return all_files if Configuration.only_paths.empty?
 
         Configuration.only_paths.flat_map do |only_path|
           all_files.filter { |file_path| file_path.starts_with?(only_path) }
         end
       end
 
-      # Get skip files.
-      # @return [Array<String>] skip files
-      def get_skip_files
+      # Get skipped files.
+      # @return [Array<String>] skipped files
+      def get_explicitly_skipped_files
         Configuration.skip_paths.flat_map do |skip_path|
           if File.directory?(skip_path)
             Dir.glob(File.join(skip_path, "**/*"))

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = '1.32.1'
+    VERSION = '1.33.0'
   end
 end

data/spec/synvert/core/utils_spec.rb

@@ -58,16 +58,42 @@ module Synvert::Core
       before do
         Configuration.only_paths = []
         Configuration.skip_paths = []
+        Configuration.respect_gitignore = false
       end
 
-      it 'gets all files' do
-        expect(Dir).to receive(:glob).with('**/*.rb').and_return(
-          [
-            'app/models/post.rb',
-            'app/controllers/posts_controller.rb'
-          ]
-        )
-        expect(described_class.glob(['**/*.rb'])).to eq(['app/models/post.rb', 'app/controllers/posts_controller.rb'])
+      context 'Configuration.respect_gitignore is false' do
+        it 'gets all files' do
+          expect(Dir).to receive(:glob).with('**/*.rb').and_return(
+            [
+              'app/models/post.rb',
+              'app/controllers/posts_controller.rb'
+            ]
+          )
+          expect(described_class.glob(['**/*.rb'])).to eq(['app/models/post.rb', 'app/controllers/posts_controller.rb'])
+        end
+      end
+
+      context 'Configuration.respect_gitignore is true' do
+        before do
+          Configuration.respect_gitignore = true
+        end
+
+        it 'correctly filters out ignored files' do
+          file_patterns = ["**/*.rb"]
+          all_files = ["app/models/post.rb", "app/controllers/posts_controller.rb", "app/controllers/temp.tmp"]
+          not_ignored_files = ["app/models/post.rb", "app/controllers/posts_controller.rb"]
+          command_output = "app/controllers/temp.tmp\n"
+
+          allow(Open3).to receive(:popen3).with('git check-ignore --stdin').and_yield(
+            instance_double(IO, puts: nil, close: nil),
+            StringIO.new(command_output),
+            StringIO.new(''),
+            instance_double(Process::Waiter, value: instance_double(Process::Status, success?: true))
+          )
+          allow(Dir).to receive(:glob).and_return(all_files)
+
+          expect(described_class.glob(file_patterns)).to match_array(not_ignored_files)
+        end
       end
 
       it 'filters only paths' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 1.32.1
+  version: 1.33.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-17 00:00:00.000000000 Z
+date: 2024-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport