exceptions_app 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+.DS_Strore

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exceptions_app.gemspec
+gemspec
+
+gem 'rake'
+gem 'minitest'
+gem 'turn'
+gem 'cucumber'
+gem 'aruba'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Igor Kuznetsov
+
+MIT License
+
+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,60 @@
+[![BuildStatus](https://travis-ci.org/kaize/exceptions_app.png?branch=master)](https://travis-ci.org/kaize/exceptions_app)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/kaize/exceptions_app)
+
+# ExceptionsApp
+
+`exceptions_app` is a gem, that provides a simple way of handling exceptions in Rails applications. 
+It changes the default *PublicExceptions* rack middleware to *SimpleResponse*. It adds a Rake task "rake gen:static_pages" that generates static pages for your custom exceptions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exceptions_app'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exceptions_app
+
+## Usage
+
+### Configuring
+
+*ExceptionsApp* have method __configure__, that yelds block inside itself. You can change the behaviour by adding this code to **initializers/exceptions_app.rb**
+
+	ExceptionsApp.configure do |config|
+	  config.envs = ["production", "another_production"]
+	  config.errors_path = ["/404"]
+	  config.statics_path = "path_for_statc"
+	end
+
+There are several options that can be changed in initializer:
+
+ - `envs` - 		Array of environments in which default *exceptions_app* should be changed to gem's middleware
+ - `errors_path` - 	Array of route paths from which custom errors pages will be generated
+ - `statics_path` - String path (directory) where to put generated static pages
+
+### Preparations
+
+*ExceptionsApp* is a simple Railtie that changes default *exceptions_app* in environments, mentioned in *envs* config option, to *SimpleResponse* rack middleware. So, to generate correct static error pages you should make custom error pages by yourself. It will be a great idea to make your own *ErrorsController* to handle exceptions and generate errors pages. The example of such controller you can see in *features* directory with cucumber integration tests.
+
+### How to work with it
+
+*ExceptionsApp* is ready to use after *bundle install*. It has default config options, so if you won't change them and won't provide any custom pages it will by default generate static error pages from default Rails 404, 500 and 422 html pages in public directory. In fact it won't change application's behaviour if you won't configure it. Default config options are:
+
+	ExceptionsApp.config.envs = ["production"]
+	ExceptionsApp.config.errors_path = ["/404", "/500", "/422"]
+	ExceptionsApp.config.statics_path = "public"
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "cucumber/rake/task"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/lib/**/*.rb']
+  t.verbose = true
+end
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.fork = true
+  t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'progress')]
+end
+
+task test_suite: [:test, :cucumber]
+
+task :default => :test_suite

data/exceptions_app.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exceptions_app/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "exceptions_app"
+  gem.version       = ExceptionsApp::VERSION
+  gem.authors       = ["Igor Kuznetsov"]
+  gem.email         = ["igkuznetsov@gmail.com"]
+  gem.description   = %q{exceptions_app is gem, that provides a simple way of handling exceptions in Rails applications.}
+  gem.summary       = %q{exceptions_app provides a simple way of handling exceptions in Rails applications}
+  gem.homepage      = "http://github.com/kaize/exceptions_app"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "rails", "~> 3.2.9"
+end

data/features/rake_task_integration.feature

@@ -0,0 +1,13 @@
+@disable_bundler
+Feature: Rake task for generating static pages
+  should be added into rails application
+
+  Background:
+    Given I successfully run `bundle exec rails new testapp --skip-bundle --skip-sprockets`
+    And I cd to "testapp"
+    And I add "exceptions_app" from this project as a dependency
+    And I successfully run `bundle install`
+
+  Scenario: Check the existence of rake task
+    When I successfully run `bundle exec rake -T --trace`
+    Then the output should contain "rake gen:static_pages"

data/features/step_definitions/rails_steps.rb

@@ -0,0 +1,7 @@
+When /^I add "([^"]+)" from this project as a dependency$/ do |gem_name|
+  append_to_file('Gemfile', %{gem "#{gem_name}", :path => "#{PROJECT_ROOT}"\n})
+end
+
+When /^I add "([^"]+)" as a dependency$/ do |gem_name|
+  append_to_file('Gemfile', %{gem "#{gem_name}"\n})
+end

data/features/support/env.rb

@@ -0,0 +1,7 @@
+require 'aruba/cucumber'
+
+PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..')).freeze
+
+Before do
+  @aruba_timeout_seconds = 100
+end

data/lib/exceptions_app.rb

@@ -0,0 +1,18 @@
+require "exceptions_app/version"
+
+module ExceptionsApp
+
+  autoload :SimpleResponse, 'exceptions_app/simple_response'
+  autoload :Config, 'exceptions_app/config'
+
+  def self.configure
+    yield self.config
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+end
+
+require 'exceptions_app/railtie' if defined?(Rails)

data/lib/exceptions_app/config.rb

@@ -0,0 +1,11 @@
+module ExceptionsApp
+  class Config
+    attr_accessor :envs, :errors_path, :statics_path
+
+    def initialize
+      @envs = ["production"]
+      @errors_path = ["/404", "/422", "/500"]
+      @statics_path = "public"
+    end
+  end
+end

data/lib/exceptions_app/railtie.rb

@@ -0,0 +1,14 @@
+module ExceptionsApp
+  class Railtie < ::Rails::Railtie
+
+    initializer "exceptions_app.install_app" do |app|
+      if ExceptionsApp.config.envs.include?(Rails.env)
+        app.config.exceptions_app = ExceptionsApp::SimpleResponse.new
+      end
+    end
+
+    rake_tasks do
+      load 'tasks/exceptions_app.rake'
+    end
+  end
+end

data/lib/exceptions_app/simple_response.rb

@@ -0,0 +1,26 @@
+module ExceptionsApp
+  class SimpleResponse
+    
+    def initialize(headers = nil)
+      @headers = headers
+    end
+
+    def call(env)
+      status = env["PATH_INFO"][1..-1]
+      @headers ||= {}
+      statics_path = "#{ExceptionsApp.config.statics_path}/#{status}.html"
+
+      if File.exists?(statics_path)
+        render(status, File.read(statics_path))
+      else
+        [status, @headers.merge!({"X-Cascade" => "pass"}), []]
+      end
+    end
+
+    private
+    
+    def render(status, body)
+      [status, {'Content-Length' => body.bytesize.to_s}, [body]]
+    end
+  end
+end

data/lib/exceptions_app/version.rb

@@ -0,0 +1,3 @@
+module ExceptionsApp
+  VERSION = "0.0.1"
+end

data/lib/tasks/exceptions_app.rake

@@ -0,0 +1,15 @@
+namespace :gen do
+
+  desc "Generate static error pages"
+  task :static_pages => :environment do
+    app = ActionDispatch::Integration::Session.new Rails.application
+    ExceptionsApp.config.errors_path.each do |path|
+      app.get path
+      response = app.response
+      unless response.body.empty?
+        File.open("#{ExceptionsApp.config.statics_path}/#{response.status}.html", "w") { |file| file.write(response.body) }
+      end
+    end
+    puts "Static pages generated successfully"
+  end
+end

data/test/lib/config_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class ConfigTest < TestCase
+
+  def test_should_return_default_configuration
+    config = ExceptionsApp::Config.new
+    assert_equal ["production"], config.envs
+    assert_equal ["/404", "/422", "/500"], config.errors_path
+  end
+
+end

data/test/lib/exceptions_app_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class ExceptionsAppTest < TestCase
+ 
+  def test_configuration_block_correct_object
+    ExceptionsApp.configure do |config|
+      assert_instance_of ExceptionsApp::Config, config
+    end
+  end
+  
+  def test_should_overwrite_default_configuration
+    environments = ["prod#1", "prod#2"]
+    errors_path = ["123", "456"]
+    ExceptionsApp.configure do |config|
+      config.envs = environments
+      config.errors_path = errors_path
+    end
+    assert_equal environments, ExceptionsApp.config.envs
+    assert_equal errors_path, ExceptionsApp.config.errors_path
+  end
+
+end

data/test/lib/simple_response_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class SimpleResponseTest < TestCase
+
+  def setup
+    @env = {}
+    @env["PATH_INFO"] = "/404"
+  end
+
+  def test_initializing_without_headers
+    sr = ExceptionsApp::SimpleResponse.new
+    response = sr.call(@env)
+    assert_equal "404", response[0]
+    assert_equal "pass", response[1]["X-Cascade"]
+  end
+
+  def test_initializing_with_headers
+    sr = ExceptionsApp::SimpleResponse.new({"ContentLength" => 0})
+    response = sr.call(@env)
+    assert_equal 0, response[1]["ContentLength"]
+  end
+
+  def test_empty_body
+    sr = ExceptionsApp::SimpleResponse.new
+    response = sr.call(@env)
+    assert_nil response[3]
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+Bundler.require
+
+MiniTest::Unit.autorun
+
+class TestCase < MiniTest::Unit::TestCase
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: exceptions_app
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Igor Kuznetsov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+description: exceptions_app is gem, that provides a simple way of handling exceptions
+  in Rails applications.
+email:
+- igkuznetsov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exceptions_app.gemspec
+- features/rake_task_integration.feature
+- features/step_definitions/rails_steps.rb
+- features/support/env.rb
+- lib/exceptions_app.rb
+- lib/exceptions_app/config.rb
+- lib/exceptions_app/railtie.rb
+- lib/exceptions_app/simple_response.rb
+- lib/exceptions_app/version.rb
+- lib/tasks/exceptions_app.rake
+- test/lib/config_test.rb
+- test/lib/exceptions_app_test.rb
+- test/lib/simple_response_test.rb
+- test/test_helper.rb
+homepage: http://github.com/kaize/exceptions_app
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4290187780574975558
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4290187780574975558
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: exceptions_app provides a simple way of handling exceptions in Rails applications
+test_files:
+- features/rake_task_integration.feature
+- features/step_definitions/rails_steps.rb
+- features/support/env.rb
+- test/lib/config_test.rb
+- test/lib/exceptions_app_test.rb
+- test/lib/simple_response_test.rb
+- test/test_helper.rb