sparkr 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8dd99340dc0555b7c2a29e091f62e406fbe5233
-  data.tar.gz: 2bda5d1efce7cca0959a8a03805a20b20b9266ef
+  metadata.gz: c95e929d69cab1b4cbaafa7a6a143de064b6a91b
+  data.tar.gz: e7aaa6685c613f0ad95841690b4c8f5f1569af2d
 SHA512:
-  metadata.gz: f886432e12a6623ec1bf5554518d482c9beeabbf80781c6ab18df3439aa10811366c161aad33f9d212bd842196728e8ecd4b3cf316f918fb905591a86bbf88cb
-  data.tar.gz: 257c9d14e88ac0abb66de3118c92fe73cc548a064987ea296d61b50ccd2712f32b5e3d725445ca945f17ce2435eb5b518c3cf3bf6d8986dea3d0d4cf503571fb
+  metadata.gz: 59167787dafcbead72b2b489c7aaa125fc0f9e6fb81365ffdb34ba03b1a684c1d8e83eb64f63e203a3fe51caddbb86831549d3c1e7ee931b972a675c017965c4
+  data.tar.gz: 6fc3c59056ecd29cdae48212c186c299e0449ee180cef5645444fe1f56321b2ff4eff344378624ada3a220967e53d937c35ec59a6949649f50a829cbac05c520

data/README.md

@@ -6,6 +6,7 @@ Sparkr is a port of [spark](https://github.com/holman/spark) for Ruby.
 
 It let's you create ASCII sparklines for your Ruby CLIs: ▁▂▃▅▇
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -40,6 +41,34 @@ The real reason for this port:
     # => "▁▂▃▅▂▇"
 
 
+### Coloring
+
+Let's say you have your list of open and closed issues.
+
+    list = [open_issue_count, closed_issue_count]
+    Sparkr.sparkline(list)
+    # => "▁█"
+
+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](https://github.com/flori/term-ansicolor).
+
+    Sparkr.sparkline(list) do |tick, count, index|
+      if index == 0
+        tick.color(:red)
+      else
+        tick.color(:green)
+      end
+    end
+    # => "▁█" (colored, trust me)
+
+To see how this looks live and in full colour, take a look at
+[Inch](http://rrrene.github.io/inch).
+
+
 ## Contributing
 
 1. Fork it ( http://github.com/rrrene/sparkr/fork )

data/lib/sparkr.rb

@@ -5,7 +5,42 @@ require "sparkr/sparkline"
 require "sparkr/version"
 
 module Sparkr
-  def self.sparkline(*args)
-    Sparkline.new(*args).to_s
+  # Returns a sparkline
+  #
+  # Example:
+  #
+  #   list = [open_issue_count, closed_issue_count]
+  #   Sparkr.sparkline(list)
+  #   # => "▁█"
+  #
+  # Example with block:
+  #
+  # Let's say you have your list of open and closed issues, but you
+  # 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.
+  #
+  #   line = Sparkr.sparkline(list) do |tick, count, index|
+  #     if index == 0
+  #       tick.color(:red)
+  #     else
+  #       tick.color(:green)
+  #     end
+  #   end
+  #
+  #   line
+  #   # => "▁█" (colored, trust me)
+  #
+  # @param numbers [Array<String,Fixnum,Float>] the numbers to be rendered
+  # @param &block [Proc] optional, can be used to format the rendered string
+  #
+  # @return [String]
+  def self.sparkline(numbers, &block)
+    sparkline = Sparkline.new(numbers)
+    if block
+      sparkline.format(&block)
+    end
+    sparkline.to_s
   end
 end

data/lib/sparkr/version.rb

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

data/sparkr.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["rf@bamaru.de"]
   spec.summary       = %w{ASCII Sparklines in Ruby}
   spec.description   = %q{ASCII Sparklines in Ruby}
-  spec.homepage      = ""
+  spec.homepage      = "http://trivelop.de/sparkr/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/test/{cli_test.rb → sparkr/cli_test.rb}

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 
 describe ::Sparkr::CLI do
   it "should find work" do

data/test/sparkr/sparkline_test.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+describe ::Sparkr::Sparkline do
+
+  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/sparkr_test.rb

@@ -18,27 +18,26 @@ describe ::Sparkr 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|
+
+  it ".sparkline should work with arity == 2" do
+    sparkline = Sparkr.sparkline([5.5,20]) do |tick, number|
       if number < 6.0
         tick = tick + "-"
       else
         tick
       end
     end
-    assert_equal '▁-█', sparkline.to_s
+    assert_equal '▁-█', sparkline
   end
 
-  it "format should work with arity == 3" do
-    sparkline = Sparkr::Sparkline.new([5.5,20])
-    sparkline.format do |tick, number, index|
+  it ".sparkline should work with arity == 3" do
+    sparkline = Sparkr.sparkline([5.5,20]) do |tick, number, index|
       if index == 1
         tick = tick + "-"
       else
         tick
       end
     end
-    assert_equal '▁█-', sparkline.to_s
+    assert_equal '▁█-', sparkline
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,10 +60,11 @@ files:
 - lib/sparkr/sparkline.rb
 - lib/sparkr/version.rb
 - sparkr.gemspec
-- test/cli_test.rb
+- test/sparkr/cli_test.rb
+- test/sparkr/sparkline_test.rb
 - test/sparkr_test.rb
 - test/test_helper.rb
-homepage: ''
+homepage: http://trivelop.de/sparkr/
 licenses:
 - MIT
 metadata: {}
@@ -88,6 +89,7 @@ signing_key:
 specification_version: 4
 summary: '["ASCII", "Sparklines", "in", "Ruby"]'
 test_files:
-- test/cli_test.rb
+- test/sparkr/cli_test.rb
+- test/sparkr/sparkline_test.rb
 - test/sparkr_test.rb
 - test/test_helper.rb