rubikon 0.4.1 → 0.5.0

data/lib/rubikon/command.rb

@@ -56,6 +56,8 @@ module Rubikon
       end
     end
 
+    private
+
     # Add a new parameter for this command
     #
     # @param [Parameter, Hash] parameter The parameter to add to this
@@ -119,6 +121,11 @@ module Rubikon
     # @see Flag
     # @see Option
     def parse_arguments(args)
+      current_param = Application::InstanceMethods.
+        instance_method(:current_param).bind(@app)
+      set_current_param = Application::InstanceMethods.
+        instance_method(:current_param=).bind(@app)
+
       @args = []
       args.each do |arg|
         if arg.start_with?('-')
@@ -128,20 +135,20 @@ module Rubikon
         end
 
         unless parameter.nil?
-          @app.current_param.active! unless @app.current_param.nil?
-          @app.current_param = parameter
+          current_param.call.send(:active!) unless current_param.call.nil?
+          set_current_param.call(parameter)
           next
         end
 
-        if @app.current_param.nil? || !@app.current_param.more_args?
+        if current_param.call.nil? || !current_param.call.send(:more_args?)
           self << arg
         else
-          @app.current_param << arg
+          current_param.call.send(:<<, arg)
         end
       end
 
-      @app.current_param.active! unless @app.current_param.nil?
-      @app.current_param = nil
+      current_param.call.send(:active!) unless current_param.call.nil?
+      set_current_param.call(nil)
     end
 
     # Resets this command to its initial state
@@ -150,7 +157,9 @@ module Rubikon
     # @since 0.4.0
     def reset
       super
-      @params.values.uniq.each { |param| param.reset if param.is_a? Parameter }
+      @params.values.uniq.each do |param|
+        param.send(:reset) if param.is_a? Parameter
+      end
     end
 
     # Checks whether a parameter with the given name exists for this command
@@ -171,7 +180,8 @@ module Rubikon
     def run(*args)
       parse_arguments(args)
       check_args
-      @app.sandbox.instance_eval(&@block)
+      Application::InstanceMethods.instance_method(:sandbox).bind(@app).call.
+        instance_eval(&@block)
     end
 
   end

data/lib/rubikon/config/auto_provider.rb

@@ -0,0 +1,39 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010, Sebastian Staudt
+
+module Rubikon
+
+  module Config
+
+    # A configuration provider loading various configuration file formats using
+    # another provider depending on the extension of the configuration file.
+    #
+    # @author Sebastian Staudt
+    # @since 0.5.0
+    class AutoProvider
+
+      # Load a configuration file with the corresponding provider detected
+      # from the file extension
+      #
+      # @param [String] file The path of the config file to load
+      # @return [Hash] The configuration values loaded from the file
+      # @see YamlProvider
+      def self.load_config(file)
+        ext = File.extname(file)
+        case ext
+          when '.ini'
+            IniProvider.load_config file
+          when '.yaml', '.yml'
+            YamlProvider.load_config file
+          else
+            raise UnsupportedConfigFormatError.new(ext)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/rubikon/config/factory.rb

@@ -0,0 +1,65 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010, Sebastian Staudt
+
+require 'rubikon/config/auto_provider'
+require 'rubikon/config/ini_provider'
+require 'rubikon/config/yaml_provider'
+
+module Rubikon
+
+  # This module contains several classes used to load configuration data from
+  # various sources
+  #
+  # @author Sebastian Staudt
+  # @since 0.5.0
+  module Config
+
+    # The configuration factory is used to load one or more configuration
+    # files from different search paths and using different file formats, e.g.
+    # YAML.
+    #
+    # @author Sebastian Staudt
+    class Factory
+
+      # Providers available for use
+      PROVIDERS = [ :auto, :ini, :yaml ]
+
+      # @return [Hash] The configuration data loaded from the configuration
+      #         files found inside the search paths
+      attr_reader :config
+
+      # @return [Array<String>] The paths of the configuration files found and
+      #        loaded 
+      attr_reader :files
+
+      # Creates a new factory instance with a given file name to be searched in
+      # the given paths and using the specified provider to load the
+      # configuration data from the files.
+      #
+      # @param [String] name The name of the configuration file
+      # @param [Array<String>] search_paths An array of paths to be searched
+      #        for configuration files
+      # @param [PROVIDERS] provider The provider to use for loading
+      #        configuration data from the files found
+      def initialize(name, search_paths, provider = :yaml)
+        provider = :auto unless PROVIDERS.include?(provider)
+        provider = Config.const_get("#{provider.to_s.capitalize}Provider")
+      
+        @files  = []
+        @config = {}
+        search_paths.each do |path|
+          config_file = File.join path, name
+          if File.exists? config_file
+            @config.merge! provider.load_config(config_file)
+            @files << config_file
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/rubikon/config/ini_provider.rb

@@ -0,0 +1,60 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010, Sebastian Staudt
+
+module Rubikon
+
+  module Config
+
+    # A configuration provider loading configuration data from INI files
+    #
+    # @author Sebastian Staudt
+    # @since 0.5.0
+    class IniProvider
+
+      # Loads a configuration Hash from a INI file
+      #
+      # This method is taken from code written by gdsx in #ruby-lang (see
+      # http://snippets.dzone.com/posts/show/563).
+      #
+      # @param [String] file The path of the file to load
+      # @return [Hash] The configuration data loaded from the file
+      def self.load_config(file)
+        content = File.new(file).readlines.map do |line|
+          line.gsub(/(?:#|;).*/, '').strip
+        end.join("\n")
+
+        config = {}
+        content = content.split(/\[([^\]]+)\]/)[1..-1]
+        content.inject([]) do |temp, field|
+          temp << field
+          if temp.length == 2
+            value = temp[1].sub(/^\s+/,'').sub(/\s+$/,'')
+            if config[temp[0]].nil?
+              config[temp[0]] = value
+            else
+              config[temp[0]] << "\n#{value}"
+            end
+            temp.clear
+          end
+          temp
+        end
+
+        config.dup.each do |key, value|
+          value_list = value.split /[\r\n]+/
+          config[key] = value_list.inject({}) do |hash, val|
+            k, v = val.split /\s*=\s*/
+            hash[k] = v
+            hash
+          end
+        end
+
+        config
+      end
+
+    end
+
+  end
+
+end

data/lib/rubikon/config/yaml_provider.rb

@@ -0,0 +1,30 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010, Sebastian Staudt
+
+require 'yaml'
+
+module Rubikon
+
+  module Config
+
+    # A configuration provider loading configuration data from YAML files
+    #
+    # @author Sebastian Staudt
+    # @since 0.5.0
+    class YamlProvider
+
+      # Loads a configuration Hash from a YAML formatted file
+      #
+      # @param [String] file The path of the file to load
+      # @return [Hash] The configuration data loaded from the file
+      def self.load_config(file)
+        YAML.load_file file
+      end
+
+    end
+
+  end
+
+end

data/lib/rubikon/exceptions.rb

@@ -78,4 +78,16 @@ module Rubikon
 
   end
 
+  # Raised if a command has been supplied that does not exist
+  #
+  # @author Sebastian Staudt
+  # @since 0.5.0
+  class UnsupportedConfigFormatError < ArgumentError
+
+    def initialize(ext)
+      super "Unknown config file extension: #{ext}"
+    end
+
+  end
+
 end

data/lib/rubikon/flag.rb

@@ -18,6 +18,8 @@ module Rubikon
 
     include Parameter
 
+    private
+
     # Adds an argument to this flag
     #
     # @param arg (see Parameter#<<)

data/lib/rubikon/has_arguments.rb

@@ -78,6 +78,8 @@ module Rubikon
       @args[arg]
     end
 
+    protected
+
     # Adds an argument to this parameter. Arguments can be accessed inside the
     # application code using the args method.
     #

data/lib/rubikon/parameter.rb

@@ -36,14 +36,6 @@ module Rubikon
       @name    = name.to_sym
     end
 
-    # Marks this parameter as active when it has been supplied by the user on
-    # the command-line. This also calls the code block of the parameter if it
-    # exists
-    def active!
-      @active = true
-      @app.sandbox.instance_eval(&@block) unless @block.nil?
-    end
-
     # Returns whether this parameter has is active, i.e. it has been supplied
     # by the user on the command-line
     #
@@ -53,6 +45,17 @@ module Rubikon
     end
     alias_method :given?, :active?
 
+    protected
+
+    # Marks this parameter as active when it has been supplied by the user on
+    # the command-line. This also calls the code block of the parameter if it
+    # exists
+    def active!
+      @active = true
+      Application::InstanceMethods.instance_method(:sandbox).bind(@app).call.
+        instance_eval(&@block) unless @block.nil?
+    end
+
     # Resets this parameter to its initial state
     #
     # @since 0.4.0

data/lib/rubikon/progress_bar.rb

@@ -35,13 +35,19 @@ module Rubikon
       end
       @maximum.round
 
-      @progress_char = options[:char] || '#'
-      @ostream  = options[:ostream] || $stdout
-      @progress = 0
-      @size     = options[:size] || 20
-      @factor   = @size.round.to_f / @maximum
-      @value    = 0
+      @progress_char  = options[:char] || '#'
+      @ostream        = options[:ostream] || $stdout
+      @progress       = 0
+      @size           = options[:size] || 20
+      @factor         = @size.round.to_f / @maximum
+      @value          = 0
+      @brackets       = options[:brackets] || false
+      @bracket_filler = options[:bracket_filler] || ' '
 
+      if @brackets
+        @ostream << '[' + @bracket_filler * @size + ']'+ "\b" * (@size + 1)
+        @ostream.flush
+      end
       self + (options[:start] || 0)
     end
 

data/lib/rubikon/throbber.rb

@@ -21,16 +21,16 @@ module Rubikon
     # @param [Thread] thread The thread that should be watched
     # @see Application::InstanceMethods#throbber
     def initialize(ostream, thread)
-      proc = Proc.new do |ostream, thread|
+      proc = Proc.new do |os, thr|
           step = 0
-          ostream.putc 32
-          while thread.alive?
-            ostream << "\b#{SPINNER[step].chr}"
-            ostream.flush
+          os.putc 32
+          while thr.alive?
+            os << "\b#{SPINNER[step].chr}"
+            os.flush
             step = (step + 1) % 4
             sleep 0.25
           end
-        ostream.putc 8
+        os.putc 8
       end
 
       super { proc.call(ostream, thread) }

data/samples/config/config_sample.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+#
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010, Sebastian Staudt
+
+if ENV['RUBIKON_DEV']
+  require File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'lib', 'rubikon')
+else
+  require 'rubygems'
+  require 'rubikon'
+end
+
+# A Rubikon application demonstrating the configuration feature
+class ConfigSample < Rubikon::Application::Base
+
+  dir = File.dirname __FILE__
+  global_dir = File.join dir, 'global'
+  local_dir = File.join dir, 'local'
+
+  set :config_file, 'config.yml'
+  set :config_paths, [ global_dir, local_dir ]
+
+  global_flag :'exclude-local' do
+    set :config_paths, [ global_dir ]
+
+    puts "Seems like you changed the truth...\n\n"
+  end
+
+  default do
+    puts "A pretty #{config[:string]} example of Rubikon's config."
+    puts "#{config[:number]} is greater than 1."
+    puts "A lie is never #{config[:boolean]}."
+    puts 'Global configs are loaded...' if config[:global]
+    puts 'and overriden by local configs' if config[:local]
+  end
+
+end

data/samples/helloworld/hello_world.rb

@@ -15,11 +15,16 @@ end
 # A relatively simple Hello World application using Rubikon
 class HelloWorld < Rubikon::Application::Base
 
+  set :config_file, 'helloworld.ini'
+  set :config_format, :ini
+
   # Greet the whole world per default
   flag :more
   option :name, [:who]
   option :names, -1
   default 'Simple hello world' do
+    p config
+
     debug 'Starting to greet the world...'
     if given? :name
       greet parameters[:name].who
@@ -38,14 +43,15 @@ class HelloWorld < Rubikon::Application::Base
   # Ask the user for his name and greet him
   command :interactive, 'Greet interactively' do
     name = input 'Please enter your name'
-    greet name
+    call :'__default', '--name', name
   end
 
   # Show a progress bar while iterating through a loop
+  flag :brackets
   command :progress, 'Display a progress bar' do
     put 'Watch my progress while I greet the world: '
     x = 1000000
-    progress_bar(:char => '+', :maximum => x, :size => 30) do |progress|
+    progress_bar(:char => '+', :maximum => x, :size => 30, :brackets => brackets.given?, :bracket_filler => '-') do |progress|
       x.times do
         progress.+
       end