flexdot 1.0.2 → 2.0.0

checksums.yaml

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

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,29 @@
+## 2.0.0
+
+### Breaking Changes
+
+v1.0.x
+
+```ruby
+# Rakefile
+Flexdot.install_tasks(
+  target_dir: '/home/username',
+  base_dir: '.'
+)
+```
+
+v2.0.0
+
+```ruby
+Flexdot.setup(
+  home_dir: '/home/username',
+  dotfiles_dir: '.'
+)
+```
+
+### Enchancements
+
+- Add default_index option fixes #2
+- Option renaming and simplification by default value
+
+Please refer to README.md for details.

data/Gemfile

@@ -4,3 +4,4 @@ gemspec
 
 gem 'rake', '>= 12.0'
 gem 'minitest', '~> 5.0'
+gem 'rr', '>= 1.2.1'

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.
@@ -12,25 +13,48 @@ Ruby 2.5+
 
 ### 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)
+  # The `rake install` command will be available to install the dotfile for the specified index file.
+  # Default nil.
+  #
+  # Note that the `rake install` command is always available if you have a single index file.
+  default_index: 'name_of_an_index_file'
 )
 ```
 
@@ -94,12 +118,24 @@ $HOME/dotfiles
 └── Rakefile
 ```
 
+### Rakefile
+
+```ruby
+require 'flexdot'
+
+Flexdot.setup(
+  home_dir: '..',
+  default_index: 'macOS'
+)
+```
+
 ### 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         # Install dotfiles for macOS
     rake install:macOS   # Install dotfiles for macOS
     rake install:ubuntu  # Install dotfiles for ubuntu
 
@@ -177,6 +213,10 @@ ubuntu:
 
 ### Installing dotfiles
 
+    $ rake install
+
+Or
+
     $ rake install:macOS
 
 The following is the output result:

data/lib/flexdot.rb

@@ -4,7 +4,7 @@ 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: '.', default_index: nil)
+    Tasks.new(dotfiles_dir, home_dir, default_index).install
   end
 end

data/lib/flexdot/{logger.rb → console.rb}

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

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,53 @@
 
 require 'yaml'
 
-require_relative 'logger'
+require_relative 'console'
 require_relative 'backup'
 require_relative 'index'
 
 module Flexdot
   class Installer
-    def initialize(name, base_dir:, target_dir:)
+    def initialize(name, dotfiles_dir:, home_dir:)
       @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)
+      @console = Console.new(@home_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)
+      index.each do |dotfile_path:, home_file_path:|
+        install_link(dotfile_path, home_file_path)
       end
     end
 
     private
 
-    attr_reader :name, :base_dir, :target_dir, :backup, :logger
+    attr_reader :name, :dotfiles_dir, :home_dir, :backup, :console
 
-    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
+      console.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/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, default_index_name = nil)
+      @default_index_name = default_index_name
+      @dotfiles_dir = Pathname.new(dotfiles_dir).expand_path
+      @home_dir = Pathname.new(home_dir).expand_path
     end
 
     def install
@@ -20,25 +23,48 @@ 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: dotfiles_dir,
+              home_dir: home_dir
             )
-            installer.install(index_file)
+            installer.install(index.filename)
           end
         end
       end
+
+      if default_index
+        desc "Install dotfiles for #{default_index.name}"
+        task :install do
+          Rake::Task["install:#{default_index.name}"].invoke
+        end
+      end
     end
 
     private
 
-    attr_reader :base_dir, :target_dir
+    attr_reader :dotfiles_dir, :home_dir
+
+    def default_index
+      @default_index ||=
+        if @default_index_name
+          ifnone = -> { raise "#{@default_index_name} index is not found" }
+          indexes.find(ifnone) { |index| index.name == @default_index_name }
+        elsif indexes.size == 1
+          indexes.first
+        else
+          nil
+        end
+    end
+
+    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 = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexdot
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies: []
 description: Flexdot is a Flexible and Rake based dotfile manager
 email:
@@ -20,6 +20,7 @@ files:
 - ".github/FUNDING.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -28,9 +29,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/logger.rb
 - lib/flexdot/tasks.rb
 - lib/flexdot/version.rb
 homepage: https://github.com/hidakatsuya/flexdot