fhlow 1.91.0

data/lib/module_fhlow/pen.rb

@@ -0,0 +1,101 @@
+#----------------------------------------------------------------------------
+# 
+# Copyright (C) 2007 Simon Lasselsberger
+# simon.lasselsberger@fh-hagenberg.at
+#
+# This file is part of the _fhlow_ scripting environment.
+#
+# The _fhlow_ scripting environment is free software; you can redistribute 
+# it and/or modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# _fhlow_ is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with _fhlow_; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#----------------------------------------------------------------------------
+
+
+require 'ansicolor'
+
+module Fhlow
+
+
+    # The class Pen is a wrapper to the standard output function from IO. It is able
+    # to add colors to the output by mixing in the module Term::ANSIColor from rubyforge.
+    # It also adds a border to the output with a header (Pen.welcome) and a footer (Pen.bye).
+    class Pen
+        include Term::ANSIColor
+
+        # Initializes the members.
+        # +_outstream+::    The IO obejct to be used for output.
+        # +_coloring+::     Set to +true+ for colorful output or +false+ for no colors.
+        # +_prefix+::       This is the prefix that will be added in front of every line.
+        # +_width+::        The width of the border in amount of characters.
+        def initialize(_outstream, _coloring, _prefix=lightblue+"| "+clear, _width=80)
+            @@coloring = _coloring
+            @outstream = _outstream
+            @prefix    = Hash.new
+            @prefix[true]   = _prefix
+            @prefix[false]  = uncolored(_prefix)
+            @width = _width
+        end
+
+        # Turns colors off.
+        def noColor
+            @@coloring = false
+        end
+
+        # Prints the header.
+        # +_msg+:: The message inside the header.
+        def header(_msg="fhlow - fast handling of a lot of work")
+            @width = _msg.length+2 if _msg.length > @width
+            @outstream.print lightblue, ",", "-"*@width, "+\n", clear
+            @outstream.print lightblue, "| ", clear, _msg.center(@width-2), lightblue, " |\n", clear
+            @outstream.print lightblue, "+", "-"*@width, "+\n", clear
+        end
+
+        # Prints a seperator line.
+        # +_color+:: The color of the line.
+        def seperator(_color=lightblue)
+            @outstream.print _color, "+", "-"*@width, "+\n", clear
+        end
+
+        # Prints the footer.
+        # +_msg+:: The message inside the footer.
+        def footer(_msg="work done!")
+            @width = _msg.length+2 if _msg.length > @width
+            @outstream.print lightblue, "+", "-"*@width, "+\n", clear
+            @outstream.print lightblue, "| ", clear, _msg.center(@width-2), lightblue, " |\n", clear
+            @outstream.print lightblue, "`", "-"*@width, "+\n", clear
+        end
+
+        # Prints a newline without adding the prefix.
+        def nl
+            @outstream.print "\n"
+        end
+
+        # Behaves like IO.print but adds the prefix to each line.
+        # <tt>*_strings</tt>:: An Array of objects that will be passed to IO.print.
+        def print(*_strings)
+            _strings.each { |s| s.gsub!(/\n(?!\z)/, "\n"+lightblue+"| "+clear) }
+            @outstream.print @prefix[@@coloring], _strings
+        end
+
+        # Behaves like IO.puts but adds the prefix to each line.
+        # <tt>*_strings</tt>:: An Array of objects that will be passed to IO.puts.
+        def puts(*_strings)
+            _strings.each { |s| s.gsub!(/\n(?!\z)/, "\n"+lightblue+"| "+clear) }
+            @outstream.puts @prefix[@@coloring]+_strings.join 
+        end
+
+    end
+
+end
+

data/lib/module_fhlow/plugin.rb

@@ -0,0 +1,54 @@
+require 'cmdparse'
+
+module Fhlow
+
+    # This _abstract_ class Plugin acts a super class for concrete Plugins 
+    class Plugin
+        # The Object that contains the command and the subcommand of a Plugin.
+        attr_reader :cmd
+
+        private
+            # Initializes the Plugin.
+            # +_actualLeaf+::   Reference to the Leaf you are working on.
+            # +_pen+::          Reference to a Pen output object.
+            # +_log+::          Reference to a Log object.
+            def initialize(_actualLeaf, _pen, _log)
+                @pen = _pen
+                @log = _log
+                @actualLeaf = _actualLeaf
+                @cmd = CmdParse::Command.new(self.class.to_s, true, true)
+                @cmd.pen = @pen
+            end
+
+            # Describes the Plugins main command. The name of the main command
+            # is the name of the Plugin subclass.
+            # +_shortdesc+::    A short description of the command.
+            # +_desc+::         A longer description of the command.
+            # +_options+::      An initialized object from CmdParse::OptionParserWrapper.
+            def describeCmd(_shortdesc, _desc="", _options=nil)
+                @cmd.short_desc = _shortdesc
+                @cmd.description = _desc
+                @cmd.options = _options if _options
+            end
+
+
+            # Descibes a subcommand of the plugin.
+            # +_name+::         The name of the subcommand.
+            # +_shortdesc+::    A short description of the command.
+            # +_desc+::         A longer description of the command.
+            # +_options+::      An initialized object from CmdParse::OptionParserWrapper.
+            # +_&action::       A Block that will be executed when the command is used.
+            def registerSubCmd(_name, _shortdesc="", _desc="", _options=nil, &_action)
+                subcmd = CmdParse::Command.new(_name, false)
+                subcmd.pen = @pen
+                subcmd.short_desc = _shortdesc
+                subcmd.description = _desc
+                subcmd.set_execution_block(&_action)
+                subcmd.options = _options if _options
+                @cmd.add_command(subcmd)
+            end
+
+    end
+
+end
+

data/lib/module_fhlow/pluginpool.rb

@@ -0,0 +1,81 @@
+#----------------------------------------------------------------------------
+# 
+# Copyright (C) 2007 Simon Lasselsberger
+# simon.lasselsberger@fh-hagenberg.at
+#
+# This file is part of the _fhlow_ scripting environment.
+#
+# The _fhlow_ scripting environment is free software; you can redistribute 
+# it and/or modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# _fhlow_ is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with _fhlow_; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#----------------------------------------------------------------------------
+
+require 'log'
+
+module Fhlow
+    
+    # A Pluginpool is a container that loads, initializes and stores references to
+    # the loaded plugins.
+    class Pluginpool
+
+        # Loads and initializes the loaded plugins.
+        # +_plugindir+::    The direcotry where the plugins can be found.
+        # +_actualLeaf+::   Reference to the Leaf you are working on.
+        # +_pen+::          Reference to a Pen output object.
+        # +_log+::          Reference to a Log object.
+        def initialize(_plugindir, _actualLeaf, _pen, _log)
+            @pool = Array.new
+            @log  = _log
+            @pen  = _pen
+            @plugindir = _plugindir
+            @actualLeaf = _actualLeaf
+
+
+            Dir.glob(@plugindir+"*.rb").each do |plugin|
+                
+                pluginname = File.basename(plugin, ".rb").capitalize
+
+                require plugin
+
+                @pool.push(Kernel.const_get(pluginname).new(@actualLeaf, @pen, @log))
+                @log.info(self, "loaded plugin "+plugin)
+            end
+
+        end
+
+        # Prints all loaded plugins.
+        def printMe
+            width = 50
+            @pen.print ",", "-"*width, "+\n"
+            @pen.print "|", " Pluginpool:".ljust(width),"|\n"
+            @pen.print "+", "-"*width, "+\n"
+            
+            @pool.each do |plugin|
+                str = "   ["+@pen.lightgreen+plugin.to_s+@pen.clear+"]"+@pen.clear
+                @pen.print "|", str.ljust(width+(str.length-@pen.uncolored(str).length)),  "|\n"
+            end
+            
+            @pen.print "`", "-"*width, "+\n"
+        end
+
+        # Calls +&block+ for each Plugin. This is a Wraper to Array.each.
+        # +&_block+:: The Block that will be invoked for each Plugin.
+        def each(&_block)
+            @pool.each(&_block)
+        end
+
+    end
+
+end
+

data/lib/module_fhlow/rootnode.rb

@@ -0,0 +1,98 @@
+#----------------------------------------------------------------------------
+# 
+# Copyright (C) 2006 Simon Lasselsberger
+# simon.lasselsberger@fh-hagenberg.at
+#
+# This file is part of the _fhlow_ scripting environment.
+#
+# The _fhlow_ scripting environment is free software; you can redistribute 
+# it and/or modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# _fhlow_ is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with _fhlow_; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#----------------------------------------------------------------------------
+require 'node'
+require 'config'
+require 'leaffactory'
+
+module Fhlow
+
+    # This class represents the root directory of one fhlow environment and is therefore
+    # the main Node with +@nodelevel+ = 0.
+    class RootNode < Node
+        
+        public
+            # Initializes the memebers and the LeafFactory.
+            # +_log+::  A reference to a Log object.
+            # +_pen+::  A reference to a Pen output object.
+            #
+            def initialize(_defaultconf, _log, _pen, _path=RootNode.detectFhlowRootDir)
+                
+                # don't do anything if _path is nil
+                raise FhlowException.new(self.class), "Couldn't detect the fhlow root directory!" if _path.nil?
+                raise FhlowException.new(self.class), "You have to provide a default configuration object!" if !_defaultconf.instance_of?(Config::Config)
+                
+                @path = _path
+                @conf = _defaultconf
+
+                # load all the leaf classes
+                LeafFactory.load(@path+"/flw/core/lib/module_fhlow/leafs/")
+
+                super("", "RootNode", self, 0, _log, _pen)
+
+                @nodes.each_value { |node| node.fetchDependencies() }
+            
+            end
+
+            def getActualLeaf(_dir=Dir.pwd)
+                raise FhlowException.new(self.class), "couldn't detect the actual child!" if _dir =~ /.*\/flw\/.*/
+                
+                ofp = _dir.gsub(@path,"").split("/")
+                
+                prefixfound = false
+                
+                begin
+
+                    @conf["fhlow"]["LeafPrefixes"].reverse.each do |prefixlevel|
+                        prefixlevel.split(",").each do |prefix|
+                            prefixfound = true if ofp[-1] =~ /#{prefix}.*/
+                            return getLeaf(ofp) if prefixfound && ofp.length > 1
+                            raise FhlowException.new(self.class), "couldn't detect the actual child!" if ofp.length < 2
+                        end
+                    end
+
+                    ofp.delete_at(-1) if !prefixfound
+
+                end until prefixfound == true
+
+            end
+
+            
+            # Returns the path to the fhlow root directory.
+            def getPath
+                @path
+            end
+
+
+            # Tries to detect the root directory of the actual fhlow root directory by parsing
+            # the string provided by 'Dir.pwd'. 
+            # +_dir+:: The directory that will be used to find the fhlow root directory.
+            def RootNode.detectFhlowRootDir(_dir=Dir.pwd)
+                if Dir.entries(_dir).include?("flw")
+                    return _dir+"/"
+                else
+                    return detectFhlowRootDir(_dir.gsub(/(.*)\/\w*[\/]*/,'\1'))
+                end
+
+            end
+    end
+end

data/lib/module_fhlow/test.rb

@@ -0,0 +1,15 @@
+class X
+    def foo(bla=self)
+        p bla
+    end
+end
+
+class Call
+    def doit()
+        X.new.foo()
+    end
+end
+
+Call.new.doit()
+X.new.foo()
+

data/lib/module_term/ansicolor.rb

@@ -0,0 +1,102 @@
+module Term
+  module ANSIColor
+    @@attributes = [
+      [ :clear        ,   0 ], 
+      [ :reset        ,   0 ],     # synonym for :clear
+      [ :bold         ,   1 ], 
+      [ :dark         ,   2 ], 
+      [ :italic       ,   3 ],     # not widely implemented
+      [ :underline    ,   4 ], 
+      [ :underscore   ,   4 ],     # synonym for :underline
+      [ :blink        ,   5 ], 
+      [ :rapid_blink  ,   6 ],     # not widely implemented
+      [ :negative     ,   7 ],     # no reverse because of String#reverse
+      [ :concealed    ,   8 ], 
+      [ :strikethrough,   9 ],     # not widely implemented
+      [ :black        ,  30 ], 
+      [ :red          ,  31 ], 
+      [ :green        ,  32 ], 
+      [ :yellow       ,  33 ], 
+      [ :blue         ,  34 ], 
+      [ :magenta      ,  35 ], 
+      [ :cyan         ,  36 ], 
+      [ :white        ,  37 ], 
+      [ :on_black     ,  40 ], 
+      [ :on_red       ,  41 ], 
+      [ :on_green     ,  42 ], 
+      [ :on_yellow    ,  43 ], 
+      [ :on_blue      ,  44 ], 
+      [ :on_magenta   ,  45 ], 
+      [ :on_cyan      ,  46 ], 
+      [ :on_white     ,  47 ], 
+      [ :lightred     , "01;31"],
+      [ :lightgreen   , "01;32"],
+      [ :lightyellow  , "01;33"],
+      [ :lightblue    , "01;34"],
+      [ :lightmagenta , "01;35"],
+      [ :lightcyan    , "01;36"],
+    ]
+
+
+    # Returns true, if the coloring function of this module
+    # is switched on, false otherwise.
+    def self.coloring?
+      @@coloring
+    end
+
+    # Turns the coloring on or off globally, so you can easily do
+    # this for example:
+    #  Term::ANSIColor::coloring = STDOUT.isatty
+    def self.coloring=(val)
+      @@coloring = val
+    end
+    self.coloring = true
+
+    @@attributes.each do |c, v|
+      eval %Q{
+          def #{c}(string = nil)
+            result = ''
+            result << "\e[#{v}m" if @@coloring 
+            if block_given?
+              result << yield
+            elsif string
+              result << string
+            elsif respond_to?(:to_str)
+              result << self
+            else
+              return result #only switch on
+            end
+            result << "\e[0m" if @@coloring
+            result
+          end
+      }
+    end
+
+    # Regular expression that is used to scan for ANSI-sequences. It is used to
+    # uncolor strins.
+    COLORED_REGEXP = /\e\[([34][0-7]|[0-9]|01;3[1-6])m/
+
+    # Returns an uncolored version of the string, that is all
+    # ANSI-sequences are stripped from the string.
+    def uncolored(string = nil) # :yields:
+      if block_given?
+        yield.gsub(COLORED_REGEXP, '')
+      elsif string
+        string.gsub(COLORED_REGEXP, '')
+      elsif respond_to?(:to_str)
+        gsub(COLORED_REGEXP, '')
+      else
+        ''
+      end
+    end
+
+    module_function
+
+    # Returns an array of all Term::ANSIColor attributes as symbols.
+    def attributes
+      @@attributes.map { |c| c.first }
+    end
+    extend self
+  end
+end
+    # vim: set et sw=2 ts=2: