slimcop 0.3.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e43c25d5b3588ae90dd33cff028ef9c42ada8905782d8ac97049324948e0e8f6
-  data.tar.gz: b487022dc36d88c433ff0cf5b2666fe97e27a0e88b3def78fcbc51a2f33d753c
+  metadata.gz: 03e13f6191b529e4c4b0ca6bc1fbbd6d1144eb029e62158ae04f43111f4dd96e
+  data.tar.gz: 4eb2dccd29708a5de535d9fb4971eb56084e3d45644fd9ad9f0731416ad22ec7
 SHA512:
-  metadata.gz: fba92c121be30436567f9cc30cb22570a8bc3f6316d8564681d9d124a2400296590fed6f0c11b7b3cb3ea16d3e48ebd3f53ba9719bc085bf76b731f1c7115e29
-  data.tar.gz: df506c25b9b513589bf05391555b83228e976b000c4117e55d85b8e209ef613c25beef1b8e981a871e8c17382048d472a59dce3386cd1f034164ec81e528b547
+  metadata.gz: '09705a482591105427cf3bc97f6ba86ab317d78e845fb0ca91d677730fa7081b5466c54112449127d83dc350431aea1de288bfc67034e10045e47dfcda57a7b3'
+  data.tar.gz: '09384443d865bb4cd1edf7d44e0ee1eb84dcf6729910220b4cad9970eba1dd16b0cb00b26b40f5845223a61488097a5fd9b8c48f25c8e69349ba47d1739cea2c'

data/.rubocop.yml

@@ -1,3 +1,6 @@
+require:
+  - rubocop-rspec
+
 AllCops:
   NewCops: enable
   SuggestExtensions: false
@@ -9,5 +12,20 @@ Layout/LineLength:
 Metrics:
   Enabled: false
 
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/ImplicitSubject:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,46 @@
 
 ## 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
+
+- 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
+
+- Disable Lint/EmptyFile by default.
+- Disable Style/RescueModifier by default.
+
+### Fixed
+
+- Fix NoMethodError on some RuboCop offenses.
+- Fix bug when uncorrectable RuboCop offense exists.
+
+## 0.4.0 - 2021-12-26
+
+### Added
+
+- Support glob pattern on arguments of executable.
+
+### Fixed
+
+- Fix bug on parsing invalid syntax Ruby code.
+
 ## 0.3.0 - 2021-12-25
 
 ### Added

data/Gemfile

@@ -2,11 +2,9 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in slimcop.gemspec
 gemspec
 
 gem 'rake', '~> 13.0'
-
-gem 'rspec', '~> 3.0'
-
-gem 'rubocop', '~> 1.21'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-rspec'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slimcop (0.3.0)
+    slimcop (0.7.0)
       rainbow
       rubocop (>= 0.87)
       slimi (>= 0.4)
@@ -42,8 +42,10 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.15.0)
       parser (>= 3.0.1.1)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    slimi (0.4.0)
+    slimi (0.4.2)
       temple
     temple (0.8.2)
     unicode-display_width (2.1.0)
@@ -53,8 +55,9 @@ PLATFORMS
 
 DEPENDENCIES
   rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
+  rspec
+  rubocop
+  rubocop-rspec
   slimcop!
 
 BUNDLED WITH

data/README.md

@@ -33,5 +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 "**/*.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.
+- "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

@@ -10,6 +10,9 @@ Layout/BlockAlignment:
 Layout/ClosingParenthesisIndentation:
   Enabled: false
 
+Lint/EmptyFile:
+  Enabled: false
+
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
@@ -76,6 +79,9 @@ Layout/TrailingEmptyLines:
 Layout/TrailingWhitespace:
   Enabled: false
 
+Lint/UselessAssignment:
+  Enabled: false
+
 Lint/Void:
   Enabled: false
 
@@ -100,6 +106,9 @@ Style/IfUnlessModifier:
 Style/Next:
   Enabled: false
 
+Style/RescueModifier:
+  Enabled: false
+
 Style/WhileUntilDo:
   Enabled: false
 

data/lib/slimcop/cli.rb

@@ -1,69 +1,71 @@
 # frozen_string_literal: true
 
 require 'rainbow'
+require 'rubocop'
 
 module Slimcop
   class Cli
     def initialize(argv)
       @argv = argv.dup
-      @configuration = Configuration.new
-      @formatter = Formatter.new
+      @formatter = ::RuboCop::Formatter::ProgressFormatter.new($stdout)
     end
 
     def call
       options = parse!
-      slim_file_paths = @argv
-
       Rainbow.enabled = options[:color] if options.key?(:color)
+      rubocop_config = RuboCopConfigGenerator.new(additional_config_file_path: options[:additional_config_file_path]).call
+      file_paths = PathFinder.new(patterns: @argv).call
 
-      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 +76,9 @@ module Slimcop
       parser.on('-a', '--auto-correct', 'Auto-correct offenses.') do
         options[:auto_correct] = true
       end
+      parser.on('-c', '--config=', 'Specify configuration file.') 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,52 +1,53 @@
 # 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
     # @param [String] source Slim code.
-    def initialize(offset:, rubocop_offense:, source:)
+    def initialize(file_path:, offset:, rubocop_offense:, source:)
+      @file_path = file_path
       @offset = offset
       @rubocop_offense = rubocop_offense
       @source = source
     end
 
-    # @return [RuboCop::Cop::Corrector]
-    def corrector
-      @rubocop_offense.corrector
-    end
-
-    # @return [String]
-    def file_path
-      @rubocop_offense.location.source_buffer.name
-    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
@@ -59,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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Slimcop
+  # Collect file paths from given path patterns.
+  class PathFinder
+    # @param [Array<String>] patterns Patterns normally given as CLI arguments (e.g. `["app/views/**/*.html.slim"]`).
+    def initialize(patterns:)
+      @patterns = patterns
+    end
+
+    # @return [Array<String>]
+    def call
+      @patterns.flat_map do |pattern|
+        ::Pathname.glob(pattern).select(&:file?).map(&:to_s)
+      end.sort
+    end
+  end
+end

data/lib/slimcop/rubo_cop_config_generator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module Slimcop
+  class RuboCopConfigGenerator
+    # @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_file_path
+      result
+    end
+
+    # @return [RuboCop::Config, nil]
+    def additional_config
+      ::RuboCop::ConfigLoader.load_file(@additional_config_file_path) if @additional_config_file_path
+    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

@@ -16,9 +16,10 @@ module Slimcop
       @source = source
     end
 
-    # @return [Array<RuboCop::Cop::Offense>, nil]
+    # @return [Array<RuboCop::Cop::Offense>]
     def call
-      return unless rubocop_processed_source.valid_syntax?
+      # 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
     end

data/lib/slimcop/slim_corrector.rb

@@ -24,7 +24,7 @@ module Slimcop
 
     # @return [Array<Proc>]
     def corrections
-      @offenses.map do |offense|
+      @offenses.select(&:corrector).map do |offense|
         lambda do |corrector|
           corrector.import!(offense.corrector, offset: offense.offset)
         end

data/lib/slimcop/slim_offense_collector.rb

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

data/lib/slimcop/version.rb

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

data/lib/slimcop.rb

@@ -4,9 +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.3.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-24 00:00:00.000000000 Z
+date: 2021-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -75,9 +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