strelka 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23f3a2bf90987379d646fd64f813d403057ba894
-  data.tar.gz: 7df48c8764cf88fc8e357fd6d4e70ab84bc7af9d
+  metadata.gz: 4def250c1b369dbb9c80a1ed8a928e2e83d6dd70
+  data.tar.gz: 12db351245be50c0d822072c7b1b28fc6f4b152b
 SHA512:
-  metadata.gz: f0d5356fbb5c03eccdb77d055796a6b120aabfd8702a590725b16b8b9446a42ad157fdd05841e96ab761ce91e74bdb8ade89893c4365d4cb5b7f34bc698f2ac1
-  data.tar.gz: 6993272bb47fd7874689853b7439b70581b27788ab3b1195125180eedca958bdc9a4e25bef06bf7d3587ea331dd70fd09d2d5a565fca256e2ec92b546679160b
+  metadata.gz: ee7ccc09f871ef0d019d61b6ed090ea2f296316d0000d803bca487345ce16293852141db9c21a743596ac0208f16ac82128f73c241ae9542308c4cade34eb699
+  data.tar.gz: 761861faeb03a911d6efba3a88d674948bd954ec47bc173fe5ed5d371d2535669292ab8d5d7f9b8d4e8351c4c8f32af105d2788a5ce060cd61edc9b7b7acfb7d

data/History.rdoc

@@ -1,3 +1,11 @@
+== v0.12.0 [2016-11-03] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Rewritten command line interface
+- Rewritten app-discovery system
+
+
 == v0.11.0 [2016-01-20] Mahlon E. Smith <mahlon@martini.nu>
 
 Enhancements:

data/Manifest.txt

@@ -54,6 +54,10 @@ lib/strelka/authprovider.rb
 lib/strelka/authprovider/basic.rb
 lib/strelka/authprovider/hostaccess.rb
 lib/strelka/behavior/plugin.rb
+lib/strelka/cli.rb
+lib/strelka/command/config.rb
+lib/strelka/command/discover.rb
+lib/strelka/command/start.rb
 lib/strelka/constants.rb
 lib/strelka/cookie.rb
 lib/strelka/cookieset.rb
@@ -107,6 +111,7 @@ spec/strelka/app_spec.rb
 spec/strelka/authprovider/basic_spec.rb
 spec/strelka/authprovider/hostaccess_spec.rb
 spec/strelka/authprovider_spec.rb
+spec/strelka/cli_spec.rb
 spec/strelka/cookie_spec.rb
 spec/strelka/cookieset_spec.rb
 spec/strelka/discovery_spec.rb

data/README.rdoc

@@ -20,7 +20,7 @@ Her name means "little arrow".
 == Prerequisites
 
 * Mongrel2[http://mongrel2.org/] 1.8.0 or better
-* Ruby 1.9.3 or better
+* Ruby 2.2 or better
 
 
 == Installation
@@ -142,6 +142,29 @@ you see the text "Hello, World!", congrats!  We'll build off of this in the
 next section, the {Strelka Tutorial}[rdoc-ref:Tutorial.rdoc].
 
 
+=== Packaging
+
+If you want your app to be launchable via the <tt>strelka</tt> command, you can
+do so by registering it with the Strelka::Discovery module. For instance, if
+your app is defined in a file called <tt>lib/acme/store.rb</tt> and you want to
+start it with the command
+
+    strelka start acme-store
+
+then you'd do something like:
+
+    require 'strelka/discovery'
+    Strelka::Discovery.register_app( 'acme-store', 'acme/store.rb' )
+
+If you want the app to be launchable directory from the gem, you can put the
+above discovery code in a file named <code>lib/strelka/apps.rb</code> to your
+gem. The `strelka` command will load all of those files from any installed gems
+before running <tt>start</tt>. You can test to see which apps are discoverable
+this way using the <tt>strelka discover</tt> command.
+
+See Strelka::Discovery for more info.
+
+
 == Further Reading
 
 You'll likely want to start with {the Tutorial}[rdoc-ref:Tutorial.rdoc].
@@ -161,14 +184,6 @@ Here's a tentative list of what kinds of stuff we have planned:
   headers, especially for service applications
 * caching -- utilities for easy HTTP caching
 
-=== Deployment/Packaging
-
-You'll be able to package up your applications as Rubygems for easy deployment.
-The Strelka::App class already supports application discovery, but we
-want to hook that up to the 'strelka' command line tool so you can install
-and run them with a minimum of manual monkeying around with directories,
-migrations, etc.
-
 === New Application Styles
 
 Create some new handler classes for different application styles, similar to
@@ -195,7 +210,7 @@ and generate the API documentation.
 
 == License
 
-Copyright (c) 2011-2013, Michael Granger and Mahlon E. Smith
+Copyright (c) 2011-2016, Michael Granger and Mahlon E. Smith
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Rakefile

@@ -30,7 +30,7 @@ hoespec = Hoe.spec 'strelka' do
 	self.dependency 'highline',        '~> 1.6'
 	self.dependency 'inversion',       '~> 0.12'
 	self.dependency 'loggability',     '~> 0.9'
-	self.dependency 'mongrel2',        ['~> 0.43', '>= 0.43.1']
+	self.dependency 'mongrel2',        '~> 0.44'
 	self.dependency 'pluggability',    '~> 0.4'
 	self.dependency 'sysexits',        '~> 1.1'
 	self.dependency 'trollop',         '~> 2.0'
@@ -42,7 +42,7 @@ hoespec = Hoe.spec 'strelka' do
 	self.dependency 'simplecov',               '~> 0.7',  :developer
 	self.dependency 'rdoc-generator-fivefish', '~> 0.1',  :developer
 
-	self.require_ruby_version( '>=2.0.0' )
+	self.require_ruby_version( '>=2.2.0' )
 	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
 	self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )
 	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"

data/bin/strelka

@@ -2,416 +2,7 @@
 # vim: set nosta noet ts=4 sw=4:
 
 require 'strelka'
-require 'strelka/discovery'
+require 'strelka/cli'
 
-require 'trollop'
-require 'highline'
-require 'loggability'
-
-# Have to do it this way to avoid the vendored 'sysexits' under OSX.
-gem 'sysexits'
-require 'sysexits'
-
-
-# A tool for setting up and running Strelka apps
-class Strelka::CLICommand
-	extend ::Sysexits,
-	       Loggability
-	include Sysexits,
-	        Strelka::Constants
-
-
-	# Write logs to Strelka's logger
-	log_to :strelka
-
-
-	# 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
-
-
-	# Class instance variables
-	@command_help = Hash.new {|h,k| h[k] = { :desc => nil, :usage => ''} }
-	@prompt = @option_parser = nil
-
-
-	### Run the utility with the given +args+.
-	def self::run( args )
-		HighLine.color_scheme = COLOR_SCHEME
-
-		oparser = self.make_option_parser
-		opts = Trollop.with_standard_exception_handling( oparser ) do
-			oparser.parse( args )
-		end
-
-		command = oparser.leftovers.shift
-		self.new( opts ).run( command, *oparser.leftovers )
-		exit :ok
-
-	rescue => err
-		self.log.fatal "Oops: %s: %s" % [ err.class.name, err.message ]
-		self.log.debug { '  ' + err.backtrace.join("\n  ") }
-
-		exit :software_error
-	end
-
-
-	### Return a String that describes the available commands, e.g., for the 'help'
-	### command.
-	def self::make_command_table
-		commands = self.available_commands
-
-		# Build the command table
-		col1len = commands.map( &:length ).max
-		return commands.collect do |cmd|
-			helptext = self.help( cmd.to_sym ) or next # no help == invisible command
-			"%s  %s" % [
-				self.prompt.color(cmd.rjust(col1len), :key),
-				self.prompt.color(helptext, :value)
-			]
-		end.compact
-	end
-
-
-	### Return an Array of the available commands.
-	def self::available_commands
-		return self.public_instance_methods( false ).
-			map( &:to_s ).
-			grep( /_command$/ ).
-			map {|methodname| methodname.sub(/_command$/, '') }.
-			sort
-	end
-
-
-	### Create and configure a command-line option parser for the command.
-	### Returns a Trollop::Parser.
-	def self::make_option_parser
-		unless @option_parser
-			progname = File.basename( $0 )
-
-			# Make a list of the log level names and the available commands
-			loglevels = Loggability::LOG_LEVELS.
-				sort_by {|name,lvl| lvl }.
-				collect {|name,lvl| name.to_s }.
-				join( ', ' )
-			command_table = self.make_command_table
-			commands = self.available_commands
-
-			@option_parser = Trollop::Parser.new do
-				banner "Manage Strelka apps"
-				version( Strelka.version_string(true) )
-
-				stop_on( commands )
-
-				text ''
-				command_table.each {|line| text(line) }
-				text ''
-
-				text 'Global Options'
-				opt :config, "Specify the config file to load.", :type => :string
-				opt :datadir, "Override the Strelka data directory.", :type => :string,
-					:short => :D
-				opt :requires, "Specify additional libraries to require.", :type => :strings,
-					:short => :r
-				text ''
-
-				text 'Other Options:'
-				opt :debug, "Turn debugging on. Also sets the --loglevel to 'debug'."
-				opt :loglevel, "Set the logging level. Must be one of: #{loglevels}",
-					:default => Strelka.logger.level.to_s
-			end
-		end
-
-		return @option_parser
-	end
-
-
-	### Add a help string for the given +command+.
-	def self::help( command, helpstring=nil )
-		if helpstring
-			@command_help[ command.to_sym ][:desc] = helpstring
-		end
-
-		return @command_help[ command.to_sym ][:desc]
-	end
-
-
-	### Add/fetch the +usagestring+ for +command+.
-	def self::usage( command, usagestring=nil )
-		if usagestring
-			prefix = usagestring[ /\A(\s+)/, 1 ]
-			usagestring.gsub!( /^#{prefix}/m, '' ) if prefix
-
-			@command_help[ command.to_sym ][:usage] = usagestring
-		end
-
-		return @command_help[ command.to_sym ][:usage]
-	end
-
-
-	### Return the global Highline prompt object, creating it if necessary.
-	def self::prompt
-		unless @prompt
-			@prompt = HighLine.new
-
-			columns = @prompt.output_cols.nonzero? || 80
-			rows    = @prompt.output_rows.nonzero? || 1000
-
-			@prompt.page_at = rows - 5
-			@prompt.wrap_at = columns - 2
-		end
-
-		return @prompt
-	end
-
-
-	#################################################################
-	###	I N S T A N C E   M E T H O D S
-	#################################################################
-
-	### Create a new instance of the command and set it up with the given
-	### +options+.
-	def initialize( options )
-		Loggability.format_with( :color ) if $stderr.tty?
-		@options = options
-
-		if @options.debug
-			$DEBUG = true
-			$VERBOSE = true
-			Loggability.level = :debug
-		elsif @options.loglevel
-			Loggability.level = @options.loglevel
-		end
-
-	end
-
-
-	######
-	public
-	######
-
-	# The Trollop options hash the command will read its configuration from
-	attr_reader :options
-
-
-	# Delegate the instance #prompt method to the class method instead
-	define_method( :prompt, &self.method(:prompt) )
-
-
-	### Run the command with the specified +command+ and +args+.
-	def run( command, *args )
-		command ||= 'help'
-		cmd_method = nil
-
-		# Set the datadir override if it's given
-		if self.options.datadir
-			self.log.debug "Using data dir option: %s" % [ self.options.datadir ]
-			Strelka::Discovery.local_data_dirs = Pathname( self.options.datadir )
-		end
-
-		# Include a 'lib' directory if there is one
-		$LOAD_PATH.unshift( 'lib' ) if File.directory?( 'lib' )
-
-		# Run the command
-		begin
-			cmd_method = self.method( "#{command}_command" )
-		rescue NameError => err
-			error "No such command %p" % [ command ]
-			exit :usage
-		end
-
-		cmd_method.call( *args )
-	end
-
-
-	#
-	# Commands
-	#
-
-	### The 'help' command
-	def help_command( *args )
-
-		# Subcommand help
-		if !args.empty?
-			command = args.shift
-
-			if self.class.available_commands.include?( command )
-				header( self.class.help(command) )
-				desc = "\n" + 'Usage: ' + command + ' ' + self.class.usage(command) + "\n"
-				message( desc )
-			else
-				error "No such command %p" % [ command ]
-			end
-
-		# Help by itself show the table of available commands
-		else
-			command_table = self.class.make_command_table
-			header "Available Commands"
-			message( *command_table )
-		end
-
-	end
-	help :help, "Show help for a single COMMAND if given, or list available commands if not"
-	usage :help, "[COMMAND]"
-
-
-	### The 'discover' command
-	def discover_command( *args )
-		header "Searching for Strelka applications..."
-
-		self.load_additional_requires
-
-		paths = Strelka::Discovery.discover_paths
-		if paths.empty?
-			message "None found."
-		else
-			paths.each do |gemname, paths|
-				message "\n"
-
-				if gemname == ''
-					subheader "Local: "
-				else
-					subheader "Gem: #{gemname}"
-				end
-
-				filenames = paths.map {|path| path.basename.to_s }
-				list( filenames )
-			end
-		end
-	end
-	help :discover, "Show available Strelka applications installed as gems."
-
-
-	### The 'setup' command
-	def setup_command( *args )
-	end
-	help :setup, "Set up a new Strelka environment and start the admin server."
-
-
-	### The 'start' command
-	def start_command( *args )
-		appname = args.pop
-		gemname = args.pop
-		path    = nil
-
-		if File.exist?( appname )
-			header "Starting %s." % [ appname ]
-			path = appname
-		else
-			path, gemname = Strelka::Discovery.find( appname, gemname )
-
-			header "Starting the %s app%s" % [
-				appname,
-				gemname == '' ? '' : " from the #{gemname} gem"
-			]
-		end
-
-		apps = Strelka::Discovery.load( path )
-		Strelka.load_config( self.options.config ) if self.options.config
-		self.log.debug "  loaded: %p" % [ apps ]
-
-		self.load_additional_requires
-
-		apps.first.run
-	end
-	help :start, "Start a Strelka app"
-
-
-	### The 'version' command
-	def version_command( *args )
-		message( "<%= color 'Version:', :header %> " + Mongrel2.version_string(true) )
-	end
-	help :version, "Prints the Ruby-Mongrel2 version."
-
-
-	### The 'config' command
-	def config_command( *args )
-		gemname = args.shift
-		discovery_name = gemname || ''
-
-		header "Dumping config for %s" % [ gemname || 'local apps' ]
-		discovered_apps = Strelka::Discovery.discover_paths
-
-		raise ArgumentError, "No apps discovered" unless discovered_apps.key?( discovery_name )
-
-		discovered_apps[ discovery_name ].each do |apppath|
-			message "  loading %s (%s)" % [ apppath, apppath.basename('.rb') ]
-			Strelka::Discovery.load( apppath )
-		end
-
-		self.load_additional_requires
-
-		message "  dumping config:"
-		$stdout.puts Configurability.default_config.dump
-	end
-	help :config, "Dump the configuration for GEMNAME (or the local directory if no gem is specified)"
-	usage :config, "[GEMNAME]"
-
-
-	### The 'version' command
-	def version_command( *args )
-		message( "<%= color 'Version:', :header %> " + Mongrel2.version_string(true) )
-	end
-	help :version, "Prints the Ruby-Mongrel2 version."
-
-
-	#
-	# Helper methods
-	#
-
-	### Load any requires added to the command via the '-r' option.
-	def load_additional_requires
-		return unless self.options.requires
-
-		self.log.debug "  loading additional requires: %p" % [ self.options.requires ]
-		self.options.requires.each do |lib|
-			require( lib )
-		end
-	end
-
-
-	#
-	# Utility methods
-	#
-
-	### Output normal output
-	def message( *parts )
-		self.prompt.say( parts.map(&:to_s).join($/) )
-	end
-
-
-	### Output the given +text+ highlighted as a header.
-	def header( text )
-		message( self.prompt.color(text, :header) )
-	end
-
-
-	### Output the given +text+ highlighted as a subheader.
-	def subheader( text )
-		message( self.prompt.color(text, :subheader) )
-	end
-
-
-	### Output the given +text+ highlighted as an error.
-	def error( text )
-		message( self.prompt.color(text, :error) )
-	end
-
-
-	### Output the given +items+ as a columnar list.
-	def list( *items )
-		message( self.prompt.list(items.flatten.compact.map(&:to_s), :columns_down) )
-	end
-
-end # class Strelka::CLICommand
-
-
-Strelka::CLICommand.run( ARGV.dup )
+Strelka::CLI.run( ARGV.dup )