Fixing jquery-tmpl-rails Sprockets deprecations

[Schwad]

This is also filed under Sprockets core for guidance here.

Versions

• Ruby 2.4.3
• Rails 5.1.3
• sprockets 3.7.3
• jquery-tmpl-rails 1.1.0

Issue:

The latest version of jquery-tmpl-rails triggers a sprockets deprecation warning of:

    DEPRECATION WARNING: Sprockets method `register_engine` is deprecated.
    Please register a mime type using `register_mime_type` then
    use `register_compressor` or `register_transformer`.

    https://github.com/rails/sprockets/blob/master/guides/extending_sprockets.md#supporting-all-versions-of-sprockets-in-processors 
    (called from block (2 levels) in <class:Railtie> at /my/path/to/gems/jquery-tmpl-rails-ef6f58001d41/lib/jquery-tmpl-rails/engine.rb:10)

Attempts at resolution:

Following the deprecation warning, the problem within the gem simply resides here: https://github.com/jimmycuadra/jquery-tmpl-rails/blob/master/lib/jquery-tmpl-rails/engine.rb#L10

Which is currently:

app.assets.register_engine(".tmpl", JqueryTemplate)

I then visited the sprockets guide for handling deprecations, extensibility and compliance with sprockets 2,3,4. https://github.com/rails/sprockets/blob/master/guides/extending_sprockets.md#supporting-all-versions-of-sprockets-in-processors

I made my best attempt at rectifying the problem with a commit on this fork here: oceanshq@de7a598

Which was:

    asset.register_mime_type 'application/javascript', extensions: ['.tmpl'], charset: :unicode
    asset.register_preprocessor 'application/javascript', JqueryTemplate

However, this attempt simply deals out breakages when trying to run the web application at all or test it on the CI. So obviously I've missed something. I am not the gem maintainer but am trying to put this PR together myself as we rely on this gem.

Questions

• Is there a simple syntactical approach I am missing here?
• It was unclear to me in the docs, although register_engine is deprecated in Sprockets 3, is it actually possible to migrate from register_engine while staying in Sprockets 3?
• If we are remaining on Sprockets 3 for the foreseeable future, is it kosher to silence this? Generally I work viewing deprecations as 'bugs that need fixing' and would rather not.

[Schwad]

@jimmycuadra

[jimmycuadra]

I haven't followed Rails in a while—what is the implication of supporting older versions of Sprockets? Generally I'm supportive of bumping dependencies to more recent versions. Folks using older versions of Rails can continue to use older versions of this gem.

[Schwad]

This is exactly true. Although it focuses on supporting 'all' versions of sprockets, the deprecation warning I am getting is that this gem's syntax is deprecated in Sprockets 3 and will not work with Sprockets 4. I would agree that you do not need to write new code to support Sprockets 2

…

On 27 April 2018 at 13:15, Jimmy Cuadra ***@***.***> wrote: I haven't followed Rails in a while—what is the implication of supporting older versions of Sprockets? Generally I'm supportive of bumping dependencies to more recent versions. Folks using older versions of Rails can continue to use older versions of this gem. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#11 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AHgCxo9M20BqxihnQD3mmYRlF1NPjIy7ks5tswvYgaJpZM4TjGzX> .

[jimmycuadra]

I am okay with doing a major version bump of this gem and requiring whatever version of Sprockets the most recent version of Rails requires.