rubocop-yiffspace 0.0.1

data/spec/rubocop/cop/yiff_space/current_user_outside_of_requests_spec.rb

@@ -0,0 +1,398 @@
+# frozen_string_literal: true
+
+RSpec.describe(RuboCop::Cop::YiffSpace::CurrentUserOutsideOfRequests, :config) do
+  let(:config) do
+    RuboCop::Config.new(
+      "YiffSpace/CurrentUserOutsideOfRequests" => {
+        "ClassName"             => "CurrentUser",
+        "IgnoredMethods"        => [],
+        "IgnoredMethodPrefixes" => [],
+        "IgnoredMethodSuffixes" => [],
+        "IgnoredMethodPatterns" => [],
+      },
+    )
+  end
+
+  it("registers an offense for CurrentUser.method calls in a regular method") do
+    expect_offense(<<~RUBY)
+      def process
+        CurrentUser.id
+        ^^^^^^^^^^^^^^ `CurrentUser` should only be used within the request cycle (controllers, views, helpers, decorators)
+      end
+    RUBY
+  end
+
+  it("registers an offense for a bare CurrentUser constant reference") do
+    expect_offense(<<~RUBY)
+      def process
+        user = CurrentUser
+               ^^^^^^^^^^^ `CurrentUser` should only be used within the request cycle (controllers, views, helpers, decorators)
+      end
+    RUBY
+  end
+
+  it("does not register an offense when CurrentUser is used inside its own class definition") do
+    expect_no_offenses(<<~RUBY)
+      class CurrentUser
+        def self.id
+          RequestStore[:current_user]&.id
+        end
+      end
+    RUBY
+  end
+
+  it("does not register an offense inside a qualified class definition matching ClassName") do
+    expect_no_offenses(<<~RUBY)
+      class Logical::CurrentUser
+        def self.email
+          RequestStore[:current_user]&.email
+        end
+      end
+    RUBY
+  end
+
+  context("when ClassName is a fully-qualified nested constant") do
+    let(:config) do
+      RuboCop::Config.new(
+        "YiffSpace/CurrentUserOutsideOfRequests" => {
+          "ClassName"             => "Logical::CurrentUser",
+          "IgnoredMethods"        => [],
+          "IgnoredMethodPrefixes" => [],
+          "IgnoredMethodSuffixes" => [],
+          "IgnoredMethodPatterns" => [],
+        },
+      )
+    end
+
+    it("does not register an offense inside the matching nested class definition") do
+      expect_no_offenses(<<~RUBY)
+        module Logical
+          class CurrentUser
+            def self.email
+              RequestStore[:current_user]&.email
+            end
+          end
+        end
+      RUBY
+    end
+
+    it("does not register an offense for a bare CurrentUser reference outside the Logical namespace") do
+      expect_no_offenses(<<~RUBY)
+        def process
+          CurrentUser.id
+        end
+      RUBY
+    end
+
+    it("registers an offense for CurrentUser inside the Logical namespace") do
+      expect_offense(<<~RUBY)
+        module Logical
+          def self.process
+            CurrentUser.id
+            ^^^^^^^^^^^^^^ `Logical::CurrentUser` should only be used within the request cycle (controllers, views, helpers, decorators)
+          end
+        end
+      RUBY
+    end
+  end
+
+  it("registers an offense even when deeply nested in another class") do
+    expect_offense(<<~RUBY)
+      class PostService
+        def call
+          CurrentUser.id
+          ^^^^^^^^^^^^^^ `CurrentUser` should only be used within the request cycle (controllers, views, helpers, decorators)
+        end
+      end
+    RUBY
+  end
+
+  context("with IgnoredMethods") do
+    let(:config) do
+      RuboCop::Config.new(
+        "YiffSpace/CurrentUserOutsideOfRequests" => {
+          "ClassName"             => "CurrentUser",
+          "IgnoredMethods"        => ["serializable_hash"],
+          "IgnoredMethodPrefixes" => [],
+          "IgnoredMethodSuffixes" => [],
+          "IgnoredMethodPatterns" => [],
+        },
+      )
+    end
+
+    it("does not register an offense in an ignored method") do
+      expect_no_offenses(<<~RUBY)
+        def serializable_hash
+          CurrentUser.id
+        end
+      RUBY
+    end
+
+    it("still registers an offense in a non-ignored method") do
+      expect_offense(<<~RUBY)
+        def process
+          CurrentUser.id
+          ^^^^^^^^^^^^^^ `CurrentUser` should only be used within the request cycle (controllers, views, helpers, decorators)
+        end
+      RUBY
+    end
+  end
+
+  context("with IgnoredMethodPrefixes") do
+    let(:config) do
+      RuboCop::Config.new(
+        "YiffSpace/CurrentUserOutsideOfRequests" => {
+          "ClassName"             => "CurrentUser",
+          "IgnoredMethods"        => [],
+          "IgnoredMethodPrefixes" => ["apionly_"],
+          "IgnoredMethodSuffixes" => [],
+          "IgnoredMethodPatterns" => [],
+        },
+      )
+    end
+
+    it("does not register an offense in a method matching the prefix") do
+      expect_no_offenses(<<~RUBY)
+        def apionly_serialize
+          CurrentUser.id
+        end
+      RUBY
+    end
+
+    it("still registers an offense in a method not matching the prefix") do
+      expect_offense(<<~RUBY)
+        def process
+          CurrentUser.id
+          ^^^^^^^^^^^^^^ `CurrentUser` should only be used within the request cycle (controllers, views, helpers, decorators)
+        end
+      RUBY
+    end
+  end
+
+  context("with IgnoredMethodSuffixes") do
+    let(:config) do
+      RuboCop::Config.new(
+        "YiffSpace/CurrentUserOutsideOfRequests" => {
+          "ClassName"             => "CurrentUser",
+          "IgnoredMethods"        => [],
+          "IgnoredMethodPrefixes" => [],
+          "IgnoredMethodSuffixes" => ["_current"],
+          "IgnoredMethodPatterns" => [],
+        },
+      )
+    end
+
+    it("does not register an offense in a method matching the suffix") do
+      expect_no_offenses(<<~RUBY)
+        def user_current
+          CurrentUser.id
+        end
+      RUBY
+    end
+  end
+
+  context("with IgnoredMethodPatterns") do
+    let(:config) do
+      RuboCop::Config.new(
+        "YiffSpace/CurrentUserOutsideOfRequests" => {
+          "ClassName"             => "CurrentUser",
+          "IgnoredMethods"        => [],
+          "IgnoredMethodPrefixes" => [],
+          "IgnoredMethodSuffixes" => [],
+          "IgnoredMethodPatterns" => ["^with_current_user"],
+        },
+      )
+    end
+
+    it("does not register an offense in a method matching the pattern") do
+      expect_no_offenses(<<~RUBY)
+        def with_current_user_context
+          CurrentUser.id
+        end
+      RUBY
+    end
+  end
+
+  context("with a namespaced ClassName (A::User)") do
+    let(:config) do
+      RuboCop::Config.new(
+        "YiffSpace/CurrentUserOutsideOfRequests" => {
+          "ClassName"             => "A::User",
+          "IgnoredMethods"        => [],
+          "IgnoredMethodPrefixes" => [],
+          "IgnoredMethodSuffixes" => [],
+          "IgnoredMethodPatterns" => [],
+        },
+      )
+    end
+
+    it("registers an offense for a bare User reference directly inside the A namespace") do
+      expect_offense(<<~RUBY)
+        module A
+          def self.user
+            User
+            ^^^^ `A::User` should only be used within the request cycle (controllers, views, helpers, decorators)
+          end
+        end
+      RUBY
+    end
+
+    it("registers an offense for User.method inside the A namespace") do
+      expect_offense(<<~RUBY)
+        module A
+          def self.user
+            User.id
+            ^^^^^^^ `A::User` should only be used within the request cycle (controllers, views, helpers, decorators)
+          end
+        end
+      RUBY
+    end
+
+    it("registers an offense for a bare User reference in a nested module with no shadowing User") do
+      expect_offense(<<~RUBY)
+        module A
+          module B
+            def self.user
+              User
+              ^^^^ `A::User` should only be used within the request cycle (controllers, views, helpers, decorators)
+            end
+          end
+        end
+      RUBY
+    end
+
+    it("does not register an offense for User in a module that defines its own User") do
+      expect_no_offenses(<<~RUBY)
+        module A
+          module C
+            class User; end
+
+            def self.user
+              User
+            end
+          end
+        end
+      RUBY
+    end
+
+    it("does not register an offense for User outside the A namespace") do
+      expect_no_offenses(<<~RUBY)
+        def process
+          User.id
+        end
+      RUBY
+    end
+
+    it("does not register an offense for User in an unrelated namespace") do
+      expect_no_offenses(<<~RUBY)
+        module B
+          def self.user
+            User.id
+          end
+        end
+      RUBY
+    end
+
+    it("registers an offense for an absolute ::A::User reference even when a local User is in scope") do
+      expect_offense(<<~RUBY)
+        module A
+          module D
+            class User; end
+
+            def self.user
+              ::A::User
+              ^^^^^^^^^ `A::User` should only be used within the request cycle (controllers, views, helpers, decorators)
+            end
+          end
+        end
+      RUBY
+    end
+  end
+
+  context("with a deeply namespaced ClassName (A::Util::User)") do
+    let(:config) do
+      RuboCop::Config.new(
+        "YiffSpace/CurrentUserOutsideOfRequests" => {
+          "ClassName"             => "A::Util::User",
+          "IgnoredMethods"        => [],
+          "IgnoredMethodPrefixes" => [],
+          "IgnoredMethodSuffixes" => [],
+          "IgnoredMethodPatterns" => [],
+        },
+      )
+    end
+
+    it("registers an offense for Util::User directly inside A") do
+      expect_offense(<<~RUBY)
+        module A
+          def self.user
+            Util::User
+            ^^^^^^^^^^ `A::Util::User` should only be used within the request cycle (controllers, views, helpers, decorators)
+          end
+        end
+      RUBY
+    end
+
+    it("registers an offense for Util::User inside a nested module within A with no shadowing Util") do
+      expect_offense(<<~RUBY)
+        module A
+          module B
+            def self.user
+              Util::User
+              ^^^^^^^^^^ `A::Util::User` should only be used within the request cycle (controllers, views, helpers, decorators)
+            end
+          end
+        end
+      RUBY
+    end
+
+    it("does not register an offense for Util::User outside the A namespace") do
+      expect_no_offenses(<<~RUBY)
+        def process
+          Util::User.id
+        end
+      RUBY
+    end
+  end
+
+  context("with a custom ClassName") do
+    let(:config) do
+      RuboCop::Config.new(
+        "YiffSpace/CurrentUserOutsideOfRequests" => {
+          "ClassName"             => "RequestUser",
+          "IgnoredMethods"        => [],
+          "IgnoredMethodPrefixes" => [],
+          "IgnoredMethodSuffixes" => [],
+          "IgnoredMethodPatterns" => [],
+        },
+      )
+    end
+
+    it("registers an offense for the configured class name") do
+      expect_offense(<<~RUBY)
+        def process
+          RequestUser.id
+          ^^^^^^^^^^^^^^ `RequestUser` should only be used within the request cycle (controllers, views, helpers, decorators)
+        end
+      RUBY
+    end
+
+    it("does not register an offense for the default CurrentUser name") do
+      expect_no_offenses(<<~RUBY)
+        def process
+          CurrentUser.id
+        end
+      RUBY
+    end
+
+    it("does not register an offense inside the configured class definition") do
+      expect_no_offenses(<<~RUBY)
+        class RequestUser
+          def self.id
+            RequestStore[:current_user]&.id
+          end
+        end
+      RUBY
+    end
+  end
+end

