flexdot 1.0.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cce20c75873ecb10cd057fa7e02177580915e399768e6e2b24a908924717d99
-  data.tar.gz: 89328d00bc1991493907c2ec558662d4ada76110e6d33052eeaa521ecac64e22
+  metadata.gz: fbeccda096b5cffa6592e2fd044091357384a1be8eed6d692f2ddfd8e7b6cb3e
+  data.tar.gz: cb0bb15f3a618e50ebe0c4e5db1fc325e426ba357f4ccfbddfd5110ec263a172
 SHA512:
-  metadata.gz: 8ba2f0a613eff80271375c8a1eaee73af9e3f573c2ae08ca86b61eff337a4363d55b5d9b45a8212d3b75ad5536215105541f9430910eed87708ec8ca3f583838
-  data.tar.gz: 3a06a1a126bf0beec0a9b9c7d72f5d96c8778a926d242dc0ed74db0ea198b0a8e6d30c0b64c8a4f40be7525ce731eefec6fe7251a8ac3ad0ad5ab4fef0789013
+  metadata.gz: 93df4b1412f1fbaccc3a242f68a569955435e2271d9cab0de29ec62cd04d760997162bb81fb1573454d837d29ba34606e6ef9a8d83b0c07cab5238c28cbfa62b
+  data.tar.gz: 89284ebc88a5c475e53e80a6049bfa2bd37d498bf4a600ecd9ba1637a5c170951a9aa6be749e72adef587b691865c686a2ae834ea973f78674f1e32effd56a54

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/test.yml

@@ -7,20 +7,27 @@ jobs:
   test:
     name: Test on ruby ${{ matrix.ruby_version }}
     runs-on: ubuntu-latest
+    # Run this build only on either pull request or push.
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+
     strategy:
       matrix:
         ruby_version:
-          - 2.5.x
-          - 2.6.x
-          - 2.7.x
+          - 2.6
+          - 2.7
+          - 3.0
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
+
     - name: Set up Ruby ${{ matrix.ruby_version }}
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby_version }}
-    - name: Build and test with Rake
+
+    - name: Install dependencies
       run: |
         gem install bundler
         bundle install --jobs 4 --retry 3
-        bundle exec rake test
+
+    - name: Run tests
+      run: bundle exec rake test

data/.gitignore

@@ -8,5 +8,5 @@
 /tmp/
 /Gemfile.lock
 
-/test/home/*
-!/test/home/dotfiles/*
+/test/tasks/home/*
+!/test/tasks/home/dotfiles/*

data/CHANGELOG.md

@@ -0,0 +1 @@
+Please see [the release page](https://github.com/hidakatsuya/flexdot/releases).

data/Gemfile

@@ -2,5 +2,4 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake', '>= 12.0'
 gem 'minitest', '~> 5.0'

data/README.md

@@ -1,5 +1,6 @@
 # Flexdot
 
+[![Gem Version](https://badge.fury.io/rb/flexdot.svg)](https://badge.fury.io/rb/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.
@@ -8,32 +9,60 @@ A Flexible and Rake based dotfile manager.
 
 ### Prerequisite
 
-Ruby 2.5+
+Ruby 2.6+
 
 ### Installing
 
-Install it as:
-
-    $ gem install flexdot
-
-Then, create the following directory structure:
+Create the following directory structure:
 
 ```
 $HOME/
-  dotfiles/
+├── dotfiles/
+:
+```
+
+Create a `Gemfile` to install Flexdot:
+
+    $ cd $HOME/dotfiles
+    $ bundle init
+
+Add this line to the `Gemfile`:
+
+```ruby
+gem 'flexdot'
 ```
 
-Create a `$HOME/dotfiles/Rakefile` with the following codes:
+Or install it yourself as:
+
+    $ gem install flexdot
+
+Then, create a `$HOME/dotfiles/Rakefile` with the following codes:
 
 ```ruby
 require 'flexdot'
 
-Flexdot.install_tasks(
-  base_dir: '.',                # $HOME/dotfiles/
-  target_dir: '/home/username'  # $HOME/
+Flexdot.setup(
+  home_dir: '/home/username',
+
+  # (optional)
+  # The dotfile directory path.
+  # Default '.'.
+  dotfiles_dir: '.'
+
+  # (optional)
+  # Whether or not to colorize the output
+  # Default: true
+  output_colorize: true
 )
 ```
 
+It is recommended that you add the Rakefile to `gitignore`:
+
+```
+# .gitignore
+Rakefile
+```
+
 Finally, run `rake -T` in the `$HOME/dotfiles` and make sure that the output is as follows:
 
     $ rake -T
@@ -94,6 +123,20 @@ $HOME/dotfiles
 └── Rakefile
 ```
 
+### Rakefile
+
+```ruby
+require 'flexdot'
+
+Flexdot.setup(
+  home_dir: '..'
+)
+
+# You can execute `install:macOS` when you run `rake` command
+# with no arguments by defining it as follows:
+task default: 'install:macOS'
+```
+
 ### Available Commands
 
 When you run the `rake -T` command in that directory structure, you should have two installation commands available:
@@ -175,24 +218,28 @@ ubuntu:
     stop.sh: .xkeysnail
 ```
 
-### Installing dotfiles
+### Installing dotfiles for macOS
+
+    $ rake
+
+Or,
 
     $ 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: 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.

data/flexdot.gemspec

@@ -10,10 +10,13 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = Gem::Requirement.new('>= 2.6.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']
+
+  spec.add_dependency 'rake', '>= 12.0'
+  spec.add_dependency 'paint', '>= 2.2.1'
 end

data/lib/flexdot/backup.rb

@@ -7,6 +7,8 @@ module Flexdot
   class Backup
     BASE_DIR = 'backup'
 
+    class AlreadyFinishedError < StandardError; end
+
     class << self
       def clear_all
         base_dir.glob('*').each(&:rmtree)
@@ -19,12 +21,19 @@ module Flexdot
 
     def initialize
       backup_dir.mkpath unless backup_dir.exist?
+      @finished = false
     end
 
     def call(file)
+      raise AlreadyFinishedError if @finished
       FileUtils.mv(file, backup_dir)
     end
 
+    def finish!
+      backup_dir.delete if backup_dir.empty?
+      @finished = true
+    end
+
     private
 
     def backup_dir

data/lib/flexdot/index.rb

@@ -21,7 +21,7 @@ module Flexdot
         dotfile_path = paths + [k]
         case v
         when String
-          block.call(dotfile_path: File.join(*dotfile_path), target_path: v)
+          block.call(dotfile_path: File.join(*dotfile_path), home_file_path: v)
         when Hash
           fetch_descendants(v, paths: dotfile_path, &block)
         else

data/lib/flexdot/installer.rb

@@ -2,53 +2,55 @@
 
 require 'yaml'
 
-require_relative 'logger'
+require_relative 'output'
 require_relative 'backup'
 require_relative 'index'
 
 module Flexdot
   class Installer
-    def initialize(name, base_dir:, target_dir:)
+    def initialize(name, dotfiles_dir, home_dir, output_colorize)
       @name = name
-      @base_dir = base_dir
-      @target_dir = target_dir
+      @dotfiles_dir = dotfiles_dir
+      @home_dir = home_dir
       @backup = Backup.new
-      @logger = Logger.new(@target_dir)
+      @output = Output.new(@home_dir, colorize: output_colorize)
     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)
+      index.each do |dotfile_path:, home_file_path:|
+        install_link(dotfile_path, home_file_path)
       end
+
+      backup.finish!
     end
 
     private
 
-    attr_reader :name, :base_dir, :target_dir, :backup, :logger
+    attr_reader :name, :dotfiles_dir, :home_dir, :backup, :output
 
-    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
+    def install_link(dotfile_path, home_file_path)
+      dotfile = @dotfiles_dir.join(dotfile_path).expand_path
+      home_file = @home_dir.join(home_file_path, dotfile.basename).expand_path
 
-      logger.log(target_file) do |status|
-        if target_file.symlink?
-          if target_file.readlink == dotfile
+      output.log(home_file) do |status|
+        if home_file.symlink?
+          if home_file.readlink == dotfile
             status.result = :already_linked
           else
-            target_file.unlink
-            target_file.make_symlink(dotfile.to_path)
+            home_file.unlink
+            home_file.make_symlink(dotfile.to_path)
             status.result = :link_updated
           end
         else
-          if target_file.exist?
-            backup.call(target_file)
+          if home_file.exist?
+            backup.call(home_file)
             status.backuped = true
-          elsif !target_file.dirname.exist?
-            target_file.dirname.mkpath
+          elsif !home_file.dirname.exist?
+            home_file.dirname.mkpath
           end
 
-          target_file.make_symlink(dotfile.to_path)
+          home_file.make_symlink(dotfile.to_path)
           status.result = :link_created
         end
       end

data/lib/flexdot/output.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'paint'
+
+module Flexdot
+  class Output
+    Status = Struct.new(:home_file, :result, :backuped)
+
+    def initialize(dotfiles_dir, colorize: true)
+      @dotfiles_dir = dotfiles_dir
+      @colorize = colorize
+    end
+
+    def log(home_file)
+      status = Status.new(home_file)
+      yield(status)
+      puts message_for(status)
+    end
+
+    private
+
+    attr_reader :dotfiles_dir
+
+    def message_for(status)
+      result_color =
+        case status.result
+        when :already_linked then :gray
+        when :link_updated   then :yellow
+        when :link_created   then :green
+        else :default
+        end
+
+      msg = []
+      msg << paint("#{status.result.to_s.gsub('_', ' ')}:", result_color)
+      msg << status.home_file.relative_path_from(dotfiles_dir)
+      msg << '(backup)' if status.backuped
+      msg.join(' ')
+    end
+
+    def paint(string, *colors)
+      colorize? ? Paint[string, *colors] : string
+    end
+
+    def colorize?
+      @colorize
+    end
+  end
+end

data/lib/flexdot/tasks.rb

@@ -8,9 +8,12 @@ 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)
+    Index = Struct.new(:filename, :name, keyword_init: true)
+
+    def initialize(dotfiles_dir, home_dir, output_colorize)
+      @dotfiles_dir = Pathname.new(dotfiles_dir).expand_path
+      @home_dir = Pathname.new(home_dir).expand_path
+      @output_colorize = output_colorize
     end
 
     def install
@@ -20,17 +23,16 @@ module Flexdot
       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
+        indexes.each do |index|
+          desc "Install dotfiles for #{index.name}"
+          task index.name do
             installer = Installer.new(
-              name,
-              base_dir: base_dir,
-              target_dir: target_dir
+              index.name,
+              dotfiles_dir,
+              home_dir,
+              output_colorize
             )
-            installer.install(index_file)
+            installer.install(index.filename)
           end
         end
       end
@@ -38,7 +40,13 @@ module Flexdot
 
     private
 
-    attr_reader :base_dir, :target_dir
+    attr_reader :dotfiles_dir, :home_dir, :output_colorize
+
+    def indexes
+      @indexes ||= Pathname.new(dotfiles_dir).glob('*.yml').map do |index_file|
+        Index.new(name: index_file.basename('.*').to_s, filename: index_file)
+      end
+    end
   end
 end
 

data/lib/flexdot/version.rb

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

data/lib/flexdot.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require 'rake'
+
 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
+  def self.setup(home_dir:, dotfiles_dir: '.', output_colorize: true)
+    Tasks.new(dotfiles_dir, home_dir, output_colorize).install
   end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: flexdot
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 3.2.0
 platform: ruby
 authors:
 - Katsuya Hidaka
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
-dependencies: []
+date: 2021-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
 description: Flexdot is a Flexible and Rake based dotfile manager
 email:
 - hidakatsuya@gmail.com
@@ -17,9 +45,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
+- ".github/dependabot.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -30,14 +59,14 @@ files:
 - lib/flexdot/backup.rb
 - lib/flexdot/index.rb
 - lib/flexdot/installer.rb
-- lib/flexdot/logger.rb
+- lib/flexdot/output.rb
 - lib/flexdot/tasks.rb
 - lib/flexdot/version.rb
 homepage: https://github.com/hidakatsuya/flexdot
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -45,15 +74,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: A Flexible and Rake based dotfile manager
 test_files: []

data/.github/FUNDING.yml

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

data/lib/flexdot/logger.rb

@@ -1,29 +0,0 @@
-# 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