stimpack 0.0.1.alpha1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbbb988cfbc8e3fb761d92e2d989dd546ef196a9acada9bae2718424c81f2d74
-  data.tar.gz: 735f0e30435e5230f2a13d11e9bb0d46a4bfd613ff7e5af79b6bbe9c8d9ec9a8
+  metadata.gz: 8a182ce65cfc7f331c0b8aab98cb9f66f74e24b2892f07759b6fc0663d2ed9d2
+  data.tar.gz: cfbdf8284d0b3c054c2708bd69bfc0eb63341044e93ca064cf9971b17e391a06
 SHA512:
-  metadata.gz: 0b4e2c7457d511322225671c656267733c429fc5b4938450e466bd7fbee2a16068b5b2f4fc5ed6e33939c60d7835033b494ee6ef8407b247eda44fa2af0f04cd
-  data.tar.gz: be22569f23c0e65833573758537e60e6fa9a67d4090f04892e44adf4705cc26b8b3e902ecd695d81d375ae823b474399ea1935f991e7d7186a1dfd4dc203ef96
+  metadata.gz: 7dfc2c8a19b50159cddb6f5ace4a593e8f69d8719ee607c3994fed1b1541cfb639fa1bba1bb458eff632487cf65e84181899bd3c3343192ddd5f03abd6f8bd7a
+  data.tar.gz: 1c7f5dce375f55b6733ac771d86f3799aa408335e0d17b11cff6c9e7d47e7ff6d53ccd54c5f944419bad9a9eda2a0c2146c4048dcf26ff643e056119302fb66c

data/README.md

@@ -1,36 +1,86 @@
 # Stimpack
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stimpack`. To experiment with that code, run `bin/console` for an interactive prompt.
+`stimpack` makes integrating with [`packwerk`](https://github.com/Shopify/packwerk) easy and establishes conventions such that packwerk packages mimic the feel and structure of [Rails engines](https://guides.rubyonrails.org/engines.html), without all of the boilerplate. With `stimpack`, new packages' autoload paths are automatically added to Rails, so your code will immediately become usable and loadable without additional configuration.
 
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'stimpack'
+Here is an example application that uses `stimpack`:
+```
+package.yml # root level pack
+app/ # Unpackaged code
+  models/
+  ...
+packs/
+  my_domain/
+    package.yml # See the packwerk docs for more info
+    deprecated_references.yml # See the packwerk docs for more info
+    app/
+      public/ # Recommended location for public API
+        my_domain.rb # creates the primary namespaces
+        my_domain/
+          my_subdomain.rb
+      services/ # Private services
+        my_domain/
+          some_private_class.rb
+      models/ # Private models
+        some_other_non_namespaced_private_model.rb # this works too
+        my_domain/
+          my_private_namespacd_model.rb
+      config/
+        initializers/ # Initializers can live in packs and load as expected
+      controllers/
+      views/
+      lib/
+        tasks/
+    spec/ # With stimpack, specs for a pack live next to the pack
+      public/
+        my_domain_spec.rb
+        my_domain/
+          my_subdomain_spec.rb
+      services/
+        my_domain/
+          some_private_class_spec.rb
+      models/
+        some_other_non_namespaced_private_model_spec.rb
+        my_domain/
+          my_private_namespaced_model_spec.rb
+      factories/ # Stimpack will automatically load pack factories into FactoryBot
+        my_domain/
+          my_private_namespaced_model_factory.rb
+  my_other_domain/
+    ... # other pack's have a similar structure
+  my_other_other_domain/
+    ...
 ```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install stimpack
 
 ## Usage
 
-TODO: Write usage instructions here
+Setting up `stimpack` is straightforward. Simply by including `stimpack` in your `Gemfile` in all environments, `stimpack` will automatically hook into and configure Rails.
 
-## Development
+From there, you can create a `./packs` folder and structure it using the conventions listed above.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+If you wish to use a different directory name, eg `components` instead of `packs`, you can customize this in your `config/application.rb` file:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+# Customize Stimpack's root directory. Note that this has to be done _before_ the Application
+# class is declared.
+Stimpack.config.root = "components"
+
+module MyCoolApp
+  class Application < Rails::Application
+    # ...
+  end
+end
+```
 
