dotify 0.1.1 → 0.2.0

data/README.md

@@ -32,10 +32,28 @@ To setup Dotify, you must first run `dotify setup` in your terminal.
     Do you want to add .gitconfig to Dotify? [Yn] y
     ...
 
-This will first create a `.dotify` directory in your home directory (yes, only one more dot directory, but this time it is a good thing). It will then ask which files you want to copy from your home directory into your `.dotify` directory. 
+This will first create a `.dotify` directory in your home directory (yes, only one more dot directory, but this time it is a good thing). It will then ask which files you want to copy from your home directory into your `.dotify` directory.
 
 **This will *not* link up the dotfiles. This command simply copies the files over for you without having to go searching for them manually.**
 
+### Add single files
+
+After you have setup Dotify, you can add files one by one if you did not add them during setup
+
+    $ dotify add .vimrc
+          create  /Users/mattbridges/.vimrc
+
+### Remove single files
+
+If you don't want a particular dotfile anymore? You can just remove it.
+
+***This actually removes the file from the home directory. Do this at your own risk***.
+
+    $ dotify remove .vimrc
+          remove  /Users/mattbridges/.vimrc
+
+If you do this and decide to change your mind, the file is still located in the `~/.dotify` directory. You can re-link it by running `dotify link` again.
+
 ### Link up your files
 
 This is the heart of the Dotify tool. This command will link the files within the `~/.dotify` directory into your home directory.
@@ -64,22 +82,35 @@ Don't want any of the dotfiles anymore? Well, I'm not one to question. Go ahead
 
 Should you run this horrid task accidentally, you can simply run `dotify link` again if you want to restore your previous settings.
 
