stimpack 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51aa29c2b4753868e002f2317fa395fe14daee1f534fddea2d04eeae81feb6fe
-  data.tar.gz: 44ca94cec6bad72328db16adfb5c809c4b0f0f630bfb33ecdc9be2492cc1270a
+  metadata.gz: 4ca6d661bee358381b9fc2fc2b40b9208c52ebc279cada30b1f8cd8d416b257e
+  data.tar.gz: 03f9fa4999c375228668a02d25712c11bc904a9e41f77f3ef4298127f9c814b4
 SHA512:
-  metadata.gz: 297365c1a65d1f4e783c7ec9a13b764904eb45ef4f083516d85288b7bfdbd45d69b576c0756449d207e721c7be5a91d3e965985fa2517db6efa864ddb323e7a1
-  data.tar.gz: a2f6604cdf86b588f290b6c1b503e8883fecbbb6083a21fd03d6e815596fcada6f90c5d49cd929030f39c248cbaf32d1b1ddb7d0bb3be11493b183372f34f149
+  metadata.gz: 6744c141fc73982fda1713198e1b6ad78971167eb7546b4be64702210b0289aa15a037fbdfa5f547e9ca732ed830d5c376710e7d365276640139af31cdb05321
+  data.tar.gz: 1fac57fcffcaefcf08b54c20750db09732ba565f41d76ce6fc81ce5eb1b1a696364389ebf7377820bdc437527ee20d5b093a096bcae53b0d8af9e85af9d56e13

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/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

@@ -3,11 +3,10 @@
 module Stimpack
   class Pack
     class Configuration
-      FILE = "package.yml"
       KEY = "metadata"
 
-      def initialize(pack)
-        @pack = pack
+      def initialize(path)
+        @path = path
       end
 
       def engine
@@ -18,7 +17,7 @@ module Stimpack
       private
 
       def data
-        @data ||= YAML.load_file(@pack.path.join(FILE)).fetch(KEY, {}).freeze
+        @data ||= YAML.load_file(@path).fetch(KEY, {}).freeze
       end
     end
   end

data/lib/stimpack/pack.rb

@@ -2,12 +2,18 @@
 
 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)
@@ -22,7 +28,7 @@ module Stimpack
     end
 
     def config
-      @config ||= Configuration.new(self)
+      @config ||= Configuration.new(path.join(PACKAGE_FILE))
     end
 
     private

data/lib/stimpack/packs.rb

@@ -14,7 +14,7 @@ module Stimpack
       def resolve
         # Gather all the packs under the root directory and create packs.
         root.children.select(&:directory?).sort!.each do |path|
-          pack = Pack.new(path)
+          next unless pack = Pack.create(path)
           @packs[pack.name] = pack
         end
         @packs.freeze

data/lib/stimpack/version.rb

@@ -1,3 +1,3 @@
 module Stimpack
-  VERSION = "0.2.0".freeze
+  VERSION = "0.5.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.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ngan Pham
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,7 +52,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Package your code.
+description: stimpack establishes and implements a set of conventions for splitting
+  up large monoliths.
 email:
 - gusto-opensource-buildkite@gusto.com
 executables: []