simplificator_infrastructure 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5b01844361849db3b53d7fa1a7cd6e17029bfe8
+  data.tar.gz: b2a4ee3dd65383d3f54351a2ad4cefafcaaf705d
+SHA512:
+  metadata.gz: 03584be764cda1872bb3dd01e15055f8ded7975e7ea5dfb6c21c4a533affcc4658419a34c58d86af4b17cdd847ff6cd09b60262ca972e128239b58e0087d4be7
+  data.tar.gz: b535999662ed60bd16a9d9915042205d49cec3172e7068deafa9a9587ade7d660705aab9c1117dbc3585a7e0e65e2c390cd4dac49e8c9c18c9e3c10f101cade3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Pascal Betz
+
+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,73 @@
+= SimplificatorInfrastructure
+
+This project rocks and uses MIT-LICENSE.
+
+
+SimplificatorInfrastructure provides re-usable code for Rails Webapps.
+
+== Error Pages
+
+Shows neat error pages when exceptions are raised.
+It is implemented as exception app which is a special rack app which gets called when an error occurs inside the rack middleware chain.
+
+
+=== Installation
+
+````
+  gem 'simplificator_infrastructure'
+````
+
+
+=== Usage
+
+In order to enable the error page handling do something like this:
+
+````
+  SimplificatorInfrastructure::ErrorPageHandler.register
+
+  # As this will hide useful information for developers
+  # you might want to do this depending on the environment
+  if Rails.env.production?
+    SimplificatorInfrastructure::ErrorPageHandler.register
+  end
+
+````
+
+Note: it's best if you do this in an after_initialize block or in an initializer file (initializers/*.rb) because
+in order for the error pages to work consider_all_requests_local needs to be false.
+Some environments set it to true which might override this again because of the order of the calls.
+
+=== Customize Error pages
+
+You can add an error page per HTTP status code. I.e. a custom 500, 404, ... error page. The gem comes with
+
+* 404 (is shown when a routing error occurs)
+* generic (is shown in all other cases)
+
+If a specific page is present then it is rendered, else the generic one is shown.
+
+To add or customize an error page you can add a view at
+
+app/views/errors/xxx.html.something
+
+where XXX is the status code
+
+Or add
+
+app/views/errors/generic_error.html.erb to replace the generic error view.
+
+=== Translations
+
+Translations are provided for
+
+* de
+* en
+
+If you want to add more translations just add the keys to your locale files.
+
+Please make sure that I18n has
+
+* available_locales
+* default_locale
+
+properly set.

data/Rakefile

@@ -0,0 +1,35 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SimplificatorInfrastructure'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/simplificator_infrastructure/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,17 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+

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

@@ -0,0 +1,39 @@
+body.simplificator_infrastrcture.errors {
+  background-color: #fff;
+  text-align: center;
+  font-family: 'Helvetica Neue', helvetica, arial sans-serif;
+}
+
+body.simplificator_infrastrcture.errors h1 {
+  color: #646464;
+  font-size: 75px;
+  font-weight: 300;
+}
+
+body.simplificator_infrastrcture.errors a {
+  color: #646464;
+}
+
+body.simplificator_infrastrcture.errors p.lead {
+  font-size: 30px;
+  font-weight: 300;
+  margin-bottom: 10px;
+  line-height: 45px;
+  color: #333333;
+}
+
+body.simplificator_infrastrcture.errors  p {
+  font-size: 16px;
+  margin-bottom: 40px;
+  line-height: 26px;
+  color: #888;
+}
+
+body.simplificator_infrastrcture.errors img.icon {
+  width: 80px;
+}
+
+body.simplificator_infrastrcture.errors img.logo {
+  width: 150px;
+  margin-top: 30px;
+}

data/app/controllers/simplificator_infrastructure/application_controller.rb

@@ -0,0 +1,4 @@
+module SimplificatorInfrastructure
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/simplificator_infrastructure/errors_controller.rb

@@ -0,0 +1,47 @@
+class SimplificatorInfrastructure::ErrorsController < ActionController::Base
+  around_filter :with_locale
+
+  layout 'simplificator_infrastructure/errors'
+  helper_method :error_summary
+
+
+  def render_error
+    render template, status: error_summary.status_code
+  end
+
+  private
+
+  def template
+    if specific_error_template_exists?
+      specific_template
+    else
+      generic_template
+    end
+  end
+
+  def specific_template
+    "errors/#{error_summary.status_code}"
+  end
+
+  def generic_template
+    'errors/generic_error'
+  end
+
+  def specific_error_template_exists?
+    lookup_context.template_exists?(error_summary.status_code, "errors", false)
+  end
+
+  def error_summary
+    @error_summary ||= begin
+      ::SimplificatorInfrastructure::ErrorSummary.new(env: env)
+    end
+  end
+
+  # sets the locale and resets afterwards for I18n.t to work in error templates
+  def with_locale
+    I18n.with_locale(error_summary.locale) do
+      yield
+    end
+  end
+
+end

data/app/helpers/simplificator_infrastructure/application_helper.rb

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

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

@@ -0,0 +1,9 @@
+<div class="content">
+  <h1 class="error"><%= I18n.t("simplificator_infrastructure.errors.404.title") %></h1>
+  <p class="lead"><%= I18n.t("simplificator_infrastructure.errors.404.lead") %></p>
+  <p><%= I18n.t("simplificator_infrastructure.errors.404.text").html_safe %></p>
+  <p>
+    <%= image_tag("simplificator_infrastructure/errors/error_404.png", class: 'icon')%>
+    <br/>
+    <%= image_tag('simplificator_infrastructure/errors/logo.png') %>
+</div>

data/app/views/errors/generic_error.html.erb

@@ -0,0 +1,9 @@
+<div class="content">
+  <h1 class="error"><%= I18n.t("simplificator_infrastructure.errors.generic.title") %></h1>
+  <p class="lead"><%= I18n.t("simplificator_infrastructure.errors.generic.lead") %></p>
+  <p><%= I18n.t("simplificator_infrastructure.errors.generic.text").html_safe %></p>
+  <p>
+    <%= image_tag("simplificator_infrastructure/errors/error_generic.png", class: 'icon')%>
+    <br/>
+    <%= image_tag('simplificator_infrastructure/errors/logo.png') %>
+</div>

data/app/views/layouts/simplificator_infrastructure/errors.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= I18n.t('simplificator_infrastructure.errors.page_title') %></title>
+    <%= stylesheet_link_tag    "simplificator_infrastructure/application", media: "all" %>
+    <%= javascript_include_tag "simplificator_infrastructure/application" %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body class="errors simplificator_infrastrcture">
+    <%= yield %>
+  </body>
+</html>

data/config/locales/de.yml

@@ -0,0 +1,13 @@
+de:
+  simplificator_infrastructure:
+    errors:
+      page_title: 'Ein Fehler ist aufgetreten'
+
+      generic:
+        title: 'Ohhh!'
+        lead: "Die Anfrage konnte leider nicht beantwortet werden."
+        text: "Wir sind benachrichtig worden und schauen uns das an. Bitte versuchen Sie es später nochmals"
+      '404':
+        title: "Oooops!"
+        lead: "Diese Seite existiert nicht (mehr)"
+        text: "Bitte gehen Sie <a href=\"/\">zurück</a> und fangen nochmals an."

data/config/locales/en.yml

@@ -0,0 +1,13 @@
+en:
+  simplificator_infrastructure:
+    errors:
+      page_title: 'An error occured'
+
+      generic:
+        title: 'Ohhh!'
+        lead: "We had a problem serving your request."
+        text: "We have been notified and will take care of this.<br/>Please try again later."
+      '404':
+        title: "Oooops!"
+        lead: "The page does not exist."
+        text: "Please go <a href=\"/\">back</a> and start over."

data/config/routes.rb

@@ -0,0 +1,2 @@
+SimplificatorInfrastructure::Engine.routes.draw do
+end

data/lib/simplificator_infrastructure.rb

@@ -0,0 +1,4 @@
+require "simplificator_infrastructure/engine"
+
+module SimplificatorInfrastructure
+end

data/lib/simplificator_infrastructure/engine.rb

@@ -0,0 +1,8 @@
+module SimplificatorInfrastructure
+  class Engine < ::Rails::Engine
+    isolate_namespace SimplificatorInfrastructure
+  end
+end
+
+require_relative 'error_summary'
+require_relative 'error_page_handler'

data/lib/simplificator_infrastructure/error_page_handler.rb

@@ -0,0 +1,21 @@
+class SimplificatorInfrastructure::ErrorPageHandler
+
+  def self.register
+    disable_all_requests_local
+    register_exception_app
+  end
+
+  private
+
+  def self.disable_all_requests_local
+    Rails.application.config.consider_all_requests_local = false
+  end
+
+  def self.register_exception_app
+    Rails.application.config.exceptions_app= lambda do |env|
+      action = SimplificatorInfrastructure::ErrorsController.action(:render_error)
+      action.call(env)
+    end
+  end
+
+end

data/lib/simplificator_infrastructure/error_summary.rb

@@ -0,0 +1,61 @@
+class SimplificatorInfrastructure::ErrorSummary
+
+  attr_reader :env
+
+  def initialize(options = {})
+    @env = options[:env]
+  end
+
+  # detects the status code based on the exception that was thrown
+  def status_code
+    @status_code ||= ActionDispatch::ExceptionWrapper.new(env, exception).status_code
+  end
+
+  # extracts the exception from env
+  def exception
+    env['action_dispatch.exception']
+  end
+
+  def params
+    env['action_dispatch.request.parameters']
+  end
+
+  # tries to detect locale based on #available_locales
+  # and a locale which is in the path, in the accept header or default
+  def locale
+    detected_locale = path_locale || params_locale || accept_locale || default_locale
+    available_locales.include?(detected_locale) ? detected_locale : default_locale
+  end
+
+  private
+
+  def default_locale
+    I18n.default_locale
+  end
+
+  def params_locale
+    locale = params['locale']
+    locale.to_sym if locale
+  end
+
+  def path_locale
+    path = env['REQUEST_PATH']
+    # RE is built on the fly to avoid load order issues with I18n.available_locales
+    locales_matcher = available_locales.map(&:to_s).join('|')
+    match = path.match(/\A\/(#{locales_matcher})\/.*\z/)
+    match[1].to_sym if match && match[1]
+  end
+
+  def available_locales
+    I18n.available_locales
+  end
+
+  # Gets the first two letter locale from HTTP_ACCEPT_LANGUAGE header
+  # (ignoring de_DE style locales and expecting locales to be ordered by quality)
+  def accept_locale
+    accept_header = env['HTTP_ACCEPT_LANGUAGE']
+    accept_header.scan(/^[a-z-]{2}/).try(:first).try(:to_sym)
+  end
+
+
+end