errawr 1.1.6 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be2440444126c0bf8520e79f82f1390e69840420
-  data.tar.gz: 54c653df41721042a39e81858e3f2fc9d5bc164b
+  metadata.gz: b15331e311d4b2350523dcf6d915e6b911c5aa1d
+  data.tar.gz: c3652e013846e44f69b465f774bbe95282e8312d
 SHA512:
-  metadata.gz: eebb52e2d62840f94662258155c5d65b3b1d247b7d35ff89a6c0e8f1f6feb59332f7b1d55d7f797b4a23668c1009c000b9be67c9cf9669168b78795ff197b3ee
-  data.tar.gz: 789f8f217c980bd913d90bb0825631e8e79dba6c4f195a94b0acb7aea0bfd38f18f27a6d3dc767199d800ef3a037af1a240aac3e3253b69ac9ec85f64e2d12c7
+  metadata.gz: 097272fcd210ba08660135400117c20ca658cb208d75989fdd67be7800020bca07c7fc687c78e04a49725378517838351a64e3dc65424b4e34f5f259a6b842b2
+  data.tar.gz: e9a7cbbb11b7ab43296b396fe741368a88cd51ec7f7f367f3401cb480f98160b19a4916e8ddd9633a85f826c4e347acf3e521dfd38fa2021c88f1781f75398e2

data/.travis.yml

@@ -2,7 +2,13 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
+  - 2.2.0
   - ruby-head
   - jruby-19mode
   - jruby-head
-  - rbx
+  - rbx
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -6,17 +6,9 @@ gemspec
 group :development do
   gem 'bundler'
   gem 'coveralls', require: false
-  gem 'rake'
 end
 
 group :test do
   gem 'rspec'
   gem 'simplecov'
 end
-
-platforms :rbx do
-  gem 'racc'
-  gem 'rubinius-coverage', github: 'rubinius/rubinius-coverage'
-  gem 'rubysl'
-  gem 'rubysl-json'
-end

data/README.md

@@ -20,46 +20,24 @@ Or install it yourself as:
 
 ## Usage
 
-### Localizations
+### Defining and Raising Errors
 
-Errawr uses [I18n](https://github.com/svenfuchs/i18n) for easily managing error localizations. Just define a locale using the ```errawr``` key.
+Errawr uses [I18n](https://github.com/svenfuchs/i18n) for easily managing error
+localizations. Just define an error in a locale file. Make sure to use 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)
+    your_error:
+      message: My awesome error message
+      metadata:
+        http_status: 400
 ```
 
-### Raising Errors
+Then just raise your exception using the `#error!` method.
 
 ```ruby
-begin
-  Errawr.error!(:your_error)
-rescue => e
-  puts e.message # Localized error message defined in locale file
-end
-```
-
-### Metadata
-
-It's possible to add additional information to a registered error through metadata. Just specify a ```metadata``` hash when either registering:
-
-```ruby
-Errawr.register!(:your_error, metadata: { http_status: 400 })
 begin
   Errawr.error!(:your_error)
 rescue => e
@@ -67,36 +45,20 @@ rescue => e
 end
 ```
 
-or throwing an error:
+Need to add more locale files? Use I18n's standard ```load_path```.
 
 ```ruby
-Errawr.register!(:your_error)
-begin
-  Errawr.error!(:your_error, metadata: { http_status: 400 })
-rescue => e
-  puts e.metadata[:http_status] # Will return 400
-end
+I18n.load_path += Dir.glob('lib/your_lib/locales/*.{rb,yml}')
 ```
 
-### 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:
-      message: My awesome error message
-      metadata:
-        http_status: 400
-```
+### Metadata
 
-Then just register and raise your exceptions like normal.
+It's possible to add additional information to a registered error through
+metadata. Just specify a ```metadata``` hash when throwing an error:
 
 ```ruby
-Errawr.register!(:your_error)
 begin
-  Errawr.error!(:your_error)
+  Errawr.error!(:your_error, metadata: { http_status: 400 })
 rescue => e
   puts e.metadata[:http_status] # Will return 400
 end
@@ -114,9 +76,8 @@ en
 ```
 
 ```ruby
-Errawr.register!(:your_error, error_message: 'You did it wrong!')
 begin
-  Errawr.error!(:your_error)
+  Errawr.error!(:your_error, error_message: 'You did it wrong!')
 rescue => e
   puts e.message # Will return "My awesome error message is: You did it wrong!"
 end
@@ -124,7 +85,8 @@ end
 
 ### Overrides
 
-Want to override that metadata you registered? That's cool too.
+It's possible to override metadata stored in a locale file both globally and
+on a per use basis.
 
 ```yaml
 en:
@@ -157,7 +119,7 @@ rescue => e
   puts e.message # => Will return "Yet another error message"
   puts e.metadata[:http_status] # => Will return 404
 end
-``` 
+```
 
 ### Custom Error Classes
 
@@ -194,4 +156,4 @@ end
 
 Errawr is maintained and funded by [Sticksnleaves](http://www.sticksnleaves.com)
 
-Thanks to all of our [contributors](https://github.com/anthonator/errawr/graphs/contributors)
+Thanks to all of our [contributors](https://github.com/anthonator/errawr/graphs/contributors)

data/lib/errawr.rb

@@ -7,24 +7,24 @@ require 'errawr/version'
 module Errawr
   I18n.load_path << "#{File.dirname(__FILE__)}/errawr/locales/en.yml"
   I18n.reload!
-  
+
   def self.included(base)
     base.extend(ClassMethods)
   end
-  
+
   module ClassMethods
     def error!(name, context = {})
-      klass = Mapper[name] || Mapper[:unknown]
+      klass = Mapper[name] || Error.new(name, context)
       klass.update_context(context) unless context.empty?
-      raise klass
+      fail klass
     end
 
     def register!(key, options = {})
       Mapper.register!(key, options)
     end
   end
-  
+
   extend ClassMethods
-  
+
   register!(:unknown)
 end

data/lib/errawr/error.rb

@@ -1,37 +1,38 @@
 module Errawr
   class Error < StandardError
     attr_reader :key, :context, :metadata
-    
+
     def initialize(key = :unknown, context = {})
       @key = key
-      @context = context
+      @context = context.dup
       @metadata = {}
       @i18n = I18n.t('errawr.' + @key.to_s)
       update_context(@context)
     end
-    
+
     def message
       process_message
     end
-    
+
     def update_context(context)
       process_context(context)
     end
-    
+
     private
+
     def process_context(context)
       @message_overridden = context.include?(:message)
-      if @i18n.kind_of?(Hash)
+      if @i18n.is_a?(Hash)
         @context.merge!(@i18n.merge(context))
       else
         @context.merge!(context)
       end
-      @metadata.merge!(@context.delete(:metadata)) if @context.has_key?(:metadata)
+      @metadata.merge!(@context.delete(:metadata)) if @context.key?(:metadata)
     end
-    
+
     def process_message
       return @context[:message] if @message_overridden
-      if @i18n.kind_of?(Hash)
+      if @i18n.is_a?(Hash)
         key = 'errawr.' + @key.to_s + '.message'
         @context[:message] = I18n.t(key, @context.merge({ default: I18n.t('errawr.unknown', @context) }))
       else
@@ -40,4 +41,4 @@ module Errawr
       @context[:message]
     end
   end
-end
+end

data/lib/errawr/version.rb

@@ -1,3 +1,3 @@
 module Errawr
-  VERSION = '1.1.6'
+  VERSION = '1.2.0'
 end

data/spec/errawr_spec.rb

@@ -3,69 +3,66 @@ require 'spec_helper'
 describe Errawr do
   describe 'error!' do
     it 'should raise an Errawr::Error exception' do
-      Errawr.register!(:dummy_error)
       expect { Errawr.error!(:dummy_error) }.to raise_error(Errawr::Error)
     end
-    
+
     it 'should return custom metadata values using #register!' do
       Errawr.register!(:some_error, metadata: { name: 'custom_register!_name' })
       begin
         Errawr.error!(:some_error)
       rescue => e
-        e.metadata[:name].should == 'custom_register!_name'
+        expect(e.metadata[:name]).to eq('custom_register!_name')
       end
     end
-    
-    it 'should return custom metadata values using #error!' do
+
+    it 'should return custom metadata set with #register! using #error!' do
       Errawr.register!(:some_error, metadata: { name: 'custom_register!_name' })
       begin
         Errawr.error!(:some_error, metadata: { name: 'custom_error!_name' })
       rescue => e
-        e.metadata[:name].should == 'custom_error!_name'
+        expect(e.metadata[:name]).to eq('custom_error!_name')
       end
     end
-    
+
     it 'should return custom metadata values from locale file' do
-      Errawr.register!(:error_hash)
       begin
         Errawr.error!(:error_hash)
       rescue => e
-        e.metadata.include?(:name).should be_true
+        expect(e.metadata).to include(:name)
       end
     end
-    
-    it 'should override custom metadata values from #register! and locale file' do
+
+    it 'should override custom metadata values from #register! and locale file using #error!' do
       Errawr.register!(:error_hash, metadata: { name: 'register!_name' })
       begin
         Errawr.error!(:error_hash, metadata: { name: 'error!_name' })
       rescue => e
-        e.metadata[:name].should == 'error!_name'
+        expect(e.metadata[:name]).to eq('error!_name')
       end
     end
-    
+
     it 'should return an overridden message for a non-hashed locale' do
       begin
         Errawr.error!(:some_error, message: 'Overridden error message')
       rescue => e
-        e.message.should == 'Overridden error message'
+        expect(e.message).to eq('Overridden error message')
       end
     end
-    
+
     it 'should return an overridden message for a hashed locale' do
       begin
         Errawr.error!(:error_hash, message: 'Overridden error message')
       rescue => e
-        e.message.should == 'Overridden error message'
+        expect(e.message).to eq('Overridden error message')
       end
     end
-    
+
     it 'should pass in interpolated params' do
-      Errawr.register!(:interpolated_error)
       begin
         Errawr.error!(:interpolated_error, error_message: 'interpolated message')
       rescue => e
-        e.message.should == 'Some error has occurred: interpolated message'
+        expect(e.message).to eq('Some error has occurred: interpolated message')
       end
     end
   end
-end
+end

data/spec/error_spec.rb

@@ -3,21 +3,21 @@ require 'spec_helper'
 describe Errawr::Error do
   it 'should return a key of :unknown if no key is set' do
     error = Errawr::Error.new
-    error.key.should == :unknown
+    expect(error.key).to eq(:unknown)
   end
-  
+
   it 'should return a localized message' do
     error = Errawr::Error.new(:some_error)
-    error.message.should == 'Some error has occurred'
+    expect(error.message).to eq('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'
+    expect(error.message).to eq('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'
+    expect(error.message).to eq('An unknown error has occurred')
   end
-end
+end

data/spec/mapper_spec.rb

@@ -2,75 +2,70 @@ require 'spec_helper'
 
 describe Errawr::Mapper do
   it 'should automatically register an unknown error' do
-    Errawr::Mapper.all[:unknown].should_not be_nil
+    expect(Errawr::Mapper.all[:unknown]).to_not eq(nil)
   end
-  
+
   describe '[]' do
     it 'should return stored errors' do
-      Errawr::Mapper[:unknown].should_not be_nil
+      expect(Errawr::Mapper[:unknown]).to_not eq(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
+      expect(Errawr::Mapper[:dummy_key]).to_not eq(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, 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
+      expect(Errawr::Mapper[:dummy_error]).to_not be_nil
     end
-    
+
     it 'should not add :metadata options to context' do
-      Errawr.register!(:dummy_error, metadata: { name: :same_dummy_error })
       begin
-        Errawr.error!(:dummy_error)
+        Errawr.error!(:dummy_error, metadata: { name: :same_dummy_error })
       rescue => e
-        e.metadata.include?(:error).should be_false
+        expect(e.metadata).to_not include(:error)
       end
     end
-    
+
     it 'should return an overridden message for a non-hashed locale' do
-      Errawr.register!(:some_error, message: 'Overridden error message')
       begin
-        Errawr.error!(:some_error)
+        Errawr.error!(:some_error, message: 'Overridden error message')
       rescue => e
-        e.message.should == 'Overridden error message'
+        expect(e.message).to eq('Overridden error message')
       end
     end
-    
+
     it 'should return an overridden message for a hashed locale' do
-      Errawr.register!(:error_hash, message: 'Overridden error message')
       begin
-        Errawr.error!(:error_hash)
+        Errawr.error!(:error_hash, message: 'Overridden error message')
       rescue => e
-        e.message.should == 'Overridden error message'
+        expect(e.message).to eq('Overridden error message')
       end
     end
-    
+
     it 'should override custom metadata values from locale file' do
-      Errawr.register!(:error_hash, metadata: { name: 'register!_name' })
       begin
-        Errawr.error!(:error_hash)
+        Errawr.error!(:error_hash, metadata: { name: 'register!_name' })
       rescue => e
-        e.metadata[:name].should == 'register!_name'
+        expect(e.metadata[:name]).to eq('register!_name')
       end
     end
-    
+
     it 'should interpolate locales' do
-      Errawr.register!(:interpolated_error, error_message: 'interpolated message')
       begin
-        Errawr.error!(:interpolated_error)
+        Errawr.error!(:interpolated_error, error_message: 'interpolated message')
       rescue => e
-        e.message.should == 'Some error has occurred: interpolated message'
+        expect(e.message).to eq('Some error has occurred: interpolated message')
       end
     end
   end
-end
+end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: errawr
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.2.0
 platform: ruby
 authors:
 - Anthony Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2015-07-18 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.
@@ -59,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,17 +87,17 @@ 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
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A framework for effectively defining and raising localized errors.