exception_handler 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcd9b5923dc39f43b43beb02ee3004ea850f3103
-  data.tar.gz: f9c1174fe636735617607af47e51cf5b43eb178b
+  metadata.gz: e68469b36f2f889baf7991a21d4efdb17a276e15
+  data.tar.gz: a031a71aafe2fd6b637cc0bf56b06ef92eccf575
 SHA512:
-  metadata.gz: b85c858abce97e7937823922a0981caae1b3dbdd0ae639a52431b4a3f139a7ee2661adf38307846829b4a6d7d293be26ada2546d15711f6632892d77f7fff69a
-  data.tar.gz: a3705b63eb93501674d6dd829c98bee369ef70911377177c742c7293d81e737cd4e409d4d22554076b79241eeaeafbcc74b2505b49acdc264504d4fd13d60c93
+  metadata.gz: 103e17d288c47a132c6fbecd30292ec29d3d92204b1739534b17eff5900f3b9e8a0688ffb18f7b2e220491552bc76dff7412d90686dc295663aedf95abdd934b
+  data.tar.gz: a0c49c6a9503d7e95172126801743d3553bc82f628a9bcdbb53919722441aea68dcc39f0e9c3651309c05df16c0a792542ef8a05b03dc6eb0f4c5ba31b45638a

data/Gemfile

@@ -5,7 +5,10 @@ gemspec
 
 ###########################################
 
+#For Testing
 group :test do
+	gem 'rspec-rails'
+	gem 'rails', '~> 4.1.1'
 	gem 'coveralls', require: false
 end
 

data/README.md

