rubocop-flexport 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a599585e57397ed31a361c5267c82ebe7ac4d7e0f673712e31369f135ec0fded
-  data.tar.gz: c9d92a894a7940d3cea6bec075b5e8934d0a79003e59fe58da9925caa74ab46c
+  metadata.gz: 21c9588d65a1cc1b11a85277a94b02caf3dd37bb067b8a2ae09b53da39052bb0
+  data.tar.gz: 2ca05dbe05457065dcfd40e703e6a9c29340fd44a20862df21364ebc1c31e76f
 SHA512:
-  metadata.gz: c596496c5e30b66d43f587a115d948ccea67549e116f4661337a101132a0776909be6329f2af13a5cf2ea115321787fbd589f00f6e20713cd012a48275d7db5e
-  data.tar.gz: 88aadf6198c2e703e2bf016d81059ec6e2309889ccaba9be6d10b9a458a8072a72baef8df08d0b0bbac66e2059a4a05b8af365439e76b30c8b2c498ad8c4815a
+  metadata.gz: 375ce90040f7a4185de7bc785867b46574dbc04a24ac0f17d8d3213075b9f689c60aec9e127830aea48005f76ca3f8a8023948a792284f45460fc80ce704ff87
+  data.tar.gz: 560c5d8655494e752fae1db186c5c7ee1d514fa938fb977c07d09a1c87b9edcffc17d9bec31aa6b42a25436df480f63e70caee00bc3b52f3cdd786cb18962aaf

data/README.md

@@ -1,4 +1,4 @@
-# Rubocop::Flexport
+# RuboCop::Flexport
 
 This repo is for cops developed at Flexport that don't make sense to upstream
 into any of the existing RuboCop repos. When possible, we prefer upstreaming.

data/config/default.yml

@@ -1,3 +1,15 @@
+Flexport/GlobalModelAccessFromEngine:
+  Description: 'Do not directly access global models from within Rails Engines.'
+  Enabled: false
+  VersionAdded: '0.2.0'
+  AutoCorrect: false
+  EnginesPath: engines/
+  GlobalModelsPath: app/models/
+  DisabledEngines: []
+  AllowedGlobalModels: []
+  Include:
+    - '**/*.rb'
+
 Flexport/NewGlobalModel:
   Description: 'Disallows addition of new global models to `app/models`. Prefer Rails Engines or namespaces.'
   Enabled: true

