app-ctx 0.1.2 → 0.1.3

data/CHANGELOG

@@ -0,0 +1,62 @@
+Sat Oct 21 11:41:31 CEST 2006  dirk@sebrink.de
+  * more examples, blocks with set_default_values
+
+Sat Oct 21 09:51:25 CEST 2006  dirk@sebrink.de
+  * add, mult, sub cleanup
+
+Sat Oct 21 09:42:12 CEST 2006  dirk@sebrink.de
+  * add arguement type conversions and test
+
+Sat Oct 21 09:17:44 CEST 2006  dirk@sebrink.de
+  * add, sub, mult
+
+Sat Oct 21 09:06:08 CEST 2006  dirk@sebrink.de
+  * .vim-session
+
+Fri Oct 20 20:48:02 CEST 2006  dirk@sebrink.de
+  * darcs changes output added
+
+Fri Oct 20 20:46:15 CEST 2006  dirk@sebrink.de
+  * typo: args
+
+Thu Oct 19 05:48:47 CEST 2006  dirk@sebrink.de
+  * 0.1.3: = README
+
+Sat Sep 16 10:08:42 CEST 2006  dirk@sebrink.de
+  * doc
+
+Sat Sep 16 09:44:32 CEST 2006  dirk@sebrink.de
+  tagged 0.1.2-set_default_values
+
+Sat Sep 16 09:40:08 CEST 2006  dirk@sebrink.de
+  * set_default_values added
+
+Tue Sep  5 00:21:41 CEST 2006  dirk@sebrink.de
+  * example/comments
+
+Mon Sep  4 23:10:13 CEST 2006  dirk@sebrink.de
+  * .gem ignored
+
+Mon Sep  4 11:56:56 CEST 2006  dirk@sebrink.de
+  * 0.1.1
+
+Mon Sep  4 01:46:30 CEST 2006  dirk@sebrink.de
+  * removed config_path from test
+
+Mon Sep  4 01:36:49 CEST 2006  dirk@sebrink.de
+  * App::run with class and closure + comment refactoring
+
+Sat Sep  2 19:18:25 CEST 2006  dirk@sebrink.de
+  * IoC comments and '...have a nice day'
+
+Tue Aug 29 18:48:49 CEST 2006  wolfger schramm <wolfger.schramm@idmedia.com>
+  * setter= config
+
+Thu Aug 24 18:08:38 CEST 2006  dirk@sebrink.de
+  * default boring file
+
+Thu Aug 24 18:05:58 CEST 2006  dirk@sebrink.de
+  * alpha version: ported and refactored for gemspec
+
+Wed Aug 23 12:12:00 CEST 2006  dirk@sebrink.de
+  * new repository

data/README

@@ -1,109 +1,118 @@
-
-    Application Context
-
-    Every application needs configuration and app-ctx provides a concise way of
-    doing it.
-
-    For all applications (you are not a mouseclicker, are u?), once in a while
-    you need to supply some configuration values to overrule the built-in
-    defaults. The app-ctx gem does unify and organize built-in constants,
-    config files and commandline option with a clearly defined priority, from
-    low to high:
-
-        - procedural: App::Config#set_default_values
-        - default values YAML file from next to the $0 script
-        - user supplied configuration file, eg.: --config=/tmp/foo.yml
-        - command line options and flags: --foo --bar=foo
-
-    But for your application it is of no interesst from where the values are
-    coming: command line option: "--port=1234", a user configuration file or
-    from the applications built-in default values. Therefor +app-ctx+ combines
-    value settings from various sources into a single configuration hash.
-
-    basically you have two ways to use it:
-
-        require 'app-ctx' # of course,and than...
-
-    1. closures (see examples/run_with_block.rb) 
-
-        App::ctx.run do |context| ... end
-
-    or 2. with a mainclass(see examples/run_with_class.rb)
-
-        App::ctx.run YourClassHere
-
-    The context object provides:
-
-       values:          the combined key and value settings
-       argv:            remaining argument(not the options) of the command line
-       defaults_path:   full path to the defaults file
-
-    for the second case(with a mainclass) an application instance of this class
-    is created. The first argument is than taken as method name and executed,
-    again with a context oject provided: 
-
-        prompt: ruby example/run_with_class show 
-
-    will result in the :show method beeing called:
-
-        context = Config.new...
-        ...
-        app = Simple.new...
-        app.show(context)
-
-
-    Conversions
-
-    Commandline options are strings only, but sometimes you need strongly typed
-    primitive values. +app-ctx+ does automatically convert integer and float
-    values, see "examples/conversions.rb" for:
-
-        prompt: ./examples/conversions.rb             
-        {:i=>23, :f=>3.14}
-        typeof 'i': Fixnum
-        typeof 'f': Float
-        prompt: ./examples/conversions.rb -i=17 -f=2.12
-        {:i=>17, :f=>2.12}
-        typeof 'i': Fixnum
-        typeof 'f': Float
-        prompt: ./examples/conversions.rb -i=i -f=f
-        {:i=>"i", :f=>"f"}
-        typeof 'i': String
-        typeof 'f': String
-
-
-    Flags/Boolean values
-    
-    Flags(options without values) are converted to boolean values, see
-    examples/boolean.rb:
-
-        dluesebrink dl-mbook ruby/app-ctx: r examples/boolean.rb 
-        {:bool=>false}
-        typeof 'bool': FalseClass
-        dluesebrink dl-mbook ruby/app-ctx: r examples/boolean.rb  --bool
-        {:bool=>true}
-        typeof 'bool': TrueClass
-
-
-    Ruby Conversions
-    
-    When Fixnum, Float and boolean conversion are not enough, as a last resort,
-    you can use ruby code directly for evaluation of option values. Replacing
-    '=' with ':' results in assigning the ruby evaluation value to the key, see
-    examples/ruby_conv.rb:
-
-        prompt: examples/ruby_conv.rb
-        {:r=>1..10, :a=>[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]}
-        typeof 'r': Range
-        typeof 'a': Array
-        prompt: ./examples/ruby_conv.rb -r:2..3 -a:'(-1..1).to_a'
-        {:r=>2..3, :a=>[-1, 0, 1]}
-        typeof 'r': Range
-        typeof 'a': Array
-        prompt: ./examples/ruby_conv.rb -r:2..3 -a:\(-1..1\).to_a
-        {:r=>2..3, :a=>[-1, 0, 1]}
-        typeof 'r': Range
-        typeof 'a': Array
-
-
+#
+#   = Application Context
+#
+#   Every application needs configuration and app-ctx provides a concise way of
+#   doing it.
+#
+#   For all applications (you are not a mouseclicker, are u?), once in a while
+#   you need to supply some configuration values to overrule the built-in
+#   defaults. The app-ctx gem does unify and organize built-in constants,
+#   config files and commandline option with a clearly defined priority, from
+#   low to high:
+#
+#       - procedural: App::Config#set_default_values
+#       - default values YAML file from next to the $0 script
+#       - user supplied configuration file, eg.: --config=/tmp/foo.yml
+#       - command line options and flags: --foo --bar=foo
+#
+#   But for your application it is of no interesst from where the values are
+#   coming: command line option: "--port=1234", a user configuration file or
+#   from the applications built-in default values. Therefor +app-ctx+ combines
+#   value settings from various sources into a single configuration hash.
+#
+#   basically you have two ways to use it:
+#
+#       require 'app-ctx' # of course,and than...
+#
+#   1. closures (see examples/run_with_block.rb) 
+#
+#       App::ctx.run do |context| ... end
+#
+#   where context object provides:
+#
+#      values:          the combined key and value settings
+#      argv:            remaining argument(not the options) of the command line
+#      defaults_path:   full path to the defaults file
+#
+#
+#   2. with a mainclass(see examples/run_with_class.rb)
+#
+#       App::ctx.run YourClassHere
+#
+#   for the second case(with a mainclass) an application instance of this class
+#   is created. The first argument is than taken as method name and executed,
+#   again with a context oject provided.
+#
+#       $ ruby example/run_with_class show 
+#
+#   will result in the :show method beeing called:
+#
+#       context = Config.new...
+#       ...
+#       app = Simple.new...
+#       app.show(context)
+#
+#
+#   == Conversions
+#
+#   Commandline options are strings only, but sometimes you need strongly typed
+#   primitive values. +app-ctx+ does automatically convert integer and float
+#   values, see "examples/conversions.rb" for:
+#
+#       $ ./examples/conversions.rb             
+#       {:i=>23, :f=>3.14}
+#       typeof 'i': Fixnum
+#       typeof 'f': Float
+#
+#       $ ./examples/conversions.rb -i=17 -f=2.12
+#       {:i=>17, :f=>2.12}
+#       typeof 'i': Fixnum
+#       typeof 'f': Float
+#
+#       $ ./examples/conversions.rb -i=i -f=f
+#       {:i=>"i", :f=>"f"}
+#       typeof 'i': String
+#       typeof 'f': String
+#
+#
+#   == Flags/Boolean values
+#   
+#   Flags(options without values) are converted to boolean values, see
+#   examples/boolean.rb:
+#
+#       $ ruby ./examples/boolean.rb 
+#       {:bool=>false}
+#       typeof 'bool': FalseClass
+#
+#       $ ruby ./examples/boolean.rb  --bool
+#       {:bool=>true}
+#       typeof 'bool': TrueClass
+#
+#
+#   == Ruby Conversions
+#   
+#   When Fixnum, Float and boolean conversion are not enough, as a last resort,
+#   you can use ruby code directly for evaluation of option values. Replacing
+#   '=' with ':' results in assigning the ruby evaluation value to the key, see
+#   examples/ruby_conv.rb:
+#
+#       $ ruby ./examples/ruby_conv.rb
+#       {:r=>1..10, :a=>[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]}
+#       typeof 'r': Range
+#       typeof 'a': Array
+#
+#       $ ruby ./examples/ruby_conv.rb -r:2..3 -a:'(-1..1).to_a'
+#       {:r=>2..3, :a=>[-1, 0, 1]}
+#       typeof 'r': Range
+#       typeof 'a': Array
+#
+#       $ ruby ./examples/ruby_conv.rb -r:2..3 -a:\(-1..1\).to_a
+#       {:r=>2..3, :a=>[-1, 0, 1]}
+#       typeof 'r': Range
+#       typeof 'a': Array
+#
+#
+#   have fun
+#   dirk
+#
 # vim: set tw=80 syntax=txt nosmartindent:

