giternal-digarc 0.1.1Digarc

data/.gitignore

@@ -0,0 +1,6 @@
+spec/test_repos
+pkg
+features/tmp
+test_repos
+.idea
+.rvmrc

data/LICENSE

@@ -0,0 +1,20 @@
+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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,93 @@
+= 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
+    branch: any_branch_in_repo
+
+As an example, here's how you'd track rspec:
+
+  rspec:
+    repo: git://github.com/dchelimsky/rspec.git
+    path: vendor/plugins
+
+Or alternatively, here's how to track the experimental branch of rspec:
+
+  rspec:
+    repo: git://github.com/dchelimsky/rspec.git
+    path: vendor/plugins
+    branch: experimental
+
+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.
+
+If you specify a branch, on a fresh check out it will check out that branch. If you already have a different branch checked out, it will switch to the specified branch (CAUTION! YOU WILL LOSE UNCOMMITED CHANGES!) 
+
+= 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.
+
+= THANK YOUs
+
+Rollcall of awesome people who have contributed to giternal:
+
+Brian Takita & Honkster Team - ability to specify individual repos for
+  freeze/unfreeze/update
+
+
+== Copyright
+
+Copyright (c) 2009-2011 Pat Maddox. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "#{ENV["GEM_PREFIX"]}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/bin/giternal

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+require "rubygems"
+if File.exist?(File.dirname(__FILE__) + '/../lib/giternal.rb')
+  $:.unshift(File.dirname(__FILE__) + '/../lib')
+end
+require 'giternal'
+
+action = ARGV[0]
+available_actions = %w(update freeze unfreeze)
+unless available_actions.include?(action)
+  puts "Usage: giternal (#{available_actions.join(':')})"
+  puts ""
+  puts File.read(File.dirname(__FILE__) + '/../README.rdoc')
+  exit 1
+end
+
+Giternal::Repository.verbose = true
+app = Giternal::App.new(FileUtils.pwd)
+app.run(*ARGV)

data/features/checking_out_externals.feature

@@ -0,0 +1,51 @@
+Feature: Checking out and updating externals
+  As a developer
+  I want to check out and update external projects via git
+  So that I can add functionality to my app with little effort
+
+  Scenario: Repository is not yet checked out
+    Given an external repository named 'first_external'
+    And 'first_external' is not yet checked out
+    When I update the externals
+    Then 'first_external' should be checked out
+
+  Scenario: Multiple externals
+    Given an external repository named 'first_external'
+    And an external repository named 'second_external'
+    When I update the externals
+    Then 'first_external' should be checked out
+    And 'second_external' should be checked out
+
+  Scenario: Repository checked out then updated
+    Given an external repository named 'first_external'
+    And the externals are up to date
+    And content is added to 'first_external'
+    Then 'first_external' should not be up to date
+    When I update the externals
+    Then 'first_external' should be up to date
+
+  Scenario: Two Repositories checked out and one updated
+    Given an external repository named 'first_external'
+    And an external repository named 'second_external'
+    And the externals are up to date
+    And content is added to 'first_external'
+    And content is added to 'second_external'
+    Then 'first_external' should not be up to date
+    And 'second_external' should not be up to date
+    When I update the external 'second_external'
+    Then 'first_external' should not be up to date
+    And 'second_external' should be up to date
+
+  Scenario: One repo frozen, one repo unfrozen, and all updated
+    Given an external repository named 'first_external'
+    And an external repository named 'second_external'
+    And the externals are up to date
+    And the externals are frozen
+    And content is added to 'first_external'
+    And content is added to 'second_external'
+    Then 'first_external' should not be up to date
+    And 'second_external' should not be up to date
+    When I unfreeze the external 'second_external'
+    And I update the externals
+    Then 'first_external' should not be up to date
+    And 'second_external' should be up to date

data/features/freeze_externals.feature

@@ -0,0 +1,26 @@
+Feature: Freeze externals
+  As a developer
+  I want to freeze externals
+  So that I can test and deploy my app with no worries
+
+  Scenario: Main project has one external
+    Given an external repository named 'first_external'
+    And the externals are up to date
+    When I freeze the externals
+    Then 'first_external' should no longer be a git repo
+    And 'first_external' should be added to the commit index
+
+  Scenario: External has been added to .gitignore
+    Given an external repository named 'first_external'
+    And the external 'first_external' has been added to .gitignore
+    And the externals are up to date
+    When I freeze the externals
+    Then 'first_external' should be added to the commit index
+
+  Scenario: Main project has two externals
+    Given an external repository named 'first_external'
+    And an external repository named 'second_external'
+    And the externals are up to date
+    When I freeze the external 'second_external'
+    Then 'second_external' should be added to the commit index
+    And 'first_external' should be removed from the commit index

data/features/steps/repository_steps.rb

@@ -0,0 +1,117 @@
+require 'rspec'
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'giternal'
+require 'giternal_helper'
+
+RSpec::Matchers.define :be_up_to_date do
+  match do |actual_repo_name|
+    File.directory?(GiternalHelper.checked_out_path(actual_repo_name)) &&
+      GiternalHelper.repo_contents(GiternalHelper.checked_out_path(actual_repo_name)) ==
+      GiternalHelper.repo_contents(GiternalHelper.external_path(actual_repo_name))
+  end
+end
+
+RSpec::Matchers.define :be_a_git_repo do
+  match do |actual_repo_name|
+    File.directory?(GiternalHelper.checked_out_path(actual_repo_name) + '/.git')
+  end
+end
+
+RSpec::Matchers.define :be_added_to_commit_index do
+  match do |actual_repo_name|
+    Dir.chdir(GiternalHelper.tmp_path + '/main_repo') do
+      status = `git status`
+      flattened_status = status.split("\n").join(" ")
+      to_be_committed_regex = /new file:\W+dependencies\/#{actual_repo_name}/
+      untracked_files_regex = /Untracked files:.*#{actual_repo_name}/
+      status =~ to_be_committed_regex && !(flattened_status =~ untracked_files_regex)
+    end    
+  end
+end
+
+Before do
+  GiternalHelper.clean!
+  GiternalHelper.create_main_repo
+end
+
+After do
+  GiternalHelper.clean!
+end
+
+Given /an external repository named '(.*)'/ do |repo_name|
+  GiternalHelper.create_repo repo_name
+  GiternalHelper.add_content repo_name
+end
+
+Given /'(.*)' is not yet checked out/ do |repo_name|
+  # TODO: Figure out why I can't use should be_false here
+  File.directory?(GiternalHelper.checked_out_path(repo_name)).should == false
+end
+
+Given "the externals are up to date" do
+  GiternalHelper.update_externals
+end
+
+Given "the externals are frozen" do
+  GiternalHelper.freeze_externals
+end
+
+Given /content is added to '(.*)'/ do |repo_name|
+  GiternalHelper.add_content(repo_name)
+end
+
+Given /^the external '(.*)' has been added to \.gitignore$/ do |repo_name|
+  GiternalHelper.add_external_to_ignore(repo_name)
+end
+
+When "I update the externals" do
+  GiternalHelper.update_externals
+end
+
+When /I update the external '(.*)'/ do |external_name|
+  GiternalHelper.update_externals("dependencies/#{external_name}")
+end
+
+When "I freeze the externals" do
+  GiternalHelper.freeze_externals
+end
+
+When /I freeze the external '(.*)'/ do |external_name|
+  GiternalHelper.freeze_externals("dependencies/#{external_name}")
+end
+
+When "I unfreeze the externals" do
+  GiternalHelper.unfreeze_externals
+end
+
+When /I unfreeze the external '(.*)'/ do |external_name|
+  GiternalHelper.unfreeze_externals("dependencies/#{external_name}")
+end
+
+Then /'(.*)' should be checked out/ do |repo_name|
+  repo_name.should be_up_to_date
+end
+
+Then /'(.*)' should be up to date/ do |repo_name|
+  repo_name.should be_up_to_date
+end
+
+Then /'(.*)' should not be up to date/ do |repo_name|
+  repo_name.should_not be_up_to_date
+end
+
+Then /'(.*)' should no longer be a git repo/ do |repo_name|
+  repo_name.should_not be_a_git_repo
+end
+
+Then /'(.*)' should be a git repo/ do |repo_name|
+  repo_name.should be_a_git_repo
+end
+
+Then /'(.*)' should be added to the commit index/ do |repo_name|
+  repo_name.should be_added_to_commit_index
+end
+
+Then /'(.*)' should be removed from the commit index/ do |repo_name|
+  repo_name.should_not be_added_to_commit_index
+end

data/features/unfreeze_externals.feature

@@ -0,0 +1,23 @@
+Feature: Unfreeze externals
+  As a developer
+  I want to unfreeze externals
+  So that I can continue to update and develop on them
+
+  Scenario: Main project has one frozen external
+    Given an external repository named 'first_external'
+    And the externals are up to date
+    And the externals are frozen
+    When I unfreeze the externals
+    Then 'first_external' should be a git repo
+    And 'first_external' should be removed from the commit index
+
+  Scenario: Main project has two frozen externals
+    Given an external repository named 'first_external'
+    And an external repository named 'second_external'
+    And the externals are up to date
+    And the externals are frozen
+    When I unfreeze the external 'second_external'
+    Then 'second_external' should be a git repo
+    And 'second_external' should be removed from the commit index
+    And 'first_external' should no longer be a git repo
+    And 'first_external' should be added to the commit index

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-digarc}
+  s.version = "0.1.1Digarc"
+
+  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