erbcop 0.1.0

checksums.yaml

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,31 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Enabled: false
+
+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

@@ -0,0 +1,10 @@
+# Changelog
+
+## Unreleased
+
+## 0.1.0 - 2022-01-15
+
+### Added
+
+- Initial release.
+- Add almost the same features as slimcop 0.11.0.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at r7kamura@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in erbcop.gemspec
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-rspec'

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    erbcop (0.1.0)
+      better_html
+      rainbow
+      rubocop (>= 0.87)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (7.0.1)
+      activesupport (= 7.0.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    better_html (1.0.16)
+      actionview (>= 4.0)
+      activesupport (>= 4.0)
+      ast (~> 2.0)
+      erubi (~> 1.4)
+      html_tokenizer (~> 0.0.6)
+      parser (>= 2.4)
+      smart_properties
+    builder (3.2.4)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    html_tokenizer (0.0.7)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    loofah (2.13.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    minitest (5.15.0)
+    nokogiri (1.13.1-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.24.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (2.7.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    smart_properties (1.17.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  erbcop!
+  rake
+  rspec
+  rubocop
+  rubocop-rspec
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ryo Nakamura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# 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.
+
+This is the ERB version of [Slimcop](https://github.com/r7kamura/slimcop).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'erbcop'
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+Or install it yourself as:
+
+```
+gem install erbcop
+```
+
+## Usage
+
+Use `erbcop` executable to check offenses and auto-correct them.
+
+```console
+$ erbcop --help
+Usage: erbcop [options] [file1, file2, ...]
+    -a, --auto-correct               Auto-correct offenses.
+    -c, --config=                    Specify configuration file. (default: .erbcop.yml or .rubocop.yml)
+        --[no-]color                 Force color output on or off.
+```
+
+### Example
+
+```console
+$ erbcop 'spec/fixtures/**/*.erb'
+Inspecting 1 file
+C
+
+Offenses:
+
+spec/fixtures/dummy.erb:1:4: C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
+<% "a" %>
+   ^^^
+spec/fixtures/dummy.erb:4:9: C: [Correctable] Style/NumericPredicate: Use array.size.positive? instead of array.size > 0.
+<% a if array.size > 0 %>
+        ^^^^^^^^^^^^^^
+spec/fixtures/dummy.erb:4:9: C: [Correctable] Style/ZeroLengthPredicate: Use !empty? instead of size > 0.
+<% a if array.size > 0 %>
+        ^^^^^^^^^^^^^^
+spec/fixtures/dummy.erb:5:4: C: [Correctable] Style/NegatedIf: Favor unless over if for negative conditions.
+<% a if !b %>
+   ^^^^^^^
+
+1 file inspected, 4 offenses detected, 4 offenses auto-correctable
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/default.yml

@@ -0,0 +1,116 @@
+Layout/ArgumentAlignment:
+  Enabled: false
+
+Layout/ArrayAlignment:
+  Enabled: false
+
+Layout/BlockAlignment:
+  Enabled: false
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Lint/EmptyFile:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/EndAlignment:
+  Enabled: false
+
+Layout/FirstArgumentIndentation:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/FirstParameterIndentation:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/IndentationConsistency:
+  Enabled: false
+
+Layout/IndentationWidth:
+  Enabled: false
+
+Layout/InitialIndentation:
+  Enabled: false
+
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/MultilineArrayBraceLayout:
+  Enabled: false
+
+Layout/MultilineAssignmentLayout:
+  Enabled: false
+
+Layout/MultilineHashBraceLayout:
+  Enabled: false
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/MultilineMethodDefinitionBraceLayout:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Layout/ParameterAlignment:
+  Enabled: false
+
+Layout/TrailingEmptyLines:
+  Enabled: false
+
+Layout/TrailingWhitespace:
+  Enabled: false
+
+Lint/UselessAssignment:
+  Enabled: false
+
+Lint/Void:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/IdenticalConditionalBranches:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/WhileUntilDo:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Enabled: false

data/erbcop.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/erbcop/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'erbcop'
+  spec.version = Erbcop::VERSION
+  spec.authors = ['Ryo Nakamura']
+  spec.email = ['r7kamura@gmail.com']
+
+  spec.summary = 'RuboCop runner for ERB template.'
+  spec.homepage = 'https://github.com/r7kamura/erbcop'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  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 'better_html'
+  spec.add_dependency 'rainbow'
+  spec.add_dependency 'rubocop', '>= 0.87'
+end

data/exe/erbcop

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'erbcop'
+
+Erbcop::Cli.new(ARGV).call

data/lib/erbcop/cli.rb

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

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

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

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

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

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

@@ -0,0 +1,93 @@
+# 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_extractor.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'better_html'
+require 'better_html/parser'
+
+module Erbcop
+  # Extract Ruby codes from Erb source.
+  class RubyExtractor
+    # @param [String, nil] file_path
+    # @param [String] source
+    def initialize(file_path:, source:)
+      @file_path = file_path
+      @source = source
+    end
+
+    # @return [Array<Hash>]
+    def call
+      nodes.map do |node|
+        snippet = node.children.first
+        clipped = RubyClipper.new(snippet).call
+        {
+          code: clipped[:code],
+          offset: node.location.begin_pos + clipped[:offset]
+        }
+      end
+    end
+
+    private
+
+    # @return [Enumerator<BetterHtml::AST::Node>]
+    def nodes
+      ::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
+    end
+  end
+end

data/lib/erbcop/ruby_offense_collector.rb

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

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

data/lib/erbcop/version.rb

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

data/lib/erbcop.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'erbcop/version'
+
+module Erbcop
+  autoload :Cli, 'erbcop/cli'
+  autoload :Offense, 'erbcop/offense'
+  autoload :PathFinder, 'erbcop/path_finder'
+  autoload :RuboCopConfigGenerator, 'erbcop/rubo_cop_config_generator'
+  autoload :RubyClipper, 'erbcop/ruby_clipper'
+  autoload :RubyExtractor, 'erbcop/ruby_extractor'
+  autoload :RubyOffenseCollector, 'erbcop/ruby_offense_collector'
+  autoload :Runner, 'erbcop/runner'
+  autoload :ErbCorrector, 'erbcop/erb_corrector'
+  autoload :ErbOffenseCollector, 'erbcop/erb_offense_collector'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: erbcop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: better_html
+  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: 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
+    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
+executables:
+- erbcop
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- default.yml
+- 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:
+- MIT
+metadata:
+  homepage_uri: https://github.com/r7kamura/erbcop
+  source_code_uri: https://github.com/r7kamura/erbcop
+  changelog_uri: https://github.com/r7kamura/erbcop/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: RuboCop runner for ERB template.
+test_files: []