exception_handler 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b14313cb847dd5ad1e6f11c110439c3f9f02891
-  data.tar.gz: d481b5a7a526fbdffe2a8bd71379a5362e6414c5
+  metadata.gz: 9910d9ea8a74498ce664a912a9615bed8e8c9ce1
+  data.tar.gz: 20e2b4badb0d3bab269375565f0b8e7141c9bca6
 SHA512:
-  metadata.gz: fe3128237d98b4c903a96a04a44e6bf313f3861e3ab859b6be2d623dbb3a20862a4479dd3a25270038f62efd501612283158fb2af82e0134840dbc94ec3e7fbb
-  data.tar.gz: 4ce1ea49e147e2f2a423ce041decfa4f99d4acfa024d2e176f01bd958be54cc515b7b24c8ac69c77bbf502ec20f281bb74607aea00fff1b7c759379ec031efd4
+  metadata.gz: a2be4863eb8b102b2ecd78bd9d8895d08f2b276b31b7ecc9e497c76a7f1594efe1a5ddda192851b7a47173fca23137a3a786b0d376dcceed050d65693fdac6f0
+  data.tar.gz: f75a584b9264900b20d8af0f495318ca9a17db5c6b773526396838bad23898f4a4ec7de8902f22f3cd25c6dc874428040021d93433af6061ebbd542458b8f2ab

data/README.md

@@ -1,4 +1,4 @@
-# ExceptionHandler
+# [![Exception Handler](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/exception_handler.png "Exception Handler Logo")](http://frontlineutilities.co.uk/ruby-on-rails/exception-handler)
 
 [![Gem Version](https://badge.fury.io/rb/exception_handler.svg)](http://badge.fury.io/rb/exception_handler)
 [![Code Climate](https://codeclimate.com/github/richpeck/exception_handler.png)](https://codeclimate.com/github/richpeck/exception_handler)
@@ -6,14 +6,13 @@
 [![Coverage Status](https://coveralls.io/repos/richpeck/exception_handler/badge.png)](https://coveralls.io/r/richpeck/exception_handler)
 [![Build Status](https://travis-ci.org/richpeck/exception_handler.svg?branch=master)](https://travis-ci.org/richpeck/exception_handler)
 
-**ExceptionHandler** Rails Gem (adapted from [this tutorial](https://gist.github.com/wojtha/8433843))
 
-> - **[Custom Error Pages](#custom-error-pages)**
-> - **[Save Errors To DB](#save-errors-to-db)**
+[**ExceptionHandler** Rails Gem](https://rubygems.org/gems/exception_handler) (adapted from [this tutorial](https://gist.github.com/wojtha/8433843) & our own middleware)
 
 Works with the [`config.exceptions_app`](http://guides.rubyonrails.org/configuring.html#rails-general-configuration) hook in Rails' middleware stack:
 
-```config.exceptions_app sets the exceptions application invoked by the ShowException middleware when an exception happens. Defaults to ActionDispatch::PublicExceptions.new(Rails.public_path).```
+    config.exceptions_app sets the exceptions application invoked by the ShowExceptionmiddleware
+    when an exception happens. Defaults to ActionDispatch::PublicExceptions.new(Rails.public_path).
 
 -----------
 

data/app/controllers/exception_handler/exception_controller.rb

@@ -5,7 +5,7 @@ module ExceptionHandler
     respond_to :html, :xml, :json
 
   	#Dependencies
-  	before_action :status
+  	before_action :status, :app_name
 
     #Layout
     layout :layout_status
@@ -51,7 +51,12 @@ module ExceptionHandler
 
     #Layout
     def layout_status
-      @status.to_s == "404" ? "application" : "error"
+      "error" if @status.to_s != "404"
+    end
+
+    #App
+    def app_name
+      @app_name   = Rails.application.class.parent_name
     end
 
   end

data/app/views/exception_handler/exception/show.html.haml

@@ -1,7 +1,15 @@
-.box
-	%h1
-		= details[:name]
-	%p
-		= details[:message]
+.error
+	/Alert
+	= image_tag 'exception_handler/alert.png', width: "150", alt: "Error!", title: "Sorry, A Server Error Occurred", class: "alert"
 
-		= ExceptionHandler.config.db
+	/Message
+	.message
+		%strong
+			= details[:name]
+		%span
+			= details[:message]
+
+	/Contact
+	.contact
+		- ExceptionHandler.config.social.each do |item, address|
+			%a{ href: address }> #{image_tag "exception_handler/contact/#{item}.png", title: item.to_s.titleize}

data/app/views/layouts/error.html.haml

@@ -3,7 +3,8 @@
 	%head
 
 		/Info
-		= meta_tags
+		%title
+			= "Error :: #{@app_name}"
 
 		/Styling
 		:sass
@@ -18,36 +19,45 @@
 			.error_container 
 				display: block
 				margin: auto
-				margin: 10% auto 0 auto
+				margin: 15% auto 0 auto
 				width: 40%
 			
 			.error_container .error 
 				display: block 
 				text-align: center
 			
-			.error_container .error img 
+			.error_container .error img.icon
 				display: block
-				margin: 0 auto 15px auto
+				margin: 0 auto 25px auto
 			
 			.error_container .message > * 
 				display: block
 			
 			.error_container .message strong 
-				font-weight: bold
+				font:
+					weight: bold
+					size: 1.5em
 				color: #f00
+				margin: 15px 0 0
+
+			.error_container .message span
+				margin: 5px auto 0
+				font:
+					size: 0.75em
+				color: #606060
 			
-			.error_container .contact_info 
+			.error_container .contact 
 				display: block
 				text-align: center
-				margin: 25px 0 0 0
+				margin: 20px 0 0 0
 			
-			.error_container .contact_info a 
+			.error_container .contact a 
 				display: inline-block
-				margin: 0
+				margin: 0 1px
 				opacity: 0.4
 				transition: opacity 0.15s ease
 			
-			.error_container .contact_info a:hover 
+			.error_container .contact a:hover 
 				opacity: 0.8
 			
 

data/lib/exception_handler.rb

@@ -16,20 +16,24 @@ module ExceptionHandler
 	#Exception Handler
 	class Exceptions < Rails::Engine
 		initializer "exception_handler.configure_rails_initialization" do |app|
-			app.config.middleware.use "ExceptionHandler::Message" #Parser
+			app.config.middleware.use "ExceptionHandler::Message" unless ExceptionHandler.config.db == false #Parser
 			app.config.exceptions_app = ->(env) { ExceptionHandler::ExceptionController.action(:show).call(env) } #Pages
 		end
 	end
 
-	#Config
+	####################
+	#      Config      #
+	####################
+
 	#Ref http://robots.thoughtbot.com/mygem-configure-block
-	mattr_accessor :config
+	mattr_accessor :config, :table
 
-	#Init Config
+	#Vars
 	@@config ||= Config.new
 
 	#Block (for initializer)
 	def self.setup
 		yield(config) if block_given?
 	end
+
 end

data/lib/exception_handler/config.rb

@@ -5,10 +5,17 @@
 ###########################################
 module ExceptionHandler
   class Config
-    attr_accessor :db
+	attr_accessor :db, :social
 
-    def initialize
-      @db = false # -> db name (false = no; true = "errors"; [value] = [value])
+	def initialize
+		@db = false # -> db name (false = no; true = "errors"; [value] = [value])
+		@social = {
+			twitter: 	"http://twitter.com/frontlineutils",
+			facebook: 	"https://facebook.com/frontline.utilities",
+			linkedin: 	"https://linkedin.com/company/frontline-utilities",
+			youtube: 	"http://youtube.com/frontlineutils",
+			fusion: 	"http://frontlinefusion.com/frontlineutils"
+		}
     end
   end
 end

data/lib/exception_handler/version.rb

@@ -1,3 +1,3 @@
 module ExceptionHandler
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/lib/generators/exception_handler/install_generator.rb

@@ -1,7 +1,51 @@
 module ExceptionHandler
 	class InstallGenerator < Rails::Generators::Base
-		def create_initializer_file
-			create_file "config/initializers/exception_handler.rb", "# Add initialization content here"
+
+		#Needed to reference files
+		source_root File.expand_path("../../templates", __FILE__) 
+
+		#Option
+		class_option :assets, desc: 'Add views, controllers, models & assets to app (for customization)'
+		class_option :migration, type: :boolean, desc: 'Create migration'
+				
+		#Config
+		def create_config_file
+			return unless options.empty?
+			template "exception_handler.rb", "config/initializers/exception_handler.rb" # https://github.com/plataformatec/devise/blob/master/lib/generators/devise/install_generator.rb#L13
+		end
+
+		#Assets
+		def create_customization assets = options.assets
+ 			#(views / controllers / models / assets)
+ 			return unless assets
+	 		file_generator assets
+		end
+
+		#Migration
+		def create_migration
+			return unless options.migration?
+			template "create_table.rb", "db/migrate/create_table.rb" #-> Need to use ActiveRecord::Generators::Base
+		end
+
+		protected
+
+		#File Generator
+		def file_generator args = options, options = %w(views controllers models assets)
+
+			#Valid?
+			return raise "Invalid Argument" unless options.include? args
+
+			#Types
+			if args.is_a? String
+				create_file "config/initializers/#{args}.rb", "# Add initialization content here"
+			elsif args.is_a? Array
+				for arg in args do
+					create_file "config/initializers/#{arg}.rb", "# Add initialization content here" #Need to use template
+				end
+			else
+				raise "Sorry, you either need to use 'views', 'controllers', 'models', 'assets' as the --files options"
+			end
+
 		end
 	end
 end

data/lib/generators/templates/create_errors.rb

@@ -0,0 +1,14 @@
+class CreateErrors < ActiveRecord::Migration
+  def change
+    create_table :errors do |t|
+      t.text :class_name
+      t.text :message
+      t.text :trace
+      t.text :target_url
+      t.text :referer_url
+      t.text :params
+      t.text :user_agent
+      t.timestamps
+    end
+  end
+end

data/lib/generators/templates/create_table.rb

@@ -0,0 +1,14 @@
+class CreateErrors < ActiveRecord::Migration
+  def change
+    create_table :errors do |t|
+      t.text :class_name
+      t.text :message
+      t.text :trace
+      t.text :target_url
+      t.text :referer_url
+      t.text :params
+      t.text :user_agent
+      t.timestamps
+    end
+  end
+end

data/lib/generators/templates/exception_handler.rb

@@ -4,11 +4,23 @@
 #Use the docs at http://github.com/richpeck/exception_handler for info
 ###
 ExceptionHandler.setup do |config|
+
 	#DB - 
 	#Default = false / true ("errors")
 	#Options = [string] = sets db name (if use true, default is "errors")
-	config.db = true
+	config.db = "errors"
+
 	#Email -
 	#Default = false / true
 	#config.email = 
+
+	#Social
+	config.social = {
+		twitter: 	"http://twitter.com/frontlineutils",
+		facebook: 	"https://facebook.com/frontline.utilities",
+		linkedin: 	"https://linkedin.com/company/frontline-utilities",
+		youtube: 	"http://youtube.com/frontlineutils",
+		fusion: 	"http://frontlinefusion.com/frontlineutils"
+	}
+
 end

data/spec/installation_spec.rb

@@ -0,0 +1,18 @@
+#Coveralls
+require 'coveralls'
+Coveralls.wear!
+
+###########################################
+
+require 'spec_helper'
+
+###########################################
+
+describe "test" do
+
+  describe "404 Error" do
+    it "will show custom 404 error page" do
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_handler
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Richard Peck
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,10 +120,13 @@ files:
 - lib/exception_handler/config.rb
 - lib/exception_handler/parser.rb
 - lib/exception_handler/version.rb
-- lib/generators/exception_handler/config_generator.rb
 - lib/generators/exception_handler/install_generator.rb
+- lib/generators/templates/create_errors.rb
+- lib/generators/templates/create_table.rb
 - lib/generators/templates/exception_handler.rb
+- readme/exception_handler.png
 - spec/exception_spec.rb
+- spec/installation_spec.rb
 - spec/spec_helper.rb
 - vendor/assets/images/exception_handler/bg.png
 homepage: http://frontlineutilities.co.uk/ror/custom_error_pages
@@ -153,4 +156,5 @@ summary: Rails gem to show custom error pages in production. Also logs errors in
   db if required
 test_files:
 - spec/exception_spec.rb
+- spec/installation_spec.rb
 - spec/spec_helper.rb

data/lib/generators/exception_handler/config_generator.rb

@@ -1,9 +0,0 @@
-module ExceptionHandler
-	class ConfigGenerator < Rails::Generators::Base
-		source_root File.expand_path("../../templates", __FILE__) #Needed to reference files
-
-		def create_initializer_file
-			template "exception_handler.rb", "config/initializers/exception_handler.rb" # https://github.com/plataformatec/devise/blob/master/lib/generators/devise/install_generator.rb#L13
-		end
-	end
-end