packs 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 156ed7ab94d5a72f12a96cb0437a3c7ec4dfb3299a56c2bdc3414f588f0497ac
-  data.tar.gz: 6df13268bafbb79c6b03477ff9981a40a83a18a424e44d51ecf0f42d8689e54b
+  metadata.gz: 29e18f23de09397b4441c88789b231d1226bd68bea5d0fce16655d0367f93b9b
+  data.tar.gz: bfd5b5aefd4de2aa8b126accd52c44a980ca1302a57c49d6faf37a969ca2d1f5
 SHA512:
-  metadata.gz: 0a14fd70f566933916a9047daf9b7201679ace0992d21938de3b33e0d21fa64482f120b5784c2a5166e1cc1fe9d1b8f96238b38e7a1f3d8b684e4adf6937a5de
-  data.tar.gz: a3214873c063d7f26324eccc7d5ddb206296959cbd0f67747e042014c13633f4186d963337c5cbb14541ff8422ff17dc98183a1eb30417d4d921eceb8d3761a1
+  metadata.gz: 29a0c8a277e0ae42061219e86ab7371dcd014e3649e3728db0d166f98c30ad430ad04a9d8cec82d862e34e075a12dbaf4ae4b96e4f77e97addfc01881762cf8f
+  data.tar.gz: c9dccdac635c403f4a0ec2f305bf9947b7ca2b96ef943ae2088888e3b2a553743f19baae48b0451c574b69abda8de2c71275de6ce6637767640a0e6f431479a2

data/README.md

@@ -1 +1,16 @@
 # packs
+
+Welcome to `packs`! `packs` are a simple ruby specification for an extensible packaging system to help modularize Ruby applications.
+
+A `pack` (also called `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.
+
+Here are some example integrations with `packs`:
+- [`stimpack`](https://github.com/rubyatscale/stimpack) 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).
+
+# 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.

data/lib/packs/configuration.rb

@@ -0,0 +1,37 @@
+# typed: strict
+
+module Packs
+  class Configuration
+    extend T::Sig
+
+    sig { params(roots: T::Array[String]).void }
+    attr_writer :roots
+
+    sig { void }
+    def initialize
+      @roots = T.let(ROOTS, T::Array[String])
+    end
+
+    sig { returns(T::Array[Pathname]) }
+    def roots
+      @roots.map do |root|
+        Pathname.new(root)
+      end
+    end
+  end
+
+  class << self
+    extend T::Sig
+
+    sig { returns(Configuration) }
+    def config
+      @config = T.let(@config, T.nilable(Configuration))
+      @config ||= Configuration.new
+    end
+
+    sig { params(blk: T.proc.params(arg0: Configuration).void).void }
+    def configure(&blk)
+      yield(config)
+    end
+  end
+end

data/lib/packs/pack.rb

@@ -0,0 +1,43 @@
+# typed: strict
+
+module Packs
+  class Pack < T::Struct
+    extend T::Sig
+
+    const :name, String
+    const :path, Pathname
+    const :relative_path, Pathname
+    const :raw_hash, T::Hash[T.untyped, T.untyped]
+
+    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(Private.root)
+      package_name = relative_path.cleanpath.to_s
+
+      Pack.new(
+        name: package_name,
+        path: path,
+        relative_path: relative_path,
+        raw_hash: package_loaded_yml || {}
+      )
+    end
+
+    sig { params(relative: T::Boolean).returns(Pathname) }
+    def yml(relative: true)
+      path_to_use = relative ? relative_path : path
+      path_to_use.join(PACKAGE_FILE).cleanpath
+    end
+
+    sig { returns(String) }
+    def last_name
+      relative_path.basename.to_s
+    end
+
+    sig { returns(T::Hash[T.untyped, T.untyped]) }
+    def metadata
+      raw_hash['metadata'] || {}
+    end
+  end
+end

data/lib/packs/private.rb

@@ -0,0 +1,14 @@
+# typed: strict
+
+module Packs
+  module Private
+    extend T::Sig
+
+    sig { returns(Pathname) }
+    def self.root
+      Pathname.pwd
+    end
+  end
+
+  private_constant :Private
+end

data/lib/packs.rb

@@ -1,5 +1,68 @@
 # typed: strict
 
-# Coming soon...!
+require 'yaml'
+require 'sorbet-runtime'
+require 'packs/pack'
+require 'packs/configuration'
+require 'packs/private'
+
 module Packs
+  PACKAGE_FILE = T.let('package.yml'.freeze, String)
+  ROOTS = T.let(%w[packs components], T::Array[String])
+
+  class << self
+    extend T::Sig
+
+    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
+
+    sig { void }
+    def bust_cache!
+      @packs_by_name = nil
+      @config = nil
+      @for_file = nil
+    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
+      config.roots.flat_map do |root|
+        absolute_root = Private.root.join(root)
+        [
+          *absolute_root.glob("*/#{PACKAGE_FILE}"),
+          *absolute_root.glob("*/*/#{PACKAGE_FILE}")
+        ]
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2022-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -104,8 +118,9 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/packs.rb
-- sorbet/config
-- sorbet/rbi/todo.rbi
+- lib/packs/configuration.rb
+- lib/packs/pack.rb
+- lib/packs/private.rb
 homepage: https://github.com/rubyatscale/packs
 licenses:
 - MIT
@@ -129,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Packs are the specification for gradual modularization in the `rubyatscale`

data/sorbet/config

@@ -1,3 +0,0 @@
---dir
-.
---ignore=/vendor/bundle

data/sorbet/rbi/todo.rbi

@@ -1,5 +0,0 @@
-# This file is autogenerated. Do not edit it by hand. Regenerate it with:
-#   srb rbi todo
-
-# typed: strong
-module ::RSpec; end