conventional_extensions 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9c04f9382953e08d30d29f802edd622ef28f91da4314d77c21d7f0eb09f2fe
-  data.tar.gz: b51b6c673302e93aec88613b42e1e7c44a7c0d4055165057ffac546614fd357f
+  metadata.gz: '060300878dfd038ee631b86d3d16bb3a1da4ce4de8c5e4d5b0c2f58299c04447'
+  data.tar.gz: 10a0f2d7c828792caaa3d28c95856a68c77e2afb4a5f3ec8f7cdc90e7a2020a2
 SHA512:
-  metadata.gz: ed770c9838eb07f7c752bf2f1973edf9a5ad77511ec6d939600114d203a3e6db9270d5ec8ef3b354c6914728ca0afe259c128d569aef0c9639928c6c4ed36895
-  data.tar.gz: d5035eff9ad821562a828dc671927a89fffe2ad1f1fe49d91b3c3147131837ecc9c82caa8adaaf26ab48149bc92a9520a3bce514efdd11380a53ff36fa657b18
+  metadata.gz: c1bdc8bfe33c5a16454714d07a20faba6f8211cb8515856613887f21e3c6c5ce7b7119da58b90510b9078f01e8d947c1696b0b1b03b3d0882e598833e45f74b8
+  data.tar.gz: 334827497c824fba2a4bbf705612387c420311d52a093b78a3d70241ba6baa34a54729cfaa9081fcf9358ff23e14d26beba5640dba7132b553d0eaaaa7ac3ace

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 ## [Unreleased]
 
+## [0.4.0] - 2022-11-23
+
+- Ignore extensions folders automatically in Rails.
+
+  We've added a Railtie which automatically ignores every extensions folder by running `Rails.autoloaders.main.ignore "**/extensions/**.rb"`.
+
+  Fixed #8.
+
+- Remove automatic extension loading for Active Records.
+
+  Due to the automatic extension loading in Active Record, there was no way for people to manually call `load_extensions` if they wanted to. And implementation wise there wasn't a way to sort that out. So the automatic loading support is out.
+
+  Though you can get the old behavior back with this, which calls `load_extensions` when a new class inherits from `ApplicationRecord`:
+
+  ```ruby
+  # app/models/application_record.rb
+  class ApplicationRecord < ActiveRecord::Base
+    extend ConventionalExtensions.load_on_inherited
+  end
+  ```
+
+  Fixed #10.
+
 ## [0.3.0] - 2022-09-27
 
 - Fixes defining a nested extension, e.g. `Organization::User` with `app/models/organization/user/extensions/`.

data/Gemfile

@@ -8,3 +8,5 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
+
+gem "debug", "~> 1.6"

data/Gemfile.lock

@@ -1,13 +1,21 @@
 PATH
   remote: .
   specs:
-    conventional_extensions (0.3.0)
+    conventional_extensions (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    debug (1.6.3)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
+    io-console (0.5.11)
+    irb (1.4.3)
+      reline (>= 0.3.0)
     minitest (5.16.3)
     rake (13.0.6)
+    reline (0.3.1)
+      io-console (~> 0.5)
 
 PLATFORMS
   arm64-darwin-20
@@ -15,6 +23,7 @@ PLATFORMS
 
 DEPENDENCIES
   conventional_extensions!
+  debug (~> 1.6)
   minitest (~> 5.0)
   rake (~> 13.0)
 

data/README.md

@@ -7,7 +7,7 @@ The entry point is to call `load_extensions` right after a class is originally d
 ```ruby
 # lib/post.rb
 class Post < SomeSuperclass
-  load_extensions # Loads every Ruby file under `lib/post/extensions/*.rb`.
+  load_extensions # Loads every Ruby file found with `lib/post/extensions/*.rb`.
 end
 ```
 
@@ -17,7 +17,7 @@ Since the loading above happens after the `Post` constant has been defined, we c
 
 ```ruby
 # lib/post/extensions/mailroom.rb
-class Post # <- Post is reopened here and so there's no superclass mismatch error
+class Post # <- Post is reopened here, so there's no superclass mismatch error
   def mailroom
     puts "you've got mail"
   end
@@ -102,6 +102,17 @@ class Subclass < BaseClass
 end
 ```
 
+This works for Active Record too, and you can add this to your `ApplicationRecord`:
+
+```ruby
+# app/models/application_record.rb
+class ApplicationRecord < ActiveRecord::Base
+  extend ConventionalExtensions.load_on_inherited
+end
+```
+
+Note that you lose support for calling `load_extensions` manually because of the implementation, so it's all or nothing.
+
 ## A less boilerplate heavy alternative to `ActiveSupport::Concern` for Active Records
 
 Typically, when writing an app domain model with `ActiveSupport::Concern` your object graph looks like this:
@@ -143,7 +154,8 @@ With ConventionalExtensions you'd write this instead:
 
 ```ruby
 # app/models/post.rb
-class Post < ApplicationRecord # ConventionalExtensions automatically loads extensions for Active Record models.
+class Post < ApplicationRecord
+  load_extensions # Loads every Ruby file found with `app/models/post/extensions/*.rb`.
 end
 
 # app/models/post/extensions/cool.rb
@@ -167,6 +179,12 @@ There are places where concerns are more suited:
 * Multi-model concerns in `app/models/concerns`, you'd need modules to help with that.
 * Needing to include multiple levels of modules and have them all inserted directly on the base class, concerns have this built in, but ConventionalExtensions can't support that. It's a rare use case nonetheless.
 
+## Using with Zeitwerk
+
+If you're using Zeitwerk to eager load your app or lib code, you may need to ignore the nested extensions folders so Zeitwerk won't expect them to contain code following its naming conventions.
+
+We handle this for Rails through `Rails.autoloaders.main.ignore "**/extensions/**.rb"`. Feel free to use this `ignore` call on your Zeitwerk loader.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/lib/conventional_extensions/railtie.rb

@@ -0,0 +1,5 @@
+class ConventionalExtensions::Railtie < Rails::Railtie
+  initializer "conventional_extensions.ignore_extensions_directories" do
+    Rails.autoloaders.main.ignore "**/extensions/**.rb"
+  end
+end

data/lib/conventional_extensions/version.rb

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

data/lib/conventional_extensions.rb

@@ -32,4 +32,4 @@ module ConventionalExtensions
   autoload :Loader, "conventional_extensions/loader"
 end
 
-defined?(ActiveSupport.on_load) and ActiveSupport.on_load(:active_record) { extend ConventionalExtensions.load_on_inherited }
+require_relative "conventional_extensions/railtie" if defined?(Rails::Railtie)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conventional_extensions
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2022-11-23 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -26,6 +26,7 @@ files:
 - conventional_extensions.gemspec
 - lib/conventional_extensions.rb
 - lib/conventional_extensions/loader.rb
+- lib/conventional_extensions/railtie.rb
 - lib/conventional_extensions/version.rb
 homepage: https://github.com/kaspth/conventional_extensions
 licenses:
@@ -49,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.3.24
 signing_key:
 specification_version: 4
 summary: ConventionalExtensions sets up a file naming convention to extend your domain