dock_driver 0.1.2 → 0.2.0

data/lib/dock_driver/dock.rb

@@ -1,168 +1,119 @@
-# -*- ruby -*-
-# vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
 
-require 'erb'
-require 'yaml'
+require 'thread'
 require 'ostruct'
-require 'logger'
-
-require 'dock_driver' unless defined? DockDriver
-require 'dock_driver/hashutils'
-require 'dock_driver/poll'
-require 'dock_driver/data_rate_poll'
-
-# An object that represents and drives a dock program, periodically
-# updating what it displays.
-#
-class DockDriver::Dock < OpenStruct
-
-	include HashUtilities
-
-	# The *normal* place people keep user-specific configuration data for this program.
-	DEFAULT_CONFIG_FILE = '~/.dock_driver.yml'.freeze
-
-	# The usual place to put user-specific diagnostic information pertaining to this program.
-	DEFAULT_LOG_FILE = '~/.dock_driver.log'.freeze
-
-	# Default values to populate this OpenStruct with.
-	#
-	DEFAULTS = {
-		:polls => {},
-		:time_format => '%Y-%m-%d %H:%M:%S %Z',
-	}.freeze
-
-	# A map of poll Classes/types to kewords for config.
-	#
-	POLL_TYPES = {
-		nil => DockDriver::Poll,
-		'text' => DockDriver::Poll,
-		'rate' => DockDriver::DataRatePoll,
-	}.freeze
-
-	# Create and start a new Dock.
-	#
-	# === Arguments:
-	#
-	# +:config_file+ - Provide a path to a config file different from
-	# the default: ~/.dock_driver.yml
-	#
-	# +:dock_command+ - Override the dock command from the config file.
-	#
-	def initialize( config_file = nil, log_file = nil, dock_command = nil )
-		super DEFAULTS
-
-		@log_file = File.expand_path( log_file || DEFAULT_LOG_FILE )
-		@log = Logger.new( @log_file )
-		@log.level = $DEBUG ? Logger::DEBUG : Logger::WARN
-
-		@config_file_mtime = nil
-		@config_file = File.expand_path( config_file || DEFAULT_CONFIG_FILE )
-
-		load_config
-
-		@running = false
-		if dock_command
-			self.dock_command = dock_command
-		end
-	end
-
-	# Start the dock. Repeatedly calls Dock#drive until it's time to stop. See Dock#stop.
-	#
-	def start
-		return if @running
-		@running = true
-		while @running
-			drive
-		end
-	end
-
-	# Signal that it's time to stop the dock.
-	#
-	def stop
-		@running = false
-	end
-
-	#########
-	protected
-	#########
-
-	# Drives the dock program by IO#popen. This method provides a main
-	# loop that repeatedly checks the mtime of the config file, polls all of
-	# the polls, updates and delivers the template or any errors that
-	# happened along the way.
-	#
-	def drive
-		pipe = File.popen( self.dock_command, 'w' )
-		pipe.sync = true
-
-		while true
-
-			begin
-				break if load_config
-			rescue Exception => e
-				@log.error e
-				pipe.puts "Couldn't load your config: %s " % e
-				sleep 10
-				next
-			end
-
-			self.polls.each do |name,p|
-				begin
-					p.poll
-				rescue Exception => e
-					@log.error e
-				end
-			end
-
-			begin
-				vbind = OpenStruct.new( self.polls ).send( :binding )
-				pipe.puts @template.result( vbind ).gsub( /\s+/, ' ' )
-			rescue SyntaxError => e
-				@log.error e
-				pipe.puts "ERB didn't like your template. Check #{@log_file} to see why."
-				sleep 30
-			rescue Exception
-				break
-			end
-
-			sleep 1
-		end
-
-		pipe.close
-	rescue => e
-		puts e
-		puts e.backtrace
-		exit
-	end
-
-	# Loads the configuration file defined by the option +:config_file+ if it has
-	# changed since this method was last called. If not, returns false.
-	#
-	def load_config
-		mtime = File.mtime @config_file
-		return false if mtime == @config_file_mtime
-
-		@table.merge! symbolify_keys YAML.load_file @config_file
-		@config_file_mtime = mtime
-
-		self.polls = {}
-		if self.commands and self.commands.is_a? Hash
-			self.commands.each do |name,hash|
-				hash[:name] = name
-				self.polls[name] = POLL_TYPES[hash[:type]].new( hash )
-			end
-		end
-
-		if self.polls[:time].nil?
-			self.polls[:time] = DockDriver::Poll.new( {
-				:cmd => Proc.new { Time.now.strftime( self.time_format ) },
-			} )
-		end
-
-		@template = ERB.new( self.template )
-		true
-	end
-
-end
+require 'erb'
 
+module DockDriver
+
+    # Manages the dock process and templating.
+    class Dock
+
+        extend Loggability
+        log_to :dock_driver
+
+        #####################################################################
+        ### C O N F I G U R A B I L I T Y   A P I
+        #####################################################################
+
+        include Configurability
+        config_key :dock
+
+        class << self
+            # The dock command.
+            attr_accessor :command
+            # The configuration for each DockItem.
+            attr_accessor :items
+            # The dock's output template.
+            attr_accessor :template
+        end
+
+        ### The default configuration for this class.
+        CONFIG_DEFAULTS = {
+            :items => [
+                { 'name' => 'date', 'command' => 'date', 'frequency' => 1 }
+                ],
+            :command => 'dzen2',
+            :template => '<% date %>'
+        }
+
+        ### Configure the class.
+        def self::configure( section )
+            merged    = CONFIG_DEFAULTS.merge( section )
+            @items    = merged[:items]
+            @command  = merged[:command]
+            @template = ERB.new( merged[:template] )
+        end
+
+        #####################################################################
+        ### D O C K   A P I
+        #####################################################################
+
+        # Set to true after the dock starts.
+        attr_accessor :running
+        # A hash of DockItems.
+        attr_accessor :items
+        # A hash of threads that have been created to run each DockItem.
+        attr_accessor :threads
+        # A mutex to ensure sane output.
+        attr_accessor :render_lock
+        # An IO pipe that will be or is connected to the dock program.
+        attr_writer   :pipe
+
+        ### A bog-standard constructor.
+        def initialize #:nodoc:
+            @items = {}
+            @threads = {}
+            @render_lock = Mutex.new
+        end
+
+        ### Lazily execute the dock command.
+        def pipe
+            return @pipe ||= IO.popen( self.class.command, 'r+' )
+        end
+
+        ### Listen to this dock's items, printing to the dock command when 
+        ### appropriate. 
+        def notify( obj )
+            self.render_lock.synchronize do
+                self.pipe.puts self.to_s if self.pipe
+            end
+        end
+
+        ### Start or restart the dock.
+        def run
+
+            self.log.debug "Template: %p" % [self.class.template]
+
+            if self.running
+                self.log.debug "Restarting the dock."
+                self.threads.values.map( &:kill )
+                self.items.clear
+                self.pipe.close
+                self.pipe = nil
+            else
+                self.log.debug "Starting the dock."
+                self.running = true
+            end
+
+            self.log.debug "Building items."
+            self.class.items.map do |item_opts|
+                item = DockItem.new( item_opts )
+                item.add_observer self
+                self.items[item.name] = item
+                self.threads[item.name] = Thread.new { item.run }
+            end
+
+            self.log.debug "Starting items."
+            self.threads.values.map( &:run )
+
+        end
+
+        ### Provide output for the dock.
+        def to_s
+            vbind = OpenStruct.new( self.items ).send( :binding )
+            return self.class.template.result( vbind ).gsub( /\s+/, ' ' )
+        end
+
+    end
+
+end

data/lib/dock_driver/dock_item.rb

@@ -0,0 +1,47 @@
+module DockDriver
+
+    # Runs a command periodically and notifies an observer periodically, and
+    # provides output from the command.
+    class DockItem
+
+        extend Loggability
+        log_to :dock_driver
+
+        include Subject
+
+        # This item's name.
+        attr_accessor :name
+        # How many seconds to wait between command executions.
+        attr_accessor :frequency
+        # The last output from the command.
+        attr_accessor :output
+        # The command to be run.
+        attr_accessor :command
+
+        # A standard contstructor.
+        def initialize( opts = {} ) #:nodoc:
+            self.log.debug "DockItem constructor options: %p" % [opts]
+            @name = opts['name']
+            @frequency = opts['frequency'] || 1
+            @command = opts['command']
+            @output = 0
+        end
+
+        # Work for a thread to do.
+        def run
+            self.log.debug "%s is running." % self.name
+            loop do
+                sleep self.frequency
+                # TODO output scanning
+                self.output = `#{self.command}`
+                self.notify_observers
+            end
+        end
+
+        # Returns the formatted output from the command.
+        def to_s
+            return self.output
+        end
+
+    end
+end

data/lib/dock_driver/dzen2.rb

@@ -0,0 +1,5 @@
+module DockDriver
+    # A class to provide an api for formatting.
+    class Dzen2
+    end
+end

data/lib/dock_driver/i3.rb

@@ -0,0 +1,80 @@
+
+require 'socket'
+require 'pathname'
+require 'json'
+
+module DockDriver
+    # A class to provide IPC communication with i3wm.
+    class I3
+        COMMAND        = 0
+        GET_WORKSPACES = 1
+        SUBSCRIBE      = 2
+        GET_OUTPUTS    = 3
+        MAGIC          = 'i3-ipc'
+
+        # ripped from include/i3/ipc.h
+        #
+        EVENT_MASK      = (1 << 31)
+        EVENT_WORKSPACE = (EVENT_MASK | 0)
+
+        def initialize( socket='~/.i3/ipc.sock' )
+            @ipc = UNIXSocket.open( Pathname( socket ).expand_path )
+        end
+
+        attr_reader :ipc
+
+        ### Send a command to i3.
+        def command( cmd )
+            self.send_data( COMMAND, cmd )
+        end
+
+        ### Return an array of current workspace state.
+        def get_workspaces
+            self.send_data( GET_WORKSPACES )
+            return self.read_data( GET_WORKSPACES )
+        end
+
+        ### Register interest in workspace change events.
+        def subscribe_workspaces
+            self.send_data( SUBSCRIBE, JSON.generate(['workspace']))
+            result = self.read_data( SUBSCRIBE )
+            return result[ 'success' ]
+        end
+
+        ### Do a blocking select, yielding an event when one is seen.
+        def wait_for_event( type=nil, timeout=nil )
+            ready = select( [self.ipc], nil, nil, timeout )
+            return if ready.nil? # timeout
+
+            msg = self.read_data( type )
+            return if msg.nil? && ! type.nil?
+
+            yield msg if block_given?
+            return msg
+        end
+
+        #########
+        protected
+        #########
+
+        ### Format a message payload and send it to i3.
+        def send_data( type, data=nil )
+            len = data.nil? ? 0 : data.to_s.bytes.count
+            body = MAGIC + [ len, type ].pack( 'LL' )
+            body << data.to_s unless data.nil?
+
+            self.ipc.write( body )
+        end
+
+        ### Receive a message payload from i3, returning it as a data structure.
+        ### Returns nil if a +type+ is specified, and the message doesn't match.
+        def read_data( expected_type=nil )
+            buf = self.ipc.read( MAGIC.bytes.count + 4 + 4 )
+            len, type = buf[6..-1].unpack( 'LL' )
+            msg = self.ipc.read( len )
+
+            return nil if ! expected_type.nil? && expected_type != type
+            return JSON.parse( msg )
+        end
+    end
+end

data/lib/dock_driver/mixins.rb

@@ -0,0 +1,33 @@
+module DockDriver
+
+    # A mixin providing a simple implementation of the listener pattern.
+    module Subject
+
+        extend Loggability
+        log_to :dock_driver
+
+        # Lazily create a list of interested objects.
+        def observers
+            return @observers ||= []
+        end
+
+        # Register an object's interest in this Subject.
+        def add_observer( obj )
+            observers ||= []
+            if obj.respond_to? :notify
+                self.observers << obj
+            else
+                raise "Object must respond to :notify: %p" % [obj]
+            end
+        end
+
+        # Dispatch notification - call +notify+ on each observer.
+        def notify_observers
+            self.observers.each do |observer|
+                observer.notify( self )
+            end
+        end
+
+    end
+
+end

data/lib/dock_driver/workspace_pager.rb

@@ -0,0 +1,5 @@
+module DockDriver
+    # A DockItem to show and switch workspaces.
+    class WorkspacePager < DockItem
+    end
+end

data/lib/dock_driver.rb

@@ -1,20 +1,86 @@
-# -*- ruby -*-
-# vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
-#
+require 'rubygems'
+require 'loggability'
 
-# A namespace for the project.
-#
+require 'dock_driver/mixins'
+
+require 'dock_driver/i3'
+require 'dock_driver/dock'
+require 'dock_driver/dock_item'
+require 'dock_driver/workspace_pager'
+
+# A namespace for the project & singleton for driving the dock.
 module DockDriver
 
-	# Version Constant
-	VERSION = '0.1.2'
+    include Configurability
+    extend Loggability
+
+    config_key :dock_driver
+    log_as :dock_driver
+
+    # Project version.
+    VERSION = '0.2.0'
+
+    # Project revision.
+    REVISION = %$Revision: aa11bde4afd8 $
+
+    # The default location of a user's config file.
+    USER_CONFIG_FILE = Pathname( '~/.dock_driver.yml' )
+
+    # Configurability defaults.
+    CONFIG_DEFAULTS = {
+        :dock_driver => {},
+        :dock => {
+            :command => 'dzen2 -dock',
+            :items => []
+        }
+    }
+
+    # The loaded config
+    @config = {}
+
+    # The dock instance for the app.
+    @dock = Dock.new
+
+    class << self
+        # The loaded config.
+        attr_accessor :config
+        # When the config was last loaded.
+        attr_accessor :config_loaded_at
+        # The dock object.
+        attr_accessor :dock
+    end
+
+    ### Configurability API
+    def self::load_config( config_file )
+        self.config = Configurability::Config.load( config_file, CONFIG_DEFAULTS )
+        self.log.info "Installing config (%p)" % [self.config]
+        self.config.install
+        self.config_loaded_at = Time.now
+        return self.config
+    end
 
-	# Revision Constant
-    REVISION = %q$Revision: 196ad604d0de $
+    # Watch the config; initate a reload if it has been touched.
+    def self::run( opts )
+        loop do
+            if self.config_loaded_at.nil? or 
+               self.config_loaded_at < File.mtime( opts[:config] )
+               self.log.debug "The config has been touched."
+               self.reload( opts )
+            end
+            sleep 1
+        end
+    end
 
-	# Behold the author(s) responsible for this mess.
-	AUTHORS = [ 'Mike Hix <mike@musl.org>' ]
+    # Reload the config
+    def self::reload( opts )
+        self.log.debug "Reloading."
+        self.load_config( opts[:config] )
+        self.dock.run
+    end
 
-end
+    # Cleanly kill the dock.
+    def self::kill
+        self.dock.pipe.close
+    end
 
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dock_driver
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Michael Hix
@@ -35,7 +35,7 @@ cert_chain:
   Edc7ShBTME9+u6K/HFwVxTOH8WJVxkwGTmxKgCevr5mZzbINH/C6LbkmfEA=
   -----END CERTIFICATE-----
 
-date: 2012-08-22 00:00:00 Z
+date: 2012-11-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -59,11 +59,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 5
         segments: 
         - 3
-        - 0
-        version: "3.0"
+        - 1
+        version: "3.1"
   type: :development
   name: hoe
   version_requirements: *id002
@@ -81,28 +81,27 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Ideas.txt
+- History.rdoc
 - Manifest.txt
-- README.txt
+- README.rdoc
+- TODO.rdoc
 files: 
 - .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
 - .gemtest
 homepage: http://hg.musl.org/projects/dock_driver/
 licenses: []
@@ -110,7 +109,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.hgignore

@@ -1,2 +0,0 @@
-doc/.*
-pkg/.*

data/History.txt

@@ -1,37 +0,0 @@
-=== 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!
-