stimpack 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a182ce65cfc7f331c0b8aab98cb9f66f74e24b2892f07759b6fc0663d2ed9d2
-  data.tar.gz: cfbdf8284d0b3c054c2708bd69bfc0eb63341044e93ca064cf9971b17e391a06
+  metadata.gz: e6ad8e03da3ba828985b82eccb3840f6f4122d5fe38bcbc7905734a566c7d4cc
+  data.tar.gz: cba30db4834bd3e056ea19c76067945d73378c799b603f1cc931d43ac409cf59
 SHA512:
-  metadata.gz: 7dfc2c8a19b50159cddb6f5ace4a593e8f69d8719ee607c3994fed1b1541cfb639fa1bba1bb458eff632487cf65e84181899bd3c3343192ddd5f03abd6f8bd7a
-  data.tar.gz: 1c7f5dce375f55b6733ac771d86f3799aa408335e0d17b11cff6c9e7d47e7ff6d53ccd54c5f944419bad9a9eda2a0c2146c4048dcf26ff643e056119302fb66c
+  metadata.gz: d38f3c326b2fa6f327de5b0d2da6e77c1ea58e54c28df8e51887247743699ad3f8cc5e4dc5f769c50eaa80011a6ee8374fd21c4173e3c5c0b59a26ebb9609f82
+  data.tar.gz: 20bd2048490efd0eaa00380263c31c98e1eededa46458e61195c62b4f2c2f4102db1f080eb03efaf3f9496bd5d1777ec06f48109d1cf2dab52332900e41cde98

data/README.md

@@ -1,6 +1,6 @@
 # Stimpack
 
-`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.
+`stimpack` establishes and implements a set of conventions for splitting up large monoliths built on top of [`packwerk`](https://github.com/Shopify/packwerk). With `stimpack`, new packages' autoload paths are automatically added to Rails, so your code will immediately become usable and loadable without additional configuration.
 
 Here is an example application that uses `stimpack`:
 ```
@@ -24,12 +24,12 @@ packs/
         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/
+    config/
+      initializers/ # Initializers can live in packs and load as expected
+    lib/
+      tasks/
     spec/ # With stimpack, specs for a pack live next to the pack
       public/
         my_domain_spec.rb
@@ -71,6 +71,17 @@ module MyCoolApp
 end
 ```
 
+### Splitting routes
+`stimpack` allows you to split your application routes for every pack. You just have to create a file describing your routes and then `draw` them in your root `config/routes.rb` file.
+
+```ruby
+# packs/my_domain/config/routes/my_domain.rb
+resources :my_resource
+
+# config/routes.rb
+draw(:my_domain)
+```
+
 ### Making your Package an Engine
 Add `engine: true` to your `package.yml` to make it an actual Rails engine:
 ```yml

data/bin/tapioca

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/lib/stimpack/integrations/rspec.rb

@@ -3,6 +3,13 @@ module Stimpack
     class RSpec
       def self.install(app)
         return unless defined?(::RSpec)
+        # Sometimes, the `rspec-rails` gem is installed in the development
+        # group. This means the ::RSpec module will be defined. However, this
+        # doesn't mean that we've loaded rspec-core, or even about to run tests.
+        # Let's make sure we are actually loading the test environment before
+        # installing our integration. An easy of doing this is seeing of the
+        # configuration method exists on RSpec.
+        return unless ::RSpec.respond_to?(:configuration)
 
         Packs.each do |pack|
           ::RSpec.configuration.pattern.concat(",#{pack.relative_path.join("spec/**/*_spec.rb")}")

data/lib/stimpack/pack/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "yaml"
+
 module Stimpack
   class Pack
     class Configuration
@@ -17,7 +19,11 @@ module Stimpack
       private
 
       def data
-        @data ||= YAML.load_file(@path).fetch(KEY, {}).freeze
+        @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

data/lib/stimpack/packs.rb

@@ -12,8 +12,9 @@ module Stimpack
       end
 
       def resolve
-        # Gather all the packs under the root directory and create packs.
-        root.children.select(&:directory?).sort!.each do |path|
+        # Gather all the parent packs and the children packs.
+        package_locations = root.glob('*/{package.yml,*/package.yml}').map(&:dirname)
+        package_locations.sort!.each do |path|
           next unless pack = Pack.create(path)
           @packs[pack.name] = pack
         end

data/lib/stimpack/railtie.rb

@@ -4,6 +4,8 @@ module Stimpack
   class Railtie < Rails::Railtie
     config.before_configuration do |app|
       Stimpack.load(app)
+      # This is not used within stimpack. Rather, this allows OTHER tools to
+      # hook into Stimpack via ActiveSupport hooks.
       ActiveSupport.run_load_hooks(:stimpack, Packs)
     end
   end

data/lib/stimpack/version.rb

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

data/lib/stimpack.rb

@@ -42,6 +42,7 @@ module Stimpack
     config
     config/locales
     config/initializers
+    config/routes
   )
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimpack
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ngan Pham
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2022-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,7 +52,50 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Package your code.
+- !ruby/object:Gem::Dependency
+  name: debug
+  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: sorbet
+  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: tapioca
+  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: stimpack establishes and implements a set of conventions for splitting
+  up large monoliths.
 email:
 - gusto-opensource-buildkite@gusto.com
 executables: []
@@ -62,6 +105,7 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- bin/tapioca
 - lib/stimpack.rb
 - lib/stimpack/integrations.rb
 - lib/stimpack/integrations/factory_bot.rb
@@ -79,7 +123,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
@@ -94,8 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: A Rails helper to package your code.
 test_files: []