flexdot 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1cce20c75873ecb10cd057fa7e02177580915e399768e6e2b24a908924717d99
+  data.tar.gz: 89328d00bc1991493907c2ec558662d4ada76110e6d33052eeaa521ecac64e22
+SHA512:
+  metadata.gz: 8ba2f0a613eff80271375c8a1eaee73af9e3f573c2ae08ca86b61eff337a4363d55b5d9b45a8212d3b75ad5536215105541f9430910eed87708ec8ca3f583838
+  data.tar.gz: 3a06a1a126bf0beec0a9b9c7d72f5d96c8778a926d242dc0ed74db0ea198b0a8e6d30c0b64c8a4f40be7525ce731eefec6fe7251a8ac3ad0ad5ab4fef0789013

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [hidakatsuya]

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Test on ruby ${{ matrix.ruby_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version:
+          - 2.5.x
+          - 2.6.x
+          - 2.7.x
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby ${{ matrix.ruby_version }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake test

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+/test/home/*
+!/test/home/dotfiles/*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hidakatsuya@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '>= 12.0'
+gem 'minitest', '~> 5.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Katsuya Hidaka
+
+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,213 @@
+# Flexdot
+
+[![Test](https://github.com/hidakatsuya/flexdot/workflows/Test/badge.svg?branch=master)](https://github.com/hidakatsuya/flexdot/actions?query=workflow%3ATest)
+
+A Flexible and Rake based dotfile manager.
+
+## Getting Started
+
+### Prerequisite
+
+Ruby 2.5+
+
+### Installing
+
+Install it as:
+
+    $ gem install flexdot
+
+Then, create the following directory structure:
+
+```
+$HOME/
+  dotfiles/
+```
+
+Create a `$HOME/dotfiles/Rakefile` with the following codes:
+
+```ruby
+require 'flexdot'
+
+Flexdot.install_tasks(
+  base_dir: '.',                # $HOME/dotfiles/
+  target_dir: '/home/username'  # $HOME/
+)
+```
+
+Finally, run `rake -T` in the `$HOME/dotfiles` and make sure that the output is as follows:
+
+    $ rake -T
+    rake clear_backups
+
+## Example
+
+This example is my actual dotfile environment.
+
+I have two working environments, macOS and ubuntu. The dotfiles in these environments are slightly different, so each dotfile is separated.
+
+### Directory Structure
+
+```
+$HOME/dotfiles
+├── common
+│   ├── bin
+│   │   ├── git-delete-other-branches
+│   │   └── git-reset-and-clean
+│   ├── git
+│   │   └── ignore
+│   ├── rubygems
+│   │   └── .gemrc
+│   └── vim
+│       └── .vimrc
+├── macOS
+│   ├── bash
+│   │   ├── .bash_profile
+│   │   └── .bashrc
+│   ├── git
+│   │   └── .gitconfig
+│   ├── karabiner
+│   │   └── tab-emulation.json
+│   └── vscode
+│       ├── keybindings.json
+│       └── settings.json
+├── ubuntu
+│   ├── bash
+│   │   └── .bashrc
+│   ├── bin
+│   │   ├── upgrade-ghcli
+│   │   ├── utils
+│   │   ├── x-copy
+│   │   └── x-open
+│   ├── git
+│   │   └── .gitconfig
+│   ├── vscode
+│   │   ├── keybindings.json
+│   │   └── settings.json
+│   └── xkeysnail
+│       ├── config.py
+│       ├── debug.sh
+│       ├── restart.sh
+│       ├── start.sh
+│       └── stop.sh
+├── macOS.yml
+├── ubuntu.yml
+└── Rakefile
+```
+
+### Available Commands
+
+When you run the `rake -T` command in that directory structure, you should have two installation commands available:
+
+    $ rake -T
+    rake clear_backups   # Clear all backups
+    rake install:macOS   # Install dotfiles for macOS
+    rake install:ubuntu  # Install dotfiles for ubuntu
+
+### Dotfile Index File
+
+`macOS.yml` and `ubuntu.yml` are for setting the link destination of dotfile. dotfile will be installed according to its setting.
+
+#### macOS.yml
+
+For example, `common -> bin -> git-delete-other-branchs` is `$HOME/dotfiles/common/bin/git-delete-other-branches`.
+And the value `bin` means `$HOME/bin` directory.
+
+So this defines linking `$HOME/dotfiles/common/bin/git-delete-other-branches` to `$HOME/bin/git-delete-other-branches`.
+
+
+```yml
+common:
+  bin:
+    git-delete-other-branches: bin
+    git-reset-and-clean: bin
+  git:
+    ignore: .config/git
+  rubygems:
+    .gemrc: .
+  vim:
+    .vimrc: .
+
+macOS:
+  bash:
+    .bash_profile: .
+    .bashrc: .
+  git:
+    .gitconfig: .
+  karabiner:
+    tab-emulation.json: .config/karabiner/assets/complex_modifications
+  vscode:
+    keybindings.json: Library/Application Support/Code/User
+    settings.json: Library/Application Support/Code/User
+```
+
+#### ubuntu.yml
+
+```yml
+common:
+  bin:
+    git-delete-other-branchs: bin
+    git-reset-and-clean: bin
+  git:
+    ignore: .config/git
+  rubygems:
+    .gemrc: .
+  vim:
+    .vimrc: .
+
+ubuntu:
+  bash:
+    .bashrc: .
+  bin:
+    upgrade-ghcli: bin
+    utils: bin
+    x-copy: bin
+    x-open: bin
+  git:
+    .gitconfig: .
+  vscode:
+    keybindings.json: .config/Code/User
+    settings.json: .config/Code/User
+  xkeysnail:
+    config.py: .xkeysnail
+    debug.sh: .xkeysnail
+    restart.sh: .xkeysnail
+    start.sh: .xkeysnail
+    stop.sh: .xkeysnail
+```
+
+### Installing dotfiles
+
+    $ rake install:macOS
+
+The following is the output result:
+
+```
+[already_linked] bin/git-delete-other-branches
+[already_linked] bin/git-reset-and-clean
+[already_linked] .config/git/ignore
+[already_linked] .gemrc
+[already_linked] .vimrc
+[link_created] .bash_profile (backup)
+[link_created] .bashrc (backup)
+[link_created] .gitconfig (backup)
+[link_created] .config/karabiner/assets/complex_modifications/tab-emulation.json (backup)
+[link_created] Library/Application Support/Code/User/keybindings.json (backup)
+[link_created] Library/Application Support/Code/User/settings.json (backup)
+```
+
+`already_linked` means skipped because `bin/git-delete-other-branches` is already linked. `link_created` means the link was created.
+Also, `(backup)` means that a file exists in the link path and that file was backed up to `$HOME/dotfiles/backup/YYYYMMDDHHIISS/filename`.
+
+### Misc
+
+You can clear all backups in `$HOME/dotfiles/backup/YYYYMMDDHHIISS` to run `rake clear_backups`.
+
+    $ rake clear_backups
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Flexdot project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hidakatsuya/flexdot/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/flexdot.gemspec

@@ -0,0 +1,19 @@
+require_relative 'lib/flexdot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flexdot'
+  spec.version       = Flexdot::VERSION
+  spec.authors       = ['Katsuya Hidaka']
+  spec.email         = ['hidakatsuya@gmail.com']
+
+  spec.summary       = 'A Flexible and Rake based dotfile manager'
+  spec.description   = 'Flexdot is a Flexible and Rake based dotfile manager'
+  spec.homepage      = 'https://github.com/hidakatsuya/flexdot'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
+  end
+  spec.require_paths = ['lib']
+end

data/lib/flexdot.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'flexdot/version'
+require_relative 'flexdot/tasks'
+
+module Flexdot
+  def self.install_tasks(base_dir:, target_dir:)
+    Tasks.new(base_dir, target_dir).install
+  end
+end

data/lib/flexdot/backup.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'fileutils'
+
+module Flexdot
+  class Backup
+    BASE_DIR = 'backup'
+
+    class << self
+      def clear_all
+        base_dir.glob('*').each(&:rmtree)
+      end
+
+      def base_dir
+        Pathname.pwd.join(BASE_DIR)
+      end
+    end
+
+    def initialize
+      backup_dir.mkpath unless backup_dir.exist?
+    end
+
+    def call(file)
+      FileUtils.mv(file, backup_dir)
+    end
+
+    private
+
+    def backup_dir
+      @backup_dir ||= self.class.base_dir.join(Time.now.strftime('%Y%m%d%H%M%S'))
+    end
+  end
+end

data/lib/flexdot/index.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Flexdot
+  class Index
+    def initialize(index)
+      @index = index
+    end
+
+    def each(&block)
+      index.each do |root, descendants|
+        fetch_descendants(descendants, paths: [root], &block)
+      end
+    end
+
+    private
+
+    attr_reader :index
+
+    def fetch_descendants(descendants, paths:, &block)
+      descendants.each do |k, v|
+        dotfile_path = paths + [k]
+        case v
+        when String
+          block.call(dotfile_path: File.join(*dotfile_path), target_path: v)
+        when Hash
+          fetch_descendants(v, paths: dotfile_path, &block)
+        else
+          raise ArgumentError, v
+        end
+      end
+    end
+  end
+end

data/lib/flexdot/installer.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require_relative 'logger'
+require_relative 'backup'
+require_relative 'index'
+
+module Flexdot
+  class Installer
+    def initialize(name, base_dir:, target_dir:)
+      @name = name
+      @base_dir = base_dir
+      @target_dir = target_dir
+      @backup = Backup.new
+      @logger = Logger.new(@target_dir)
+    end
+
+    def install(index_file)
+      index = Index.new(YAML.load_file(index_file.to_path))
+      index.each do |dotfile_path:, target_path:|
+        install_link(dotfile_path, target_path)
+      end
+    end
+
+    private
+
+    attr_reader :name, :base_dir, :target_dir, :backup, :logger
+
+    def install_link(dotfile_path, target_path)
+      dotfile = @base_dir.join(dotfile_path).expand_path
+      target_file = @target_dir.join(target_path, dotfile.basename).expand_path
+
+      logger.log(target_file) do |status|
+        if target_file.symlink?
+          if target_file.readlink == dotfile
+            status.result = :already_linked
+          else
+            target_file.unlink
+            target_file.make_symlink(dotfile.to_path)
+            status.result = :link_updated
+          end
+        else
+          if target_file.exist?
+            backup.call(target_file)
+            status.backuped = true
+          elsif !target_file.dirname.exist?
+            target_file.dirname.mkpath
+          end
+
+          target_file.make_symlink(dotfile.to_path)
+          status.result = :link_created
+        end
+      end
+    end
+  end
+end

data/lib/flexdot/logger.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Flexdot
+  class Logger
+    Status = Struct.new(:target_file, :result, :backuped)
+
+    def initialize(target_dir)
+      @target_dir = target_dir
+    end
+
+    def log(target_file)
+      status = Status.new(target_file)
+      yield(status)
+      puts message_for(status)
+    end
+
+    private
+
+    attr_reader :target_dir
+
+    def message_for(status)
+      [].tap { |msg|
+        msg << "[#{status.result}]"
+        msg << status.target_file.relative_path_from(target_dir)
+        msg << '(backup)' if status.backuped
+      }.join(' ')
+    end
+  end
+end

data/lib/flexdot/tasks.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require_relative 'installer'
+require_relative 'backup'
+
+module Flexdot
+  class Tasks
+    include Rake::DSL
+
+    def initialize(base_dir, target_dir)
+      @base_dir = Pathname.new(base_dir)
+      @target_dir = Pathname.new(target_dir)
+    end
+
+    def install
+      desc 'Clear backups'
+      task :clear_backups do
+        Backup.clear_all
+      end
+
+      namespace :install do
+        Pathname.new(base_dir).glob('*.yml') do |index_file|
+          name = index_file.basename('.*')
+
+          desc "Install dotfiles for #{name}"
+          task name do
+            installer = Installer.new(
+              name,
+              base_dir: base_dir,
+              target_dir: target_dir
+            )
+            installer.install(index_file)
+          end
+        end
+      end
+    end
+
+    private
+
+    attr_reader :base_dir, :target_dir
+  end
+end
+
+

data/lib/flexdot/version.rb

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

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: flexdot
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Katsuya Hidaka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies: []
+description: Flexdot is a Flexible and Rake based dotfile manager
+email:
+- hidakatsuya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/FUNDING.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flexdot.gemspec
+- lib/flexdot.rb
+- lib/flexdot/backup.rb
+- lib/flexdot/index.rb
+- lib/flexdot/installer.rb
+- lib/flexdot/logger.rb
+- lib/flexdot/tasks.rb
+- lib/flexdot/version.rb
+homepage: https://github.com/hidakatsuya/flexdot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Flexible and Rake based dotfile manager
+test_files: []