csd 0.1.8 → 0.1.9

data/lib/csd/application/minisip/options/compile.rb

@@ -1,19 +1,9 @@
 # -*- encoding: UTF-8 -*-
-# This file gets eval'ed by the global options parser in lib/csd/rb
-# TODO: There must be a nicer solution for this.
+# This file gets eval'ed by the global options parser in lib/csd/options_parser
 
-self.temp = false
-opts.on("-t", "--temp",
-        "Use a subdirectory in the system's temporary directory",
-        "to download files and not the current directory") do |value|
-  self.temp = value
-end
-
-self.path = nil
-opts.on("--path [PATH]",
-        "Defines the working directory manually.",
-        "(This will override the --temp option)") do |value|
-  self.path = value
+self.apt_get = true
+opts.on("--no-apt-get","Don't run any apt-get commands") do |value|
+  self.apt_get = value
 end
 
 #self.owner = nil
@@ -25,11 +15,6 @@ end
 #  end
 #end
 
-#self.debug_minisip = false
-#opts.on("--debug-minisip","Compile MiniSIP using the --enable-debug flag.") do |value|
-#  self.debug_minisip = value
-#end
-
 self.only_fix_giomm = false
 opts.on("--only-fix-giomm","Forces the AI to do nothing except trying to bugfix the Ubuntu 10.04 giomm") do |value|
   self.only_fix_giomm = value
@@ -40,36 +25,30 @@ opts.on("--ffmpeg-first","Compile FFmpeg before compiling MiniSIP. Default is fi
   self.ffmpeg_first = value
 end
 
-self.apt_get = true
-opts.on("--no-apt-get","Don't run any apt-get commands") do |value|
-  self.apt_get = value
-end
+
+
+opts.headline 'MINISIP LIBRARY OPTIONS'.green.bold
 
 self.bootstrap = true
-opts.on("--no-bootstrap","Don't run any bootstrap commands") do |value|
+opts.on("--no-bootstrap","Don't run the bootstrap command on any MiniSIP library") do |value|
   self.bootstrap = value
 end
 
 self.configure = true
-opts.on("--no-configure","Don't run any configure commands") do |value|
+opts.on("--no-configure","Don't run the configure command on any MiniSIP library") do |value|
   self.configure = value
 end
 
 self.make = true
-opts.on("--no-make","Don't run any make commands") do |value|
+opts.on("--no-make","Don't run the make command on any MiniSIP library") do |value|
   self.make = value
 end
 
 self.make_install = true
-opts.on("--no-make-install","Don't run any make install commands") do |value|
+opts.on("--no-make-install","Don't run the make install command on any MiniSIP library") do |value|
   self.make_install = value
 end
 
-self.make_dist = false
-opts.on("--make-dist","Use `make dist´ instead of `make install´") do |value|
-  self.make_dist = value
-end
-
-opts.on("--only libmcrypto,libmnetuli,etc.", Array, "Process only these libraries") do |list|
+opts.on("--only libmutil,libmsip,etc.", Array, "Process only these libraries") do |list|
   self.only = list
 end

data/lib/csd/application/minisip/unix.rb

@@ -100,7 +100,7 @@ module CSD
           UI.info "Creating plugin target directory".green.bold
           # result = Path.plugins_destination.parent.directory? ? Cmd.run("sudo mkdir #{Path.plugins_destination}") : CommandResult.new
           # TODO: This will maybe need sudo rights in the future
-          Cmd.copy(Dir[File.join('Path.plugins', '*.{l,la,so}')], Path.plugins_destination) if Path.plugins_destination.directory?
+          Cmd.copy(Dir[File.join(Path.plugins, '*.{l,la,so}')], Path.plugins_destination) if Path.plugins_destination.directory?
         end
         
         # Iteratively configures and compiles the internal MiniSIP libraries.
@@ -132,9 +132,8 @@ module CSD
                 Cmd.run("make")
               end
               if Options.make_install
-                maker_command = Options.make_dist ? 'dist' : 'install'
-                UI.info "Make #{maker_command} #{library}".green.bold
-                Cmd.run("make #{maker_command}")
+                UI.info "Make install #{library}".green.bold
+                Cmd.run("make install")
               end
             else
               UI.warn "Skipping minisip library #{library} because it not be found: #{directory}".green.bold
@@ -186,7 +185,7 @@ module CSD
               UI.error "Could not enter #{directory}."
             end
           end
-          Cmd.cd Path.root
+          Cmd.cd '/'
           Cmd.run('minisip_gtk_gui')
         end
         

data/lib/csd/commands.rb

@@ -49,7 +49,7 @@ module CSD
           target.mkpath unless Options.reveal
         rescue Errno::EACCES => e
           result.reason = "Cannot create directory (no permission): #{target}"
-          params[:die_on_failure] ? UI.die(result.reason) : UI.error(result.reason)
+          params[:die_on_failure] ? raise(CSD::Error::Command::MkdirFailed, result.reason) : UI.error(result.reason)
         end
       end
       result.success  = (target.directory? or Options.reveal)
@@ -81,7 +81,7 @@ module CSD
           result.success = target.current_path?
         rescue Exception => e
           result.reason = "Cannot change to directory `#{target}´. Reason: #{e.message}"
-          params[:die_on_failure] ? UI.die(result.reason) : UI.error(result.reason)
+          params[:die_on_failure] ? raise(CSD::Error::Command::CdFailed, result.reason) : UI.error(result.reason)
         end
       end
       result
@@ -165,7 +165,7 @@ module CSD
           end
           result.success = false
           result.reason = "Could not perform replace operation! #{e.message}"
-          params[:die_on_failure] ? UI.die(result.reason) : UI.error(result.reason)
+          params[:die_on_failure] ? raise(CSD::Error::Command::ReplaceFailed, result.reason) : UI.error(result.reason)
         end
         result
       end
@@ -190,7 +190,7 @@ module CSD
     # [+output?+] The command's output as a +String+ (with newline delimiters). Note that the exit code can be accessed via the global variable <tt>$?</tt>
     #
     def run(cmd, params={})
-      default_params = { :die_on_failure => true, :announce_pwd => true, :verbose => Options.verbose, :internal => Options.testmode }
+      default_params = { :die_on_failure => true, :announce_pwd => true, :verbose => Options.verbose, :internal => false }
       params = default_params.merge(params)
       result = CommandResult.new
       cmd = cmd.to_s
@@ -211,12 +211,12 @@ module CSD
           result.output << line
         end
       end
-      UI.separator unless params[:verbose] or params[:internal] or Options.testmode # i.e. if dots are concatenated in the same line, we should create a new line after them
+      UI.separator unless params[:verbose] or params[:internal] # i.e. if dots are concatenated in the same line, we should create a new line after them
       result.status = $?
       result.success = $?.success?
       if params[:die_on_failure] and !result.success
         UI.info result.output unless params[:verbose] # In verbose mode, we don't need to repeat the unsuccessful command's output
-        UI.die "The last command was unsuccessful." 
+        raise CSD::Error::Command::RunFailed, "The last command was unsuccessful." 
       end
       result
     end
@@ -236,7 +236,14 @@ module CSD
       rescue Exception => e
         result.success = false
         result.reason = "Could not perform #{action} operation! #{e.message}"
-        params[:die_on_failure] ? UI.die(result.reason) : UI.error(result.reason)
+        if params[:die_on_failure]
+          case action
+            when :copy then raise CSD::Error::Command::CopyFailed, result.reason
+            when :move then raise CSD::Error::Command::MoveFailed, result.reason
+          end
+        else
+          UI.error result.reason
+        end
       end
       result
     end
@@ -262,7 +269,7 @@ module CSD
       end
       UI.info "Downloading #{name} to #{destination.enquote}".green.bold
       # We will simply return the CommandResult of the run-method.
-      Cmd.run("git clone #{repository} #{destination}", :announce_pwd => false, :verbose => true)
+      Cmd.run("git clone #{repository} #{destination}", :announce_pwd => false)
     end
   
   end

data/lib/csd/container.rb

@@ -2,10 +2,24 @@
 
 module CSD
   class << self
-    # This method chooses and holds the user interface instance.
+    
+    # This method holds the user interface instance.
     #
     def ui
-      @@ui ||= UserInterface::CLI.new
+      # In testmode we don't want to perform caching
+      return choose_ui if Options.testmode
+      # Otherwise we choose and cache the UI here
+      @@ui ||= choose_ui
+    end
+    
+    # This method chooses an user interface instance according to the Options and returns a new instance of it.
+    #
+    def choose_ui
+      if Options.silent
+        UserInterface::Silent.new
+      else
+        UserInterface::CLI.new
+      end
     end
   
     # This method chooses and holds the command execution instance.
@@ -54,6 +68,11 @@ module CSD
   # A wrapper for the Options class to be able to run all methods as class methods.
   #
   class Options
+    # Because the Options class will respond to clear, we must pass it on explicitly to the OptionsParser instance residing in CSD.options
+    #
+    def self.clear
+      ::CSD.options.clear
+    end
     def self.method_missing(meth, *args, &block)
       ::CSD.options.send(meth, *args, &block)
     end

data/lib/csd/error.rb

@@ -23,18 +23,25 @@ module CSD
     module Argument
       class NoApplication < CSDError; status_code(11); end
       class NoAction < CSDError; status_code(12); end
+      class InvalidOption < CSDError; status_code(50); end
     end
     
-    # Errors in this module are related to the Application Module Framework
+    # Errors in this module are raised by the Command module
     #
-    module Application
-      class OptionsSyntax < CSDError; status_code(200); end
+    module Command
+      class RunFailed < CSDError; status_code(60); end
+      class CdFailed < CSDError; status_code(61); end
+      class CopyFailed < CSDError; status_code(62); end
+      class MoveFailed < CSDError; status_code(63); end
+      class ReplaceFailed < CSDError; status_code(64); end
+      class MkdirFailed < CSDError; status_code(65); end
     end
     
-    # Errors in this module are raised by the User Interface
-    # TODO: This has to go :)
-    module UI
-      class Die < CSDError; status_code(1000); end
+    # Errors in this module are related to the Application Module Framework
+    #
+    module Application
+      class OptionsSyntax < CSDError; status_code(100); end
+      class NoInstanceMethod < CSDError; status_code(101); end
     end
   
   end

data/lib/csd/extensions/core/kernel.rb

@@ -0,0 +1,23 @@
+# -*- encoding: UTF-8 -*-
+
+module CSD
+  module Extensions
+    module Core
+      # This module comprises extensions to the Kernel module
+      #
+      module Kernel
+        
+        # Checks whether the AI was executed with superuser rights (a.k.a. +sudo+). Returns +true+ or +false+.
+        #
+        def superuser?
+          Process.uid == 0
+        end
+        
+      end
+    end
+  end
+end
+
+module Kernel #:nodoc:
+  include CSD::Extensions::Core::Kernel
+end

data/lib/csd/extensions/core/object.rb

@@ -1,4 +1,5 @@
 # -*- encoding: UTF-8 -*-
+require 'csd/vendor/active_support/object_extensions'
 
 module CSD
   module Extensions

data/lib/csd/extensions/core/open_struct.rb

@@ -0,0 +1,26 @@
+# -*- encoding: UTF-8 -*-
+require 'ostruct'
+
+module CSD
+  module Extensions
+    module Core
+      # This module comprises extensions to OpenStruct.
+      #
+      module OpenStruct
+        
+        # Deletes all attributes of this OpenStruct instance.
+        #
+        def clear
+          testmode = self.testmode # This is the only thing we would not like to overwrite. It indicates whether we are running our Test Suite or not.
+          @table = {}
+          self.testmode = testmode
+        end
+        
+      end
+    end
+  end
+end
+
+class Object #:nodoc:
+  include CSD::Extensions::Core::OpenStruct
+end

data/lib/csd/options_parser.rb

@@ -35,6 +35,8 @@ module CSD
     end
     
     def clear
+      # Resetting all attributes to nil (because e.g. an application instance might have modified or added some).
+      super
       # First we define all valid actions and scopes
       self.actions = []
       self.scopes  = []
@@ -83,18 +85,9 @@ module CSD
     #
     def parse_options
       OptionParser.new do |opts|
-        self.banner = Applications.current ? "ADVANCED HELP FOR #{Applications.current.name}" : "Usage: ".bold + "ai [help] [TASK] APPLICATION [OPTIONS]"
+        self.banner = Applications.current ? 'OPTIONS' : "Usage: ".bold + "#{CSD.executable} [help] [TASK] APPLICATION [OPTIONS]"
         opts.banner = self.banner.magenta.bold
 
-        unless Applications.current
-          opts.headline "EXAMPLE COMMANDS".green.bold
-          opts.list_item 'ai', 'Lists all available applications'
-          opts.list_item 'ai minisip', 'Lists available tasks for the application MiniSIP'
-          opts.list_item 'ai minisip --developer', 'Lists advanced AI tasks for the application MiniSIP'
-          opts.list_item 'ai compile minisip', 'Downloads MiniSIP and compiles it'
-          opts.list_item 'ai help compile minisip', 'Shows more details about the different compiling options'
-        end
-      
         # Here we load application-specific options file.
         # TODO: There must be a better way for this in general than to eval the raw ruby code
         begin
@@ -117,30 +110,32 @@ module CSD
         #opts.on("-l", "--local","Assume that there is no uplink to the Internet") do |value|
         #  self.online = !value
         #end
-        opts.on("-r", "--reveal","List all commands that normally would be executed in this operation") do |value|
+        opts.on("-r", "--reveal","List all commands that normally would be executed in this operation (preview-mode)") do |value|
           self.reveal = value
         end
         opts.on("-e", "--verbose","Show more elaborate output") do |value|
           self.verbose = value
         end
-        opts.on("-d", "--debug","Show more elaborate output and debugging information") do |value|
+        opts.on("-d", "--debug","Show more elaborate output and debugging information about the AI") do |value|
           self.debug = value
         end
         opts.on("-s", "--silent","Don't show any output") do |value|
           self.silent = value
         end
-        opts.on_tail("-a", "--developer", "Activating advanced AI functionality (developers only)") do |value|
-          self.developer = value
-        end
+        #opts.on_tail("-a", "--developer", "Activating advanced AI functionality (developers only)") do |value|
+        #  self.developer = value
+        #end
         opts.on_tail("-h", "--help", "Show detailed help (regarding the given ACTION and APPLICATION)") do |value|
           self.help = value
         end
-        opts.on_tail("-v", "--version", "Show version") do
+        opts.on_tail("-v", "--version", "Show the version of this AI") do
           puts "CSD Gem Version: #{CSD::Version}".blue
           exit
         end
         self.helptext = opts.help
       end.parse!
+      rescue OptionParser::InvalidOption => e
+        raise Error::Argument::InvalidOption, e.message.gsub('invalid option: ', 'This option argument seems to be incorrect: ')
     end
 
   end

data/lib/csd/user_interface/base.rb

@@ -1,10 +1,18 @@
 # -*- encoding: UTF-8 -*-
+
 module CSD
+  # User Interaction is performed within this namespace.
+  #
   module UserInterface
+    # This is the parent class of all user interfaces.
+    #
     class Base
-    
+      
       def separator
       end
+      
+      def indicate_activity
+      end
     
       def debug(message)
       end
@@ -17,9 +25,6 @@ module CSD
 
       def error(message)
       end
-    
-      def die(message)
-      end
 
     end
   end

data/lib/csd/user_interface/cli.rb

@@ -6,35 +6,30 @@ module CSD
     class CLI < Base
     
       include Gem::UserInteraction
-    
+      
       def separator
-        say
+        $stdout.puts
       end
       
       def indicate_activity
         $stdout.putc '.'
         $stdout.flush
       end
-    
+      
       def debug(message)
-        say "DEBUG: #{message}".magenta if Options.debug and !Options.silent
+        $stdout.puts "DEBUG: #{message}".magenta if Options.debug
       end
-    
+      
       def info(message)
-        say message if !Options.silent
+        $stdout.puts message
       end
-    
+      
       def warn(message)
-        say 'NOTE: '.red + message.red if !Options.silent
+        $stdout.puts 'NOTE: '.red + message.red
       end
-
+      
       def error(message)
-        say('ERROR: '.red.blink + message.red) if !Options.silent
-      end
-    
-      def die(message)
-        say('ERROR: '.red.blink + message.red) if !Options.silent
-        raise Error::UI::Die
+        $stderr.puts('ERROR: '.red.blink + message.red)
       end
 
     end