stimpack 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77c100a2db422cb489d3405605ad303d16f83881a5a7fc041217e424672ce6fa
-  data.tar.gz: 3bb479b3ff75547dc957609dad9b9bb109a3e6396f220d5f0bf04056d5ea8fb9
+  metadata.gz: 3cb6166834b2ea8ebd3623491464ee321b457fc4347c7f8af80e8efa47c18785
+  data.tar.gz: b165b651e620abd0197c509070049a2f9ff5523f2b5c4ab32b2b7d26392c8b16
 SHA512:
-  metadata.gz: '059c1b11d33c8d26d3c08deff15d2864cba2484fae0d62e33042d6feb88a9f40a869522f93847b5bcdb4d654eebf6f1337979e288ad5bce047e104aa83718d21'
-  data.tar.gz: 42bab45829e429e543e898cdece963e185e53adbc692611f5ddaacaafcccd4e03376cd4cba1a3dc8f6872d66808127fa8d8c05d49e911e3181eef7abe2d32707
+  metadata.gz: 81f1124b9c8901a6a681f00385f9a5d67c48d035925c241b69ab68f0c9745d7b4c15decd45d59b1fceb6d9b552ec23c4431f900a230f77ef1954c5edba740bf0
+  data.tar.gz: e4c881c3356dab09454183967508051133a1054054fc10dc9106cae7fb5b2ef3378ff5c68da93dcfb119e55004144cb539c70ebf8c875ca9e301a4ecdafd2e94

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/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/railtie.rb

@@ -4,7 +4,7 @@ module Stimpack
   class Railtie < Rails::Railtie
     config.before_configuration do |app|
       Stimpack.load(app)
-      ActiveSupport.run_load_hooks(:stimpack, yield: Packs)
+      ActiveSupport.run_load_hooks(:stimpack, Packs)
     end
   end
 end

data/lib/stimpack/version.rb

@@ -1,3 +1,3 @@
 module Stimpack
-  VERSION = "0.1.0".freeze
+  VERSION = "0.4.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.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ngan Pham
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails