static_error_pages 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: edd5ae7a438aa70c6f805c8f76c79417c9c9d2c247d55427b8b86282a7851138
+  data.tar.gz: 4262cb87418728eb0e64d9c8b7c552c2bda6d4f9873d26dfed8f6cbae4d4c7c7
+SHA512:
+  metadata.gz: 5def53668dea2221670c6cd0f10dfced127c5f1b8ecf17ed4eabf05bcdeaa8f5058d44c9e79adc64928a593af3b21e151cae398e1262e952d110cb44c02004ae
+  data.tar.gz: 9c61b36c8682410bfa859d97016527bfa32f2d659007b7610c6ba702bc88ed7891f213c698c1237194d80b5ebec0261a62f5c3cd920a2887c04a34c60de714da

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Stefan Wienert
+
+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,15 @@
+# StaticErrorPages
+
+Quick'n Dirty static error pages generator for Rails
+
+- Relies on ``ApplicationController.renderer`` to generate 404.html, 500.html, 503.html, 422.html during deploy
+- Adds a rake task ``bundle exec rails assets:error_pages`` and adds that to ``precompile`` for auto deployment.
+
+This is a Rails Engine, and it provides some German language SLIM templates which should be copied over:
+
+```
+bundle exec rails g static_error_pages:copy
+```
+
+Afterwards, adjust the files in ``app/views/error_pages/*``, especially the layout file and include a minimalistic CSS for the error page.
+

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'StaticErrorPages'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/views/error_pages/404.html.slim

@@ -0,0 +1,2 @@
+h1 Nicht gefunden
+p Diese Seite wurde leider nicht gefunden.

data/app/views/error_pages/422.html.slim

@@ -0,0 +1,4 @@
+h1 = @title = 'Änderung abgelehnt/Formular ungültig'
+p Ihre Formulareingabe konnte aus Sicherheitsgründen nicht bearbeitet werden. Dies kann u.a. auftreten, wenn Sie ein Formular mittels Zurück-Button wieder aufgerufen haben.
+p Bitte probieren Sie es nach einem Seiten Reload erneut. Dies tut uns leid!
+

data/app/views/error_pages/500.html.slim

@@ -0,0 +1,3 @@
+h1 = @title = 'Server-Fehler'
+p Hier ist leider ein Programmier-Fehler passiert. Das tut uns leid.
+p Wir werden über solche Fehler i.d.R. informiert und werkeln vielleicht sogar bereits an der Lösung. Sollte der Fehler bestehen bleiben, wenden Sie sich bitte an unseren Support oder Ihren Community-Manager.

data/app/views/error_pages/503.html.slim

@@ -0,0 +1,2 @@
+h1 = @title = 'Server überlastet oder offline'
+p Dieser Dienst ist momentan überlastet oder nicht verfügbar. Bitte probieren Sie es später noch einmal.

data/app/views/error_pages/layout.html.slim

@@ -0,0 +1,20 @@
+doctype html
+html lang='de'
+  head
+    meta(http-equiv="Content-Type" content="text/html; charset=utf-8")
+    meta[name="viewport" content="width=device-width, initial-scale=1.0"]
+    meta(name="robots" content="noindex")
+    == stylesheet_link_tag "application", media: 'all'
+    title
+      = @title
+      = ' '
+      |– Empfehlungsbund.de
+    //link rel="shortcut icon" href=image_path('favicons/icon.ico')
+  body
+    main(style='min-height: 60vh')
+      .container
+        = yield
+    footer
+
+
+

data/lib/generators/static_error_pages/copy_generator.rb

@@ -0,0 +1,16 @@
+module StaticErrorPages
+
+  class CopyGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../templates", __FILE__)
+
+    desc "Copies over all SLIM-views"
+
+    def copy_views
+      files = Dir["#{StaticErrorPages::Railtie.root.join('app/views')}/**/*.slim"]
+
+      files.each do |file|
+        copy_file(file, "app/views/error_pages/#{File.basename(file)}")
+      end
+    end
+  end
+end

data/lib/static_error_pages.rb

@@ -0,0 +1,5 @@
+require "static_error_pages/railtie"
+
+module StaticErrorPages
+  # Your code goes here...
+end

data/lib/static_error_pages/railtie.rb

@@ -0,0 +1,10 @@
+module StaticErrorPages
+  class Railtie < ::Rails::Engine
+    # generators do
+      # require "path/to/my_railtie_generator"
+    # end
+    config.static_error_pages = ActiveSupport::OrderedOptions.new
+    config.static_error_pages.pages = %w(404.html 500.html 503.html 422.html)
+    config.static_error_pages.layout = '../error_pages/layout'
+  end
+end

data/lib/static_error_pages/version.rb

@@ -0,0 +1,3 @@
+module StaticErrorPages
+  VERSION = '0.1.0'
+end

data/lib/tasks/static_error_pages_tasks.rake

@@ -0,0 +1,20 @@
+# desc "Explaining what the task does"
+# task :static_error_pages do
+#   # Task goes here
+# end
+
+namespace :assets do
+  desc "Generate all configured error-pages"
+  task error_pages: :environment do
+    Rails.application.config.static_error_pages.pages.each do |file|
+      out = ApplicationController.renderer.render("error_pages/#{file}", layout: '../error_pages/layout')
+      public_path = Rails.public_path.join(file)
+      File.write(public_path, out)
+      puts "Generated #{file}"
+    end
+  end
+end
+
+Rake::Task["assets:precompile"].enhance do
+  Rake::Task["assets:error_pages"].invoke
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: static_error_pages
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Wienert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+description: Generate Rails error pages on deployment using application controller
+  renderer
+email:
+- info@stefanwienert.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/views/error_pages/404.html.slim
+- app/views/error_pages/422.html.slim
+- app/views/error_pages/500.html.slim
+- app/views/error_pages/503.html.slim
+- app/views/error_pages/layout.html.slim
+- lib/generators/static_error_pages/copy_generator.rb
+- lib/static_error_pages.rb
+- lib/static_error_pages/railtie.rb
+- lib/static_error_pages/version.rb
+- lib/tasks/static_error_pages_tasks.rake
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Generate Rails error pages on deployment using application-controller renderer
+test_files: []