gl_rubocop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2722762e37718da016ff909dc1386f835f5fdb8f20ce44ecd8114a7980191152
+  data.tar.gz: cadaf9bcbb5b045cab2a678cd5d5c9154ab513ed9931ed403e4e9478adf5c756
+SHA512:
+  metadata.gz: 98cf48d132aaf848c6d5308cac9f9b30f185860fb191441a94f3c147d8de720369acc1ef2524d9551a2e1706ae456ff8295fbdaed03c1a23c95d3eda3305b57b
+  data.tar.gz: 35dc30bbd8620cf814683a0512b8e6c8f2edb3862d221a3cfe0d891e7895d60589d4378f01752b6fe97b5017be91b4c98f39bda04e1160c4f8f2a991575a9b2f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Give Lively
+
+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/README.md

@@ -0,0 +1,2 @@
+# gl_rubocop
+A shareable configuration of rules we use at Give Lively to lint our Ruby code.

data/gl_rubocop.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gl_rubocop/version'
+
+NON_GEM_FILES = ['Gemfile', 'Gemfile.lock', 'Guardfile', 'bin/lint'].freeze
+
+Gem::Specification.new do |spec|
+  spec.name = 'gl_rubocop'
+  spec.version = GLRubocop::VERSION
+  spec.authors = ['Give Lively']
+
+  spec.summary = "A shareable configuration of Give Lively's rubocop rules."
+  spec.homepage = 'https://github.com/givelively/gl_rubocop'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1'
+
+  spec.extra_rdoc_files = ['README.md']
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = %w[gl_rubocop.gemspec README.md LICENSE] +
+               `git ls-files | grep -E '^(lib)'`.split("\n")
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rubocop', '~> 1.62.0'
+  spec.add_dependency 'rubocop-magic_numbers'
+  spec.add_dependency 'rubocop-performance'
+  spec.add_dependency 'rubocop-rails'
+  spec.add_dependency 'rubocop-rake'
+  spec.add_dependency 'rubocop-rspec', '~> 2.25'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/gl_rubocop/gl_cops/callback_method_names.rb

@@ -0,0 +1,23 @@
+module GLRubocop
+  module GLCops
+    # This cop ensures that controller callbacks are named methods, not inline blocks.
+    #
+    # Good:
+    #   before_action :set_user
+    #
+    # Bad:
+    #   before_action { do_something }
+    #   before_action -> { do_something }
+    class CallbackMethodNames < RuboCop::Cop::Cop
+      CALLBACKS = %i[before_action after_action around_action].freeze
+
+      def on_send(node)
+        return unless CALLBACKS.include?(node.method_name)
+
+        error_message = 'Use a named method for controller callbacks instead of an inline block.'
+
+        add_offense(node, message: error_message) if node.parent&.block_type?
+      end
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/interactor_inherits_from_interactor_base.rb

@@ -0,0 +1,14 @@
+module GLRubocop
+  module GLCops
+    class InteractorInheritsFromInteractorBase < RuboCop::Cop::Cop
+      def on_class(klass)
+        return unless klass.instance_of?(RuboCop::AST::ClassNode)
+        return unless klass.parent_class.nil?
+
+        add_offense(klass)
+      end
+
+      MSG = 'Interactor should inherit from InteractorBase'.freeze
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/prevent_erb_files.rb

@@ -0,0 +1,15 @@
+module GLRubocop
+  module GLCops
+    class PreventErbFiles < RuboCop::Cop::Cop
+      MSG = 'File name should not end with .erb'.freeze
+
+      def investigate(processed_source)
+        file_path = processed_source.buffer.name
+        return unless File.extname(file_path) == '.erb'
+
+        range = processed_source.buffer.source_range
+        add_offense(nil, location: range, message: MSG)
+      end
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/sidekiq_inherits_from_sidekiq_job.rb

@@ -0,0 +1,14 @@
+module GLRubocop
+  module GLCops
+    class SidekiqInheritsFromSidekiqJob < RuboCop::Cop::Cop
+      def on_class(klass)
+        return unless klass.instance_of?(RuboCop::AST::ClassNode)
+        return if klass.parent_class.present? || klass.identifier.short_name == :SidekiqJob
+
+        add_offense(klass)
+      end
+
+      MSG = 'All Sidekiq workers and jobs should inherit from SidekiqJob'.freeze
+    end
+  end
+end

data/lib/gl_rubocop/version.rb

@@ -0,0 +1,3 @@
+module GLRubocop
+  VERSION = '0.1.0'.freeze
+end

data/lib/gl_rubocop.rb

@@ -0,0 +1,12 @@
+require 'rubocop'
+
+module GLRubocop
+  PROJECT_ROOT = File.expand_path('../', __dir__)
+  CONFIG_DEFAULT = File.join(PROJECT_ROOT, '.rubocop.yml')
+
+  # Register your custom RuboCop config
+  RuboCop::ConfigLoader.default_configuration = RuboCop::ConfigLoader.merge_with_default(
+    RuboCop::ConfigLoader.load_file(CONFIG_DEFAULT),
+    CONFIG_DEFAULT
+  )
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: gl_rubocop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Give Lively
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.62.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.62.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-magic_numbers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- gl_rubocop.gemspec
+- lib/gl_rubocop.rb
+- lib/gl_rubocop/gl_cops/callback_method_names.rb
+- lib/gl_rubocop/gl_cops/interactor_inherits_from_interactor_base.rb
+- lib/gl_rubocop/gl_cops/prevent_erb_files.rb
+- lib/gl_rubocop/gl_cops/sidekiq_inherits_from_sidekiq_job.rb
+- lib/gl_rubocop/version.rb
+homepage: https://github.com/givelively/gl_rubocop
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: A shareable configuration of Give Lively's rubocop rules.
+test_files: []