RubyGems - exception_handler - Versions diffs - 0.5.1 → 0.6.0 - Mend

exception_handler 0.5.1 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (47) hide show

checksums.yaml +4 -4
data/.gitignore +1 -1
data/.travis.yml +4 -4
data/Gemfile +1 -3
data/README.md +111 -98
data/app/assets/images/exception_handler/connect/facebook.png +0 -0
data/app/assets/images/exception_handler/connect/fusion.png +0 -0
data/app/assets/images/exception_handler/connect/linkedin.png +0 -0
data/app/assets/images/exception_handler/connect/twitter.png +0 -0
data/app/assets/images/exception_handler/connect/youtube.png +0 -0
data/app/assets/images/exception_handler/noise.png +0 -0
data/app/assets/images/favicon.ico +0 -0
data/app/assets/stylesheets/exception_handler.css.erb +18 -0
data/app/assets/stylesheets/styles/_base.css.erb +34 -0
data/app/assets/stylesheets/styles/_exception.css.erb +105 -0
data/app/assets/stylesheets/styles/_footer.css.erb +27 -0
data/app/assets/stylesheets/styles/_responsive.css +5 -0
data/app/controllers/exception_handler/exception_controller.rb +28 -33
data/app/mailers/exception_handler/exception_mailer.rb +17 -0
data/app/models/exception_handler/exception.rb +191 -0
data/app/views/exception_handler/exception/show.html.erb +3 -32
data/app/views/exception_handler/mailers/layout.haml +8 -0
data/app/views/exception_handler/mailers/layout.text.erb +1 -0
data/app/views/exception_handler/mailers/new_exception.erb +4 -0
data/app/views/layouts/exception.html.erb +15 -23
data/config/locales/exception_handler.en.yml +13 -0
data/exception_handler.gemspec +61 -16
data/lib/exception_handler.rb +20 -79
data/lib/exception_handler/config.rb +20 -22
data/lib/exception_handler/engine.rb +36 -0
data/lib/generators/exception_handler/migration_generator.rb +28 -10
data/lib/generators/exception_handler/views_generator.rb +5 -5
data/lib/generators/templates/migration.rb.erb +12 -11
metadata +41 -64
data/app/assets/images/exception_handler/close.png +0 -0
data/app/assets/images/exception_handler/home.png +0 -0
data/app/assets/stylesheets/exception_handler/error.css.erb +0 -309
data/app/helpers/exception_handler/application_helper.rb +0 -56
data/app/models/exception_handler/error.rb +0 -14
data/app/services/exception_handler/exception.rb +0 -34
data/config/locales/en.yml +0 -9
data/lib/exception_handler/parse.rb +0 -23
data/lib/exception_handler/parser/data.rb +0 -59
data/lib/exception_handler/parser/ignore.rb +0 -32
data/lib/exception_handler/version.rb +0 -3
data/post_install_message.md +0 -53
data/spec/helpers/exception_handler/application_helper_spec.rb +0 -42

data/app/views/exception_handler/mailers/layout.haml ADDED

@@ -0,0 +1,8 @@
+!!!
+%html
+  %head
+    %meta{:content => "text/html; charset=utf-8", "http-equiv" => "Content-Type"}/
+    :css
+      /* Email styles need to be inline */
+  %body
+    = yield

data/app/views/exception_handler/mailers/layout.text.erb ADDED

	@@ -0,0 +1 @@
1	+ <%= yield %>

data/app/views/exception_handler/mailers/new_exception.erb ADDED

@@ -0,0 +1,4 @@
+<h1><%= Rails.application.class.parent_name %> (<%= Rails.env.titleize %>)</h1>
+<strong><u><%= @exception.response %> (<%= @exception.status %>)</u></strong>
+<p><%= @exception.message %></p>

data/app/views/layouts/exception.html.erb CHANGED

@@ -1,29 +1,21 @@
 <!DOCTYPE html>
 <html>
+  <!-- Head -->
   <head>
-    <!--Info -->
-    <title><%= "Error - #{@exception.status} Error (#{details[:name]})" %></title>
-    <%= stylesheet_link_tag "exception_handler/error" %>
+    <%= content_tag :title, "Error - #{@exception.status} (#{@exception.response.to_s.gsub("_", " ").titleize})" %>
+    <%= stylesheet_link_tag :exception_handler %>
+    <%= favicon_link_tag %>
   </head>
-  <!--Body -->
-  <body>
-    <div class="container">
-      <%= yield %>
-    </div>
-    <!-- Footer -->
-    <footer>
-    	<div class="connect">
-    		<%= social %>
-    	</div>
-    	<div class="app">
-    		<strong><%= link_to app, main_app.root_url, title: "Go to index" %></strong>
-    		<span> - <%= @exception.status %> Error</span>
-    	</div>
-    </footer>
+  <!-- Body -->
+  <%= content_tag :body, yield %>
-  </body>
-</html>
+  <!-- Footer -->
+  <% if ExceptionHandler.config.try(:social) %>
+    <%= content_tag :footer do %>
+      <% ExceptionHandler.config.social.each do |k,v| %>
+        <%= link_to image_tag("exception_handler/connect/#{k}.png"), v[:url] + "/" + v[:name], id: v[:name] if v %>
+      <% end %>
+    <% end %>
+  <% end %>
+</html>

data/config/locales/exception_handler.en.yml ADDED

@@ -0,0 +1,13 @@
+##################################
+##################################
+# Have to use strings rather than integers
+##################################
+##################################
+en:
+  exception:
+    not_found:              "Page missing"
+    internal_server_error:  "<strong>Our server experienced an error. Our developers have been notified and are resolving it:</strong>  %{message}"
+##################################
+##################################

data/exception_handler.gemspec CHANGED

@@ -1,21 +1,56 @@
-# coding: utf-8
+# Dependencies
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'exception_handler/version'
+##############################################################
+##############################################################
+# => Version
+# => https://github.com/rails/rails/blob/master/version.rb
+module ExceptionHandler
+  module VERSION
+    MAJOR = 0
+    MINOR = 6
+    TINY  = 0
+    PRE   = nil # "alpha"
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end
+# => Declaration
+# => https://github.com/rails/rails/blob/master/rails.gemspec#L1
+version = ExceptionHandler::VERSION::STRING
+##############################################################
+##############################################################
+# => Gem
 Gem::Specification.new do |s|
-  # General
+  ##############################################################
+  # => General
+  s.platform      = Gem::Platform::RUBY
   s.name          = "exception_handler"
-  s.version       = ExceptionHandler::VERSION
+  s.version       = version
+  # => Author
   s.authors       = ["Richard Peck"]
   s.email         = ["rpeck@frontlineutilities.co.uk"]
+  # => Details
   s.summary       = %q{Rails gem to show custom error pages in production. Also logs errors in db & sends notification emails}
   s.description   = %q{Rails gem to create custom error pages. Captures exceptions using "exception_app" callback, routing to "Exception" controller, rendering the view as required.}
   s.homepage      = "http://github.com/richpeck/exception_handler"
+  # => License
   s.license       = "MIT"
-  # Files
+  ##############################################################
+  # => Files
+  # => Remove "readme" dir from gem
   s.files         = `git ls-files -z`.split("\x0")
   s.files.reject! { |fn| fn.include? "readme" } #-> https://github.com/gauntlt/gauntlt/blob/master/gauntlt.gemspec#L16
@@ -23,17 +58,27 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/}) unless RUBY_VERSION >= "2.2.0" #-> deprecated in Ruby 2.2.0
   s.require_paths = ["lib"]
-  # Options
-  s.post_install_message = File.read(File.join(File.dirname(__FILE__), 'post_install_message.md')) #-> https://github.com/jarrett/ichiban/blob/master/ichiban.gemspec#L35
+  ##############################################################
+  # => Ruby
+  s.required_ruby_version = ">= 2.1.0"
-  # dev Dependencies
-  s.add_development_dependency "bundler", "~> 1.6"
-  s.add_development_dependency "rails", "~> 4.0.0"
-  s.add_development_dependency "activerecord"
-  s.add_development_dependency "activesupport"
+  # => Runtime
+  s.add_dependency "bundler",    "~> 1.6"
+  s.add_dependency "rails",      ">= 4.2.0"
+  s.add_dependency "responders", "~> 2.3"
+  # => Extras
+  s.add_development_dependency "autoprefixer-rails"
+  # => Dev
+  # => For testing etc
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", "~> 3.3"
-  s.add_development_dependency "rspec-rails", "~> 3.3"
-  s.add_development_dependency "sqlite3", "~> 1.3.10"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "sqlite3",     ">= 1.3.10"
+##############################################################
+##############################################################
-end
+end

data/lib/exception_handler.rb CHANGED

@@ -1,88 +1,29 @@
-###########################################
-#Core Dependencies
-require "action_dispatch"
-#Libs
-#http://stackoverflow.com/a/4528011/1143732
-#http://stackoverflow.com/a/21693468/1143732
-#https://github.com/jekyll/jekyll/blob/master/lib/jekyll.rb#L8
-Dir.glob(File.join(File.dirname(__FILE__), "exception_handler", '**/*.rb'), &method(:require))
-###########################################
+#########################################################
+#########################################################
 module ExceptionHandler
-  #Config
-  #Invoke instance of config (ExceptionHandler.config) -- loads defaults -- can merge through class
-  mattr_accessor :config
-  #Default (has to init so is available in all areas)
-  @@config = "" #-> should initialize class & then append in initializer
-  # Class methods
-  class << self
-    # Don't have prefix method return anything.
-    # This will keep Rails Engine from generating all table prefixes with the engines name
-    # http://stackoverflow.com/questions/19435214/rails-mountable-engine-with-isolate-namespace-but-without-prefixed-namespace-on
-    def table_name_prefix
-      #No prefix
-    end
+  # => Table Prefix
+  # => Keeps Rails Engine from generating all table prefixes with the engines name
+  # => http://stackoverflow.com/questions/19435214/rails-mountable-engine-with-isolate-namespace-but-without-prefixed-namespace-on
+  def self.table_name_prefix
+    # => No prefix
   end
-  #########################
-  #Exception Handler
-  class Engine < Rails::Engine
-    #Keep helpers in your engine
-    #http://guides.rubyonrails.org/engines.html#inside-an-engine
-    #http://stackoverflow.com/questions/31877839/accessing-helpers-from-the-parent-app-in-an-isolated-rails-engine
-    #use main_app to call "main app" helpers etc http://stackoverflow.com/a/9178022/1143732 + http://edgeapi.rubyonrails.org/classes/Rails/Engine.html#class-Rails::Engine-label-Using+Engine-27s+routes+outside+Engine
-    isolate_namespace ExceptionHandler
-    #Tests (generates dummy Rails app)
-    #http://stackoverflow.com/q/32082637/1143732 (ref in question)
-    config.generators do |g|
-      g.test_framework :rspec
-    end
-    #Assets
-    config.assets.precompile << %w(exception_handler/**)
-    #Config
-    config.before_initialize do |app|
-      ExceptionHandler.config = ExceptionHandler::Config.new app.config.try(:exception_handler) #-> Var
-    end
-    #Boot order:
-    #http://api.rubyonrails.org/classes/Rails/Application.html#class-Rails::Application-label-Booting+process
-    #1)  require "config/boot.rb" to setup load paths
-    #2)  require railties and engines
-    #3)  Define Rails.application as "class MyApp::Application < Rails::Application"
-    #4)  Run config.before_configuration callbacks
-    #5)  Load config/environments/ENV.rb
-    #6)  Run config.before_initialize callbacks
-    #7)  Run Railtie#initializer defined by railties, engines and application.
-    #    One by one, each engine sets up its load paths, routes and runs its config/initializers/* files.
-    #8)  Custom Railtie#initializers added by railties, engines and applications are executed
-    #9)  Build the middleware stack and run to_prepare callbacks
-    #10) Run config.before_eager_load and eager_load! if eager_load is true
-    #11) Run config.after_initialize callbacks
-    #Hook
-    #Needs to fire before better_errors (for dev)
-    initializer :exception_handler, before: "better_errors.configure_rails_initialization" do |app| #-> "before" ref - http://blog.carbonfive.com/2011/02/25/configure-your-gem-the-rails-way-with-railtie/ && http://apidock.com/rails/Rails/Initializable/Initializer/before - should degrade gracefully
+  # => Config
+  # => Invoke instance of config (ExceptionHandler.config)
+  mattr_accessor :config
-      #Action
-      app.config.middleware.use ExceptionHandler::Parse if ExceptionHandler.config.try(:db) #-> DB
-      app.config.exceptions_app = ->(env) { ExceptionHandler::ExceptionController.action(:show).call(env) } #-> Controller
+end
-      #Dev
-      #Logic needed after initialize (app data)
-      app.config.consider_all_requests_local = false if Rails.env.development? and ExceptionHandler.config.try(:dev)
-    end
+#########################################################
+#########################################################
-  end
-end
+# => Libs
+# => http://stackoverflow.com/a/4528011/1143732
+# => http://stackoverflow.com/a/21693468/1143732
+# => https://github.com/jekyll/jekyll/blob/master/lib/jekyll.rb#L8
+Dir.glob(File.join(File.dirname(__FILE__), 'exception_handler', '**/*.rb'), &method(:require))
-###########################################
+#########################################################
+#########################################################

data/lib/exception_handler/config.rb CHANGED

@@ -16,17 +16,23 @@ module ExceptionHandler
       #Init
       def initialize values=nil
-        defaults = values.present? ? Config::DEFAULTS.deep_merge!(values) : Config::DEFAULTS
+        defaults = values.present? ? Config::DEFAULTS.deep_merge!(values) : DEFAULTS
         defaults.each do |k,v|
-          instance_variable_set("@#{k}",v) #-> http://apidock.com/ruby/Object/instance_variable_set
+          instance_variable_set("@#{k}",v) #-> http://apidock.com/ruby/Object/instance_variable_set
         end
+        # => Errors
+        raise(Exception, "ExceptionHandler :: Valid Email Required") if @email && !@email.is_a?(String)
+        #raise(Exception, "ExceptionHandler :: Migration Required → Table \"#{db}\" doesn't exist") if @db && !ActiveRecord::Base.connection.table_exists?(db)
       end
-      # INSTANCE METHODS #
+    ###########################################
+      # Public (Instance) Methods #
       #DB
       def db
-        @db == true ? Config::TABLE_NAME : @db
+        @db == true ? TABLE_NAME : @db
       end
     ###########################################
@@ -38,31 +44,23 @@ module ExceptionHandler
       # Defaults
       # http://stackoverflow.com/a/8917301/1143732
       DEFAULTS = {
-        dev: 	  false, #-> defaults to "false" for dev mode
+        dev:    false, #-> defaults to "false" for dev mode
         db:     false, #-> defaults to :errors if true, else use "table_name" / :table_name
-        email: 	false, #-> need to integrate
+        email: 	false, #-> requires string email and ActionMailer
         social: {
-          :facebook 	=> 	'frontline.utilities',
-          :twitter 	  => 	'frontlineutils',
-          :youtube 	  =>	'frontlineutils',
-          :linkedin 	=> 	'frontline-utilities',
-          :fusion 	  => 	'frontlineutils',
-          :url => {
-            :facebook 	=> 	'https://facebook.com',
-            :twitter 	  => 	'http://twitter.com',
-            :youtube 	  =>	'https://youtube.com/user',
-            :linkedin 	=> 	'https://linkedin.com/company',
-            :fusion 	  => 	'https://frontlinefusion.com',
-          },
+          facebook: { name: "frontline.utilities", url: "https://facebook.com" },
+          twitter:  { name: "frontlineutils",      url: "http://twitter.com" },
+          youtube:  { name: "frontlineutils",      url: "https://youtube.com/user" },
+          linkedin: { name: "frontline-utilities", url: "https://linkedin.com/company" },
+          fusion:   { name: "flutils",             url: "https://frontlinefusion.com" }
         },
         layouts: {
-          '404' => nil, #-> 404 Callback (needs improving big time) Use the following: '404' => <<-EOF redirect_to root_url, notice: "Hello" EOF
-          '400' => nil, #-> layout for 400 error code (404 should only be used as response)
-          '500' => 'exception'
+          "400" => nil, # => inherits from "ApplicationController" layout
+          "500" => "exception"
         },
       }
     ###########################################
   end
-end
+end

data/lib/exception_handler/engine.rb ADDED

@@ -0,0 +1,36 @@
+module ExceptionHandler
+  class Engine < Rails::Engine
+    #########################################################
+    #########################################################
+      # => Wraps helpers in ExceptionHandler module
+      # => http://guides.rubyonrails.org/engines.html#inside-an-engine
+      # => http://stackoverflow.com/questions/31877839/accessing-helpers-from-the-parent-app-in-an-isolated-rails-engine
+      isolate_namespace ExceptionHandler
+      # => Tests
+      config.generators do |g|
+        g.test_framework :rspec
+      end
+      # => Assets
+      # => For Sprockets 4, had to include link_tree in exception_handler.css
+      config.assets.precompile << %w(exception_handler.css)
+    #########################################################
+    #########################################################
+      # => Hooks
+      # => This should be config.before_initialize but because ActiveRecord is not initialized, cannot check for table
+      initializer :exception_handler, before: "better_errors.configure_rails_initialization" do |app|
+        ExceptionHandler.config ||= ExceptionHandler::Config.new config.try(:exception_handler)                       # => Vars
+        app.config.exceptions_app = ->(env) { ExceptionHandler::ExceptionController.action(:show).call(env) }         # => Rails
+        app.config.consider_all_requests_local = false if Rails.env.development? && ExceptionHandler.config.try(:dev) # => Dev
+      end
+    #########################################################
+    #########################################################
+  end
+end

data/lib/generators/exception_handler/migration_generator.rb CHANGED

@@ -1,37 +1,55 @@
 ###########################################
 require 'rails/generators/active_record'
+require 'exception_handler/exception' # => ATTRS constant (for attributes)
 ###########################################
-#Migration Generator (for adding errors table)
-#Ref: https://github.com/plataformatec/devise/blob/master/lib/generators/active_record/devise_generator.rb
+# => 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
+    # => Name - from http://old.thoughtsincomputation.com/posts/cgfr3-part-3-adding-a-generator
     argument :name, default: "migration"
-    #Source of Migrations
+    # => Source of Migrations
     source_root File.expand_path("../../templates", __FILE__)
     ###########################################
-    #Table Name - false = off, true = errors, value = value
-    #Always outputs string for some reason...
+    # => Table Name - false = off, true = errors, value = value
+    # => Always outputs string for some reason...
     def table_name
       ExceptionHandler.config.db
     end
     ###########################################
-    #Create
+    # => Create
     def create_errors_migration
-      migration_template "migration.rb.erb", "db/migrate/create_errors.rb"
+      migration_template "migration.rb.erb", "db/migrate/create_#{table_name.to_s.gsub("_","")}.rb", migration_version: migration_version
+    end
+    ###########################################
+    # => From Devise
+    # => https://github.com/plataformatec/devise/blob/master/lib/generators/active_record/devise_generator.rb#L81
+    # => Rails 5?
+    def rails5?
+      Rails.version.start_with? '5'
+    end
+    # => Migration Version
+    def migration_version
+      if rails5?
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
     end
     ###########################################
   end
-end
+end