errawr 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f191ece7e68880cb8fe7c0f1b7602b93ec7682b
+  data.tar.gz: af5f3f544c7424e14b3a82b15b5767937b55208d
+SHA512:
+  metadata.gz: e13c00a643cf2b978bb901fcac57b8f9a5c49d55ce25519d445b347c1214c8e472e06fae443a53000c9f4b6d88c960e304912f4f70f7114501dd0c5631a8a3ea
+  data.tar.gz: 2d963cad145fd66659e42f929021277cb20e7f25dc6919985ec22ec011cb40c3bbf0b25635fe46ec458f29594661bc5b8420bf761e01c4b5d913269f1f174dd6

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in errawr.gemspec
+gemspec
+
+group :development do
+  gem 'bundler'
+  gem 'coveralls', require: false
+  gem 'rake'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Anthony Smith
+
+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,159 @@
+# Errawr
+
+A framework for effectively defining and raising localized errors.
+
+[![Build Status](https://travis-ci.org/anthonator/errawr.png?branch=master)](https://travis-ci.org/anthonator/errawr) [![Dependency Status](https://gemnasium.com/anthonator/errawr.png)](https://gemnasium.com/anthonator/errawr) [![Coverage Status](https://coveralls.io/repos/anthonator/errawr/badge.png?branch=master)](https://coveralls.io/r/anthonator/errawr?branch=master) [![Code Climate](https://codeclimate.com/github/anthonator/errawr.png)](https://codeclimate.com/github/anthonator/errawr)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'errawr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install errawr
+
+## Usage
+
+### Localizations
+
+Errawr uses [I18n](https://github.com/svenfuchs/i18n) for easily managing error localizations. Just define a locale using the ```errawr``` key.
+
+```yaml
+en:
+  errawr:
+    your_error: Your error message here
+```
+
+Need to add more locale files? Use I18n's standard ```load_path```.
+
+```ruby
+I18n.load_path += Dir.glob('lib/your_lib/locales/*.{rb,yml}')
+```
+
+### Registering Errors
+
+Before you can raise an error you'll need to register it first.
+
+```ruby
+Errawr.register!(:your_error)
+```
+
+It's also possible to pass in additional metadata when registering an error.
+
+```ruby
+Errawr.register!(:bad_request, { http_status: 400 })
+begin
+  Errawr.error!(:bad_request)
+rescue => e
+  puts e.context[:http_status]
+end
+```
+
+### Raising Errors
+
+```ruby
+begin
+  Errawr.error!(:your_error)
+rescue => e
+  puts e.message # Localized error message defined in locale file
+end
+```
+
+### Managing Errors through Locale Files
+
+It's also possible to manage your errors and their metadata purely through locale files.
+
+```yaml
+en:
+  errawr:
+    your_error:
+      name: my error
+      error:
+        message: My awesome error message
+```
+
+Then just register and raise your exceptions like normal.
+
+```ruby
+Errawr.register!(:your_error)
+begin
+  Errawr.error!(:your_error)
+rescue => e
+  puts e.context[:name] # Will return "my error"
+end
+```
+
+**Note** the ```errawr.your_error.error.message``` locale key. This is the key used to define an error message when managing an error through a locale file.
+
+### Overrides
+
+Want to override that metadata you registered? That's cool too.
+
+```yaml
+en:
+  errawr:
+    your_error:
+      name: my error
+      error:
+        message: My awesome error message
+```
+
+```ruby
+# #register! overrides metadata defined in the locale file
+Errawr.register!(:your_error, name: 'my infamous error')
+begin
+  Errawr.error!(:your_error)
+rescue => e
+  puts e.context[:name] # Will return "my infamous error"
+end
+
+begin
+  # #error! metadata overrides both #register! and the locale file
+  Errawr.error!(:your_error, name: 'my very favorite error')
+rescue => e
+  puts e.context[:name] # Will return "my very favorite error"
+end
+``` 
+
+### Custom Error Classes
+
+Want to write a custom error class? No problem!
+
+```ruby
+class YourError < Errawr::Error
+  def your_method
+     ...
+  end
+end
+
+# Register your error with your custom class
+Errawr.register!(:your_error, { error: { base_class: YourError } })
+
+# Do something with it
+begin
+  Errawr.error!(:your_error)
+rescue => e
+  e.your_method
+end
+```
+
+## 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
+
+## Credits
+[![Sticksnleaves](http://sticksnleaves-wordpress.herokuapp.com/wp-content/themes/sticksnleaves/images/snl-logo-116x116.png)](http://www.sticksnleaves.com)
+
+Errawr is maintained and funded by [Sticksnleaves](http://www.sticksnleaves.com)
+
+Thanks to all of our [contributors](https://github.com/anthonator/errawr/graphs/contributors)

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/errawr.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'errawr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'errawr'
+  spec.version       = Errawr::VERSION
+  spec.authors       = ['Anthony Smith']
+  spec.email         = ['anthony@sticksnleaves.com']
+  spec.description   = %q{Easily define and raise localized errors.}
+  spec.summary       = %q{A framework for effectively defining and raising localized errors.}
+  spec.homepage      = 'http://www.github.com/anthonator/errawr'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  
+  spec.add_runtime_dependency 'i18n'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/errawr/error.rb

@@ -0,0 +1,31 @@
+module Errawr
+  class Error < StandardError
+    attr_reader :key, :context, :message
+    
+    def initialize(key = :unknown, context = {})
+      @key = key
+      @i18n = I18n.t('errawr.' + @key.to_s)
+      process_context(context)
+      process_message
+    end
+    
+    private
+    def process_context(context)
+      if @i18n.kind_of?(Hash)
+        @context = @i18n.merge(context)
+        @context.delete(:error)
+      else
+        @context = {}
+      end
+    end
+    
+    def process_message
+      if @i18n.kind_of?(Hash)
+        key = 'errawr.' + @key.to_s + '.error.message'
+        @message = I18n.t(key, @context, { default: I18n.t('errawr.unknown', @context) })
+      else
+        @message = I18n.t('errawr.' + @key.to_s, @context)
+      end
+    end
+  end
+end

data/lib/errawr/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  errawr:
+    unknown: An unknown error has occurred

data/lib/errawr/mapper.rb

@@ -0,0 +1,26 @@
+module Errawr
+  class Mapper
+    @@errors = {}
+    
+    def self.all
+      @@errors.dup
+    end
+    
+    def self.[](key)
+      @@errors[key.to_sym]
+    end
+    
+    def self.add(error)
+      @@errors[error.key] = error
+    end
+    
+    def self.register!(key, options = {})
+      base_klass = options[:error] ? options[:error][:base_class] || Error : Error
+      raise(ArgumentError, ':base_class must be a subclass of Errawr::Error') unless base_klass <= Error
+      klass = Class.new(base_klass).new(key, options.select { |k, v| ![:error].include?(k) })
+      add(klass)
+    end
+    
+    register!(:unknown)
+  end
+end

data/lib/errawr/version.rb

@@ -0,0 +1,3 @@
+module Errawr
+  VERSION = '1.0.0'
+end

data/lib/errawr.rb

@@ -0,0 +1,19 @@
+require 'i18n'
+
+require 'errawr/error'
+require 'errawr/mapper'
+require 'errawr/version'
+
+module Errawr
+  I18n.load_path += Dir.glob('lib/errawr/locales/*.{rb,yml}')
+  
+  def self.error!(name, context = {})
+    klass = Mapper[name] || Mapper[:unknown]
+    klass.context.merge!(context)
+    raise klass
+  end
+  
+  def self.register!(key, options = {})
+    Mapper.register!(key, options)
+  end
+end

data/spec/errawr_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Errawr do
+  it 'should raise an Errawr::Error exception' do
+    Errawr.register!(:dummy_error)
+    expect { Errawr.error!(:dummy_error) }.to raise_error(Errawr::Error)
+  end
+end

data/spec/error_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Errawr::Error do
+  before(:each) do
+    I18n.load_path += Dir.glob('spec/support/en.yml')
+    I18n.reload!
+  end
+  
+  it 'should return a key of :unknown if no key is set' do
+    error = Errawr::Error.new
+    error.key.should == :unknown
+  end
+  
+  it 'should return a localized message' do
+    error = Errawr::Error.new(:some_error)
+    error.message.should == 'Some error has occurred'
+  end
+  
+  it 'should return a localized message if I18n value is a hash' do
+    error = Errawr::Error.new(:error_hash)
+    error.message.should == 'Some hashed error has occurred'
+  end
+  
+  it 'should return an unknown error if error => message is not provided' do
+    error = Errawr::Error.new(:bad_error_hash)
+    error.message.should == 'An unknown error has occurred'
+  end
+  
+  it 'should insert custom values into the context if I18n value is a hash' do
+    error = Errawr::Error.new(:error_hash)
+    error.context[:name].should == 'error_name'
+  end
+end

data/spec/mapper_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Errawr::Mapper do
+  it 'should automatically register an unknown error' do
+    Errawr::Mapper.all[:unknown].should_not be_nil
+  end
+  
+  describe '[]' do
+    it 'should return stored errors' do
+      Errawr::Mapper[:unknown].should_not be_nil
+    end
+  end
+  
+  describe 'add' do
+    it 'should add an error to stored errors' do
+      Errawr::Mapper.add(DummyError.new)
+      Errawr::Mapper[:dummy_key].should_not be_nil
+    end
+  end
+  
+  describe 'register!' do
+    it 'should throw an error if base class is not a subclass of Errawr::Error' do
+      expect { Errawr.register!(:dummy_error, { error: { base_class: StandardError } }) }.to raise_error(ArgumentError)
+    end
+    
+    it 'should add an error to stored errors' do
+      Errawr.register!(:dummy_error)
+      Errawr::Mapper[:dummy_error].should_not be_nil
+    end
+    
+    it 'should not add :error options to context' do
+      Errawr.register!(:dummy_error, error: { name: :same_dummy_error })
+      begin
+        Errawr.error!(:dummy_error)
+      rescue => e
+        e.context.include?(:error).should be_false
+      end
+    end
+  end
+  
+  describe 'error!' do
+    it 'should return custom context values from locale file' do
+      Errawr.register!(:error_hash)
+      begin
+        Errawr.error!(:error_hash)
+      rescue => e
+        e.context.include?(:name).should be_true
+      end
+    end
+    
+    it '#register! should override custom context values from locale file' do
+      Errawr.register!(:error_hash, name: 'register!_name')
+      begin
+        Errawr.error!(:error_hash)
+      rescue => e
+        e.context[:name].should == 'register!_name'
+      end
+    end
+    
+    it '#error! should override custom context values from #register! and locale file' do
+      Errawr.register!(:error_hash, name: 'register!_name')
+      begin
+        Errawr.error!(:error_hash, name: 'error!_name')
+      rescue => e
+        e.context[:name].should == 'error!_name'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'errawr'
+
+# Require supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| puts f; require f }

data/spec/support/dummy_error.rb

@@ -0,0 +1,5 @@
+class DummyError < Errawr::Error
+  def initialize
+    @key = :dummy_key
+  end
+end

data/spec/support/en.yml

@@ -0,0 +1,9 @@
+en:
+  errawr:
+    some_error: Some error has occurred
+    error_hash:
+      name: error_name
+      error:
+        message: Some hashed error has occurred
+    bad_error_hash:
+      name: bad_error

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: errawr
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Anthony Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Easily define and raise localized errors.
+email:
+- anthony@sticksnleaves.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- errawr.gemspec
+- lib/errawr.rb
+- lib/errawr/error.rb
+- lib/errawr/locales/en.yml
+- lib/errawr/mapper.rb
+- lib/errawr/version.rb
+- spec/errawr_spec.rb
+- spec/error_spec.rb
+- spec/mapper_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_error.rb
+- spec/support/en.yml
+homepage: http://www.github.com/anthonator/errawr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A framework for effectively defining and raising localized errors.
+test_files:
+- spec/errawr_spec.rb
+- spec/error_spec.rb
+- spec/mapper_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_error.rb
+- spec/support/en.yml