dotty 0.0.1

data/spec/repository_actions_spec.rb

@@ -0,0 +1,204 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Dotty::RepositoryActions do
+
+  describe "#create" do
+    before do
+      @repo = Dotty::Repository.new('repo', 'git://github.com/user/repo.git')
+      suppress_output do
+        subject.create @repo
+      end
+    end
+
+    it "should initialize an empty git repository" do
+      Dir.exist?(File.join @repo.local_path, '.git').should be_true
+    end
+
+    it "should create a git remote called origin with the specified url" do
+      output = nil
+      suppress_output do
+        output = `cd #{@repo.local_path}; git remote -v`
+      end
+      output.should == "origin\tgit://github.com/user/repo.git (fetch)\norigin\tgit://github.com/user/repo.git (push)\n"
+    end
+  end
+
+  describe "#checkout" do
+    it "should check out the git repository" do
+      @repo = Dotty::Repository.new('repo', 'url')
+      subject.stub!(:run)
+      subject.should_receive(:run).once.with('git clone url /tmp/dotty-testing-root/default/repo')
+      suppress_output do
+        subject.checkout @repo
+      end
+    end
+
+    it "should update the fetch the repository submodules" do
+      @repo = Dotty::Repository.new('repo', 'url')
+      subject.stub!(:run)
+      subject.should_receive(:run).once.with('git submodule update --init')
+      suppress_output do
+        subject.checkout @repo
+      end
+    end
+  end
+
+  describe "#destroy" do
+    include_context "bootstrapped repository"
+
+    it "should remove the local repository directory" do
+      suppress_output do
+        @actions.invoke :destroy, [@repo]
+      end
+      Dir.exist?(@repo.local_path).should be_false
+    end
+
+    it "should invoke #implode" do
+      @actions.stub!(:implode)
+      @actions.should_receive(:implode).with(@repo)
+      suppress_output do
+        @actions.destroy @repo
+      end
+    end
+  end
+
+  describe "#implode" do
+    include_context "bootstrapped repository"
+
+    it "should remove symlinks defined in dotty-symlinks.yml" do
+      suppress_output do
+        @actions.implode(@repo)
+      end
+      File.symlink?(File.join Dotty::RepositoryActions::USER_HOME, 'aa').should be_false
+      File.symlink?(File.join Dotty::RepositoryActions::USER_HOME, 'bb').should be_false
+    end
+
+    it "should try to run repository specific implode action if dotty-repository.thor exists" do
+      %x(touch #{@repo.local_path}/dotty-repository.thor)
+      @actions.stub!(:run)
+      @actions.should_receive(:run).once.with('thor dotty_repository:implode')
+      suppress_output do
+        @actions.implode(@repo)
+      end
+    end
+
+    it "should not try to run a repository specific implode action if dotty-repository.thor does not exist" do
+      @actions.stub!(:run)
+      @actions.should_not_receive(:run).with('thor dotty_repository:implode')
+      suppress_output do
+        @actions.implode(@repo)
+      end
+    end
+    
+  end
+
+  describe "#bootstrap" do
+    include_context "added repository"
+
+    it "should create symlinks returned from repository#symlinks" do
+      @repo.stub!(:symlinks).and_return({ 'a' => '.a', 'b' => '.b' })
+      suppress_output do
+        @actions.bootstrap(@repo)
+      end
+      File.symlink?(File.join Dotty::RepositoryActions::USER_HOME, '.b').should be_true
+      File.symlink?(File.join Dotty::RepositoryActions::USER_HOME, '.a').should be_true
+    end
+
+    it "should make directories for the symlinks if needed" do
+      @repo.stub!(:symlinks).and_return({ 'b' => 'other/dir/b' })
+      suppress_output do
+        @actions.bootstrap(@repo)
+      end
+      File.directory?(File.join Dotty::RepositoryActions::USER_HOME, 'other/dir').should be_true
+      File.symlink?(File.join Dotty::RepositoryActions::USER_HOME, 'other/dir/b').should be_true
+    end
+
+    it "should try to run repository specific bootstrap action if dotty-repository.thor exists" do
+      %x(touch #{@repo.local_path}/dotty-repository.thor)
+      @actions.stub!(:run)
+      @actions.should_receive(:run).once.with('thor dotty_repository:bootstrap')
+      suppress_output do
+        @actions.bootstrap(@repo)
+      end
+    end
+
+    it "should not try to run a repository specific bootstrap action if dotty-repository.thor does not exist" do
+      @actions.stub!(:run)
+      @actions.should_not_receive(:run).with('thor dotty_repository:bootstrap')
+      suppress_output do
+        @actions.bootstrap(@repo)
+      end
+    end
+  end
+
+  describe "#update" do
+    include_context "bootstrapped repository"
+    
+    it "should run git commands to update repo" do
+      @actions.stub!(:run)
+      @actions.should_receive(:run).once.with('git fetch && git pull && git submodule update --init')
+      suppress_output do 
+        @actions.update @repo
+      end
+    end
+  end
+
+  describe "#update_submodules" do
+    include_context "bootstrapped repository"
+    
+    before do
+      # TODO: Find a better way of testing thor invocations with options
+      @default_method_options = { :commit => true, :commit_message => 'Updated submodules' }
+      @actions.stub!(:options).and_return(@default_method_options)
+      @actions.stub!(:run).and_return("")
+    end
+    
+    it "should by default update pull submodules and commit changes to the dotty repository" do
+      @actions.should_receive(:run).once.with("git submodule update --init && git submodule foreach git pull origin master && git commit -am 'Updated submodules'")
+      suppress_output do 
+        @actions.update_submodules @repo
+      end
+    end
+
+    it "should not commit if commit option is false" do
+      @actions.stub!(:options).and_return @default_method_options.merge(:commit => false)
+      @actions.should_receive(:run).once.with('git submodule update --init && git submodule foreach git pull origin master')
+      suppress_output do
+        @actions.update_submodules @repo
+      end
+    end
+
+    it "should push if push option is true" do
+      @actions.stub!(:options).and_return @default_method_options.merge(:push => true)
+      @actions.should_receive(:run).once.with(/git push/)
+      suppress_output do
+        @actions.update_submodules @repo
+      end
+    end
+
+    it "should raise error if the repository is not in a clean state" do
+      @actions.stub!(:run).and_return("?? dirty")
+      expect {
+        suppress_output { @actions.update_submodules @repo }
+      }.to raise_error Dotty::Error, "Repository 'repo' is not in a clean state - cannot commit updated submodules"
+    end
+
+    it "should not raise error if the repository is not in a clean state but --no-commit is supplied" do
+      @actions.stub!(:run).and_return("?? dirty")
+      expect {
+        suppress_output { @actions.invoke :update_submodules, [@repo], :commit => false }
+      }.to_not raise_error Dotty::Error, "Repository 'repo' is not in a clean state - cannot commit updated submodules"
+    end
+
+    it "should not raise an error when repository is not in clean state but --ignore_dirty is given" do
+      @actions.stub!(:run).and_return("?? dirty")
+      @actions.stub!(:options).and_return @default_method_options.merge(:ignoredirty => true)
+      expect {
+        suppress_output { @actions.update_submodules @repo }
+      }.to_not raise_error Dotty::Error, "Repository 'repo' is not in a clean state - cannot commit updated submodules"
+    end
+      
+  end
+
+end
+

data/spec/repository_spec.rb

@@ -0,0 +1,303 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Dotty::Repository do
+
+  describe ".add_repository" do
+    include_context "profile data"
+
+    it "should add it to the repositories list" do
+      suppress_output do
+        Dotty::Repository.add_repository("new_repo", "git://github.com/user/repo1.git")
+      end
+      Dotty::Repository.repositories.size.should == 3
+    end
+
+    it "should return the new repository" do
+      suppress_output do
+        @repo = Dotty::Repository.add_repository("new_repo", "git://github.com/user/repo1.git")
+      end
+      @repo.should be_kind_of Dotty::Repository
+    end
+
+    it "should invoke Dotty::Profile.write_yaml" do
+      Dotty::Profile.should_receive(:write_yaml)
+      Dotty::Repository.add_repository("new_repo", "git://github.com/user/repo1.git")
+    end
+  end
+
+  describe ".add_existing_repository" do
+    it "should trigger .add_repository" do
+      new_repo = Dotty::Repository.new('new_repo_name', 'url')
+      Dotty::Repository.should_receive(:add_repository).once.with('new_repo_name', 'url').and_return(new_repo)
+      suppress_output do
+        @repo = Dotty::Repository.add_existing_repository('new_repo_name', 'url')
+      end
+    end
+
+    it "should trigger the repository checkout action" do
+      Dotty::Repository.actions.should_receive(:checkout).once.with(instance_of Dotty::Repository)
+      suppress_output do
+        @repo = Dotty::Repository.add_existing_repository("existing_repo", "url")
+      end
+    end
+
+    it "should trigger the bootstrap repository action" do
+      Dotty::Repository.actions.stub!(:bootstrap)
+      Dotty::Repository.actions.should_receive(:bootstrap)
+      suppress_output do
+        Dotty::Repository.add_existing_repository("existing_repo", "git://github.com/user/repo1.git")
+      end
+    end
+  end
+
+  describe ".create_repository" do
+    include_context "bootstrapped repository"
+
+    it "should trigger the create repository action" do
+      @actions.stub!(:create)
+      @actions.should_receive(:create)
+
+      suppress_output do
+        Dotty::Repository.create_repository("new_repo", "git://github.com/user/repo1.git")
+      end
+    end
+
+    it "should trigger .add_repository" do
+      Dotty::Repository.stub!(:add_repository).and_return(Dotty::Repository.new("new_repo", "url"))
+      Dotty::Repository.should_receive(:add_repository)
+
+      suppress_output do
+        Dotty::Repository.create_repository("new_repo", "git://github.com/user/repo1.git")
+      end
+    end
+  end
+
+  describe ".import" do
+    it "should invoke .add for all repositories in the given yaml file" do
+      yaml_path = Tempfile.new("dotty-test-import").path
+      File.open(yaml_path, 'w') do |f|
+        f.write({
+          'repo1' => { 'url' => 'url1' },
+          'repo2' => { 'url' => 'url2' }
+        }.to_yaml)
+      end
+      Dotty::Repository.stub(:add_existing_repository)
+      Dotty::Repository.should_receive(:add_existing_repository).once.with('repo1', 'url1')
+      Dotty::Repository.should_receive(:add_existing_repository).once.with('repo2', 'url2')
+      Dotty::Repository.import yaml_path
+    end
+  end
+
+  describe ".list" do
+    it "should return an empty array when Profile.current_profile_data is empty" do
+      Dotty::Profile.stub!(:current_profile_data).and_return({})
+      Dotty::Repository.list.should == []
+    end
+
+    context "with profile data" do
+      include_context "profile data"
+
+      it "should return an array with the same number of repository instances as in profile_data" do
+        Dotty::Repository.list.size.should == 2
+      end
+
+      it "should return an array consisting of Dotty::Repository instances" do
+        Dotty::Repository.list.collect(&:class).uniq.should == [Dotty::Repository]
+      end
+
+      it "should have objects with the correct name value" do
+        Dotty::Repository.list.collect(&:name).should == %w(my_repo other_repo)
+      end
+
+      it "should have objects with the correct url" do
+        Dotty::Repository.list.collect(&:url).should == %w(git://github.com/me/my_repo git://github.com/me/other_repo)
+      end
+    end
+  end
+
+  describe ".find" do
+    include_context "profile data"
+
+    it "should return the correct repository given a name that exists" do
+      repo = Dotty::Repository.find('my_repo')
+      repo.name.should == 'my_repo'
+      repo.url.should == 'git://github.com/me/my_repo'
+    end
+  end
+
+  describe "#initialize" do
+    it "should return a Dotty::Repository instance given valid attributes" do
+      Dotty::Repository.new('repo1', 'git://github.com/user/repo1.git').should be_instance_of Dotty::Repository
+    end
+
+    it "should raise an error if the name is not valid" do
+      expect {
+        Dotty::Repository.new('repo a', 'sdfsdf')
+      }.to raise_error Dotty::InvalidRepositoryNameError, "Repository name can only contain letters, numbers and the following characters: .-_"
+    end
+  end
+
+  describe "#destroy" do
+    include_context "bootstrapped repository"
+
+    it "should return the instance" do
+      suppress_output do
+        @repo.destroy.should == @repo
+      end
+    end
+
+    it "should remove the repository from the list" do
+      repositories = Dotty::Repository.list
+      suppress_output do
+        @repo.destroy
+      end
+      Dotty::Repository.repositories.should == repositories - [@repo]
+    end
+
+    it "should invoke Dotty::Profile.write_yaml" do
+      Dotty::Profile.should_receive(:write_yaml)
+      suppress_output do
+        @repo.destroy
+      end
+    end
+    
+    it "should invoke Dotty::RepositoryActions#destroy" do
+      @actions.stub!(:destroy)
+      @actions.should_receive(:destroy).with(@repo)
+      suppress_output do
+        @repo.destroy
+      end
+    end
+  end
+
+  describe "#git_status" do
+    include_context "bootstrapped repository"
+
+    before do
+      @repo.stub(:git_status_output).and_return(" D gvimrc\n?? a\n")
+    end
+
+    it "should return an hash with the changes" do
+      @repo.git_status.should == { 'gvimrc' => ' D', 'a' => '??' }
+    end
+  end
+  
+  describe "#unpushed_changes?" do
+    include_context "bootstrapped repository"
+
+    it "should return false when there are no unpushed commits" do
+      @repo.unpushed_changes?.should == false
+    end
+
+    # TODO find a good way to test this
+    #it "should should return true if git repo has commits that haven't been pushed" do
+    #end
+  end
+
+  context "with a @repo" do
+    before do
+      @repo = Dotty::Repository.new('repo1', 'git://github.com/user/repo1.git')
+      FileUtils.mkdir_p @repo.local_path
+    end
+
+    describe "#local_path" do
+      it "should return the correct local path" do
+        @repo.local_path.should == '/tmp/dotty-testing-root/default/repo1'
+      end
+    end
+
+    describe "#url" do
+      it "should return the correct url" do
+        @repo.url.should == 'git://github.com/user/repo1.git'
+      end
+    end
+
+    describe "#name" do
+      it "should return the correct name" do
+        @repo.name.should == 'repo1'
+      end
+    end
+    
+    describe "#symlinks_from_dotfiles_directories" do
+      before do
+        @dotfile_dirs = {
+          :default => File.join(@repo.local_path, 'dotfiles'),
+          :other => File.join(@repo.local_path, 'other_dotfiles')
+        }
+        @dotfile_dirs.each_pair do |name, path|
+          FileUtils.mkdir_p(path)
+        end
+      end
+
+      it "should return the correct symlinks for regular files in dotfiles/" do
+        %x(touch #{@dotfile_dirs[:default]}/.a && touch #{@dotfile_dirs[:default]}/b)
+        @repo.symlinks_from_dotfiles_directories.should == { 'dotfiles/.a' => '.a', 'dotfiles/b' => 'b' }
+      end
+
+      it "should handle files in the dotfiles root correctly" do
+        FileUtils.mkdir(File.join @dotfile_dirs[:default], '.a')
+        FileUtils.mkdir(File.join @dotfile_dirs[:default], 'b')
+        @repo.symlinks_from_dotfiles_directories.should == { 'dotfiles/.a' => '.a', 'dotfiles/b' => 'b' }
+      end
+
+      it "should handle files and directories within in+XXX directories" do
+        FileUtils.mkdir_p(File.join @dotfile_dirs[:default], 'in+.other_dir/b')
+        %x(touch #{@dotfile_dirs[:default]}/in+.other_dir/.a)
+        @repo.symlinks_from_dotfiles_directories.should == { 'dotfiles/in+.other_dir/.a' => '.other_dir/.a', 'dotfiles/in+.other_dir/b' => '.other_dir/b' }
+      end
+
+      it "should handle nested in+XXX dirs" do
+        FileUtils.mkdir_p(File.join @dotfile_dirs[:default], 'in+first/in+second/a')
+        %x(touch #{@dotfile_dirs[:default]}/in+first/b)
+        %x(touch #{@dotfile_dirs[:default]}/in+first/in+second/c)
+        @repo.symlinks_from_dotfiles_directories.should == { 
+          'dotfiles/in+first/in+second/a' => 'first/second/a', 
+          'dotfiles/in+first/b' => 'first/b',
+          'dotfiles/in+first/in+second/c' => 'first/second/c' 
+        }
+      end
+
+      it "should not include stuff in dirs without the in+XXX convention" do
+        FileUtils.mkdir_p(File.join @dotfile_dirs[:default], 'main/sub')
+        @repo.symlinks_from_dotfiles_directories.should == { 
+          'dotfiles/main' => 'main'
+        }
+      
+      end
+    end
+
+    describe "#symlinks_from_yaml" do
+      it "should return an empty hash if there is no dotty-symlinks.yml file or dotfiles/* in the repo" do
+        @repo.symlinks.should == {}
+      end
+
+      it "should return a hash with the correct symlinks if dotty-symlinks.yml file exists" do
+        expected_symlinks = { 'a' => 'aa', 'b' => 'bb' }
+        File.open File.join(@repo.local_path, 'dotty-symlinks.yml'), 'w' do |f|
+          f.write expected_symlinks.to_yaml
+        end
+        @repo.symlinks_from_yaml.should == expected_symlinks
+      end
+    end
+
+    describe "#symlinks" do
+      it "should return #symlinks_from_dotfiles_directories merged with #symlinks_from_yaml" do
+        @repo.stub!(:symlinks_from_dotfiles_directories).and_return({ :a => 1, :b => 2})
+        @repo.stub!(:symlinks_from_yaml).and_return({ :b => 3, :c => 4})
+        @repo.symlinks.should == { :a => 1, :b => 3, :c => 4 }
+      end
+    end
+
+    describe "#has_thor_task?" do
+      it "should return true when dotty-repository.thor is present in the repo" do
+        %x{touch #{@repo.local_path}/dotty-repository.thor}
+        @repo.has_thor_task?.should === true
+      end
+
+      it "should return false when there is no dotty-repository.thor present in the repo" do
+        @repo.has_thor_task?.should === false
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,62 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'simplecov'
+SimpleCov.start
+
+require 'dotty'
+require 'support/shared_contexts'
+require 'tempfile'
+
+Dotty::App.send(:remove_const, :ROOT_PATH)
+Dotty::App.const_set :ROOT_PATH, '/tmp/dotty-testing-root'
+
+Dotty::Profile.send(:remove_const, :YAML_PATH)
+Dotty::Profile.const_set :YAML_PATH, Tempfile.new('dotty-profiles-test').path
+
+Dotty::RepositoryActions.send(:remove_const, :USER_HOME)
+Dotty::RepositoryActions.const_set :USER_HOME, '/tmp/dotty-testing-user-home'
+
+RSpec.configure do |config|
+  config.before(:each) do
+  end
+
+  config.after(:each) do
+    clean_dotty
+  end
+
+  def clean_dotty
+    [Dotty::RepositoryActions::USER_HOME, Dotty::App::ROOT_PATH].each do |p|
+      system "rm -rf #{p}" if File.exist?(p)
+      FileUtils.mkdir_p p
+    end
+    system "rm #{Dotty::Profile::YAML_PATH}" if File.exist?(Dotty::Profile::YAML_PATH)
+    Dotty::Profile.profile_data = nil
+    Dotty::Profile.current_profile = nil
+    Dotty::Repository.repositories = nil
+  end
+
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+    result
+  end
+
+  def suppress_output
+    begin
+      orig_stderr = $stderr.clone
+      orig_stdout = $stdout.clone
+      $stdout.reopen("/dev/null", "w")
+      $stderr.reopen("/dev/null", "w")
+      yield
+    ensure
+      $stdout.reopen(orig_stdout)
+      $stderr.reopen(orig_stderr)
+    end
+  end
+end

data/spec/support/shared_contexts.rb

@@ -0,0 +1,61 @@
+shared_context "added repository" do
+  before do
+    @repo = Dotty::Repository.new('repo', { :url => 'git://github.com/user/repo.git' })
+    Dotty::Repository.list << @repo
+    FileUtils.mkdir_p @repo.local_path
+    @actions = Dotty::Repository.actions
+    
+    %x{touch #{File.join @repo.local_path, 'temp'}}
+    @symlinks = { 'a' => 'aa', 'b' => 'bb' }
+    File.open File.join(@repo.local_path, 'dotty-symlinks.yml'), 'w' do |f|
+      f.write @symlinks.to_yaml
+    end
+    %x(git init #{@repo.local_path})
+  end
+end
+
+shared_context "bootstrapped repository" do
+  include_context "added repository"
+  before do
+    @symlinks.each do |source_name, dest_name| 
+      source_path = File.join @repo.local_path, source_name
+      destination_path = File.join Dotty::RepositoryActions::USER_HOME, dest_name
+      %x{touch #{source_path}}
+      %x{ln -s #{source_path} #{destination_path}} unless File.exist?(destination_path)
+    end
+  end
+end
+      
+
+shared_context "two in memory repositories" do
+  before do
+    @repo1 = Dotty::Repository.new('repo1name', 'url')
+    @repo2 = Dotty::Repository.new('repo2name', 'url2')
+    Dotty::Repository.repositories = [@repo1, @repo2]
+  end
+end
+
+shared_context "profile data" do
+  before do
+    @profile_data = {
+      'current_profile' => 'my_profile',
+      'profiles' => {
+          'my_profile' => {
+            'repositories' => {
+              'my_repo'     => { 'url' => 'git://github.com/me/my_repo' },
+              'other_repo'  => { 'url' => 'git://github.com/me/other_repo' }
+            }
+          },
+          'other_profile' => {
+            'repositories' => {
+              'my_repo'     => { 'url' => 'git://github.com/me/my_repo' },
+              'other_repo'  => { 'url' => 'git://github.com/me/other_repo' }
+            }
+          }
+      }
+    }
+    File.open(Dotty::Profile::YAML_PATH, 'w') do |f|
+      f.write(@profile_data.to_yaml)
+    end
+  end
+end

data/templates/README.md

@@ -0,0 +1,41 @@
+# Dotty repository
+
+## dotfiles/
+
+Dotty will symlink files and directories in the root your repos dotfiles/ directory, relative to ~.
+You can symlink stuff to sub directories of ~ by using the in+subdir directory naming convention.
+
+### Examples
+
+    dotfiles/.vim             => ~/.vim
+    dotfiles/in+.ssh/config   => ~/.ssh/config
+    dotfiles/in+a/in+b/c      => ~/a/b/c
+
+## dotty-symlink.yml
+
+If you want more control over the symlinking, you can create a dotty-symlink.yml in the repo root.
+
+### Example
+    
+    file_in_repo:.in_home_dir
+
+## dotty-repository.thor
+
+If you want to do more than symlinking, you can create a dotty-repository.thor that implements the 'bootstrap' and 'implode' thor tasks.
+The class must be named "DottyRepository".
+
+### Example
+
+    class DottyRepository < Thor
+      include Thor::Actions
+
+      desc "bootstrap", "Bootstrap this repo"
+      def bootstrap
+        # Do stuff here
+      end
+
+      desc "implode", "Implode this repo"
+      def implode
+        # Do stuff here
+      end
+    end