automatic_namespaces 0.4.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eabe8d9d26c2bf99b74b99a047bfb6445eee106a7437571c7062cc163f9f13bf
-  data.tar.gz: 21153b5fe8d5ce982f70964970ad448d75974506435ab67a49f03e881609cb3a
+  metadata.gz: 748dacb562a8622a1288a39b7036364a09cb0a8a5e19b2862a3e1145bd7f5549
+  data.tar.gz: abe1ffc72d71e4bd1f49bab3ea60066a43e3ab8e61ee7304f9fbe400bedc206f
 SHA512:
-  metadata.gz: 6e9e6b77583f244650d94c09cf20d41fd8d1b6ec8ed1f95dd9f6345cfef05e588700b03ca8dad75c5b0ebf0cd12328ef1d75f0a975524cb4874face90a3e03c1
-  data.tar.gz: 2e19e2aacb6dd786ac9aacc14cfebd9a0104f5e3fcd5e66dc8916f98c917321911ead978f822ae350ec5dbb054455c6d8a363515f3176198200f36e8d335e686
+  metadata.gz: 2b2b6df942abf3c07bb88d3c2338e6614bc799d926adfac6271c70df6484ae58ae2d0cdd5cbfc861c7a364442bd84fefb9b93462b677923b506641426f4cb750
+  data.tar.gz: a68100758eda2db63a1c917e567c2a5d33591f47c9b09b14848d00bd4abc22f37ecaf70575e8c562d491dcd7de0fb439f2fa025e39323267160a1b7d07fc513b

data/README.md

@@ -11,7 +11,7 @@ app
 │   │   ├── class1.rb       # contains Component1::Class1
 ```
 
-When building a modular monolith using packages ([packwerk](https://github.com/Shopify/packwerk) + [stimpack](https://github.com/rubyatscale/stimpack)), 
+When building a modular monolith using packages ([packwerk](https://github.com/Shopify/packwerk) + [packs-rails](https://github.com/rubyatscale/packs-rails)), 
 this pattern creates a lot of extra noise in the directory structure:
 
 ```
@@ -40,7 +40,7 @@ And that's only for a single pack! As your modular monolith grows, you'll likely
 hundreds) of packs. That's a lot of "namespace" directories that aren't adding a lot of value. You already 
 know the namespace of those classes in a strongly namespaced pack -- it's the pack name -- can Zeitwerk know it, too?
 
-This gem patches the Rails 7 autoloader so that most subdirectories under your strongly namespaced component's `app` directory are 
+This gem configures the Rails 7 autoloader so that most subdirectories under your strongly namespaced component's `app` directory are 
 automatically associated with the namespace. 
 
 ## Installation
@@ -57,7 +57,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 Given the `package.yml` of a strongly namespaced pack:
 
-```
+```yml
 enforce_dependencies: true
 enforce_privacy: true
 public_path: app/public/
@@ -72,7 +72,7 @@ metadata:
 
 modify the metadata to opt into automatic namespacing:
 
-```
+```yml
 metadata:
  automatic_pack_namespace: true
 ```
@@ -99,7 +99,7 @@ metadata:
 If your package / namespace name requires ActiveSupport inflections, you will probably need to tell `automatic_namespaces`
 what the correct namespace name should be in that package:
 
-```
+```yml
 # packs/shoes_ui/package.yml
 metadata:
   automatic_pack_namespace: true
@@ -109,9 +109,19 @@ metadata:
 This is necessary because `automatic_namespaces` works by modifying the autoloader paths, which has to 
 happen during Rails application initialization; but the inflector is not available for use then.
 
+If you would like to use your own file layout conventions for packs (i.e. not `app/*`) you can specify 
+your own glob by using `autoload_glob` to append the glob to the folder containing package.yml. This defaults
+to `'/**/app/*'` 
+
+```yml
+metadata:
+  # Put the folder containing package.yml as the root for the autoloader.
+  autoload_glob: ''
+```
+
 ## Development
 
-After checking out the repo, run `bundle instal` to install dependencies. Then, run `rspec` to run the tests. 
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rspec` to run the tests. 
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/automatic_namespaces/autoloader.rb

@@ -6,16 +6,20 @@ class AutomaticNamespaces::Autoloader
 
   def enable_automatic_namespaces
     namespaced_packages.each do |pack, metadata|
-      package_namespace = define_namespace(pack, metadata)
-      pack_directories(pack.path, metadata).each do |pack_dir|
-        set_namespace_for(pack_dir, package_namespace)
-      end
+      set_namespace_for_pack(pack, metadata)
+    end
+  end
+
+  def set_namespace_for_pack(pack, metadata)
+    package_namespace = define_namespace(pack, metadata)
+    pack_directories(pack.path, metadata).each do |pack_dir|
+      set_namespace_for_dir(pack_dir, package_namespace)
     end
   end
 
   private
 
-  def set_namespace_for(pack_dir, package_namespace)
+  def set_namespace_for_dir(pack_dir, package_namespace)
     Rails.logger.debug { "Associating #{pack_dir} with namespace #{package_namespace}" }
     ActiveSupport::Dependencies.autoload_paths.delete(pack_dir)
     Rails.autoloaders.main.push_dir(pack_dir, namespace: package_namespace)
@@ -23,7 +27,8 @@ class AutomaticNamespaces::Autoloader
   end
 
   def pack_directories(pack_root_dir, metadata)
-    Dir.glob("#{pack_root_dir}/**/app/*").select { |dir| namespaced_directory?(dir, metadata) }
+    glob = metadata['autoload_glob'] || "/**/app/*"
+    Dir.glob("#{pack_root_dir}#{glob}").select { |dir| namespaced_directory?(dir, metadata) }
   end
 
   def namespaced_directory?(dir, metadata)

data/lib/automatic_namespaces/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AutomaticNamespaces
-  VERSION = "0.4.0"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: automatic_namespaces
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Gary Passero
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-06 00:00:00.000000000 Z
+date: 2025-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,7 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
 email:
 - gpassero@gmail.com
 executables: []
@@ -114,7 +112,6 @@ metadata:
   source_code_uri: https://github.com/gap777/automatic_namespaces
   changelog_uri: https://github.com/gap777/automatic_namespaces/releases
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -129,8 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Modify autoloading to assume all files within a directory belong in a namespace
 test_files: []