exceptionally_beautiful 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a478d516a8c878e7d74548e35c8af2983db8c4a6
-  data.tar.gz: 991e4c83503493a7c3c2902f7018b3f7fbd5eec9
+  metadata.gz: 6a36e540a4184161fb1862b7c35dbfe827a99537
+  data.tar.gz: 7388c72aacc54e8d45f8ab822626ec45c3e8359d
 SHA512:
-  metadata.gz: 36e5d8da49a8fb778952c8741275e3417caf522839024281adcd738449c82f7af884f56022cb549ccd060149e3399505ec183e4b652309acaa38756a9b4f37a5
-  data.tar.gz: 1b410e26bfddb8fd36b6a4137932218d88617945c2c48a094143cd45a77e13868b74fc81faf12054ad5557bd8c5e46a5a3403c977637607005e6b6c907b4f60e
+  metadata.gz: f6bf154bd9f2406d253105f5d3a44f39c4eca770be8db54c29fa8eebbd7107790a6b9e41f80cfe2e0603c24e4fcac4698d8180984565e626479643762a431e7b
+  data.tar.gz: cdc0ba7b4a29151887479f8e264d842ef7fd98bcf3a37c47d6ac35f2f06511fdc2bba17a2e09ce0cf0bd8fb9abbf587c46775972c2fb09bc371fc45037bac5be

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 0.1.2 (2015-02-25)
+
+* Specify error codes the gem will handle via `config.errors`.
+* Rake task for caching error pages in your app's public folder (see README for more information).
+* Capistrano integration (see README for more information).
+
+## 0.1.1 (2015-02-10)
+
+Removed beta restrictions from Rails dependency.
+
 ## 0.1.0 (2015-01-22)
 
 This release breaks the previous I18n translation file format. See the README for information on how the translation file should be setup now.

data/README.md

@@ -24,7 +24,7 @@ The generator will:
 
 ## What You Get
 
-Exceptionally Beautiful will handle any three-digit status code you throw at it. It comes with translation data for the following common errors:
+Exceptionally Beautiful can handle any three-digit status code you throw at it. It comes with translation data for the following common errors:
 
 | Code |         Error         |
 |------|:---------------------:|
@@ -34,23 +34,24 @@ Exceptionally Beautiful will handle any three-digit status code you throw at it.
 | 500  | Internal Server Error |
 | 502  | Bad Gateway           |
 
-Any status code that is either unrecognized or missing translation data will fall back to default messaging.
-
 ## Customizing
 
-If the default controller, action, and/or layout don't suit your fancy, you can override any of them in the initializer provided by the generator:
+If the default errors, controller, action, and/or layout don't suit your fancy, you can override any of them in the initializer provided by the generator:
 
 ``` ruby
 ExceptionallyBeautiful.setup do |config|
+  config.errors = [403, 404, 422, 500, 502]
   config.layout = 'errors'
   config.controller = 'exceptionally_beautiful/errors'
   config.action = 'show'
 end
 ```
 
+**Important:** If you want Exceptionally Beautiful to handle an error code other than the defaults specified, it must be added to `config.errors`.
+
 ### Error Messages
 
-You can customize and add new errors to the translation file copied over by the initializer (`config/locales/exceptionally_beautiful.en.yml`).
+You can customize and add new errors to the translation file copied over by the initializer (`config/locales/exceptionally_beautiful.en.yml`). Error codes missing translation data will fall back to default messaging.
 
 #### I18n Gotcha
 
@@ -83,7 +84,7 @@ The `message` for each error can be formatted using Markdown. e.g.
 
 ## Usage With `rescue_from`
 
-If you're using Rails' `rescue_from` functionality, you can still use Exceptionally Beautiful:
+Using Rails' `rescue_from` in your controllers? You can use Exceptionally Beautiful's error handler there too:
 
 ``` ruby
 class ApplicationController < ActionController::Base
@@ -95,6 +96,28 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+## Rake Task
+
+This library comes with a Rake task that caches your beautiful error pages as static HTML files in your application's public folder.
+
+``` bash
+bundle exec rake exceptionally_beautiful:cache
+```
+
+## Capistrano Integration
+
+Want to cache your error pages as part of your deployment workflow? Use the included Capistrano 3 task:
+
+``` ruby
+# In your Capfile
+require 'exceptionally_beautiful/capistrano'
+
+# In your config/deploy.rb
+after 'deploy:compile_assets', 'exceptionally_beautiful:cache'
+```
+
+By default, the `exceptionally_beautiful:cache` task is only run on servers with the `:app` role, however you can override that by setting the `:exceptionally_beautiful_roles` option.
+
 ## Inspiration & Alternatives
 
 This is by no means the first library to tackle this problem. Check out these other alternatives before deciding what to use.

data/lib/exceptionally_beautiful/capistrano/exceptionally_beautiful.rake

@@ -0,0 +1,18 @@
+namespace :exceptionally_beautiful do
+  desc "Cache all Exceptionally Beautiful error pages in your application's public folder"
+  task :cache do
+    on roles fetch(:exceptionally_beautiful_roles) do |host|
+      within release_path do
+        with :rails_env => fetch(:rails_env) do
+          execute :rake, 'exceptionally_beautiful:cache'
+        end
+      end
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :exceptionally_beautiful_roles, -> { :app }
+  end
+end

data/lib/exceptionally_beautiful/capistrano.rb

@@ -0,0 +1,7 @@
+require 'capistrano/version'
+
+if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION).release >= Gem::Version.new('3.0.0')
+  load File.expand_path('../capistrano/exceptionally_beautiful.rake', __FILE__)
+else
+  fail LoadError
+end

data/lib/exceptionally_beautiful/engine.rb

@@ -7,5 +7,9 @@ module ExceptionallyBeautiful
     initializer 'exceptionally_beautiful.update_exceptions_app' do |app|
       app.config.exceptions_app = app.routes
     end
+
+    rake_tasks do
+      load config.root.join('lib/exceptionally_beautiful/tasks/exceptionally_beautiful.rake')
+    end
   end
 end

data/lib/exceptionally_beautiful/markdown_renderer.rb

@@ -1,3 +1,6 @@
+require 'redcarpet'
+require 'exceptionally_beautiful/html_renderer'
+
 module ExceptionallyBeautiful
   class MarkdownRenderer
     attr_reader :text

data/lib/exceptionally_beautiful/routes.rb

@@ -1,8 +1,11 @@
+require 'exceptionally_beautiful/routing_constraint'
+
 module ActionDispatch::Routing
   class Mapper
     def exceptionally_beautiful_routes
       match '(errors)/:status', :to => "#{ExceptionallyBeautiful.controller}##{ExceptionallyBeautiful.action}",
-                                :constraints => { :status => /\d{3}/ }, :via => :all
+                                :constraints => ExceptionallyBeautiful::RoutingConstraint.new, :via => :all,
+                                :as => :exceptionally_beautiful_error
     end
   end
 end

data/lib/exceptionally_beautiful/routing_constraint.rb

@@ -0,0 +1,8 @@
+module ExceptionallyBeautiful
+  class RoutingConstraint
+    def matches?(request)
+      status = request.env['action_dispatch.request.path_parameters'][:status]
+      !status.nil? && status.match(/\d{3}/) && ExceptionallyBeautiful.errors.include?(status.to_i)
+    end
+  end
+end

data/lib/exceptionally_beautiful/tasks/exceptionally_beautiful.rake

@@ -0,0 +1,16 @@
+namespace :exceptionally_beautiful do
+  desc "Cache all Exceptionally Beautiful error pages in your application's public folder"
+  task :cache => :environment do
+    app = ActionDispatch::Integration::Session.new(Rails.application)
+    app.https!
+
+    ExceptionallyBeautiful.errors.each do |error_code|
+      app.get "/#{error_code}"
+
+      file_path = Rails.root.join('public')
+      file_name = "/#{error_code}.html"
+
+      File.open([file_path, file_name].join, 'w') { |f| f.write(app.response.body) }
+    end
+  end
+end

data/lib/exceptionally_beautiful/version.rb

@@ -1,3 +1,3 @@
 module ExceptionallyBeautiful
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/exceptionally_beautiful.rb

@@ -1,9 +1,11 @@
 require 'exceptionally_beautiful/markdown_renderer'
-require 'exceptionally_beautiful/html_renderer'
 require 'exceptionally_beautiful/engine'
 require 'exceptionally_beautiful/routes'
 
 module ExceptionallyBeautiful
+  mattr_accessor :errors
+  self.errors = [403, 404, 422, 500, 502]
+
   mattr_accessor :controller
   self.controller = 'exceptionally_beautiful/errors'
 

data/lib/generators/templates/exceptionally_beautiful.rb

@@ -1,4 +1,7 @@
 ExceptionallyBeautiful.setup do |config|
+  # The error codes to handle
+  # config.errors = [403, 404, 422, 500, 502]
+
   # The controller to use when rendering errors
   # config.controller = 'exceptionally_beautiful/errors'
 

data/spec/features/exceptionally_beautiful_engine_spec.rb

@@ -12,7 +12,7 @@ feature 'something' do
   end
 
   describe 'default errors' do
-    [403, 404, 422, 500, 502].each do |error_code|
+    ExceptionallyBeautiful.errors.each do |error_code|
       describe "#{error_code} error messaging" do
         let(:error) { ExceptionallyBeautiful::Error.new(error_code) }
         before { visit "/errors/#{error_code}" }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exceptionally_beautiful
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - PJ Kelly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -222,10 +222,14 @@ files:
 - config/routes.rb
 - exceptionally_beautiful.gemspec
 - lib/exceptionally_beautiful.rb
+- lib/exceptionally_beautiful/capistrano.rb
+- lib/exceptionally_beautiful/capistrano/exceptionally_beautiful.rake
 - lib/exceptionally_beautiful/engine.rb
 - lib/exceptionally_beautiful/html_renderer.rb
 - lib/exceptionally_beautiful/markdown_renderer.rb
 - lib/exceptionally_beautiful/routes.rb
+- lib/exceptionally_beautiful/routing_constraint.rb
+- lib/exceptionally_beautiful/tasks/exceptionally_beautiful.rake
 - lib/exceptionally_beautiful/version.rb
 - lib/generators/exceptionally_beautiful/install_generator.rb
 - lib/generators/templates/exceptionally_beautiful.rb