@@ -18,14 +18,14 @@ Works with the [`config.exceptions_app`](http://guides.rubyonrails.org/configuri
 
 ####Custom Error Pages
 
-You can deploy *custom error pages*. These allow you to serve your own design error pages in production; showing both the error, and the problem. This is a big step forward from the standard Rails error reporting facility
+`ExceptionHandler` deploys *custom error pages*. These allow you to serve your own design error pages in production; showing both the error, and the problem. This is a big step forward from the standard Rails error reporting facility
 
 There are two types of error page: 
 
 	- 404 errors
 	- 500 errors (+ other)
 
-The **`404`** error is standard (missing page) - we use your own `layout` for this. The **`500 & other errors`** are `server` issues, and so we have included an `errors` layout (`/views/layouts/errors.html.haml`).
+The custom **`404`** error uses your own `layout`. The **`500 & other errors`** are `server` issues, and so we have included an `errors` layout (`/views/layouts/errors.html.haml`).
 
 The `errors` layout in important. If you try and load your "standard" layout with an internal server error, all your
 "supporting" functionality is called too. Problem? You're likely going to cause even more errors.
@@ -35,7 +35,8 @@ You can change them by using the **`rails generate exception_handler:assets --vi
 
  **500 Errors** | **404 Errors**
 --- | ---
-![500 Server Error Pages](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/500.png "500 Server Error Page") | ![404 Server Error Pages](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/500.png "404 Server Error Page") 
+![500 Server Error Pages](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/500.png "500 Server Error Page") | ![404 Server Error Pages](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/404.png "404 Server Error Page") 
+Uses **errors** layout | Uses **standard** layout
 
 -----------
 
@@ -56,7 +57,7 @@ Sometimes, you want to save your errors to your database (admin areas, multi-ten
 This db allows you to track, read & repair errors in your application on the fly. We deploy this in our admin areas, to help us
 appreciate any issues on our client apps.
 
-![500 Server Error Pages](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/db.png "500 Server Error Page")
+![Errors Table](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/db.png "Errors Table")
 
 This functionality is **`disabled`** by default
 
@@ -67,33 +68,89 @@ To enable, you need to do the following:
 	- rake db:migrate #-> creates `errors` table
 
 	- config/initializers/exception_handler.rb
+	- ExceptionHandler.setup do |config|
+	-    config.db = true
+	- end
 
 ---------
 
 ## Installation
 
+###Step1 
+
+You need to reference the [`exception_handler`](http://rubygems.org/gems/exception_handler) gem. Once you have downloaded the gem, you'll be able to deploy it in your application.
+
 Add this line to your application's Gemfile:
 
-    gem 'exception_handler'
+	gem 'exception_handler'
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+**Or** install it yourself as:
 
     $ gem install exception_handler
 
+![gem install](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/gem_install.png "gem install")
+
+--
+
+###Step2
+
+Run:
+
+	rails generate exception_handler:install
+
+![Installation](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/install.png "Installation")
+
+This will create `config/initializers/exception_handler.rb`. Whilst not vital, it will give you 
+access to the configuration options which can change the gem's behavior:
+
+![Config File](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/config.png "Configuration")
+
+--
+
+###Database
+
+If you want to set up the database, you will need to use the `migration installer`:
+
+	$ rails generate exception_handler:migration
+
+This creates:
+
+	$ rake db:migrate
+
+This will migrate the datatable for you. Now you need to change `config.db = true`
+
+![DB Config](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/config_db.png "Config DB")
+
+
+---------
+
 ###Configuration
 
+[Exception handler](https://rubygems.org/gems/exception_handler) comes with 3 installers
+
+**You only need to use `rails generate exception_handler:install`**. The others allow you to include files on your system, or create the `errors` table.
+
 	# General
-	$ rails generate exception_handler:install
+	$ rails generate exception_handler:install #-> installs "config" file (initializer)
+
+![Install](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/install.png "Standard Install")
+
 
 	# Migration
-	$ rails generate exception_handler:migrate
+	$ rails generate exception_handler:migration #-> generates migration for "errors" table
+
+![Migration Install](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/install_migration.png "Migration Install")
+
 
 	# Files
-	$ rails generate exception_handler:assets
+	$ rails generate exception_handler:views #-> controller, models, views & assets
+	$ rails generate exception_handler:views -v views controllers models assets #-> remove as appropriate to install individual assets
+
+![Views Install](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/install_views.png "Views Install")
 
 
 
@@ -101,22 +158,34 @@ Or install it yourself as:
 
 ## Usage
 
-###Dev
+###Development Environment
+
+**[`config.exceptions_app`](http://guides.rubyonrails.org/configuring.html#rails-general-configuration)** is only used in Rails' production environment. Therefore, if you wish to **test the gem in dev**,
+you'll need to make your app process requests as `production` for now. This is a temporary step, and will be
+resolved in a new version:
 
 	#config/environments/development.rb
 	config.consider_all_requests_local = false # true
 
-`config.exceptions_app` is used in Rails' production environment. Therefore, if you wish to test the gem in dev,
-you'll need to make your app process requests as `production` for now. This is a temporary step, and will be
-resolved in a new version
+![Development Testing](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/development.png "Development Testing")
+
+You should change this setting if you wish to test your styling in development mode. Please note **it should be temporary**
 
-###Production
+--
+
+###Production Environment
 
     No action required
 
+---------
+
 ###Demo
 
-Demo to be put onto Heroku etc
+**404 Error** | **500 Error**
+:---: | :---:
+[![404 Error Page](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/404_demo.png "404 Error Page Demo")](http://firststopcosmeticshop.co.uk/sdfsdf/sdf/sdfsdf) | [![500 Error Page](https://raw.githubusercontent.com/richpeck/exception_handler/master/readme/500_demo.png "500 Error Page Demo")](http://firststopcosmeticshop.co.uk/search/fasdfasdfasdfasdfasdf)
+[Link](http://firststopcosmeticshop.co.uk/sdfsdf/sdf/sdfsdf) | [Link](http://firststopcosmeticshop.co.uk/search/fasdfasdfasdfasdfasdf)
+
 
 --------
 

data/app/controllers/exception_handler/exception_controller.rb

@@ -56,7 +56,7 @@ module ExceptionHandler
 
     #App
     def app_name
-      @app_name   = Rails.application.class.parent_name
+      @app_name = Rails.application.class.parent_name
     end
 
   end

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

@@ -1,15 +1,18 @@
-.error
-	/Alert
-	= image_tag 'exception_handler/alert.png', width: "150", alt: "Error!", title: "Sorry, A Server Error Occurred", class: "alert"
+- if @status.to_s == "404"
+	Sorry, this page is missing!
+- else
+	.error
+		/Alert
+		= image_tag 'exception_handler/alert.png', width: "150", alt: "Error!", title: "Sorry, A Server Error Occurred", class: "alert"
 
-	/Message
-	.message
-		%strong
-			= details[:name]
-		%span
-			= details[:message]
+		/Message
+		.message
+			%strong
+				= details[:name]
+			%span
+				= details[:message]
 
-	/Contact
-	.contact
-		- ExceptionHandler.config.social.each do |item, address|
-			%a{ href: address, target: "_blank" }> #{image_tag "exception_handler/contact/#{item}.png", title: item.to_s.titleize}
+		/Contact
+		.contact
+			- ExceptionHandler.config.social.each do |item, address|
+				%a{ href: address, target: "_blank" }> #{image_tag "exception_handler/contact/#{item}.png", title: item.to_s.titleize}

data/exception_handler.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rails", "~> 4.0.0"
   spec.add_development_dependency "haml", "~> 4.0.5"
   spec.add_development_dependency "sass", "~> 3.3.7"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "activesupport"  
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/lib/exception_handler/config.rb

@@ -1,8 +1,11 @@
 ###########################################
+
 # Refs
 # http://stackoverflow.com/questions/10584638/setting-up-configuration-settings-when-writing-a-gem
 # http://robots.thoughtbot.com/mygem-configure-block
+
 ###########################################
+
 module ExceptionHandler
   class Config
 	attr_accessor :db, :social

data/lib/exception_handler/version.rb

@@ -1,3 +1,3 @@
 module ExceptionHandler
-  VERSION = "0.2.7"
+  VERSION = "0.3.0"
 end

data/lib/generators/exception_handler/install_generator.rb

@@ -1,51 +1,20 @@
 module ExceptionHandler
-	class InstallGenerator < Rails::Generators::Base
+	class Generators
+		class InstallGenerator < Rails::Generators::Base
 
-		#Needed to reference files
-		source_root File.expand_path("../../templates", __FILE__) 
+			#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"
+			#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
 
+			###########################################
+
 		end
 	end
 end

data/lib/generators/exception_handler/migration_generator.rb

@@ -0,0 +1,27 @@
+###########################################
+
+require 'rails/generators/active_record'
+
+###########################################
+
+#Migration Generator (for adding errors table)
+#Ref: https://github.com/plataformatec/devise/blob/master/lib/generators/active_record/devise_generator.rb
+
+module ExceptionHandler
+  class MigrationGenerator < ActiveRecord::Generators::Base
+  
+  		#Name - from http://old.thoughtsincomputation.com/posts/cgfr3-part-3-adding-a-generator
+  		argument :name, default: "migration"
+
+		#Source of Migrations
+		source_root File.expand_path("../../templates", __FILE__)
+
+		###########################################
+
+		#Create Migration
+		def create_errors_migration
+			migration_template "create_table.rb", "db/migrate/create_errors.rb"
+		end
+
+	end
+end

data/lib/generators/exception_handler/views_generator.rb

@@ -0,0 +1,42 @@
+module ExceptionHandler
+	class ViewsGenerator < Rails::Generators::Base
+
+		#Views
+		@@views = %w(views controllers models assets)
+
+		#Options
+		class_option :files, aliases: "-v", default: @@views, type: :array, desc: "Select file types (views, models, controllers, assets)"
+
+		#Needed to reference files
+		source_root File.expand_path("../../../../app", __FILE__) 
+
+		###########################################
+
+		#Files
+		def create_files
+			generate_files options.files
+		end
+
+		###########################################
+
+		protected
+
+		#File Generator
+		def generate_files args
+
+			#Valid?
+			return raise args.inspect unless args.nil? || (args-@@views).empty?
+
+			#Types
+			for arg in args do
+				directory arg, "app/#{arg}"
+			end
+
+			#Success
+			puts "Files transferred successfully"
+		end
+
+		###########################################
+
+	end
+end

data/lib/generators/templates/create_table.rb

@@ -1,13 +1,15 @@
 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.string  :usable_type
+      t.integer :usable_id
+      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

data/lib/generators/templates/exception_handler.rb

@@ -6,9 +6,8 @@
 ExceptionHandler.setup do |config|
 
 	#DB - 
-	#Default = false / true ("errors")
-	#Options = [string] = sets db name (if use true, default is "errors")
-	config.db = "errors"
+	#Options = false / true
+	config.db = false
 
 	#Email -
 	#Default = false / true

data/spec/installation_spec.rb

@@ -1,18 +1,24 @@
-#Coveralls
-require 'coveralls'
-Coveralls.wear!
-
 ###########################################
 
 require 'spec_helper'
 
 ###########################################
 
-describe "test" do
+class InstallationSpec < Rails::Generators::TestCase
+
+	#Setup
+	tests ExceptionHandler::Generators::InstallGenerator
+	destination File.expand_path("../../tmp", __FILE__)
+
+	#Before
+	setup do
+		prepare_destination
+		run_generator
+	end
 
-  describe "404 Error" do
-    it "will show custom 404 error page" do
-    end
-  end
+	#Config Installer
+	test "assert Config Files Are Created" do 
+		assert_file "config/initializers/exception_handler.rb"
+	end
 
 end

data/spec/spec_helper.rb

@@ -4,6 +4,25 @@
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+#Coveralls
+require 'coveralls'
+Coveralls.wear!
+
+#Env
+ENV["RAILS_ENV"] = 'test'
+
+#Rails
+#require 'rails'
+#require 'active_support'
+
+#For Generators
+require "rails/generators/test_case"
+require "generators/exception_handler/install_generator"
+
+
+###########################################
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_handler
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Richard Peck
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-31 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.3.7
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +139,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/images/exception_handler/alert.png
+- app/assets/images/exception_handler/bg.png
+- app/assets/images/exception_handler/contact/facebook.png
+- app/assets/images/exception_handler/contact/fusion.png
+- app/assets/images/exception_handler/contact/linkedin.png
+- app/assets/images/exception_handler/contact/twitter.png
+- app/assets/images/exception_handler/contact/youtube.png
 - app/controllers/exception_handler/exception_controller.rb
 - app/models/exception_handler/error.rb
 - app/views/exception_handler/exception/show.html.haml
@@ -121,22 +156,25 @@ files:
 - lib/exception_handler/parser.rb
 - lib/exception_handler/version.rb
 - lib/generators/exception_handler/install_generator.rb
-- lib/generators/templates/create_errors.rb
+- lib/generators/exception_handler/migration_generator.rb
+- lib/generators/exception_handler/views_generator.rb
 - lib/generators/templates/create_table.rb
 - lib/generators/templates/exception_handler.rb
+- readme/404.png
+- readme/404_demo.png
 - readme/500.png
+- readme/500_demo.png
+- readme/config.png
+- readme/config_db.png
 - readme/db.png
+- readme/development.png
 - readme/exception_handler.png
-- spec/exception_spec.rb
+- readme/gem_install.png
+- readme/install.png
+- readme/install_migration.png
+- readme/install_views.png
 - spec/installation_spec.rb
 - spec/spec_helper.rb
-- vendor/assets/images/exception_handler/alert.png
-- vendor/assets/images/exception_handler/bg.png
-- vendor/assets/images/exception_handler/contact/facebook.png
-- vendor/assets/images/exception_handler/contact/fusion.png
-- vendor/assets/images/exception_handler/contact/linkedin.png
-- vendor/assets/images/exception_handler/contact/twitter.png
-- vendor/assets/images/exception_handler/contact/youtube.png
 homepage: http://frontlineutilities.co.uk/ror/custom_error_pages
 licenses:
 - MIT
@@ -163,6 +201,5 @@ specification_version: 4
 summary: Rails gem to show custom error pages in production. Also logs errors in "errors"
   db if required
 test_files:
-- spec/exception_spec.rb
 - spec/installation_spec.rb
 - spec/spec_helper.rb

data/lib/generators/templates/create_errors.rb

@@ -1,14 +0,0 @@
-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/spec/exception_spec.rb

@@ -1,18 +0,0 @@
-#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