csd 0.1.8 → 0.1.9

data/Rakefile

@@ -1,18 +1,32 @@
-require 'rubygems'
-require 'rake'
-require 'rdoc'
+# -*- encoding: UTF-8 -*-
+begin
+  require 'rubygems'
+rescue LoadError
+  puts 'RubyGems could not be found. Please install it first.'
+end
 
 begin
+  require 'rake'
+  require 'rake/testtask'
+  require 'rake/rdoctask'
+  require 'rdoc'
   require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "csd"
-    gemspec.summary = "Installation and compilation handler for software used in CSD projects."
-    gemspec.description = "CSD stands for Communication Systems Design and is a project of the Telecommunication Systems Laboratory (TSLab) of the Royal Institute of Technology in Stockholm, Sweden. Within CSD many software tools are used to build up various networks and services. This gem is supposed to automate processes to handle the compilation and installation of these software tools. Technology Transfer Alliance (TTA) is the project team, which maintains this code."
-    gemspec.email = "mtoday11@gmail.com"
-    gemspec.homepage = "http://github.com/csd/csd"
-    gemspec.authors = ["Technology Transfer Alliance Team"]
-    gemspec.executables = ['tta', 'ai']
-    gemspec.post_install_message = %q{
+rescue LoadError
+  puts 'Some gem dependencies are missing. Please install them with:'
+  puts '[sudo] gem install rake rdoc shoulda redgreen autotest jeweler activesupport'
+end
+
+# This is where we specify the details of this gem. The csd.gemspec file will be generated *automatically* from these specifications.
+#
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name        = "csd"
+  gemspec.summary     = "Installation and compilation handler for software used in CSD projects."
+  gemspec.description = "CSD stands for Communication Systems Design and is a project of the Telecommunication Systems Laboratory (TSLab) of the Royal Institute of Technology in Stockholm, Sweden. Within CSD many software tools are used to build up various networks and services. This gem is supposed to automate processes to handle the compilation and installation of these software tools. Technology Transfer Alliance (TTA) is the project team, which maintains this code."
+  gemspec.email       = "mtoday11@gmail.com"
+  gemspec.homepage    = "http://github.com/csd/csd"
+  gemspec.authors     = ["Technology Transfer Alliance Team"]
+  gemspec.executables = ['ai']
+  gemspec.post_install_message = %q{
 ============================================================
 
  Thank you for installing the TTA Automated Installer!
@@ -22,51 +36,45 @@ begin
  NOTE: On DEBIAN and UBUNTU the executable `tta´ is *maybe*
        not in your PATH by default. If that is the case,
        you can fix it by running this command:
-      
+
  echo "export PATH=\$PATH:$(gem env | grep "E D" | sed "s/[^\w]* //")" >> ~/.bashrc;. ~/.bashrc
-       
+
 ============================================================
     }
-  end
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.test_files = FileList['test/functional/**/test*.rb', 'test/unit/**/test_*.rb']
+# Here we define the default task when no task was specified by the user
+task :default => :test
+
+# Checks for dependencies and runs all test. Note that it requires you to be online
+task :test => :check_dependencies
+Rake::TestTask.new :test do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  #t.verbose = true
 end
 
-Rake::TestTask.new('test:all') do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+# Generates the source code documentation
+Rake::RDocTask.new do |r|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  r.rdoc_dir = 'rdoc'
+  r.title = "csd #{version}"
+  r.rdoc_files.include('README*')
+  r.rdoc_files.include('lib/csd.rb')
+  r.rdoc_files.include('lib/csd/**/*.rb')
 end
 
+# Analyzes the code test coverage ratio
 begin
   require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
+  Rcov::RcovTask.new do |t|
+    t.rcov_opts = ['--sort', 'coverage', '--text-report', '--exclude', "features,kernel,load-diff-lcs\.rb,instance_exec\.rb,lib/spec.rb,lib/spec/runner.rb,^spec/*,bin/spec,examples,/gems,/Library/Ruby,\.autotest,#{ENV['GEM_HOME']}"]
+    t.libs << 'test'
+    t.pattern = 'test/**/test_*.rb'
+    #t.verbose = true
   end
 rescue LoadError
   task :rcov do
     abort "RCov is not available. In order to run rcov, you must: sudo gem install rcov"
   end
 end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "csd #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/csd.rb')
-  rdoc.rdoc_files.include('lib/csd/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-0.1.8
+0.1.9

data/bin/ai

@@ -1,22 +1,25 @@
 #!/usr/bin/env ruby
 
+# NOTE: If you would like to execute this file as a developer
+#       but not install the CSD gem, you can use this command:
+#       ruby -I path/to/csd/lib path/to/csd/bin/tta
 
-
-# This executable is DEPRECATED
-# Please use 'tta' instead.
-
-puts
-puts "`ai´ is DEPRECATED. Please use `tta´ instead."
-
+# First, let's load the RubyGems framework and the CSD gem.
+# Even though RubyGems is already loaded for Ruby >= 1.9,
+# we want to go sure here and load it to provide robustness
 require 'rubygems'
 require 'csd'
 
 begin
+  # Running the CSD library and telling it who started it
   CSD.bootstrap :executable => 'ai'
 rescue CSD::Error::CSDError => e
+  # Here we catch CSD internal errors and exit with the propriate status code
+  # We output the error message only for status codes 50 and higher, because they are rather severe
   CSD.ui.error e.message unless e.status_code <= 49
   exit e.status_code
 rescue Interrupt
+  # Lastly, close the AI gracefully on abnormal termination
   CSD.ui.separator
   CSD.ui.info "Quitting the AI...".red
   exit

data/csd.gemspec

@@ -5,14 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{csd}
-  s.version = "0.1.8"
+  s.version = "0.1.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Technology Transfer Alliance Team"]
-  s.date = %q{2010-07-28}
+  s.date = %q{2010-07-29}
+  s.default_executable = %q{ai}
   s.description = %q{CSD stands for Communication Systems Design and is a project of the Telecommunication Systems Laboratory (TSLab) of the Royal Institute of Technology in Stockholm, Sweden. Within CSD many software tools are used to build up various networks and services. This gem is supposed to automate processes to handle the compilation and installation of these software tools. Technology Transfer Alliance (TTA) is the project team, which maintains this code.}
   s.email = %q{mtoday11@gmail.com}
-  s.executables = ["tta", "ai"]
+  s.executables = ["ai"]
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
@@ -24,7 +25,6 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "bin/ai",
-     "bin/tta",
      "csd.gemspec",
      "lib/csd.rb",
      "lib/csd/application.rb",
@@ -50,7 +50,9 @@ Gem::Specification.new do |s|
      "lib/csd/extensions.rb",
      "lib/csd/extensions/core/array.rb",
      "lib/csd/extensions/core/dir.rb",
+     "lib/csd/extensions/core/kernel.rb",
      "lib/csd/extensions/core/object.rb",
+     "lib/csd/extensions/core/open_struct.rb",
      "lib/csd/extensions/core/option_parser.rb",
      "lib/csd/extensions/core/pathname.rb",
      "lib/csd/extensions/core/string.rb",
@@ -60,18 +62,26 @@ Gem::Specification.new do |s|
      "lib/csd/user_interface.rb",
      "lib/csd/user_interface/base.rb",
      "lib/csd/user_interface/cli.rb",
+     "lib/csd/user_interface/silent.rb",
      "lib/csd/vendor/active_support/MIT-LICENSE",
      "lib/csd/vendor/active_support/inflector.rb",
+     "lib/csd/vendor/active_support/object_extensions.rb",
      "lib/csd/vendor/term/GPL2-LICENSE",
      "lib/csd/vendor/term/ansicolor.rb",
      "lib/csd/vendor/zentest/zentest_assertions.rb",
      "lib/csd/version.rb",
      "test/application/test_minisip.rb",
+     "test/functional/test_application_base.rb",
+     "test/functional/test_application_default.rb",
      "test/functional/test_applications.rb",
+     "test/functional/test_cli.rb",
      "test/functional/test_commands.rb",
+     "test/functional/test_csd.rb",
      "test/functional/test_options.rb",
      "test/helper.rb",
+     "test/unit/test_container.rb",
      "test/unit/test_dir.rb",
+     "test/unit/test_open_struct.rb",
      "test/unit/test_pathname.rb",
      "test/unit/test_string.rb"
   ]
@@ -86,9 +96,9 @@ Gem::Specification.new do |s|
  NOTE: On DEBIAN and UBUNTU the executable `tta´ is *maybe*
        not in your PATH by default. If that is the case,
        you can fix it by running this command:
-      
+
  echo "export PATH=\$PATH:$(gem env | grep "E D" | sed "s/[^\w]* //")" >> ~/.bashrc;. ~/.bashrc
-       
+
 ============================================================
     }
   s.rdoc_options = ["--charset=UTF-8"]
@@ -97,11 +107,17 @@ Gem::Specification.new do |s|
   s.summary = %q{Installation and compilation handler for software used in CSD projects.}
   s.test_files = [
     "test/application/test_minisip.rb",
+     "test/functional/test_application_base.rb",
+     "test/functional/test_application_default.rb",
      "test/functional/test_applications.rb",
+     "test/functional/test_cli.rb",
      "test/functional/test_commands.rb",
+     "test/functional/test_csd.rb",
      "test/functional/test_options.rb",
      "test/helper.rb",
+     "test/unit/test_container.rb",
      "test/unit/test_dir.rb",
+     "test/unit/test_open_struct.rb",
      "test/unit/test_pathname.rb",
      "test/unit/test_string.rb"
   ]

data/lib/csd.rb

@@ -67,10 +67,7 @@ module CSD
       end
       UI.separator
       UI.info '  To execute a task:   '.green.bold + "#{executable} [TASK] #{Applications.current.name}".cyan.bold + "          Example: #{executable} compile minisip".dark
-      #UI.info '  To execute a task:   '.green.bold + "#{executable} [TASK] #{Applications.current.name}".cyan.bold
       UI.info '   For more details:   '.green.bold + "#{executable} help [TASK] #{Applications.current.name}".cyan.bold + "     Example: #{executable} help compile minisip".dark
-      #UI.info '   For more details:   '.green.bold + "#{executable} help [TASK] #{Applications.current.name}".cyan.bold
-      #UI.info '            Example:   '.green.bold + "#{executable} help install #{Applications.current.name}".cyan.bold
       UI.separator
       UI.warn "You did not specify a valid task name."
       raise Error::Argument::NoAction

data/lib/csd/application/default.rb

@@ -11,6 +11,13 @@ module CSD
     #
     module Default
       
+      # This method must be overwritten by the actual application module. It holds the application instance
+      # which was chosen for this operating system.
+      #
+      def instance
+        raise Error::Application::NoInstanceMethod, "The application module must define an method called `instance´."
+      end
+      
       def name
         self.to_s.demodulize.underscorize
       end

data/lib/csd/application/default/base.rb

@@ -5,11 +5,34 @@ module CSD
   # This namespace holds all individual application Modules
   #
   module Application
-    
     # This is the root class of all Applications
     #
     class Base
       
+      def initialize
+        define_working_directory
+      end
+      
+      # This method chooses the working directory, which will contain downloads needed for various tasks, etc.
+      # Note that this directory is *not* removed by the AI in any case. The user has to make sure she knows the
+      # location of it (especially if it is a temporary directory which is physically created right here).
+      #
+      def define_working_directory
+        if Options.work_dir
+          # The user specified the working directory manually
+          path = Options.work_dir
+        elsif Options.temp
+          # The user specified the working directory to be a system's temporary directory
+          # Note that only with this option, the directory is actually created at this point
+          path = Dir.mktmpdir 
+        else
+          # Other than that, we create a subdirectory in the current directory and use that
+          app_name = Applications.current ? Applications.current.name : 'application'
+          path = File.join(Dir.pwd, "#{app_name}.ai")
+        end
+        Path.work = path.pathnamify.expand_path
+      end
+      
     end
   end
 end

data/lib/csd/application/minisip.rb

@@ -41,22 +41,28 @@ module CSD
           @instance ||= case Gem::Platform.local.os
             
             when 'darwin'
+              # Mac OS X
+              UI.debug "Mac OS X identified"
               Darwin.new
-              
+            
             when 'linux'
+              # Linux
               UI.debug "Analyzing Linux kernel release: #{Gem::Platform.local.kernel_release}"
               case Gem::Platform.local.kernel_release
                 
                 when '2.6.32-21-generic', '2.6.32-22-generic'
+                  # Ubuntu 10.04
                   UI.debug "Ubuntu 10.04 identified"
                   Ubuntu10.new
-                  
+                
                 else
+                  # Any other Linux (currently only Debian is supported)
                   UI.debug "Debian identified"
                   Debian.new
               end
               
             else
+              # Microsoft Windows, Java, Solaris, etc...
               UI.debug "This Operating System is not supported."
               Base.new
           end

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

@@ -6,8 +6,18 @@ module CSD
     module Minisip
       class Base < CSD::Application::Base
         
+        # This is an +Array+ containing the names of the internal MiniSIP libraries. Note that they
+        # are sorted according to the sequence in which they need to be compiled.
+        #
         LIBRARIES = %w{ libmutil libmnetutil libmcrypto libmikey libmsip libmstun libminisip minisip }
         
+        # Tasks to be done before the introduction is evoked.
+        #
+        def initialize
+          super
+          define_relative_paths
+        end
+        
         # MAIN APPLICATION OPERATIONS
         
         def compile
@@ -21,8 +31,6 @@ module CSD
         # GENERAL USER INFORMATION
         
         def introduction
-          define_root_path
-          define_paths
           UI.separator
           UI.info " Working directory:              ".green + Path.work.to_s.yellow
           UI.info " Your Platform:                  ".green + Gem::Platform.local.humanize.to_s.yellow
@@ -30,6 +38,8 @@ module CSD
           UI.separator
           if Options.help
             UI.info Options.helptext
+            # Cleanup in case the working directory was temporary and is empty
+            Path.work.rmdir if Options.temp and Path.work.directory? and Path.work.children.empty?
             exit
           else
             raise Interrupt unless (Options.yes or Options.reveal or UI.ask_yes_no("Continue?".red.bold, true))
@@ -101,7 +111,7 @@ module CSD
         end
 
         def libminisip_cpp_flags
-          if Options.ffmpeg_first?
+          if Options.ffmpeg_first
             %{CPPFLAGS="-I#{Path.hdviper_x264} -I#{Path.hdviper_x264_test_x264api} -I#{Path.ffmpeg_libavutil} -I#{Path.ffmpeg_libavcodec} -I#{Path.ffmpeg_libswscale} -I#{Path.repository_grabber} -I#{Path.repository_decklinksdk}"}
           else
             %{CPPFLAGS="-I#{Path.hdviper_x264} -I#{Path.hdviper_x264_test_x264api} -I#{Path.repository_grabber} -I#{Path.repository_decklinksdk}"}
@@ -112,22 +122,15 @@ module CSD
           %{LDFLAGS="#{Path.hdviper_libx264api} #{Path.hdviper_libtidx264} -lpthread -lrt"}
         end
         
-        # DEFINING PATHS ETC...
-        
-        def define_root_path
-          if Options.path
-            if File.directory?(Options.path)
-              Path.root = File.expand_path(Options.path)
-            else
-              raise Error::Options::PathNotFound, "The path `#{Options.path}´ doesn't exist."
-            end
-          else
-            Path.root = Options.temp ? Dir.mktmpdir : Dir.pwd
-          end
-        end
-        
-        def define_paths
-          Path.work                               = Pathname.new(File.join(Path.root, 'minisip.ai'))
+        def define_relative_paths
+          Path.build                              = Pathname.new(File.join(Path.work, 'build'))
+          Path.build_bin                          = Pathname.new(File.join(Path.build, 'bin'))
+          Path.build_gtkgui                       = Pathname.new(File.join(Path.build_bin, 'minisip_gtkgui'))
+          Path.build_include                      = Pathname.new(File.join(Path.build, 'include'))
+          Path.build_lib                          = Pathname.new(File.join(Path.build, 'lib'))
+          Path.build_lib_pkg_config               = Pathname.new(File.join(Path.build_lib, 'pkgconfig'))
+          Path.build_share                        = Pathname.new(File.join(Path.build, 'share'))
+          Path.build_share_aclocal                = Pathname.new(File.join(Path.build_share, 'aclocal'))
           Path.giomm_header                       = Pathname.new(File.join('/', 'usr', 'include', 'giomm-2.4', 'giomm.h'))
           Path.giomm_header_backup                = Pathname.new(File.join('/', 'usr', 'include', 'giomm-2.4', 'giomm.h.ai-backup'))
           Path.repository                         = Pathname.new(File.join(Path.work, 'repository'))
@@ -151,14 +154,6 @@ module CSD
           Path.hdviper_libtidx264                 = Pathname.new(File.join(Path.hdviper_x264, 'libtidx264.a'))
           Path.hdviper_x264_test_x264api          = Pathname.new(File.join(Path.hdviper_x264, 'test', 'x264API'))
           Path.hdviper_libx264api                 = Pathname.new(File.join(Path.hdviper_x264_test_x264api, 'libx264api.a'))
-          Path.build                              = Pathname.new(File.join(Path.work, 'build'))
-          Path.build_bin                          = Pathname.new(File.join(Path.build, 'bin'))
-          Path.build_gtkgui                       = Pathname.new(File.join(Path.build_bin, 'minisip_gtkgui'))
-          Path.build_include                      = Pathname.new(File.join(Path.build, 'include'))
-          Path.build_lib                          = Pathname.new(File.join(Path.build, 'lib'))
-          Path.build_lib_pkg_config               = Pathname.new(File.join(Path.build_lib, 'pkgconfig'))
-          Path.build_share                        = Pathname.new(File.join(Path.build, 'share'))
-          Path.build_share_aclocal                = Pathname.new(File.join(Path.build_share, 'aclocal'))
           Path.plugins                            = Pathname.new(File.join(Path.work, 'plugins'))
           Path.plugins_destination                = Pathname.new(File.join(Path.build_lib, 'libminisip', 'plugins'))
         end

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

@@ -1 +1,13 @@
-# -*- encoding: UTF-8 -*-
+# -*- encoding: UTF-8 -*-
+
+opts.headline 'WORKING DIRECTORY OPTIONS'.green.bold
+
+self.temp = false
+opts.on("-t", "--temp", "Use a system's temporary directory as working directory.") do |value|
+  self.temp = value
+end
+
+self.work_dir = nil
+opts.on("--work-dir [PATH]", "Defines and/or creates the working directory. This will override the --temp option.") do |value|
+  self.work_dir = value
+end