-## Contributing
+### Making your Package an Engine
+Add `engine: true` to your `package.yml` to make it an actual Rails engine:
+```yml
+# packs/my_pack/package.yml
+enforce_dependencies: true
+enforce_privacy: true
+metadata:
+  engine: true
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ngan/stimpack.
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/Gusto/stimpack.

data/lib/stimpack/integrations/factory_bot.rb

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

data/lib/stimpack/integrations/rails.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Stimpack
+  module Integrations
+    class Rails
+      def self.install(app)
+        Stimpack.config.paths.freeze
+
+        Packs.each do |pack|
+          Stimpack.config.paths.each do |path|
+            app.paths[path] << pack.path.join(path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stimpack/integrations/rspec.rb

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

data/lib/stimpack/integrations.rb

@@ -0,0 +1,9 @@
+require "active_support"
+
+module Stimpack
+  module Integrations
+    autoload :FactoryBot, "stimpack/integrations/factory_bot"
+    autoload :Rails, "stimpack/integrations/rails"
+    autoload :RSpec, "stimpack/integrations/rspec"
+  end
+end

data/lib/stimpack/pack/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+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 ||= YAML.load_file(@path).fetch(KEY, {}).freeze
+      end
+    end
+  end
+end

data/lib/stimpack/pack.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Stimpack
+  class Pack
+    PACKAGE_FILE = "package.yml"
+
+    autoload :Configuration, "stimpack/pack/configuration"
+
+    attr_reader :name
+    attr_reader :path
+    attr_reader :engine
+
+    def self.create(path)
+      new(path) if path.join(PACKAGE_FILE).exist?
+    end
+
+    def initialize(path)
+      @path = path
+      @name = path.relative_path_from(Packs.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(path.join(PACKAGE_FILE))
+    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/packs.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "pathname"
+require "rails"
+
+module Stimpack
+  module Packs
+    class << self
+      def root
+        @root ||= Rails.root.join(Stimpack.config.root)
+      end
+
+      def resolve
+        # Gather all the packs under the root directory and create packs.
+        root.children.select(&:directory?).sort!.each do |path|
+          next unless pack = Pack.create(path)
+          @packs[pack.name] = pack
+        end
+        @packs.freeze
+      end
+
+      def find(path)
+        path = "#{path}/"
+
+        @packs.values.find do |pack|
+          path.start_with?("#{pack.path}/")
+        end
+      end
+
+      def [](name)
+        @packs[name]
+      end
+
+      def each(*args, &block)
+        @packs.each_value(*args, &block)
+      end
+    end
+
+    @packs = {}
+  end
+end

data/lib/stimpack/railtie.rb

@@ -0,0 +1,10 @@
+require "rails"
+
+module Stimpack
+  class Railtie < Rails::Railtie
+    config.before_configuration do |app|
+      Stimpack.load(app)
+      ActiveSupport.run_load_hooks(:stimpack, Packs)
+    end
+  end
+end

data/lib/stimpack/stim.rb

@@ -0,0 +1,35 @@
+module Stimpack
+  class Stim < Module
+    def initialize(pack, namespace)
+      @pack = pack
+      @namespace = namespace
+      super()
+    end
+
+    def included(engine)
+      engine.called_from = @pack.path
+      engine.extend(ClassMethods)
+      engine.isolate_namespace(@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.config.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
+    end
+
+    module ClassMethods
+      def find_root(_from)
+        called_from
+      end
+    end
+  end
+end

data/lib/stimpack/version.rb

@@ -1,3 +1,3 @@
 module Stimpack
-  VERSION = "0.0.1.alpha1"
+  VERSION = "0.3.0".freeze
 end

data/lib/stimpack.rb

@@ -1,6 +1,48 @@
-require "stimpack/version"
+require "active_support"
 
 module Stimpack
+  extend ActiveSupport::Autoload
+
+  autoload :Integrations
+  autoload :Pack
+  autoload :Packs
+  autoload :Railtie
+  autoload :Stim
+
   class Error < StandardError; end
-  # Your code goes here...
+
+  class << self
+    attr_reader :config
+
+    def load(app)
+      Packs.resolve
+
+      Integrations::Rails.install(app)
+      Integrations::FactoryBot.install(app)
+      Integrations::RSpec.install(app)
+    end
+
+    def [](name)
+      Packs[name.to_s]
+    end
+  end
+
+  @config = ActiveSupport::OrderedOptions.new
+  @config.root = "packs".freeze
+  @config.paths = %w(
+    app
+    app/controllers
+    app/channels
+    app/helpers
+    app/models
+    app/mailers
+    app/views
+    lib
+    lib/tasks
+    config
+    config/locales
+    config/initializers
+  )
 end
+
+require "stimpack/railtie"

metadata

@@ -1,16 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: stimpack
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ngan Pham
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
-dependencies: []
-description: Name hold for upcoming gem
+date: 2022-03-08 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,6 +63,15 @@ files:
 - bin/console
 - bin/setup
 - lib/stimpack.rb
+- lib/stimpack/integrations.rb
+- 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/stim.rb
 - lib/stimpack/version.rb
 homepage: https://github.com/Gusto/stimpack
 licenses: []
@@ -28,7 +79,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
@@ -36,15 +87,15 @@ 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:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
-summary: Name hold for upcoming gem
+summary: A Rails helper to package your code.
 test_files: []