build-tool 0.2 → 0.3

data/lib/build-tool/cfg/parser.y

@@ -1,6 +1,7 @@
 class BuildTool::Cfg::Parser < BuildTool::Cfg::Lexer
 
     token APPEND
+    token APPLY
     token ARCHIVE
     token BUILD_PREFIX
     token BUILD_SYSTEM
@@ -23,7 +24,9 @@ class BuildTool::Cfg::Parser < BuildTool::Cfg::Lexer
     token LOG_DIRECTORY
     token LONG
     token MODULE
+    token ONLY
     token OPTION
+    token PATCH
     token PATH
     token PREPEND
     token PROTOCOL
@@ -35,6 +38,7 @@ class BuildTool::Cfg::Parser < BuildTool::Cfg::Lexer
     token SHORT
     token SSH_KEY
     token STRING
+    token SVN
     token TEMPLATE
     token TOKEN
     token TRACK_BRANCH
@@ -96,6 +100,7 @@ rule
 
     vcs_declaration
         : git_declaration          { result = val[0]; }
+        | svn_declaration          { result = val[0]; }
         | git_svn_declaration      { result = val[0]; }
         | archive_declaration      { result = val[0]; }
         ;
@@ -165,7 +170,7 @@ rule
 
     feature_statement
         : statement                 { result = val.flatten; }
-        | LONG DESCRIPTION STRING   { result = LongDescriptionNode.new( val[2] ); }
+        | LONG DESCRIPTION multiline_string   { result = LongDescriptionNode.new( val[2] ); }
         | SHORT DESCRIPTION STRING  { result = ShortDescriptionNode.new( val[2] ); }
         ;
 
@@ -237,6 +242,8 @@ rule
         | USE ENVIRONMENT  identifier { result = UseEnvironmentNode.new( val[2] ); }
         | USE REPOSITORY   identifier { result = UseRepositoryNode.new( val[2] ); }
         | USE VCS          identifier { result = UseVcsNode.new(         val[2] ); }
+        | LONG DESCRIPTION multiline_string   { result = LongDescriptionNode.new( val[2] ); }
+        | DESCRIPTION STRING          { result = ShortDescriptionNode.new( val[1] ); }
         | build_system_declaration    { result = val[0]; }
         | vcs_declaration             { result = val[0]; }
         | repository_declaration      { result = val[0]; }
@@ -245,7 +252,8 @@ rule
         | BUILD_PREFIX   STRING { result = ModuleBuildPrefixNode.new(   val[1] ); }
         | REMOTE_PATH    STRING { result = ModuleRemotePathNode.new(    val[1] ); }
         | LOCAL_PATH     STRING { result = ModuleLocalPathNode.new(     val[1] ); }
-        | TEMPLATE { result = ModuleTemplateNode.new(); }
+        | TEMPLATE              { result = ModuleTemplateNode.new(); }
+        | APPLY PATCH STRING    { result = ApplyPatchesNode.new(val[2]); }
         ;
 
     #
@@ -303,6 +311,30 @@ rule
         : FILE STRING { result = SshKeyFileNode.new( val[1] ); }
         ;
 
+    #
+    ### SVN CONFIGURATION
+    #
+    svn_declaration
+        : VCS SVN svn_statements END { result = SvnDeclarationNode.new( val[2] ); }
+        ;
+
+    svn_statements
+        : /* empty */
+        | svn_statement svn_statements { result = val.flatten; }
+        ;
+
+    svn_statement
+        : ONLY STRING { result = SvnCheckoutOnlyNode.new(val[1]); }
+        ;
+
+    #
+    ### HELPER
+    #
+    multiline_string
+        : /* empty */
+        | multiline_string STRING  { result = val[0] ? val[0] + "\n" + val[1] : val[1]; } 
+        ;
+
 end # class BuildTool::Cfg::GitParser
 
 ---- header ----

data/lib/build-tool/cfg/visitor.rb

@@ -136,11 +136,6 @@ module BuildTool; module Cfg;
             node.accept( visitor )
         end
 
-        def visit_GitDeclarationNode( node )
-            visitor = GitDeclarationNodeVisitor.new( configuration )
-            return node.accept( visitor )
-        end
-
         def visit_IncludeNode( node )
             visitor = IncludeNodeVisitor.new( configuration )
             node.accept( visitor )
@@ -266,7 +261,6 @@ module BuildTool; module Cfg;
 
         def visit_LongDescriptionNode( node )
             if @feature.long_description
-                puts @feature.description
                 logger.warn "Overwriting long description for feature #{@feature.name}"
             end
             @feature.long_description = node.values
@@ -376,6 +370,10 @@ module BuildTool; module Cfg;
             @module = nil
         end
 
+        def visit_ApplyPatchesNode( node )
+            @module.patches << node.value
+        end
+
         def visit_ArchiveDeclarationNode( node )
             if @module.vcs_configuration and @module.vcs_configuration.name == "archive"
                 vcs = @module.vcs_configuration.dup
@@ -400,6 +398,13 @@ module BuildTool; module Cfg;
             @module.build_system.module = @module
         end
 
+        def visit_LongDescriptionNode( node )
+            if @module.long_description
+                logger.warn "Overwriting long description for feature #{@module.name}"
+            end
+            @module.long_description = node.values
+        end
+
         def visit_EnvironmentDeclarationNode( node )
             visitor = EnvironmentDeclarationNodeVisitor.new( configuration )
             @module.environment = node.accept( visitor )
@@ -491,6 +496,24 @@ module BuildTool; module Cfg;
             @module.repository = node.accept( visitor )
         end
 
+        def visit_ShortDescriptionNode( node )
+            if !@module.description.nil?
+                logger.warn "Overwriting short description for module #{@module.name}"
+            end
+            @module.description = node.values
+        end
+
+        def visit_SvnDeclarationNode( node )
+            if @module.vcs_configuration and @module.vcs_configuration.name == "svn"
+                vcs = @module.vcs_configuration.dup
+            else
+                vcs = BuildTool::VCS::SvnConfiguration.new
+            end
+            @module.vcs_configuration = vcs
+            visitor = SvnDeclarationNodeVisitor.new( configuration, vcs )
+            node.accept( visitor )
+        end
+
         def visit_UseBuildSystemNode( node )
             @module.build_system = configuration.build_system( node.value ).dup
             @module.build_system.module = @module
@@ -624,6 +647,23 @@ module BuildTool; module Cfg;
 
     end
 
+    class SvnDeclarationNodeVisitor < GitDeclarationNodeVisitor
+
+        def initialize( configuration, vcs )
+            super( configuration, vcs )
+        end
+
+        def visit_SvnDeclarationNode( node )
+            visit_nodes( node.values )
+            return @vcs
+        end
+
+        def visit_SvnCheckoutOnlyNode( node )
+            @vcs.only = node.value.split( / +/ )
+        end
+
+    end # class SvnDeclarationNodeVisitor
+
 end; end
 
 

data/lib/build-tool/commands.rb

@@ -41,6 +41,7 @@ module BuildTool; module Commands;
 
             def_attribute :name
             def_attribute :description
+            def_attribute :long_description
             def_attribute :cmdalias
 
         end
@@ -57,6 +58,10 @@ module BuildTool; module Commands;
             self.class.description
         end
 
+        def long_description
+            self.class.long_description || nil
+        end
+
         def self.included( klass )
             klass.extend( ClassMethods )
         end
@@ -86,9 +91,6 @@ module BuildTool; module Commands;
         attr_accessor :cmd
 
         def initialize(parent = nil)
-            @options = OptionParser.new
-            @options.set_program_name( name )
-            initialize_options
             @skip_command = false
             @parent = parent
             @cmd = nil
@@ -206,6 +208,7 @@ module BuildTool; module Commands;
         def execute( args )
             @options = OptionParser.new
             @options.set_program_name( name )
+            @options.separator long_description if long_description
 
             @parsing = true
             initialize_options
@@ -257,7 +260,7 @@ module BuildTool; module Commands;
         # @return [String] The commands full name
         #
         def fullname
-            if parent.fullname
+            if parent && parent.fullname
                 return parent.fullname + " " + name
             else
                 return name

data/lib/build-tool/commands/build.rb

@@ -10,6 +10,7 @@ module BuildTool; module Commands;
 
         name        "build"
         description "Build a module."
+        long_description [ "Build the given modules. This is the all in one interface to build-tool." ]
 
         # Log this command if $noop is not active
         def log?
@@ -17,7 +18,9 @@ module BuildTool; module Commands;
         end
 
         def initialize_options
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname} [MODULES]..."
 
+            @options.separator "Options:"
             @clean        = false
             @configure    = false
             @from_scratch = false

data/lib/build-tool/commands/configure.rb

@@ -13,6 +13,8 @@ module BuildTool; module Commands;
 
         name        "configure"
         description "configure the module"
+        long_description [ "Invokes the configuration phase for the specified modules." ]
+
 
         # Log this command if $noop is not active
         def log?
@@ -21,10 +23,13 @@ module BuildTool; module Commands;
 
         def initialize_options
 
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname} MODULES..."
             @rmcache      = false
             @from_scratch = false
             @clean        = false
 
+            @options.separator "Options:"
+
             options.on( "--[no-]clean", "Make clean before building." ) { |t|
                 @clean = t
                 }

data/lib/build-tool/commands/ctags.rb

@@ -13,6 +13,12 @@ module BuildTool; module Commands;
 
         name        "ctags"
         description "run ctags on the module."
+        long_description [ "Invoke ctags for the specified MODULES." ]
+
+        def initialize_options
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname} MODULES..."
+            super
+        end
 
         def applicable?
             BuildTool::Application.instance.name != "build-tool"

data/lib/build-tool/commands/environments/list.rb

@@ -9,13 +9,18 @@ module BuildTool; module Commands; module Environments
 
         name        "list"
         description "List all available environments in alphabetical order."
+        long_description [ "Shows the list of  all environments of the current recipe."]
         cmdalias    "lsenv"
 
         def initialize_options
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname}"
+
+            @options.separator "Options:"
             @all = false
             options.on( "--all", "Show inactive environments." ) { |t|
                 @all = true
                 }
+                super
         end
 
         def do_execute( args )

data/lib/build-tool/commands/environments/set.rb

@@ -9,6 +9,7 @@ module BuildTool; module Commands; module Environments
 
         name        "set"
         description "Open a shell with the environment set."
+        long_description "Opens a new shell with the exact environment used by build-tool for the script."
 
         def do_execute( args )
             case args.length
@@ -25,6 +26,11 @@ module BuildTool; module Commands; module Environments
             return env.shell
         end
 
+        def initialize_options
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname} MODULE"
+            super
+        end
+
     end # class
 
 end; end; end # module BuildTool::Commands::Modules

data/lib/build-tool/commands/fetch.rb

@@ -13,6 +13,9 @@ module BuildTool; module Commands;
 
         name        "fetch"
         description "fetch remote changes (if applicable)"
+        long_description [ "Invoke the fetch phase for the given modules. It depends on the modules",
+                           "VCS if this command has any effect." ]
+
 
         # Log this command if $noop is not active
         def log?
@@ -23,6 +26,11 @@ module BuildTool; module Commands;
             BuildTool::Application.instance.name != "build-tool"
         end
 
+        def initialize_options
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname} MODULES..."
+            super
+        end
+
         def is_module_ready?( mod )
             isready = true
             isready &= mod.prepare_for_vcs_access

data/lib/build-tool/commands/files.rb

@@ -10,6 +10,8 @@ module BuildTool; module Commands;
 
         name        "files"
         description "Get the content of some helper files."
+        long_description [ "Shows the list of files provided with this recipe without parameters",
+                           "or the content of the given file if one is specified." ]
 
         def applicable?
             BuildTool::Application.instance.name != "build-tool"
@@ -30,6 +32,11 @@ module BuildTool; module Commands;
             end
         end
 
+        def initialize_options
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname} [FILENAME]"
+            super
+        end
+
         def print_file_list
             recipe = Application::instance.recipe
             files_dir = recipe.files_path

data/lib/build-tool/commands/gc.rb

@@ -9,8 +9,12 @@ module BuildTool; module Commands;
 
         name        "gc"
         description "Remove old stuff"
+        long_description [ "Invokes maintenance actions. The history db is purged from entries older",
+                           "than 10 days. If supplied do garbage collection for the modules too.",
+                           "What that means is subject to the modules. See with -vvvv."]
 
         def initialize_options
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname} [MODULE|GROUP]..."
             super
         end
 

data/lib/build-tool/commands/history.rb

@@ -9,9 +9,16 @@ module BuildTool; module Commands;
 
         name        "history"
         description "show command history"
+        long_description [ "Query the command history",
+                           "    NO PARAM: Show the history list",
+                           "    NUMBER:   Show detailed information about entry NUMBER",
+                           "    +NUMBER:  Show detailed information about NUMBER next to last entry",
+                           "    MODULE:   Show the last three commands on MODULE" ]
 
         def initialize_options
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname} [NUMBER|+NUMBER|MODULE]"
 
+            @options.separator "Options:"
             # Show detailed history. Add start time, duration and success/failure
             @long = false
             options.on( "-l", "--long", "Use long list format." ) { |t|

data/lib/build-tool/commands/info.rb

@@ -9,8 +9,10 @@ module BuildTool; module Commands;
 
         name        "info"
         description "show info"
+        long_description [ "Show information about the currently used recipe" ]
 
         def initialize_options
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname}"
             super
         end
 

data/lib/build-tool/commands/install.rb

@@ -13,6 +13,7 @@ module BuildTool; module Commands;
 
         name        "install"
         description "install the module"
+        long_description [ "Invokes the installation phase for the specified modules." ]
 
         # Log this command if $noop is not active
         def log?
@@ -20,9 +21,10 @@ module BuildTool; module Commands;
         end
 
         def initialize_options
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname} MODULES..."
 
+            @options.separator "Options:"
             @fast        = false
-
             options.on( "--fast", "Fast install. No compile (if supported)" ) { |t|
                 @fast = t
                 }

data/lib/build-tool/commands/lsfeatures.rb

@@ -9,8 +9,11 @@ module BuildTool; module Commands;
 
         name        "lsfeatures"
         description "List all available features."
+        long_description [ "Shows the list of all features available with the current recipe or",
+                           "detailed info about one or more features given as arguments." ]
 
         def initialize_options
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname} [FEATURES]..."
             super
         end
 

data/lib/build-tool/commands/modules/info.rb

@@ -11,6 +11,15 @@ module BuildTool; module Commands; module Modules
         description "show detailed information about modules."
 
         def do_execute_module( mod )
+            if mod.description
+                say mod.description
+                say ""
+            else
+                say "No description specified to the module"
+                say ""
+            end
+            say mod.long_description if mod.long_description
+
             say "Active:            #{mod.active?}"
 
             if mod.repository
@@ -18,6 +27,7 @@ module BuildTool; module Commands; module Modules
                 if mod.repository.sshkey
                     say "  SSH Key:         '#{mod.repository.sshkey.name}' (#{mod.repository.sshkey.file})"
                 end
+                say "Apply Patches:     #{mod.patches.join(", ")}"
             else
                 say "Repository:        not configured"
             end
@@ -77,6 +87,11 @@ module BuildTool; module Commands; module Modules
             return 0
         end
 
+        def initialize_options
+            @options.banner = "Usage: #{Pathname.new($0).basename} #{self.fullname} MODULES..."
+            super
+        end
+
     end # class Info
 
 end; end; end # module BuildTool::Commands::Modules