csd 0.1.9 → 0.1.10

data/lib/csd/application/minisip/unix/linux/debian/ubuntu10.rb

@@ -6,14 +6,14 @@ module CSD
     module Minisip
       class Ubuntu10 < Debian
         
-        def after_aptitude_dependencies
+        def after_aptitude
           fix_ubuntu_10_04
-          exit if Options.only_fix_giomm
           super
         end
         
         def fix_ubuntu_10_04
-          if Path.giomm_header_backup.file?
+          UI.info "Fixing broken Debian libraries (Ubuntu 10.04 only)".green.bold
+          if Path.giomm_header_backup.file? and !Options.reveal
             UI.warn "giomm-2.4 seems to be fixed already, I won't touch it now. Delete #{Path.giomm_header_backup.enquote} to enforce it."
           else
             Path.new_giomm_header = File.join(Dir.mktmpdir, 'giomm.h')
@@ -22,11 +22,13 @@ module CSD
               r.replace '#include <giomm/socket.h>', "/* ----- AI COMMENTING OUT START ----- \n#include <giomm/socket.h>"
               r.replace '#include <giomm/tcpconnection.h>', "#include <giomm/tcpconnection.h>\n ----- AI COMMENTING OUT END ----- */"
             end
+            # We cannot use Cmd.copy here, because Cmd.copy has no superuser privileges.
+            # And since we are for sure on Ubuntu, these commands will work.
             Cmd.run("sudo cp #{Path.giomm_header} #{Path.giomm_header_backup}")
             Cmd.run("sudo cp #{Path.new_giomm_header} #{Path.giomm_header}")
           end
         end
-      
+        
       end
     end
   end

data/lib/csd/applications.rb

@@ -7,54 +7,49 @@ module CSD
   # A convenience wrapper to get information about the available applications
   #
   class Applications
-
+    
     # Returns the application module instance of +app_name+. Returns +nil+ if the application could not be found or loaded.
     #
     def self.find(app_name)
       return nil if app_name.to_s.empty?
       begin
-        UI.debug "Applications.find: Attempting to require `#{File.join(Path.applications, app_name.to_s)}´."
+        UI.debug "#{self}.find got a request to see whether `#{app_name}´ is a valid application or not"
         require File.join(Path.applications, app_name.to_s)
-        UI.debug "Applications.find: Attempting to load `#{app_name}´."
+        UI.debug "#{self}.find tries to initialize the loaded application `#{app_name}´ now"
         "CSD::Application::#{app_name.to_s.camelize}".constantize
       rescue LoadError => e
-        UI.debug "Applications.find: The Application `#{app_name}´ could not be loaded properly."
-        UI.debug "                   Reason: #{e}"
+        UI.debug "#{self}.find could not load `#{app_name}´ in #{e.to_s.gsub('no such file to load -- ', '').enquote}"
         nil
       end
     end
-
+    
+    # This method returns instantiated modules of all valid applications in an +Array+ or in a block.
+    #
     def self.all(&block)
       result = []
       Dir.directories(Path.applications) do |dir|
         next if dir == 'default'
-        UI.debug "Applications.all: Identified application directory `#{dir}´."
         if app = find(dir)
-          UI.debug "Applications.all: The application `#{dir}´ is valid."
           block_given? ? yield(app) : result << app
         end
       end
       result
     end
 
-    def self.valid?(name)
-      list.include?(name)
-    end
-    
-    # This method identifies the desired application and initializes it in to +@@current+.
-    # It is meant to be very robust, we expect the application to be any one of the first three arguments.
+    # This method holds the desired application and initializes its module into +@@current+.
     #
     def self.current
-      @@current ||= begin
-        Applications.find(ARGV.first) || Applications.find(ARGV.second) || Applications.find(ARGV.third)
-      end
+      # In testmode we don't want to perform caching
+      return choose_current if Options.testmode
+      # Otherwise we choose and cache the current application module here
+      @@current ||= choose_current
     end
     
-    # Forces a reload of the current application. This method is useful for functional tests.
+    # This method identifies the desired application. No caching takes place here.
+    # It is meant to be very robust, we expect the application to be any one of the first three arguments.
     #
-    def self.current!
-      @@current = false
-      current
+    def self.choose_current
+      Applications.find(ARGV.first) || Applications.find(ARGV.second) || Applications.find(ARGV.third)
     end
     
   end

data/lib/csd/commands.rb

@@ -87,6 +87,31 @@ module CSD
       result
     end
     
+    # Creates a new file and writes content to it. Truncates the file if it already had content.
+    #
+    def touch_and_replace_content(target, content='', params={})
+      default_params = { :die_on_failure => true, :internal => false }
+      params = default_params.merge(params)
+      target = target.pathnamify
+      result = CommandResult.new
+      unless params[:internal]
+        UI.info "Writing content into file #{target} as follows:".cyan 
+        UI.info "#{content}"
+      end
+      if Options.reveal
+        result.success = true
+      else
+        begin
+          File.open(target, 'w') { |f| f << content }
+          result.success = target.file? # TODO: Maybe check for the actual content of the created file here
+        rescue Exception => e
+          result.reason = "Cannot write to file `#{target}´. Reason: #{e.message}"
+          params[:die_on_failure] ? raise(CSD::Error::Command::TouchAndReplaceContentFailed, result.reason) : UI.error(result.reason)
+        end
+      end
+      result
+    end
+    
     # Copies one or several files to the destination
     #
     def copy(src, dest, params={})
@@ -151,9 +176,9 @@ module CSD
         default_params = { :die_on_failure => true }
         params = default_params.merge(params)
         begin
-          UI.info "   Modifying".yellow
+          UI.info "   Replacing".yellow
           UI.info "   `#{pattern}´".blue
-          UI.info "   to".yellow
+          UI.info "   with".yellow
           UI.info "   `#{substitution.to_s.gsub("\n", "\n    ")}´".white
           new_file_content = File.read(self.filepath).gsub(pattern.to_s, substitution.to_s)
           File.open(self.filepath, 'w+') { |file| file << new_file_content } unless Options.reveal
@@ -177,26 +202,28 @@ module CSD
     #
     # The following options can be passed as a hash.
     #
-    # [+:die_on_failure+] If the exit code of the command was not 0, exit the CSD application (default: +true+).
+    # [+:die_on_failure+] If the status code of the command was not 0, raise an Command::RunFailed exception (default: +true+).
     # [+:announce_pwd+] Before running the command, announce in which path the command will be executed (default: +true+).
     # [+:verbose+] Instead of printing just one `.´ per command output line, print the full command output lines (default: +false+).
     # [+:internal+] If this parameter is +true+, there will be no output what-so-ever for running this command. (default: +false+).
+    # [+:force_in_reveal+] If this parameter is +true+, the command will be executed, even in <tt>--reveal</tt> mode (default: +false+).
     #
     # ==== Returns
     #
     # This method returns a CommandResult object with the following values:
     #
-    # [+success?+] +true+ if the command was successful, +nil+ if not.
-    # [+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>
+    # [+output?+] The command's output as a +String+ (with newline delimiters). Note that the status code can be accessed via the global variable <tt>$?</tt>.
+    # [+status?+] Contains <tt>$?</tt> and all the methods Ruby provides for it.
+    # [+success?+] +true+ if the command was successful, +nil+ if not (internally <tt>$?.success?</tt> is called).
     #
     def run(cmd, params={})
-      default_params = { :die_on_failure => true, :announce_pwd => true, :verbose => Options.verbose, :internal => false }
+      default_params = { :die_on_failure => true, :announce_pwd => true, :verbose => Options.verbose, :internal => false, :force_in_reveal => false }
       params = default_params.merge(params)
       result = CommandResult.new
       cmd = cmd.to_s
       UI.info "Running command in #{pwd}".yellow if params[:announce_pwd] and !params[:internal]
       UI.info cmd.cyan unless params[:internal]
-      if Options.reveal
+      if Options.reveal and !params[:force_in_reveal]
         result.success = true
         return result
       end

data/lib/csd/error.rb

@@ -1,11 +1,15 @@
 # -*- encoding: UTF-8 -*-
 
 module CSD
-  # In this module we will keep all types of errors in a readable hierarchy
+  # In this module we will keep all types of errors in a readable hierarchy.
+  # The application modules are assigned the following individual error ranges:
+  #
+  # * +minisip+ has been assigned error status codes 200-280
+  # * +decklink+ has been assigned error status codes 280-299
   #
   module Error
     
-    # All Exceptions raised by CSD must be children of this class. 
+    # All Exceptions raised by CSD must be children of this class.
     #
     class CSDError < StandardError
       def self.status_code(code = nil)
@@ -18,29 +22,41 @@ module CSD
       end
     end
     
+    # Errors in this module are caused by internal AI failures.
+    #
+    module Internal
+      # Somebody tried to run the CSD::Extensions::Core::Pathname.pathnamify method on +nil+. This probably happened in the test-suite when a +Path+ is not set.
+      class PathnamifyingNil < CSDError; status_code(1000); end
+    end
+    
     # Errors in this module are related to command-line options
     #
     module Argument
-      class NoApplication < CSDError; status_code(11); end
-      class NoAction < CSDError; status_code(12); end
-      class InvalidOption < CSDError; status_code(50); end
+      # The <tt>--help</tt> parameter was given, thus the AI quitted after showing the help.
+      class HelpWasRequested    < CSDError; status_code(2); end
+      # The <tt>--version</tt> parameter was given, thus the AI quitted after showing the AI version number.
+      class VersionWasRequested < CSDError; status_code(3); end
+      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 raised by the Command module
     #
     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 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
+      class MkdirFailed   < CSDError; status_code(65); end
+      class TouchAndReplaceContentFailed < CSDError; status_code(66); end
     end
     
     # Errors in this module are related to the Application Module Framework
     #
     module Application
-      class OptionsSyntax < CSDError; status_code(100); end
+      class OptionsSyntax    < CSDError; status_code(100); end
       class NoInstanceMethod < CSDError; status_code(101); end
     end
   

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

@@ -1,23 +1,13 @@
 # -*- 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
-
+# This module extends the original Kernel module. Note that methods cannot be added via the +include+ method in this case.
+#
 module Kernel #:nodoc:
-  include CSD::Extensions::Core::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

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

@@ -18,6 +18,7 @@ module CSD
         def pathnamify
           case self
             when ::Pathname then self
+            when NilClass then raise ::CSD::Error::Internal::PathnamifyingNil
             else ::Pathname.new(self)
           end
         end

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

@@ -13,7 +13,7 @@ module CSD
         #
         # ==== Example
         #
-        #   'Hello World'.enquote    # => '"Hello World"'
+        #   'Hello World'.enquote    # => '`Hello World´'
         #
         def enquote
           %Q{"#{self}"}

data/lib/csd/extensions/gem/platform.rb

@@ -16,16 +16,22 @@ module CSD
           "#{os} (#{cpu}#{version_string})"
         end
         
+        # Determines whether the OS is Debian or Ubuntu. Returns +true+ or +false+.
+        #
+        def debian?
+          kernel_version and kernel_version =~ /Debian|Ubuntu/
+        end
+        
         # On linux systems, this method returns the current kernel version.
         #
         def kernel_version
-          Cmd.run('uname --kernel-version', :internal => true).output.to_s.chop if os == 'linux'
+          Cmd.run('uname --kernel-version', :internal => true, :force_in_reveal => true).output.to_s.chop if os == 'linux'
         end
         
         # On linux systems, this method returns the current kernel release.
         #
         def kernel_release
-          Cmd.run('uname --kernel-release', :internal => true).output.to_s.chop if os == 'linux'
+          Cmd.run('uname --kernel-release', :internal => true, :force_in_reveal => true).output.to_s.chop if os == 'linux'
         end
   
       end
@@ -33,7 +39,7 @@ module CSD
   end
 end
 
-module Gem
+module Gem #:nodoc:
   class Platform #:nodoc:
     include CSD::Extensions::Gem::Platform
   end

data/lib/csd/options_parser.rb

@@ -26,10 +26,10 @@ module CSD
     def define_actions_and_scopes
       if Applications.current
         # Here we overwrite the default supported actions and scopes with the application specific ones
-        UI.debug "Loading actions of #{Applications.current}."
+        UI.debug "#{self.class} loads the actions of #{Applications.current} now"
         self.actions = Applications.current.actions
         # At this point we know that the first argument is no option, but *some* action (may it be valid or not)
-        UI.debug "Loading scopes of #{Applications.current}."
+        UI.debug "#{self.class} loads the scopes of #{Applications.current} now"
         self.scopes  = Applications.current.scopes(self.action)
       end
     end
@@ -130,7 +130,7 @@ module CSD
         end
         opts.on_tail("-v", "--version", "Show the version of this AI") do
           puts "CSD Gem Version: #{CSD::Version}".blue
-          exit
+          raise Error::Argument::VersionWasRequested
         end
         self.helptext = opts.help
       end.parse!

data/lib/csd/user_interface/base.rb

@@ -13,19 +13,22 @@ module CSD
       
       def indicate_activity
       end
-    
+      
+      def ask_yes_no(question, default=nil)
+      end
+      
       def debug(message)
       end
-    
+      
       def info(message)
       end
-    
+      
       def warn(message)
       end
-
+      
       def error(message)
       end
-
+      
     end
   end
 end

data/lib/csd/user_interface/cli.rb

@@ -4,7 +4,7 @@ require 'csd/user_interface/base'
 module CSD
   module UserInterface
     class CLI < Base
-    
+      
       include Gem::UserInteraction
       
       def separator
@@ -16,6 +16,14 @@ module CSD
         $stdout.flush
       end
       
+      # Be careful, this function writes to +STDOUT+ and not to <tt>$stdout</tt>. In other words,
+      # the output cannot be hidden from the end-user, and thus, for example, not be properly
+      # tested in the test suite. ask_yes_no is provided by Gem::UserInteraction.
+      #
+      def continue?
+        ask_yes_no("Continue?".red.bold, true)
+      end
+      
       def debug(message)
         $stdout.puts "DEBUG: #{message}".magenta if Options.debug
       end

data/lib/csd/user_interface/silent.rb

@@ -10,16 +10,19 @@ module CSD
       
       def indicate_activity
       end
-    
+      
+      def continue?
+      end
+      
       def debug(message)
       end
-    
+      
       def info(message)
       end
-    
+      
       def warn(message)
       end
-
+      
       def error(message)
       end
       

data/lib/csd/vendor/zentest/zentest_assertions.rb

@@ -1,4 +1,8 @@
 # -*- encoding: UTF-8 -*-
+require 'test/unit/assertions'
+
+# This module is part of the Zentest framework released under the MIT license.
+# It comprises extra assertions for Test::Unit
 #
 # (The MIT License)
 # 
@@ -22,41 +26,41 @@
 # 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.
+#
+module Test #:nodoc:
+  module Unit #:nodoc:
+    module Assertions #:nodoc:
+      
+      # Captures $stdout and $stderr to StringIO objects and returns them.
+      # Restores $stdout and $stderr when done.
+      #
+      # Usage:
+      #   def test_puts
+      #     out, err = capture do
+      #       puts 'hi'
+      #       STDERR.puts 'bye!'
+      #     end
+      #     assert_equal "hi\n", out.string
+      #     assert_equal "bye!\n", err.string
+      #   end
+      #
+      def capture
+        require 'stringio'
+        orig_stdout = $stdout.dup
+        orig_stderr = $stderr.dup
+        captured_stdout = StringIO.new
+        captured_stderr = StringIO.new
+        $stdout = captured_stdout
+        $stderr = captured_stderr
+        yield
+        captured_stdout.rewind
+        captured_stderr.rewind
+        return captured_stdout.string, captured_stderr.string
+      ensure
+        $stdout = orig_stdout
+        $stderr = orig_stderr
+      end
 
-require 'test/unit/assertions'
-
-# Extra assertions for Test::Unit
-
-module Test::Unit::Assertions
-
-  # Captures $stdout and $stderr to StringIO objects and returns them.
-  # Restores $stdout and $stderr when done.
-  #
-  # Usage:
-  #   def test_puts
-  #     out, err = capture do
-  #       puts 'hi'
-  #       STDERR.puts 'bye!'
-  #     end
-  #     assert_equal "hi\n", out.string
-  #     assert_equal "bye!\n", err.string
-  #   end
-  #
-  def capture
-    require 'stringio'
-    orig_stdout = $stdout.dup
-    orig_stderr = $stderr.dup
-    captured_stdout = StringIO.new
-    captured_stderr = StringIO.new
-    $stdout = captured_stdout
-    $stderr = captured_stderr
-    yield
-    captured_stdout.rewind
-    captured_stderr.rewind
-    return captured_stdout.string, captured_stderr.string
-  ensure
-    $stdout = orig_stdout
-    $stderr = orig_stderr
+    end
   end
-
 end