dotfiler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 448eb71751e98c9d2495abeafd02e88eddcd1d06
+  data.tar.gz: cfc6c4ee8ba52e8608fd6b30963fe4152fecceb1
+SHA512:
+  metadata.gz: e10921ffd3f69aa7a9f8142e899ad8f6703197ff30c43dc0708e496bc6b1947bdf204da927721a54cc720b4638a972f8d0e04044041df40616922678bb8514a1
+  data.tar.gz: 9bf9de86945ec7329618fafcaae297ad5ea22dcdc81f28766a3d390c49a6151cfcc97ccb66757bd0cfb202db19968be4fc3afa8f23b2a2c3bd9cd7b4da7f825a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Aleksandar Radunovic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,302 @@
+# Dotfiler
+
+Dotfiler is a CLI gem for managing dotfiles.
+
+## Contents
+
+* [**Installation**](#installation)
+* [**Usage**](#usage)
+    * [Initial setup](#initial-setup)
+    * [Creating new dotfile](#creating-new-dotfile)
+    * [Listing managed dotfiles](#listing-managed-dotfiles)
+    * [Removing existing dotfile](#removing-existing-dotfile)
+    * [Editing dotfiles](#editing-dotfiles)
+    * [Installing dotfiles](#installing-dotfiles)
+    * [Backing up existing dotfiles](#backing-up-existing-dotfiles)
+    * [Help](#help)
+    * [Checking the version](#checking-the-version)
+* [**Code of Conduct**](#code-of-conduct)
+* [**License**](#license)
+
+## Installation
+
+Make sure you have Ruby >= 2.3 installed.
+
+To install Dotfiler, run:
+
+    $ gem install dotfiler
+
+Dotfiler works Linux and MacOS only.
+
+## Usage
+
+### Initial setup
+
+    $ dotfiler init --help
+    Command:
+      dotfiler init
+
+    Usage:
+      dotfiler init PATH
+
+    Description:
+      Create config file. Create dotfiles directory at specified path. Initialize git repo.
+
+    Arguments:
+      PATH                  # REQUIRED Path where the Dotfiles directory will be created
+
+    Options:
+      --[no-]git            # Initialize git repo for dotfiles directory, default: true
+      --help, -h            # Print this help
+
+Example:
+
+    $ dotfiler init ~/code/my_dotfiles
+    #  Creating config file (/Users/aleksandar/.dotfiler)...
+    #  Creating dotfiles directory (/Users/aleksandar/code/my_dotfiles)...
+    #  Creating dotfiles file (/Users/aleksandar/code/my_dotfiles/.dotfiles)...
+    #  Initialized empty Git repository in /Users/aleksandar/code/my_dotfiles/.git/
+
+As you can see, `init` command does 4 things:
+
+1. Creates Dotfiler configuration (YAML) file (`.dotfiler`) in your home directory.
+2. Creates a directory where dotfiles will be kept, at specified location.
+3. Creates a file (`.dotfiles`) which holds necessary info about each dotfile
+you add. The file is created in dotfiles directory.
+4. Initializes Git repo in dotfiles directory. You can skip this by passing
+`--no-git` option.
+
+**NOTE:** If any of the files/dirs already exist, you will be prompted to either overwrite or
+keep them.
+
+### Adding new dotfile
+
+To add a file/directory to your dotfiles, use `add` command.
+
+    $ dotfiler add --help
+    Command:
+      dotfiler add
+
+    Usage:
+      dotfiler add PATH
+
+    Description:
+      Add specified file/directory to dotfiles
+
+    Arguments:
+      PATH                        # REQUIRED File/directory path
+
+    Options:
+      --name=VALUE, -n VALUE      # Name which will be assigned to dotfile
+      --target=VALUE, -t VALUE    # Path to where the symlink will be created
+      --help, -h                  # Print this help
+
+Example:
+
+    $ dotfiler add ~/.zshrc
+    #  Moving /Users/aleksandar/.zshrc to dotfiles directory (/Users/aleksandar/code/my_dotfiles)...
+    #  Symlinking dotfile (/Users/aleksandar/code/my_dotfiles/.zshrc) to /Users/aleksandar/.zshrc...
+    #  Adding zshrc to dotfiles...
+
+`add` command does 3 things:
+
+1. Moves specified file/directory to dotfiles directory.
+2. Creates a symbolic link in file's/dir's original location which points to
+it's new location in dotfiles directory. If you want to change the symlink's
+location, use `--target` option.
+3. Updates `.dotfiles` file.
+
+Dotfile consists of **name**, **path** and **link**:
+
+- **Name** serves as a unique identifier for a dotfile. By default, name of the
+file will be used as a dotfile name (without starting dots/underscores). You can
+set a custom name for a dotfile with `--name` option.
+Name is used for specifying which dotfile to remove or edit.
+- **Path** is an actual dotfile path (in dotfiles directory).
+- **Link** is a symbolic link path
+
+Aliases: `a`
+
+### Listing managed dotfiles
+
+To get a list of all currently managed dotfiles, use `list` command.
+
+    $ dotfiler list --help
+    Command:
+      dotfiler list
+
+    Usage:
+      dotfiler list [NAMES]
+
+    Description:
+      List all managed dotfiles
+
+    Arguments:
+      NAMES                 # List only names of managed dotfiles
+
+    Options:
+      --help, -h                            # Print this help
+
+Example:
+
+    $ dotfiler list
+    zsh
+      - LINK: /Users/aleksandar/.zshrc
+      - PATH: /Users/aleksandar/code/my_dotfiles/.zshrc
+
+
+    # to list dotfiles names only
+
+    $ dotfiler list names
+
+
+Aliases: `ls`
+
+### Removing existing dotfile
+
+To remove a dotfile, use `remove` command.
+
+    $ dotfiler remove --help
+    Command:
+      dotfiler remove
+
+    Usage:
+      dotfiler remove NAME
+
+    Description:
+      Remove specified dotfile from dotfiles and restore it to it's original location
+
+    Arguments:
+      NAME                  # REQUIRED Name of the dotfile that should be removed
+
+    Options:
+      --help, -h                            # Print this help
+
+Example:
+
+    $ dotfiler remove zshrc
+    #  Removing symlink (/Users/aleksandar/.zshrc)...
+    #  Restoring dotfile (/Users/aleksandar/code/my_dotfiles/.zshrc) to its original location (/Users/aleksandar/.zshrc)...
+    #  Removing 'zsh' from dotfiles...
+
+`remove` command does 3 things:
+
+1. Removes dotfile symbolic link.
+2. Moves the file/dir from dotfiles directory to a location of previously removed symlink.
+3. Updates `.dotfiles` file.
+
+Aliases: `rm`
+
+### Editing dotfiles
+
+To edit a dotfile, use `edit` command.
+
+    $ dotfiler edit --help
+    Command:
+      dotfiler edit
+
+    Usage:
+      dotfiler edit NAME
+
+    Description:
+      Edit specified dotfile. By default, dotfile will be opened in $EDITOR
+
+    Arguments:
+      NAME                     # REQUIRED Name of the dotfile you want to edit
+
+    Options:
+      --with=VALUE, w VALUE    # Editor in which to open the specified dotfile
+      --help, -h               # Print this help
+
+    $ dotfiler edit zshrc
+    #### This will open ~/code/my_dotfiles/.zshrc file in $EDITOR ####
+
+You can specify a different editor by using `--with` option:
+
+    $ dotfiler edit zshrc --with=vim
+
+Aliases: `e`
+
+### Installing dotfiles
+
+To install all dotfiles, use `install` command.
+
+    $ dotfiler install --help
+    Command:
+      dotfiler install
+
+    Usage:
+      dotfiler install PATH
+
+    Description:
+      Install dotfiles from existing dotfiles directory
+
+    Arguments:
+      PATH                  # REQUIRED Path to existing dotfiles directory
+
+    Options:
+      --help, -h            # Print this help
+
+Example:
+
+    $ dotfiler install ~/code/my_dotfiles
+
+`install` command will create symlinks of files located in specified dotfiles directory,
+by looking at `.dotfiles` file. If symlink's location is already taken, it will:
+
+- Overwrite the file if it is **a symbolic link**
+- Backup file/dir if it is **not a symbolic link**
+
+Backed up files will be placed in `dotfiler_installation_backup_{{CURRENT_TIMESTAMP}}`
+directory, located in your home directory,
+
+### Backing up existing dotfiles
+
+To back up existing dotfiles, use `backup` command.
+
+    $ dotfiler backup --help
+    Command:
+      dotfiler backup
+
+    Usage:
+      dotfiler backup
+
+    Description:
+      Backup existing dotfiles directory
+
+    Options:
+      --help, -h                            # Print this help
+
+Example:
+
+    $ dotfiler backup
+    #  Backing up dotfiles directory (/Users/aleksandar/code/my_dotfiles) to Users/aleksandar/.dotfiler_backup_2018-29-05-10-00-00
+
+### Help
+
+To see what commands are available, use `help` command:
+
+    $ dotfiler help
+
+Aliases: `-h, --help`
+
+### Checking the version
+
+To check Dotfiler version, run:
+
+    $ dotfiler version
+
+Aliases: `v, -v, --version`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aradunovic/dotfiler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Dotfiler project’s codebases and issue trackers is expected to follow the [code of conduct](https://github.com/aradunovic/dotfiler/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/dotfiler.gemspec

@@ -0,0 +1,28 @@
+require File.expand_path("../lib/dotfiler/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name         = "dotfiler"
+  spec.version      = Dotfiler::VERSION
+  spec.authors      = ["Aleksandar Radunovic"]
+  spec.email        = ["aleksandar@radunovic.io"]
+
+  spec.summary      = "CLI gem for managing dotfiles"
+  spec.description  = spec.summary
+  spec.homepage     = "https://github.com/aradunovic/dotfiler"
+  spec.license      = "MIT"
+
+  spec.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "dotfiler.gemspec"]
+  spec.require_path = "lib"
+  spec.bindir       = "exe"
+  spec.executables  = ["dotfiler"]
+
+  spec.required_ruby_version = ">= 2.3"
+
+  spec.add_dependency "dry-container",   "0.6.0"
+  spec.add_dependency "dry-auto_inject", "0.4.6"
+  spec.add_dependency "hanami-cli",      "0.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.0"
+end

data/exe/dotfiler

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "dotfiler"
+require "dotfiler/cli/commands"
+
+Hanami::CLI.new(Dotfiler::CLI::Commands).call

data/lib/dotfiler.rb

@@ -0,0 +1,11 @@
+require "dotfiler/version"
+
+module Dotfiler
+  Error = Class.new(StandardError)
+
+  def self.resolve
+    @_container ||= Container
+  end
+end
+
+require "dotfiler/container"

data/lib/dotfiler/cli/commands.rb

@@ -0,0 +1,39 @@
+require "hanami/cli"
+
+require "dotfiler/cli/commands/command"
+
+require "dotfiler/cli/commands/init"
+require "dotfiler/cli/commands/install"
+require "dotfiler/cli/commands/add"
+require "dotfiler/cli/commands/remove"
+require "dotfiler/cli/commands/list"
+require "dotfiler/cli/commands/edit"
+require "dotfiler/cli/commands/backup"
+require "dotfiler/cli/commands/version"
+
+module Dotfiler
+  module CLI
+    module Commands
+      extend Hanami::CLI::Registry
+
+      register "init",    Init
+      register "install", Install
+      register "add",     Add,     aliases: ["a"]
+      register "remove",  Remove,  aliases: ["rm"]
+      register "list",    List,    aliases: ["ls"]
+      register "edit",    Edit,    aliases: ["e"]
+      register "backup",  Backup
+      register "version", Version, aliases: ["v", "-v", "--version"]
+
+      %w(add remove list edit backup).each do |cmd|
+        before(cmd) do
+          unless Dotfiler.resolve[:config].set?
+            $stderr.puts("ERROR: Dotfiler needs to be set up first. Check `dotfiler init -h`")
+            exit(1)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/dotfiler/cli/commands/add.rb

@@ -0,0 +1,105 @@
+module Dotfiler
+  module CLI
+    module Commands
+      class Add < Command
+        include Dotfiler::Import["dotfiles", "symlinker", "mover"]
+
+        desc "Add specified file/directory to dotfiles"
+
+        argument :path,   required: true,  desc: "File/directory path"
+        option   :name,   required: false, desc: "Name which will be assigned to dotfile",    aliases: ["-n"]
+        option   :target, required: false, desc: "Path to where the symlink will be created", aliases: ["-t"]
+
+        def call(path:, **options)
+          handle_errors do
+            path = to_path.(path)
+
+            validate_path!(path)
+
+            name = options.fetch(:name, generate_dotfile_name(path))
+
+            validate_name!(name)
+
+            dotfiles_path = to_path.(config[:dotfiles])
+            dotfile_path  = resolve_dotfile_path(path, dotfiles_path, options)
+            target_path   = to_path.(options.fetch(:target, path.to_s))
+
+            info("Symlinking dotfile (#{dotfile_path}) to #{target_path}...")
+            symlink_path  = symlinker.call(dotfile_path, target_path)
+
+
+            info("Adding #{name} to dotfiles...")
+            dotfiles.add!(name: name, link: symlink_path.to_s, path: dotfile_path.to_s)
+          end
+        end
+
+        private
+
+        def validate_path!(path)
+          error!("Path #{path} does not exist") unless path.exists?
+        end
+
+        def validate_name!(name)
+          error!("Dotfile with the name '#{name}' already exists") if dotfiles.name_taken?(name)
+        end
+
+        def resolve_dotfile_path(path, dotfiles_path, options)
+          if dotfiles_path.contains?(path)
+            error!(already_dotfile_error(path, dotfiles_path)) if options[:target].nil?
+
+            path
+          else
+            safely_move(path, dotfiles_path)
+          end
+        end
+
+        def already_dotfile_error(path, dotfiles_path)
+          "Specified #{path.file? ? "file" : "directory"} (#{path}) " +
+            "is already in dotfiles directory (#{dotfiles_path})." +
+            "\nIf you want to symlink it, please provide `--target` option"
+        end
+
+        def safely_move(source, destination)
+          full_destination_path = destination.join(source.name)
+
+          if full_destination_path.exists?
+            available_options = {
+              "1" => { value: :overwrite,            desc: "Overwrite it" },
+              "2" => { value: :backup_and_overwrite, desc: "Backup and overwrite it" },
+              "3" => { value: :cancel,               desc: "Cancel"}
+            }
+            answer = prompt(
+              "Dotfile (#{full_destination_path}) already exists.\nWould you like to:",
+              available_options
+            )
+
+            case answer
+            when :overwrite
+              # fall-through
+            when :backup_and_overwrite
+              backup(full_destination_path)
+            else
+              terminate!(:clean, message: "Cancelling...")
+            end
+          end
+
+          move(source, destination)
+        end
+
+        def backup(path)
+          info("Backing up #{path} to #{path}_old")
+          mover.call(path, to_path.(path.to_s + "_old"))
+        end
+
+        def move(source, destination)
+          info("Moving #{source} to dotfiles directory (#{destination})...")
+          mover.call(source, destination)
+        end
+
+        def generate_dotfile_name(path)
+          path.name.to_s.gsub(/\A[._]+/, "")
+        end
+      end
+    end
+  end
+end