Stance - Simple & Explicit Events for Rails apps

Usage

# Your model
class Appointment < ActiveRecord::Base
  include Stance::Eventable
end

# Define your events
class AppointmentEvents < Stance::Events
  # Define events.
  event :my_event
  event :some_event

  # Namespaced events
  event 'offers.create'
  event 'offers.delete'

  # Singleton event: only one active event with this name can exist for the same subject.
  event :my_event, singleton: true

  # By default, events are recorded in the database, unless you set the `record` option to false,
  event :my_recordless_event, record: false

  # You can define a class event, which is published on the class instead of the instance.
  event :my_class_event, class: true

  # Will be called before/after each event in this class. Have access to the event `subject` and
  # `record`.
  before_create :do_something_before
  after_create :do_something_after

  # Optionally, create a class for an event.
  class SomeEvent < Stance::Event
    # Define optional callbacks which have access to the `subject` and event `record`.
    before_create :do_something_before
    after_create :do_something_after
  end
end

# Publish events from the model
Appointment.find(1).publish_event :some_event
Appointment.find(1).publish_event 'offers.create'
Appointment.find(1).publish_event :event_with_metadata, foo: :bah
Appointment.publish_event :my_class_event

ActiveRecord Callbacks

Stance comes with a couple of opt-in modules to help ease your Callback spaghetti...

class Appointment < ActiveRecord::Base
  include Stance::Eventable
  include Stance::ActiveRecordCallbacks
end

class AppointmentEvents < Stance::Events
  include Stance::ActiveRecordEvents
end

# Now all your model callbacks will trigger an event of the same name, where any public methods
# defined will be called.
class AppointmentEvents::AfterCreate < Stance::Event
  include Stance::ActiveRecordEvents

  # This method will be called upon the :after_create callback of the Appointment model.
  def do_something;end

  private

    # Private methods will not be called by the callback.
    def my_private_method;end
end

Installation

Add this line to your application's Gemfile:

gem 'stance'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install stance

Run the installer to generate the migration, and then run the migration:

$ rails g stance:install
$ rails db:migrate

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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/joelmoss/stance. 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 Stance project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.