exceptor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 367de4b84b72b82e01669953ae8c4d29ec231fa0
+  data.tar.gz: 96933f4a4bcf97adcc24868e767b6ffc909c369b
+SHA512:
+  metadata.gz: 6b33f4f6e012bb107dd02ff200bc7d10cec0c44ca7f0ec37346cf5cb010efe902264b19dfd120c8437e52823762b426ce0870cd646e5c9d293b11cc0eccce529
+  data.tar.gz: a18a1caa17591478db2d64e54dcb94f6ef271759968c3d6c043e5c11b4c5a9900e08af3b2a1330be3b5b444a85c1894a8e3ffd71937402914efb634b6904fe32

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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/RAILS.md

@@ -0,0 +1,78 @@
+# Integrate Rails with Exceptor
+Exceptor is more flexible vs ActiveSupport::Rescuable & It's different in context.
+
+There is a great pattern that fits with RoR.
+
+At first we need to create a new directory inside the `app` directory:
+
+    $ cd your-rails-app/app
+    $ mkdir exceptions
+
+After that, we need to paste below line inside `Application` class located in `config` directory to fix autoload problem.
+
+```ruby
+config.autoload_paths << Rails.root.join('app')
+```
+
+Imagine we want to use Exceptor in all of the controllers.
+
+    $ cd your-rails-app/app/exceptions
+    $ mkdir controllers
+    $ touch application_controller.rb
+
+Let's edit the new file `application_controller` like this:
+
+```ruby
+module Exceptions
+  module Controllers
+    class ApplicationController < Exceptor::Base
+      on(:defualt) do |context,error|
+        render json: { error: 'Something went wrong' }
+      end
+      on(ActiveRecord::RecordInvalid) do |context,error|
+        render json: {
+          errors: error.record.errors
+        }  
+      end
+      # ...
+    end
+  end
+end
+```
+The we need to edit `application_controller.rb` inside `app/controllers/` directory.
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Exceptor::Safe
+  default_exceptor Exceptions::Controllers::ApplicatonController
+end
+```
+
+You can use `exceptor` closure on all of the controllers now!
+
+For example instead of:
+```ruby
+class UsersController < ApplicationController
+  def create
+    begin
+      user.create!(user_params)
+    rescue ActiveRecord::RecordInvalid
+      render json: {
+        errors: user.errors
+      }
+    end
+  end
+end
+```
+You can do:
+```ruby
+class UsersController < ApplicationController
+  def create
+    exceptor do
+      user.create!(user_params)
+    end
+  end
+end
+```
+
+That's all, It's useful isn't it?

data/README.md

@@ -0,0 +1,97 @@
+# Exceptor
+
+Handle your exceptions with an elegant OO pattern.
+## Introduction
+
+With Exceptor handle all of your exceptions in one place, Don't repeat yourself! define a handler for your exception and use it all over the program.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exceptor', '~> 1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exceptor
+
+## Usage
+
+Let's define a handler for exceptions
+```ruby
+class ExceptionHandler < Exceptor::Base
+
+  on(:default) do |context,error|
+    # self is equal to instance which error raised on.
+    # context is the closure binding
+    # error contains error information such as message, exception and ...
+    "#{@instance_var} #{context.local_var} raised #{error.class}"
+  end
+
+  on(StandardError) do |context,error|
+    "#{@instance_var} #{context.local_var} raised StandardError"
+  end
+
+end
+```
+As you see, we can define a handler for all non-defined exceptions with `:default` argument.
+Also inside the block you can directly access to the instance which error raised on, and you can access block binding too(from context argument).
+
+Ok, Let's use our `ExceptionHandler`:
+
+```ruby
+class Foo
+  include Exceptor::Safe
+  default_exceptor ExceptionHandler
+
+  def initialize
+    @instance_var = "Foo"
+  end
+
+  def save
+    local_var = "Bar"
+    # Just put your dangerous code inside exceptor block, That's all
+    exceptor do
+      bar.save # For example bar.save is gonna raise StandardError
+    end
+  end
+
+end
+
+object = Foo.new.save
+# => "Foo Bar raised StandardError"
+```
+
+As you see, you can define handler for your exceptions, and use it with `exceptor` closure! Also setting `default_exceptor` isn't required.
+
+Also you can pass your handler like:
+
+```ruby
+exceptor(MyCustomHandler) do
+  # put your dangerous code here
+end
+```
+
+Exceptor is very handy, you can use it in your daily programming.
+
+Exceptor is about 70-80 lines of code(It's small), so there isn't any performance issue.
+
+You can use [specs](https://github.com/EhsanYousefi/Exceptor/blob/master/spec/exceptor_spec.rb) as example.
+
+## Rails users
+
+If you want to use Exceptor in a RoR application, [Check this out](https://github.com/EhsanYousefi/Exceptor/blob/master/ROR.md)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/EhsanYousefi/Exceptor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "exceptor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exceptor.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exceptor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exceptor"
+  spec.version       = Exceptor::VERSION
+  spec.authors       = ["Ehsan Yousefi"]
+  spec.email         = ["ehsan.yousefi@live.com"]
+
+  spec.summary       = %q{Handle your exceptions with an elegant OO pattern.}
+  spec.description   = %q{With Exceptor handle all of your exceptions in one place, Don't repeat yourself! define a handler for your exception and use it all over the program.}
+  spec.homepage      = "https://github.com/EhsanYousefi/Exceptor"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/exceptor.rb

@@ -0,0 +1,14 @@
+require "exceptor/version"
+require "exceptor/base"
+require "exceptor/class_methods"
+require "exceptor/instance_methods"
+require "exceptor/context_delegator"
+
+module Exceptor
+  module Safe
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.include(InstanceMethods)
+    end
+  end
+end

data/lib/exceptor/base.rb

@@ -0,0 +1,27 @@
+require_relative 'class_attr'
+module Exceptor
+  class Base
+
+    extend ClassAttr
+    class_attr :exceptors
+
+    def self.inherited(subclass)
+      subclass.exceptors = subclass.exceptors.dup if subclass.exceptors
+      super
+    end
+
+    def self.on(exception, &block)
+      if exception == :default
+        if self.exceptors
+          self.exceptors.default = block
+        else
+          self.exceptors = {}.tap { |o| o.default = block }
+        end
+      else
+        self.exceptors ||= {}
+        self.exceptors[exception] = block
+      end
+    end
+
+  end
+end

data/lib/exceptor/class_attr.rb

@@ -0,0 +1,12 @@
+module Exceptor
+  module ClassAttr
+
+    def class_attr(*args)
+      args.each do |arg|
+        define_singleton_method(arg) { {} }
+        define_singleton_method("#{arg}=") { |param| define_singleton_method(arg) { param } }
+      end
+    end
+
+  end
+end

data/lib/exceptor/class_methods.rb

@@ -0,0 +1,20 @@
+module Exceptor
+  module ClassMethods
+
+    def self.extended(base)
+      base.extend(ClassAttr)
+      base.class_attr :_default_exceptor
+      base.define_singleton_method(:default_exceptor) { |param| self._default_exceptor = param }
+    end
+
+    def exceptor(constant = nil,&block)
+      constant ||= self._default_exceptor
+      begin
+        block.call
+      rescue => e
+        instance_exec(ContextDelegator.new(block.binding),e,&constant.exceptors[e.class])
+      end
+    end
+
+  end
+end

data/lib/exceptor/context_delegator.rb

@@ -0,0 +1,14 @@
+module Exceptor
+  class ContextDelegator < BasicObject
+
+    def initialize(context)
+      @context = context
+    end
+
+    def method_missing(name, *args, &block)
+      name = name.id2name
+      name.delete!('=') ? @context.local_variable_set(name, args[0]) : @context.local_variable_get(name)
+    end
+
+  end
+end

data/lib/exceptor/instance_methods.rb

@@ -0,0 +1,14 @@
+module Exceptor
+  module InstanceMethods
+
+    def exceptor(constant = nil,&block)
+      constant ||= self.class._default_exceptor
+      begin
+        block.call
+      rescue => e
+        instance_exec(ContextDelegator.new(block.binding),e,&constant.exceptors[e.class])
+      end
+    end
+
+  end
+end

data/lib/exceptor/version.rb

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

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: exceptor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ehsan Yousefi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: With Exceptor handle all of your exceptions in one place, Don't repeat
+  yourself! define a handler for your exception and use it all over the program.
+email:
+- ehsan.yousefi@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- RAILS.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exceptor.gemspec
+- lib/exceptor.rb
+- lib/exceptor/base.rb
+- lib/exceptor/class_attr.rb
+- lib/exceptor/class_methods.rb
+- lib/exceptor/context_delegator.rb
+- lib/exceptor/instance_methods.rb
+- lib/exceptor/version.rb
+homepage: https://github.com/EhsanYousefi/Exceptor
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Handle your exceptions with an elegant OO pattern.
+test_files: []