Giter VIP home page Giter VIP logo

event-driven's Introduction

EventDriven

Provides a basic ruby port of Symfony's EventDispatacher component.

Eventing allows connecting two components of an application without coupling between them.

Installation

Add this line to your application's Gemfile:

gem 'event_driven'

And then execute:

$ bundle

Or install it yourself as:

$ gem install event_driven

Usage

Basic event usage:

  # Creating a custom event class
  class PartyInvitation < EventDriven::Event
    attr_reader :message
    
    def initialize(message)
      @message = message
    end
  end
  
  # Any ruby object that implements #call can be used as a listener  
  handler = -> (event, event_name) do
    puts "#{event_name} - message #{event.message}" 
  end
  
  # Creating a dispatcher
  dispatcher = EventDriven::Dispatcher.new
  
  # Add a listener to any event name
  dispatcher.add_listener(event_name: :party_time, listener: handler)
  
  # Fire an event to let other parts of the system know it happened
  
  party_anouncement = PartyInvitation.new("It's party time!")
  
  dispatcher.dispatch(event_name: :party_time, event: party_anouncement)

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/emerson-h/event_driven.

event-driven's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.