flexdot 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d1b112b651204f8ce82ddad718e2b6673e7c0d898704b7e43aea5328040c869
-  data.tar.gz: 917fb9ffe2100da70b42dc5f96666104bea4f603aa71026e2aaaa497f5e220e5
+  metadata.gz: fbeccda096b5cffa6592e2fd044091357384a1be8eed6d692f2ddfd8e7b6cb3e
+  data.tar.gz: cb0bb15f3a618e50ebe0c4e5db1fc325e426ba357f4ccfbddfd5110ec263a172
 SHA512:
-  metadata.gz: 9718bc11bcc0181d8803b91fc62f54d515cdb52b49aa8629239ffe841eac8f7edc867bcbaae547648c1ffbe3a0f2334628eabc3cd40c8c4e71b03c4e56c8a1a3
-  data.tar.gz: '08e880cd0f2e81ad725b2057dcfb50fac18a6c1fa93b72e41d6f453a1d33883b3fcb25d68252f187f6fbaa966640c2dfac2b044f52a677dc8f045f609bfa7d2b'
+  metadata.gz: 93df4b1412f1fbaccc3a242f68a569955435e2271d9cab0de29ec62cd04d760997162bb81fb1573454d837d29ba34606e6ef9a8d83b0c07cab5238c28cbfa62b
+  data.tar.gz: 89284ebc88a5c475e53e80a6049bfa2bd37d498bf4a600ecd9ba1637a5c170951a9aa6be749e72adef587b691865c686a2ae834ea973f78674f1e32effd56a54

data/README.md

@@ -48,6 +48,11 @@ Flexdot.setup(
   # The dotfile directory path.
   # Default '.'.
   dotfiles_dir: '.'
+
+  # (optional)
+  # Whether or not to colorize the output
+  # Default: true
+  output_colorize: true
 )
 ```
 
@@ -224,17 +229,17 @@ Or,
 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

@@ -18,4 +18,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rake', '>= 12.0'
+  spec.add_dependency 'paint', '>= 2.2.1'
 end

data/lib/flexdot/installer.rb

@@ -2,18 +2,18 @@
 
 require 'yaml'
 
-require_relative 'console'
+require_relative 'output'
 require_relative 'backup'
 require_relative 'index'
 
 module Flexdot
   class Installer
-    def initialize(name, dotfiles_dir:, home_dir:)
+    def initialize(name, dotfiles_dir, home_dir, output_colorize)
       @name = name
       @dotfiles_dir = dotfiles_dir
       @home_dir = home_dir
       @backup = Backup.new
-      @console = Console.new(@home_dir)
+      @output = Output.new(@home_dir, colorize: output_colorize)
     end
 
     def install(index_file)
@@ -27,13 +27,13 @@ module Flexdot
 
     private
 
-    attr_reader :name, :dotfiles_dir, :home_dir, :backup, :console
+    attr_reader :name, :dotfiles_dir, :home_dir, :backup, :output
 
     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
 
-      console.log(home_file) do |status|
+      output.log(home_file) do |status|
         if home_file.symlink?
           if home_file.readlink == dotfile
             status.result = :already_linked

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

@@ -10,9 +10,10 @@ module Flexdot
 
     Index = Struct.new(:filename, :name, keyword_init: true)
 
-    def initialize(dotfiles_dir, home_dir)
+    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
@@ -27,8 +28,9 @@ module Flexdot
           task index.name do
             installer = Installer.new(
               index.name,
-              dotfiles_dir: dotfiles_dir,
-              home_dir: home_dir
+              dotfiles_dir,
+              home_dir,
+              output_colorize
             )
             installer.install(index.filename)
           end
@@ -38,7 +40,7 @@ module Flexdot
 
     private
 
-    attr_reader :dotfiles_dir, :home_dir
+    attr_reader :dotfiles_dir, :home_dir, :output_colorize
 
     def indexes
       @indexes ||= Pathname.new(dotfiles_dir).glob('*.yml').map do |index_file|

data/lib/flexdot/version.rb

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

data/lib/flexdot.rb

@@ -6,7 +6,7 @@ require_relative 'flexdot/version'
 require_relative 'flexdot/tasks'
 
 module Flexdot
-  def self.setup(home_dir:, dotfiles_dir: '.')
-    Tasks.new(dotfiles_dir, home_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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexdot
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-18 00:00:00.000000000 Z
+date: 2021-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !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
@@ -43,9 +57,9 @@ files:
 - flexdot.gemspec
 - lib/flexdot.rb
 - lib/flexdot/backup.rb
-- lib/flexdot/console.rb
 - lib/flexdot/index.rb
 - lib/flexdot/installer.rb
+- lib/flexdot/output.rb
 - lib/flexdot/tasks.rb
 - lib/flexdot/version.rb
 homepage: https://github.com/hidakatsuya/flexdot

data/lib/flexdot/console.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Flexdot
-  class Console
-    Status = Struct.new(:home_file, :result, :backuped)
-
-    def initialize(dotfiles_dir)
-      @dotfiles_dir = dotfiles_dir
-    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)
-      [].tap { |msg|
-        msg << "[#{status.result}]"
-        msg << status.home_file.relative_path_from(dotfiles_dir)
-        msg << '(backup)' if status.backuped
-      }.join(' ')
-    end
-  end
-end