dotify 0.5.1 → 0.6.0

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -31,13 +31,15 @@ To install Dotify, you must first run `dotify install` in your terminal.
     $ dotify install
         create /Users/computer-user/.dotify
         create /Users/computer-user/.dotrc
-    Do you want to add .bash_history to Dotify? [Yn] n
-    Do you want to add .bashrc to Dotify? [Yn] y
-        create /Users/mattbridges/.dotify/.bashrc
+    Editing config file...
+    Do you want to link .bashrc to the home directory? [Yn] n
+        linked  /Users/computer-user/.bashrc
+    Do you want to link .dotrc to the home directory? [Yn] n
+        linked  /Users/computer-user/.dotrc
     Do you want to add .railsrc to Dotify? [Yn] n
-        create /Users/mattbridges/.dotify/.railsrc
+        linked  /Users/computer-user/.railsrc
     Do you want to add .zshrc to Dotify? [Yn] n
-        create /Users/mattbridges/.dotify/.zshrc
+        linked  /Users/computer-user/.zshrc
     ...
 
 This will first create a `.dotify` directory in your home directory as well as a `.dotrc` file for Dotify configuration (yes, it is more dotfiles, but this is a good thing!).
@@ -46,61 +48,32 @@ During the installation process, a Vim instance will open with a sample `.dotrc`
 
 Alternatively, you could run `dotify setup` to setup Dotify's configuration, followed by `dotify install` to add the initial files into Dotify.
 
-### 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
+### Link single files
 
-This is the heart of the Dotify tool. This command will link the files within the `~/.dotify` directory into your home directory.
+After you have setup Dotify, you can add files one by one if you did not add them during setup.
 
-    $ dotify link
-    Do you want to link .bash_profile to the home directory? [Yn] Y
-          linked  /Users/mattbridges/.bash_profile
-    Do you want to link .dotrc to the home directory? [Yn] n
-    Do you want to link .gitconfig to the home directory? [Yn] Y
-          linked  /Users/mattbridges/.gitconfig
-    ...
-
-You can also link files one-by-one by passing the filename to the `link` task.
+    $ dotify link .vimrc
+        linked  /Users/computer-user/.vimrc
 
-    $ dotify link .bashrc
-    Do you want to link ~/.bashrc? [Yn] Y
-          linked  /Users/mattbridges/.bashrc
+### Unlink the chains...
 
-### Unlink everything
-
-Don't want any of the dotfiles anymore? Well, I'm not one to question. Go ahead and wipe them out.
+Don't want any of the dotfiles anymore? Or want to drop one? Well, I'm not one to question. Go ahead and move them back into the home directory.
 
     $ dotify unlink
-    Do you want to unlink .bashrc from the home directory? [Yn] y
-          unlinked  /Users/computer-user/.bashrc
-    Do you want to unlink .dotrc from the home directory? [Yn] n
-    Do you want to unlink .gemrc from the home directory? [Yn] y
-          unlinked  /Users/computer-user/.gemrc
+    Do you want to unlink .bash_profile from the home directory? [Yn] Y
+        unlinked  /Users/computer-user/.bash_profile
+    Do you want to unlink .dotrc from the home directory? [Yn] Y
+        unlinked  /Users/computer-user/.dotrc
+    Do you want to unlink .gemrc from the home directory? [Yn]
     ...
 
-Should you run this horrid task accidentally, you can simply run `dotify link` again if you want to restore your previous settings.
+Should you run this task and decide to change your mind, you can simply run `dotify link` or `dotify link [FILE]` again if you want to restore your changes.
 
 By default, `unlink` loops through all of the Dotify files. You can also pass a filename to `unlink` to unlink a single file.
 
     $ dotify unlink .bashrc
     Are you sure you want to remove ~/.bashrc? [Yn] Y
-       remove /Users/mattbridges/.bashrc
+        unlinked  /Users/computer-user/.bashrc
 
 ## Versioning
 
@@ -149,36 +122,21 @@ The same can be done for the home directory when running `dotify setup`. There a
 
 More configuration options will likely be added in future versions, so be sure to check up here for your options.
 
-## Clarifying the add/remove/link/unlink tasks
-
-Here is a little clarification on the `add`/`remove`/`link`/`unlink` tasks.
-
-* `dotify add` adds one or more dotfiles in the users' home directory into Dotify.
-* `dotify remove` removes one or more linked dotfiles from Dotify and returns them to the home directory.
-* `dotify link` links one or more files added to Dotify into the home directory.
-* `dotify unlink` simply removes one or more home directory files that are linked into Dotify.
-
-For instructions on how to use these methods, use `dotify help [TASK]` for further explanation.
-
 ## 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 add {{FILENAME}}     # Add a one or more dotfiles to Dotify. (FILENAME is optional)
       dotify edit [FILE]          # Edit a dotify file
       dotify help [TASK]          # Describe available tasks or one specific task
       dotify install              # Install files from your home directory into Dotify
-      dotify link {{FILENAME}}    # Link up one or all of your dotfiles (FILENAME is optional)
-      dotify remove {{FILENAME}}  # Remove a single dotfile from Dotify (FILENAME is optional)
-      dotify save                 # Commit Dotify files and push to Github
+      dotify link [[FILENAME]]    # Link up one or all of your dotfiles (FILENAME is optional)
+      dotify save                 # Save Dotify files and push to Github.
       dotify setup                # Setup your system for Dotify to manage your dotfiles
-      dotify unlink {{FILENAME}}  # Unlink one or all of your dotfiles (FILENAME is optional)
+      dotify unlink [[FILENAME]]  # Unlink one or all of your dotfiles (FILENAME is optional)
       dotify version              # Check your Dotify version
 
-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.

data/dotify.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "multi_json"
   gem.add_dependency "json"
   gem.add_dependency "git"
+  gem.add_development_dependency "guard-rspec"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "webmock"
   gem.add_development_dependency "vcr"

data/lib/dotify.rb

@@ -1,8 +1,16 @@
-require 'dotify/config'
 require 'dotify/version'
-require "fileutils"
+require 'dotify/errors'
+
+require 'fileutils'
 
 module Dotify
+
+  autoload :Config,   'dotify/config'
+  autoload :Files,    'dotify/files'
+  autoload :List,     'dotify/list'
+  autoload :Unit,     'dotify/unit'
+  autoload :CLI,      'dotify/cli'
+
   def self.installed?
     Config.installed?
   end

data/lib/dotify/cli.rb

@@ -1,14 +1,10 @@
 require 'rubygems'
 require 'thor'
 require 'fileutils'
-require 'json'
 require 'git'
 require 'net/http'
 
 require 'dotify'
-require 'dotify/config'
-require 'dotify/files'
-require 'dotify/file_list'
 require 'dotify/version_checker'
 
 Dotify::Config.load_config!
@@ -35,9 +31,9 @@ module Dotify
 
     desc :save, "Save Dotify files and push to Github."
     method_option :message, :aliases => '-m', :type => :string, :required => false, :desc => "Git commit message to send to Github"
-    method_option :force,   :aliases => '-f', :type => :boolean, :desc => "Do not ask for confirmation when adding files to the staging area."
-    method_option :debug,   :aliases => '-d', :type => :boolean, :desc => "Show error messages if there is a Git failure."
-    method_option :verbose, :aliases => '-v', :type => :boolean, :default => true, :desc => "Show error messages if there is a Git failure."
+    method_option :force,   :aliases => '-f', :type => :boolean, :default => false, :desc => "Do not ask for confirmation when adding files to the staging area."
+    method_option :debug,   :aliases => '-d', :type => :boolean, :default => false, :desc => "Show error messages if there is a Git failure."
+    method_option :verbose, :aliases => '-v', :type => :boolean, :default => true,  :desc => "Display file creation and status updates."
     method_option :push,    :aliases => '-p', :type => :boolean, :default => false, :desc => "Force the push to the remote repository."
     def save
       if File.exists? Files.dotify('.git') # if the Dotify directory has been made a git repo
@@ -64,7 +60,7 @@ module Dotify
             repo.push
           rescue Exception => e
             say "There was a problem pushing to your remote repo.", :red
-            say("Grit Error: #{e.message}", :red) if options[:debug]
+            say("Git Error: #{e.message}", :red) if options[:debug]
             return
           end
           say "Successfully pushed!", :blue
@@ -76,25 +72,28 @@ module Dotify
 
     desc 'edit [FILE]', "Edit a dotify file"
     method_option :save, :aliases => '-s', :default => false, :type => :boolean, :require => true, :desc => "Save Dotify files and push to Github"
-    def edit(filename)
-      if Files.linked.include? Files.dotify(filename)
-        exec "#{Config.editor} #{Files.dotify(filename)}"
+    def edit(file)
+      file = Unit.new(file)
+      if file.linked?
+        exec "#{Config.editor} #{file.dotify}"
         save if options[:save] == true
       else
-        say "'#{Files.filename(filename)}' has not been linked by Dotify. Please run `dotify link #{Files.filename(filename)}` to edit this file.", :blue
+        say "'#{file}' has not been linked by Dotify. Please run `dotify link #{file}` to edit this file.", :blue
       end
     end
 
     desc :version, "Check your Dotify version"
     method_option :verbose, :aliases => '-v', :default => false, :type => :boolean, :desc => "Output any errors that occur during the Version check."
