slimcop 0.6.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5970bfa12ccffdb04b26f3b827b8102e035cb95ddd7f6d2ad70f1ff53d240f
-  data.tar.gz: d293f0d5c72e0e96c21f515ed16c6f0dbe9bf0aae745e42cec20186e654922a0
+  metadata.gz: 4ddeb0d894aab7002ef81c70937513071636e1d048f5fd8e94300fd9af6c96a4
+  data.tar.gz: c12290288593975b5e2ca620fd023ada7b6c04d39c41dcbae8155f9f8245809f
 SHA512:
-  metadata.gz: b2423cffaf849c867d335df2d3fec06645f5578aecc9597a9d218d5cc99989a86be664609b364c6092695ad391825ce9ff244387d3dd6d77710d5c820d02d5f1
-  data.tar.gz: 294f4adb1bc4e8198a2d0b6fb79b810561a57a90fb01ebcfdfe0d3d057278e67ca3c8f77c5063b1bbadb55c36e84b7363db4b39d3004de2d7884f1afcb5f6cca
+  metadata.gz: 02b791ca65f375995f387c08cb107c7d7d37791fdcfa6546cef9ae60869e00bd21bed8610bce6f5dad8b8641f48b1ab8528f29538ee2352af356a08d10cc7ae5
+  data.tar.gz: 7d58c62120d8fc325d339f5837d7d3f4ef9e72209ca106f2c3b5a9ce96f27d57f7a8b9fbd5da0e9292e479dcb2cb9459907189a9622f98d9d9f2cfd27666eca8

data/CHANGELOG.md

@@ -2,6 +2,40 @@
 
 ## Unreleased
 
+## 0.9.0 - 2022-01-02
+
+### Changed
+
+- Require slimi >= 0.5.1 to extract Ruby code from Ruby attribute.
+
+### Fixed
+
+- Fix -v and --version option.
+
+## 0.8.0 - 2021-12-29
+
+### 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

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    slimcop (0.6.0)
+    slimcop (0.9.0)
       rainbow
       rubocop (>= 0.87)
-      slimi (>= 0.4)
+      slimi (>= 0.5.1)
 
 GEM
   remote: https://rubygems.org/
@@ -45,9 +45,11 @@ GEM
     rubocop-rspec (2.6.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    slimi (0.4.2)
+    slimi (0.5.1)
       temple
+      tilt
     temple (0.8.2)
+    tilt (2.0.10)
     unicode-display_width (2.1.0)
 
 PLATFORMS

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/lib/slimcop/cli.rb

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
 
 require 'rainbow'
+require 'rubocop'
 
 module Slimcop
   class Cli
     def initialize(argv)
       @argv = argv.dup
-      @formatter = Formatter.new
     end
 
     def call
       options = parse!
-      Rainbow.enabled = options[:color] if options.key?(:color)
+      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
 
+      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 +32,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,28 +67,16 @@ 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 = {}
       parser = ::OptionParser.new
       parser.banner = 'Usage: slimcop [options] [file1, file2, ...]'
+      parser.version = VERSION
       parser.on('-a', '--auto-correct', 'Auto-correct offenses.') do
         options[:auto_correct] = true
       end
-      parser.on('-c', '--config=', 'Specify configuration file.') do |file_path|
+      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|

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,9 +16,20 @@ 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.sort
+      end.uniq.sort
+    end
+
+    private
+
+    # @return [Array<String>]
+    def patterns
+      if @patterns.empty?
+        DEFAULT_PATH_PATTERNS
+      else
+        @patterns
+      end
     end
   end
 end

data/lib/slimcop/rubo_cop_config_generator.rb

@@ -4,6 +4,8 @@ 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
@@ -29,13 +31,22 @@ module Slimcop
     # @return [Hash]
     def merged_config_hash
       result = slimcop_default_config
-      result = ::RuboCop::ConfigLoader.merge(result, additional_config) if @additional_config_file_path
+      result = ::RuboCop::ConfigLoader.merge(result, additional_config) if additional_config
       result
     end
 
     # @return [RuboCop::Config, nil]
     def additional_config
-      ::RuboCop::ConfigLoader.load_file(@additional_config_file_path) if @additional_config_file_path
+      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]

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.6.0'
+  VERSION = '0.9.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'

data/slimcop.gemspec

@@ -33,5 +33,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rainbow'
   spec.add_dependency 'rubocop', '>= 0.87'
-  spec.add_dependency 'slimi', '>= 0.4'
+  spec.add_dependency 'slimi', '>= 0.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimcop
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2022-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.5.1
 description: 
 email:
 - r7kamura@gmail.com
@@ -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