rubocop-elegant 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3a3c039c33e63e1f6f6060c046c611f6930788518f792b8b2207d10565466e0
+  data.tar.gz: 83efd07a973b2c71c4b1a33306874d0544d9717415b61861a49dc3a4c5415a2d
+SHA512:
+  metadata.gz: 1cf1d9d1521ca0471c0a04c482049db3d1bd6f49eccbdb6effa53e1f316363879b56b95911ee11dbc31de05775f56698f6e2a01eacb9c2e01d565e829eb2829c
+  data.tar.gz: 003315aa360d8a7f92b6c1f401013c40f23d01d3f22be6781223d96bfc936ed31d95f70a4fe2517e8ad506880d103316182eed3e498ed14352cc7119dfc0ef14

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+source 'https://rubygems.org'
+gemspec
+
+gem 'minitest', '~>6.0', require: false
+gem 'minitest-reporters', '~>1.7', require: false
+gem 'rake', '~>13.2', require: false
+gem 'rdoc', '7.1.0', require: false
+gem 'rubocop', '~>1.74', require: false
+gem 'rubocop-minitest', '~>0.38', require: false
+gem 'rubocop-performance', '~>1.25', require: false
+gem 'rubocop-rake', '~>0.7', require: false
+gem 'simplecov', '~>0.22', require: false
+gem 'simplecov-cobertura', '~>3.0', require: false
+gem 'yard', '~>0.9', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-2026 Yegor Bugayenko
+
+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 NON-INFRINGEMENT. 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/LICENSES/MIT.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-2026 Yegor Bugayenko
+
+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 NON-INFRINGEMENT. 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,46 @@
+# RuboCop Cop for Elegant Ruby Code
+
+[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
+[![DevOps By Rultor.com](https://www.rultor.com/b/yegor256/rubocop-elegant)](https://www.rultor.com/p/yegor256/rubocop-elegant)
+[![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
+
+[![rake](https://github.com/yegor256/rubocop-elegant/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/rubocop-elegant/actions/workflows/rake.yml)
+[![Gem Version](https://badge.fury.io/rb/rubocop-elegant.svg)](https://badge.fury.io/rb/rubocop-elegant)
+[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/github/yegor256/rubocop-elegant/master/frames)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/rubocop-elegant/blob/master/LICENSE.txt)
+[![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/rubocop-elegant.svg)](https://codecov.io/github/yegor256/rubocop-elegant?branch=master)
+[![Hits-of-Code](https://hitsofcode.com/github/yegor256/rubocop-elegant)](https://hitsofcode.com/view/github/yegor256/rubocop-elegant)
+
+First, install it:
+
+```bash
+gem install rubocop-elegant
+```
+
+Then, add it to your `.rubocop.yml`:
+
+```yaml
+plugins:
+  - rubocop-elegant
+```
+
+Should work.
+
+## How to contribute
+
+Read
+[these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
+Make sure your build is green before you contribute
+your pull request. You will need to have
+[Ruby](https://www.ruby-lang.org/en/) 2.3+ and
+[Bundler](https://bundler.io/) installed. Then:
+
+```bash
+bundle update
+bundle exec rake
+```
+
+If it's clean and you don't see any error messages, submit your pull request.
+
+[rubocop-elegant]: https://www.rubydoc.info/github/yegor256/rubocop-elegant/master/rubocop-elegant
+[fluent interface]: https://en.wikipedia.org/wiki/Fluent_interface

data/REUSE.toml

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+version = 1
+[[annotations]]
+path = [
+    ".DS_Store",
+    ".gitattributes",
+    ".gitignore",
+    ".pdd",
+    "**.json",
+    "**.md",
+    "**.png",
+    "**.svg",
+    "**.txt",
+    "**/.DS_Store",
+    "**/.gitignore",
+    "**/.pdd",
+    "**/*.csv",
+    "**/*.jpg",
+    "**/*.json",
+    "**/*.md",
+    "**/*.pdf",
+    "**/*.png",
+    "**/*.svg",
+    "**/*.txt",
+    "**/*.vm",
+    "**/CNAME",
+    "**/Gemfile.lock",
+    "Gemfile.lock",
+    "README.md",
+    "renovate.json",
+]
+precedence = "override"
+SPDX-FileCopyrightText = "Copyright (c) 2025 Yegor Bugayenko"
+SPDX-License-Identifier = "MIT"

data/Rakefile

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+
+CLEAN.include('coverage')
+
+def name
+  @name ||= File.basename(Dir['*.gemspec'].first, '.*')
+end
+
+def version
+  Gem::Specification.load(Dir['*.gemspec'].first).version
+end
+
+task default: %i[clean test rubocop yard]
+
+require 'rake/testtask'
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = false
+end
+
+require 'yard'
+desc 'Build Yard documentation'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+  t.options = ['--fail-on-warning']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.fail_on_error = true
+end

data/config/default.yml

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+---
+Elegant:
+  Enabled: true
+  DocumentationBaseURL: https://github.com/yegor256/rubocop-elegant
+Elegant/NoComments:
+  Description: 'Disallows comments in source code, except SPDX license comments'
+  Enabled: true
+  VersionAdded: '0.0.1'

data/lib/rubocop/cop/elegant/no_comments.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+module RuboCop
+  module Cop
+    module Elegant
+      class NoComments < Base
+        extend AutoCorrector
+
+        MSG = 'Comment is not allowed, unless it is SPDX, magic, or rubocop directive'
+
+        def on_new_investigation
+          processed_source.comments.each do |comment|
+            register(comment) unless allowed?(comment)
+          end
+        end
+
+        private
+
+        def allowed?(comment)
+          spdx?(comment) || magic?(comment) || rubocop?(comment)
+        end
+
+        def spdx?(comment)
+          comment.text.match?(/^#\s*SPDX-/)
+        end
+
+        def magic?(comment)
+          comment.text.match?(/^#\s*(frozen_string_literal|encoding|coding|warn_indent):/)
+        end
+
+        def rubocop?(comment)
+          comment.text.match?(/^#\s*rubocop:(disable|enable|todo)\s/)
+        end
+
+        def register(comment)
+          add_offense(comment) do |corrector|
+            corrector.remove(removal_range(comment))
+          end
+        end
+
+        def removal_range(comment)
+          range = comment.source_range
+          line_start = range.source_line[0, range.column]
+          return range_with_line(range) if line_start.strip.empty?
+          range_with_prefix(range, line_start)
+        end
+
+        def range_with_line(range)
+          start_pos = range.begin_pos - range.column
+          end_pos = range.end_pos
+          end_pos += 1 if newline_after?(end_pos)
+          range.with(begin_pos: start_pos, end_pos: end_pos)
+        end
+
+        def range_with_prefix(range, prefix)
+          whitespace = prefix.match(/\s*$/)[0]
+          range.with(begin_pos: range.begin_pos - whitespace.length, end_pos: range.end_pos)
+        end
+
+        def newline_after?(pos)
+          processed_source.buffer.source[pos] == "\n"
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/elegant_cops.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require_relative 'elegant/no_comments'

data/lib/rubocop/elegant/plugin.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'lint_roller'
+
+module RuboCop
+  module Elegant
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-elegant',
+          version: VERSION,
+          homepage: 'https://github.com/yegor256/rubocop-elegant',
+          description: 'Set of custom RuboCop cops for elegant Ruby coding'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/elegant/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+module RuboCop
+  module Elegant
+    VERSION = '0.0.1'
+  end
+end

data/lib/rubocop-elegant.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'rubocop'
+require_relative 'rubocop/elegant/version'
+require_relative 'rubocop/elegant/plugin'
+require_relative 'rubocop/cop/elegant_cops'

data/rubocop-elegant.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'English'
+
+Gem::Specification.new do |s|
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.required_ruby_version = '>=2.2'
+  s.name = 'rubocop-elegant'
+  s.version = '0.0.1'
+  s.license = 'MIT'
+  s.summary = 'Set of custom RuboCop cops for elegant Ruby coding'
+  s.description =
+    'Explain it here...'
+  s.authors = ['Yegor Bugayenko']
+  s.email = 'yegor256@gmail.com'
+  s.homepage = 'https://github.com/yegor256/rubocop-elegant'
+  s.files = `git ls-files | grep -v -E '^(test/|\\.|renovate)'`.split($RS)
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = ['README.md']
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-elegant
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yegor Bugayenko
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Explain it here...
+email: yegor256@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- LICENSE.txt
+- LICENSES/MIT.txt
+- README.md
+- REUSE.toml
+- Rakefile
+- config/default.yml
+- lib/rubocop-elegant.rb
+- lib/rubocop/cop/elegant/no_comments.rb
+- lib/rubocop/cop/elegant_cops.rb
+- lib/rubocop/elegant/plugin.rb
+- lib/rubocop/elegant/version.rb
+- rubocop-elegant.gemspec
+homepage: https://github.com/yegor256/rubocop-elegant
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Set of custom RuboCop cops for elegant Ruby coding
+test_files: []