effuse 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e208d054b1eb72349a276a147661a166d1ebe4f
-  data.tar.gz: d2e9ea2a776e62cfa3e1f4ae75ba4f6308d43e9a
+  metadata.gz: 01fcca7a41037832b35adf55ac340137179f2b52
+  data.tar.gz: b5eddc54ee5243de924620a40eef9c27e8a59216
 SHA512:
-  metadata.gz: 2823430b0105b2bd90fbe46e8a62920cc0830e2675320123ce25c08b35586b5d2e185b33c0c1ea163052ec78471774cea0ceb20729ec2cac1e2b14ec30a39334
-  data.tar.gz: c91052dda97b8a0e8ff34a3bbe2041b118911386faed70bbe9a2ff211b50dbc913ff9802f6953b19457ae208029385f3ca83b59a93fb08bcdbadd76accb3b9c2
+  metadata.gz: c2e4b5451947f1c3aa09e7c6d5622f51bc6a60bd3a17b89c5185a929a69f13f9b8c6903e6b61cfa4a2e15ed91d16aa82d67821ee9da2336c0590276a00ebc14f
+  data.tar.gz: 4cb6206d5d4a6d5ea70478505c1bd08ea00ca18af8b008b9f04cd16d54e7a2d512099bfc90383743587298a42d0313e82c88c50a3b663b22ba212d75b834b262

data/ChangeLog.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 2.1.0 (November 10 2013)
+
+ * Added support for `effuse.yml` files
+ * Deprecated `.effuseignore` files
+ * Added `--version` option
+
 ## 2.0.1 (May 14 2013)
 
  * Fix: Backup files by appending `.effuse`

data/README.md

@@ -1,6 +1,6 @@
 # Effuse
 
-A tool for symlinking dotfiles
+Tool for symlinking dotfiles.
 
 ## Install
 
@@ -10,54 +10,121 @@ gem install effuse
 
 ## Usage
 
-So, say you have all your precious dotfiles in a nice little git repository or
-Dropbox folder or whatever else you might use. It's a great way to be able to
-use your configurations on multiple computers, but how do you get those
-configurations out of the repository and into your filesystem?
+So, say you have all your precious dotfiles in a nice little git
+repository or Dropbox folder or whatever else you might use. It's a
+great way to be able to use your configurations on multiple computers,
+but how do you get those configurations out of the repository and into
+your filesystem?
 
-The answer: symbolic links. Lots of them. And how do you go about creating all
-these symlinks? Sure, you could create each one by hand, but you're a busy
-person and obviously don't have time for such menial tasks. Luckily, you've
-just discovered Effuse!
+The answer: symbolic links. Lots of them. And how do you go about
+creating all these symlinks? Sure, you could create each one by hand,
+but you're a busy person and obviously don't have time for such menial
+tasks. Luckily, you've just discovered Effuse!
 
-Just run `effuse` in your dotfiles repository and it will automagically create
-symlinks to all your configurations in your home directory!
+Just run `effuse` in your dotfiles repository and it will automagically
+create symlinks to all your configurations in your home directory!
 
-Your configurations don't go in your home directory? No problem! Just run
-`effuse /path/` and the symlinks will be created wherever your heart desires.
+Your configurations don't go in your home directory? No problem! Just
+run `effuse /path/` and the symlinks will be created wherever your heart
+desires.
 
 Would you rather import a dotfile from your system into your repository
 than replace it? No problem, just use `effuse --import`.
 
-Symlinks aren't working out for you? Effuse has got you covered. Just run
-`effuse --clean` in your dotfiles repository and it will remove all those nasty
-symlinks it created before.
+Symlinks aren't working out for you? Effuse has got you covered. Just
+run `effuse --clean` in your dotfiles repository and it will remove all
+those nasty symlinks it created before.
 
 Don't want to symlink a certain bothersome file? Why not tell Effuse
-your opinion on the matter using `effuse --exclude file`? Or why not
-give it a stern talking to using a `.effuseignore` file? Just put one
-file glob to exclude per line in there and never worry again.
+your opinion on the matter using `effuse --exclude file`?
+
+Maybe you don't like to have the files in your dotfiles repository named
+with leading dots. If that's what floats your boat, you can have Effuse
+prefix the symlink paths using `effuse --prefix .`.
+
+Now, say you want to create symlinks in `~/foo`, you want to exclude
+`*.bak` files, and you want to prefix your symlink paths with `.`.
+Specifying all those on the command line every time you run Effuse
+sounds horrible, doesn't it? Luckily, you can use an `effuse.yml` file
+instead!
+
+```yaml
+destination: ~/foo
+prefix: .
+exclude:
+  - '*.bak'
+```
+
+### Example
+
+```sh
+~ $ cd dotfiles
+dotfiles $ ls -a
+. .. .vimrc .zshrc .zsh
+dotfiles $ ls .zsh
+foo.zsh
+dotfiles $ effuse
+'/home/you/.vimrc' -> '/home/you/dotfiles/.vimrc'
+'/home/you/.zshrc' -> '/home/you/dotfiles/.zshrc'
+'/home/you/.zsh/foo.zsh' -> '/home/you/dotfiles/.zsh/foo.zsh'
+dotfiles $ file ~/.zsh/foo.zsh
+/home/you/.zsh/foo.zsh: symbolic link to `/home/you/dotfiles/.zsh/foo.zsh`
+```
+
+### Command Line
 
 ```
-Usage: effuse [OPTIONS] [DEST]
+usage: effuse [OPTIONS...] [DEST]
     -i, --import                     Import existing files
     -c, --clean                      Remove symlinks
 
-        --exclude GLOB               Exclude GLOB from symlinking
-        --include GLOB               Include GLOB in symlinking
-
     -y, --no-confirm                 Do not ask before replacing files
     -n, --no-backup                  Do not create backup files
 
-    -p, --prefix PREFIX              Prefix symlinked paths with PREFIX
+        --exclude GLOB               Exclude GLOB from symlinking
+        --include GLOB               Include GLOB in symlinking
+
+    -p, --prefix                     Prefix symlink paths with PREFIX
 
     -v, --verbose                    Show verbose output
+
+        --version                    Show version
     -h, --help                       Show this message
 ```
 
+### YAML File
+
+The `effuse.yml` file may contain the following keys:
+
+* `destination`: Symlink destination directory (defaults to `~`)
+* `prefix`: Symlink path prefix
+* `exclude`: Array of globs to exclude from symlinking
+* `include`: Array of globs to not exclude from symlinking
+
+### Migrating from 2.0 to 2.1
+
+Version 2.1 of Effuse deprecates the use of `.effuseignore` files in
+favor of `effuse.yml` files. To migrate, add each line of the ignore
+file to the `exclude` array of the YAML file.
+
+`.effuseignore`:
+
+```
+*.bak
+foo
+```
+
+`effuse.yml`:
+
+```yaml
+exclude:
+  - '*.bak'
+  - 'foo'
+```
+
 ## License
 
-Copyright (c) 2012-2013, Curtis McEnroe <programble@gmail.com>
+Copyright © 2012-2013, Curtis McEnroe <programble@gmail.com>
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above
@@ -70,4 +137,3 @@ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-

data/bin/effuse

@@ -1,161 +1,3 @@
 #!/usr/bin/env ruby
