dotify 0.2.0 → 0.3.0

data/README.md

@@ -4,6 +4,16 @@
 
 Dotify is a simple CLI tool to make managing dotfiles on your system easy. When developing on a Linux/Unix basic system, keeping track of all of those dotfiles in the home directory can be pain. Some developers do not even bother managing them and many have come up with their own static or even dynamic way of managing them. This is a need in the community, and this tool makes managing these crazy files a breeze.
 
+## Ruby Version Support
+
+As this is a gem for use on your local system, I understand there are still many Ruby developers still stuck with using Ruby 1.8. As such, Dotify supports the following Ruby versions definitively:
+
+* 1.8.7
+* 1.9.2
+* 1.9.3
+* JRuby
+* Rubinius
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,19 +32,57 @@ Or install it yourself as:
 
 As dotify is a CLI tool, everything is done in the command line. Here are the current available methods for managing dotfiles.
 
-### Setup Dotify
+### Preparing your system for Dotify
 
 To setup Dotify, you must first run `dotify setup` in your terminal.
 
     $ dotify setup
         create /Users/computer-user/.dotify
-    Do you want to add .bachrc to Dotify? [Yn] n
-    Do you want to add .gitconfig to Dotify? [Yn] y
-    ...
+        create /Users/computer-user/.dotrc
+
+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!).
+
+In order to install files from the home directory into Dotify, you must run the `install` task.
+
+### The .dotrc file
+
+The `.dotrc` file in your home directory serves as the configuration file for Dotify.
+
+#### Ignoring files
+
+When you are linking files in your Dotify directory, some files you do not want ever want to link (`.git`, `.gitmodules`, `.gitignore`, .etc) because they are used specifically for that directory (such as git versioning). You can configure Dotify to ignore these files when calling `dotify link` in the `.dotrc` in this way:
+
+    $ cat ~/.dotrc
+    ignore:
+      dotify:
+      - '.git'
+      - '.gitmodules'
+      - '.gitignore'
 
-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.
+The same can be done for the home directory when running `dotify setup`. There are some directories that you should not move around (`.dropbox`, `.rbenv`, `.rvm`) and do not want to accidentally attempt to move. You can do that in your `.dotrc` file as well:
 
-**This will *not* link up the dotfiles. This command simply copies the files over for you without having to go searching for them manually.**
+    $ cat ~/.dotrc
+    ignore:
+      dotfiles:
+      - '.dropbox'
+      - '.rbenv'
+      - '.rvm'
+
+More configuration options will likely be added in future versions, so be sure to check up here for your options.
+
+### Install Dotify
+
+Now that you have configured Dotify to your liking, you should now run `dotify install`.
+
+    $ dotify install
+    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
+    Do you want to add .railsrc to Dotify? [Yn] n
+        create /Users/mattbridges/.dotify/.railsrc
+    Do you want to add .zshrc to Dotify? [Yn] n
+        create /Users/mattbridges/.dotify/.zshrc
+    ...
 
 ### Add single files
 
@@ -68,20 +116,32 @@ This is the heart of the Dotify tool. This command will link the files within th
     Do you want to link ~/.gitignore? [Yn] Y
     ...
 
+You can also link files one-by-one by passing the filename to the `link` task.
+
+    $ dotify link .bashrc
+    Do you want to link ~/.bashrc? [Yn] Y
+       create /Users/computer-user/.bashrc
+
 ### Unlink everything
 
 Don't want any of the dotfiles anymore? Well, I'm not one to question. Go ahead and wipe them out.
 
     $ dotify unlink
     Are you sure you want to remove ~/.bashrc? [Yn] Y
-          remove  /Users/computer-user/.bashrc
+       remove  /Users/computer-user/.bashrc
     Are you sure you want to remove ~/.gemrc? [Yn] Y
-          remove  /Users/computer-user/.gemrc
+       remove  /Users/computer-user/.gemrc
     Are you sure you want to remove ~/.gitconfig? [Yn] n
     ...
 
 Should you run this horrid task accidentally, you can simply run `dotify link` again if you want to restore your previous settings.
 
+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
+
 ## Confused?
 
 Dotify can manages dotfiles from two different directions:

data/dotify.gemspec

@@ -16,5 +16,8 @@ Gem::Specification.new do |gem|
   gem.version       = Dotify::VERSION
 
   gem.add_dependency "thor"
