app-ctx 0.1.4 → 0.1.6

data/{CHANGELOG → History.txt}

@@ -1,3 +1,34 @@
+== 0.1.6 / 2007-02-17
+
+* repacked with hoe
+
+Sat Feb 17 10:56:36 CET 2007  dirk@sebrink.de
+  * class#method entrypoints added and hash pimping tested and fixed
+
+Sun Feb 11 15:59:24 CET 2007  dirk@sebrink.de
+  * proof-of-concept: loading plain ruby values from file
+
+Sun Feb 11 15:58:48 CET 2007  dirk@sebrink.de
+  * customized :entrypoints 
+
+Sun Feb 11 15:57:36 CET 2007  dirk@sebrink.de
+  * minor
+
+Sat Dec  2 22:03:46 CET 2006  dirk@sebrink.de
+  * new: forward 
+
+Thu Nov  2 16:42:56 CET 2006  dirk@sebrink.de
+  * bugfix: rdoc include missing for ruby 1.8.5
+
+Thu Nov  2 16:40:37 CET 2006  dirk@sebrink.de
+  * bug fix: rdoc include needed for ruby 1.8.5 version
+
+Sun Oct 29 10:10:32 CET 2006  dirk@sebrink.de
+  * made gemspec file autobuilding
+
+Sat Oct 21 12:23:02 CEST 2006  dirk@sebrink.de
+  * n
+
 Sat Oct 21 11:45:50 CEST 2006  dirk@sebrink.de
   * added examples to gemspec
 
@@ -66,3 +97,4 @@ Thu Aug 24 18:05:58 CEST 2006  dirk@sebrink.de
 
 Wed Aug 23 12:12:00 CEST 2006  dirk@sebrink.de
   * new repository
+

data/Manifest.txt

@@ -0,0 +1,17 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/app-ctx.rb
+lib/app-ctx
+lib/app-ctx/dlog.rb
+test/config-1.yml
+test/config-2.yml
+test/plain-ruby-as-config-dsl.rb
+test/test_app-ctx.rb
+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

data/README.txt

@@ -0,0 +1,151 @@
+app-ctx
+    by dirk luesebrink
+    http://www.sofasportler.de/dirk.blog
+
+== DESCRIPTION:
+  
+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: set from your implementation App::Config#set_default_values
+    - YAML default values file loaded 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.
+
+== SYNOPSIS:
+
+(hint: see also the examples dir)
+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::run :class => Simple
+
+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)
+
+
+= String/Type mappings
+
+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
+
+== REQUIREMENTS:
+
+* the hoe gem
+
+== INSTALL:
+
+* sudo gem install app-ctx --include-dependencies
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/app-ctx.rb'
+
+Hoe.new('app-ctx', App::VERSION) do |p|
+  p.rubyforge_name = 'app-ctx'
+  p.summary = "Every application needs configuration and app-ctx provides a concise way of doing it."
+  p.description = p.paragraphs_of('README.txt', 2..4).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/lib/app-ctx.rb

@@ -1,12 +1,14 @@
-
 require 'yaml'
 require 'rdoc/rdoc'
 require 'rdoc/usage'
 
+$:.unshift File.dirname(__FILE__)
 require 'app-ctx/dlog'
 
 module App
 
+    VERSION = '0.1.6'
+
     # the priority of configuation settings is:
     #   1. command line options
     #   2. configuration from custom file, eg.: --config=/tmp/foo.yml
@@ -39,6 +41,14 @@ module App
             @values = defaults.merge(@values)
         end
 
+        # continue processing of command line with next argument from cmdline
+        def forward(target)
+            begin
+                (op = argv.shift) && target.send(op, self)
+            rescue ArgumentError => e
+                target.send(op)
+            end
+        end
 
         def to_s
          <<-EOT
@@ -139,7 +149,7 @@ module App
 
     thank you, good bye and have a nice day
 
-        EOM
+            EOM
         }
 
         def inform message_id, binding
@@ -151,7 +161,13 @@ module App
             @context = context
         end
 
-        def execute clazz = nil
+        def execute opts = {}
+
+            tmp = opts[:entrypoint] || :application_main
+            entrypoint, clazz = tmp.to_s.split("#").reverse
+            clazz = eval "#{clazz ||= opts[:class]}"
+
+            pimp_my_hash(@context.values)
 
             if block_given?
                 warn "attached block takes precedence over class!" if clazz
@@ -165,11 +181,12 @@ module App
             setter_injection app, @context
 
             begin 
+                pimp_my_hash(@context.values) # XXX refresh lost pimping
                 # first try the default entry point
-                app.application_main @context
+                app.send(entrypoint, @context)
 
             rescue NoMethodError => e
-                if app.respond_to? :application_main
+                if app.respond_to?(entrypoint)
                     DL.logger.error "failed invokation", e
                 else
                     if 0 == @context.argv.length 
@@ -182,6 +199,8 @@ module App
                         begin
                             op = @context.argv.shift
                             app.send(op, @context)
+                        rescue ArgumentError => e
+                            app.send(op)
                         rescue => e
                             DL.logger.error "oops: #{e}", e
                         end
@@ -192,6 +211,22 @@ module App
             app # the created application instance
         end
 
+        def pimp_my_hash(h) # as seen on why/redhanded the first time
+            class << h
+                def method_missing(m,*a)
+                    if m.to_s =~ /=$/
+                        self[$`.to_sym] = a[0]
+                    elsif a.empty?
+                        self[m]
+                    else
+                        raise NoMethodError, "#{m}"
+                    end
+                end
+            end
+            h
+        end
+        private :pimp_my_hash
+
         # IoC setter dependency injection:
         # try all context keys as setter class 
         def setter_injection obj, context
@@ -216,7 +251,7 @@ module App
             if block_given? 
                 container.execute {|context| block.call(context) }
             else
-                container.execute params[:class]
+                container.execute(params)
             end
         end
 

data/test/config-1.yml

@@ -0,0 +1,5 @@
+:f: 3.21
+:i: 17
+:empty_hash: {}
+:assoc: 
+    :key: "foo"

data/test/config-2.yml

@@ -0,0 +1,3 @@
+:f2: -3.21
+:assoc: 
+    :key: "bar"

data/test/plain-ruby-as-config-dsl.rb

@@ -0,0 +1,14 @@
+
+title = "plain ruby as config file DSL"
+
+comment = %Q{
+    this file gets loaded on startup and local varibles in-here thereafter
+    become available as part of the global configuration};
+
+require 'date'
+birthday = Date.parse "2007-11-16"
+
+float_value = 1.234
+int_value = 1234
+
+some_string = %q{the quick brown...}

data/test/{t_app-ctx.rb → test_app-ctx.rb}

@@ -8,6 +8,36 @@ require 'app-ctx'
 
 class AppModuleTest < Test::Unit::TestCase
 
+    def load_values_from_file(filepath)
+        b = binding
+        v1 = eval "local_variables", b
+        eval IO.read(filepath), b
+        v2 = eval "local_variables", b
+        (v2 - v1).inject({}) do |c, key|
+            c[key.to_sym] = eval "#{key}", b
+            c
+        end
+    end
+
+    def test_load_values_from_file
+        puts "\n --> #{self.name}"
+        filename = File.join(File.dirname(__FILE__), "plain-ruby-as-config-dsl.rb")
+        c = load_values_from_file(filename)
+        assert_kind_of Hash, c
+        #assert_equal 6, c.size
+        expect = {
+            :float_value => 1.234,
+            :int_value   => 1234,
+            :some_string => "the quick brown...",
+            :title       => "plain ruby as config file DSL",
+            :comment     => %Q{
+    this file gets loaded on startup and local varibles in-here thereafter
+    become available as part of the global configuration},
+            :birthday    => Date.parse("2007-11-16"),
+        }
+        assert_equal expect, c
+    end
+
     class With_application_main
         attr_reader :context
         attr_accessor :baroque
@@ -36,6 +66,32 @@ class AppModuleTest < Test::Unit::TestCase
             @context = context
         end
     end
+
+    def test_customized_entrypoint 
+        puts "\n --> #{self.name}"
+        argv = ["-f", "--foo=bar", "arg1", "arg2"]
+        app = App::run :entrypoint => :entrypoint, :class => ArgumentEntryPoint, :argv => argv
+        assert_not_nil app
+        assert_equal ArgumentEntryPoint, app.class
+        assert_not_nil app.context
+        assert_equal({:f=>true, :foo=>"bar"}, app.context.values)
+        assert_equal ["arg1", "arg2"], app.context.argv
+    end
+
+    def test_class_method_entrypoint
+        puts "\n --> #{self.name}"
+        argv = ["-f", "--foo=bar", "arg1", "arg2"]
+        app = App::run :entrypoint => "AppModuleTest::ArgumentEntryPoint#entrypoint", :argv => argv
+        assert_not_nil app
+        assert_equal ArgumentEntryPoint, app.class
+        assert_not_nil app.context
+        assert_equal({:f=>true, :foo=>"bar"}, app.context.values)
+        assert_equal ["arg1", "arg2"], app.context.argv
+
+        assert_equal true, app.context.values.f
+        assert_equal "bar", app.context.values.foo
+    end
+
     def test_run_without_point
         puts "\n --> #{self.name}"
         argv = ["-f", "--foo=bar", "entrypoint", "first_method_arg"]
@@ -45,6 +101,9 @@ class AppModuleTest < Test::Unit::TestCase
         assert_not_nil app.context
         assert_equal({:f=>true, :foo=>"bar"}, app.context.values)
         assert_equal ["first_method_arg"], app.context.argv
+
+        assert_equal true, app.context.values.f
+        assert_equal "bar", app.context.values.foo
     end
 
 end
@@ -53,19 +112,33 @@ class AppConfigTest < Test::Unit::TestCase
 
     include App
 
+    def test_forward
+        puts "\n --> #{self.name}"
+        class << (recorder = Object.new)
+            def c; "c"; end
+            def method_missing(m, *args, &blk)
+                args.first.forward(self)
+            end
+        end
+        c = Config.new :argv => ["a", "b", "c"]
+        assert_equal "c", c.forward(recorder)
+    end
+
     def test_config_block
         puts "\n --> #{self.name}"
-        App::Config.new do |context| 
+        App::run do |context| 
             puts "--------------->context: #{context.inspect}"
             assert_not_nil context
             assert_equal({}, context.values)
         end
 
-        App::Config.new :argv=>["-f", "--foo=bar", "arg1", "arg2"] do |context| 
+        App::run(:argv=>["-f", "--foo=bar", "arg1", "arg2"]) do |context| 
             puts "--------------->context: #{context.inspect}"
             assert_not_nil context
             assert_equal({:f=>true, :foo=>"bar"}, context.values)
             assert_equal ["arg1", "arg2"], context.argv
+            assert_equal true, context.values.f
+            assert_equal "bar", context.values.foo
         end
     end
 
@@ -73,17 +146,17 @@ class AppConfigTest < Test::Unit::TestCase
         puts "\n --> #{self.name}"
         c = App::Config.new
         # config file does not exist:w
-        c.load_config_file File.join(File.dirname($0), "no-such-file")
+        c.load_config_file File.join(File.dirname(__FILE__), "no-such-file")
         assert_equal({}, c.values)
 
         # load configuration from file
-        c.load_config_file File.join(File.dirname($0), "config-1.yml")
+        c.load_config_file File.join(File.dirname(__FILE__), "config-1.yml")
         assert_equal({
             :f=>3.21, :i=>17, :empty_hash=>{}, :assoc=>{:key=>"foo"}
         }, c.values)
 
         # config overloading
-        c.load_config_file File.join(File.dirname($0), "config-2.yml")
+        c.load_config_file File.join(File.dirname(__FILE__), "config-2.yml")
         assert_equal({
             :f=>3.21, :i=>17, :empty_hash=>{}, 
             :assoc=>{:key=>"bar"}, :f2=>-3.21
@@ -97,8 +170,8 @@ class AppConfigTest < Test::Unit::TestCase
         assert_equal({}, c.values)
 
         # find the default values config file next to the $0 script
-        puts "script: #{$0}"
-        assert_equal File.expand_path($0).sub(/.rb$/, ".yml"), c.defaults_path
+        puts "script: #{$0}" 
+        assert_equal File.expand_path($0).sub(/(.rb)?$/, ".yml"), c.defaults_path
     end
 
     def test_config_path

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: app-ctx
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
-date: 2006-11-02 00:00:00 +01:00
-summary: command line application startup and config context
+  version: 0.1.6
+date: 2007-02-17 00:00:00 +01:00
+summary: Every application needs configuration and app-ctx provides a concise way of doing it.
 require_paths: 
 - lib
-email: dirk@sebrink.de
-homepage: http://www.sofasportler.de/dirk.blog/category/coding/ruby/, http://www.sebrink.de/
-rubyforge_project: 
-description: 
+email: ryand-ruby@zenspider.com
+homepage: "    by dirk luesebrink"
+rubyforge_project: app-ctx
+description: "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: set from your implementation App::Config#set_default_values - YAML default values file loaded 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."
 autorequire: 
 default_executable: 
 bindir: bin
@@ -26,32 +26,44 @@ platform: ruby
 signing_key: 
 cert_chain: 
 authors: 
-- Dirk Luesebrink
+- Ryan Davis
 files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/app-ctx.rb
+- lib/app-ctx
+- lib/app-ctx/dlog.rb
+- test/config-1.yml
+- test/config-2.yml
+- test/plain-ruby-as-config-dsl.rb
+- test/test_app-ctx.rb
 - 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
-rdoc_options: 
-- --main
-- README
-extra_rdoc_files: 
-- CHANGELOG
-- README
+- test/test_app-ctx.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
 executables: []
 
 extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 

data/README

@@ -1,118 +0,0 @@
-#
-#   = 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: