Move API to Packs::Specification for more clarity on where the methods are defined (#19)

* move private

* Move API under Specification submodule

Author: Alex Evanczuk

.rubocop.yml

@@ -116,3 +116,7 @@ Style/NumericPredicate:
 
 Layout/BlockEndNewline:
   Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/packs-specification.rb

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    packs-specification (0.0.8)
+    packs-specification (0.0.9)
       sorbet-runtime
 
 GEM

lib/packs-specification.rb

@@ -4,8 +4,11 @@
 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 @@ class << self
 
     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

lib/packs/pack.rb

@@ -13,7 +13,7 @@ class Pack < T::Struct
     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 @@ def last_name
     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
 

lib/packs/private.rb

@@ -5,7 +5,7 @@
 
   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.

lib/packs/rspec/support.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

lib/packs/specification.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)

lib/packs/private/configuration.rb lib/packs/specification/configuration.rblib/packs/private/configuration.rb renamed to lib/packs/specification/configuration.rb

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'packs-specification'
-  spec.version       = '0.0.8'
+  spec.version       = '0.0.9'
   spec.authors       = ['Gusto Engineers']
   spec.email         = ['dev@gusto.com']
   spec.summary       = 'The specification for packs in the `rubyatscale` ecosystem.'

packs-specification.gemspec

@@ -32,38 +32,6 @@
 
       it { expect(Packs.all.count).to eq 2 }
     end
-
-    context 'in an app with a differently configured root configured via ruby' do
-      before do
-        write_pack('packs/my_pack')
-        write_pack('components/my_pack')
-        Packs.configure do |config|
-          config.pack_paths = ['packs/*', 'components/*']
-        end
-      end
-
-      it { expect(Packs.all.count).to eq 2 }
-    end
-
-    context 'in an app with a differently configured root configured via ruby and YML' do
-      before do
-        write_pack('packs/my_pack')
-        write_pack('components/my_pack')
-        write_pack('packages/my_pack')
-        write_file('packs.yml', <<~YML)
-          pack_paths:
-            - packs/*
-            - components/*
-        YML
-        Packs.configure do |config|
-          config.pack_paths = ['packs/*']
-        end
-      end
-
-      it 'prioritizes the YML configuration' do
-        expect(Packs.all.count).to eq 2
-      end
-    end
   end
 
   describe '.find' do