rubocop-grep 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d17d31d5330cf736985149bc97d6450855687f0c51f600e2255e74bdd0919a1d
+  data.tar.gz: f0d95990a73f923fa3206e5b965d2f9a719947e9fbfb76b85a44f64a87df4df1
+SHA512:
+  metadata.gz: 6bc2ef94f372ae4d545ac5f320d30d4d876f58d35b4e659a18b4b833c46ff3cdba658f31a456c8f0a7cd85e6057baee75ee3cee19880c8767a23b70908e75590
+  data.tar.gz: d89343cd6f8c90e1302275ec8415dd2956c0fa0c4c32daed7ef7cfe361a7245e6fd37e1f168e6c9e5f647ffb94ccfbb123f9872f0f2f7cdc12301d5c2a2f71aa

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Naming/FileName:
+ Exclude:
+   - lib/rubocop-grep.rb

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-grep.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem 'steep', '1.4.0.dev.2', require: false
+gem 'rbs', require: false

data/README.md

@@ -0,0 +1,129 @@
+# rubocop-grep
+
+It is a RuboCop extension to define your cop with regexps.
+
+Sometimes you need a custom cop to detect a problem. For example, if you need a cop to detect your internal library, RuboCop's core rules are not helpful.
+But creating a new cop is not easy enough if you are not familiar with RuboCop. You need to know AST, RuboCop's API, and so on.
+
+In this case, rubocop-grep can be helpful. You can create a custom cop only with a Regular expression! If a regexp is enough to detect your problem, this gem can be the best way to solve the problem.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rubocop-grep --require=false
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rubocop-grep
+
+## Usage
+
+First of all, you need to tell RuboCop to load this extension. 
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-grep
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rubocop-grep
+```
+
+Then, define your rule in `.rubocop.yml` like the following.
+
+```yaml
+Grep/Grep:
+  Rules:
+    # The simplest rule definition. It warns if the regexp matches your code.
+    - Pattern: '\bENV\b'
+      Message: Do not refer ENV directly.
+
+    # Pattern can be an array.
+    - Pattern:
+        - 'binding\.irb'
+        - 'binding\.pry'
+      Message: 'Debug code remains'
+
+    # The pattern matches code comments with `comment: true` option (default: false).
+    - Pattern: 'Rspec'
+      Message: 'Rspec is a typo of RSpec'
+      MatchInComment: true
+```
+
+## Similar Projects
+
+There are some similar projects to solve similar problems. Probably you should use one of the similar projects instead of rubocop-grep.
+
+### grep (1)
+
+You can simply use `grep (1)` command, or `git grep (1)`.
+
+* Pros
+  * They are available in most environments.
+  * You can use them for non-Ruby files too.
+* Cons
+  * They are not integrated with RuboCop.
+    * rubocop-grep is fully integrated with RuboCop. It means you can integrate this gem out-of-the-box with CI, editors, and so on.
+    * But you need to set up a workflow for `grep (1)` if you want to use it on CI.
+  * They do not have a configuration file.
+    * You can configure rubocop-grep with `.rubocop.yml`, but you cannot configure grep.
+
+If regexp is enough for your problem and you do not need RuboCop integration, `grep (1)` is a good solution.
+
+### Querly
+
+https://github.com/soutaro/querly
+
+Querly is a gem to detect a problem by the original query language.
+
+* Pros
+  * The query is more powerful than regexp.
+    * It is based on AST, so you can ignore whitespaces, the order of keyword arguments, and so on.
+* Cons
+  * They are not integrated with RuboCop.
+
+If you need more powerful queries and you do not need RuboCop integration, Querly is a good solution.
+
+### Goodcheck
+
+https://github.com/sider/goodcheck
+
+Goodcheck is a linter based on Regexp.
+
+* Pros
+  * It supports a tokenizer too.
+    * If you use a tokenizer, you don't need to care about whitespaces.
+  * You can use it for non-Ruby files too.
+  * It has a configuration file.
+* Cons
+  * They are not integrated with RuboCop.
+
+If regexp is enough for your problem and you do not need RuboCop integration, Goodcheck is a good solution.
+
+### Creating a custom cop by yourself
+
+You can also create a custom cop by yourself to solve your problem.
+
+* Pros
+  * Creating a custom cop is the most powerful approach in similar projects.
+    * It can find any problem that can be detected statically.
+* Cons
+  * You need to know AST, RuboCop API, and so on.
+
+If regexp is not enough for your problem and you are familiar with RuboCop, creating a custom cop is a good solution.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pocke/rubocop-grep.

data/Rakefile

@@ -0,0 +1,37 @@
+# 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]
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate a new cop with a template'
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/grep_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/Steepfile

@@ -0,0 +1,10 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+
+  check "lib"
+  configure_code_diagnostics(D::Ruby.all_error) do |hash|
+    hash[D::Ruby::MethodDefinitionMissing] = :hint
+  end
+end

data/config/default.yml

@@ -0,0 +1,6 @@
+# Write it!
+
+Grep/Grep:
+  Description: 'It is a RuboCop extension to define your own cop with regexps.'
+  Enabled: true
+  VersionAdded: '0.1'

data/lib/rubocop/cop/grep/grep.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grep
+      # Detect code snippets which are matched with specified Regexps.
+      class Grepx < Base
+        include RangeHelp
+
+        def on_new_investigation
+          source = processed_source.raw_source
+
+          cop_config['Rules'].each do |rule|
+            match_comment = rule['MatchInComment']
+
+            # @type var patterns: Array[String]
+            patterns = _ = Array(rule['Pattern'])
+
+            opt = regexp_option(rule)
+            patterns.each do |pat|
+              re = Regexp.new(pat, opt)
+              from = 0
+              while m = re.match(source, from)
+                if match_comment || !in_comment?(m)
+                  pos = position_from_matchdata(m)
+                  range = source_range(processed_source.buffer, pos[:line], pos[:column], pos[:length])
+                  add_offense(range, message: rule['Message'])
+                end
+                from = m.end(0) || raise
+              end
+            end
+          end
+        end
+
+        private def position_from_matchdata(m)
+          pre_match = m.pre_match
+          line = pre_match.count("\n") + 1
+          column = pre_match[/^([^\n]*)\z/, 1]&.size || 0
+          matched = m[0] or raise
+          length = matched.size
+
+          { line: line, column: column, length: length }
+        end
+
+        private def in_comment?(m)
+          line = position_from_matchdata(m)[:line]
+          processed_source.comments.any? { |c| c.loc.line == line }
+        end
+
+        private def regexp_option(rule)
+          opt = 0
+          opt |= Regexp::MULTILINE if rule['Multiline']
+          opt |= Regexp::EXTENDED if rule['Extended']
+          opt |= Regexp::IGNORECASE if rule['Ignorecase']
+          opt
+        end
+      end
+
+      Grep = _ = Grepx
+    end
+  end
+end

data/lib/rubocop/cop/grep_cops.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require_relative 'grep/grep'

data/lib/rubocop/grep/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Grep
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = (_ = Config.new(hash, path)).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/grep/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Grep
+    VERSION = "0.1.0"
+  end
+end

data/lib/rubocop/grep.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "grep/version"
+
+module RuboCop
+  module Grep
+    # Your code goes here...
+    PROJECT_ROOT   = Pathname.new(__dir__ || raise).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end
+

data/lib/rubocop-grep.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/grep'
+require_relative 'rubocop/grep/version'
+require_relative 'rubocop/grep/inject'
+
+RuboCop::Grep::Inject.defaults!
+
+require_relative 'rubocop/cop/grep_cops'

data/rbs_collection.lock.yaml

@@ -0,0 +1,54 @@
+---
+sources:
+- type: git
+  name: ruby/gem_rbs_collection
+  revision: 7765c1821affc50f5b09fda8fba3a7c9b429b216
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 03012a67119a706eb045ed758b8366b03eefc3cd
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: dbm
+  version: '0'
+  source:
+    type: stdlib
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7765c1821affc50f5b09fda8fba3a7c9b429b216
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib
+- name: pstore
+  version: '0'
+  source:
+    type: stdlib
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 03012a67119a706eb045ed758b8366b03eefc3cd
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: yaml
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,21 @@
+# Download sources
+sources:
+  - name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Skip loading rbs gem's RBS.
+  # It's unnecessary if you don't use rbs as a library.
+  - name: rbs
+    ignore: true
+  - name: steep
+    ignore: true
+  - name: rubocop-grep
+    ignore: true
+  - name: pathname
+  - name: yaml

data/rubocop-grep.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/grep/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rubocop-grep"
+  spec.version = RuboCop::Grep::VERSION
+  spec.authors = ["Masataka Pocke Kuwabara"]
+  spec.email = ["kuwabara@pocke.me"]
+
+  spec.summary = "It is a RuboCop extension to define your own cop with regexps."
+  spec.description = "It is a RuboCop extension to define your own cop with regexps."
+  spec.homepage = "https://github.com/pocke/rubocop-grep"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.add_runtime_dependency 'rubocop'
+end

data/sig/_shim.rbs

@@ -0,0 +1,66 @@
+module RuboCop
+  class ConfigLoader
+    def self.debug?: () -> boolish
+    def self.merge_with_default: (Config, String) -> Config
+  end
+
+  class Config
+    def initialize: (Hash[untyped, untyped], String) -> void
+  end
+
+  module Cop
+    class Base
+      extend AST::NodePattern::Macros
+
+      def add_offense: (untyped node, ?message: String) -> void
+      def cop_config: () -> Hash[String, untyped]
+      def processed_source: () -> AST::ProcessedSource
+    end
+
+    module RangeHelp
+      def source_range: (Parser::Source::Buffer source_buffer, Integer line_number, Integer column, ?Integer length) -> Parser::Source::Range 
+    end
+  end
+
+  class ProcessedSource = AST::ProcessedSource
+end
+
+module RuboCop
+  module AST
+    class ProcessedSource
+      def raw_source: () -> String
+      def buffer: () -> Parser::Source::Buffer
+      def comments: () -> Array[Parser::Source::Comment]
+    end
+
+    module NodePattern
+      module Macros
+        def def_node_matcher: (Symbol, String) -> void
+      end
+    end
+  end
+end
+
+module Parser
+  module Source
+    class Range
+    end
+
+    class Buffer
+    end
+
+    class Map
+      def line: () -> Integer
+      def first_line: () -> Integer
+      def last_line: () -> Integer
+      def column: () -> Integer
+      def first_column: () -> Integer
+      def last_column: () -> Integer
+    end
+
+    class Comment
+      def location: () -> Map
+      alias loc location
+    end
+  end
+end

data/sig/manifest.yaml

@@ -0,0 +1,3 @@
+dependencies:
+  - name: yaml
+  - name: pathname

data/sig/rubocop/cop/cop/grep.rbs

@@ -0,0 +1,40 @@
+module RuboCop
+  module Cop
+    module Grep
+      class Grepx < ::RuboCop::Cop::Base
+        include RangeHelp
+
+        type rule = {
+          'Pattern' => String | Array[String],
+          'Message' => String,
+          'MatchInComment' => bool?,
+
+          # Regexp options
+          'Multiline' => bool?,
+          'Extended' => bool?,
+          'Ignorecase' => bool?,
+        }
+
+        type config = {
+          'Rules' => Array[rule]
+        }
+
+        def on_new_investigation: () -> void
+
+        private def position_from_matchdata: (MatchData) -> {
+          line: Integer,
+          column: Integer,
+          length: Integer,
+        }
+
+        private def in_comment?: (MatchData) -> bool
+
+        private def regexp_option: (rule) -> Integer
+
+        def cop_config: () -> config
+      end
+      # HACK: Steep has a bug when the class name is the same as the parent namespace name.
+      class Grep = Grepx
+    end
+  end
+end

data/sig/rubocop/grep/inject.rbs

@@ -0,0 +1,7 @@
+module RuboCop
+  module Grep
+    module Inject
+      def self.defaults!: () -> void
+    end
+  end
+end

data/sig/rubocop/grep.rbs

@@ -0,0 +1,9 @@
+module RuboCop
+  module Grep
+    VERSION: String
+
+    PROJECT_ROOT: Pathname
+    CONFIG_DEFAULT: Pathname
+    CONFIG: untyped
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-grep
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masataka Pocke Kuwabara
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+description: It is a RuboCop extension to define your own cop with regexps.
+email:
+- kuwabara@pocke.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- Steepfile
+- config/default.yml
+- lib/rubocop-grep.rb
+- lib/rubocop/cop/grep/grep.rb
+- lib/rubocop/cop/grep_cops.rb
+- lib/rubocop/grep.rb
+- lib/rubocop/grep/inject.rb
+- lib/rubocop/grep/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- rubocop-grep.gemspec
+- sig/_shim.rbs
+- sig/manifest.yaml
+- sig/rubocop/cop/cop/grep.rbs
+- sig/rubocop/grep.rbs
+- sig/rubocop/grep/inject.rbs
+homepage: https://github.com/pocke/rubocop-grep
+licenses: []
+metadata:
+  homepage_uri: https://github.com/pocke/rubocop-grep
+  source_code_uri: https://github.com/pocke/rubocop-grep
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.0.dev
+signing_key:
+specification_version: 4
+summary: It is a RuboCop extension to define your own cop with regexps.
+test_files: []