data/spec/rubocop/cop/yiff_space/resolvable_user_spec.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+RSpec.describe(RuboCop::Cop::YiffSpace::ResolvableUser, :config) do
+  let(:schema) { double("schema") }
+  let(:posts_table) { double("posts_table", name: "posts") }
+
+  before do
+    allow(cop).to(receive(:schema).and_return(schema))
+    allow(schema).to(receive(:table_by).and_return(posts_table))
+  end
+
+  context("when only the _id column exists") do
+    before do
+      allow(posts_table).to(receive(:with_column?).with(name: "creator_id").and_return(true))
+      allow(posts_table).to(receive(:with_column?).with(name: "creator_ip_addr").and_return(false))
+    end
+
+    it("registers an offense and corrects to belongs_to_user") do
+      expect_offense(<<~RUBY)
+        class Post < ApplicationRecord
+          resolvable(:creator)
+          ^^^^^^^^^^^^^^^^^^^^ use `belongs_to_user(:creator)` when `"creator_id"` column exists
+        end
+      RUBY
+
+      expect_correction(<<~RUBY)
+        class Post < ApplicationRecord
+          belongs_to_user(:creator)
+        end
+      RUBY
+    end
+  end
+
+  context("when both the _id and _ip_addr columns exist") do
+    before do
+      allow(posts_table).to(receive(:with_column?).with(name: "creator_id").and_return(true))
+      allow(posts_table).to(receive(:with_column?).with(name: "creator_ip_addr").and_return(true))
+    end
+
+    it("registers an offense and corrects to belongs_to_user with ip: true") do
+      expect_offense(<<~RUBY)
+        class Post < ApplicationRecord
+          resolvable(:creator)
+          ^^^^^^^^^^^^^^^^^^^^ use `belongs_to_user(:creator, ip: true)` when `"creator_id"` and `"creator_ip_addr"` columns exist
+        end
+      RUBY
+
+      expect_correction(<<~RUBY)
+        class Post < ApplicationRecord
+          belongs_to_user(:creator, ip: true)
+        end
+      RUBY
+    end
+  end
+
+  context("when the _id column does not exist") do
+    before do
+      allow(posts_table).to(receive(:with_column?).with(name: "creator_id").and_return(false))
+      allow(posts_table).to(receive(:with_column?).with(name: "creator_ip_addr").and_return(false))
+    end
+
+    it("does not register an offense") do
+      expect_no_offenses(<<~RUBY)
+        class Post < ApplicationRecord
+          resolvable(:creator)
+        end
+      RUBY
+    end
+  end
+
+  it("does not register an offense when the schema is unavailable") do
+    allow(cop).to(receive(:schema).and_return(nil))
+
+    expect_no_offenses(<<~RUBY)
+      class Post < ApplicationRecord
+        resolvable(:creator)
+      end
+    RUBY
+  end
+
+  it("does not register an offense when the table is not found in the schema") do
+    allow(schema).to(receive(:table_by).and_return(nil))
+
+    expect_no_offenses(<<~RUBY)
+      class Post < ApplicationRecord
+        resolvable(:creator)
+      end
+    RUBY
+  end
+
+  it("does not register an offense when the call is outside a class") do
+    allow(posts_table).to(receive(:with_column?).with(name: "creator_id").and_return(true))
+    allow(posts_table).to(receive(:with_column?).with(name: "creator_ip_addr").and_return(false))
+
+    expect_no_offenses(<<~RUBY)
+      resolvable(:creator)
+    RUBY
+  end
+end

