gitosis_easy_conf 0.0.3

data/gitosis_easy_conf.gemspec

@@ -0,0 +1,187 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gitosis_easy_conf}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gerrit Riessen"]
+  s.date = %q{2011-09-01}
+  s.description = %q{Easy gitosis configuration}
+  s.email = %q{gerrit.riessen@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "examples/Rakefile",
+    "examples/gitosis.complex.conf",
+    "examples/gitosis.concise.conf",
+    "examples/gitosis.readme.conf",
+    "gitosis_easy_conf.gemspec",
+    "lib/gitosis_easy_conf.rb",
+    "lib/gitosis_easy_conf/config.rb",
+    "lib/gitosis_easy_conf/forkers.rb",
+    "lib/gitosis_easy_conf/groups.rb",
+    "lib/gitosis_easy_conf/repositories.rb",
+    "test/helper.rb",
+    "test/test_gitosis_config.rb",
+    "test/test_gitosis_forker.rb",
+    "test/test_gitosis_groups.rb",
+    "test/test_gitosis_repositories.rb"
+  ]
+  s.homepage = %q{https://github.com/gorenje/gitosis_easy_conf}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Make writing a gitosis configuration easier}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<gitosis_easy_conf>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<inifile>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<inifile>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<inifile>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<inifile>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<inifile>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<inifile>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_runtime_dependency(%q<inifile>, [">= 0"])
+    else
+      s.add_dependency(%q<gitosis_easy_conf>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<inifile>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<inifile>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<inifile>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<inifile>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<inifile>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<inifile>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<inifile>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<gitosis_easy_conf>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<inifile>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<inifile>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<inifile>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<inifile>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<inifile>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<inifile>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<inifile>, [">= 0"])
+  end
+end
+

data/lib/gitosis_easy_conf/config.rb

@@ -0,0 +1,26 @@
+module Gitosis
+  class Config
+    def initialize(&block)
+      @configs = {}
+      instance_eval(&block)
+    end
+
+    def method_missing(method, *args, &block)
+      if args.length > 0 || block_given?
+        @configs[method] = case method
+                           when :fork_naming_convention then
+                             if block_given? && ![2,-1].include?(block.arity)
+                               raise BlockArityIncorrect, "Block needs exactly two arguments"
+                             end
+                             block
+                           when :filename then
+                             args.first
+                           else
+                             [args, block]
+                           end
+      else
+        @configs[method]
+      end
+    end
+  end
+end

data/lib/gitosis_easy_conf/forkers.rb

@@ -0,0 +1,45 @@
+# Define a mapping from a Gitosis user and their public key. Here the use of string and
+# symbol are unimportant, i.e.
+#   Gitosis.forkers do
+#      fubar :key_one
+#      fubar "key_one"
+#   end
+# are equivalent.
+#
+module Gitosis
+  class Forker
+    def initialize(&block)
+      @forkers = {}
+      instance_eval(&block)
+    end
+
+    def method_missing(method, *args, &block)
+      if args.length > 0
+
+        if @forkers.values.include?(args.first.to_s)
+          raise(SamePublicKeyForForkers, "Key '#{args.first}' used by '#{method}' "+
+                "and #{@forkers.invert[args.first.to_s]}'")
+        end
+
+        if @forkers.keys.include?(method)
+          raise(ForkerAlreadyDefined, "Forker '#{method}' already defined with key: " +
+                "#{@forkers[method]}")
+        end
+
+        @forkers[method] = args.first.to_s
+      else
+        raise(Gitosis::UnknownForker,
+              "Forker '#{method}' Not Found") unless @forkers.keys.include?(method)
+        @forkers[method]
+      end
+    end
+
+    def [](name)
+      send(name.to_sym)
+    end
+
+    def all
+      @forkers.keys
+    end
+  end
+end

data/lib/gitosis_easy_conf/groups.rb

@@ -0,0 +1,69 @@
+# Group definition use strings and symbols to define groups with mutliple members and
+# shared membership:
+#   Gitosis.groups do
+#     fubar 'public.key'
+#     snafu :fubar
+#     luke 'fubar'
+#     combined :luke, :snafu, :fubar
+#   end
+#
+# This means that the following have the values:
+#   Gitosis.groups[:fubar] ==> 'public.key'
+#   Gitosis.groups[:snafu] ==> 'public.key'
+#   Gitosis.groups[:luke] ==> 'fubar'
+#   Gitosis.groups[:combined] ==> 'public.key fubar'
+#
+# String values are public keys and symbols are references to group names.
+# Duplicate key names are removed and returned is a concatenation of all keys.
+#
+module Gitosis
+  class Group
+
+    def initialize(&block)
+      @groups = {}
+      instance_eval(&block)
+    end
+
+    def method_missing(method, *args, &block)
+      if args.length > 0
+        @groups[method.to_sym] = args
+      else
+        raise UnknownGroup, "Unkown group '#{method}'" unless @groups[method]
+        @groups[method].uniq.join(" ")
+      end
+    end
+
+    def denormalize
+      @groups.keys.each do |key|
+        @groups[key] = @groups[key].collect do |member|
+          @_refs = []
+          denormalize_member(member)
+        end.flatten
+      end
+      self
+    end
+
+    def [](name)
+      send(name)
+    end
+
+    private
+
+    def denormalize_member(member)
+      case member
+      when String then member
+      when Symbol
+        if @_refs.include?(member)
+          raise SelfReferencingGroup, "Group '#{member}' cycle reference"
+        end
+        @_refs << member
+
+        raise UnknownGroup, "Unkown group '#{member}'" unless @groups[member]
+
+        @groups[member].collect { |a| denormalize_member(a) }
+      else
+        raise UnknownGroupType, "Group '#{member}' type not supported: #{member.class}"
+      end
+    end
+  end
+end

data/lib/gitosis_easy_conf/repositories.rb

@@ -0,0 +1,88 @@
+# Definition of a gitosis repository.
+#
+require 'inifile'
+
+module Gitosis
+  EmptyConfig = {
+    :writable => [], :readable => [], :forks => []
+  }
+
+  class Repository
+    def initialize(&block)
+      @base_config = EmptyConfig
+
+      conf_file_name = Gitosis.config.filename
+      @no_file_found = if conf_file_name.nil? or !File.exists?(conf_file_name)
+                         @conffile = {}
+                         true
+                       else
+                         @conffile = IniFile.new(conf_file_name)
+                         false
+                       end
+      @conffile["gitosis"] = {}
+      @origconffile = @conffile.clone
+
+      @fork_name = Gitosis.config.fork_naming_convention || lambda do |repo,forker|
+        "#{forker}_#{repo}"
+      end
+
+      instance_eval(&block)
+    end
+
+    def write
+      @conffile.write unless @conffile.eql?(@origconffile) || @no_file_found
+    end
+
+    def with_base_configuration(config,&block)
+      @base_config = config || EmptyConfig
+      instance_eval(&block)
+      @base_config = EmptyConfig
+    end
+
+    def method_missing(method, *args, &block)
+      args = [{}] if args.first.nil?
+      repo_name = (args.first[:name] || method).to_sym
+
+      committers = _get_keys([@base_config,args.first].map{|h| h[:writable]})
+      @conffile["group #{repo_name}.writable"] = {
+        'members'  => committers,
+        'writable' => repo_name.to_s
+      } unless committers == ""
+
+      readers = _get_keys([@base_config,args.first].map{|h| h[:readable]})
+      @conffile["group #{repo_name}.readonly"] = {
+        'members'  => readers,
+        'readonly' => repo_name.to_s
+      } unless readers == ""
+
+      [@base_config, args.first].map { |h| h[:forks] }.flatten.compact.
+        collect { |a| a == :all ? Gitosis.forkers.all : a }.flatten.compact.each do |forker|
+
+        fork_repo_name = @fork_name.call(repo_name,forker)
+
+        @conffile["group fork.#{repo_name}.#{forker}.writable"] = {
+          'members'  => ::Forker[forker],
+          'writable' => fork_repo_name,
+        }
+
+        @conffile["group fork.#{repo_name}.#{forker}.readonly"] = {
+          'members'  => readers,
+          'readonly' => fork_repo_name,
+        } unless readers == ""
+      end
+    end
+
+    private
+
+    def _get_keys(ary)
+      ary.flatten.compact.collect do |member|
+        case member
+        when String then member
+        when Symbol then Gitosis.groups[member]
+        else
+          raise UnknownGroup, "Group '#{member}'"
+        end
+      end.flatten.join(' ')
+    end
+  end
+end

data/lib/gitosis_easy_conf.rb

@@ -0,0 +1,60 @@
+require 'gitosis_easy_conf/repositories'
+require 'gitosis_easy_conf/groups'
+require 'gitosis_easy_conf/forkers'
+require 'gitosis_easy_conf/config'
+
+module Gitosis
+  extend self
+
+  # Exceptions
+  %w[
+    SelfReferencingGroup     UnknownForker            UnknownGroup
+    UnknownGroupType         SamePublicKeyForForkers  ForkerAlreadyDefined
+    BlockArityIncorrect
+  ].each do |exception_name|
+    const_set( exception_name, Class.new(StandardError))
+  end
+
+  # Configuration verbs -- config, forkers, groups (or roles) and repositories.
+  def config(&block)
+    if block_given?
+      if defined?(@@config)
+        @@config.instance_eval(&block)
+      else
+        @@config = Config.new(&block)
+      end
+    else
+      @@config ||= Config.new(){}
+    end
+  end
+
+  def forkers(&block)
+    block_given? ? @@forkers = Forker.new(&block) : (@@forkers ||= nil)
+  end
+
+  def groups(&block)
+    block_given? ? @@groups = Group.new(&block).denormalize : (@@groups ||= nil)
+  end
+  alias :roles :groups
+
+  def repositories(&block)
+    block_given? ? @@repository = Repository.new(&block) : @@repository
+  end
+
+  def setup(filename = nil, &block)
+    config do
+      filename filename
+    end
+
+    class_eval(&block)
+    repositories.write
+  end
+end
+
+class Forker
+  class << self
+    def [](name)
+      Gitosis.forkers.send(name.to_sym)
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,40 @@
+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 'test/unit'
+require 'shoulda'
+require 'inifile'
+require 'rr'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gitosis_easy_conf'
+
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+
+  # used in the repository tests, compares the complete gitosis configuration.
+  # assumes the existence of @results hash.
+  def assert_config(expected,msg)
+    assert_equal( (["gitosis"] + expected.keys).sort, @results.keys.sort,
+                  msg + " (top level keys)")
+    assert_equal( {}, @results["gitosis"], msg + " (empty gitosis)")
+
+    expected.keys.each do |group_keys|
+      gmsg = msg + " [#{group_keys}]"
+      assert_equal(expected[group_keys].keys.sort,
+                   @results[group_keys].keys.sort, gmsg+" (prop keys)")
+
+      exp, com = expected[group_keys], @results[group_keys]
+      exp.keys.each do |property_key|
+        assert_equal exp[property_key], com[property_key], gmsg + " [#{property_key}]"
+      end
+    end
+  end
+end

data/test/test_gitosis_config.rb

@@ -0,0 +1,99 @@
+require 'helper'
+
+class TestGitosisConfig < Test::Unit::TestCase
+  context "config" do
+
+    should "return a config hash if block given" do
+      Gitosis.config do
+        fubar(:one,:two) do
+          puts "blah"
+        end
+      end
+      assert_equal [:one,:two], Gitosis.config.fubar.first
+      assert Gitosis.config.fubar.last.is_a?(Proc)
+    end
+
+    should "return a filename" do
+      Gitosis.config do
+        filename
+      end
+      assert_equal nil, Gitosis.config.filename
+
+      Gitosis.config do
+        filename do
+          puts "blah"
+        end
+      end
+      assert_equal nil, Gitosis.config.filename
+
+      Gitosis.config do
+        filename("fubar","snafu") do
+          puts "blah"
+        end
+      end
+      assert_equal "fubar", Gitosis.config.filename
+    end
+
+    should "return a fork_name_convention" do
+      Gitosis.config do
+        fork_name_convention
+      end
+      assert_equal nil,  Gitosis.config.fork_naming_convention
+
+      Gitosis.config do
+        fork_name_convention("one")
+      end
+      assert_equal nil,  Gitosis.config.fork_naming_convention
+
+      Gitosis.config do
+        fork_naming_convention("fubar","snafu") do |para,para2|
+          "#{para}+#{para2}"
+        end
+      end
+      assert_equal Proc,  Gitosis.config.fork_naming_convention.class
+      assert_equal "1+2", Gitosis.config.fork_naming_convention.call("1","2")
+
+      Gitosis.config do
+        fork_naming_convention do |para,para2|
+          "#{para}+#{para2}"
+        end
+      end
+      assert_equal Proc,  Gitosis.config.fork_naming_convention.class
+      assert_equal "1+2", Gitosis.config.fork_naming_convention.call("1","2")
+
+      Gitosis.config do
+        fork_naming_convention do |*args|
+          '%s+%s' % args.map { |a| a.to_s }
+        end
+      end
+      assert_equal Proc,  Gitosis.config.fork_naming_convention.class
+      assert_equal "1+2", Gitosis.config.fork_naming_convention.call("1","2")
+    end
+
+    should "fork_name_convention should complain if arity is not correct" do
+      assert_raises Gitosis::BlockArityIncorrect do
+        Gitosis.config do
+          fork_naming_convention("fubar","snafu") do
+            nil
+          end
+        end
+      end
+
+      assert_raises Gitosis::BlockArityIncorrect do
+        Gitosis.config do
+          fork_naming_convention("fubar","snafu") do |a|
+            nil
+          end
+        end
+      end
+
+      assert_raises Gitosis::BlockArityIncorrect do
+        Gitosis.config do
+          fork_naming_convention("fubar","snafu") do |a,b,c|
+            nil
+          end
+        end
+      end
+    end
+  end
+end