r404 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc6e6557052a8a89d2cef3beb454a9496d6581fabe2432f9bb86319e810d58dc
+  data.tar.gz: 933b900e2c34b746e3e99f6aedd71519b1262230cff073dffc52c0536faad94c
+SHA512:
+  metadata.gz: c6def4e9cad4d39b550357807cbee510319896c1107320d17124d295dd8be7992541e4f1b7879309a475df64a31df64a64732e93191f93cc9a6f8952a64e4067
+  data.tar.gz: ff5098e3b4a191218b8c707b111ae62a1dabe6ddac7d980be07a4754092a71665ce0fcab54d1cc335f48f07f78262e28a73de77fe6b6593024471c358591572f

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.0.0 - 2018/01/20
+
+* initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,148 @@
+# r404
+
+[![Gem Version](https://badge.fury.io/rb/r404.svg)](https://badge.fury.io/rb/r404) <img src="https://travis-ci.org/jonhue/r404.svg?branch=master" />
+
+An error handler & renderer for Rails.
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+    * [Raising an error](#raising-an-error)
+    * [Rendering an error](#rendering-an-error)
+    * [List of all error classes](#list-of-all-error-classes)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+    * [Semantic versioning](#semantic-versioning)
+* [License](#license)
+
+---
+
+## Installation
+
+r404 works with Rails 5 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+gem 'r404'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install r404
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'r404', github: 'jonhue/r404'
+```
+
+Now run the generator:
+
+    $ rails g r404
+
+Finally add `include R404Controller` to your `ApplicationController` located in `app/controllers/application_controller.rb`.
+
+---
+
+## Usage
+
+### Raising an error
+
+You can raise errors in controllers and views:
+
+```ruby
+r404 :not_found
+
+# more specific
+r404 404
+```
+
+**Note:** The status parameter defaults to `404`.
+
+You are able to pass exception details which will be available in your template:
+
+```ruby
+r404 :not_found, 'Here is what went wrong ...'
+```
+
+Alternatively you can raise errors from anywhere by raising the [error class](#list-of-all-error-classes) directly:
+
+```ruby
+raise R404::NotFound
+```
+
+### Rendering an error
+
+r404 automatically looks up templates in the `app/views/r404` directory. The `status` and `exception` (if passed) variables are available in your template.
+
+Often you don't want to render a template, but instead your goal is to redirect back passing an alert. You are able to override error specific methods in your `ApplicationController`:
+
+```ruby
+private
+
+def render_r404_access_denied format, status, exception
+    format.html { redirect_back fallback_location: root_url, alert: 'You are unauthorized to perform this action' }
+end
+```
+
+### List of all error classes
+
+* `R404::AccessDenied` (`:access_denied`, `403`)
+* `R404::NotFound` (`:not_found`, `404`)
+
+---
+
+## To Do
+
+[Here](https://github.com/jonhue/r404/projects/1) is the full list of current projects.
+
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/r404/issues/new).
+
+---
+
+## Contributing
+
+We hope that you will consider contributing to r404. Please read this short overview for some information about how to get started:
+
+[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
+
+### Contributors
+
+Give the people some :heart: who are working on this project. See them all at:
+
+https://github.com/jonhue/r404/graphs/contributors
+
+### Semantic Versioning
+
+r404 follows Semantic Versioning 2.0 as defined at http://semver.org.
+
+## License
+
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/app/controllers/concerns/r404_controller.rb

@@ -0,0 +1,26 @@
+module R404Controller
+
+    extend ActiveSupport::Concern
+
+    included do
+        rescue_from (R404::AccessDenied) { |exception| render_r404 :access_denied, 403, exception }
+        rescue_from (R404::NotFound) { |exception| render_r404 :not_found, 404, exception }
+
+        def render_r404 code, status, exception
+            logger.error exception
+            respond_to do |format|
+                begin
+                    send "render_r404_#{code}", format, status, exception
+                rescue NoMethodError
+                    render_r404_for code, format, status, exception
+                end
+                format.all { render nothing: true, status: status }
+            end
+        end
+
+        def render_r404_for code, format, status, exception = nil
+            format.html { render "r404/#{code}", status: status, locals: { status: status, exception: exception } }
+        end
+    end
+
+end

data/app/helpers/r404_helper.rb

@@ -0,0 +1,13 @@
+module R404Helper
+
+    def r404 code = 404, exception = nil
+        # status = code.is_a?(Integer) ? code : nil
+        case code
+        when 403, :access_denied
+            raise R404::AccessDenied.new(exception)
+        when 404, :not_found
+            raise R404::NotFound.new(exception)
+        end
+    end
+
+end

data/lib/generators/r404_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class R404Generator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    source_root File.join File.dirname(__FILE__), 'templates'
+    desc 'Install r404'
+
+    def create_views
+        template 'access_denied.html.erb', 'app/views/r404/access_denied.html.erb'
+        template 'not_found.html.erb', 'app/views/r404/not_found.html.erb'
+    end
+
+end

data/lib/generators/templates/access_denied.html.erb

@@ -0,0 +1,4 @@
+<h1>Access denied</h1>
+<p>
+    <%%= link_to 'Go home', root_path %>
+</p>

data/lib/generators/templates/not_found.html.erb

@@ -0,0 +1,4 @@
+<h1>Not found</h1>
+<p>
+    <%%= link_to 'Go home', root_path %>
+</p>

data/lib/r404/access_denied.rb

@@ -0,0 +1,9 @@
+module R404
+    class AccessDenied < StandardError
+
+        def initialize exception
+            super
+        end
+
+    end
+end

data/lib/r404/engine.rb

@@ -0,0 +1,7 @@
+require 'rails/railtie'
+
+module R404
+    class Engine < ::Rails::Engine
+        # isolate_namespace R404
+    end
+end

data/lib/r404/not_found.rb

@@ -0,0 +1,9 @@
+module R404
+    class NotFound < StandardError
+
+        def initialize exception
+            super
+        end
+
+    end
+end

data/lib/r404/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails/railtie'
+
+module R404
+    class Railtie < ::Rails::Railtie
+
+        initializer 'r404.action_controller' do
+            ActiveSupport.on_load :action_controller do
+                include R404Helper
+            end
+        end
+
+    end
+end

data/lib/r404/version.rb

@@ -0,0 +1,5 @@
+module R404
+
+    VERSION = '1.0.0'
+
+end

data/lib/r404.rb

@@ -0,0 +1,11 @@
+require 'r404/version'
+
+module R404
+
+    require 'r404/access_denied'
+    require 'r404/not_found'
+
+    require 'r404/railtie'
+    require 'r404/engine'
+
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: r404
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonas Hübotter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: Error handler & renderer for Rails
+email: me@jonhue.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- app/controllers/concerns/r404_controller.rb
+- app/helpers/r404_helper.rb
+- lib/generators/r404_generator.rb
+- lib/generators/templates/access_denied.html.erb
+- lib/generators/templates/not_found.html.erb
+- lib/r404.rb
+- lib/r404/access_denied.rb
+- lib/r404/engine.rb
+- lib/r404/not_found.rb
+- lib/r404/railtie.rb
+- lib/r404/version.rb
+homepage: https://github.com/jonhue/r404
+licenses:
+- MIT
+metadata: {}
+post_install_message: |
+  **Thank you for installing r404!**
+
+
+  There are two more steps to take:
+
+  1) Run `rails g r404`
+  2) Add `include R404Controller` to `app/controllers/application_controller.rb`
+
+
+  Learn more at https://github.com/jonhue/r404
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Error handler & renderer for Rails
+test_files: []