rubocop-yiffspace 0.0.1

data/lib/rubocop/cop/yiffspace_cops.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative("mixin/node_formatting_helper")
+require_relative("mixin/active_record_helper")
+require_relative("yiff_space/belongs_to_user")
+require_relative("yiff_space/belongs_to_user_invalid_ip")
+require_relative("yiff_space/belongs_to_user_missing_ip")
+require_relative("yiff_space/current_user_outside_of_requests")
+require_relative("yiff_space/resolvable_user")
+require_relative("yiff_space/user_to_id")

data/lib/rubocop/yiff_space/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require("lint_roller")
+
+module RuboCop
+  module YiffSpace
+    # A plugin that integrates rubocop-yiffspace with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name:        "rubocop-yiffspace",
+          version:     VERSION,
+          homepage:    "https://github.com/YiffSpace/rubocop-plugin",
+          description: "Shared rubocop rules for YiffSpace",
+        )
+      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/yiff_space/version.rb

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

data/lib/rubocop/yiff_space.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative("yiff_space/version")
+
+module RuboCop
+  module YiffSpace
+  end
+end

data/lib/rubocop-yiffspace.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require("rubocop")
+
+require_relative("rubocop/yiff_space")
+require_relative("rubocop/yiff_space/version")
+require_relative("rubocop/yiff_space/plugin")
+
+require_relative("rubocop/cop/yiffspace_cops")

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+RSpec.describe(RuboCop::Cop::YiffSpace::BelongsToUserInvalidIp, :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 ip: true is set but the column does not exist") do
+    before { allow(posts_table).to(receive(:with_column?).and_return(false)) }
+
+    it("registers an offense and removes the ip: option") do
+      expect_offense(<<~RUBY)
+        class Post < ApplicationRecord
+          belongs_to_user(:creator, ip: true)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ `ip: true` set for `belongs_to_user(:creator)` when `"posts.creator_ip_addr"` column does not exist
+        end
+      RUBY
+
+      expect_correction(<<~RUBY)
+        class Post < ApplicationRecord
+          belongs_to_user(:creator)
+        end
+      RUBY
+    end
+  end
+
+  context("when a custom ip column string is set but does not exist") do
+    before { allow(posts_table).to(receive(:with_column?).and_return(false)) }
+
+    it("registers an offense using the custom column name") do
+      expect_offense(<<~RUBY)
+        class Post < ApplicationRecord
+          belongs_to_user(:creator, ip: "custom_col")
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ `ip: "custom_col"` set for `belongs_to_user(:creator)` when `"posts.custom_col"` column does not exist
+        end
+      RUBY
+
+      expect_correction(<<~RUBY)
+        class Post < ApplicationRecord
+          belongs_to_user(:creator)
+        end
+      RUBY
+    end
+  end
+
+  context("when ip: true is set and the column exists") do
+    before { allow(posts_table).to(receive(:with_column?).with(name: "creator_ip_addr").and_return(true)) }
+
+    it("does not register an offense") do
+      expect_no_offenses(<<~RUBY)
+        class Post < ApplicationRecord
+          belongs_to_user(:creator, ip: true)
+        end
+      RUBY
+    end
+  end
+
+  it("does not register an offense when ip: is not specified") do
+    allow(posts_table).to(receive(:with_column?).and_return(false))
+
+    expect_no_offenses(<<~RUBY)
+      class Post < ApplicationRecord
+        belongs_to_user(:creator)
+      end
+    RUBY
+  end
+
+  it("does not register an offense when ip: false") do
+    allow(posts_table).to(receive(:with_column?).and_return(false))
+
+    expect_no_offenses(<<~RUBY)
+      class Post < ApplicationRecord
+        belongs_to_user(:creator, ip: false)
+      end
+    RUBY
+  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
+        belongs_to_user(:creator, ip: true)
+      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
+        belongs_to_user(:creator, ip: true)
+      end
+    RUBY
+  end
+
+  it("does not register an offense when the call is outside a class") do
+    allow(posts_table).to(receive(:with_column?).and_return(false))
+
+    expect_no_offenses(<<~RUBY)
+      belongs_to_user(:creator, ip: true)
+    RUBY
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+RSpec.describe(RuboCop::Cop::YiffSpace::BelongsToUserMissingIp, :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 the ip column exists but ip: is not specified") do
+    before { allow(posts_table).to(receive(:with_column?).with(name: "creator_ip_addr").and_return(true)) }
+
+    it("registers an offense and adds ip: true") do
+      expect_offense(<<~RUBY)
+        class Post < ApplicationRecord
+          belongs_to_user(:creator)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^ Specify `ip: true` when a `belongs_to_user(:creator)` relation has a corresponding `"creator_ip_addr"` column
+        end
+      RUBY
+
+      expect_correction(<<~RUBY)
+        class Post < ApplicationRecord
+          belongs_to_user(:creator, ip: true)
+        end
+      RUBY
+    end
+
+    it("registers an offense when ip: false is explicitly set") do
+      expect_offense(<<~RUBY)
+        class Post < ApplicationRecord
+          belongs_to_user(:creator, ip: false)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specify `ip: true` when a `belongs_to_user(:creator)` relation has a corresponding `"creator_ip_addr"` column
+        end
+      RUBY
+    end
+  end
+
+  context("when ip: true is already set") do
+    before { allow(posts_table).to(receive(:with_column?).with(name: "creator_ip_addr").and_return(true)) }
+
+    it("does not register an offense") do
+      expect_no_offenses(<<~RUBY)
+        class Post < ApplicationRecord
+          belongs_to_user(:creator, ip: true)
+        end
+      RUBY
+    end
+  end
+
+  context("when the ip column does not exist") do
+    before { allow(posts_table).to(receive(:with_column?).with(name: "creator_ip_addr").and_return(false)) }
+
+    it("does not register an offense") do
+      expect_no_offenses(<<~RUBY)
+        class Post < ApplicationRecord
+          belongs_to_user(: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
+        belongs_to_user(: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
+        belongs_to_user(: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_ip_addr").and_return(true))
+
+    expect_no_offenses(<<~RUBY)
+      belongs_to_user(:creator)
+    RUBY
+  end
+end

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

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+RSpec.describe(RuboCop::Cop::YiffSpace::BelongsToUser, :config) do
+  it("registers an offense for belongs_to(:user) when options are present") do
+    expect_offense(<<~RUBY)
+      belongs_to(:user, optional: false)
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `belongs_to_user(:user)` instead of `belongs_to(:user)`
+    RUBY
+
+    expect_correction(<<~RUBY)
+      belongs_to_user(:user, optional: false)
+    RUBY
+  end
+
+  it('registers an offense for belongs_to with class_name: "User"') do
+    expect_offense(<<~RUBY)
+      belongs_to(:creator, class_name: "User")
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `belongs_to_user(:creator)` instead of `belongs_to(:creator)`
+    RUBY
+
+    expect_correction(<<~RUBY)
+      belongs_to_user(:creator)
+    RUBY
+  end
+
+  it("removes class_name while preserving other options") do
+    expect_offense(<<~RUBY)
+      belongs_to(:creator, class_name: "User", optional: true)
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `belongs_to_user(:creator)` instead of `belongs_to(:creator)`
+    RUBY
+
+    expect_correction(<<~RUBY)
+      belongs_to_user(:creator, optional: true)
+    RUBY
+  end
+
+  it('registers an offense for belongs_to with a string attribute and class_name: "User"') do
+    expect_offense(<<~RUBY)
+      belongs_to("creator", class_name: "User")
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `belongs_to_user("creator")` instead of `belongs_to("creator")`
+    RUBY
+
+    expect_correction(<<~RUBY)
+      belongs_to_user("creator")
+    RUBY
+  end
+
+  it("does not register an offense for belongs_to(:user) with no options hash") do
+    # The cop requires at least one option present to trigger
+    expect_no_offenses(<<~RUBY)
+      belongs_to(:user)
+    RUBY
+  end
+
+  it("does not register an offense for belongs_to(:creator) without class_name") do
+    expect_no_offenses(<<~RUBY)
+      belongs_to(:creator, optional: true)
+    RUBY
+  end
+
+  it("does not register an offense for belongs_to with a non-User class_name") do
+    expect_no_offenses(<<~RUBY)
+      belongs_to(:creator, class_name: "Admin")
+    RUBY
+  end
+
+  it("does not register an offense when already using belongs_to_user") do
+    expect_no_offenses(<<~RUBY)
+      belongs_to_user(:creator)
+    RUBY
+  end
+
+  context("with a custom ClassName") do
+    let(:config) do
+      RuboCop::Config.new("YiffSpace/BelongsToUser" => { "ClassName" => "CurrentUser" })
+    end
+
+    it("registers an offense for belongs_to with the inferred attribute name") do
+      expect_offense(<<~RUBY)
+        belongs_to(:current_user, optional: false)
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `belongs_to_user(:current_user)` instead of `belongs_to(:current_user)`
+      RUBY
+
+      expect_correction(<<~RUBY)
+        belongs_to_user(:current_user, optional: false)
+      RUBY
+    end
+
+    it("registers an offense for belongs_to with the configured class_name") do
+      expect_offense(<<~RUBY)
+        belongs_to(:creator, class_name: "CurrentUser")
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `belongs_to_user(:creator)` instead of `belongs_to(:creator)`
+      RUBY
+
+      expect_correction(<<~RUBY)
+        belongs_to_user(:creator)
+      RUBY
+    end
+
+    it("does not register an offense for the default :user attribute") do
+      expect_no_offenses(<<~RUBY)
+        belongs_to(:user, optional: false)
+      RUBY
+    end
+
+    it('does not register an offense for class_name: "User" when ClassName is CurrentUser') do
+      expect_no_offenses(<<~RUBY)
+        belongs_to(:creator, class_name: "User")
+      RUBY
+    end
+  end
+
+  context("with a namespaced ClassName") do
+    let(:config) do
+      RuboCop::Config.new("YiffSpace/BelongsToUser" => { "ClassName" => "Logical::CurrentUser" })
+    end
+
+    it("infers the attribute name from the last segment") do
+      expect_offense(<<~RUBY)
+        belongs_to(:current_user, optional: false)
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `belongs_to_user(:current_user)` instead of `belongs_to(:current_user)`
+      RUBY
+
+      expect_correction(<<~RUBY)
+        belongs_to_user(:current_user, optional: false)
+      RUBY
+    end
+
+    it("matches the full namespaced class_name") do
+      expect_offense(<<~RUBY)
+        belongs_to(:creator, class_name: "Logical::CurrentUser")
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `belongs_to_user(:creator)` instead of `belongs_to(:creator)`
+      RUBY
+
+      expect_correction(<<~RUBY)
+        belongs_to_user(:creator)
+      RUBY
+    end
+
+    it("does not register an offense for a non-matching class_name") do
+      expect_no_offenses(<<~RUBY)
+        belongs_to(:creator, class_name: "CurrentUser")
+      RUBY
+    end
+  end
+
+  it('registers an offense for belongs_to with class_name: "User" on the :user attribute') do
+    # :user + class_name: "User" triggers the class_name path, not the :user shorthand
+    expect_offense(<<~RUBY)
+      belongs_to(:user, class_name: "User")
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `belongs_to_user(:user)` instead of `belongs_to(:user)`
+    RUBY
+
+    expect_correction(<<~RUBY)
+      belongs_to_user(:user)
+    RUBY
+  end
+end