gaffe 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f11ed5e2f7011f004427fe69184837d35b31af2
-  data.tar.gz: 304c3635b28278b352059fd745e1041179047aa6
+  metadata.gz: dfa9dc27f05fc2fb90bdb304ae0461451cadd7d4
+  data.tar.gz: 7bd1fb55e1684cacd0a7a488f8ae2b75c8a3b5e2
 SHA512:
-  metadata.gz: 0c62e677a735251fd1b3b89d1b9e6a8082f54d881301f1c6beb46a297403506c40345313835a8fa77788630e61b1d1bbc6471c9701d1bc6e4e56a582475ba673
-  data.tar.gz: 7532aaf83cd7de38e20350dc75e1266f5f4a5a1c713be971a0a08bea2c1ea10cf532ec4433b481c638db6ce288444f2b1de34235568b902deeb4706540a6d2bd
+  metadata.gz: 64397092c293a471ccd9022a0fecf91c4b827bbe771d1337f47f34647122fd614953ba29c3f4a744b69e1631fe00ff610b59d04666e9e68dad10c5fe0f1eacb6
+  data.tar.gz: 145f786bf8f153cba5cf7cfd79e773e338f65fd2dc0330beac2ccd4f4ce035c02119d2dd01a62e1af1dd6d98b6760e943e7a0f146cf24ceff9965c0372292bbf

data/.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  Includes:
+    - Gemfile
+    - Rakefile
+
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 200
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+IfUnlessModifier:
+  Enabled: false
+
+CaseIndentation:
+  IndentWhenRelativeTo: case
+  IndentOneStep: true
+
+MethodLength:
+  CountComments: false
+  Max: 20
+
+SignalException:
+  Enabled: false
+
+ColonMethodCall:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false

data/.scss-lint.yml

@@ -0,0 +1,12 @@
+linters:
+  CapitalizationInSelector:
+    enabled: false
+  SortedProperties:
+    enabled: false
+  LeadingZero:
+    enabled: false
+  BorderZero:
+    enabled: false
+  SelectorDepth:
+    enabled: true
+    max_depth: 4

data/.travis.yml

@@ -9,3 +9,11 @@ gemfile:
   - gemfiles/Gemfile.rails-3.2.x
 
 script: "echo 'DO IT' && bundle exec rake spec"
+
+notifications:
+  hipchat:
+    rooms:
+      secure: HwIKOZp8SIVCnPseNTJqZgrUBr7/7z5RGczqX7lGWOXK/S6Zwm/YyglC5ueN+HW2Tsc9nQkVLmLb7fH4kctdeanKea3TTfYS1+GmUOZPhFie4nFnywIgz7os//LfNONIF42Ix94HsmuhsQ6yVPMOU+mYnN9L/ZrWML5NH03mIOw=
+    template:
+      - '%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message} (<a href="%{build_url}">Build</a>/<a href="%{compare_url}">Changes</a>)'
+    format: 'html'

data/README.md

@@ -16,7 +16,7 @@
 
 It comes with default error pages but makes it very easy to override them (which you should do). The default error pages look like this:
 
-![](http://i.imgur.com/9gPfCOm.png)
+![](http://i.imgur.com/nz5nWXn.png)
 
 ## Installation
 
@@ -75,25 +75,39 @@ You might also want to get rid of filters and other stuff to make sure that erro
 ```ruby
 class ErrorsController < ApplicationController
   include Gaffe::Errors
-  skip_before_filter :ensure_current_user
 
+  # Make sure anonymous users can see the page
+  skip_before_filter :authenticate_user!
+
+  # Override 'error' layout
+  layout 'application'
+
+  # Render the correct template based on the exception “standard” code.
+  # Eg. For a 404 error, the `errors/not_found` template will be rendered.
   def show
-    # The following variables are available:
-    @exception # The encountered exception (Eg. `#<ActiveRecord::NotFound …>`)
-    @status_code # The status code we should return (Eg. `404`)
-    @rescue_response # The "standard" name for the status code (Eg. `:not_found`)
+    # Here, the `@exception` variable contains the original raised error
+    render "errors/#{@rescue_response}", status: @status_code
   end
 end
 ```
 
-For example, you might want your `Api::ErrorsController` to return a standard JSON response:
+For example, you might want your `API::ErrorsController` to return a standard JSON response:
 
 ```ruby
-class Api::ErrorsController < Api::ApplicationController
+class API::ErrorsController < API::ApplicationController
   include Gaffe::Errors
-  skip_before_filter :ensure_current_user
 
+  # Make sure anonymous users can see the page
+  skip_before_filter :authenticate_user!
+
+  # Disable layout (your `API::ApplicationController` probably does this already)
+  layout false
+
+  # Render a simple JSON response containing the error “standard” code
+  # plus the exception name and backtrace if we’re in development.
   def show
+    output = { error: @rescue_response }
+    output.merge! exception: @exception.inspect, backtrace: @exception.backtrace.first(10) if Rails.env.development?
     render json: { error: @rescue_response }, status: @status_code
   end
 end
@@ -139,6 +153,12 @@ you’ll have to edit the `config/environments/development.rb` file.
 config.consider_all_requests_local = false
 ```
 
+## Contributors
+
+* [@remiprev](https://github.com/remiprev)
+* [@simonprev](https://github.com/simonprev)
+* [@jmuheim](https://github.com/jmuheim)
+
 ## License
 
 `Gaffe` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/gaffe/blob/master/LICENSE.md) file.
@@ -147,6 +167,6 @@ The mushroom cloud logo is based on [this lovely icon](http://thenounproject.com
 
 ## About Mirego
 
-Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We proudly build mobile applications for [iPhone](http://mirego.com/en/iphone-app-development/ "iPhone application development"), [iPad](http://mirego.com/en/ipad-app-development/ "iPad application development"), [Android](http://mirego.com/en/android-app-development/ "Android application development"), [Blackberry](http://mirego.com/en/blackberry-app-development/ "Blackberry application development"), [Windows Phone](http://mirego.com/en/windows-phone-app-development/ "Windows Phone application development") and [Windows 8](http://mirego.com/en/windows-8-app-development/ "Windows 8 application development") in beautiful Quebec City.
+[Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).
 
-We also love [open-source software](http://open.mirego.com/) and we try to extract as much code as possible from our projects to give back to the community.
+We also [love open-source software](http://open.mirego.com) and we try to give back to the community as much as we can.

data/app/assets/stylesheets/errors.css

@@ -1,12 +1,21 @@
-html { font-size: 62.5% }
-* { margin: 0; padding: 0; font-size: 100%; -moz-box-sizing: border-box; box-sizing: border-box; }
+html {
+  font-size: 62.5%;
+}
+
+* {
+  margin: 0;
+  padding: 0;
+  font-size: 100%;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+}
 
 body {
+  padding: 60px;
+  background: #fafafa;
   font-size: 150%;
   font-family: Helvetica, Arial, sans-serif;
-  background: #fafafa;
   font-weight: 300;
-  padding: 60px;
   line-height: 1.5;
 }
 
@@ -14,10 +23,11 @@ body {
   width: 100%;
   max-width: 700px;
   margin: 0 auto;
-  background: #fff;
   padding: 30px;
-  box-shadow: 0 0 20px rgba(0,0,0,0.2);
+  background: #fff;
+  box-shadow: 0 0 20px rgba(0, 0, 0, 0.2);
   border-radius: 3px;
+  border-top: 3px solid #b00f08;
 }
 
 hr {
@@ -29,34 +39,45 @@ p {
 }
 
 a {
-  color: #F3711B;
+  color: #731217;
+}
+
+a:hover {
+  color: #b00f08;
 }
 
 h1 {
-  font-size: 240%;
   margin: 0 0 15px;
+  font-size: 240%;
   font-weight: 300;
+  color: #731217;
 }
 
 .content {
-  background: #FFFCE1;
   padding: 15px;
   margin: 15px 0;
-  border: 1px solid rgba(0,0,0,0.1);
+  background: #eee;
+  border: 1px solid rgba(0, 0, 0, 0.1);
+  font-weight: bold;
+  color: #666;
 }
 
 pre {
-  background: #fafafa;
+  overflow: auto;
   padding: 15px;
+  background: #fafafa;
+  border: 1px solid rgba(0, 0, 0, 0.1);
   line-height: 1.8;
-  color: rgba(0,0,0,0.8);
-  border: 1px solid rgba(0,0,0,0.1);
-  overflow: auto;
+  color: rgba(0, 0, 0, 0.8);
+}
+
+pre.exception {
+  background-color: #ffeded;
 }
 
 pre em {
   font-style: normal;
-  color: rgba(0,0,0,0.5);
+  color: rgba(0, 0, 0, 0.5);
   border-bottom: 1px dotted;
   cursor: help;
 }

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

@@ -18,6 +18,14 @@
         <hr>
       </div>
 
+      <% if Rails.env.development? || Rails.env.test? %>
+        <p>Original exception (only displayed in <strong>development</strong> and <strong>test</strong> environment):</p>
+
+<pre>
+<code><%= @exception.inspect %></code>
+</pre>
+      <% end %>
+
       <p>You can overwrite this page by creating these files:</p>
 
 <% handlers = ActionView::Template::Handlers.extensions.map(&:to_s).join(', ') %>

data/gaffe.gemspec

@@ -23,5 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 2.14'
   spec.add_development_dependency 'coveralls'
 
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'scss-lint'
+  spec.add_development_dependency 'phare'
+
   spec.add_dependency 'rails', '>= 3.2.0'
 end

data/lib/gaffe.rb

@@ -36,7 +36,7 @@ module Gaffe
     controller = configuration.errors_controller
 
     if controller.is_a?(Hash)
-      controller = controller.detect { |pattern, _| env["REQUEST_URI"] =~ pattern }.try(:last)
+      controller = controller.find { |pattern, _| env['REQUEST_URI'] =~ pattern }.try(:last)
     end
 
     controller ||= builtin_errors_controller

data/lib/gaffe/errors.rb

@@ -9,11 +9,9 @@ module Gaffe
     end
 
     def show
-      begin
-        render "errors/#{@rescue_response}", status: @status_code
-      rescue ActionView::MissingTemplate
-        render "errors/internal_server_error", status: 500
-      end
+      render "errors/#{@rescue_response}", status: @status_code
+    rescue ActionView::MissingTemplate
+      render 'errors/internal_server_error', status: 500
     end
 
   protected

data/lib/gaffe/version.rb

@@ -1,3 +1,3 @@
 module Gaffe
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/spec/gaffe/errors_spec.rb

@@ -12,7 +12,7 @@ describe Gaffe::Errors do
       context 'with builtin exception' do
         let(:exception) { ActionController::RoutingError.new(:foo) }
         its(:status) { should eql 404 }
-        its(:body) { should match /Not Found/ }
+        its(:body) { should match(/Not Found/) }
       end
 
       context 'with custom exception and missing view' do
@@ -25,7 +25,7 @@ describe Gaffe::Errors do
 
         let(:exception) { exception_class.new }
         its(:status) { should eql 500 }
-        its(:body) { should match /Internal Server Error/ }
+        its(:body) { should match(/Internal Server Error/) }
       end
     end
   end

data/spec/gaffe/gaffe_spec.rb

@@ -33,7 +33,7 @@ describe Gaffe do
       context 'with custom-defined controller that respond to `#constantize`' do
         before do
           Gaffe.configure do |config|
-            config.errors_controller = "String"
+            config.errors_controller = 'String'
           end
         end
 

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
-$:.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'coveralls'
 Coveralls.wear!
 
 require 'rspec'
-require "action_controller/railtie"
+require 'action_controller/railtie'
 require 'gaffe'
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gaffe
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Rémi Prévost
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2014-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,48 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: scss-lint
+  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: phare
+  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: rails
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +133,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rubocop.yml
+- .scss-lint.yml
 - .travis.yml
 - Gemfile
 - LICENSE.md