giternal 0.0.2 → 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+spec/test_repos
+pkg
+features/tmp
+test_repos

data/{License.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Pat Maddox
+Copyright (c) 2009 Pat Maddox
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -0,0 +1,75 @@
+= Why giternal
+
+There are a couple tools out there that keep track of git externals
+for you.  Git submodules are built in, and braid is a different
+project.  They both have problems that prevent them from using those
+externals collaboratively.
+
+In a nutshell, git submodules keep a reference to the head of each
+external project.  This means that if Joe and Sarah each make
+non-conflicting changes to their externals, and push the external
+reference in the main project, one of them will get a conflict on
+update.  Braid doesn't treat the externals as being separate from the
+main project, so any commits you make will go to the parent instead of
+the external.
+
+In order to demonstrate these issues more concretely, I've written a
+script that will simulate the workflow of making changes to an
+external, pushing it upstream, and pulling it into another project.
+You'll notice in the submodule example that there's a conflict when
+updating the main repo, and files are missing in the local external
+after update.  In the braid example, the changes never make it
+upstream.  This script checks to see if a tool allows you to not only
+track dependencies but collaborate as well.  To execute it, run
+
+ruby test_trackers.rb giternal|submodules|braid
+
+= Using it
+
+Put a file in your project named .giternal.yml or config/giternal.yml,
+that looks like this:
+
+  local_dir_name:
+    repo: git://path/to/repo.git
+    path: local/sub/dir
+
+As an example, here's how you'd track rspec:
+
+  rspec:
+    repo: git://github.com/dchelimsky/rspec.git
+    path: vendor/plugins
+
+To pull the externals into your workspace, run "giternal update".  You
+should add vendor/plugins/rspec to .gitignore to keep the files from
+being added to your main repo.
+
+= Deploying externals
+
+I frequently use a cap task that changes to deploy_root and runs
+"giternal update" to pull all the externals.  The downside with this
+approach is that you'll get the bleeding edge of your external, and
+you may want to use a particular version that you've tested and know
+works with your app.  Enter freezing.
+
+Make sure your working dir is clean and then run "giternal freeze".
+The externals are no longer separate repos - the history was zipped up
+so that the external can be unfrozen later.  Each external is added to
+the git index, so all you have to do is commit.  You've got a
+self-contained external that is frozen to a working version, suitable
+for deploy.
+
+After you've tagged your release, you can unfreeze the giternal with
+"giternal unfreeze" and get back to development.
+
+= How I want to work with externals
+
+When tracking externals, the most important thing is knowing my
+libraries work together, and second I can try to stay up to date.
+When I update an external, I would run rake.  If it passes, keep that
+version.  If not, look at what it would take to take for my code and
+the library code to work.  If I feel like I can do it, I do, otherwise
+I unfreeze and stay on the older working version.
+
+== Copyright
+
+Copyright (c) 2009 Pat Maddox. See LICENSE for details.

data/Rakefile

@@ -1,4 +1,60 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "giternal"
+    gem.summary = %Q{Non-sucky git externals}
+    gem.description = %Q{Giternal provides dead-simple management of external git dependencies. It only stores a small bit of metadata, letting you actively develop in any of the repos. Come deploy time, you can easily freeze freeze all the dependencies to particular versions}
+    gem.email = "pat.maddox@gmail.com"
+    gem.homepage = "http://github.com/pat-maddox/giternal"
+    gem.authors = ["Pat Maddox"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "cucumber"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => [:spec, :features]
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "giternal #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 0
+:major: 0

data/giternal.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{giternal}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Pat Maddox"]
+  s.date = %q{2009-10-10}
+  s.default_executable = %q{giternal}
+  s.description = %q{Giternal provides dead-simple management of external git dependencies. It only stores a small bit of metadata, letting you actively develop in any of the repos. Come deploy time, you can easily freeze freeze all the dependencies to particular versions}
+  s.email = %q{pat.maddox@gmail.com}
+  s.executables = ["giternal"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".emacs-project",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "bin/giternal",
+     "features/checking_out_externals.feature",
+     "features/freeze_externals.feature",
+     "features/steps/repository_steps.rb",
+     "features/unfreeze_externals.feature",
+     "giternal.gemspec",
+     "giternal_helper.rb",
+     "lib/giternal.rb",
+     "lib/giternal/app.rb",
+     "lib/giternal/repository.rb",
+     "lib/giternal/version.rb",
+     "lib/giternal/yaml_config.rb",
+     "spec/giternal/app_spec.rb",
+     "spec/giternal/repository_spec.rb",
+     "spec/giternal/yaml_config_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "test_trackers.rb"
+  ]
+  s.homepage = %q{http://github.com/pat-maddox/giternal}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Non-sucky git externals}
+  s.test_files = [
+    "spec/giternal/app_spec.rb",
+     "spec/giternal/repository_spec.rb",
+     "spec/giternal/yaml_config_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+  end
+end

data/giternal_helper.rb

@@ -1,6 +1,6 @@
 class GiternalHelper
-  @@giternal_base = File.expand_path(File.dirname(__FILE__))
-  
+  @@giternal_base ||= File.expand_path(File.dirname(__FILE__))
+
   def self.create_main_repo
     FileUtils.mkdir_p tmp_path
     Dir.chdir(tmp_path) do
@@ -14,10 +14,6 @@ class GiternalHelper
     end
   end
 
-  def self.wipe_repos
-    FileUtils.rm_r(tmp_path) if File.directory?(tmp_path)
-  end
-
   def self.tmp_path
     "/tmp/giternal_test"
   end
@@ -27,7 +23,7 @@ class GiternalHelper
   end
 
   def self.base_project_dir
-    tmp_path + '/main_repo' 
+    tmp_path + '/main_repo'
   end
 
   def self.run(*args)
@@ -70,6 +66,7 @@ class GiternalHelper
 
   def self.clean!
     FileUtils.rm_rf tmp_path
+    %w(GIT_DIR GIT_WORK_TREE GIT_INDEX_FILE).each {|var| ENV[var] = nil }
   end
 
   def self.update_externals
@@ -89,7 +86,7 @@ class GiternalHelper
       GiternalHelper.run('unfreeze')
     end
   end
-  
+
   def self.repo_contents(path)
     Dir.chdir(path) do
       contents = `git cat-file -p HEAD`

data/lib/giternal/app.rb

@@ -30,8 +30,11 @@ module Giternal
     def config
       return @config if @config
 
-      config_file = File.expand_path(@base_dir + '/config/giternal.yml')
-      unless File.file?(config_file)
+      config_file = ['config/giternal.yml', '.giternal.yml'].detect do |file|
+        File.file? File.expand_path(@base_dir + '/' + file)
+      end
+
+      if config_file.nil?
         $stderr.puts "config/giternal.yml is missing"
         exit 1
       end

data/lib/giternal/repository.rb

@@ -16,6 +16,8 @@ module Giternal
     end
 
     def update
+      git_ignore_self
+
       return true if frozen?
       FileUtils.mkdir_p checkout_path unless File.exist?(checkout_path)
       if checked_out?
@@ -78,5 +80,13 @@ module Giternal
 			block.call
 			puts " ..updated\n" if verbose
 		end
+
+		def git_ignore_self
+		  Dir.chdir(@base_dir) do
+		    unless File.exist?('.gitignore') && File.read('.gitignore').include?(rel_repo_path)
+		      `echo '#{rel_repo_path}' >> .gitignore`
+		    end
+		  end
+		end
   end
 end

data/spec/giternal/app_spec.rb

@@ -14,8 +14,19 @@ module Giternal
         YamlConfig.stub!(:new).and_return @mock_config
       end
 
-      it "should exit with an error when no config file exists" do
+      it "should look for config/giternal.yml" do
+        File.should_receive(:file?).with(/some_fake_dir\/config\/giternal\.yml/)
+        @app.config
+      end
+
+      it "should look for .giternal.yml if giternal.yml does not exist" do
         File.should_receive(:file?).with(/some_fake_dir\/config\/giternal\.yml/).and_return false
+        File.should_receive(:file?).with(/some_fake_dir\/\.giternal\.yml/).and_return true
+        @app.config
+      end
+
+      it "should exit with an error when no config file exists" do
+        File.stub!(:file?).and_return false
         $stderr.should_receive(:puts)
         @app.should_receive(:exit).with(1)
         @app.config

data/spec/giternal/repository_spec.rb

@@ -17,6 +17,23 @@ module Giternal
         should == 'foo'
     end
 
+    it "should be ignored from git" do
+      @repository.update
+      Dir.chdir(GiternalHelper.base_project_dir) do
+        # TODO: What I really want is to say it shouldn't include 'foo'
+        `git status`.should_not include('dependencies')
+      end
+    end
+
+    it "should only add itself to .gitignore if it's not already there" do
+      2.times { @repository.update }
+      Dir.chdir(GiternalHelper.base_project_dir) do
+        File.read('.gitignore').scan(/foo/).should have(1).item
+        # TODO: What I really want is to say it shouldn't include 'foo'
+        `git status`.should_not include('dependencies')
+      end
+    end
+
     it "should not show any output when verbose mode is off" do
       @repository.verbose = false
       @repository.should_not_receive(:puts)

data/spec/spec_helper.rb

@@ -11,9 +11,9 @@ require 'fileutils'
 require 'giternal_helper'
 
 Spec::Runner.configuration.before(:each) do
-  GiternalHelper.wipe_repos
+  GiternalHelper.clean!
 end
 
 Spec::Runner.configuration.after(:each) do
-  GiternalHelper.wipe_repos
+  GiternalHelper.clean!
 end

data/test_trackers.rb

@@ -0,0 +1,157 @@
+require 'fileutils'
+module Repomanipulator
+  def repo_path(path)
+    File.expand_path File.join(File.dirname(__FILE__), "test_repos", path)
+  end
+
+  def create_repo(name)
+    path = repo_path(name)
+    FileUtils.mkdir_p(path)
+    Dir.chdir(path) do
+      `git init`
+      `echo first_file > first_file`
+    end
+    commit_all path, "created repo"
+  end
+
+  def commit_all(path, message)
+    Dir.chdir(path) do
+      `git add .`
+      puts `git commit -m "#{message}"`
+    end
+  end
+
+  def clone_repo(from, to, options=nil)
+    Dir.chdir(repo_path("")) { `git clone #{options} #{from} #{to}` }
+  end
+
+  def add_content_to(file, content)
+    path = repo_path file
+    FileUtils.touch path
+    File.open(path, 'w') {|f| f << content }
+    `cd #{File.dirname(path)} && git checkout master`
+    commit_all File.dirname(repo_path(file)), "added content to #{file}"
+  end
+
+  def push(repo)
+    Dir.chdir(repo_path(repo)) { `git push origin master` }
+  end
+
+  def pull(repo)
+    Dir.chdir(repo_path(repo)) { puts `git pull` }
+  end
+
+  def verify_repo_has_files(repo, *files)
+    Dir.chdir(repo_path(repo)) do
+      missing_files = files.select {|f| !File.exist?(f) }
+      raise "Expected files: [#{missing_files.join(', ')}] to exist in #{repo} but are missing" unless missing_files.empty?
+    end
+  end
+end
+include Repomanipulator
+
+module GitSubmodules
+  def add_external(base, external)
+    external_path = repo_path(external)
+    Dir.chdir(repo_path(base)) { puts `git submodule add #{external_path} #{external}` }
+    commit_all repo_path(base), "committed external #{external}"
+  end
+
+  def update_externals(repo)
+    Dir.chdir(repo_path(repo)) do
+      puts `git submodule init`
+      puts `git submodule update`
+    end
+    commit_all repo_path(repo), "updated externals"
+  end
+end
+
+module Giternal
+  def add_external(base, external)
+    external_path = repo_path external
+    Dir.chdir(repo_path(base)) do
+      FileUtils.touch ".giternal.yml"
+      File.open(".giternal.yml", 'w') do |f|
+        f << external << ":\n"
+        f << "  repo: #{external_path}\n"
+        f << "  path: ."
+      end
+      `echo #{external} >> .gitignore`
+    end
+    commit_all repo_path(base), "added #{external}"
+  end
+
+  def update_externals(base)
+    Dir.chdir(repo_path(base)) { puts `giternal update` }
+  end
+end
+
+module Braid
+  def add_external(base, external)
+    external_path = repo_path external
+    Dir.chdir(repo_path(base)) { puts `braid add --type git #{external_path} #{external}` }
+  end
+
+  def update_externals(base)
+    Dir.chdir(repo_path(base)) { puts `braid update` }
+  end
+end
+
+
+drivers = {"submodules" => GitSubmodules, "giternal" => Giternal, "braid" => Braid}
+unless drivers.keys.include?(ARGV.first)
+  puts "Run with:  ruby test_tracking.rb #{drivers.keys.join('|')}"
+  exit
+end
+include drivers[ARGV.first]
+
+FileUtils.rm_rf repo_path("")
+
+def ALERT(message)
+  puts
+  puts "*** " + message
+end
+
+ALERT "the project has will_paginate as an external"
+create_repo "will_paginate-full"
+clone_repo "will_paginate-full", "will_paginate", "--bare"
+
+create_repo "base-full"
+add_external "base-full", "will_paginate"
+clone_repo "base-full", "base", "--bare"
+
+ALERT "Joe and Sarah clone copies of the project"
+clone_repo "base", "joe"
+update_externals "joe"
+
+clone_repo "base", "sarah"
+update_externals "sarah"
+
+ALERT "Joe adds README to will_paginate and commits"
+add_content_to "joe/will_paginate/README", "some content"
+
+ALERT "Joe commits a change to the base project"
+add_content_to "joe/foo", "in the base project"
+
+ALERT "Joe pushes his code"
+push "joe"
+push "joe/will_paginate"
+
+ALERT "Sarah adds LICENSE to her repo and commits"
+add_content_to "sarah/will_paginate/LICENSE", "gnu baby"
+
+ALERT "Sarah commits a change to the base project"
+add_content_to "sarah/bar", "in the base project"
+
+ALERT "Sarah pulls from base project and updates externals"
+pull "sarah"
+update_externals "sarah"
+push "sarah/will_paginate"
+
+ALERT "Does the cloned project have all the files we expect?"
+verify_repo_has_files("sarah", "foo", "bar", "will_paginate/README", "will_paginate/LICENSE")
+
+ALERT "Does the upstream external have all the files we expect?"
+clone_repo "will_paginate", "will_paginate_clone"
+verify_repo_has_files "will_paginate_clone", "README", "LICENSE"
+puts "woooo!  Collaboration ftw"