officer_neetzsche 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 271ee4879a7e1972dfd96edbf5ed8db9ce1edcd6c642631f52d6aa77bba9f7c6
+  data.tar.gz: 4d6ce8fb83453d12b2bdbe4824974e776247fbbdb2a3f304d8f4fcf641fb9a5a
+SHA512:
+  metadata.gz: f2380fae302b365699c193d7b8721ca3ed35a56e18b039b9c335ac4bb79815db3c35afaad341512e737c06332dc35ac752d9233ed518dc92c77bb1f777610314
+  data.tar.gz: 702240bef2cf52c4fab6882271c737f0b5381d48917e3b3a10bdc43d4d36433dc1139eb6dc798db07495d9f6ca74608bc21283de9d690b8a8260a3e0490c2d62

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.1.0 (unreleased)
+
+- Add `NEETzsche/NoComments`, ported from hyperborea-news.
+- Disable `Style/Documentation` whenever the plugin is loaded, since it demands the comments `NEETzsche/NoComments` forbids.

data/README.md

@@ -0,0 +1,138 @@
+# OfficerNEETzsche
+
+RuboCop cops that enforce NEETzsche-isms. Every cop ships enabled: register the plugin and the rules apply.
+
+## Cops
+
+| Cop | Enforces | Autocorrect |
+| --- | --- | --- |
+| `NEETzsche/NoComments` | No comments. The code explains itself. | Yes |
+
+## Requirements
+
+- Ruby 2.7 or newer.
+- RuboCop 1.72 or newer, which introduced `plugins:`.
+
+## Installation
+
+Add the gem to your `Gemfile`:
+
+```ruby
+group :development, :test do
+  gem "officer_neetzsche", require: false
+end
+```
+
+Until the gem is published to RubyGems, point Bundler at the repository instead:
+
+```ruby
+group :development, :test do
+  gem "officer_neetzsche", github: "TheStranjer/OfficerNEETzsche", require: false
+end
+```
+
+Then run `bundle install`.
+
+## Usage
+
+Register the plugin in `.rubocop.yml`:
+
+```yaml
+plugins:
+  - officer_neetzsche
+```
+
+That is the whole setup. Every cop in the `NEETzsche` department is enabled by default, so `bundle exec rubocop` enforces them alongside your other cops. `AllCops: NewCops` does not apply: cops added in later releases are on the moment you upgrade.
+
+Listing the gem under `require:` also works. RuboCop loads it as a plugin and prints a warning asking you to move it under `plugins:`.
+
+Run only these cops:
+
+```sh
+bundle exec rubocop --only NEETzsche
+```
+
+Autocorrect what they flag:
+
+```sh
+bundle exec rubocop --autocorrect --only NEETzsche
+```
+
+## NEETzsche/NoComments
+
+Flags every comment. On autocorrect, a comment on its own line is deleted along with the line, and a trailing comment is deleted along with the whitespace before it.
+
+```ruby
+# bad
+# Returns the user's full name.
+def full_name
+  "#{first_name} #{last_name}" # join with a space
+end
+
+# good
+def full_name
+  "#{first_name} #{last_name}"
+end
+```
+
+Comments that change how Ruby or RuboCop behaves are allowed:
+
+- Magic comments: `frozen_string_literal`, `encoding`, `coding`, `warn_indent`, `shareable_constant_value`, and Emacs `-*- ... -*-` lines.
+- Shebangs, such as `#!/usr/bin/env ruby`.
+- RuboCop directives: anything starting with `# rubocop:`, so `disable`, `enable`, `todo`, `disable-next`, `todo-next`, `push`, and `pop`.
+
+`Style/Documentation` demands the class and module comments this cop forbids, so the plugin disables it. Re-enable it in your own `.rubocop.yml` if you want the two to fight.
+
+## Configuration
+
+Disable one cop:
+
+```yaml
+NEETzsche/NoComments:
+  Enabled: false
+```
+
+Disable the whole department:
+
+```yaml
+NEETzsche:
+  Enabled: false
+```
+
+Exclude paths from one cop:
+
+```yaml
+NEETzsche/NoComments:
+  Exclude:
+    - "db/schema.rb"
+```
+
+Directive comments are always allowed, so a comment can be kept by disabling the cop around it:
+
+```ruby
+# rubocop:disable NEETzsche/NoComments
+# This comment survives.
+# rubocop:enable NEETzsche/NoComments
+```
+
+## Development
+
+```sh
+bundle install
+bundle exec rake
+```
+
+The default Rake task runs the specs and then RuboCop against this repository, with this gem's own cops loaded.
+
+### Adding a cop
+
+1. Create `lib/rubocop/cop/neetzsche/<cop_name>.rb` with a class under `RuboCop::Cop::NEETzsche`, and `require_relative` it from `lib/rubocop/cop/neetzsche_cops.rb`.
+2. Add `NEETzsche/<CopName>` to `config/default.yml` with `Description`, `Enabled: true`, and `VersionAdded`.
+3. Add `spec/rubocop/cop/neetzsche/<cop_name>_spec.rb` using `expect_offense`, `expect_correction`, and `expect_no_offenses`.
+4. Add the cop to the table above and to `CHANGELOG.md`.
+
+The suite fails if a registered `NEETzsche` cop is missing from `config/default.yml` or is not `Enabled: true`.
+
+### Releasing
+
+`bundle exec rake build` writes the gem to `pkg/`. `bundle exec rake release` tags the version, pushes the tag, and pushes the gem to RubyGems.

