flexdot 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abd911eda16fc28b419271e8e75d96f33314f2cc73cc850180966c16cb7fca4f
-  data.tar.gz: d3f84e097a314f4fc83772e5cc63874f2c3e0adf9658967b56269b52f3a284d2
+  metadata.gz: 48d7de6cd3258b46931514ab34fa84153a7a76f63b425a081cb2f422142b40c4
+  data.tar.gz: e4f4e78e06806b7cc5e0b916c43d1079c4c1bf05c1777996d969e909c8ae4d0b
 SHA512:
-  metadata.gz: 844806f825d04329fc3fd63a893925e928075afc08c9d6bfcf262bb1b4dac0429edd0525cd68b7744e82dd08deccd10bc41f33e628bb72bb59a94448604b9505
-  data.tar.gz: 0dbbd2c56ab172c289206fc8e480be8deef399e2f153213046a83e61497010e8652ce67844f88fade41b29c41a8e8be842e4b8ff3f693d4722e26d6937bd55cd
+  metadata.gz: c3a96c01c6878c0643e88240f48d5f82273c58d320beca92573fba885fef38aab776743e1cbaaa8a3a2af6ab29b8a8b9898a34b1ba3853d601ac9ecba47efca5
+  data.tar.gz: 2b2deae37d254ba1139553b679da60fa1186fa175adcc4cdfc760902fd666aadaab957533d47d2927584d16086ca10aa3c5c0bb5dacdee425f581fba43f78808

data/.github/dependabot.yml

@@ -0,0 +1,16 @@
+# 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"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/test.yml

@@ -7,20 +7,28 @@ 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.5
+          - 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/CHANGELOG.md

@@ -1,29 +1,68 @@
+## 3.0.0
+
+### Breaking Changes
+
+Revert 'Add default_index option #2'. Please follow the instructions below to migrate:
+
+First, modify your Rakefile as follows:
+
+```diff
+require 'flexdot'
+
+Flexdot.setup(
++   home_dir: '..'
+-   home_dir: '..',
+-   default_index: 'macOS'
+)
+
++ task default: 'install:macOS'
+```
+
+Then, update flexdot:
+
+```
+$ bundle update flexdot
+```
+
+Now you can run the following command to install the default index dotfiles:
+
+```
+$ rake
+```
+
 ## 2.0.0
 
 ### Breaking Changes
 
-v1.0.x
+- Change the syntax of configuration in the `Rakefile`
+
+### Enchancements
+
+- Add `default_index` option fixes #2
+- Option renaming and simplification by default value
+
+### Migrating from v1.0.x
+
+First, you need to rewrite the `Rakefile` configuration to the v2.0.0 syntax.
 
 ```ruby
-# Rakefile
+# v1.0.x
 Flexdot.install_tasks(
   target_dir: '/home/username',
   base_dir: '.'
 )
 ```
 
-v2.0.0
-
 ```ruby
+# v2.0.0
 Flexdot.setup(
   home_dir: '/home/username',
   dotfiles_dir: '.'
 )
 ```
 
-### Enchancements
+Note that If the `dotfiles_dir` option is `'.'` (current directory) , you can omit it.
 
-- Add default_index option fixes #2
-- Option renaming and simplification by default value
+Then, update flexdot to v2.0.0 and you're done.
 
-Please refer to README.md for details.
+    $ bundle update flexdot

data/Gemfile

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

data/README.md

@@ -47,17 +47,17 @@ Flexdot.setup(
   # (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'
+  dotfiles_dir: '.'
 )
 ```
 
+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
@@ -124,9 +124,12 @@ $HOME/dotfiles
 require 'flexdot'
 
 Flexdot.setup(
-  home_dir: '..',
-  default_index: 'macOS'
+  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
@@ -135,7 +138,6 @@ When you run the `rake -T` command in that directory structure, you should have
 
     $ 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
 
@@ -211,11 +213,11 @@ ubuntu:
     stop.sh: .xkeysnail
 ```
 
-### Installing dotfiles
+### Installing dotfiles for macOS
 
-    $ rake install
+    $ rake
 
-Or
+Or,
 
     $ rake install:macOS
 

data/lib/flexdot.rb

@@ -4,7 +4,7 @@ require_relative 'flexdot/version'
 require_relative 'flexdot/tasks'
 
 module Flexdot
-  def self.setup(home_dir:, dotfiles_dir: '.', default_index: nil)
-    Tasks.new(dotfiles_dir, home_dir, default_index).install
+  def self.setup(home_dir:, dotfiles_dir: '.')
+    Tasks.new(dotfiles_dir, home_dir).install
   end
 end

data/lib/flexdot/tasks.rb

@@ -10,8 +10,7 @@ module Flexdot
 
     Index = Struct.new(:filename, :name, keyword_init: true)
 
-    def initialize(dotfiles_dir, home_dir, default_index_name = nil)
-      @default_index_name = default_index_name
+    def initialize(dotfiles_dir, home_dir)
       @dotfiles_dir = Pathname.new(dotfiles_dir).expand_path
       @home_dir = Pathname.new(home_dir).expand_path
     end
@@ -35,31 +34,12 @@ module Flexdot
           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 :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)

data/lib/flexdot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexdot
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Katsuya Hidaka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2021-04-11 00:00:00.000000000 Z
 dependencies: []
 description: Flexdot is a Flexible and Rake based dotfile manager
 email:
@@ -18,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/FUNDING.yml"
+- ".github/dependabot.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - CHANGELOG.md
@@ -53,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A Flexible and Rake based dotfile manager