Project

cry

0.0
No commit activity in last 3 years
No release in over 3 years
Ridiculously simple interface for subscribing to arbitrary events on your objects and executing callbacks.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.12
~> 10.0
~> 3.0
 Project Readme

Cry

Super-simple publish/subscribe interface for any Ruby object.

Installation

Add this line to your application's Gemfile:

gem 'cry'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cry

Usage

class Cat
  include Cry

  def pat
    publish(:purr, "contented")
  end
end

Cat.new
  .on(:purr) { |kind| puts "a #{kind} kind of purr" }
  .pat

You can pass multiple events to on to reuse the same listener.

There's also publish!, which does the same thing but raises Cry::NoListenersError if no listeners have subscribed to the event.

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 tags, and push the .gem file to rubygems.org.

Contributing

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

License

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