stimpack 1.0.0.alpha1 → 1.0.0.alpha6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aedf6786a9c8dce60f5d90bf3f9b97bea858d3faeac218c2991a5ed5dd61503e
-  data.tar.gz: 1b7c218dc706f75f77d4d1e6e099f174520c26ebbf573f985f05e6e28a343af8
+  metadata.gz: f7e4f58a5817580fd238b6a209d51565f992d7c39ade6003338d168c2a52235b
+  data.tar.gz: 372c732e00ab4fb1c301e8c44ff483954c8fd9864166712e9a42dff124d9bfb8
 SHA512:
-  metadata.gz: be4a82f48f0c966edfc9c86c096d4e8cbfe7f23177007ddd91bffe769ac7fab05921f6b7c2855b8fbadc49c54aede9024b1820f76ecbe988b492507adc3fc212
-  data.tar.gz: 889c48f4b28b1260e6387ba6205f5b586846630c33182f680bbbaf8bfe0a18f89529b16ef87c562991452da74bbd2191168189d1b7f4380e56448eabe586fae1
+  metadata.gz: 03fbcedb9c236fe384c124a7ca8f923a1717862d648f134a5954960136b33e2297b2c803e7335af22fe0cc8212e8420cdac1131618c5abfdb353975550e96c3c
+  data.tar.gz: 107de7c60b5dc14f02196bc04df5ea933122038a0fae17fac9a144ecfc9b0e22a3ede60cd28699061475771bcc056bf3c26b9df7620b47b7a2d54022e9c28f8d

data/lib/stimpack.rb

@@ -5,54 +5,26 @@ module Stimpack
   extend ActiveSupport::Autoload
 
   autoload :Integrations
-  autoload :Autoloaders
+  autoload :Pack
   autoload :Packs
-  autoload :Settings
-  autoload :Stim
   autoload :Railtie
-  autoload :Require
-  autoload :ZeitwerkProxy
+  autoload :Stim
 
   class Error < StandardError; end
 
   class << self
-    def start!
-      @started = @started ? return : true
-
-      # Override Rails' autoloader accessors.
-      # Rails::Autoloaders.singleton_class.prepend(Autoloaders)
-
+    def load(app)
       Packs.resolve
 
-      install_integrations
-    end
-
-    def finalize!
-      @finalized = @finalized ? return : true
-
-      Require.setup
-    end
-
-    def autoloader(original)
-      return original if @finalized
-
-      @autoloader_proxies ||= {}
-      @autoloader_proxies[original] ||= ZeitwerkProxy.new(original)
+      Integrations::Rails.install(app)
+      Integrations::FactoryBot.install(app)
+      Integrations::RSpec.install(app)
     end
 
     def [](name)
       Packs[name.to_s]
     end
-
-    private
-
-    def install_integrations
-      Integrations::FactoryBot.install
-      Integrations::RSpec.install
-    end
   end
 end
 
 require "stimpack/railtie"
-# require "stimpack/require"
-# require "stimpack/kernel"

data/lib/stimpack/integrations.rb

@@ -2,9 +2,8 @@ require "active_support"
 
 module Stimpack
   module Integrations
-    extend ActiveSupport::Autoload
-
-    autoload :RSpec, "stimpack/integrations/rspec"
     autoload :FactoryBot, "stimpack/integrations/factory_bot"
+    autoload :Rails, "stimpack/integrations/rails"
+    autoload :RSpec, "stimpack/integrations/rspec"
   end
 end

data/lib/stimpack/integrations/factory_bot.rb

@@ -1,11 +1,11 @@
 module Stimpack
   module Integrations
     class FactoryBot
-      def self.install
-        return unless Rails.configuration.respond_to?(:factory_bot)
+      def self.install(app)
+        return unless app.config.respond_to?(:factory_bot)
 
         Packs.each do |pack|
-          Rails.configuration.factory_bot.definition_file_paths << pack.settings.relative_path.join("spec/factories").to_s
+          app.config.factory_bot.definition_file_paths << pack.relative_path.join("spec/factories").to_s
         end
       end
     end