data/lib/rubocop/cop/flexport/global_model_access_from_engine.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+require 'digest/sha1'
+
+module RuboCop
+  module Cop
+    module Flexport
+      # This cop checks for engines reaching directly into app/ models.
+      #
+      # With an ActiveRecord object, engine code can perform arbitrary
+      # reads and arbitrary writes to models located in the main `app/`
+      # directory. This cop helps isolate Rails Engine code to ensure
+      # that modular boundaries are respected.
+      #
+      # Checks for both access via `MyGlobalModel.foo` and associations.
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   class MyEngine::MyService
+      #     m = SomeGlobalModel.find(123)
+      #     m.any_random_attribute = "whatever i want"
+      #     m.save
+      #   end
+      #
+      #   # good
+      #
+      #   class MyEngine::MyService
+      #     ApiServiceForGlobalModels.perform_a_supported_operation("foo")
+      #   end
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   class MyEngine::MyModel < ApplicationModel
+      #     has_one :some_global_model, class_name: "SomeGlobalModel"
+      #   end
+      #
+      #   # good
+      #
+      #   class MyEngine::MyModel < ApplicationModel
+      #     # No direct association to global models.
+      #   end
+      #
+      class GlobalModelAccessFromEngine < Cop
+        MSG = 'Direct access of global model from within Rails Engine.'
+
+        def_node_matcher :rails_association_hash_args, <<-PATTERN
+          (send _ {:belongs_to :has_one :has_many} sym $hash)
+        PATTERN
+
+        def on_const(node)
+          return unless in_enforced_engine_file?
+          return unless global_model_const?(node)
+          # The cop allows access to e.g. MyGlobalModel::MY_CONST.
+          return if child_of_const?(node)
+
+          add_offense(node)
+        end
+
+        def on_send(node)
+          return unless in_enforced_engine_file?
+
+          rails_association_hash_args(node) do |assocation_hash_args|
+            class_name_node = extract_class_name_node(assocation_hash_args)
+            class_name = class_name_node&.value
+            next unless global_model?(class_name)
+
+            add_offense(class_name_node)
+          end
+        end
+
+        # Because this cop's behavior depends on the state of external files,
+        # we override this method to bust the RuboCop cache when those files
+        # change.
+        def external_dependency_checksum
+          Digest::SHA1.hexdigest(model_dir_paths.join)
+        end
+
+        private
+
+        def global_model_names
+          @global_model_names ||= calculate_global_models
+        end
+
+        def model_dir_paths
+          Dir[File.join(global_models_path, '**/*.rb')]
+        end
+
+        def calculate_global_models
+          all_model_paths = model_dir_paths.reject do |path|
+            path.include?('/concerns/')
+          end
+          all_models = all_model_paths.map do |path|
+            # Translates `app/models/foo/bar_baz.rb` to `Foo::BarBaz`.
+            file_name = path.gsub(global_models_path, '').gsub('.rb', '')
+            ActiveSupport::Inflector.classify(file_name)
+          end
+          all_models - allowed_global_models
+        end
+
+        def extract_class_name_node(assocation_hash_args)
+          assocation_hash_args.each_pair do |key, value|
+            return value if key.value == :class_name && value.str_type?
+          end
+          nil
+        end
+
+        def in_enforced_engine_file?
+          file_path = processed_source.path
+          return false unless file_path.include?(engines_path)
+          return false if in_disabled_engine?(file_path)
+
+          true
+        end
+
+        def in_disabled_engine?(file_path)
+          disabled_engines.any? do |e|
+            file_path.include?(File.join(engines_path, e))
+          end
+        end
+
+        def global_model_const?(const_node)
+          # Remove leading `::`, if any.
+          class_name = const_node.source.sub(/^:*/, '')
+          global_model?(class_name)
+        end
+
+        # class_name is e.g. "FooGlobalModelNamespace::BarModel"
+        def global_model?(class_name)
+          global_model_names.include?(class_name)
+        end
+
+        def child_of_const?(node)
+          node.parent.const_type?
+        end
+
+        def global_models_path
+          path = cop_config['GlobalModelsPath']
+          path += '/' unless path.end_with?('/')
+          path
+        end
+
+        def engines_path
+          cop_config['EnginesPath']
+        end
+
+        def disabled_engines
+          raw = cop_config['DisabledEngines'] || []
+          raw.map do |e|
+            ActiveSupport::Inflector.underscore(e)
+          end
+        end
+
+        def allowed_global_models
+          cop_config['AllowedGlobalModels'] || []
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/flexport/new_global_model.rb

@@ -12,6 +12,12 @@ module RuboCop
       # Use RuboCop's standard `Exclude` file list parameter to exclude
       # existing global model files from counting as violations for this cop.
       #
+      # If you have a monorepo with multiple Rails services, you may wish to
+      # set GlobalModelsPath to something more specific than `app/models` so
+      # that it only matches the main monolith service and allows global
+      # models in other, smaller services. To do this, just set GlobalModelsPath
+      # to e.g. `flexport/app/models` in your `.rubocop.yml`.
+      #
       # @example AllowNamespacedGlobalModels: true (default)
       #   # When `AllowNamespacedGlobalModels` is true, the cop only forbids
       #   # additions at the top-level directory.

data/lib/rubocop/cop/flexport_cops.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
+require_relative 'flexport/global_model_access_from_engine'
 require_relative 'flexport/new_global_model'

data/lib/rubocop/flexport/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Flexport
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-flexport
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Flexport Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -37,6 +51,7 @@ files:
 - bin/setup
 - config/default.yml
 - lib/rubocop-flexport.rb
+- lib/rubocop/cop/flexport/global_model_access_from_engine.rb
 - lib/rubocop/cop/flexport/new_global_model.rb
 - lib/rubocop/cop/flexport_cops.rb
 - lib/rubocop/flexport.rb