routes_lazy_routes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 776e64fd7ac17ff3e62acfb3cafd7e908ed32de16d798ecda0f9e494abdca344
+  data.tar.gz: 5c8811a1b1411849d27e2988f9a4d12db36a9fbbfd5c6676d383903678c85f44
+SHA512:
+  metadata.gz: 444b44d3d13ba5eff7a1c1b2960eba368295223506e460b48156eb7a5046e94a208adefabc855d48f560de5cef5151b0ea6d58fa027378b3ba9096a6bcaf5c12
+  data.tar.gz: a3ae5366ea23776ac6aeabfcaf7b3116adfb47aa7c7ec2becf97a22b62ed856001fee1d2d2d1d8dcb591f584b4aa6553d641da1ecd7f0fdb5887dd27d4bccf9b

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.0.rc.2
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.byebug_history
+/test/log/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in routes_lazy_routes.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Akira Matsuda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# routes_lazy_routes
+
+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 to wait dozens of seconds per every `rails` command invocation.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'routes_lazy_routes'
+```
+
+If you're not brave enough, you can limit the group not to include `production` environment.
+Indeed, enabling this gem for the processes like batch or job may improve their runtime performance, but so far as that's not a critical problem for your production system, the following setup might be safer.
+
+```ruby
+group :development, :test do
+  gem 'routes_lazy_routes'
+end
+```
+
+
+## Usage
+
+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.
+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.
+
+
+## Contributing
+
+Patches are welcome on GitHub at https://github.com/amatsuda/routes_lazy_routes.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "routes_lazy_routes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/routes_lazy_routes.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'routes_lazy_routes/version'
+require_relative 'routes_lazy_routes/lazy_routes_middleware'
+require_relative 'routes_lazy_routes/routes_reloader_wrapper'
+require_relative 'routes_lazy_routes/railtie'
+
+module RoutesLazyRoutes
+  class << self
+    # The root of evil
+    def arise!
+      Rails::Application::RoutesReloader.class_eval do
+        class << self
+          def new
+            RoutesLazyRoutes::RoutesReloaderWrapper.new super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/routes_lazy_routes/lazy_routes_middleware.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RoutesLazyRoutes
+  class LazyRoutesMiddleware
+    def initialize(app, original_routes_reloader)
+      @app = app
+      @original_routes_reloader = original_routes_reloader
+      @mutex = Mutex.new
+      @loaded = false
+    end
+
+    def call(env)
+      unless @loaded
+        @mutex.synchronize do
+          @app.instance_variable_set :@routes_reloader, @original_routes_reloader
+          @original_routes_reloader.execute
+          @loaded = true
+        end
+      end
+
+      @app.call env
+    end
+  end
+end

data/lib/routes_lazy_routes/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RoutesLazyRoutes
+  class Railtie < ::Rails::Railtie
+    initializer 'routes_lazy_routes', before: :add_routing_paths do
+      RoutesLazyRoutes.arise!
+    end
+  end
+end

data/lib/routes_lazy_routes/routes_reloader_wrapper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RoutesLazyRoutes
+  class RoutesReloaderWrapper
+    delegate :paths, :eager_load=, :updated?, :route_sets, to: :@original_routes_reloader
+
+    def initialize(original_routes_reloader)
+      @original_routes_reloader = original_routes_reloader
+
+      Rails.application.config.middleware.use LazyRoutesMiddleware, original_routes_reloader
+    end
+
+    def execute
+      # pretty vacant
+    end
+  end
+end

data/lib/routes_lazy_routes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RoutesLazyRoutes
+  VERSION = "0.1.0"
+end

data/routes_lazy_routes.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/routes_lazy_routes/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "routes_lazy_routes"
+  spec.version       = RoutesLazyRoutes::VERSION
+  spec.authors       = ["Akira Matsuda"]
+  spec.email         = ["ronnie@dio.jp"]
+
+  spec.summary       = 'A Rails routes lazy loader'
+  spec.description   = 'A Rails plugin that defers loading the whole bloody routes so the app can spin up quickly'
+  spec.homepage      = 'https://github.com/amatsuda/routes_lazy_routes'
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/amatsuda/routes_lazy_routes'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails'
+  spec.add_development_dependency 'byebug'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: routes_lazy_routes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akira Matsuda
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails plugin that defers loading the whole bloody routes so the app
+  can spin up quickly
+email:
+- ronnie@dio.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/routes_lazy_routes.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/version.rb
+- routes_lazy_routes.gemspec
+homepage: https://github.com/amatsuda/routes_lazy_routes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/amatsuda/routes_lazy_routes
+  source_code_uri: https://github.com/amatsuda/routes_lazy_routes
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.0.rc.2
+signing_key:
+specification_version: 4
+summary: A Rails routes lazy loader
+test_files: []