-
-require 'fileutils'
-require 'optparse'
-require 'ostruct'
-
-opts = OpenStruct.new(dest_dir: Dir.home,
-                      import:   false,
-                      clean:    false,
-                      confirm:  true,
-                      backup:   true,
-                      prefix:   '',
-                      verbose:  false,
-                      exclude:  %w[*~ .*~ .*.swp
-                                   .effuseignore *.effuse .*.effuse
-                                   .git .gitignore .gitmodules])
-
-if File.file?('.effuseignore')
-  File.open('.effuseignore').each_line do |glob|
-    opts.exclude << glob.chomp
-  end
-end
-
-OptionParser.new do |o|
-  o.banner = 'Usage: effuse [OPTIONS] [DEST]'
-
-  o.on('-i', '--import', 'Import existing files') { opts.import = true }
-  o.on('-c', '--clean', 'Remove symlinks') { opts.clean = true }
-
-  o.separator ''
-
-  o.on('--exclude GLOB', 'Exclude GLOB from symlinking') do |glob|
-    opts.exclude << glob
-  end
-  o.on('--include GLOB', 'Include GLOB in symlinking') do |glob|
-    opts.exclude.delete(glob)
-  end
-
-  o.separator ''
-
-  o.on('-y', '--no-confirm', 'Do not ask before replacing files') do
-    opts.confirm = false
-  end
-  o.on('-n', '--no-backup', 'Do not create backup files') do
-    opts.backup = false
-  end
-
-  o.separator ''
-
-  o.on('-p', '--prefix PREFIX', 'Prefix symlinked paths with PREFIX') do |prefix|
-    opts.prefix = prefix
-  end
-
-  o.separator ''
-
-  o.on('-v', '--verbose', 'Show verbose output') { opts.verbose = true }
-  o.on_tail('-h', '--help', 'Show this message') do
-    puts o
-    exit
-  end
-end.parse!
-
-opts.dest_dir = ARGV[0] if ARGV[0]
-
-if File.identical?(opts.dest_dir, '.')
-  puts 'error: destination directory is current directory'
-  exit 1
-end
-
-$opts = opts # Don't hate me
-
-def vputs(s)
-  puts s if $opts.verbose
-end
-
-def confirm?(s)
-  return true unless $opts.confirm
-  loop do
-    print "#{s} [Y/n] "
-    input = $stdin.gets.chomp
-    return true if input.empty? || input[0].downcase == ?y
-    return false if input[0].downcase == ?n
-  end
-end
-
-def backup(src)
-  if $opts.backup
-    vputs "renaming '#{src}' -> '#{src}.effuse'"
-    File.rename(src, src + '.effuse')
-  else
-    vputs "deleting '#{src}'"
-    File.delete(src)
-  end
-end
-
-dirs = ['.']
-files = {}
-
-dirs.each do |dir|
-  vputs "scanning '#{dir}'"
-  Dir.foreach(dir) do |file|
-    next if ['.', '..'].include?(file)
-
-    if opts.exclude.any? {|glob| File.fnmatch(glob, file) }
-      vputs "excluding '#{File.join(dir, file)}'"
-      next
-    end
-
-    file = File.join(dir, file)
-
-    if File.directory?(file)
-      vputs "adding '#{file}'"
-      dirs << file
-      next
-    end
-
-    vputs "found '#{file}'"
-    relpath = opts.prefix + File.join(file.split('/').drop(1))
-    files[File.absolute_path(file)] = File.join(opts.dest_dir, relpath)
-  end
-end
-
-if opts.clean
-  files.each_pair do |src, dest|
-    if File.exist?(dest) && File.identical?(src, dest)
-      puts dest
-      File.delete(dest)
-    else
-      vputs "not symlinked '#{dest}'"
-    end
-  end
-else
-  files.each_pair do |src, dest|
-    if File.exist?(dest)
-      if File.identical?(src, dest)
-        vputs "already symlinked '#{dest}'"
-        next
-      elsif opts.import
-        if confirm?("'#{dest}' already exists. Import it?")
-          backup(src)
-          vputs "renaming '#{dest}' -> '#{src}'"
-          File.rename(dest, src)
-        else
-          vputs "skipping '#{dest}'"
-          next
-        end
-      else # Replace destination file
-        if confirm?("'#{dest}' already exists. Replace it?")
-          backup(dest)
-        else
-          vputs "skipping '#{dest}'"
-          next
-        end
-      end
-    end
-
-    puts "'#{dest}' -> '#{src}'"
-    FileUtils.mkdir_p(File.dirname(dest))
-    File.symlink(src, dest)
-  end
-end
+require 'effuse'
+Effuse.new.execute

data/effuse.gemspec

@@ -1,12 +1,17 @@
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+require 'effuse'
+
 Gem::Specification.new do |s|
-  s.name = 'effuse'
-  s.version = '2.0.1'
-  s.authors = ['Curtis McEnroe']
-  s.email = ['programble@gmail.com']
-  s.homepage = 'https://github.com/programble/effuse'
-  s.summary = 'A tool for symlinking dotfiles'
-  s.description = s.summary
+  s.name          = 'effuse'
+  s.version       = Effuse::VERSION
+  s.authors       = ['Curtis McEnroe']
+  s.email         = ['programble@gmail.com']
+  s.homepage      = 'https://github.com/programble/effuse'
+  s.licenses      = ['ISC']
+  s.summary       = 'Tool for symlinking dotfiles'
+  s.description   = s.summary
 
-  s.files = `git ls-files`.split("\n")
-  s.executables = 'effuse'
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = 'effuse'
+  s.require_paths = ['lib']
 end

data/lib/effuse.rb

@@ -0,0 +1,211 @@
+require 'fileutils'
+require 'yaml'
+require 'optparse'
+
+class Effuse
+  VERSION = '2.1.0'
+
+  def initialize
+    @dest_dir = Dir.home
+    @import   = false
+    @clean    = false
+    @confirm  = true
+    @backup   = true
+    @prefix   = ''
+    @verbose  = false
+    @exclude  = %w[*~ .*~ .*.sw? .effuseignore effuse.yml *.effuse .*.effuse
+                   .git .gitignore .gitmodules]
+
+    ignore_file
+    effuse_file
+    options
+
+    vputs self.inspect
+  end
+
+  def ignore_file
+    return unless File.file? '.effuseignore'
+    puts 'warning: ignore file is deprecated, use effuse.yml instead'
+    File.readlines('.effuseignore').each do |glob|
+      @exclude << glob.chomp
+    end
+  end
+
+  def effuse_file
+    return unless File.file? 'effuse.yml'
+    yaml = YAML.load_file('effuse.yml')
+
+    if yaml.include? 'destination'
+      @dest_dir = File.expand_path(yaml['destination'])
+    end
+    @prefix = yaml['prefix'] if yaml.include? 'prefix'
+
+    exclude = yaml['exclude'] || yaml['ignore']
+    @exclude.concat(exclude) if exclude
+    @exclude -= yaml['include'] if yaml.include? 'include'
+  end
+
+  def options
+    OptionParser.new do |o|
+      o.banner = 'usage: effuse [OPTIONS...] [DEST]'
+
+      o.on('-i', '--import', 'Import existing files') do
+        @import = true
+      end
+      o.on('-c', '--clean', 'Remove symlinks') do
+        @clean = true
+      end
+
+      o.separator ''
+
+      o.on('-y', '--no-confirm', 'Do not ask before replacing files') do
+        @confirm = false
+      end
+      o.on('-n', '--no-backup', 'Do not create backup files') do
+        @backup = false
+      end
+
+      o.separator ''
+
+      o.on('--exclude GLOB', 'Exclude GLOB from symlinking') do |glob|
+        @exclude << glob
+      end
+      o.on('--include GLOB', 'Include GLOB in symlinking') do |glob|
+        @exclude.delete(glob)
+      end
+
+      o.separator ''
+
+      o.on('-p', '--prefix', 'Prefix symlink paths with PREFIX') do |prefix|
+        @prefix = prefix
+      end
+
+      o.separator ''
+
+      o.on('-v', '--verbose', 'Show verbose output') do
+        @verbose = true
+      end
+
+      o.separator ''
+
+      o.on_tail('--version', 'Show version') do
+        puts "effuse #{VERSION}"
+        exit
+      end
+      o.on_tail('-h', '--help', 'Show this message') do
+        puts o
+        exit
+      end
+    end.parse!
+    @dest_dir = ARGV.first if ARGV.first
+  end
+
+  def vputs(s)
+    puts(s) if @verbose
+  end
+
+  def confirm? s
+    return true unless @confirm
+    loop do
+      print "#{s} [Y/n] "
+      input = $stdin.gets.chomp
+      return true if input.empty? || input[0].downcase == ?y
+      return false if input[0].downcase == ?n
+    end
+  end
+
+  def backup(src)
+    if @backup
+      vputs "renaming '#{src}' -> '#{src}.effuse'"
+      File.rename(src, src + '.effuse')
+    else
+      vputs "deleting '#{src}'"
+      File.delete(src)
+    end
+  end
+
+  def scan
+    dirs = ['.']
+    files = {}
+
+    dirs.each do |dir|
+      vputs "scanning '#{dir}'"
+      Dir.foreach(dir) do |entry|
+        next if %w[. ..].include? entry
+
+        path = File.join(dir, entry)
+
+        if @exclude.any? {|g| File.fnmatch(g, entry) }
+          vputs "excluding '#{path}'"
+          next
+        end
+
+        if File.directory? path
+          dirs << path
+          next
+        end
+
+        vputs "adding '#{path}'"
+        relpath = @prefix + File.join(path.split('/').drop(1))
+        files[File.absolute_path(path)] = File.join(@dest_dir, relpath)
+      end
+    end
+
+    files
+  end
+
+  def clean(files)
+    files.each do |src, dest|
+      if File.exist?(dest) && File.identical?(src, dest)
+        puts dest
+        File.delete(dest)
+      else
+        vputs "'#{dest}' not symlinked"
+      end
+    end
+  end
+
+  def symlink(files)
+    files.each do |src, dest|
+      if File.exist? dest
+        if File.identical? src, dest
+          vputs "'#{dest}' already symlinked"
+          next
+        elsif @import
+          if confirm? "'#{dest}' already exists. Import it?"
+            backup(src)
+            vputs "renaming '#{dest}' -> '#{src}'"
+            File.rename(dest, src)
+          else
+            vputs "skipping '#{dest}'"
+            next
+          end
+        else # Replace destination file
+          if confirm? "'#{dest}' already exists. Replace it?"
+            backup(dest)
+          else
+            vputs "skipping '#{dest}'"
+            next
+          end
+        end
+      end
+
+      puts "'#{dest}' -> '#{src}'"
+      FileUtils.mkdir_p(File.dirname(dest))
+      File.symlink(src, dest)
+    end
+  end
+
+  def execute
+    if File.identical? @dest_dir, '.'
+      puts 'error: destination directory is current directory'
+      exit 1
+    end
+
+    if @clean
+      clean(scan)
+    else
+      symlink(scan)
+    end
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: effuse
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Curtis McEnroe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-11-10 00:00:00.000000000 Z
 dependencies: []
-description: A tool for symlinking dotfiles
+description: Tool for symlinking dotfiles
 email:
 - programble@gmail.com
 executables:
@@ -18,13 +18,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - ChangeLog.md
 - README.md
 - bin/effuse
 - effuse.gemspec
+- lib/effuse.rb
 homepage: https://github.com/programble/effuse
-licenses: []
+licenses:
+- ISC
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -32,18 +34,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
-summary: A tool for symlinking dotfiles
+summary: Tool for symlinking dotfiles
 test_files: []