maid 0.1.2 → 0.1.3.beta.1

data/lib/maid/trash_migration.rb

@@ -0,0 +1,38 @@
+# Migrate trash to correct directory on Linux due to a configuration bug in previous releases.
+#
+# It used to be that the default trash path was the same on every platform, so everything used to go to `~/.Trash` regardless of OS.  (For what it's worth, that used to be the correct trash path on older releases of Ubuntu.)
+module Maid
+  module TrashMigration
+    class << self
+      def incorrect_trash
+        File.expand_path('~/.Trash') + '/'
+      end
+  
+      def correct_trash
+        Maid.new.trash_path
+      end
+
+      def needed?
+        Platform.linux? &&
+          File.directory?(incorrect_trash) &&
+          !ENV['MAID_NO_MIGRATE_TRASH']
+      end
+ 
+      def perform
+        maid = ::Maid::Maid.new(:trash_path => correct_trash)
+        # Use local variable so it's available in the closure used by `instance_eval`
+        path = incorrect_trash
+
+        # Might as well use Maid itself for this :)
+        maid.instance_eval do
+          rule 'Migrate Linux trash to correct path' do
+            trash(dir("#{ path }/*"))
+            trash(path)
+          end
+        end
+
+        maid.clean
+      end
+    end
+  end
+end

data/lib/maid/version.rb

@@ -1,3 +1,3 @@
 module Maid
-  VERSION = "0.1.2"
+  VERSION = "0.1.3.beta.1"
 end

data/maid.gemspec

@@ -1,6 +1,7 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "maid/version"
+require "maid/platform"
 
 Gem::Specification.new do |s|
   s.name        = "maid"
@@ -14,11 +15,21 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "maid"
 
-  s.add_dependency('thor', '~> 0.14.6')
-  s.add_development_dependency('rake', '~> 0.8.7')
-  s.add_development_dependency('rspec', '~> 2.5.0')
-  s.add_development_dependency('timecop', '~> 0.3.5')
-  s.add_development_dependency('ZenTest', '~> 4.4.2')
+  s.add_dependency('thor', '~> 0.16.0')
+  s.add_dependency('deprecated', '~> 3.0.1')
+  s.add_dependency('xdg', '~> 2.2.2') # Only used on Linux, but still required/tested on OSX
+  s.add_development_dependency('guard', '~> 1.4.0')
+  s.add_development_dependency('guard-rspec', '~> 2.1.0')
+  s.add_development_dependency('rake', '~> 0.9.2.2')
+  s.add_development_dependency('rspec', '~> 2.11.0')
+  s.add_development_dependency('timecop', '~> 0.5.2')
+  s.add_development_dependency('fakefs', '~> 0.4.0')
+
+  if Maid::Platform.linux?
+    s.add_development_dependency('rb-inotify', '~> 0.8.8')
+  elsif Maid::Platform.osx?
+    s.add_development_dependency('rb-fsevent', '~> 0.9.2')
+  end
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/script/provision

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+# A simple shell-based provisioner for Vagrant.
+# 
+# Documentation: [Shell Provisioner](http://vagrantup.com/v1/docs/provisioners/shell.html)
+set -o errexit
+
+sudo apt-get update
+
+# ## Dependencies
+sudo apt-get install -y ruby1.9.1
+
+# ## Development dependencies
+#
+# For building `maid-x.y.z.gem`
+sudo apt-get install -y git-core
+# For building `ffi` for `guard`'s soft dependency on `rb-inotify`
+sudo apt-get install -y make ruby1.9.1-dev libffi-dev
+
+# ## RubyGems
+cd /vagrant
+sudo gem install bundler
+bundle install

data/spec/lib/maid/app_spec.rb

@@ -26,10 +26,13 @@ module Maid
       @app.stub!(:maid_options)
       @app.stub!(:say)
 
+      TrashMigration.stub(:needed?) { false }
+
       # NOTE It's pretty important that this is stubbed, unless you want your rules to be run over and over when you test!
       @maid = mock('Maid')
       @maid.stub!(:clean)
       @maid.stub!(:log_device)
+      @maid.stub!(:load_rules)
       Maid.stub!(:new).and_return(@maid)
     end
 
@@ -63,12 +66,6 @@ module Maid
     end
   end
 
-  describe App, 'sample rules' do
-    it 'should be able to run' do
-      lambda { App.start(%w[clean --silent --noop --rules=lib/maid/rules.sample.rb]) }.should_not raise_error(SyntaxError)
-    end
-  end
-
   describe App, '#version' do
     it 'should print out the gem version' do
       app = App.new
@@ -85,6 +82,7 @@ module Maid
     it 'should log to STDOUT for testing purposes when given noop' do
       opts = @app.maid_options('noop' => true)
       opts[:file_options][:noop].should be_true
+      opts[:logger].should be_false
       opts[:log_device].should == STDOUT
       opts[:log_formatter].call(nil, nil, nil, 'hello').should == "hello\n"
     end

data/spec/lib/maid/maid_spec.rb

@@ -3,8 +3,7 @@ require 'spec_helper'
 module Maid
   describe Maid do
     before :each do
-      @logger = mock('Logger')
-      @logger.stub!(:progname=)
+      @logger = double('Logger').as_null_object
       Logger.stub!(:new).and_return(@logger)
       FileUtils.stub(:mkdir_p)
     end
@@ -26,16 +25,55 @@ module Maid
         Maid.new(:log_device => '/home/username/log/maid.log')
       end
 
-      it 'should set the trash to the default path' do
-        trash_path = Maid::DEFAULTS[:trash_path]
-        FileUtils.should_receive(:mkdir_p).with(trash_path).once
-        maid = Maid.new
-        maid.trash_path.should_not be_nil
-        maid.trash_path.should == trash_path
+      it 'should take a logger object during intialization' do
+        Logger.unstub!(:new)
+        maid = Maid.new(:logger => @logger)
+        maid.logger.should == @logger
+      end
+
+      describe 'platform-specific behavior' do
+        before do
+          Platform.stub(:linux?)
+          Platform.stub(:osx?)
+          @home = File.expand_path('~')
+        end
+
+        context 'when running on Linux' do
+          before do
+            Platform.stub(:linux?) { true }
+            XDG.stub(:[]).with('DATA_HOME') { "#{ @home }/.local/share" }
+          end
+
+          it 'should set the trash to the correct default path' do
+            trash_path = "#{ @home }/.local/share/Trash/files/"
+            FileUtils.should_receive(:mkdir_p).with(trash_path).once
+            maid = Maid.new
+            maid.trash_path.should == trash_path
+          end
+        end
+
+        context 'when running on OS X' do
+          before do
+            Platform.stub(:osx?) { true }
+          end
+
+          it 'should set the trash to the correct default path' do
+            trash_path = "#{ @home }/.Trash/"
+            FileUtils.should_receive(:mkdir_p).with(trash_path).once
+            maid = Maid.new
+            maid.trash_path.should == trash_path
+          end
+        end
+
+        context 'when running on an unsupported platform' do
+          it 'does not implement trashing files' do
+            lambda { Maid.new }.should raise_error(NotImplementedError)
+          end
+        end
       end
 
       it 'should set the trash to the given path, if provided' do
-        trash_path = '/home/username/.local/share/Trash/files/'
+        trash_path = '/home/username/tmp/my_trash/'
         FileUtils.should_receive(:mkdir_p).with(trash_path).once
         maid = Maid.new(:trash_path => trash_path)
         maid.trash_path.should_not be_nil
@@ -79,7 +117,6 @@ module Maid
     describe '#clean' do
       before :each do
         @maid = Maid.new
-        @maid.stub!(:add_rules)
         @logger.stub!(:info)
       end
 
@@ -89,19 +126,13 @@ module Maid
         @maid.clean
       end
 
-      it 'should process the default rules' do
-        @maid.should_receive(:add_rules).with(Maid::DEFAULTS[:rules_path])
-        @maid.clean
-      end
-
-      it 'should follow the given rules, if provided' do
-        @maid.should_receive(:add_rules)
+      it 'should follow the given rules' do
         @maid.should_receive(:follow_rules)
         @maid.clean
       end
     end
 
-    describe '#add_rules' do
+    describe '#load_rules' do
       before :each do
         Kernel.stub!(:load)
         @maid = Maid.new
@@ -109,19 +140,13 @@ module Maid
 
       it 'should set the Maid instance' do
         ::Maid.should_receive(:with_instance).with(@maid)
-        @maid.add_rules('path')
-      end
-
-      it 'should load the path' do
-        path = 'rules.rb'
-        Kernel.should_receive(:load).with(path)
-        @maid.add_rules(path)
+        @maid.load_rules
       end
 
       it 'should give an error on STDERR if there is a LoadError' do
         Kernel.stub!(:load).and_raise(LoadError)
         STDERR.should_receive(:puts)
-        @maid.add_rules('path')
+        @maid.load_rules
       end
     end
 

data/spec/lib/maid/numeric_extensions_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Maid::NumericExtensions, '#since?' do
+describe Maid::NumericExtensions::Time, '#since?' do
   it 'should tell you that 1 week ago happened after 2 weeks ago' do
     (1.week.since? 2.weeks.ago).should be_true
   end
@@ -9,3 +9,17 @@ describe Maid::NumericExtensions, '#since?' do
     (2.week.since? 1.weeks.ago).should be_false
   end
 end
+
+describe Maid::NumericExtensions::SizeToKb do
+  it 'should tell you that 1 megabyte equals 1024 kilobytes' do
+    (1.megabyte == 1024.kilobytes).should be_true
+  end
+
+  it 'should tell you that 1 gigabyte equals 1024 megabytes' do
+    (1.gigabyte == 1024.megabytes).should be_true
+  end
+  
+  it 'should tell you that 1 terabyte equals 1024 gigabytes' do
+    (1.terabyte == 1024.gigabytes).should be_true
+  end
+end

data/spec/lib/maid/platform_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module Maid
+  describe Platform do
+    def stub_host_os(value)
+      RbConfig::CONFIG.stub(:[]).with('host_os') { value }
+    end
+
+    describe 'determining the host OS' do
+      it 'delegates to RbConfig' do
+        stub_host_os('foo')
+        subject.host_os.should == 'foo'
+      end
+    end
+
+    context 'when running on Ubuntu' do
+      before do
+        stub_host_os('linux-gnu')
+      end
+
+      it 'is identified as Linux' do
+        subject.linux?.should be_true
+      end
+
+      it 'is not identified as OS X' do
+        subject.osx?.should be_false
+      end
+    end
+
+    context 'when running on Mac OS X' do
+      before do
+        stub_host_os('darwin10.0')
+      end
+
+      it 'is not identified as Linux' do
+        subject.linux?.should be_false
+      end
+
+      it 'is identified as OS X' do
+        subject.osx?.should be_true
+      end
+    end
+  end
+end

data/spec/lib/maid/tools_spec.rb

@@ -1,75 +1,192 @@
 require 'spec_helper'
 
 module Maid
-  describe Tools do
+  # NOTE: Please use FakeFS instead of mocking and stubbing specific calls which happen to modify the filesystem.
+  #
+  # More info:
+  #
+  # * [FakeFS](https://github.com/defunkt/fakefs)
+  describe Tools, :fakefs => true do
     before :each do
       @home = File.expand_path('~')
-      FileUtils.stub!(:mv)
+      @now = Time.now
 
       Maid.ancestors.should include(Tools)
-      @maid = Maid.new
-      @logger  = @maid.instance_eval { @logger }
+
+      @logger = double('Logger').as_null_object
+      @maid = Maid.new(:logger => @logger)
+
+      # Prevent warnings from showing when testing deprecated methods:
+      @maid.stub(:__deprecated_run_action__)
+
+      # For safety, stub `cmd` to prevent running commands:
+      @maid.stub(:cmd)
     end
 
     describe '#move' do
       before :each do
-        @from    = '~/Downloads/foo.zip'
-        @to      = '~/Reference/'
-        @options = @maid.file_options
+        @src_file = (@src_dir = '~/Source/') + (@file_name = 'foo.zip')
+        FileUtils.mkdir_p(@src_dir)
+        FileUtils.touch(@src_file)
+        FileUtils.mkdir_p(@dst_dir = '~/Destination/')
       end
 
       it 'should move expanded paths, passing file_options' do
-        FileUtils.should_receive(:mv).with("#{@home}/Downloads/foo.zip", "#{@home}/Reference", @options)
-        @maid.move('~/Downloads/foo.zip', '~/Reference/')
+        @maid.move(@src_file, @dst_dir)
+        File.exists?(@dst_dir + @file_name).should be_true
       end
 
       it 'should log the move' do
         @logger.should_receive(:info)
-        @maid.move(@from, @to)
+        @maid.move(@src_file, @dst_dir)
       end
 
       it 'should not move if the target already exists' do
-        File.stub!(:exist?).and_return(true)
-        FileUtils.should_not_receive(:mv)
+        FileUtils.touch(@dst_dir + @file_name)
         @logger.should_receive(:warn)
 
-        @maid.move(@from, @to)
+        @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)
+        src_files = [@src_file, second_src_file]
+
+        @maid.move(src_files, @dst_dir)
+        File.exist?(@dst_dir + @file_name).should be_true
+        File.exist?(@dst_dir + second_file_name).should be_true
       end
     end
 
     describe '#trash' do
       before :each do
         @trash_path = @maid.trash_path
-        @path = '~/Downloads/foo.zip'
+        @src_file = (@src_dir = '~/Source/') + (@file_name = 'foo.zip')
+        FileUtils.mkdir_p(@src_dir)
+        FileUtils.touch(@src_file)
+
+        @trash_file = File.join(@trash_path, @file_name)
       end
 
       it 'should move the path to the trash' do
-        @maid.should_receive(:move).with(@path, @trash_path)
-        @maid.trash(@path)
+        @maid.trash(@src_file)
+        File.exist?(@trash_file).should be_true
       end
 
       it 'should use a safe path if the target exists' do
         # Without an offset, ISO8601 parses to local time, which is what we want here.
         Timecop.freeze(Time.parse('2011-05-22T16:53:52')) do
-          File.stub!(:exist?).and_return(true)
-          @maid.should_receive(:move).with(@path, "#{@trash_path}/foo.zip 2011-05-22-16-53-52")
-          @maid.trash(@path)
+          FileUtils.touch(@trash_file)
+          @maid.trash(@src_file)
+          new_trash_file = File.join(@trash_path, @file_name + ' 2011-05-22-16-53-52')
+          File.exist?(new_trash_file).should be_true
         end
       end
+
+      it 'should handle multiple paths' do
+        second_src_file = @src_dir + (second_file_name = 'bar.zip')
+        FileUtils.touch(second_src_file)
+        @src_files = [@src_file, second_src_file]
+        @maid.trash(@src_files)
+
+        second_trash_file = File.join(@trash_path, second_file_name)
+        File.exist?(@trash_file).should be_true
+        File.exist?(second_trash_file).should be_true
+      end
+
+      it 'should remove files greater then the remove option size' do
+        @maid.stub!(:disk_usage).and_return(1025)
+        @maid.trash(@src_file, :remove_over => 1.mb)
+        File.exist?(@src_file).should_not be_true
+        File.exist?(@trash_file).should_not be_true
+      end
+
+      it 'should trash files less then the remove option size' do
+        @maid.stub!(:disk_usage).and_return(1023)
+        @maid.trash(@src_file, :remove_over => 1.mb)
+        File.exist?(@trash_file).should be_true
+      end
+    end
+
+    describe '#remove' do
+      before :each do
+        @src_file = (@src_dir = '~/Source/') + (@file_name = 'foo.zip')
+        FileUtils.mkdir_p(@src_dir)
+        FileUtils.touch(@src_file)
+        @src_file_expand_path = File.expand_path(@src_file)
+        @options = @maid.file_options
+      end
+
+      it 'should remove expanded paths, passing options' do
+        @maid.remove(@src_file)
+        File.exist?(@src_file).should be_false
+      end
+
+      it 'should log the remove' do
+        @logger.should_receive(:info)
+        @maid.remove(@src_file)
+      end
+
+      it 'should set the secure option' do
+        @options = @options.merge(:secure => true)
+        FileUtils.should_receive(:rm_r).with(@src_file_expand_path, @options)
+        @maid.remove(@src_file, :secure => true)
+      end
+
+      it 'should set the force option' do
+        @options = @options.merge(:force => true)
+        FileUtils.should_receive(:rm_r).with(@src_file_expand_path, @options)
+        @maid.remove(@src_file, :force => true)
+      end
+
+      it 'should handle multiple paths' do
+        second_src_file = @src_dir + (second_file_name = 'bar.zip')
+        FileUtils.touch(second_src_file)
+        @src_files = [@src_file, second_src_file]
+
+        @maid.remove(@src_files)
+        File.exist?(@src_file).should be_false
+        File.exist?(second_src_file).should be_false
+      end
     end
 
     describe '#dir' do
