rubocop-discourse 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09c74d2dcf1477ce0ae014f1f22d5d0683963a963ebd4e326eb870fb492398e9'
+  data.tar.gz: 0aec169456ac388da0e57f01c3f941f8604978d32150d00ccd35ed04c0f45237
+SHA512:
+  metadata.gz: c93f323c3161d55ad1f8aba8f545904757683f0628184b7414171c0713e24fc54c76df328a15ec02969689273649ef804eaa9ed363a51442c5cc7486786934fa
+  data.tar.gz: 9d68351058a663411c9a860fcdf19a3a3406663143316b20586ba32be835e82ff68ff35b43aecc1adf21d9b53289612e246a6a570a9822c9d8df905c4b952db6

data/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Setup ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+          architecture: 'x64'
+
+      - name: Setup bundler
+        run: gem install bundler
+
+      - name: Setup gems
+        run: bundle install
+
+      - name: Rubocop
+        run: bundle exec rubocop
+
+  publish:
+    if: contains(github.ref, 'refs/tags/v')
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Release Gem
+        uses: CvX/publish-rubygems-action@master
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: https://raw.githubusercontent.com/discourse/discourse/master/.rubocop.yml
+
+Discourse:
+  Enabled: true

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify dependencies in gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Civilized Discourse Construction Kit, Inc.
+
+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 NONINFRINGEMENT. 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/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/config/default.yml

@@ -0,0 +1,14 @@
+Discourse/NoChdir:
+  Enabled: true
+
+Discourse/NoDirectMultisiteManipulation:
+  Enabled: true
+
+Discourse/NoTimeNewWithoutArgs:
+  Enabled: true
+
+Discourse/NoUriEscapeEncode:
+  Enabled: true
+
+Discourse/TimeEqMatcher:
+  Enabled: true

data/lib/rubocop-discourse.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require_relative "rubocop/discourse"
+require_relative "rubocop/discourse/inject"
+
+RuboCop::Discourse::Inject.defaults!
+
+require_relative "rubocop/cop/discourse_cops"

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      # Avoid using chdir - it is not thread safe.
+      #
+      # Instead, you may be able to use:
+      # Discourse::Utils.execute_command(chdir: "test") do |runner|
+      #   runner.exec("pwd")
+      # end
+      #
+      # @example
+      #   # bad
+      #   Dir.chdir("test")
+      class NoChdir < Cop
+        MSG = "Chdir is not thread safe."
+
+        def_node_matcher :using_dir_chdir?, <<-MATCHER
+          (send (const nil? :Dir) :chdir ...)
+        MATCHER
+
+        def_node_matcher :using_fileutils_cd?, <<-MATCHER
+          (send (const nil? :FileUtils) :cd ...)
+        MATCHER
+
+        def on_send(node)
+          return if !(using_dir_chdir?(node) || using_fileutils_cd?(node))
+          add_offense(node, message: MSG)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      # Use `type: :multisite` example setting instead of modifying `Rails.configuration.multisite`.
+      #
+      # @example
+      #   # bad
+      #   it "works" do
+      #     Rails.configuration.multisite = true
+      #     do_something
+      #   end
+      #
+      #   # good
+      #   it "works", type: :multisite do
+      #     do_something
+      #   end
+      class NoDirectMultisiteManipulation < Cop
+        MSG = "Use `type: :multisite` example setting instead of modifying `Rails.configuration.multisite`."
+
+        def_node_matcher :multisite_setter?, <<-MATCHER
+          (send
+            (send
+              (const nil? :Rails) :configuration) :multisite=
+            _)
+        MATCHER
+
+        def on_send(node)
+          return unless multisite_setter?(node)
+
+          add_offense(node, message: MSG)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      # Use `Time.zone.now` instead of `Time.new` without arguments.
+      #
+      # @example
+      #   # bad
+      #   now = Time.new
+      #
+      #   # good
+      #   now = Time.zone.now
+      class NoTimeNewWithoutArgs < Cop
+        MSG = "Use `Time.zone.now` instead of `Time.new` without arguments."
+
+        def_node_matcher :time_new_without_args?, <<-MATCHER
+          (send (const nil? :Time) :new)
+        MATCHER
+
+        def on_send(node)
+          return unless time_new_without_args?(node)
+
+          add_offense(node, message: MSG)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.expression, "Time.zone.now")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      # Do not use URI.escape and its ilk, they are deprecated
+      # with a warning in the ruby source. Instead use
+      # Addressable::URI, which has encode, encode_component,
+      # and unencode methods. UrlHelper has helper methods for this.
+      #
+      # # @example
+      #   # bad
+      #   URI.encode("https://a%20a.com?a='a%22")
+      #
+      #   # good
+      #   UrlHelper.encode("https://a%20a.com?a='a%22")
+      #   Addressable::URI.encode("https://a%20a.com?a='a%22")
+      class NoURIEscapeEncode < Cop
+        MSG = "URI.escape, URI.encode, URI.unescape, URI.decode are deprecated and should not be used."
+
+        def_node_matcher :using_uri_escape?, <<-MATCHER
+          (send (const nil? :URI) :escape ...)
+        MATCHER
+
+        def_node_matcher :using_uri_encode?, <<-MATCHER
+          (send (const nil? :URI) :encode ...)
+        MATCHER
+
+        def_node_matcher :using_uri_unescape?, <<-MATCHER
+          (send (const nil? :URI) :unescape ...)
+        MATCHER
+
+        def_node_matcher :using_uri_decode?, <<-MATCHER
+          (send (const nil? :URI) :decode ...)
+        MATCHER
+
+        def on_send(node)
+          return if [
+            using_uri_escape?(node),
+            using_uri_encode?(node),
+            using_uri_unescape?(node),
+            using_uri_decode?(node)
+          ].none?
+          add_offense(node, message: MSG)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      # Use `time_eq` matcher with timestamps in specs.
+      #
+      # @example
+      #   # bad
+      #   expect(user.created_at).to eq(Time.zone.now)
+      #
+      #   # good
+      #   expect(user.created_at).to eq_time(Time.zone.now)
+      class TimeEqMatcher < Cop
+        MSG = "Use time_eq when testing timestamps"
+
+        def_node_matcher :using_eq_matcher_with_timestamp?, <<-MATCHER
+          (send
+            (send nil? :expect
+              (send ... #timestamp_suffix?))
+            {:to :not_to :to_not}
+            (send nil? :eq #not_nil))
+        MATCHER
+
+        def on_send(node)
+          return unless using_eq_matcher_with_timestamp?(node)
+
+          add_offense(node, message: MSG)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.children.last.loc.selector, "eq_time")
+          end
+        end
+
+        private
+
+        def timestamp_suffix?(property)
+          property =~ /_at$/
+        end
+
+        def not_nil(expression)
+          expression != [s(:nil)]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/discourse_cops.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+path = File.join(__dir__, "discourse", "*.rb")
+Dir[path].each { |file| require file }

data/lib/rubocop/discourse.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # RuboCop Discourse project namespace
+  module Discourse
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop/discourse/inject.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Discourse
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/rubocop-discourse.gemspec

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = "rubocop-discourse"
+  s.version     = "2.0.0"
+  s.summary     = "Custom rubocop cops used by Discourse"
+  s.authors     = ["David Taylor"]
+  s.files       = `git ls-files`.split($/)
+  s.license       = "MIT"
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "rubocop", ">= 0.69.0"
+
+  s.add_development_dependency "rake", "~> 13.0"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-discourse
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- David Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.69.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.69.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- Rakefile
+- config/default.yml
+- lib/rubocop-discourse.rb
+- lib/rubocop/cop/discourse/no_chdir.rb
+- lib/rubocop/cop/discourse/no_direct_multisite_manipulation.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
+- lib/rubocop/cop/discourse_cops.rb
+- lib/rubocop/discourse.rb
+- lib/rubocop/discourse/inject.rb
+- rubocop-discourse.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Custom rubocop cops used by Discourse
+test_files: []