packs-specification 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c88728f832e53f87f6c8ff27cfec4418ed91f7887a0c79ff48ff99621b1e9a3
-  data.tar.gz: c765f94b52e2a7d96ab74a12791d6aa9bb95122fb902ec6bd96fc6c083e9c5fb
+  metadata.gz: 122afd26ffb01ea123411f9efecf42dfd3773ceb65f77bd961788284ad3b16db
+  data.tar.gz: d48b1a2e41405ca2c8d5d0abd99e2f75e171ea4e27cbf498a40a8b297c45d2d8
 SHA512:
-  metadata.gz: 1dcae4f9561fb74c5e272beaa7030766d52398e3b709cb890858245990ded777b56e7c6dfc028706c3796aeb88c7f2d39e4b622fd2e9f2e6894fa7454296242a
-  data.tar.gz: b1a6ad713dd92015b1c6f32d0f8a9cd5e89d1a707817a8f739a8aba0f0ec7bffd28bbd9d01c9c168c6e93a59c05455f724362b1b3ae3e9be179d2dcac123cba6
+  metadata.gz: 54dd61ad4422dd16b24143d3c82e4f18e4062e61eb0d95311aad3fb14cb34125a978dad366907cc937c612bbd3aa98ee3ab4d4bd2d57805c83995b416b107ada
+  data.tar.gz: edd3354022070ee6bf9a8c54050a2e1cd76ded04f434fc34bb9bb6af176dd90ca07eb47a988db9e714732777156fdfdef658b0c6e1e6531366ec003644983f9e

data/README.md

@@ -1,25 +1,26 @@
 # packs-specification
+This is a low-dependency gem that allows your production environment to query simple information about [`packs`](https://github.com/rubyatscale/packs).
 
-Welcome to `packs-specification`! `packs` are a simple ruby specification for an extensible packaging system to help modularize Ruby applications.
 
-A `pack` (short for `package`) is a folder of Ruby code with a `package.yml` at the root that is intended to represent a well-modularized domain, and the rest of the [rubyatscale](https://github.com/rubyatscale) ecosystem is intended to help make the boundaries between a pack and any other more clear.
+## Usage
+```ruby
 
-# Configuration
-By default, this library will look for `packs` in the folder `packs/*/package.yml` (as well as nested packs at `packs/*/*/package.yml`). To change where `packs` are located, create a `packs.yml` file:
-```
-pack_paths:
-  - "{packs,utilities,deprecated}/*" # packs with multiple roots!
-  - "{packs,utilities,deprecated}/*/*" # nested packs!
-  - gems/* # gems can be packs too!
-```
+require 'packs-specification'
 
-Here are some example integrations with `packs`:
-- [`packs-rails`](https://github.com/rubyatscale/packs-rails) can be used to integrate `packs` into your `rails` application
-- [`rubocop-packs`](https://github.com/rubyatscale/rubocop-packs) contains cops to improve boundaries around `packs` 
-- [`packwerk`](https://github.com/Shopify/packwerk) and [`packwerk-extensions`](https://github.com/rubyatscale/packwerk-extensions) help you describe and constrain your package graph in terms of dependencies between packs and pack public API
-- [`code_ownership`](https://github.com/rubyatscale/code_ownership) gives your application the capability to determine the owner of a pack
-- [`use_packs`](https://github.com/rubyatscale/use_packs) gives a CLI, `bin/packs`, that makes it easy to create new packs, move files between packs, and more.
-- [`pack_stats`](https://github.com/rubyatscale/pack_stats) makes it easy to send metrics about pack adoption and modularization to your favorite metrics provider, such as DataDog (which has built-in support).
+# Getting all packs
+# Example use: adding pack paths to a list of fixture paths
+# Returns a T::Array[Packs::Pack]
+Packs.all
 
-# How is a pack different from a gem?
-A ruby [`gem`](https://guides.rubygems.org/what-is-a-gem/) is the Ruby community solution for packaging and distributing Ruby code. A gem is a great place to start new projects, and a great end state for code that's been extracted from an existing codebase. `packs` are intended to help gradually modularize an application that has some conceptual boundaries, but is not yet ready to be factored into gems.
+# Getting the pack for a specific file
+# Example use: Associating a file with an owner via a pack owner
+# Returns a T.nilable(Packs::Pack)
+Packs.for_file('/path/to/file.rb')
+Packs.for_file(Pathname.new('/path/to/file.rb')) # also works
+
+# Getting a pack with a specific name
+# Example use: Special casing certain behavior for a specific pack
+# Example use: Development tools that operate on user inputted pack names
+# Returns a T.nilable(Packs::Pack)
+Packs.find('packs/my_pack')
+```

data/lib/packs/pack.rb

@@ -1,17 +1,29 @@
 # typed: strict
 
 module Packs
-  class Pack < T::Struct
+  class Pack
     extend T::Sig
 
-    const :name, String
-    const :path, Pathname
-    const :relative_path, Pathname
-    const :raw_hash, T::Hash[T.untyped, T.untyped]
+    sig { returns(String) }
+    attr_reader :name
+
+    sig { returns(Pathname) }
+    attr_reader :path
+
+    sig { returns(Pathname) }
+    attr_reader :relative_path
+
+    sig { params(name: String, path: Pathname, relative_path: Pathname).void }
+    def initialize(name:, path:, relative_path:)
+      @name = name
+      @path = path
+      @relative_path = relative_path
+      @raw_hash = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @is_gem = T.let(nil, T.nilable(T::Boolean))
+    end
 
     sig { params(package_yml_absolute_path: Pathname).returns(Pack) }
     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(Specification.root)
       package_name = relative_path.cleanpath.to_s
@@ -19,11 +31,15 @@ module Packs
       Pack.new(
         name: package_name,
         path: path,
-        relative_path: relative_path,
-        raw_hash: package_loaded_yml || {}
+        relative_path: relative_path
       )
     end
 
+    sig { returns(T::Hash[T.untyped, T.untyped]) }
+    def raw_hash
+      @raw_hash ||= YAML.load_file(yml(relative: false)) || {}
+    end
+
     sig { params(relative: T::Boolean).returns(Pathname) }
     def yml(relative: true)
       path_to_use = relative ? relative_path : path
@@ -37,12 +53,25 @@ module Packs
 
     sig { returns(T::Boolean) }
     def is_gem? # rubocop:disable Naming/PredicateName
-      @is_gem ||= T.let(relative_path.glob('*.gemspec').any?, T.nilable(T::Boolean))
+      @is_gem ||= relative_path.glob('*.gemspec').any?
     end
 
     sig { returns(T::Hash[T.untyped, T.untyped]) }
     def metadata
       raw_hash['metadata'] || {}
     end
+
+    sig { returns(T::Array[Symbol]) }
+    private def instance_variables_to_inspect = [:@name]
+
+    if RUBY_VERSION < '4'
+      sig { returns(String) }
+      def inspect
+        ivars = instance_variables_to_inspect.map do |ivar|
+          "#{ivar}=#{instance_variable_get(ivar).inspect}"
+        end.join(', ')
+        "#<#{self.class.name}:0x#{object_id.to_s(16)} #{ivars}>"
+      end
+    end
   end
 end

data/lib/packs/rspec/support.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+require 'tmpdir'
 require_relative 'fixture_helper'
 
 RSpec.configure do |config|
@@ -10,12 +12,18 @@ RSpec.configure do |config|
 
   # Eventually, we could make this opt-in via metadata so someone can use this support without affecting all their tests.
   config.around do |example|
-    prefix = [File.basename($0), Process.pid].join('-') # rubocop:disable Style/SpecialGlobalVars
-    tmpdir = Dir.mktmpdir(prefix)
-    Dir.chdir(tmpdir) do
+    if example.metadata[:skip_chdir_to_tmpdir]
       example.run
+    else
+      begin
+        prefix = [File.basename($0), Process.pid].join('-') # rubocop:disable Style/SpecialGlobalVars
+        tmpdir = Dir.mktmpdir(prefix)
+        Dir.chdir(tmpdir) do
+          example.run
+        end
+      ensure
+        FileUtils.rm_rf(tmpdir)
+      end
     end
-  ensure
-    FileUtils.rm_rf(tmpdir)
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: packs-specification
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - Gusto Engineers
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -28,16 +27,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.16
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.16
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +69,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +143,6 @@ metadata:
   source_code_uri: https://github.com/rubyatscale/packs-specification
   changelog_uri: https://github.com/rubyatscale/packs-specification/releases
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -138,15 +150,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: The specification for packs in the `rubyatscale` ecosystem.
 test_files: []