servitude 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11b7ea1e73f25eb1270966889eb4341dd269657a
-  data.tar.gz: ab47729667a4604e5fb23bd1976b160d96d7b6e8
+  metadata.gz: 9d92cd3bbaeb18254224bf3d04c90ef1076d16d6
+  data.tar.gz: d821dac504ebe7db88da0d37566908f5625b3e48
 SHA512:
-  metadata.gz: c13a26dda70ac70166e95038910e07692809df93cd82ec8b348b863a5fff729acdc5c8df004ed922f7c7f234b93779b7b58aff0de6e750125e480519bd0b0589
-  data.tar.gz: f7cb8d3b33788691a07f726db705d15a18adb5699ce545e9803e72af6210131be950f579f4a586dd2faf1bbef7f776684e92368373354dbd8d098ea0132281cc
+  metadata.gz: 225a9fe42a13c8114c2574596a7a9540ccbc2e3a191e7b2a2fb53335ecf53f03ca8a62db6a4afddc1fc70ddf5470173f2c024d9bfa8bde11acc0de098b003a82
+  data.tar.gz: 734f32e55b8eb623eca14dad76e552b6ae6ef9c1e757c9bfcdedbbec2ea5677e7d5aa3d631e5b1f1eba12600aa998faf6d52fac538b830008a1be22b636d10ec

data/README.md

@@ -20,8 +20,6 @@ Or install it yourself as:
 
 ## Usage
 
-For executable examples see the [examples folder](https://github.com/midas/servitude/tree/master/examples).
-
 To build a server with Servitude only a couple of steps are required.
 
 * Include the Servitude::Base module in the base module of your server project.
@@ -30,7 +28,8 @@ To build a server with Servitude only a couple of steps are required.
 * If a single threaded server, implement your functionality in the Server#run method.
 * If a multi-threaded server, implement your functionality in a handler class that includes the Servitude::Actor module and call the handler from the Server#run method.
 
-For more details see the examples folder.
+For executable examples see the [examples folder](https://github.com/midas/servitude/tree/master/examples).  To run the examples, clone the project, 
+install the bundle and follow the usage instructions in each example.
 
 The rest of this document will discuss the functionality each module provides.
 
@@ -79,11 +78,11 @@ If you do not call ::boot, an error is raised before your server can be started.
 
 ### Servitude::Cli
 
-The Cli module provides the functionality of a Command Line Interface for your server.
+The Cli module provides several classes with Command Line Interface functionality for your server.  The Cli::Service class provides standard unix service
+sub-commands: start, stop, status and restart.
 
     module AwesomeServer
-      class Cli
-        include Servitude::Cli
+      class Cli < Servitude::Cli::Service
       end
     end
 
@@ -91,7 +90,17 @@ In your CLI file (bin/awesome-server):
 
     #!/usr/bin/env ruby
     require 'awesome_server'
-    AwesomeServer::Cli.new( ARGV ).run
+    AwesomeServer::Cli.start
+
+To build a custom CLI, you can inherit from Cli::Base.
+
+    module AwesomeServer
+      class Cli < Servitude::Cli::Base
+      end
+    end
+
+For details on how to add commands to your custom or standard service CLIs see the [Thor documentation](http://whatisthor.com/).
+
 
 ### Servitude::Configuration
 
@@ -258,7 +267,7 @@ The Server module provides callbacks to utilize in your server implementation:
 
 * __before_initialize__: executes just before the initilaization of the server
 * __after_initialize__: executes immediately after initilaization of the server
-* __before_run: executes just before the run method is called
+* __before_run__: executes just before the run method is called
 * __before_sleep__: executes just before the main thread sleeps to avoid exiting
 * __finalize__: executes before server exits
 

data/examples/3_echo_server_with_cli_and_daemon

@@ -3,8 +3,6 @@
 require 'rubygems'
 require 'servitude'
 require 'socket'
-require 'trollop'
-require 'pry'
 
 # The echo server accepts with CLI builds on the 2_echo_server example, addiing a command line interface.
 #
@@ -21,7 +19,7 @@ require 'pry'
 #
 # Usage:
 #   Help:
-#     bundle exec examples/3_echo_server_with_cli_and_daemon -h
+#     bundle exec examples/3_echo_server_with_cli_and_daemon help
 #
 #   Start (interactive):
 #     bundle exec examples/3_echo_server_with_cli_and_daemon start -i
@@ -52,10 +50,7 @@ module EchoServer
        default_thread_count: nil,
        version_copyright: "v#{VERSION} \u00A9#{Time.now.year} LFE"
 
-  class Cli
-
-    include Servitude::Cli
-
+  class Cli < Servitude::Cli::Service
   end
 
   class Server
@@ -95,4 +90,4 @@ module EchoServer
   end
 end
 
-EchoServer::Cli.new( ARGV ).run
+EchoServer::Cli.start

data/examples/4_echo_server_with_cli_daemon_and_file_config

@@ -3,8 +3,6 @@
 require 'rubygems'
 require 'servitude'
 require 'socket'
-require 'trollop'
-require 'pry'
 
 # The echo server accepts with CLI builds on the 2_echo_server example, addiing a command line interface.
 #
@@ -21,7 +19,7 @@ require 'pry'
 #
 # Usage:
 #   Help:
-#     bundle exec examples/4_echo_server_with_cli_daemon_and_config -h
+#     bundle exec examples/4_echo_server_with_cli_daemon_and_config help
 #
 #   Start (interactive):
 #     bundle exec examples/4_echo_server_with_cli_daemon_and_config start -i
@@ -52,10 +50,7 @@ module EchoServer
        default_thread_count: nil,
        version_copyright: "v#{VERSION} \u00A9#{Time.now.year} LFE"
 
-  class Cli
-
-    include Servitude::Cli
-
+  class Cli < Servitude::Cli::Service
   end
 
   class Server
@@ -95,4 +90,4 @@ module EchoServer
   end
 end
 
-EchoServer::Cli.new( ARGV ).run
+EchoServer::Cli.start

data/examples/5_echo_server_with_cli_daemon_and_env_config

@@ -3,8 +3,6 @@
 require 'rubygems'
 require 'servitude'
 require 'socket'
-require 'trollop'
-require 'pry'
 
 # The echo server accepts with CLI builds on the 2_echo_server example, addiing a command line interface.
 #
@@ -21,7 +19,7 @@ require 'pry'
 #
 # Usage:
 #   Help:
-#     bundle exec examples/5_echo_server_with_cli_daemon_and_env_config -h
+#     bundle exec examples/5_echo_server_with_cli_daemon_and_env_config help
 #
 #   Start (interactive):
 #     bundle exec examples/5_echo_server_with_cli_daemon_and_env_config start -i
@@ -60,10 +58,7 @@ module EchoServer
        default_thread_count: nil,
        version_copyright: "v#{VERSION} \u00A9#{Time.now.year} LFE"
 
-  class Cli
-
-    include Servitude::Cli
-
+  class Cli < Servitude::Cli::Service
   end
 
   class Server
@@ -111,4 +106,4 @@ module EchoServer
   end
 end
 
-EchoServer::Cli.new( ARGV ).run
+EchoServer::Cli.start

data/lib/servitude/cli/base.rb

@@ -0,0 +1,6 @@
+module Servitude
+  module Cli
+    class Base < Thor
+    end
+  end
+end

data/lib/servitude/cli/service.rb

@@ -0,0 +1,74 @@
+module Servitude
+  module Cli
+    class Service < Base
+
+      def self.environment_option
+        method_option :environment, desc: "The environment to execute in", type: :string, aliases: '-e'
+      end
+
+      def self.pid_option
+        method_option :pid, desc: "The path for the PID file", type: :string, default: Servitude::NS::DEFAULT_PID_PATH
+      end
+
+      def self.common_start_options
+        method_option :config, type: :string, aliases: '-c', desc: "The path for the config file", default: Servitude::NS::DEFAULT_CONFIG_PATH
+        environment_option
+        method_option :log_level, desc: "The log level", type: :string, aliases: '-o', default: 'info'
+        method_option :log, desc: "The path for the log file", type: :string, aliases: '-l', default: Servitude::NS::DEFAULT_LOG_PATH
+        method_option :threads, desc: "The number of threads", type: :numeric, aliases: '-t', default: Servitude::NS::DEFAULT_THREAD_COUNT
+      end
+
+      desc "restart", "Stop and start the server"
+      common_start_options
+      pid_option
+      def restart
+        stop
+        start_daemon
+      end
+
+      desc "start", "Start the server"
+      common_start_options
+      pid_option
+      method_option :interactive, type: :boolean, aliases: '-i', desc: "Start the server in interactive mode", default: false
+      def start
+        if options[:interactive]
+          start_interactive
+        else
+          start_daemon
+        end
+      end
+
+      no_commands do
+
+        def start_interactive
+          server = Servitude::NS::Server.new( options.merge( use_config: Servitude::NS::USE_CONFIG, log: 'STDOUT' ))
+          server.start
+        end
+
+        def start_daemon
+          server = Servitude::Daemon.new( options.merge( use_config: Servitude::NS::USE_CONFIG ))
+          server.start
+        end
+
+      end
+
+      desc "status", "Check the status of the server daemon"
+      pid_option
+      def status
+        Servitude::Daemon.new( options.merge( use_config: Servitude::NS::USE_CONFIG )).status
+      end
+
+      desc "stop", "Stop the server daemon"
+      pid_option
+      def stop
+        server = Servitude::Daemon.new( options.merge( use_config: Servitude::NS::USE_CONFIG ))
+        server.stop
+      end
+
+      def self.handle_no_command_error( name )
+        puts "Unrecognized command: #{name}"
+      end
+
+    end
+  end
+end

data/lib/servitude/cli.rb

@@ -1,135 +1,14 @@
 require 'rubygems'
 require 'servitude'
-require 'trollop'
+require 'thor'
 require 'yell'
 
+
 module Servitude
   module Cli
 
-    def self.included( base )
-      base.class_eval do
-        attr_reader :cmd,
-                    :options
-      end
-    end
-
-    SUB_COMMANDS = %w(
-      restart
-      start
-      status
-      stop
-    )
-
-    def initialize( args )
-      unless Servitude.boot_called
-        raise 'You must call boot before starting server'
-      end
-
-      Trollop::options do
-        version Servitude::NS::VERSION_COPYRIGHT
-        banner <<-EOS
-#{Servitude::NS::APP_NAME} #{Servitude::NS::VERSION_COPYRIGHT}
-
-Usage:
-  #{Servitude::NS::APP_ID} [command] [options]
-
-  commands:
-#{SUB_COMMANDS.map { |sub_cmd| "    #{sub_cmd}" }.join( "\n" )}
-
-  (For help with a command: #{Servitude::NS::APP_ID} [command] -h)
-
-options:
-      EOS
-        stop_on SUB_COMMANDS
-      end
-
-      # Get the sub-command and its options
-      #
-      @cmd = ARGV.shift || ''
-      @options = case( cmd )
-        when ''
-          Trollop::die 'No command provided'
-        when "restart"
-          Trollop::options do
-            opt :config, "The path for the config file", :type => String, :short => '-c', :default => Servitude::NS::DEFAULT_CONFIG_PATH
-            opt :environment, "The log level", :type => String, :short => '-e'
-            opt :log_level, "The log level", :type => String, :default => 'info', :short => '-o'
-            opt :log, "The path for the log file", :type => String, :short => '-l', :default => Servitude::NS::DEFAULT_LOG_PATH
-            opt :pid, "The path for the PID file", :type => String, :default => Servitude::NS::DEFAULT_PID_PATH
-            opt :threads, "The number of threads", :type => Integer, :default => Servitude::NS::DEFAULT_THREAD_COUNT, :short => '-t'
-          end
-        when "start"
-          Trollop::options do
-            opt :config, "The path for the config file", :type => String, :short => '-c', :default => Servitude::NS::DEFAULT_CONFIG_PATH
-            opt :environment, "The log level", :type => String, :short => '-e'
-            opt :interactive, "Execute the server in interactive mode", :short => '-i'
-            opt :log_level, "The log level", :type => String, :default => 'info', :short => '-o'
-            opt :log, "The path for the log file", :type => String, :short => '-l', :default => Servitude::NS::DEFAULT_LOG_PATH
-            opt :pid, "The path for the PID file", :type => String, :default => Servitude::NS::DEFAULT_PID_PATH
-            opt :threads, "The number of threads", :type => Integer, :default => Servitude::NS::DEFAULT_THREAD_COUNT, :short => '-t'
-          end
-        when "status"
-          Trollop::options do
-            opt :pid, "The path for the PID file", :type => String, :default => Servitude::NS::DEFAULT_PID_PATH
-          end
-        when "stop"
-          Trollop::options do
-            opt :pid, "The path for the PID file", :type => String, :default => Servitude::NS::DEFAULT_PID_PATH
-          end
-        else
-          Trollop::die "unknown command #{cmd.inspect}"
-        end
-
-      if cmd == 'start'
-        unless options[:interactive]
-          Trollop::die( :config, "is required when running as daemon" ) unless options[:config]
-          Trollop::die( :log, "is required when running as daemon" ) unless options[:log]
-          Trollop::die( :pid, "is required when running as daemon" ) unless options[:pid]
-        end
-      end
-
-      if %w(restart status stop).include?( cmd )
-        Trollop::die( :pid, "is required" ) unless options[:pid]
-      end
-    end
-
-    def run
-      send( cmd )
-    end
-
-  protected
-
-    def start
-      if options[:interactive]
-        start_interactive
-      else
-        start_daemon
-      end
-    end
-
-    def start_interactive
-      server = Servitude::NS::Server.new( options.merge( use_config: Servitude::NS::USE_CONFIG, log: 'STDOUT' ))
-      server.start
-    end
-
-    def start_daemon
-      server = Servitude::Daemon.new( options.merge( use_config: Servitude::NS::USE_CONFIG ))
-      server.start
-    end
-
-    def stop
-      server = Servitude::Daemon.new( options.merge( use_config: Servitude::NS::USE_CONFIG ))
-      server.stop
-    end
-
-    def restart
-      stop
-      start_daemon
-    end
-
-    def status
-      Servitude::Daemon.new( options.merge( use_config: Servitude::NS::USE_CONFIG )).status
-    end
+    autoload :Base,    'servitude/cli/base'
+    autoload :Service, 'servitude/cli/service'
 
   end
 end

data/lib/servitude/config_helper.rb

@@ -1,5 +1,3 @@
-require 'celluloid/autostart'
-
 module Servitude
   module ConfigHelper
 

data/lib/servitude/version.rb

@@ -1,3 +1,3 @@
 module Servitude
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/servitude.gemspec

@@ -28,6 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "hooks", "~> 0"
   spec.add_dependency "oj", "~> 2"
   spec.add_dependency "rainbow", "~> 2"
-  spec.add_dependency "trollop", "~> 2"
+  spec.add_dependency "thor"
   spec.add_dependency "yell", "~> 1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servitude
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jason Harrelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-12 00:00:00.000000000 Z
+date: 2014-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,19 +137,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: trollop
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yell
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +191,8 @@ files:
 - lib/servitude/actor.rb
 - lib/servitude/base.rb
 - lib/servitude/cli.rb
+- lib/servitude/cli/base.rb
+- lib/servitude/cli/service.rb
 - lib/servitude/config_helper.rb
 - lib/servitude/configuration.rb
 - lib/servitude/daemon.rb