ki-repo 0.1.1 → 0.1.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmQ2ZWU2NzU1OGRiMzZjMjJmZWY4Zjg4YTAzY2NhM2ZmOTAwZTU5YQ==
+  data.tar.gz: !binary |-
+    ZDUxMjViYmY2ZTU3ZTg0NGQ2MzViNjUwZDVkMzU3MmY2N2FjNWZiYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTRjZTJlN2YwNWY3NTA0NTVjYTU5N2IxZDFjZTAzZjVhNjJjMzE0MjI4MDcz
+    NjM1NjU1YzhhN2Q2ZTc4YjU3OGEyY2Q1Mzk0ODBmOTlkZTM5ZWY4NmZhZjlh
+    YjBmZWI1ZjRlYjgyMjE0NDFhZTM2YjEzNmU0MGQ4NDQ2MzYyNjc=
+  data.tar.gz: !binary |-
+    NWIwM2NmOTU4YmZlMjZiODg2NmYzZDFjYzgwMjE4MTRkZDkzMTk5YzIyY2Vj
+    MWFjYjcyMGJiMmNkZGMwNjRkYzE2ZDY3OTVmZjRmNWI2ZTQ5Mjk0M2Q3NmQw
+    OGNmYzdhMmZhOGYzNjc2M2Q3MzFmYTU3Y2EzYTQ2YTNiNWMxMjI=

data/LICENSE.txt

@@ -1,4 +1,4 @@
-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.

data/README.md

@@ -8,6 +8,7 @@ note: Currently Ki is not ready for any kind of use.
 
 * Rubygem: https://rubygems.org/gems/ki-repo
 * Documentation for latest released version is available at http://rubydoc.info/gems/ki-repo
+* See also ki-flow, the advanced CI system: http://ki-flow.org and https://github.com/mikko-apo/ki-flow
 
 # Documentation
 
@@ -26,6 +27,26 @@ note: Currently Ki is not ready for any kind of use.
 Once these features are implemented Ki is ready for use on local server. In the future, the goal is to provide tools
 to manage distributed repositories: downloads and replication.
 
+# Tech stack
+
+* http://www.ruby-lang.org/en/
+
+## Testing and documentation
+
+* http://rspec.info/ - Test framework
+* http://gofreerange.com/mocha - Ruby test mocking
+* https://github.com/colszowka/simplecov - Test coverage
+* http://yardoc.org/ - Yard documentation
+* https://github.com/rtomayko/rdiscount - Markdown
+
+## Web
+
+* http://rack.github.com/ - Ruby web server support
+* http://www.sinatrarb.com/ - Simple web application framework
+* http://coffeescript.org/
+* http://sass-lang.com/
+* http://code.google.com/p/selenium/wiki/RubyBindings - Selenium WebDriver
+
 # Copyright
 
 Copyright (c) 2012 Mikko Apo. See {file:LICENSE.txt} for further details.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/bin/ki

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # 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.

data/docs/backlog.md

@@ -1,29 +1,29 @@
-# @title Ki: Backlog
+# @title ki-repo: Backlog
 
-# Backlog for 0.2
+# Next release
+* if there is a file ki-version.json under ki-repo directory, many tests fail
+* /web/ is not registered correctly
 * fix defined? checks
-* fix double repository entries in finder.all_repositories "should show imported version"
-* cleanup gem
-* create release notes
-
-# 0.3
-* cleanup and removal operations
 * version() returns sometime nil, sometimes Version
 * version!()
 * fix Version.exists? - there should be a better way to check if version exists
 * VersionTester should support test_version(metadata, source)
 * Download & replication
-* website command
 * daemon: long running processes, web site monitoring
 * multiple local repositories: command line tools and helpers
-* support for separate binaries directory
 * pref: define repository lookup order
+* support for separate binaries directory
+* cleanup and removal operations
+* create release notes
+* web cmd store handler to prefs
+* version-build can use .ki.yml to build version
 
 # Future releases
 * Digital signing
 * Encrypted/packed packages
 * Support for using files from other repositories
 * when building version create file operations based on user's changes
+* version retention strategy visible from source
 
 # Maybe at some point...
 * replace popen4.spawn with Kernel.spawn

data/docs/development.md