+  gem.add_dependency "json"
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "vcr"
 end

data/lib/dotify.rb

@@ -1,4 +1,9 @@
-module Dotify
-end
 require 'bundler/setup'
+require 'dotify/config'
 require "fileutils"
+
+module Dotify
+  def self.installed?
+    Config.installed?
+  end
+end

data/lib/dotify/cli.rb

@@ -1,8 +1,13 @@
 require 'thor'
+require 'fileutils'
+require 'json'
+require 'net/http'
+
 require 'dotify'
 require 'dotify/config'
 require 'dotify/files'
-require 'fileutils'
+require 'dotify/file_list'
+require 'dotify/version_checker'
 
 Dotify::Config.load_config!
 
@@ -11,52 +16,61 @@ module Dotify
     include Thor::Actions
     default_task :help
 
-    map "-l" => :link
-    map "-u" => :unlink
+    map %w[-v --version] => :version
     map "-s" => :setup
     map "-a" => :add
     map "-r" => :remove
+    map "-l" => :link
+    map "-u" => :unlink
 
     def self.source_root
-      Config.home
+      File.expand_path("../../../templates", __FILE__)
+    end
+
+    desc :version, "Check your Dotify version"
+    def version
+      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
+      end
+    rescue Exception
+      say "There was an error checking your Dotify version. Please try again.", :red
     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"
+    method_option :install, :default => false, :type => :boolean, :aliases => '-i', :desc => "Run Dotify install right away. This does not allow for customizing your .dotrc file before attempting install files into Dotify."
+    method_option :verbose, :default => true, :type => :boolean, :aliases => '-v', :desc => "Setup Dotify with verbose output."
     def setup
-      empty_directory(Config.path) unless File.directory?(Config.path)
-      Files.unlinked do |path, file|
-        add(file) unless Config.dirname == file
+      return say('Dotify has already been setup!', :blue) if Dotify.installed?
+      empty_directory(Config.path, :verbose => options[:verbose])
+      dotrc = File.join(Config.home, Config::DOTIFY_CONFIG)
+      template Config::DOTIFY_CONFIG, dotrc, :verbose => options[:verbose]
+      invoke :install if options[:install] == true
+    end
+
+    desc :install, "Install files from your home directory into Dotify"
+    method_option :link, :default => false, :type => :boolean, :aliases => '-l', :desc => "Link dotfiles when setup is complete"
+    def install
+      invoke :setup unless Dotify.installed?
+      Files.uninstalled do |path, file|
+        add_file(file, options.merge(:quiet => true)) 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]
+        invoke :link, nil, { :all => true }
       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
+      return not_setup_warning unless Dotify.installed?
+      add_file(file, options)
     end
 
     desc "remove [FILENAME]", "Remove a single dotfile from Dotify"
@@ -69,60 +83,106 @@ module Dotify
     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)
+      return not_setup_warning unless Dotify.installed?
       if !File.exists?(Files.dotify(file))
-        say "Dotify is not currently managing ~/#{file}.", :blue unless options.quiet?
+        say "Dotify is not currently managing ~/#{file}.", :blue unless options[:quiet] == true
         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?
+        say_status :removed, Files.dotify(file) unless options[:quiet] == true
       end
     end
 
-    desc :link, "Link up all of your dotfiles"
+    desc 'link {{FILENAME}}', "Link up one or all of your dotfiles (FILENAME is optional)"
     method_option :all, :default => false, :type => :boolean, :aliases => '-a', :desc => "Link dotfiles without confirmation"
-    def link
-      count = 0
-      Files.dots do |file, dot|
-        if options[:all]
-          if File.exists? Files.dotfile(file)
-            replace_link Files.dotfile(file), file
-          else
-            create_link Files.dotfile(file), file
-          end
-          count += 1
-        else
-          if yes?("Do you want to link ~/#{dot}? [Yn]", :yellow)
-            create_link Files.dotfile(file), file
-            count += 1
-          end
+    def link(file=nil)
+      return not_setup_warning unless Dotify.installed?
+      if file.nil?
+        count = 0
+        Files.dots do |file, dot|
+          count += 1 if link_file(file, dot, options) == true
         end
+        say "No files were linked.", :blue if count == 0
+      else
+        link_file(file, Files.filename(file), options)
       end
