packs-specification 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fc4e79e4786eb16e964a3431d06fa071f48c7f4ae361c7d9747a50bd1634e76
-  data.tar.gz: 772de64f7ea2558241e0a3c234e3ce7660750fe37c49d09935c11260734bf282
+  metadata.gz: 1c88728f832e53f87f6c8ff27cfec4418ed91f7887a0c79ff48ff99621b1e9a3
+  data.tar.gz: c765f94b52e2a7d96ab74a12791d6aa9bb95122fb902ec6bd96fc6c083e9c5fb
 SHA512:
-  metadata.gz: 29bf27fd2b72214370cb3513944f8b383bcc06aed7ff82fe92a1954aba1fd22111e6566d3c7158e43b8ca022723214e2e9176af3c7de72200b7cf8835e56c8fe
-  data.tar.gz: 48a3d36d1d9a587ca9c0ccf3fe984c5baf24cc3cc704e4f544deddc19a00661e6545d8361148aeaf3c1a68fe05f7fa3af4b3a75c3be3f4f815c90c0fb88f4dba
+  metadata.gz: 1dcae4f9561fb74c5e272beaa7030766d52398e3b709cb890858245990ded777b56e7c6dfc028706c3796aeb88c7f2d39e4b622fd2e9f2e6894fa7454296242a
+  data.tar.gz: b1a6ad713dd92015b1c6f32d0f8a9cd5e89d1a707817a8f739a8aba0f0ec7bffd28bbd9d01c9c168c6e93a59c05455f724362b1b3ae3e9be179d2dcac123cba6

data/lib/packs/pack.rb

@@ -13,7 +13,7 @@ module Packs
     def self.from(package_yml_absolute_path)
       package_loaded_yml = YAML.load_file(package_yml_absolute_path)
       path = package_yml_absolute_path.dirname
-      relative_path = path.relative_path_from(Private.root)
+      relative_path = path.relative_path_from(Specification.root)
       package_name = relative_path.cleanpath.to_s
 
       Pack.new(
@@ -36,7 +36,7 @@ module Packs
     end
 
     sig { returns(T::Boolean) }
-    def is_gem?
+    def is_gem? # rubocop:disable Naming/PredicateName
       @is_gem ||= T.let(relative_path.glob('*.gemspec').any?, T.nilable(T::Boolean))
     end
 

data/lib/packs/rspec/support.rb

@@ -5,7 +5,7 @@ RSpec.configure do |config|
 
   config.before do
     # We bust_cache always because each test may write its own packs
-    Packs.bust_cache!
+    Packs::Specification.bust_cache!
   end
 
   # Eventually, we could make this opt-in via metadata so someone can use this support without affecting all their tests.

data/lib/packs/{private → specification}/configuration.rb

@@ -1,7 +1,7 @@
 # typed: strict
 
 module Packs
-  module Private
+  module Specification
     class Configuration < T::Struct
       extend T::Sig
       CONFIGURATION_PATHNAME = T.let(Pathname.new('packs.yml'), Pathname)

data/lib/packs/specification.rb

@@ -0,0 +1,73 @@
+# typed: strict
+
+require 'packs/specification/configuration'
+
+module Packs
+  module Specification
+    extend T::Sig
+
+    class << self
+      extend T::Sig
+
+      sig { returns(Pathname) }
+      def root
+        Pathname.pwd
+      end
+
+      sig { returns(Configuration) }
+      def config
+        @config = T.let(@config, T.nilable(Configuration))
+        @config ||= Configuration.fetch
+      end
+
+      sig { void }
+      def bust_cache!
+        @packs_by_name = nil
+        @for_file = nil
+        @config = nil
+      end
+
+      sig { returns(T::Array[Pack]) }
+      def all
+        packs_by_name.values
+      end
+
+      sig { params(name: String).returns(T.nilable(Pack)) }
+      def find(name)
+        packs_by_name[name]
+      end
+
+      sig { params(file_path: T.any(Pathname, String)).returns(T.nilable(Pack)) }
+      def for_file(file_path)
+        path_string = file_path.to_s
+        @for_file = T.let(@for_file, T.nilable(T::Hash[String, T.nilable(Pack)]))
+        @for_file ||= {}
+        @for_file[path_string] ||= all.find { |package| path_string.start_with?("#{package.name}/") || path_string == package.name }
+      end
+
+      private
+
+      sig { returns(T::Hash[String, Pack]) }
+      def packs_by_name
+        @packs_by_name = T.let(@packs_by_name, T.nilable(T::Hash[String, Pack]))
+        @packs_by_name ||= begin
+          all_packs = package_glob_patterns.map do |path|
+            Pack.from(path)
+          end
+
+          # We want to match more specific paths first so for_file works correctly.
+          sorted_packages = all_packs.sort_by { |package| -package.name.length }
+          sorted_packages.to_h { |p| [p.name, p] }
+        end
+      end
+
+      sig { returns(T::Array[Pathname]) }
+      def package_glob_patterns
+        absolute_root = Specification.root
+        Specification.config.pack_paths.flat_map do |pack_path|
+          Pathname.glob(absolute_root.join(pack_path).join(PACKAGE_FILE))
+        end
+      end
+    end
+  end
+end

data/lib/packs-specification.rb

@@ -4,8 +4,11 @@ require 'yaml'
 require 'pathname'
 require 'sorbet-runtime'
 require 'packs/pack'
-require 'packs/private'
+require 'packs/specification'
 
+# We let `packs-specification` define some API methods such as all, find, and for_file,
+# because this allows a production environment to require `packs-specification` only and get some simple functionality, without
+# needing to load all of `packs`.
 module Packs
   PACKAGE_FILE = T.let('package.yml'.freeze, String)
 
@@ -14,67 +17,17 @@ module Packs
 
     sig { returns(T::Array[Pack]) }
     def all
-      packs_by_name.values
+      Specification.all
     end
 
     sig { params(name: String).returns(T.nilable(Pack)) }
     def find(name)
-      packs_by_name[name]
+      Specification.find(name)
     end
 
     sig { params(file_path: T.any(Pathname, String)).returns(T.nilable(Pack)) }
     def for_file(file_path)
-      path_string = file_path.to_s
-      @for_file = T.let(@for_file, T.nilable(T::Hash[String, T.nilable(Pack)]))
-      @for_file ||= {}
-      @for_file[path_string] ||= all.find { |package| path_string.start_with?("#{package.name}/") || path_string == package.name }
-    end
-
-    sig { void }
-    def bust_cache!
-      @packs_by_name = nil
-      @config = nil
-      @for_file = nil
-    end
-
-    sig { returns(Private::Configuration) }
-    def config
-      @config = T.let(@config, T.nilable(Private::Configuration))
-      @config ||= Private::Configuration.fetch
-    end
-
-    sig { params(blk: T.proc.params(arg0: Private::Configuration).void).void }
-    def configure(&blk)
-      # If packs.yml is being used, then ignore direct configuration.
-      # This is only a stop-gap to permit Stimpack users to more easily migrate
-      # to packs.yml
-      return if Private::Configuration::CONFIGURATION_PATHNAME.exist?
-
-      yield(config)
-    end
-
-    private
-
-    sig { returns(T::Hash[String, Pack]) }
-    def packs_by_name
-      @packs_by_name = T.let(@packs_by_name, T.nilable(T::Hash[String, Pack]))
-      @packs_by_name ||= begin
-        all_packs = package_glob_patterns.map do |path|
-          Pack.from(path)
-        end
-
-        # We want to match more specific paths first so for_file works correctly.
-        sorted_packages = all_packs.sort_by { |package| -package.name.length }
-        sorted_packages.to_h { |p| [p.name, p] }
-      end
-    end
-
-    sig { returns(T::Array[Pathname]) }
-    def package_glob_patterns
-      absolute_root = Private.root
-      config.pack_paths.flat_map do |pack_path|
-        Pathname.glob(absolute_root.join(pack_path).join(PACKAGE_FILE))
-      end
+      Specification.for_file(file_path)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packs-specification
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-09 00:00:00.000000000 Z
+date: 2023-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -118,10 +118,10 @@ files:
 - README.md
 - lib/packs-specification.rb
 - lib/packs/pack.rb
-- lib/packs/private.rb
-- lib/packs/private/configuration.rb
 - lib/packs/rspec/fixture_helper.rb
 - lib/packs/rspec/support.rb
+- lib/packs/specification.rb
+- lib/packs/specification/configuration.rb
 homepage: https://github.com/rubyatscale/packs-specification
 licenses:
 - MIT

data/lib/packs/private.rb

@@ -1,16 +0,0 @@
-# typed: strict
-
-require 'packs/private/configuration'
-
-module Packs
-  module Private
-    extend T::Sig
-
-    sig { returns(Pathname) }
-    def self.root
-      Pathname.pwd
-    end
-  end
-
-  private_constant :Private
-end