Project

sparkr

0.08
No commit activity in last 3 years
No release in over 3 years
ASCII Sparklines in Ruby
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 Dependencies

Development

~> 1.5
>= 0
 Project Readme

Sparkr Build Status Code Climate Inline docs

Sparkr is a port of spark for Ruby.

It lets you create ASCII sparklines for your Ruby CLIs: ▁▂▃▅▇

Installation

Add this line to your application's Gemfile:

gem 'sparkr'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sparkr

Usage

Shell

After installation, just run sparkr and pass it a list of numbers, like you would with spark. The output is what you would expect:

$ sparkr 0 30 55 80 33 150
▁▂▃▅▂▇

It is also possible to pipe data into sparkr:

$ echo 9 13 5 17 1 | sparkr
▄▆▂█▁

Ruby

The real reason for this port:

Sparkr.sparkline([0, 30, 55, 80, 33, 150])
# => "▁▂▃▅▂▇"

Coloring

Let's say you have your list of open and closed issues.

require 'sparkr'

open_issue_count = 3
closed_issue_count = 13

list = [open_issue_count, closed_issue_count]
puts "Issues: " + Sparkr.sparkline(list)
# => "Issues: ▁█"

But now you want to format the sparkline so that the open issues are red and the closed ones are green (to quickly see how you are doing).

Let's further suppose you use a gem that adds a #color method to String for ANSI coloring, like Term::ANSIColor.

require 'sparkr'
require 'term/ansicolor'

class String
  include Term::ANSIColor
end

open_issue_count = 3
closed_issue_count = 13

list = [open_issue_count, closed_issue_count]
sparkline = Sparkr.sparkline(list) do |tick, count, index|
  if index == 0
    tick.color(:red)
  else
    tick.color(:green)
  end
end
puts "Issues: " + sparkline
# => "Issues: ▁█" (colored, trust me)

To see how this looks live and in full colour, take a look at Inch.

Contributing

  1. Fork it ( http://github.com/rrrene/sparkr/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Author

René Föhring (@rrrene)

Credits

Sparkr would not exist without Zach Holman's spark.

License

Sparkr is released under the MIT License. See the LICENSE.txt file for further details.