-      say "No files were linked.", :blue if count == 0
     end
 
-    desc :unlink, "Unlink all of your dotfiles"
+    desc 'unlink {{FILENAME}}', "Unlink one or all of your dotfiles (FILENAME is optional)"
     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]", :yellow)
-          remove_file Files.dotfile(file)
-          count += 1
+    def unlink(file = nil)
+      return not_setup_warning unless Dotify.installed?
+      if file.nil?
+        count = 0
+        Files.installed do |file, dot|
+          if options[:all] || yes?("Are you sure you want to remove ~/#{dot}? [Yn]", :yellow)
+            unlink_file(file)
+            count += 1
+          end
         end
+        say "No files were unlinked.", :blue if count == 0
+      else
+        unlink_file(file)
       end
-      say "No files were unlinked.", :blue if count == 0
     end
 
     no_tasks do
 
+      def not_setup_warning
+        say('Dotify has not been setup yet! You need to run \'dotify setup\' first.', :yellow)
+      end
+
+      def unlink_file(file)
+        remove_file Files.dotfile(file)
+        return true
+      end
+
+      def link_file(file, dot, options = {})
+        if options[:all]
+          if File.exists? Files.dotfile(file)
+            replace_link Files.dotfile(file), file
+          else
+            create_link Files.dotfile(file), file
+          end
+          return true
+        else
+          if yes?("Do you want to link ~/#{dot}? [Yn]", :yellow)
+            create_link Files.dotfile(file), file
+            return true
+          end
+          return false
+        end
+        return false
+      end
+
+      def add_file(file, options = {})
+        file = Files.filename(file)
+        dotfile = Files.dotfile(file)
+        dotify_file = Files.dotify(file)
+
+        if !File.exist?(dotfile) || !File.identical?(dotfile, dotify_file)
+          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
+        else
+          say "'#{file}' does not exist or is already installed in Dotify.", :blue unless options[:quiet] == true
+        end
+      end
+
       def replace_link(dotfile, file)
         remove_file dotfile, :verbose => false
         create_link dotfile, file, :verbose => false

data/lib/dotify/config.rb

@@ -6,61 +6,29 @@ module Dotify
   class Config
 
     DOTIFY_DIRNAME = '.dotify'
-    DOTIFY_BACKUP = '.backup'
-    #SHELLS = {
-    #  'zsh' => '/bin/zsh',
-    #  'bash' => '/bin/bash',
-    #  'sh' => '/bin/sh'
-    #}
+    DOTIFY_CONFIG = '.dotrc'
 
     class << self
 
-      #def shell=(shell)
-      #  if !SHELLS.keys.include?(shell)
-      #    raise NonValidShell, "You must specify a valid shell: #{SHELLS.keys.map(&:inspect).join(", ")}"
-      #  end
-      #  @shell = shell
-      #end
-
-      #def shell
-      #  @shell
-      #end
-
-      #def profile=(name)
-      #  @profile = name
-      #end
-
-      #def profile
-      #  @profile
-      #end
-
       def dirname
         @dirname ||= DOTIFY_DIRNAME
       end
 
-      def path
-        File.join(home, dirname)
+      def installed?
+        File.directory?(File.join(home, dirname))
       end
 
-      def backup
-        File.join(path, backup_dirname)
+      def path
+        File.join(home, dirname)
       end
 
-      def backup_dirname
-        @backup ||= DOTIFY_BACKUP
+      def load_config!
+        config = File.exists?(config_file) ? (YAML.load_file(config_file) || {}) : {}
+        symbolize_keys!(config)
       end
 
-      def load_config!
-        #@config = File.exists?(config_file) ? (YAML.load_file(config_file) || {}) : {}
-        #symbolize_keys!(@config)
-        #@config.each do |key, value|
-        #  if !value.nil? && methods(false).map(&:to_s).include?("#{key}=")
-        #    self.__send__("#{key}=", value)
-        #  else
-        #    @config.delete(key)
-        #  end
-        #end
-        #@config
+      def ignore(what)
+        config.fetch(:ignore, {}).fetch(what, [])
       end
 
       def config
@@ -74,7 +42,7 @@ module Dotify
       private
 
         def config_file
-          #File.join(home, '.dotrc')
+          File.join(home, DOTIFY_CONFIG)
         end
 
         def symbolize_keys!(opts)