packs-rails 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86b24d9e3e2adf0c50759fd39ec774e7d2b9e15776856b2ec0da408cc23c2994
-  data.tar.gz: 91271c3dd67896da4f43f402af7a487e26127724e8227af7984cd0a8c0471f6f
+  metadata.gz: c4b16ad1fd38eabdd5c57a587cf893991dc3d67a84bc0111f04e647d67878b63
+  data.tar.gz: bfaaaee8ef07fd9dbf5f7056133c18f294095a3db369cc56d10ffa0f8c0edd0d
 SHA512:
-  metadata.gz: b61003f0dcb3b03c95fa58b5867937d663d09d7a6554a39a9f536a9b06b43fd1ef658fe1f02eafac25ae80e893ae9fa238af95f3c3962298536e7c1926701754
-  data.tar.gz: be3f59f451118f069e4e697554b668a3b161b5686222ebd013b00f3359dbb798c2cb68a98fea01def41ceb1a743538d8c4963f9cd5cca5d9ba33d5bbcf46fc92
+  metadata.gz: 424e39b8c152ee19afb8b85ac5a393145bef1315a7a88acf3fd55bf18033503d4a817313543d397c3b2210013de9aa765a1831f63ee4ffa8a6e5c45e95653e03
+  data.tar.gz: f99f87275c735db75b54dac68001fb3dedef117906b7cd20e6b392df96d200348961e69591fb8979784e855f39526a3cabe372f5626f73d95e5bc8b7b823d4cf

data/README.md

@@ -11,7 +11,7 @@ app/ # Unpackaged code
 packs/
   my_domain/
     package.yml # See the packwerk docs for more info
-    deprecated_references.yml # See the packwerk docs for more info
+    package_todo.yml # See the packwerk docs for more info
     app/
       public/ # Recommended location for public API
         my_domain.rb # creates the primary namespaces
@@ -42,7 +42,7 @@ packs/
         some_other_non_namespaced_private_model_spec.rb
         my_domain/
           my_private_namespaced_model_spec.rb
-      factories/ # packs-rails will automatically load pack factories into FactoryBot
+      factories/ # packs-rails will automatically load pack factories into FactoryBot, see Ecosystem and Integrations#factory_bot below
         my_domain/
           my_private_namespaced_model_factory.rb
   my_other_domain/
@@ -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
@@ -111,6 +125,31 @@ rspec packs/foobar/spec
 rspec packs/foobar/nested_pack
 ```
 
+#### factory_bot and factory_bot_rails
+
+Ensure you have the gem in your Gemfile, and that `require: false` is not present, otherwise the `packs-rails` FactoryBot integration will not be run upon application/environment load.
+This integration will automatically add the `[spec|test]/factories` directory from each pack to the application's `config.factory_bot.definition_file_paths`.
+
+Using the example application above:
+```
+...
+packs/
+  my_domain/
+    ...
+    spec/ # OR test/
+      ...
+      factories/
+        my_domain/
+          my_private_namespaced_model_factory.rb
+  my_other_domain/
+    ...
+    spec/ # OR test/
+      ...
+      factories/
+        my_other_domain/
+          my_private_namespaced_model_factory.rb
+```
+
 #### parallel_tests
 
 `parallel_tests` has it its own spec discovery mechanism, so packs-rails's RSpec integration doesn't do anything when you use them together.

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

@@ -11,6 +11,7 @@ module Packs
         # hook into packs-rails via ActiveSupport hooks.
         ActiveSupport.run_load_hooks(:packs_rails, Packs)
       end
+      
     end
   end
 end

data/lib/packs/rails/version.rb

@@ -1,5 +1,5 @@
 module Packs
   module Rails
-    VERSION = "0.0.3".freeze
+    VERSION = "0.0.5".freeze
   end
 end

metadata

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