rails-cached-routes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ce322076dded160513fbd3ad08bf642d0fdbf0b
+  data.tar.gz: a6d95f51b4f2a747f7ac6b19bd57355443d5a0ad
+SHA512:
+  metadata.gz: 449a2c21e367ee27a8b2b34e86dc9282c3a3cd0f324c0c5205666e9383dbdf7fa279283ead4cd458026a8e682901a15d43af507f35750fc2d653837be354ad9e
+  data.tar.gz: 7e5e729f756cb5d01c407707fbbcc6a175b867ed1c9ad9f251c786de14daad981bed98aaf21e729267846ea293b105f33294b525c4121a33d01414360dec9403

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails-cached-routes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David McCullars
+
+MIT License
+
+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,38 @@
+# Rails::Cached::Routes
+
+For large applications with extensive routes files, the expense of loading
+the routes file for every command that requires the rails stack can become
+painfully slow.  In this case, time can be saved by marshalling the
+routes to a file so that subsequent loads of the rails stack can just
+unmarshal that file and be on its way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails-cached-routes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-cached-routes
+
+## Usage
+
+No special steps are needed to utilize rails-cached-routes as the railtie
+automatically adds the functionality into place.  For each route file
+processed by rails, a .cached file will be created on-the-fly whenever
+the rails stack is loaded the first time.  From then on the cached
+file will be used until its timestamp becomes older than the original
+routes file.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/cached_routes/cached_redirect.rb

@@ -0,0 +1,22 @@
+require 'action_dispatch/routing/redirection'
+
+module CachedRoutes
+  class CachedRedirect
+
+    include ActionDispatch::Routing::Redirection
+
+    def initialize(ad_redirect)
+      @path = case ad_redirect
+              when ActionDispatch::Routing::Redirect
+                ad_redirect.path({}, nil)
+              else
+                ad_redirect
+              end
+    end
+
+    def to_action_dispatch_redirect
+      redirect(@path)
+    end
+
+  end
+end

data/lib/cached_routes/marshaller.rb

@@ -0,0 +1,49 @@
+module CachedRoutes
+  class Marshaller
+
+    attr_reader :routes_file, :cached_file
+
+    def initialize
+      if caller_line = caller.detect { |li| !(li =~ /cached_routes/i) }
+        @routes_file = caller_line.sub /:.*/, ''
+        @cached_file = caller_line.sub /\.rb:.*/, '.cached'
+      else
+        warn "Can not determine caller routes file.  Skipping route caching."
+      end
+    end
+
+    def can_unmarshal_routes?
+      routes_file &&
+      cached_file &&
+      File.exist?(routes_file) &&
+      File.exist?(cached_file) &&
+      File.mtime(cached_file) >= File.mtime(routes_file)
+    end
+
+    def marshal_routes(new_routes)
+      new_routes.map! do |route|
+        if ActionDispatch::Routing::Redirect === route.app
+          route = route.clone
+          route.instance_variable_set :@app, CachedRedirect.new(route.app)
+        end
+        route
+      end
+      File.open(cached_file, 'wb') do |io|
+        Marshal.dump(new_routes, io)
+      end
+      nil
+    end
+
+    def unmarshal_routes(routes)
+      File.open(cached_file, 'rb') do |io|
+        Marshal.load(io).each do |route|
+          if CachedRedirect === route.app
+            route.instance_variable_set :@app, route.app.to_action_dispatch_redirect
+          end
+          routes << route
+        end
+      end
+    end
+
+  end
+end

data/lib/cached_routes/railtie.rb

@@ -0,0 +1,9 @@
+module CachedRoutes
+  class Railtie < Rails::Railtie
+
+    initializer "add_caching_of_routes" do |app|
+      app.routes.singleton_class.send :include, RouteSet
+    end
+
+  end
+end

data/lib/cached_routes/route_set.rb

@@ -0,0 +1,20 @@
+module CachedRoutes
+  module RouteSet
+
+    def self.included(base)
+      base.alias_method_chain :draw, :caching
+    end
+
+    def draw_with_caching(*args, &block)
+      marshaller = Marshaller.new
+      if marshaller.can_unmarshal_routes?
+        marshaller.unmarshal_routes(self.set.routes)
+      else
+        routes_before = self.set.routes.clone
+        draw_without_caching(*args, &block)
+        marshaller.marshal_routes(self.set.routes - routes_before)
+      end
+    end 
+
+  end
+end

data/lib/cached_routes/version.rb

@@ -0,0 +1,3 @@
+module CachedRoutes
+  VERSION = "0.0.1"
+end

data/lib/rails-cached-routes.rb

@@ -0,0 +1,3 @@
+Dir[File.expand_path('../cached_routes/**/*.rb', __FILE__)].each do |file|
+  load file
+end

data/rails-cached-routes.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cached_routes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-cached-routes"
+  spec.version       = CachedRoutes::VERSION
+  spec.authors       = ["David McCullars"]
+  spec.email         = ["david.mccullars@gmail.com"]
+  spec.description   = %q{Cache expensive rails routes files to speed up rails stack}
+  spec.summary       = <<-END
+For large applications with extensive routes files, the expense of loading
+the routes file for every command that requires the rails stack can become
+painfully slow.  In this case, time can be saved by marshalling the
+routes to a file so that subsequent loads of the rails stack can just
+unmarshal that file and be on its way.
+  END
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "> 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rails-cached-routes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David McCullars
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Cache expensive rails routes files to speed up rails stack
+email:
+- david.mccullars@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/cached_routes/cached_redirect.rb
+- lib/cached_routes/marshaller.rb
+- lib/cached_routes/railtie.rb
+- lib/cached_routes/route_set.rb
+- lib/cached_routes/version.rb
+- lib/rails-cached-routes.rb
+- rails-cached-routes.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: For large applications with extensive routes files, the expense of loading
+  the routes file for every command that requires the rails stack can become painfully
+  slow.  In this case, time can be saved by marshalling the routes to a file so that
+  subsequent loads of the rails stack can just unmarshal that file and be on its way.
+test_files: []