csd 0.1.5 → 0.1.6

data/lib/csd/container.rb

@@ -0,0 +1,61 @@
+# -*- encoding: UTF-8 -*-
+
+module CSD
+  class << self
+    # This method chooses and holds the user interface instance.
+    #
+    def ui
+      @@ui ||= UserInterface::CLI.new
+    end
+  
+    # This method chooses and holds the command execution instance.
+    #
+    def cmd
+      @@cmd ||= Commands.new
+    end
+  
+    # This holds the container for paths.
+    #
+    def path
+      @@path ||= PathContainer.new
+    end
+  
+    # This holds the container for argument options.
+    #
+    def options
+      @@options ||= OptionsParser.new
+    end
+  end
+
+  # A wrapper for the UI class to be able to run all methods as class methods.
+  #
+  class UI
+    def self.method_missing(meth, *args, &block)
+      ::CSD.ui.send(meth, *args, &block)
+    end
+  end
+
+  # A wrapper for the Commands class to be able to run all methods as class methods.
+  #
+  class Cmd
+    def self.method_missing(meth, *args, &block)
+      ::CSD.cmd.send(meth, *args, &block)
+    end
+  end
+
+  # A wrapper for the Path class to be able to run all methods as class methods.
+  #
+  class Path
+    def self.method_missing(meth, *args, &block)
+      ::CSD.path.send(meth, *args, &block)
+    end
+  end
+
+  # A wrapper for the Options class to be able to run all methods as class methods.
+  #
+  class Options
+    def self.method_missing(meth, *args, &block)
+      ::CSD.options.send(meth, *args, &block)
+    end
+  end
+end

data/lib/csd/error.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# -*- encoding: UTF-8 -*-
+
 module CSD
   # In this module we will keep all types of errors in a readable hierarchy
   #
@@ -24,9 +25,17 @@ module CSD
       class NoAction < CSDError; status_code(12); end
     end
     
+    # Errors in this module are related to the Application Module Framework
+    #
     module Application
       class OptionsSyntax < CSDError; status_code(200); 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
+    end
   
   end
 end

data/lib/csd/extensions.rb

@@ -1,2 +1,3 @@
-# encoding: utf-8
-Dir.glob(File.join(File.dirname(__FILE__), 'extensions', '**', '*.rb')) { |file| require file }
+# -*- encoding: UTF-8 -*-
+Dir[File.join(File.dirname(__FILE__), 'extensions', 'core', '*.rb')].sort.each { |path| require "csd/extensions/core/#{File.basename(path, '.rb')}" }
+Dir[File.join(File.dirname(__FILE__), 'extensions', 'gem', '*.rb')].sort.each { |path| require "csd/extensions/gem/#{File.basename(path, '.rb')}" }

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

@@ -1,9 +1,37 @@
-# encoding: utf-8
+# -*- encoding: UTF-8 -*-
+
 module CSD
+  # This namespace is given to modifications to the ruby language or other gems. Its purpose is to
+  # simplify working with simple objects, such as Arrays, Files, etc.
+  #
   module Extensions
+    # This namespace is given to all extensions made to the Ruby Core or the Ruby Standard Library.
+    #
     module Core
+      # This module comprises extensions to the Array object.
+      #
       module Array
 
+        # Equal to <tt>self[1]</tt>.
+        def second
+          self[1]
+        end
+
+        # Equal to <tt>self[2]</tt>.
+        def third
+          self[2]
+        end
+
+        # Equal to <tt>self[3]</tt>.
+        def fourth
+          self[3]
+        end
+
+        # Equal to <tt>self[4]</tt>.
+        def fifth
+          self[4]
+        end
+
       end
     end
   end

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

@@ -1,11 +1,25 @@
-# encoding: utf-8
+# -*- encoding: UTF-8 -*-
 require 'pathname'
 
 module CSD
   module Extensions
     module Core
+      # This module comprises extensions to the Dir object.
+      #
       module Dir
         
+        # This method returns the names of all children-directories (i.e. first generation of descendants)
+        # of a directory in either an +Array+, or in a block. It does the same thing as
+        # +Pathname.children_directories+ but returns just the name and not the entire path to the children directories.
+        #
+        # ==== Examples
+        #
+        #  Dir.directories('/home/user')    # => ['Desktop', 'Documents', ...]
+        #
+        #  Dir.directories('/home/user') do |dir|
+        #    puts dir
+        #  end
+        #
         def directories(path, &block)
           if block_given?
             ::Pathname.new(path).children_directories { |pathname| yield pathname.basename.to_s }
@@ -14,29 +28,6 @@ module CSD
           end
         end
         
-        # Returns all direct subdirectories of +path+ with their entire path
-        #
-        #def directories(path, &block)
-        #  result = []
-        #  glob(::File.join(path, '*')).each do |dir|
-        #    if (::File.directory?(dir) and dir != '.' and dir != '..')
-        #      block_given? ? yield(dir) : result << dir
-        #    end
-        #  end
-        #  result
-        #end
-        
-        #def directories(path, absolute=false, &block)
-        #  result = []
-        #  entries(path) do |entry|
-        #    if (::File.directory?(entry) and entry != '.' and entry != '..')
-        #      dir = absolute? ? File.join(path, entry) : entry
-        #      block_given? ? yield(dir) : result << dir
-        #    end
-        #  end
-        #  result
-        #end
-        
       end
     end
   end

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

@@ -1,10 +1,18 @@
-# encoding: utf-8
+# -*- encoding: UTF-8 -*-
+
 module CSD
   module Extensions
     module Core
+      # This module comprises extensions to Object (the parent of all classes).
+      #
       module Object
         
-        # Creates a Pathname object from the current object. Preferrably from Strings and Hashes.
+        # Creates a Pathname object from the current object.
+        #
+        # ==== Examples
+        #
+        #  '/my/path'.pathnamify            # =>  #<Pathname:my/path>
+        #  my_pathname_object.pathnamify    # =>  #<Pathname:my/path>
         #
         def pathnamify
           case self

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

@@ -1,26 +1,45 @@
-# encoding: utf-8
-require File.join(File.dirname(__FILE__), 'string')
+# -*- encoding: UTF-8 -*-
+require 'csd/extensions/core/string'
 require 'optparse'
 
 module CSD
   module Extensions
     module Core
+      # This module comprises extensions to OptionParser objects.
+      #
       module OptionParser
 
+        # Inserts a new line to the options help output.
+        #
         def newline
           separator ''
         end
           
+        # Inserts a new line and a headline to the options help output.
+        #
         def headline(text)
           newline
           separator(text)
         end
         
+        # Inserts an indented headline to the options help output.
+        #
         def subheadline(text)
           separator(@summary_indent + text)
         end
         
-        def list_item(item='', description='', &block)
+        # This method creates a line with two columns. The +item+ will be in the first
+        # column and be indented. The +description+ will be in the second column.
+        #
+        # ==== Examples
+        #
+        #  OptionParser.new do |opts|
+        #    opts.headline 'List of Applications'
+        #    opts.list_item 'MiniSIP', 'An open-source high-definition video conferencing client.'
+        #    opts.list_item 'OpenSIP', 'An open-source SIP server.'
+        # end
+        #
+        def list_item(item='', description='')
           separator(summary_indent + item.ljust(summary_width + 1) + description)
         end
         

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

@@ -1,11 +1,24 @@
-# encoding: utf-8
-require File.join(File.dirname(__FILE__), 'string')
+# -*- encoding: UTF-8 -*-
+require 'csd/extensions/core/string'
 
 module CSD
   module Extensions
     module Core
+      # This module comprises extensions to Pathname objects.
+      #
       module Pathname
         
