servitude 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53cfb7474208ec999ec104ff7f6cbebc5a95cdfc
-  data.tar.gz: 5eb37804b51441b9ac8556eb3b587ecb099751a2
+  metadata.gz: 0cb042d305f0b88d3c0f0c6fb30c68cf5e594ee0
+  data.tar.gz: 7428b62b9bdb7e62fcde7638b22f97ae381e1a87
 SHA512:
-  metadata.gz: 5a84f41870b6242178b9ae7fabe6f710965666be7f59dc376508034f206b57d74f1edb597d0bdcb53501dcc39c194de527020c97a946d9b92bc44fe108c90d5c
-  data.tar.gz: cf03f89b9c90305ecfe663fe695ce43ef47c9a125511a4df69e76f2cc35452dcd10c4c9778f0ad19d953bbdb303f701912c3f5edfa2e998131910655d57d2aad
+  metadata.gz: 2771c1e6a3ae5152a48b61784cb2a9cad04455f417d2688b4614a85f82eed2491f9cd592a03c83bf78467ff563bebdcd6e19ed687c1c09c92daf8330f3a7cf05
+  data.tar.gz: da0c91b560eabf6c12869a0b93f6c8eab4a065e825e56ed0e11f27c585af4fc781d107a778d9076853150fe7a7de5d1c5fd98b0b8ae65e3cbb8e36ce0bc81f55

data/README.md

@@ -68,12 +68,12 @@ If you do not call ::boot, an error is raised before your server can be started.
       boot host_namespace: AwesomeServer,
            app_id: 'awesome-server',
            app_name: 'Aswesome Server',
-           company: 'Awesome, Inc.',
+           attribution: "v#{VERSION} \u00A9#{Time.now.year} Awesome, Inc."
+           author: 'Awesome, Inc.',
            default_config_path: "/etc/awesome/awesome-server.conf",
            default_log_path: "/var/log/awesome/awesome-server.log",
            default_pid_path: "/var/run/awesome/awesome-server.pid",
            default_thread_count: 1,
-           version_copyright: "v#{VERSION} \u00A9#{Time.now.year} Awesome, Inc."
     end
 
 ### Servitude::Cli

data/examples/1_simple_server

@@ -25,13 +25,13 @@ module SimpleServer
   boot host_namespace: SimpleServer,
        app_id: 'simple-server',
        app_name: 'Simple Server',
-       company: 'LFE',
+       attribution: "v#{VERSION} \u00A9#{Time.now.year} LFE",
+       author: 'LFE',
        use_config: false,
        default_config_path: nil,
        default_log_path: nil,
        default_pid_path: nil,
-       default_thread_count: nil,
-       version_copyright: "v#{VERSION} \u00A9#{Time.now.year} LFE"
+       default_thread_count: nil
 
   class Server
 

data/examples/2_echo_server

@@ -31,13 +31,13 @@ module EchoServer
   boot host_namespace: EchoServer,
        app_id: 'echo-server',
        app_name: 'Echo Server',
-       company: 'LFE',
+       attribution: "v#{VERSION} \u00A9#{Time.now.year} LFE",
+       author: 'LFE',
        use_config: false,
        default_config_path: nil,
        default_log_path: nil,
        default_pid_path: nil,
-       default_thread_count: nil,
-       version_copyright: "v#{VERSION} \u00A9#{Time.now.year} LFE"
+       default_thread_count: nil
 
   class Server
 

data/examples/3_echo_server_with_cli_and_daemon

@@ -42,13 +42,13 @@ module EchoServer
   boot host_namespace: EchoServer,
        app_id: 'echo-server-with-cli',
        app_name: 'Echo Server With CLI',
-       company: 'LFE',
+       attribution: "v#{VERSION} \u00A9#{Time.now.year} LFE",
+       author: 'LFE',
        use_config: false,
        default_config_path: "#{PROJECT_ROOT}}/config/#{APP_FOLDER}.conf",
        default_log_path: "#{PROJECT_ROOT}/tmp/#{APP_FOLDER}.log",
        default_pid_path: "#{PROJECT_ROOT}/tmp/#{APP_FOLDER}.pid",
-       default_thread_count: nil,
-       version_copyright: "v#{VERSION} \u00A9#{Time.now.year} LFE"
+       default_thread_count: nil
 
   class Cli < Servitude::Cli::Service
   end

data/examples/4_echo_server_with_cli_daemon_and_file_config

@@ -42,13 +42,13 @@ module EchoServer
   boot host_namespace: EchoServer,
        app_id: 'echo-server-with-cli-and-file-config',
        app_name: 'Echo Server With CLI And File Config',
-       company: 'LFE',
+       attribution: "v#{VERSION} \u00A9#{Time.now.year} LFE",
+       author: 'LFE',
        use_config: true,
        default_config_path: "#{PROJECT_ROOT}/config/4.conf",
        default_log_path: "#{PROJECT_ROOT}/tmp/#{APP_FOLDER}.log",
        default_pid_path: "#{PROJECT_ROOT}/tmp/#{APP_FOLDER}.pid",
-       default_thread_count: nil,
-       version_copyright: "v#{VERSION} \u00A9#{Time.now.year} LFE"
+       default_thread_count: nil
 
   class Cli < Servitude::Cli::Service
   end

data/examples/5_echo_server_with_cli_daemon_and_env_config

@@ -50,13 +50,13 @@ module EchoServer
   boot host_namespace: EchoServer,
        app_id: 'echo-server-with-cli-and-env-config',
        app_name: 'Echo Server With CLI And Env Config',
-       company: 'LFE',
+       attribution: "v#{VERSION} \u00A9#{Time.now.year} LFE",
+       author: 'LFE',
        use_config: true,
        default_config_path: "#{PROJECT_ROOT}/config/5.conf",
        default_log_path: "#{PROJECT_ROOT}/tmp/#{APP_FOLDER}.log",
        default_pid_path: "#{PROJECT_ROOT}/tmp/#{APP_FOLDER}.pid",
-       default_thread_count: nil,
-       version_copyright: "v#{VERSION} \u00A9#{Time.now.year} LFE"
+       default_thread_count: nil
 
   class Cli < Servitude::Cli::Service
   end

data/lib/servitude/base.rb

@@ -16,27 +16,61 @@ module Servitude
 
     module ClassMethods
 
-      def boot( host_namespace: raise(ArgumentError, 'host_namespace keyword is required'),
-                app_id: host_namespace.name.split( '::' ).join( '-' ).downcase,
-                app_name: host_namespace.name.split( '::' ).join( ' ' ),
-                company: raise(ArgumentError, 'company keyword is required'),
+      def boot( host_namespace: nil,
+                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 ),
                 use_config: false,
                 default_config_path: nil,
                 default_log_path: nil,
                 default_pid_path: nil,
                 default_thread_count: nil,
-                version_copyright: "v#{host_namespace::VERSION} Copyright © #{Time.now.year} #{company}" )
+                version_copyright: nil ) # TODO: Remove when version_copyright keyword deprecation expires
+        unless host_namespace
+          raise ArgumentError, 'host_namespace keyword is required'
+        end
+        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
+          raise ArgumentError, 'author keyword is required'
+        end
+        unless attribution || version_copyright
+          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
+
+        # 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
+
         Servitude::const_set :NS, host_namespace
 
         const_set :APP_ID, app_id
         const_set :APP_NAME, app_name
-        const_set :COMPANY, company
+        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 :DEFAULT_LOG_PATH, default_log_path
         const_set :DEFAULT_PID_PATH, default_pid_path
         const_set :DEFAULT_THREAD_COUNT, default_thread_count
         const_set :USE_CONFIG, use_config
-        const_set :VERSION_COPYRIGHT, version_copyright
+        const_set :VERSION_COPYRIGHT, attribution # TODO: Remove when version_copyright keyword deprecation expires
 
         Servitude::boot_called = true
       end

data/lib/servitude/util.rb

@@ -0,0 +1,19 @@
+require 'rainbow'
+
+module Servitude
+
+  module Util
+
+    def self.deprecate( deprecated_usage, sanctioned_usage )
+      $stderr.print Rainbow( " *** DEPRECATED " ).yellow.inverse
+      $stderr.print ' '
+      $stderr.print Rainbow( deprecated_usage ).underline
+      $stderr.print Rainbow(" -- use ")
+      $stderr.print Rainbow( sanctioned_usage ).underline
+      $stderr.print Rainbow(" instead")
+      $stderr.puts ''
+    end
+
+  end
+
+end

data/lib/servitude/version.rb

@@ -1,3 +1,3 @@
 module Servitude
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/servitude.rb

@@ -16,6 +16,7 @@ module Servitude
   autoload :Server,                   'servitude/server'
   autoload :ServerThreaded,           'servitude/server_threaded'
   autoload :SupervisionError,         'servitude/supervision_error'
+  autoload :Util,                     'servitude/util'
 
   INT  = "INT"
   TERM = "TERM"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: servitude
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jason Harrelson
@@ -203,6 +203,7 @@ files:
 - lib/servitude/server_logging.rb
 - lib/servitude/server_threaded.rb
 - lib/servitude/supervision_error.rb
+- lib/servitude/util.rb
 - lib/servitude/version.rb
 - servitude.gemspec
 - spec/servitude/pretty_print_spec.rb