sundae 0.9.2 → 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+doc
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/{History.txt → CHANGELOG}

@@ -1,3 +1,11 @@
+=== 1.0.0 / 2012-02-21
+
+* Backwards incompatible: use Ruby for config file (not YAML)
+* minor enhancements:
+  * support globs or regexp for ignore_paths
+  * better documentation
+  * switched to bones for gem config
+
 === 0.9.2 / 2009-04-28
 
 * 1 minor enhancement

data/README.rdoc

@@ -0,0 +1,155 @@
+= Sundae
+
+== Synopsis
+
+(Re)generates directories by mixing the file hierarchies contained in
+various 'mounted' directories.  The generated directories contain
+symbolic links to the mounted files.  Combined with other tools (to
+sync files), this scheme allows you to create separate collections of
+files (work, personal, reference, linux, osx, etc.), choose which of
+these you want to mount on each of your computers, and then build a
+hierarchy that allows you to work on them side by side.
+
+For example, let's take your bash config files.  You want to separate
+startup commands that you use on all unix computers from those that
+you only need on Linux or OS X.  Plus maybe you have some aliases that
+you use only at work and some that you need only at home.  
+
+Rewrite your .bashrc to load everything in ~/etc/bash.  Store that
+file and your other bash config files in a folder with just general
+*nix bash stuff.  Then use Sundae to create links in ~/etc/bash to all
+of the things that you need for your particular computer (general unix
+stuff + either linux or OS X stuff + work aliases + ...).  The files
+are together in one folder so your script knows to read them, but they
+can be version controlled and/or synced across all of your computers
+in separate bundles (one for *nix, one for ubuntu, one for OS X,
+etc.).
+
+You have to figure out how to use this model.  It's not for everyone.
+It requires rewriting config files, making sure certain files kept in
+different folders don't have the same name, etc.  But it's worth it
+when you sit down at a new computer and say "I only want to use my
+*nix and linux config files, my work files, and music" and it all just
+works. Like this:
+
+    ~> ls
+    Desktop  local  mnt  src  WualaDrive
+    ~> sundae
+    ~> ls
+    bin  Desktop  doc  etc  lib  local  mnt  share  src  tmp  var  WualaDrive
+
+== Install
+
+  sudo gem install sundae
+
+== Usage
+
+The first time you run Sundae, it will create a template config file
+in your home directory.  This file, <tt>.sundae</tt>, needs to be
+customized.  It is just a Ruby file that defines the following:
+
+[+configatron.paths+]          
+  array; where the collections are stored
+[+configatron.ignore_rules+]
+  array; each element is a string or Regexp and becomes a rule that prevents
+  links to files or directories that match the Regexp.  Globs in strings are expanded.
+
+The hierarchy in <em>path</em> should look something like
+this:
+
+  path/
+  |-- collection1/
+  |   |-- mnt1/
+  |   |   |-- real_files_and_dirs
+  |   |   ` ...
+  |   |-- mnt2/
+  `-- collection2/
+      ` ...
+
+Why is this double layer "collection" stuff going on?  Because while
+most of the time you can share a whole folder between computers,
+sometimes you want to mix your config files into a folder that also
+contains nonsymlinked files.
+
+For example, your ~/.ssh folder probably has a public and private key
+that you want to stay unique to that machine, but you might want to
+mix in a "config" file that has host aliases that you share between
+machines.  This is how you do that.  I do it with my .unison, .mocp,
+.ssh, and .lftp folders.
+
+For example, the hierarchy in my <em>path</em>s looks sort of like this:
+
+  ~/mnt/git/             <-- "path"
+  |-- nix/               <-- "collection"
+  |   |-- home/          <-- "mnt"
+  |   |   |-- .emacs.d/     (~/.emacs.d will point here)
+  |   |   |-- etc/          (~/etc will point here)
+  |   |   ` ...
+  |   |-- dot-unison
+  |   |   |-- .sundae_path  (says "~/.unison")
+  |   |   |-- default.prf   (~/.unison/default.prf will point here)
+  |   |   `
+  |   |
+  |-- osx/   
+  |   |-- home_library/     (says "~/Library")
+  |   |   |-- .sundae_path
+  |   |   `-- Library-Keyboard_Layouts/
+  |   |       `-- Keyboard Layouts/
+  |   |           ` Colemak.keylayout
+  |   |
+  |-- personal
+  |   `-- home/
+  |       |-- doc/
+  |       |   ` ...
+  |       ` ... 
+  ` ...    
+  ~/mnt/sync/            <-- "path"
+  |-- reference          <-- "collection"
+  |   |-- home/          <-- "mnt"
+  |       ` ...
+  |-- music
+  |   |-- home/          
+  |       ` ...
+  ` ...
+
+Sundae will act on all of the <em>mnt</em>s--subdirectories of the
+<em>collection</em>s, that is, the sub-subdirectories of the
+<em>path</em>.  The "collections" are only there to facilitate
+grouping common files and syncronizing them between computers.
+
+By default, all of the contents in each of the <em>mnt</em>s are
+placed in the user's home directory.  This can be altered by
+creating a file called <tt>.sundae_path</tt> in the top of the
+<em>mnt</em>; the file should contain one line, which is the
+absolute path to where that directory should be "mounted."
+
+And that's it.  When called, Sundae creates links so that you can
+work on your files from seperate parts of life as if they were side
+by side.  
+
+== Author
+<don@ohspite.net>
+
+== Copyright
+Copyright (c) 2011, 2008 <don@ohspite.net>.  
+Licensed under the MIT License.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Rakefile

@@ -1,18 +1,30 @@
-# -*- ruby -*-
+begin
+  require 'bones'
+rescue LoadError
+  abort '### please install the "bones" gem ###'
+end
 
-require 'rubygems'
-require 'hoe'
-require './lib/sundae.rb'
+task :default => 'test:run'
+task 'gem:release' => 'test:run'
 
-Hoe.new('sundae', Sundae::VERSION) do |p|
-  p.developer('Don', 'don@ohspite.net')
-  p.email = 'don@ohspite.net'
-  p.description = "Mix collections of files while maintaining complete separation. Synchronize any combination of your documents and configuration settings between all of your computers."
-  p.summary = "Mix collections of files while maintaining complete separation."
-  p.url = "http://rubyforge.org/projects.sundae"
-#  p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
-  p.remote_rdoc_dir = ''
-  p.extra_deps = ['configatron']
-end
+Bones do 
+  name           'sundae'
+  authors        'Don'
+  email          'don@ohspite.net'
+  url            'https://github.com/ohspite/sundae'
+  summary        'Mix collections of files while maintaining complete separation.'
+  description    'Mix collections of files while maintaining complete separation.'
+  history_file   'CHANGELOG'
+  manifest_file  'Manifest'
+  readme_file    'README.rdoc'
+  rdoc.main      'README.rdoc'
 
-# vim: syntax=Ruby
+  ignore_file    '.gitignore'
+  exclude        %w(tmp$ bak$ ~$ CVS \.svn/ \.git/ \.bzr/ \.bzrignore ^pkg/)
+  rdoc.include   %w(README ^lib/ ^bin/ ^ext/ \.txt$ \.rdoc$)
+  depend_on 'highline'
+  depend_on 'configatron'
+  depend_on 'rdoc'
+
+#  spec.opts << '--color'
+end

data/bin/sundae

@@ -7,7 +7,7 @@
 #
 # == Usage
 #
-#    sundae [--config-path PATH]
+#    sundae [options] [commands]
 #
 # For command line details see 
 #    sundae --help
@@ -16,25 +16,84 @@
 # <don@ohspite.net>
 #
 # == Copyright
-# Copyright (c) 2008 <don@ohspite.net>.  
+# Copyright (c) 2012, 2008 <don@ohspite.net>.  
 # Licensed under the MIT License.
 
-require 'rdoc/usage'
 require 'optparse'
+require 'highline/import'
 
 $:.unshift File.join(File.dirname(__FILE__), "../lib")
 
 require 'sundae'
 
 class App # :nodoc:
+
+  COMMAND_LIST = %w{run
+                    source
+                    move
+                   }
+
   def initialize
     parse_commandline(ARGV)
 
     Sundae.load_config_file(@options[:config_path])
-    
-    Sundae.remove_dead_links
-    Sundae.remove_generated_directories
-    Sundae.create_filesystem
+
+    case @commands[0]
+    when :run
+      Sundae.update_filesystem
+    when :remove
+      Sundae.remove_filesystem
+    when :sources
+      ARGV << "." if ARGV.empty?
+      Process.abort "#{ARGV[0]} is not a directory." unless File.directory?(ARGV[0])
+      path = File.expand_path(ARGV[0])
+      mnts = Sundae.find_source_directories(path)
+      mnts.each do |mnt|
+        install_location = Sundae.install_location(mnt)
+        relative = path.sub(install_location, '')
+        puts mnt
+        Dir.entries(File.join(mnt, relative)).sort.each do |e|
+          next if e =~ /^..?$/
+          line_end = File.directory?(e) ? "/" : "" 
+          puts "  " + e + line_end
+        end
+        puts
+      end
+    when :move
+      Process.abort "The 'move' command requires a file or directory as an argument." if ARGV.empty?
+      Process.abort "#{ARGV[0]} is not a file or directory." unless File.exist?(ARGV[0])
+
+      if ARGV.size == 1 
+        path = File.expand_path(ARGV[0])      
+        
+        current_mnt = nil
+        Sundae.all_mnts.map do |mnt|
+          current_mnt = mnt if path =~ Regexp.new(mnt)
+        end
+        choices = if current_mnt
+                    Sundae.all_mnts
+                  else
+                    Sundae.find_source_directories(File.dirname(path))
+                  end
+        choices.push "--Cancel?--"
+        choose do |menu|
+          menu.prompt = "move to: "
+          menu.choices(*choices) do |new_path|
+            if new_path == "--Cancel?--" 
+              Process.abort("No move performed.")
+            else
+              Sundae.move_to_mnt(path, new_path)
+            end
+          end
+        end
+      else
+        relative_path = ARGV.pop
+        ARGV.each do |path|
+          path = File.expand_path(path)
+          Sundae.move_to_relative_path(path, relative_path)
+        end
+      end
+    end
   end
   
   private
@@ -42,12 +101,18 @@ class App # :nodoc:
   def parse_commandline(option_line)
     options = {:verbose => false}
     option_parser = OptionParser.new do |opts|
-      opts.banner = "Usage: #{File.basename(__FILE__)} [options] "
+      opts.banner = "Usage: #{File.basename(__FILE__)} [options] [command]"
+      opts.separator ""
+      opts.separator "Available commands (can be abbreviated):"
+      opts.separator '    run             create the filesystem from the mounts; the default command'
+      opts.separator '    rm              remove generated directories and symlinks'
+      opts.separator '    move PATH       moves the resource at \'path\' (or pointed to by \'path\' if it is a link) to another mount collection'
+      opts.separator '    sources DIR=./  print the mounts that have resources in \'dir\' and what comes from each'
       opts.separator ""
       opts.separator "Specific options:"
       opts.on('-c', 
               '--config-path PATH',
-              'specify the path to the \'.sundae\' directory (default is \'~/.sundae\')') do |path|
+              'specify the path to the \'.sundae\' directory (default is \'~/.sundae\'); used with the regular \'run\' command') do |path|
         options[:config_path] = File.expand_path(path)
       end
 #       opts.on('-v', 
@@ -71,23 +136,31 @@ class App # :nodoc:
     end
     
     argv = Array.new
-    begin
-      option_parser.order!(option_line) do |command|
-        case command
-        when "some_value"
-          
-        else
-          argv << command
-        end
+    commands = Array.new
+    if option_line.empty? then option_line = ['run'] end
+    option_parser.order!(option_line) do |input|
+      action = case input
+               when nil then :run
+               when /^ru?n?$/ then :run
+               when /^re?m?o?v?e?$/ then :remove
+               when /^so?u?r?c?e?s?$/ then :sources
+               when /^mo?v?e?$/ then :move
+               else nil
+               end
+      if action.nil? 
+        argv << input
+      else
+        commands << action
       end
-    rescue 
-      RDoc::usage('usage')
     end
     argv.each { |a| option_line << a }
-    
+
+    if commands.empty? then Process.abort "No command unambiguously specified." end
+    if commands.size > 1 then Process.abort "More than one command specified." end
+
     @options = options
+    @commands = commands
   end
 end
 
-
 App.new

data/lib/sundae.rb

@@ -1,4 +1,4 @@
-require 'rubygems'
+# require 'rubygems'
 require 'configatron'
 require 'fileutils'
 require 'find'
@@ -7,7 +7,11 @@ require 'find'
 # together using symbolic links.
 #
 module Sundae
-  VERSION = "0.9.2"
+  # :stopdoc:
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+  VERSION = ::File.read(PATH + 'version.txt').strip
 
   DEFAULT_CONFIG_FILE = File.expand_path(File.join(ENV['HOME'], '.sundae'))
  
@@ -17,25 +21,18 @@ module Sundae
   #
   def self.load_config_file(config_file = DEFAULT_CONFIG_FILE)
     config_file ||= DEFAULT_CONFIG_FILE
-    config_file = File.join(config_file, '.sundae') unless File.basename(config_file) == '.sundae' 
+    config_file = File.join(config_file, '.sundae') if File.directory?(config_file)
 
     create_template_config_file(config_file) unless File.file?(config_file)
 
-    configatron.set_default(:collection_links, false)
-    configatron.set_default(:collection_link_prefix, '_')
-
-    configatron.configure_from_yaml(config_file)
+    load(config_file)
     configatron.paths.map! { |p| File.expand_path(p) }
-    configatron.ignore_rules.map! { |a| Regexp.new(a) }
 
     # An array which lists the directories where mnts are stored.
     @paths = configatron.paths
     # These are the rules that are checked to see if a file in a mnt
     # should be ignored.
     @ignore_rules = configatron.ignore_rules
-
-    @collection_links = configatron.collection_links
-    @collection_link_prefix = configatron.collection_link_prefix
   end
 
   # Create a template configuration file at <em>config_file</em> after
@@ -47,16 +44,23 @@ module Sundae
       ans = gets.downcase.strip
       if ans == "y" || ans == "yes"
         File.open(config_file, "w") do |f|
-          f.puts ":paths:"
-          f.puts "- ~/mnt"
-          f.puts ":collection_links:"
-          f.puts "  false"
-          f.puts ":collection_link_prefix:"
-          f.puts "  '_'"
-          f.puts ":ignore_rules: # Ruby Regexps"
-          f.puts "- \\.svn"
-          f.puts "- \\.bzr"
-          f.puts "- \\.DS_Store"
+          f.puts <<-EOM.gsub(/^ {14}/, '')
+              # -*-Ruby-*-
+
+              # An array which lists the directories where mnts are stored.
+              configatron.paths = ["~/mnt"]
+
+              # These are the rules that are checked to see if a file in a mnt
+              # should be ignored.
+              #
+              # For `ignore_rules', use either strings (can be globs)
+              # or Ruby regexps.  You can mix both in the same array.
+              # Globs are matched using the method File.fnmatch.
+              configatron.ignore_rules = %w(.git, 
+                                            .bzr,
+                                            .svn,
+                                            .DS_Store)
+              EOM
         end
         puts 
         puts "Okay then."
@@ -74,7 +78,13 @@ module Sundae
   def self.ignore_file?(file) # :doc:
     return true if File.basename(file) =~ /^\.\.?$/
     return true if File.basename(file) == ".sundae_path"
-    @ignore_rules.each { |r| return true if File.basename(file) =~ r }
+    @ignore_rules.each do |r| 
+      if r.kind_of? Regexp
+        return true if File.basename(file) =~ r 
+      else
+        return true if File.fnmatch(r, file)
+      end
+    end
     return false
   end
 
@@ -94,12 +104,7 @@ module Sundae
   # be created.
   #
   def self.install_locations 
-    locations = []
-
-    all_mnts.each do |mnt|
-      locations << install_location(mnt)
-    end
-    return locations.sort.uniq
+    all_mnts.map { |m| install_location(m) }.sort.uniq
   end
 
   # Given _path_, return all mnts (i.e., directories two levels down)
@@ -111,7 +116,7 @@ module Sundae
     collections.each do |c|
       collection_mnts = Dir.entries(File.join(path, c)).delete_if {|a| a=~/^\./}
       collection_mnts.map! { |mnt| File.join(c, mnt) }
-      mnts |= collection_mnts
+      mnts |= collection_mnts # |= is the union
     end
 
     return mnts.sort.uniq
