slimcop 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294e38d0a479f35dc2d3c6c2c042af57645927ec17cc2b91b6e6c68107defd40
-  data.tar.gz: 5f65145f2f89a7fbae3341228bc5d3b2ac8c53c065748ed2dc2e86a1f49d8d95
+  metadata.gz: c8ddb3a3a507467e8a94efb06e67729026956faf788fae905c2520ddd2016d4d
+  data.tar.gz: 793d36ff3bfffbb5f4979996395f219fe301e5ab6cbd283a75cba389d2ef0b99
 SHA512:
-  metadata.gz: cd736f85dafc680f45a77ab81f791620909eda2c23523cf0d7ce4e999587c464946c14a77a2e1853cd4f14da26e9cd2fd17b444ef0d53e031ae38220adef9998
-  data.tar.gz: 840ee9ef8e7db1c8fb6590b36c157114784c51c20de7adad8a947fc4df305bb54b838fd63faadcbfafb52f715533effaaa95d5fd408a5be81fea546456dfaf95
+  metadata.gz: 80f8d52c2fc2a845ce0f06f58bdf943123e8253dd3834b504ee3dd3da8f30ddb55902ec9e30db041d6eae084617addcefd42b338a720f3300b5c05cf8af34f32
+  data.tar.gz: 1eef3d4bc19ad6824e6e70b98da9bb35b88cbf48e748a6bb8e00aa9bed21cedde553518ac7460098ef80ee5ac19ca6183973c89443896a22a4da4fc618ac30fb

data/CHANGELOG.md

@@ -2,12 +2,48 @@
 
 ## Unreleased
 
+## 0.8.0
+
+### Changed
+
+- Use .rubocop.yml by default.
+- Use "**/*.slim" by default.
+
+### Fixed
+
+- Fix bug that --no-color was not working.
+
+## 0.7.1 - 2021-12-29
+
+### Fixed
+
+- Exclude disabled offenses.
+- Uniq paths at PathFinder.
+
+## 0.7.0 - 2021-12-28
+
+### Changed
+
+- Re-use RuboCop's progress formatter as our default formatter.
+
+## 0.6.0 - 2021-12-28
+
+### Added
+
+- Add -c, --config CLI option to customize RuboCop config.
+
+### Changed
+
+- Not investigate all files then auto-correct them, but do it for each file.
+- Sort processed files in alphabetical order.
+- Disable Lint/UselessAssignment by default.
+
 ## 0.5.0 - 2021-12-27
 
 ### Changed
 
-- Ignore Lint/EmptyFile by default.
-- Ignore Style/RescueModifier by default.
+- Disable Lint/EmptyFile by default.
+- Disable Style/RescueModifier by default.
 
 ### Fixed
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slimcop (0.5.0)
+    slimcop (0.8.0)
       rainbow
       rubocop (>= 0.87)
       slimi (>= 0.4)
@@ -45,7 +45,7 @@ GEM
     rubocop-rspec (2.6.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    slimi (0.4.1)
+    slimi (0.4.2)
       temple
     temple (0.8.2)
     unicode-display_width (2.1.0)

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
+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/default.yml

@@ -79,6 +79,9 @@ Layout/TrailingEmptyLines:
 Layout/TrailingWhitespace:
   Enabled: false
 
+Lint/UselessAssignment:
+  Enabled: false
+
 Lint/Void:
   Enabled: false
 

data/lib/slimcop/cli.rb

@@ -1,69 +1,70 @@
 # frozen_string_literal: true
 
 require 'rainbow'
+require 'rubocop'
 
 module Slimcop
   class Cli
     def initialize(argv)
       @argv = argv.dup
-      @configuration = Configuration.new
-      @formatter = Formatter.new
     end
 
     def call
       options = parse!
-      slim_file_paths = PathFinder.new(patterns: @argv).call
+      formatter = ::RuboCop::Formatter::ProgressFormatter.new($stdout, color: options[:color])
+      rubocop_config = RuboCopConfigGenerator.new(additional_config_file_path: options[:additional_config_file_path]).call
+      file_paths = PathFinder.new(patterns: @argv).call
 
-      Rainbow.enabled = options[:color] if options.key?(:color)
-
-      offenses_set = investigate(auto_correct: options[:auto_correct], slim_file_paths: slim_file_paths)
-      correct(offenses_set) if options[:auto_correct]
-      offenses = offenses_set.flat_map { |(_, _, array)| array }
-      report(offenses)
+      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)
       exit(offenses.empty? ? 0 : 1)
     end
 
     private
 
-    # @param [Array] offenses_set
-    def correct(offenses_set)
-      offenses_set.each do |(file_path, source, offenses)|
-        rewritten_source = SlimCorrector.new(
-          file_path: file_path,
-          offenses: offenses,
-          source: source
-        ).call
-        ::File.write(file_path, rewritten_source)
-      end
+    # @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 [Array] slim_file_paths
-    # @return [Array]
-    def investigate(auto_correct:, slim_file_paths:)
-      slim_file_paths.map do |file_path|
-        source = ::File.read(file_path)
-        offenses = SlimOffenseCollector.new(
-          auto_correct: auto_correct,
-          file_path: file_path,
-          rubocop_config: @configuration.rubocop_config,
-          source: source
-        ).call
-        [file_path, source, offenses]
-      end
-    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)
+    # @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]
@@ -74,6 +75,9 @@ 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|
+        options[:additional_config_file_path] = file_path
+      end
       parser.on('--[no-]color', 'Force color output on or off.') do |value|
         options[:color] = value
       end

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/path_finder.rb

@@ -5,6 +5,10 @@ require 'pathname'
 module Slimcop
   # Collect file paths from given path patterns.
   class PathFinder
+    DEFAULT_PATH_PATTERNS = %w[
+      **/*.slim
+    ].freeze
+
     # @param [Array<String>] patterns Patterns normally given as CLI arguments (e.g. `["app/views/**/*.html.slim"]`).
     def initialize(patterns:)
       @patterns = patterns
@@ -12,8 +16,19 @@ module Slimcop
 
     # @return [Array<String>]
     def call
-      @patterns.flat_map do |pattern|
+      patterns.flat_map do |pattern|
         ::Pathname.glob(pattern).select(&:file?).map(&:to_s)
+      end.uniq.sort
+    end
+
+    private
+
+    # @return [Array<String>]
+    def patterns
+      if @patterns.empty?
+        DEFAULT_PATH_PATTERNS
+      else
+        @patterns
       end
     end
   end

data/lib/slimcop/rubo_cop_config_generator.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module Slimcop
+  class RuboCopConfigGenerator
+    DEFAULT_ADDITIONAL_CONFIG_PATH = '.rubocop.yml'
+
+    # @param [String] additional_config_file_path
+    def initialize(additional_config_file_path: nil)
+      @additional_config_file_path = additional_config_file_path
+    end
+
+    # @return [RuboCop::Config]
+    def call
+      ::RuboCop::ConfigLoader.merge_with_default(merged_config, loaded_path)
+    end
+
+    private
+
+    # @return [String]
+    def loaded_path
+      @additional_config_file_path || slimcop_default_config_file_path
+    end
+
+    # @return [RuboCop::Config]
+    def merged_config
+      ::RuboCop::Config.create(merged_config_hash, loaded_path)
+    end
+
+    # @return [Hash]
+    def merged_config_hash
+      result = slimcop_default_config
+      result = ::RuboCop::ConfigLoader.merge(result, additional_config) if additional_config
+      result
+    end
+
+    # @return [RuboCop::Config, nil]
+    def additional_config
+      if instance_variable_defined?(:@additional_config)
+        @additional_config
+      else
+        @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)
+          end
+      end
+    end
+
+    # @return [RuboCop::Config]
+    def slimcop_default_config
+      ::RuboCop::ConfigLoader.load_file(slimcop_default_config_file_path)
+    end
+
+    # @return [String]
+    def slimcop_default_config_file_path
+      @slimcop_default_config_file_path ||= ::File.expand_path('../../default.yml', __dir__)
+    end
+  end
+end

data/lib/slimcop/ruby_offense_collector.rb

@@ -21,7 +21,7 @@ module Slimcop
       # Skip if invalid syntax Ruby code is given. (e.g. "- if a?")
       return [] unless rubocop_processed_source.valid_syntax?
 
-      rubocop_team.investigate(rubocop_processed_source).offenses
+      rubocop_team.investigate(rubocop_processed_source).offenses.reject(&:disabled?)
     end
 
     private

data/lib/slimcop/version.rb

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

data/lib/slimcop.rb

@@ -4,10 +4,9 @@ require_relative 'slimcop/version'
 
 module Slimcop
   autoload :Cli, 'slimcop/cli'
-  autoload :Configuration, 'slimcop/configuration'
-  autoload :Formatter, 'slimcop/formatter'
   autoload :Offense, 'slimcop/offense'
   autoload :PathFinder, 'slimcop/path_finder'
+  autoload :RuboCopConfigGenerator, 'slimcop/rubo_cop_config_generator'
   autoload :RubyExtractor, 'slimcop/ruby_extractor'
   autoload :RubyOffenseCollector, 'slimcop/ruby_offense_collector'
   autoload :SlimCorrector, 'slimcop/slim_corrector'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimcop
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-26 00:00:00.000000000 Z
+date: 2021-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -75,10 +75,9 @@ files:
 - exe/slimcop
 - lib/slimcop.rb
 - lib/slimcop/cli.rb
-- lib/slimcop/configuration.rb
-- lib/slimcop/formatter.rb
 - lib/slimcop/offense.rb
 - lib/slimcop/path_finder.rb
+- lib/slimcop/rubo_cop_config_generator.rb
 - lib/slimcop/ruby_extractor.rb
 - lib/slimcop/ruby_offense_collector.rb
 - lib/slimcop/slim_corrector.rb

data/lib/slimcop/configuration.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module Slimcop
-  class Configuration
-    # @return [RuboCop::Config]
-    def rubocop_config
-      @rubocop_config ||= begin
-        config_path = ::File.expand_path('../../default.yml', __dir__)
-        config = ::RuboCop::ConfigLoader.load_file(config_path)
-        ::RuboCop::ConfigLoader.merge_with_default(config, config_path)
-      end
-    end
-  end
-end

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