arborist 0.0.1.pre20160106113421 → 0.0.1.pre20160128152542

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9556233dcdad66412d5cabd6df2a7f3235dc616d
-  data.tar.gz: 04d28c6e8168ff42793194506fa13c6a3261ba11
+  metadata.gz: ff35c627aec6f851ab5771166be2e66540abc85e
+  data.tar.gz: 3b424125fb3f00a0dcafb5be8b9fabd33bd62785
 SHA512:
-  metadata.gz: a257132168202d1b7540286aad139cf52f3052924f64af76192ea65244ed591aff0dfc28241ee4e17497ab399b68639478e6200943757321b2a73c71fbd619fc
-  data.tar.gz: c027d0fad82b687ae3d3f56335f7d81f50818f964a0d659b14bef3697124539efccd74e6dd72434bae896d3a30f508c411e36c113c0c8c61a55500ae8d1ab3d2
+  metadata.gz: 43fcf881e75fc6a9a78b00e1e69eb352c79aac330153fadf5df20f7e4dfda8c0da42b18ca5e25fd1e84cd897201024ffccd82e84210c919c2e750a9b7c8c1573
+  data.tar.gz: 769e82ffa9da3bed89475ef155a5c66e36263cd53cd9a61ae545183b5ad631da704f69abe650ba8080080bcae5943dba787df325d6f614dcbf5db60ba6b58e5d

data/Manifest.txt

@@ -12,11 +12,15 @@ Protocol.md
 README.md
 Rakefile
 TODO.md
-bin/amanagerd
-bin/amonitord
-bin/aobserverd
+Tutorial.md
+bin/arborist
 lib/arborist.rb
+lib/arborist/cli.rb
 lib/arborist/client.rb
+lib/arborist/command/client.rb
+lib/arborist/command/config.rb
+lib/arborist/command/start.rb
+lib/arborist/command/watch.rb
 lib/arborist/event.rb
 lib/arborist/event/node_acked.rb
 lib/arborist/event/node_delta.rb
@@ -24,6 +28,8 @@ lib/arborist/event/node_matching.rb
 lib/arborist/event/node_update.rb
 lib/arborist/event/sys_reloaded.rb
 lib/arborist/exceptions.rb
+lib/arborist/loader.rb
+lib/arborist/loader/file.rb
 lib/arborist/manager.rb
 lib/arborist/manager/event_publisher.rb
 lib/arborist/manager/tree_api.rb

data/README.md

@@ -1,17 +1,26 @@
 # Arborist
 
-home :: http://deveiate.org/projects/Arborist  
-code :: http://bitbucket.org/ged/Arborist  
-github :: https://github.com/ged/arborist  
-docs :: http://deveiate.org/code/arborist  
+home
+: http://deveiate.org/projects/Arborist
+
+code
+: http://bitbucket.org/ged/Arborist
+
+github
+: https://github.com/ged/arborist
+
+docs
+: http://deveiate.org/code/arborist
 
 
 ## Description
 
-Arborist is a monitoring framework that follows the UNIX philosophy
+Arborist is a monitoring toolkit that follows the UNIX philosophy
 of small parts and loose coupling for stability, reliability, and
 customizability.
 
+[![Build Status](https://semaphoreci.com/api/v1/projects/13677b60-5f81-4e6e-a9c6-e21d30daa4ca/461532/badge.svg)](https://semaphoreci.com/ged/arborist)
+
 
 ## Prerequisites
 
@@ -44,7 +53,7 @@ and generate the API documentation.
 
 ## License
 
-Copyright (c) 2015, Michael Granger and Mahlon E. Smith
+Copyright (c) 2015-2016, Michael Granger and Mahlon E. Smith
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Rakefile

@@ -20,7 +20,7 @@ hoespec = Hoe.spec 'arborist' do |spec|
 	spec.readme_file = 'README.md'
 	spec.history_file = 'History.md'
 	spec.extra_rdoc_files = FileList[ '*.rdoc', '*.md' ]
-	self.license 'BSD-3-Clause'
+	spec.license 'BSD-3-Clause'
 	spec.urls = {
 		home:   'http://deveiate.org/projects/arborist',
 		code:   'http://bitbucket.org/ged/arborist',
@@ -46,7 +46,7 @@ hoespec = Hoe.spec 'arborist' do |spec|
 	spec.require_ruby_version( '>=2.2.0' )
 	spec.hg_sign_tags = true if spec.respond_to?( :hg_sign_tags= )
 
-	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
+	spec.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
 end
 
 
@@ -66,6 +66,20 @@ task :coverage do
 end
 
 
+# Use the fivefish formatter for docs generated from development checkout
+if File.directory?( '.hg' )
+	require 'rdoc/task'
+
+	Rake::Task[ 'docs' ].clear
+	RDoc::Task.new( 'docs' ) do |rdoc|
+	    rdoc.main = "README.md"
+	    rdoc.rdoc_files.include( "*.rdoc", "*.md", "ChangeLog", "lib/**/*.rb" )
+	    rdoc.generator = :fivefish
+		rdoc.title = 'Arborist'
+	    rdoc.rdoc_dir = 'doc'
+	end
+end
+
 task :gemspec => GEMSPEC
 file GEMSPEC => __FILE__ do |task|
 	spec = $hoespec.spec

data/TODO.md

@@ -5,6 +5,7 @@
 * Serialize nodes on shutdown
 * Include a node's subscriptions in its serialized data
 * Implement loading/reloading nodes. 
+* Implement the system events (sys.acked, sys.reloaded, etc.)
 
 ## Tree API
 
@@ -21,4 +22,12 @@
 
 ## Node
 
-* Add a 'disabled' state, can be set on 'up' nodes by acking them.
+* Allow (require?) node types to specify what kinds of nodes can be
+  their parent, and also adds the constructor DSL method to it
+
+
+## Setup/Installation
+
+* Add a CLI for generating a basic setup and then adding 
+  nodes/monitors/observers to it.
+

data/Tutorial.md

@@ -0,0 +1,8 @@
+# Arborist Tutorial
+
+Sorry, we're still building. We'll flesh this out once we get the software
+stable and work out the kinks.
+
+In the meantime, feel free to come chat us up in the
+[Arborist Gitter channel](https://gitter.im/ged/arborist).
+

data/bin/arborist

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# vim: set nosta noet ts=4 sw=4:
+
+require 'arborist'
+require 'arborist/cli'
+
+Arborist::CLI.run( ARGV.dup )
+

data/lib/arborist.rb

@@ -17,7 +17,7 @@ module Arborist
 	VERSION = '0.0.1'
 
 	# Version control revision
-	REVISION = %q$Revision: fddcbace9b6d $
+	REVISION = %q$Revision: e23d2b9f8f31 $
 
 
 	# The name of the environment variable which can be used to set the config path
@@ -111,11 +111,10 @@ module Arborist
 	end
 
 
-	### Return a new Arborist::Manager for the nodes described in files under
-	### the specified +directory+.
-	def self::manager_for( directory )
+	### Return a new Arborist::Manager for the nodes loaded by the specified +loader+.
+	def self::manager_for( loader )
 		self.load_all
-		nodes = Arborist::Node.each_in( directory )
+		nodes = Arborist::Node.each_in( loader )
 		manager = Arborist::Manager.new
 		manager.load_tree( nodes )
 
@@ -124,10 +123,10 @@ module Arborist
 
 
 	### Return a new Arborist::MonitorRunner for the monitors described in files under
-	### the specified +directory+.
-	def self::monitor_runner_for( directory )
+	### the specified +loader+.
+	def self::monitor_runner_for( loader )
 		self.load_all
-		monitors = Arborist::Monitor.each_in( directory )
+		monitors = Arborist::Monitor.each_in( loader )
 		runner = Arborist::MonitorRunner.new
 		runner.load_monitors( monitors )
 
@@ -136,10 +135,10 @@ module Arborist
 
 
 	### Return a new Arborist::ObserverRunner for the observers described in files under
-	### the specified +directory+.
-	def self::observer_runner_for( directory )
+	### the specified +loader+.
+	def self::observer_runner_for( loader )
 		self.load_all
-		observers = Arborist::Observer.each_in( directory )
+		observers = Arborist::Observer.each_in( loader )
 		runner = Arborist::ObserverRunner.new
 		runner.load_observers( observers )
 
@@ -171,11 +170,13 @@ module Arborist
 
 	autoload :Client, 'arborist/client'
 	autoload :Event, 'arborist/event'
+	autoload :Loader, 'arborist/loader'
 	autoload :Manager, 'arborist/manager'
 	autoload :Monitor, 'arborist/monitor'
 	autoload :MonitorRunner, 'arborist/monitor_runner'
 	autoload :Node, 'arborist/node'
 	autoload :Observer, 'arborist/observer'
+	autoload :ObserverRunner, 'arborist/observer_runner'
 	autoload :Subscription, 'arborist/subscription'
 
 end # module Arborist

data/lib/arborist/cli.rb

@@ -0,0 +1,380 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'loggability'
+require 'highline'
+require 'gli'
+
+require 'arborist' unless defined?( Arborist )
+require 'arborist/mixins'
+
+
+# The command-line interface to Arborist.
+module Arborist::CLI
+	extend Arborist::MethodUtilities,
+	       Loggability,
+	       GLI::App
+
+
+	# Write logs to Arborist's logger
+	log_to :arborist
+
+
+	# Make a HighLine color scheme
+	COLOR_SCHEME = HighLine::ColorScheme.new do |scheme|
+		scheme[:header]    = [ :bold, :yellow ]
+		scheme[:subheader] = [ :bold, :white ]
+		scheme[:key]       = [ :white ]
+		scheme[:value]     = [ :bold, :white ]
+		scheme[:error]     = [ :red ]
+		scheme[:warning]   = [ :yellow ]
+		scheme[:message]   = [ :reset ]
+	end
+
+
+	#
+	# GLI
+	#
+
+	# Set up global[:description] and options
+	program_desc 'Arborist'
+
+	# The command version
+	version Arborist::VERSION
+
+	# Use an OpenStruct for options instead of a Hash
+	use_openstruct( true )
+
+	# Subcommand options are independent of global[:ones]
+	subcommand_option_handling :normal
+
+	# Strict argument validation
+	arguments :strict
+
+
+	# Custom parameter types
+	accept Array do |value|
+		value.strip.split(/\s*,\s*/)
+	end
+	accept Pathname do |value|
+		Pathname( value.strip )
+	end
+
+
+	# Global options
+	desc "Specify the config file to load"
+	flag [:c, :config], type: Pathname
+
+	desc 'Enable debugging output'
+	switch [:d, :debug]
+
+	desc 'Enable verbose output'
+	switch [:v, :verbose]
+
+	desc 'Set log level to LEVEL (one of %s)' % [Loggability::LOG_LEVELS.keys.join(', ')]
+	default_value Loggability[self].level
+	flag [:l, :loglevel], must_match: Loggability::LOG_LEVELS.keys
+
+	desc "Don't actually do anything, just show what would happen."
+	switch [:n, 'dry-run']
+
+	desc "Additional Ruby libs to require before doing anything."
+	flag [:r, 'requires'], type: Array
+
+
+	#
+	# GLI Event callbacks
+	#
+
+	pre do |global, command, options, args|
+		if loglevel = global[:loglevel]
+			Loggability.level = loglevel.to_sym
+		else
+			Loggability.level = :fatal
+		end
+
+		# Include a 'lib' directory if there is one
+		$LOAD_PATH.unshift( 'lib' ) if File.directory?( 'lib' )
+
+		self.require_additional_libs( global.requires ) if global.requires
+		self.load_config( global )
+		self.install_highline_colorscheme
+
+		true
+	end
+
+
+	##
+	# Registered subcommand modules
+	singleton_attr_accessor :subcommand_modules
+
+	##
+	# The IO opened to the output file
+	singleton_attr_accessor :outfile
+
+
+	### Overridden -- Add registered subcommands immediately before running.
+	def self::run( * )
+		self.add_registered_subcommands
+		super
+	end
+
+
+	### Add the specified +mod+ule containing subcommands to the 'arborist' command.
+	def self::register_subcommands( mod )
+		self.subcommand_modules ||= []
+		self.subcommand_modules.push( mod )
+		mod.extend( GLI::DSL, GLI::AppSupport, Loggability )
+		mod.log_to( :arborist )
+	end
+
+
+	### Add the commands from the registered subcommand modules.
+	def self::add_registered_subcommands
+		self.subcommand_modules ||= []
+		self.subcommand_modules.each do |mod|
+			merged_commands = mod.commands.merge( self.commands )
+			self.commands.update( merged_commands )
+			command_objs = self.commands_declaration_order | self.commands.values
+			self.commands_declaration_order.replace( command_objs )
+		end
+	end
+
+
+	### Return the HighLine prompt used by the command to communicate with the
+	### user.
+	def self::prompt
+		@prompt ||= HighLine.new( $stdin, $stderr )
+	end
+
+
+	### If the command's output was redirected to a file, return the open File object
+	### for it.
+	def self::outfile
+		return @outfile
+	end
+
+
+	### Discard the existing HighLine prompt object if one existed. Mostly useful for
+	### testing.
+	def self::reset_prompt
+		@prompt = nil
+	end
+
+
+	### Load any additional Ruby libraries given with the -r global option.
+	def self::require_additional_libs( requires)
+		requires.each do |path|
+			path = "arborist/#{path}" unless path.start_with?( 'arborist/' )
+			require( path )
+		end
+	end
+
+
+	### Install the color scheme used by HighLine
+	def self::install_highline_colorscheme
+		HighLine.color_scheme = HighLine::ColorScheme.new do |cs|
+			cs[:headline]   = [ :bold, :white, :on_black ]
+			cs[:success]    = [ :bold, :green ]
+			cs[:error]      = [ :bold, :red ]
+			cs[:up]         = [ :green ]
+			cs[:down]       = [ :red ]
+			cs[:unknown]    = [ :dark, :yellow ]
+			cs[:disabled]   = [ :dark, :white ]
+			cs[:acked]      = [ :yellow ]
+			cs[:highlight]  = [ :bold, :yellow ]
+			cs[:search_hit] = [ :black, :on_white ]
+			cs[:prompt]     = [ :cyan ]
+			cs[:even_row]   = [ :bold ]
+			cs[:odd_row]    = [ :normal ]
+		end
+	end
+
+
+	### Load the config file using either arborist-base's config-loader if available, or
+	### fall back to DEFAULT_CONFIG_FILE
+	def self::load_config( global={} )
+		Arborist.load_config( global.config ) if global.config
+
+		# Set up the logging formatter
+		Loggability.format_with( :color ) if $stdout.tty?
+	end
+
+
+	### Set up the output levels and globals based on the associated +global+ options.
+	def self::setup_output( global )
+
+		# Turn on Ruby debugging and/or verbosity if specified
+		if global[:n]
+			$DRYRUN = true
+			Loggability.level = :warn
+		else
+			$DRYRUN = false
+		end
+
+		if global[:verbose]
+			$VERBOSE = true
+			Loggability.level = :info
+		end
+
+		if global[:debug]
+			$DEBUG = true
+			Loggability.level = :debug
+		end
+	end
+
+
+	# Write the error to the log on exceptions.
+	on_error do |exception|
+		case exception
+		when OptionParser::ParseError, GLI::CustomExit
+			self.log.debug( exception )
+		else
+			self.log.error( exception )
+		end
+
+		exception.backtrace.each {|frame| self.log.debug(frame) }
+
+		true
+	end
+
+
+	#
+	# GLI subcommands
+	#
+
+
+	# Convenience module for subcommand registration syntax sugar.
+	module Subcommand
+
+		### Extension callback -- register the extending object as a subcommand.
+		def self::extended( mod )
+			Arborist::CLI.log.debug "Registering subcommands from %p" % [ mod ]
+			Arborist::CLI.register_subcommands( mod )
+		end
+
+
+		###############
+		module_function
+		###############
+
+		### Exit with the specified +exit_code+ after printing the given +message+.
+		def exit_now!( message, exit_code=1 )
+			raise GLI::CustomExit.new( message, exit_code )
+		end
+
+
+		### Exit with a helpful +message+ and display the usage.
+		def help_now!( message=nil )
+			exception = OptionParser::ParseError.new( message )
+			def exception.exit_code; 64; end
+
+			raise exception
+		end
+
+
+		### Get the prompt (a Highline object)
+		def prompt
+			return Arborist::CLI.prompt
+		end
+
+
+		### Return the specified +text+ as a Highline::String for convenient formatting,
+		### color, etc.
+		def hl( text )
+			return HighLine::String.new( text.to_s )
+		end
+
+
+		### Return the specified +string+ in the 'headline' ANSI color.
+		def headline_string( string )
+			return hl( string ).color( :headline )
+		end
+
+
+		### Return the specified +string+ in the 'highlight' ANSI color.
+		def highlight_string( string )
+			return hl( string ).color( :highlight )
+		end
+
+
+		### Return the specified +string+ in the 'success' ANSI color.
+		def success_string( string )
+			return hl( string ).color( :success )
+		end
+
+
+		### Return the specified +string+ in the 'error' ANSI color.
+		def error_string( string )
+			return hl( string ).color( :error )
+		end
+
+
+		### Output a table with the given +rows+.
+		def display_table( rows )
+			colwidths = rows.transpose.map do |colvals|
+				colvals.map {|val| visible_chars(val) }.max
+			end
+
+			rows.each do |row|
+				row_string = row.zip( colwidths ).inject( '' ) do |accum, (val, colsize)|
+					padding = ' ' * (colsize - visible_chars(val) + 2)
+					accum + val.to_s + padding
+				end
+
+				Arborist::CLI.prompt.say( row_string + "\n" )
+			end
+		end
+
+
+		### Return the count of visible (i.e., non-control) characters in the given +string+.
+		def visible_chars( string )
+			return string.to_s.gsub(/\e\[.*?m/, '').scan( /\P{Cntrl}/ ).size
+		end
+
+
+		### In dry-run mode, output the description instead of running the provided block and
+		### return the +return_value+.
+		### If dry-run mode is not enabled, yield to the block.
+		def unless_dryrun( description, return_value=true )
+			if $DRYRUN
+				self.log.warn( "DRYRUN> #{description}" )
+				return return_value
+			else
+				return yield
+			end
+		end
+		alias_method :unless_dry_run, :unless_dryrun
+
+	end # module Subcommand
+
+
+	### Register one or more subcommands with the 'arborist' command shell. The given
+	### block will be evaluated in the context of Arborist::CLI.
+	def self::register( &block )
+		self.instance_eval( &block )
+	end
+
+
+	### Custom command loader. The default one is silly.
+	def self::load_commands( path )
+		self.log.debug "Load commands from %s" % [ path ]
+		Pathname.glob( path + '*.rb' ).each do |rbfile|
+			self.log.debug "  loading %s..." % [ rbfile ]
+			require( rbfile )
+		end
+	end
+
+
+	# Load commands from any files in the specified directory relative to LOAD_PATHs
+	def self::commands_from( subdir )
+		$LOAD_PATH.map {|path| Pathname(path) }.each do |libdir|
+			command_dir = libdir.expand_path + subdir
+			load_commands( command_dir )
+		end
+	end
+
+
+	commands_from 'arborist/command'
+
+end # class Arborist::CLI