automatic_namespaces 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4591f54c57c3df9887c0321b7105e03873f7f922576b9cbc6385dae4c40a1c11
-  data.tar.gz: 3f478d56630b968d7b22d4f3feac07eadd9ed22535667a34d824fa8e3067f929
+  metadata.gz: e7aa390b64ae64d8c78d9b6ac2af5bd2e98d0c63007220eccba244f90ed3c674
+  data.tar.gz: 9acd543871604473d1ac25ca14d64e48873c18c7265ea4c9641def935737ecb4
 SHA512:
-  metadata.gz: 2c8c2b1df45d0a7e6273a7f2b01ad521d87bd5ede3ca5f2e47107981191f4949c9fb997fe93478f97daf256b3499271ddd9ab865940940d82196795a01e7a9ee
-  data.tar.gz: 7f6c638a11fc1c3ec1b70591f3f18e8d60f49c18f07e051281bd8c002da15b645ef9e34b9869b8eecebb398a72b4987652b48d01252541d974f8bde358c3a5bc
+  metadata.gz: 0b2c495a8cd14320988c3ee06a760f913611f1e2f5cf82d14ec0ba01d276b85bd00a8d404b1d6bed6e37a1a0ba454a76a1bfda15327fb445798751d03fef425d
+  data.tar.gz: df329e6def590f4714ef782ab235d82a89daee0fbf2cf3291527e1bd3cf719f24e7bb75981c40d659db98dc31140e3f4732b867eccf888d3daf6a966e06a51e4

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
 ```
@@ -85,10 +85,21 @@ generally contain namespaced classes. These are exempted from `automatic_namespa
 * javascript
 * views
 
+Additional directories can be excluded by adding them to the `automatic_pack_namespace_exclusions` key in your 
+`package.yml` file. This is useful if you require files in your pack that sit outside of your packs namespace:
+
+```yml
+metadata:
+  automatic_pack_namespace: true
+  automatic_pack_namespace_exclusions:
+    - app/policies # Exclude pundit policies
+    - app/admin # Exclude active admin definition files
+```
+
 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
@@ -98,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

@@ -1,35 +1,42 @@
 require 'yaml'
 
 class AutomaticNamespaces::Autoloader
+  DEFAULT_EXCLUDED_DIRS = %w[/app/helpers /app/inputs /app/javascript /app/views].freeze
+  PACKAGE_EXCLUDED_DIRS_KEY = "automatic_pack_namespace_exclusions".freeze
 
   def enable_automatic_namespaces
     namespaced_packages.each do |pack, metadata|
-      package_namespace = define_namespace(pack, metadata)
-      pack_directories(pack.path).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)
     Rails.application.config.watchable_dirs[pack_dir] = [:rb]
   end
 
-  def pack_directories(pack_root_dir)
-    Dir.glob("#{pack_root_dir}/**/app/*").reject { |dir| non_namspaced_directory(dir) }
+  def pack_directories(pack_root_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)
+    excluded_directories(metadata).none? { |excluded_dir| dir.include?(excluded_dir) }
   end
 
-  def non_namspaced_directory(dir)
-    dir.include?('/app/assets') ||
-      dir.include?('/app/helpers') || # Rails assumes helpers are global, not namespaced
-      dir.include?('/app/inputs') || # Not sure how to namespace form inputs
-      dir.include?('/app/javascript') ||
-      dir.include?('/app/views')
+  def excluded_directories(metadata)
+    DEFAULT_EXCLUDED_DIRS + metadata.fetch(PACKAGE_EXCLUDED_DIRS_KEY, [])
   end
 
   def define_namespace(pack, metadata)
@@ -59,7 +66,3 @@ class AutomaticNamespaces::Autoloader
     package_description["metadata"]
   end
 end
-
-
-
-

data/lib/automatic_namespaces/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: automatic_namespaces
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Gary Passero
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
+date: 2025-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - gpassero@gmail.com
 executables: []
@@ -114,7 +114,7 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Modify autoloading to assume all files within a directory belong in a namespace
 test_files: []