rubocop-discourse 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 938e8b3d2af662cc5d3a325fa317cf727164287036c47203481262f0fb00839c
-  data.tar.gz: d7c47414ffccdd5e240f152a9994c1eba1bf96497f8d5ec96f5e11ec1972a8e7
+  metadata.gz: 4393a2ad64c2662ce3c1dcdb1608501b93b6c13bc31b9a7a2a25b2c8a1404e89
+  data.tar.gz: eabd1def336f6290d8a694c209256827585b4a28baa2f0a84fa74f65cfc76f07
 SHA512:
-  metadata.gz: a8f462667a26681e75d9a492f7b07c836d249ba6f653acf200c66513ec890c7d5b97fddec986525994f1968e24563382d8504da8cd2ff6a070edde3e9b317a22
-  data.tar.gz: 2f79d3ff37c7689fcea71e84ff4dffed726db49cca9063a79a212acd35a281b57231aa844093b63d50fcb2d8b89e1cf0e4477740b49e4dfdaab99a4fd3ed7b63
+  metadata.gz: 40a5a38b088a3ab91c3a155ab4a2bcf78ed44ecd62a4fc98ccbf2b21cba5aac0d6d906b460e5be293f48dace6be3295d73841b0c147f9c4296002b094971d95b
+  data.tar.gz: 72b08959eb26c04941c3fc972a3d9725f6465355f02c0fb1913dfa7826a76ca42ad716327a1a40ea541eebadbfc01715783dc2467fa255d204cff7d09c36f213

data/.github/workflows/ci.yml

@@ -29,6 +29,9 @@ jobs:
 
       - name: Rubocop
         run: bundle exec rubocop
+      
+      - name: Rspec
+        run: bundle exec rspec spec
 
   publish:
     if: contains(github.ref, 'refs/tags/v')

data/.gitignore

@@ -1,2 +1,3 @@
 .rubocop-http*
 Gemfile.lock
+.byebug_history

data/Gemfile

@@ -4,3 +4,7 @@ source "https://rubygems.org"
 
 # Specify dependencies in gemspec
 gemspec
+
+group :development, :test do
+  gem 'byebug'
+end

data/config/default.yml

@@ -7,9 +7,24 @@ Discourse/NoChdir:
 Discourse/NoTimeNewWithoutArgs:
   Enabled: true
 
-Discourse/NoUriEscapeEncode:
+Discourse/NoURIEscapeEncode:
   Enabled: true
 
+Discourse/NoAddReferenceOrAliasesActiveRecordMigration:
+  Enabled: true
+  Include:
+  - "**/db/migrate/*"
+  - "**/db/post_migrate/*"
+
+Discourse/NoNokogiriHtmlFragment:
+  Enabled: true
+
+Discourse/NoResetColumnInformationInMigrations:
+  Enabled: false
+  Include:
+  - "**/db/migrate/*"
+  - "**/db/post_migrate/*"
+
 # Specs
 
 Discourse/NoDirectMultisiteManipulation:

data/default.yml

@@ -12,7 +12,7 @@ AllCops:
     - "db/schema.rb"
     - "bundle/**/*"
     - "vendor/**/*"
-    - "node_modules/**/*"
+    - "**/node_modules/**/*"
     - "public/**/*"
     - "plugins/**/gems/**/*"
 

data/lib/rubocop/cop/discourse/no_add_reference_active_record_migrations.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      # The methods:
+      #
+      # * add_reference
+      # * add_belongs_to
+      # * t.references
+      # * t.belongs_to
+      #
+      # in ActiveRecord migrations are magic, and they all do
+      # some unexpected things in the background. For example, by default
+      # add_reference adds an index at the same time, but not concurrently,
+      # which is a nightmare for large tables.
+      #
+      # Instead, inside a disable_ddl_transaction! migration we should create
+      # the new column (with any defaults and options required) and the index
+      # concurrently using hand-written SQL. This also allows us to handle
+      # IF NOT EXISTS cases, which enable re-runnable migrations. Also we
+      # can pick a better name for the index at the same time.
+      #
+      # @example
+      #
+      # # bad
+      # def up
+      #   add_reference :posts, :image_upload
+      #   # or add_belongs_to :posts, :image_upload
+      #   # or t.references :image_upload when doing create_table do |t|
+      #   # or t.belongs_to :image_upload when doing create_table do |t|
+      # end
+      #
+      # # good
+      # disable_ddl_transaction!
+      # def up
+      #   execute <<~SQL
+      #     ALTER TABLE posts
+      #     ADD COLUMN IF NOT EXISTS image_upload_id bigint
+      #   SQL
+      #
+      #   execute <<~SQL
+      #     CREATE INDEX CONCURRENTLY IF NOT EXISTS
+      #     index_posts_on_image_upload_id ON posts USING btree (image_upload_id)
+      #   SQL
+      # end
+      class NoAddReferenceOrAliasesActiveRecordMigration < Cop
+        MSG = <<~MSG
+          AR methods add_reference, add_belongs_to, t.references, and t.belongs_to are
+          high-risk for large tables and have too many background magic operations.
+          Instead, write a disable_ddl_transactions! migration and write custom SQL to
+          add the new column and CREATE INDEX CONCURRENTLY. Use the IF NOT EXISTS clause
+          to make the migration re-runnable if it fails partway through.
+        MSG
+
+        def_node_matcher :using_add_reference?, <<-MATCHER
+          (send nil? :add_reference ...)
+        MATCHER
+
+        def_node_matcher :using_add_belongs_to?, <<-MATCHER
+          (send nil? :add_belongs_to ...)
+        MATCHER
+
+        def_node_matcher :using_t_references?, <<-MATCHER
+          (send (lvar _) :references ...)
+        MATCHER
+
+        def_node_matcher :using_t_belongs_to?, <<-MATCHER
+          (send (lvar _) :belongs_to ...)
+        MATCHER
+
+        def on_send(node)
+          return if [
+            using_add_reference?(node),
+            using_add_belongs_to?(node),
+            using_t_references?(node),
+            using_t_belongs_to?(node)
+          ].none?
+          add_offense(node, message: MSG)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/discourse/no_nokogiri_html_fragment.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      # Do not use Nokogiri::HTML.fragment
+      # Instead use Nokogiri::HTML5.fragment, which is using Nokogumbo parser
+      #
+      # @example
+      #   # bad
+      #   Nokogiri::HTML.fragment("<p>test</p>")
+      #
+      #   # good
+      #   Nokogiri::HTML5.fragment("<p>test</p>")
+      class NoNokogiriHtmlFragment < Cop
+        MSG = "Nokogiri::HTML.fragment is deprecated and should not be used."
+
+        def_node_matcher :using_nokogiri_html_fragment?, <<-MATCHER
+          (send
+            (const
+              (const nil? :Nokogiri) :HTML) :fragment ...)
+        MATCHER
+
+        def on_send(node)
+          return if !using_nokogiri_html_fragment?(node)
+          add_offense(node, message: MSG)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/discourse/no_reset_column_information_in_migrations.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      # Do not use `ActiveRecord::ModelSchema.reset_column_information` in
+      # migrations. The method is not thread safe and we run migrations
+      # concurrently for multisites. Also, we don't encourage the use of
+      # ActiveRecord methods in migrations and prefer to write SQL directly.
+      class NoResetColumnInformationInMigrations < Cop
+        MSG = "ActiveRecord::ModelSchema.reset_column_information is not thread-safe " \
+          "and we run migrations concurrently on multisite clusters. Using this " \
+          "method also means ActiveRecord methods are being used in migration "\
+          "which is discouraged at Discourse. Instead, you should write SQL in your migrations instead."
+
+        def on_send(node)
+          return if node.method_name != :reset_column_information
+          add_offense(node, message: MSG)
+        end
+      end
+    end
+  end
+end

data/rubocop-discourse.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "rubocop-discourse"
-  s.version     = "2.1.2"
+  s.version     = "2.2.0"
   s.summary     = "Custom rubocop cops used by Discourse"
   s.authors     = ["David Taylor"]
   s.files       = `git ls-files`.split($/)
@@ -13,4 +13,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "rubocop-rspec", ">= 1.39.0"
 
   s.add_development_dependency "rake", "~> 13.0"
+  s.add_development_dependency "rspec"
 end

data/spec/lib/rubocop/cop/no_add_reference_active_record_migrations_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RuboCop::Cop::Discourse::NoAddReferenceOrAliasesActiveRecordMigration, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:config) do
+    RuboCop::Config.new
+  end
+
+  it "raises an offense if add_reference is used, with or without arguments" do
+    inspect_source(<<~RUBY)
+      add_reference :posts, :users, foreign_key: true, null: false
+    RUBY
+    expect(cop.offenses.first.message).to eq(described_class::MSG)
+  end
+
+  it "raises an offense if add_belongs_to is used, with or without arguments" do
+    inspect_source(<<~RUBY)
+      add_belongs_to :posts, :users, foreign_key: true, null: false
+    RUBY
+    expect(cop.offenses.first.message).to eq(described_class::MSG)
+  end
+
+  it "raises an offense if t.references, or any variable.references is used, with or without arguments" do
+    inspect_source(<<~RUBY)
+      create_table do |t|
+        t.references :topic, null: false
+      end
+      create_table do |mytable|
+        mytable.references :topic, null: false
+      end
+    RUBY
+    expect(cop.offenses.count).to eq(2)
+    expect(cop.offenses.first.message).to eq(described_class::MSG)
+  end
+
+  it "raises an offense if t.belongs_to, or any variable.belongs_to is used, with or without arguments" do
+    inspect_source(<<~RUBY)
+      create_table do |t|
+        t.belongs_to :topic, null: false
+      end
+      create_table do |mytable|
+        mytable.belongs_to :topic, null: false
+      end
+    RUBY
+    expect(cop.offenses.count).to eq(2)
+    expect(cop.offenses.first.message).to eq(described_class::MSG)
+  end
+end

data/spec/lib/rubocop/cop/no_reset_column_information_migrations_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RuboCop::Cop::Discourse::NoResetColumnInformationInMigrations, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) do
+    RuboCop::Config.new
+  end
+
+  it "raises an offense if reset_column_information is used" do
+    inspect_source(<<~RUBY)
+      class SomeMigration < ActiveRecord::Migration[6.0]
+        def up
+          Post.reset_column_information
+        end
+      end
+    RUBY
+
+    expect(cop.offenses.first.message).to eq(described_class::MSG)
+  end
+
+  it "raise an offense if reset_column_information is used without AR model" do
+    inspect_source(<<~RUBY)
+      class SomeMigration < ActiveRecord::Migration[6.0]
+        def up
+          "post".classify.constantize.reset_column_information
+        end
+      end
+    RUBY
+
+    expect(cop.offenses.first.message).to eq(described_class::MSG)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+Bundler.setup
+
+# Require supporting files exposed for testing.
+require 'rubocop'
+require 'rubocop/rspec/support'
+
+require 'rubocop-discourse' # and any other gems you need
+
+RSpec.configure do |config|
+  config.include RuboCop::RSpec::ExpectOffense
+  # some (optional) config here
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-discourse
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - David Taylor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-03 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: 
 executables: []
@@ -68,9 +82,12 @@ files:
 - config/default.yml
 - default.yml
 - lib/rubocop-discourse.rb
+- lib/rubocop/cop/discourse/no_add_reference_active_record_migrations.rb
 - lib/rubocop/cop/discourse/no_chdir.rb
 - lib/rubocop/cop/discourse/no_direct_multisite_manipulation.rb
 - lib/rubocop/cop/discourse/no_json_parse_response.rb
+- lib/rubocop/cop/discourse/no_nokogiri_html_fragment.rb
+- lib/rubocop/cop/discourse/no_reset_column_information_in_migrations.rb
 - lib/rubocop/cop/discourse/no_time_new_without_args.rb
 - lib/rubocop/cop/discourse/no_uri_escape_encode.rb
 - lib/rubocop/cop/discourse/time_eq_matcher.rb
@@ -80,6 +97,9 @@ files:
 - rubocop-core.yml
 - rubocop-discourse.gemspec
 - rubocop-rspec.yml
+- spec/lib/rubocop/cop/no_add_reference_active_record_migrations_spec.rb
+- spec/lib/rubocop/cop/no_reset_column_information_migrations_spec.rb
+- spec/spec_helper.rb
 homepage: 
 licenses:
 - MIT