stimpack 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b42399feb13f1a49d98931774e5b84d183fc7e1aa788e42e1687e5b08da0a7d
-  data.tar.gz: 57032be9ad0ec238c44599f3261f2a24c30fb57a50b81981d5f832c42187f45d
+  metadata.gz: 5c1c50146a16145446bf9b0bc74d29d19f8cb62fe9194a98d7767163ab5ffe31
+  data.tar.gz: 335d8aaaf0fcd39058d2379d646f4fa1c4ba02c811b70dfc90e316668be35004
 SHA512:
-  metadata.gz: a03f395c7e10c89e6fb1e6757634aa70f3631106635d9da6236c6a828af8a5c7830670ca720ed656f77ece61e98d86ad52fad1b7a44affd9f1d88df68c402d2a
-  data.tar.gz: c6cfbb618b10b21a5cf4ac0e465811236a269ef3210187870a47b1fd1043342ef3ee2b5fe0ea440a9f5c2dac57b4bdff495d9d04525ca3e5c5e1c90c7b9a9197
+  metadata.gz: 69ab74f37e4eb0980c8ef7c383c54953acc9a80f442b7513f6ce5ba9ca6f328499a6bd1f81f3ef8590d720456cbf453fca24854dbb7704313797ca709aafe7af
+  data.tar.gz: 18bb1001c9d8da9c055202d65ee55e8dbf9c83f3d445999bbf18bc05e7650113d0acd4dc5c1df1d7a742e5e8d11b4683b61c171b5e1b86ab293262f83aee45c6

data/lib/stimpack/integrations/factory_bot.rb

@@ -1,10 +1,14 @@
+# typed: true
+
 module Stimpack
   module Integrations
     class FactoryBot
       def initialize(app)
         return unless app.config.respond_to?(:factory_bot)
+        Stimpack.configure_packs
 
         Packs.all.each do |pack|
+          next if pack.relative_path.glob('*.gemspec').any?
           app.config.factory_bot.definition_file_paths << pack.relative_path.join("spec/factories").to_s
         end
       end

data/lib/stimpack/integrations/rails.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 require "active_support/inflections"
 
@@ -9,22 +10,24 @@ module Stimpack
         @app = app
 
         Stimpack.config.paths.freeze
+        Stimpack.configure_packs
+
         create_engines
         inject_paths
       end
 
       def create_engines
         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 +46,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,11 +1,17 @@
+# 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)
         default_path = ::RSpec.configuration.default_path
 
+        Stimpack.configure_packs
+
         if to_run == [default_path]
           # 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.
@@ -26,10 +32,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 +48,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.8.0".freeze
+  VERSION = "0.8.2".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
 
@@ -18,10 +18,28 @@ module Stimpack
     def root
       @root ||= Rails::Application.find_root(Dir.pwd)
     end
+
+    #
+    # This is temporary. For now, we allow Stimpack roots to be configured via Stimpack.config.root
+    # Later, if clients configure packs directly, we can deprecate the Stimpack setting and
+    # remove this function and its invocations.
+    #
+    def configure_packs
+      Packs.configure do |config|
+        roots = Array(Stimpack.config.root)
+        pack_paths = roots.flat_map do |root|
+          # Support nested packs by default. Later, this can be pushed to a client configuration.
+          ["#{root}/*", "#{root}/*/*"]
+        end
+
+        config.pack_paths = pack_paths
+      end
+    end
   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.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Ngan Pham
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-08 00:00:00.000000000 Z
+date: 2022-12-29 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
@@ -152,7 +163,7 @@ metadata:
   homepage_uri: https://github.com/Gusto/stimpack
   source_code_uri: https://github.com/Gusto/stimpack
   changelog_uri: https://github.com/Gusto/stimpack/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +178,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.25
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: A Rails helper to package your code.
 test_files: []

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,48 +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}/"
-        matched_path = @find_pack_paths.find do |pack_path|
-          path.start_with?(pack_path)
-        end
-        all_by_path.fetch(matched_path.chomp("/")) if matched_path
-      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