slimcop 0.11.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b967da47ab7a5721d082f4d1a4e9bb84006431c5acb5992a27f8246bdcfd904
-  data.tar.gz: 6e260866461bc31ddef835279d647905f17f87890b63af229bd98557699e0d8f
+  metadata.gz: 9fa07b1fe38abcfaa4931343e0f3a44ad24cb17d6d85ed6dbe6090dd16f429b7
+  data.tar.gz: 6612b476195e0f2f34991edaa869fa5336d4e1d553e5c124b983856da9881b28
 SHA512:
-  metadata.gz: 62cbf9db3a9f0fc741714afdd4f886b61efb4bed1e3f4ca54e6e7caa03b3cf2e8f3141aec2456b3b13f7fe0999e5a7ab9a7578a6700225a220db08200f9b2f96
-  data.tar.gz: c6742245998d9fbd23dca47dbf55be3e8717722daa7515df5afab77baca05d1c2ddc26d80a62bbbc97a7cfa06332a5c6fb3bc078a7d3853479598f7cb86c36ea
+  metadata.gz: 5a9fa1438ea7d1c7401f1fa77990977e3d65b36c7435eae44f14c0369169ef453ed8736ee7b50eb544381a6db8fa225c4b0d4b870b86b62e13d6e60c36e28749
+  data.tar.gz: c1fe2201f69025cf886305532bdad15144097c301ae407c22ee6b22ff5a264c3a9fec0b206ff9fcb274f806ce900ebd300500f24d1c4d47d519f4374760f20f8

data/CHANGELOG.md

@@ -2,11 +2,34 @@
 
 ## Unreleased
 
+## 0.14.0 - 2022-01-22
+
+### Changed
+
+- Disable Style/MultilineTernaryOperator by default.
+
+## 0.13.1 - 2022-01-18
+
+### Fixed
+
+- Fix missing some metadata in gemspec.
+
+## 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
 
-- Use :offset instead of :begin_ at RubyExtractor.
 - Detect offenses from code that containing `if`, `unless`, `do`, etc.
 
 ## 0.10.0 - 2022-01-06

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    slimcop (0.11.0)
-      rainbow
-      rubocop (>= 0.87)
+    slimcop (0.14.0)
       slimi (>= 0.5.1)
+      templatecop
 
 GEM
   remote: https://rubygems.org/
@@ -45,10 +44,14 @@ GEM
     rubocop-rspec (2.6.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    slimi (0.7.0)
+    slimi (0.7.1)
       temple
       thor
       tilt
+    templatecop (0.2.0)
+      parallel
+      parser
+      rubocop (>= 0.87)
     temple (0.8.2)
     thor (1.2.1)
     tilt (2.0.10)

data/default.yml

@@ -103,6 +103,9 @@ Style/IdenticalConditionalBranches:
 Style/IfUnlessModifier:
   Enabled: false
 
+Style/MultilineTernaryOperator:
+  Enabled: false
+
 Style/Next:
   Enabled: false
 

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 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,7 +30,7 @@ module Slimcop
     # @return [Array<Hash>]
     def call
       ranges.map do |(begin_, end_)|
-        clipped = RubyClipper.new(@source[begin_...end_]).call
+        clipped = ::Templatecop::RubyClipper.new(@source[begin_...end_]).call
         {
           code: clipped[:code],
           offset: begin_ + clipped[:offset]

data/lib/slimcop/version.rb

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

data/lib/slimcop.rb

@@ -3,13 +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 :RubyClipper, 'slimcop/ruby_clipper'
   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

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
   spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -27,11 +28,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.metadata = {
-    '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.11.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2022-01-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
+  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,21 +60,16 @@ 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_clipper.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
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/r7kamura/slimcop
+  source_code_uri: https://github.com/r7kamura/slimcop
+  changelog_uri: https://github.com/r7kamura/slimcop/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []

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: .slimcop.yml or .rubocop.yml)') 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,65 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module Slimcop
-  class RuboCopConfigGenerator
-    DEFAULT_ADDITIONAL_CONFIG_PATH1 = '.slimcop.yml'
-    DEFAULT_ADDITIONAL_CONFIG_PATH2 = '.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_PATH1)
-            ::RuboCop::ConfigLoader.load_file(DEFAULT_ADDITIONAL_CONFIG_PATH1)
-          elsif ::File.exist?(DEFAULT_ADDITIONAL_CONFIG_PATH2)
-            ::RuboCop::ConfigLoader.load_file(DEFAULT_ADDITIONAL_CONFIG_PATH2)
-          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_clipper.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-module Slimcop
-  # Remove unnecessary part (e.g. `if`, `unless`, `do`, ...) from Ruby code.
-  class RubyClipper
-    # @param [String] code
-    def initialize(code)
-      @code = code
-    end
-
-    # @return [Hash]
-    def call
-      [
-        PrecedingKeywordRemover,
-        TrailingDoRemover
-      ].each_with_object(
-        code: @code,
-        offset: 0
-      ) do |klass, object|
-        result = klass.new(object[:code]).call
-        object[:code] = result[:code]
-        object[:offset] += result[:offset]
-      end
-    end
-
-    class PrecedingKeywordRemover
-      REGEXP = /
-        \A
-        (?:
-          begin
-          | case
-          | else
-          | elsif
-          | ensure
-          | if
-          | rescue
-          | unless
-          | until
-          | when
-          | while
-          | for[ \t]+\w+[ \t]+in
-        )
-        [ \t]
-      /x.freeze
-
-      # @param [String] code
-      def initialize(code)
-        @code = code
-      end
-
-      # @return [Hash]
-      def call
-        data = @code.match(REGEXP)
-        if data
-          offset = data[0].length
-          {
-            code: @code[offset..],
-            offset: offset
-          }
-        else
-          {
-            code: @code,
-            offset: 0
-          }
-        end
-      end
-    end
-
-    class TrailingDoRemover
-      REGEXP = /
-        [ \t]
-        do
-        [ \t]*
-        (\|[^|]*\|)?
-        [ \t]*
-        \Z
-      /x.freeze
-
-      # @param [String] code
-      def initialize(code)
-        @code = code
-      end
-
-      # @return [Hash]
-      def call
-        {
-          code: @code.sub(REGEXP, ''),
-          offset: 0
-        }
-      end
-    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_corrector.rb

@@ -1,42 +0,0 @@
-# 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<Slimcop::Offense>] offenses
-    # @param [String] source
-    def initialize(file_path:, offenses:, source:)
-      @file_path = file_path
-      @offenses = offenses
-      @source = source
-    end
-
-    # @return [String] Rewritten Slim code.
-    def call
-      ::RuboCop::Cop::Legacy::Corrector.new(source_buffer, corrections).rewrite
-    end
-
-    private
-
-    # @return [Array<Proc>]
-    def corrections
-      @offenses.select(&:corrector).map do |offense|
-        lambda do |corrector|
-          corrector.import!(offense.corrector, offset: offense.offset)
-        end
-      end
-    end
-
-    # @return [Parser::Source::Buffer]
-    def source_buffer
-      ::Parser::Source::Buffer.new(
-        @file_path,
-        source: @source
-      )
-    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[:offset],
-            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