Using annotate with Jets

thushara · May 30, 2019, 7:22pm

Has anyone used annotate in a Jets project?
Under Jets:

irb(main):002:0> Rails::Application.subclasses
=> []
irb(main):003:0>

This causes annotate to fail here:

github.com

ctran/annotate_models/blob/develop/lib/annotate.rb#L156


  if defined?(Rails::Application)
    if Rails.version.split('.').first.to_i < 3
      Rails.configuration.eager_load_paths.each do |load_path|
        matcher = /\A#{Regexp.escape(load_path)}(.*)\.rb\Z/
        Dir.glob("#{load_path}/**/*.rb").sort.each do |file|
          require_dependency file.sub(matcher, '\1')
        end
      end
    else
      klass = Rails::Application.send(:subclasses).first
      klass.eager_load!
    end
  else
    options[:model_dir].each do |dir|
      FileList["#{dir}/**/*.rb"].each do |fname|
        require File.expand_path(fname)
      end
    end
  end
end

tung · May 30, 2019, 10:45pm

Generally, annotate won’t work with Jets. Dug into it a little and a small change will allow annotating models to work: https://github.com/ctran/annotate_models/pull/626

It’s more work but you can use the forked version https://github.com/tongueroo/annotate_models

Here’s a test example with the forked version.

$ annotate
Model files unchanged.
$ cat app/models/post.rb                                                                                                               
# == Schema Information
#
# Table name: posts
#
#  id         :bigint           not null, primary key
#  title      :string(255)
#  body       :text(65535)
#  published  :boolean
#  created_at :datetime         not null
#  updated_at :datetime         not null
#

class Post < ApplicationRecord
end
$

Note, annotate will not work with routes though. The Jets routing layer is a completely different implementation than Rails.

Also, you need to be running Jets v1.9.8+ The autoloaders were changed in this version. For the annotate fork to work, you need at least v1.9.8

thushara · May 31, 2019, 10:53pm

Thank you!
I can annotate models now with this in my Gemfile:

gem ‘annotate’, git: ‘https://github.com/tongueroo/annotate_models.git’, :branch => ‘develop’

tung · February 22, 2020, 6:14am

PR needs a test. If you’re interested, feel free to add. https://github.com/ctran/annotate_models/pull/626 No sweat either way of course.