slimcop 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d598a52269b8958e493b5b29b175e58d96d122381679e21b5c90c86b2c50d8a
-  data.tar.gz: 8f45fae7e940bdc8ece0c4ae5575554ba715f6d79e986a9c18fd9893e7c9ff61
+  metadata.gz: bace4128c4ef162ff7f9a4f1eca5af7275631b850df5a6ad48a92d8693114771
+  data.tar.gz: d7a04c3c5ed2930490174e41e838cd6c7e26a8eae8e6476fa188ee89ae3f103f
 SHA512:
-  metadata.gz: bbcc157e1514269668fe126bce9f29315cf848ef49208c784877a36fdd00b5d71de538af0474ca76dfdee44c4aa3920167b065bc0f41b65a5948facf04f133b8
-  data.tar.gz: '009cdacfe8068fcda5c90a172ca49ef0b77db8e965d4700723f6010bbe0fd0b35b5dcbe8f8d7472b79121785961e0997d1a41146b1aeb0eb4c21add9240bb126'
+  metadata.gz: d4cacec671cd5855ceedd2183099450f2e4abf759d71f11e77e4af5f5c25b7e52a71d6da4f4e7fbaac812bf7509311c4edc5233501b021dfbb9da6259e1b305d
+  data.tar.gz: 0db1c7751629572c7e8738e52fe8d44f41e20047b48f091aa00defa0dad62f2674bf5ae0fafe2b2a53ce5b3eab006fde3f0a9ae840a8cc6c779cadb9632c4845

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## Unreleased
 
+## 0.2.0 - 2021-12-21
+
+### Added
+
+- Add --color and --no-color option.
+
+### Changed
+
+- Improve offenses CLI output format.
+- Return exit status 1 if any offense found.
+
 ## 0.1.0 - 2021-12-21
 
 - Initial release.

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    slimcop (0.1.0)
+    slimcop (0.2.0)
+      rainbow
       rubocop (>= 0.87)
       slimi (>= 0.1.1)
 

data/README.md

@@ -1,5 +1,6 @@
 # Slimcop
 
+[![Gem Version](https://badge.fury.io/rb/slimcop.svg)](https://rubygems.org/gems/slimcop)
 [![test](https://github.com/r7kamura/slimcop/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/slimcop/actions/workflows/test.yml)
 
 [RuboCop](https://github.com/rubocop/rubocop) runner for [Slim template](https://github.com/slim-template/slim).
@@ -32,4 +33,5 @@ Use `slimcop` executable to check offenses and auto-correct them.
 $ slimcop --help
 Usage: slimcop [options] [file1, file2, ...]
     -a, --auto-correct               Auto-correct offenses.
+        --[no-]color                 Force color output on or off.
 ```

data/lib/slimcop/cli.rb

@@ -1,36 +1,71 @@
 # frozen_string_literal: true
 
-require 'optparse'
-require 'rubocop'
+require 'rainbow'
 
 module Slimcop
   class Cli
     def initialize(argv)
       @argv = argv.dup
+      @configuration = Configuration.new
+      @formatter = Formatter.new
     end
 
     def call
       options = parse!
-      @argv.each do |slim_file_path|
-        runner = Runner.new(
-          file_path: slim_file_path
-        )
-        if options[:auto_correct]
-          ::File.write(
-            slim_file_path,
-            runner.auto_correct
-          )
-        else
-          messages = runner.offenses.map do |offense|
-            offense[:rubocop_offense].message
-          end
-          puts messages
-        end
-      end
+      slim_file_paths = @argv
+
+      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)
+      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
+    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)
+    end
+
     # @return [Hash]
     def parse!
       options = {}
@@ -39,6 +74,9 @@ module Slimcop
       parser.on('-a', '--auto-correct', 'Auto-correct offenses.') do
         options[:auto_correct] = true
       end
+      parser.on('--[no-]color', 'Force color output on or off.') do |value|
+        options[:color] = value
+      end
       parser.parse!(@argv)
       options
     end

data/lib/slimcop/configuration.rb

@@ -0,0 +1,16 @@
+# 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

@@ -0,0 +1,72 @@
+# 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

data/lib/slimcop/offense.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'parser'
+
+module Slimcop
+  class Offense
+    # @return [Integer]
+    attr_reader :offset
+
+    # @return [RuboCop::Cop::Offense]
+    attr_reader :rubocop_offense
+
+    # @param [Integer] offset
+    # @param [RuboCop::Cop::Offense] rubocop_offense
+    # @param [String] source Slim code.
+    def initialize(offset:, rubocop_offense:, source:)
+      @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
+    end
+
+    private
+
+    # @return [Parser::Source::Buffer]
+    def buffer
+      ::Parser::Source::Buffer.new(
+        file_path,
+        source: @source
+      )
+    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
+      )
+    end
+  end
+end

data/lib/slimcop/ruby_offense_collector.rb

@@ -5,10 +5,12 @@ require 'rubocop'
 module Slimcop
   # Collect RuboCop offenses from Ruby code.
   class RubyOffenseCollector
+    # @param [Boolean] auto_correct
     # @param [String] file_path
     # @param [RuboCop::Config] rubocop_config
     # @param [String] source
-    def initialize(file_path:, rubocop_config:, source:)
+    def initialize(auto_correct:, file_path:, rubocop_config:, source:)
+      @auto_correct = auto_correct
       @file_path = file_path
       @rubocop_config = rubocop_config
       @source = source
@@ -37,7 +39,7 @@ module Slimcop
       ::RuboCop::Cop::Team.new(
         ::RuboCop::Cop::Registry.new(::RuboCop::Cop::Cop.all),
         @rubocop_config,
-        auto_correct: true,
+        auto_correct: @auto_correct,
         display_cop_names: true,
         extra_details: true,
         stdin: ''

data/lib/slimcop/slim_corrector.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
+require 'parser'
 require 'rubocop/cop/legacy/corrector'
 
 module Slimcop
   # Apply auto-corrections to Slim file.
   class SlimCorrector
     # @param [String] file_path
-    # @param [Array<Hash>] offenses
+    # @param [Array<Slimcop::Offense>] offenses
     # @param [String] source
     def initialize(file_path:, offenses:, source:)
       @file_path = file_path
@@ -25,7 +26,7 @@ module Slimcop
     def corrections
       @offenses.map do |offense|
         lambda do |corrector|
-          corrector.import!(offense[:rubocop_offense].corrector, offset: offense[:offset])
+          corrector.import!(offense.corrector, offset: offense.offset)
         end
       end
     end

data/lib/slimcop/slim_offense_collector.rb

@@ -3,27 +3,31 @@
 module Slimcop
   # Collect RuboCop offenses from Slim code.
   class SlimOffenseCollector
+    # @param [Boolean] auto_correct
     # @param [String] file_path Slim file path
     # @param [RuboCop::Config] rubocop_config
     # @param [String] source Slim code
-    def initialize(file_path:, rubocop_config:, source:)
+    def initialize(auto_correct:, file_path:, rubocop_config:, source:)
+      @auto_correct = auto_correct
       @file_path = file_path
       @rubocop_config = rubocop_config
       @source = source
     end
 
-    # @return [Array<Hash>]
+    # @return [Array<Slimcop::Offense>]
     def call
       snippets.flat_map do |snippet|
         RubyOffenseCollector.new(
+          auto_correct: @auto_correct,
           file_path: @file_path,
           rubocop_config: @rubocop_config,
           source: snippet[:code]
         ).call.map do |rubocop_offense|
-          {
+          Offense.new(
             offset: snippet[:begin_],
-            rubocop_offense: rubocop_offense
-          }
+            rubocop_offense: rubocop_offense,
+            source: @source
+          )
         end
       end
     end

data/lib/slimcop/version.rb

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

data/lib/slimcop.rb

@@ -4,9 +4,11 @@ require_relative 'slimcop/version'
 
 module Slimcop
   autoload :Cli, 'slimcop/cli'
+  autoload :Configuration, 'slimcop/configuration'
+  autoload :Formatter, 'slimcop/formatter'
+  autoload :Offense, 'slimcop/offense'
   autoload :RubyExtractor, 'slimcop/ruby_extractor'
   autoload :RubyOffenseCollector, 'slimcop/ruby_offense_collector'
-  autoload :Runner, 'slimcop/runner'
   autoload :SlimCorrector, 'slimcop/slim_corrector'
   autoload :SlimOffenseCollector, 'slimcop/slim_offense_collector'
 end

data/slimcop.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
     'rubygems_mfa_required' => 'true'
   }
 
+  spec.add_dependency 'rainbow'
   spec.add_dependency 'rubocop', '>= 0.87'
   spec.add_dependency 'slimi', '>= 0.1.1'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: slimcop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-20 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -61,9 +75,11 @@ files:
 - exe/slimcop
 - lib/slimcop.rb
 - lib/slimcop/cli.rb
+- lib/slimcop/configuration.rb
+- lib/slimcop/formatter.rb
+- lib/slimcop/offense.rb
 - lib/slimcop/ruby_extractor.rb
 - lib/slimcop/ruby_offense_collector.rb
-- lib/slimcop/runner.rb
 - lib/slimcop/slim_corrector.rb
 - lib/slimcop/slim_offense_collector.rb
 - lib/slimcop/version.rb

data/lib/slimcop/runner.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module Slimcop
-  # Report offenses in Slim file, and apply auto-corrections if required.
-  class Runner
-    # @param [String] file_path
-    def initialize(file_path:)
-      @file_path = file_path
-    end
-
-    # @return [Array<Hash>]
-    def offenses
-      @offenses ||= SlimOffenseCollector.new(
-        file_path: @file_path,
-        rubocop_config: rubocop_config,
-        source: source
-      ).call
-    end
-
-    def auto_correct
-      SlimCorrector.new(
-        file_path: @file_path,
-        offenses: offenses,
-        source: source
-      ).call
-    end
-
-    private
-
-    # @return [RuboCop::Config]
-    def rubocop_config
-      config_path = ::File.expand_path('../../default.yml', __dir__)
-      config = ::RuboCop::ConfigLoader.load_file(config_path)
-      ::RuboCop::ConfigLoader.merge_with_default(config, config_path)
-    end
-
-    # @return [Array<Hash>]
-    def snippets
-      RubyExtractor.new(source: source).call
-    end
-
-    # @return [String]
-    def source
-      ::File.read(@file_path)
-    end
-  end
-end