dottor 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gem "thor"
+gem "rspec"

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  thor

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Marco Campana
+
+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.md

@@ -0,0 +1,85 @@
+Dottor
+======
+
+Description
+-----------
+Dottor is an unobtrusive command line tool for easily managing your dotfiles,
+without assumptions on how your dotfiles repository should be organized.
+
+Why Dottor?
+-----------
+I designed dottor so that it would be easy to setup and use, reliable and work
+with existing dotfiles repos.
+
+With Dottor you can:
+
+1. Get started with yout current dotfils repo, without changing anything.
+2. Specify different profiles, so that you can use it to symlink files in your
+dev machine as well as in your production boxes.
+
+How it works?
+-------------
+
+Dottor expect to find in your repo a YAML file named dottor_rules.yml (or you
+can specify a different path) with the following format
+
+```ruby
+  profile_name:
+  -  source: <dotffile or directory>
+     target: <where do you want the file to be symlinked to>
+  -  source: <dotffile or directory>
+     target: <where do you want the file to be symlinked to>
+```
+
+All the actions performed by Dottor are based on the dottor_rules.yml file.
+Check my [dotfiles repo][dotfiles_repo] for a working example.
+
+
+Getting started
+---------------
+
+```
+  gem install dottor
+```
+
+### Create a dottor_rules.yml inside your dotfiles repo
+
+```
+  dottor init
+```
+
+### Create symlinks based on dottor_rules.yml file in current directory
+
+```
+  dottor symlink <profile_name>
+```
+
+### Specify a dottor_rules.yml file in another directory
+
+```
+  dottor symlink <profile_name> -f <custom_path>
+```
+
+### Delete all the symlinks
+
+```
+  dottor symlink -d
+```
+
+Submitting a Pull Request
+-------------------------
+
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+6. Add specs for your feature or bug fix.
+8. Commit and push your changes.
+
+License
+-------
+Released under the MIT License.  See the [LICENSE][license] file for further
+details.
+
+[license]: https://github.com/marcocampana/dottor/blob/master/LICENSE.md
+[dotfiles_repo]: https://github.com/marcocampana/dotfiles

data/bin/dottor

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "dottor"
+
+Dottor::App.start

data/dottor.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dottor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dottor"
+  s.version     = Dottor::VERSION
+  s.authors     = ["Marco Campana"]
+  s.email       = ["m.campana@gmail.com"]
+  s.homepage    = 'http://github.com/marcocampana/dottor'
+  s.summary     = %q{Command line tool to manage dotfiles the easy way}
+  s.description = %q{Unobtrusive command line tool for easily managing your dotfiles, without assumptions on how your dotfiles repository should be organized.}
+
+  s.rubyforge_project = "dottor"
+
+  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_development_dependency 'rspec'
+end

data/lib/dottor.rb

@@ -0,0 +1,70 @@
+require 'yaml'
+require 'fileutils'
+require 'thor'
+require 'dottor/dotfile'
+
+module Dottor
+  class App < Thor
+    desc "symlink <profile_name>", "Symlink dotfiles defined in specified profile name"
+    method_option :file, :aliases => "-f", :desc => "Use specified rules yaml file instead of the default dottor_rules.yml"
+    method_option :delete, :aliases => "-d", :desc => "Delete existing symlinks added by dottor"
+    def symlink(profile_name)
+      yaml_rules = options[:file] ? File.open(options[:file]) : File.open('dottor_rules.yml')
+
+      say("Loading rules YAML file")
+      rules = YAML::load(yaml_rules)
+
+      rules[profile_name].each do |mapping|
+        dotfile = Dotfile.new(mapping)
+        if options[:delete]
+          dotfile.delete_symlink
+        else
+          dotfile.create_symlink
+        end
+      end
+    end
+
+    desc "init", "Create dottor_rule.yml file"
+    method_option :force, :desc => "Overwrite existing dottor_rules.yml file"
+    def init
+      if File.exists?('dottor_rules.yml')
+        if options[:force]
+          FileUtils.rm 'dottor_rules.yml'
+        else
+          say("Abort: dottor_rules.yml already exist. Use the --force to overwrite.")
+          exit(1)
+        end
+      end
+
+      rules_hash = {"profile_name" => []}
+
+      exclude_files = ['.gitignore', 'README', 'README.md']
+      if git_repo?
+        files_in_current_dir = `git ls-files`.split("\n") - exclude_files
+      else
+        files_in_current_dir = Dir["*"] - exclude_files
+      end
+
+      if files_in_current_dir.empty?
+        rules_hash["profile_name"] = [{"source" => ".dotfile", "target" => "target_path/.dotfile"}]
+      else
+        files_in_current_dir.each do |file_name|
+          rules_hash["profile_name"] << {"source" => file_name, "target" => "target_path/#{file_name}"}
+        end
+      end
+
+      File.open('dottor_rules.yml', 'w') do |file|
+        file.write(YAML.dump(rules_hash))
+      end
+
+      say("dottor_rules.yml file created. Modify it and run 'dottor symlink <profile_name>'")
+    end
+
+    private
+
+    # TODO move into an helper module
+    def git_repo?
+      File.exists? '.git'
+    end
+  end
+end

data/lib/dottor/dotfile.rb

@@ -0,0 +1,39 @@
+module Dottor
+  class Dotfile
+    attr_accessor :source, :target
+
+    def initialize(hash)
+      @source = hash["source"]
+      @target = hash["target"]
+    end
+
+    def create_symlink
+      # If file exists rename it to .old
+      # TODO check if .old file already exists
+      if File.exists?(target)
+        old_file_name = "#{target}.old"
+        FileUtils.mv target, old_file_name
+      end
+
+      # If symlink exists, remove it
+      if File.symlink?(target)
+        FileUtils.rm target
+      end
+
+      $stdout.puts("Create symlink #{File.join(current_path, source)} -> #{target}")
+      FileUtils.symlink File.join(current_path, source), target
+    end
+
+    def delete_symlink
+      if File.symlink?(target)
+        FileUtils.rm target
+      end
+    end
+
+    private
+
+    def current_path
+      Dir.pwd
+    end
+  end
+end

data/lib/dottor/version.rb

@@ -0,0 +1,3 @@
+module Dottor
+  VERSION = "0.1.0"
+end

data/spec/app_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Dottor::App" do
+  describe "symlink" do
+    it "should use the dottor_rules.yml in current directory by default" do
+      stub_dottor_rules_file('dottor_rules.yml')
+      stub_dotfile
+
+      Dottor::App.start(['symlink', 'development'])
+    end
+
+    it "should use the specified dottor_rules file with -f option" do
+      stub_dottor_rules_file('../my_custom_dottor_rules.yml')
+      stub_dotfile
+
+      Dottor::App.start(['symlink', 'development', '-f', '../my_custom_dottor_rules.yml'])
+    end
+
+    it "should call the create_symlink method" do
+      stub_dottor_rules_file('dottor_rules.yml')
+      stub_dotfile(:create_symlink)
+
+      Dottor::App.start(['symlink', 'development'])
+    end
+  end
+end

data/spec/fixtures/dottor_rules.yml

@@ -0,0 +1,4 @@
+---
+development:
+- source: .vimrc
+  target: target_path/.vimrc

data/spec/helpers/utils.rb

@@ -0,0 +1,13 @@
+module Utils
+  def stub_dottor_rules_file(file_name)
+    dottor_rules_file = File.open(File.expand_path(File.dirname(__FILE__) + '/../fixtures/dottor_rules.yml'))
+    File.should_receive(:open).with(file_name).and_return(dottor_rules_file)
+  end
+
+  def stub_dotfile(method=nil)
+    dotfile_mock = mock(:delete_symlink => nil, :create_symlink => nil)
+    Dottor::Dotfile.should_receive(:new).and_return(dotfile_mock)
+
+    dotfile_mock.should_receive(method) if method
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rspec'
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'dottor'
+require 'helpers/utils'
+
+RSpec.configure do |c|
+  c.include Utils
+
+  c.mock_with :rspec
+
+  c.before(:each) do
+    STDOUT.should_receive(:puts).and_return("")
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: dottor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Marco Campana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70257029527160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70257029527160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70257029524660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257029524660
+description: Unobtrusive command line tool for easily managing your dotfiles, without
+  assumptions on how your dotfiles repository should be organized.
+email:
+- m.campana@gmail.com
+executables:
+- dottor
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- bin/dottor
+- dottor.gemspec
+- lib/dottor.rb
+- lib/dottor/dotfile.rb
+- lib/dottor/version.rb
+- spec/app_spec.rb
+- spec/fixtures/dottor_rules.yml
+- spec/helpers/utils.rb
+- spec/spec_helper.rb
+homepage: http://github.com/marcocampana/dottor
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: dottor
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Command line tool to manage dotfiles the easy way
+test_files:
+- spec/app_spec.rb
+- spec/fixtures/dottor_rules.yml
+- spec/helpers/utils.rb
+- spec/spec_helper.rb
+has_rdoc: