homeconf 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c665a0c79b5e74a56181634140175956bf93f51ff32df7ddb9aed81a7917890
+  data.tar.gz: 14e23e0a0b332f2afdf3d2d9c6db63cbe2336394fe4ede5349b2e90e1a98a781
+SHA512:
+  metadata.gz: a6fa7e2c13a83c7aeddb0a01279dff85219c2f9fa5a4fbbe43d562d10b25b1e55d80a963b3d21522a54538aa5e500dda8a81ed8b7821aae24023c7a09753faed
+  data.tar.gz: d037c435518d1e6af58341887519bc7975c0e0f8b756637635b8d90bb733c8382415a723f51db59a78f3319d050434002301420c8f42d3f3e9402182659cffa7

data/HEADER

@@ -0,0 +1,13 @@
+Copyright 2014-2023 Mark Lundquist
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,2 @@
+Homeconf
+Copyright 2014-2023 Mark Lundquist

data/README.md

@@ -0,0 +1,65 @@
+# homeconf
+
+**homeconf** is a Ruby utility to create and manage your home directory files and configuration in a single, portable,
+version controllable directory.
+
+----------
+
+## Installation
+
+**homeconf**'s installation is pretty standard:
+
+```sh
+$ gem install homeconf
+```
+
+If you'd rather install homeconf using `bundler`, add a line for it in your `Gemfile` (but set the `require` option
+to `false`, as it is a standalone tool):
+
+```rb
+gem 'homeconf', require: false
+```
+
+----------
+
+## Quickstart
+
+Just type `homeconf` to see your homeconf directory and if it's initialized.
+
+```
+$ cd
+$ homeconf
+```
+
+### Create homeconf directory
+
+Create your homeconf directory and start adding files and directories.
+
+```
+$ cd
+$ homeconf --create
+```
+
+### Initialize to create symlinks
+
+You can add files and directories to your homeconf directory, then initialize to create symlinks from your home
+directory.
+```
+$ echo "echo 'hello world'" > ~/homeconf/hello.sh
+$ mkdir ~/homeconf/my_scripts
+$ homeconf --init
+```
+
+### Add files and directories
+Move existing files and directories into homeconf directory.  Homeconf will create the symlink from your home directory.
+
+```
+$ homeconf --add .zshrc
+$ homeconf --add bin
+```
+
+### See configuration
+Run with verbose to see homeconf files and directories, and whether they're linked.
+```
+$ homeconf --verbose
+```

data/bin/homeconf

@@ -0,0 +1,133 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'getoptlong'
+require 'homeconf'
+
+@this = File.basename $PROGRAM_NAME
+
+def usage(retval = 0)
+  puts <<~USAGE
+    Usage: #{@this} [OPTION]...
+
+    Options:
+      -a, --add              Add filepath. Moves filepath into homeconf, then creates a link to it.
+      -c, --create           Create homeconf directory, if it doesn't exist.
+      -d, --directory        Homeconf directory. Default: #{Homeconf::DEFAULT_DIRECTORY}
+      -i, --initialize       Initialize homeconf.  Creates links to dot files and directories from homeconf to home.
+
+      -h, --help        show help
+      -v, --verbose     verbose output
+      -V, --version     show version
+  USAGE
+  exit retval
+end
+
+def print_version
+  header = File.realdirpath(File.join(File.dirname(__dir__), 'HEADER'))
+  puts <<~VERSION
+    #{@this} #{Homeconf::VERSION}
+    #{File.read(header)}
+  VERSION
+  exit 0
+end
+
+def error(msg)
+  puts "#{@this}: #{msg}"
+end
+
+def print_config(homeconf)
+  puts 'homeconf dirs:'
+  print_linked_table(homeconf, homeconf.list_homeconf_dirs)
+  puts 'homeconf files:'
+  print_linked_table(homeconf, homeconf.list_homeconf_files)
+end
+
+def print_linked_table(homeconf, filepaths)
+  longest = 1
+  filepaths.each do |filepath|
+    basename = File.basename(filepath)
+    length = basename.length
+    longest = length if length > longest
+  end
+
+  filepaths.each do |filepath|
+    basename = File.basename(filepath)
+    puts "  #{basename}#{' ' * (longest - basename.length + 2)}#{homeconf.linked?(filepath) ? 'linked' : 'unlinked'}"
+  end
+end
+
+# Handle options
+add_filepaths = Set.new
+homeconf_dir = Homeconf::DEFAULT_DIRECTORY
+create = false
+init = false
+verbose = false
+
+begin
+  opts = GetoptLong.new(
+    ['--add', '-a', GetoptLong::REQUIRED_ARGUMENT],
+    ['--create', '-c', GetoptLong::NO_ARGUMENT],
+    ['--directory', '-d', GetoptLong::REQUIRED_ARGUMENT],
+    ['--initialize', '-i', GetoptLong::NO_ARGUMENT],
+    ['--help', '-h', GetoptLong::NO_ARGUMENT],
+    ['--verbose', '-v', GetoptLong::NO_ARGUMENT],
+    ['--version', '-V', GetoptLong::NO_ARGUMENT]
+  )
+  opts.quiet = true # suppress GetoptLong stderr messages
+
+  opts.each do |opt, arg|
+    case opt
+    when '--add'
+      add_filepaths.add arg
+    when '--create'
+      create = true
+    when '--directory'
+      homeconf_dir = arg
+    when '--initialize'
+      init = true
+    when '--help'
+      usage
+      exit 0
+    when '--verbose'
+      verbose = true
+    when '--version'
+      print_version
+    else
+      puts "other passed: #{opt}"
+    end
+  end
+rescue GetoptLong::MissingArgument => e
+  error(e)
+  usage 1
+rescue StandardError => e
+  puts "#{e.class}: #{e}" if verbose
+  error(e)
+  exit 1
+end
+
+begin
+  homeconf = Homeconf::Homeconf.new(homeconf_dir, verbose: verbose)
+  homeconf.create if create
+  add_filepaths.each do |add_filepath|
+    puts add_filepath
+    Dir.glob(add_filepath, File::FNM_DOTMATCH).reject {|f| f == '.' || f == '..' }.each do |filepath|
+      homeconf.add filepath
+    end
+  end
+  homeconf.init if init
+
+  if homeconf.initialized?
+    puts "#{@this} initialized. #{homeconf.directory}"
+  else
+    puts "#{@this} not initialized. #{homeconf.directory}"
+  end
+  print_config(homeconf) if verbose
+rescue StandardError => e
+  puts "#{e.class}: #{e}" if verbose
+  error(e)
+  exit 1
+end

data/lib/homeconf/default_homeconfignore

@@ -0,0 +1,22 @@
+# homeconf ignore file
+# Files and directories in the homeconf directory matching an ignore pattern won't by symlinked from HOME
+# File glob patterns are supported.
+#
+# Examples:
+# .git
+# private_dir
+# *~
+# *.iml
+#
+# vcs
+.git
+.svn
+.hg
+.cvs
+
+# IntelliJ
+*.iml
+/.idea
+
+# emacs
+*~

data/lib/homeconf/errors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Homeconf
+  # {HomeconfDirNotFound} is raised to indicate that no {Homeconf} directory was not found
+  class HomeconfDirNotFound < StandardError
+  end
+
+  # {InvalidHomeconfDir} is raised to indicate that the homeconf directory is not a valid directory
+  class InvalidHomeconfDir < StandardError
+  end
+
+  # {FileExistsError} is raised to indicate that file or directory already exists
+  class FileExistsError < StandardError
+  end
+
+  # {FileNotFoundError} is raised to indicate that file or directory was not found
+  class FileNotFoundError < StandardError
+  end
+
+  # {SymlinkError} is raised to indicate that target file or directory is a symlink
+  class SymlinkError < StandardError
+  end
+end

data/lib/homeconf/file_finder.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require_relative 'errors'
+
+module Homeconf
+  IGNORE_FILE = '.homeconfignore'
+
+  # Common methods for finding files.
+  # @api private
+  module FileFinder
+    def self.homeconf_dirs(homeconf_dir)
+      homeconf_dir = realpath(homeconf_dir)
+      ignores = ignores(homeconf_dir)
+      homeconf_dir.children
+                  .select(&:directory?)
+                  .reject { |p| ignores.include?(p.to_s) }
+                  .map(&:to_s)
+                  .sort
+    end
+
+    def self.homeconf_files(homeconf_dir)
+      homeconf_dir = realpath(homeconf_dir)
+      ignores = ignores(homeconf_dir)
+      homeconf_dir.children
+                  .select(&:file?)
+                  .reject { |p| ignores.include?(p.to_s) }
+                  .map(&:to_s)
+                  .sort
+    end
+
+    def self.ignores(filepath)
+      homeconf_dir = realpath(filepath)
+      ignore_file = homeconf_dir.join(IGNORE_FILE)
+      ignores = Set.new
+
+      return ignores.to_a unless File.file?(ignore_file) && File.readable?(ignore_file)
+
+      ignores.add ignore_file.to_s # implicitly ignore IGNORE_FILE
+
+      ignore_globs = File.readlines(ignore_file, chomp: true).grep_v(/^\s*$/).grep_v(/^\s*#/)
+      ignore_globs.each do |g|
+        Dir.glob(homeconf_dir.join(g).to_s, File::FNM_DOTMATCH).each { |f| ignores.add(f) }
+      end
+
+      ignores
+    end
+
+    def self.realpath(filepath)
+      begin
+        realpath = Pathname.new(filepath).expand_path.realpath
+      rescue Errno::ENOENT
+        raise InvalidHomeconfDir.new("Does not exist. #{filepath}")
+      rescue => e
+        raise e
+      end
+      raise InvalidHomeconfDir.new("Not a directory. #{filepath}") unless realpath.directory?
+      realpath
+    end
+
+  end
+end

data/lib/homeconf/homeconf.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'etc'
+require 'fileutils'
+require 'pathname'
+require_relative 'errors'
+require_relative 'file_finder'
+require_relative 'pathname'
+
+module Homeconf
+  DEFAULT_DIRECTORY_NAME = 'homeconf'
+  DEFAULT_DIRECTORY = File.join(Dir.home, DEFAULT_DIRECTORY_NAME).freeze
+  DEFAULT_HOMECONFIGNORE_FILE = File.join(__dir__,'default_homeconfignore')
+
+  class Homeconf
+    attr_reader :directory, :homedir
+
+    @verbose = false
+
+    def initialize(directory = DEFAULT_DIRECTORY, verbose: false)
+      @verbose = verbose
+      @homedir = Dir.home
+
+      # Parent directory must exist
+      @directory = File.realdirpath(File.expand_path(directory))
+
+      if @directory.eql? @homedir
+        raise InvalidHomeconfDir, "cannot use directory '#{@directory}': #{$USER} home directory cannot be used."
+      end
+    end
+
+    def create
+      mkdir_unless_exists @directory
+      ignore_file = File.join(@directory, IGNORE_FILE)
+      return if File.exist?(ignore_file)
+
+      description = File.read(DEFAULT_HOMECONFIGNORE_FILE)
+      File.write(ignore_file, description)
+    end
+
+    def add(filepath)
+      expand_path = File.expand_path(filepath)
+      raise FileNotFoundError, "cannot add '#{expand_path}': No such file or directory" unless File.exist?(expand_path)
+
+      if File.symlink?(expand_path)
+        raise SymlinkError,
+              "cannot add '#{expand_path}': It is a symlink, not a file or directory"
+      end
+
+      target = File.join(@directory, File.basename(expand_path))
+
+      raise FileExistsError, "cannot add '#{expand_path}', '#{target}' already exists" if File.exist?(target)
+
+      move(expand_path)
+      link(target)
+    end
+
+    def init
+      validate
+      unlinked_dirs.each do |f|
+        link(f)
+      end
+      unlinked_files.each do |f|
+        link(f)
+      end
+    end
+
+    def validate
+      validate_dir @directory
+    end
+
+    def create_directory(directory)
+      mkdir_unless_exists(File.realdirpath(directory))
+    end
+
+    # Returns the homeconf files that are not ignored and not symlinked from the home directory.
+    def unlinked_files
+      unlinked_files = []
+      FileFinder.homeconf_files(@directory).each do |file|
+        unlinked_files.push file unless linked? file
+      end
+      unlinked_files.sort
+    end
+
+    # Returns the homeconf directories that are not ignored and not symlinked from the home directory.
+    def unlinked_dirs
+      unlinked_dirs = []
+      FileFinder.homeconf_dirs(@directory).each do |dir|
+        unlinked_dirs.push dir unless linked? dir
+      end
+      unlinked_dirs.sort
+    end
+
+    # Returns whether the homeconf is initialized.  Homeconf is initialized when all files and directories in the
+    # homeconf directory that are not ignored and symlinked from the home directory.
+    def initialized?
+      validate_dir @directory
+      unlinked_dirs.empty? && unlinked_files.empty?
+    rescue StandardError => e
+      puts "Error: #{e}" if @verbose
+      false
+    end
+
+    def validate_dir(directory)
+      raise HomeconfDirNotFound, "No such directory. #{directory}" unless File.exist? directory
+      raise InvalidHomeconfDir, "Not a directory. #{directory}" unless File.directory? directory
+      raise InvalidHomeconfDir, "Directory not writable. #{directory}" unless File.writable? directory
+      true
+    end
+
+    def list_homeconf_dirs
+      FileFinder.homeconf_dirs @directory
+    end
+
+    def list_homeconf_files
+      FileFinder.homeconf_files @directory
+    end
+
+    def linked?(filepath)
+      basename = File.basename(filepath)
+      link = File.join(Dir.home, basename)
+      return false unless File.symlink?(link)
+
+      expected_link_target = File.join(@directory, basename)
+      link_target = File.readlink(link)
+      link_target = File.join(@homedir, link_target) unless Pathname.new(link_target).absolute?
+
+      link_target = File.realpath(link_target)
+      expected_link_target.eql?(link_target)
+    end
+
+    def move(path)
+      expand_path = File.expand_path(path)
+      unless File.exist?(expand_path)
+        raise FileNotFoundError,
+              "cannot move '#{expand_path}', No such file or directory."
+      end
+      if File.symlink?(expand_path)
+        raise SymlinkError,
+              "cannot move '#{expand_path}': It is a symlink, not a file or directory"
+      end
+
+      target = File.join(@directory, File.basename(expand_path))
+      raise FileExistsError, "cannot move '#{target}', File or directory exists." if File.exist?(target)
+
+      FileUtils.mv(expand_path, target)
+    end
+
+    def link(filepath)
+      target = Pathname.new(filepath).expand_path(@directory)
+
+      unless target.path_prefix?(@directory)
+        raise SymlinkError,
+              "cannot link '#{target}', not in homeconf directory: '#{@directory}'"
+      end
+      raise FileNotFoundError, "cannot link '#{target}', No such file or directory." unless File.exist?(target)
+
+      return if FileFinder.ignores(@directory).include? target.to_s
+
+      relative_target = target.relative_path_from(@homedir)
+      link_path = File.join(@homedir, File.basename(target))
+
+      # move existing file to backup
+      backup_file_if_exist(link_path)
+
+      puts "link: #{link_path} -> #{relative_target}" if @verbose
+      File.symlink(relative_target, link_path)
+    end
+
+    private
+
+    def backup_file_if_exist(filepath)
+      return unless File.exist? filepath
+
+      bk_file = "#{filepath}#{bk_timestamp}"
+      puts "#{filepath} file exists, moving to #{bk_file}" if @verbose
+      FileUtils.mv(filepath, bk_file)
+    end
+
+    def bk_timestamp
+      DateTime.now.strftime('.bk-%Y-%m-%d_%H-%M-%S')
+    end
+
+    def mkdir_unless_exists(directory, permissions = 0o755)
+      unless Dir.exist? directory
+        Dir.mkdir directory, permissions
+        puts "Created directory. #{directory}" if @verbose
+      end
+    rescue Errno::ENOENT
+      raise HomeconfDirNotFound, "No such directory. #{File.dirname directory}"
+    rescue Errno::ENOTDIR
+      raise InvalidHomeconfDir, "Not a directory. #{File.dirname directory}"
+    end
+  end
+end

data/lib/homeconf/pathname.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Pathname mix-ins for homeconf.
+#
+class Pathname
+  # Returns whether +self+ has the path prefix of +path_prefix+
+  #
+  def path_prefix?(path_prefix)
+    path_parts = expand_path.parent.to_s.split(File::SEPARATOR)
+    prefix_parts = File.expand_path(path_prefix).split(File::SEPARATOR)
+
+    return false if path_parts.size < prefix_parts.size
+
+    prefix_parts.each_with_index do |part, index|
+      return false unless path_parts[index].eql? part
+    end
+
+    true
+  end
+end

data/lib/homeconf/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Homeconf
+  VERSION = '0.1.1'
+end

data/lib/homeconf.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'logger'
+require_relative 'homeconf/homeconf'
+require_relative 'homeconf/pathname'
+require_relative 'homeconf/version'
+
+module Homeconf
+  class << self
+    attr_accessor :logger
+  end
+
+  self.logger = Logger.new($stderr)
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: homeconf
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mark Lundquist
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-parameterized
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: "    Homeconf is a Ruby program to create and manage a single directory
+  for all home directory configuration.\n"
+email:
+- homeconf@epicmaven.com
+executables:
+- homeconf
+extensions: []
+extra_rdoc_files:
+- HEADER
+- LICENSE
+- NOTICE
+- README.md
+files:
+- HEADER
+- LICENSE
+- NOTICE
+- README.md
+- bin/homeconf
+- lib/homeconf.rb
+- lib/homeconf/default_homeconfignore
+- lib/homeconf/errors.rb
+- lib/homeconf/file_finder.rb
+- lib/homeconf/homeconf.rb
+- lib/homeconf/pathname.rb
+- lib/homeconf/version.rb
+homepage: https://github.com/EpicMaven/homeconf
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/EpicMaven/homeconf
+  bug_tracker_uri: https://github.com/EpicMaven/homeconf/issues
+  source_code_uri: https://github.com/EpicMaven/homeconf/tree/v0.1.1
+  documentation_uri: https://rubydoc.info/gems/EpicMaven/0.1.1
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+- "--title=homeconf"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.8
+signing_key: 
+specification_version: 4
+summary: Homeconf manages portable, version controlled home directory configuration.
+test_files: []