@@ -124,7 +129,7 @@ module Sundae
 
     @paths.each do |path| 
       next unless File.exist?(path)
-      mnts |= mnts_in_path(path).map { |mnt| File.join(path, mnt) }
+      mnts |= mnts_in_path(path).map { |mnt| File.join(path, mnt) } # |= is the union operator
     end
 
     return mnts
@@ -143,7 +148,7 @@ module Sundae
       end
     end
 
-    return dirs.sort.uniq
+    return dirs.sort.uniq.select { |d| File.directory?(d) }
   end
   
   # Check for symlinks in the base directories that are missing their
@@ -172,7 +177,7 @@ module Sundae
     generated_directories.each do |dir| 
       next if File.basename(dir) == ('.sundae')
 
-      # Do a quick search to make sure no non-symlink file is being
+      # Do a search to make sure no non-symlink file is being
       # deleted. That would suck.
       if sf = find_static_file(dir)
         puts "found static file: #{sf}"
@@ -229,18 +234,6 @@ module Sundae
 
       Find.prune if File.directory?(path) 
     end
-    create_collection_links(target, link_path)
-  end
-
-  # Create links in a generated mirror directory to the analogous
-  # location in the mounted directories.
-  #
-  def self.create_collection_links(target, link_name)
-    return unless @collection_links
-
-    collection_name = File.basename(root_path(target))
-    collection_link = File.join(link_name, @collection_link_prefix + collection_name)
-    create_link(target, collection_link) unless File.exist? collection_link
   end
 
   # Starting at _dir_, walk up the directory hierarchy and return the
