ruh_roh 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Scott Windsor
+
+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.rdoc

@@ -0,0 +1,87 @@
+= RuhRoh
+
+RuhRoh is a rails plugin that allows you pre-generate error pages with the full rails stack available.
+
+While rails' default error pages are great, they look totally unprofessional for any real site.
+RuRoh provides a quick and easy way to have nicely rendered error pages generated from your stack
+during deployment. This allows you to re-use your existing layouts and customize your error pages
+without having to re-create them on the fly (which could result in further errors). The pages can
+be generated via capistrano during deploy, or generated during a post-commit hook similar to asset
+pipeline resources.
+
+= Usage
+
+In your Gemfile, add RuhRoh.
+
+  gem 'ruh_roh'
+
+In your routes file, mount the engine on the /error path.
+
+  YourApp::Application.routes.draw do
+    mount RuhRoh::Engine => "/error"
+  end
+
+Now you can render out some error pages!
+
+  rake ruh_roh:generate
+
+There are default 404, 422 & 500 templates available by default - it will also use your application
+layout.
+
+To override the existing templates, just make a new view to override the default.
+
+in app/views/ruh_roh/errors/404.html.erb
+
+  <h1>Oh noes! Dis page not foundses.</h1>
+
+# Configuration
+
+There are a few config options. Make sure these are set in your config, but in an after_initialize
+block.
+
+  module YourApp
+    class Application < Rails::Application
+
+        config.after_initialize do
+          # Set error layout
+          config.ruh_roh.application_layout = "error"
+          # Set error hostname
+          config.ruh_roh.application_host = "scoobysnacks.com"
+          # Set handled errors
+          config.ruh_roh.handled_errors = %(404 418 500)
+        end
+    end
+  end
+
+= Deployment
+
+For deployment, you can add this to your capistrano config:
+
+    namespace :deploy do
+     desc "Generate error pages for production"
+     task :generate_error_pages do
+       run <<-EOF
+         cd #{release_path} && RAILS_ENV='production' bundle exec rake ruh_roh:generate
+       EOF
+     end
+        end
+    after "deploy:update", "deploy:generate_error_pages"
+
+This should be very similar to your precompile_assets task. If you can't write to public on your production 
+server, you can consider make the rake task a git post-commit hook or just checking in the html files
+by hand.
+
+= Misc hacks/notes/etc
+
+You'll want to sent an application host if you have and urls in your pages. This is a side effect
+on how pages are rendered via the integration runner - otherwise you'll end up with "example.com"
+for all of your urls.
+
+Also, if your layout or views use any routes for your application, you'll have to prepend them with
+"main_app". For example, "root_url" becomes "main_app.root_url". This is a bit of a side effect
+of how rails engine's work.
+
+= License
+
+This project is released under the MIT License. Have fun, and be excellent to each other.
+

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RuhRoh'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# RSpec as default
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/generate_error/errors.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/generate_error/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/generate_error/errors.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/ruh_roh/application_controller.rb

@@ -0,0 +1,11 @@
+module RuhRoh
+  class ApplicationController < ActionController::Base
+    layout :application_layout
+
+    private
+
+    def application_layout
+      Rails.configuration.ruh_roh.application_layout
+    end
+  end
+end

data/app/controllers/ruh_roh/errors_controller.rb

@@ -0,0 +1,7 @@
+module RuhRoh
+  class ErrorsController < ApplicationController
+    def error
+      render :action => params[:id]
+    end
+  end
+end

data/app/helpers/ruh_roh/application_helper.rb

@@ -0,0 +1,4 @@
+module RuhRoh
+  module ApplicationHelper
+  end
+end

data/app/helpers/ruh_roh/errors_helper.rb

@@ -0,0 +1,4 @@
+module RuhRoh
+  module ErrorsHelper
+  end
+end

data/app/views/layouts/ruh_roh/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>RuhRoh</title>
+  <%= stylesheet_link_tag    "ruh_roh/application", :media => "all" %>
+  <%= javascript_include_tag "ruh_roh/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/ruh_roh/errors/404.html.erb

@@ -0,0 +1,2 @@
+<h1>The page you were looking for doesn't exist.</h1>
+<p>You may have mistyped the address or the page may have moved.</p>

data/app/views/ruh_roh/errors/422.html.erb

@@ -0,0 +1,2 @@
+<h1>The change you wanted was rejected.</h1>
+<p>Maybe you tried to change something you didn't have access to.</p>

data/app/views/ruh_roh/errors/500.html.erb

@@ -0,0 +1,2 @@
+<h1>I'm sorry, but something went wrong.</h1>
+<p>We've been notified about this issue and we'll take a look at it shortly.</p>

data/config/routes.rb

@@ -0,0 +1,3 @@
+RuhRoh::Engine.routes.draw do
+  match ":id", :to=>"errors#error"
+end

data/lib/ruh_roh/engine.rb

@@ -0,0 +1,5 @@
+module RuhRoh
+  class Engine < ::Rails::Engine
+    isolate_namespace RuhRoh
+  end
+end

data/lib/ruh_roh/generator.rb

@@ -0,0 +1,33 @@
+
+module RuhRoh
+  class Generator
+
+    def generate!
+      config.handled_errors.each do |action|
+        app.get "/error/#{action}"
+        if app.response.code == "200"
+          File.open("public/#{action}.html", "w") { |f| f.write app.response.body }
+        else
+          raise app.response.body
+        end
+      end
+    end
+
+    private
+
+    def config
+      Rails.configuration.ruh_roh
+    end
+
+    def app
+      @app ||= (
+        require "rails/console/app"
+        extend Rails::ConsoleMethods
+
+        app.host = config.application_host
+        app
+      )
+    end
+  end
+
+end

data/lib/ruh_roh/version.rb

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

data/lib/ruh_roh.rb

@@ -0,0 +1,13 @@
+require "ruh_roh/engine"
+require "ruh_roh/generator"
+
+module RuhRoh
+  class Engine < Rails::Engine
+    initializer "ruh_roh.some_init_task" do |app|
+      RuhRohConfig = Struct.new(:application_layout, :application_host, :handled_errors)
+      app.config.ruh_roh = RuhRohConfig.new
+      app.config.ruh_roh.application_layout = "application"
+      app.config.ruh_roh.handled_errors = %w(404 422 500)
+    end
+  end
+end

data/lib/tasks/ruh_roh_tasks.rake

@@ -0,0 +1,6 @@
+namespace :ruh_roh do
+  desc "generates error pages"
+  task :generate => :environment do
+    RuhRoh::Generator.new.generate!
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: ruh_roh
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Scott Windsor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-03-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 3
+        - 2
+        - 12
+        version: 3.2.12
+  requirement: *id001
+  prerelease: false
+  type: :runtime
+  name: rails
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  requirement: *id002
+  prerelease: false
+  type: :development
+  name: rspec-rails
+description: "    While rails' default error pages are great, they look totally unprofessional for any real site.\n    RuRoh provides a quick and easy way to have nicely rendered error pages generated from your stack\n    during deployment. This allows you to re-use your existing layouts and customize your error pages\n    without having to re-create them on the fly (which could result in further errors). The pages can\n    be generated via capistrano during deploy, or generated during a post-commit hook similar to asset\n    pipeline resources.\n"
+email: 
+- swindsor@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/assets/javascripts/generate_error/errors.js
+- app/assets/stylesheets/generate_error/application.css
+- app/assets/stylesheets/generate_error/errors.css
+- app/controllers/ruh_roh/application_controller.rb
+- app/controllers/ruh_roh/errors_controller.rb
+- app/helpers/ruh_roh/application_helper.rb
+- app/helpers/ruh_roh/errors_helper.rb
+- app/views/layouts/ruh_roh/application.html.erb
+- app/views/ruh_roh/errors/404.html.erb
+- app/views/ruh_roh/errors/422.html.erb
+- app/views/ruh_roh/errors/500.html.erb
+- config/routes.rb
+- lib/ruh_roh/engine.rb
+- lib/ruh_roh/generator.rb
+- lib/ruh_roh/version.rb
+- lib/ruh_roh.rb
+- lib/tasks/ruh_roh_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://github.com/sentientmonkey/ruh_roh
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: RuhRoh is a rails plugin that allows you pre-generate error pages with the full rails stack available.
+test_files: []
+