packs-rails 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 933735a6316c8d68f6d52952ea6748eacc3ca256e53319bed4fd4ea21ecc72b2
-  data.tar.gz: 5cf3dbc2495f75c20f599f7cd3ef0d87205b595aee5255f672f34e5308d4c2f2
+  metadata.gz: 0c9a4e816b8efb6891cf9b373c7c099b28a3d2f17d4f240d1177182698e1e791
+  data.tar.gz: 9e1428992751e466c6cefb19230c1b0e5f0bad323b5740951e18e5e3e68604ca
 SHA512:
-  metadata.gz: 5041bca28225bd6dfde297ab985c17dd0ff3ecc04f11565ec23faa72958997db2200df20605d6ed91919a0c4f5f9e5a9dca35271eacbdd66c546098a68b6702b
-  data.tar.gz: 4ca3fb43d679613bdfa5e70e4d5cf3924787ccea379cdbaabd53895c8313a43b820311263f951aecd8200eac4c6c3d4c4ae05bf04ab40b985d9c16d751dfed50
+  metadata.gz: c7400fe1e63caf68bc2ade9b562f9ebc5562bc661bd6a31093356a17a46161610e4807df6aa0d8bb10318e13420fd75fff628dfe70b5312e0241e343bdd96d15
+  data.tar.gz: a329905ac9d4aa3de0d6b650d3acca0c7c917ef615de2c439ba61f440b4d33e998f5c5c0c6257ac165df060e5df16c8c46f6d1658211cc18b3dd9f227c272d16

data/README.md

@@ -23,7 +23,7 @@ packs/
       models/ # Private models
         some_other_non_namespaced_private_model.rb # this works too
         my_domain/
-          my_private_namespacd_model.rb
+          my_private_namespaced_model.rb
       controllers/
       views/
     config/
@@ -53,21 +53,23 @@ packs/
 
 ## Usage
 
-Setting up `packs-rails` is straightforward. Simply by including `packs-rails` in your `Gemfile` in all environments, `packs-rails` will automatically hook into and configure Rails.
+Setting up `packs-rails` is straightforward. Simply by including `packs-rails` in your `Gemfile` in **all environments**, `packs-rails` will automatically hook into and configure Rails.
 
 From there, you can create a `./packs` folder and structure it using the conventions listed above.
 
 If you wish to use a different directory name, eg `components` instead of `packs`, you can customize this by configuring `packs.yml`. See [`packs`](https://github.com/rubyatscale/packs) for more information.
 
 ### Splitting routes
-`packs-rails` 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.
+`packs-rails` 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 (NOTE: the `draw` function is only in Rails 6.1+).
 
 ```ruby
 # packs/my_domain/config/routes/my_domain.rb
 resources :my_resource
 
 # config/routes.rb
-draw(:my_domain)
+Rails.application.routes.draw do
+  draw(:my_domain)
+end
 ```
 
 ### Making your Package an Engine
@@ -80,6 +82,18 @@ metadata:
   engine: true
 ```
 
+Add `engine_name: ` to your `package.yml` to use a specific, maybe namespaced, engine name instead of the last package folder name.
+```yml
+# packs/my_pack/package.yml
+enforce_dependencies: true
+enforce_privacy: true
+metadata:
+  engine: true
+  engine_name: namespaced/my_pack
+```
+
+The engine is created as `Namespaced::MyPack::Engine` instead of `MyPack::Engine`.
+
 ## Ecosystem and Integrations
 
 ### RSpec Integration

data/lib/packs/rails/integrations/factory_bot.rb

@@ -9,6 +9,7 @@ module Packs
 
           Packs.all.reject(&:is_gem?).each do |pack|
             app.config.factory_bot.definition_file_paths << pack.relative_path.join("spec/factories").to_s
+            app.config.factory_bot.definition_file_paths << pack.relative_path.join("test/factories").to_s
           end
         end
       end

data/lib/packs/rails/integrations/rails.rb

@@ -7,6 +7,8 @@ module Packs
   module Rails
     module Integrations
       class Rails
+        CONFIG_ROUTES_PATH =  "config/routes".freeze
+
         def initialize(app)
           @app = app
 
@@ -27,6 +29,10 @@ module Packs
         def inject_paths
           Packs.all.reject(&:is_gem?).each do |pack|
             Packs::Rails.config.paths.each do |path|
+              # Prior to Rails 6.1, the "config/routes" app path is nil and was not added until drawable routes feature was implemented
+              # https://github.com/rails/rails/pull/37892/files#diff-a785e41df3f87063a8fcffcac726856a25d8eae6d1f9bca2b36989fe88613f8eR62
+              next if pre_rails_6_1? && path == CONFIG_ROUTES_PATH
+
               @app.paths[path] << pack.relative_path.join(path)
             end
           end
@@ -34,6 +40,11 @@ module Packs
 
         private
 
+        def pre_rails_6_1?
+          return @_pre_rails_6_1 if defined?(@_pre_rails_6_1)
+          @_pre_rails_6_1 = ::Rails.gem_version < Gem::Version.new("6.1")
+        end
+
         def create_namespace(name)
           namespace = ActiveSupport::Inflector.camelize(name)
           namespace.split("::").reduce(Object) do |base, mod|
@@ -46,7 +57,7 @@ module Packs
         end
 
         def create_engine(pack)
-          name = pack.last_name
+          name = pack.metadata.fetch("engine_name", pack.last_name)
           namespace = create_namespace(name)
           stim = Stim.new(pack, namespace)
           namespace.const_set("Engine", Class.new(::Rails::Engine)).include(stim)

data/lib/packs/rails/integrations/rspec.rb

@@ -16,6 +16,7 @@ module Packs
             # to the collection of directories to run.
 
             pack_paths = Packs.all.map do |pack|
+              next if pack.is_gem?
               spec_path = pack.relative_path.join(default_path)
               spec_path.to_s if spec_path.exist?
             end

data/lib/packs/rails/railtie.rb

@@ -5,12 +5,15 @@ module Packs
     class Railtie < ::Rails::Railtie
       config.before_configuration do |app|
         Integrations::Rails.new(app)
-        Integrations::FactoryBot.new(app)
-
+        
         # This is not used within packs-rails. Rather, this allows OTHER tools to
         # hook into packs-rails via ActiveSupport hooks.
         ActiveSupport.run_load_hooks(:packs_rails, Packs)
       end
+      
+      config.after_initialize do |app|
+        Integrations::FactoryBot.new(app)
+      end
     end
   end
 end

data/lib/packs/rails/version.rb

@@ -1,5 +1,5 @@
 module Packs
   module Rails
-    VERSION = "0.0.2".freeze
+    VERSION = "0.0.4".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packs-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Ngan Pham
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-01 00:00:00.000000000 Z
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties