kaspth / conventional_extensions Goto Github PK

Hiya 👋

Extensions don't seem to be loading for namespaced classes.

As an example, here is a Organisation::User AR model and an extension...

# /app/models/organisation/user.rb
class Organisation::User < ApplicationRecord
end

# /app/models/organisation/user/extensions/first_name.rb
class Organisation::User
  def first_name
    'Joel'
  end
end

Calling the #first_name method results in a method_missing exception...

Organisation::User.new.first_name

# `method_missing': undefined method `first_name' for #<Organisation::User...

According to the README...

ConventionalExtensions automatically loads extensions for Active Record models.

But that isn't happening. So I have to manually add load_extensions in my models.

thx

Gotta make sure that everything reloads properly in a Rails app.

E.g. when Zeitwerk removes the old constants it'll be as if we've never called load_extensions, but then when Post gets loaded again, we'll call load_extensions again. However, our require use and $LOADED_FEATURES check (which is what require also does) might not comport with that.

So we either need to hook into Zeitwerk and clear our loaded extensions or something else.

In 0.2.1...

lib/conventional_extensions/loader.rb:10:in `dirname': no implicit conversion of false into String (TypeError)

Seems the path arguments in ConventionalExtensions::Loader#initialize is false 🤔

Hey @kaspth, thanks for creating this awesome gem!

I've encountered a weird issue on the latest 0.3.0 version. I have a minimal reproduction repo here: https://github.com/marcoroth/conventional_extensions-repro

I guess the main questions is: Am I even supposed to use load_exentions inside a model class under app/models/?

Versions

• conventional_extensions: 0.3.0
• Ruby: 3.1.2
• Rails: 7.0.4

Relevant Files

• app/models/post.rb
• app/models/post/extensions/mailroom.rb

Reproducion Steps

bundle install

rails db:create db:migrate 

rails c

Loading development environment (Rails 7.0.4)
irb(main):001:0> Post.new.mailroom
/Users/marcoroth/.anyenv/envs/rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/conventional_extensions-0.3.0/lib/conventional_extensions.rb:15:in `load_extensions': private method `load' called for nil:NilClass (NoMethodError)

    @loader.load(*extensions)
           ^^^^^

Possible fix?

This seems to fix it locally, but honestly I haven't fully grokked why @loader wouldn't need to be defined in some cases. This "fix" possibly also has some unwanted side-effects since @loader is not going to be cleaned up in the ensure block because of the loader_defined_before_entrance condition.

  def load_extensions(*extensions, from: Frame.previous.path)
-   @loader = Loader.new(self, from) unless loader_defined_before_entrance = defined?(@loader)
+   loader_defined_before_entrance = defined?(@loader)
+   @loader = Loader.new(self, from) unless loader_defined_before_entrance
+   @loader = Loader.new(self, from) if @loader.nil
    @loader.load(*extensions)
  ensure
    @loader = nil unless loader_defined_before_entrance
  end

I assume the defined?(...) is not doing the right thing, it returns a truthy value even if @loader is nil and thus not instantiating a loader.

irb(main):005:0> @loader = nil
=> nil
irb(main):006:0> defined?(@loader)
=> "instance-variable"

Either way, I'm happy to open a pull request if this fix makes sense.

In config/environments/test.rb, I have this line:

config.eager_load = ENV['CI'].present?

When running my tests in CI, ENV['CI'] is true, thus setting eager_load to true. Which then results in Zeitwerk::NameError...

expected file app/models/client/extensions/stripe.rb to define constant Client::Extensions::Stripe, but didn't (Zeitwerk::NameError)

eager_load is true in prod, so I'm half expecting the same exception (not actually tested that yet). But I'm assuming something is done to avoid that?

Anyway, thx again for an amazing lib. Any help would be appreciated.

Following on from #3, and now I've used this gem a little more, it has become apparent that sometimes a little more control is required as to when extensions are loaded.

For example, I may have included a module (a concern) in a model, which one of the model extensions requires. This will fail due to extensions being loaded before the inclusion of the module.

So would it be possible to disable this auto loading of extensions for a given class?