exception_handler 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d804786a9e059b8d5ac5b055892c16d42f58d55f
-  data.tar.gz: 1e27dda5d5a2cabd8470c352d1cc186851c695ca
+  metadata.gz: 7b14313cb847dd5ad1e6f11c110439c3f9f02891
+  data.tar.gz: d481b5a7a526fbdffe2a8bd71379a5362e6414c5
 SHA512:
-  metadata.gz: ef0e66479c5055ac155826555636428f23466255d8a060fe4b428b7558a1f2556fb6c8e9d3877125e7bf1dacf1379e35f0fc9214e51476458e90daf975f7a0aa
-  data.tar.gz: be954599ca3c05944b191c7167ba87dc57d980d90cf0ffa0cc185a2ea1baa863f93230fe58cf5e8a055c4d6ee2bf41d43b2bc8b73a67a336aee70b5c07e82643
+  metadata.gz: fe3128237d98b4c903a96a04a44e6bf313f3861e3ab859b6be2d623dbb3a20862a4479dd3a25270038f62efd501612283158fb2af82e0134840dbc94ec3e7fbb
+  data.tar.gz: 4ce1ea49e147e2f2a423ce041decfa4f99d4acfa024d2e176f01bd958be54cc515b7b24c8ac69c77bbf502ec20f281bb74607aea00fff1b7c759379ec031efd4

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -1,4 +1,5 @@
 rvm:
+ - 1.9.3
  - 2.0.0
  - 2.1.1
  - ruby-head

data/Gemfile

@@ -2,3 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in custom_error_pages.gemspec
 gemspec
+
+###########################################
+
+group :test do
+	gem 'coveralls', require: false
+end
+
+###########################################

data/README.md

@@ -8,10 +8,24 @@
 
 **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)**
+
 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).```
 
+-----------
+
+####Custom Error Pages
+
+You can create *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
+
+
+
+####Save Errors To DB
+
+Sometimes, you want to save your errors to your database (admin areas, multi-tenant apps, etc). We've included some middleware which captures the routes 
 
 ---------
 
@@ -29,6 +43,24 @@ Or install it yourself as:
 
     $ gem install exception_handler
 
+###Generators
+
+	# General
+	$ rails generate exception_handler:install
+
+	#Config (for db)
+	$ rails generate exception_handler:config
+
+	#Assets
+	$ rails generate exception_handler:assets:all
+	-
+	$ rails generate exception_handler:assets:views
+	$ rails generate exception_handler:assets:controllers
+	$ rails generate exception_handler:assets:models
+	$ rails generate exception_handler:assets:assets
+
+
+
 ---------
 
 ## Usage
@@ -46,9 +78,25 @@ resolved in a new version
 
     No action required
 
+###Demo
+
+Demo to be put onto Heroku etc
 
 --------
 
+## Support
+
+If you need help, you may consider:
+
+1. Watching this [**video tutorial**](http://www.youtube.com/watch?v=Zo2vav3dYnY):
+
+   [![ExceptionHandler Update](http://img.youtube.com/vi/Zo2vav3dYnY/0.jpg)](http://www.youtube.com/watch?v=Zo2vav3dYnY)
+2. Read [**our tutorial**](http://google.com)
+3. Ask on [**StackOverflow**](http://stackoverflow.com)
+4. Go on the [**gem support page**](http://frontlineutilities.co.uk)
+
+---------
+
 ## Contributing
 
 1. Fork it ( https://github.com/richpeck/exception_handler/fork )

data/Rakefile

@@ -1,2 +1,8 @@
-require "bundler/gem_tasks"
-
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+###########################################
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/models/exception_handler/error.rb

@@ -0,0 +1,9 @@
+module ExceptionHandler
+	class Error < ActiveRecord::Base
+		#Table is called "errors"
+		#Dev needs to use migration to create db
+
+		#Associations
+		belongs_to :usable, polymorphic: true
+	end
+end

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

@@ -3,3 +3,5 @@
 		= details[:name]
 	%p
 		= details[:message]
+
+		= ExceptionHandler.config.db

data/exception_handler.gemspec

@@ -6,8 +6,8 @@ require 'exception_handler/version'
 Gem::Specification.new do |spec|
   spec.name          = "exception_handler"
   spec.version       = ExceptionHandler::VERSION
-  spec.authors       = ["Richard Peck"]
-  spec.email         = ["rpeck@frontlineutilities.co.uk"]
+  spec.authors       = ["Richard Peck", "Joe Hilton"]
+  spec.email         = ["rpeck@frontlineutilities.co.uk", "jhilton@frontlineutilities.co.uk"]
   spec.summary       = %q{Rails gem to show custom error pages in production. Also logs errors in "errors" db if required}
   spec.description   = %q{Rails gem to create custom error pages. Captures exceptions using "exception_app" callback, routing to "Exception" controller, rendering the view as required.}
   spec.homepage      = "http://frontlineutilities.co.uk/ror/custom_error_pages"
@@ -22,4 +22,6 @@ 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 "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/exception_handler.rb

@@ -1,9 +1,13 @@
 ###########################################
 
+#Core Dependencies
 require "action_dispatch"
 
-require "exception_handler/version"
-require "exception_handler/parser"
+#Gem Files
+versions = %w(version parser config)
+for version in versions do
+	require "exception_handler/#{version}"
+end
 
 ###########################################
 
@@ -17,4 +21,15 @@ module ExceptionHandler
 		end
 	end
 
+	#Config
+	#Ref http://robots.thoughtbot.com/mygem-configure-block
+	mattr_accessor :config
+
+	#Init Config
+	@@config ||= Config.new
+
+	#Block (for initializer)
+	def self.setup
+		yield(config) if block_given?
+	end
 end

data/lib/exception_handler/config.rb

@@ -0,0 +1,14 @@
+###########################################
+# 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
+
+    def initialize
+      @db = false # -> db name (false = no; true = "errors"; [value] = [value])
+    end
+  end
+end

data/lib/exception_handler/parser.rb

@@ -42,7 +42,7 @@ module ExceptionHandler
 		#Save
 		def save
 			ActiveRecord::Base.logger.silence do
-				#ExceptionHandler::Error.create(relevant_info)
+				ExceptionHandler::Error.create(relevant_info)
 			end
  			log(relevant_info)
 		end

data/lib/exception_handler/version.rb

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

data/lib/generators/exception_handler/config_generator.rb

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

data/lib/generators/exception_handler/install_generator.rb

@@ -0,0 +1,7 @@
+module ExceptionHandler
+	class InstallGenerator < Rails::Generators::Base
+		def create_initializer_file
+			create_file "config/initializers/exception_handler.rb", "# Add initialization content here"
+		end
+	end
+end

data/lib/generators/templates/exception_handler.rb

@@ -0,0 +1,14 @@
+#Exception Handler
+###
+#You can add different settings using this block
+#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
+	#Email -
+	#Default = false / true
+	#config.email = 
+end

data/spec/exception_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

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: exception_handler
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.5
 platform: ruby
 authors:
 - Richard Peck
+- Joe Hilton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,27 +67,64 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.3.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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'
 description: Rails gem to create custom error pages. Captures exceptions using "exception_app"
   callback, routing to "Exception" controller, rendering the view as required.
 email:
 - rpeck@frontlineutilities.co.uk
+- jhilton@frontlineutilities.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - app/controllers/exception_handler/exception_controller.rb
+- app/models/exception_handler/error.rb
 - app/views/exception_handler/exception/show.html.haml
 - app/views/layouts/error.html.haml
 - exception_handler.gemspec
 - lib/exception_handler.rb
+- 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/exception_handler.rb
+- spec/exception_spec.rb
+- spec/spec_helper.rb
 - vendor/assets/images/exception_handler/bg.png
 homepage: http://frontlineutilities.co.uk/ror/custom_error_pages
 licenses:
@@ -113,4 +151,6 @@ signing_key:
 specification_version: 4
 summary: Rails gem to show custom error pages in production. Also logs errors in "errors"
   db if required
-test_files: []
+test_files:
+- spec/exception_spec.rb
+- spec/spec_helper.rb