godefer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89b8e1803e4f34cb2dcffdc84ddf89db4d1587b0
-  data.tar.gz: 99d1dd2aa28736d522eb0d13d84c0bf665d66cb3
+  metadata.gz: 98e03532245eb8835e7fa878912698cd2e48c600
+  data.tar.gz: 3190101b1dead8f35b0461524712056703cdfa28
 SHA512:
-  metadata.gz: 73892dfef51ca21a66e5c1c9b49c688068f0903bed21cc7dadb1c11b5a3d577dcfacbdb19af528db2ba8209edc93f3ac9b1285ede19aa612d195d0b02d10fdb2
-  data.tar.gz: 2b20512630f15afe18d0497f45b192aaeef588038ee7fb998a724c5540a401b31409ddbd807ee2a2178bd426ef802c15f293b6f592df7b4ca729ac46449fa433
+  metadata.gz: e26e349e62a721008367279a838f5f8d6f8915fc314cfa60b095c2985585649939022ba6b30a7dd8f4942f92c4e29bc3bd61e0cbed7f6d9b5150e38bb9151412
+  data.tar.gz: 9be5041a4b66623d01cf89e6896d89bff6aa85d0eb92fac0c6fc1072a810106fcc355aca9ffcb3edb412b1c7e16573b54d414901eb8dabbacdc93462072366d3

data/.travis.yml

@@ -1,4 +1,10 @@
 language: ruby
 rvm:
+  - 2.0.0-p647
+  - 2.1.7
   - 2.2.3
+  - jruby-1.7.22
+  - jruby-9.0.3.0
+  - rbx-2.4.1
+  - rbx-2.5.8
 before_install: gem install bundler -v 1.10.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    godefer (0.1.0)
+    godefer (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -25,7 +25,7 @@ DEPENDENCIES
   bundler (~> 1.10)
   codeclimate-test-reporter
   godefer!
-  minitest
+  minitest (~> 5.8)
   rake (~> 10.0)
 
 BUNDLED WITH

data/README.md

@@ -4,9 +4,7 @@
 [![Code Climate](https://codeclimate.com/github/zacheryph/godefer/badges/gpa.svg)](https://codeclimate.com/github/zacheryph/godefer)
 [![Test Coverage](https://codeclimate.com/github/zacheryph/godefer/badges/coverage.svg)](https://codeclimate.com/github/zacheryph/godefer/coverage)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/godefer`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Godefer implements the `defer` / `recover` mechanism from [Go](https://golang.org).  It allows grouping operations together that require a closing of some sort after opening.  I don't really know the usefulness of this gem, though I will take issues and pull requests.
 
 ## Installation
 
@@ -26,7 +24,53 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Godefer allows two different uses.  The first using a general block, which would mostly be useful probably writing one off scripts of some sort.  The other is to include the `Defer` module into your own class and running code within a `with_defer` block.
+
+### Block Usage
+
+Example of writing to an output file.  The `defer {}` block gets called at the end of the run block.
+
+```ruby
+Defer.run do
+  f = File.open('output.log')
+  defer { f.close }
+
+  # do stuff that uses f
+end
+```
+
+### Module Usage
+
+Similar example where we are doing a bunch of stuff within a class.
+
+```ruby
+class Audit
+  include Defer
+  attr_accessor :file
+
+  def large_operation
+    with_defer do
+      opening
+      defer { closing }
+
+      helper
+      # ...
+    end
+  end
+
+  def opening
+    # ...
+  end
+
+  def helper
+    # ...
+  end
+
+  def closing
+    # ...
+  end
+end
+```
 
 ## Development
 
@@ -36,4 +80,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/godefer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/zacheryph/godefer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

data/Rakefile

@@ -8,8 +8,3 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
-
-desc "Open irb session with library loaded"
-task :console do
-  sh "irb -rubygems -Ilib -rgodefer"
-end

data/bin/console

@@ -1,14 +1,16 @@
 #!/usr/bin/env ruby
 
+begin
+  require "pry"
+rescue LoadError
+end
+
 require "bundler/setup"
 require "godefer"
 
-# 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
+begin
+  Pry.start
+rescue
+  require 'irb'
+  IRB.start
+end

data/lib/defer/block.rb

@@ -8,7 +8,11 @@ module Defer
 
     def run(&block)
       ret = instance_eval(&block)
+    rescue Exception => e
+      @_exception = e
+    ensure
       _cleanup
+      raise @_exception if @_exception && !@_recovered
       ret
     end
 
@@ -16,6 +20,11 @@ module Defer
       _stack.unshift(block)
     end
 
+    def recover
+      @_recovered = true
+      @_exception
+    end
+
     private
 
     def _stack

data/lib/defer/version.rb

@@ -1,3 +1,3 @@
 module Defer
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: godefer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Zachery Hostens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2015-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler