maid 0.3.0 → 0.4.0.alpha.1

data/.ruby-gemset

@@ -0,0 +1 @@
+maid

data/.ruby-version

@@ -0,0 +1 @@
+1.8.7

data/AUTHORS.md

@@ -1,7 +1,13 @@
 In alphabetical order:
 
 * Benjamin Oakes (@benjaminoakes)
+* Bradley Smith (@bradleyd)
+* Graham Siener (@gsiener)
+* John Colvin (@JohnColvin)
+* Justin Hileman (@bobthecow)
 * Larry Lv (@larrylv)
 * Lewis O'Driscoll (@loddy1234)
 * Lloyd Philbrook (@phoolish)
 * Mark Jaquith (@markjaquith)
+* Mikael Hultgren (@blomma)
+* Mu Ye (@yemutex)

data/ChangeLog

@@ -1,3 +1,19 @@
+maid (0.4.0) unstable; urgency=low
+
+  * (Work in progress)
+  * NOTE: A previous alpha of v0.3.0 was released as v0.2.3.alpha.1. 
+  * Mu Ye: Require option to cause real cleaning to take place (Closes: #78)
+  * Graham Siener: Add UTF-8 support for zipfile_contents tool (Closes: #35)
+  * Justin Hileman: Add ability to list duplicate files (Closes: #15)
+  * Mikael Hultgren: Rotate log file
+  * John Colvin: Add filetype detection and filtering (Closes: #51)
+  * 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)
+
+ -- Benjamin Oakes <hello@benjaminoakes.com>  TODO
+
 maid (0.3.0) stable; urgency=high
 
   * Stats!  { 'collaborators' => 11, 'downloads' => 5664, 'forks' => 36,
@@ -15,21 +31,12 @@ maid (0.2.2) stable; urgency=high
     'open_issues' => 35, 'closed_issues' => 60, 'stars' => 654,
     'users_sharing_rules' => 19 }
   * "urgency=high" because of security related change in #70
-  * Includes all changes since the 0.2.1 release
-
- -- Benjamin Oakes <hello@benjaminoakes.com>  Wed, 27 Feb 2013 00:00:00 +0000
-
-maid (0.2.2.beta.1) unstable; urgency=low
-
-  * Stats!  { 'collaborators' => 11, 'downloads' => 4788, 'forks' => 36,
-    'open_issues' => 36, 'closed_issues' => 59, 'stars' => 649,
-    'users_sharing_rules' => 18 }
   * Added better documentation (Closes: #91)
   * Safely escape shell commands (Closes: #70)
   * Made gem version dependencies less strict
   * Started experimental Ruby 2.0 support
 
- -- Benjamin Oakes <hello@benjaminoakes.com>  Sun, 17 Feb 2013 00:00:00 +0000
+ -- Benjamin Oakes <hello@benjaminoakes.com>  Wed, 27 Feb 2013 00:00:00 +0000
 
 maid (0.2.1) stable; urgency=low
 
@@ -40,108 +47,56 @@ maid (0.2.1) stable; urgency=low
 
 maid (0.2.0) stable; urgency=low
 
-  * Includes all changes since the 0.1.3 release (including the short lived
-    0.1.4 version).  See below for details.
-
- -- Benjamin Oakes <hello@benjaminoakes.com>  Tue, 25 Dec 2012 00:00:00 +0000
-
-maid (0.2.0.rc.2) unstable; urgency=low
-
-  * Change "maid --version" to be the same as "maid version"
-
- -- Benjamin Oakes <hello@benjaminoakes.com>  Mon, 24 Dec 2012 00:00:00 +0000
-
-maid (0.2.0.rc.1) unstable; urgency=low
-
-  * More documentation for "dir".
-
- -- Benjamin Oakes <hello@benjaminoakes.com>  Wed, 19 Dec 2012 00:00:00 +0000
-
-maid (0.2.0.beta.3) unstable; urgency=low
-
-  * Use newly released "xdg" instead of custom "maid-xdg" dependency. (The new
-    release was found after Beta 2 was released.)
-
- -- Benjamin Oakes <hello@benjaminoakes.com>  Mon, 17 Dec 2012 00:00:00 +0000
-
-maid (0.2.0.beta.2) unstable; urgency=low
-
+  * Started semver.org-like version numbering.
+  * Improved user documentation, now in Markdown.  (Closes: #66)
   * Add more documentation to "find" and "remove" (Closes: #74)
-  * Add logging to "mkdir" (Closes: #75, #77)
-  * Updated README to include Hacker News post
-  * Updated AUTHORS to include new contributors
-  * Various development improvements
-
- -- Benjamin Oakes <hello@benjaminoakes.com>  Sun, 16 Dec 2012 00:00:00 +0000
-
-maid (0.2.0.beta.1) unstable; urgency=low
-
+  * Add more documentation for "dir".
   * Change "dir" to allow multiple paths (Closes: #64)
-  * Change "mkdir" to return the path of the created directory (Closes: #69)
-  * Various development improvements
-
- -- Benjamin Oakes <hello@benjaminoakes.com>  Sun, 2 Dec 2012 00:00:00 +0000
-
-maid (0.2.0.alpha.1) unstable; urgency=low
-
-  * Started semver.org-like version numbering.  Total adoption is
-    forthcoming.  This forced v0.2.0 vs. v0.1.4.
   * Changed "dir" tool to always sort. (Closes: #62)
+  * Lewis O'Driscoll: Add logging to "mkdir" (Closes: #75, #77)
+  * Change "mkdir" to return the path of the created directory (Closes: #69)
+  * Use newly released "xdg" instead of custom "maid-xdg" dependency.
+  * Change "maid --version" to be the same as "maid version"
   * Added "version --long" ("-l") command which gives information about the platform
     version and Ruby version. (Closes: #65)
-  * Improved user documentation, now in Markdown.  (Closes: #66)
   * Updated development dependencies.
-  * Various minor internal changes.
-
- -- Benjamin Oakes <hello@benjaminoakes.com>  Tue, 27 Nov 2012 00:00:00 +0000
-
-maid (0.1.4.alpha.2) unstable; urgency=low
-
+  * Updated README to include Hacker News post
+  * Updated AUTHORS to include new contributors
   * Noted license in gemspec.  Was incorrect value in alpha.1. Made an early
     alpha release to test effect on RubyGems.org listing. (Closes: #61)
-  * Minor development-only documentation changes.
+  * Various development improvements
 
- -- Benjamin Oakes <hello@benjaminoakes.com>  Sat, 24 Nov 2012 00:00:00 +0000
+ -- Benjamin Oakes <hello@benjaminoakes.com>  Tue, 25 Dec 2012 00:00:00 +0000
 
 maid (0.1.3) stable; urgency=medium
 
   * Stats!  { 'stars' => 192 }
   * First stable release with official support for Ubuntu.
-  * Added new features, fixed bugs as listed for betas 1 and 2.
-  * Minor development-only changes:
-      * Added ChangeLog (this file)
-      * Updated development dependencies to most recent versions
-      * Scripted testing of supported Ruby and Ubuntu releases
-
- -- Benjamin Oakes <hello@benjaminoakes.com>  Fri, 23 Nov 2012 00:00:00 +0000
-
-maid (0.1.3.beta.2) unstable; urgency=low
-
-  * Fixed "Trash does not expand paths". (Closes: #56)
-  * Fixed "XDG gives a warning about RbConfig vs Config" on Ubuntu by using
-    custom-built maid-xdg gem. (Closes: #53)
-
- -- Benjamin Oakes <hello@benjaminoakes.com>  Wed, 21 Nov 2012 00:00:00 +0000
-
-maid (0.1.3.beta.1) unstable; urgency=low
-
-  * Started official support for Ubuntu.
   * Fixed default trash path on Ubuntu (and possibly other Linux
     distributions). (Closes: #6)
-  * Added ability to handle an array of filenames passed to "move", "trash". (Closes:
-    #16)
-  * Added "remove" tool for deleting files, and secure deletion. (Closes: #30)
-  * Added "remove_over" option for "trash" which can delete files if they're
-    over a size threshold. (Closes: #32)
-  * Added "sync" tool for using rsync. (Closes: #17)
-  * Added "mkdir" tool for making directories ("folders"). (Closes: #20)
+  * Lloyd Philbrook: Added ability to handle an array of filenames passed to
+    "move", "trash". (Closes: #16)
+  * Lloyd Philbrook: Added "remove" tool for deleting files, and secure deletion.
+    (Closes: #30)
+  * Lloyd Philbrook: Added "remove_over" option for "trash" which can delete
+    files if they're over a size threshold. (Closes: #32)
+  * Lloyd Philbrook: Added "sync" tool for using rsync. (Closes: #17)
+  * Larry Lv: Added "mkdir" tool for making directories ("folders"). (Closes: #20)
+  * Larry Lv: The "find" tool acts like "dir" when no block is given. (Closes: #27)
   * Added "created_at" tool for looking up creation time. (Closes: #21)
   * Added "modified_at" tool for looking up modification time. (Closes: #13)
-  * Renamed "last_accessed" to "accessed_at", deprecated "last_accessed".
-    (Closes: #22)
+  * Lloyd Philbrook: Renamed "last_accessed" to "accessed_at", deprecated
+    "last_accessed".  (Closes: #22)
   * Deprecated "git_piston" in favor of SparkleShare. (Closes: #18)
   * Updated README and samples. (Closes: #38)
   * Updated dependencies. (Closes: #5)
+  * Fixed "Trash does not expand paths". (Closes: #56)
+  * Fixed "XDG gives a warning about RbConfig vs Config" on Ubuntu by using
+    custom-built maid-xdg gem. (Closes: #53)
+  * Minor development-only changes:
+      * Added ChangeLog (this file)
+      * Updated development dependencies to most recent versions
+      * Scripted testing of supported Ruby and Ubuntu releases
 
  -- Benjamin Oakes <hello@benjaminoakes.com>  Mon, 15 Oct 2012 00:00:00 +0000
 

data/README.md

@@ -1,6 +1,11 @@
 # Maid
 
-Be lazy!  Let Maid clean up after you, based on rules you define.
+[![Gem Version](https://badge.fury.io/rb/maid.png)](http://badge.fury.io/rb/maid)
+[![Build Status](https://secure.travis-ci.org/benjaminoakes/maid.png)](http://travis-ci.org/benjaminoakes/maid)
+[![Dependency Status](https://gemnasium.com/benjaminoakes/maid.png)](https://gemnasium.com/benjaminoakes/maid)
+[![Code Climate](https://codeclimate.com/github/benjaminoakes/maid.png)](https://codeclimate.com/github/benjaminoakes/maid)
+
+**Be lazy!**  Let Maid clean up after you, based on rules you define.
 
 [Installation](#installation)
 | [Tutorial](#tutorial)
@@ -43,10 +48,6 @@ This project wouldn't be where it is today without its users and contributors.
 
 ### For Developers
 
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/benjaminoakes/maid)
-[![Build Status](https://secure.travis-ci.org/benjaminoakes/maid.png)](http://travis-ci.org/benjaminoakes/maid)
-[![Dependency Status](https://gemnasium.com/benjaminoakes/maid.png)](https://gemnasium.com/benjaminoakes/maid)
-
 * Address a `TODO` or `FIXME` in the code.
 * Complete an issue (easy ones [are labelled](https://github.com/benjaminoakes/maid/issues?labels=difficulty-1&page=1&state=open), and issues for future releases are [grouped by milestone](https://github.com/benjaminoakes/maid/issues/milestones)).
 * **Working on an issue?** Please leave a comment so others know.

data/Vagrantfile

@@ -1,10 +1,15 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
-Vagrant::Config.run do |config|
+Vagrant.configure('2') do |config|
   # See also: `script/vagrant-test`, `script/vagrant-test-all`
-  config.vm.box = ENV['MAID_TARGET_BOX'] || 'precise64'
+  config.vm.box     = ENV['MAID_TARGET_BOX'] || 'precise64'
   config.vm.box_url = 'http://files.vagrantup.com/precise64.box' if 'precise64' == config.vm.box
 
+  config.vm.provider :virtualbox do |vb|
+    # Maid has very low system requirements
+    vb.customize ['modifyvm', :id, '--cpus', 1, '--memory', 192]
+  end
+
   config.vm.provision(:shell, :path => 'script/vagrant-provision', :args => ENV['MAID_TARGET_RUBY'] || '1.9.3')
 end

data/lib/maid/app.rb

@@ -11,12 +11,17 @@ class Maid::App < Thor
   end
 
   desc 'clean', 'Clean based on rules'
-  method_option :rules,  :type => :string,  :aliases => %w(-r)
-  method_option :noop,   :type => :boolean, :aliases => %w(-n --dry-run)
-  method_option :silent, :type => :boolean, :aliases => %w(-s)
+  method_option :rules,   :type => :string,  :aliases => %w(-r)
+  method_option :noop,    :type => :boolean, :aliases => %w(-n --dry-run)
+  method_option :force,   :type => :boolean, :aliases => %w(-f)
+  method_option :silent,  :type => :boolean, :aliases => %w(-s)
   def clean
     maid = Maid::Maid.new(maid_options(options))
 
+    unless options.noop? || options.force?
+      warn 'Running "maid clean" without a flag is deprecated.  Please use "maid clean --noop" or "maid clean --force".'
+    end
+
     if Maid::TrashMigration.needed?
       migrate_trash
       return

data/lib/maid/maid.rb

@@ -10,7 +10,12 @@ require 'xdg'
 class Maid::Maid
   DEFAULTS = {
     :progname     => 'Maid',
+
     :log_device   => File.expand_path('~/.maid/maid.log'),
+    # We don't want the log files to grow without check, but 50 MB doesn't seem too bad.  (We're going with a larger size just for safety right now.)
+    :log_shift_age  => 5,
+    :log_shift_size => 10 * 1_048_576, # 10 * 1 MB
+
     :rules_path   => File.expand_path('~/.maid/rules.rb'),
     :file_options => { :noop => false }, # for `FileUtils`
   }.freeze
@@ -31,7 +36,7 @@ class Maid::Maid
     @logger = unless options[:logger]
       @log_device = options[:log_device]
       FileUtils.mkdir_p(File.dirname(@log_device)) unless @log_device.kind_of?(IO)
-      Logger.new(@log_device)
+      @logger = Logger.new(@log_device, options[:log_shift_age], options[:log_shift_size])
     else
       options[:logger]
     end
@@ -98,7 +103,7 @@ class Maid::Maid
     if supported_command?(command)
       %x(#{ command })
     else
-      raise ArgumentError, "Unsupported system command: #{ command.inspect }"
+      raise NotImplementedError, "Unsupported system command: #{ command.inspect }"
     end
   end
 

data/lib/maid/platform.rb

@@ -13,5 +13,16 @@ 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

@@ -1,7 +1,11 @@
-require 'fileutils'
+require 'digest/md5'
 require 'find'
+require 'fileutils'
 require 'time'
 
+require 'mime/types'
+require 'zip/zip'
+
 # These "tools" are methods available in the Maid DSL.
 #
 # In general, methods are expected to:
@@ -208,6 +212,15 @@ module Maid::Tools
       sort
   end
 
+  # Give only files matching the given glob.
+  #
+  # This is the same as #dir but only includes actual files (no directories or symlinks).
+  #
+  def files(globs)
+    dir(globs).
+      select { |f| File.file?(f) }
+  end
+
   # Create a directory and all of its parent directories.
   #
   # The path of the created directory is returned, which allows for chaining (see examples).
@@ -270,13 +283,13 @@ module Maid::Tools
 
   # [Mac OS X] Use Spotlight to locate all files matching the given filename.
   #
-  # [Ubuntu] Not currently supported.  See [issue #67](https://github.com/benjaminoakes/maid/issues/67).
+  # [Ubuntu] Use `locate` to locate all files matching the given filename.
   #
   # ## Examples
   #
   #     locate('foo.zip') # => ['/a/foo.zip', '/b/foo.zip']
   def locate(name)
-    cmd("mdfind -name #{ sh_escape(name) }").split("\n")
+    cmd("#{Maid::Platform::Commands.locate} #{ sh_escape(name) }").split("\n")
   end
 
   # [Mac OS X] Use Spotlight metadata to determine the site from which a file was downloaded.
@@ -285,9 +298,46 @@ module Maid::Tools
   #
   #     downloaded_from('foo.zip') # => ['http://www.site.com/foo.zip', 'http://www.site.com/']
   def downloaded_from(path)
-    raw = cmd("mdls -raw -name kMDItemWhereFroms #{ sh_escape(path) }")
-    clean = raw[1, raw.length - 2]
-    clean.split(/,\s+/).map { |s| t = s.strip; t[1, t.length - 2] }
+    mdls_to_array(path, 'kMDItemWhereFroms')
+  end
+
+  # Find all duplicate files in the given globs.
+  #
+  # Globs are expanded as in #dir, then all non-files are filtered out. The remaining
+  # files are compared by size, and non-dupes are filtered out. The remaining candidates
+  # are then compared by checksum. Dupes are returned as an array of arrays.
+  #
+  # ## Examples
+  #
+  #     dupes_in('~/{Downloads,Desktop}/*') # => [
+  #                                                ['~/Downloads/foo.zip', '~/Downloads/foo (1).zip'],
+  #                                                ['~/Desktop/bar.txt', '~/Desktop/bar copy.txt']
+  #                                              ]
+  #
+  # Keep the dupe with the shortest name (ideal for `foo (1).zip` and `foo copy.zip` style dupes):
+  #
+  #     dupes_in('~/Downloads/*').each do |dupes|
+  #       trash dupes.sort_by { |p| File.basename(p).length }[1..-1]
+  #     end
+  #
+  # Keep the oldest dupe:
+  #
+  #     dupes_in('~/Desktop/*', '~/Downloads/*').each do |dupes|
+  #       trash dupes.sort_by { |p| File.mtime(p) }[1..-1]
+  #     end
+  #
+  def dupes_in(globs)
+    dupes = []
+    files(globs).                           # Start by filtering out non-files
+      group_by { |f| size_of(f) }.          # ... then grouping by size, since that's fast
+      reject { |s, p| p.length < 2 }.       # ... and filter out any non-dupes
+      map do |size, candidates|
+        dupes += candidates.
+          group_by { |p| checksum_of(p) }. # Now group our candidates by a slower checksum calculation
+          reject { |c, p| p.length < 2 }.   # ... and filter out any non-dupes
+          values
+      end
+    dupes
   end
 
   # [Mac OS X] Use Spotlight metadata to determine audio length.
@@ -303,10 +353,10 @@ module Maid::Tools
   #
   # ## Examples
   #
-  #     zipfile_contents('foo.zip') # => ['foo/foo.exe', 'foo/README.txt']
+  #     zipfile_contents('foo.zip') # => ['foo.exe', 'README.txt', 'subdir/anything.txt']
   def zipfile_contents(path)
-    raw = cmd("unzip -Z1 #{ sh_escape(path) }")
-    raw.split("\n")
+    # It might be nice to use `glob` from `Zip::ZipFileSystem`, but it seems buggy.  (Subdirectories aren't included.)
+    Zip::ZipFile.foreach(path).map { |entry| entry.name }.sort
   end
 
   # Calculate disk usage of a given path in kilobytes.
@@ -370,6 +420,24 @@ module Maid::Tools
     File.mtime(expand(path))
   end
 
+  # Get the size of a file.
+  #
+  # ## Examples
+  #
+  #     size_of('foo.zip') # => 2193
+  def size_of(path)
+    File.size(path)
+  end
+
+  # Get a checksum for a file.
+  #
+  # ## Examples
+  #
+  #     checksum_of('foo.zip') # => "ae8dbb203dfd560158083e5de90969c2"
+  def checksum_of(path)
+    Digest::MD5.hexdigest(File.read(path))
+  end
+
   # @deprecated
   #
   # Pull and push the `git` repository at the given path.
@@ -439,6 +507,75 @@ module Maid::Tools
     log("Fired sync from #{ sh_escape(from) } to #{ sh_escape(to) }.  STDOUT:\n\n#{ stdout }")
   end
 
+  # [Mac OS X] Use Spotlight metadata to determine which content types a file has.
+  #
+  # ## Examples
+  #
+  #     spotlight_content_types('foo.zip') # => ['public.zip-archive', 'public.archive']
+  def spotlight_content_types(path)
+    mdls_to_array(path, 'kMDItemContentTypeTree')
+  end
+
+  # Get the content types of a path.
+  #
+  # Content types can be MIME types, Internet media types or Spotlight content types (OS X only).
+  #
+  # ## Examples
+  #
+  #     content_types('foo.zip') # => ["public.zip-archive", "com.pkware.zip-archive", "public.archive", "application/zip", "application"]
+  #     content_types('bar.jpg') # => ["public.jpeg", "public.image", "image/jpeg", "image"]
+  def content_types(path)
+    [spotlight_content_types(path), mime_type(path), media_type(path)].flatten
+  end
+
+  # Get the MIME type of the file.
+  #
+  # ## Examples
+  #
+  #     mime_type('bar.jpg') # => "image/jpeg"
+  def mime_type(path)
+    type = MIME::Types.type_for(path)[0]
+    [type.media_type, type.sub_type].join('/')
+  end
+
+  # Get the Internet media type of the file.
+  #
+  # In other words, the first part of `mime_type`.
+  #
+  # ## Examples
+  #
+  #     media_type('bar.jpg') # => "image"
+  def media_type(path)
+    MIME::Types.type_for(path)[0].media_type
+  end
+
+  # Filter an array by content types.
+  #
+  # Content types can be MIME types, internet media types or Spotlight content types (OS X only).
+  #
+  # If you need your rules to work on multiple platforms, it's recommended to avoid using Spotlight content types.
+  #
+  # ## Examples
+  #
+  # ### Using media types
+  #
+  #     where_content_type(dir('~/Downloads/*'), 'video')
+  #     where_content_type(dir('~/Downloads/*'), ['image', 'audio'])
+  #
+  # ### Using MIME types
+  #
+  #     where_content_type(dir('~/Downloads/*'), 'image/jpeg')
+  #
+  # ### Using Spotlight content types
+  # 
+  # Less portable, but richer data in some cases.
+  #
+  #     where_content_type(dir('~/Downloads/*'), 'public.image')
+  def where_content_type(paths, filter_types)
+    filter_types = Array(filter_types)
+    Array(paths).select { |p| !(filter_types & content_types(p)).empty? }
+  end
+
   private
 
   def sh_escape(array)
@@ -460,4 +597,12 @@ module Maid::Tools
   def expand_all(paths)
     Array(paths).map { |path| expand(path) }
   end
+
+  def mdls_to_array(path, attribute)
+    return [] unless Maid::Platform.osx?
+    raw = cmd("mdls -raw -name #{attribute} #{ sh_escape(path) }")
+    return [] if raw.empty?
+    clean = raw[1, raw.length - 2]
+    clean.split(/,\s+/).map { |s| t = s.strip; t[1, t.length - 2] }
+  end
 end

data/lib/maid/version.rb

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

data/maid.gemspec

@@ -1,7 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path('../lib', __FILE__)
 require 'maid/version'
-require 'maid/platform'
 
 Gem::Specification.new do |s|
   s.name        = 'maid'
@@ -18,19 +17,25 @@ Gem::Specification.new do |s|
 
   # Strategy: if possible, use ranges (so there are fewer chances of version conflicts)
   s.add_dependency('escape', '>= 0.0.1', '< 0.1.0') # Used for better Ruby 1.8.7 support
-  s.add_dependency('thor', '>= 0.14.0', '< 0.18.0')
+  s.add_dependency('thor', '>= 0.14.0', '< 0.19.0')
   s.add_dependency('deprecated', '~> 3.0.0')
-  s.add_dependency('ohai', '>= 6.14.0', '< 6.17.0')
+  s.add_dependency('mime-types', '~> 1.21') # TODO: loosen version restrictions based on testing
+  s.add_dependency('ohai', '>= 6.14.0', '< 6.18.0')
+  s.add_dependency('rubyzip', '>= 0.5.7', '< 0.10.0')
   s.add_dependency('xdg', '~> 2.2.3') # previous versions had bugs
+  # TODO: use one of these two gems instead of `mdfind`.  **But** They have to work on Linux as well.
+  #
+  #     s.add_dependency('mac-spotlight', '~> 0.0.4')
+  #     s.add_dependency('spotlight', '~> 0.0.6')
 
   # Strategy: specific versions (since they're just for development)
   s.add_development_dependency('fakefs', '~> 0.4.2')
   s.add_development_dependency('guard', '~> 1.6.2')
-  s.add_development_dependency('guard-rspec', '~> 2.4.0')
+  s.add_development_dependency('guard-rspec', '~> 2.5.0')
   s.add_development_dependency('rake', '~> 10.0.3')
   s.add_development_dependency('redcarpet', '~> 2.2.2') # Soft dependency of `yard`
-  s.add_development_dependency('rspec', '~> 2.12.0')
-  s.add_development_dependency('timecop', '~> 0.5.9.1')
+  s.add_development_dependency('rspec', '~> 2.13.0')
+  s.add_development_dependency('timecop', '~> 0.6.1')
   s.add_development_dependency('yard', '~> 0.8.4')
 
   # In Vagrant, polling won't cross over the OS boundary if you develop in the host OS but run your tests in the
@@ -41,8 +46,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rb-inotify', '~> 0.9.0')
   s.add_development_dependency('rb-fsevent', '~> 0.9.2')
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files         = `git ls-files -z`.split("\0")
+  s.test_files    = `git ls-files -z -- {test,spec,features}/*`.split("\0")
+  s.executables   = `git ls-files -z -- bin/*`.split("\0").map{ |f| File.basename(f) }
   s.require_paths = %w(lib)
 end

data/spec/dependency_spec.rb

@@ -1,8 +1,10 @@
 require 'logger'
+require 'mime/types'
 require 'ohai'
 require 'rbconfig'
 require 'stringio'
 require 'xdg'
+require 'zip/zip'
 
 # > What is Dependency Testing?
 # >
@@ -11,6 +13,10 @@ require 'xdg'
 # >
 # > -- http://sqa.fyicenter.com/FAQ/Software-QA-Testing/What_is_Dependency_Testing_.html
 describe 'Dependency expectations' do
+  before do
+    @file_fixtures_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/files/')
+  end
+
   describe Logger do
     # Depending on the situation, `Logger` might have been overwritten to have a different interface.  (I'm looking at you, Rails.)
     it 'logs with the expected interface' do
@@ -22,6 +28,16 @@ describe 'Dependency expectations' do
     end
   end
 
+  describe MIME::Types do
+    it 'reports media types and sub types when given a path' do
+      types = MIME::Types.type_for('anything.jpg')
+      types.length.should == 1
+      type = types[0]
+      type.media_type.should == 'image'
+      type.sub_type.should == 'jpeg'
+    end
+  end
+
   describe Ohai do
     before do
       @ohai = Ohai::System.new
@@ -59,4 +75,17 @@ describe 'Dependency expectations' do
       XDG['DATA_HOME'].to_s.should match(%r{^/.*?/\.local/share$})
     end
   end
+
+  describe Zip::ZipFile do
+    it 'makes entries available with foreach' do
+      Zip::ZipFile.foreach("#@file_fixtures_path/foo.zip").map { |entry| entry.name }.sort.
+        should == %w(README.txt foo.exe subdir/anything.txt)
+    end
+
+    it 'supports UTF-8 filenames' do
+      # Filename is a Japanese character
+      Zip::ZipFile.foreach("#@file_fixtures_path/\343\201\225.zip").map { |entry| entry.name }.
+        should == %w(anything.txt)
+    end
+  end
 end

data/spec/lib/maid/app_spec.rb

@@ -43,22 +43,30 @@ module Maid
       @app.clean
     end
 
-    it 'should tell the Maid to clean' do
+    it 'should clean when --force is specified' do      
       @maid.should_receive(:clean)
-      @app.clean
+      App.start(['clean', '--force'])
+    end 
+
+    it 'should issue deprecation notice when called without option, but still clean' do
+      @maid.should_receive(:clean).twice
+      capture_stderr { App.start(['clean']) }.string.should match(/deprecated/)
+      capture_stderr { App.start(['clean', '--silent']) }.string.should match(/deprecated/)
     end
 
     it 'should not be silent if not given the --silent option' do
-      capture_stdout { App.start(['clean']) }.string.should_not == ''
+      capture_stdout { App.start(['clean', '--force']) }.string.should_not == ''
     end
 
     it 'should be silent if given the --silent option' do
       # TODO: It might even make sense to wrap `maid.clean` in `capture_stdout { ... }`
-      capture_stdout { App.start(['clean', '--silent']) }.string.should == ''
+      capture_stdout { App.start(['clean', '--noop', '--silent']) }.string.should == ''
+      capture_stdout { App.start(['clean', '--force', '--silent']) }.string.should == ''
     end
 
     it 'should complain about a MISSPELLED option' do
       capture_stderr { App.start(['clean', '--slient']) }.string.should match(/Unknown/)
+      capture_stderr { App.start(['clean', '--noop', '--slient']) }.string.should match(/Unknown/)
     end
 
     it 'should complain about an undefined task' do
@@ -77,7 +85,7 @@ module Maid
     end
 
     it 'is mapped as --version' do
-      # TODO: Test via Rspec (it's only in the smoke test script for now)
+      App.start(['--version']).should == @app.version
     end
 
     context 'with the "long" option' do

data/spec/lib/maid/maid_spec.rb

@@ -10,16 +10,26 @@ module Maid
 
     describe '.new' do
       it 'should set up a logger with the default path' do
-        Logger.should_receive(:new).with(Maid::DEFAULTS[:log_device])
+        Logger.should_receive(:new).with(Maid::DEFAULTS[:log_device], anything, anything)
         Maid.new
       end
 
-      it 'should set up a logger with the given path, if provided' do
+      it 'should set up a logger with the given path, when provided' do
         log_device = '/var/log/maid.log'
-        Logger.should_receive(:new).with(log_device)
+        Logger.should_receive(:new).with(log_device, anything, anything)
         Maid.new(:log_device => log_device)
       end
 
+      it 'should rotate the log with the default settings' do
+        Logger.should_receive(:new).with(anything, Maid::DEFAULTS[:log_shift_age], Maid::DEFAULTS[:log_shift_size])
+        Maid.new
+      end
+
+      it 'should rotate the log with the given settings, when provided' do
+        Logger.should_receive(:new).with(anything, 42, 1_000_000)
+        Maid.new(:log_shift_age => 42, :log_shift_size => 1_000_000)
+      end
+
       it 'should make the log directory in case it does not exist' do
         FileUtils.should_receive(:mkdir_p).with('/home/username/log')
         Maid.new(:log_device => '/home/username/log/maid.log')
@@ -189,11 +199,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(ArgumentError)
+        lambda { @maid.cmd('not-a-real-command arg1 arg2') }.should raise_error(NotImplementedError)
       end
 
       it 'should report `echo` as a real command' do
-        lambda { @maid.cmd('echo .') }.should_not raise_error(ArgumentError)
+        lambda { @maid.cmd('echo .') }.should_not raise_error(NotImplementedError)
       end
     end
   end

data/spec/lib/maid/platform_spec.rb

@@ -25,6 +25,10 @@ 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
@@ -39,6 +43,10 @@ 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

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'spec_helper'
 
 module Maid
@@ -188,7 +189,7 @@ module Maid
       end
 
       it 'should handle multiple paths' do
-        second_src_file = @src_dir + (second_file_name = 'bar.zip')
+        second_src_file = "#@src_dir/bar.zip"
         FileUtils.touch(second_src_file)
         @src_files = [@src_file, second_src_file]
 
@@ -250,6 +251,56 @@ module Maid
       end
     end
 
+    describe '#files' do
+      before do
+        @file = (@dir = "#@home/Downloads") + '/foo.zip'
+        FileUtils.mkdir_p(@dir)
+        FileUtils.mkdir(@dir + '/notfile')
+      end
+
+      it 'lists only files in a directory' do
+        FileUtils.touch(@file)
+        @maid.files('~/Downloads/*.zip').should == [@file]
+      end
+
+      it 'lists multiple files in alphabetical order' do
+        # It doesn't occur with `FakeFS` as far as I can tell, but Ubuntu (and possibly OS X) can give the results out
+        # of lexical order.  That makes using the `dry-run` output difficult to use.
+        Dir.stub(:glob) { %w(/home/foo/b.zip /home/foo/a.zip /home/foo/c.zip) }
+        @maid.dir('~/Downloads/*.zip').should == %w(/home/foo/a.zip /home/foo/b.zip /home/foo/c.zip)
+      end
+
+      context 'with multiple files' do
+        before do
+          @other_file = "#@dir/qux.tgz"
+          FileUtils.touch(@file)
+          FileUtils.touch(@other_file)
+        end
+
+        it 'list files in all provided globs' do
+          @maid.dir(%w(~/Downloads/*.tgz ~/Downloads/*.zip)).should == [@file, @other_file]
+        end
+
+        it 'lists files when using regexp-like glob patterns' do
+          @maid.dir('~/Downloads/*.{tgz,zip}').should == [@file, @other_file]
+        end
+      end
+
+      context 'with multiple directories' do
+        before do
+          @other_file = "#@home/Desktop/bar.zip"
+          FileUtils.touch(@file)
+          FileUtils.mkdir_p(File.dirname(@other_file))
+          FileUtils.mkdir(@home + '/Desktop/notfile')
+          FileUtils.touch(@other_file)
+        end
+
+        it 'lists files in directories when using regexp-like glob patterns' do
+          @maid.dir('~/{Desktop,Downloads}/*.zip').should == [@other_file, @file]
+        end
+      end
+    end
+
     describe '#mkdir' do
       it 'should create a directory successfully' do
         @maid.mkdir('~/Downloads/Music/Pink.Floyd')
@@ -301,6 +352,10 @@ module Maid
     end
 
     describe '#downloaded_from' do
+      before do
+        Platform.stub(:osx?) { true }
+      end
+
       it 'should determine the download site' do
         @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/']
@@ -316,8 +371,11 @@ module Maid
 
     describe '#zipfile_contents' do
       it 'should inspect the contents of a .zip file' do
-        @maid.should_receive(:cmd).and_return("foo/foo.exe\nfoo/README.txt\n")
-        @maid.zipfile_contents('foo.zip').should == ['foo/foo.exe', 'foo/README.txt']
+        Zip::ZipFile.stub(:foreach) do
+          [mock(:name => 'foo.exe'), mock(:name => 'README.txt'), mock(:name => 'subdir/anything.txt')]
+        end
+
+        @maid.zipfile_contents('foo.zip').should == ['README.txt', 'foo.exe', 'subdir/anything.txt']
       end
     end
 
@@ -378,6 +436,28 @@ module Maid
       end
     end
 
+    describe '#size_of' do
+      before do
+        @file = '~/foo.zip'
+      end
+
+      it 'should give the size of the file' do
+        File.should_receive(:size).with(@file).and_return(42)
+        @maid.size_of(@file).should == 42
+      end
+    end
+
+    describe '#checksum_of' do
+      before do
+        @file = '~/test.txt'
+      end
+
+      it 'should return the checksum of the file' do
+        File.should_receive(:read).with(@file).and_return('contents')
+        @maid.checksum_of(@file).should == Digest::MD5.hexdigest('contents')
+      end
+    end
+
     describe '#git_piston' do
       it 'is deprecated' do
         @maid.should have_deprecated_method(:git_piston)
@@ -431,4 +511,52 @@ module Maid
       end
     end
   end
+
+  describe Tools, :fakefs => false do
+    let(:file_fixtures_path) { File.expand_path(File.dirname(__FILE__) + '../../../fixtures/files/') }
+    let(:file_fixtures_glob) { "#{ file_fixtures_path }/*" }
+    let(:image_path) { File.join(file_fixtures_path, 'ruby.jpg') }
+
+    before do
+      @logger = double('Logger').as_null_object
+      @maid = Maid.new(:logger => @logger)
+    end
+
+    describe '#dupes_in' do
+      it 'should list duplicate files in arrays' do
+        dupes = @maid.dupes_in(file_fixtures_glob)
+        dupes.first.should be_kind_of(Array)
+
+        basenames = dupes.flatten.map { |p| File.basename(p) }
+        basenames.should == %w(bar.zip foo.zip)
+      end
+    end
+
+    describe '#mime_type' do
+      context 'given a JPEG image' do
+        it 'reports "image/jpeg"' do
+          @maid.mime_type(image_path).should == 'image/jpeg'
+        end
+      end
+    end
+
+    describe '#media_type' do
+      context 'given a JPEG image' do
+        it 'reports "image"' do
+          @maid.media_type(image_path).should == 'image'
+        end
+      end
+    end
+
+    describe '#where_content_type' do
+      context 'given "image"' do
+        it 'only lists the fixture JPEG' do
+          matches = @maid.where_content_type(@maid.dir(file_fixtures_glob), 'image')
+
+          matches.length.should == 1
+          matches.first.should end_with('spec/fixtures/files/ruby.jpg')
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: maid
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.4.0.alpha.1
+  prerelease: 6
 platform: ruby
 authors:
 - Benjamin Oakes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape
-  requirement: &22954240 !ruby/object:Gem::Requirement
+  requirement: &10781460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *22954240
+  version_requirements: *10781460
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &22953420 !ruby/object:Gem::Requirement
+  requirement: &10780320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,13 +35,13 @@ dependencies:
         version: 0.14.0
     - - <
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
-  version_requirements: *22953420
+  version_requirements: *10780320
 - !ruby/object:Gem::Dependency
   name: deprecated
-  requirement: &22952580 !ruby/object:Gem::Requirement
+  requirement: &10779220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -49,10 +49,21 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *22952580
+  version_requirements: *10779220
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: &10794980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10794980
 - !ruby/object:Gem::Dependency
   name: ohai
-  requirement: &22952100 !ruby/object:Gem::Requirement
+  requirement: &10794500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -60,13 +71,27 @@ dependencies:
         version: 6.14.0
     - - <
       - !ruby/object:Gem::Version
-        version: 6.17.0
+        version: 6.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *10794500
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: &10793740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+    - - <
+      - !ruby/object:Gem::Version
+        version: 0.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *22952100
+  version_requirements: *10793740
 - !ruby/object:Gem::Dependency
   name: xdg
-  requirement: &22951380 !ruby/object:Gem::Requirement
+  requirement: &10792860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -74,10 +99,10 @@ dependencies:
         version: 2.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *22951380
+  version_requirements: *10792860
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &22950900 !ruby/object:Gem::Requirement
+  requirement: &10792180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -85,10 +110,10 @@ dependencies:
         version: 0.4.2
   type: :development
   prerelease: false
-  version_requirements: *22950900
+  version_requirements: *10792180
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &22950440 !ruby/object:Gem::Requirement
+  requirement: &10791120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -96,21 +121,21 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *22950440
+  version_requirements: *10791120
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &22949980 !ruby/object:Gem::Requirement
+  requirement: &10790520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *22949980
+  version_requirements: *10790520
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &22949520 !ruby/object:Gem::Requirement
+  requirement: &10789880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -118,10 +143,10 @@ dependencies:
         version: 10.0.3
   type: :development
   prerelease: false
-  version_requirements: *22949520
+  version_requirements: *10789880
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &22949060 !ruby/object:Gem::Requirement
+  requirement: &10788600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -129,32 +154,32 @@ dependencies:
         version: 2.2.2
   type: :development
   prerelease: false
-  version_requirements: *22949060
+  version_requirements: *10788600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &22948540 !ruby/object:Gem::Requirement
+  requirement: &10787920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 2.13.0
   type: :development
   prerelease: false
-  version_requirements: *22948540
+  version_requirements: *10787920
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &22948000 !ruby/object:Gem::Requirement
+  requirement: &10787160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.9.1
+        version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *22948000
+  version_requirements: *10787160
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &22947500 !ruby/object:Gem::Requirement
+  requirement: &10803020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -162,10 +187,10 @@ dependencies:
         version: 0.8.4
   type: :development
   prerelease: false
-  version_requirements: *22947500
+  version_requirements: *10803020
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &22946840 !ruby/object:Gem::Requirement
+  requirement: &10802560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -173,10 +198,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *22946840
+  version_requirements: *10802560
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &23300740 !ruby/object:Gem::Requirement
+  requirement: &10802060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -184,7 +209,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *23300740
+  version_requirements: *10802060
 description: Be lazy.  Let Maid clean up after you, based on rules you define.  Think
   of it as "Hazel for hackers".
 email:
@@ -196,7 +221,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - .travis.yml
 - .yardopts
 - AUTHORS.md
@@ -230,6 +256,10 @@ files:
 - script/vagrant-test
 - script/vagrant-test-all
 - spec/dependency_spec.rb
+- spec/fixtures/files/bar.zip
+- spec/fixtures/files/foo.zip
+- spec/fixtures/files/ruby.jpg
+- spec/fixtures/files/さ.zip
 - spec/lib/maid/app_spec.rb
 - spec/lib/maid/maid_spec.rb
 - spec/lib/maid/numeric_extensions_spec.rb
@@ -256,9 +286,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: maid
 rubygems_version: 1.8.11

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.8.7@maid --create