sparkr 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aee5d3645985bf8644aafd37b96c4b9431204b05
-  data.tar.gz: 546ae2e5aba6ac1da35d03f931409184b0a5b31d
+  metadata.gz: c8dd99340dc0555b7c2a29e091f62e406fbe5233
+  data.tar.gz: 2bda5d1efce7cca0959a8a03805a20b20b9266ef
 SHA512:
-  metadata.gz: 3689591a7bd6c57ccdd8219bb01ee32e5668eafdab825c44c747b0946beaed88ba5f9fac8ee90634c38668175eae093dbabfbb904d2743acc6c950f0ab21fddf
-  data.tar.gz: 3ac3b156b8eb4445fd3b87db872b897f53d397c3e22b9ae16eec3038ba8557a3d07021255ec147208ddb820aadc092951d1a433a66cdd38ea217015b0e882362
+  metadata.gz: f886432e12a6623ec1bf5554518d482c9beeabbf80781c6ab18df3439aa10811366c161aad33f9d212bd842196728e8ecd4b3cf316f918fb905591a86bbf88cb
+  data.tar.gz: 257c9d14e88ac0abb66de3118c92fe73cc548a064987ea296d61b50ccd2712f32b5e3d725445ca945f17ce2435eb5b518c3cf3bf6d8986dea3d0d4cf503571fb

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/README.md

@@ -1,5 +1,7 @@
 # Sparkr
 
+[![Build Status](https://travis-ci.org/rrrene/sparkr.png?branch=master)](https://travis-ci.org/rrrene/sparkr)
+
 Sparkr is a port of [spark](https://github.com/holman/spark) for Ruby.
 
 It let's you create ASCII sparklines for your Ruby CLIs: ▁▂▃▅▇

data/lib/sparkr.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "sparkr/cli"
 require "sparkr/sparkline"
 require "sparkr/version"

data/lib/sparkr/cli.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Sparkr
   class CLI
     def self.run(*args)

data/lib/sparkr/sparkline.rb

@@ -1,19 +1,93 @@
+# encoding: utf-8
+
 module Sparkr
   class Sparkline
     TICKS = %w(▁ ▂ ▃ ▄ ▅ ▆ ▇ █)
     DEFAULT_SEPARATOR = ''
 
     def initialize(_numbers)
-      numbers = _numbers.map(&:to_i)
-      step_height = (numbers.max - numbers.min) / (TICKS.size - 1).to_f
-      step_height = 1 if step_height == 0
+      @original_numbers = _numbers
+
+      numbers  = normalize_numbers(_numbers)
+      one_step = step_height(numbers)
 
       @ticks = numbers.map do |n|
-        index = ((n - numbers.min) / step_height).to_i
+        index = (n / one_step).to_i
         TICKS[index]
       end
     end
 
+    # Formats all the ticks in the Sparkline with a given block,
+    # returns itself
+    #
+    # Example:
+    #
+    # Let's say you have a list of open and closed issues and want
+    # to format it so the open ones are red and the closed ones are
+    # green, so you can quickly see how you are doing. Let's further
+    # suppose you use a gem that adds a #color method to String
+    # for ANSI coloring.
+    #
+    #   list = [open_issue_count, closed_issue_count]
+    #   sparkline = Sparkr::Sparkline.new(list)
+    #   sparkline.format do |tick, count, index|
+    #     if index == 0
+    #       tick.color(:red)
+    #     else
+    #       tick.color(:green)
+    #     end
+    #   end
+    #
+    #   sparkline.to_s
+    #   # => "▁█" (colored, which you can't see)
+    #
+    # @return [Sparkline] itself
+    def format(&block)
+      new_ticks = []
+      @ticks.each_with_index do |tick, index|
+        if block.arity == 2
+          new_ticks << yield(tick, @original_numbers[index])
+        elsif block.arity == 3
+          new_ticks << yield(tick, @original_numbers[index], index)
+        end
+      end
+      @ticks = new_ticks
+      self
+    end
+
+    # Returns the normalized equivalent of a given list
+    #
+    #   normalize_numbers([3,4,7])
+    #   # => [0,1,4]
+    #
+    # @return [Fixnum] the normalized equivalent of the given +_numbers+
+    def normalize_numbers(_numbers)
+      numbers = _numbers.map(&:to_i)
+      min = numbers.min
+      numbers.map do |n|
+        n - min
+      end
+    end
+
+    # @return [Float] the numerical "height" of a single bar "step"
+    def step_height(_numbers)
+      min, max = _numbers.minmax
+      actual_height = max - min
+      step = actual_height / steps.to_f
+      if step == 0
+        1
+      else
+        step
+      end
+    end
+
+    # @return [Fixnum] the count of steps between the smallest and highest bar
+    def steps
+      TICKS.size - 1
+    end
+
+    # @param sep [String,nil] separator used to join the bars of the sparkline
+    # @return [String] the sparkline, seperated by +sep+ (defaults to '')
     def to_s(sep = nil)
       @ticks.join(sep || DEFAULT_SEPARATOR)
     end

data/lib/sparkr/version.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Sparkr
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/test/cli_test.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require File.expand_path(File.dirname(__FILE__) + '/test_helper')
 
 describe ::Sparkr::CLI do

data/test/sparkr_test.rb

@@ -1,7 +1,9 @@
+# encoding: utf-8
+
 require File.expand_path(File.dirname(__FILE__) + '/test_helper')
 
 describe ::Sparkr do
-  it "should find work" do
+  it "should find work like holman/spark" do
     assert_sparkline '▁▂▃▄▅▆▇█', [1,2,3,4,5,6,7,8]
     assert_sparkline '▁▂█▅▂', [1,5,22,13,5]
     assert_sparkline '▁█', [5.5,20]
@@ -11,4 +13,32 @@ describe ::Sparkr do
     assert_sparkline '▁▂▃▄▂█', [0,30,55,80,33,150]
     assert_sparkline '▁▂▄▆█', [1,2,3,4,5]
   end
+
+  it "should find work with equal numbers" do
+    assert_sparkline '▁▁', [10, 10]
+  end
+
+  it "format should work with arity == 2" do
+    sparkline = Sparkr::Sparkline.new([5.5,20])
+    sparkline.format do |tick, number|
+      if number < 6.0
+        tick = tick + "-"
+      else
+        tick
+      end
+    end
+    assert_equal '▁-█', sparkline.to_s
+  end
+
+  it "format should work with arity == 3" do
+    sparkline = Sparkr::Sparkline.new([5.5,20])
+    sparkline.format do |tick, number, index|
+      if index == 1
+        tick = tick + "-"
+      else
+        tick
+      end
+    end
+    assert_equal '▁█-', sparkline.to_s
+  end
 end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'simplecov'
 SimpleCov.start
 
@@ -12,6 +14,8 @@ def assert_sparkline(expected, numbers)
   actual = Sparkr.sparkline(numbers)
 
   assert actual.include?('▁'), "there must be a minimum"
-  assert actual.include?('█'), "there must be a maximum"
+  unless numbers.uniq.size == 1 # all numbers are the same
+    assert actual.include?('█'), "there must be a maximum"
+  end
   assert_equal expected, actual
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,6 +49,7 @@ files:
 - .gitignore
 - .ruby-gemset
 - .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md