servitude 0.1.0 → 0.2.0

data/lib/servitude/server_logging.rb

@@ -13,21 +13,15 @@ module Servitude
         l.adapter $stdout, :level => [:debug, :info, :warn]
         l.adapter $stderr, :level => [:error, :fatal]
       end
-
-      #Celluloid.logger = Yell.new do |l|
-        #l.level = :info
-        #l.adapter :file, File.join( File.dirname( options[:log] ), "#{APP_ID}-celluloid.log" )
-      #end
     end
 
     def log_startup
-      start_banner( options ).each do |line|
+      start_banner.each do |line|
         Servitude::NS.logger.info line
       end
     end
 
-    def start_banner( options )
-      configuration_attributes = Servitude::NS::Configuration.attributes rescue nil
+    def start_banner
       [
         "",
         "***",
@@ -35,46 +29,62 @@ module Servitude
         "*",
         "* #{Servitude::NS::VERSION_COPYRIGHT}",
         "*",
-        "* Configuration:",
-        (options[:config_loaded] ? "*   file: #{options[:config]}" : nil),
-        Array( configuration_attributes ).map { |a| "*   #{a}: #{config_value a}" },
-        "*",
+        (Servitude::NS::configuration.empty? ? nil : "* Configuration"),
+        PrettyPrint::configuration_lines( Servitude::NS::configuration, "*  ", all_config_filters ),
+        (Servitude::NS::configuration.empty? ? nil : "*"),
         "***",
       ].flatten.reject( &:nil? )
     end
 
     def log_level
-      options.fetch( :log_level, :info ).to_sym
+      ((Servitude::NS::configuration.log_level || :info).to_sym rescue :info)
     end
 
+    def all_config_filters
+      default_config_filters + config_filters
+    end
 
-    def config_value( key )
-      value = Servitude::NS.configuration.send( key )
-
-      return value unless value.is_a?( Hash )
+    def default_config_filters
+      %w(
+        help
+        interactive
+        interactive_given
+      )
+    end
 
-      return redacted_hash( value )
+    # Override for custom config filtering
+    #
+    def config_filters
+      []
     end
 
-    def redacted_hash( hash )
-      redacted_hash = {}
+    #def config_value( key )
+      #value = Servitude::NS.configuration.send( key )
 
-      hash.keys.
-           collect( &:to_s ).
-           grep( /#{redacted_keys}/i ).
-           each do |blacklisted_key|
-        value = hash[blacklisted_key]
-        redacted_hash[blacklisted_key] = value.nil? ? nil : '[REDACTED]'
-      end
+      #return value unless value.is_a?( Hash )
 
-      hash.merge( redacted_hash )
-    end
+      #return redacted_hash( value )
+    #end
 
-    def redacted_keys
-      %w(
-        password
-      ).join( '|' )
-    end
+    #def redacted_hash( hash )
+      #redacted_hash = {}
+
+      #hash.keys.
+           #collect( &:to_s ).
+           #grep( /#{redacted_keys}/i ).
+           #each do |blacklisted_key|
+        #value = hash[blacklisted_key]
+        #redacted_hash[blacklisted_key] = value.nil? ? nil : '[REDACTED]'
+      #end
+
+      #hash.merge( redacted_hash )
+    #end
+
+    #def redacted_keys
+      #%w(
+        #password
+      #).join( '|' )
+    #end
 
   end
 end

data/lib/servitude/version.rb

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

data/servitude.gemspec

@@ -21,8 +21,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "pry-debugger"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 
   spec.add_dependency "celluloid", "~> 0"
+  spec.add_dependency "hashie"
   spec.add_dependency "hooks", "~> 0"
   spec.add_dependency "oj", "~> 2"
   spec.add_dependency "rainbow", "~> 2"

data/spec/servitude/pretty_print_spec.rb

@@ -0,0 +1,71 @@
+require "servitude/pretty_print"
+
+describe Servitude::PrettyPrint do
+
+  describe '.configuration_lines' do
+    def configuration_lines( *arguments )
+      described_class.configuration_lines( *arguments )
+    end
+
+    describe 'a key-value pair' do
+      specify {
+        expect( configuration_lines( foo: 'bar' )).to eq( ["foo: bar"] )
+      }
+    end
+
+    describe 'multiple key-value pair' do
+      specify {
+        expect( configuration_lines( foo: 'bar', baz: 'bam' )).to eq( ["foo: bar", "baz: bam"] )
+      }
+    end
+
+    describe 'a nested key-value pair' do
+      specify {
+        expect( configuration_lines({ foo: { 'bar' => 'baz' } })).to eq( ["foo.bar: baz"] )
+      }
+    end
+
+    describe 'a nested config with an array' do
+      specify {
+        expect( configuration_lines({ foo: { 'bar' => 'baz', bam: [1,2,3] } })).to eq( ["foo.bar: baz", "foo.bam: [1, 2, 3]"] )
+      }
+    end
+
+    describe 'a nested config with an array with filter apilied' do
+      specify {
+        expect( configuration_lines({ foo: { 'bar' => 'baz', bam: [1,2,3] } }, '', %w(foo.bam))).to eq( ["foo.bar: baz"] )
+      }
+    end
+  end
+
+  describe '.format_configuration' do
+    def format_configuration( *arguments )
+      described_class.format_configuration( *arguments )
+    end
+
+    describe 'a key-value pair' do
+      specify {
+        expect( format_configuration( foo: 'bar' )).to eq( [["foo", "bar"]] )
+      }
+    end
+
+    describe 'multiple key-value pair' do
+      specify {
+        expect( format_configuration( foo: 'bar', baz: 'bam' )).to eq( [["foo","bar"],["baz","bam"]] )
+      }
+    end
+
+    describe 'a nested key-value pair' do
+      specify {
+        expect( format_configuration({ foo: { 'bar' => 'baz' } })).to eq( [["foo.bar", "baz"]] )
+      }
+    end
+
+    describe 'a nested config with an array' do
+      specify {
+        expect( format_configuration({ foo: { 'bar' => 'baz', bam: [1,2,3] } })).to eq( [["foo.bar", "baz"], ["foo.bam", "[1, 2, 3]"]] )
+      }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servitude
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Harrelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: celluloid
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: hooks
   requirement: !ruby/object:Gem::Requirement
@@ -145,27 +173,39 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- config/4.conf
+- config/5.conf
 - examples/1_simple_server
 - examples/2_echo_server
+- examples/3_echo_server_with_cli_and_daemon
+- examples/4_echo_server_with_cli_daemon_and_file_config
+- examples/5_echo_server_with_cli_daemon_and_env_config
 - lib/servitude.rb
 - lib/servitude/actor.rb
 - lib/servitude/base.rb
 - lib/servitude/cli.rb
+- lib/servitude/config_helper.rb
 - lib/servitude/configuration.rb
 - lib/servitude/daemon.rb
+- lib/servitude/environment_configuration.rb
 - lib/servitude/logging.rb
+- lib/servitude/pretty_print.rb
 - lib/servitude/server.rb
 - lib/servitude/server_logging.rb
 - lib/servitude/server_threaded.rb
 - lib/servitude/supervision_error.rb
 - lib/servitude/version.rb
 - servitude.gemspec
+- spec/servitude/pretty_print_spec.rb
+- spec/spec_helper.rb
+- tmp/.gitkeep
 homepage: ''
 licenses:
 - MIT
@@ -191,4 +231,6 @@ signing_key:
 specification_version: 4
 summary: A set of utilities to aid in building multithreaded Ruby servers utilizing
   Celluloid.
-test_files: []
+test_files:
+- spec/servitude/pretty_print_spec.rb
+- spec/spec_helper.rb