dock_driver 0.1.2 → 0.2.0

data/.pryrc

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby -*- ruby -*-
+
+$LOAD_PATH.unshift 'lib'
+
+begin
+        require 'dock_driver'
+rescue Exception => e
+        $stderr.puts "DockDriver's libraries failed to load: #{e.message}\n\t" +
+                e.backtrace.join( "\n\t" )
+end

data/History.rdoc

@@ -0,0 +1,52 @@
+= History
+
+=== 0.2.0 / 2012-11-21
+
+* 1 major enhancement
+  * A complete rewrite.
+    * Basic functionality is complete.
+    * The namespace has been re-arranged and made more general.
+    * Uses Configurability and Loggability gems.
+    * OptionParser has been replaced by Trollop.
+    * Support for INT and HUP signals.
+    * Dock now waits for DockItems to notify it before creating output.
+    * Dock now lazily executes the dock command.
+    * Dock no longer sets sync on the pipe which sometimes made dzen2 exit uncleanly.
+
+=== 0.1.2 / 2012-08-22
+
+* 1 minor enhancement
+  * the signal handler for INT now exits.
+
+=== 0.1.1 / 2012-05-20
+
+* 2 minor enhancements
+  * logging
+  * bug fixes
+
+=== 0.1.0 / 2012-05-15
+
+* 3 minor enhancements
+
+  * bin/dock_driver completed
+  * RSpec tests completed & passing
+  * Several bugs fixed
+
+=== 0.0.3 / 2012-05-15
+
+* 1 minor enhancement
+
+  * Doc & Manifest Updates
+
+=== 0.0.2 / 2012-05-15
+
+* 1 minor enhancement
+
+  * 100% documentation coverage
+
+=== 0.0.1 / 2012-05-15
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -1,17 +1,16 @@
 .autotest
-.hgignore
-History.txt
-Ideas.txt
+.pryrc
+History.rdoc
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
+TODO.rdoc
 bin/dock_driver
 data/example.dock_driver.yml
 lib/dock_driver.rb
-lib/dock_driver/hashutils.rb
-lib/dock_driver/poll.rb
-lib/dock_driver/data_rate_poll.rb
 lib/dock_driver/dock.rb
-spec/dock_driver/dock_spec.rb
-spec/dock_driver/poll_spec.rb
-spec/dock_driver_spec.rb
+lib/dock_driver/dock_item.rb
+lib/dock_driver/dzen2.rb
+lib/dock_driver/i3.rb
+lib/dock_driver/mixins.rb
+lib/dock_driver/workspace_pager.rb

data/{README.txt → README.rdoc}

@@ -17,8 +17,6 @@ started. It's located in this gem's data directory, which is usually:
 
 * easy, flexible configuration
 * sholud the configuration change, the dock will be automatically restarted
-* field extraction with +scan_regex+ (no grep or pipes necessary)
-* automatic running average of data rates
 
 See 'Ideas' for more info on what's planned for the future.
 
@@ -32,9 +30,6 @@ See 'Ideas' for more info on what's planned for the future.
 
 There really isn't an API or interface other than the YAML config file.
 
-See the +--help+ option for more information on how to use the
-+dock_config+ binary.
-
 == REQUIREMENTS:
 
 * This gem proudly has zero dependencies.

data/Rakefile

@@ -5,8 +5,32 @@ require 'hoe'
 Hoe.plugin :mercurial
 
 Hoe.spec 'dock_driver' do
-	developer 'Michael Hix', 'mike@musl.org'
-	require_ruby_version '>= 1.8.7'
-	require_rubygems_version '>= 1.8'
+    self.readme_file = 'README.rdoc'
+    self.history_file = 'History.rdoc'
+    self.extra_rdoc_files = FileList[ '*.rdoc' ]
+	self.developer 'Michael Hix', 'mike@musl.org'
+	self.require_ruby_version '>= 1.8.7'
+	self.require_rubygems_version '>= 1.8'
 end
 
+# This task is probably a bad idea but I'm doing it until the project settles
+# down.
+desc "Build Manifest.txt automatically, respecting .hgignore."
+task :manifest do
+    return unless File.exist?( '.hgignore' )
+
+    ignore = Regexp.union(
+        /^\.(hg|rvm)/,
+        *File.readlines( '.hgignore' ).map { |l| l.chomp }
+    )
+
+    manifest = []
+
+    Dir.glob( [ '**/*', '**/.*' ] ).sort.each do |file|
+        next if File.directory?( file )
+        next if file =~ ignore
+        manifest << file
+    end
+
+    File.write( 'Manifest.txt', manifest.join( "\n" ) + "\n" )
+end

data/TODO.rdoc

@@ -0,0 +1,11 @@
+= TODO
+== Important Features
+* Color & full Dzen2 escape support. (DockDriver::Dzen2)
+* DockDriver::WorkspacePager
+* DockItem output scanning
+* DockItem data rate support
+== Ideas
+* DockItem plugins
+* Multiple Dock support
+* DockItems with rotating output
+* Notifications / Slave window support

data/bin/dock_driver

@@ -1,90 +1,31 @@
 #!/usr/bin/env ruby
-# vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
-#
 
-require 'optparse'
-require 'dock_driver/dock'
+require 'rubygems'
+require 'dock_driver'
+require 'trollop'
 
 include Signal
 
-opts = {}
-parser = OptionParser.new do |p|
-
-	p.on(
-		'-c',
-		'--conf FILE',
-		"Specify an alternate config file. (Default: #{DockDriver::Dock::DEFAULT_CONFIG_FILE})"
-	) do |file|
-		unless File.exists? file
-			$stderr.puts "That config file doesn't exist." % file
-			$stderr.puts
-			$stderr.puts p
-			exit
-		end
-		opts[:conf] = file
-	end
-
-	p.on(
-		'-l',
-		'--log FILE',
-		"Specify an alternate log file. (Default: #{DockDriver::Dock::DEFAULT_LOG_FILE})"
-	) do |log|
-		if File.exists? log
-			$stderr.puts "That log file exists, and I'm cowardly refusing to overwrite it." % log
-			$stderr.puts
-			$stderr.puts p
-			exit
-		end
-		opts[:log] = log
-	end
-
-	p.on(
-		'-d',
-		'--dock COMMAND',
-		'Override the dock command from the config file.'
-	) do |command|
-		opts[:dock] = command
-	end
-
-	p.on( '-e', '--debug', 'Enable $DEBUG' ) { |debug| $DEBUG = true }
-
-	p.on( '-h', '--help', 'Print this help text.' ) do
-		cmd = File.basename( $0 )
-		$stderr.puts "\n%s\n%s\n\nVersion: %s\n%s\n\n" % [
-			cmd,
-			'=' * cmd.length,
-			DockDriver::VERSION,
-			DockDriver::REVISION,
-		]
-		$stderr.puts p
-		$stderr.puts "\nAuthors:\n\t%s\n\n" % [
-			DockDriver::AUTHORS.join( '\n\t' ),
-		]
-		exit
-	end
+extend Loggability
+log_to :dock_driver
 
+opts = Trollop.options do
+    opt :config,
+        "Specify an alternate config file.",
+        :default => DockDriver::USER_CONFIG_FILE.expand_path.to_s
 end
 
-# Handle invalid options.
-#
-begin
-	parser.parse!
-rescue => e
-	$stderr.puts "\n%s\n\n%s\n" % [e, parser]
-	exit
-end
-
-$stderr.puts "Options: %p" % opts if $DEBUG
+self.log.debug "DockDriver opts: %p" % [opts]
 
-dock = DockDriver::Dock.new( opts[:conf], opts[:log], opts[:dock] )
-
-# Respond to ^C.
-#
 trap 'INT' do
-	dock.stop
-	exit
+    self.log.debug "Recieved SIGINT."
+    DockDriver.kill
+    exit 0
 end
 
-dock.start
+trap 'HUP' do
+    self.log.debug "Recieved SIGHUP."
+    DockDriver.reload opts
+end
 
+DockDriver.run opts

data/data/example.dock_driver.yml

@@ -1,147 +1,16 @@
 ---
-# Specify a program to run here. This bit of code was initially meant to run
-# dzen2 but other docks are certainly appropriate, provided they accept commands
-# and data over standard input. You'll probably need to adjust your formats and
-# templates below if you use a different dock program.
-#
-dock_command: 
-    dzen2 -dock -ta r -x 0 -y 0 -w 1680 -h 24 -bg black -fg white 
-    -fn "-*-terminus-medium-r-*-*-12-*-*-*-*-*-*-*"
-    -e "button3="
-
-# See the manpages for strftime and dzen2.
-#
-time_format: 
-    ^fg(white)%A ^fg(gray80)%Y-%m-%d ^fg(gray60)%H:%M:%S ^fg(gray30)%Z
-
-# Determines the layout and styling of the dock.
-#
-# Processed by +ERB+. +Poll+ objects as defined by the 'commands' section are
-# available. Since +Poll+ objects respond to to_s intelligently, it's usually
-# sufficient to just specify the object name. Since they're also subclasses of
-# +OpenStruct+, you can also use any attribute defined on the poll here too.
-#
-# See the dzen2 documentation.
-#
-template:
-    <%= time %>
-    <%= load %>
-    ^fg(white)eth0
-    <%= eth0_rx %>^fg(gray30) <%= eth0_tx %>^fg(gray30) <%= eth0_rx.unit %>/s
-    <%= cpu0_temp %>
-    <%= cpu1_temp %>
-    <%= gpu_temp %>
-    ^fg(black)
-
-# Provides a list of commands to poll.
-#
-# The key commands needs to be a hash of hashes. The example below shows
-# some interesting examples. Here's the basic structure:
-#
-#   commands:
-#       name:
-#           cmd: 'whoami'
-#       frob:
-#           cmd: 'byte_frobber'
-#           type: 'rate'
-#           scan_regex: 'bytes_frobbed: (\d+)'
-#           format: '%0.3f bits per second'
-#
-# You'd refer to the above commands in your template like so:
-#
-#   User '<%= name %>' is frobbing <%= frob %>!
-#
-# Which would yield something like the following on your dock.
-#
-#   User 'mike' is frobbing 0.321 bits per second!
-#
-# Standard options for commands are as follows:
-#
-#
-# cmd:
-#
-# A required string that will get executed by a shell. If you're comfortable enough with YAML,
-# this can be a ruby Proc too.
-#
-#
-# scan_regex:
-#
-# This optional key provides a way to extract values from command
-# output. The value should be a regular expression without forward
-# slashes, and you'll probably want to put it in single quotes. The best
-# way to use it is to define one capture group with parenthasees. If you
-# define more than one capture group, they'll be joined up with spaces and
-# returned as a single string.
-#
-#
-# format:
-#
-# A string that allows you to wrap the output from your command in
-# another string. You can prepend a label, append a unit, convert the
-# data type in a limited fashion, or whatever you like.
-#
-# See: Kernel#format
-#
-#
-# delay:
-#
-# How long to cache the command output for. If delay is set to 60, even
-# if the bar is refreshed every second, the command will only be run every
-# 60 seconds or so. Timing isn't guaranteed, but it's good enough to
-# estimate data rates.
-#
-#
-# type:
-#
-# This optional key allows you to specify the type of poll to use. If
-# you don't specify a type, the default 'text' is used. It simply runs the
-# command, applies any scan_regex or format specified, and returns the
-# resulting text.
-#
-# If you specify 'rate', the command and scan_regex are expected
-# to return a number. This number will be interpereted as a total in
-# bytes. For example the number of bits that your network adapter has
-# sent. A history of how that value changes over time is kept, and the
-# output from this poll is the average of that history.
-#
-#
-# history_length:
-#
-# This only applies to the 'rate' type. The history length is the number
-# of samples to keep and allows you to control how long of a running
-# average to keep. The larger this number is, the more the average will
-# lag behind the actual rate of change.
-#
-#
-commands:
-    load:
-        cmd: 'uptime'
-        scan_regex: '(\d+\.\d+)$'
-        format: '^fg(white)load ^fg(gray60)%s^fg(gray30)/15'
-        delay: 60
-    cpu0_temp:
-        cmd: 'sensors'
-        scan_regex: 'Core 0:\s+\+(\d+\.\d+)'
-        format: '^fg(white)cpu0 ^fg(gray60)%s^fg(gray30)°C'
-        delay: 30
-    cpu1_temp:
-        cmd: 'sensors'
-        scan_regex: 'Core 1:\s+\+(\d+\.\d+)'
-        format: '^fg(white)cpu1 ^fg(gray60)%s^fg(gray30)°C'
-        delay: 30
-    gpu_temp:
-        cmd: 'nvidia-smi -q -d TEMPERATURE'
-        scan_regex: '(\d+) C'
-        format: '^fg(white)gpu ^fg(gray60)%s^fg(gray30)°C'
-        delay: 30    
-    eth0_rx:
-        cmd: 'ifconfig eth0'
-        scan_regex: 'RX bytes:(\d+)'
-        format: '^fg(#208020)%0.3f'
-        type: 'rate'
-    eth0_tx:
-        cmd: 'ifconfig eth0'
-        scan_regex: 'TX bytes:(\d+)'
-        format: '^fg(#802020)%0.3f'
-        type: 'rate'
-
+dock_driver:
+    command: 'dzen2'
+    template: ''
+dock:
+    items:
+        - name: gronald
+          command: foo --bar baz
+          frequency: 1.5
+        - name: aphrodite
+          command: feeblebeeble -vqnf 42
+          scan: 'Gort: (\d+)'
+          frequency: 3
+logging:
+    __default__: warn (color)
+    dock_driver: debug (color)