https://github.com/xijo/fortschritt

A small, opinionated, non-configurable ruby progress meter
https://github.com/xijo/fortschritt

Last synced: about 2 months ago
JSON representation

A small, opinionated, non-configurable ruby progress meter

• Host: GitHub
• URL: https://github.com/xijo/fortschritt
• Owner: xijo
• License: wtfpl
• Created: 2015-07-08T13:15:36.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-09-09T11:36:05.000Z (4 months ago)
• Last Synced: 2024-09-09T13:48:50.960Z (4 months ago)
• Language: Ruby
• Homepage:
• Size: 31.3 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fortschritt

 * no colors

 * no config

 * no tty stuff

 * no terminal size calculation

 * no dependencies

 

![fortschritt](https://user-images.githubusercontent.com/10758879/146650253-878fa450-3a2e-44ad-b28a-ba2dce9050bc.gif)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'fortschritt'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install fortschritt

## Usage

Start a progress bar by calling `with_fortschritt` on an `Enumerable` or an `ActiveRecord::Relation`.

It will create a new progress bar, that will be incremented by calling `Fortschritt.increment`.

However, for convenience you can call `#fortschritt` on your iterated objects as well. It will call `Fortschritt.increment` and return `self`, so you can chain it up nicely.

```ruby

User.all.with_fortschritt.find_each do |user|

  user.fortschritt.valid?

end

# will print something like this: 1616/145096 → 00:13:21 → ETA 2016-02-04 18:11:50

```

### Silent

If no output is required or wanted invoke `with_fortschritt` with the `silent: true` option

```ruby

User.all.with_fortschritt(silent: true).find_each do |user|

  user.fortschritt.valid?

end

# won't output any progress

```

Please note, within a Rails application fortschritt will detect the `Rails.env.test?` environment and silent itself automatically.

Fortschritt will also never output anything to a non-tty STDOUT.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/xijo/fortschritt.