-      it 'should delegate to Dir#[] with an expanded path' do
-        Dir.should_receive(:[]).with("#@home/Downloads/*.zip")
-        @maid.dir('~/Downloads/*.zip')
+      before :each do
+        @file = (dir = "#@home/Downloads/") + 'foo.zip'
+        FileUtils.mkdir_p(dir)
+      end
+
+      it 'lists files in a directory' do
+        FileUtils.touch(@file)
+        @maid.dir('~/Downloads/*.zip').should == [@file]
+      end
+    end
+
+    describe '#mkdir' do
+      it 'should create a directory successfully' do
+        @maid.mkdir('~/Downloads/Music/Pink.Floyd')
+        File.exist?("#@home/Downloads/Music/Pink.Floyd").should be_true
       end
     end
 
     describe '#find' do
+      before :each do
+        @file = (@dir = '~/Source/') + (@file_name = 'foo.zip')
+        FileUtils.mkdir_p(@dir)
+        FileUtils.touch(@file)
+        @dir_expand_path = File.expand_path(@dir)
+        @file_expand_path = File.expand_path(@file)
+      end
+
       it 'should delegate to Find.find with an expanded path' do
         f = lambda { }
-        Find.should_receive(:find).with("#@home/Downloads/foo.zip", &f)
-        @maid.find('~/Downloads/foo.zip', &f)
+        Find.should_receive(:find).with(@file_expand_path, &f)
+        @maid.find(@file, &f)
+      end
+
+      it "should return an array of all the files' names when no block is given" do
+        @maid.find(@dir).should == [@dir_expand_path, @file_expand_path]
       end
     end
 
@@ -82,7 +199,7 @@ module Maid
 
     describe '#downloaded_from' do
       it 'should determine the download site' do
-        @maid.should_receive(:cmd).and_return(%Q{(\n    "http://www.site.com/foo.zip",\n"http://www.site.com/"\n)})
+        @maid.should_receive(:cmd).and_return(%((\n    "http://www.site.com/foo.zip",\n"http://www.site.com/"\n)))
         @maid.downloaded_from('foo.zip').should == ['http://www.site.com/foo.zip', 'http://www.site.com/']
       end
     end
@@ -103,25 +220,110 @@ module Maid
 
     describe '#disk_usage' do
       it 'should give the disk usage of a file' do
-        @maid.should_receive(:cmd).and_return("136     foo.zip")
+        @maid.should_receive(:cmd).and_return('136     foo.zip')
         @maid.disk_usage('foo.zip').should == 136
       end
+
+      context 'when the file does not exist' do
+        it 'raises an error' do
+          @maid.should_receive(:cmd).and_return('du: cannot access `foo.zip\': No such file or directory')
+          lambda { @maid.disk_usage('foo.zip') }.should raise_error(RuntimeError)
+        end
+      end
+    end
+
+    describe '#created_at' do
+      before do
+        @path = "~/test.txt"
+      end
+
+      it 'should give the created time of the file' do
+        Timecop.freeze(@now) do
+          FileUtils.touch(File.expand_path(@path))
+          @maid.created_at(@path).should == Time.now
+        end
+      end
     end
 
-    describe '#last_accessed' do
+    describe '#accessed_at' do
+      # FakeFS does not implement atime.
       it 'should give the last accessed time of the file' do
-        time = Time.now
-        File.should_receive(:atime).with("#@home/foo.zip").and_return(time)
-        @maid.last_accessed('~/foo.zip').should == time
+        File.should_receive(:atime).with("#@home/foo.zip").and_return(@now)
+        @maid.accessed_at('~/foo.zip').should == @now
+      end
+
+      it 'should trigger deprecation warning when last_accessed is used, but still run' do
+        File.should_receive(:atime).with("#@home/foo.zip").and_return(@now)
+        @maid.should have_deprecated_method(:last_accessed)
+        @maid.last_accessed('~/foo.zip').should == @now
+      end
+    end
+
+    describe '#modified_at' do
+      before do
+        @path = "~/test.txt"
+        FileUtils.touch(File.expand_path(@path))
+      end
+
+      it 'should give the modified time of the file' do
+        Timecop.freeze(@now) do
+          File.open(@path, 'w') { |f| f.write('Test') }
+        end
+
+        # use to_i to ignore milliseconds during test
+        @maid.modified_at(@path).to_i.should == @now.to_i
       end
     end
 
     describe '#git_piston' do
+      it 'is deprecated' do
+        @maid.should have_deprecated_method(:git_piston)
+        @maid.git_piston('~/code/projectname')
+      end
+
       it 'should pull and push the given git repository, logging the action' do
-        @maid.should_receive(:cmd).with(%Q{cd "#@home/code/projectname" && git pull && git push 2>&1})
+        @maid.should_receive(:cmd).with(%(cd "#@home/code/projectname" && git pull && git push 2>&1))
         @logger.should_receive(:info)
         @maid.git_piston('~/code/projectname')
       end
     end
+
+    describe '#sync' do
+      before :each do
+        @src_dir = '~/Downloads/'
+        @dst_dir = '~/Reference'
+      end
+
+      it 'should sync the expanded paths, retaining backslash' do
+        @maid.should_receive(:cmd).with(%(rsync -a -u "#@home/Downloads/" "#@home/Reference" 2>&1))
+        @maid.sync(@src_dir, @dst_dir)
+      end
+
+      it 'should log the action' do
+        @logger.should_receive(:info)
+        @maid.sync(@src_dir, @dst_dir)
+      end
+
+      it 'should have no options' do
+        @maid.should_receive(:cmd).with(%(rsync  "#@home/Downloads/" "#@home/Reference" 2>&1))
+        @maid.sync(@src_dir, @dst_dir, :archive => false, :update => false)
+      end
+
+      it 'should add all options' do
+        @maid.should_receive(:cmd).with(%(rsync -a -v -u -m --exclude=".git" --delete "#@home/Downloads/" "#@home/Reference" 2>&1))
+        @maid.sync(@src_dir, @dst_dir, :archive => true, :update => true, :delete => true, :verbose => true, :prune_empty => true, :exclude => '.git')
+      end
+
+      it 'should add multiple exlcude options' do
+        @maid.should_receive(:cmd).with(%(rsync -a -u --exclude=".git" --exclude=".rvmrc" "#@home/Downloads/" "#@home/Reference" 2>&1))
+        @maid.sync(@src_dir, @dst_dir, :exclude => ['.git', '.rvmrc'])
+      end
+
+      it 'should add noop option' do
+        @maid.file_options[:noop] = true
+        @maid.should_receive(:cmd).with(%(rsync -a -u -n "#@home/Downloads/" "#@home/Reference" 2>&1))
+        @maid.sync(@src_dir, @dst_dir)
+      end
+    end
   end
 end