slimcop 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5970bfa12ccffdb04b26f3b827b8102e035cb95ddd7f6d2ad70f1ff53d240f
-  data.tar.gz: d293f0d5c72e0e96c21f515ed16c6f0dbe9bf0aae745e42cec20186e654922a0
+  metadata.gz: 03e13f6191b529e4c4b0ca6bc1fbbd6d1144eb029e62158ae04f43111f4dd96e
+  data.tar.gz: 4eb2dccd29708a5de535d9fb4971eb56084e3d45644fd9ad9f0731416ad22ec7
 SHA512:
-  metadata.gz: b2423cffaf849c867d335df2d3fec06645f5578aecc9597a9d218d5cc99989a86be664609b364c6092695ad391825ce9ff244387d3dd6d77710d5c820d02d5f1
-  data.tar.gz: 294f4adb1bc4e8198a2d0b6fb79b810561a57a90fb01ebcfdfe0d3d057278e67ca3c8f77c5063b1bbadb55c36e84b7363db4b39d3004de2d7884f1afcb5f6cca
+  metadata.gz: '09705a482591105427cf3bc97f6ba86ab317d78e845fb0ca91d677730fa7081b5466c54112449127d83dc350431aea1de288bfc67034e10045e47dfcda57a7b3'
+  data.tar.gz: '09384443d865bb4cd1edf7d44e0ee1eb84dcf6729910220b4cad9970eba1dd16b0cb00b26b40f5845223a61488097a5fd9b8c48f25c8e69349ba47d1739cea2c'

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+### 0.7.0 - 2021-12-28
+
+### Changed
+
+- Re-use RuboCop's progress formatter as our default formatter.
+
 ## 0.6.0 - 2021-12-28
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slimcop (0.6.0)
+    slimcop (0.7.0)
       rainbow
       rubocop (>= 0.87)
       slimi (>= 0.4)

data/README.md

@@ -33,16 +33,25 @@ Use `slimcop` executable to check offenses and auto-correct them.
 $ slimcop --help
 Usage: slimcop [options] [file1, file2, ...]
     -a, --auto-correct               Auto-correct offenses.
+    -c, --config=                    Specify configuration file.
         --[no-]color                 Force color output on or off.
 ```
 
 ### Example
 
 ```console
-$ slimcop spec/**/*.slim
+$ slimcop "**/*.slim"
+Inspecting 1 file
+C
 
 Offenses:
 
