routes_lazy_routes 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d328eaa59962f83c7d301afe8040f66b51b2c524fd59cde08ee68f49e5d2a478
-  data.tar.gz: 16c074d69396f4205076238e56b4e7e1f6fedb38eff428d52454fe24173b2634
+  metadata.gz: b3a53d214d3a09b1d78449db704c5c01f161848c502e5db060d49445a27cbc44
+  data.tar.gz: 3a1f0142211703faa3e74d038500376f38886bc44c904e55796a456bbdcb5cbc
 SHA512:
-  metadata.gz: b8869ac12f5faa11b76cdb5301c56dd88a1ec0904eb2edab3888e9ac47724bbe72bf85667aba7665f5262b34fca13ef5c04350f0b5ecea4da8cb632618bf8150
-  data.tar.gz: c81344fc4c6f912554d5ea2aa5210690ba31dbbac0070584e7a50fc343bb3df6455f8847449fcd381f68c6084fd7db2e1ada4c4eb325c2d63fe3c07246892005
+  metadata.gz: 7d808c84a2d36a0ba6f0ae2bf292a157ae3912a052ccf4f8b6a557e7156591b58ddf1121dc73bcf9db32a8a363c69cf8d3ca71331acddbabc3b960785211db62
+  data.tar.gz: 2a9219db0ec56fa7a120d736824ddf63f53af888f1f0cbb959c80857d07f79a1d015dcef2de3f29fd9aedaaa42ce81662541f433acb7d4cf6869c514df421970

data/.github/workflows/main.yml

@@ -4,15 +4,30 @@ on: [push,pull_request]
 
 jobs:
   build:
+    strategy:
+      matrix:
+        include:
+          - ruby-version: 2.7.3
+            rails-version: '~> 5.2.4'
+          - ruby-version: 2.7.3
+            rails-version: '~> 6.0.3'
+          - ruby-version: 2.7.3
+            rails-version: '~> 6.1.0'
+          - ruby-version: 3.0.1
+            rails-version: '~> 6.0.3'
+          - ruby-version: 3.0.1
+            rails-version: '~> 6.1.0'
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.0
+        ruby-version: ${{ matrix.ruby-version }}
     - name: Run the default task
       run: |
-        gem install bundler -v 2.2.0.rc.2
+        gem install bundler
         bundle install
         bundle exec rake
+      env:
+        RAILS_VERSION: ${{ matrix.rails-version }}

data/Gemfile

@@ -5,6 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in routes_lazy_routes.gemspec
 gemspec
 
+gem "rails", ENV["RAILS_VERSION"] if ENV["RAILS_VERSION"]
+
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"

data/README.md

@@ -2,7 +2,7 @@
 
 routes_lazy_routes is an evil Rails plugin that defers loading the whole bloody routes until the server gets the first request, so the app can spin up quickly. 🤘
 
-This voodoo gem is designed especially for you who are maintaining a Rails app that contains hundreds of routes that forces you to wait dozens of seconds per every `rails` command invocation.
+This voodoo gem is designed especially for you who are maintaining a huge legacy Rails app that contains hundreds of routes that forces you to wait dozens of seconds per every `rails` command invocation.
 
 
 ## Installation
@@ -30,7 +30,7 @@ You have nothing to do with it. It should just work beneath the skin.
 
 ## Trade-off
 
-The first visitor of the server should sacrifice their time for the Rails process to load the routes.
+The first visitor of the server should sacrifice their time for the Rails process to load the routes. First strike is deadly.
 If you're bundling this in the production server, it'd be a good idea to throw a jab to the server right after the deployment in order to warm up before accepting real client requests.
 
 

data/lib/routes_lazy_routes/application.rb

@@ -2,11 +2,24 @@
 
 module RoutesLazyRoutes
   module Application
-    # We expect `Rails.application.eager_load!` to load all routes as well
-    def eager_load!
-      RoutesLazyRoutes.eager_load!
+    module LoadRunner
+      # We expect `Rails.application.eager_load!` to load all routes as well
+      def eager_load!
+        RoutesLazyRoutes.eager_load!
 
