tagful 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5af551adaa68565b0f1fbe40f255e3648b5c5ec
+  data.tar.gz: 7dcb4e485e45033699f19a4b73b45b308c65b6aa
+SHA512:
+  metadata.gz: 9f199d9b6269b61a7fecd74780aa44085788597e0bf1a6c4a99017021327b896db5cbaee78e7307a7e46ce87bfd757656071df96c04f9b4930a41b8fcab42244
+  data.tar.gz: e411cefdf656d91d541e6c361918a4435d0cb1b3fb5b0a751e3a46813c0ca6789665bd611a01f4a560c6b786301657ae736360281366e3f3550dae1a3c822baf

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Seiei Higa
+
+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,130 @@
+# Tagful
+
+Tagging your exception.
+
+based on: [Exceptional Ruby: Master the art of handling failure in Ruby](http://exceptionalruby.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tagful'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tagful
+
+## Usage
+
+Tagging your exception with `tagful`
+
+```ruby
+class Person
+  include Tagful
+
+  # Ruby 2.1 or later
+  tagful\
+  def hello
+    raise 'hello'
+  end
+
+  # Ruby 2.0
+  def hello
+    raise 'hello'
+  end
+  tagful :hello
+end
+
+begin
+  Person.new.hello
+rescue Person::Error => e
+  puts e.message
+end
+# hello
+```
+
+You can specify your error module by `tagful_with`:
+
+```ruby
+class Robot
+  include Tagful
+
+  module Broken; end
+
+  tagful_with Broken
+
+  tagful\
+  def initialize
+    raise ':('
+  end
+end
+
+begin
+  Robot.new
+rescue Robot::Broken => e
+  puts e.message
+end
+# :(
+```
+
+or pass your error module to `tagful`:
+
+```ruby
+class Person
+  include Tagful
+
+  module NoManner; end
+
+  def eat
+    raise 'burps'
+  end
+  tagful :eat, NoManner
+end
+
+begin
+  Person.new.eat
+rescue Person::NoManner => e
+  puts e.message
+end
+# burps
+```
+
+You can use `Class` instead of `Module`:
+
+```ruby
+class Pizza
+  include Tagful
+
+  class NotFound < ArgumentError
+    def self.exception(message = nil)
+      super("not found: #{message}")
+    end
+  end
+
+  def take_cheese!
+    raise 'cheese'
+  end
+  tagful :take_cheese!, NotFound
+end
+
+begin
+  Pizza.new.take_cheese!
+rescue Pizza::NotFound => e
+  puts e.message
+end
+# not found: cheese
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/hanachin/tagful/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/tagful/version.rb

@@ -0,0 +1,3 @@
+module Tagful
+  VERSION = "1.0.1"
+end

data/lib/tagful.rb

@@ -0,0 +1,77 @@
+require "tagful/version"
+
+module Tagful
+  class NotFound < ArgumentError; end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def tagful_with(error_module_or_class)
+      @tagful_error_module_or_class = error_module_or_class
+    end
+
+    def tagful(method_id, error_module_or_class = nil)
+      visibility =
+        case
+        when public_method_defined?(method_id)
+          :public
+        when protected_method_defined?(method_id)
+          :protected
+        when private_method_defined?(method_id)
+          :private
+        else
+          raise ::Tagful::NoMethod
+        end
+
+      if error_module_or_class.nil?
+        if @tagful_error_module_or_class.is_a?(Class)
+          error_class = @tagful_error_module_or_class
+        else
+          error_module = @tagful_error_module_or_class
+          error_module ||= 'Error'
+        end
+      else
+        if error_module_or_class.is_a?(Class)
+          error_class = error_module_or_class
+        else
+          error_module = error_module_or_class
+        end
+      end
+
+      if error_class
+        class_eval(<<-CODE)
+          module TagfulMethods
+            #{visibility}
+            def #{method_id}(*args)
+              super
+            rescue => e
+              raise #{error_class}, e.message
+            end
+          end
+
+          prepend(TagfulMethods)
+        CODE
+      else
+        class_eval(<<-CODE)
+          unless defined?(#{error_module})
+            module #{error_module}; end
+          end
+
+          module TagfulMethods
+            #{visibility}
+            def #{method_id}(*args)
+              super
+            rescue => e
+              e.extend(#{error_module}) and raise
+            end
+          end
+
+          prepend(TagfulMethods)
+        CODE
+      end
+      method_id
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tagful"
+require "pry"

data/spec/tagful_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+RSpec.describe Tagful do
+  class Person
+    module Error; end
+
+    include Tagful
+
+    def yo
+      raise 'yo'
+    end
+
+    tagful\
+    def hi
+      raise 'hi'
+    end
+
+    tagful\
+    def hello
+      Hello.new
+    end
+
+    private
+
+    tagful\
+    def heart
+      # you can't touch my heart
+    end
+  end
+
+  class HoumorPerson < Person
+    module NotFunny; end
+
+    def say_joke
+      puts 'coffee or tea?'
+      raise 'T'
+    end
+    tagful :say_joke, NotFunny
+  end
+
+  class Hello
+    class Mad < StandardError; end
+
+    def initialize
+      raise Mad, "ugh!"
+    end
+  end
+
+  class Robot
+    include Tagful
+
+    module Broken; end
+    module NoBattery; end
+
+    tagful_with Broken
+
+    tagful\
+    def to_evil
+      raise ':('
+    end
+
+    def walk
+      raise
+    end
+    tagful :walk, NoBattery
+  end
+
+  class Pizza
+    include Tagful
+
+    class Dirty < StandardError; end
+
+    class Factory
+      def self.exception(message = nil)
+        Dirty.new("something wrong in pizza factory: #{message}")
+      end
+    end
+
+    class NotFound < ArgumentError
+      def self.exception(message = nil)
+        super("not found: #{message}")
+      end
+    end
+
+    tagful_with Pizza::Factory
+
+    tagful\
+    def initialize(contamination = nil)
+      if contamination
+        raise contamination.to_s
+      end
+    end
+
+    def take_cheese!
+      raise 'cheese'
+    end
+    tagful :take_cheese!, NotFound
+  end
+
+  describe '.tagful_with' do
+    it 'tagged method with specified Module' do
+      expect { Robot.new.to_evil }.to raise_error(Robot::Broken, ':(')
+    end
+
+    it 'respect tagful arguments' do
+      expect { Robot.new.walk }.to raise_error(Robot::NoBattery) do |error|
+        expect(error).to_not be_an(Robot::Broken)
+      end
+    end
+
+    context 'tagged with class' do
+      it 'raise error by class.exception' do
+        expect { Pizza.new('bug') }.to raise_error(Pizza::Dirty, 'something wrong in pizza factory: bug')
+      end
+    end
+  end
+
+  describe '.tagful' do
+    context 'not tagged method' do
+      it 'raise not tagged error' do
+        expect { Person.new.yo }.to raise_error do |error|
+          expect(error).not_to be_a(Person::Error)
+          expect(error.message).to eq 'yo'
+        end
+      end
+    end
+
+    context 'tagged method' do
+      it 'raise tagged error' do
+        expect { Person.new.hi }.to raise_error(Person::Error, 'hi')
+      end
+
+      it 'respect method visibility' do
+        expect { Person.new.heart }.to raise_error
+      end
+    end
+
+    context 'raise error from inside of tagged method' do
+      it 'raise tagged error' do
+        expect { Person.new.hello }.to raise_error do |error|
+          expect(error).to be_an(Hello::Mad).and be_an(Person::Error)
+          expect(error.message).to eq 'ugh!'
+        end
+      end
+    end
+
+    context 'tagged with class' do
+      it 'raise tagged error class' do
+        expect { Pizza.new.take_cheese! }.to raise_error(Pizza::NotFound, 'not found: cheese')
+      end
+    end
+  end
+end

data/tagful.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tagful/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tagful"
+  spec.version       = Tagful::VERSION
+  spec.authors       = ["Seiei Higa"]
+  spec.email         = ["hanachin@gmail.com"]
+  spec.summary       = %q{Tagging your exception.}
+  spec.homepage      = "https://github.com/hanachin/tagful"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: tagful
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Seiei Higa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: 
+email:
+- hanachin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tagful.rb
+- lib/tagful/version.rb
+- spec/spec_helper.rb
+- spec/tagful_spec.rb
+- tagful.gemspec
+homepage: https://github.com/hanachin/tagful
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Tagging your exception.
+test_files:
+- spec/spec_helper.rb
+- spec/tagful_spec.rb
+has_rdoc: