slimcop 0.9.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75b0d9431db2adbba5b1b238af9c11bdbf95528541136714f1d09acdb226048c
-  data.tar.gz: 1bdfd90997739807a9ca4e38ad37bd29ae2d9f736fbaf0d74824aa367bbd5dd4
+  metadata.gz: 583b9f7c6ea2e90edb94a7ed4c84762881cac6937374dc747f55db4c4e6c3e58
+  data.tar.gz: fc8d197b9b6b469281a99d49b62a57cf6674895376d3f549ceb4fbb82bb24260
 SHA512:
-  metadata.gz: a8bb9144ee99b9745fa1f6ae1c136ed7e438e6d433c22963ade6cb25120d4fb81780ee03f4051ed393b4d37ee7f33b5a74c603229a88f487f6646e094d13ea5f
-  data.tar.gz: 1af01925da76e7116394f222ec7b9630e842e9be4d4d3dd71ff0a2e4480d0160e5e408c4675ef28dbbcbb04dc541a162d602341b9002098829eb24ced4946519
+  metadata.gz: 564ce43ebcf8fcd8d18a0834f98cc23a779de0bb1db57eb332a3694486ffd4ec567066a2b8e544c3ed2b3c42357ef27346fa19beff58f45b4bd5fcb0d902abf6
+  data.tar.gz: 33db301ef4145581fcff267e9def94f7ef3e6bd6f34e75f4e31e82605e9c58479b360429ef313db582fedda09f3b06121a4095f5b7d1c6ab139669bba25abc5b

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## Unreleased
 
+## 0.13.0 - 2022-01-15
+
+### Changed
+
+- Use templatecop.
+
+## 0.12.0 - 2022-01-12
+
+### Changed
+
+- Keep trying auto-correction up to 7 times until no offense detected.
+
+## 0.11.0 - 2022-01-10
+
+### Changed
+
+- Detect offenses from code that containing `if`, `unless`, `do`, etc.
+
+## 0.10.0 - 2022-01-06
+
+### Added
+
+- Use .slimcop.yml as its 1st default config file.
+
 ## 0.9.1 - 2022-01-04
 
 ### Fixed

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    slimcop (0.9.1)
-      rainbow
-      rubocop (>= 0.87)
+    slimcop (0.13.0)
       slimi (>= 0.5.1)
+      templatecop
 
 GEM
   remote: https://rubygems.org/
@@ -45,10 +44,15 @@ GEM
     rubocop-rspec (2.6.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    slimi (0.6.0)
+    slimi (0.7.0)
       temple
+      thor
       tilt
+    templatecop (0.1.0)
+      parser
+      rubocop (>= 0.87)
     temple (0.8.2)
+    thor (1.2.1)
     tilt (2.0.10)
     unicode-display_width (2.1.0)
 

data/README.md

@@ -40,7 +40,7 @@ Usage: slimcop [options] [file1, file2, ...]
 ### Example
 
 ```console
-$ slimcop
+$ slimcop 'spec/fixtures/**/*.slim'
 Inspecting 1 file
 C
 

data/exe/slimcop

@@ -3,5 +3,12 @@
 
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'slimcop'
+require 'templatecop'
 
-Slimcop::Cli.new(ARGV).call
+Templatecop::Cli.call(
+  default_configuration_path: File.expand_path('../default.yml', __dir__),
+  default_path_patterns: %w[**/*.slim],
+  executable_name: 'slimcop',
+  implicit_configuration_paths: %w[.slimcop.yml .rubocop.yml],
+  ruby_extractor: Slimcop::RubyExtractor
+)

data/lib/slimcop/ruby_extractor.rb

@@ -1,10 +1,25 @@
 # frozen_string_literal: true
 
 require 'slimi'
+require 'templatecop'
 
 module Slimcop
-  # Extract codes from Slim source.
+  # Extract Ruby codes from Slim source.
   class RubyExtractor
+    class << self
+      # @param [String, nil] file_path
+      # @param [String] source
+      def call(
+        file_path:,
+        source:
+      )
+        new(
+          file_path: file_path,
+          source: source
+        ).call
+      end
+    end
+
     # @param [String, nil] file_path
     # @param [String] source
     def initialize(file_path:, source:)
@@ -15,10 +30,10 @@ module Slimcop
     # @return [Array<Hash>]
     def call
       ranges.map do |(begin_, end_)|
+        clipped = ::Templatecop::RubyClipper.new(@source[begin_...end_]).call
         {
-          begin_: begin_,
-          code: @source[begin_...end_],
-          end_: end_
+          code: clipped[:code],
+          offset: begin_ + clipped[:offset]
         }
       end
     end

data/lib/slimcop/version.rb

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

data/lib/slimcop.rb

@@ -3,12 +3,5 @@
 require_relative 'slimcop/version'
 
 module Slimcop
-  autoload :Cli, 'slimcop/cli'
-  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'
-  autoload :SlimOffenseCollector, 'slimcop/slim_offense_collector'
 end

data/slimcop.gemspec

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

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: slimcop
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-03 00:00:00.000000000 Z
+date: 2022-01-15 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
+  name: slimi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.87'
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.87'
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
-  name: slimi
+  name: templatecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0'
 description: 
 email:
 - r7kamura@gmail.com
@@ -74,14 +60,8 @@ files:
 - default.yml
 - exe/slimcop
 - lib/slimcop.rb
-- lib/slimcop/cli.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
-- lib/slimcop/slim_offense_collector.rb
 - lib/slimcop/version.rb
 - slimcop.gemspec
 homepage: https://github.com/r7kamura/slimcop

data/lib/slimcop/cli.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-require 'rainbow'
-require 'rubocop'
-
-module Slimcop
-  class Cli
-    def initialize(argv)
-      @argv = argv.dup
-    end
-
-    def call
-      options = parse!
-      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],
-          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 [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 [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]
-    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. (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
-      parser.parse!(@argv)
-      options
-    end
-  end
-end

data/lib/slimcop/offense.rb

@@ -1,75 +0,0 @@
-# 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
-
-    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(file_path:, offset:, rubocop_offense:, source:)
-      @file_path = file_path
-      @offset = offset
-      @rubocop_offense = rubocop_offense
-      @source = source
-    end
-
-    # @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
-
-    # @return [Parser::Source::Buffer]
-    def buffer
-      ::Parser::Source::Buffer.new(
-        file_path,
-        source: @source
-      )
-    end
-
-    # @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
-end

data/lib/slimcop/path_finder.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-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
-    end
-
-    # @return [Array<String>]
-    def call
-      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
-end

data/lib/slimcop/rubo_cop_config_generator.rb

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-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(auto_correct:, file_path:, rubocop_config:, source:)
-      @auto_correct = auto_correct
-      @file_path = file_path
-      @rubocop_config = rubocop_config
-      @source = source
-    end
-
-    # @return [Array<RuboCop::Cop::Offense>]
-    def call
-      # 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.reject(&:disabled?)
-    end
-
-    private
-
-    # @return [RuboCop::ProcessedSource]
-    def rubocop_processed_source
-      @rubocop_processed_source ||= ::RuboCop::ProcessedSource.new(
-        @source,
-        @rubocop_config.target_ruby_version,
-        @file_path
-      )
-    end
-
-    # @return [RuboCop::Cop::Team]
-    def rubocop_team
-      ::RuboCop::Cop::Team.new(
-        ::RuboCop::Cop::Registry.new(::RuboCop::Cop::Cop.all),
-        @rubocop_config,
-        auto_correct: @auto_correct,
-        display_cop_names: true,
-        extra_details: true,
-        stdin: ''
-      )
-    end
-  end
-end

data/lib/slimcop/slim_offense_collector.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-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(auto_correct:, file_path:, rubocop_config:, source:)
-      @auto_correct = auto_correct
-      @file_path = file_path
-      @rubocop_config = rubocop_config
-      @source = source
-    end
-
-    # @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(
-            file_path: @file_path,
-            offset: snippet[:begin_],
-            rubocop_offense: rubocop_offense,
-            source: @source
-          )
-        end
-      end
-    end
-
-    private
-
-    # @return [Array<Hash>]
-    def snippets
-      RubyExtractor.new(
-        file_path: @file_path,
-        source: @source
-      ).call
-    end
-  end
-end