data/config/default.yml

@@ -0,0 +1,10 @@
+NEETzsche:
+  Enabled: true
+
+NEETzsche/NoComments:
+  Description: "Forbids comments. Magic comments, shebangs, and rubocop directives are allowed."
+  Enabled: true
+  VersionAdded: "0.1.0"
+
+Style/Documentation:
+  Enabled: false

data/lib/officer_neetzsche/plugin.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+require "pathname"
+
+module OfficerNEETzsche
+  class Plugin < LintRoller::Plugin
+    def about
+      LintRoller::About.new(
+        name: "officer_neetzsche",
+        version: VERSION,
+        homepage: "https://github.com/TheStranjer/OfficerNEETzsche",
+        description: "RuboCop cops that enforce NEETzsche-isms."
+      )
+    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

data/lib/officer_neetzsche/version.rb

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

data/lib/officer_neetzsche.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+require_relative "officer_neetzsche/version"
+require_relative "officer_neetzsche/plugin"
+require_relative "rubocop/cop/neetzsche_cops"

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module NEETzsche
+      class NoComments < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = "Avoid comments; let the code speak for itself."
+
+        MAGIC = /\A#\s*(?:frozen_string_literal|encoding|coding|warn_indent|shareable_constant_value|-\*-)/.freeze
+        SHEBANG = /\A#!/.freeze
+        DIRECTIVE = /\A#\s*rubocop\s*:/.freeze
+
+        def on_new_investigation
+          processed_source.comments.each do |comment|
+            next if functional?(comment)
+
+            add_offense(comment) do |corrector|
+              corrector.remove(removal_range(comment))
+            end
+          end
+        end
+
+        private
+
+        def functional?(comment)
+          text = comment.text
+          MAGIC.match?(text) || SHEBANG.match?(text) || DIRECTIVE.match?(text)
+        end
+
+        def removal_range(comment)
+          if comment_only_line?(comment)
+            range_by_whole_lines(comment.source_range, include_final_newline: true)
+          else
+            range_with_surrounding_space(range: comment.source_range, side: :left, newlines: false)
+          end
+        end
+
+        def comment_only_line?(comment)
+          processed_source.lines[comment.loc.line - 1].lstrip.start_with?("#")
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/neetzsche_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "neetzsche/no_comments"

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: officer_neetzsche
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TheStranjer
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.0
+description: A RuboCop plugin whose cops each enforce one NEETzsche-ism. Every cop
+  is enabled by default.
+email:
+- thestranjer@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- config/default.yml
+- lib/officer_neetzsche.rb
+- lib/officer_neetzsche/plugin.rb
+- lib/officer_neetzsche/version.rb
+- lib/rubocop/cop/neetzsche/no_comments.rb
+- lib/rubocop/cop/neetzsche_cops.rb
+homepage: https://github.com/TheStranjer/OfficerNEETzsche
+licenses: []
+metadata:
+  source_code_uri: https://github.com/TheStranjer/OfficerNEETzsche
+  changelog_uri: https://github.com/TheStranjer/OfficerNEETzsche/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/TheStranjer/OfficerNEETzsche/issues
+  default_lint_roller_plugin: OfficerNEETzsche::Plugin
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: RuboCop cops that enforce NEETzsche-isms.
+test_files: []