automatic_namespaces 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4127c0936ad000fe4b361c619dbd3d1b78a43d975d3d048432d93fd6d0f9f597
+  data.tar.gz: 6ad52407e24da1ab14e9264d16c7fd388db5a5eba94935ae8964689ed0280396
+SHA512:
+  metadata.gz: 274f7b77c5340a6be552e7ba39a877336b04c63ff7126e472b2ca5244ca547e4d6ccb622606e44caebf49a707457da87efe0207870febb3f539111b4a716d71e
+  data.tar.gz: 2309e8898758ccc3d31157b55d035f4091e55b25693a58f72af57b53eba41712801bd07f1e27c727bbcd98083e68e604954cebc628e4857578b0927b3f7473bb

data/README.md

@@ -0,0 +1,125 @@
+# AutomaticNamespaces
+
+This gem eases some pain related to strong namespaces in a modular monolith. 
+
+By default, Rails 7 autoloader (Zeitwerk) requires a separate "namespace" directory above a namespaced class. For example:
+
+```
+app
+├── models
+│   ├── component1
+│   │   ├── class1.rb       # contains Component1::Class1
+```
+
+When building a modular monolith using packages ([packwerk](https://github.com/Shopify/packwerk) + [stimpack](https://github.com/rubyatscale/stimpack)), 
+this pattern creates a lot of extra noise in the directory structure:
+
+```
+packs
+├── component1
+│   ├── app
+│   │   ├── controllers
+│   │   │   ├── component1
+│   │   │   │   ├── model1_controller.rb  # contains Component1::Model1Controller
+│   │   │   │   ├── model2_controller.rb  # contains Component1::Model2Controller
+│   │   ├── models
+│   │   │   ├── component1
+│   │   │   │   ├── model1.rb             # contains Component1::Model1
+│   │   │   │   ├── model2.rb             # contains Component1::Model2
+│   │   ├── public
+│   │   │   ├── component1
+│   │   │   │   ├── public_type1.rb       # contains Component1::PublicType1
+│   │   │   │   ├── public_type2.rb       # contains Component1::PublicType2
+│   │   ├── services
+│   │   │   ├── component1
+│   │   │   │   ├── service1.rb           # contains Component1::Service1
+│   │   │   │   ├── service2.rb           # contains Component1::Service2
+```
+
+And that's only for a single pack! As your modular monolith grows, you'll likely have dozens (maybe you'll have 
+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 
+automatically associated with the namespace. 
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add automatic_namespaces
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install automatic_namespaces
+
+## Usage
+
+Given the `package.yml` of a strongly namespaced pack:
+
+```
+enforce_dependencies: true
+enforce_privacy: true
+public_path: app/public/
+dependencies:
+ - "packs/components/core_ui"
+ - "packs/components/core_ext"
+ - "packs/components/us_states"
+ - "packs/subsystems/products"
+ - "packs/subsystems/inventory"
+metadata:
+```
+
+modify the metadata to opt into automatic namespacing:
+
+```
+metadata:
+ automatic_pack_namespace: true
+```
+
+Now restructure your files to remove the extra namespace directories under `app`. Note that some directories do not 
+generally contain namespaced classes. These are exempted from `automatic_namespaces`:
+
+* assets
+* helpers
+* javascript
+* views
+
+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:
+
+```
+# packs/shoes_ui/package.yml
+metadata:
+  automatic_pack_namespace: true
+  namespace_override: ShoesUI
+```
+
+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.
+
+## Development
+
+After checking out the repo, run `bundle instal` 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).
+
+## Credits
+
+Thanks to a handful of individuals who directly contributed to the creation of this gem:
+
+* [Caleb Woods](https://github.com/alexevanczuk) - For feeling the pain and helping to spike an approach during a project kickoff at [RoleModel Software](www.rolemodelsoftware.com)
+* [Alex Evanczuk](https://github.com/alexevanczuk) - For being willing to collaborate on the project, helping to refine the approach, and even mentoring me on how to create my first gem for sharing with others. 
+* [Xavier Noria](https://github.com/fxn) - For his suggestions on how to patch Zeitwerk to make this work at all, and for suggestions on how to keep hot reloading working after Rails autopaths were missing all pack directories. 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gap777/automatic_namespaces. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/gap777/automatic_namespaces/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AutomaticNamespaces project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gap777/automatic_namespaces/blob/main/CODE_OF_CONDUCT.md).

data/lib/automatic_namespaces/autoloader.rb

@@ -0,0 +1,56 @@
+require 'yaml'
+
+class AutomaticNamespaces::Autoloader
+
+  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
+    end
+  end
+
+  private
+
+  def set_namespace_for(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) }
+  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')
+  end
+
+  def define_namespace(pack, metadata)
+    namespace = metadata['namespace_override'] || pack.name.camelize
+    Object.const_set(namespace, Module.new)
+    namespace.constantize
+  end
+
+  def namespaced_packages
+    Stimpack::Packs.all
+                   .map {|pack| [pack, package_metadata(pack)] }
+                   .select {|pack, metadata| metadata && metadata["automatic_pack_namespace"] }
+  end
+
+  def package_metadata(pack)
+    package_file = pack.path.join('package.yml').to_s
+    package_description = YAML.load_file(package_file) || {}
+    package_description["metadata"]
+  end
+end
+
+
+
+

data/lib/automatic_namespaces/railtie.rb

@@ -0,0 +1,9 @@
+require "rails/railtie"
+
+module AutomaticNamespaces
+  class Railtie < Rails::Railtie
+    initializer 'automatic_namespaces' do
+      Autoloader.new.enable_automatic_namespaces
+    end
+  end
+end

data/lib/automatic_namespaces/version.rb

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

data/lib/automatic_namespaces.rb

@@ -0,0 +1,17 @@
+
+require "active_support"
+require_relative "automatic_namespaces/version"
+require_relative "automatic_namespaces/autoloader"
+
+module AutomaticNamespaces
+
+  class Error < StandardError; end
+  extend ActiveSupport::Autoload
+
+  autoload :Autoloader
+  autoload :Railtie
+
+  private_constant :Autoloader
+end
+
+require "automatic_namespaces/railtie"

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: automatic_namespaces
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Gary Passero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stimpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- gpassero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/automatic_namespaces.rb
+- lib/automatic_namespaces/autoloader.rb
+- lib/automatic_namespaces/railtie.rb
+- lib/automatic_namespaces/version.rb
+homepage: https://github.com/gap777/automatic_namespaces
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gap777/automatic_namespaces
+  source_code_uri: https://github.com/alexevanczuk/my_example_gem
+  changelog_uri: https://github.com/alexevanczuk/my_example_gem/releases
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Modify autoloading to assume all files within a directory belong in a namespace
+test_files: []