slimcop 0.9.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ddeb0d894aab7002ef81c70937513071636e1d048f5fd8e94300fd9af6c96a4
-  data.tar.gz: c12290288593975b5e2ca620fd023ada7b6c04d39c41dcbae8155f9f8245809f
+  metadata.gz: dd949a834535638a785282759fe46fb6fd368282d3030d17a113fa5253755bd7
+  data.tar.gz: 70be88bc581d8ba538879cffabcef3c58e21bbddda4ce8c7812c32e465ab5108
 SHA512:
-  metadata.gz: 02b791ca65f375995f387c08cb107c7d7d37791fdcfa6546cef9ae60869e00bd21bed8610bce6f5dad8b8641f48b1ab8528f29538ee2352af356a08d10cc7ae5
-  data.tar.gz: 7d58c62120d8fc325d339f5837d7d3f4ef9e72209ca106f2c3b5a9ce96f27d57f7a8b9fbd5da0e9292e479dcb2cb9459907189a9622f98d9d9f2cfd27666eca8
+  metadata.gz: 377b550717a43db56aefd5c66eb78622e2945c93436a45de5c50b8c9a61312a9d62d3e37d25108238788a5c08e0a4964dcc0401bd34531a620f02e62917091d3
+  data.tar.gz: db3cb5e5f9bf3ea5cf56d0a3e15bd430907721b2d33dd7d0e59bb2bd65e2d1fe78d8e51aee8ada603c8b92142694dc415921ce16e7e08e70633f918ef8ea830f

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## Unreleased
 
+## 0.12.0 - 2022-01-12
+
+### Changed
+
+- Keep trying auto-correction up to 7 times until no offense detected.
+
+## 0.11.0 - 2022-01-10
+
+### Changed
+
+- Detect offenses from code that containing `if`, `unless`, `do`, etc.
+
+## 0.10.0 - 2022-01-06
+
+### Added
+
+- Use .slimcop.yml as its 1st default config file.
+
+## 0.9.1 - 2022-01-04
+
+### Fixed
+
+- Fix $LOAD_PATH at ./exe/slimcop.
+
 ## 0.9.0 - 2022-01-02
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slimcop (0.9.0)
+    slimcop (0.12.0)
       rainbow
       rubocop (>= 0.87)
       slimi (>= 0.5.1)
@@ -45,10 +45,12 @@ GEM
     rubocop-rspec (2.6.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    slimi (0.5.1)
+    slimi (0.7.0)
       temple
+      thor
       tilt
     temple (0.8.2)
+    thor (1.2.1)
     tilt (2.0.10)
     unicode-display_width (2.1.0)
 

data/README.md

@@ -40,7 +40,7 @@ Usage: slimcop [options] [file1, file2, ...]
 ### Example
 
 ```console
-$ slimcop
+$ slimcop 'spec/fixtures/**/*.slim'
 Inspecting 1 file
 C
 

data/exe/slimcop

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'slimcop'
 
 Slimcop::Cli.new(ARGV).call

data/lib/slimcop/cli.rb

@@ -15,58 +15,18 @@ module Slimcop
       rubocop_config = RuboCopConfigGenerator.new(additional_config_file_path: options[:additional_config_file_path]).call
       file_paths = PathFinder.new(patterns: @argv).call
 
-      formatter.started(file_paths)
-      offenses = file_paths.flat_map do |file_path|
-        formatter.file_started(file_path, {})
-        source = ::File.read(file_path)
-        offenses_ = investigate(
-          auto_correct: options[:auto_correct],
-          file_path: file_path,
-          rubocop_config: rubocop_config,
-          source: source
-        )
-        if options[:auto_correct]
-          correct(
-            file_path: file_path,
-            offenses: offenses_,
-            source: source
-          )
-        end
-        formatter.file_finished(file_path, offenses_)
-        offenses_
-      end
-      formatter.finished(file_paths)
+      offenses = Runner.new(
+        auto_correct: options[:auto_correct],
+        file_paths: file_paths,
+        formatter: formatter,
+        rubocop_config: rubocop_config
+      ).call
+
       exit(offenses.empty? ? 0 : 1)
     end
 
     private
 
-    # @param [String] file_path
-    # @param [Array<Slimcop::Offense>] offenses
-    # @param [String] source
-    def correct(file_path:, offenses:, source:)
-      rewritten_source = SlimCorrector.new(
-        file_path: file_path,
-        offenses: offenses,
-        source: source
-      ).call
-      ::File.write(file_path, rewritten_source)
-    end
-
-    # @param [Boolean] auto_correct
-    # @param [String] file_path
-    # @param [String] rubocop_config
-    # @param [String] source
-    # @return [Array<Slimcop::Offense>]
-    def investigate(auto_correct:, file_path:, rubocop_config:, source:)
-      SlimOffenseCollector.new(
-        auto_correct: auto_correct,
-        file_path: file_path,
-        rubocop_config: rubocop_config,
-        source: source
-      ).call
-    end
-
     # @return [Hash]
     def parse!
       options = {}
@@ -76,7 +36,7 @@ module Slimcop
       parser.on('-a', '--auto-correct', 'Auto-correct offenses.') do
         options[:auto_correct] = true
       end
-      parser.on('-c', '--config=', 'Specify configuration file. (default: .rubocop.yml if it exists)') do |file_path|
+      parser.on('-c', '--config=', 'Specify configuration file. (default: .slimcop.yml or .rubocop.yml)') do |file_path|
         options[:additional_config_file_path] = file_path
       end
       parser.on('--[no-]color', 'Force color output on or off.') do |value|

data/lib/slimcop/rubo_cop_config_generator.rb

@@ -4,7 +4,8 @@ require 'rubocop'
 
 module Slimcop
   class RuboCopConfigGenerator
-    DEFAULT_ADDITIONAL_CONFIG_PATH = '.rubocop.yml'
+    DEFAULT_ADDITIONAL_CONFIG_PATH1 = '.slimcop.yml'
+    DEFAULT_ADDITIONAL_CONFIG_PATH2 = '.rubocop.yml'
 
     # @param [String] additional_config_file_path
     def initialize(additional_config_file_path: nil)
@@ -43,8 +44,10 @@ module Slimcop
         @additional_config = \
           if @additional_config_file_path
             ::RuboCop::ConfigLoader.load_file(@additional_config_file_path)
-          elsif ::File.exist?(DEFAULT_ADDITIONAL_CONFIG_PATH)
-            ::RuboCop::ConfigLoader.load_file(DEFAULT_ADDITIONAL_CONFIG_PATH)
+          elsif ::File.exist?(DEFAULT_ADDITIONAL_CONFIG_PATH1)
+            ::RuboCop::ConfigLoader.load_file(DEFAULT_ADDITIONAL_CONFIG_PATH1)
+          elsif ::File.exist?(DEFAULT_ADDITIONAL_CONFIG_PATH2)
+            ::RuboCop::ConfigLoader.load_file(DEFAULT_ADDITIONAL_CONFIG_PATH2)
           end
       end
     end

data/lib/slimcop/ruby_clipper.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Slimcop
+  # Remove unnecessary part (e.g. `if`, `unless`, `do`, ...) from Ruby code.
+  class RubyClipper
+    # @param [String] code
+    def initialize(code)
+      @code = code
+    end
+
+    # @return [Hash]
+    def call
+      [
+        PrecedingKeywordRemover,
+        TrailingDoRemover
+      ].each_with_object(
+        code: @code,
+        offset: 0
+      ) do |klass, object|
+        result = klass.new(object[:code]).call
+        object[:code] = result[:code]
+        object[:offset] += result[:offset]
+      end
+    end
+
+    class PrecedingKeywordRemover
+      REGEXP = /
+        \A
+        (?:
+          begin
+          | case
+          | else
+          | elsif
+          | ensure
+          | if
+          | rescue
+          | unless
+          | until
+          | when
+          | while
+          | for[ \t]+\w+[ \t]+in
+        )
+        [ \t]
+      /x.freeze
+
+      # @param [String] code
+      def initialize(code)
+        @code = code
+      end
+
+      # @return [Hash]
+      def call
+        data = @code.match(REGEXP)
+        if data
+          offset = data[0].length
+          {
+            code: @code[offset..],
+            offset: offset
+          }
+        else
+          {
+            code: @code,
+            offset: 0
+          }
+        end
+      end
+    end
+
+    class TrailingDoRemover
+      REGEXP = /
+        [ \t]
+        do
+        [ \t]*
+        (\|[^|]*\|)?
+        [ \t]*
+        \Z
+      /x.freeze
+
+      # @param [String] code
+      def initialize(code)
+        @code = code
+      end
+
+      # @return [Hash]
+      def call
+        {
+          code: @code.sub(REGEXP, ''),
+          offset: 0
+        }
+      end
+    end
+  end
+end

data/lib/slimcop/ruby_extractor.rb

@@ -3,7 +3,7 @@
 require 'slimi'
 
 module Slimcop
-  # Extract codes from Slim source.
+  # Extract Ruby codes from Slim source.
   class RubyExtractor
     # @param [String, nil] file_path
     # @param [String] source
@@ -15,10 +15,10 @@ module Slimcop
     # @return [Array<Hash>]
     def call
       ranges.map do |(begin_, end_)|
+        clipped = RubyClipper.new(@source[begin_...end_]).call
         {
-          begin_: begin_,
-          code: @source[begin_...end_],
-          end_: end_
+          code: clipped[:code],
+          offset: begin_ + clipped[:offset]
         }
       end
     end

data/lib/slimcop/runner.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Slimcop
+  # Run investigation and auto-correcttion.
+  class Runner
+    # @param [Boolean] auto_correct
+    # @param [Array<String>] file_paths
+    # @param [Object] formatter
+    # @param [RuboCop::Config] rubocop_config
+    def initialize(
+      auto_correct:,
+      file_paths:,
+      formatter:,
+      rubocop_config:
+    )
+      @auto_correct = auto_correct
+      @file_paths = file_paths
+      @formatter = formatter
+      @rubocop_config = rubocop_config
+    end
+
+    # @return [Array<RuboCop::Cop::Offense>]
+    def call
+      on_started
+      offenses = investigate_and_correct
+      on_finished
+      offenses
+    end
+
+    private
+
+    # @param [String] file_path
+    # @param [Array<Slimcop::Offense>] offenses
+    # @param [String] source
+    def correct(file_path:, offenses:, source:)
+      rewritten_source = SlimCorrector.new(
+        file_path: file_path,
+        offenses: offenses,
+        source: source
+      ).call
+      ::File.write(file_path, rewritten_source)
+    end
+
+    # @param [Boolean] auto_correct
+    # @param [String] file_path
+    # @param [String] rubocop_config
+    # @param [String] source
+    # @return [Array<Slimcop::Offense>]
+    def investigate(auto_correct:, file_path:, rubocop_config:, source:)
+      SlimOffenseCollector.new(
+        auto_correct: auto_correct,
+        file_path: file_path,
+        rubocop_config: rubocop_config,
+        source: source
+      ).call
+    end
+
+    # @return [Array<RuboCop::Cop::Offense>]
+    def investigate_and_correct
+      @file_paths.flat_map do |file_path|
+        offenses_per_file = []
+        max_trials_count.times do
+          on_file_started(file_path)
+          source = ::File.read(file_path)
+          offenses = investigate(
+            auto_correct: @auto_correct,
+            file_path: file_path,
+            rubocop_config: @rubocop_config,
+            source: source
+          )
+          offenses_per_file += offenses
+          break if offenses.empty?
+
+          next unless @auto_correct
+
+          correct(
+            file_path: file_path,
+            offenses: offenses,
+            source: source
+          )
+        end
+        on_file_finished(file_path, offenses_per_file)
+        offenses_per_file
+      end
+    end
+
+    # @return [Integer]
+    def max_trials_count
+      if @auto_correct
+        7 # What a heuristic number.
+      else
+        1
+      end
+    end
+
+    def on_started
+      @formatter.started(@file_paths)
+    end
+
+    # @param [String] file_path
+    def on_file_started(file_path)
+      @formatter.file_started(file_path, {})
+    end
+
+    # @param [String] file_path
+    # @param [Array<RuboCop::Cop::Offenses]
+    def on_file_finished(file_path, offenses)
+      @formatter.file_finished(file_path, offenses)
+    end
+
+    def on_finished
+      @formatter.finished(@file_paths)
+    end
+  end
+end

data/lib/slimcop/slim_offense_collector.rb

@@ -25,7 +25,7 @@ module Slimcop
         ).call.map do |rubocop_offense|
           Offense.new(
             file_path: @file_path,
-            offset: snippet[:begin_],
+            offset: snippet[:offset],
             rubocop_offense: rubocop_offense,
             source: @source
           )

data/lib/slimcop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Slimcop
-  VERSION = '0.9.0'
+  VERSION = '0.12.0'
 end

data/lib/slimcop.rb

@@ -7,8 +7,10 @@ module Slimcop
   autoload :Offense, 'slimcop/offense'
   autoload :PathFinder, 'slimcop/path_finder'
   autoload :RuboCopConfigGenerator, 'slimcop/rubo_cop_config_generator'
+  autoload :RubyClipper, 'slimcop/ruby_clipper'
   autoload :RubyExtractor, 'slimcop/ruby_extractor'
   autoload :RubyOffenseCollector, 'slimcop/ruby_offense_collector'
+  autoload :Runner, 'slimcop/runner'
   autoload :SlimCorrector, 'slimcop/slim_corrector'
   autoload :SlimOffenseCollector, 'slimcop/slim_offense_collector'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimcop
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-02 00:00:00.000000000 Z
+date: 2022-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -78,8 +78,10 @@ files:
 - lib/slimcop/offense.rb
 - lib/slimcop/path_finder.rb
 - lib/slimcop/rubo_cop_config_generator.rb
+- lib/slimcop/ruby_clipper.rb
 - lib/slimcop/ruby_extractor.rb
 - lib/slimcop/ruby_offense_collector.rb
+- lib/slimcop/runner.rb
 - lib/slimcop/slim_corrector.rb
 - lib/slimcop/slim_offense_collector.rb
 - lib/slimcop/version.rb