maid 0.2.3.alpha.1 → 0.3.0.beta.1

data/AUTHORS.md

@@ -1,9 +1,7 @@
 In alphabetical order:
 
 * Benjamin Oakes (@benjaminoakes)
-* Bradley Smith (@bradleyd)
 * Larry Lv (@larrylv)
 * Lewis O'Driscoll (@loddy1234)
 * Lloyd Philbrook (@phoolish)
 * Mark Jaquith (@markjaquith)
-* Mu Ye (@yemutex)

data/ChangeLog

@@ -1,11 +1,10 @@
-maid (0.2.3.alpha.1) unstable; urgency=low
+maid (0.3.0.beta.1) unstable; urgency=high
 
-  * Mu Ye: Improve command line spec coverage (Closes: #97)
-  * Changed from ArgumentError to NotImplementedError when a command is
-    unsupported on the host OS.
-  * Bradley Smith: Add locate support on Ubuntu (Closes: #67)
+  * Only allow "move" to move to existing directories.  Renaming files
+    can be accomplished with the new "rename" tool.  This fixes a bug in
+    overwrite warnings.  (Closes: #87)
 
- -- Benjamin Oakes <hello@benjaminoakes.com>  Fri, 8 Mar 2013 00:00:00 +0000
+ -- Benjamin Oakes <hello@benjaminoakes.com>  Sun, 24 Feb 2013 00:00:00 +0000
 
 maid (0.2.2) stable; urgency=high
 

data/lib/maid/maid.rb

@@ -98,7 +98,7 @@ class Maid::Maid
     if supported_command?(command)
       %x(#{ command })
     else
-      raise NotImplementedError, "Unsupported system command: #{ command.inspect }"
+      raise ArgumentError, "Unsupported system command: #{ command.inspect }"
     end
   end
 

data/lib/maid/platform.rb

@@ -13,16 +13,5 @@ module Maid::Platform
     def osx?
       !!(host_os =~ /darwin/i)
     end
-
-  end
-
-  # Commands based on OS type
-  class Commands
-    class << self
-      # logicaly decides which locate command to use
-      def locate
-        Maid::Platform.linux? ? 'locate' : 'mdfind -name'
-      end
-    end
   end
 end

data/lib/maid/tools.rb

@@ -15,9 +15,9 @@ module Maid::Tools
   # For showing deprecation notices
   include Deprecated
 
-  # Move from `sources` to `destination`
+  # Move `sources` to a `destination` directory.
   #
-  # The path is not moved if a file already exists at the destination with the same name.  A warning is logged instead.
+  # Movement is only allowed to directories that already exist.  If your intention is to rename, see the `rename` method.
   #
   # ## Examples
   #
@@ -32,15 +32,47 @@ module Maid::Tools
   def move(sources, destination)
     destination = expand(destination)
 
-    expand_all(sources).each do |source|
-      target = File.join(destination, File.basename(source))
-
-      unless File.exist?(target)
-        log("mv #{ sh_escape(source) } #{ sh_escape(destination) }")
+    if File.directory?(destination)
+      expand_all(sources).each do |source|
+        log("move #{ sh_escape(source) } #{ sh_escape(destination) }")
         FileUtils.mv(source, destination, @file_options)
-      else
-        warn("skipping #{ sh_escape(source) } because #{ sh_escape(target) } already exists")
       end
+    else
+      # Unix `mv` warns about the target not being a directory with multiple sources.  Maid checks the same.
+      warn("skipping move because #{ sh_escape(destination) } is not a directory (use 'mkdir' to create first, or use 'rename')")
+    end
+  end
+
+  # Rename a single file.
+  #
+  # Any directories needed in order to complete the rename are made automatically.
+  #
+  # Overwriting is not allowed; it logs a warning.  If overwriting is desired, use `remove` to delete the file first, then use `rename`.
+  #
+  # ## Examples
+  #
+  # Simple rename:
+  #
+  #     rename('foo.zip', 'baz.zip') # "foo.zip" becomes "baz.zip"
+  #
+  # Rename needing directories:
+  #
+  #     rename('foo.zip', 'bar/baz.zip') # "bar" is created, "foo.zip" becomes "baz.zip" within "bar"
+  #
+  # Attempting to overwrite:
+  #
+  #     rename('foo.zip', 'existing.zip') # "skipping move of..."
+  def rename(source, destination)
+    source = expand(source)
+    destination = expand(destination)
+
+    mkdir(File.dirname(destination))
+
+    if File.exist?(destination)
+      warn("skipping rename of #{ sh_escape(source) } to #{ sh_escape(destination) } because it would overwrite")
+    else
+      log("rename #{ sh_escape(source) } #{ sh_escape(destination) }")
+      FileUtils.mv(source, destination, @file_options)
     end
   end
 
@@ -99,7 +131,7 @@ module Maid::Tools
 
       if File.exist?(path)
         if File.exist?(target)
-          move(path, safe_trash_path)
+          rename(path, safe_trash_path)
         else
           move(path, @trash_path)
         end
@@ -244,7 +276,7 @@ module Maid::Tools
   #
   #     locate('foo.zip') # => ['/a/foo.zip', '/b/foo.zip']
   def locate(name)
-    cmd("#{Maid::Platform::Commands.locate} #{ sh_escape(name) }").split("\n")
+    cmd("mdfind -name #{ sh_escape(name) }").split("\n")
   end
 
   # [Mac OS X] Use Spotlight metadata to determine the site from which a file was downloaded.

data/lib/maid/version.rb

@@ -1,3 +1,3 @@
 module Maid
-  VERSION = '0.2.3.alpha.1'
+  VERSION = '0.3.0.beta.1'
 end

data/spec/lib/maid/app_spec.rb

@@ -77,7 +77,7 @@ module Maid
     end
 
     it 'is mapped as --version' do
-      App.start(['--version']).should == @app.version
+      # TODO: Test via Rspec (it's only in the smoke test script for now)
     end
 
     context 'with the "long" option' do

data/spec/lib/maid/maid_spec.rb

@@ -189,11 +189,11 @@ module Maid
       end
 
       it 'should report `not-a-real-command` as not being a supported command' do
-        lambda { @maid.cmd('not-a-real-command arg1 arg2') }.should raise_error(NotImplementedError)
+        lambda { @maid.cmd('not-a-real-command arg1 arg2') }.should raise_error(ArgumentError)
       end
 
       it 'should report `echo` as a real command' do
-        lambda { @maid.cmd('echo .') }.should_not raise_error(NotImplementedError)
+        lambda { @maid.cmd('echo .') }.should_not raise_error(ArgumentError)
       end
     end
   end

data/spec/lib/maid/platform_spec.rb

@@ -25,10 +25,6 @@ module Maid
       it 'is not identified as OS X' do
         subject.osx?.should be_false
       end
-
-      it 'locate is "locate"' do
-        Platform::Commands.locate.should match(/locate/)
-      end
     end
 
     context 'when running on Mac OS X' do
@@ -43,10 +39,6 @@ module Maid
       it 'is identified as OS X' do
         subject.osx?.should be_true
       end
-
-      it 'locate is "mdfind"' do
-        Platform::Commands.locate.should match(/mdfind/)
-      end
     end
   end
 end

data/spec/lib/maid/tools_spec.rb

@@ -41,13 +41,6 @@ module Maid
         @maid.move(@src_file, @dst_dir)
       end
 
-      it 'should not move if the target already exists' do
-        FileUtils.touch(@dst_dir + @file_name)
-        @logger.should_receive(:warn)
-
-        @maid.move(@src_file, @dst_dir)
-      end
-
       it 'should handle multiple from paths' do
         second_src_file = @src_dir + (second_file_name = 'bar.zip')
         FileUtils.touch(second_src_file)
@@ -57,6 +50,60 @@ module Maid
         File.exist?(@dst_dir + @file_name).should be_true
         File.exist?(@dst_dir + second_file_name).should be_true
       end
+
+      context 'given the destination directory does not exist' do
+        before do
+          FileUtils.rmdir(@dst_dir)
+        end
+
+        it 'does not overwrite when moving' do
+          FileUtils.should_not_receive(:mv)
+          @logger.should_receive(:warn).once
+
+          another_file = "#@src_file.1"
+          @maid.move([@src_file, another_file], @dst_dir)
+        end
+      end
+    end
+
+    describe '#rename' do
+      before do
+        @src_file = (@src_dir = '~/Source/') + (@file_name = 'foo.zip')
+        FileUtils.mkdir_p(@src_dir)
+        FileUtils.touch(@src_file)
+        @expanded_src_name = "#@home/Source/foo.zip"
+
+        @dst_name = '~/Destination/bar.zip'
+        @expanded_dst_dir = "#@home/Destination/"
+        @expanded_dst_name = "#@home/Destination/bar.zip"
+      end
+
+      it 'creates needed directories' do
+        File.directory?(@expanded_dst_dir).should be_false
+        @maid.rename(@src_file, @dst_name)
+        File.directory?(@expanded_dst_dir).should be_true
+      end
+
+      it 'moves the file from the source to the destination' do
+        File.exists?(@expanded_src_name).should be_true
+        File.exists?(@expanded_dst_name).should be_false
+        @maid.rename(@src_file, @dst_name)
+        File.exists?(@expanded_src_name).should be_false
+        File.exists?(@expanded_dst_name).should be_true
+      end
+
+      context 'given the target already exists' do
+        before do
+          FileUtils.mkdir_p(@expanded_dst_dir)
+          FileUtils.touch(@expanded_dst_name)
+        end
+
+        it 'does not move' do
+          @logger.should_receive(:warn)
+
+          @maid.rename(@src_file, @dst_name)
+        end
+      end
     end
 
     describe '#trash' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maid
 version: !ruby/object:Gem::Version
-  version: 0.2.3.alpha.1
+  version: 0.3.0.beta.1
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-08 00:00:00.000000000 Z
+date: 2013-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape
-  requirement: &15830020 !ruby/object:Gem::Requirement
+  requirement: &13576940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *15830020
+  version_requirements: *13576940
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &15829220 !ruby/object:Gem::Requirement
+  requirement: &13576140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,10 +38,10 @@ dependencies:
         version: 0.18.0
   type: :runtime
   prerelease: false
-  version_requirements: *15829220
+  version_requirements: *13576140
 - !ruby/object:Gem::Dependency
   name: deprecated
-  requirement: &15828480 !ruby/object:Gem::Requirement
+  requirement: &13575420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -49,10 +49,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *15828480
+  version_requirements: *13575420
 - !ruby/object:Gem::Dependency
   name: ohai
-  requirement: &15827940 !ruby/object:Gem::Requirement
+  requirement: &13574920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -63,10 +63,10 @@ dependencies:
         version: 6.17.0
   type: :runtime
   prerelease: false
-  version_requirements: *15827940
+  version_requirements: *13574920
 - !ruby/object:Gem::Dependency
   name: xdg
-  requirement: &15827100 !ruby/object:Gem::Requirement
+  requirement: &13574200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -74,10 +74,10 @@ dependencies:
         version: 2.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *15827100
+  version_requirements: *13574200
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &15826520 !ruby/object:Gem::Requirement
+  requirement: &13573740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -85,10 +85,10 @@ dependencies:
         version: 0.4.2
   type: :development
   prerelease: false
-  version_requirements: *15826520
+  version_requirements: *13573740
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &15825380 !ruby/object:Gem::Requirement
+  requirement: &13573280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -96,10 +96,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *15825380
+  version_requirements: *13573280
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &15824120 !ruby/object:Gem::Requirement
+  requirement: &13572780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -107,10 +107,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *15824120
+  version_requirements: *13572780
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &15823480 !ruby/object:Gem::Requirement
+  requirement: &13572300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -118,10 +118,10 @@ dependencies:
         version: 10.0.3
   type: :development
   prerelease: false
-  version_requirements: *15823480
+  version_requirements: *13572300
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &15822800 !ruby/object:Gem::Requirement
+  requirement: &13571740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -129,10 +129,10 @@ dependencies:
         version: 2.2.2
   type: :development
   prerelease: false
-  version_requirements: *15822800
+  version_requirements: *13571740
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &15720280 !ruby/object:Gem::Requirement
+  requirement: &13571220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -140,10 +140,10 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *15720280
+  version_requirements: *13571220
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &15718860 !ruby/object:Gem::Requirement
+  requirement: &13570540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -151,10 +151,10 @@ dependencies:
         version: 0.5.9.1
   type: :development
   prerelease: false
-  version_requirements: *15718860
+  version_requirements: *13570540
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &15717940 !ruby/object:Gem::Requirement
+  requirement: &13130520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -162,10 +162,10 @@ dependencies:
         version: 0.8.4
   type: :development
   prerelease: false
-  version_requirements: *15717940
+  version_requirements: *13130520
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &15717240 !ruby/object:Gem::Requirement
+  requirement: &13129900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -173,10 +173,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *15717240
+  version_requirements: *13129900
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &15716540 !ruby/object:Gem::Requirement
+  requirement: &13128980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -184,7 +184,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *15716540
+  version_requirements: *13128980
 description: Be lazy.  Let Maid clean up after you, based on rules you define.  Think
   of it as "Hazel for hackers".
 email: