homesick 1.1.5 → 2.0.0

data/homesick.gemspec

@@ -1,105 +1,34 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: homesick 1.1.5 ruby lib
+# frozen_string_literal: true
+
+require_relative 'lib/homesick/version'
 
 Gem::Specification.new do |s|
-  s.name = "homesick".freeze
-  s.version = "1.1.5"
+  s.name        = 'homesick'
+  s.version     = Homesick::Version::STRING
+  s.authors     = ['Joshua Nichols', 'Yusuke Murata']
+  s.email       = ['josh@technicalpickles.com', 'info@muratayusuke.com']
+  s.homepage    = 'http://github.com/technicalpickles/homesick'
+  s.summary     = "Your home directory is your castle. Don't leave your dotfiles behind."
+  s.description = 'Homesick is sorta like rip, but for dotfiles. It uses git to clone a ' \
+                  'repository containing dotfiles, and saves them in ~/.homesick. It then ' \
+                  'allows you to symlink all the dotfiles into place with a single command.'
+  s.license     = 'MIT'
+  s.metadata    = { 'rubygems_mfa_required' => 'true' }
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib".freeze]
-  s.authors = ["Joshua Nichols".freeze, "Yusuke Murata".freeze]
-  s.date = "2017-03-23"
-  s.description = "\n    Your home directory is your castle. Don't leave your dotfiles behind.\n    \n\n    Homesick is sorta like rip, but for dotfiles. It uses git to clone a repository containing dotfiles, and saves them in ~/.homesick. It then allows you to symlink all the dotfiles into place with a single command. \n\n  ".freeze
-  s.email = ["josh@technicalpickles.com".freeze, "info@muratayusuke.com".freeze]
-  s.executables = ["homesick".freeze]
-  s.extra_rdoc_files = [
-    "ChangeLog.markdown",
-    "LICENSE",
-    "README.markdown"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    ".rubocop.yml",
-    ".travis.yml",
-    "ChangeLog.markdown",
-    "Gemfile",
-    "Guardfile",
-    "LICENSE",
-    "README.markdown",
-    "Rakefile",
-    "bin/homesick",
-    "homesick.gemspec",
-    "lib/homesick.rb",
-    "lib/homesick/actions/file_actions.rb",
-    "lib/homesick/actions/git_actions.rb",
-    "lib/homesick/cli.rb",
-    "lib/homesick/utils.rb",
-    "lib/homesick/version.rb",
-    "spec/homesick_cli_spec.rb",
-    "spec/spec.opts",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/technicalpickles/homesick".freeze
-  s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.6.11".freeze
-  s.summary = "Your home directory is your castle. Don't leave your dotfiles behind.".freeze
+  s.required_ruby_version = '>= 3.2'
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = ['homesick']
+  s.require_paths = ['lib']
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<thor>.freeze, [">= 0.14.0"])
-      s.add_development_dependency(%q<capture-output>.freeze, ["~> 1.0.0"])
-      s.add_development_dependency(%q<coveralls>.freeze, [">= 0"])
-      s.add_development_dependency(%q<guard>.freeze, [">= 0"])
-      s.add_development_dependency(%q<guard-rspec>.freeze, [">= 0"])
-      s.add_development_dependency(%q<jeweler>.freeze, [">= 1.6.2"])
-      s.add_development_dependency(%q<rake>.freeze, [">= 0.8.7"])
-      s.add_development_dependency(%q<rb-readline>.freeze, ["~> 0.5.0"])
-      s.add_development_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
-      s.add_development_dependency(%q<rubocop>.freeze, [">= 0"])
-      s.add_development_dependency(%q<test_construct>.freeze, [">= 0"])
-      s.add_development_dependency(%q<libnotify>.freeze, [">= 0"])
-      s.add_development_dependency(%q<terminal-notifier-guard>.freeze, ["~> 1.7.0"])
-      s.add_development_dependency(%q<listen>.freeze, ["< 3"])
-      s.add_development_dependency(%q<rack>.freeze, ["< 2"])
-    else
-      s.add_dependency(%q<thor>.freeze, [">= 0.14.0"])
-      s.add_dependency(%q<capture-output>.freeze, ["~> 1.0.0"])
-      s.add_dependency(%q<coveralls>.freeze, [">= 0"])
-      s.add_dependency(%q<guard>.freeze, [">= 0"])
-      s.add_dependency(%q<guard-rspec>.freeze, [">= 0"])
-      s.add_dependency(%q<jeweler>.freeze, [">= 1.6.2"])
-      s.add_dependency(%q<rake>.freeze, [">= 0.8.7"])
-      s.add_dependency(%q<rb-readline>.freeze, ["~> 0.5.0"])
-      s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
-      s.add_dependency(%q<rubocop>.freeze, [">= 0"])
-      s.add_dependency(%q<test_construct>.freeze, [">= 0"])
-      s.add_dependency(%q<libnotify>.freeze, [">= 0"])
-      s.add_dependency(%q<terminal-notifier-guard>.freeze, ["~> 1.7.0"])
-      s.add_dependency(%q<listen>.freeze, ["< 3"])
-      s.add_dependency(%q<rack>.freeze, ["< 2"])
-    end
-  else
-    s.add_dependency(%q<thor>.freeze, [">= 0.14.0"])
-    s.add_dependency(%q<capture-output>.freeze, ["~> 1.0.0"])
-    s.add_dependency(%q<coveralls>.freeze, [">= 0"])
-    s.add_dependency(%q<guard>.freeze, [">= 0"])
-    s.add_dependency(%q<guard-rspec>.freeze, [">= 0"])
-    s.add_dependency(%q<jeweler>.freeze, [">= 1.6.2"])
-    s.add_dependency(%q<rake>.freeze, [">= 0.8.7"])
-    s.add_dependency(%q<rb-readline>.freeze, ["~> 0.5.0"])
-    s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
-    s.add_dependency(%q<rubocop>.freeze, [">= 0"])
-    s.add_dependency(%q<test_construct>.freeze, [">= 0"])
-    s.add_dependency(%q<libnotify>.freeze, [">= 0"])
-    s.add_dependency(%q<terminal-notifier-guard>.freeze, ["~> 1.7.0"])
-    s.add_dependency(%q<listen>.freeze, ["< 3"])
-    s.add_dependency(%q<rack>.freeze, ["< 2"])
-  end
-end
+  s.add_dependency 'thor', '~> 1.0'
 
+  s.add_development_dependency 'bundler-audit', '~> 0.9'
+  s.add_development_dependency 'capture-output', '~> 1.0'
+  s.add_development_dependency 'mutant-rspec'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-rake'
+  s.add_development_dependency 'test_construct'
+end

data/lib/homesick/actions/file_actions.rb

@@ -1,18 +1,17 @@
-# -*- encoding : utf-8 -*-
+# frozen_string_literal: true
+
 module Homesick
   module Actions
     # File-related helper methods for Homesick
     module FileActions
+      protected
+
       def mv(source, destination)
         source = Pathname.new(source)
         destination = Pathname.new(destination + source.basename)
-        case
-        when destination.exist? && (options[:force] || shell.file_collision(destination) { source })
-          say_status :conflict, "#{destination} exists", :red
-          FileUtils.mv source, destination unless options[:pretend]
-        else
-          FileUtils.mv source, destination unless options[:pretend]
-        end
+        collision = destination.exist? && (options[:force] || shell.file_collision(destination) { source })
+        say_status :conflict, "#{destination} exists", :red if collision
+        FileUtils.mv source, destination unless options[:pretend]
       end
 
       def rm_rf(dir)
@@ -24,7 +23,7 @@ module Homesick
         target = Pathname.new(target)
 
         if target.symlink?
-          say_status :unlink, "#{target.expand_path}", :green
+          say_status :unlink, target.expand_path.to_s, :green
           FileUtils.rm_rf target
         else
           say_status :conflict, "#{target} is not a symlink", :red
@@ -42,45 +41,40 @@ module Homesick
       end
 
       def ln_s(source, destination)
-        source = Pathname.new(source).realpath        
+        source = Pathname.new(source).realpath
         destination = Pathname.new(destination)
         FileUtils.mkdir_p destination.dirname
 
-        action = if destination.symlink? && destination.readlink == source
-                   :identical
-                 elsif destination.symlink?
-                   :symlink_conflict
-                 elsif destination.exist?
-                   :conflict
-                 else
-                   :success
-                 end
+        action = :success
+        action = :identical if destination.symlink? && destination.readlink == source
+        action = :symlink_conflict if destination.symlink?
+        action = :conflict if destination.exist?
 
         handle_symlink_action action, source, destination
       end
 
       def handle_symlink_action(action, source, destination)
-        case action
-        when :identical
+        if action == :identical
           say_status :identical, destination.expand_path, :blue
-        when :symlink_conflict, :conflict
-          if action == :conflict
-            say_status :conflict, "#{destination} exists", :red
-          else
-            say_status :conflict,
-                      "#{destination} exists and points to #{destination.readlink}",
-                      :red
-          end
-          if collision_accepted?(destination, source)
-            FileUtils.rm_r destination, force: true unless options[:pretend]
-            FileUtils.ln_s source, destination, force: true unless options[:pretend]
-          end
+          return
+        end
+        message = generate_symlink_message action, source, destination
+        if %i[symlink_conflict conflict].include?(action)
+          say_status :conflict, message, :red
+          return unless collision_accepted?(destination, source)
+
+          FileUtils.rm_r destination, force: true unless options[:pretend]
         else
-          say_status :symlink,
-                     "#{source.expand_path} to #{destination.expand_path}",
-                     :green
-          FileUtils.ln_s source, destination unless options[:pretend]
+          say_status :symlink, message, :green
         end
+        FileUtils.ln_s source, destination, force: true unless options[:pretend]
+      end
+
+      def generate_symlink_message(action, source, destination)
+        message = "#{source.expand_path} to #{destination.expand_path}"
+        message = "#{destination} exists and points to #{destination.readlink}" if action == :symlink_conflict
+        message = "#{destination} exists" if action == :conflict
+        message
       end
     end
   end

data/lib/homesick/actions/git_actions.rb

@@ -1,4 +1,5 @@
-# -*- encoding : utf-8 -*-
+# frozen_string_literal: true
+
 module Homesick
   module Actions
     # Git-related helper methods for Homesick
@@ -8,35 +9,37 @@ module Homesick
         major: 1,
         minor: 8,
         patch: 0
-      }
+      }.freeze
       STRING = MIN_VERSION.values.join('.')
 
       def git_version_correct?
         info = `git --version`.scan(/(\d+)\.(\d+)\.(\d+)/).flatten.map(&:to_i)
         return false unless info.count == 3
-        current_version = Hash[[:major, :minor, :patch].zip(info)]
-        return true if current_version.eql?(MIN_VERSION)
-        return true if current_version[:major] > MIN_VERSION[:major]
-        return true if current_version[:major] == MIN_VERSION[:major] && current_version[:minor] > MIN_VERSION[:minor]
-        return true if current_version[:major] == MIN_VERSION[:major] && current_version[:minor] == MIN_VERSION[:minor] && current_version[:patch] >= MIN_VERSION[:patch]
-        false
+
+        current_version = %i[major minor patch].zip(info).to_h
+        major_equals = current_version.eql?(MIN_VERSION)
+        major_greater = current_version[:major] > MIN_VERSION[:major]
+        minor_greater = current_version[:major] == MIN_VERSION[:major] &&
+                        current_version[:minor] > MIN_VERSION[:minor]
+        patch_greater = current_version[:major] == MIN_VERSION[:major] &&
+                        current_version[:minor] == MIN_VERSION[:minor] &&
+                        current_version[:patch] >= MIN_VERSION[:patch]
+
+        major_equals || major_greater || minor_greater || patch_greater
       end
 
-      # TODO: move this to be more like thor's template, empty_directory, etc
       def git_clone(repo, config = {})
-        config ||= {}
         destination = config[:destination] || File.basename(repo, '.git')
-
         destination = Pathname.new(destination) unless destination.is_a?(Pathname)
         FileUtils.mkdir_p destination.dirname
 
         if destination.directory?
           say_status :exist, destination.expand_path, :blue
         else
-          say_status 'git clone',
-                     "#{repo} to #{destination.expand_path}",
-                     :green
-          system "git clone -q --config push.default=upstream --recursive #{repo} #{destination}"
+          say_status 'git clone', "#{repo} to #{destination.expand_path}", :green
+          unless options[:pretend]
+            system "git clone -q --config push.default=upstream --recursive #{repo} #{destination}"
+          end
         end
       end
 

data/lib/homesick/cli.rb

@@ -1,4 +1,6 @@
-# -*- encoding : utf-8 -*-
+# frozen_string_literal: true
+
+require 'fileutils'
 require 'thor'
 
 module Homesick
@@ -12,6 +14,10 @@ module Homesick
 
     add_runtime_options!
 
+    def self.exit_on_failure?
+      true
+    end
+
     map '-v' => :version
     map '--version' => :version
     # Retain a mapped version of the symlink command for compatibility.
@@ -21,45 +27,20 @@ module Homesick
       super
       # Check if git is installed
       unless git_version_correct?
