dock_driver 0.1.2 → 0.2.0

data/Ideas.txt

@@ -1,19 +0,0 @@
-= Ideas
-
-== Without Dependencies
-
-* Graphing
-* Automatic Coloring (with definable syntax)
-
-== With Dependencies
-
-* Maildir support
-* SNMP Poller
-* gateway / internet latency
-
-== dzen2 Ideas
-
-* buttons
-* events
-* text window
-

data/lib/dock_driver/data_rate_poll.rb

@@ -1,136 +0,0 @@
-# -*- ruby -*-
-# vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
-
-require 'ostruct'
-
-require 'dock_driver' unless defined? DockDriver
-require 'dock_driver/poll'
-
-# A class to provide periodic command execution, caching, and a
-# running average of changes in the output of the command.
-#
-class DockDriver::DataRatePoll < DockDriver::Poll
-
-	# Default values to populate the OpenStruct with.
-	#
-	DEFAULTS = {
-		:unit => :mb,
-		:history_size => 2,
-		:format => '%0.3f',
-	}.freeze
-
-	# Create a new DataRatePoll.
-	#
-	# === Arguments:
-	#
-	# +opts+ - A hash containing options. Merged with DEFAULTS.
-	#
-	# +block+ - If a block is given, replace :cmd with that block.
-	#
-	# === Options:
-	#
-	# Everything accepted by from Poll, plus:
-	#
-	# +:history_size+ - How many samples to keep
-	#
-	# +:unit+ - The unit to use. See the methods and aliases available.
-	# (b, kb, mb, gb, tb, pb, eb, zb, yb, and full names: bits, kibibits, mebibits, ...)
-	#
-	def initialize( opts = {} )
-		super DEFAULTS.merge( opts )
-
-		@last_sample = nil
-		@history = Array.new( self.history_size ) { 0 }
-	end
-
-	# Runs the command if enough time has elapsed since the last
-	# poll. "Enough Time" is defined by the :delay option. Maintains the
-	# history of output, average and formatting.
-	#
-	def poll
-		return false unless super
-
-		@sample = @sample.to_f
-		@last_sample ||= @sample
-		sample = 8 * ( @sample - @last_sample )
-		@history.shift if @history.length >= self.history_size
-		@history.push sample
-		@last_sample = @sample
-
-		true
-	end
-
-	# Returns the average value in bits.
-	#
-	def bits
-		@history.inject( :+ ) / @history.count.to_f
-	end
-	alias :b :bits
-
-	# Returns the average value in kibibits.
-	#
-	def kibibits
-		bits / 1024.0
-	end
-	alias :kb :kibibits
-
-	# Returns the average value in mebibits.
-	#
-	def mebibits
-		kibibits / 1024.0
-	end
-	alias :mb :mebibits
-
-	# Returns the average value in gibibits.
-	#
-	def gibibits
-		mebibits / 1024.0
-	end
-	alias :gb :gibibits
-
-	# Returns the average value in tebibits.
-	#
-	def tebibits
-		gibibits / 1024.0
-	end
-	alias :tb :tebibits
-
-	# Returns the average value in pebibits.
-	#
-	def pebibits
-		tebibits / 1024.0
-	end
-	alias :pb :pebibits
-
-	# Returns the average value in exbibits.
-	#
-	def exbibits
-		pebibits / 1024.0
-	end
-	alias :eb :exbibits
-
-	# Returns the average value in zebibits.
-	#
-	def zebibits
-		exbibits / 1024.0
-	end
-	alias :zb :zebibits
-
-	# Returns the average value in yobibits.
-	#
-	def yobibits
-		zebibits / 1024.0
-	end
-	alias :yb :yobibits
-
-	# Returns a string representing the data rate this poll tracks.
-	#
-	def to_s
-		value = self.unit ? send( self.unit ) : bits
-		return value.to_s if self.format.nil?
-		self.format % value
-	end
-
-end
-

data/lib/dock_driver/hashutils.rb

@@ -1,79 +0,0 @@
-# -*- ruby -*-
-# vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
-#
-# Copyright (c) 2007-2012, Michael Granger and Mahlon E. Smith
-# All rights reserved.
-#
-
-### A collection of utilities for working with Hashes.
-#
-module HashUtilities
-
-	###############
-	module_function
-	###############
-
-	### Return a version of the given +hash+ with its keys transformed
-	### into Strings from whatever they were before.
-	def stringify_keys( hash )
-		newhash = {}
-
-		hash.each do |key,val|
-			if val.is_a?( Hash )
-				newhash[ key.to_s ] = stringify_keys( val )
-			else
-				newhash[ key.to_s ] = val
-			end
-		end
-
-		return newhash
-	end
-
-
-	### Return a duplicate of the given +hash+ with its identifier-like keys
-	### transformed into symbols from whatever they were before.
-	def symbolify_keys( hash )
-		newhash = {}
-
-		hash.each do |key,val|
-			keysym = key.to_s.dup.untaint.to_sym
-
-			if val.is_a?( Hash )
-				newhash[ keysym ] = symbolify_keys( val )
-			else
-				newhash[ keysym ] = val
-			end
-		end
-
-		return newhash
-	end
-	alias_method :internify_keys, :symbolify_keys
-
-
-	# Recursive hash-merge function
-	def merge_recursively( key, oldval, newval )
-		case oldval
-		when Hash
-			case newval
-			when Hash
-				oldval.merge( newval, &method(:merge_recursively) )
-			else
-				newval
-			end
-
-		when Array
-			case newval
-			when Array
-				oldval | newval
-			else
-				newval
-			end
-
-		else
-			newval
-		end
-	end
-
-end # HashUtilities
-

data/lib/dock_driver/poll.rb

@@ -1,90 +0,0 @@
-# -*- ruby -*-
-# vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
-#
-
-require 'ostruct'
-
-require 'dock_driver' unless defined? DockDriver
-
-# A class to provide periodic command execution and caching.
-#
-class DockDriver::Poll < OpenStruct
-
-	# Default values to populate the OpenStruct with.
-	#
-	DEFAULTS = {
-		:delay => 1,
-	}.freeze
-
-	# Create a new Poll.
-	#
-	# === Arguments:
-	#
-	# +opts+ - A hash containing options. Merged with DEFAULTS.
-	#
-	# +block+ - If a block is given, replace :cmd with that block.
-	#
-	# === Options:
-	#
-	# +:delay+ - Determines the minimum amount of time to let elapse between executions.
-	#
-	# +:cmd+ - A string or block to execute.
-	#
-	# +:scan_regex+ - A bare string to be interpreted as a regex for use with +scan+. Any
-	# capture group matches will be joined with single spaces.
-	#
-	# +:format+ - A format string. See: Kernel#format
-	#
-	def initialize( opts = {}, &block )
-		super DEFAULTS.merge( opts )
-
-		@sample = nil
-
-		if block_given?
-			self.cmd = block
-		end
-	end
-
-	# Runs the command if enough time has elapsed since the last
-	# poll. "Enough Time" is defined by the :delay option. If the command
-	# fails to run, it is disabled and the format and output string are set
-	# to nil.
-	#
-	def poll
-		return false if @sample and (Time.now - (self.last_poll || 0 )) < self.delay
-
-		self.last_poll = Time.now
-
-		case self.cmd
-		when Proc
-			@sample = self.cmd.call.to_s.chomp
-		else
-			output = `#{self.cmd.to_s} 2>&1`.chomp
-			if $? == 0
-				@sample = output
-			else
-				self.format = nil
-				@sample = '[%s: Error!] ' % self.name
-				raise output
-			end
-		end
-
-		if self.scan_regex
-			extract = @sample.scan( Regexp.new( self.scan_regex ) ).flatten
-			@sample = extract.join( ' ' ) unless extract.empty?
-		end
-
-		true
-	end
-
-	# Returns the output of the command this Poll runs. It will return a formatted string if
-	# the +:format+ option is correctly specified.
-	#
-	def to_s
-		return @sample.to_s if self.format.nil?
-		self.format % @sample
-	end
-
-end
-

data/spec/dock_driver/dock_spec.rb

@@ -1,36 +0,0 @@
-
-require 'pathname'
-require 'fileutils'
-require 'dock_driver/dock'
-
-describe DockDriver::Dock do
-
-	subject do
-		@conf = Pathname( __FILE__ ).parent.parent.parent
-		@conf += 'data/example.dock_driver.yml'
-
-		# Use very common binaries that are all but guaranteed to be in the
-		# user's path so that we can maintain a meaningful example config file.
-		#
-		dock = Dock.new( @conf.to_s, nil, 'cat' )
-		dock.polls.values.each { |p| p.cmd = 'echo test' }
-		dock
-	end
-
-	it 'should load a config file' do
-		subject.dock_command.should_not be nil
-		subject.template.should_not be nil
-		subject.polls.should have_at_least( 2 ).things
-		subject.polls.values.each { |p| p.should be_a_kind_of Poll }
-	end
-
-	it 'should only reload a config file with a more recent mtime' do
-		subject.send( :load_config ).should be false
-		sleep 0.1
-		FileUtils.touch @conf
-		subject.send( :load_config ).should be true
-		subject.send( :load_config ).should be false
-	end
-
-end
-

data/spec/dock_driver/poll_spec.rb

@@ -1,45 +0,0 @@
-
-require 'dock_driver/poll'
-require 'dock_driver/data_rate_poll'
-
-include DockDriver
-
-shared_examples 'a poll' do
-
-	subject do
-		described_class.new( :cmd => 'echo test' )
-	end
-
-	it 'should execute shell commands' do
-		lambda do
-			subject.poll.should == true
-		end.should_not raise_error
-	end
-
-	it 'should execute blocks' do
-		subject.cmd = lambda {}
-		lambda do
-			subject.poll.should == true
-		end.should_not raise_error
-	end
-
-	it 'should cache command output' do
-		subject.delay = 10
-		subject.poll.should == true
-		subject.poll.should == false
-
-		subject.delay = 0
-		subject.poll.should == true
-		subject.poll.should == true
-	end
-
-end
-
-describe Poll do
-	it_behaves_like 'a poll'
-end
-
-describe DataRatePoll do
-	it_behaves_like 'a poll'
-end
-

data/spec/dock_driver_spec.rb

@@ -1,17 +0,0 @@
-
-require 'dock_driver'
-
-describe DockDriver do
-
-	it 'should define a standard version number' do
-		defined?( VERSION ).should == 'constant'
-		VERSION.should =~ /^\d+\.\d+\.\d+$/
-	end
-
-	it 'should define a mercurial revision' do
-		defined?( REVISION ).should == 'constant'
-		REVISION.should =~ /^Revision: [[:xdigit:]]+ $/
-	end
-
-end
-