slimcop 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bace4128c4ef162ff7f9a4f1eca5af7275631b850df5a6ad48a92d8693114771
-  data.tar.gz: d7a04c3c5ed2930490174e41e838cd6c7e26a8eae8e6476fa188ee89ae3f103f
+  metadata.gz: 8f5970bfa12ccffdb04b26f3b827b8102e035cb95ddd7f6d2ad70f1ff53d240f
+  data.tar.gz: d293f0d5c72e0e96c21f515ed16c6f0dbe9bf0aae745e42cec20186e654922a0
 SHA512:
-  metadata.gz: d4cacec671cd5855ceedd2183099450f2e4abf759d71f11e77e4af5f5c25b7e52a71d6da4f4e7fbaac812bf7509311c4edc5233501b021dfbb9da6259e1b305d
-  data.tar.gz: 0db1c7751629572c7e8738e52fe8d44f41e20047b48f091aa00defa0dad62f2674bf5ae0fafe2b2a53ce5b3eab006fde3f0a9ae840a8cc6c779cadb9632c4845
+  metadata.gz: b2423cffaf849c867d335df2d3fec06645f5578aecc9597a9d218d5cc99989a86be664609b364c6092695ad391825ce9ff244387d3dd6d77710d5c820d02d5f1
+  data.tar.gz: 294f4adb1bc4e8198a2d0b6fb79b810561a57a90fb01ebcfdfe0d3d057278e67ca3c8f77c5063b1bbadb55c36e84b7363db4b39d3004de2d7884f1afcb5f6cca

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,50 @@
 
 ## Unreleased
 
+## 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
+
+- Show Slim file path on Slim syntax error.
+
+### Changed
+
+- Require slimi >= 0.4 for :file option handling.
+
 ## 0.2.0 - 2021-12-21
 
 ### 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,10 +1,10 @@
 PATH
   remote: .
   specs:
-    slimcop (0.2.0)
+    slimcop (0.6.0)
       rainbow
       rubocop (>= 0.87)
-      slimi (>= 0.1.1)
+      slimi (>= 0.4)
 
 GEM
   remote: https://rubygems.org/
@@ -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.1.1)
+    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

@@ -35,3 +35,14 @@ Usage: slimcop [options] [file1, file2, ...]
     -a, --auto-correct               Auto-correct offenses.
         --[no-]color                 Force color output on or off.
 ```
+
+### Example
+
+```console
+$ slimcop spec/**/*.slim
+
+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.
+```

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

@@ -6,51 +6,62 @@ module Slimcop
   class Cli
     def initialize(argv)
       @argv = argv.dup
-      @configuration = Configuration.new
       @formatter = Formatter.new
     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 }
+      offenses = file_paths.flat_map do |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
+        offenses_
+      end
       report(offenses)
       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
+    # @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
 
     # @param [Array<Slimcop::Offense>] offenses
@@ -74,6 +85,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

@@ -4,6 +4,9 @@ require 'parser'
 
 module Slimcop
   class Offense
+    # @return [String]
+    attr_reader :file_path
+
     # @return [Integer]
     attr_reader :offset
 
@@ -13,7 +16,8 @@ module Slimcop
     # @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
@@ -24,11 +28,6 @@ module Slimcop
       @rubocop_offense.corrector
     end
 
-    # @return [String]
-    def file_path
-      @rubocop_offense.location.source_buffer.name
-    end
-
     # @return [Integer]
     def line
       range.line

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_extractor.rb

@@ -5,8 +5,10 @@ require 'slimi'
 module Slimcop
   # Extract codes from Slim source.
   class RubyExtractor
+    # @param [String, nil] file_path
     # @param [String] source
-    def initialize(source:)
+    def initialize(file_path:, source:)
+      @file_path = file_path
       @source = source
     end
 
@@ -26,7 +28,7 @@ module Slimcop
     # @return [Array] Slim AST, represented in S-expression.
     def ast
       ::Slimi::Filters::Interpolation.new.call(
-        ::Slimi::Parser.new.call(@source)
+        ::Slimi::Parser.new(file: @file_path).call(@source)
       )
     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
@@ -36,7 +37,10 @@ module Slimcop
 
     # @return [Array<Hash>]
     def snippets
-      RubyExtractor.new(source: @source).call
+      RubyExtractor.new(
+        file_path: @file_path,
+        source: @source
+      ).call
     end
   end
 end

data/lib/slimcop/version.rb

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

data/lib/slimcop.rb

@@ -4,9 +4,10 @@ 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'

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.1.1'
+  spec.add_dependency 'slimi', '>= 0.4'
 end

metadata

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