rubocop-config-captive 1.0.0.pre.alpha.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89d38bf5656750c061e2f17069a6b5b9e2919d462cc1fb527c15896cf807c751
+  data.tar.gz: 700106edcfd7d46a29150039913a00d1033c6c80ba222cf54c4754da0d729a75
+SHA512:
+  metadata.gz: d24d1dff0a51f0fa491d7233ccc9a2e5b7f9d1ca14519feaa6c65120c3694455bc353e044d625848bad04c53ea69a733ca35fe834ec5449a126deaca64cd75a3
+  data.tar.gz: d79d9497e83fcfbb5b26cee87bc7fea4b1d017899bda5b75baf22f9cfcac5977589ba5efb870a9f80b07f7d62f9f2b135d698a0503426e3c1682e702b25b5339

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rubocop", "~> 1.21"
+gem 'rspec'
+gem 'rubocop-rspec'
+
+group :test do
+  gem 'pry'
+end

data/README.md

@@ -0,0 +1,56 @@
+# Captive Rubocop config
+
+[![License][license-image]][license-url]
+
+> Rubocop shared configurations for projects
+
+## Install
+
+add the follow line into your `Gemfile`
+
+```ruby
+group :test, :development do
+  gem 'rubocop-config-captive', github: 'Captive-Studio/rubocop-config'
+end
+```
+
+And then in a terminal
+
+```console
+$ bundle install
+[...]
+```
+
+## Usage
+
+```yml
+# /.rubocop.yml
+inherit_gem:
+  rubocop-config-captive:
+    - config/default.yml
+    # -OR-
+    # - config/rubocop-XXX.yml
+```
+
+## My project has too many errors
+
+Firstly, you can use `bundle exec rubocop -a` to auto-correct your project
+
+Then if you have too many warnings, you can use the command line :
+
+`bundle exec rubocop --auto-gen-config` to create `.rubocop_todo.yml` file that ignore these errors
+
+## Contributing
+
+To contribute, here are some inspirations for good configurations :
+
+- [Airbnb](https://github.com/airbnb/ruby/tree/main/rubocop-airbnb)
+
+## License
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[${license}][license-url] © ${author}) -->
+[MIT][license-url] © Captive Studio <julien.polo@captive.fr>
+
+<!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[license-image]: https://img.shields.io/badge/license-${license}-green.svg?style=flat-square) -->
+[license-image]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square
+<!-- AUTO-GENERATED-CONTENT:END -->
+[license-url]: ./LICENSE

data/lib/rubocop/captive/inject.rb

@@ -0,0 +1,20 @@
+# Straight up ripped from the custom Rspec rubocop
+# https://github.com/nevir/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+require 'yaml'
+
+module RuboCop
+  module Captive
+    # 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.load_file(path).to_hash
+        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/lib/rubocop/captive.rb

@@ -0,0 +1,16 @@
+require 'pathname'
+require 'psych'
+
+Dir.glob(File.expand_path('cop/**/*.rb', File.dirname(__FILE__))).map(&method(:require))
+
+module RuboCop
+  # RuboCop Captive project namespace
+  module Captive
+    PROJECT_ROOT =
+      Pathname.new(__FILE__).parent.parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG = Psych.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(*constants(false))
+  end
+end

data/lib/rubocop/cop/captive/active_admin/active_admin_addons_presence.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Captive
+      module ActiveAdmin
+        class ActiveAdminAddonsPresence < RuboCop::Cop::Cop
+          MSG = "The gem `activeadmin_addons` should be added to the Gemfile "\
+                "if `activeadmin` is present in Gemfile"
+
+          def on_send(node)
+            return unless node.command?(:gem)
+
+            gem_name = node.arguments[0]&.value
+            return unless gem_name == 'activeadmin'
+
+            add_offense(node, message: MSG) unless activeadmin_addons_present?
+          end
+
+          private
+
+          def activeadmin_addons_present?
+            Gem.loaded_specs.keys.include?('activeadmin_addons')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/captive/string_where_in_scope.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Captive
+      class StringWhereInScope < RuboCop::Cop::Cop
+        MSG = 'The `where` method should be used in a scope in a model.'
+
+        def_node_matcher :where_with_string?, <<~PATTERN
+          (send _ :where (str _) ...)
+        PATTERN
+
+        def on_send(node)
+          return unless where_with_string?(node)
+
+          options_node = node.arguments[0]
+          return if options_node&.hash_type?
+
+          add_offense(options_node, message: MSG)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/captive/translation/devise_i18n_presence.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Captive
+      module Translation
+        class DeviseI18nPresence < RuboCop::Cop::Cop
+          MSG = "The gem `devise-i18n` should be added to the Gemfile "\
+                "if `devise` is present in Gemfile"
+
+          def on_send(node)
+            return unless node.command?(:gem)
+
+            gem_name = node.arguments[0]&.value
+            return unless gem_name == 'devise'
+
+            add_offense(node, message: MSG) unless devise_i18n_present?
+          end
+
+          private
+
+          def devise_i18n_present?
+            Gem.loaded_specs.keys.include?('devise-i18n')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/captive/translation/kaminari_i18n_presence.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Captive
+      module Translation
+        class KaminariI18nPresence < RuboCop::Cop::Cop
+          MSG = "The gem `kaminari-i18n` should be added to the Gemfile "\
+                "if `kaminari` is present in Gemfile"
+
+          def on_send(node)
+            return unless node.command?(:gem)
+
+            gem_name = node.arguments[0]&.value
+            return unless gem_name == 'kaminari'
+
+            add_offense(node, message: MSG) unless kaminari_i18n_present?
+          end
+
+          private
+
+          def kaminari_i18n_present?
+            Gem.loaded_specs.keys.include?('kaminari-i18n')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/captive/translation/rails_i18n_presence.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Captive
+      module Translation
+        class RailsI18nPresence < RuboCop::Cop::Cop
+          MSG = "The gem `rails-i18n` should be added to the Gemfile "\
+                "if `rails` is present in Gemfile"
+
+          def on_send(node)
+            return unless node.command?(:gem)
+
+            gem_name = node.arguments[0]&.value
+            return unless gem_name == 'rails'
+
+            add_offense(node, message: MSG) unless rails_i18n_present?
+          end
+
+          private
+
+          def rails_i18n_present?
+            Gem.loaded_specs.keys.include?('rails-i18n')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop-captive.rb

@@ -0,0 +1,14 @@
+require 'pathname'
+require 'yaml'
+
+# Load original rubocop gem
+require 'rubocop'
+
+require 'rubocop-performance'
+require 'rubocop-rails'
+
+require 'rubocop/captive'
+require 'rubocop/captive/inject'
+# require 'rubocop/airbnb/version'
+
+RuboCop::Captive::Inject.defaults!

data/rubocop-config-captive.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |gem|
+  gem.name = 'rubocop-config-captive'
+  gem.version = '1.0.0-alpha.3'
+  gem.summary = 'Shared rubocop configurations'
+  gem.description = 'Shared rubocop configuration for Captive projects'
+  gem.authors = ['Captive', 'Julien Polo', "Clément Prod'homme"]
+  gem.email = ['julien.polo@captive.fr']
+  gem.homepage = 'https://github.com/Captive-Studio/rubocop-config'
+  gem.license = 'MIT'
+  gem.required_ruby_version = '>= 2.5'
+
+  gem.files = Dir[
+    '{conf,lib}/**/*',
+    '*.md',
+    '*.gemspec',
+    'Gemfile',
+  ]
+
+  # It is not clear what the level of support is provided by Airbnb
+  # ⚠️ Instead of depending on rubocop-airbnb we copy sources
+  #
+  # gem.add_dependency('rubocop-airbnb', '~> 4.0.0')
+  gem.add_dependency('rubocop', '~> 1.49.0')
+  gem.add_dependency('rubocop-performance', '~> 1.16.0 ')
+  gem.add_dependency('rubocop-rake', '~> 0.6.0')
+  gem.add_dependency('rubocop-rails', '~> 2.18.0')
+  gem.add_dependency('rubocop-rspec', '~> 2.19.0')
+  gem.add_dependency('rubocop-capybara', '~> 2.17.1')
+  gem.add_development_dependency('rspec', '~> 3.12')
+  # gem.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-config-captive
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha.3
+platform: ruby
+authors:
+- Captive
+- Julien Polo
+- Clément Prod'homme
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.49.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.49.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: Shared rubocop configuration for Captive projects
+email:
+- julien.polo@captive.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/rubocop-captive.rb
+- lib/rubocop/captive.rb
+- lib/rubocop/captive/inject.rb
+- lib/rubocop/cop/captive/active_admin/active_admin_addons_presence.rb
+- lib/rubocop/cop/captive/string_where_in_scope.rb
+- lib/rubocop/cop/captive/translation/devise_i18n_presence.rb
+- lib/rubocop/cop/captive/translation/kaminari_i18n_presence.rb
+- lib/rubocop/cop/captive/translation/rails_i18n_presence.rb
+- rubocop-config-captive.gemspec
+homepage: https://github.com/Captive-Studio/rubocop-config
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Shared rubocop configurations
+test_files: []