batt 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in batt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Spike Grobstein
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Batt
+
+Read the battery status from your laptop. Designed to be used in `tmux`'s status line.
+
+Currently only supports OSX.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'batt'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install batt
+
+## Usage
+
+There is a full API that I'm working on, but it's not complete. Gem docs will come
+at the time that the code is implemented.
+
+You can use the commandline program, in OSX only for now:
+
+    batt <action>
+
+Where `action` is one of the following:
+
+ * `all` -- prints out all status of the battery
+ * `status` -- 'charging' or 'discharging'
+ * `source` -- 'AC Power' or 'Battery Power'
+ * `remaining` -- amount of time remaining til complete discharge or complete charge
+ * `capacity` -- a percentage of how charged the battery is
+
+ ## tmux
+
+ Example `tmux` status line configuration:
+
+    tmux set-option status-right-length 120
+    tmux set-option status-right "[ #(batt source) #(batt remaining) ] #(date \"+%Y-%m-%d %H:%M:%S\")"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/batt.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'batt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "batt"
+  spec.version       = Batt::VERSION
+  spec.authors       = ["Spike Grobstein"]
+  spec.email         = ["me@spike.cx"]
+  spec.description   = %q{Read basic information about your laptop's battery. Includes both ANSI and tmux colour support.}
+  spec.summary       = %q{Read basic information about your laptop's battery}
+  spec.homepage      = "https://github.com/spikegrobstein/batt"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "cocaine", "~> 0.5"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/bin/batt

@@ -0,0 +1,6 @@
+#! /usr/bin/env ruby
+# vi:syntax=ruby
+
+require 'batt'
+
+Batt::App.start(ARGV)

data/lib/batt/app.rb

@@ -0,0 +1,51 @@
+module Batt
+  class App < Thor
+
+    desc "all", "spit out the full battery status"
+    # option :tmux, :type => :boolean
+    # option :ansi, :type => :boolean
+    def all
+      b = Batt::Reader.new
+      result = b.status
+
+      size = result.keys.map{ |k| k.length }.reduce(0) { |m, l| m = l if l > m; m }
+      result.each do |k,v|
+        puts "%#{ size }s: %s" % [ k, v ]
+      end
+
+    end
+
+    desc "source", "spit out the current source of power (AC or battery)"
+    def source
+      b = Batt::Reader.new
+
+      puts b.status[:source]
+    end
+
+    desc "capacity", "spit out the current capacity in % of the battery"
+    def capacity
+      b = Batt::Reader.new
+
+      puts b.status[:capacity]
+    end
+
+    desc "status", "spit out the status of the battery"
+    def status
+      b = Batt::Reader.new
+      result = b.status
+
+      puts b.status[:status]
+    end
+
+    desc "remaining", "spit out the remaining time for the battery"
+    def remaining
+      b = Batt::Reader.new
+
+      puts b.status[:remaining]
+    end
+
+  end
+end
+
+
+

data/lib/batt/reader.rb

@@ -0,0 +1,49 @@
+module Batt
+  class Reader
+
+    attr_accessor :battery_reader
+
+    def initialize
+      os = get_os
+      case os
+      when :darwin
+        @battery_reader = lambda { parse_battery_status_osx(get_battery_status_osx) }
+      else
+        raise "Unsupported OS: #{ os }"
+      end
+    end
+
+    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
+    def get_os
+      line = Cocaine::CommandLine.new('uname')
+      output = line.run
+
+      output.chomp.downcase.intern
+    end
+
+    # get the battery status for OSX
+    # returns a hash.
+    # spits out something like:
+    # Currently drawing from 'AC Power'
+    # -InternalBattery-0     98%; charging; 0:30 remaining
+    # TODO: write some docs
+    def get_battery_status_osx
+      line = Cocaine::CommandLine.new('pmset', '-g batt')
+      output = line.run
+    end
+
+    def parse_battery_status_osx(output)
+      output = output.split(/\n/)
+      status = output.shift.scan(/'(.+?)'/).first
+      result = status + output.shift.scan(/(\d+%);\s*(.+?);\s*(.+)/).first
+
+      Hash[[:source, :capacity, :status, :remaining].zip(result)]
+    end
+  end
+end

data/lib/batt/version.rb

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

data/lib/batt.rb

@@ -0,0 +1,11 @@
+require "batt/version"
+
+require 'cocaine'
+require 'thor'
+
+require 'batt/reader'
+require 'batt/app'
+
+module Batt
+  # Your code goes here...
+end

data/spec/batt/reader_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe Batt::Reader do
+  let(:reader) { Batt::Reader.new }
+  let(:status) { reader.status }
+
+  it "should initialize without error" do
+    b = Batt::Reader.new
+  end
+
+  context "get_battery_status_osx" do
+    let(:output_ac_power_no_estimate) { "Currently drawing from 'AC Power'\n -InternalBattery-0     98%; charging; (no estimate)" }
+    let(:output_ac_power_estimate) { "Currently drawing from 'AC Power'\n -InternalBattery-0     88%; charging; 0:30 remaining" }
+    let(:output_battery_power) { "Currently drawing from 'Battery Power'\n -InternalBattery-0     100%; discharging; 5:36 remaining" }
+
+    let(:status) { reader.parse_battery_status_osx(output) }
+
+    before do
+      reader.stub(:get_os => :darwin)
+    end
+
+    context "when ac attached" do
+      context "no estimate" do
+        let(:output) { output_ac_power_no_estimate }
+
+        it "should return a hash" do
+          status.class.should == Hash
+        end
+
+        it "should return a source of 'AC Power'" do
+          status[:source].should == 'AC Power'
+        end
+
+        it "should return a capacity of '98%'" do
+          status[:capacity].should == '98%'
+        end
+
+        it "should return a status of 'charging'" do
+          status[:status].should == 'charging'
+        end
+
+        it "should return a remaining of '(no estimate)'" do
+          status[:remaining].should == '(no estimate)'
+        end
+
+      end
+
+      context "with estimate" do
+        let(:output) { output_ac_power_estimate }
+
+        it "should return a hash" do
+          status.class.should == Hash
+        end
+
+        it "should return a source of 'AC Power'" do
+          status[:source].should == 'AC Power'
+        end
+
+        it "should return a capacity of '88%'" do
+          status[:capacity].should == '88%'
+        end
+
+        it "should return a status of 'charging'" do
+          status[:status].should == 'charging'
+        end
+
+        it "should return a remaining of '0:30 remaining'" do
+          status[:remaining].should == '0:30 remaining'
+        end
+      end
+    end
+
+    context "when on battery power" do
+      let(:output) { output_battery_power }
+
+      it "should return a hash" do
+        status.class.should == Hash
+      end
+
+      it "should return a source of 'Battery Power'" do
+        status[:source].should == 'Battery Power'
+      end
+
+      it "should return a capacity of '100%'" do
+        status[:capacity].should == '100%'
+      end
+
+      it "should return a status of 'discharging'" do
+        status[:status].should == 'discharging'
+      end
+
+      it "should return a remaining of '5:36 remaining'" do
+        status[:remaining].should == '5:36 remaining'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$: << File.dirname(__FILE__) + '/../lib'
+
+require 'batt'
+
+def fixture_path(filename)
+  File.join( File.dirname(__FILE__), 'fixtures', filename )
+end
+

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: batt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Spike Grobstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocaine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Read basic information about your laptop's battery. Includes both ANSI
+  and tmux colour support.
+email:
+- me@spike.cx
+executables:
+- batt
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- batt.gemspec
+- bin/batt
+- lib/batt.rb
+- lib/batt/app.rb
+- lib/batt/reader.rb
+- lib/batt/version.rb
+- spec/batt/reader_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spikegrobstein/batt
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4283814709343736854
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4283814709343736854
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Read basic information about your laptop's battery
+test_files:
+- spec/batt/reader_spec.rb
+- spec/spec_helper.rb