batt 0.0.1 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+0.1.0 (2013/07/13)
+---
+
+ * added tmux colour support for `capacity`
+ * fixed the tmux example in the readme.
+
+0.0.1 (2013/07/09)
+---
+
+Initial Release

data/README.md

@@ -35,12 +35,23 @@ Where `action` is one of the following:
  * `remaining` -- amount of time remaining til complete discharge or complete charge
  * `capacity` -- a percentage of how charged the battery is
 
- ## tmux
+## tmux
 
- Example `tmux` status line configuration:
+Tmux support is a work in progress and is one of the primary use-cases for the design
+of this gem. Currently, only the `capacity` action has tmux support, which can be enabled
+via passing `--tmux` to it:
 
-    tmux set-option status-right-length 120
-    tmux set-option status-right "[ #(batt source) #(batt remaining) ] #(date \"+%Y-%m-%d %H:%M:%S\")"
+    batt capacity --tmux
+
+Future releases will have additional support for tmux. I just need to work out what
+it's gonna look like.
+
+### Example tmux.conf
+
+Example `tmux` status line configuration. Add this to your .tmux.conf:
+
+    set-option status-right-length 120
+    set-option status-right "[ #(batt source) #(batt capacity --tmux) ] #(date \"+%Y-%m-%d %H:%M\")"
 
 ## Contributing
 

data/lib/batt/app.rb

@@ -1,3 +1,4 @@
+require 'pry'
 module Batt
   class App < Thor
 
@@ -23,10 +24,18 @@ module Batt
     end
 
     desc "capacity", "spit out the current capacity in % of the battery"
+    option :tmux, :type => :boolean, :desc => 'Enable tmux colour'
     def capacity
       b = Batt::Reader.new
 
-      puts b.status[:capacity]
+      c = b.status[:capacity]
+
+      if options[:tmux]
+        color = %w(red yellow green)[c.to_i / 33]
+        puts "#[bg=#{color},fg=black]#{ c }#[default]"
+      else
+        puts c
+      end
     end
 
     desc "status", "spit out the status of the battery"

data/lib/batt/reader.rb

@@ -13,13 +13,15 @@ module Batt
       end
     end
 
+    # runs the batteryreader
+    # this could probably be refactored to leverage a class per OS
     def status
       @battery_reader.call
     end
 
     # figure out which OS is running
     # this might need to be a little more solid
-    # returns a downcased symbol
+    # returns a downcased symbol (eg: +:darwin+ or +:linux+)
     def get_os
       line = Cocaine::CommandLine.new('uname')
       output = line.run

data/lib/batt/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: batt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000 Z
+date: 2013-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocaine
@@ -118,6 +118,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -145,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4283814709343736854
+      hash: 2248559496602016421
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -154,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4283814709343736854
+      hash: 2248559496602016421
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24