rubocop-platanus 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a03dfa4de53bd8b6ecc894167346f22ae13d475c5388990d014b8cf910a36aa7
-  data.tar.gz: aa8b77d809a7c927feb85fbc2611bca678025243e2997a98aea81bc25fa25d68
+  metadata.gz: 1c7bdbf20cbe6ebdb80fc221e98427c0aaf6ce306e0f916eea5d41ddf15a1d61
+  data.tar.gz: 1d8b17010d0875bc096c683444d1d7221b080f07c10d19749db25c8b6db60ebc
 SHA512:
-  metadata.gz: 1f8e068755dca01d916faa1e80696d4a7e169d805829a0c62f3fba93f30ca76e55208ba70116d844d12c0c84d71ebf02d0cedc70f90658a0fc49624471ebcdeb
-  data.tar.gz: 80a86b5d5706bb9306c14a10b030f6500fce2b7f66e26c30247419f2b16527ab7e7e891b235c251f2554fd4583798267af01438d225045f9b1dd679644aa321c
+  metadata.gz: afa1eee563a4fb84a2ab075c47c21d0b9a42b92b4ab3f6588e3cb1cd951bc7b39a08c6cf01a2bc2eaf2e56dededd368c4ae78b1f0a56a671cddbc37bbeff2ec1
+  data.tar.gz: ac478f3cd0a18ee955c6c2d03c0d7ca8bfbc18c855393911482dc17d8ceb219e3e01efef45fa3ed22c9e987d0aed8638c68d0b4c5565be441413557e498de9f8

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### v0.2.0
+
+Features
+
+* Add cop Platanus/NoFlashInApi
+* Add cop Platanus/NoEnumerize
+* Add cop Platanus/NoRenderJson
+* Add cop Platanus/PunditInApplicationController
+
 ### v0.1.0
 
 * Initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-platanus (0.1.0)
+    rubocop-platanus (0.2.0)
       rubocop (>= 0.89.0)
 
 GEM
@@ -98,6 +98,7 @@ GEM
     unicode-display_width (2.1.0)
 
 PLATFORMS
+  x86_64-darwin-20
   x86_64-linux
 
 DEPENDENCIES
@@ -112,4 +113,4 @@ DEPENDENCIES
   rubocop-platanus!
 
 BUNDLED WITH
-   2.3.11
+   2.3.14

data/README.md

