dotfile_linker 0.0.2 → 1.0.0

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.8.7
+  - 1.9.3

data/Gemfile

@@ -2,6 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in dotfile_linker.gemspec
 gemspec
-gem 'rake', '~>0.9'
-gem 'rspec', '~>2.9'
-gem 'colorize'

data/README.md

@@ -1,6 +1,7 @@
-# DotfileLinker
+# DotfileLinker [![Build Status](https://secure.travis-ci.org/dillonkearns/dotfile-linker.png?branch=master)](http://travis-ci.org/dillonkearns/dotfile-linker?branch=master) [![Dependency Status](https://gemnasium.com/dillonkearns/dotfile_linker.png)](https://gemnasium.com/dillonkearns/dotfile_linker) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/dillonkearns/dotfile-linker)
 
-A simple script to help you symlink your dotfiles to your home directory.
+A simple command-line utility to help you symlink your dotfiles to your home directory. Just run `dotfile_linker` from
+your dotfiles directory.
 
 ## Description
 
@@ -10,14 +11,13 @@ structure on how you manage your dotfiles.
 
 ## Installation
 
-Download the source, then run:
+This gem is hosted on [rubygems.org](https://rubygems.org/gems/dotfile_linker), so simply install with:
 
-    $ bundle install
-    $ rake install
+    $ gem install dotfile_linker
 
 ## Usage
 
-Run `link_dotfiles` from your dotfiles directory. The script will then run through each file that isn't already
+Run `dotfile_linker` from your dotfiles directory. The script will then run through each file that isn't already
 symlinked in your home directory and ask if you want to symlink it. The `-d` option cycles through existing symlinks in
 your home directory and asks if you'd like to remove them.
 

data/Rakefile

@@ -2,3 +2,5 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new("spec")
+
+task :default => :spec

data/bin/dotfile_linker

@@ -0,0 +1,6 @@
+#! /usr/bin/ruby
+
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+require 'dotfile_linker'
+
+DotfileLinker::Linker.new.start

data/dotfile_linker.gemspec

@@ -4,10 +4,8 @@ require File.expand_path('../lib/dotfile_linker/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Dillon Kearns"]
   gem.email         = ["dillon@dillonkearns.com"]
-  gem.description   = "This gem aims to provide a simple, unopinionated solution to managing symlinking your " \
-                      "dotfiles, allowing you to save them in an isolated, versioned directory and keep your home " \
-                      "directory clean. Similar tools exist, but tend to impose a structure on how you manage your dotfiles."
-  gem.summary       = "A simple script to help you symlink your dotfiles to your home directory."
+  gem.description   = "A simple command-line utility to help you symlink your dotfiles to your home directory. Just run `dotfile_linker` from your dotfiles directory."
+  gem.summary       = gem.description
   gem.homepage      = "https://github.com/dillonkearns/dotfile-linker"
 
   gem.files         = `git ls-files`.split($\)
@@ -18,7 +16,8 @@ Gem::Specification.new do |gem|
   gem.version       = DotfileLinker::VERSION
 
   gem.required_ruby_version = ">=1.8.7"
-  gem.add_runtime_dependency("colorize")
-  gem.add_development_dependency("rake", "~>0.9")
-  gem.add_development_dependency("rspec", "~>2.9")
+
+  gem.add_runtime_dependency "colorize", "~> 0.5.8"
+  gem.add_development_dependency "rake", "~> 0.9.2"
+  gem.add_development_dependency "rspec", "~> 2.11.0"
 end

data/lib/dotfile_linker.rb

@@ -1,69 +1,144 @@
 require 'dotfile_linker/version'
 require 'optparse'
+require 'fileutils'
 require 'colorize'
 
 class String
   def human_filename
-    self.gsub(%r{^(/[^/]+){2}}, '~')
+    self.sub(/^#{ ENV['HOME'] }/, '~')
   end
 end
 
 module DotfileLinker
-  BLACKLIST = %w{ .git }
-  @@options = {}
+  class InvalidDotfilesDir < RuntimeError; end
 
-  def self.parse_options
-    optparse = OptionParser.new do |opts|
-      opts.on('-d', '--delete', 'Delete symlinks') { @@options[:delete_mode] = true }
-      opts.on_tail('-v', '--version', 'Show version') { puts VERSION; exit }
-      opts.on_tail('-h', '--help', 'Show this message') { puts opts; exit }
+  class Linker
+    BLACKLIST = %w{ .git }
+
+    def initialize
+      @options = {}
     end
-    optparse.parse!
-  end
 
-  def self.exclude_file?(filename)
-    filename =~ /^\.\.?$/ or BLACKLIST.include?(filename)
-  end
+    def dotfiles_dir
+      @options[:path] || Dir.pwd
+    end
 
-  def self.positive_user_response?
-    case gets.strip
-    when /^y/i
-      true
-    when /^n/i
-      false
-    else
-      puts 'Exiting'
-      exit
+    def home_dir
+      ENV['HOME']
     end
-  end
 
-  def self.link_file(filename)
-    unless exclude_file?(filename)
-      symlink_file = File.expand_path("~/#{ filename }")
-      actual_file = File.expand_path(filename)
-      if @@options[:delete_mode]
-        if File.symlink?(symlink_file)
-          puts "delete symlink #{ symlink_file.human_filename.magenta }? (y/n)"
-          File.delete(symlink_file) if positive_user_response?
-        end
+    def ignore_file_name
+      File.expand_path("~/.dotfile_linker_ignore")
+    end
+
+    def raise_if_home_and_dotfiles_dir_match
+      if File.expand_path(home_dir) == File.expand_path(dotfiles_dir)
+        raise InvalidDotfilesDir, "Please specify your dotfiles directory by running `link_dotfiles` from that path, or providing a --path flag".red
+      end
+    end
+
+    def user_response(message)
+      puts message
+      case gets.strip
+      when /^y/i
+        :yes
+      when /^n/i
+        :no
+      when /^i/i
+        :ignore
+      when /^q/i
+        :quit
       else
-        unless File.symlink?(symlink_file)
-          puts "link %s -> %s? (y/n)" % [symlink_file.human_filename.magenta, actual_file.human_filename.cyan]
-          File.symlink(actual_file, symlink_file) if positive_user_response?
+        user_response("Please enter a valid response")
+      end
+    end
+
+    def user_response_or_exit(message)
+      response = user_response(message)
+      if response == :quit
+        puts "Exiting"
+        exit
+      end
+      response
+    end
+
+    def parse_options
+      optparse = OptionParser.new do |opts|
+        opts.on('-p', '--path PATH', String, 'Use [PATH] as dotfiles directory (instead of current directory)') { |path| @options[:path] = File.expand_path(path) }
+        opts.on_tail('-u', '--unlink', 'Unlink mode') { @options[:unlink_mode] = true }
+        opts.on_tail('-v', '--version', 'Show version') { puts VERSION; exit }
+        opts.on_tail('-h', '--help', 'Show this message') { puts opts; exit }
+      end
+      optparse.parse!
+    end
+
+    def ignore_list
+      @ignore_list ||=
+        begin
+          File.open(ignore_file_name, 'rb').lines.to_a.map(&:chomp)
+        rescue Errno::ENOENT
+          []
         end
+    end
+
+    def ignore_file(filename)
+      File.open(ignore_file_name, 'a') do |f|
+        f.puts filename
       end
     end
-  end
 
-  def self.link_files
-    Dir.foreach(Dir.pwd) { |filename| link_file(filename) }
-  end
+    def exclude_file?(filename)
+      filename =~ /^\.\.?$/ or BLACKLIST.include?(filename) or ignore_list.include?(filename)
+    end
+
+    def link_file(filename)
+      home_dir_file_path = File.expand_path("~/#{ filename }")
+      dotfiles_dir_file_path = File.expand_path("#{ dotfiles_dir }/#{ filename }")
+      unless File.symlink?(home_dir_file_path) || exclude_file?(filename)
+        case user_response_or_exit("move and link #{ home_dir_file_path.human_filename.magenta } -> #{ dotfiles_dir_file_path.human_filename.cyan }? (y/n/i[gnore])")
+        when :yes
+          FileUtils.mv(home_dir_file_path, dotfiles_dir_file_path, :verbose => true)
+          FileUtils.ln_s(dotfiles_dir_file_path, home_dir_file_path, :verbose => true)
+        when :ignore
+          ignore_file(filename)
+          puts "ignored #{filename.cyan}"
+        end
+      end
+    end
+
+    def link_files
+      Dir.foreach(home_dir) { |filename| link_file(filename) }
+    end
+
+    def unlink_file(filename)
+      home_dir_symlink_path = File.expand_path("~/#{ filename }")
+      dotfiles_dir_file_path = File.expand_path("#{ dotfiles_dir }/#{ filename }")
+      if File.symlink?(home_dir_symlink_path)
+        case user_response_or_exit("unlink #{ home_dir_symlink_path.human_filename.magenta } and restore #{ dotfiles_dir_file_path.human_filename.cyan }? (y/n)")
+        when :yes
+          FileUtils.rm(home_dir_symlink_path, :verbose => true)
+          FileUtils.mv(dotfiles_dir_file_path, home_dir_symlink_path, :verbose => true)
+        end
+      end
+    end
 
-  def self.start
-    parse_options
-    link_files
-    puts 'Done'
-  rescue Interrupt
-    # do nothing
+    def unlink_files
+      Dir.foreach(dotfiles_dir) { |filename| unlink_file(filename) }
+    end
+
+    def start
+      raise_if_home_and_dotfiles_dir_match
+      parse_options
+      if @options[:unlink_mode]
+        unlink_files
+      else
+        link_files
+      end
+      puts 'Finished'
+    rescue Interrupt
+      # do nothing
+    rescue InvalidDotfilesDir => e
+      puts e.message
+    end
   end
 end

data/lib/dotfile_linker/version.rb

@@ -1,3 +1,3 @@
 module DotfileLinker
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/spec/dotfile_linker_spec.rb

@@ -1,42 +1,180 @@
-require 'rspec'
+require 'spec_helper'
 require 'dotfile_linker'
 
-describe DotfileLinker do
-  describe ".exclude_file?" do
+describe DotfileLinker::Linker do
+  before(:each) do
+    @linker = DotfileLinker::Linker.new
+    @linker.stub(:user_response).and_return(:yes)
+    DotfileLinker::Linker.any_instance.stub(:puts)
+  end
+
+  describe "#user_response" do
+    before do
+      @linker = DotfileLinker::Linker.new
+    end
+
+    it "returns expected symbols" do
+      values = { :yes    => %w{y Y yes Yes},
+                 :no     => %w{n N no No},
+                 :ignore => %w{i I ignore Ignore},
+                 :quit => %w{q Q quit Quit} }
+      values.each do |k, v|
+        v.each do |response|
+          @linker.stub(:gets).and_return(response)
+          @linker.user_response('fake message').should == k
+        end
+      end
+    end
+  end
+
+  describe "#exclude_file?" do
     it "excludes files in blacklist" do
-      %w{ . .. .git }.each { |filename| DotfileLinker.exclude_file?(filename).should be }
+      %w{ . .. .git }.each { |filename| @linker.exclude_file?(filename).should be }
     end
 
     it "doesn't exclude files prefixed with dot" do
-      %w{ .bash_profile .emacs .gitconfig .tmux.conf }.each { |filename| DotfileLinker.exclude_file?(filename).should_not be }
+      %w{ .bash_profile .emacs .gitconfig .tmux.conf }.each { |filename| @linker.exclude_file?(filename).should_not be }
     end
 
     it "doesn't exclude files that aren't prefixed with dot" do
-      ['my_script' 'sample.rb'].each { |filename| DotfileLinker.exclude_file?(filename).should_not be }
+      ['my_script' 'sample.rb'].each { |filename| @linker.exclude_file?(filename).should_not be }
+    end
+
+    it "excludes files in ignore list" do
+      @linker.stub(:ignore_list).and_return(%w{ignored_file .other_ignored_file})
+      @linker.exclude_file?('ignored_file').should be
+      @linker.exclude_file?('.other_ignored_file').should be
     end
   end
 
-  describe ".link_file when symlink doesn't already exist" do
-    before do
-      DotfileLinker.stub!(:positive_user_response?).and_return(true)
-      File.stub!(:symlink?).and_return(false)
+  describe "#ignore_list" do
+    it "excludes files which are in the .dotfiles_ignore file" do
+      File.should_receive(:open).with(File.expand_path("~/.dotfile_linker_ignore"), kind_of(String)).and_return(".ignored_file1\n.ignored_file2\n.ignored_file3\n")
+      @linker.ignore_list.should == %w[.ignored_file1 .ignored_file2 .ignored_file3]
+    end
+
+    it "returns [] when file does not exist" do
+      File.should_receive(:open).with(File.expand_path("~/.dotfile_linker_ignore"), kind_of(String)).and_raise(Errno::ENOENT)
+      @linker.ignore_list.should == []
+    end
+  end
 
+  describe "#ignore_file" do
+    it "should write a new ignore entry" do
+      file = mock('file')
+      File.should_receive(:open).with(@linker.ignore_file_name, 'a').and_yield(file)
+      file.should_receive(:puts).with('some_file')
+      @linker.ignore_file('some_file')
+    end
+  end
+
+  describe "#raise_if_home_and_dotfiles_dir_match" do
+    it "raises exception when home dir and dotfiles dir are the same" do
+      @linker.stub(:dotfiles_dir).and_return(@linker.home_dir)
+      expect { @linker.raise_if_home_and_dotfiles_dir_match }.to raise_error(DotfileLinker::InvalidDotfilesDir)
+    end
+  end
+
+  describe "#link_file" do
+    before do
       @bad_filenames = %w{ . .. .git }
       @good_filenames = %w{.bash_profile .bashrc .dotrc  .emacs .gemrc .gitconfig .gitignore_global .irbrc .oh-my-zsh
                           .pryrc .rvmrc .ssh .tmux.conf .zshrc .zshrc.pre-oh-my-zsh}
     end
 
-    it "links accepted files to home directory" do
-      @good_filenames.each do |filename|
-        File.should_receive(:symlink).with("#{ Dir.pwd }/#{ filename }", "#{ Dir.home }/#{ filename }")
-        DotfileLinker.link_file(filename)
+    describe "when the user ignores a file" do
+      before do
+        @linker.stub(:user_response).and_return(:ignore)
+      end
+
+      it "should call #ignore_file" do
+        @linker.should_receive(:ignore_file).with("file I want to ignore")
+        @linker.link_file("file I want to ignore")
+      end
+    end
+
+    describe "when file exists in ~/" do
+      before do
+        File.stub(:exist?).with(/^#{ ENV['HOME'] }/).and_return(true)
+      end
+
+      describe "and is a symlink" do
+        before do
+          File.stub(:symlink?).and_return(true)
+        end
+
+        it "doesn't attempt to move or symlink any files" do
+          FileUtils.should_not_receive(:ln_s)
+          FileUtils.should_not_receive(:mv)
+
+          @good_filenames.each do |filename|
+            @linker.link_file(filename)
+          end
+
+          @bad_filenames.each do |filename|
+            @linker.link_file(filename)
+          end
+        end
+      end
+
+      describe "and is not a symlink" do
+        before do
+          File.stub(:symlink?).and_return(false)
+        end
+
+        it "should move then symlinks accepted files" do
+          @good_filenames.each do |filename|
+            home_dir_file_path = "#{ ENV['HOME'] }/#{ filename }"
+            dotfiles_dir_file_path = "#{ @linker.dotfiles_dir }/#{ filename }"
+            FileUtils.should_receive(:mv).with(home_dir_file_path, dotfiles_dir_file_path, { :verbose => true }).ordered
+            FileUtils.should_receive(:ln_s).with(dotfiles_dir_file_path, home_dir_file_path, { :verbose => true }).ordered
+            @linker.link_file(filename)
+          end
+        end
+
+        it "shouldn't move or symlink blacklisted files" do
+          FileUtils.should_not_receive(:ln_s)
+          FileUtils.should_not_receive(:mv)
+          @bad_filenames.each do |filename|
+            @linker.link_file(filename)
+          end
+        end
       end
     end
+  end
+
+  describe "#unlink_file" do
+    [true, false].each do |home_dir_file_is_symlink|
+      describe "when symlink #{ "isn't" unless home_dir_file_is_symlink } in ~" do
+        it "should #{ "not" unless home_dir_file_is_symlink } remove symlink and move file" do
+          filename = "file_to_unlink"
+          home_dir_file_path = "#{ ENV['HOME'] }/#{ filename }"
+          dotfiles_dir_file_path = "#{ @linker.dotfiles_dir }/#{ filename }"
+
+          File.stub(:symlink?).with(home_dir_file_path).and_return(home_dir_file_is_symlink)
+          if home_dir_file_is_symlink
+            FileUtils.should_receive(:rm).with(home_dir_file_path, { :verbose => true }).ordered
+            FileUtils.should_receive(:mv).with(dotfiles_dir_file_path, home_dir_file_path, { :verbose => true }).ordered
+          else
+            FileUtils.should_not_receive(:rm)
+            FileUtils.should_not_receive(:mv)
+          end
+          @linker.unlink_file(filename)
+        end
+      end
+    end
+
+    describe "with negative response" do
+      before do
+        @linker.stub(:user_response).and_return(:no)
+      end
+
+      it "does not remove symlink or move file" do
+        File.stub(:symlink?).and_return(true)
+        FileUtils.should_not_receive(:rm)
+        FileUtils.should_not_receive(:mv)
 
-    it "doesn't link blacklisted files" do
-      @bad_filenames.each do |filename|
-        File.should_not_receive(:symlink)
-        DotfileLinker.link_file(filename)
+        @linker.unlink_file('some_file')
       end
     end
   end
@@ -47,7 +185,7 @@ describe DotfileLinker do
     end
 
     it "replaces home dir for long path" do
-      File.expand_path("#{ Dir.home }/some/test/dir/.gitignore").human_filename.should == '~/some/test/dir/.gitignore'
+      File.expand_path("~/some/test/dir/.gitignore").human_filename.should == '~/some/test/dir/.gitignore'
     end
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rspec'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dotfile_linker
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors: 
 - Dillon Kearns
@@ -15,72 +15,81 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-25 00:00:00 Z
+date: 2012-10-07 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 27
         segments: 
         - 0
-        version: "0"
+        - 5
+        - 8
+        version: 0.5.8
+  requirement: *id001
   prerelease: false
-  type: :runtime
   name: colorize
-  requirement: *id001
+  type: :runtime
 - !ruby/object:Gem::Dependency 
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 25
+        hash: 63
         segments: 
         - 0
         - 9
-        version: "0.9"
+        - 2
+        version: 0.9.2
+  requirement: *id002
   prerelease: false
-  type: :development
   name: rake
-  requirement: *id002
+  type: :development
 - !ruby/object:Gem::Dependency 
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 17
+        hash: 35
         segments: 
         - 2
-        - 9
-        version: "2.9"
+        - 11
+        - 0
+        version: 2.11.0
+  requirement: *id003
   prerelease: false
-  type: :development
   name: rspec
-  requirement: *id003
-description: This gem aims to provide a simple, unopinionated solution to managing symlinking your dotfiles, allowing you to save them in an isolated, versioned directory and keep your home directory clean. Similar tools exist, but tend to impose a structure on how you manage your dotfiles.
+  type: :development
+description: A simple command-line utility to help you symlink your dotfiles to your home directory. Just run `dotfile_linker` from your dotfiles directory.
 email: 
 - dillon@dillonkearns.com
 executables: 
-- link_dotfiles
+- dotfile_linker
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- bin/link_dotfiles
+- bin/dotfile_linker
 - dotfile_linker.gemspec
 - lib/dotfile_linker.rb
 - lib/dotfile_linker/version.rb
 - spec/dotfile_linker_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
 homepage: https://github.com/dillonkearns/dotfile-linker
 licenses: []
 
@@ -112,9 +121,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
-summary: A simple script to help you symlink your dotfiles to your home directory.
+summary: A simple command-line utility to help you symlink your dotfiles to your home directory. Just run `dotfile_linker` from your dotfiles directory.
 test_files: 
 - spec/dotfile_linker_spec.rb
+- spec/spec_helper.rb

data/bin/link_dotfiles

@@ -1,6 +0,0 @@
-#! /usr/bin/ruby
-
-$:.unshift(File.expand_path("../../lib", __FILE__))
-require 'dotfile_linker'
-
-DotfileLinker.start