safely 0.1.0pre

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+group :development do
+  gem "toadhopper"
+
+  gem "rspec", "~> 2.5.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "mocha"
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mocha (0.9.12)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    toadhopper (1.1)
+    yard (0.6.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  mocha
+  rcov
+  rspec (~> 2.5.0)
+  toadhopper
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kenneth Kalmer
+
+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.rdoc

@@ -0,0 +1,60 @@
+= safely
+
+Safely is a simple exception handling and alerting mechanism extract from the daemon-kit[http://github.com/kennethkalmer/daemon-kit] project.
+
+Safely currently supports error reporting to Hoptoad via the Toadhopper[http://github.com/toolmantim/toadhopper] gem. Future support will
+include reporting errors to log files and via email.
+
+== Installation
+
+In your Gemfile
+
+    gem "toadhopper", "~> 1.1"
+    gem "safely", "~> 0.1"
+
+Or directly
+
+    gem install toadhopper -v "~> 1.1"
+    gem install safely -v "~> 0.1"
+
+Although Safely currently only supports Toadhopper, it doesn't specify it as a dependency. This allows for
+future strategies to be added and giving users the choice on which strategy to use without bloating their
+projects.
+
+== Usage
+
+    require 'toadhopper'
+    require 'safely'
+    
+    # Configure
+    Safely.configure do |c|
+      c.hoptoad_key = 'XXXXXXXX'
+    end
+    
+    # Run your code
+    safely do
+      do_something_dangerous!
+    end
+
+== TODO
+
+* Support for mail exceptions
+* Support for logging exceptions
+* Fine-tine strategies
+* Support for trapping exceptions on exit
+
+== Contributing to safely
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Kenneth Kalmer. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'safely'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "safely"
+  gem.homepage = "http://github.com/kennethkalmer/safely"
+  gem.license = "MIT"
+  gem.summary = %Q{Safely run your code, keep track of exceptions}
+  gem.description = %Q{Safely run your code in a loving error reporting embrace}
+  gem.email = "kenneth.kalmer@gmail.com"
+  gem.authors = ["Kenneth Kalmer"]
+  gem.version = Safely::VERSION
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+#RSpec::Core::RakeTask.new(:rcov) do |spec|
+#  spec.pattern = 'spec/**/*_spec.rb'
+#  spec.rcov = true
+#end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/safely/config.rb

@@ -0,0 +1,6 @@
+module Safely
+  class Config
+    # Hoptoad API key
+    attr_accessor :hoptoad_key
+  end
+end

data/lib/safely/mixin.rb

@@ -0,0 +1,15 @@
+module Safely
+  module Mixin
+
+    def safely
+      Safely.load_strategies!
+
+      begin
+        yield
+      rescue => e
+        Safely.report!( e )
+      end
+    end
+
+  end
+end

data/lib/safely.rb

@@ -0,0 +1,51 @@
+$:.unshift File.expand_path('../', __FILE__)
+
+module Safely
+
+  VERSION = "0.1.0pre"
+
+  autoload :Config, 'safely/config'
+  autoload :Mixin,  'safely/mixin'
+
+  class << self
+
+    def reset!
+      self.config = nil
+    end
+
+    def configure
+      yield self.config
+    end
+
+    def config
+      @config ||= Safely::Config.new
+    end
+
+    def load_strategies!
+      begin
+        require 'toadhopper'
+      rescue LoadError
+        # Print warning
+      end
+    end
+
+    def report!( exception )
+      if defined?( Toadhopper ) && !config.hoptoad_key.nil?
+        Toadhopper( config.hoptoad_key ).post!( exception )
+      else
+        STDERR.puts "Toadhopper not available or not configured!"
+      end
+    end
+
+    private
+
+    def config=( config )
+      @config = config
+    end
+
+  end
+
+end
+
+Object.send( :include, Safely::Mixin )
+Object.send( :extend, Safely::Mixin )

data/safely.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{safely}
+  s.version = "0.1.0pre"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kenneth Kalmer"]
+  s.date = %q{2011-04-14}
+  s.description = %q{Safely run your code in a loving error reporting embrace}
+  s.email = %q{kenneth.kalmer@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/safely.rb",
+    "lib/safely/config.rb",
+    "lib/safely/mixin.rb",
+    "safely.gemspec",
+    "spec/config_spec.rb",
+    "spec/safely_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kennethkalmer/safely}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{Safely run your code, keep track of exceptions}
+  s.test_files = [
+    "spec/config_spec.rb",
+    "spec/safely_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<toadhopper>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<toadhopper>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<toadhopper>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/spec/config_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Safely::Config do
+  describe "Hoptoad" do
+    it { should respond_to(:hoptoad_key) }
+    it { should respond_to(:hoptoad_key=) }
+  end
+end

data/spec/safely_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Safely do
+  describe "configuration" do
+    it "should accept a Hoptoad api key" do
+      Safely.configure do |c|
+        c.hoptoad_key = "foo"
+      end
+
+      Safely.config.hoptoad_key.should == "foo"
+    end
+  end
+
+  describe "integration" do
+    it "should be mixed into Kernel" do
+      Object.should respond_to(:safely)
+    end
+
+    it "should be mixed into instances" do
+      Object.new.should respond_to(:safely)
+    end
+  end
+
+  describe "strategies" do
+    it "should load Toadhopper if present" do
+      Safely.load_strategies!
+
+      defined?( Toadhopper ).should be_true
+    end
+  end
+
+  describe "usage" do
+    it "should report exceptions to hoptoad" do
+      Safely.configure do |c|
+        c.hoptoad_key = "foo"
+      end
+
+      Toadhopper.any_instance.expects(:post!)
+
+      safely do
+        raise "Hello"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'safely'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with(:mocha)
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: safely
+version: !ruby/object:Gem::Version 
+  prerelease: 5
+  version: 0.1.0pre
+platform: ruby
+authors: 
+- Kenneth Kalmer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: toadhopper
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+description: Safely run your code in a loving error reporting embrace
+email: kenneth.kalmer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/safely.rb
+- lib/safely/config.rb
+- lib/safely/mixin.rb
+- safely.gemspec
+- spec/config_spec.rb
+- spec/safely_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kennethkalmer/safely
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1229273114892724216
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Safely run your code, keep track of exceptions
+test_files: 
+- spec/config_spec.rb
+- spec/safely_spec.rb
+- spec/spec_helper.rb