+    method_option :check, :aliases => '-c', :default => false, :type => :boolean, :desc => "Check Rubygems.org to see if your installed version of Dotify is out of date."
     def version
+      return say "Dotify Version: v#{Dotify.version}", :blue unless options[:check]
       if VersionChecker.out_of_date?
         say "Your version of Dotify is out of date.", :yellow
         say "  Your Version:   #{Dotify.version}", :blue
         say "  Latest Version: #{VersionChecker.version}", :blue
         say "I recommend that you uninstall Dotify completely before updating", :yellow
       else
-        say "Your version of Dotify is up to date: #{Dotify::VERSION}", :blue
+        say "Your version of Dotify is up to date: #{Dotify.version}", :blue
       end
     rescue Exception => e
       say "There was an error checking your Dotify version. Please try again.", :red
@@ -107,7 +106,7 @@ module Dotify
     method_options :verbose => true
     def setup
       # Warn if Dotify is already setup
-      if !Dotify.installed?
+      if Dotify.installed?
         say "Dotify is already setup", :blue
       end
 
@@ -122,7 +121,7 @@ module Dotify
       end
 
       say "Editing config file...", :blue
-      sleep 1 # Give a little time for reading the message
+      sleep 0.5 # Give a little time for reading the message
       invoke :edit, [Config.file]
       say "Config file updated.", :blue
 
@@ -133,145 +132,63 @@ module Dotify
     desc :install, "Install files from your home directory into Dotify"
     def install
       invoke :setup unless Dotify.installed?
-      invoke :add
+      invoke :link
     end
 
-    desc "add {{FILENAME}}", "Add a one or more dotfiles to Dotify. (FILENAME is optional)"
-    method_option :force, :type => :boolean, :default => false, :aliases => '-f', :desc => "Remove Dotify file(s) without confirmation"
-    def add(file=nil)
-      not_setup_warning unless Dotify.installed?
-      if file.nil?
-        Files.uninstalled { |path, file| add_dotify_file(file, options) }
-      else
-        add_dotify_file(file, options.merge(:single => true))
-      end
-    end
-
-    desc "remove {{FILENAME}}", "Remove a single dotfile from Dotify (FILENAME is optional)"
+    desc 'link [[FILENAME]]', "Link up one or all of your dotfiles (FILENAME is optional)"
     long_desc <<-DESC
-      This removes the dotfiles from the Dotify directory and move \
-      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.
+      This task takes a file from the home directory, \
+      moves it into Dotify, and symlinks the file in the \
+      home directory to the corresponding file in Dotify.
     DESC
-    method_option :force, :type => :boolean, :default => false, :aliases => '-f', :desc => "Remove Dotify file(s) without confirmation"
-    def remove(file=nil)
-      not_setup_warning unless Dotify.installed?
-      if file.nil?
-        Files.linked { |path, file| remove_dotify_file(file, options) }
-      else
-        remove_dotify_file(file, options)
-      end
-    end
-
-    desc 'link {{FILENAME}}', "Link up one or all of your dotfiles (FILENAME is optional)"
-    method_option :force, :default => false, :type => :boolean, :aliases => '-f', :desc => "Link dotfiles without confirmation"
-    def link(file=nil)
-      not_setup_warning unless Dotify.installed?
-      if file.nil?
-        Files.unlinked do |path, file|
-          link_file(file, options)
-        end
-      else
-        link_file(file, options)
-      end
+    method_option :force,   :default => false, :type => :boolean, :aliases => '-f', :desc => "Link dotfiles without confirmation"
+    method_option :relink,  :default => false, :type => :boolean, :aliases => '-r', :desc => "Relink files already in the"
+    def link(file = nil)
+      return not_setup_warning unless Dotify.installed?
+      # Link a single file
+      return link_file Unit.new(file), options unless file.nil?
+      # Relink the files
+      return Files.linked { |file| link_file(file, options) } if options[:relink]
+      # Link the files
+      Files.unlinked { |file| link_file(file, options) }
     end
 
-    desc 'unlink {{FILENAME}}', "Unlink one or all of your dotfiles (FILENAME is optional)"
+    desc 'unlink [[FILENAME]]', "Unlink one or all of your dotfiles (FILENAME is optional)"
     long_desc <<-DESC
-      This 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.
+      This task unlinks the dotfile from Dotify and \
+      moves it back into the home directory. This will \
+      only be run if the file is symlinked to the corresponsing \
+      file in Dotify.
     DESC
     method_option :force, :default => false, :type => :boolean, :aliases => '-f', :desc => 'Remove all installed dotfiles without confirmation'
     def unlink(file = nil)