@@ -250,11 +243,7 @@ module Sundae
     raise ArgumentError if dir == '/'
 
     parent = File.expand_path(File.join(dir, '..'))
-    if @paths.include? parent
-      return dir
-    else
-      root_path parent
-    end
+    return (@paths.include?(parent)) ? dir : root_path(parent)
   end
 
   # Dispatch calls to create_directory_link and create_file_link.
@@ -326,5 +315,78 @@ module Sundae
     minimally_create_links(target_path2, link_name)
   end
 
+  def self.update_filesystem
+    remove_dead_links
+    remove_generated_directories
+    create_filesystem
+  end
+
+  def self.remove_filesystem
+    remove_dead_links
+    remove_generated_directories
+  end
+
+  # Return an array of mnts that are installing to +path+.
+  #
+  def self.find_source_directories(path)
+    sources = Array.new
+    all_mnts.each do |mnt|
+      install_location = File.expand_path(install_location(mnt))
+      if path.include?(install_location)
+        relative_path =  path.sub(Regexp.new(install_location), "")
+        sources << mnt if File.exist?(File.join(mnt, relative_path))
+      end
+    end
+    return sources
+  end
+
+  # Move the file at +path+ (or its target in the case of a link) to
+  # +mnt+ preserving relative path.
+  #
+  def self.move_to_mnt(path, mnt)
+    if File.symlink?(path)
+      to_move = File.readlink(path)
+      current = Sundae.find_source_directories(path)[0]
+      relative_path = to_move.sub(Regexp.new(current), "")
+      FileUtils.mv(to_move, mnt + relative_path) unless current == mnt
+      FileUtils.ln_sf(mnt + relative_path, path)
+    else
+      location = Sundae.install_location(mnt)
+      relative_path = path.sub(Regexp.new(location), "")
+      FileUtils.mv(path, mnt + relative_path) unless path == mnt + relative_path
+      FileUtils.ln_s(mnt + relative_path, path)
+    end
+  end
+
+  # Move the target at +link+ according to +relative_path+.
+  #
+  def self.move_to_relative_path(link, relative_path)
+    raise ArgumentError, "#{link} is not a link." unless File.symlink?(link)
+
+    target = File.readlink(link)
+
+    pwd = FileUtils.pwd
+    mnt = Sundae.find_source_directories(link)[0]
+    mnt_pwd = File.join(mnt, pwd.sub(Regexp.new(install_location(mnt)), ""))
+
+    if File.directory?(relative_path)
+      new_target_path = File.join(mnt_pwd, relative_path, File.basename(link))
+      new_link_path   = File.join(pwd,     relative_path, File.basename(link))
+    else
+      new_target_path = File.join(mnt_pwd, relative_path)
+      new_link_path   = File.join(pwd,     relative_path)   
+    end
+
+    target          = File.expand_path(target)
+    new_target_path = File.expand_path(new_target_path)
+    new_link_path   = File.expand_path(new_link_path)
+
+    raise ArgumentError, "#{link} and #{new_target_path} are the same file" if target == new_target_path
+    FileUtils.mkdir_p(File.dirname(new_target_path))
+    FileUtils.mv(target, new_target_path)
+    FileUtils.rm(link)
+    FileUtils.ln_s(new_target_path, new_link_path)
+  end
+  
 end