rubocop-flexport 0.7.0 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1affaedaabe7b84350802f0d4222c052e94d19120c92e556250df045d9f36cc5
-  data.tar.gz: efed93fb328d46330498aa2298e3aa5ff872faaab01dae64b06ab279f764d36e
+  metadata.gz: 14af72c337894273c5528d75f172b6defe96ae4f2a79f338fcaed8a02190aad5
+  data.tar.gz: 1ff6475e48b37ba26859de9150e30799e4d40b000ce2610b6b7dcc57d7a8cc7b
 SHA512:
-  metadata.gz: 0737a98974780066c5b8a0822825a7a9372cf6b3c155d4b5734fafed971b023e8559e6a77d29f16c9213389b9162f61ea24948d8a2a7dd3f5aeadf820577ab9d
-  data.tar.gz: b01a9c75229f63ce3bfef495e622c8c53450fa0cf5ac0cb1f4afddfca21785b8760c3428c90d5bb7144de4e4124112f9843d212d494cc988ddfa6b4963b428a5
+  metadata.gz: e43ce8e0ed08dc66aef89f753f8a53bc4e9532b46e45c0e42fd2b6d545c0d0ea62e24cad6ab1afe7728eefd0da4e5651614fd965d31bd127b3f17a5145911f89
+  data.tar.gz: 91ba38734c2c250fae6323c14f17c782b25bc7eb8bc6754fc3225bbfa005a0165b0d4099ac78a0b8998bf7ebbdd7273fc20084f6a541a8149160d83d1889ea9f

data/README.md

@@ -43,7 +43,7 @@ like below and then run `bundle install`:
 gem "rubocop-flexport", path: "/Users/<user>/rubocop-flexport"
 ```
 
-To release a new version, update the version number in `version.rb`, and then
+To release a new version, update the version number in `lib/rubocop/flexport/version.rb`, and then
 run `bundle exec rake release`, which will create a git tag for the version,
 push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/config/default.yml

@@ -6,6 +6,8 @@ Flexport/EngineApiBoundary:
   UnprotectedEngines: []
   StronglyProtectedEngines: []
   EngineSpecificOverrides: []
+  FactoryBotEnabled: false
+  FactoryBotOutboundAccessAllowedEngines: []
 
 Flexport/GlobalModelAccessFromEngine:
   Description: 'Do not directly access global models from within Rails Engines.'
@@ -16,6 +18,8 @@ Flexport/GlobalModelAccessFromEngine:
   GlobalModelsPath: app/models/
   DisabledEngines: []
   AllowedGlobalModels: []
+  FactoryBotEnabled: false
+  FactoryBotGlobalAccessAllowedEngines: []
   Include:
     - '**/*.rb'
 

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'digest/sha1'
+
 # rubocop:disable Metrics/ClassLength
 module RuboCop
   module Cop
@@ -17,7 +19,7 @@ module RuboCop
       #   will be accessible outside your engine. For example, adding
       #   `api/foo_service.rb` will allow code outside your engine to
       #   invoke eg `MyEngine::Api::FooService.bar(baz)`.
-      # - Create a `_whitelist.rb` file in `api/`. Modules listed in
+      # - Create an `_allowlist.rb` or `_whitelist.rb` file in `api/`. Modules listed in
       #   this file are accessible to code outside the engine. The file
       #   must have this name and a particular format (see below).
       #
@@ -39,6 +41,11 @@ module RuboCop
       # The cop detects cross-engine associations as well as cross-engine
       # module access.
       #
+      # The cop will complain if you use FactoryBot factories defined in other
+      # engines in your engine's specs. You can disable this check by adding
+      # the engine name to `FactoryBotOutboundAccessAllowedEngines` in
+      # .rubocop.yml.
+      #
       # # Isolation guarantee
       #
       # This cop can be easily circumvented with metaprogramming, so it cannot
@@ -141,6 +148,7 @@ module RuboCop
       class EngineApiBoundary < Cop
         include EngineApi
         include EngineNodeContext
+        include FactoryBotUsage
 
         MSG = 'Direct access of %<accessed_engine>s engine. ' \
               'Only access engine via %<accessed_engine>s::Api.'
@@ -179,19 +187,42 @@ module RuboCop
 
         def on_send(node)
           rails_association_hash_args(node) do |assocation_hash_args|
-            class_name_node = extract_class_name_node(assocation_hash_args)
-            next if class_name_node.nil?
-
-            accessed_engine = extract_model_engine(class_name_node)
-            next if accessed_engine.nil?
-            next if valid_engine_access?(node, accessed_engine)
+            check_for_cross_engine_rails_association(node, assocation_hash_args)
+          end
+          return unless check_for_cross_engine_factory_bot?
 
-            add_offense(class_name_node, message: message(accessed_engine))
+          factory_bot_usage(node) do |factory_node|
+            check_for_cross_engine_factory_bot_usage(node, factory_node)
           end
         end
 
+        def check_for_cross_engine_rails_association(node, assocation_hash_args)
+          class_name_node = extract_class_name_node(assocation_hash_args)
+          return if class_name_node.nil?
+
+          accessed_engine = extract_model_engine(class_name_node)
+          return if accessed_engine.nil?
+          return if valid_engine_access?(node, accessed_engine)
+
+          add_offense(class_name_node, message: message(accessed_engine))
+        end
+
+        def check_for_cross_engine_factory_bot_usage(node, factory_node)
+          factory = factory_node.children[0]
+          accessed_engine, model_class_name = factory_engines[factory]
+          return if accessed_engine.nil? || !protected_engines.include?(accessed_engine)
+
+          model_class_node = parse_ast(model_class_name)
+          return if valid_engine_access?(model_class_node, accessed_engine)
+
+          add_offense(node, message: message(accessed_engine))
+        end
+
         def external_dependency_checksum
-          engine_api_files_modified_time_checksum(engines_path)
+          checksum = engine_api_files_modified_time_checksum(engines_path)
+          return checksum unless check_for_cross_engine_factory_bot?
+
+          checksum + spec_factories_modified_time_checksum
         end
 
         private
@@ -268,7 +299,7 @@ module RuboCop
           (
             in_legacy_dependent_file?(accessed_engine) ||
             through_api?(node) ||
-            whitelisted?(node, accessed_engine)
+            allowlisted?(node, accessed_engine)
           )
         end
 
@@ -296,14 +327,15 @@ module RuboCop
         end
 
         def current_engine
-          @current_engine ||= begin
-            file_path = processed_source.path
-            if file_path&.include?(engines_path)
-              parts = file_path.split(engines_path)
-              engine_dir = parts.last.split('/').first
-              ActiveSupport::Inflector.camelize(engine_dir) if engine_dir
-            end
-          end
+          @current_engine ||= engine_name_from_path(processed_source.path)
+        end
+
+        def engine_name_from_path(file_path)
+          return nil unless file_path&.include?(engines_path)
+
+          parts = file_path.split(engines_path)
+          engine_dir = parts.last.split('/').first
+          ActiveSupport::Inflector.camelize(engine_dir) if engine_dir
         end
 
         def in_engine_file?(accessed_engine)
@@ -326,15 +358,16 @@ module RuboCop
           node.parent&.const_type? && node.parent.children.last == :Api
         end
 
-        def whitelisted?(node, engine)
-          whitelist = read_api_file(engine, :whitelist)
-          return false if whitelist.empty?
+        def allowlisted?(node, engine)
+          allowlist = read_api_file(engine, :allowlist)
+          allowlist = read_api_file(engine, :whitelist) if allowlist.empty?
+          return false if allowlist.empty?
 
           depth = 0
           max_depth = 5
-          while node.const_type? && depth < max_depth
+          while node&.const_type? && depth < max_depth
             full_const_name = remove_leading_colons(node.source)
-            return true if whitelist.include?(full_const_name)
+            return true if allowlist.include?(full_const_name)
 
             node = node.parent
             depth += 1
@@ -392,6 +425,37 @@ module RuboCop
         def strongly_protected_engine?(engine)
           strongly_protected_engines.include?(engine)
         end
+
+        def factory_bot_outbound_access_allowed_engines
+          @factory_bot_outbound_access_allowed_engines ||=
+            camelize_all(cop_config['FactoryBotOutboundAccessAllowedEngines'] || [])
+        end
+
+        def factory_bot_enabled?
+          cop_config['FactoryBotEnabled']
+        end
+
+        def check_for_cross_engine_factory_bot?
+          spec_file? &&
+            factory_bot_enabled? &&
+            !factory_bot_outbound_access_allowed_engines.include?(current_engine)
+        end
+
+        # Maps factories to the engine where they are defined.
+        def factory_engines
+          @factory_engines ||= find_factories.each_with_object({}) do |factory_file, h|
+            path, factories = factory_file
+            engine_name = engine_name_from_path(path)
+            factories.each do |factory, model_class_name|
+              h[factory] = [engine_name, model_class_name]
+            end
+          end
+        end
+
+        def spec_factories_modified_time_checksum
+          mtimes = factory_files.sort.map { |f| File.mtime(f) }
+          Digest::SHA1.hexdigest(mtimes.join)
+        end
       end
     end
   end

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

@@ -45,8 +45,14 @@ module RuboCop
       #     # No direct association to global models.
       #   end
       #
+      # This cop will also complain if you try to use global FactoryBot
+      # factories in your engine's specs. To disable this behavior for your
+      # engine, add it to the `FactoryBotGlobalAccessAllowedEngines` list in
+      # .rubocop.yml.
+      #
       class GlobalModelAccessFromEngine < Cop
         include EngineNodeContext
+        include FactoryBotUsage
 
         MSG = 'Direct access of global model `%<model>s` ' \
               'from within Rails Engine.'
@@ -69,19 +75,41 @@ module RuboCop
           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)
+            check_for_rails_association_with_global_model(assocation_hash_args)
+          end
+
+          return unless check_for_global_factory_bot?
 
-            add_offense(class_name_node, message: message(class_name))
+          factory_bot_usage(node) do |factory_node|
+            check_for_global_factory_bot_usage(node, factory_node)
           end
         end
 
+        def check_for_rails_association_with_global_model(assocation_hash_args)
+          class_name_node = extract_class_name_node(assocation_hash_args)
+          class_name = class_name_node&.value
+          return unless global_model?(class_name)
+
+          add_offense(class_name_node, message: message(class_name))
+        end
+
+        def check_for_global_factory_bot_usage(node, factory_node)
+          factory = factory_node.children[0]
+          return unless global_factory?(factory)
+
+          model_class_name = global_factories[factory]
+          add_offense(node, message: message(model_class_name))
+        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)
+          if check_for_global_factory_bot?
+            Digest::SHA1.hexdigest((model_dir_paths + global_factories.keys.sort).join)
+          else
+            Digest::SHA1.hexdigest(model_dir_paths.join)
+          end
         end
 
         private
@@ -94,6 +122,11 @@ module RuboCop
           @global_model_names ||= calculate_global_models
         end
 
+        def global_factories
+          @global_factories ||=
+            find_factories.reject { |path| path.start_with?(engines_path) }.values.reduce(:merge)
+        end
+
         def model_dir_paths
           Dir[File.join(global_models_path, '**/*.rb')]
         end
@@ -127,7 +160,15 @@ module RuboCop
 
         def in_disabled_engine?(file_path)
           disabled_engines.any? do |e|
-            file_path.include?(File.join(engines_path, e))
+            # Add trailing / to engine path to avoid incorrectly
+            # matching engines with similar names
+            file_path.include?(File.join(engines_path, e, ''))
+          end
+        end
+
+        def check_for_global_factory_bot?
+          spec_file? && factory_bot_enabled? && factory_bot_global_access_allowed_engines.none? do |engine|
+            processed_source.path.include?(File.join(engines_path, engine, ''))
           end
         end
 
@@ -142,6 +183,10 @@ module RuboCop
           global_model_names.include?(class_name)
         end
 
+        def global_factory?(factory_name)
+          global_factories.include?(factory_name)
+        end
+
         def child_of_const?(node)
           node.parent.const_type?
         end
@@ -163,6 +208,14 @@ module RuboCop
           end
         end
 
+        def factory_bot_global_access_allowed_engines
+          cop_config['FactoryBotGlobalAccessAllowedEngines'] || []
+        end
+
+        def factory_bot_enabled?
+          cop_config['FactoryBotEnabled']
+        end
+
         def allowed_global_models
           cop_config['AllowedGlobalModels'] || []
         end

data/lib/rubocop/cop/flexport_cops.rb

@@ -2,6 +2,7 @@
 
 require_relative 'mixin/engine_api'
 require_relative 'mixin/engine_node_context'
+require_relative 'mixin/factory_bot_usage'
 
 require_relative 'flexport/engine_api_boundary'
 require_relative 'flexport/global_model_access_from_engine'

data/lib/rubocop/cop/mixin/engine_api.rb

@@ -10,9 +10,13 @@ module RuboCop
       extend NodePattern::Macros
 
       API_FILE_DETAILS = {
+        allowlist: {
+          file_basename: '_allowlist.rb',
+          array_matcher: :allowlist_array
+        },
         whitelist: {
           file_basename: '_whitelist.rb',
-          array_matcher: :whitelist_array
+          array_matcher: :allowlist_array
         },
         legacy_dependents: {
           file_basename: '_legacy_dependents.rb',
@@ -58,8 +62,7 @@ module RuboCop
         File.join(engines_path, "#{raw_name}/app/api/#{raw_name}/api/")
       end
 
-      def parse_ast(file_path)
-        source_code = File.read(file_path)
+      def parse_ast(source_code)
         source = RuboCop::ProcessedSource.new(source_code, RUBY_VERSION.to_f)
         source.ast
       end
@@ -99,7 +102,7 @@ module RuboCop
         #             s(:const, nil, :Trucking), :LoadTypes)), :freeze)))
         #
         # We want the :begin in the 2nd case, the :module in the 1st case.
-        module_node = parse_ast(path)
+        module_node = parse_ast(File.read(path))
         module_block_node = module_node&.children&.[](1)
         if module_block_node&.begin_type?
           module_block_node
@@ -108,7 +111,7 @@ module RuboCop
         end
       end
 
-      def_node_matcher :whitelist_array, <<-PATTERN
+      def_node_matcher :allowlist_array, <<-PATTERN
           (casgn nil? {:PUBLIC_MODULES :PUBLIC_SERVICES :PUBLIC_CONSTANTS :PUBLIC_TYPES} {$array (send $array ...)})
       PATTERN
 

data/lib/rubocop/cop/mixin/factory_bot_usage.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+
+module RuboCop
+  module Cop
+    # Helpers for detecting FactoryBot usage.
+    # rubocop:disable Metrics/ModuleLength
+    module FactoryBotUsage
+      extend NodePattern::Macros
+
+      Factory = Struct.new('Factory', :name, :aliases, :parent, :model_class_name)
+
+      FACTORY_BOT_METHODS = %i[
+        attributes_for
+        attributes_for_list
+        build
+        build_list
+        build_pair
+        build_stubbed
+        build_stubbed_list
+        create
+        create_list
+        create_pair
+      ].freeze
+
+      def_node_matcher :factory_bot_usage, <<~PATTERN
+        (send _ {#{FACTORY_BOT_METHODS.map(&:inspect).join(' ')}} $sym ...)
+      PATTERN
+
+      # Cache factories at the class level so that we don't have to fetch them
+      # again for every file we lint. We use class variables here so that the
+      # cache can be shared by all cops that include this module.
+      # rubocop:disable Style/ClassVars
+      @@factories = nil
+
+      def self.factories_cache
+        @@factories
+      end
+
+      def self.factories_cache=(factories)
+        @@factories = factories
+      end
+      # rubocop:enable Style/ClassVars
+
+      def spec_file?
+        processed_source&.path&.match?(/_spec\.rb$/) || false
+      end
+
+      # Parses factory definition files, returning a hash mapping factory names
+      # to model class names for each file.
+      def find_factories
+        RuboCop::Cop::FactoryBotUsage.factories_cache ||= begin
+          # We'll add factories here as we parse the factory files.
+          @factories = {}
+
+          # We'll add factories that specify a parent here, so we can resolve the
+          # reference to the parent after we have finished parsing all the files.
+          @parents = {}
+
+          # Parse the factory files, then resolve any parent references.
+          traverse_factory_files
+          resolve_parents
+
+          @factories
+        end
+      end
+
+      def factory_files
+        @factory_files ||= Dir['spec/factories/**/*.rb'] + Dir["#{engines_path}*/spec/factories/**/*.rb"]
+      end
+
+      def engines_path
+        raise NotImplementedError
+      end
+
+      private
+
+      def traverse_factory_files
+        factory_files.each do |path|
+          @factories[path] = {}
+          @parents[path] = {}
+
+          source_code = File.read(path)
+          source = RuboCop::ProcessedSource.new(source_code, RUBY_VERSION.to_f)
+          traverse_node(source.ast, path)
+        end
+      end
+
+      def resolve_parents
+        all_factories = @factories.values.reduce(:merge)
+        all_parents = @parents.values.reduce(:merge)
+        @parents.each do |path, parents|
+          parents.each do |factory, parent|
+            parent = all_parents[parent] while all_parents[parent]
+            model_class_name = all_factories[parent]
+            next unless model_class_name
+
+            @factories[path][factory] = model_class_name
+          end
+        end
+      end
+
+      def traverse_node(node, path, parent = nil, model_class_name = nil)
+        return unless node.is_a?(Parser::AST::Node)
+
+        factory_node = extract_factory_node(node)
+        if factory_node
+          factory = parse_factory_node(factory_node)
+          parent = determine_parent(factory, parent)
+          model_class_name = determine_model_class_name(factory, model_class_name)
+          if factory_node?(node)
+            register_factory(path, factory.name, factory.aliases, parent, model_class_name)
+            return
+          end
+        end
+
+        node.children.each { |child| traverse_node(child, path, parent, model_class_name) }
+      end
+
+      def extract_factory_node(node)
+        return node.children[0] if factory_block?(node)
+        return node if factory_node?(node)
+      end
+
+      def register_factory(path, factory_name, aliases, parent, model_class_name)
+        ([factory_name] + aliases).each do |name|
+          if parent
+            @parents[path][name] = parent
+          else
+            @factories[path][name] = model_class_name
+          end
+        end
+      end
+
+      def factory_block?(node)
+        return false if node&.type != :block
+
+        factory_node?(node.children[0])
+      end
+
+      def factory_node?(node)
+        node&.type == :send && node.children[1] == :factory
+      end
+
+      def parse_factory_node(node)
+        factory_name_node, factory_config_node = node.children[2..3]
+
+        name = factory_name_node.children[0]
+        aliases = extract_aliases(factory_config_node)
+        parent = extract_parent(factory_config_node)
+        model_class_name = extract_model_class_name(factory_config_node)
+
+        Factory.new(name, aliases, parent, model_class_name)
+      end
+
+      def extract_aliases(factory_config_hash_node)
+        aliases_array = extract_hash_value(factory_config_hash_node, :aliases)
+        return [] if aliases_array&.type != :array
+
+        aliases_array.children.map(&:value)
+      end
+
+      def extract_parent(factory_config_hash_node)
+        parent_node = extract_hash_value(factory_config_hash_node, :parent)
+        parent_node&.value
+      end
+
+      def extract_model_class_name(factory_config_hash_node)
+        model_class_name_node = extract_hash_value(factory_config_hash_node, :class)
+
+        case model_class_name_node&.type
+        when :const
+          model_class_name_node.source.sub(/^::/, '')
+        when :str
+          model_class_name_node.value.sub(/^::/, '')
+        end
+      end
+
+      def extract_hash_value(node, hash_key)
+        return nil if node&.type != :hash
+
+        pairs = node.children.select { |child| child.type == :pair }
+        pairs.each do |pair|
+          key, value = pair.children
+          return value if key.value == hash_key
+        end
+
+        nil
+      end
+
+      def determine_parent(factory, parent_from_surrounding_block)
+        # If the factory specifies an explicit model class name, we don't need
+        # to resolve the parent to determine the model class name.
+        return nil if factory.model_class_name
+
+        factory.parent || parent_from_surrounding_block
+      end
+
+      def determine_model_class_name(factory, model_class_name_from_surrounding_block)
+        factory.model_class_name ||
+          model_class_name_from_surrounding_block ||
+          ActiveSupport::Inflector.camelize(factory.name)
+      end
+    end
+    # rubocop:enable Metrics/ModuleLength
+  end
+end

data/lib/rubocop/flexport/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Flexport
-    VERSION = '0.7.0'
+    VERSION = '0.10.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-flexport
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.10.2
 platform: ruby
 authors:
 - Flexport Engineering
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -57,6 +57,7 @@ files:
 - lib/rubocop/cop/flexport_cops.rb
 - lib/rubocop/cop/mixin/engine_api.rb
 - lib/rubocop/cop/mixin/engine_node_context.rb
+- lib/rubocop/cop/mixin/factory_bot_usage.rb
 - lib/rubocop/flexport.rb
 - lib/rubocop/flexport/inject.rb
 - lib/rubocop/flexport/version.rb
@@ -64,7 +65,7 @@ homepage: https://github.com/flexport/rubocop-flexport
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,16 +73,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: RuboCop cops used at Flexport.
 test_files: []