data/spec/rubocop/cop/yiff_space/user_to_id_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+RSpec.describe(RuboCop::Cop::YiffSpace::UserToId, :config) do
+  let(:config) { RuboCop::Config.new("YiffSpace/UserToId" => { "Enabled" => true }) }
+
+  it("registers an offense for the is_a?(User) ternary pattern and corrects it") do
+    expect_offense(<<~RUBY)
+      user.is_a?(User) ? user.id : user
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `u2id(user)` instead of `user.is_a?(User) ? user.id : user`
+    RUBY
+
+    expect_correction(<<~RUBY)
+      u2id(user)
+    RUBY
+  end
+
+  it("registers an offense with a different variable name") do
+    expect_offense(<<~RUBY)
+      creator.is_a?(User) ? creator.id : creator
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `u2id(creator)` instead of `creator.is_a?(User) ? creator.id : creator`
+    RUBY
+
+    expect_correction(<<~RUBY)
+      u2id(creator)
+    RUBY
+  end
+
+  it("does not register an offense when the if-branch receiver differs from the else-branch") do
+    expect_no_offenses(<<~RUBY)
+      user.is_a?(User) ? user.id : something_else
+    RUBY
+  end
+
+  it("does not register an offense when checking against a non-User class") do
+    expect_no_offenses(<<~RUBY)
+      user.is_a?(Admin) ? user.id : user
+    RUBY
+  end
+
+  it("does not register an offense when the if-branch does not call .id") do
+    expect_no_offenses(<<~RUBY)
+      user.is_a?(User) ? user.name : user
+    RUBY
+  end
+
+  it("does not register an offense for a non-ternary if") do
+    expect_no_offenses(<<~RUBY)
+      if user.is_a?(User)
+        user.id
+      else
+        user
+      end
+    RUBY
+  end
+
+  it("does not register an offense when already using u2id") do
+    expect_no_offenses(<<~RUBY)
+      u2id(user)
+    RUBY
+  end
+
+  it("does not register an offense for unrelated ternaries") do
+    expect_no_offenses(<<~RUBY)
+      user.nil? ? nil : user
+    RUBY
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require("rubocop-yiffspace")
+require("rubocop/rspec/support")
+
+# Satisfy requires_gem("activerecord") checks in cops without loading the full gem.
+Gem.loaded_specs["activerecord"] ||= Gem::Specification.new do |s|
+  s.name = "activerecord"
+  s.version = "8.0"
+end
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.raise_errors_for_deprecations!
+  config.raise_on_warning = true
+  config.fail_if_no_examples = true
+
+  config.order = :random
+  Kernel.srand(config.seed)
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-yiffspace
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Donovan_DMC
+bindir: exe
+cert_chain: []
+date: 2026-05-07 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.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.2
+description: Shared rubocop rules for YiffSpace
+email:
+- hewwo@yiff.rocks
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/jsonSchemas.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/rubocop-plugin.iml"
+- ".idea/vcs.xml"
+- ".rspec"
+- ".ruby-version"
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/custom.yml
+- config/default.yml
+- config/rails.yml
+- config/shared.yml
+- config/shared/bundler.yml
+- config/shared/gemspec.yml
+- config/shared/layout.yml
+- config/shared/lint.yml
+- config/shared/metrics.yml
+- config/shared/migration.yml
+- config/shared/naming.yml
+- config/shared/rails.yml
+- config/shared/security.yml
+- config/shared/style.yml
+- lib/rubocop-yiffspace.rb
+- lib/rubocop/cop/mixin/active_record_helper.rb
+- lib/rubocop/cop/mixin/node_formatting_helper.rb
+- lib/rubocop/cop/yiff_space/belongs_to_user.rb
+- lib/rubocop/cop/yiff_space/belongs_to_user_invalid_ip.rb
+- lib/rubocop/cop/yiff_space/belongs_to_user_missing_ip.rb
+- lib/rubocop/cop/yiff_space/current_user_outside_of_requests.rb
+- lib/rubocop/cop/yiff_space/resolvable_user.rb
+- lib/rubocop/cop/yiff_space/user_to_id.rb
+- lib/rubocop/cop/yiffspace_cops.rb
+- lib/rubocop/yiff_space.rb
+- lib/rubocop/yiff_space/plugin.rb
+- lib/rubocop/yiff_space/version.rb
+- spec/rubocop/cop/yiff_space/belongs_to_user_invalid_ip_spec.rb
+- spec/rubocop/cop/yiff_space/belongs_to_user_missing_ip_spec.rb
+- spec/rubocop/cop/yiff_space/belongs_to_user_spec.rb
+- spec/rubocop/cop/yiff_space/current_user_outside_of_requests_spec.rb
+- spec/rubocop/cop/yiff_space/resolvable_user_spec.rb
+- spec/rubocop/cop/yiff_space/user_to_id_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/YiffSpace/rubocop-plugin
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/YiffSpace/rubocop-plugin
+  source_code_uri: https://github.com/YiffSpace/rubocop-plugin
+  rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::YiffSpace::Plugin
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Shared rubocop rules for YiffSpace
+test_files: []