-      super
+        super
+      end
+    end
+
+    module TaskLoader
+      # A monkey-patch that loads our Rake task for enhancing `rake routes` after Rails loads all other tasks.
+      # Just declaring our own `rake_tasks` in the railtie cannot achieve this, since calling each railtie's `rake_tasks` is done before requiring "rails/tasks",
+      # so enhancing Rails' Rake task from a gem this way seems impossible.
+      def load_tasks(*)
+        super
+
+        load "#{__dir__}/tasks/routes_lazy_routes.rake"
+      end
     end
   end
 end

data/lib/routes_lazy_routes/command/routes_command.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RoutesLazyRoutes
+  module Command
+    module RoutesCommand
+      # A monkey-patch that eager_loads the routes right before running the `rails routes` command.
+      def require_environment!
+        super
+
+        RoutesLazyRoutes.eager_load!
+      end
+    end
+  end
+end

data/lib/routes_lazy_routes/railtie.rb

@@ -4,12 +4,20 @@ require_relative 'application'
 
 module RoutesLazyRoutes
   class Railtie < ::Rails::Railtie
-    initializer 'routes_lazy_routes', before: :add_routing_paths do
+    # Extending the following modules have to be done very early, like before executing any initializer, so here it is
+    Rails::Application.prepend RoutesLazyRoutes::Application::TaskLoader
+
+    if defined? Rails::Command::RoutesCommand
+      require_relative 'command/routes_command'
+      Rails::Command::RoutesCommand.prepend RoutesLazyRoutes::Command::RoutesCommand
+    end
+
+    initializer :routes_lazy_routes, before: :add_routing_paths do
       RoutesLazyRoutes.arise!
 
       Rails.application.config.middleware.use LazyRoutesMiddleware
 
-      Rails.application.extend RoutesLazyRoutes::Application
+      Rails.application.extend RoutesLazyRoutes::Application::LoadRunner
 
       ActiveSupport.on_load :action_dispatch_integration_test, run_once: true do
         RoutesLazyRoutes.eager_load!

data/lib/routes_lazy_routes/routes_reloader_wrapper.rb

@@ -2,7 +2,7 @@
 
 module RoutesLazyRoutes
   class RoutesReloaderWrapper
-    delegate :paths, :eager_load=, :updated?, :route_sets, to: :@original_routes_reloader
+    delegate :paths, :eager_load=, :updated?, :route_sets, :external_routes, to: :@original_routes_reloader
 
     def initialize(original_routes_reloader)
       @original_routes_reloader = original_routes_reloader

data/lib/routes_lazy_routes/tasks/routes_lazy_routes.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+if Rake::Task.task_defined?('routes')
+  namespace :routes_lazy_routes do
+    task :eager_load do
+      RoutesLazyRoutes.eager_load!
+    end
+  end
+
+  Rake::Task['routes'].enhance ['routes_lazy_routes:eager_load']
+end

data/lib/routes_lazy_routes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RoutesLazyRoutes
-  VERSION = '0.2.0'
+  VERSION = '0.4.1'
 end

data/routes_lazy_routes.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rails'
+  spec.add_dependency 'railties'
+  spec.add_dependency 'actionpack'
   spec.add_development_dependency 'byebug'
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: routes_lazy_routes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -56,9 +70,11 @@ files:
 - bin/setup
 - lib/routes_lazy_routes.rb
 - lib/routes_lazy_routes/application.rb
+- lib/routes_lazy_routes/command/routes_command.rb
 - lib/routes_lazy_routes/lazy_routes_middleware.rb
 - lib/routes_lazy_routes/railtie.rb
 - lib/routes_lazy_routes/routes_reloader_wrapper.rb
+- lib/routes_lazy_routes/tasks/routes_lazy_routes.rake
 - lib/routes_lazy_routes/version.rb
 - routes_lazy_routes.gemspec
 homepage: https://github.com/amatsuda/routes_lazy_routes
@@ -82,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.2
+rubygems_version: 3.3.0.dev
 signing_key:
 specification_version: 4
 summary: A Rails routes lazy loader