straides 0.0.2 → 0.1.0

data/README.md

@@ -3,17 +3,29 @@
 Better HTTP STatus coDES for RAIls!
 
 Straides provides a convenient and more consistent way for handling error conditions
-in controllers.
+in controllers. It makes it possible, for example, to abort execution of a request in a before_filter.
 
-Straides makes it possible, for example, to abort execution of a request in a before_filter.
+# Installation
+
+1.  Add the gem to your Gemfile.
+
+        gem 'straides'
+
+2.  Update your gem bundle.
+
+        $ bundle install
 
 
 # Usage
 
+Straides provides a helper method called `error`. Call it at any time with the HTTP error code
+and optionally additional parameters for `render` to abort the current request and render an
+error message.
+
     # Stop controller execution and return the request with the given HTTP error.
     error 404 unless [condition]
 
-    # Shorter version, integrated into loading for example a user object.
+    # Abort with an error if an operation didn't return a result.
     user = User.find_by_username(params[:id]) or error 401
 
 
@@ -24,7 +36,7 @@ Straides returns reasonable default responses dependent on the request format.
 * If the request returns HTML, it renders `public/[error code].html`, similar to what Rails does.
 * If the request returns JSON, it leaves the response body empty by default.
 
-These behaviors can be overridden by providing the call to `error` with the same parameters
+These behaviors can be customized by providing the call to `error` with the same parameters
 as you would give to [render](http://apidock.com/rails/ActionController/Base/render) in Rails.
 
     # Provide a custom error message in the response body.
@@ -35,3 +47,28 @@ as you would give to [render](http://apidock.com/rails/ActionController/Base/ren
 
     # Render a custom JSON response.
     error 401, :json => { :code => 401, :message => 'Please log in first.' }
+
+
+# Customizing Straides
+
+Straides can be configured by creating an initializer file at _config/initializers/straides.rb_.
+
+    Straides.configure do |config|
+
+      # Disable auto-loading of Straides into every controller.
+      config.auto_load = false
+    end
+
+
+## Auto-loading
+
+Straides loads the `error` helper method by default into every controller.
+If you don't want that, for example because you only want to use Straides in certain controllers,
+you can disable this auto-loading behavior with `config.auto_load = false`.
+Please note that you then have to include Straides into every controller manually, like this:
+
+    class FooController < ApplicationController
+      include Straides
+
+      ...
+    end

data/lib/straides/configuration.rb

@@ -0,0 +1,30 @@
+module Straides
+
+  class Configuration
+
+    def initialize
+
+      # Whether to auto-include the Straides config into every controller.
+      @auto_load = true
+    end
+
+    attr_accessor :auto_load
+
+    # Returns the singleton instance of this Configuration class,
+    # to be used for configuring the Rails app that uses this gem.
+    def self.instance
+      @__instance__ ||= new
+    end
+  end
+
+  # Helper method for configuring Straides in an initializer file.
+  #
+  # Example:
+  #   Straides::Configuration.configure do |config|
+  #     config.auto_load = false
+  #   end
+  def self.configure
+    raise RuntimeError("ERROR: You must provide a block to Straides.configure.") unless block_given?
+    yield Configuration.instance
+  end
+end

data/lib/straides/railtie.rb

@@ -0,0 +1,15 @@
+require "rails/railtie"
+
+module Straides
+
+  class Railtie < Rails::Railtie
+
+    # Initialize Straides after the Rails initializers have run.
+    config.after_initialize do
+      if Straides::Configuration.instance.auto_load
+        ActionController::Base.send :include, Straides
+      end
+    end
+  end
+
+end

data/lib/straides/version.rb

@@ -1,3 +1,3 @@
 module Straides
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/straides.rb

@@ -1,6 +1,8 @@
+require 'active_support/concern'
+require 'straides/configuration'
+require 'straides/railtie'
 require 'straides/return_http_code_error'
 require 'straides/version'
-require 'active_support/concern'
 
 module Straides
   extend ActiveSupport::Concern
@@ -25,7 +27,7 @@ module Straides
     def show_error(error)
       unless error.has_template?
         if request.send(:format).html?
-          error.render_options[:file] = "public/#{error.render_options[:status] || 'error'}"
+          error.render_options[:file] = "public/#{error.render_options[:status] || '500'}"
           error.render_options[:formats] = [:html]
         else
           error.render_options[:nothing] = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: straides
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-27 00:00:00.000000000Z
+date: 2012-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70126776392840 !ruby/object:Gem::Requirement
+  requirement: &70323458738280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70126776392840
+  version_requirements: *70323458738280
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70323458737760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70323458737760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70126776390900 !ruby/object:Gem::Requirement
+  requirement: &70323458736960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70126776390900
+  version_requirements: *70323458736960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70126776389120 !ruby/object:Gem::Requirement
+  requirement: &70323458736120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70126776389120
+  version_requirements: *70323458736120
 description: A more convenient way to return different HTTP status codes from Rails.
 email:
 - kevin.goslar@gmail.com
@@ -51,6 +62,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/straides/configuration.rb
+- lib/straides/railtie.rb
 - lib/straides/return_http_code_error.rb
 - lib/straides/version.rb
 - lib/straides.rb