+        # This method returns the full paths to all children-directories (i.e. first generation of descendants)
+        # of a directory in either an +Array+, or in a block.
+        #
+        # ==== Examples
+        #
+        #  Dir.directories('/home/user')    # => ['/home/user/Desktop', '/home/user/Documents', ...]
+        #
+        #  Dir.directories('/home/user') do |dir|
+        #    puts dir
+        #  end
+        #
         def children_directories(&block)
           result = []
           children.map do |child|
@@ -15,10 +28,25 @@ module CSD
           result
         end
         
+        # Converts a Pathname object into a +String+ and wraps it into two quotation
+        # marks (according to the +String#enquite+ method). This method is useful for
+        # printing a path in a readable way in a command-line user interface.
+        #
         def enquote
           to_s.enquote
         end
         
+        # Verifies whether the current directory (i.e. +pwd+) is the path of this Pathname
+        # object. Returns +true+ or +false+.
+        #
+        # ==== Examples
+        #
+        #  Dir.chdir('/home/user')
+        #  Pathname.new('/home/user').current_path?            # => true
+        #  Pathname.new('/home/user/../user').current_path?    # => true
+        #  Pathname.new('/lib').current_path?                  # => false
+        #  Pathname.new('/i/do/not/exist').current_path?       # => false
+        #
         def current_path?
           self.exist? and self.realpath == self.class.getwd.realpath
         end

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

@@ -1,21 +1,68 @@
-# encoding: utf-8
-require 'term/ansicolor'
+# -*- encoding: UTF-8 -*-
+require 'csd/vendor/term/ansicolor'
+require 'csd/vendor/active_support/inflector'
 
 module CSD
   module Extensions
     module Core
+      # This module comprises extensions to String objects.
+      #
       module String
-  
+        
+        # Adds a double-quote to the beginning and the end of a +String+.
+        #
+        # ==== Example
+        #
+        #   'Hello World'.enquote    # => '"Hello World"'
+        #
         def enquote
           %Q{"#{self}"}
         end
         
+        # See CSD::Vendor::ActiveSupport::Inflector#constantize
+        #
+        def constantize
+          Vendor::ActiveSupport::Inflector.constantize(self)
+        end
+        
+        # See CSD::Vendor::ActiveSupport::Inflector#camelize
+        #
+        def camelize
+          Vendor::ActiveSupport::Inflector.camelize(self)
+        end
+        
+        # See CSD::Vendor::ActiveSupport::Inflector#demodulize
+        #
+        def demodulize
+          Vendor::ActiveSupport::Inflector.demodulize(self)
+        end
+        
+        # See CSD::Vendor::ActiveSupport::Inflector#underscore. Note that there is
+        # a name conflict with <tt>String#underscore</tt> provided by CSD::Vendor::Term::ANSIColor,
+        # which is why this method is renamed to +underscorize+.
+        # 
+        def underscorize
+          Vendor::ActiveSupport::Inflector.underscore(self)
+        end
+        
+        # Just an alias to the more logical wording of this method
+        #
+        def starts_with?(*args) #:nodoc:
+          start_with?(*args)
+        end
+        
+        # Just an alias to the more logical wording of this method
+        #
+        def ends_with?(*args) #:nodoc:
+          end_with?(*args)
+        end
+        
       end
     end
   end
 end
 
 class String #:nodoc:
-  include Term::ANSIColor
+  include CSD::Vendor::Term::ANSIColor
   include CSD::Extensions::Core::String
 end

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

@@ -1,16 +1,31 @@
-# encoding: utf-8
+# -*- encoding: UTF-8 -*-
+
 module CSD
   module Extensions
+    # This namespace is given to all extensions made to third-party Gems.
+    #
     module Gem
+      # This module comprises extensions to the Array object.
+      #
       module Platform
   
+        # This method returns a human-readable string for the current OS and CPU architecture.
+        #
         def humanize
           version_string = version ? ", version #{version}" : ''
-          "#{os} (CPU: #{cpu}#{version_string})"
+          "#{os} (#{cpu}#{version_string})"
         end
         
+        # On linux systems, this method returns the current kernel version.
+        #
         def kernel_version
-          Cmd.run('uname -v', :silent => true).chop if os == 'linux'
+          Cmd.run('uname --kernel-version', :silent => true).output.chop if os == 'linux'
+        end
+        
+        # On linux systems, this method returns the current kernel release.
+        #
+        def kernel_release
+          Cmd.run('uname --kernel-release', :silent => true).output.chop if os == 'linux'
         end
   
       end

data/lib/csd/{options.rb → options_parser.rb}

@@ -1,45 +1,40 @@
-# encoding: utf-8
-# Ruby standard library
+# -*- encoding: UTF-8 -*-
 require 'optparse'
 require 'optparse/time'
 require 'ostruct'
-# Vendor
-require 'active_support/core_ext/string/inflections'
-require 'active_support/core_ext/string/starts_ends_with'
-require 'active_support/core_ext/array'
-# CSD
 require 'csd/extensions'
-Dir.glob(File.join(File.dirname(__FILE__), '*.rb')) { |file| require file }
 
 module CSD
   # A class that handles the command line option parsing and manipulation
   #
-  class Options < GlobalOpenStruct
+  class OptionsParser < OpenStruct
     
-    def self.parse!
+    def parse!
       clear
       parse_literals
       define_actions_and_scopes
       parse_options
     end
     
-    def self.valid_action?
-      public_actions    = actions[:public] ? self.actions[:public].map { |pair| pair.keys.first } : []
-      developer_actions = actions[:developer] ? self.actions[:developer].map { |pair| pair.keys.first } : []
+    def valid_action?
+      public_actions    = actions['public'] ? self.actions['public'].map { |pair| pair.keys.first } : []
+      developer_actions = actions['developer'] ? self.actions['developer'].map { |pair| pair.keys.first } : []
       all_actions = public_actions + developer_actions
       all_actions.include?(self.action)
     end
     
-    def self.define_actions_and_scopes
+    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}."
         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}."
         self.scopes  = Applications.current.scopes(self.action)
       end
     end
     
-    def self.clear
+    def clear
       # First we define all valid actions and scopes
       self.actions = []
       self.scopes  = []
@@ -52,14 +47,15 @@ module CSD
       self.dry       = false
       self.reveal    = false
       self.verbose   = false
-      self.debug     = false
       self.silent    = false
       self.developer = false
+      # Shortcut to allow for debugging the options parser itself
+      self.debug     = (ARGV.include?('--debug') or ARGV.include?('-d'))
     end
 
     # Here we check for literals, i.e. "help", ACTION and APPLICATION.
     #
-    def self.parse_literals
+    def parse_literals
       # First let's see whether we are in help mode, i.e. whether the first argument is `help´.
       # If so, we would like to remove it from the ARGV list.
       if ARGV.first == 'help'
@@ -85,7 +81,7 @@ module CSD
     # Parse all options that the user gave as command parameter. Note that this function strips the options
     # from ARGV and leaves only literal (non-option) parameters (i.e. actions/applications/scopes; strings without -- and -).
     #
-    def self.parse_options
+    def parse_options
       OptionParser.new do |opts|
         self.banner = Applications.current ? "ADVANCED HELP FOR #{Applications.current.name}" : "Usage: ".bold + "ai [help] [TASK] APPLICATION [OPTIONS]"
         opts.banner = self.banner.magenta.bold
@@ -102,7 +98,7 @@ module CSD
         # 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
-          unless Applications.current.options(self.action).size.blank?
+          unless Applications.current.options(self.action).size == 0
             opts.headline "#{self.action.to_s.upcase} #{Applications.current.name.upcase} OPTIONS".green.bold
             eval Applications.current.options(self.action)
           else
@@ -140,7 +136,7 @@ module CSD
           self.help = value
         end
         opts.on_tail("-v", "--version", "Show version") do
-          puts "CSD Gem Version: #{CSD::VERSION}".blue
+          puts "CSD Gem Version: #{CSD::Version}".blue
           exit
         end
         self.helptext = opts.help