stimpack 0.7.1 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be1d3fa462f2ec696d5c72721fd96cead8a0bb2c08f238f2ffab9af6ce753ea9
-  data.tar.gz: 2a09c371fea45fca32c6d386ec6588887a04326ee306b81199edeb7e4ffa2cb3
+  metadata.gz: 46d22ca966c49e9a2f424291c0c44caec1ea24664c3239f1cca1fa4e218e91bf
+  data.tar.gz: 5a393fa3f27d5b9bcab1edf0d193f9a4cf7d64410d4184725b6cc26ac6e66679
 SHA512:
-  metadata.gz: 56a878d5ccc64a91ab8366759d6900758e80a59f0a4ad60b8c8397849e975f2043e46926bff5ac6ec1745aad5d69fd78ba5cc7dcce2242f45aeb374a5483863a
-  data.tar.gz: 8767f7b944326da96773793170b32b5e880bfebc1ad0e8ab657e2d84154a874c9a50603ebd0c1e9e5bd4fead7c13810e5e93e10e6072e40e99fa9485d550fa09
+  metadata.gz: 97ab5bfa795b0cd6008a13df1bb297e51191b5da2e561421e64b1fef71a80724709ffed50fdb66504102ca4625d532afb77564744564b8f77919c2aa3ff68b1b
+  data.tar.gz: 70eb5b61e2739cd657f31bd0ec79bc221f12ac3c0507365fec6701fda7deaae4839d0c127c6bab423ac3083b35852e03d0b5b0e4fd042245c894e45e48dce166

data/README.md

@@ -46,7 +46,7 @@ packs/
         my_domain/
           my_private_namespaced_model_factory.rb
   my_other_domain/
-    ... # other pack's have a similar structure
+    ... # other packs have a similar structure
   my_other_other_domain/
     ...
 ```
@@ -83,7 +83,7 @@ draw(:my_domain)
 ```
 
 ### Making your Package an Engine
-Add `engine: true` to your `package.yml` to make it an actual Rails engine:
+Add `engine: true` to your `package.yml` to make it an actual Rails engine ([read more about what this means here](https://guides.rubyonrails.org/engines.html)):
 ```yml
 # packs/my_pack/package.yml
 enforce_dependencies: true
@@ -92,6 +92,8 @@ metadata:
   engine: true
 ```
 
+## Ecosystem and Integrations
+
 ### RSpec Integration
 Simply add `--require stimpack/rspec` to your `.rspec`.
 Or, if you'd like, pass it as an argument to `rspec`:
@@ -121,6 +123,27 @@ rspec packs/foobar/spec
 rspec packs/foobar/nested_pack
 ```
 
+#### parallel_tests
+
+`parallel_tests` has it its own spec discovery mechanism, so Stimpack's RSpec integration doesn't do anything when you use them together.
+To make them work, you'll need to explicitly specify the spec paths:
+
+```bash
+RAILS_ENV=test bundle exec parallel_test spec packs/**/spec -t rspec <other_options>
+```
+
+#### Knapsack (Pro)
+
+Similarly, Knapsack (and its Pro version) has its own spec discovery mechanism and the API will find and queue the relevant specs.
+To make it discover your pack tests as well, you'll need to configure the following variables:
+
+```yaml
+KNAPSACK_PRO_TEST_DIR: spec
+KNAPSACK_PRO_TEST_FILE_PATTERN: '{spec,packs}/**{,/*/**}/*_spec.rb'
+```
+
+Setting `KNAPSACK_PRO_TEST_FILE_PATTERN` will tell Knapsack where your specs are located, while setting `KNAPSACK_PRO_TEST_DIR` is necessary because otherwise an incorrect value is sent to rspec via the `--default-path` option.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Gusto/stimpack.

data/lib/stimpack/integrations/factory_bot.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Stimpack
   module Integrations
     class FactoryBot

data/lib/stimpack/integrations/rails.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 require "active_support/inflections"
 
@@ -14,17 +15,21 @@ module Stimpack
       end
 
       def create_engines
+        # Ideally, the user just does `Packs.configure { |config| config.roots = '...' }`
+        # But that would be a public API change and can come later
+        Packs.configure { |config| config.roots = Array(Stimpack.config.root) }
+
         Packs.all.each do |pack|
-          next unless pack.config.engine?
+          next unless pack.metadata['engine']
 
-          pack.engine = create_engine(pack)
+          create_engine(pack)
         end
       end
 
       def inject_paths
         Packs.all.each do |pack|
           Stimpack.config.paths.each do |path|
-            @app.paths[path] << pack.path.join(path)
+            @app.paths[path] << pack.relative_path.join(path)
           end
         end
       end
@@ -43,8 +48,8 @@ module Stimpack
       end
 
       def create_engine(pack)
-        name = pack.path.relative_path_from(Stimpack::Packs.root)
-        namespace = create_namespace(pack.name)
+        name = pack.last_name
+        namespace = create_namespace(name)
         stim = Stim.new(pack, namespace)
         namespace.const_set("Engine", Class.new(::Rails::Engine)).include(stim)
       end

data/lib/stimpack/integrations/rspec.rb

@@ -1,6 +1,10 @@
+# typed: true
+
 module Stimpack
   module Integrations
     class RSpec
+      extend T::Sig
+
       def initialize
         # This is the list of directories RSpec was told to run.
         to_run = ::RSpec.configuration.instance_variable_get(:@files_or_directories_to_run)
@@ -10,6 +14,7 @@ module Stimpack
           # This is the default case when you run `rspec`. We want to add all the pack's spec paths
           # to the collection of directories to run.
 
+          Packs.configure { |config| config.roots = Array(Stimpack.config.root) }
           pack_paths = Packs.all.map do |pack|
             spec_path = pack.relative_path.join(default_path)
             spec_path.to_s if spec_path.exist?
@@ -26,10 +31,10 @@ module Stimpack
           # If it doesn't match a pack path, we leave it alone.
 
           to_run.map! do |path|
-            if pack = Packs.all_by_path[path]
+            if pack = Packs.find(path)
               [
                 pack,
-                *Packs.all(pack)
+                *nested_packs_for(pack)
               ].map do |pack|
                 spec_path = pack.relative_path.join(default_path)
                 spec_path.to_s if spec_path.exist?
@@ -42,6 +47,13 @@ module Stimpack
 
         ::RSpec.configuration.files_or_directories_to_run = to_run.flatten.compact.uniq
       end
+
+      sig { params(parent_pack: Packs::Pack).returns(T::Array[Packs::Pack]) }
+      def nested_packs_for(parent_pack)
+        Packs.all.select do |pack|
+          pack.name != parent_pack.name && pack.name.include?(parent_pack.name)
+        end
+      end
     end
   end
 end

data/lib/stimpack/stim.rb

@@ -1,5 +1,10 @@
+# typed: true
+
 module Stimpack
   class Stim < Module
+    extend T::Sig
+
+    sig { params(pack: Packs::Pack, namespace: Module).void }
     def initialize(pack, namespace)
       @pack = pack
       @namespace = namespace
@@ -7,7 +12,7 @@ module Stimpack
     end
 
     def included(engine)
-      engine.called_from = @pack.path
+      engine.called_from = @pack.relative_path
       engine.extend(ClassMethods)
       engine.isolate_namespace(@namespace)
 
@@ -28,7 +33,7 @@ module Stimpack
 
     module ClassMethods
       def find_root(_from)
-        called_from
+        T.unsafe(self).called_from
       end
     end
   end

data/lib/stimpack/version.rb

@@ -1,3 +1,3 @@
 module Stimpack
-  VERSION = "0.7.1".freeze
+  VERSION = "0.8.1".freeze
 end

data/lib/stimpack.rb

@@ -1,12 +1,12 @@
+require 'packs'
 require "active_support"
 require "rails/application"
+require 'sorbet-runtime'
 
 module Stimpack
   extend ActiveSupport::Autoload
 
   autoload :Integrations
-  autoload :Pack
-  autoload :Packs
   autoload :Railtie
   autoload :Stim
 
@@ -21,7 +21,8 @@ module Stimpack
   end
 
   @config = ActiveSupport::OrderedOptions.new
-  @config.root = "packs".freeze
+  # Should this allow a plural version to be set? What are semantics of that?
+  @config.root = Array("packs".freeze)
   @config.paths = %w(
     app
     app/controllers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimpack
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.1
 platform: ruby
 authors:
 - Ngan Pham
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: packs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
@@ -139,9 +153,6 @@ files:
 - lib/stimpack/integrations/factory_bot.rb
 - lib/stimpack/integrations/rails.rb
 - lib/stimpack/integrations/rspec.rb
-- lib/stimpack/pack.rb
-- lib/stimpack/pack/configuration.rb
-- lib/stimpack/packs.rb
 - lib/stimpack/railtie.rb
 - lib/stimpack/rspec.rb
 - lib/stimpack/stim.rb
@@ -167,7 +178,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: A Rails helper to package your code.

data/lib/stimpack/pack/configuration.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require "yaml"
-
-module Stimpack
-  class Pack
-    class Configuration
-      KEY = "metadata"
-
-      def initialize(path)
-        @path = path
-      end
-
-      def engine
-        data.fetch("engine", false)
-      end
-      alias_method :engine?, :engine
-
-      private
-
-      def data
-        @data ||= begin
-          contents = YAML.respond_to?(:safe_load_file) ? YAML.safe_load_file(@path) : YAML.load_file(@path)
-          contents ||= {}
-          contents.fetch(KEY, {}).freeze
-        end
-      end
-    end
-  end
-end

data/lib/stimpack/pack.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-
-module Stimpack
-  class Pack
-    PACKAGE_FILE = "package.yml"
-
-    autoload :Configuration, "stimpack/pack/configuration"
-
-    attr_reader :path
-    attr_reader :name
-    attr_accessor :engine
-
-    def initialize(path)
-      @path = path
-      @name = path.basename.to_s
-    end
-
-    def relative_path
-      @relative_path ||= path.relative_path_from(Stimpack.root)
-    end
-
-    def config
-      @config ||= Configuration.new(path.join(PACKAGE_FILE))
-    end
-  end
-end

data/lib/stimpack/packs.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support"
-
-module Stimpack
-  module Packs
-    PACKAGE_GLOB_PATTERN = "*/#{Pack::PACKAGE_FILE}"
-
-    class << self
-      def root
-        @root ||= Stimpack.root.join(Stimpack.config.root)
-      end
-
-      def find(path)
-        @find_pack_paths ||= all_by_path.keys.sort_by(&:length).reverse!.map { |path| "#{path}/" }
-        path = "#{path}/"
-        @find_pack_paths.find do |pack_path|
-          path.start_with?(pack_path)
-        end
-      end
-
-      def all(parent = nil)
-        @all ||= resolve(root).each_with_object({}) do |pack, map|
-          map[pack] = resolve(pack.path).freeze
-        end.freeze
-
-        if parent
-          @all[parent]
-        else
-          @all.keys + @all.values.flatten
-        end
-      end
-
-      def all_by_path
-        @all_by_path ||= all.each_with_object({}) do |pack, map|
-          map[pack.relative_path.to_s] = pack
-        end
-      end
-
-      private
-
-      def resolve(directory)
-        directory.glob(PACKAGE_GLOB_PATTERN).map { |path| Pack.new(path.dirname) }
-      end
-    end
-  end
-end