-      not_setup_warning unless Dotify.installed?
-      if file.nil?
-        Files.linked do |path, file|
-          unlink_file(file, options)
-        end
-      else
-        unlink_file(file, options)
-      end
+      return not_setup_warning unless Dotify.installed?
+      # Unlink a single file
+      return unlink_file Unit.new(file), options unless file.nil?
+      # Unlink the files
+      Files.linked { |file| unlink_file(file, options) }
     end
 
     no_tasks do
 
       def not_setup_warning
-        say('Dotify has not been setup yet! You need to run \'dotify setup\' first.', :yellow)
+        say "Dotify has not been setup yet! You need to run 'dotify setup' first.", :yellow
       end
 
       def unlink_file(file, options = {})
-        file = Files.filename(file)
-        dot = Files.dotfile(file)
-        dotify = Files.dotify(file)
-        if File.exists?(dot) && File.exists?(dotify)
-          if options[:force] == true || yes?("Do you want to unlink #{file} from the home directory? [Yn]", :blue)
-            FileUtils.rm_rf dot
-            say_status :unlinked, dot
-          end
-        else
-          say "'#{file}' does not exist in Dotify.", :blue
+        say "'#{file}' does not exist in Dotify.", :blue unless file.linked?
+        if options[:force] == true || yes?("Do you want to unlink #{file} from the home directory? [Yn]", :blue)
+          file.unlink
+          say_status :unlinked, file.dotfile
         end
       end
 
       def link_file(file, options = {})
-        file = Files.filename(file)
-        home = Files.dotfile(file)
-        path = Files.dotify(file)
-        status = case
-                 when !File.exists?(home) then :linked
-                 when File.exists?(home) then :replaced; end
-        if File.exists?(path)
-          if options[:force] == true || yes?("Do you want to link #{file} to the home directory? [Yn]", :blue)
-            FileUtils.rm_rf(home, :verbose => false)
-            FileUtils.ln_s(path, home, :verbose => false)
-            say_status status, home
-          end
-        else
-          say "'#{file}' does not exist in the home directory.", :blue
-        end
-      end
-
-      def remove_dotify_file(file, options = {})
-        file = Files.filename(file)
-        home = Files.dotfile(file)
-        path = Files.dotify(file)
-        if File.exist?(home) && File.exist?(path)
-          if options[:force] == true || yes?("Do you want to remove #{file} from Dotify? [Yn]", :blue)
-            FileUtils.rm_rf(home, :verbose => false)
-            if File.directory? path
-              FileUtils.cp_r(path, home, :verbose => false)
-            else
-              FileUtils.cp(path, home, :verbose => false)
-            end
-            FileUtils.rm_rf(path, :verbose => false)
-            say_status :removed, path
-          end
-        elsif File.exist?(home) && !File.exist?(path)
-          say "The file '#{file}' is not managed by Dotify. Cannot remove.", :blue
-        else
-          say "The file '~/#{file}' does not exist", :blue
-        end
-      end
-
-      def add_dotify_file(file, options = {})
-        file = Files.filename(file)
-        home = Files.dotfile(file)
-        path = Files.dotify(file)
-        if File.exist?(home)
-          if options[:force] == true || yes?("Do you want to add #{file} to Dotify? [Yn]", :blue)
-            if File.directory? home
-              FileUtils.cp_r(home, path, :verbose => false)
-            else
-              FileUtils.cp(home, path, :verbose => false)
-              say_status :adding, path
-            end
-          end
-        else
-          if options[:single] == true
-            say "The file '#{file}' doesn't exist or Dotify already manages it.", :blue
-          end
+        return say_status :linked, file.dotfile if file.linked?
+        return say "'#{file}' does not exist in the home directory.", :blue unless file.in_home_dir?
+        if options[:force] == true || yes?("Do you want to link #{file} to the home directory? [Yn]", :blue)
+          file.link
+          say_status :linked, file.dotfile
         end
       end
 

data/lib/dotify/config.rb

@@ -9,7 +9,7 @@ module Dotify
     CONFIG_FILE = '.dotrc'
     EDITOR = 'vim'
     DEFAULT_IGNORE = {
-      :dotify => %w[.git .gitmodule],
+      :dotify => %w[.DS_Store .git .gitmodule],
       :dotfiles => %w[.DS_Store .Trash .dropbox .dotify]
     }
 
@@ -19,14 +19,18 @@ module Dotify
         @dirname ||= DIRNAME
       end
 
-      def installed?
-        File.directory?(File.join(home, dirname))
+      def home
+        Thor::Util.user_home
       end
 
       def path
         File.join(home, dirname)
       end
 
+      def installed?
+        File.exists?(path) && File.directory?(path)
+      end
+
       def editor
         config.fetch(:editor, 'vim')
       end
@@ -44,10 +48,6 @@ module Dotify
         @config || load_config!
       end
 
-      def home
-        Thor::Util.user_home
-      end
-
       def file
         File.join(home, CONFIG_FILE)
       end