README.md

Bario

Bario means Barium in spanish.

This gem aim to provide a simple interface to track the progress of your process like background jobs, scripts, cron jobs... with a kind progress bars backed by redis.

This gem still in very early state of development. Some behaviour could change in the future. Ideas, pull requests and any kind of feedback are welcome.

Install

$ gem install bario

or add it to the Gemfile

gem "bario"

Usage

Examples:

# Create a bar with 100 as total
b1 = Bario::Bar.create(total: 100)

# Increment a unit
b1.increment

# Increment 10 units
b1.increment(10)

# Decrement 
b1.decrement

# Create a nested bar
b2 = b1.add_bar(total: 10)
b2.increment

# Find a bar
b3 = Bario::Bar.find(b1.id)

# List all bars
Bario::Bar.all

# Delete a bar (and nested bars)
b3.delete

# You can also name a bar, usefull to identify it in the web panel.
foo = Bario::Bar.create(name: "foo")

# Attributes of a bar
foo.inspect #=> 
#<Bario::Bar:70234519614100 id: 12, name: foo, total: 100, current: 0, root: true, created_at: 2017-11-26 21:29:30 UTC, updated_at: 2017-11-26 21:29:30 UTC>

The frontend

Standalone

If you've installed Bario as a gem running the front end standalone is easy:

$ bario-web start

$ bario-web --redis redis://localhost:6379/0 start

For more options check the help:

$ bario-web --help

Rails 3 onwards

You can also mount Bario on a subpath in your existing Rails app by adding require "bario/web" to the top of your routes file or in an initializer then adding this to routes.rb:

mount Bario::Web => "/bario"

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/ceritium/bario. 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.

Code of Conduct

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