Remove sprockets dependency (#17)

Remove dependency on Sprockets. Now compatible with both Propshaft and Sprockets

Author: westonganger

.github/workflows/test.yml

@@ -23,8 +23,6 @@ jobs:
           - ruby: "3.2"
           - ruby: "3.3"
           ### TEST RAILS VERSIONS
-          - ruby: "2.7"
-            rails_version: "~> 6.0.0"
           - ruby: "2.7"
             rails_version: "~> 6.1.0"
           - ruby: "3.3"

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ### Unreleased
 - [View Diff](https://github.com/westonganger/pairer/compare/v1.1.0...master)
-- Nothing yet
+- [#17](https://github.com/westonganger/pairer/pull/17) - Remove dependency on Sprockets. Now compatible with both Propshaft and Sprockets.
 
 ### v1.1.0 - July 23, 2024
 - [View Diff](https://github.com/westonganger/pairer/compare/v1.0.0...v1.1.0)

Gemfile

@@ -18,7 +18,15 @@ def get_env(name)
   (ENV[name] && !ENV[name].empty?) ? ENV[name] : nil
 end
 
-gem "rails", get_env("RAILS_VERSION")
+rails_version = get_env("RAILS_VERSION")
+
+gem "rails", rails_version
+
+if rails_version.nil? || rails_version.to_f >= 8.0
+  gem "propshaft"
+else
+  gem 'sprockets-rails', require: 'sprockets/railtie'
+end
 
 db_gem = get_env("DB_GEM") || "sqlite3"
 gem db_gem, get_env("DB_GEM_VERSION")

app/assets/javascripts/pairer/application.js

@@ -1,5 +1,3 @@
-//= require rails-ujs
-
 window.init = function(){
   $('form').attr('autocomplete', 'off');
 

app/assets/stylesheets/pairer/application.css

@@ -1,8 +1,3 @@
-/*
- *= require ./utility
- *= require_self
- */
-
 :root{
   --navbar-height: 3.5em;
 }

app/views/layouts/pairer/application.html.slim

@@ -13,6 +13,7 @@ html
 
     link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/united/bootstrap.min.css" integrity="sha512-JsK+6bBl5wmtKe9PnCXclLS1fwG7GvLZ9IkBg/ACzuSJJUKTedxyXRFujJf+KpcNFFhSX+I05YPAm99r1ivmog==" crossorigin="anonymous" referrerpolicy="no-referrer"
 
+    = stylesheet_link_tag 'pairer/utility'
     = stylesheet_link_tag 'pairer/application', media: 'all'
 
     script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js" referrerpolicy="no-referrer"
@@ -28,6 +29,7 @@ html
 
     script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha512-oBTprMeNEKCnqfuqKd6sbvFzmFQtlXS3e0C/RGFV0hD6QzhHV+ODfaQbAlmY6/q0ubbwlAM/nCJjkrgA3waLzg==" crossorigin="anonymous" referrerpolicy="no-referrer"
 
+    = javascript_include_tag 'rails-ujs'
     = javascript_include_tag 'pairer/application'
 
   body

lib/pairer/engine.rb

@@ -1,14 +1,16 @@
 require 'slim'
-require "sprockets/railtie"
 require 'hashids'
 
 module Pairer
   class Engine < ::Rails::Engine
     isolate_namespace Pairer
 
     initializer "pairer.assets.precompile" do |app|
+      # this initializer is only called when sprockets is in use
+
       app.config.assets.precompile << "pairer_manifest.js" ### manifest file required
       app.config.assets.precompile << "pairer/favicon.ico"
+      app.config.assets.precompile << "rails-ujs" # provided by activesupport
 
       ### Automatically precompile assets in specified folders
       ["app/assets/images/"].each do |folder|

pairer.gemspec

@@ -18,11 +18,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.7"
 
-  spec.add_dependency "rails", ">= 6.0"
+  spec.add_dependency "rails", ">= 6.1"
   spec.add_dependency "actioncable"
   spec.add_dependency "slim"
   spec.add_dependency "hashids"
-  spec.add_dependency "sprockets-rails"
 
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "rspec-rails"

spec/dummy/config/environments/development.rb

@@ -45,14 +45,6 @@
   # Highlight code that triggered database queries in logs.
   config.active_record.verbose_query_logs = true
 
-  # Debug mode disables concatenation and preprocessing of assets.
-  # This option may cause significant delays in view rendering with a large
-  # number of complex assets.
-  config.assets.debug = true
-
-  # Suppress logger output for asset requests.
-  config.assets.quiet = true
-
   # Raises error for missing translations.
   # config.action_view.raise_on_missing_translations = true
 

spec/dummy/config/environments/production.rb

@@ -22,12 +22,6 @@
   # Apache or NGINX already handles this.
   config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
 
-  # Compress CSS using a preprocessor.
-  # config.assets.css_compressor = :sass
-
-  # Do not fallback to assets pipeline if a precompiled asset is missed.
-  config.assets.compile = false
-
   # Enable serving of images, stylesheets, and JavaScripts from an asset server.
   # config.action_controller.asset_host = 'http://assets.example.com'