svutil 0.1.8 → 0.9.0

data/lib/svutil.rb

@@ -6,5 +6,5 @@ require 'svutil/log'
 require 'svutil/process_manager'
 
 module SVUtil
-  VERSION = '0.1.8'
+  VERSION = '0.9.0'
 end

data/lib/svutil/config.rb

@@ -27,6 +27,7 @@ module SVUtil
   end
 
   class Config
+      
     class << self
       attr_writer :config_file
       attr_reader :attrs
@@ -34,12 +35,11 @@ module SVUtil
       # Used mainly for testing
       attr_accessor :option_source
 
-      def config_class
-      	subclasses_of(self).first || self
-      end
+      attr_accessor :cli_options
+      attr_accessor :cli_option_handlers
 
-      def config_file
-	      @config_file || 'settings'
+      def self.config_class
+      	subclasses_of(self).first || self
       end
 
       def set(options = {})
@@ -55,55 +55,75 @@ module SVUtil
         yield @defaults
       end
 
+      def config_file
+        @config_file ||= "settings"
+      end
+
+      def set_cli_option(option, value)
+        @cli_options ||= {}
+        @cli_options[option.to_s] = value
+      end
+
+      def handle_options(&block)
+        @cli_option_handlers ||= []
+        @cli_option_handlers << block
+      end 
+
+      def validator(&block)
+        @validate_block = block
+      end
+
       def validate
 	      # TODO: Check file perms
         if ((pid_file.nil? or pid_file.empty? or File.directory?(pid_file)) && self.daemon)
-          STDERR.puts "PID file must be a writable file"
-          exit 1
+          err("PID file must be a writable file")
         end
+        # TODO: Validate the writability of the log file
+        @validate_block.call(self) unless @validate_block.nil?
         true
       end
 
       def init
-        self.set do |c|
-          process_options
-          # If there is no config file and we haven't specified one then ignore
-          if File.exists?(self.config_file) || self.config_provided_on_cli
-            load_config_file
-          end
-        end
-      end
-
-      protected
-        # Overide in subclasses for additional options
-        def process_options
-          parse_options
-        end
-
-        def parse_options(&block)
+        set do |c|
+          self.config_provided_on_cli = false
           OptionParser.new do |opts|
             opts.on("-f", "--config [filename]", "Config file to use (default 'settings')") do |filename|
               self.config_file = filename.strip
               self.config_provided_on_cli = true
             end
             opts.on("-d", "--daemon", "Run in the background as a daemon") do
-              self.daemon = true
+              set_cli_option(:daemon, true)
             end
             opts.on("-l", "--debug-log [log-file]", "Debug Log File") do |log|
-              self.log_file = log
+              set_cli_option(:log_file, log)
             end
             opts.on("-T", "--trace", "Display backtrace on errors") do
-              self.trace = true
+              set_cli_option(:trace, true)
             end
             opts.on("-P", "--pid [pid-file]", "PID File") do |pid|
-              self.pid_file = pid
+              set_cli_option(:pid_file, pid)
+            end
+            # Handle CLI passed options
+            (cli_option_handlers || []).each do |handler|
+              handler.call(opts)
             end
-            yield opts if block_given?
           end.parse!(self.option_source || ARGV)
+
+          # Process the config file
+          if (self.config_file && File.exists?(self.config_file)) || self.config_provided_on_cli
+            load_config_file
+          end
+
+          # Finally apply any CLI options
+          (cli_options || {}).each do |(k,v)|
+            c.send("#{k}=", v)
+          end
         end
+      end
 
       private
         def method_missing(method_id, *args)
+          @defaults ||= Defaults.new
           @attrs ||= {}
           if method_id.to_s =~ /=$/
             @attrs[method_id.to_s[0...-1]] = args.first
@@ -123,13 +143,18 @@ module SVUtil
           contents.split("\n").each_with_index do |line, index|
             pair = line.split("=")
             if pair.size != 2
-              STDERR.puts "Invalid config file '#{config_file}'. Syntax error at line #{index + 1}"
-              exit 1
+              err("Invalid config file '#{config_file}'. Syntax error at line #{index + 1}")
             end
             self.send("#{pair[0].strip}=", pair[1].strip)
           end
         end
 
+        # TODO: This should be moved out to a Validator class
+        def err(message)
+          STDERR.puts(message)
+          exit 1
+        end
+
         def subclasses_of(*superclasses) #:nodoc:
           subclasses = []
           superclasses.each do |sup|

data/test/test_config.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/test_helper.rb')
 
 class CustomConfig < SVUtil::Config
   defaults do |c|
@@ -13,69 +13,71 @@ class TestConfig < Test::Unit::TestCase
   end
   
   def test_set
-    assert !Config.my_symbol
-    Config.my_symbol = 'abc'
-    assert_equal 'abc', Config.my_symbol
-    Config.my_var = 10
-    assert_equal 10, Config.my_var
+    assert !CustomConfig.my_symbol
+    CustomConfig.my_symbol = 'abc'
+    assert_equal 'abc', CustomConfig.my_symbol
+    CustomConfig.my_var = 10
+    assert_equal 10, CustomConfig.my_var
   end
 
   def test_set_with_block
-    Config.expects(:validate).times(1)
-    Config.set do |c|
+    CustomConfig.expects(:validate).times(1)
+    CustomConfig.set do |c|
       c.another = 'abc'
       c.some_var = 123
       c.foobar = true
     end
-    assert_equal 'abc', Config.another
-    assert_equal 123, Config.some_var
-    assert Config.foobar
+    assert_equal 'abc', CustomConfig.another
+    assert_equal 123, CustomConfig.some_var
+    assert CustomConfig.foobar
   end
 
   def test_standard_cli_options
-    Config.expects(:validate).times(1)
-    Config.option_source = [ "-f", "test/settings", "-d", "-l", "debug", "-T" ]
-    Config.init
-    assert_equal "test/settings", Config.config_file
-    assert_equal "debug", Config.log_file
-    assert Config.daemon
-    assert Config.trace
+    CustomConfig.expects(:validate).times(1)
+    CustomConfig.option_source = [ "-f", "test/settings", "-d", "-l", "debug", "-T" ]
+    CustomConfig.init
+    assert_equal "test/settings", CustomConfig.config_file
+    assert_equal "debug", CustomConfig.log_file
+    assert CustomConfig.daemon
+    assert CustomConfig.trace
   end
 
   def test_config_file
-    Config.expects(:validate).times(1)
-    Config.config_file = "test/settings"
-    Config.init
-    assert_equal 'bar', Config.foo
+    CustomConfig.expects(:validate).times(1)
+    CustomConfig.config_file = "test/settings"
+    CustomConfig.init
+    assert_equal 'bar', CustomConfig.foo
   end
 
   def test_load_config_file
-    Config.expects(:load_config_file).times(1)
-    Config.config_file = "test/settings"
-    Config.init
-    assert_equal 'bar', Config.foo
+    CustomConfig.expects(:load_config_file).times(1)
+    CustomConfig.config_file = "test/settings"
+    CustomConfig.init
+    assert_equal 'bar', CustomConfig.foo
+  end
+
+  def test_validations_on_cli_with_no_config_file
+    CustomConfig.expects(:validate).times(1)
+    CustomConfig.config_file = nil
+    CustomConfig.init
   end
 
-  # Command Line loses!
+  # Command Line wins!
   def test_file_overide
-    Config.expects(:validate).times(1)
-    Config.config_file = "test/settings"
-    Config.option_source = [ "-l", "logfile_set_on_cli" ]
-    Config.init
-    assert_equal "logfile_set_in_config_file", Config.log_file
+    CustomConfig.expects(:validate).times(1)
+    CustomConfig.config_file = "test/settings"
+    CustomConfig.option_source = [ "-l", "logfile_set_on_cli" ]
+    CustomConfig.init
+    assert_equal "logfile_set_on_cli", CustomConfig.log_file
   end
 
   def test_defaults
-    Config.defaults do |c|
+    CustomConfig.defaults do |c|
       c.manager = 'daniel'
     end
-    assert_equal 'daniel', Config.manager
-    Config.manager = 'james'
-    assert_equal 'james', Config.manager
-  end
-
-  def test_validations
-
+    assert_equal 'daniel', CustomConfig.manager
+    CustomConfig.manager = 'james'
+    assert_equal 'james', CustomConfig.manager
   end
 
   def test_custom_defaults

data/test/test_config_handle_options.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper.rb')
+
+class MyConfig < SVUtil::Config
+  handle_options do |opts|
+    opts.on("-Q", "--restless", "Feeling restless?") do
+      set_cli_option(:restless, true)
+    end
+    opts.on("-x", "--x-value [value]", "X Value") do |x|
+      set_cli_option(:x, x)
+    end
+  end
+end
+
+class TestConfigHandleOptions < Test::Unit::TestCase
+  include SVUtil
+
+  def setup
+  end
+  
+  def test_handle_options
+    MyConfig.option_source = [ "-P", "foo", "-x", "12345", "-Q" ]
+    MyConfig.init
+    assert MyConfig.pid_file = "foo"
+    assert MyConfig.x = '1234'
+    assert MyConfig.restless
+  end
+
+  def test_built_in_options
+    MyConfig.option_source = [ "-d", "-P", "foo" ]
+    MyConfig.init
+    assert MyConfig.daemon
+  end
+end

data/test/test_validations.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper.rb')
+
+class ValidatedConfig < SVUtil::Config
+  validator do |c|
+    err("Output dir must be provided") unless c.output_dir
+  end
+end
+
+class TestValidations < Test::Unit::TestCase
+  include SVUtil
+
+  def setup
+  end
+  
+  def test_custom_validation_error
+    ValidatedConfig.expects(:err).times(1)
+    ValidatedConfig.output_dir = nil
+    ValidatedConfig.validate
+  end
+  
+  def test_custom_validation
+    ValidatedConfig.expects(:err).never
+    ValidatedConfig.output_dir = "foo"
+    assert ValidatedConfig.validate
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svutil
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-21 00:00:00.000000000Z
+date: 2012-01-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: newgem
-  requirement: &70318178637000 !ruby/object:Gem::Requirement
+  requirement: &70175710061260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.5.3
   type: :development
   prerelease: false
-  version_requirements: *70318178637000
+  version_requirements: *70175710061260
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &70318178636200 !ruby/object:Gem::Requirement
+  requirement: &70175710060100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.12'
   type: :development
   prerelease: false
-  version_requirements: *70318178636200
+  version_requirements: *70175710060100
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70318173938520 !ruby/object:Gem::Requirement
+  requirement: &70175705942700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *70318173938520
+  version_requirements: *70175705942700
 description: A simple managed process builder for Ruby projects
 email:
 - daniel@netfox.com
@@ -66,7 +66,9 @@ files:
 - test/test_helper.rb
 - test/test_svutil.rb
 - test/test_config.rb
+- test/test_config_handle_options.rb
 - test/test_defaults.rb
+- test/test_validations.rb
 - .gemtest
 homepage: http://svutil.rubyforge.org
 licenses: []
@@ -96,6 +98,8 @@ specification_version: 3
 summary: Simple Process Builder for Ruby
 test_files:
 - test/test_config.rb
+- test/test_config_handle_options.rb
 - test/test_defaults.rb
 - test/test_helper.rb
 - test/test_svutil.rb
+- test/test_validations.rb