packwerk 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91ec92f15d9d87fa8c54861afd424fe6149ef8f8e05f114b6ee04559fa6053fc
-  data.tar.gz: b83cc17ff9cd7d2d37db4456017d429b4a8f8e45766cdfa4551ace2e32c58183
+  metadata.gz: da27cf2b0d19f98831fc32b685ab58ab5a1abeacad532eff698787ef0dd8892d
+  data.tar.gz: 2b7d574417307d4b2d4aa0ae8e85665e5a701bc304307abd0302d02ebb4b6060
 SHA512:
-  metadata.gz: 596f4f1a6b026e96ab6299e9ba7ceb63b7d709bd49c0629390f50e62e751174e4a92557243bef3a8f7f36aaf416e54fbf1fdb9f368fc2e478eb033e208358dc6
-  data.tar.gz: fdca4107315ea6140d7b92e5cd7b53216a73f65fac4c1c3147c798a1d407f75d3898b31517bec6bf2452e7ca0a3d1ad87599142250cf75684ccc9a48436bcd91
+  metadata.gz: 730635a8851f68e9b43b25454f56bfe7296a42e76da335ab4b14b5fb2562a09c758107b9b25ab8d8455bd722e28079023568d84a6621d30b77b5d709c4dd5bd9
+  data.tar.gz: 97e9941ee9756c33dc952dca17ca6fe255ad8e2605584f3715616ff8e4a2a1caf380a079c0954435fff54ff83a7a92000176d9d6aa30858ef67f263958d2d105

data/Gemfile.lock

@@ -85,7 +85,7 @@ GIT
 PATH
   remote: .
   specs:
-    packwerk (1.1.0)
+    packwerk (1.1.1)
       activesupport (>= 5.2)
       ast
       better_html

data/lib/packwerk/cli.rb

@@ -3,9 +3,11 @@
 require "benchmark"
 require "sorbet-runtime"
 
+require "packwerk/application_load_paths"
 require "packwerk/application_validator"
 require "packwerk/configuration"
 require "packwerk/files_for_processing"
+require "packwerk/formatters/offenses_formatter"
 require "packwerk/formatters/progress_formatter"
 require "packwerk/inflector"
 require "packwerk/output_styles"
@@ -13,6 +15,7 @@ require "packwerk/run_context"
 require "packwerk/updating_deprecated_references"
 require "packwerk/checking_deprecated_references"
 require "packwerk/commands/detect_stale_violations_command"
+require "packwerk/commands/update_deprecations_command"
 require "packwerk/commands/offense_progress_marker"
 
 module Packwerk
@@ -101,7 +104,7 @@ module Packwerk
 
     def generate_configs
       configuration_file = Packwerk::Generators::ConfigurationFile.generate(
-        load_paths: @configuration.load_paths,
+        load_paths: Packwerk::ApplicationLoadPaths.extract_relevant_paths,
         root: @configuration.root_path,
         out: @out
       )
@@ -134,33 +137,16 @@ module Packwerk
     end
 
     def update_deprecations(paths)
-      updating_deprecated_references = ::Packwerk::UpdatingDeprecatedReferences.new(@configuration.root_path)
-      @run_context = Packwerk::RunContext.from_configuration(
-        @configuration,
-        reference_lister: updating_deprecated_references
+      update_deprecations = Commands::UpdateDeprecationsCommand.new(
+        files: fetch_files_to_process(paths),
+        configuration: @configuration,
+        offenses_formatter: offenses_formatter,
+        progress_formatter: @progress_formatter
       )
-
-      files = fetch_files_to_process(paths)
-
-      @progress_formatter.started(files)
-
-      all_offenses = T.let([], T.untyped)
-      execution_time = Benchmark.realtime do
-        all_offenses = files.flat_map do |path|
-          @run_context.process_file(file: path).tap do |offenses|
-            mark_progress(offenses: offenses, progress_formatter: @progress_formatter)
-          end
-        end
-
-        updating_deprecated_references.dump_deprecated_references_files
-      end
-
-      @out.puts # put a new line after the progress dots
-      show_offenses(all_offenses)
-      @progress_formatter.finished(execution_time)
-      @out.puts("✅ `deprecated_references.yml` has been updated.")
-
-      all_offenses.empty?
+      result = update_deprecations.run
+      @out.puts
+      @out.puts(result.message)
+      result.status
     end
 
     def check(paths)
@@ -181,15 +167,15 @@ module Packwerk
         @out.puts("Manually interrupted. Violations caught so far are listed below:")
       end
 
-      @out.puts # put a new line after the progress dots
-      show_offenses(all_offenses)
       @progress_formatter.finished(execution_time)
+      @out.puts
+      @out.puts(offenses_formatter.show_offenses(all_offenses))
 
       all_offenses.empty?
     end
 
     def detect_stale_violations(paths)
-      detect_stale_violations = DetectStaleViolationsCommand.new(
+      detect_stale_violations = Commands::DetectStaleViolationsCommand.new(
         files: fetch_files_to_process(paths),
         configuration: @configuration,
         progress_formatter: @progress_formatter
@@ -225,19 +211,6 @@ module Packwerk
       end
     end
 
-    def show_offenses(offenses)
-      if offenses.empty?
-        @out.puts("No offenses detected 🎉")
-      else
-        offenses.each do |offense|
-          @out.puts(offense.to_s(@style))
-        end
-
-        offenses_string = Inflector.default.pluralize("offense", offenses.length)
-        @out.puts("#{offenses.length} #{offenses_string} detected")
-      end
-    end
-
     def list_validation_errors(result)
       @out.puts
       if result.ok?
@@ -256,5 +229,9 @@ module Packwerk
         false
       end
     end
+
+    def offenses_formatter
+      @offenses_formatter ||= Formatters::OffensesFormatter.new(style: @style)
+    end
   end
 end

data/lib/packwerk/commands/detect_stale_violations_command.rb

@@ -1,63 +1,60 @@
 # typed: true
 # frozen_string_literal: true
-require "packwerk/cli"
 require "sorbet-runtime"
 require "benchmark"
-require "packwerk/configuration"
-require "packwerk/formatters/progress_formatter"
 require "packwerk/run_context"
 require "packwerk/detect_stale_deprecated_references"
 require "packwerk/commands/offense_progress_marker"
+require "packwerk/commands/result"
 
 module Packwerk
-  class DetectStaleViolationsCommand
-    extend T::Sig
-    include OffenseProgressMarker
-    Result = Struct.new(:message, :status)
-
-    def initialize(files:, configuration:, run_context: nil, progress_formatter: nil, reference_lister: nil)
-      @configuration = configuration
-      @run_context = run_context
-      @reference_lister = reference_lister
-      @progress_formatter = progress_formatter
-      @files = files
-    end
+  module Commands
+    class DetectStaleViolationsCommand
+      extend T::Sig
+      include OffenseProgressMarker
+      def initialize(files:, configuration:, run_context: nil, progress_formatter: nil, reference_lister: nil)
+        @configuration = configuration
+        @run_context = run_context
+        @reference_lister = reference_lister
+        @progress_formatter = progress_formatter
+        @files = files
+      end
 
-    sig { returns(Result) }
-    def run
-      @progress_formatter.started(@files)
+      sig { returns(Result) }
+      def run
+        @progress_formatter.started(@files)
 
-      all_offenses = T.let([], T.untyped)
-      execution_time = Benchmark.realtime do
-        all_offenses = @files.flat_map do |path|
-          run_context.process_file(file: path).tap do |offenses|
-            mark_progress(offenses: offenses, progress_formatter: @progress_formatter)
+        execution_time = Benchmark.realtime do
+          @files.flat_map do |path|
+            run_context.process_file(file: path).tap do |offenses|
+              mark_progress(offenses: offenses, progress_formatter: @progress_formatter)
+            end
           end
         end
-      end
 
-      @progress_formatter.finished(execution_time)
-      calculate_result
-    end
+        @progress_formatter.finished(execution_time)
+        calculate_result
+      end
 
-    private
+      private
 
-    def run_context
-      @run_context ||= Packwerk::RunContext.from_configuration(@configuration, reference_lister: reference_lister)
-    end
+      def run_context
+        @run_context ||= Packwerk::RunContext.from_configuration(@configuration, reference_lister: reference_lister)
+      end
 
-    def reference_lister
-      @reference_lister ||= ::Packwerk::DetectStaleDeprecatedReferences.new(@configuration.root_path)
-    end
+      def reference_lister
+        @reference_lister ||= ::Packwerk::DetectStaleDeprecatedReferences.new(@configuration.root_path)
+      end
 
-    sig { returns Result }
-    def calculate_result
-      result_status = !reference_lister.stale_violations?
-      message = "There were stale violations found, please run `packwerk update`"
-      if result_status
-        message = "No stale violations detected"
+      sig { returns(Result) }
+      def calculate_result
+        result_status = !reference_lister.stale_violations?
+        message = "There were stale violations found, please run `packwerk update`"
+        if result_status
+          message = "No stale violations detected"
+        end
+        Result.new(message: message, status: result_status)
       end
-      Result.new(message, result_status)
     end
   end
 end

data/lib/packwerk/commands/result.rb

@@ -0,0 +1,13 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+module Packwerk
+  module Commands
+    class Result < T::Struct
+      prop :message, String
+      prop :status, T::Boolean
+    end
+  end
+end

data/lib/packwerk/commands/update_deprecations_command.rb

@@ -0,0 +1,81 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require "benchmark"
+
+require "packwerk/commands/offense_progress_marker"
+require "packwerk/commands/result"
+require "packwerk/run_context"
+require "packwerk/updating_deprecated_references"
+
+module Packwerk
+  module Commands
+    class UpdateDeprecationsCommand
+      extend T::Sig
+      include OffenseProgressMarker
+
+      sig do
+        params(
+          files: T::Enumerable[String],
+          configuration: Configuration,
+          offenses_formatter: Formatters::OffensesFormatter,
+          progress_formatter: Formatters::ProgressFormatter
+        ).void
+      end
+      def initialize(files:, configuration:, offenses_formatter:, progress_formatter:)
+        @files = files
+        @configuration = configuration
+        @progress_formatter = progress_formatter
+        @offenses_formatter = offenses_formatter
+        @updating_deprecated_references = T.let(nil, T.nilable(UpdatingDeprecatedReferences))
+        @run_context = T.let(nil, T.nilable(RunContext))
+      end
+
+      sig { returns(Result) }
+      def run
+        @progress_formatter.started(@files)
+
+        all_offenses = T.let([], T.untyped)
+        execution_time = Benchmark.realtime do
+          all_offenses = @files.flat_map do |path|
+            run_context.process_file(file: path).tap do |offenses|
+              mark_progress(offenses: offenses, progress_formatter: @progress_formatter)
+            end
+          end
+
+          updating_deprecated_references.dump_deprecated_references_files
+        end
+
+        @progress_formatter.finished(execution_time)
+        calculate_result(all_offenses)
+      end
+
+      private
+
+      sig { returns(RunContext) }
+      def run_context
+        @run_context ||= RunContext.from_configuration(
+          @configuration,
+          reference_lister: updating_deprecated_references
+        )
+      end
+
+      sig { returns(UpdatingDeprecatedReferences) }
+      def updating_deprecated_references
+        @updating_deprecated_references ||= UpdatingDeprecatedReferences.new(@configuration.root_path)
+      end
+
+      sig { params(all_offenses: T::Array[T.nilable(::Packwerk::Offense)]).returns(Result) }
+      def calculate_result(all_offenses)
+        result_status = all_offenses.empty?
+        message = <<~EOS
+          #{@offenses_formatter.show_offenses(all_offenses)}
+          ✅ `deprecated_references.yml` has been updated.
+        EOS
+
+        Result.new(message: message, status: result_status)
+      end
+    end
+  end
+end

data/lib/packwerk/configuration.rb

@@ -22,7 +22,10 @@ module Packwerk
       private
 
       def from_packwerk_config(path)
-        new(YAML.load_file(path), config_path: path)
+        new(
+          YAML.load_file(path) || {},
+          config_path: path
+        )
       end
     end
 
@@ -42,7 +45,7 @@ module Packwerk
       @root_path = File.expand_path(root)
       @package_paths = configs["package_paths"] || "**/"
       @custom_associations = configs["custom_associations"] || []
-      @load_paths = configs["load_paths"]
+      @load_paths = configs["load_paths"] || []
       @inflections_file = File.expand_path(configs["inflections_file"] || "config/inflections.yml", @root_path)
 
       @config_path = config_path

data/lib/packwerk/formatters/offenses_formatter.rb

@@ -0,0 +1,49 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "benchmark"
+require "sorbet-runtime"
+
+require "packwerk/inflector"
+require "packwerk/output_styles"
+
+module Packwerk
+  module Formatters
+    class OffensesFormatter
+      extend T::Sig
+
+      sig do
+        params(style: T.any(T.class_of(OutputStyles::Plain), T.class_of(OutputStyles::Coloured))).void
+      end
+      def initialize(style: OutputStyles::Plain)
+        @style = style
+      end
+
+      sig { params(offenses: T::Array[T.nilable(Offense)]).returns(String) }
+      def show_offenses(offenses)
+        return "No offenses detected 🎉" if offenses.empty?
+
+        <<~EOS
+          #{offenses_list(offenses)}
+          #{offenses_summary(offenses)}
+        EOS
+      end
+
+      private
+
+      sig { params(offenses: T::Array[T.nilable(Offense)]).returns(String) }
+      def offenses_list(offenses)
+        offenses
+          .compact
+          .map { |offense| offense.to_s(@style) }
+          .join("\n")
+      end
+
+      sig { params(offenses: T::Array[T.nilable(Offense)]).returns(String) }
+      def offenses_summary(offenses)
+        offenses_string = Inflector.default.pluralize("offense", offenses.length)
+        "#{offenses.length} #{offenses_string} detected"
+      end
+    end
+  end
+end

data/lib/packwerk/node.rb

@@ -27,7 +27,7 @@ module Packwerk
         case type_of(constant_node)
         when CONSTANT_ROOT_NAMESPACE
           ""
-        when CONSTANT, CONSTANT_ASSIGNMENT
+        when CONSTANT, CONSTANT_ASSIGNMENT, SELF
           # (const nil :Foo)
           #   "Foo"
           # (const (cbase) :Foo)
@@ -40,6 +40,8 @@ module Packwerk
           #   "::Foo = 1"
           # (casgn (lvar :a) :Foo (int 1))
           #   "a::Foo = 1"
+          # (casgn (self) :Foo (int 1))
+          #   "self::Foo = 1"
           namespace, name = constant_node.children
           if namespace
             [constant_name(namespace), name].join("::")
@@ -204,12 +206,13 @@ module Packwerk
       HASH_PAIR = :pair
       METHOD_CALL = :send
       MODULE = :module
+      SELF = :self
       STRING = :str
       SYMBOL = :sym
 
       private_constant(
         :BLOCK, :CLASS, :CONSTANT, :CONSTANT_ASSIGNMENT, :CONSTANT_ROOT_NAMESPACE, :HASH, :HASH_PAIR, :METHOD_CALL,
-        :MODULE, :STRING, :SYMBOL,
+        :MODULE, :SELF, :STRING, :SYMBOL,
       )
 
       def type_of(node)

data/lib/packwerk/parsed_constant_definitions.rb

@@ -28,8 +28,8 @@ module Packwerk
 
       fully_qualified_constant_name = "::#{constant_name}"
 
-      possible_namespaces = namespace_path.reduce([""]) do |acc, current|
-        acc << acc.last + "::" + current
+      possible_namespaces = namespace_path.each_with_object([""]) do |current, acc|
+        acc << "#{acc.last}::#{current}" if acc.last && current
       end
 
       possible_namespaces.map { |namespace| namespace + fully_qualified_constant_name }

data/lib/packwerk/parsers/factory.rb

@@ -31,7 +31,7 @@ module Packwerk
       end
 
       def erb_parser_class
-        @erb_parser_class || Erb
+        @erb_parser_class ||= Erb
       end
 
       def erb_parser_class=(klass)

data/lib/packwerk/sanity_checker.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# typed: false
 # frozen_string_literal: true
 
 require "packwerk/application_validator"

data/lib/packwerk/spring_command.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# typed: ignore
+# typed: false
 
 require "spring/commands"
 

data/lib/packwerk/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Packwerk
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Shopify Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -192,6 +192,8 @@ files:
 - lib/packwerk/cli.rb
 - lib/packwerk/commands/detect_stale_violations_command.rb
 - lib/packwerk/commands/offense_progress_marker.rb
+- lib/packwerk/commands/result.rb
+- lib/packwerk/commands/update_deprecations_command.rb
 - lib/packwerk/configuration.rb
 - lib/packwerk/const_node_inspector.rb
 - lib/packwerk/constant_discovery.rb
@@ -201,6 +203,7 @@ files:
 - lib/packwerk/detect_stale_deprecated_references.rb
 - lib/packwerk/file_processor.rb
 - lib/packwerk/files_for_processing.rb
+- lib/packwerk/formatters/offenses_formatter.rb
 - lib/packwerk/formatters/progress_formatter.rb
 - lib/packwerk/generators/application_validation.rb
 - lib/packwerk/generators/configuration_file.rb