batt 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.2.0 (2013/08/04)
+---
+
+ * added new `meter` action for rendering a meter
+ * created new `Batt::Formatter::Tmux` class for doing tmux color more easily
+
 0.1.0 (2013/07/13)
 ---
 

data/README.md

@@ -4,6 +4,8 @@ Read the battery status from your laptop. Designed to be used in `tmux`'s status
 
 Currently only supports OSX.
 
+*Dude I was just realizing I basically cannot live without batt now...  it is dope* -- Rich Soni
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/batt/app.rb

@@ -31,8 +31,8 @@ module Batt
       c = b.status[:capacity]
 
       if options[:tmux]
-        color = %w(red yellow green)[c.to_i / 33]
-        puts "#[bg=#{color},fg=black]#{ c }#[default]"
+        color = Reader.color_for_capacity(c.to_i)
+        puts Formatter::Tmux.format c, :fg => :black, :bg => color
       else
         puts c
       end
@@ -53,6 +53,28 @@ module Batt
       puts b.status[:remaining]
     end
 
+    desc "meter", "return an ascii-art battery meter showing the current capacity."
+    option :tmux, :type => :boolean, :desc => "Enable tmux colour"
+    option :size, :type => :numeric, :desc => "The size of the meter", :default => 5
+    def meter
+      b = Batt::Reader.new
+
+      c = b.status[:capacity].to_i
+
+      meter_size = options[:size]
+      meter_filled_level = (meter_size * ( c.to_f / 100 )).round
+
+      if options[:tmux]
+        meter_filled = " " * (meter_filled_level)
+        meter_empty = " " * (meter_size - meter_filled_level)
+        color = Reader.color_for_capacity(c)
+
+        puts "[#{ Formatter::Tmux.format meter_filled, :bg => color }#{ meter_empty }]"
+      else
+        puts "[#{ '|' * meter_filled_level }#{ ' ' * (meter_size - meter_filled_level) }]"
+      end
+    end
+
   end
 end
 

data/lib/batt/formatter/tmux.rb

@@ -0,0 +1,36 @@
+module Batt
+  module Formatter
+    class Tmux
+
+      class << self
+
+        def format(string, options={})
+          fg = options[:fg]
+          bg = options[:bg]
+
+          color_string = [ bg_color(bg), fg_color(fg) ].compact.join(',')
+
+          if color_string.length > 0
+            "#[#{ color_string }]#{ string }#[default]"
+          else
+            string
+          end
+        end
+
+        def bg_color(color)
+          return nil unless color
+
+          "bg=#{ color }"
+        end
+
+        def fg_color(color)
+          return nil unless color
+
+          "fg=#{ color }"
+        end
+
+      end
+
+    end
+  end
+end

data/lib/batt/reader.rb

@@ -47,5 +47,19 @@ module Batt
 
       Hash[[:source, :capacity, :status, :remaining].zip(result)]
     end
+
+    class << self
+
+      # Given a capacity percentage, return the color
+      def color_for_capacity(capacity)
+        case capacity.to_i
+        when -100..20 then :red # if there's any weird errors where things go negative, be red.
+        when 20..30 then :orange
+        when 30..75 then :yellow
+        else
+          :green
+        end
+      end
+    end
   end
 end

data/lib/batt/version.rb

@@ -1,3 +1,3 @@
 module Batt
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/batt.rb

@@ -3,6 +3,7 @@ require "batt/version"
 require 'cocaine'
 require 'thor'
 
+require 'batt/formatter/tmux'
 require 'batt/reader'
 require 'batt/app'
 

data/spec/batt/formatter/tmux_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe Batt::Formatter::Tmux do
+  let(:formatter) { Batt::Formatter::Tmux }
+  let(:string_to_format) { 'just testing' }
+
+  describe "format" do
+
+    context "when no colors are passed" do
+      it "should return just the string" do
+        formatter.format(string_to_format).should == string_to_format
+      end
+    end
+
+    context "when passed just a fg color" do
+      let(:output) { formatter.format(string_to_format, :fg => :red) }
+
+      it "should not include a bg field" do
+        output.should_not match(/bg=/)
+      end
+
+      it "should include the fg color in the string" do
+        output.should match(/fg=red/)
+      end
+
+      it "should not have a comma in the color descriptors" do
+        output.should_not match(/^#\[.+?,.+?\]/)
+      end
+
+      it "should reset the color to default at the end" do
+        output.should match(/#\[default\]$/)
+      end
+
+      it "should include the string being formatted" do
+        output.should match(/#{ string_to_format }/)
+      end
+
+    end
+
+    context "when passed just a bg color" do
+      let(:output) { formatter.format(string_to_format, :bg => :red) }
+
+      it "should not include a fg field" do
+        output.should_not match(/fg=/)
+      end
+
+      it "should include the bg color in the string" do
+        output.should match(/bg=red/)
+      end
+
+      it "should not have a comma in the color descriptors" do
+        output.should_not match(/^#\[.+?,.+?\]/)
+      end
+
+      it "should reset the color to default at the end" do
+        output.should match(/#\[default\]$/)
+      end
+
+      it "should include the string being formatted" do
+        output.should match(/#{ string_to_format }/)
+      end
+
+    end
+
+    context "when passed both fg and bg colors" do
+      let(:output) { formatter.format(string_to_format, :fg => :black, :bg => :red) }
+
+      it "should include both fg and bg fields" do
+        output.should match(/fg=black/)
+        output.should match(/bg=red/)
+      end
+
+      it "should separate the color descriptors with a comma" do
+        output.should match(/^#\[.+?,.+?\]/)
+      end
+
+      it "should reset the color to default at the end" do
+        output.should match(/#\[default\]$/)
+      end
+
+      it "should include the string being formatted" do
+        output.should match(/#{ string_to_format }/)
+      end
+
+    end
+
+  end
+
+  describe "bg_color" do
+
+    it "should return nil if passed nil" do
+      formatter.bg_color(nil).should be_nil
+    end
+
+    it "should accept a string color" do
+      formatter.bg_color("red").should == 'bg=red'
+    end
+
+    it "should accept a symbol color" do
+      formatter.bg_color(:red).should == 'bg=red'
+    end
+
+  end
+
+  describe "fg_color" do
+
+    it "should return nil if passed nil" do
+      formatter.fg_color(nil).should be_nil
+    end
+
+    it "should accept a string color" do
+      formatter.fg_color("red").should == 'fg=red'
+    end
+
+    it "should accept a symbol color" do
+      formatter.fg_color(:red).should == 'fg=red'
+    end
+
+  end
+
+end

data/spec/batt/reader_spec.rb

@@ -93,5 +93,48 @@ describe Batt::Reader do
         status[:remaining].should == '5:36 remaining'
       end
     end
+
+    context "color_for_capacity" do
+
+      def color_for_capacity(capacity)
+        Batt::Reader.color_for_capacity(capacity)
+      end
+
+      it "should be :red when -1" do
+        color_for_capacity(-1).should == :red
+      end
+
+      it "should be :red when 15" do
+        color_for_capacity(15).should == :red
+      end
+
+      it "should be :red when == 20" do
+        color_for_capacity(20).should == :red
+      end
+
+      it "should be :orange when between 20 and 30" do
+        color_for_capacity(25).should == :orange
+      end
+
+      it "should be :orange when == 30" do
+        color_for_capacity(30).should == :orange
+      end
+
+      it "should be :yellow when == 50" do
+        color_for_capacity(50).should == :yellow
+      end
+
+      it "should be :green when 80" do
+        color_for_capacity(80).should == :green
+      end
+
+      it "should be :green when 100" do
+        color_for_capacity(100).should == :green
+      end
+
+      it "should be :green when 101" do
+        color_for_capacity(101).should == :green
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: batt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-13 00:00:00.000000000 Z
+date: 2013-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocaine
@@ -127,8 +127,10 @@ files:
 - bin/batt
 - lib/batt.rb
 - lib/batt/app.rb
+- lib/batt/formatter/tmux.rb
 - lib/batt/reader.rb
 - lib/batt/version.rb
+- spec/batt/formatter/tmux_spec.rb
 - spec/batt/reader_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/spikegrobstein/batt
@@ -146,7 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2248559496602016421
+      hash: -2829731468714431913
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -155,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2248559496602016421
+      hash: -2829731468714431913
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -163,5 +165,6 @@ signing_key:
 specification_version: 3
 summary: Read basic information about your laptop's battery
 test_files:
+- spec/batt/formatter/tmux_spec.rb
 - spec/batt/reader_spec.rb
 - spec/spec_helper.rb