flexdot 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbeccda096b5cffa6592e2fd044091357384a1be8eed6d692f2ddfd8e7b6cb3e
-  data.tar.gz: cb0bb15f3a618e50ebe0c4e5db1fc325e426ba357f4ccfbddfd5110ec263a172
+  metadata.gz: c373b333d8109e552863dc5e8dc1ce031d04b7344d80269c591408688cd70ade
+  data.tar.gz: ee06b19abd37b90a35c0b9ced7a0c28a18c4d757f03318773763628efc1320f0
 SHA512:
-  metadata.gz: 93df4b1412f1fbaccc3a242f68a569955435e2271d9cab0de29ec62cd04d760997162bb81fb1573454d837d29ba34606e6ef9a8d83b0c07cab5238c28cbfa62b
-  data.tar.gz: 89284ebc88a5c475e53e80a6049bfa2bd37d498bf4a600ecd9ba1637a5c170951a9aa6be749e72adef587b691865c686a2ae834ea973f78674f1e32effd56a54
+  metadata.gz: fe5589432db9a290342835c1799a8ff19f3e59df553e21b40de0bf059d6d8ea65ba0f1eb3a0929d5678d22ce47182e9d531c15d9486a19b71f68e80955ef6d0d
+  data.tar.gz: 158067f3e822573f3d2a28b72b85f6dc4fb88afe532c9a2504c4cffff42720be1734a3b3e3253ec529cfc32e2f1f795e06119cf8448dec564a49652a104676af

data/.github/workflows/test.yml

@@ -7,15 +7,16 @@ 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.6
           - 2.7
-          - 3.0
+          - '3.0'
+          - 3.1
     steps:
     - uses: actions/checkout@v2
 

data/.gitignore

@@ -2,7 +2,6 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/README.md

@@ -9,7 +9,7 @@ A Flexible and Rake based dotfile manager.
 
 ### Prerequisite
 
-Ruby 2.6+
+Ruby 2.7+
 
 ### Installing
 
@@ -53,6 +53,12 @@ Flexdot.setup(
   # Whether or not to colorize the output
   # Default: true
   output_colorize: true
+
+  # (optional)
+  # Whether to automatically delete old backups.
+  # If nil, do not delete, otherwise keep to the specified number of backups.
+  # Default: nil
+  keep_max_backup_count: 10
 )
 ```
 
@@ -68,188 +74,9 @@ Finally, run `rake -T` in the `$HOME/dotfiles` and make sure that the output is
     $ 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
-```
-
-### 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:
-
-    $ 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 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` 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`.
+## Usage
 
-    $ rake clear_backups
+See [doc/example.md](doc/example.md)
 
 ## License
 

data/doc/example.md

@@ -0,0 +1,182 @@
+# 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
+```
+
+## 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:
+
+    $ 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 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` 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

data/flexdot.gemspec

@@ -10,7 +10,7 @@ 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.6.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }

data/lib/flexdot/backup.rb

@@ -19,8 +19,9 @@ module Flexdot
       end
     end
 
-    def initialize
+    def initialize(keep_max_count)
       backup_dir.mkpath unless backup_dir.exist?
+      @keep_max_count = keep_max_count
       @finished = false
     end
 
@@ -34,6 +35,16 @@ module Flexdot
       @finished = true
     end
 
+    def remove_outdated!
+      return if @keep_max_count.nil?
+
+      backups = self.class.base_dir.glob('*/').select { |dir| dir.basename.to_s.match?(/\d{14}/) }
+      backups.sort_by! { |dir| dir.basename.to_s }.reverse!
+      backups.slice!(0, @keep_max_count)
+
+      backups.each(&:rmtree)
+    end
+
     private
 
     def backup_dir

data/lib/flexdot/installer.rb

@@ -8,12 +8,12 @@ require_relative 'index'
 
 module Flexdot
   class Installer
-    def initialize(name, dotfiles_dir, home_dir, output_colorize)
+    def initialize(name, home_dir, dotfiles_dir, options)
       @name = name
       @dotfiles_dir = dotfiles_dir
       @home_dir = home_dir
-      @backup = Backup.new
-      @output = Output.new(@home_dir, colorize: output_colorize)
+      @backup = Backup.new(options.keep_max_backup_count)
+      @output = Output.new(@home_dir, colorize: options.output_colorize)
     end
 
     def install(index_file)
@@ -23,11 +23,12 @@ module Flexdot
       end
 
       backup.finish!
+      backup.remove_outdated!
     end
 
     private
 
-    attr_reader :name, :dotfiles_dir, :home_dir, :backup, :output
+    attr_reader :name, :home_dir, :dotfiles_dir, :backup, :output
 
     def install_link(dotfile_path, home_file_path)
       dotfile = @dotfiles_dir.join(dotfile_path).expand_path

data/lib/flexdot/tasks.rb

@@ -10,10 +10,10 @@ module Flexdot
 
     Index = Struct.new(:filename, :name, keyword_init: true)
 
-    def initialize(dotfiles_dir, home_dir, output_colorize)
-      @dotfiles_dir = Pathname.new(dotfiles_dir).expand_path
+    def initialize(home_dir, options)
       @home_dir = Pathname.new(home_dir).expand_path
-      @output_colorize = output_colorize
+      @dotfiles_dir = Pathname.new(options.dotfiles_dir).expand_path
+      @options = options
     end
 
     def install
@@ -28,9 +28,9 @@ module Flexdot
           task index.name do
             installer = Installer.new(
               index.name,
-              dotfiles_dir,
               home_dir,
-              output_colorize
+              dotfiles_dir,
+              options
             )
             installer.install(index.filename)
           end
@@ -40,7 +40,7 @@ module Flexdot
 
     private
 
-    attr_reader :dotfiles_dir, :home_dir, :output_colorize
+    attr_reader :home_dir, :dotfiles_dir, :options
 
     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.2.0'
+  VERSION = '3.3.0'
 end

data/lib/flexdot.rb

@@ -6,7 +6,31 @@ require_relative 'flexdot/version'
 require_relative 'flexdot/tasks'
 
 module Flexdot
-  def self.setup(home_dir:, dotfiles_dir: '.', output_colorize: true)
-    Tasks.new(dotfiles_dir, home_dir, output_colorize).install
+  Options = Struct.new(
+    # The dotfile directory path.
+    # Default: '.'.
+    :dotfiles_dir,
+
+    # Whether or not to colorize the output
+    # Default: true
+    :output_colorize,
+
+    # Whether to automatically delete old backups.
+    # If nil, do not delete, otherwise keep to the specified number of backups.
+    # Default: nil
+    :keep_max_backup_count,
+
+    keyword_init: true
+  )
+
+  DEFAULT_OPTIONS = {
+    dotfiles_dir: '.',
+    output_colorize: true,
+    keep_max_backup_count: nil
+  }
+
+  def self.setup(home_dir:, **options)
+    opts = Options.new(DEFAULT_OPTIONS.merge(options))
+    Tasks.new(home_dir, opts).install
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexdot
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-28 00:00:00.000000000 Z
+date: 2022-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -48,12 +48,12 @@ files:
 - ".github/dependabot.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
-- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- doc/example.md
 - flexdot.gemspec
 - lib/flexdot.rb
 - lib/flexdot/backup.rb
@@ -74,14 +74,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A Flexible and Rake based dotfile manager

data/CHANGELOG.md

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