ki-repo 0.1.0 → 0.1.1

data/lib/util/simple_optparse.rb

@@ -0,0 +1,103 @@
+# encoding: UTF-8
+
+# Copyright 2012 Mikko Apo
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Ki
+
+  # simplified OptionParser, which supports unknown options by ignoring them
+  # * supports options in two formats: "-f file.txt" and "-f=file.txt"
+  # * supports short and long form: "--file" and "-f"
+  # * supports multiple parameters for options
+  # Does not support
+  # * parameters with spaces
+  # * type conversions
+  # * optional parameter values
+  class SimpleOptionParser
+    attr_chain :options_for_to_s, -> { Array.new }
+    attr_chain :options, -> { Array.new }
+
+    def initialize(&block)
+      block.call(self)
+    end
+
+    def on(*args, &block)
+      if block.nil?
+        raise "Option without parser block: " + args.join(", ")
+      end
+      if args.size == 3
+        short = args.delete_at(0)
+        long, *params = args.delete_at(0).split(" ")
+        comment = args.delete_at(0)
+        options_for_to_s << {short: short, long: long, comment: comment, params: params, block: block }
+        options << {opt: short, comment: comment, params: params, block: block }
+        options << {opt: long, comment: comment, params: params, block: block }
+      else
+        raise "unsupported option configuration size: " + args.join(", ")
+      end
+    end
+
+    def parse(args)
+      ret = []
+      open = nil
+      collected_params = nil
+      collect_count = nil
+      args.each do |a|
+        if open
+          collected_params << a
+          if collect_count == collected_params.size
+            open[:block].call(*collected_params)
+            open = nil
+          end
+        else
+          found_option, rest_of_a = find_option(a)
+          if found_option
+            collect_count = found_option[:params].size
+            if collect_count == 0
+              # no parameters
+              found_option[:block].call
+            elsif collect_count == 1 && rest_of_a && rest_of_a.size > 0
+              # single parameter was defined with opt=value
+              found_option[:block].call rest_of_a
+            else
+              open = found_option
+              collected_params = []
+            end
+          else
+            ret << a
+          end
+        end
+      end
+      if open
+        raise "requires #{collect_count} parameters for '#{open[:opt]}', found only #{collected_params.size}: #{collected_params.join(", ")}"
+      end
+      ret
+    end
+    def find_option(a)
+      options.each do |o|
+        if a.start_with?(o[:opt] + "=")
+          return o, a[o[:opt].size+1..-1]
+        elsif a.start_with?(o[:opt])
+          return o,nil
+        end
+      end
+      nil
+    end
+    def to_s
+      options_for_to_s.map do |o|
+      format("    %2s%s %-29s%s",o[:short], o[:short] && o[:long]? ",": " ", o[:long], o[:comment] )
+      end.join("\n")
+    end
+  end
+end

data/lib/util/test.rb

@@ -0,0 +1,323 @@
+# encoding: UTF-8
+
+# Copyright 2012 Mikko Apo
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'tmpdir'
+
+module Ki
+
+  # Automatic resource cleanup that is executed when ruby is closing down
+  $testers = []
+
+  at_exit do
+    Tester.final_tester_check
+  end
+
+# Modifies run time environment for tests and automatically restores original state
+# * note: cleanup is triggered by calling the {#after} method
+#
+# @see #cleaners
+# @see #tmpdir
+# @see #catch_stdio
+# @see #chdir
+# @see #after
+  class Tester
+    # List of Procs which should be executed
+    # @see after
+    attr_reader :cleaners
+
+    # Name of the test round that uses this tester
+    attr_reader :test_name
+
+    # Dummy IO stream
+    # @see catch_stdio
+    attr_chain :stdin, -> { DummyIO.new }
+
+    # Dummy IO stream
+    # @see catch_stdio
+    attr_chain :stdout, -> { DummyIO.new }
+
+    # Dummy IO stream
+    # @see catch_stdio
+    attr_chain :stderr, -> { DummyIO.new }
+
+    def initialize(test_name = nil)
+      @test_name = test_name
+      @cleaners = []
+      $testers << self
+    end
+
+    # Creates a temporary directory
+    # * if called without a block removes directory when after is called
+    # @param [String] src tmpdir copies contents of src path if src is defined. note: only visible files are copied. files and directories starting with . are excluded
+    # @param [Proc] block if a block is defined, passes the temporary directory path to the block as parameter and removes the directory when the block ends
+    # @return [String, Object] If block is not defined, returns the path of the temporary directory. If block is defined, returns the value the block returns.
+    # @example
+    #   tmp_source = @tester.tmpdir
+    #   File.touch(File.join(tmp_source, "file.txt"))
+    #   @tester.tmpdir(tmp_source).each do |dest_2|
+    #
+    #   end
+    # @see copy_visible_files
+    def tmpdir(src=nil, &block)
+      dest = Dir.mktmpdir
+      cleanup = -> { FileUtils.remove_entry_secure(dest) }
+      if src
+        catcher = ExceptionCatcher.new
+        catcher.catch do
+          Tester.copy_visible_files(src, dest)
+        end
+        # if there is a problem copying files, cleanup and raise original exception
+        if catcher.exceptions?
+          catcher.catch do
+            cleanup.call
+          end
+          catcher.check
+        end
+      end
+      if block
+        begin
+          block.call(dest)
+        ensure
+          cleanup.call
+        end
+      else
+        @cleaners << cleanup
+        dest
+      end
+    end
+
+    # Redirects $stdin, $stdout, $stderr streams to the Tester instance
+    # * if called without block, streams are restored when after is called
+    # @param [Proc] block if block is defined, restores streams once the block ends
+    # @return self which is useful when catch_stdio is called with block because stdin, stdout and stderr are available after the block
+    # @example
+    #   @tester.catch_stdio do
+    #     puts "foo"
+    #   end
+    #   @tester.stdio.join == "foo\n"
+    #
+    # @see DummyIO, stdin, stdout, stderr
+    def catch_stdio(&block)
+      original_streams = [$stdin, $stdout, $stderr]
+      cleanup = -> { $stdin, $stdout, $stderr = original_streams }
+      stdin.clear
+      stdout.clear
+      stderr.clear
+      $stdin = stdin
+      $stdout = stdout
+      $stderr = stderr
+      if block
+        begin
+          block.call
+        ensure
+          cleanup.call
+        end
+      else
+        @cleaners << cleanup
+      end
+      self
+    end
+
+    # Changes working directory to target
+    # @param (String) dest target directory
+    # @param (Proc) block if block is defined, restores working directory after block ends
+    # @return (Object) if block is defined returns block's return value
+    # @example
+    #   @tester.chdir(dest)
+    def chdir(dest, &block)
+      if block
+        Dir.chdir(dest, &block)
+      else
+        if !defined? @original_dir
+          @original_dir = Dir.pwd
+          @cleaners << -> { Dir.chdir(@original_dir); @original_dir=nil }
+        end
+        Dir.chdir(dest)
+      end
+    end
+
+    def env(key, value)
+      current = ENV[key]
+      @cleaners << -> {ENV[key]=current}
+      ENV[key]=value
+      self
+    end
+
+    # Executes all pending cleanup operations
+    # * cleaners lists all procs that will be executed
+    # * all exceptions from procs are caught and raised together
+    # * Tester helper methods schedule cleanup operations to cleaners if needed
+    # @return [void]
+    # @example RSpec test
+    #   describe "My tests" do
+    #     before do
+    #       @tester = Tester.new
+    #     end
+    #
+    #     after do
+    #       @tester.after
+    #     end
+    #
+    #     it "should export files" do
+    #       dest = @tester.tmpdir
+    #     end
+    #   end
+    #
+    # @example Tests can add their own cleanup procs. This reduces the need to write exception management in tests
+    #    it "should combine ..." do
+    #      dao = DAO.new
+    #      @tester.cleaners << -> { dao.rollback }
+    #      dao.do_something_that_does_not_cleanup_environment_and_might_raise_exception
+    #    end
+    #
+    # @see ExceptionCatcher, cleaners
+    def after
+      catcher = ExceptionCatcher.new
+      @cleaners.each do |after_block|
+        catcher.catch do
+          after_block.call
+        end
+      end
+      @cleaners.clear
+      catcher.check
+    end
+
+    def clear?
+      @cleaners.empty?
+    end
+
+    def self.final_tester_check
+      catcher = ExceptionCatcher.new
+      $testers.each do |tester|
+        if !tester.clear?
+          puts "Tester#{tester.test_name ? " '#{tester.test_name}'" : ""} has not been cleared! Please add the missing .after() command. Clearing it automatically."
+          catcher.catch do
+            tester.after
+          end
+        end
+      end
+      catcher.check
+    end
+
+    # Copies contents of src to dest
+    # * excludes files and directories beginning with a '.'
+    # @param [String] src source directory path
+    # @param [String] dest destination directory path
+    # @return [String] dest directory
+    def self.copy_visible_files(src, dest)
+      Dir.glob(File.join(src, "**/*")).each do |file_src|
+        file_path = file_src[src.size+1..-1]
+        if File.file?(file_src)
+          FileUtils.cp(file_src, File.join(dest, file_path))
+        elsif File.directory?(file_src)
+          FileUtils.mkdir(File.join(dest, file_path))
+        end
+      end
+      dest
+    end
+
+    # Writes defined files to target directory
+    # * note: dest_root and target directories are automatically created
+    # @param [String] dest_root target directory path
+    # @param [Hash] files map of files and their contents
+    # @return [String] dest_root directory
+    # @example
+    #   src = Tester.write_files(@tester.tmpdir, "file.txt" => "aa", "dir/my.txt" => "bb")
+    def self.write_files(dest_root, files={})
+      files.each_pair { |file_path, content|
+        dir = File.dirname(file_path)
+        if dir != "."
+          FileUtils.mkdir_p(File.join(dest_root, dir))
+        end
+        File.safe_write(File.join(dest_root, file_path), content)
+      }
+      dest_root
+    end
+
+    # Verifies that files exist in target directory.
+    # If files or directories are missing, contents are wrong, type is wrong or there are unwanted files raises an exception.
+    # @param [String] source_root target directory path
+    # @param [List] args containing check_for_extra_files and files map
+    #   * check_for_extra_files, by default verify_files does not check if there are other files or directories. If set to true, raises an exception if there are other files
+    #   * files, a map of file paths and contents. If file name ends with "/" or file contents are nil, path is a directory
+    # @return [Boolean] true if there were no errors
+    # @example
+    #   @tester.verify_files(tmpdir, "file.txt" => "aa", "dir/my.txt" => "bb", "dir" => nil) # other files are ok
+    #   @tester.verify_files(tmpdir, true, "file.txt" => "aa", "dir/my.txt" => "bb", "dir" => nil) # other files will fail
+    def self.verify_files(source_root, *args)
+      check_for_extra_files, files = args
+      if files.nil? && check_for_extra_files.kind_of?(Hash)
+        files = check_for_extra_files
+        check_for_extra_files = nil
+      end
+      files.each_pair do |file, contents|
+        file_path = File.join(source_root, file)
+        is_dir = file.end_with?("/") || contents.nil?
+        if !File.exists?(file_path)
+          raise "#{ is_dir ? "Directory" : "File"} '#{file_path}' is missing!"
+        end
+        if is_dir != File.directory?(file_path)
+          raise "Existing #{ is_dir ? "file" : "directory"} '#{file_path}' should be a #{ is_dir ? "directory" : "file"}!"
+        end
+        if !is_dir
+          file_contents = IO.read(file_path)
+          [contents].flatten.each do |o|
+            if o.kind_of?(Regexp)
+              if !file_contents.match(o)
+                raise "File '#{file_path}' does not match regexp #{o.inspect}, file contents: '#{file_contents}'"
+              end
+            elsif o.kind_of?(String)
+              if file_contents != o
+                raise "File '#{file_path}' is broken! Expected '#{o}' but was '#{file_contents}'"
+              end
+            elsif o.kind_of?(Proc)
+              if !o.call(file_contents)
+                raise "File '#{file_path}' did not pass test!"
+              end
+            else
+              raise "Unsupported checker! File '#{file_path}' object: #{o.inspect}"
+            end
+          end
+        end
+      end
+      if check_for_extra_files
+        files_and_dirs = {}
+        files.each_pair do |k, v|
+          file_arr=k.split("/")
+          c = file_arr.size
+          while c > 0
+            c -= 1
+            files_and_dirs[File.join(source_root, file_arr)]=true
+            file_arr.delete_at(-1)
+          end
+        end
+        Dir.glob(File.join(source_root, "**/*")).each do |file|
+          if !files_and_dirs[file]
+            raise "#{ File.directory?(file) ? "Directory" : "File"} '#{file}' exists, but it should not exist!"
+          end
+        end
+      end
+    end
+
+    # Dummy IO class that implements stream methods
+    # @see catch_stdio
+    class DummyIO < Array
+      def write(s)
+        self.<< s
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ki-repo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-21 00:00:00.000000000 Z
+date: 2012-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -91,26 +91,81 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A generic repository for storing packages and metadata related to the
   packages.
 email: 
-executables: []
+executables:
+- ki
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .document
-- .rspec
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
 - VERSION
-- lib/ki-repo.rb
-- spec/ki-repo_spec.rb
-- spec/spec_helper.rb
+- docs/backlog.md
+- docs/development.md
+- docs/development_setup.md
+- docs/images/for_git.txt
+- docs/ki_commands.md
+- docs/repository_basics.md
+- docs/writing_extensions.md
+- lib/cmd/cmd.rb
+- lib/cmd/user_pref_cmd.rb
+- lib/cmd/version_cmd.rb
+- lib/data_access/repository_finder.rb
+- lib/data_access/repository_info.rb
+- lib/data_access/version_helpers.rb
+- lib/data_access/version_iterators.rb
+- lib/data_access/version_operations.rb
+- lib/data_storage/dir_base.rb
+- lib/data_storage/ki_home.rb
+- lib/data_storage/ki_json.rb
+- lib/data_storage/repository.rb
+- lib/data_storage/version_metadata.rb
+- lib/ki_repo_all.rb
+- lib/util/attr_chain.rb
+- lib/util/exception_catcher.rb
+- lib/util/hash.rb
+- lib/util/hash_cache.rb
+- lib/util/ruby_extensions.rb
+- lib/util/service_registry.rb
+- lib/util/simple_optparse.rb
+- lib/util/test.rb
+- bin/ki
 homepage: http://github.com/mikko-apo/ki-repo
 licenses:
 - Apache License, Version 2.0
@@ -126,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -631020498654190277
+      hash: 1963502672638660453
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -138,5 +193,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Repository for storing packages and metadata.
+summary: ! 'Repository for storing packages and metadata - note: not ready for any
+  kind of use'
 test_files: []

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.rspec

@@ -1 +0,0 @@
---color

data/Gemfile

@@ -1,14 +0,0 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "rspec"
-  gem "yard"
-  gem "bundler"
-  gem "jeweler"
-  gem "simplecov"
-end

data/Gemfile.lock

@@ -1,38 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.3)
-    git (1.2.5)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.7.5)
-    multi_json (1.3.7)
-    rake (10.0.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.0)
-    rspec-expectations (2.12.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.0)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    yard (0.8.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  jeweler
-  rspec
-  simplecov
-  yard

data/Rakefile

@@ -1,42 +0,0 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "ki-repo"
-  gem.homepage = "http://github.com/mikko-apo/ki-repo"
-  gem.license = "Apache License, Version 2.0"
-  gem.summary = "Repository for storing packages and metadata."
-  gem.description = "A generic repository for storing packages and metadata related to the packages."
-#  gem.email = "mikko.apo@reaktor.fi"
-  gem.authors = ["Mikko Apo"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-
-require 'yard'
-YARD::Rake::YardocTask.new

data/spec/ki-repo_spec.rb

@@ -1,6 +0,0 @@
-require_relative 'spec_helper'
-
-describe "KiRepo" do
-  it "works" do
-  end
-end

data/spec/spec_helper.rb

@@ -1,12 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
-require 'ki-repo'
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-RSpec.configure do |config|
-  
-end