templatecop 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f45182757cc404cba39cb3bc1ab455fedfd4c0d66d2082279825015a6df89b3
-  data.tar.gz: 31d1044762cac8c8996f760b5c047c396538033a05a4c6ac8334f9afbaa73359
+  metadata.gz: cec282db3c407d288d9bba6ac5122424c5f52a14096046fb469918821bfbdbc4
+  data.tar.gz: f977c7d4134cd2fa82a2c6b35cba52a6cfaf58eb5a614f58f41224c25abe1b43
 SHA512:
-  metadata.gz: 13cad1ba40ae63a8604e66b64567f172e8f63e2094eb4d7baf4e3d43c708bcbcdfba35af46f67349666b8578a1bfba31126b82550c98ef54475fb9fafb923cd1
-  data.tar.gz: 0ee17fa0e595a9abcf0355bf3992db7ee6b90e10883718fd25bdd1e2f4065069affb349b9b9727ce6b680a31f207e6bcdd05d87f74028280a70024b3d4d0af97
+  metadata.gz: 25b20e224432836b15eec614aee67fa722ce3dca5a61642f8bba5b52607890db83b230d993a0ed48665427f9eb53a1f7f44a893a0b398fd868e56f0c24516903
+  data.tar.gz: 82b810eae2b1ed05b1d461f249fac065c2129d6f041561926919d8d0fd6d54760a958ea4b8f727c637d57ceba6742abbcf6a256d6cb1fed0219834687e983278

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Unreleased
 
+## 0.4.0 - 2023-01-10
+
+### Added
+
+- Add CLI switches for debug mode.
+- Add directory support for PathFinder.
+
+### Fixed
+
+- Add compatibility for RuboCop v1.38.0 and above.
+- Display correct label when autocorrecting.
+- Respect AllCops Exclude pattern.
+
 ## 0.3.0 - 2022-03-14
 
 ### Added

data/lib/templatecop/cli.rb

@@ -65,11 +65,13 @@ module Templatecop
       ).call
       file_paths = PathFinder.new(
         default_patterns: @default_path_patterns,
+        exclude_patterns: rubocop_config.for_all_cops['Exclude'],
         patterns: @argv
       ).call
 
       offenses = Runner.new(
-        auto_correct: options[:auto_correct],
+        autocorrect: options[:autocorrect],
+        debug: options[:debug],
         file_paths: file_paths,
         formatter: formatter,
         rubocop_config: rubocop_config,
@@ -88,7 +90,7 @@ module Templatecop
       parser.banner = "Usage: #{@executable_name} [options] [file1, file2, ...]"
       parser.version = VERSION
       parser.on('-a', '--auto-correct', 'Auto-correct offenses.') do
-        options[:auto_correct] = true
+        options[:autocorrect] = true
       end
       parser.on('-c', '--config=', "Specify configuration file. (default: #{@default_configuration_path} or .rubocop.yml)") do |file_path|
         options[:forced_configuration_path] = file_path
@@ -96,6 +98,9 @@ module Templatecop
       parser.on('--[no-]color', 'Force color output on or off.') do |value|
         options[:color] = value
       end
+      parser.on('-d', '--debug', 'Display debug info.') do |value|
+        options[:debug] = value
+      end
       parser.parse!(@argv)
       options
     end

data/lib/templatecop/path_finder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'pathname'
+require 'set'
 
 module Templatecop
   # Collect file paths from given path patterns.
@@ -9,29 +10,55 @@ module Templatecop
     # @param [Array<String>] patterns Patterns normally given as CLI arguments (e.g. `["app/views/**/*.html.template"]`).
     def initialize(
       default_patterns:,
+      exclude_patterns:,
       patterns:
     )
       @default_patterns = default_patterns
+      @exclude_patterns = exclude_patterns || []
       @patterns = patterns
     end
 
     # @return [Array<String>]
     def call
-      patterns.flat_map do |pattern|
-        ::Pathname.glob(pattern).select(&:file?).map do |pathname|
-          pathname.expand_path.to_s
-        end
-      end.uniq.sort
+      matching_paths(patterns) do |path|
+        !excluded?(path)
+      end.sort
     end
 
     private
 
+    # @return [Set<String>]
+    def excluded
+      @excluded ||= matching_paths(@exclude_patterns)
+    end
+
+    # @return [TrueClass,FalseClass]
+    def excluded?(path)
+      excluded.include?(path)
+    end
+
+    # @return [Set<String>]
+    def matching_paths(patterns, &block)
+      patterns.each_with_object(Set.new) do |pattern, set|
+        ::Pathname.glob(pattern) do |pathname|
+          next unless pathname.file?
+
+          path = pathname.expand_path.to_s
+          set.add(path) if block.nil? || block.call(path)
+        end
+      end
+    end
+
     # @return [Array<String>]
     def patterns
-      if @patterns.empty?
-        @default_patterns
-      else
-        @patterns
+      return @default_patterns if @patterns.empty?
+
+      @patterns.map do |pattern|
+        next pattern unless File.directory?(pattern)
+
+        @default_patterns.map do |default|
+          File.join(pattern, default)
+        end.flatten
       end
     end
   end

data/lib/templatecop/ruby_offense_collector.rb

@@ -5,12 +5,20 @@ require 'rubocop'
 module Templatecop
   # Collect RuboCop offenses from Ruby code.
   class RubyOffenseCollector
-    # @param [Boolean] auto_correct
+    # @param [Boolean] autocorrect
+    # @param [Boolean] debug
     # @param [String] file_path
     # @param [RuboCop::Config] rubocop_config
     # @param [String] source
-    def initialize(auto_correct:, file_path:, rubocop_config:, source:)
-      @auto_correct = auto_correct
+    def initialize(
+      autocorrect:,
+      file_path:,
+      rubocop_config:,
+      source:,
+      debug: false
+    )
+      @autocorrect = autocorrect
+      @debug = debug
       @file_path = file_path
       @rubocop_config = rubocop_config
       @source = source
@@ -26,21 +34,39 @@ module Templatecop
 
     private
 
+    # @return [RuboCop::Cop::Registry]
+    def registry
+      @registry ||= begin
+        all_cops = if ::RuboCop::Cop::Registry.respond_to?(:all)
+                     ::RuboCop::Cop::Registry.all
+                   else
+                     ::RuboCop::Cop::Cop.all
+                   end
+
+        ::RuboCop::Cop::Registry.new(all_cops)
+      end
+    end
+
     # @return [RuboCop::ProcessedSource]
     def rubocop_processed_source
       @rubocop_processed_source ||= ::RuboCop::ProcessedSource.new(
         @source,
         @rubocop_config.target_ruby_version,
         @file_path
-      )
+      ).tap do |processed_source|
+        processed_source.config = @rubocop_config if processed_source.respond_to?(:config)
+        processed_source.registry = registry if processed_source.respond_to?(:registry)
+      end
     end
 
     # @return [RuboCop::Cop::Team]
     def rubocop_team
       ::RuboCop::Cop::Team.new(
-        ::RuboCop::Cop::Registry.new(::RuboCop::Cop::Cop.all),
+        registry,
         @rubocop_config,
-        auto_correct: @auto_correct,
+        auto_correct: @autocorrect, # DEPRECATED
+        autocorrect: @autocorrect,
+        debug: @debug,
         display_cop_names: true,
         extra_details: true,
         stdin: ''

data/lib/templatecop/runner.rb

@@ -4,21 +4,24 @@ require 'parallel'
 require 'stringio'
 
 module Templatecop
-  # Run investigation and auto-correcttion.
+  # Run investigation and auto-correction.
   class Runner
-    # @param [Boolean] auto_correct
+    # @param [Boolean] autocorrect
+    # @param [Boolean] debug
     # @param [Array<String>] file_paths
     # @param [Object] formatter
     # @param [RuboCop::Config] rubocop_config
     # @param [#call] ruby_extractor
     def initialize(
-      auto_correct:,
+      autocorrect:,
       file_paths:,
       formatter:,
       rubocop_config:,
-      ruby_extractor:
+      ruby_extractor:,
+      debug: false
     )
-      @auto_correct = auto_correct
+      @autocorrect = autocorrect
+      @debug = debug
       @file_paths = file_paths
       @formatter = formatter
       @rubocop_config = rubocop_config
@@ -49,14 +52,22 @@ module Templatecop
       ::File.write(file_path, rewritten_source)
     end
 
-    # @param [Boolean] auto_correct
+    # @param [Boolean] autocorrect
+    # @param [Boolean] debug
     # @param [String] file_path
     # @param [String] rubocop_config
     # @param [String] source
     # @return [Array<Templatecop::Offense>]
-    def investigate(auto_correct:, file_path:, rubocop_config:, source:)
+    def investigate(
+      autocorrect:,
+      debug:,
+      file_path:,
+      rubocop_config:,
+      source:
+    )
       TemplateOffenseCollector.new(
-        auto_correct: auto_correct,
+        autocorrect: autocorrect,
+        debug: debug,
         file_path: file_path,
         rubocop_config: rubocop_config,
         ruby_extractor: @ruby_extractor,
@@ -72,7 +83,8 @@ module Templatecop
           on_file_started(file_path)
           source = ::File.read(file_path)
           offenses = investigate(
-            auto_correct: @auto_correct,
+            autocorrect: @autocorrect,
+            debug: @debug,
             file_path: file_path,
             rubocop_config: @rubocop_config,
             source: source
@@ -80,7 +92,7 @@ module Templatecop
           offenses_per_file |= offenses
           break if offenses.select(&:correctable?).empty?
 
-          next unless @auto_correct
+          next unless @autocorrect
 
           correct(
             file_path: file_path,
@@ -95,7 +107,7 @@ module Templatecop
 
     # @return [Integer]
     def max_trials_count
-      if @auto_correct
+      if @autocorrect
         7 # What a heuristic number.
       else
         1

data/lib/templatecop/template_offense_collector.rb

@@ -3,19 +3,22 @@
 module Templatecop
   # Collect RuboCop offenses from Template code.
   class TemplateOffenseCollector
-    # @param [Boolean] auto_correct
+    # @param [Boolean] autocorrect
+    # @param [Boolean] debug
     # @param [String] file_path Template file path
     # @param [RuboCop::Config] rubocop_config
     # @param [#call] ruby_extractor
     # @param [String] source Template code
     def initialize(
-      auto_correct:,
+      autocorrect:,
+      debug:,
       file_path:,
       rubocop_config:,
       ruby_extractor:,
       source:
     )
-      @auto_correct = auto_correct
+      @autocorrect = autocorrect
+      @debug = debug
       @file_path = file_path
       @rubocop_config = rubocop_config
       @ruby_extractor = ruby_extractor
@@ -26,7 +29,8 @@ module Templatecop
     def call
       snippets.flat_map do |snippet|
         RubyOffenseCollector.new(
-          auto_correct: @auto_correct,
+          autocorrect: @autocorrect,
+          debug: @debug,
           file_path: @file_path,
           rubocop_config: @rubocop_config,
           source: snippet[:code]

data/lib/templatecop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Templatecop
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: templatecop
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryo Nakamura
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-14 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.87'
-description: 
+description:
 email:
 - r7kamura@gmail.com
 executables: []
@@ -64,7 +64,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -88,7 +87,7 @@ metadata:
   source_code_uri: https://github.com/r7kamura/templatecop
   changelog_uri: https://github.com/r7kamura/templatecop/blob/mainCHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: RuboCop runner framework for template language.
 test_files: []

data/Gemfile.lock

@@ -1,72 +0,0 @@
-PATH
-  remote: .
-  specs:
-    templatecop (0.3.0)
-      parallel
-      parser
-      rubocop (>= 0.87)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.5.0)
-    parallel (1.21.0)
-    parser (3.1.0.0)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.2.0)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.24.1)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
-    rubocop-rspec (2.7.0)
-      rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
-    slimcop (0.13.1)
-      slimi (>= 0.5.1)
-      templatecop
-    slimi (0.7.1)
-      temple
-      thor
-      tilt
-    temple (0.8.2)
-    thor (1.2.1)
-    tilt (2.0.10)
-    unicode-display_width (2.1.0)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  rake
-  rspec
-  rubocop
-  rubocop-rspec
-  slimcop
-  templatecop!
-
-BUNDLED WITH
-   2.3.5