servitude 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17a6491898797ad45347d09d899bd9ad38023115
-  data.tar.gz: d0725d50f1c40dba41190a1ee4a980e0337765e4
+  metadata.gz: 80d47c3acb94c6f7d9e74314a4229743841a959c
+  data.tar.gz: 18004ef4ba391377f0fb380f126e53fb395f1e5f
 SHA512:
-  metadata.gz: 0c507b9f2510bdc856ad094d855290d7b0714f74d8ccd76f1e4d0fbcb391e973576a551cfe3fcd287aff38d7abc64496e7d2266e873c74ed53b94d3cceb28200
-  data.tar.gz: 6e90125ea1bdc65bc9c26990fde6ed414c1a552c311575115334fb05a7529aea6f33d44db4a51f4730ee2a5a56bdd4a95a76fa0392b327c9b6ca422ce701b891
+  metadata.gz: 6dba8c112362cfb824c127afa17d1bf72651e32e7472d9a322adf1eec9b968a1aced4ad3521422b96ffcc3592ff254da13f018cfb24286810f54319d06c96e39
+  data.tar.gz: f99cd105a9bb25c239e0fb2db98a50702678fab769a9f1634ef56c1775f54b3ad329701437883d8a9731ad2f2ed45db0d89a4cfbab31f29fd4fae5753f5e4371

data/examples/1_simple_server

@@ -22,13 +22,12 @@ module SimpleServer
 
   PROJECT_ROOT = File.expand_path( '../..', __FILE__ )
   
-  boot host_namespace: SimpleServer,
-       app_id: 'simple-server',
+  boot app_id: 'simple-server',
        app_name: 'Simple Server',
        attribution: "v#{VERSION} \u00A9#{Time.now.year} LFE",
        author: 'LFE',
        use_config: false,
-       default_config_path: nil,
+       default_config_path: nil
 
   class Server
 

data/examples/2_echo_server

@@ -28,13 +28,12 @@ module EchoServer
 
   PROJECT_ROOT = File.expand_path( '../..', __FILE__ )
   
-  boot host_namespace: EchoServer,
-       app_id: 'echo-server',
+  boot app_id: 'echo-server',
        app_name: 'Echo Server',
        attribution: "v#{VERSION} \u00A9#{Time.now.year} LFE",
        author: 'LFE',
        use_config: false,
-       default_config_path: nil,
+       default_config_path: nil
 
   class Server
 

data/examples/3_echo_server_with_cli_and_daemon

@@ -39,13 +39,12 @@ module EchoServer
 
   PROJECT_ROOT = File.expand_path( '../..', __FILE__ )
   
-  boot host_namespace: EchoServer,
-       app_id: 'echo-server-with-cli',
+  boot app_id: 'echo-server-with-cli',
        app_name: 'Echo Server With CLI',
-       attribution: "v#{VERSION} \u00A9#{Time.now.year} LFE",
        author: 'LFE',
+       attribution: "v#{VERSION} \u00A9#{Time.now.year} LFE",
        use_config: false,
-       default_config_path: "#{PROJECT_ROOT}}/config/#{APP_FOLDER}.conf",
+       default_config_path: "#{PROJECT_ROOT}}/config/#{APP_FOLDER}.conf"
 
   class Cli < Servitude::Cli::Service
   end

data/examples/4_echo_server_with_cli_daemon_and_file_config

@@ -39,13 +39,12 @@ module EchoServer
 
   PROJECT_ROOT = File.expand_path( '../..', __FILE__ )
   
-  boot host_namespace: EchoServer,
-       app_id: 'echo-server-with-cli-and-file-config',
+  boot app_id: 'echo-server-with-cli-and-file-config',
        app_name: 'Echo Server With CLI And File Config',
        attribution: "v#{VERSION} \u00A9#{Time.now.year} LFE",
        author: 'LFE',
        use_config: true,
-       default_config_path: "#{PROJECT_ROOT}/config/4.conf",
+       default_config_path: "#{PROJECT_ROOT}/config/4.conf"
 
   class Cli < Servitude::Cli::Service
   end

data/examples/5_echo_server_with_cli_daemon_and_env_config

@@ -47,8 +47,7 @@ module EchoServer
 
   PROJECT_ROOT = File.expand_path( '../..', __FILE__ )
   
-  boot host_namespace: EchoServer,
-       app_id: 'echo-server-with-cli-and-env-config',
+  boot app_id: 'echo-server-with-cli-and-env-config',
        app_name: 'Echo Server With CLI And Env Config',
        attribution: "v#{VERSION} \u00A9#{Time.now.year} LFE",
        author: 'LFE',

data/lib/servitude.rb

@@ -22,35 +22,4 @@ module Servitude
   INT  = "INT"
   TERM = "TERM"
 
-  class << self
-    attr_accessor :boot_called, :configuration, :logger
-
-    def initialize_loggers( log_level: nil, filename: nil )
-      raise ArgumentError, 'log_level keyword is required' unless log_level
-
-      logger.adapter.close if logger && logger.adapter
-
-      self.logger = Yell.new do |l|
-        l.level = log_level
-        if filename
-          l.adapter :file, filename, :level => [:debug, :info, :warn]
-        else
-          l.adapter $stdout, :level => [:debug, :info, :warn]
-          l.adapter $stderr, :level => [:error, :fatal]
-        end
-      end
-    end
-
-    def server_class
-      case SERVER_CLASS
-        when String, Symbol
-          eval SERVER_CLASS.to_s, binding, __FILE__, __LINE__
-        else
-          SERVER_CLASS
-      end
-    end
-  end
-
-  Servitude.initialize_loggers log_level: :info
-
 end

data/lib/servitude/base.rb

@@ -9,86 +9,80 @@ module Servitude
       base.extend( ClassMethods )
       base.class_eval do
         class << self
-          attr_accessor :logger
+          attr_accessor :boot_called,
+                        :configuration,
+                        :logger
         end
       end
     end
 
     module ClassMethods
 
-      def boot( host_namespace: nil,
-                app_id: ( host_namespace.name.split( '::' ).join( '-' ).downcase rescue nil ),
+      def boot( app_id: ( host_namespace.name.split( '::' ).join( '-' ).downcase rescue nil ),
                 app_name: ( host_namespace.name.split( '::' ).join( ' ' ) rescue nil ),
                 author: nil,
-                company: nil, # TODO: Remove when company keyword deprecation expires
-                attribution: ( "v#{host_namespace::VERSION} Copyright © #{Time.now.year} #{author || company}" rescue nil ),
+                attribution: ( "v#{host_namespace::VERSION} Copyright © #{Time.now.year} #{author}" rescue nil ),
                 use_config: false,
                 default_config_path: nil,
-                server_class: ( host_namespace::Server rescue "#{host_namespace.name}::Server" ),
-                version_copyright: nil ) # TODO: Remove when version_copyright keyword deprecation expires
-        unless host_namespace
-          raise ArgumentError, 'host_namespace keyword is required'
-        end
+                server_class: ( host_namespace::Server rescue "#{host_namespace.name}::Server" ))
         unless app_id
           raise ArgumentError, 'app_id keyword is required'
         end
         unless app_name
           raise ArgumentError, 'app_name keyword is required'
         end
-        unless author || company
+        unless author
           raise ArgumentError, 'author keyword is required'
         end
-        unless attribution || version_copyright
+        unless attribution
           raise ArgumentError, 'attribution keyword is required'
         end
 
-        # TODO: Remove when company keyword deprecation expires
-        if company
-          Util.deprecate "#{Base.name}.boot company: #{company.inspect}",
-                         "#{Base.name}.boot author: #{company.inspect}"
-          author = company
-        end
-
         unless server_class
           raise ArgumentError, 'server_class keyword is required'
         end
 
-        # TODO: Remove when version_copyright keyword deprecation expires
-        if version_copyright
-          Util.deprecate "#{Base.name}.boot version_copyright: #{version_copyright.inspect}",
-                         "#{Base.name}.boot attribution: #{version_copyright.inspect}"
-          attribution = version_copyright
-        end
-
-        # TODO: Remove when host namespace deprecation expires
         const_set :APP_ID, app_id
         const_set :APP_NAME, app_name
         const_set :AUTHOR, author
-        const_set :COMPANY, author # TODO: Remove when company keyword deprecation expires
         const_set :ATTRIBUTION, attribution
         const_set :DEFAULT_CONFIG_PATH, default_config_path
+        const_set :SERVER_CLASS, server_class
         const_set :USE_CONFIG, use_config
-        const_set :VERSION_COPYRIGHT, attribution # TODO: Remove when version_copyright keyword deprecation expires
 
-        Servitude.const_set :APP_ID, app_id
-        Servitude.const_set :APP_NAME, app_name
-        Servitude.const_set :AUTHOR, author
-        Servitude.const_set :COMPANY, author # TODO: Remove when company keyword deprecation expires
-        Servitude.const_set :ATTRIBUTION, attribution
-        Servitude.const_set :DEFAULT_CONFIG_PATH, default_config_path
-        Servitude.const_set :SERVER_CLASS, server_class
-        Servitude.const_set :USE_CONFIG, use_config
-        Servitude.const_set :VERSION_COPYRIGHT, attribution # TODO: Remove when version_copyright keyword deprecation expires
+        host_namespace.boot_called = true
+      end
 
-        Servitude::boot_called = true
+      # Override to contradict convention of Server being nested
+      # in ::host_namespace
+      #
+      def host_namespace
+        self
       end
 
-      def configuration
-        @configuration
+      def server_class
+        case self::SERVER_CLASS
+          when String, Symbol
+            eval self::SERVER_CLASS.to_s, binding, __FILE__, __LINE__
+          else
+            self::SERVER_CLASS
+        end
       end
 
-      def configuration=( configuration )
-        @configuration = configuration
+      def initialize_loggers( log_level: nil, filename: nil )
+        raise ArgumentError, 'log_level keyword is required' unless log_level
+
+        logger.adapter.close if logger && logger.adapter
+
+        self.logger = Yell.new do |l|
+          l.level = log_level
+          if filename
+            l.adapter :file, filename, :level => [:debug, :info, :warn]
+          else
+            l.adapter $stdout, :level => [:debug, :info, :warn]
+            l.adapter $stderr, :level => [:error, :fatal]
+          end
+        end
       end
 
       def configure

data/lib/servitude/cli/service.rb

@@ -11,7 +11,7 @@ module Servitude
       end
 
       def self.common_start_options
-        method_option :config, type: :string, aliases: '-c', desc: "The path for the config file", default: Servitude::DEFAULT_CONFIG_PATH
+        method_option :config, type: :string, aliases: '-c', desc: "The path for the config file"
         environment_option
         method_option :log_level, desc: "The log level", type: :string, aliases: '-o'
         method_option :log, desc: "The path for the log file", type: :string, aliases: '-l'
@@ -41,12 +41,14 @@ module Servitude
       no_commands do
 
         def start_interactive
-          server = Servitude::server_class.new( configuration( options, use_config: Servitude::USE_CONFIG, log: 'STDOUT' ))
+          server = host_namespace::server_class.new( configuration( options, use_config: host_namespace::USE_CONFIG, log: 'STDOUT' ))
           server.start
         end
 
         def start_daemon
-          server = Servitude::Daemon.new( configuration( options, use_config: Servitude::USE_CONFIG ))
+          server = Servitude::Daemon.new( host_namespace::APP_NAME,
+                                          host_namespace::server_class,
+                                          configuration( options, use_config: host_namespace::USE_CONFIG ))
           server.start
         end
 
@@ -55,8 +57,16 @@ module Servitude
         end
 
         def configuration( options, additional_options={} )
+          unless options[:config]
+            options = options.merge( config: host_namespace::DEFAULT_CONFIG_PATH )
+          end
+
           options = options.merge( additional_options )
-          Servitude.configuration = configuration_class.load( options )
+          host_namespace.configuration = configuration_class.load( host_namespace::DEFAULT_CONFIG_PATH, options )
+        end
+
+        def host_namespace
+          raise NotImplementedError
         end
 
       end
@@ -65,7 +75,9 @@ module Servitude
       pid_option
       method_option :quiet, type: :boolean, aliases: '-q', desc: "Do not prompt to remove an old PID file", default: false
       def status
-        result = Servitude::Daemon.new( configuration( options, use_config: Servitude::USE_CONFIG  )).status
+        result = Servitude::Daemon.new( host_namespace::APP_NAME,
+                                        host_namespace::server_class,
+                                        configuration( options, use_config: host_namespace::USE_CONFIG  )).status
         at_exit { exit result }
       end
 
@@ -73,7 +85,9 @@ module Servitude
       pid_option
       method_option :quiet, type: :boolean, aliases: '-q', desc: "Do not prompt to remove an old PID file", default: false
       def stop
-        server = Servitude::Daemon.new( configuration( options, use_config: Servitude::USE_CONFIG ))
+        server = Servitude::Daemon.new( host_namespace::APP_NAME,
+                                        host_namespace::server_class,
+                                        configuration( options, use_config: host_namespace::USE_CONFIG ))
         server.stop
       end
 

data/lib/servitude/config_helper.rb

@@ -2,7 +2,11 @@ module Servitude
   module ConfigHelper
 
     def config
-      Servitude.configuration
+      host_namespace.configuration
+    end
+
+    def host_namespace
+      raise NotImplementedError
     end
 
   end

data/lib/servitude/configuration.rb

@@ -1,25 +1,16 @@
 require 'hashie'
-#require 'oj'
 require 'pathname'
 require 'yaml'
 
 module Servitude
   class Configuration < Hashie::Mash
 
-    def self.load( options={} )
-      merged_options = defaults.merge( file_options )
+    def self.load( config_filepath, options={} )
+      merged_options = defaults.merge( file_options( config_filepath ))
       merged_options = merged_options.merge( options )
       new( merged_options )
     end
 
-    def self.config_filepath
-      Servitude::DEFAULT_CONFIG_PATH
-    end
-
-    def config_filepath
-      Pathname.new( self.class.config_filepath )
-    end
-
     def slice( *keys )
       klass.new( select { |k,v| keys.map( &:to_s ).include?( k ) } )
     end
@@ -39,15 +30,15 @@ module Servitude
       }
     end
 
-    def self.file_options
+    def self.file_options( config_filepath )
       return {} unless config_filepath
 
       File.exists?( config_filepath ) ?
-        load_file_options :
+        load_file_options( config_filepath ) :
         {}
     end
 
-    def self.load_file_options
+    def self.load_file_options( config_filepath )
       YAML::load( File.read( config_filepath ))
     end
 

data/lib/servitude/daemon.rb

@@ -5,18 +5,22 @@ require 'timeout'
 module Servitude
   class Daemon
 
-    attr_reader :name,
+    attr_reader :app_name,
+                :name,
                 :options,
                 :pid,
                 :pid_path,
                 :script,
+                :server_class,
                 :timeout
 
-    def initialize( options )
+    def initialize( app_name, server_class, options )
       @options  = options
-      @name     = options[:name] || Servitude::APP_NAME
+      @app_name = app_name
+      @name     = options[:name] || app_name
       @pid_path = options[:pid] || '.'
       @pid      = get_pid
+      @server_class = server_class
       @timeout  = options[:timeout] || 10
     end
 
@@ -37,7 +41,7 @@ module Servitude
     end
 
     def run
-      Servitude::server_class.new( options ).start
+      server_class.new( options ).start
     end
 
     def stop
@@ -46,7 +50,7 @@ module Servitude
           remove_pid
         when :failed_to_stop
         when :does_not_exist
-          puts "#{Servitude::APP_NAME} process is not running"
+          puts "#{app_name} process is not running"
           prompt_and_remove_pid_file if pid_file_exists? && !options[:quiet]
         else
           raise 'Unknown return code from #kill_process'
@@ -55,10 +59,10 @@ module Servitude
 
     def status
       if process_exists?
-        puts "#{Servitude::APP_NAME} process running with PID: #{pid}"
+        puts "#{app_name} process running with PID: #{pid}"
         true
       else
-        puts "#{Servitude::APP_NAME} process does not exist"
+        puts "#{app_name} process does not exist"
         prompt_and_remove_pid_file if pid_file_exists? && !options[:quiet]
         false
       end
@@ -117,7 +121,7 @@ module Servitude
     def kill_process
       return :does_not_exist unless process_exists?
 
-      $stdout.write "Attempting to stop #{Servitude::APP_NAME} process #{pid}..."
+      $stdout.write "Attempting to stop #{app_name} process #{pid}..."
       Process.kill INT, pid
 
       iteration_num = 0
@@ -128,10 +132,10 @@ module Servitude
       end
 
       if process_exists?
-        $stderr.puts "\nFailed to stop #{Servitude::APP_NAME} process #{pid}"
+        $stderr.puts "\nFailed to stop #{app_name} process #{pid}"
         return :failed_to_stop
       else
-        $stdout.puts "\nSuccessfuly stopped #{Servitude::APP_NAME} process #{pid}"
+        $stdout.puts "\nSuccessfuly stopped #{app_name} process #{pid}"
       end
 
       return :success

data/lib/servitude/environment_configuration.rb

@@ -6,7 +6,7 @@ module Servitude
   class EnvironmentConfiguration < Servitude::Configuration
 
     def for_env
-      _config.send( _config.environment )
+      send( environment )
     end
 
   end

data/lib/servitude/logging.rb

@@ -11,11 +11,15 @@ module Servitude
 
       define_method level do |*messages|
         messages.each do |message|
-          Servitude.logger.send level, message
+          host_namespace.logger.send level, message
         end
       end
 
     end
 
+    def host_namespace
+      raise NotImplementedError
+    end
+
   end
 end

data/lib/servitude/server.rb

@@ -22,7 +22,7 @@ module Servitude
     end
 
     def initialize( cli_options={} )
-      unless Servitude.boot_called
+      unless host_namespace.boot_called
         raise 'You must call boot before starting server'
       end
 
@@ -35,19 +35,33 @@ module Servitude
 
     def start
       log_startup
+      setup_signal_handling
+      run_sequence
+      sleep_sequence
+    end
 
-      trap( INT )  { stop }
-      trap( TERM ) { stop }
+  protected
+
+    def run
+      raise NotImplementedError
+    end
 
+    def run_sequence
       run_hook :before_run
       run
+    end
+
+    def sleep_sequence
       run_hook :before_sleep
       sleep
     end
 
-  protected
+    def setup_signal_handling
+      trap( INT )  { stop }
+      trap( TERM ) { stop }
+    end
 
-    def run
+    def host_namespace
       raise NotImplementedError
     end
 

data/lib/servitude/server_logging.rb

@@ -6,12 +6,12 @@ module Servitude
   protected
 
     def initialize_loggers
-      Servitude.initialize_loggers log_level: log_level
+      host_namespace.initialize_loggers log_level: log_level
     end
 
     def log_startup
       start_banner.each do |line|
-        Servitude.logger.info line
+        host_namespace.logger.info line
       end
     end
 
@@ -19,19 +19,19 @@ module Servitude
       [
         "",
         "***",
-        "* #{Servitude::APP_NAME} started",
+        "* #{host_namespace::APP_NAME} started",
         "*",
-        "* #{Servitude::VERSION_COPYRIGHT}",
+        "* #{host_namespace::ATTRIBUTION}",
         "*",
-        (Servitude.configuration.empty? ? nil : "* Configuration"),
-        PrettyPrint::configuration_lines( Servitude.configuration, "*  ", all_config_filters ),
-        (Servitude.configuration.empty? ? nil : "*"),
+        ((host_namespace.configuration.nil? || host_namespace.configuration.empty?) ? nil : "* Configuration"),
+        PrettyPrint::configuration_lines( host_namespace.configuration, "*  ", all_config_filters ),
+        ((host_namespace.configuration.nil? || host_namespace.configuration.empty?) ? nil : "*"),
         "***",
       ].flatten.reject( &:nil? )
     end
 
     def log_level
-      (Servitude.configuration.log_level.to_sym rescue :info)
+      (host_namespace.configuration.log_level.to_sym rescue :info)
     end
 
     def all_config_filters
@@ -51,8 +51,12 @@ module Servitude
       []
     end
 
+    def host_namespace
+      raise NotImplementedError
+    end
+
     #def config_value( key )
-      #value = Servitude.configuration.send( key )
+      #value = host_namespace.configuration.send( key )
 
       #return value unless value.is_a?( Hash )
 

data/lib/servitude/version.rb

@@ -1,3 +1,3 @@
 module Servitude
-  VERSION = "1.2.1"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servitude
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Jason Harrelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler