rubocop-config-captive 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daad52b9ec57ffb696430f0f7b9a1c797b841afb97c64e86bd8610730fdaecaf
-  data.tar.gz: 82d299623bea48f72e8b71111309d051c829782b2f5b5648b3e5f49b3e67c780
+  metadata.gz: b5756c218562b8bb428e080131872a1d86d05631ab0356b2a22b36411733732c
+  data.tar.gz: 70e0e42455ef3fa6dd8f69fd2192f4961cc9d8eebab8d60a10b68b96a359379d
 SHA512:
-  metadata.gz: 2727c1c5c3f2d413e832167b303bb77ecb495a2c65e0fc82147a19882c511fa5235005f471c085f92e9204140b69a7c48e0ad14bbcd4289e1e746e3ab8f2839c
-  data.tar.gz: 0cb908ed58c39398e9bfa1c2f2b49e7ab7ffd96ec5c78518722db0afc992505ad1185064503f97cbe76e9fca604678ee7214bb32ae795f21071724e13b99c0a4
+  metadata.gz: 020a795f4efc08e561f4c280bc2c1016b08d1d3819e11c5f9a17971aa6ada85dd96a768aa4875ddf3056dcc1fb63afb8e904416918ef29c16efb19f0bd696000
+  data.tar.gz: c968e241425d6ab95fd76b22d7c3edcf49dda21760ca7c9dbff05ee89e3d8db25ba85b2b79a343ca4b88a31d0b000d4d850eef53300f34aabb5e01c05a0b014d

data/Gemfile

@@ -5,9 +5,9 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem 'yard', '~> 0.9.34'
+  gem "yard", "~> 0.9.34"
 end
 
 group :test do
-  gem 'pry', '0.14.2'
+  gem "pry", "0.14.2"
 end

data/README.md

@@ -1,6 +1,7 @@
 # Captive Rubocop config
 
 [![License][license-image]][license-url]
+[![Gem Version](https://img.shields.io/gem/v/rubocop-config-captive.svg)](https://rubygems.org/gems/rubocop-config-captive)
 
 > Rubocop shared configurations for projects
 

data/config/rubocop-captive.yml

@@ -4,6 +4,7 @@ require:
   - ../lib/rubocop/cop/captive/translation/rails_i18n_presence.rb
   - ../lib/rubocop/cop/captive/translation/kaminari_i18n_presence.rb
   - ../lib/rubocop/cop/captive/rspec/specify_before_parameter.rb
+  - ../lib/rubocop/cop/captive/rails/no_email_from_controller.rb
   - ../lib/rubocop/cop/captive/string_where_in_scope.rb
   - ../lib/rubocop/cop/captive/no_app_env.rb
 
@@ -35,6 +36,12 @@ Captive/RSpec/SpecifyBeforeParameter:
   Include:
     - 'spec/**/*'
 
+# Rails
+Captive/Rails/NoEmailFromController:
+  Description: "Do not send emails from controllers. Because it doesn't follow the MVC standard"
+  Include:
+    - 'app/controllers/**/*'
+
 # other
 Captive/StringWhereInScope:
   Description: 'The `where` method should be used in a scope in a model.'

data/config/rubocop-layout.yml

@@ -43,3 +43,8 @@ Layout/MultilineMethodParameterLineBreaks:
 Layout/LineLength:
   # Disable LineLength on comments
   AllowedPatterns: ['^(\s*#)']
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'test/**/*.rb'
+    - '**/*_spec.rb'
+    - '**/*_test.rb'

data/config/rubocop-style.yml

@@ -1,3 +1,12 @@
 inherit_from:
   # @see https://github.com/airbnb/ruby/blob/main/rubocop-airbnb/config/rubocop-style.yml
   - ./__private__/rubocop-style.yml
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/lib/rubocop/captive/inject.rb

@@ -1,6 +1,6 @@
 # Straight up ripped from the custom Rspec rubocop
 # https://github.com/nevir/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-require 'yaml'
+require "yaml"
 
 module RuboCop
   module Captive

data/lib/rubocop/captive/version.rb

@@ -3,6 +3,6 @@
 module RuboCop
   module Captive
     # Version information for the the Airbnb RuboCop plugin.
-    VERSION = '1.5.0'
+    VERSION = "1.6.0"
   end
 end

data/lib/rubocop/captive.rb

@@ -1,14 +1,14 @@
-require 'pathname'
-require 'psych'
+require "pathname"
+require "psych"
 
-Dir.glob(File.expand_path('cop/**/*.rb', File.dirname(__FILE__))).map(&method(:require))
+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_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
     CONFIG = Psych.safe_load(CONFIG_DEFAULT.read).freeze
 
     private_constant(*constants(false))

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

@@ -21,7 +21,7 @@ module RuboCop
             return unless node.command?(:gem)
 
             gem_name = node.arguments[0]&.value
-            return unless gem_name == 'activeadmin'
+            return unless gem_name == "activeadmin"
 
             add_offense(node, message: MSG) unless activeadmin_addons_present?
           end
@@ -29,7 +29,7 @@ module RuboCop
           private
 
           def activeadmin_addons_present?
-            Gem.loaded_specs.keys.include?('activeadmin_addons')
+            Gem.loaded_specs.keys.include?("activeadmin_addons")
           end
         end
       end

data/lib/rubocop/cop/captive/rails/no_email_from_controller.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Captive
+      module Rails
+        # This cop checks for email delivery methods in controllers.
+        # Sending email in controllers is not allowed in order to follow the MVC standard
+        # An email must be sent from a Model
+        class NoEmailFromController < Base
+          MSG = "Do not send emails from controllers. Because it doesn't follow the MVC standard"
+
+          def_node_search :email_delivery?, <<~PATTERN
+            (send _ {:deliver_now :deliver_later})
+          PATTERN
+
+          def on_send(node)
+            return unless email_delivery?(node)
+
+            controller_class = find_controller_class(node)
+            return unless controller_class
+
+            add_offense(node, message: MSG)
+          end
+
+          private
+
+          def find_controller_class(node)
+            node.ancestors.find do |ancestor|
+              ancestor.is_a?(Parser::AST::Node) &&
+                ancestor.type == :class &&
+                ancestor.children[0].const_type?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/captive/rspec/specify_before_parameter.rb

@@ -27,7 +27,7 @@ module RuboCop
         class SpecifyBeforeParameter < RuboCop::Cop::Base
           extend AutoCorrector
 
-          MSG = 'Specify the parameter in `before` blocks. Example : before(:each) or before(:all)'
+          MSG = "Specify the parameter in `before` blocks. Example : before(:each) or before(:all)"
 
           def_node_matcher :before_block?, <<~PATTERN
             (block
@@ -53,7 +53,7 @@ module RuboCop
 
           def add_parameter(node)
             source = node.loc.expression.source
-            source.insert(source.index('before') + 6, '(:each)')
+            source.insert(source.index("before") + 6, "(:each)")
           end
         end
       end

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

@@ -18,7 +18,7 @@ module RuboCop
       #
       #   scope :date_after, ->(date) { where('date > ?', date) }
       class StringWhereInScope < RuboCop::Cop::Cop
-        MSG = 'The `where` method should be used in a scope in a model.'
+        MSG = "The `where` method should be used in a scope in a model."
 
         def_node_matcher :where_with_string?, <<~PATTERN
           (send _ :where (str _) ...)

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

@@ -21,7 +21,7 @@ module RuboCop
             return unless node.command?(:gem)
 
             gem_name = node.arguments[0]&.value
-            return unless gem_name == 'devise'
+            return unless gem_name == "devise"
 
             add_offense(node, message: MSG) unless devise_i18n_present?
           end
@@ -29,7 +29,7 @@ module RuboCop
           private
 
           def devise_i18n_present?
-            Gem.loaded_specs.keys.include?('devise-i18n')
+            Gem.loaded_specs.keys.include?("devise-i18n")
           end
         end
       end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rubocop'
+require "rubocop"
 
 module RuboCop
   module Cop
@@ -23,7 +23,7 @@ module RuboCop
             return unless node.command?(:gem)
 
             gem_name = node.arguments[0]&.value
-            return unless gem_name == 'kaminari'
+            return unless gem_name == "kaminari"
 
             add_offense(node, message: MSG) unless kaminari_i18n_present?
           end
@@ -31,7 +31,7 @@ module RuboCop
           private
 
           def kaminari_i18n_present?
-            Gem.loaded_specs.keys.include?('kaminari-i18n')
+            Gem.loaded_specs.keys.include?("kaminari-i18n")
           end
         end
       end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rubocop'
+require "rubocop"
 
 module RuboCop
   module Cop
@@ -23,7 +23,7 @@ module RuboCop
             return unless node.command?(:gem)
 
             gem_name = node.arguments[0]&.value
-            return unless gem_name == 'rails'
+            return unless gem_name == "rails"
 
             add_offense(node, message: MSG) unless rails_i18n_present?
           end
@@ -31,7 +31,7 @@ module RuboCop
           private
 
           def rails_i18n_present?
-            Gem.loaded_specs.keys.include?('rails-i18n')
+            Gem.loaded_specs.keys.include?("rails-i18n")
           end
         end
       end

data/lib/rubocop-captive.rb

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

data/rubocop-config-captive.gemspec

@@ -1,37 +1,37 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
-require 'rubocop/captive/version'
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "rubocop/captive/version"
 
 Gem::Specification.new do |gem|
-  gem.name = 'rubocop-config-captive'
+  gem.name = "rubocop-config-captive"
   gem.version = RuboCop::Captive::VERSION
-  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.6'
+  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.6"
 
   gem.files = Dir[
-    '{config,lib}/**/*',
-    '*.md',
-    '*.gemspec',
-    'Gemfile',
+    "{config,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.51.0')
-  gem.add_dependency('rubocop-performance', '~> 1.17.1 ')
-  gem.add_dependency('rubocop-rake', '~> 0.6.0')
-  gem.add_dependency('rubocop-rails', '~> 2.18.0')
-  gem.add_dependency('rubocop-rspec', '~> 2.22.0')
-  gem.add_dependency('rubocop-capybara', '~> 2.18.0')
-  gem.add_dependency('rubocop-factory_bot', '~> 2.23.1')
-  gem.add_development_dependency('rspec', '~> 3.12')
+  gem.add_dependency("rubocop", "~> 1.51.0")
+  gem.add_dependency("rubocop-performance", "~> 1.17.1 ")
+  gem.add_dependency("rubocop-rake", "~> 0.6.0")
+  gem.add_dependency("rubocop-rails", "~> 2.18.0")
+  gem.add_dependency("rubocop-rspec", "~> 2.22.0")
+  gem.add_dependency("rubocop-capybara", "~> 2.18.0")
+  gem.add_dependency("rubocop-factory_bot", "~> 2.23.1")
+  gem.add_development_dependency("rspec", "~> 3.12")
   # gem.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-config-captive
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Captive
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -169,6 +169,7 @@ files:
 - lib/rubocop/captive/version.rb
 - lib/rubocop/cop/captive/active_admin/active_admin_addons_presence.rb
 - lib/rubocop/cop/captive/no_app_env.rb
+- lib/rubocop/cop/captive/rails/no_email_from_controller.rb
 - lib/rubocop/cop/captive/rspec/specify_before_parameter.rb
 - lib/rubocop/cop/captive/string_where_in_scope.rb
 - lib/rubocop/cop/captive/translation/devise_i18n_presence.rb