chatty_error 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ee6c167ded044fc0f026fbb193fb7a3e1766c7f
+  data.tar.gz: fe0e92dd3fc3ff62aa9739865309fd55c966c7d3
+SHA512:
+  metadata.gz: 8f43c037fc81a0802b62cb0b3c9a86504850f24c56e669c313a48961c10a0458e315564070464938ba2dafc963e0a1fc9ff72a0ac4a6da1da5cae4d5363148f4
+  data.tar.gz: a977da3e3455b0099490a412e87bb2cb60d86344509743090e7d308924e54f9770f85f9d941fdb0c825203115bd770226bbde42871cd6faa051af58a6c94e74c

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chatty_error.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,31 @@
+Copyright (c) 2013, Synergy Marketing, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+Neither the name of the Synergy Marketing, Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.
+

data/README.md

@@ -0,0 +1,68 @@
+# ChattyError
+
+'chatty_error' helps you create error with message easily. An error message is loaded from i18n locale file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chatty_error'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chatty_error
+
+## Examples
+
+my_error.rb
+
+    class MyError < StandardError
+      include ChattyError
+
+      caused_by :file_not_found, :user_disabled
+    end
+
+en.yml
+
+    en:
+      chatty_errors:
+        my_error:
+          file_not_found: "File not found!!!"
+          user_disabled: "User disabled!!!"
+
+model.rb
+
+    class Model
+      def exist?(file_path)
+        unless File.exist?(file_path)
+          raise MyError.file_not_found
+        end
+
+        # some code ...
+
+      rescue MyError => e
+        puts e.message # => File not found!!! (autoload from en.yml)
+      end
+
+      def authenticate(user)
+        if user.disabled?
+          raise MyError.user_disabled
+        end
+
+        # some code ...
+      rescue MyError => e
+        puts e.message # => User disabled!!! (autoload from en.yml)
+      end
+    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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/chatty_error.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chatty_error/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chatty_error"
+  spec.version       = ChattyError::VERSION
+  spec.authors       = ["Kentaro Kawano"]
+  spec.email         = ["info@techscore.com"]
+  spec.description   = %q{'chatty_error' helps you create error with message easily. An error message is loaded from i18n locale file.}
+  spec.summary       = %q{'chatty_error' helps you create error with message easily.}
+  spec.homepage      = "https://github.com/techscore/chatty_error"
+  spec.license       = "The BSD 3-Clause License"
+
+  spec.required_ruby_version     = '>= 1.9.3'
+
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "i18n"
+  spec.add_development_dependency "rspec"
+end

data/lib/chatty_error.rb

@@ -0,0 +1,75 @@
+require "chatty_error/version"
+require "chatty_error/configuration"
+require "i18n"
+
+module ChattyError
+  def cause
+    @cause
+  end
+
+  def cause=(cause)
+    @cause = cause
+  end
+
+  def options
+    @options
+  end
+
+  def options=(options)
+    @options = options
+  end
+
+  module ClassMethods
+    def configuration
+      if @configuration.nil? && self.superclass.methods.include?(:configuration)
+        @configuration = self.superclass.configuration.clone
+      else
+        @configuration ||= Configuration.new
+      end
+    end
+
+    def configuration=(conf)
+      @configuration = conf
+    end
+
+    def configure
+      yield configuration if block_given?
+    end
+
+    def underscore(string)
+      string.gsub(/::/, '.') \
+        .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2') \
+        .gsub(/([a-z\d])([A-Z])/,'\1_\2') \
+        .tr("-", "_").downcase
+    end
+
+    def generate_key(class_name, method_name)
+      [underscore(class_name), method_name.to_s.downcase].join('.')
+    end
+
+    def error_message(name, method_name, options={})
+      key = generate_key(name, method_name)
+      I18n.t(key,
+             :scope => configuration.default_scope,
+             :default => [:default, configuration.default_message],
+             :locale => options[:locale])
+    end
+
+    def caused_by(*args)
+      args.each do |method_name|
+        class_name = self.name
+        define_singleton_method method_name do |options={}|
+          message = self.error_message(class_name, method_name, options)
+          e = self.new(message)
+          e.cause = method_name
+          e.options = options
+          return e
+        end
+      end
+    end
+  end
+
+  def self.included(klass)
+    klass.extend ChattyError::ClassMethods
+  end
+end

data/lib/chatty_error/configuration.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+module ChattyError
+
+  class Configuration
+    attr_accessor :default_scope, :default_message
+
+    def initialize
+      @default_scope = 'chatty_errors'
+      @default_message = ''
+    end
+  end
+
+end

data/lib/chatty_error/version.rb

@@ -0,0 +1,3 @@
+module ChattyError
+  VERSION = "1.0.0"
+end

data/spec/chatty_error_spec.rb

@@ -0,0 +1,139 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe ChattyError do
+  describe '#included' do
+    context 'methods defined' do
+      it { expect(FooError.methods.include?(:configuration)).to be true }
+      it { expect(FooError.methods.include?(:configuration=)).to be true }
+      it { expect(FooError.methods.include?(:configure)).to be true }
+      it { expect(FooError.methods.include?(:generate_key)).to be true }
+      it { expect(FooError.methods.include?(:error_message)).to be true }
+      it { expect(FooError.methods.include?(:caused_by)).to be true }
+      it { expect(FooError.new.methods.include?(:cause)).to be true }
+      it { expect(FooError.new.methods.include?(:cause=)).to be true }
+      it { expect(FooError.new.methods.include?(:options)).to be true }
+      it { expect(FooError.new.methods.include?(:options=)).to be true }
+    end
+  end
+
+  describe '#configure' do
+    context 'return nil unless block_given' do
+      it { expect(BarError.configure).to be nil}
+    end
+
+    context 'configure default scope' do
+      it { expect(BarError.configuration.default_scope).to eq :other_scope }
+    end
+
+    context 'configure default message' do
+      it { expect(BarError.configuration.default_message).to eq "error" }
+    end
+  end
+
+  describe '#configuration' do
+    context 'inherit from parent' do
+      it { expect(FooFooError.configuration.default_scope).to eq "fooooo" }
+      it { expect(FooFooError.configuration.default_message).to eq "foo error" }
+    end
+
+    context 'configure' do
+      it { expect(FooError.configuration.default_scope).to eq "fooooo" }
+      it { expect(FooError.configuration.default_message).to eq "foo error" }
+      it { expect(Foo2Error.configuration.default_scope).to eq "foo2" }
+      it { expect(Foo2Error.configuration.default_message).to eq "foo2 error" }
+    end
+  end
+
+  describe '#undercase' do
+    it { expect(BazError.underscore('A')).to eq 'a' }
+    it { expect(BazError.underscore('Abc')).to eq 'abc' }
+    it { expect(BazError.underscore('AbcD')).to eq 'abc_d' }
+    it { expect(BazError.underscore('AbcDef')).to eq 'abc_def' }
+    it { expect(BazError.underscore('ABCD')).to eq 'abcd' }
+    it { expect(BazError.underscore('ABcDe')).to eq 'a_bc_de' }
+    it { expect(BazError.underscore('A::BCD')).to eq 'a.bcd' }
+    it { expect(BazError.underscore('A::B::CD')).to eq 'a.b.cd' }
+    it { expect(BazError.underscore('A::B::C::D')).to eq 'a.b.c.d' }
+    it { expect(BazError.underscore('AAA::BBB::CCC::DDD')).to eq 'aaa.bbb.ccc.ddd' }
+    it { expect(BazError.underscore('AaaBbb::CccDdd')).to eq 'aaa_bbb.ccc_ddd' }
+  end
+
+  describe '#generate_key' do
+    it { expect(FooError.generate_key(FooError.name, :foo)).to eq 'foo_error.foo' }
+    it { expect(BarError.generate_key(BarError.name, :bar)).to eq 'bar_error.bar' }
+    it { expect(Boo::Error.generate_key(Boo::Error.name, :boo)).to eq 'boo.error.boo' }
+    it { expect(Boo::Foo::Error.generate_key(Boo::Foo::Error.name, :boofoo)).to eq 'boo.foo.error.boofoo' }
+    it { expect(Boo::Foo::Woo::Error.generate_key(Boo::Foo::Woo::Error.name, :boofoo_woo)).to eq 'boo.foo.woo.error.boofoo_woo' }
+    it { expect(Boo::Foo::Woo::Error2.generate_key(Boo::Foo::Woo::Error2.name, :boofoo_woo)).to eq 'boo.foo.woo.error2.boofoo_woo' }
+  end
+
+  describe '#error_message' do
+    context 'default configuration' do
+      let (:default_error_message) { I18n.t('chatty_errors.default') }
+      it { expect(HogeError.error_message(HogeError.name, :base)).to eq default_error_message }
+      it { expect(HogeError.error_message(HogeError.name, :hoge1)).to eq default_error_message }
+      it { expect(HogeError.error_message(HogeError.name, :hoge2)).to eq default_error_message }
+    end
+
+    context 'specific configuration' do
+      context 'in yml' do
+        it { expect(BaseError.error_message(BaseError.name, :base)).to eq I18n.t('chatty_errors.base_error.base') }
+        it { expect(PiyoError.error_message(PiyoError.name, :piyopiyo)).to eq I18n.t('my_errors.piyo_error.piyopiyo') }
+
+      end
+
+      context 'not in yml' do
+        it { expect(PiyoError.error_message(PiyoError.name, :piyopiyo2)).to eq 'p_error' }
+      end
+    end
+  end
+
+  describe '#caused_by' do
+    context 'defined method' do
+      it { expect(BaseError.methods.include?(:base)).to be true }
+      it { expect(HogeError.methods.include?(:base)).to be true }
+      it { expect(HogeError.methods.include?(:hoge1)).to be true }
+      it { expect(HogeError.methods.include?(:hoge2)).to be true }
+      it { expect(PiyoError.methods.include?(:piyopiyo)).to be true }
+    end
+
+    context 'initialize self instance' do
+      it { expect(HogeError.base).to be_an_instance_of HogeError }
+      it { expect(HogeError.hoge1).to be_an_instance_of HogeError }
+      it { expect(HogeError.hoge2).to be_an_instance_of HogeError }
+
+      it { expect(PiyoError.piyopiyo).to be_an_instance_of PiyoError }
+    end
+
+    context 'raise error' do
+      it { expect{raise HogeError.base}.to raise_error(HogeError) }
+      it { expect{raise HogeError.hoge1}.to raise_error(HogeError) }
+      it { expect{raise HogeError.hoge2}.to raise_error(HogeError) }
+      it { expect{raise PiyoError.piyopiyo}.to raise_error(PiyoError) }
+    end
+
+    context 'error message' do 
+      it { expect(BaseError.base.message).to eq I18n.t('chatty_errors.base_error.base') }
+      it { expect(HogeError.base.message).to eq I18n.t('chatty_errors.base_error.base') }
+      it { expect(HogeError.hoge1.message).to eq I18n.t('chatty_errors.default') }
+      it { expect(HogeError.hoge2.message).to eq I18n.t('chatty_errors.default') }
+      it { expect(HogeHogeError.base.message).to eq I18n.t('chatty_errors.hoge_hoge_error.base') }
+      it { expect(HogeHogeError.hoge1.message).to eq I18n.t('chatty_errors.default') }
+      it { expect(HogeHogeError.hoge2.message).to eq I18n.t('chatty_errors.default') }
+      it { expect(PiyoError.base.message).to eq I18n.t('my_errors.base_error.base') }
+      it { expect(PiyoError.piyopiyo.message).to eq I18n.t('my_errors.piyo_error.piyopiyo') }
+      it { expect(PiyoPiyoError.base.message).to eq I18n.t('my_errors.piyo_piyo_error.base') }
+      it { expect(PiyoPiyoError.piyopiyo.message).to eq I18n.t('my_errors.piyo_error.piyopiyo') }
+      it { expect(PiyoPiyoError.piyoooo.message).to eq I18n.t('my_errors.piyo_piyo_error.piyoooo') }
+      it { expect(PiyoPiyoError.piyoooo(:locale => :en).message).to eq \
+           I18n.t('my_errors.piyo_piyo_error.piyoooo', :locale => :en) }
+    end
+
+    context 'cause' do
+      it { expect(BaseError.base.cause).to eq :base }
+      it { expect(HogeError.hoge1.cause).to eq :hoge1 }
+    end
+  end
+end

data/spec/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  my_errors:
+    piyo_piyo_error:
+      piyoooo: "error: piyoooo"
+

data/spec/locales/ja.yml

@@ -0,0 +1,17 @@
+ja:
+  chatty_errors:
+    default: "エラーが発生しました"
+    base_error:
+      base: "エラー: base(base_error)"
+    hoge_hoge_error:
+      base: "エラー: base(hoge_hoge_error)"
+  my_errors:
+    base_error:
+      base: "エラー: base(piyo_error)"
+    hoge_error:
+      hoge1: "エラー: hoge1"
+    piyo_error:
+      piyopiyo: "エラー: piyopiyo"
+    piyo_piyo_error:
+      base: "エラー: base(piyo_piyo_error)"
+      piyoooo: "error: piyoooo"

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'chatty_error'
+
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end
+
+I18n.default_locale = :ja
+I18n.load_path = Dir["#{File.dirname(__FILE__)}/locales/*.yml"]

data/spec/support/models.rb

@@ -0,0 +1,80 @@
+# coding: utf-8
+
+class FooError < StandardError
+  include ChattyError
+
+  configure do |c|
+    c.default_scope = 'fooooo'
+    c.default_message = 'foo error'
+  end
+end
+
+class FooFooError < FooError
+end
+
+class Foo2Error < FooError
+  configure do |c|
+    c.default_scope = 'foo2'
+    c.default_message = 'foo2 error'
+  end
+end
+
+class BarError < StandardError
+  include ChattyError
+
+  configure do |c|
+    c.default_scope = :other_scope
+    c.default_message = "error"
+  end
+end
+
+class BazError < StandardError
+  include ChattyError
+end
+
+module Boo
+  class Error < StandardError
+    include ChattyError
+  end
+
+  module Foo
+    class Error < StandardError
+      include ChattyError
+    end
+
+    module Woo
+      class Error < StandardError
+        include ChattyError
+      end
+
+      class Error2 < Error
+      end
+    end
+  end
+end
+
+class BaseError < StandardError
+  include ChattyError
+  caused_by :base
+end
+
+class HogeError < BaseError
+  caused_by :hoge1, :hoge2
+end
+
+class HogeHogeError < HogeError
+  caused_by :base
+end
+
+class PiyoError < BaseError
+  caused_by :piyopiyo
+
+  configure do |c|
+    c.default_scope = 'my_errors'
+    c.default_message = 'p_error'
+  end
+end
+
+class PiyoPiyoError < PiyoError
+  caused_by :base, :piyoooo
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: chatty_error
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kentaro Kawano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-12 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: '''chatty_error'' helps you create error with message easily. An error
+  message is loaded from i18n locale file.'
+email:
+- info@techscore.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- chatty_error.gemspec
+- lib/chatty_error.rb
+- lib/chatty_error/configuration.rb
+- lib/chatty_error/version.rb
+- spec/chatty_error_spec.rb
+- spec/locales/en.yml
+- spec/locales/ja.yml
+- spec/spec_helper.rb
+- spec/support/models.rb
+homepage: https://github.com/techscore/chatty_error
+licenses:
+- The BSD 3-Clause License
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: '''chatty_error'' helps you create error with message easily.'
+test_files:
+- spec/chatty_error_spec.rb
+- spec/locales/en.yml
+- spec/locales/ja.yml
+- spec/spec_helper.rb
+- spec/support/models.rb