stimpack 0.0.1.alpha1 → 1.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbbb988cfbc8e3fb761d92e2d989dd546ef196a9acada9bae2718424c81f2d74
-  data.tar.gz: 735f0e30435e5230f2a13d11e9bb0d46a4bfd613ff7e5af79b6bbe9c8d9ec9a8
+  metadata.gz: aedf6786a9c8dce60f5d90bf3f9b97bea858d3faeac218c2991a5ed5dd61503e
+  data.tar.gz: 1b7c218dc706f75f77d4d1e6e099f174520c26ebbf573f985f05e6e28a343af8
 SHA512:
-  metadata.gz: 0b4e2c7457d511322225671c656267733c429fc5b4938450e466bd7fbee2a16068b5b2f4fc5ed6e33939c60d7835033b494ee6ef8407b247eda44fa2af0f04cd
-  data.tar.gz: be22569f23c0e65833573758537e60e6fa9a67d4090f04892e44adf4705cc26b8b3e902ecd695d81d375ae823b474399ea1935f991e7d7186a1dfd4dc203ef96
+  metadata.gz: be4a82f48f0c966edfc9c86c096d4e8cbfe7f23177007ddd91bffe769ac7fab05921f6b7c2855b8fbadc49c54aede9024b1820f76ecbe988b492507adc3fc212
+  data.tar.gz: 889c48f4b28b1260e6387ba6205f5b586846630c33182f680bbbaf8bfe0a18f89529b16ef87c562991452da74bbd2191168189d1b7f4380e56448eabe586fae1

data/README.md

@@ -9,7 +9,7 @@ TODO: Delete this and the text above, and describe your gem
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'stimpack'
+gem "stimpack"
 ```
 
 And then execute:
@@ -33,4 +33,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ngan/stimpack.
-

data/lib/stimpack.rb

@@ -1,6 +1,58 @@
-require "stimpack/version"
+require "active_support"
+require "rails"
 
 module Stimpack
+  extend ActiveSupport::Autoload
+
+  autoload :Integrations
+  autoload :Autoloaders
+  autoload :Packs
+  autoload :Settings
+  autoload :Stim
+  autoload :Railtie
+  autoload :Require
+  autoload :ZeitwerkProxy
+
   class Error < StandardError; end
-  # Your code goes here...
+
+  class << self
+    def start!
+      @started = @started ? return : true
+
+      # Override Rails' autoloader accessors.
+      # Rails::Autoloaders.singleton_class.prepend(Autoloaders)
+
+      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)
+    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/autoloaders.rb

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

data/lib/stimpack/instance.rb

@@ -0,0 +1,14 @@
+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/integrations.rb

@@ -0,0 +1,10 @@
+require "active_support"
+
+module Stimpack
+  module Integrations
+    extend ActiveSupport::Autoload
+
+    autoload :RSpec, "stimpack/integrations/rspec"
+    autoload :FactoryBot, "stimpack/integrations/factory_bot"
+  end
+end

data/lib/stimpack/integrations/factory_bot.rb

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

data/lib/stimpack/integrations/rspec.rb

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

data/lib/stimpack/kernel.rb

@@ -0,0 +1,11 @@
+# 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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,35 @@
+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/packs.rb

@@ -0,0 +1,56 @@
+require "active_support"
+require "pathname"
+require "rails"
+
+module Stimpack
+  module Packs
+    PATH = Pathname.new("packs").freeze
+    PACK_CLASS = "Pack".freeze
+
+    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
+
+      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)
+      end
+
+      def find(path)
+        path = "#{path}/"
+
+        @packs.values.find do |pack|
+          path.start_with?("#{pack.root}/")
+        end
+      end
+
+      def [](name)
+        @packs[name]
+      end
+
+      def each(*args, &block)
+        @packs.each_value(*args, &block)
+      end
+
+      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)
+          end
+        end
+      end
+    end
+
+    @packs = {}
+  end
+end

data/lib/stimpack/railtie.rb

@@ -0,0 +1,13 @@
+require "rails"
+
+module Stimpack
+  class Railtie < Rails::Railtie
+    config.before_configuration do
+      Stimpack.start!
+    end
+
+    config.after_initialize do
+      Stimpack.finalize!
+    end
+  end
+end

data/lib/stimpack/require.rb

@@ -0,0 +1,47 @@
+# 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

@@ -0,0 +1,40 @@
+# 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/stim.rb

@@ -0,0 +1,32 @@
+module Stimpack
+  class Stim < Module
+    def initialize(path)
+      @path = path
+      super()
+    end
+
+    def included(engine)
+      engine.called_from = @path
+      engine.extend(ClassMethods)
+      settings = engine.settings
+
+      if settings.isolate_namespace?
+        engine.isolate_namespace(settings.namespace)
+      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 = "0.0.1.alpha1"
+  VERSION = "1.0.0.alpha1".freeze
 end

data/lib/stimpack/zeitwerk_proxy.rb

@@ -0,0 +1,24 @@
+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

metadata

@@ -1,16 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: stimpack
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha1
+  version: 1.0.0.alpha1
 platform: ruby
 authors:
 - Ngan Pham
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
-dependencies: []
-description: Name hold for upcoming gem
+date: 2021-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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
+    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: rspec
+  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'
+description: Package your code.
 email:
 - gusto-opensource-buildkite@gusto.com
 executables: []
@@ -21,7 +63,21 @@ 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/rspec.rb
+- lib/stimpack/kernel.rb
+- lib/stimpack/package.rb
+- lib/stimpack/packages.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:
@@ -36,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -46,5 +102,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Name hold for upcoming gem
+summary: A Rails helper to package your code.
 test_files: []