error_page_assets 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16bbd1059b6b3587f6f2a9255a4b5b99b2c92303
+  data.tar.gz: 6518f7a7f144ae70e68d0b00070dadf45195ec62
+SHA512:
+  metadata.gz: a1eeab19d61714b3f5c6205cadeec29aea56c6014a0929679cda84d92295173fb0815edc0077c1adc927b143dea9338066e77d1b043d71c051d68ec6e6cd6e12
+  data.tar.gz: a4eb0112a9f0dc5751572f45e1908db88fc2fa1fa1357333e21aed505ad1eb2cbfce8a01fd8871b3a3e0db2f6564274b5cc341a459dc3304bd9f506609ddaaf5

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+end

data/Guardfile

@@ -0,0 +1,17 @@
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: 'rspec' do
+  # run all specs if any Ruby file is modified
+  watch(%r{^lib/.+\.rb}) { "spec" }
+  # watch(%r{.*\.rb})
+  # watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+
+  # re-run just the spec
+  watch(%r{^spec/.+_spec\.rb$})
+
+  # run all specs if the helper is modified
+  watch(%r{spec/spec_helper\.rb})  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Scott Bronson
+
+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,99 @@
+# Error Page Assets
+
+Let the asset pipeline generate your static error pages.
+
+This gem lets you include Sprockets-generated CSS and JS files,
+complete with cache-busting digests, in `public/404.html` and friends.
+You can even use layouts.
+
+No monkeypatching, no Rails engines, no routing, just idiomatic code.
+The asset pipeline will generate static files so your
+web server shows your custom error pages even when your app is down hard.
+
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'error_page_assets'
+```
+
+Move your error pages into the asset pipeline
+
+```sh
+git mv public/404.html app/assets/html/404.html.erb
+git mv public/422.html app/assets/html/422.html.erb
+git mv public/500.html app/assets/html/500.html.erb
+```
+
+And tell the asset pipeline to compile your error pages.
+In `config/application.rb`:
+
+```ruby
+config.assets.precompile += %w[404.html 422.html 500.html]
+```
+
+
+## Usage
+
+Whenever assets are precompiled (i.e. during each deploy),
+your error pages will be generated and dropped into `/public`.
+
+```sh
+# public/404.html doesn't exist
+rails assets:precompile
+# public/404.html exists and includes your most recent code
+```
+
+Your error pages are automatically generated along with the
+rest of your assets each time you deploy.
+
+### Rails Helpers
+
+Now you can update your error pages to use Rails helpers:
+
+```erb
+old:
+  <link href="/css/application.css" media="all" rel="stylesheet"/>
+  <script src="/js/application.js"></script>
+new:
+  <%= stylesheet_link_tag 'application', media: 'all', digest: true %>
+  <%= javascript_include_tag "application" %>
+```
+
+
+## Layouts
+
+The Asset pipeline knows how to include stylesheets in your html,
+but it doesn't know how to render layouts.  If you'd like your
+static error pages to use layouts too, use the
+[render anywhere](https://github.com/yappbox/render_anywhere) gem.
+
+
+## Roadmap
+
+* Do we still need to use digest:true?
+* Use an initializer to automatically add error pages to the sprockets config?
+* Rails generator to move your error pages?
+
+
+## Alternatives
+
+* Inspired by: http://icelab.com.au/articles/precompiled-rails-static-404-and-500-pages/
+* Rails Engine: https://github.com/marcusg/dynamic_error_pages
+* Dynamic Route: https://github.com/eric1234/better_exception_app
+
+
+## License
+
+Pain-free MIT.
+
+
+## Contributing
+
+My app isn't localized so I haven't bothered with `I18n.available_locales`.
+If you want localization, please file an issue.
+
+To make this gem less imperfect, please submit your issues and patches on
+[GitHub](https://github.com/bronson/error_page_assets/).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => ['spec']
+task :test => ['spec']

data/error_page_assets.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'error_page_assets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "error_page_assets"
+  spec.version       = ErrorPageAssets::VERSION
+  spec.authors       = ["Scott Bronson"]
+  spec.email         = ["brons_errpage@rinspin.com"]
+  spec.summary       = "Uses the asset pipeline to generate your static error pages."
+  # spec.description   = "Uses the asset pipeline to generate your static error pages."
+  spec.homepage      = "http://github.com/bronson/static_error_pages"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/error_page_assets/railtie.rb

@@ -0,0 +1,13 @@
+require 'error_page_Assets'
+require 'rails'
+
+module ErrorPageAssets
+  class Railtie < Rails::Railtie
+    railtie_name :error_page_assets
+
+    rake_tasks do
+      load "tasks/error_page_assets.rake"
+    end
+  end
+end
+

data/lib/error_page_assets/version.rb

@@ -0,0 +1,3 @@
+module ErrorPageAssets
+  VERSION = "0.1"
+end

data/lib/error_page_assets.rb

@@ -0,0 +1,3 @@
+module ErrorPageAssets
+  require 'error_page_assets/railtie' if defined?(Rails)
+end

data/lib/tasks/error_page_assets.rake

@@ -0,0 +1,35 @@
+require 'fileutils'
+
+# Use the Asset Pipeline to generate static error pages.
+# For example, /app/assets/html/404.html.erb will be compiled to /public/404.html
+
+
+Rake::Task['assets:precompile'].enhance do
+  Rake::Task['assets:precompile:error_pages'].invoke
+end
+
+namespace :assets do
+  namespace :precompile do
+    def log msg
+      # try to log like Sprockets even though their stuff is all private
+      STDERR.puts msg
+      Rails.logger.info(msg) if Rails.respond_to?(:logger)
+    end
+
+    def copy_error_files
+      pattern = Rails.root.join('public', 'assets', "[0-9][0-9][0-9]*.html")
+      groups = Dir[pattern].group_by { |s| File.basename(s)[0..2] }
+      groups.sort_by { |base,_| base }.each do |base, group|
+        latest = group.sort_by { |f| File.mtime(f) }.last
+        log "copy #{latest} to public/#{base}.html"
+        FileUtils.cp latest, Rails.root.join('public', "#{base}.html")
+      end
+    end
+
+    desc 'Copies the newest error pages into /public'
+    task :error_pages do
+      copy_error_files
+    end
+  end
+end
+

data/spec/error_page_assets_spec.rb

@@ -0,0 +1,30 @@
+require 'rake'
+
+describe 'assets:precompile:error_pages' do
+  before do
+    # load rake task
+    Rake.application = Rake::Application.new
+    Rake.application.rake_require('stub_assets_precompile', ['spec'])
+    Rake.application.rake_require('error_page_assets', ['lib/tasks'])
+
+    # allow rake task to call Rails.root.join
+    stub_const('Rails', Class.new)
+    allow(Rails).to receive_message_chain(:root, :join) { |*args| File.join('spec', *args) }
+  end
+
+  it "copies the error pages" do
+    # ensure the rake task uses the most recent asset file
+    expect(File).to receive(:mtime).with('spec/public/assets/404-digestnew.html').and_return(Time.now)
+    expect(File).to receive(:mtime).with('spec/public/assets/404-digestold.html').and_return(Time.now - 3600)
+    expect(File).to receive(:mtime).with('spec/public/assets/500.html').and_return(Time.now)
+
+    # ensure the rake task doesn't actually perform the copies
+    expect(FileUtils).to receive(:cp).with('spec/public/assets/404-digestnew.html', 'spec/public/404.html')
+    expect(FileUtils).to receive(:cp).with('spec/public/assets/500.html', 'spec/public/500.html')
+
+    # suppress our logging while testing
+    expect(STDERR).to receive(:puts).twice
+
+    Rake.application['assets:precompile:error_pages'].invoke
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.order = 'random'
+end

data/spec/stub_assets_precompile.rake

@@ -0,0 +1,6 @@
+namespace :assets do
+  desc 'stubs assets:precompile for testing'
+  task :precompile do
+    puts 'precompiling'
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: error_page_assets
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Scott Bronson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- brons_errpage@rinspin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- error_page_assets.gemspec
+- lib/error_page_assets.rb
+- lib/error_page_assets/railtie.rb
+- lib/error_page_assets/version.rb
+- lib/tasks/error_page_assets.rake
+- spec/error_page_assets_spec.rb
+- spec/public/assets/404-digestnew.html
+- spec/public/assets/404-digestold.html
+- spec/public/assets/500.html
+- spec/spec_helper.rb
+- spec/stub_assets_precompile.rake
+homepage: http://github.com/bronson/static_error_pages
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Uses the asset pipeline to generate your static error pages.
+test_files:
+- spec/error_page_assets_spec.rb
+- spec/public/assets/404-digestnew.html
+- spec/public/assets/404-digestold.html
+- spec/public/assets/500.html
+- spec/spec_helper.rb
+- spec/stub_assets_precompile.rake