sundae 1.0.4 → 1.0.5

data/README.rdoc

@@ -67,7 +67,11 @@ this:
   |   |   |-- real_files_and_dirs
   |   |   ` ...
   |   |-- mnt2/
-  `-- collection2/
+  |-- collection2_really_a_mnt/
+  |   |-- .sundae_path          <--- empty
+  |   |-- real_files_and_dirs
+  |   |   ` ...
+  `-- collection3/
       ` ...
 
 Sundae will act on all of the <em>mnt</em>s--subdirectories of the
@@ -75,6 +79,19 @@ Sundae will act on all of the <em>mnt</em>s--subdirectories of the
 <em>path</em>.  The "collections" are only there to facilitate
 grouping common files and syncronizing them between computers.
 
+This sub-subdirectory business is there so you can, for example, throw
+all of your linux files under version control but have some of them
+inserted into your home directory and some of them go somewhere else.
+
+If you have one collection of files that you syncronize across
+computers that all get deposited into the same path, you don't need a
+collection of mnts.  You can make can make the top level
+directory--that would normally be treated as a collection--be treated
+as a mnt by including a .sundae_path file in that folder (even if it's
+empty).  Like in the 'collection2_really_a_mnt' example above.  It
+seems complicated to have both options, but it's really not.  I
+promise.
+
 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>;
@@ -114,8 +131,11 @@ For example, the hierarchy in my <em>path</em>s looks sort of like this:
   |       ` ... 
   ` ...    
   ~/mnt/sync/            <-- "path"
-  |-- reference          <-- "collection"
-  |   |-- home/          <-- "mnt"
+  |-- reference          <-- "mnt"
+  |   |-- .sundae_path   (empty)          
+  |   |-- doc/          
+  |       ` ...
+  |   |-- share/          
   |       ` ...
   |-- music
   |   |-- home/          
@@ -127,7 +147,7 @@ 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
+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.  You can put the file in "~/mnt/nix/.ssh/config" in the
@@ -147,6 +167,9 @@ of files beneath "~/a/", then you don't want sundae to look through
 everything every time it runs.  Just put it in a mnt directory with a
 <tt>.sundae_path</tt> of "~/a/b/c/d".
 
+Again, if you want the first-level subdirectories of a "path" treated
+as a mnt instead of a collection of mnts, just add a .sundae_path file.
+
 == Author
 <don@ohspite.net>
 

data/lib/sundae.rb

@@ -115,8 +115,12 @@ module Sundae
   def self.install_location(mnt) 
     mnt = Pathname.new(mnt).expand_path
     mnt_config = mnt + '.sundae_path'
+
     if mnt_config.exist?
-      return Pathname.new(mnt_config.readlines[0].strip).expand_path
+      line = mnt_config.readlines[0]
+      if line then
+        return Pathname.new(line.strip).expand_path
+      end
     end
 
     base = mnt.basename.to_s
@@ -141,28 +145,27 @@ module Sundae
   def self.mnts_in_path(path) 
     Pathname.new(path).expand_path
     mnts = []
-    collections = path.children(false).delete_if {|c| c.to_s =~ /^\./}
-
-    collections.each do |c|
-      collection_mnts = (path + c).children(false).delete_if {|kid| kid.to_s =~ /^\./}
-      collection_mnts.map! { |mnt| (c + mnt) }
+    collections = path.children.delete_if {|c| c.basename.to_s =~ /^\./}
 
-      mnts |= collection_mnts # |= is the union
-    end
-
-    return mnts.sort.uniq
+    return collections.map do |c|
+      if c.children(false).include? Pathname.new('.sundae_path')
+        c
+      else
+        collection_mnts = c.children.delete_if {|kid| kid.basename.to_s =~ /^\./}
+        # collection_mnts.keep_if { |k| (path + c + k).directory? }
+        collection_mnts.reject! { |k| ! (path + c + k).directory? }
+        collection_mnts.map! { |mnt| (c + mnt) }
+      end
+    end.flatten.sort.uniq
   end
 
   # Return all mnts for every path as an array.
   #
   def self.all_mnts 
-    mnts = []
-
-    @paths.each do |path| 
+    @paths.map do |path| 
       next unless path.exist?
-      mnts |= mnts_in_path(path).map { |mnt| path + mnt } # |= is the union operator
-    end
-    return mnts
+      mnts_in_path(path)
+    end.compact.flatten
   end
 
   # Return all subdirectories and files in the mnts returned by
@@ -198,7 +201,7 @@ module Sundae
       files = location.entries.map { |f| location + f }
       files.each do |file|
         next unless file.symlink?
-        next if file.readlink.exist?
+        next if file.exist?
         next unless root_path(file.readlink)
         file.delete 
       end
@@ -217,22 +220,22 @@ module Sundae
     return nil
   end
 
-  # Delete each generated directory if there aren't any real files in
-  # them.
-  #
-  def self.remove_generated_directories
-    generated_directories.each do |dir| 
-      # don't get rid of the linked config file
-      next if dir.basename.to_s == '.sundae' 
-      remove_generated_stuff dir
-
-      # if sf = find_static_file(dir)
-      #   puts "found static file: #{sf}"
-      # else
-      #   dir.rmtree
-      # end
-    end
-  end
+  # # Delete each generated directory if there aren't any real files in
+  # # them.
+  # #
+  # def self.remove_generated_directories
+  #   generated_directories.each do |dir| 
+  #     # don't get rid of the linked config file
+  #     next if dir.basename.to_s == '.sundae' 
+  #     remove_generated_stuff dir
+
+  #     # if sf = find_static_file(dir)
+  #     #   puts "found static file: #{sf}"
+  #     # else
+  #     #   dir.rmtree
+  #     # end
+  #   end
+  # end
 
   def self.remove_generated_files
     generated_files.each do |fod| 
@@ -243,7 +246,7 @@ module Sundae
   end
 
   def self.remove_generated_stuff(fod)
-    return unless fod.exist?
+    return unless fod.exist? || fod.symlink?
     if fod.ftype == 'directory'
       fod.each_child do |c|
         remove_generated_stuff c
@@ -264,29 +267,31 @@ module Sundae
     end
   end
 
-  # For each directory and file in _target_, create a link at <em>link_name</em>.  If
-  # there is currently no file at <em>link_path</em>, create a symbolic link there.
+  # For each directory and file in _old_, create a link at <em>link_name</em>.  If
+  # there is currently no file at <em>new</em>, create a symbolic link there.
   # If there is currently a symbolic link, combine the contents at the
-  # link location and _target_ in a new directory and proceed
+  # link location and _old_ in a new directory and proceed
   # recursively.
   #
-  def self.minimally_create_links(target, link_path) 
-    target = File.expand_path(target)
-    link_path = File.expand_path(link_path)
+  def self.minimally_create_links(old, new) 
+    old    = Pathname.new(old)
+    new = Pathname.new(new)
 
-    unless File.exist?(target)
-      raise "attempt to create links from missing directory: " + target
+    unless old.exist?
+      raise "attempt to create links from missing directory: " + old
     end
 
-    Find.find(target) do |path|
-      next if path == target
+    old.realpath.find do |path|
+      next if path == old.realpath
       Find.prune if ignore_file?(File.basename(path))
 
-      rel_path = path.gsub(target, '')
-      link_name = File.join(link_path, rel_path)
-      create_link(path, link_name)
+      rel_path = path.relative_path_from(old.realpath)
+      link_name = new + rel_path
+
+#      puts "#{link_name} -> #{old + rel_path}"
+      create_link(old + rel_path, link_name)
 
-      Find.prune if File.directory?(path) 
+      Find.prune if path.directory?
     end
   end
 
@@ -306,78 +311,83 @@ module Sundae
 
   # Dispatch calls to create_directory_link and create_file_link.
   #
-  def self.create_link(target, link_name) 
-    if File.directory?(target) 
+  def self.create_link(old, new) 
+    old    = Pathname.new(old)
+    new = Pathname.new(new)
+
+    if old.directory?
       begin
-        create_directory_link(target, link_name)
+        create_directory_link(old, new)
       rescue => message
         puts message
       end
-    elsif File.file?(target) 
-      create_file_link(target, link_name)
+    elsif old.file?
+      create_file_link(old, new)
     end
   end
 
-  # Create a symbolic link to <em>target</em> from <em>link_name</em>.
+  # Create a symbolic link to <em>old</em> from <em>new</em>.
   #
-  def self.create_file_link(target, link_name) 
-    raise ArgumentError, "#{target} does not exist" unless File.file?(target)
-    if File.exist?(link_name)
-      raise ArgumentError, "#{link_name} cannot be overwritten for #{target}." unless File.symlink?(link_name)
-      if (not File.exist?(File.readlink(link_name)))
-        FileUtils.ln_sf(target, link_name)
-      else
-        unless (File.expand_path(File.readlink(link_name)) == File.expand_path(target))
-          raise ArgumentError, "#{link_name} points to #{File.readlink(link_name)}, not #{target}" unless File.symlink?(link_name)
-        end
-      end
+  def self.create_file_link(old, new) 
+    old = Pathname.new(old)
+    new = Pathname.new(new)
+
+    raise ArgumentError, "#{old} does not exist" unless old.file? || old.symlink?
+    if new.symlink?
+      raise ArgumentError, "#{new.to_s} cannot be overwritten for #{old}: points to #{new.readlink.to_s}" unless new.readlink.to_s == old.to_s
     else
-      FileUtils.ln_s(target, link_name)
+      raise ArgumentError, "#{new} cannot be overwritten for #{old}." if new.exist?
+      new.make_symlink(old)
     end
   end
 
-  # Create a symbolic link to the directory at <em>target</em> from
-  # <em>link_name</em>, unless <em>link_name</em> already exists.  In that case,
+  # Create a symbolic link to the directory at <em>old</em> from
+  # <em>new</em>, unless <em>new</em> already exists.  In that case,
   # create a directory and recursively run minimally_create_links.
   #
-  def self.create_directory_link(target, link_name) 
-    raise ArgumentError unless File.directory?(target)
-    if (not File.exist?(link_name)) || 
-        (File.symlink?(link_name) && (not File.exist?(File.readlink(link_name))))
-      FileUtils.ln_sf(target, link_name)
+  def self.create_directory_link(old, new) 
+    old = Pathname.new(old)
+    new = Pathname.new(new)
+
+    raise ArgumentError unless old.directory?
+    if not new.exist? || new.symlink?
+      new.make_symlink(old)
     else
-      case File.ftype(link_name)
+      case new.ftype
       when 'file'
-        raise "Could not link #{link_name} to #{target}: target exists."
+        raise "Could not link #{new} to #{old}: old exists."
       when 'directory'
-        minimally_create_links(target, link_name)
+        minimally_create_links(old, new)
       when 'link'
-        case File.ftype(File.readlink(link_name))
+        case new.realpath.ftype
         when 'file'
-          raise "Could not link #{link_name} to #{target}: another link exists there."
+          raise "Could not link #{new} to #{old}: another link exists there."
         when 'directory'
-          combine_directories(link_name, target, File.readlink(link_name))          
+          combine_directories(old, new.readlink, new)   
         end
       end
     end
   end
 
   # Create a directory and create links in it pointing to
-  # <em>target_path1</em> and <em>target_path2</em>.
+  # <em>old1</em> and <em>old2</em>.
   #
-  def self.combine_directories(link_name, target_path1, target_path2) 
-    raise unless File.symlink?(link_name)
-    return if target_path1 == target_path2
+  def self.combine_directories(old1, old2, new) 
+    new = Pathname.new(new)
+    old1 = Pathname.new(old1).expand_path
+    old2 = Pathname.new(old2).expand_path
+
+    raise "combine_directories in #{new}" unless new.symlink?
+    return if old1 == old2
     
-    FileUtils.rm(link_name)
-    FileUtils.mkdir_p(link_name)
-    minimally_create_links(target_path1, link_name)
-    minimally_create_links(target_path2, link_name)
+    new.delete
+    new.mkpath
+    minimally_create_links(old1, new)
+    minimally_create_links(old2, new)
   end
 
   def self.update_filesystem
-    remove_dead_links
-    remove_generated_files
+    remove_filesystem
     create_filesystem
   end
 

data/test/test_sundae.rb

@@ -58,7 +58,7 @@ class TestSundae < Test::Unit::TestCase
     d2   = @@mnts_dir + 'c1/d2'
     link = @@sandbox  + 'link'
     FileUtils.ln_s(d1, link)
-    Sundae.combine_directories(link, d1, d2)
+    Sundae.combine_directories(d1, d2, link)
     assert File.symlink?(link + 'f11')
   end
 
@@ -162,7 +162,8 @@ class TestSundae < Test::Unit::TestCase
   end
 
   def test_class_mnts_in_path
-    assert_equal ['c1/d1', 'c1/d2', 'c2/d1', 'c2/d3'].map {|x| Pathname.new(x)},
+    md = Pathname.new(@@mnts_dir)
+    assert_equal ['c1/d1', 'c1/d2', 'c2/d1', 'c2/d3'].map {|x| (md + x).expand_path},
         Sundae.mnts_in_path(@@path1)
   end
 
@@ -175,13 +176,13 @@ class TestSundae < Test::Unit::TestCase
     assert (@@sandbox + 'perm_file').exist?
   end
 
-  def test_class_remove_generated_directories
-    Sundae.generated_directories.each { |d| FileUtils.mkdir_p(d) }
-    Sundae.remove_generated_directories
-    Sundae.generated_directories.each do |d|
-      assert ! File.exist?(d)
-    end
-  end
+  # def test_class_remove_generated_directories
+  #   Sundae.generated_directories.each { |d| FileUtils.mkdir_p(d) }
+  #   Sundae.remove_generated_directories
+  #   Sundae.generated_directories.each do |d|
+  #     assert ! File.exist?(d)
+  #   end
+  # end
 
   def test_class_root_path
     assert_equal @@mnts_dir +'c1',  Sundae.root_path(@@mnts_dir + 'c1')

data/version.txt

@@ -1 +1 @@
-1.0.4
+1.0.5

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sundae
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,43 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-13 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &82655870 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.6.11
+        version: 1.6.12
   type: :runtime
   prerelease: false
-  version_requirements: *82655870
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.12
 - !ruby/object:Gem::Dependency
   name: configatron
-  requirement: &82654320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.9.1
   type: :runtime
   prerelease: false
-  version_requirements: *82654320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.1
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &82653700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,48 +53,46 @@ dependencies:
         version: '3.12'
   type: :runtime
   prerelease: false
-  version_requirements: *82653700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &82653190 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.7.3
+        version: 3.8.0
   type: :development
   prerelease: false
-  version_requirements: *82653190
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
 description: Mix collections of files while maintaining complete separation.
 email: don@ohspite.net
 executables:
-- !binary |-
-  c3VuZGFl
+- sundae
 extensions: []
 extra_rdoc_files:
-- !binary |-
-  UkVBRE1FLnJkb2M=
-- !binary |-
-  YmluL3N1bmRhZQ==
+- README.rdoc
+- bin/sundae
 files:
-- !binary |-
-  LmdpdGlnbm9yZQ==
-- !binary |-
-  Q0hBTkdFTE9H
-- !binary |-
-  Q09QWUlORw==
-- !binary |-
-  UkVBRE1FLnJkb2M=
-- !binary |-
-  UmFrZWZpbGU=
-- !binary |-
-  YmluL3N1bmRhZQ==
-- !binary |-
-  bGliL3N1bmRhZS5yYg==
-- !binary |-
-  dGVzdC90ZXN0X3N1bmRhZS5yYg==
-- !binary |-
-  dmVyc2lvbi50eHQ=
+- .gitignore
+- CHANGELOG
+- COPYING
+- README.rdoc
+- Rakefile
+- bin/sundae
+- lib/sundae.rb
+- test/test_sundae.rb
+- version.txt
 homepage: https://github.com/ohspite/sundae
 licenses: []
 post_install_message: 
@@ -107,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: sundae
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Mix collections of files while maintaining complete separation.