ki-repo 0.1.1 → 0.1.2

data/lib/cmd/user_pref_cmd.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-# Copyright 2012 Mikko Apo
+# Copyright 2012-2013 Mikko Apo
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,6 +20,7 @@ module Ki
   class UserPrefFile < KiJSONHashFile
     attr_chain :uses, -> { Array.new }, :accessor => CachedData
     attr_chain :prefixes, -> { Array.new }, :accessor => CachedData
+    attr_chain :requires, -> { Array.new }, :accessor => CachedData
 
     def initialize
       super("ki-user-pref.json")
@@ -31,42 +32,6 @@ module Ki
   class UserPrefCommand
     attr_chain :shell_command
 
-    def help
-<<EOF
-#{summary}
-Syntax: #{shell_command} prefix|use parameters...
-
-### Examples for command prefixes:
-    #{shell_command} prefix
-    - shows command prefixes, when a "ki command" is executed ki looks for the command with all prefix combinations
-    #{shell_command} prefix version package
-    - sets two command prefixes, looks for "command", "version-command" and "package-command"
-    #{shell_command} prefix + foo
-    - adds one command prefix to existing ones, looks for "command", "version-command", "package-command", "foo-command"
-    #{shell_command} prefix - package foo
-    - removes two command prefixes from list
-    #{shell_command} prefix -c
-    - clears command prefix list
-
-### Examples for automatic script loading:
-    #{shell_command} use
-    - shows list of automatically loading scripts. when ki starts up, it looks for all defined versions and loads all files tagged with ki-cmd
-    #{shell_command} use ki/http ki/ftp/123:ki-extra
-    - scripts are loaded from two different version. ki/http uses latest available version and files tagged with "ki-cmd", ki/ftp uses specific version and files tagged with "ki-extra"
-    #{shell_command} use + ki/scp
-    - adds one more script package version
-    #{shell_command} use - ki/scp ki/ftp/123:ki-extra
-    - removes two configurations
-    #{shell_command} use -c
-    - clear use list
-
-EOF
-    end
-
-    def summary
-      "Sets user preferences"
-    end
-
     def execute(ctx, args)
       user_pref = ctx.user_pref
       pref = args.delete_at(0)
@@ -76,6 +41,9 @@ EOF
       elsif pref == "use"
         arr = user_pref.uses
         str = "Use"
+      elsif pref == "require"
+        arr = user_pref.requires
+        str = "Require"
       elsif pref.nil?
         puts "User preferences:"
         user_pref.cached_data.each_pair do |key, values|
@@ -116,6 +84,48 @@ EOF
         end
       end
     end
+
+    def summary
+      "Sets user preferences"
+    end
+
+    def help
+<<EOF
+#{summary}
+Syntax: #{shell_command} prefix|use parameters...
+
+### Examples for command prefixes:
+    #{shell_command} prefix
+    - shows command prefixes, when a "ki command" is executed ki looks for the command with all prefix combinations
+    #{shell_command} prefix version package
+    - sets two command prefixes, looks for "command", "version-command" and "package-command"
+    #{shell_command} prefix + foo
+    - adds one command prefix to existing ones, looks for "command", "version-command", "package-command", "foo-command"
+    #{shell_command} prefix - package foo
+    - removes two command prefixes from list
+    #{shell_command} prefix -c
+    - clears command prefix list
+
+### Examples for default script loading:
+    #{shell_command} use
+    - shows list of automatically loading scripts. when ki starts up, it looks for all defined versions and loads all files tagged with "ki"
+    #{shell_command} use ki/http ki/ftp/123:ki-extra
+    - scripts are loaded from two different version. ki/http uses latest available version and files tagged with "ki", ki/ftp uses specific version and files tagged with "ki-extra"
+    #{shell_command} use + ki/scp
+    - adds one more script package version
+    #{shell_command} use - ki/scp ki/ftp/123:ki-extra
+    - removes two configurations
+    #{shell_command} use -c
+    - clear use list
+
+### Examples for default Ruby file requiring:
+    #{shell_command} require
+    #{shell_command} require hooves/default
+    #{shell_command} require + hooves/default
+    #{shell_command} require - hooves/default
+    #{shell_command} require -c
+EOF
+    end
   end
 
   KiCommand.register_cmd("pref", UserPrefCommand)

data/lib/cmd/version_cmd.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-# Copyright 2012 Mikko Apo
+# Copyright 2012-2013 Mikko Apo
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -37,34 +37,6 @@ module Ki
       metadata_file.save
     end
 
-    def help
-      <<EOF
-"#{shell_command}" can be used to generate version metadata files. Version metadata files
-contain information about files (size, permission bits, hash checksums), version origins
-and dependencies.
-
-After version metadata file is ready, it can be imported to repository using version-import.
-
-### Usage
-
-    #{shell_command} <parameters> file_pattern1*.* file_pattern2*.*
-
-### Examples
-
-    #{shell_command} test.sh
-    #{shell_command} readme* -t doc
-    #{shell_command} -d my/component/1,name=comp,path=doc,internal -O "mv doc/test.sh helloworld.sh"
-    ki version-import
-
-### Parameters
-#{opts}
-EOF
-    end
-
-    def summary
-      "Create version metadata file"
-    end
-
     def opts
       OptionParser.new do |opts|
         opts.banner = ""
@@ -104,6 +76,34 @@ EOF
         end
       end
     end
+
+    def summary
+      "Create version metadata file"
+    end
+
+    def help
+      <<EOF
+"#{shell_command}" can be used to generate version metadata files. Version metadata files
+contain information about files (size, permission bits, hash checksums), version origins
+and dependencies.
+
+After version metadata file is ready, it can be imported to repository using version-import.
+
+### Usage
+
+    #{shell_command} <parameters> file_pattern1*.* file_pattern2*.*
+
+### Examples
+
+    #{shell_command} test.sh
+    #{shell_command} readme* -t doc
+    #{shell_command} -d my/component/1,name=comp,path=doc,internal -O "mv doc/test.sh helloworld.sh"
+    ki version-import
+
+### Parameters
+#{opts}
+EOF
+    end
   end
 
   # Tests version from repository or metadata file
@@ -132,24 +132,6 @@ EOF
       end
     end
 
-    def help
-      <<EOF
-"#{shell_command}" tests versions, their files and their dependencies. Can also test version that has not been imported yet.
-
-### Examples
-
-    #{shell_command} -r my/product other/product
-    #{shell_command} -f ki-version.json -i file-directory
-
-### Parameters
-#{opts}
-EOF
-    end
-
-    def summary
-      "Tests versions and their dependencies"
-    end
-
     def opts
       OptionParser.new do |opts|
         opts.banner = ""
@@ -168,42 +150,38 @@ EOF
         end
       end
     end
-  end
-
-  # Imports version and its files to repository
-  # @see VersionImporter
-  class ImportVersion
-    attr_chain :input_dir, -> { Dir.pwd }
-    attr_chain :file, -> { File.join(input_dir, "ki-version.json") }
-    attr_chain :importer, -> {}
-    attr_chain :shell_command, :require
 
-    def execute(ctx, args)
-      @importer = VersionImporter.new
-      opts.parse(args)
-      @importer.ki_home(ctx.ki_home).import(file, input_dir)
+    def summary
+      "Tests versions and their dependencies"
     end
 
     def help
       <<EOF
-"#{shell_command}" imports version and its files to repository.
-
-Version name can be defined either during "version-build",
-or generated automatically for component at import (with -c my/component) or defined to be a specific version (-v).
-Can also move files (-m), test dependencies before import (-t).
+"#{shell_command}" tests versions, their files and their dependencies. Can also test version that has not been imported yet.
 
 ### Examples
 
-    #{shell_command} -m -t -c my/product
+    #{shell_command} -r my/product other/product
     #{shell_command} -f ki-version.json -i file-directory
 
 ### Parameters
 #{opts}
 EOF
     end
+  end
 
-    def summary
-      "Imports version metadata and files to repository"
+  # Imports version and its files to repository
+  # @see VersionImporter
+  class ImportVersion
+    attr_chain :input_dir, -> { Dir.pwd }
+    attr_chain :file, -> { File.join(input_dir, "ki-version.json") }
+    attr_chain :importer, -> {}
+    attr_chain :shell_command, :require
+
+    def execute(ctx, args)
+      @importer = VersionImporter.new
+      opts.parse(args)
+      @importer.ki_home(ctx.ki_home).import(file, input_dir)
     end
 
     def opts
@@ -232,42 +210,42 @@ EOF
         end
       end
     end
-  end
 
-  # Exports version from repository to target directory
-  # @see VersionExporter
-  class ExportVersion
-    attr_chain :out, -> { Dir.pwd }
-    attr_chain :shell_command, :require
-
-    def execute(ctx, args)
-      @exporter = VersionExporter.new
-      file_patterns = opts.parse(args)
-      version = file_patterns.delete_at(0)
-      @exporter.find_files.files(file_patterns)
-      @exporter.ki_home(ctx.ki_home).export(version, out)
+    def summary
+      "Imports version metadata and files to repository"
     end
 
     def help
       <<EOF
-"#{shell_command}" exports version and its dependencies to target directory.
-
-### Usage
+"#{shell_command}" imports version and its files to repository.
 
-    #{shell_command} <parameters> <file_export_pattern*.*>
+Version name can be defined either during "version-build",
+or generated automatically for component at import (with -c my/component) or defined to be a specific version (-v).
+Can also move files (-m), test dependencies before import (-t).
 
 ### Examples
 
-    #{shell_command} -o export-dir --tags -c bin my/product
-    #{shell_command} -o scripts -c -t my/admin-tools '*.sh'
+    #{shell_command} -m -t -c my/product
+    #{shell_command} -f ki-version.json -i file-directory
 
 ### Parameters
 #{opts}
 EOF
     end
+  end
 
-    def summary
-      "Export version to a directory"
+  # Exports version from repository to target directory
+  # @see VersionExporter
+  class ExportVersion
+    attr_chain :out, -> { Dir.pwd }
+    attr_chain :shell_command, :require
+
+    def execute(ctx, args)
+      @exporter = VersionExporter.new
+      file_patterns = opts.parse(args)
+      version = file_patterns.delete_at(0)
+      @exporter.find_files.files(file_patterns)
+      @exporter.ki_home(ctx.ki_home).export(version, out)
     end
 
     def opts
@@ -287,6 +265,28 @@ EOF
         end
       end
     end
+
+    def summary
+      "Export version to a directory"
+    end
+
+    def help
+      <<EOF
+"#{shell_command}" exports version and its dependencies to target directory.
+
+### Usage
+
+    #{shell_command} <parameters> <file_export_pattern*.*>
+
+### Examples
+
+    #{shell_command} -o export-dir --tags -c bin my/product
+    #{shell_command} -o scripts -c -t my/admin-tools '*.sh'
+
+### Parameters
+#{opts}
+EOF
+    end
   end
 
   # Sets status for version
@@ -314,6 +314,10 @@ EOF
       end
     end
 
+    def summary
+      "Add status values to version"
+    end
+
     def help
       <<EOF
 "#{shell_command}" sets status values to versions and sets status value order to component.
@@ -328,10 +332,6 @@ Status value order is used to determine which statuses match version queries:
     #{shell_command} order my/component maturity alpha,beta,gamma
 EOF
     end
-
-    def summary
-      "Add status values to version"
-    end
   end
 
   # Shows information about a version
@@ -389,22 +389,7 @@ EOF
     end
 
     def map_to_csl(map)
-      map.sort.map { |k, v| "#{k}=#{Array.wrap(v).join(",")}" }.join(", ")
-    end
-
-    def help
-      <<EOF
-"#{shell_command}" prints information about version or versions and their dependencies
-
-### Examples
-
-    #{shell_command} -r -d my/component/23 my/product/127
-    #{shell_command} -f ki-version.json -i binary-dir
-EOF
-    end
-
-    def summary
-      "Prints information about version or versions"
+      map.sort.map { |k, v| "#{k}=#{Array(v).join(",")}" }.join(", ")
     end
 
     def opts
@@ -428,6 +413,24 @@ EOF
         end
       end
     end
+
+    def summary
+      "Prints information about version or versions"
+    end
+
+    def help
+      <<EOF
+"#{shell_command}" prints information about version or versions and their dependencies
+
+### Examples
+
+    #{shell_command} -r -d my/component/23 my/product/127
+    #{shell_command} -f ki-version.json -i binary-dir
+
+### Parameters
+#{opts}
+EOF
+    end
   end
 
   # Sets status for version
@@ -453,6 +456,10 @@ EOF
       end
     end
 
+    def summary
+      "Searches for versions and components"
+    end
+
     def help
 <<EOF
 "#{shell_command}" searches for versions and components.
@@ -463,10 +470,6 @@ EOF
     #{shell_command} my/*
 EOF
     end
-
-    def summary
-      "Searches for versions and components"
-    end
   end
 
   KiCommand.register_cmd("version-build", BuildVersionMetadataFile)