dotty 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in dotty.gemspec
+gemspec

data/README.md

@@ -0,0 +1,110 @@
+# Dotty
+
+Dotty is a command line tool for managing your dotfiles (written in Ruby, using [Thor](https://github.com/wycats/thor/))
+
+## Features
+* Store dotfiles in multiple git repositories
+* Automate symlinking and other bootstrapping of dotfile repositories
+* Support profiles so that it's easy to switch between sets of dotfiles
+* Shows uncommited changes / unpushed commits for your dotfile repos
+* Easily update submodules in your dotfile repos
+
+## How dotty interacts with dotty repositories
+
+By using one or more of the approaches below, you instruct dotty on how it can boostrap and implode (opposite of bootstrap) your 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.
+
+#### Example
+
+    dotfiles/.vim             => ~/.vim
+    dotfiles/in+.ssh/config   => ~/.ssh/config
+    dotfiles/in+a/in+b/c      => ~/a/b/c
+
+
+### dotty-symlinks.yml
+
+If you want more control over the symlinking, you can create a dotty-symlink.yml in the repo root.
+
+#### Example
+    
+    file_in_repo:filename_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
+
+## Installation / usage
+
+    gem install dotty
+
+### Requirements
+* ruby (tested on 1.9.2) and rubygems
+* git (the git executable must be in your $PATH)
+
+Note: I had graphviz installed via brew, which has a 'dotty' executable. I fixed this by doing "mv /usr/local/bin/dotty{,.graphviz}"
+
+    $ dotty
+
+    Tasks:
+      dotty add <name> <git repo url>             # Add existing dotty git repository
+      dotty bootstrap [name]                      # Bootstrap specified or all dotty repositories. Usually involves making symlinks in your home dir.
+      dotty create <name> <git repo url>          # Create a new git repository with the specified git repo url as origin
+      dotty create_profile <profile name>         # Create a new profile
+      dotty execute [repo name] <command to run>  # For specified or all repositories, run given command
+      dotty help [TASK]                           # Describe available tasks or one specific task
+      dotty implode [name]                        # Opposite of bootstrap
+      dotty import_repos <yaml_file_location>     # Imports dotty repositories from the specified yaml file location (http works)
+      dotty list                                  # List installed dotty repositories
+      dotty profile [profile name]                # Switch to given profile or show current profile if no profile name is given
+      dotty profiles                              # List profiles
+      dotty remove <name>                         # Remove dotty repository
+      dotty remove_profile <profile name>         # Remove given profile
+      dotty update [name]                         # Update specified or all dotty repositories
+      dotty update_submodules [name]              # For specified or all repositories, for submodules and pull
+
+### Creating an example dotty repository
+
+    $ dotty create dotty-test git@github.com:trym/dotty-test
+
+     create repo  dotty-test [git@github.com:trym/dotty-test]
+             run  git init /Users/trym/.dotty/default/dotty-test from "."
+    Initialized empty Git repository in /Users/trym/.dotty/default/dotty-test/.git/
+             run  git remote add origin git@github.com:trym/dotty-test from "./.dotty/default/dotty-test"
+          create  .dotty/default/dotty-test/dotfiles
+          create  .dotty/default/dotty-test/README.md
+
+    $ cd ~/.dotty/default/dotty-test
+    $ touch dotfiles/testfile
+    $ dotty bootstrap dotty-test
+       bootstrap  dotty-test
+          create    sers/trym/testfile
+
+    $ ls -al ~/testfile
+    lrwxr-xr-x  1 trym  staff  55 May  3 01:05 /Users/trym/testfile -> /Users/trym/.dotty/default/dotty-test/dotfiles/testfile
+
+    $ dotty implode dotty-test
+         implode  dotty-test
+          remove  /Users/trym/testfile
+ 
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/dotty

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+#$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+require "dotty"
+
+Dotty::App.start

data/dotty.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'dotty/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'dotty'
+  s.version     = Dotty::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Trym Skaar']
+  s.email       = ['trym@tryms.no']
+  s.homepage    = 'http://github.com/trym/dotty'
+  s.summary     = %q{Dotfile manager using git repositories}
+  s.description = %q{Command line tool for easily managing your dotfile git repositories}
+
+  s.rubyforge_project = "dotty"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'thor'
+  s.add_dependency 'hashie'
+
+  s.add_development_dependency 'rspec', '>= 2.6.0.rc4'
+  s.add_development_dependency 'simplecov', '>= 0.4.0'
+end

data/lib/dotty/app.rb

@@ -0,0 +1,150 @@
+module Dotty
+  class App < Thor
+    include Thor::Actions
+    include Dotty::Helpers
+
+    ROOT_PATH = File.expand_path(File.join Thor::Util.user_home, '.dotty')
+    source_root File.join(File.dirname(__FILE__), '../../templates')
+
+    desc "list", "List installed dotty repositories"
+    def list
+      say "Installed dotty repositories for profile '#{Profile::current_profile}'", :blue
+      say "\n"
+      if Repository.list.empty?
+        say "No repositories here. Use 'create', 'add' or 'import_repos' to get going.", :yellow
+      else
+        table = Repository.list.collect do |repo|
+          git_changes = repo.git_status.size > 0 ? shell.set_color(" [#{repo.git_status.size} uncomitted changes]", :red) : ""
+          git_changes += shell.set_color(" [unpushed commits]", :red) if repo.unpushed_changes?
+          [repo.name, repo.url + git_changes]
+        end
+        print_table table, :ident => 2, :colwidth => 20
+      end
+      say "\n"
+    end
+
+    desc "add <name> <git repo url>", "Add existing dotty git repository"
+    def add(repo_name, url)
+      Repository.add_existing_repository repo_name, url
+    end
+
+    desc "create <name> <git repo url>", "Create a new git repository with the specified git repo url as origin"
+    def create(repo_name, repo_url)
+      repo = Dotty::Repository.create_repository(repo_name, repo_url)
+      empty_directory File.join(repo.local_path, 'dotfiles')
+      copy_file "README.md", File.join(repo.local_path, 'README.md')
+    end
+
+    desc "remove <name>", "Remove dotty repository"
+    def remove(repo_name)
+      find_repo!(repo_name).destroy
+    end
+
+    desc "update [name]", "Update specified or all dotty repositories"
+    def update(repo_name=nil)
+      for_specified_or_all_repos(repo_name) do |repo|
+        actions.update repo
+      end
+    end
+
+    desc "bootstrap [name]", "Bootstrap specified or all dotty repositories. Usually involves making symlinks in your home dir."
+    def bootstrap(repo_name=nil)
+      for_specified_or_all_repos(repo_name) do |repo|
+        actions.bootstrap repo
+      end
+    end
+
+    desc "implode [name]", "Opposite of bootstrap"
+    def implode(repo_name=nil)
+      for_specified_or_all_repos(repo_name) do |repo|
+        actions.implode repo
+      end
+    end
+
+    desc "update_submodules [name]", "For specified or all repositories,  for submodules and pull"
+    method_options :push => false
+    method_options :commit => true
+    method_options :ignoredirty => false
+    def update_submodules(repo_name=nil)
+      for_specified_or_all_repos(repo_name) do |repo|
+        actions.invoke :update_submodules, [repo], options
+      end
+    end
+
+    desc "execute [repo name] <command to run>", "For specified or all repositories, run given command"
+    def execute(repo_name=nil, command)
+      for_specified_or_all_repos(repo_name) do |repo|
+        inside repo.local_path do
+          run command
+          say "\n"
+        end
+      end
+    end
+
+    desc "import_repos <yaml_file_location>", "Imports dotty repositories from the specified yaml file location (http works)"
+    def import_repos(location)
+      say_status "import yaml", "Importing dotty repositories from '#{location}'", :blue
+      Repository.import location
+    end
+
+    desc "profile [profile name]", "Switch to given profile or show current profile if no profile name is given"
+    def profile(name=nil)
+      if name.nil?
+        say "Current dotty profile: " + shell.set_color(Profile.current_profile, :blue)
+      else
+        name = name.downcase
+        Profile.find!(name)
+        say_status "profile", "Changing to profile '#{name}'"
+        implode # Implode all repos for current profile
+        Repository.repositories = nil # Force reload of repositories
+        Profile.current_profile = name
+        Profile.write_yaml
+        bootstrap # Bootstrap repos for the profile we changed to
+      end
+    end
+
+    desc "profiles", "List profiles"
+    def profiles
+      say "DOTTY PROFILES\n", :blue
+      profile_names = Profile.profiles
+      profile_names << 'default' if profile_names.empty?
+      profile_names.each do |profile_name|
+        with_padding do
+          say Profile.current_profile == profile_name ? shell.set_color('* ' + profile_name, :green) : profile_name
+        end
+      end
+    end
+
+    desc "create_profile <profile name>", "Create a new profile"
+    def create_profile(name)
+      say_status "create", "Create profile '#{name}'"
+      Profile.create name
+    end
+
+    desc "remove_profile <profile name>", "Remove given profile"
+    def remove_profile(name)
+      say_status "remove", "Removing profile '#{name}'"
+      Profile.remove name
+    end
+
+    protected
+
+    def find_repo!(name)
+      Repository.find(name.downcase) || raise(RepositoryNotFoundError, "The specified repository does not exist")  
+    end
+
+    def actions
+      @actions ||= RepositoryActions.new
+    end
+
+    def for_specified_or_all_repos(repo_name=nil)
+      if repo_name
+        yield find_repo!(repo_name.downcase)
+      else
+        Repository.list.each { |repo| yield repo }
+      end
+    end
+
+
+  end
+end

data/lib/dotty/helpers.rb

@@ -0,0 +1,19 @@
+module Dotty
+  module Helpers
+    def error(message, halt=true)
+      exit if halt
+    end
+
+    def remove_symlink(path)
+      if File.exist? path
+        say_status "remove", path
+        if File.symlink? path
+          File.delete path
+        else
+          say_status "error", "#{path} is not a symlink - not removing"
+        end
+      end
+
+    end
+  end
+end

data/lib/dotty/profile.rb

@@ -0,0 +1,57 @@
+module Dotty
+  class Profile
+    YAML_PATH = File.join(App::ROOT_PATH, '.profiles.yml')
+
+    class << self
+      attr_accessor :current_profile, :profile_data
+
+      def create(name)
+        profile_data['profiles'].merge!(name => {})
+        write_yaml
+      end
+
+      def remove(name)
+        find!(name)
+        @current_profile = profile_data['current_profile'] = nil
+        profile_data['profiles'].delete name
+        write_yaml
+      end
+
+      def profile_data
+        @profile_data ||= read_yaml || { 'profiles' => {} }
+      end
+
+      def current_profile
+        @current_profile ||= profile_data['current_profile'] || profiles.first || 'default'
+      end
+
+      def profiles
+        profile_data['profiles'] && profile_data['profiles'].keys or []
+      end
+
+      def current_profile_data
+        profile_data['profiles'][current_profile] or {}
+      end
+
+      def read_yaml
+        File.exist?(YAML_PATH) && YAML::load(File.open YAML_PATH)
+      end
+
+      def write_yaml
+        profile_data['current_profile'] = current_profile
+        (profile_data['profiles'][current_profile] ||= {}).merge!(
+          'repositories' => Repository.list.inject({}) { |hsh, repo| hsh.merge(repo.name => { 'url' => repo.url }) }
+        )
+        FileUtils.mkdir_p App::ROOT_PATH unless File.directory?(App::ROOT_PATH)
+        File.open(YAML_PATH, 'w') do |f|
+          f.write profile_data.to_yaml
+        end
+      end
+
+      def find!(name)
+        profile_data['profiles'] && profile_data['profiles'][name] or raise Dotty::Error, "Profile '#{name}' does not exist"
+      end
+    end
+
+  end
+end

data/lib/dotty/repository.rb

@@ -0,0 +1,141 @@
+module Dotty
+  class Repository
+    YAML_PATH = File.join(App::ROOT_PATH, '.repos.yml')
+
+    attr_accessor :name, :url
+
+    class << self
+      attr_accessor :repositories
+
+      def add_existing_repository(name, url)
+        repo = add_repository(name, url)
+        actions.checkout(repo)
+        actions.bootstrap(repo)
+        return repo
+      end
+
+      def add_repository(name, url)
+        unless Repository.find(name).nil?
+          raise Dotty::Error, "There is already a repository with that name"
+        end
+        repo = self.new(name, url)
+        list << repo
+        Profile::write_yaml
+        return repo
+      end
+
+      def create_repository(name, url)
+        repo = add_repository(name, url)
+        actions.create(repo)
+        return repo
+      end
+
+      def list
+        @repositories ||= (Profile.current_profile_data['repositories'] || {}).collect{ |name, options| Repository.new(name, options['url']) }
+      end
+
+      def find(name)
+        list.detect{ |repo| repo.name == name }
+      end
+
+      def actions
+        @actions ||= Dotty::RepositoryActions.new
+      end
+
+      def import(location)
+        repositories = YAML::load(open(location).read) || {}
+        if repositories.empty?
+          error "Didn't find any repositories at '#{location}'"
+        end
+        repositories.keys.each do |name|
+          if find(name)
+            puts "Not adding '#{name}', a repository with that name already exists"
+            next
+          end
+          add_existing_repository(name, repositories[name]['url'])
+        end
+      end
+
+    end
+  
+    def initialize(name, url)
+      unless name =~ /^[a-zA-Z0-9\.\-\_]+$/
+        raise InvalidRepositoryNameError, "Repository name can only contain letters, numbers and the following characters: .-_"
+      end
+      @name = name
+      @url = url
+    end
+
+    def local_path
+      File.join(Dotty::App::ROOT_PATH, Profile::current_profile, @name)
+    end
+
+    def symlinks
+      symlinks_from_dotfiles_directories.merge symlinks_from_yaml
+    end
+
+    def symlinks_from_yaml
+      symlink_file_path = File.join(local_path, 'dotty-symlinks.yml')
+      File.exist?(symlink_file_path) && YAML::load(File.open symlink_file_path) or {}
+    end
+
+    def symlinks_from_dotfiles_directories
+      hsh = {}
+      Dir.glob(File.join local_path, '*dotfiles/') do |dotfiles_directory|
+        dotfiles_directory = Pathname.new(dotfiles_directory)
+
+        # 'root' files 
+        dotfiles_directory.children.each do |path|
+          next if path.basename.to_s =~ /^in\+/
+          source = path.relative_path_from(Pathname.new local_path).to_s
+          target = path.relative_path_from(dotfiles_directory).to_s
+          hsh.merge!(source => target)
+        end
+
+        # stuff in in+XXX directories
+        Dir.glob(File.join(dotfiles_directory.to_s , 'in+*/**/*'), File::FNM_DOTMATCH).each do |path|
+          next if path =~ %r([\.]{2}) or path =~ %r(/\.$) # Remove BS entries like dotfiles/../otherstuff TODO: do it in a better way
+          path = Pathname.new(path)
+          next if path.basename.to_s =~ /^in\+/ # We dont want to do anything with the 'placeholder' directories
+          source = path.relative_path_from(Pathname.new local_path).to_s
+          target = path.relative_path_from(Pathname.new dotfiles_directory).to_s.gsub('in+', '')
+          hsh.merge!(source => target)
+        end
+      end
+      return hsh
+    end
+
+    def git_status
+      # TODO use --json when more people have a git that supports it
+      git_status_output.split("\n").inject({}) do |hsh, line|
+        change_type, file = line[0..1], line[3..-1]
+        hsh.merge(file => change_type)
+      end
+    end
+
+    def unpushed_changes?
+      txt = 'Your branch is ahead of'
+      `cd #{local_path} && git status | grep '#{txt}' 2>&1`.include?(txt)
+    end
+
+    def git_status_output
+      `cd #{local_path} && git status --porcelain`
+    end
+
+    def has_thor_task?
+      File.exist? File.join(local_path, 'dotty-repository.thor')
+    end
+
+    def invoke_action(action, *args)
+      self.class.actions.invoke action, args
+    end
+
+    def destroy
+      Repository.repositories.reject! { |repo| repo.name == name }
+      Dotty::Profile.write_yaml
+      Repository.actions.destroy self
+      self
+    end
+    
+  end
+end

data/lib/dotty/repository_actions.rb

@@ -0,0 +1,110 @@
+module Dotty
+  class RepositoryActions < Thor
+    USER_HOME = Thor::Util.user_home
+
+    include Thor::Actions
+    include Dotty::Helpers
+ 
+    desc "create <repo instance>", "create repository"
+    def create(repo)
+      say_status "create repo", "#{repo.name} [#{repo.url}]", :blue
+      FileUtils.mkdir_p repo.local_path
+      run "git init #{repo.local_path}"
+      inside repo.local_path do
+        run "git remote add origin #{repo.url}"
+      end
+    end
+
+    desc "destroy <repo instance>", "remove repository"
+    def destroy(repo)
+      say_status "remove repo", repo.name, :blue
+      implode repo
+      say_status "remove", repo.local_path
+      FileUtils.rm_rf repo.local_path
+    end
+
+    desc "checkout <repo instance>", "add repository"
+    def checkout(repo)
+      say_status "add repo", "#{repo.name} => #{repo.url}", :blue
+      FileUtils.mkdir_p repo.local_path
+      run "git clone #{repo.url} #{repo.local_path}"
+      inside repo.local_path do
+        run "git submodule update --init"
+      end
+    end
+
+    desc "bootstrap <repo instance>", "bootstrap repository"
+    def bootstrap(repo)
+      say_status "bootstrap", repo.name, :blue
+      with_padding do
+        # Create symlinks defined in dotty-symlinks.yml
+        repo.symlinks.each do |source, destination_filename|
+          create_link File.join(USER_HOME, destination_filename), File.join(repo.local_path, source)
+        end
+
+        # Execute repository's bootstrap task
+        thor_file_path = File.join(repo.local_path, 'dotty-repository.thor')
+        if File.exist? thor_file_path
+          inside repo.local_path do
+            run "thor dotty_repository:bootstrap"
+          end
+        end
+      end
+    end
+
+    desc "implode <repo instance>", "implode repository"
+    def implode(repo)
+      say_status "implode", repo.name, :blue
+
+      # Remove symlinks defined in dotty-symlinks.yml
+      repo.symlinks.each do |source, destination_filename|
+        destination_path = File.join(USER_HOME, destination_filename)
+        remove_symlink destination_path
+      end
+
+      # Execute repository's implode task
+      thor_file_path = File.join(repo.local_path, 'dotty-repository.thor')
+      if File.exist? thor_file_path
+        inside repo.local_path do
+          run "thor dotty_repository:implode"
+        end
+      end
+    end
+
+    desc "update <repo instance>", "update repository"
+    def update(repo)
+      say_status "update", repo.name, :blue
+
+      inside repo.local_path do
+        run "git fetch && git pull && git submodule update --init"
+      end
+    end
+
+    desc "update_submodules", "update repository's submodules"
+    method_options :ignoredirty => false
+    method_options %w(commit_message -m) => "Updated submodules"
+    method_options :commit => true
+    method_options :push => false
+    def update_submodules(repo)
+      say "update submodules", repo.name, :blue
+
+      inside repo.local_path do
+        cmd = []
+        cmd << "git submodule update --init"
+        cmd << "git submodule foreach git pull origin master"
+        if options[:commit]
+          changes = run('git status -s', :capture => true)
+          if options[:ignoredirty] or [nil, ""].include?(changes)
+            cmd << "git commit -am '#{options[:commit_message]}'"
+          else
+            raise Dotty::Error, "Repository '#{repo.name}' is not in a clean state - cannot commit updated submodules"
+          end
+        end
+        options[:push] && cmd << "git push"
+        run cmd.join(" && ")
+      end
+    end
+    
+    
+  end
+end

data/lib/dotty/version.rb

@@ -0,0 +1,3 @@
+module Dotty
+  VERSION = "0.0.1"
+end

data/lib/dotty.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'yaml'
+require 'hashie'
+require 'thor'
+require 'pathname'
+
+require 'dotty/helpers'
+require 'dotty/app'
+require 'dotty/profile'
+require 'dotty/repository'
+require 'dotty/repository_actions'
+
+module Dotty
+  class Error < StandardError; end
+  class RepositoryNotFoundError < Error; end
+  class InvalidRepositoryNameError < Error; end
+end