Skip to content

AkihikoITOH/deferrable

Repository files navigation

Deferrable

Ruby Gem Version Maintainability

Go's defer brought to Ruby.

Installation

gem 'gopher-deferrable'

And then execute:

$ bundle install

Usage

Single deferred call

require 'deferrable'

class YourClass
  include Deferrable

  def say_hello
    defer { puts 'world' }
    puts 'hello'
  end

  deferrable :say_hello
end

YourClass.new.say_hello

# hello
# world
# => nil

Stacked deferred call

require 'deferrable'

class YourClass
  include Deferrable

  def say_hello
    defer { puts 'bye' }
    puts 'hello'
    defer { puts 'world' }
  end

  deferrable :say_hello
end

YourClass.new.say_hello

# hello
# world
# bye
# => nil

On Error

require 'deferrable'

class YourClass
  include Deferrable

  def say_hello
    defer { puts 'bye' }
    puts 'hello'
    oops
    defer { puts 'world' }
  end

  def oops
    raise StandardError
  end

  deferrable :say_hello
end

YourClass.new.say_hello

# hello
# bye
# `oops': StandardError (StandardError)

In case of early return

require 'deferrable'

class YourClass
  include Deferrable

  def say_hello
    defer { puts 'bye' }
    puts 'hello'
    return 'i gotta go'
    defer { puts 'world' }
  end

  deferrable :say_hello
end

YourClass.new.say_hello

# hello
# bye
# => 'i gotta go'

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/AkihikoITOH/deferrable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Deferrable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.