packwerk 1.1.2 → 1.3.1

data/lib/packwerk/cache_deprecated_references.rb

@@ -1,55 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "sorbet-runtime"
-
-require "packwerk/deprecated_references"
-require "packwerk/reference"
-require "packwerk/reference_lister"
-require "packwerk/violation_type"
-
-module Packwerk
-  class CacheDeprecatedReferences
-    extend T::Sig
-    extend T::Helpers
-    include ReferenceLister
-    abstract!
-
-    sig do
-      params(
-        root_path: String,
-        deprecated_references: T::Hash[Packwerk::Package, Packwerk::DeprecatedReferences]
-      ).void
-    end
-    def initialize(root_path, deprecated_references = {})
-      @root_path = root_path
-      @deprecated_references = T.let(deprecated_references, T::Hash[Packwerk::Package, Packwerk::DeprecatedReferences])
-    end
-
-    sig do
-      params(reference: Packwerk::Reference, violation_type: ViolationType)
-        .returns(T::Boolean)
-        .override
-    end
-    def listed?(reference, violation_type:)
-      deprecated_references = deprecated_references_for(reference.source_package)
-      deprecated_references.add_entries(reference, violation_type.serialize)
-      true
-    end
-
-    private
-
-    sig { params(package: Packwerk::Package).returns(Packwerk::DeprecatedReferences) }
-    def deprecated_references_for(package)
-      @deprecated_references[package] ||= Packwerk::DeprecatedReferences.new(
-        package,
-        deprecated_references_file_for(package),
-      )
-    end
-
-    sig { params(package: Packwerk::Package).returns(String) }
-    def deprecated_references_file_for(package)
-      File.join(@root_path, package.name, "deprecated_references.yml")
-    end
-  end
-end

data/lib/packwerk/checking_deprecated_references.rb

@@ -1,43 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "sorbet-runtime"
-
-require "packwerk/reference_lister"
-
-module Packwerk
-  class CheckingDeprecatedReferences
-    extend T::Sig
-    include ReferenceLister
-
-    sig { params(root_path: String).void }
-    def initialize(root_path)
-      @root_path = root_path
-      @deprecated_references = T.let({}, T::Hash[Packwerk::Package, Packwerk::DeprecatedReferences])
-    end
-
-    sig do
-      params(reference: Packwerk::Reference, violation_type: ViolationType)
-        .returns(T::Boolean)
-        .override
-    end
-    def listed?(reference, violation_type:)
-      deprecated_references_for(reference.source_package).listed?(reference, violation_type: violation_type)
-    end
-
-    private
-
-    sig { params(source_package: Packwerk::Package).returns(Packwerk::DeprecatedReferences) }
-    def deprecated_references_for(source_package)
-      @deprecated_references[source_package] ||= Packwerk::DeprecatedReferences.new(
-        source_package,
-        deprecated_references_file_for(source_package),
-      )
-    end
-
-    sig { params(package: Packwerk::Package).returns(String) }
-    def deprecated_references_file_for(package)
-      File.join(@root_path, package.name, "deprecated_references.yml")
-    end
-  end
-end

data/lib/packwerk/commands/detect_stale_violations_command.rb

@@ -1,60 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-require "sorbet-runtime"
-require "benchmark"
-require "packwerk/run_context"
-require "packwerk/detect_stale_deprecated_references"
-require "packwerk/commands/offense_progress_marker"
-require "packwerk/commands/result"
-
-module Packwerk
-  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)
-
-        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
-
-        @progress_formatter.finished(execution_time)
-        calculate_result
-      end
-
-      private
-
-      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
-
-      sig { returns(Result) }
-      def calculate_result
-        result_status = !reference_lister.stale_violations?
-        message = "There were stale violations found, please run `packwerk update-deprecations`"
-        if result_status
-          message = "No stale violations detected"
-        end
-        Result.new(message: message, status: result_status)
-      end
-    end
-  end
-end

data/lib/packwerk/commands/offense_progress_marker.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-# typed: strict
-require "sorbet-runtime"
-require "packwerk/formatters/progress_formatter"
-
-module Packwerk
-  module OffenseProgressMarker
-    extend T::Sig
-
-    sig do
-      params(
-        offenses: T::Array[T.nilable(::Packwerk::Offense)],
-        progress_formatter: ::Packwerk::Formatters::ProgressFormatter
-      ).void
-    end
-    def mark_progress(offenses:, progress_formatter:)
-      if offenses.empty?
-        progress_formatter.mark_as_inspected
-      else
-        progress_formatter.mark_as_failed
-      end
-    end
-  end
-end

data/lib/packwerk/commands/result.rb

@@ -1,13 +0,0 @@
-# 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

@@ -1,81 +0,0 @@
-# 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/detect_stale_deprecated_references.rb

@@ -1,14 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "packwerk/cache_deprecated_references"
-
-module Packwerk
-  class DetectStaleDeprecatedReferences < CacheDeprecatedReferences
-    extend T::Sig
-    sig { returns(T::Boolean) }
-    def stale_violations?
-      @deprecated_references.values.any?(&:stale_violations?)
-    end
-  end
-end

data/lib/packwerk/generators/application_validation.rb

@@ -1,62 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Packwerk
-  module Generators
-    class ApplicationValidation
-      class << self
-        def generate(for_rails_app: false, root: ".", out: $stdout)
-          new(root, out: out).generate(for_rails_app: for_rails_app)
-        end
-      end
-
-      def initialize(root, out: $stdout)
-        @root = root
-        @out = out
-      end
-
-      def generate(for_rails_app:)
-        @out.puts("📦 Generating application validator...")
-        if for_rails_app
-          generate_packwerk_validate_script
-        else
-          generate_validation_test
-        end
-      end
-
-      private
-
-      def generate_packwerk_validate_script
-        destination_file_path = File.join(@root, "bin")
-        FileUtils.mkdir_p(destination_file_path)
-
-        if File.exist?(File.join(destination_file_path, "packwerk"))
-          @out.puts("⚠️  Packwerk application validation bin script already exists.")
-          return true
-        end
-
-        source_file_path = File.expand_path("templates/packwerk", __dir__)
-        FileUtils.cp(source_file_path, destination_file_path)
-
-        @out.puts("✅ Packwerk application validation bin script generated in #{destination_file_path}")
-        true
-      end
-
-      def generate_validation_test
-        destination_file_path = File.join(@root, "test")
-        FileUtils.mkdir_p(destination_file_path)
-
-        if File.exist?(File.join(destination_file_path, "packwerk_validator_test.rb"))
-          @out.puts("⚠️  Packwerk application validation test already exists.")
-          return true
-        end
-
-        source_file_path = File.expand_path("templates/packwerk_validator_test.rb", __dir__)
-        FileUtils.cp(source_file_path, destination_file_path)
-
-        @out.puts("✅ Packwerk application validation test generated in #{destination_file_path}")
-        true
-      end
-    end
-  end
-end

data/lib/packwerk/generators/templates/packwerk

@@ -1,23 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# This file was auto-generated by Packwerk through `packwerk init`
-
-# Needs to be run in test environment in order to have test helper paths available in the autoload paths
-ENV["RAILS_ENV"] = "test"
-
-# Command line arguments needs to be duplicated because spring modifies it
-packwerk_argv = ARGV.dup
-
-begin
-  load(File.expand_path("spring", __dir__))
-rescue LoadError => e
-  raise unless e.message.include?("spring")
-end
-
-require File.expand_path("../config/environment", __dir__)
-
-require "packwerk"
-
-cli = Packwerk::Cli.new
-cli.run(packwerk_argv)

data/lib/packwerk/generators/templates/packwerk_validator_test.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-require "packwerk"
-
-# This test is necessary to make sure that the package system is working correctly
-class PackwerkValidatorTest < Minitest::Test
-  def test_the_application_is_correctly_set_up_for_the_package_system
-    assert(Packwerk::Cli.new.execute_command(["validate"]))
-  end
-end

data/lib/packwerk/reference_lister.rb

@@ -1,23 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "sorbet-runtime"
-
-require "packwerk/reference"
-require "packwerk/violation_type"
-
-module Packwerk
-  module ReferenceLister
-    extend T::Sig
-    extend T::Helpers
-
-    interface!
-
-    sig do
-      params(reference: Packwerk::Reference, violation_type: ViolationType)
-        .returns(T::Boolean)
-        .abstract
-    end
-    def listed?(reference, violation_type:); end
-  end
-end

data/lib/packwerk/spring_command.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-# typed: false
-
-require "spring/commands"
-
-module Packwerk
-  class SpringCommand
-    def env(*)
-      # Packwerk needs to run in a test environment, which has a set of autoload paths that are
-      # often a superset of the dev/prod paths (for example, test/support/helpers)
-      "test"
-    end
-
-    def exec_name
-      "packwerk"
-    end
-
-    def gem_name
-      "packwerk"
-    end
-
-    def call
-      load(Gem.bin_path(gem_name, exec_name))
-    end
-  end
-
-  Spring.register_command("packwerk", SpringCommand.new)
-end