-        say_status :error, "Git version >= #{Homesick::Actions::GitActions::STRING} must be installed to use Homesick", :red
+        say_status :error,
+                   "Git version >= #{Homesick::Actions::GitActions::STRING} must be installed to use Homesick",
+                   :red
         exit(1)
       end
-      # Hack in support for diffing symlinks
-      # Also adds support for checking if destination or content is a directory
-      shell_metaclass = class << shell; self; end
-      shell_metaclass.send(:define_method, :show_diff) do |destination, content|
-        destination = Pathname.new(destination)
-        content = Pathname.new(content)
-        return 'Unable to create diff: destination or content is a directory' if destination.directory? || content.directory?
-        return super(destination, content) unless destination.symlink?
-        say "- #{destination.readlink}", :red, true
-        say "+ #{content.expand_path}", :green, true
-      end
+      configure_symlinks_diff
     end
 
     desc 'clone URI CASTLE_NAME', 'Clone +uri+ as a castle with name CASTLE_NAME for homesick'
-    def clone(uri, destination=nil)
+    def clone(uri, destination = nil)
       destination = Pathname.new(destination) unless destination.nil?
 
       inside repos_dir do
-        if File.exist?(uri)
-          uri = Pathname.new(uri).expand_path
-          fail "Castle already cloned to #{uri}" if uri.to_s.start_with?(repos_dir.to_s)
-
-          destination = uri.basename if destination.nil?
-
-          ln_s uri, destination
-        elsif uri =~ GITHUB_NAME_REPO_PATTERN
-          destination = Pathname.new(uri).basename if destination.nil?
-          git_clone "https://github.com/#{Regexp.last_match[1]}.git",
-                    destination: destination
-        elsif uri =~ /%r([^%r]*?)(\.git)?\Z/ || uri =~ /[^:]+:([^:]+)(\.git)?\Z/
-          destination = Pathname.new(Regexp.last_match[1].gsub(/\.git$/, '')).basename if destination.nil?
-          git_clone uri, destination: destination
-        else
-          fail "Unknown URI format: #{uri}"
-        end
-
+        destination = clone_from_uri(uri, destination)
         setup_castle(destination)
       end
     end
@@ -74,11 +55,19 @@ module Homesick
         destination = Pathname.new(name)
         homesickrc = destination.join('.homesickrc').expand_path
         return unless homesickrc.exist?
-        proceed = options[:force] || shell.yes?("#{name} has a .homesickrc. Proceed with evaling it? (This could be destructive)")
-        return say_status 'eval skip', "not evaling #{homesickrc}, #{destination} may need manual configuration", :blue unless proceed
+
+        proceed = options[:force] ||
+                  shell.yes?("#{name} has a .homesickrc. Proceed with evaling it? (This could be destructive)")
+        unless proceed
+          return say_status 'eval skip',
+                            "not evaling #{homesickrc}, #{destination} may need manual configuration",
+                            :blue
+        end
+
         say_status 'eval', homesickrc
         inside destination do
-          eval homesickrc.read, binding, homesickrc.expand_path.to_s
+          ctx = Homesick::RC::Context.new(destination.expand_path)
+          ctx.instance_eval(homesickrc.read, homesickrc.expand_path.to_s)
         end
       end
     end
@@ -92,7 +81,7 @@ module Homesick
     def pull(name = DEFAULT_CASTLE_NAME)
       if options[:all]
         inside_each_castle do |castle|
-          say castle.to_s.gsub(repos_dir.to_s + '/', '') + ':'
+          say "#{castle.to_s.gsub("#{repos_dir}/", '')}:"
           update_castle castle
         end
       else
@@ -135,11 +124,12 @@ module Homesick
     def link(name = DEFAULT_CASTLE_NAME)
       check_castle_existance(name, 'symlink')
 
-      inside castle_dir(name) do
+      castle_path = castle_dir(name)
+      inside castle_path do
         subdirs = subdirs(name)
 
         # link files
-        symlink_each(name, castle_dir(name), subdirs)
+        symlink_each(name, castle_path, subdirs)
 
         # link files in subdirs
         subdirs.each do |subdir|
@@ -159,22 +149,9 @@ module Homesick
       castle_path = Pathname.new(castle_dir(castle)).join(relative_dir)
       FileUtils.mkdir_p castle_path
 
-      # Are we already tracking this or anything inside it?
       target = Pathname.new(castle_path.join(file.basename))
       if target.exist?