+## Confused?
+
+Dotify can manages dotfiles from two different directions:
+
+1. `add` and `remove` both look in the user's home directory for dotfiles to manage
+2. `link` and `unlink` both look in the Dotify directory for dotfiles to manage.
+
+In other words, when the user has dotfiles in the home directory that he/she wants Dotify to manage, they would use `dotify add [FILENAME]` (or even `setup`) to instruct Dotify to manage those files.
+
+On the other hand, if he/she has files that they have instructed Dotify to manage but have removed them from the home directory, they would use `link` and `unlink` to re-link them into the home directory.
+
 ## Not sure what to do?
 
 This tool is powered by the amazing library, [Thor](http://whatisthor.com/). You can use the `help` task like so:
 
     $ dotify help
     Tasks:
-      dotify help [TASK]  # Describe available tasks or one specific task
-      dotify link         # Link up all of your dotfiles
-      dotify setup        # Setup your system for Dotify to manage your dotfiles
-      dotify unlink       # Unlink all of your dotfiles
+      dotify add [FILENAME]     # Add a single dotfile to the Dotify directory
+      dotify help [TASK]        # Describe available tasks or one specific task
+      dotify link               # Link up all of your dotfiles
+      dotify remove [FILENAME]  # Remove a single dotfile from Dotify
+      dotify setup              # Setup your system for Dotify to manage your dotfiles
+      dotify unlink             # Unlink all of your dotfiles
 
 And if you want a little clarity on one of the command you can run `dotify help [TASK]` to find out what other options you have in the other tasks.
 
 ## Contributing
 
-This tool is developed with much influence from *37singals*' fantastic idea of **Do Less**. This is meant to be a *simple* tool. 
+This tool is developed with much influence from *37singals*' fantastic idea of **Do Less**. This is meant to be a *simple* tool.
 
 Contributions are welcome and encouraged. The contrubution process is the typical Github one.
 

data/lib/dotify/cli.rb

@@ -11,34 +11,74 @@ module Dotify
     include Thor::Actions
     default_task :help
 
-    map "-l" => "link"
-    map "-u" => "unlink"
-    map "-b" => "backup"
-    map "-r" => "restore"
+    map "-l" => :link
+    map "-u" => :unlink
+    map "-s" => :setup
+    map "-a" => :add
+    map "-r" => :remove
 
     def self.source_root
       Config.home
     end
 
     desc :setup, "Setup your system for Dotify to manage your dotfiles"
+    method_option :link, :default => false, :type => :boolean, :aliases => '-l', :desc => "Link dotfiles when setup is complete"
     def setup
       empty_directory(Config.path) unless File.directory?(Config.path)
-      Dir[File.join(Config.home, ".*")].each do |file|
-        filename = Files.file_name(file)
-        dotify_file = File.join(Config.path, filename)
-        unless ['.', '..', Config.dirname].include? filename
-          if yes?("Do you want to add #{filename} to Dotify? [Yn]", :yellow)
-            if File.directory?(Files.dotfile(file))
-              FileUtils.rm_rf dotify_file
-              FileUtils.cp_r Files.dotfile(file), dotify_file
-              say_status :create, dotify_file
-            else
-              copy_file Files.dotfile(file), dotify_file
-            end
+      Files.unlinked do |path, file|
+        add(file) unless Config.dirname == file
+      end
+      say "Dotify has been successfully setup.", :blue
+      if options[:link]
+        say "Linking up the new dotfiles...", :blue
+        invoke :link, nil, { :all => true } if options[:link]
+      end
+    end
+
+    desc "add [FILENAME]", "Add a single dotfile to the Dotify directory"
+    method_option :force, :default => false, :type => :boolean, :aliases => '-f', :desc => "Add file without confirmation"
+    def add(file)
+      file = Files.file_name(file)
+      dotfile = Files.dotfile(file)
+      dotify_file = Files.dotify(file)
+      case
+      when !File.exist?(dotfile)
+        say "'~/#{file}' does not exist", :blue
+      when File.identical?(dotfile, dotify_file)
+        say "'~/#{file}' is already identical to '~/.dotify/#{file}'", :blue
+      else
+        if options[:force] == true || yes?("Do you want to add #{file} to Dotify? [Yn]", :yellow)
+          if File.directory?(dotfile)
+            FileUtils.rm_rf dotify_file
+            FileUtils.cp_r dotfile, dotify_file
+            say_status :create, dotify_file
+          else
+            copy_file dotfile, dotify_file
           end
         end
       end
-      say "Dotify has been successfully setup.", :blue
+    end
+
+    desc "remove [FILENAME]", "Remove a single dotfile from Dotify"
+    long_desc <<-STRING
+      `dotify remove [FILENAME]` removes the dotfiles from the Dotify directory
+      and moves it back into the home directory. If you decide you want Dotify
+      to manage that file again, you can simply run `dotify add [FILENAME]` to
+      add it back again.
+    STRING
+    method_option :force, :default => false, :type => :boolean, :aliases => '-f', :desc => "Remove file without confirmation"
+    method_option :quiet, :default => false, :type => :boolean, :aliases => '-q', :desc => "Don't output anything"
+    def remove(file)
+      if !File.exists?(Files.dotify(file))
+        say "Dotify is not currently managing ~/#{file}.", :blue unless options.quiet?
+        return
+      end
+      if options[:force] == true || yes?("Are you sure you want to remove #{file} from Dotify? [Yn]", :yellow)
+        remove_file Files.dotfile(file), :verbose => false
+        copy_file Files.dotify(file), Files.dotfile(file), :verbose => false
+        remove_file Files.dotify(file), :verbose => false
+        say_status :removed, Files.dotify(file) unless options.quiet?
+      end
     end
 
     desc :link, "Link up all of your dotfiles"
@@ -54,21 +94,26 @@ module Dotify
           end
           count += 1
         else
-          if yes?("Do you want to link ~/#{dot}? [Yn]", :green)
+          if yes?("Do you want to link ~/#{dot}? [Yn]", :yellow)
             create_link Files.dotfile(file), file
             count += 1
           end
         end
       end
-      say "No files were linked.", :yellow if count == 0
+      say "No files were linked.", :blue if count == 0
     end
 
     desc :unlink, "Unlink all of your dotfiles"
+    long_desc <<-STRING
+      `dotify unlink` removes the dotfiles from the home directory and preserves the
+      files in the Dotify directory. This allows you to simply run `dotify link` again
+      should you decide you want to relink anything to the Dotify files.
+    STRING
     method_option :all, :default => false, :type => :boolean, :aliases => '-a', :desc => 'Remove all installed dotfiles without confirmation'
     def unlink
       count = 0
       Files.installed do |file, dot|
-        if options[:all] || yes?("Are you sure you want to remove ~/#{dot}? [Yn]", :blue)
+        if options[:all] || yes?("Are you sure you want to remove ~/#{dot}? [Yn]", :yellow)
           remove_file Files.dotfile(file)
           count += 1
         end

data/lib/dotify/files.rb

@@ -11,7 +11,7 @@ module Dotify
       include Thor::Actions
 
       def dots
-        @dots ||= file_list(File.join(dotify_path, "/.*"))
+        @dots ||= file_list(File.join(Config.path, "/.*"))
         return @dots unless block_given?
         @dots.each {|d| yield(d, file_name(d)) }
       end
@@ -25,6 +25,14 @@ module Dotify
         installed.each {|i| yield(i, file_name(i)) }
       end
 
+      def unlinked
+        dots = self.dots.map { |f| file_name(f) }
+        installed = self.installed.map {|f| file_name(f)}
+        unlinked = (dots - installed).map{|f| dotfile(f) }
+        return unlinked unless block_given?
+        unlinked.each {|u| yield(u, file_name(u)) }
+      end
+
       def file_name(file)
         file.split("/").last
       end
@@ -37,6 +45,10 @@ module Dotify
         File.join(Config.home, file_name(file))
       end
 
+      def dotify(file)
+        File.join(Config.path, file_name(file))
+      end
+
       def link_dotfile(file)
         FileUtils.ln_s(file_name(file), Config.home) == 0 ? true : false
       end
@@ -55,10 +67,6 @@ module Dotify
           files.select { |f| !['.', '..'].include?(file_name(f)) }
         end
 
-        def dotify_path
-          Config.path
-        end
-
     end
   end
 end

data/lib/dotify/version.rb

@@ -1,3 +1,3 @@
 module Dotify
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/dotify/files_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'dotify/config'
 require 'dotify/files'
 require 'fileutils'
 
@@ -13,6 +14,7 @@ describe Dotify::Files do
   after do
     Fake.teardown
   end
+
   it "should respond to the right methods" do
     Dotify::Files.should respond_to :dots
     Dotify::Files.should respond_to :installed
@@ -30,6 +32,13 @@ describe Dotify::Files do
     end
   end
 
+  describe Dotify::Files, "#dotify" do
+    it "should return the path to the file when it is linked in the root" do
+      Dotify::Files.dotify(".vimrc").should == File.join(Dotify::Config.path, ".vimrc")
+      Dotify::Files.dotify("/spec/home/.bashrc").should == File.join(Dotify::Config.path, ".bashrc")
+    end
+  end
+
   describe Dotify::Files, "#dots" do
     before do
       Dotify::Files.stub(:file_list) do
@@ -50,6 +59,26 @@ describe Dotify::Files do
     end
   end
 
+  describe Dotify::Files, "#unlinked" do
+    before do
+      Dotify::Files.stub(:dots) do
+        ['/spec/test/.vimrc', '/spec/test/.bashrc', '/spec/test/.zshrc']
+      end
+      Dotify::Files.stub(:installed) do
+        ['/root/test/.bashrc', '/root/test/.zshrc']
+      end
+    end
+    it "should return the list of unlinked dotfiles in the root path" do
+      unlinked = Dotify::Files.unlinked.map { |u| Dotify::Files.file_name(u) }
+      unlinked.should include '.vimrc'
+      unlinked.should_not include '.bashrc'
+    end
+    it "shoud yield the unlinked files if a block is given" do
+      unlinked = Dotify::Files.unlinked.map { |u| [u, Dotify::Files.file_name(u)] }
+      expect { |b| Dotify::Files.unlinked(&b) }.to yield_successive_args(*unlinked)
+    end
+  end
+
   describe Dotify::Files, "#installed" do
     before do
       fake_root, dotify = Fake.paths
@@ -87,7 +116,7 @@ describe Dotify::Files do
 
   describe Dotify::Files, "#link_dotfile" do
     it "should receive a file and link it into the root path" do
-      first = File.join(Dotify::Files.send(:dotify_path), ".vimrc")
+      first = File.join(Dotify::Config.path, ".vimrc")
       FileUtils.should_receive(:ln_s).with(Dotify::Files.file_name(first), Dotify::Config.home).once
       Dotify::Files.link_dotfile first
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors: