static_errors 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 366b74b0021aac86c4a4ecde8e580f50b927007d
+  data.tar.gz: 33a48b256aa1285b5f78dda53b6211b23915b5f2
+SHA512:
+  metadata.gz: f4da41c54d7169ffff20eb62c05fb6b076532ecc7cb62d635531cfb487adb3a9c795de4663509b0fc0a183606c9e2e7a7152e672a1d7ecc031de3d91a2ede074
+  data.tar.gz: 6d02934eefe496f267386fdc6c4c92c7123de3fa8c7bea080baed35d79af3d80101260ba97a10944ae6e54333dabb9c3c1fa5f3fd371c6272b327084dd0eb609

data/README.md

@@ -0,0 +1,55 @@
+# Overview
+
+StaticErrors is a gem to help with the creation of static error pages. It allows you to 
+use a dynamically generated page as a template, so all of your default styling and layouts
+can be used to design the error page. This dynamic page is then saved for static rendering.
+
+# Syntax
+
+    rake static_errors <options: option=value,value2>
+
+| Options | Use | Default |
+| --- | --- | --- |
+| path | Changes the dynamic error root url | http://localhost:3000/errors/ |
+| languages | Any additional languages to save | <none> |
+| errors | Which errors to save | <none> |
+| destination | Where to save the static error pages | public/ |
+
+
+# Use Cases
+
+## 1: Basic Operations
+
+    rake static_errors errors=404
+
+    Saving http://localhost:3000/errors/404 to public/404.html
+
+
+## 2: Multiple Errors
+
+    rake static_errors errors=422,500
+
+    Saving http://localhost:3000/errors/422 to public/422.html
+    Saving http://localhost:3000/errors/500 to public/500.html
+
+
+## 3: Multiple Languages
+
+    rake static_errors errors=422 languages=en-GB,de
+
+    Saving http://localhost:3000/errors/422 to public/422.html
+    Saving http://localhost:3000/errors/422?locale=en-GB to public/422.en-GB.html
+    Saving http://localhost:3000/errors/422?locale=de to public/422.de.html
+
+
+## 4: Custom URL / Filepaths
+
+    rake static_errors errors=422 path=http://mytestserver/special_errors/ destination=public/local/errors/
+
+    Saving http://mytestserver/special_errors/422 to public/local/errors/422.html
+
+
+# Final Considerations
+
+You may wish to check the urls of any externally referenced files needed to render your
+error pages. ex: Should jquery/bootstrap/etc be at the same url for your static errors?

data/lib/static_errors.rb

@@ -0,0 +1,3 @@
+module StaticErrors
+  require "static_errors/railtie.rb" if defined?(Rails)
+end

data/lib/static_errors/railtie.rb

@@ -0,0 +1,10 @@
+require 'static_errors'
+require 'rails'
+
+module StaticErrors
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      require 'static_errors/tasks/static_errors.rb'
+    end
+  end
+end

data/lib/static_errors/tasks/static_errors.rb

@@ -0,0 +1,38 @@
+def save(source, dest)
+  puts "Saving #{source} to #{dest}"
+  
+  a = Mechanize.new
+  a.get(source) do |page|
+    File.delete(dest) if File.exist?(dest)
+    page.save dest
+  end
+end
+
+task :static_errors => :environment do
+  @path = 'http://localhost:3000/errors/'
+  @languages = ''
+  @errors = ''
+  @destination = "public/"
+  
+  @path = ENV["path"] if ENV["path"]
+  @languages = ENV["languages"] if ENV["languages"]
+  @errors = ENV["errors"] if ENV["errors"]
+  @destination = ENV["destination"] if ENV["destination"]
+  
+=begin
+  puts "Path: #{@path}"
+  puts "Languages #{@languages}"
+  puts "Errors #{@errors}"
+  puts "Destination #{@destination}"
+=end
+
+  languages = @languages.split(',')
+  errors = @errors.split(',')
+  
+  errors.each do |error|
+    save("#{@path}#{error}", "#{@destination}#{error}.html")
+    languages.each do |language|
+      save("#{@path}#{error}?locale=#{language}", "#{@destination}#{error}.#{language}.html")
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: static_errors
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- shogarth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Saves dynamic pages as a static error file
+email: shogarth@shogarth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/static_errors.rb
+- lib/static_errors/railtie.rb
+- lib/static_errors/tasks/static_errors.rb
+homepage: http://shogarth.com
+licenses:
+- Copyright 2014 - All Rights Reserved
+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.0.0.rc.2
+signing_key: 
+specification_version: 4
+summary: Static Errors
+test_files: []