-        if absolute_path.directory?
-          move_dir_contents(target, absolute_path)
-          absolute_path.rmtree
-          subdir_remove(castle, relative_dir + file.basename)
-
-        elsif more_recent? absolute_path, target
-          target.delete
-          mv absolute_path, castle_path
-        else
-          say_status(:track,
-                     "#{target} already exists, and is more recent than #{file}. Run 'homesick SYMLINK CASTLE' to create symlinks.",
-                     :blue)
-        end
+        handle_existing_track_target(castle, absolute_path, castle_path, relative_dir, file, target)
       else
         mv absolute_path, castle_path
       end
@@ -189,7 +166,6 @@ module Homesick
         git_add absolute_path
       end
 
-      # are we tracking something nested? Add the parent dir to the manifest
       subdir_add(castle, relative_dir) unless relative_dir.eql?(Pathname.new('.'))
     end
 
@@ -261,14 +237,14 @@ module Homesick
                  "Opening a new shell in castle '#{castle}'. To return to the original one exit from the new shell.",
                  :green
       inside castle_dir do
-        system(ENV['SHELL'])
+        system(ENV.fetch('SHELL', nil))
       end
     end
 
     desc 'open CASTLE',
          'Open your default editor in the root of the given castle'
     def open(castle = DEFAULT_CASTLE_NAME)
-      unless ENV['EDITOR']
+      unless ENV.fetch('EDITOR', nil)
         say_status :error,
                    'The $EDITOR environment variable must be set to use this command',
                    :red
@@ -277,11 +253,11 @@ module Homesick
       end
       check_castle_existance castle, 'open'
       castle_dir = repos_dir.join(castle)
-      say_status "#{castle_dir.realpath}: #{ENV['EDITOR']} .",
-                 "Opening the root directory of castle '#{castle}' in editor '#{ENV['EDITOR']}'.",
+      say_status "#{castle_dir.realpath}: #{ENV.fetch('EDITOR', nil)} .",
+                 "Opening the root directory of castle '#{castle}' in editor '#{ENV.fetch('EDITOR', nil)}'.",
                  :green
       inside castle_dir do
-        system("#{ENV['EDITOR']} .")
+        system("#{ENV.fetch('EDITOR', nil)} .")
       end
     end
 
@@ -289,15 +265,16 @@ module Homesick
          'Execute a single shell command inside the root of a castle'
     def exec(castle, *args)
       check_castle_existance castle, 'exec'
-      unless args.count > 0
+      unless args.any?
         say_status :error,
                    'You must pass a shell command to execute',
                    :red
         exit(1)
       end
       full_command = args.join(' ')
+      action = options[:pretend] ? 'Would execute' : 'Executing command'
       say_status "exec '#{full_command}'",
-                 "#{options[:pretend] ? 'Would execute' : 'Executing command'} '#{full_command}' in castle '#{castle}'",
+                 "#{action} '#{full_command}' in castle '#{castle}'",
                  :green
       inside repos_dir.join(castle) do
         system(full_command)
@@ -307,7 +284,7 @@ module Homesick
     desc 'exec_all COMMAND',
          'Execute a single shell command inside the root of every cloned castle'
     def exec_all(*args)
-      unless args.count > 0
+      unless args.any?
         say_status :error,
                    'You must pass a shell command to execute',
                    :red
@@ -315,8 +292,9 @@ module Homesick
       end
       full_command = args.join(' ')
       inside_each_castle do |castle|
+        action = options[:pretend] ? 'Would execute' : 'Executing command'
         say_status "exec '#{full_command}'",
-                   "#{options[:pretend] ? 'Would execute' : 'Executing command'} '#{full_command}' in castle '#{castle}'",
+                   "#{action} '#{full_command}' in castle '#{castle}'",
                    :green
         system(full_command)
       end

data/lib/homesick/rc.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Homesick
+  module RC
+    # Evaluation context for .homesickrc scripts.
+    #
+    # Runs castle setup scripts in a clean object rather than in the
+    # Homesick::CLI binding, so scripts cannot access CLI internals.
+    # Standard Ruby library methods (File, Dir, system, etc.) remain
+    # available to scripts.
+    class Context
+      # @param castle_path [Pathname, String] absolute path to the castle root
+      def initialize(castle_path)
+        @castle_path = Pathname.new(castle_path)
+      end
+
+      # The absolute path of the castle being configured.
+      attr_reader :castle_path
+
+      # Execute a shell command.
+      # @param command [String]
+      # @return [Boolean] true if the command succeeded
+      def run(command)
+        system(command)
+      end
+    end
+  end
+end