erbcop 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83b12a5974c220329d0f7e7afd819ccb684393822e42afb1c313a7222b101ddc
-  data.tar.gz: 395fb3c1ed1b1d3e06fd5fba735528092825adb6b6152d3de8564d95d90733ed
+  metadata.gz: 0f9f5330f08da6f5c0f830990aa71a99dd28a26c298225daac38d7e093e23e9b
+  data.tar.gz: dc59cbbe140b340162018f7ad8201ce1dcf93723e917b18b28d2ed95e22bf737
 SHA512:
-  metadata.gz: 02f26eb4e0dc4db0047aa0e75bff070073f099b7e7f2f1ce463e27852769bac04af383dea0864985586639f189d848174d3b17bc85d9cf0bbdb91442dfdc0bce
-  data.tar.gz: ac2022f7afea7cf9b1338bcf61c4b8bd2c14f970ac6eba26be4839ec45b9b96a71e5a71f4f4051013fef1fff354f3cc8723ecbc8bee5c8d552d6f4884156ed1a
+  metadata.gz: cfe447c8f1063d4ca7a80f8d8ae27b999de085c98326185b5ba59e74ca7b8d02fef2a9ad3cf92f9d0013f2f4970befcc38ece49b328fbb47ef87c9e0b082cd48
+  data.tar.gz: 5bfa9369536dc698dfee9d32df8a8ce893f2fcf663ec2644f1b0f4f2fb38b8da088f95519f206031c808560339a9d4746b613c8f0122a9cffa9b30050d189bbd

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## Unreleased
 
+## 0.4.0 - 2022-01-22
+
+### Changed
+
+- Disable Style/NestedTernaryOperator by default.
+
+## 0.3.0 - 2022-01-22
+
+### Changed
+
+- Disable Style/MultilineTernaryOperator by default.
+
+## 0.2.1 - 2022-01-22
+
+### Fixed
+
+- Exclude code in ERB comment.
+
+## 0.2.0 - 2022-01-15
+
+### Changed
+
+- Use templatecop.
+
 ## 0.1.0 - 2022-01-15
 
 ### Added

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    erbcop (0.1.0)
+    erbcop (0.4.0)
       better_html
-      rainbow
-      rubocop (>= 0.87)
+      templatecop
 
 GEM
   remote: https://rubygems.org/
@@ -84,6 +83,10 @@ GEM
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     smart_properties (1.17.0)
+    templatecop (0.2.0)
+      parallel
+      parser
+      rubocop (>= 0.87)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)

data/README.md

@@ -1,5 +1,6 @@
 # Erbcop
 
+[![Gem Version](https://badge.fury.io/rb/erbcop.svg)](https://rubygems.org/gems/erbcop)
 [![test](https://github.com/r7kamura/erbcop/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/erbcop/actions/workflows/test.yml)
 
 [RuboCop](https://github.com/rubocop/rubocop) runner for ERB template.

data/default.yml

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

data/erbcop.gemspec

@@ -30,6 +30,5 @@ Gem::Specification.new do |spec|
   spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.add_dependency 'better_html'
-  spec.add_dependency 'rainbow'
-  spec.add_dependency 'rubocop', '>= 0.87'
+  spec.add_dependency 'templatecop'
 end

data/exe/erbcop

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

data/lib/erbcop/ruby_extractor.rb

@@ -2,10 +2,25 @@
 
 require 'better_html'
 require 'better_html/parser'
+require 'templatecop'
 
 module Erbcop
   # Extract Ruby codes from Erb 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:)
@@ -17,7 +32,7 @@ module Erbcop
     def call
       nodes.map do |node|
         snippet = node.children.first
-        clipped = RubyClipper.new(snippet).call
+        clipped = ::Templatecop::RubyClipper.new(snippet).call
         {
           code: clipped[:code],
           offset: node.location.begin_pos + clipped[:offset]
@@ -27,36 +42,29 @@ module Erbcop
 
     private
 
+    # @return [Array<BetterHtml::AST::Node>]
+    def erbs
+      root.descendants(:erb).reject do |erb|
+        erb.children.first&.type == :indicator && erb.children.first&.to_a&.first == '#'
+      end
+    end
+
     # @return [Enumerator<BetterHtml::AST::Node>]
     def nodes
+      erbs.flat_map do |erb|
+        erb.descendants(:code).to_a
+      end
+    end
+
+    # @return [BetterHtml::AST::Node]
+    def root
       ::BetterHtml::Parser.new(
         ::Parser::Source::Buffer.new(
           @file_path,
           source: @source
         ),
         template_language: :html
-      ).ast.descendants(:code)
-    end
-
-    # @return [Array<Array<Integer>>]
-    def ranges
-      result = []
-      traverse(ast) do |begin_, end_|
-        result << [begin_, end_]
-      end
-      result
-    end
-
-    def traverse(node, &block)
-      return unless node.instance_of?(::Array)
-
-      if node[0] == :erbi && node[1] == :position
-        block.call(node[2], node[3])
-      else
-        node.each do |element|
-          traverse(element, &block)
-        end
-      end
+      ).ast
     end
   end
 end

data/lib/erbcop/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erbcop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: better_html
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: templatecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.87'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.87'
 description: 
 email:
 - r7kamura@gmail.com
@@ -73,16 +59,7 @@ files:
 - erbcop.gemspec
 - exe/erbcop
 - lib/erbcop.rb
-- lib/erbcop/cli.rb
-- lib/erbcop/erb_corrector.rb
-- lib/erbcop/erb_offense_collector.rb
-- lib/erbcop/offense.rb
-- lib/erbcop/path_finder.rb
-- lib/erbcop/rubo_cop_config_generator.rb
-- lib/erbcop/ruby_clipper.rb
 - lib/erbcop/ruby_extractor.rb
-- lib/erbcop/ruby_offense_collector.rb
-- lib/erbcop/runner.rb
 - lib/erbcop/version.rb
 homepage: https://github.com/r7kamura/erbcop
 licenses:

data/lib/erbcop/cli.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require 'rainbow'
-require 'rubocop'
-
-module Erbcop
-  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
-
-      offenses = Runner.new(
-        auto_correct: options[:auto_correct],
-        file_paths: file_paths,
-        formatter: formatter,
-        rubocop_config: rubocop_config
-      ).call
-
-      exit(offenses.empty? ? 0 : 1)
-    end
-
-    private
-
-    # @return [Hash]
-    def parse!
-      options = {}
-      parser = ::OptionParser.new
-      parser.banner = 'Usage: erbcop [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: .erbcop.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/erbcop/erb_corrector.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'parser'
-require 'rubocop/cop/legacy/corrector'
-
-module Erbcop
-  # Apply auto-corrections to Erb file.
-  class ErbCorrector
-    # @param [String] file_path
-    # @param [Array<Erbcop::Offense>] offenses
-    # @param [String] source
-    def initialize(file_path:, offenses:, source:)
-      @file_path = file_path
-      @offenses = offenses
-      @source = source
-    end
-
-    # @return [String] Rewritten Erb 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/erbcop/erb_offense_collector.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Erbcop
-  # Collect RuboCop offenses from Erb code.
-  class ErbOffenseCollector
-    # @param [Boolean] auto_correct
-    # @param [String] file_path Erb file path
-    # @param [RuboCop::Config] rubocop_config
-    # @param [String] source Erb 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<Erbcop::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

data/lib/erbcop/offense.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-
-require 'parser'
-require 'rubocop'
-
-module Erbcop
-  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 Erb 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/erbcop/path_finder.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require 'pathname'
-
-module Erbcop
-  # Collect file paths from given path patterns.
-  class PathFinder
-    DEFAULT_PATH_PATTERNS = %w[
-      **/*.erb
-    ].freeze
-
-    # @param [Array<String>] patterns Patterns normally given as CLI arguments (e.g. `["app/views/**/*.html.erb"]`).
-    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/erbcop/rubo_cop_config_generator.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module Erbcop
-  class RuboCopConfigGenerator
-    DEFAULT_ADDITIONAL_CONFIG_PATH1 = '.erbcop.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 || erbcop_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 = erbcop_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 erbcop_default_config
-      ::RuboCop::ConfigLoader.load_file(erbcop_default_config_file_path)
-    end
-
-    # @return [String]
-    def erbcop_default_config_file_path
-      @erbcop_default_config_file_path ||= ::File.expand_path('../../default.yml', __dir__)
-    end
-  end
-end

data/lib/erbcop/ruby_clipper.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-module Erbcop
-  # 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/erbcop/ruby_offense_collector.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module Erbcop
-  # 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/erbcop/runner.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-module Erbcop
-  # Run investigation and auto-correcttion.
-  class Runner
-    # @param [Boolean] auto_correct
-    # @param [Array<String>] file_paths
-    # @param [Object] formatter
-    # @param [RuboCop::Config] rubocop_config
-    def initialize(
-      auto_correct:,
-      file_paths:,
-      formatter:,
-      rubocop_config:
-    )
-      @auto_correct = auto_correct
-      @file_paths = file_paths
-      @formatter = formatter
-      @rubocop_config = rubocop_config
-    end
-
-    # @return [Array<RuboCop::Cop::Offense>]
-    def call
-      on_started
-      offenses = investigate_and_correct
-      on_finished
-      offenses
-    end
-
-    private
-
-    # @param [String] file_path
-    # @param [Array<Erbcop::Offense>] offenses
-    # @param [String] source
-    def correct(file_path:, offenses:, source:)
-      rewritten_source = ErbCorrector.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<Erbcop::Offense>]
-    def investigate(auto_correct:, file_path:, rubocop_config:, source:)
-      ErbOffenseCollector.new(
-        auto_correct: auto_correct,
-        file_path: file_path,
-        rubocop_config: rubocop_config,
-        source: source
-      ).call
-    end
-
-    # @return [Array<RuboCop::Cop::Offense>]
-    def investigate_and_correct
-      @file_paths.flat_map do |file_path|
-        offenses_per_file = []
-        max_trials_count.times do
-          on_file_started(file_path)
-          source = ::File.read(file_path)
-          offenses = investigate(
-            auto_correct: @auto_correct,
-            file_path: file_path,
-            rubocop_config: @rubocop_config,
-            source: source
-          )
-          offenses_per_file += offenses
-          break if offenses.empty?
-
-          next unless @auto_correct
-
-          correct(
-            file_path: file_path,
-            offenses: offenses,
-            source: source
-          )
-        end
-        on_file_finished(file_path, offenses_per_file)
-        offenses_per_file
-      end
-    end
-
-    # @return [Integer]
-    def max_trials_count
-      if @auto_correct
-        7 # What a heuristic number.
-      else
-        1
-      end
-    end
-
-    def on_started
-      @formatter.started(@file_paths)
-    end
-
-    # @param [String] file_path
-    def on_file_started(file_path)
-      @formatter.file_started(file_path, {})
-    end
-
-    # @param [String] file_path
-    # @param [Array<RuboCop::Cop::Offenses]
-    def on_file_finished(file_path, offenses)
-      @formatter.file_finished(file_path, offenses)
-    end
-
-    def on_finished
-      @formatter.finished(@file_paths)
-    end
-  end
-end