externals 1.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Winton Welsh
+
+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.markdown

@@ -0,0 +1,55 @@
+Externals
+=========
+
+Quickly freeze and unfreeze external git dependencies.
+
+Installation
+------------
+
+<pre>
+sudo gem install winton-externals
+</pre>
+
+Configuration
+-------------
+
+Create *config/externals.yml*:
+
+<pre>
+acts_as_archive:
+  repo: git://github.com/winton/acts_as_archive.git
+  path: vendor/plugins
+rails:
+  repo: git://github.com/rails/rails.git
+  path: vendor
+</pre>
+
+Freeze or unfreeze
+------------------
+
+You can run either of these for the first time, depending on what you want:
+
+<pre>
+externals freeze
+externals unfreeze
+</pre>
+
+If you only want to freeze one of the items in config/externals.yml
+
+<pre>
+externals freeze acts_as_archive
+externals unfreeze acts_as_archive
+</pre>
+
+The usual flow is to unfreeze, commit to the external, freeze, and commit to the parent project.
+
+Your .git directories will be zipped and stored in /tmp when frozen, and moved back to the external when unfrozen.
+
+Are my externals frozen?
+------------------------
+
+When you want to know the status of your externals:
+
+<pre>
+externals status
+</pre>

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+GEM_NAME = 'externals'
+PKG_FILES = FileList['**/*'] - FileList['coverage', 'coverage/**/*', 'pkg', 'pkg/**/*']
+
+spec = Gem::Specification.new do |s|
+  s.author = "Winton Welsh"
+  s.email = "mail@wintoni.us"
+  s.executables << GEM_NAME
+  s.extra_rdoc_files = [ "README.markdown" ]
+  s.files = PKG_FILES.to_a
+  s.has_rdoc = false
+  s.homepage = "http://github.com/winton/#{GEM_NAME}"
+  s.name = GEM_NAME
+  s.platform = Gem::Platform::RUBY
+  s.require_path = "lib"
+  s.summary = "Quickly freeze and unfreeze external git dependencies"
+  s.version = "1.0.2"
+end
+
+desc "Package gem"
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install gem"
+task :install do
+  Rake::Task['gem'].invoke
+  `sudo gem uninstall #{GEM_NAME} -x`
+  `sudo gem install pkg/#{GEM_NAME}*.gem`
+  `rm -Rf pkg`
+end
+
+desc "Generate gemspec"
+task :gemspec do
+  File.open("#{File.dirname(__FILE__)}/#{GEM_NAME}.gemspec", 'w') do |f|
+    f.write(spec.to_ruby)
+  end
+end
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/bin/externals

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'externals'
+
+app = Externals::App.new(FileUtils.pwd)
+app.run(ARGV[0], ARGV[1])

data/externals.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{externals}
+  s.version = "1.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Winton Welsh"]
+  s.date = %q{2009-05-28}
+  s.default_executable = %q{externals}
+  s.email = %q{mail@wintoni.us}
+  s.executables = ["externals"]
+  s.extra_rdoc_files = ["README.markdown"]
+  s.files = ["bin", "bin/externals", "externals.gemspec", "lib", "lib/externals", "lib/externals/app.rb", "lib/externals/repository.rb", "lib/externals/yaml_config.rb", "lib/externals.rb", "MIT-LICENSE", "Rakefile", "README.markdown", "spec", "spec/externals", "spec/externals/app_spec.rb", "spec/externals/repository_spec.rb", "spec/externals/yaml_config_spec.rb", "spec/spec.opts", "spec/spec_helper.rb"]
+  s.homepage = %q{http://github.com/winton/externals}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Quickly freeze and unfreeze external git dependencies}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/externals.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + "/externals/app.rb"
+require File.dirname(__FILE__) + "/externals/repository.rb"
+require File.dirname(__FILE__) + "/externals/yaml_config.rb"

data/lib/externals/app.rb

@@ -0,0 +1,42 @@
+module Externals
+  class App
+    
+    def initialize(base_dir)
+      @base_dir = base_dir
+    end
+    
+    def config
+      return @config if @config
+      config_path = ['config/externals.yml', '.externals.yml'].detect do |file|
+        File.exists? File.expand_path(@base_dir + '/' + file)
+      end
+      @config = YamlConfig.new(@base_dir, config_path)
+    end
+
+    def freeze(filter = nil)
+      config.each_repo(filter) { |r| r.freeze }
+    end
+
+    def run(action, filter_str = nil)
+      available_actions = %w(st status fr freeze un unfreeze)
+      if available_actions.include?(action)
+        filter = Regexp.new(filter_str) if filter_str
+        send(action, filter)
+      else
+        puts "Usage: externals (#{available_actions.join(':')}) optional_regex_string"
+      end
+    end
+    
+    def status(filter = nil)
+      config.each_repo(filter) { |r| r.status }
+    end
+    
+    def unfreeze(filter = nil)
+      config.each_repo(filter) { |r| r.unfreeze }
+    end
+    
+    alias_method :fr, :freeze
+    alias_method :st, :status
+    alias_method :un, :unfreeze
+  end
+end

data/lib/externals/repository.rb

@@ -0,0 +1,119 @@
+require 'fileutils'
+
+module Externals
+  class Repository
+    
+    attr_reader :name
+    
+    def initialize(base_dir, name, repo_url, rel_path)
+      @base_dir = base_dir
+      @name = name
+      @repo_url = repo_url
+      @rel_path = rel_path
+    end
+    
+    def exists?
+      File.exist?(repo_path)
+    end
+    
+    def freeze
+      install unless exists?
+      if is_not_a_git_repo?
+        puts "already frozen: #{@name}"
+      elsif is_a_git_repo?
+        overwrite = true
+        # Conditionally destroy compressed repo
+        if is_compressed?
+          puts "You already have a frozen git snapshot. Overwrite?"
+          overwrite = STDIN.gets.downcase[0..0] == 'y'
+        end
+        Dir.chdir(repo_path) do
+          if overwrite
+            # Make temp directory
+            FileUtils.mkdir_p(temp_path)
+            # Compress .git folder to temp
+            `tar czf #{temp_path}/#{@name}.git.tgz .git` unless $TESTING
+          end
+          # Remove repository's .git folder
+          FileUtils.rm_r('.git')
+        end
+        puts "frozen: #{@name}"
+      end
+    end
+    
+    def install
+      # Create directory that we will clone into
+      unless File.exist?(checkout_path)
+        FileUtils.mkdir_p(checkout_path)
+      end
+      Dir.chdir(checkout_path) do
+        # Remove repository if exists
+        FileUtils.rm_rf(@name)
+        # Clone repository
+        `git clone #{@repo_url} #{@name}` unless $TESTING
+      end
+    end
+    
+    def is_a_git_repo?
+      File.exist?("#{repo_path}/.git")
+    end
+    
+    def is_not_a_git_repo?
+      !is_a_git_repo?
+    end
+    
+    def is_compressed?
+      File.exists?("#{temp_path}/#{@name}.git.tgz")
+    end
+    
+    def is_not_compressed?
+      !is_compressed?
+    end
+    
+    def status
+      if exists?
+        puts "#{is_a_git_repo? ? "not frozen" : "frozen and #{is_compressed? ? "has" : "does not have"} a snapshot"}: #{@name}"
+      else
+        puts "does not exist and #{is_compressed? ? "has" : "does not have"} a snapshot: #{@name}"
+      end
+    end
+
+    def unfreeze
+      if is_a_git_repo?
+        puts "already unfrozen: #{@name}"
+      elsif !exists?
+        install
+        puts "#{@name} unfrozen"
+      elsif is_not_a_git_repo?
+        if is_compressed?
+          Dir.chdir(temp_path) do
+            # Decompress git snapshot
+            `tar xzf #{@name}.git.tgz` unless $TESTING
+            # Move back to repo
+            FileUtils.mv(".git", repo_path)
+            # Remove snapshot
+            FileUtils.rm_f("#{@name}.git.tgz")
+          end
+        else
+          # Clone fresh repo if no snapshot found
+          install
+        end
+        puts "unfrozen: #{@name}"
+      end
+    end
+
+    private
+    
+    def checkout_path
+      File.expand_path(File.join(@base_dir, @rel_path))
+    end
+
+    def repo_path
+      File.expand_path(checkout_path + '/' + @name)
+    end
+    
+    def temp_path
+      @base_dir + '/tmp'
+    end
+  end
+end

data/lib/externals/yaml_config.rb

@@ -0,0 +1,32 @@
+require 'yaml'
+
+module Externals
+  class YamlConfig
+    
+    attr_reader :repositories
+    
+    def initialize(base_dir, config_path)
+      @base_dir = base_dir
+      if config_path && File.exists?(config_path)
+        config = YAML.load(File.read(config_path))
+        @repositories = config.map do |name, attributes|
+          Repository.new(@base_dir, name, attributes["repo"], attributes["path"])
+        end
+        @repositories = @repositories.sort do |a, b|
+          a.name <=> b.name
+        end
+      else
+        $stderr.puts "config/externals.yml is missing"
+        @repositories = []
+      end
+    end
+
+    def each_repo(filter = nil)
+      repositories.each do |r|
+        if block_given? and (!filter or filter.match(r.name))
+          yield(r)
+        end
+      end
+    end
+  end
+end

data/spec/externals/app_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+module Externals
+  describe Externals::App do
+    
+    before(:each) do
+      @app = App.new("some_fake_dir")
+      @mock_config = stub("config", :null_object => true)
+    end
+
+    describe "loading the config file" do
+      
+      before(:each) do
+        File.stub!(:exists?).and_return(true)
+        YamlConfig.stub!(:new).and_return(@mock_config)
+      end
+
+      it "should look for config/externals.yml" do
+        File.should_receive(:exists?).with(/some_fake_dir\/config\/externals\.yml/)
+        @app.config
+      end
+
+      it "should look for .externals.yml if externals.yml does not exist" do
+        File.should_receive(:exists?).with(/some_fake_dir\/config\/externals\.yml/).and_return(false)
+        File.should_receive(:exists?).with(/some_fake_dir\/\.externals\.yml/).and_return(true)
+        @app.config
+      end
+
+      it "should create a config from the config file" do
+        YamlConfig.should_receive(:new).with('some_fake_dir', "config/externals.yml").and_return(@mock_config)
+        @app.config
+      end
+    end
+
+    describe "app actions" do
+      
+      before(:each) do
+        @app.stub!(:config).and_return(@mock_config)
+        @mock_repo = mock("repo")
+        @mock_config.stub!(:each_repo).and_yield(@mock_repo)
+      end
+
+      it "should give the status of each of the repositories" do
+        @mock_repo.should_receive(:status)
+        @app.status
+      end
+
+      it "should freeze each of the repositories" do
+        @mock_repo.should_receive(:freeze)
+        @app.freeze
+      end
+
+      it "should unfreeze each of the repositories" do
+        @mock_repo.should_receive(:unfreeze)
+        @app.unfreeze
+      end
+    end
+  end
+end

data/spec/externals/repository_spec.rb

@@ -0,0 +1,141 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+module Externals
+  describe Externals::Repository do
+    
+    before(:each) do
+      @stdout = $stdout
+      $stdout = StringIO.new
+      @repo = Repository.new("/", "tmp", "git://", "/")
+    end
+    
+    after(:each) do
+      $stdout = @stdout
+    end
+    
+    describe "freeze" do
+      
+      before(:each) do
+        @repo.stub!(:exists?).and_return(false)
+        @repo.stub!(:install)
+        @repo.stub!(:is_not_a_git_repo?)
+        @repo.stub!(:is_a_git_repo?).and_return(true)
+        @repo.stub!(:is_compressed?).and_return(true)
+        STDIN.stub!(:gets).and_return('y')
+        FileUtils.stub!(:mkdir_p)
+        FileUtils.stub!(:rm_r)
+      end
+      
+      it "should install the repository if it does not exist" do
+        @repo.should_receive(:install)
+        @repo.freeze
+      end
+      
+      it "should display a message if the repository is already frozen" do
+        @repo.stub!(:is_not_a_git_repo?).and_return(true)
+        @repo.freeze
+        $stdout.string.include?("already frozen").should == true
+      end
+      
+      it "should ask if the compressed file should be overwritten if exists" do
+        @repo.stub!(:is_not_a_git_repo?).and_return(false)
+        @repo.freeze
+        $stdout.string.include?("Overwrite?").should == true
+      end
+      
+      it "should remove the repository's .git file" do
+        FileUtils.should_receive(:rm_r).with('.git')
+        @repo.freeze
+      end
+    end
+    
+    describe "install" do
+      
+      before(:each) do
+        File.stub!(:exist?)
+        FileUtils.stub!(:mkdir_p)
+        FileUtils.stub!(:rm_f)
+      end
+      
+      after(:each) do
+        @repo.install
+      end
+      
+      it "should create the checkout path if does not exist" do
+        File.should_receive(:exist?).and_return(false)
+        FileUtils.should_receive(:mkdir_p)
+      end
+      
+      it "should remove repository if exists" do
+        FileUtils.should_receive(:rm_rf)
+      end
+    end
+    
+    describe "unfreeze" do
+      
+      before(:each) do
+        @repo.stub!(:is_a_git_repo?)
+        @repo.stub!(:exists?)
+        @repo.stub!(:install)
+        @repo.stub!(:is_not_a_git_repo?)
+        @repo.stub!(:is_compressed?)
+        FileUtils.stub!(:mv)
+        FileUtils.stub!(:rm_f)
+      end
+      
+      it "should display a message if the repository is already unfrozen" do
+        @repo.should_receive(:is_a_git_repo?).and_return(true)
+        @repo.unfreeze
+        $stdout.string.include?("already unfrozen").should == true
+      end
+      
+      it "should install the repository if it does not exist" do
+        @repo.should_receive(:exists?).and_return(false)
+        @repo.should_receive(:install)
+        @repo.unfreeze
+      end
+      
+      it "should display a message after the install" do
+        @repo.should_receive(:is_a_git_repo?).and_return(false)
+        @repo.should_receive(:exists?).and_return(false)
+        @repo.unfreeze
+        $stdout.string.include?("unfrozen").should == true
+      end
+      
+      it "should move the uncompressed .git directory back to the repo if compressed file exists" do
+        @repo.should_receive(:is_a_git_repo?).and_return(false)
+        @repo.should_receive(:exists?).and_return(true)
+        @repo.should_receive(:is_not_a_git_repo?).and_return(true)
+        @repo.should_receive(:is_compressed?).and_return(true)
+        FileUtils.should_receive(:mv)
+        @repo.unfreeze
+      end
+      
+      it "should remove the snapshot if compressed file exists" do
+        @repo.should_receive(:is_a_git_repo?).and_return(false)
+        @repo.should_receive(:exists?).and_return(true)
+        @repo.should_receive(:is_not_a_git_repo?).and_return(true)
+        @repo.should_receive(:is_compressed?).and_return(true)
+        FileUtils.should_receive(:rm_f)
+        @repo.unfreeze
+      end
+      
+      it "should install the repository if no snapshot found" do
+        @repo.should_receive(:is_a_git_repo?).and_return(false)
+        @repo.should_receive(:exists?).and_return(true)
+        @repo.should_receive(:is_not_a_git_repo?).and_return(true)
+        @repo.should_receive(:is_compressed?).and_return(false)
+        @repo.should_receive(:install)
+        @repo.unfreeze
+      end
+      
+      it "should display a message when finished" do
+        @repo.should_receive(:is_a_git_repo?).and_return(false)
+        @repo.should_receive(:exists?).and_return(true)
+        @repo.should_receive(:is_not_a_git_repo?).and_return(true)
+        @repo.unfreeze
+        $stdout.string.include?("unfrozen").should == true
+      end
+    end
+  end
+end

data/spec/externals/yaml_config_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+module Externals
+  describe Externals::YamlConfig do
+    
+    before(:each) do
+      @rspec = mock("rspec")
+      @foo = mock("foo")
+      @rspec.stub!(:name).and_return('rspec')
+      @foo.stub!(:name).and_return('foo')
+      File.stub!(:read).and_return(
+        "rspec:\n  repo: git://rspec\n  path: vendor/plugins\n" +
+        "foo:\n  repo: git://at/foo\n  path: path/to/foo\n"
+      )
+      Repository.stub!(:new).and_return(@rspec)
+      Repository.stub!(:new).and_return(@foo)
+    end
+    
+    it "should create repositories" do
+      File.stub!(:exists?).and_return(true)
+      Repository.should_receive(:new).with(
+        "base_dir", "rspec", "git://rspec", "vendor/plugins"
+      )
+      Repository.should_receive(:new).with(
+        "base_dir", "foo", "git://at/foo", "path/to/foo"
+      )
+      config = YamlConfig.new("base_dir", "config/externals.yml")
+    end
+    
+    it "should allow repository iteration" do
+      File.stub!(:exists?).and_return(true)
+      config = YamlConfig.new("base_dir", "config/externals.yml")
+      config.each_repo { |r| [ @rspec, @foo ].include?(r).should == true }
+      config.each_repo('r') { |r| r.should == @rspec }
+      config.each_repo('f') { |r| r.should == @foo }
+    end
+    
+    it "should error if config doesn't exist" do
+      File.stub!(:exists?).and_return(false)
+      $stderr.should_receive(:puts)
+      config = YamlConfig.new('base_dir', 'config/externals.yml')
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$TESTING = true
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'externals'
+require 'pp'
+
+def debug(object)
+  puts "<pre>"
+  pp object
+  puts "</pre>"
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: externals
+version: !ruby/object:Gem::Version 
+  version: 1.0.2
+platform: ruby
+authors: 
+- Winton Welsh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-06 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mail@wintoni.us
+executables: 
+- externals
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- bin/externals
+- externals.gemspec
+- lib/externals/app.rb
+- lib/externals/repository.rb
+- lib/externals/yaml_config.rb
+- lib/externals.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+- spec/externals/app_spec.rb
+- spec/externals/repository_spec.rb
+- spec/externals/yaml_config_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/winton/externals
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Quickly freeze and unfreeze external git dependencies
+test_files: []
+