@@ -1,4 +1,4 @@
-# Test Gem
+# Rubocop Platanus
 
 [![Gem Version](https://badge.fury.io/rb/rubocop-platanus.svg)](https://badge.fury.io/rb/rubocop-platanus)
 [![CircleCI](https://circleci.com/gh/platanus/rubocop-platanus.svg?style=shield)](https://app.circleci.com/pipelines/github/platanus/rubocop-platanus)

data/config/default.yml

@@ -3,4 +3,36 @@
 Platanus/NoCommand:
   Description: "Prefer usage of `ActiveJob` instead of `PowerTypes::Command`"
   Enabled: true
+  Include:
+    - "app/commands/**/*.rb"
   VersionAdded: "<<next>>"
+
+Platanus/NoFlashInApi:
+  Description: "Don't use `flash` in api controllers."
+  Enabled: true
+  SafeAutoCorrect: false
+  Include:
+    - "app/controllers/api/**/*.rb"
+  VersionAdded: "<<next>>"
+  
+Platanus/NoEnumerize:
+  Description: "Prefer usage of Rails `enum` instead of `Enumerize`"
+  Enabled: true
+  SafeAutoCorrect: false
+  Include:
+    - "app/models/**/*.rb"
+  VersionAdded: "<<next>>"
+
+Platanus/NoRenderJson:
+  Description: "Prefer usage of `respond_with` instead of `render json:` to take advantage of `ApiResponder` and `serializers`"
+  Enabled: true
+  Include:
+    - "app/controllers/**/*.rb"
+  VersionAdded: "<<next>>"
+
+Platanus/PunditInApplicationController:
+  Description: "`Pundit` should be included only in the `Application Controller`"
+  Enabled: true
+  Include:
+    - "app/controllers/**/*.rb"
+  VersionAdded: "0.1.0"

data/lib/rubocop/cop/platanus/no_enumerize.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Platanus
+      # Prefer usage of Rails `enum` instead of `Enumerize`
+      #
+      # @safety
+      #   This cop's autocorrection will remove any lines using `extend Enumerize`
+      #   and `enumerize :foo, in: [:bar, :baz]` within a file in app/models.
+      #   There might be a case where using `enumerize` might be the intended behavior.
+      #
+      # @example
+      #   # bad
+      #   class Foo
+      #     extend Enumerize
+      #     enumerize :bar, in: [:foo, :bar]
+      #   end
+      #
+      #   # good
+      #   class Foo
+      #     enum bar: { foo: 0, bar: 1 }
+      #   end
+      #
+      class NoEnumerize < Base
+        extend AutoCorrector
+        MSG = 'Use Rails `enum` instead of `enumerize`.'
+
+        # Detect if class extends `Enumerize`
+        def_node_matcher :extend_enumerize?, <<~PATTERN
+          (send nil? :extend (const nil? :Enumerize) ...)
+        PATTERN
+
+        # Returns the name and `in:` arguments of the enumerize call
+        def_node_matcher :get_enumerize_args, <<~PATTERN
+          (send nil? :enumerize (sym $_) (
+            hash
+            <
+              (pair (sym :in) (array $...))
+              ...
+            >
+          ))
+        PATTERN
+
+        def on_send(node)
+          on_extend_enumerize(node)
+          on_enumerize(node)
+        end
+
+        private
+
+        # Detects if class extends `Enumerize`
+        def on_extend_enumerize(node)
+          return unless extend_enumerize?(node)
+
+          add_offense(node) do |corrector|
+            corrector.remove(node)
+          end
+        end
+
+        # Detects if class uses `enumerize`. If so, it corrects the code.
+        def on_enumerize(node)
+          enumerize_args = get_enumerize_args(node)
+          return unless enumerize_args
+
+          name, args = enumerize_args
+          args = args.map(&:value)
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, enumerize_correction(name, args))
+          end
+        end
+
+        # Returns the corrected code for `enumerize`
+        def enumerize_correction(name, args)
+          args_string = args.map.with_index do |arg, i|
+            "#{arg}: #{i}"
+          end.join(', ')
+
+          "enum #{name}: { #{args_string} }"
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/platanus/no_flash_in_api.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Platanus
+      # Flash shouldn't be used in API controllers.
+      #
+      # @safety
+      #   Auto correction will delete any lines using `flash[:type] = 'foo'`. There might be cases
+      #   where using flash might be the intended behavior.
+      #
+      # @example
+      #
+      #   # bad
+      #   class Api::Internal::ResourcesController < Api::Internal::BaseController
+      #     def show
+      #       flash[:notice] = 'Foo'
+      #       ...
+      #     end
+      #   end
+      #
+      #   # good
+      #   class Api::Internal::ResourcesController < Api::Internal::BaseController
+      #     def show
+      #       ...
+      #     end
+      #   end
+      #
+      class NoFlashInApi < Base
+        extend AutoCorrector
+
+        MSG = "Don't use `flash` in API controllers."
+
+        def_node_matcher :flash?, <<~PATTERN
+          (send (send nil? :flash) :[]= ...)
+        PATTERN
+
+        def on_send(node)
+          return unless flash?(node)
+
+          add_offense(node) do |corrector|
+            corrector.remove(node)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/platanus/no_render_json.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Platanus
+      # `render json:` shouldn't be used in controllers because it'll skip
+      #  the use of ApiResponder and serializers. Use `respond_with` instead.
+      #
+      # @example
+      #
+      #   # bad
+      #   render json: { data: @foo }
+      #
+      #   # bad
+      #   class Api::Internal::ResourcesController < Api::Internal::BaseController
+      #     def show
+      #       authorization_url = google_srv.generate_authorization_url
+      #       respond_with({ authorization_url: authorization_url })
+      #     end
+      #   end
+      #
+      #   # bad
+      #   class Api::Internal::ResourcesController < Api::Internal::BaseController
+      #     def show
+      #       hash_response = { data: @foo }
+      #       respond_with hash_response
+      #     end
+      #   end
+      #
+      #   # good
+      #   respond_with @foo
+      #
+      #   # good
+      #   # values/resource.rb
+      #   class Resource
+      #     include ActiveModel::Serialization
+      #
+      #     attr_accessor :id, :name
+      #
+      #     def initialize(id, name)
+      #       @id = id
+      #       @name = name
+      #     end
+      #   end
+      #
+      #   # serializers/resource_serializer.rb
+      #   class Api::Internal::ResourceSerializer < ActiveModel::Serializer
+      #     type :resource
+      #     attributes(
+      #       :id,
+      #       :name
+      #     )
+      #   end
+      #
+      #   # controllers/api/internal_resources/resources_controller.rb
+      #   class Api::Internal::ResourcesController < Api::Internal::BaseController
+      #     def show
+      #       respond_with(Resource.new(blog.id, blog.title))
+      #     end
+      #   end
+      #
+      class NoRenderJson < Base
+        RENDER_JSON_MSG = 'Use `respond_with` instead of `render json:`.'
+        RENDER_HASH_MSG =
+          'Don\'t use `respond_with` with a hash. Use a value and serializer instead.'
+
+        RESTRICT_ON_SEND = %i[render respond_with].freeze
+
+        # Matches if render is called with json
+        def_node_matcher :render_json?, <<~PATTERN
+          (send nil? :render (hash (pair (sym :json) ...) ...))
+        PATTERN
+
+        # Captures the argument of respond_with
+        def_node_matcher :respond_with, <<~PATTERN
+          (send nil? :respond_with $_)
+        PATTERN
+
+        # Matches if node is hash
+        def_node_matcher :is_hash?, '(hash ...)'
+
+        # Captures the variable named of a used variable
+        def_node_matcher :var_name, '(lvar $_)'
+
+        def on_send(node)
+          if render_json?(node)
+            add_offense(node, message: RENDER_JSON_MSG)
+          elsif respond_with_hash?(node)
+            add_offense(node, message: RENDER_HASH_MSG)
+          end
+        end
+
+        # Determines if the node corresponds to a call of respond_with
+        # with a hash as it's argument.
+        def respond_with_hash?(node)
+          hash_node = respond_with(node)
+          return true if is_hash?(hash_node)
+
+          var_name = var_name(hash_node)
+          return false if var_name.nil?
+
+          var_is_hash?(node, var_name)
+        end
+
+        # Determines if a variable name corresponds to a hash within it's
+        # most immediate scope.
+        def var_is_hash?(node, var_name)
+          scope = node.parent
+          return false unless scope
+
+          pattern = "`(lvasgn :#{var_name} (hash ...))"
+          matcher = RuboCop::AST::NodePattern.new(pattern)
+
+          matcher.match(scope)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/platanus/pundit_in_application_controller.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Platanus
+      # Pundit should not be included in specific controllers. Prefer
+      # including it in the ApplicationController instead.
+      #
+      # @example
+      #   # bad
+      #   class ApplicationController < ActionController::Base
+      #   end
+      #
+      #   class FooController < ApplicationController
+      #     include Pundit
+      #   end
+      #
+      #   # bad
+      #   class ApplicationController < ActionController::Base
+      #   end
+      #
+      #   class FooController < ApplicationController
+      #     include Pundit::Authorization
+      #   end
+      #
+      #   # good
+      #   class ApplicationController < ActionController::Base
+      #     include Pundit
+      #   end
+      #
+      #   class FooController < ApplicationController
+      #   end
+      #
+      #   # good
+      #   class ApplicationController < ActionController::Base
+      #     include Pundit::Authorization
+      #   end
+      #
+      #   class FooController < ApplicationController
+      #   end
+      #
+      class PunditInApplicationController < Base
+        MSG = '`Pundit` should be included only in the `ApplicationController`.'
+
+        def_node_matcher :get_include_pundit_node, <<~PATTERN
+          (class _ _ `$(
+            send
+            nil?
+            :include
+            (const {nil? | (const _ :Pundit)} {:Pundit | :Authorization})
+          ))
+        PATTERN
+
+        def_node_matcher :application_controller?, <<~PATTERN
+          (class (const nil? :ApplicationController) `(const (const nil? :ActionController) :Base) ...)
+        PATTERN
+
+        def on_class(node)
+          pundit_include_node = get_include_pundit_node(node)
+          return unless pundit_include_node && !application_controller?(node)
+
+          add_offense(pundit_include_node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/platanus_cops.rb

@@ -1,3 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'platanus/no_command'
+require_relative 'platanus/no_flash_in_api'
+require_relative 'platanus/no_enumerize'
+require_relative 'platanus/no_render_json'
+require_relative 'platanus/pundit_in_application_controller'

data/lib/rubocop/platanus/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Platanus
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-platanus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Platanus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-22 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,6 +158,10 @@ files:
 - config/default.yml
 - lib/rubocop-platanus.rb
 - lib/rubocop/cop/platanus/no_command.rb
+- lib/rubocop/cop/platanus/no_enumerize.rb
+- lib/rubocop/cop/platanus/no_flash_in_api.rb
+- lib/rubocop/cop/platanus/no_render_json.rb
+- lib/rubocop/cop/platanus/pundit_in_application_controller.rb
 - lib/rubocop/cop/platanus_cops.rb
 - lib/rubocop/platanus.rb
 - lib/rubocop/platanus/inject.rb