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/sn_foil. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Add this line to your application's Gemfile:

gem 'snfoil'

And then execute:

$ bundle

Or install it yourself as:

$ gem install snfoil

Contexts are groupings of common actions that a certain entity can perform.

SnFoil Contexts handle basic CRUD through a few different actions

Methods allow users to create inheritable actions that occur in a specific order. Methods will always run before their hook counterpart. Since these are inheritable, you can chain needed actions all the way through the parent heirarchy by using the super keyword.

Important Note Methods always need to return the options hash at the end.

Author's opinion: While simplier than hooks, they do not allow for as clean of a composition as hooks.

# Call the webhooks for third party integrations
# Commit business logic to internal process
def after_create_success(**options)
    options = super

    call_webhook_for_model(options[:object])
    finalize_business_logic(options[:object])

    options
end

# notify error tracker
def after_create_error(**options)
    options = super

    notify_errors(options[:object].errors)

    options
end

Hooks make it very easy to compose multiple actions that need to occur in a specific order. You can have as many repeated hooks as you would like. This makes defining single responsibility hooks very simple, and they will get called in the order they are defined. The major downside of hooks are that they are currently not inheritable.

Important Note Hooks always need to return the options hash at the end.

Lets take the Method example and make it into hooks instead.

# Call the webhooks for third party integrations
after_create_success do |options|
    call_webhook_for_model(options[:object])
    options
end

# Commit business logic to internal process
after_create_success do |options|
    finalize_business_logic(options[:object])
    options
end

# notify error tracker
after_create_error do |options|
    notify_errors(options[:object].errors)
    options
end

The call order for actions is extremely important because SnFoil passes the options hash throughout the entire process. So any data you may need down the call order can be added earlier in the stack.

After checking out the repo, run bin/setup to install dependencies. 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.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/snfoil. 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.

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

Everyone interacting in the Sn::Foil project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.