data/examples/boolean.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'app-ctx'
+
+Defaults = {:bool=>false}
+
+App::run do |context|
+    h = Defaults.update(context.values)
+    puts h.inspect
+    puts "typeof 'bool': #{h[:bool].class}"
+end
+

data/examples/conversions.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'app-ctx'
+
+Defaults = {:i => 23, :f => 3.14,:bool=>false}
+
+App::run do |context|
+    h = Defaults.update(context.values)
+    puts h.inspect
+    puts "typeof 'i': #{h[:i].class}"
+    puts "typeof 'f': #{h[:f].class}"
+    puts "typeof 'bool': #{h[:bool].class}"
+end
+

data/examples/ruby_conv.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'app-ctx'
+
+Defaults = {:r => 1..10, :a=>(1..10).to_a}
+
+App::run do |context|
+    h = Defaults.update(context.values)
+    puts h.inspect
+    puts "typeof 'r': #{h[:r].class}"
+    puts "typeof 'a': #{h[:a].class}"
+end
+

data/examples/run_with_block.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'app-ctx'
+
+class Simple
+    # $ ./examples/run_with_block.rb add 1 5
+    # 1 + 5 = 6
+    # $
+    def add a, b
+        puts "#{a} + #{b} = #{a + b}"
+    end
+
+    # $ ./examples/run_with_block.rb add 1 5
+    # 1 + 5 = 6
+    # $
+    def sub a, b
+        puts "#{a} - #{b} = #{a - b}"
+    end
+end
+
+
+App::run do |context|
+    puts context
+    Simple.new.send(context.argv.shift, *context.argv)
+end
+

data/examples/run_with_class.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'app-ctx'
+
+class Simple
+
+    # $ ./examples/run_with_class.rb add 1 5
+    # 1 + 5 = 6
+    # $
+    def add context
+        a, b = context.argv 
+        puts "#{a} + #{b} = #{a + b}"
+    end
+
+    # $ ./examples/run_with_class.rb mult 1 5
+    # 1 * 5 = 5
+    # $
+    def mult context
+        a, b = context.argv 
+        puts "#{a} * #{b} = #{a * b}"
+    end
+
+    # $ ./examples/run_with_class.rb sub 1 5
+    # 1 - 5 = -4
+    # $
+    def sub context
+        a, b = context.argv
+        puts "#{a} - #{b} = #{a - b}"
+    end
+
+    # $ ./examples/run_with_class.rb --foo --bar=1 show like no other
+    #        args : ["like", "no", "other"]
+    #      values : {:foo=>true, :bar=>1}
+    #    defaults : '/Users/dluesebrink/ruby/app-ctx/examples/run_with_class.yml'
+    # user config : ''
+    #   arguments : like, no, other
+    # $
+    def show context
+        puts context
+        puts "arguments: #{context.argv.join(", ")}"
+    end
+
+    def some_func context
+        puts "some_func called: #{context.argv.join(", ")}"
+    end
+end
+
+App::run :class => Simple

data/examples/set_default_values.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'app-ctx'
+
+class Simple
+
+    def initialize(context)
+        context.set_default_values({
+            :desc => "programatically setting default values",
+            :port => 1234,
+        })
+    end
+
+    def show context
+        puts context
+        puts "arguments: #{context.argv.join(", ")}"
+    end
+end
+
+App::run :class => Simple

data/lib/app-ctx.rb

@@ -108,7 +108,7 @@ module App
 
             #[@values.dup.update(c), av]
             @values.update(c)
-            [@values, argv]
+            [@values, argv.map { |e| parse_arg(e) }]
         end
 
         def parse_arg val

data/test/t_app-ctx.rb

@@ -144,6 +144,15 @@ class AppConfigTest < Test::Unit::TestCase
         assert ! cfg[:b]
     end
 
+    def test_parse_command_line_argument_conversion
+        puts "\n --> #{self.name}"
+
+        c = Config.new :argv => ["string", "5", "2.34"]
+        cfg, av = c.values, c.argv
+        assert_equal({}, cfg)
+        assert_equal ["string", 5, 2.34], av
+    end
+
     def test_parse_command_line_int_float_flags
         puts "\n --> #{self.name}"
 

metadata

@@ -3,13 +3,13 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: app-ctx
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2006-09-18 00:00:00 +02:00
+  version: 0.1.3
+date: 2006-10-21 00:00:00 +02:00
 summary: command line application startup and config context
 require_paths: 
 - lib
-email: dirk.luesebrink@idmedia.com
-homepage: http://www.idmedia.com/
+email: dirk@sebrink.de
+homepage: http://www.sofasportler.de/dirk.blog, http://www.sebrink.de/
 rubyforge_project: 
 description: 
 autorequire: 
@@ -28,9 +28,16 @@ cert_chain:
 authors: 
 - Dirk Luesebrink
 files: 
+- examples/boolean.rb
+- examples/conversions.rb
+- examples/ruby_conv.rb
+- examples/run_with_block.rb
+- examples/run_with_class.rb
+- examples/set_default_values.rb
 - lib/app-ctx.rb
 - lib/app-ctx/dlog.rb
 - test/t_app-ctx.rb
+- CHANGELOG
 - README
 test_files: 
 - test/t_app-ctx.rb
@@ -38,6 +45,7 @@ rdoc_options:
 - --main
 - README
 extra_rdoc_files: 
+- CHANGELOG
 - README
 executables: []