@@ -16,12 +16,13 @@ Follow the instructions here: {file:docs/development_setup.md}
 * {Ki::KiCommandHelp}, {Ki::KiInfoCommand} - help, ki-info
 * {Ki::UserPrefCommand} - Stored preferences
 * {Ki::BuildVersionMetadataFile}, {Ki::TestVersion}, {Ki::ImportVersion}, {Ki::ExportVersion}, {Ki::VersionStatus}, {Ki::ShowVersion}, {Ki::VersionSearch} - repository management
+* {Ki::RackCommand} - Starts up web application
 
 ## Data storage - files and directories
 
 * {Ki::KiHome}, {Ki::Repository::Repository}, {Ki::Repository::Component}, {Ki::Repository::Version} - Repository directory objects
 * {Ki::VersionMetadataFile}, {Ki::Dependency}, {Ki::VersionStatusFile} - Version metadata and statuses
-* {Ki::DirectoryBaseModule}, {Ki::DirectoryBase} - Base classes for file and directory management
+* {Ki::DirectoryBase} - Base class for file and directory management
 * {Ki::KiJSONFile}, {Ki::KiJSONListFile}, {Ki::KiJSONHashFile}, {Ki::KiJSONHashFile::CachedMapDataAccessor} - Base classes for JSON files
 * {Ki::DirectoryWithChildrenInListFile} - Helper to generate list file class and related methods for a repository object
 * {Ki::RepositoryMethods}, {Ki::RepositoryMethods::RepositoryListFile} - Repository helper methods
@@ -43,3 +44,4 @@ Follow the instructions here: {file:docs/development_setup.md}
 * {ExceptionCatcher} - Execute multiple blocks and process exceptions in the end
 * {Ki::ServiceRegistry} - Class for storing all Ki extensions
 * {Ki::SimpleOptionParser} - Simplified OptionParser
+* {Ki::HashLog} - Hash based logging

data/docs/ki_commands.md

@@ -1,5 +1,5 @@
 # @title Ki: Command line utilities
-# Command line utilities for Ki Repository v0.1.0
+# Command line utilities for Ki Repository v0.1.1
 "ki" is the main command line tool that starts all other Ki processes. Whenever ki command line tools
 are executed, ki goes through the following startup process
 
@@ -14,12 +14,13 @@ Examples
     ki -u my/tools compile
     ki -u my/tools:scripts,tools compile
 
-note: By default only files with tag "ki-cmd" are used. Use the 'my/tools:scripts,tools' to define additional tags.
+note: By default only files with tag "ki" are used. Use the 'my/tools:scripts,tools' to define additional tags.
 
 Common parameters:
 
     -h, --home                       Path to Ki root directory
     -u, --use                        Use defined scripts
+        --require                    Require Ruby files, comma separated list
 
 ## help: Displays help for given Ki command
 
@@ -30,7 +31,6 @@ Common parameters:
     ki help
     ki help version-build
 
-
 ## ki-info: Show information about Ki
 
 "ki ki-info" shows information about Ki.
@@ -162,6 +162,14 @@ Status value order is used to determine which statuses match version queries:
     ki version-show -r -d my/component/23 my/product/127
     ki version-show -f ki-version.json -i binary-dir
 
+### Parameters
+
+    -r, --recursive                  Shows version's dependencies.
+    -d, --dirs                       Shows version's directories.
+    -f, --file FILE                  Version source file. By default uses file's directory as source for binary files.
+    -i, --input-directory INPUT-DIR  Binary file input directory
+
+
 ## version-search: Searches for versions and components
 
 "ki version-search" searches for versions and components.
@@ -188,11 +196,11 @@ Syntax: ki pref prefix|use parameters...
     ki pref prefix -c
     - clears command prefix list
 
-### Examples for automatic script loading:
+### Examples for default script loading:
     ki pref 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
+    - shows list of automatically loading scripts. when ki starts up, it looks for all defined versions and loads all files tagged with "ki"
     ki pref 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"
+    - 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"
     ki pref use + ki/scp
     - adds one more script package version
     ki pref use - ki/scp ki/ftp/123:ki-extra
@@ -200,3 +208,24 @@ Syntax: ki pref prefix|use parameters...
     ki pref use -c
     - clear use list
 
+### Examples for default Ruby file requiring:
+    ki pref require
+    ki pref require hooves/default
+    ki pref require + hooves/default
+    ki pref require - hooves/default
+    ki pref require -c
+
+## web: Starts Ki web server and uses code from Ki packages
+
+ki-repo has a built in web server.
+
+### Usage
+
+    ki web - Starts Ki web server
+
+### Parameters
+
+        --handler HANDLER            Use specified Rack Handler
+        --development                Development mode, resource urls are reloaded
+    -p, --port PORT                  Use specified port
+

data/docs/repository_basics.md

@@ -41,7 +41,7 @@ Ki-Repo is a repository for storing file packages and metadata about those packa
 An example repository has following structure:
 
 * Repository has three components: `"my/componentA"`, `"my/componentB"`, `"my/product"`.
-* Each component maintains a chronological list of versions. For example, `"my/component"` has versions `"3"`, `"2"` and `"1"`.
+* Each component maintains a chronological list of versions. For example, `"my/component"` has versions `"23"`, `"22"` and `"21"`.
 * Component's name should be a unique identifier and it can include any number of identifiers. Valid component names include `"ki/repo"`, `"ki-repo"` or `"my/test/builds/ki/repo/"`.
 * Version contains a set of files. Version can also define dependencies and other metadata.
 
@@ -144,6 +144,15 @@ File operations are defined for "version-build" with -o and -O parameters
     ki version-build -d my/tests/a/123,name=tests -o "rm *.txt"
     ki version-build -O "cp scripts/start.sh start.sh"
 
+### Status information
+
+Each version can have status values. Status values can be used to tag certain kind of versions (released),
+or find latest version that has a specific status value:
+
+    my/component:released
+    my/component:IntegrationTest=green
+
+
 ## Component
 
 Component has only a two responsibilities:
@@ -155,6 +164,8 @@ Status value order is used to determine which statuses match version queries:
 
     my/component:maturity>alpha
 
+"maturity" order could be "alpha,beta,gamma" and latest version that has either beta or gamma would get chosen.
+
 ## Repository
 
 Repository directory keeps a list of all components that have data in the repository.

data/docs/writing_extensions.md

@@ -20,31 +20,49 @@ Examples
     ki -u my/tools compile
     ki -u my/tools:scripts,tools compile
 
-note: By default only files with tag "ki-cmd" are used. Use the 'my/tools:scripts,tools' to define additional tags.
+note: By default only files with tag "ki" are used. Use the 'my/tools:scripts,tools' to define additional tags.
 
 Ki's extension mechanism makes it easy to manage different scenarios:
 * write and distribute command line utilities
 * use different versions of those utilities at the same time on the same machine (backwards compatability)
 * add new features to existing utilities: hashing algorithms, integrations to different tools like git, mercurial and svn
 
-# Command line utility
+# Extension points
+
+{Ki::KiCommand} stores all registered extensions to its class variable {Ki::KiCommand::KiExtensions} ({Ki::ServiceRegistry}).
+
+Currently used extension points are:
+
+* /commands/
+* /hashing/
+* /web/
+
+## Command line utility - /commands/
 
 Command classes are registered with KiCommand.register_cmd
 
     KiCommand.register_cmd("version-build", BuildVersionMetadataFile)
 
 They should implement following methods:
+
 * execute(ctx, args)
 * help, summary
 * attr_chain :shell_command, :require is optional but help method can use it to generate more useful help texts
 
 For more information, see {Ki::ImportVersion}
 
-# Extension points
+## Cryptographic hash functions - /hashing/
 
-{Ki::KiCommand} stores all registered extensions to its class variable {Ki::KiCommand::KiExtensions} ({Ki::ServiceRegistry}).
+Classes used for hashing must implement class method digest which returns a class extending Digest::Class
 
-Currently used extension points are:
+For more information, see {Ki::SHA2} and {Digest::SHA2}
 
-* /commands/
-* /hashing/
+## Web classes - /web/
+
+Ki-repo includes support for running web applications. Web applications are created by creating Rack application classes
+and tagging each file containing classes with "ki". That way "ki" command loads files and {Ki::RackCommand} starts
+web application from classes that were loaded. Each class is registered to the path remaining from registration key:
+
+    KiCommand.register("/web/test", MyApp2)
+
+For more information, see {Ki::RackCommand}

data/lib/cmd/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.
@@ -39,12 +39,52 @@ module Ki
       KiExtensions.register(name, clazz)
     end
 
+    # bin/ki command line tool calls this method, which finds the correct class to manage the execution
+    def execute(args)
+      @use = []
+      @require = []
+      @load = []
+      my_args = opts.parse(args.dup)
+      require_files
+      load_scripts
+      if my_args.empty?
+        KiCommandHelp.new.shell_command("#{0} help").execute(self, [])
+      else
+        find_cmd(my_args.delete_at(0)).execute(self, my_args)
+      end
+    end
+
+    def opts
+      SimpleOptionParser.new do |opts|
+        opts.on("-h", "--home HOME-PATH", "Path to Ki root directory") do |v|
+          ki_home(KiHome.new(v))
+        end
+        opts.on("-u", "--use VER", "Use defined scripts") do |v|
+          @use << v.split(",")
+        end
+        opts.on("--require RUBYFILE", "Require Ruby files, comma separated list") do |v|
+          @require << v.split(",")
+        end
+      end
+    end
+
+    def require_files
+      @require.flatten!
+      requires = @require.empty? ? user_pref.requires : @require
+      requires.each do |req|
+        Dir.glob(req).each do |path|
+          require path
+        end
+      end
+    end
+
     def load_scripts
       # load all script files defined in UserPrefFile uses
+      @use.flatten!
       uses = @use.empty? ? user_pref.uses : @use
       uses.each do |use_str|
         ver, tags_str = use_str.split(":")
-        tags = tags_str ? tags_str.split(",") : "ki-cmd"
+        tags = tags_str ? tags_str.split(",") : "ki"
         version = ki_home.version(ver)
         version.find_files.tags(tags).file_list.each do |full_path|
           load full_path
@@ -79,30 +119,6 @@ module Ki
       cmd
     end
 
-    # bin/kaiju command line tool calls this method, which finds the correct class to manage the execution
-    def execute(args)
-      @use = []
-      my_args = opts.parse(args.dup)
-      load_scripts
-      if my_args.empty?
-        KiCommandHelp.new.shell_command("#{0} help").execute(self, [])
-      else
-        find_cmd(my_args.delete_at(0)).execute(self, my_args)
-      end
-    end
-
-    def opts
-      o = SimpleOptionParser.new do |opts|
-        opts.on("-h", "--home HOME-PATH", "Path to Ki root directory") do |v|
-          ki_home(KiHome.new(v))
-        end
-        opts.on("-u", "--use VER", "Use defined scripts") do |v|
-          @use << v
-        end
-      end
-      o
-    end
-
     def help
 <<EOF
 "ki" is the main command line tool that starts all other Ki processes. Whenever ki command line tools
@@ -119,7 +135,7 @@ Examples
     ki -u my/tools compile
     ki -u my/tools:scripts,tools compile
 
-note: By default only files with tag "ki-cmd" are used. Use the 'my/tools:scripts,tools' to define additional tags.
+note: By default only files with tag "ki" are used. Use the 'my/tools:scripts,tools' to define additional tags.
 
 Common parameters:
 
@@ -134,17 +150,6 @@ EOF
     attr_chain :summary, -> { "Displays help for given Ki command" }
     attr_chain :shell_command, :require
 
-    def help
-<<EOF
-"#{shell_command}" shows information Ki and its commands.
-
-### Examples
-
-    #{shell_command}
-    #{shell_command} version-build
-EOF
-    end
-
     # Finds matching command and displays its help
     def execute(ctx, args)
       if args.size == 1
@@ -169,6 +174,17 @@ EOF
         puts "\nRun '#{$0} help COMMAND' for more information about that command."
       end
     end
+
+    def help
+<<EOF
+"#{shell_command}" shows information Ki and its commands.
+
+### Examples
+
+    #{shell_command}
+    #{shell_command} version-build
+EOF
+    end
   end
 
 # Lists available Ki commands
@@ -182,22 +198,8 @@ EOF
       opts.parse(args.empty? ? ["-c"] : args)
     end
 
-    def help
-      <<EOF
-"#{shell_command}" shows information about Ki.
-
-### Examples
-
-    #{shell_command} -c
-    #{shell_command} -r
-
-### Parameters
-#{opts}
-EOF
-    end
-
     def opts
-      o = SimpleOptionParser.new do |opts|
+      SimpleOptionParser.new do |opts|
         opts.on("-c", "--commands", "List commands") do |v|
           commands = KiCommand::KiExtensions.find(KiCommand::CommandPrefix[0..-2])
           commands.each do |id, service_class|
@@ -214,7 +216,20 @@ EOF
           end
         end
       end
-      o
+    end
+
+    def help
+      <<EOF
+"#{shell_command}" shows information about Ki.
+
+### Examples
+
+    #{shell_command} -c
+    #{shell_command} -r
+
+### Parameters
+#{opts}
+EOF
     end
   end