data/lib/stimpack/integrations/rails.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Stimpack
+  module Integrations
+    class Rails
+      PATHS = %w(
+        app
+        app/controllers
+        app/channels
+        app/helpers
+        app/models
+        app/mailers
+        app/views
+        lib
+        lib/tasks
+        config
+        config/locales
+        config/initializers
+      ).freeze
+
+      def self.install(app)
+        Packs.each do |pack|
+          PATHS.each do |path|
+            app.paths[path] << pack.path.join(path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stimpack/integrations/rspec.rb

@@ -1,11 +1,11 @@
 module Stimpack
   module Integrations
     class RSpec
-      def self.install
+      def self.install(app)
         return unless defined?(::RSpec)
 
         Packs.each do |pack|
-          ::RSpec.configuration.pattern.concat(",#{pack.settings.relative_path.join("spec/**/*_spec.rb")}")
+          ::RSpec.configuration.pattern.concat(",#{pack.relative_path.join("spec/**/*_spec.rb")}")
         end
       end
     end

data/lib/stimpack/pack.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Stimpack
+  class Pack
+    autoload :Configuration, "stimpack/pack/configuration"
+
+    attr_reader :name
+    attr_reader :path
+    attr_reader :engine
+
+    def self.root
+      @root ||= Rails.root.join("packs")
+    end
+
+    def initialize(path)
+      @path = path
+      @name = path.relative_path_from(self.class.root)
+
+      if config.engine?
+        @engine = create_engine
+      end
+    end
+
+    def relative_path
+      @relative_path ||= path.relative_path_from(Rails.root)
+    end
+
+    def config
+      @config ||= Configuration.new(self)
+    end
+
+    private
+
+    def create_engine
+      namespace = create_namespace(name)
+      stim = Stim.new(self, namespace)
+      namespace.const_set("Engine", Class.new(Rails::Engine)).include(stim)
+    end
+
+    def create_namespace(name)
+      namespace = ActiveSupport::Inflector.camelize(name)
+      namespace.split("::").reduce(Object) do |base, mod|
+        if base.const_defined?(mod)
+          base.const_get(mod)
+        else
+          base.const_set(mod, Module.new)
+        end
+      end
+    end
+  end
+end

data/lib/stimpack/pack/configuration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Stimpack
+  class Pack
+    class Configuration
+      FILE = "package.yml"
+      KEY = "metadata"
+
+      def initialize(pack)
+        @pack = pack
+      end
+
+      def engine
+        data.fetch("engine", false)
+      end
+      alias_method :engine?, :engine
+
+      private
+
+      def data
+        @data ||= YAML.load_file(@pack.path.join(FILE)).fetch(KEY, {}).freeze
+      end
+    end
+  end
+end

data/lib/stimpack/packs.rb

@@ -1,31 +1,30 @@
+# frozen_string_literal: true
+
 require "active_support"
 require "pathname"
 require "rails"
 
 module Stimpack
   module Packs
-    PATH = Pathname.new("packs").freeze
-    PACK_CLASS = "Pack".freeze
+    PACK_CLASS = "Pack"
 
     class << self
       def resolve
-        PATH.glob("**/#{Settings::PACKWERK_PACKAGE_CONFIG}").each do |path|
-          path = path.dirname
-          create(path.relative_path_from(PATH).to_s, path.expand_path)
-        end
-      end
+        # Gather all the directories with package config files.
+        paths = filter(Pack.root.glob("**/#{Pack::Configuration::FILE}").map(&:dirname).sort)
 
-      def create(name, path)
-        namespace = create_namespace(name)
-        stim = Stim.new(path)
-        @packs[name] = namespace.const_set(PACK_CLASS, Class.new(Rails::Engine)).include(stim)
+        # Create thes packs.
+        paths.each do |path|
+          pack = Pack.new(path)
+          @packs[pack.name] = pack
+        end
       end
 
       def find(path)
         path = "#{path}/"
 
         @packs.values.find do |pack|
-          path.start_with?("#{pack.root}/")
+          path.start_with?("#{pack.path}/")
         end
       end
 
@@ -39,13 +38,14 @@ module Stimpack
 
       private
 
-      def create_namespace(name)
-        namespace = ActiveSupport::Inflector.camelize(name)
-        namespace.split("::").reduce(Object) do |base, mod|
-          if base.const_defined?(mod)
-            base.const_get(mod)
-          else
-            base.const_set(mod, Module.new)
+      def filter(paths)
+        # Reject all paths that are nested since they might be just packwerk
+        # packages instead of packs.
+        paths.reject do |path|
+          path = "#{path}/"
+          paths.any? do |other_path|
+            other_path = "#{other_path}/"
+            path != other_path && path.start_with?(other_path)
           end
         end
       end

data/lib/stimpack/railtie.rb

@@ -2,12 +2,8 @@ require "rails"
 
 module Stimpack
   class Railtie < Rails::Railtie
-    config.before_configuration do
-      Stimpack.start!
-    end
-
-    config.after_initialize do
-      Stimpack.finalize!
+    config.before_configuration do |app|
+      Stimpack.load(app)
     end
   end
 end

data/lib/stimpack/stim.rb

@@ -1,32 +1,35 @@
 module Stimpack
   class Stim < Module
-    def initialize(path)
-      @path = path
+    def initialize(pack, namespace)
+      @pack = pack
+      @namespace = namespace
       super()
     end
 
     def included(engine)
-      engine.called_from = @path
+      engine.called_from = @pack.path
       engine.extend(ClassMethods)
-      settings = engine.settings
+      engine.isolate_namespace(@namespace)
 
-      if settings.isolate_namespace?
-        engine.isolate_namespace(settings.namespace)
+      # Set all of these paths to nil because we want the Rails integration to take
+      # care of them. The purpose of this Engine is really just for the namespace
+      # isolation.
+      (Stimpack::Integrations::Rails::PATHS +
+        # In addition to the paths we've delegated to the main app, we don't allow
+        # Engine Packs to have various capabilities.
+        %w(
+          config/environments
+          db/migrate
+        )
+      ).uniq.each do |path|
+        engine.paths[path] = nil
       end
-
-      # if settings.implicit_namespace?
-      #   engine.paths["lib"].skip_load_path!
-      # end
     end
 
     module ClassMethods
       def find_root(_from)
         called_from
       end
-
-      def settings
-        @settings ||= Stimpack::Settings.new(self)
-      end
     end
   end
 end

data/lib/stimpack/version.rb

@@ -1,3 +1,3 @@
 module Stimpack
-  VERSION = "1.0.0.alpha1".freeze
+  VERSION = "1.0.0.alpha6".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimpack
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha1
+  version: 1.0.0.alpha6
 platform: ruby
 authors:
 - Ngan Pham
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-20 00:00:00.000000000 Z
+date: 2021-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,28 +63,23 @@ files:
 - bin/console
 - bin/setup
 - lib/stimpack.rb
-- lib/stimpack/autoloaders.rb
-- lib/stimpack/instance.rb
 - lib/stimpack/integrations.rb
 - lib/stimpack/integrations/factory_bot.rb
+- lib/stimpack/integrations/rails.rb
 - lib/stimpack/integrations/rspec.rb
-- lib/stimpack/kernel.rb
-- lib/stimpack/package.rb
-- lib/stimpack/packages.rb
+- lib/stimpack/pack.rb
+- lib/stimpack/pack/configuration.rb
 - lib/stimpack/packs.rb
 - lib/stimpack/railtie.rb
-- lib/stimpack/require.rb
-- lib/stimpack/settings.rb
 - lib/stimpack/stim.rb
 - lib/stimpack/version.rb
-- lib/stimpack/zeitwerk_proxy.rb
 homepage: https://github.com/Gusto/stimpack
 licenses: []
 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
@@ -100,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Rails helper to package your code.
 test_files: []

data/lib/stimpack/autoloaders.rb

@@ -1,11 +0,0 @@
-module Stimpack
-  module Autoloaders
-    def main
-      Stimpack.autoloader(super)
-    end
-
-    def once
-      Stimpack.autoloader(super)
-    end
-  end
-end

data/lib/stimpack/instance.rb

@@ -1,14 +0,0 @@
-require "pathname"
-require "active_support/inflector"
-
-module Stimpack
-  class Instance
-    def initialize
-      Pathname.new("packages").glob("*/package.yml").each do |path|
-        path = path.realpath.dirname
-        name = ActiveSupport::Inflector.classify(path.basename)
-        Stimpack::Packages.create(name, path)
-      end
-    end
-  end
-end

data/lib/stimpack/kernel.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Kernel
-  module_function
-
-  alias_method :stimpack_original_require, :require
-
-  def require(path)
-    stimpack_original_require(Stimpack::Require.resolve(path) || path)
-  end
-end

data/lib/stimpack/package.rb

@@ -1,14 +0,0 @@
-require "rails"
-require "active_support/core_ext/module/delegation"
-
-module Stimpack
-  class Package < ::Rails::Engine
-    class << self
-      delegate :subclasses, to: :superclass
-
-      def find_root(from)
-        Packages.paths[module_parent.name]
-      end
-    end
-  end
-end

data/lib/stimpack/packages.rb

@@ -1,35 +0,0 @@
-require "rails"
-
-module Stimpack
-  module Packages
-    def self.paths
-      @paths ||= {}
-    end
-
-    def self.create(name, path)
-      paths[name] = path
-
-      class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
-        module ::#{name}
-          class Engine < ::Stimpack::Package
-          end
-        end
-      RUBY
-
-      engine = const_get("::#{name}::Engine")
-      # Isolate the package namespace.
-      engine.isolate_namespace(engine.module_parent)
-
-      # Disable Railtie initializers for Packages.
-      engine.paths["config/initializers"] = nil
-
-      engine.paths["lib/tasks"] = "tasks"
-      engine.paths["db/migrate"] = "migrations"
-      engine.paths["config/routes.rb"] = "routes.rb"
-
-      if engine.paths["db/migrate"].existent.any?
-        ActiveRecord::Migrator.migrations_paths << engine.paths["db/migrate"].first
-      end
-    end
-  end
-end

data/lib/stimpack/require.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Stimpack
-  class Require
-    IGNORED_PATH_PREFIXES = ["/", "./"].freeze
-    RUBY_EXTENSION = ".rb"
-
-    include Singleton
-
-    attr_accessor :enabled
-
-    def self.resolve(path)
-      instance.resolve(path)
-    end
-
-    def self.setup
-      instance.setup
-    end
-
-    def initialize
-      @packs = {}
-    end
-
-    def setup
-      @setup = @setup ? return : true
-
-      Packs.each do |pack|
-        if pack.settings.implicit_namespace?
-          @packs["#{pack.settings.name}/"] = "#{pack.paths["lib"].first}/"
-        end
-      end
-    end
-
-    def resolve(path)
-      path = path.to_s
-      return if path.start_with?(*IGNORED_PATH_PREFIXES)
-
-      @packs.find do |pack_path, full_path|
-        if path.start_with?(pack_path)
-          full_pack_path = path.sub(pack_path, full_path)
-          full_pack_path.concat(RUBY_EXTENSION) unless full_pack_path.end_with?(RUBY_EXTENSION)
-          return File.exist?(full_pack_path) && full_pack_path
-        end
-      end
-    end
-  end
-end

data/lib/stimpack/settings.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Stimpack
-  class Settings
-    PACKWERK_PACKAGE_CONFIG = "package.yml"
-
-    def initialize(pack)
-      @pack = pack
-
-      package_config = YAML.load_file(pack.root.join(PACKWERK_PACKAGE_CONFIG)) || {}
-      @config = package_config.fetch("metadata", {}).freeze
-    end
-
-    def path
-      @pack.called_from
-    end
-
-    def relative_path
-      @relative_path ||= path.relative_path_from(Rails.root)
-    end
-
-    def name
-      @name ||= ActiveSupport::Inflector.underscore(namespace.name)
-    end
-
-    def namespace
-      @pack.module_parent
-    end
-
-    # def implicit_namespace
-    #   @config.fetch("implicit_namespace", true)
-    # end
-    # alias_method :implicit_namespace?, :implicit_namespace
-
-    def isolate_namespace
-      @config.fetch("isolate_namespace", true)
-    end
-    alias_method :isolate_namespace?, :isolate_namespace
-  end
-end

data/lib/stimpack/zeitwerk_proxy.rb

@@ -1,24 +0,0 @@
-require "active_support"
-
-module Stimpack
-  class ZeitwerkProxy
-    delegate_missing_to :@loader
-
-    def initialize(loader)
-      @loader = loader
-    end
-
-    def push_dir(path, namespace: Object)
-      @loader.push_dir(path, namespace: _resolve_namespace(path) || namespace)
-    end
-
-    private
-
-    def _resolve_namespace(path)
-      pack = Packs.find(path)
-      return unless pack
-
-      pack.settings.namespace if pack.settings.implicit_namespace?
-    end
-  end
-end