automatic_namespaces 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4591f54c57c3df9887c0321b7105e03873f7f922576b9cbc6385dae4c40a1c11
-  data.tar.gz: 3f478d56630b968d7b22d4f3feac07eadd9ed22535667a34d824fa8e3067f929
+  metadata.gz: eabe8d9d26c2bf99b74b99a047bfb6445eee106a7437571c7062cc163f9f13bf
+  data.tar.gz: 21153b5fe8d5ce982f70964970ad448d75974506435ab67a49f03e881609cb3a
 SHA512:
-  metadata.gz: 2c8c2b1df45d0a7e6273a7f2b01ad521d87bd5ede3ca5f2e47107981191f4949c9fb997fe93478f97daf256b3499271ddd9ab865940940d82196795a01e7a9ee
-  data.tar.gz: 7f6c638a11fc1c3ec1b70591f3f18e8d60f49c18f07e051281bd8c002da15b645ef9e34b9869b8eecebb398a72b4987652b48d01252541d974f8bde358c3a5bc
+  metadata.gz: 6e9e6b77583f244650d94c09cf20d41fd8d1b6ec8ed1f95dd9f6345cfef05e588700b03ca8dad75c5b0ebf0cd12328ef1d75f0a975524cb4874face90a3e03c1
+  data.tar.gz: 2e19e2aacb6dd786ac9aacc14cfebd9a0104f5e3fcd5e66dc8916f98c917321911ead978f822ae350ec5dbb054455c6d8a363515f3176198200f36e8d335e686

data/README.md

@@ -85,6 +85,17 @@ 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:
 

data/lib/automatic_namespaces/autoloader.rb

@@ -1,11 +1,13 @@
 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|
+      pack_directories(pack.path, metadata).each do |pack_dir|
         set_namespace_for(pack_dir, package_namespace)
       end
     end
@@ -20,16 +22,16 @@ class AutomaticNamespaces::Autoloader
     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)
+    Dir.glob("#{pack_root_dir}/**/app/*").select { |dir| namespaced_directory?(dir, metadata) }
   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 namespaced_directory?(dir, metadata)
+    excluded_directories(metadata).none? { |excluded_dir| dir.include?(excluded_dir) }
+  end
+
+  def excluded_directories(metadata)
+    DEFAULT_EXCLUDED_DIRS + metadata.fetch(PACKAGE_EXCLUDED_DIRS_KEY, [])
   end
 
   def define_namespace(pack, metadata)
@@ -59,7 +61,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.4.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.4.0
 platform: ruby
 authors:
 - Gary Passero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport