csd 0.2.2 → 0.3.0

data/lib/csd/options_parser.rb

@@ -9,6 +9,12 @@ module CSD
   #
   class OptionsParser < OpenStruct
     
+    # When this method is called, the OptionsParser is populated with information gained via the CLI arguments.
+    # For example, the application, action and scope are determined and all --options are identified. Each time
+    # this method is called, all current options get lost and are replaced by what could be found in ARGV.
+    # Note that it is a destructive method, that is, the ARGV is stripped of all processed arguments. Thus this
+    # method can only be called once (that is, unless ARGV is re-populated).
+    #
     def parse!
       clear
       parse_literals
@@ -16,14 +22,23 @@ module CSD
       parse_options
     end
     
+    # Determines whether the action chosen by the user is valid for the application which was chosen.
+    # Returns +true+ if it is a valid action. Returns +false+ if not, or if no application was chosen.
+    #
     def valid_action?
-      self.actions_names.include?(self.action)
+      self.actions_names and self.actions_names.include?(self.action)
     end
     
+    # Determines whether the scope chosen by the user is valid for the application and action which was chosen.
+    # Returns +true+ if it is a valid action. Returns +false+ if not, or if no application was chosen.
+    #
     def valid_scope?
-      self.scopes_names.include?(self.scope)
+      self.scopes_names and self.scopes_names.include?(self.scope)
     end
     
+    # This method assumes that the application has been chosen and tries to determine which actions and scopes
+    # the chosen application can respond to.
+    #
     def define_actions_and_scopes
       if Applications.current
         # Here we overwrite the default supported actions and scopes with the application specific ones
@@ -41,6 +56,8 @@ module CSD
       end
     end
     
+    # This method resets all Options to default.
+    #
     def clear(additional_options='')
       # Resetting all attributes to nil (because e.g. an application instance might have modified or added some).
       super()

data/lib/csd/user_interface/base.rb

@@ -17,6 +17,10 @@ module CSD
       def ask_yes_no(question, default=nil)
       end
       
+      def continue?
+        ask_yes_no 'Continue?', true
+      end
+      
       def debug(message)
       end
       

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Technology Transfer Alliance Team
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-30 00:00:00 +02:00
+date: 2010-09-07 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -37,15 +37,23 @@ files:
 - VERSION
 - bin/ai
 - bin/ttai
-- csd.gemspec
 - lib/csd.rb
 - lib/csd/application.rb
 - lib/csd/application/decklink.rb
 - lib/csd/application/decklink/about.yml
 - lib/csd/application/decklink/base.rb
-- lib/csd/application/decklink/options/install.rb
+- lib/csd/application/decklink/options/common.rb
+- lib/csd/application/decklink/options/common_defaults.rb
 - lib/csd/application/default.rb
 - lib/csd/application/default/base.rb
+- lib/csd/application/graphics.rb
+- lib/csd/application/graphics/about.yml
+- lib/csd/application/graphics/base.rb
+- lib/csd/application/graphics/error.rb
+- lib/csd/application/graphics/options/common.rb
+- lib/csd/application/graphics/options/common_defaults.rb
+- lib/csd/application/graphics/options/install.rb
+- lib/csd/application/graphics/options/install_defaults.rb
 - lib/csd/application/i2conf.rb
 - lib/csd/application/i2conf/about.yml
 - lib/csd/application/i2conf/base.rb
@@ -78,7 +86,11 @@ files:
 - lib/csd/application/minisip/unix/linux.rb
 - lib/csd/application/minisip/unix/linux/debian.rb
 - lib/csd/application/minisip/unix/linux/debian/ubuntu10.rb
-- lib/csd/application/opensips/about.yml
+- lib/csd/application/mslog.rb
+- lib/csd/application/mslog/about.yml
+- lib/csd/application/mslog/base.rb
+- lib/csd/application/mslog/options/common.rb
+- lib/csd/application/mslog/options/common_defaults.rb
 - lib/csd/applications.rb
 - lib/csd/commands.rb
 - lib/csd/container.rb

data/csd.gemspec

@@ -1,161 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{csd}
-  s.version = "0.2.2"
-
-  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-08-30}
-  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 = ["ai", "ttai"]
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "COPYING",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "bin/ai",
-     "bin/ttai",
-     "csd.gemspec",
-     "lib/csd.rb",
-     "lib/csd/application.rb",
-     "lib/csd/application/decklink.rb",
-     "lib/csd/application/decklink/about.yml",
-     "lib/csd/application/decklink/base.rb",
-     "lib/csd/application/decklink/options/install.rb",
-     "lib/csd/application/default.rb",
-     "lib/csd/application/default/base.rb",
-     "lib/csd/application/i2conf.rb",
-     "lib/csd/application/i2conf/about.yml",
-     "lib/csd/application/i2conf/base.rb",
-     "lib/csd/application/i2conf/config_example.rb",
-     "lib/csd/application/i2conf/options/common.rb",
-     "lib/csd/application/i2conf/options/common_defaults.rb",
-     "lib/csd/application/i2conf/options/install.rb",
-     "lib/csd/application/i2conf/options/install_defaults.rb",
-     "lib/csd/application/minisip.rb",
-     "lib/csd/application/minisip/about.yml",
-     "lib/csd/application/minisip/base.rb",
-     "lib/csd/application/minisip/component.rb",
-     "lib/csd/application/minisip/component/core.rb",
-     "lib/csd/application/minisip/component/ffmpeg.rb",
-     "lib/csd/application/minisip/component/gnome.rb",
-     "lib/csd/application/minisip/component/hdviper.rb",
-     "lib/csd/application/minisip/component/network.rb",
-     "lib/csd/application/minisip/component/plugins.rb",
-     "lib/csd/application/minisip/component/x264.rb",
-     "lib/csd/application/minisip/error.rb",
-     "lib/csd/application/minisip/options/common.rb",
-     "lib/csd/application/minisip/options/common_defaults.rb",
-     "lib/csd/application/minisip/options/install.rb",
-     "lib/csd/application/minisip/options/install_defaults.rb",
-     "lib/csd/application/minisip/options/package.rb",
-     "lib/csd/application/minisip/options/package_defaults.rb",
-     "lib/csd/application/minisip/phonebook_example.rb",
-     "lib/csd/application/minisip/unix.rb",
-     "lib/csd/application/minisip/unix/darwin.rb",
-     "lib/csd/application/minisip/unix/linux.rb",
-     "lib/csd/application/minisip/unix/linux/debian.rb",
-     "lib/csd/application/minisip/unix/linux/debian/ubuntu10.rb",
-     "lib/csd/application/opensips/about.yml",
-     "lib/csd/applications.rb",
-     "lib/csd/commands.rb",
-     "lib/csd/container.rb",
-     "lib/csd/error.rb",
-     "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",
-     "lib/csd/extensions/gem/platform.rb",
-     "lib/csd/options_parser.rb",
-     "lib/csd/path_container.rb",
-     "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_platform.rb",
-     "test/unit/test_string.rb"
-  ]
-  s.homepage = %q{http://github.com/csd/csd}
-  s.post_install_message = %q{
-============================================================
-
-  Thank you for installing the TTA Automated Installer!
-
-  You can run it by typing `ai´ in your command line.
-
-  NOTE: On DEBIAN and UBUNTU the executable `ai´ 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"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  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_platform.rb",
-     "test/unit/test_string.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end
-

data/lib/csd/application/opensips/about.yml

@@ -1,2 +0,0 @@
-human: opensips
-description: An open-source SIP server.