-spec/fixtures/dummy.slim:1:3 C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
-spec/fixtures/dummy.slim:3:5 C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
+spec/fixtures/dummy.slim:1:3: C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
+- "a"
+  ^^^
+spec/fixtures/dummy.slim:3:5: C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
+| #{"c"}
+    ^^^
+
+1 file inspected, 2 offenses detected, 2 offenses auto-correctable
 ```

data/lib/slimcop/cli.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require 'rainbow'
+require 'rubocop'
 
 module Slimcop
   class Cli
     def initialize(argv)
       @argv = argv.dup
-      @formatter = Formatter.new
+      @formatter = ::RuboCop::Formatter::ProgressFormatter.new($stdout)
     end
 
     def call
@@ -15,7 +16,9 @@ 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],
@@ -30,9 +33,10 @@ module Slimcop
             source: source
           )
         end
+        @formatter.file_finished(file_path, offenses_)
         offenses_
       end
-      report(offenses)
+      @formatter.finished(file_paths)
       exit(offenses.empty? ? 0 : 1)
     end
 
@@ -64,19 +68,6 @@ module Slimcop
       ).call
     end
 
-    # @param [Array<Slimcop::Offense>] offenses
-    def report(offenses)
-      result = +''
-      unless offenses.empty?
-        result << "\nOffenses:\n\n"
-        lines = offenses.map do |offense|
-          @formatter.format_offense(offense)
-        end
-        result << lines.join("\n")
-      end
-      puts(result)
-    end
-
     # @return [Hash]
     def parse!
       options = {}

data/lib/slimcop/offense.rb

@@ -1,17 +1,35 @@
 # frozen_string_literal: true
 
+require 'forwardable'
+
 require 'parser'
+require 'rubocop'
 
 module Slimcop
   class Offense
+    extend ::Forwardable
+
     # @return [String]
     attr_reader :file_path
 
     # @return [Integer]
     attr_reader :offset
 
-    # @return [RuboCop::Cop::Offense]
-    attr_reader :rubocop_offense
+    delegate(
+      %i[
+        column
+        column_length
+        correctable?
+        corrected_with_todo?
+        corrected?
+        corrector
+        highlighted_area
+        line
+        message
+        real_column
+        severity
+      ] => :rubocop_offense_with_real_location
+    )
 
     # @param [Integer] offset
     # @param [RuboCop::Cop::Offense] rubocop_offense
@@ -23,29 +41,13 @@ module Slimcop
       @source = source
     end
 
-    # @return [RuboCop::Cop::Corrector]
-    def corrector
-      @rubocop_offense.corrector
-    end
-
-    # @return [Integer]
-    def line
-      range.line
-    end
-
-    # @return [String]
-    def message
-      @rubocop_offense.message
-    end
-
-    # @return [Integer]
-    def real_column
-      range.column + 1
-    end
-
-    # @return [RuboCop::Cop::Severity]
-    def severity
-      @rubocop_offense.severity
+    # @return [Parser::Source::Range]
+    def location
+      @location ||= ::Parser::Source::Range.new(
+        buffer,
+        @rubocop_offense.location.begin_pos + @offset,
+        @rubocop_offense.location.end_pos + @offset
+      )
     end
 
     private
@@ -58,12 +60,15 @@ module Slimcop
       )
     end
 
-    # @return [Parser::Source::Range]
-    def range
-      @range ||= ::Parser::Source::Range.new(
-        buffer,
-        @rubocop_offense.location.begin_pos + @offset,
-        @rubocop_offense.location.end_pos + @offset
+    # @return [RuboCop::Cop::Offense]
+    def rubocop_offense_with_real_location
+      ::RuboCop::Cop::Offense.new(
+        @rubocop_offense.severity.name,
+        location,
+        @rubocop_offense.message,
+        @rubocop_offense.cop_name,
+        @rubocop_offense.status,
+        @rubocop_offense.corrector
       )
     end
   end

data/lib/slimcop/version.rb

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

data/lib/slimcop.rb

@@ -4,7 +4,6 @@ require_relative 'slimcop/version'
 
 module Slimcop
   autoload :Cli, 'slimcop/cli'
-  autoload :Formatter, 'slimcop/formatter'
   autoload :Offense, 'slimcop/offense'
   autoload :PathFinder, 'slimcop/path_finder'
   autoload :RuboCopConfigGenerator, 'slimcop/rubo_cop_config_generator'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimcop
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2021-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -75,7 +75,6 @@ files:
 - exe/slimcop
 - lib/slimcop.rb
 - lib/slimcop/cli.rb
-- lib/slimcop/formatter.rb
 - lib/slimcop/offense.rb
 - lib/slimcop/path_finder.rb
 - lib/slimcop/rubo_cop_config_generator.rb

data/lib/slimcop/formatter.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require 'optparse'
-require 'rainbow'
-
-module Slimcop
-  # Format String for CLI output.
-  class Formatter
-    COLOR_FOR_SEVERITY_CODE = {
-      convention: :yellow,
-      error: :red,
-      fatal: :red,
-      info: :gray,
-      refactor: :yellow,
-      warning: :magenta
-    }.freeze
-
-    # @param [Slimcop::Offense] offense
-    # @return [String]
-    def format_offense(offense)
-      format(
-        '%<path>s:%<line>d:%<column>d %<severity>s: %<message>s',
-        column: offense.real_column,
-        line: offense.line,
-        message: message(offense),
-        path: file_path(offense),
-        severity: severity(offense)
-      )
-    end
-
-    private
-
-    # @param [String] path e.g. "./spec/fixtures/dummy.slim"
-    # @return [String]
-    # @example "spec/fixtures/dummy.slim"
-    def canonicalize_path(path)
-      ::File.expand_path(path).delete_prefix("#{::Dir.pwd}/")
-    end
-
-    # @param [Slimcop::Offense] offense
-    # @return [String]
-    def file_path(offense)
-      Rainbow(canonicalize_path(offense.file_path)).cyan
-    end
-
-    # @param [Slimcop::Offense] offense
-    # @return [String]
-    def message(offense)
-      "#{status(offense)}#{offense.message}"
-    end
-
-    # @param [Slimcop::Offense] offense
-    # @return [String]
-    def severity(offense)
-      Rainbow(offense.severity.code).color(COLOR_FOR_SEVERITY_CODE[offense.severity.name])
-    end
-
-    # @param [Slimcop::Offense] offense
-    # @return [String]
-    def status(offense)
-      if offense.rubocop_offense.corrected_with_todo?
-        Rainbow('[Todo] ').green
-      elsif offense.rubocop_offense.corrected?
-        Rainbow('[Corrected] ').green
-      elsif offense.rubocop_offense.correctable?
-        Rainbow('[Correctable] ').yellow
-      else
-        ''
-      end
-    end
-  end
-end