sparkr 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13933a0323bc68a37ae398dbe0de249769d57d0e
-  data.tar.gz: 96bd30bbd54ec4c09327e920ceb0046f47b9f77a
+  metadata.gz: a2b803ac74d70b8ad2eaf16e843476e2d9be2e6b
+  data.tar.gz: de4f7507f9f15f93464d88c12cb0747338a12895
 SHA512:
-  metadata.gz: 6a75738f6a5420adba764234f409003e3f6d0e9db0de3f6217b316bb596f78f97a82f62b364656170ba88a24f819c7b74e388c3611c63021b649a0f4239b0369
-  data.tar.gz: 8f21ae8ee6f677e6c2446045fa081a913cbda07756f00db5d3ebdeed9ac3daddcf38e60bb15b74f83747434d89a7311ffde5811d7d9e5ee5421485fb3d36558b
+  metadata.gz: 593c4038a8bf0fc0dbeee096d5f8ae725034c4a94ce30dd00fccae9cd169842519208d79a1a45fa64a17cd51493db2f9e65ed90443705666099c02e3d55c5c93
+  data.tar.gz: 5466b0f309cab197763c9e085c30b72185f907e377a18dd8a01c9c845e6ce208ad76bc516f6e757dd09f1bb0b1b6785346e8e8b5f9b2f4cc785a7bddae17c988

data/README.md

@@ -1,10 +1,9 @@
-# Sparkr
-
-[![Build Status](https://travis-ci.org/rrrene/sparkr.png?branch=master)](https://travis-ci.org/rrrene/sparkr)
+# Sparkr [![Build Status](https://travis-ci.org/rrrene/sparkr.png?branch=master)](https://travis-ci.org/rrrene/sparkr) [![Code Climate](https://codeclimate.com/github/rrrene/sparkr.png)](https://codeclimate.com/github/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: ▁▂▃▅▇
+It lets you create ASCII sparklines for your Ruby CLIs: ▁▂▃▅▇
+
 
 
 ## Installation
@@ -22,6 +21,7 @@ Or install it yourself as:
     $ gem install sparkr
 
 
+
 ## Usage
 
 ### Shell
@@ -37,7 +37,7 @@ you would expect:
 
 The real reason for this port:
 
-    Sparkr.sparkline([0,30,55,80,33,150])
+    Sparkr.sparkline([0, 30, 55, 80, 33, 150])
     # => "▁▂▃▅▂▇"
 
 
@@ -45,9 +45,16 @@ The real reason for this port:
 
 Let's say you have your list of open and closed issues.
 
-    list = [open_issue_count, closed_issue_count]
-    Sparkr.sparkline(list)
-    # => "▁█"
+```ruby
+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).
@@ -56,19 +63,34 @@ 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)
+```ruby
+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](http://rrrene.github.io/inch).
 
 
+
 ## Contributing
 
 1. Fork it ( http://github.com/rrrene/sparkr/fork )
@@ -78,16 +100,19 @@ To see how this looks live and in full colour, take a look at
 5. Create new Pull Request
 
 
+
 ## Author
 
 René Föhring (@rrrene)
 
 
+
 ## Credits
 
 Sparkr would not exist without Zach Holman's [spark](https://github.com/holman/spark).
 
 
+
 ## License
 
 Sparkr is released under the MIT License. See the LICENSE.txt file for further

data/bin/sparkr

@@ -1,10 +1,20 @@
 #!/usr/bin/env ruby
 
-path = __FILE__
-while File.symlink?(path)
-  path = File.expand_path(File.readlink(path), File.dirname(path))
+# @return [String] the path of sparkr's lib directory
+def find_lib_path
+  path = __FILE__
+  while File.symlink?(path)
+    path = File.expand_path(File.readlink(path), File.dirname(path))
+  end
+  File.join(File.dirname(File.expand_path(path)), '..', 'lib')
 end
-$:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
+
+# @return [Array<String>] the arguments passed or piped via the command-line
+def cli_arguments
+  STDIN.tty? ? ARGV : STDIN.read.split(/\s+/)
+end
+
+$LOAD_PATH.unshift(find_lib_path)
 
 require 'sparkr'
-Sparkr::CLI.run(*ARGV)
+Sparkr::CLI.run(*cli_arguments)

data/examples/issues.rb

@@ -0,0 +1,7 @@
+require 'sparkr'
+
+open_issue_count = 3
+closed_issue_count = 13
+
+list = [open_issue_count, closed_issue_count]
+puts "Issues: " + Sparkr.sparkline(list)

data/examples/issues_colored.rb

@@ -0,0 +1,24 @@
+require 'sparkr'
+#
+# You need Term::ANSIColor for this example:
+#
+#     $ gem install term-ansicolor
+#
+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

data/lib/sparkr.rb

@@ -32,7 +32,7 @@ module Sparkr
   #   line
   #   # => "▁█" (colored, trust me)
   #
-  # @param numbers [Array<String,Fixnum,Float>] the numbers to be rendered
+  # @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]

data/lib/sparkr/cli.rb

@@ -2,8 +2,43 @@
 
 module Sparkr
   class CLI
+    # Helper method to run an instance with the given +args+
+    #
+    # @see #run
+    # @return [CLI] the instance that ran
     def self.run(*args)
-      puts Sparkline.new(args.map(&:to_f)).to_s
+      instance = new
+      instance.run(*args)
+      instance
+    end
+
+    # Runs sparkr with the given +args+
+    # @return [void]
+    def run(*args)
+      if args.empty?
+        puts help
+      else
+        sparkline = Sparkline.new(args.map(&:to_f))
+        puts sparkline.to_s
+      end
+    end
+
+    private
+
+    # Returns usage information
+    def help
+      """
+USAGE:
+  sparkr [-h|--help] VALUE,...
+
+EXAMPLES:
+  sparkr 1 5 22 13 53
+  ▁▁▃▂█
+  sparkr 0,30,55,80,33,150
+  ▁▂▃▄▂█
+  echo 9 13 5 17 1 | sparkr
+  ▄▆▂█▁
+      """
     end
   end
 end

data/lib/sparkr/sparkline.rb

@@ -46,23 +46,17 @@ module Sparkr
     #   # => "▁█" (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
+    def format
+      @ticks = @ticks.map.with_index do |tick, index|
+        yield tick, @original_numbers[index], index
       end
-      @ticks = new_ticks
       self
     end
 
     # Returns the normalized equivalent of a given list
     #
-    #   normalize_numbers([3,4,7])
-    #   # => [0,1,4]
+    #   normalize_numbers([3, 4, 7])
+    #   # => [0, 1, 4]
     #
     # @return [Fixnum] the normalized equivalent of the given +_numbers+
     def normalize_numbers(_numbers)
@@ -90,7 +84,7 @@ module Sparkr
       TICKS.size - 1
     end
 
-    # @param sep [String,nil] separator used to join the bars of the sparkline
+    # @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)

data/lib/sparkr/version.rb

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

data/test/sparkr/cli_test.rb

@@ -3,12 +3,23 @@
 require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 
 describe ::Sparkr::CLI do
-  it "should find work" do
+  it ".run should work with array of numbers as strings" do
+    string_numbers = %w(1 2 3 4 100 5 10 20 50 300)
     out, err = capture_io do
-      ::Sparkr::CLI.run("1", "2", "3", "4", "100", "5", "10", "20", "50", "300")
+      ::Sparkr::CLI.run(*string_numbers)
     end
     refute out.empty?, "there should be some output"
     assert err.empty?, "there should be no errors"
     assert_equal "▁▁▁▁▃▁▁▁▂█\n", out
   end
+
+  it ".run should print usage information if args are missing" do
+    string_numbers = %w()
+    out, err = capture_io do
+      ::Sparkr::CLI.run(*string_numbers)
+    end
+    refute out.empty?, "there should be some output"
+    assert err.empty?, "there should be no errors"
+    assert_match /USAGE\:/, out
+  end
 end

data/test/sparkr/sparkline_test.rb

@@ -10,7 +10,7 @@ describe ::Sparkr::Sparkline do
   end
 
   it "format should work with arity == 2" do
-    sparkline = Sparkr::Sparkline.new([5.5,20])
+    sparkline = Sparkr::Sparkline.new([5.5, 20])
     sparkline.format do |tick, number|
       if number < 6.0
         tick = tick + "-"
@@ -22,7 +22,7 @@ describe ::Sparkr::Sparkline do
   end
 
   it "format should work with arity == 3" do
-    sparkline = Sparkr::Sparkline.new([5.5,20])
+    sparkline = Sparkr::Sparkline.new([5.5, 20])
     sparkline.format do |tick, number, index|
       if index == 1
         tick = tick + "-"

data/test/sparkr_test.rb

@@ -4,23 +4,22 @@ require File.expand_path(File.dirname(__FILE__) + '/test_helper')
 
 describe ::Sparkr 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]
-    assert_sparkline '▁▁▁▁▃▁▁▁▂█', [1,2,3,4,100,5,10,20,50,300]
-    assert_sparkline '▁▄█', [1,50,100]
-    assert_sparkline '▁▃█', [2,4,8]
-    assert_sparkline '▁▂▃▄▂█', [0,30,55,80,33,150]
-    assert_sparkline '▁▂▄▆█', [1,2,3,4,5]
+    assert_sparkline '▁▂▃▄▅▆▇█', [1, 2, 3, 4, 5, 6, 7, 8]
+    assert_sparkline '▁▂█▅▂', [1, 5, 22, 13, 5]
+    assert_sparkline '▁█', [5.5, 20]
+    assert_sparkline '▁▁▁▁▃▁▁▁▂█', [1, 2, 3, 4, 100, 5, 10, 20, 50, 300]
+    assert_sparkline '▁▄█', [1, 50, 100]
+    assert_sparkline '▁▃█', [2, 4, 8]
+    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 ".sparkline should work with arity == 2" do
-    sparkline = Sparkr.sparkline([5.5,20]) do |tick, number|
+    sparkline = Sparkr.sparkline([5.5, 20]) do |tick, number|
       if number < 6.0
         tick = tick + "-"
       else
@@ -31,7 +30,7 @@ describe ::Sparkr do
   end
 
   it ".sparkline should work with arity == 3" do
-    sparkline = Sparkr.sparkline([5.5,20]) do |tick, number, index|
+    sparkline = Sparkr.sparkline([5.5, 20]) do |tick, number, index|
       if index == 1
         tick = tick + "-"
       else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkr
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2014-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,6 +55,8 @@ files:
 - README.md
 - Rakefile
 - bin/sparkr
+- examples/issues.rb
+- examples/issues_colored.rb
 - lib/sparkr.rb
 - lib/sparkr/cli.rb
 - lib/sparkr/sparkline.rb
@@ -84,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: '["ASCII", "Sparklines", "in", "Ruby"]'