maid 0.2.0.beta.1 → 0.2.0.beta.2

data/AUTHORS.md

@@ -0,0 +1,7 @@
+In alphabetical order:
+
+* Benjamin Oakes (@benjaminoakes)
+* Larry Lv (@larrylv)
+* Lewis O'Driscoll (@loddy1234)
+* Lloyd Philbrook (@phoolish)
+* Mark Jaquith (@markjaquith)

data/ChangeLog

@@ -1,6 +1,15 @@
+maid (0.2.0.beta.2) unstable; urgency=low
+
+  * 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
 
-  * (Development in progress)
   * Change "dir" to allow multiple paths (Closes: #64)
   * Change "mkdir" to return the path of the created directory (Closes: #69)
   * Various development improvements

data/README.md

@@ -2,21 +2,38 @@
 
 Be lazy!  Let Maid clean up after you, based on rules you define.
 
-[Installation](https://github.com/benjaminoakes/maid#installation) | [Tutorial](https://github.com/benjaminoakes/maid#tutorial) | [Example](https://github.com/benjaminoakes/maid-example) | [Documentation](http://rubydoc.info/gems/maid/Maid/Tools) | [Change Log](https://github.com/benjaminoakes/maid/blob/master/ChangeLog)
+[Installation](https://github.com/benjaminoakes/maid#installation)
+| [Tutorial](https://github.com/benjaminoakes/maid#tutorial)
+| [Example](https://github.com/benjaminoakes/maid-example)
+| [Documentation][]
+| [Change Log](https://github.com/benjaminoakes/maid/blob/master/ChangeLog)
 
-Maid keeps files from sitting around too long, untouched.  Many of the downloads and other files you collect can easily be categorized and handled appropriately by rules you define.  Let the maid in your computer take care of the easy stuff, so you can spend more of your time on what matters.
+Maid keeps files from sitting around too long, untouched.  Many of the downloads and temporary files you collect can
+easily be categorized and handled appropriately by rules you define.  Let the `maid` in your computer take care of the
+easy stuff, so you can spend more of your time on what matters.
 
-Think of it like the email filters you might already have, but for files.  Worried about things happening that you don't expect?  Maid doesn't overwrite files and actions are logged so you can tell what happened.
+Think of it like the email filters you might already have, but for files.  Worried about things happening that you don't
+expect?  Maid doesn't overwrite files and actions are logged so you can tell what happened.
 
-Maid is inspired by the Mac OS X shareware program [Hazel](http://www.noodlesoft.com/hazel.php).  This tool was created on Mac OS X 10.6, but should be generally portable to other systems.  (Some of the more advanced features such as `downloaded_from` require OS X, however.)
+Maid is inspired by the Mac OS X shareware program [Hazel](http://www.noodlesoft.com/hazel.php).  Think of Maid as
+**"Hazel for hackers"**.
 
-Your rules are defined in Ruby, so easy rules are easy and difficult rules are possible.  This also makes Maid a great general-purpose **advanced file renaming tool**.
+Your rules are defined in Ruby, so simple rules are easy and difficult rules are possible.  This also makes Maid a great
+general-purpose **advanced file renaming tool**.
 
 ## Want to help?
 
+This project wouldn't be where it is today without its users and contributors.  Thank you!  See [AUTHORS][] and the
+[contributors graph][] for more info.
+
+  [authors]: https://github.com/benjaminoakes/maid/blob/master/AUTHORS.md
+  [contributors graph]: https://github.com/benjaminoakes/maid/graphs/contributors
+
 ### For Users
 
-[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=benjaminoakes&url=https://github.com/benjaminoakes/maid&title=maid&language=en_GB&tags=github&category=software)
+[
+[Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)
+](https://flattr.com/submit/auto?user_id=benjaminoakes&url=https://github.com/benjaminoakes/maid&title=maid&language=en_GB&tags=github&category=software)
 
 * Participate in [beta testing](https://github.com/benjaminoakes/maid/issues/10)
 * [Report an issue](https://github.com/benjaminoakes/maid/issues) (bug or feature request)
@@ -29,13 +46,22 @@ Your rules are defined in Ruby, so easy rules are easy and difficult rules are p
 [![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.
 * See the [Contributing guide](https://github.com/benjaminoakes/maid/wiki/Contributing)
 
 ## Buzz
 
-[![OneThingWell Logo](https://raw.github.com/benjaminoakes/maid/master/resources/OneThingWell.png)](http://onethingwell.org/)
+[
+![Hacker News Logo](https://raw.github.com/benjaminoakes/maid/master/resources/hacker-news.png)
+](http://news.ycombinator.com/)
+
+[Hazel for hackers](http://news.ycombinator.com/item?id=4928605) - December 16th, 2012 (peaked at #2)
+
+[
+![OneThingWell Logo](https://raw.github.com/benjaminoakes/maid/master/resources/OneThingWell.png)
+](http://onethingwell.org/)
 
 [Maid](http://onethingwell.org/post/30455088809/maid) - August 29th, 2012
 
@@ -47,21 +73,25 @@ Your rules are defined in Ruby, so easy rules are easy and difficult rules are p
 
 ## Installation
 
-[![Download for Ubuntu](https://github.com/benjaminoakes/maid/raw/master/resources/download-for-ubuntu.png)](https://github.com/benjaminoakes/maid/issues/3)
+[
+![Download for Ubuntu](https://github.com/benjaminoakes/maid/raw/master/resources/download-for-ubuntu.png)
+](https://github.com/benjaminoakes/maid/issues/3)
 
 #### Offically supported:
 
 * **OS:** Mac OS X, Ubuntu
 * **Ruby:** 1.8.7, 1.9.3 (preferred)
 
-(Other Ruby versions and OSes may work, but are not officially supported.  Contributions are welcome, however.)
+Some features require OS X.  See the [documentation][] for more details.  Other Ruby versions and Linux distributions
+may work, but are not officially supported.  (Contributions are welcome, however.)
 
 ### Manual Installation
 
 First, you need Ruby:
 
 * **Mac OS X:** Ruby 1.8.7 comes preinstalled.
-* **Ubuntu:** Ruby is not preinstalled.  To install Ruby 1.9.3: `sudo apt-get install ruby1.9.1 # (sic)`  ([Interested in a package?](https://github.com/benjaminoakes/maid/issues/3))
+* **Ubuntu:** Ruby is not preinstalled.  To install Ruby 1.9.3: `sudo apt-get install ruby1.9.1 # (sic)`
+  ([Interested in a package?](https://github.com/benjaminoakes/maid/issues/3))
 
 Then, you can install via RubyGems.  Open a terminal and run:
 
@@ -79,12 +109,15 @@ If you decide you don't want Maid installed anymore, remove it:
 
 ### Troubleshooting
 
-* Having multiple Ruby versions installed can confuse things.  If you're a Ruby developer, you may prefer to just `gem install maid` with your preferred setup.  Ruby 1.9.3 is recommended.
-* Older packages of Ruby for Ubuntu may not automatically add the RubyGems `bin` directory to your `$PATH`.  Double check your settings.
+* Having multiple Ruby versions installed can confuse things.  If you're a Ruby developer, you may prefer to just
+  `gem install maid` with your preferred setup.  Ruby 1.9.3 is recommended.
+* Older packages of Ruby for Ubuntu may not automatically add the RubyGems `bin` directory to your `$PATH`.  Double
+  check your settings.
 
 ## Tutorial
 
-In a nutshell, Maid uses "rules" to define how files are handled.  Once you have rules defined, you can either test what cleaning would do (`maid clean -n`) or actually clean (`maid clean`).
+In a nutshell, Maid uses "rules" to define how files are handled.  Once you have rules defined, you can either test what
+cleaning would do (`maid clean -n`) or actually clean (`maid clean`).
 
 To generate a [sample rules file](https://github.com/benjaminoakes/maid/blob/master/lib/maid/rules.sample.rb), run:
 
@@ -152,29 +185,38 @@ Then, this is the command to test, as well as some sample output:
     mv "/Users/ben/Downloads/issue12.pdf" "/Users/ben/Books/"
     mv "/Users/ben/Downloads/spring2011newsletter.pdf" "/Users/ben/Books/"
 
-For help with command line usage, run `maid help`.  For more DSL helper methods, please see the documentation of [Maid::Tools](http://rubydoc.info/gems/maid/Maid/Tools).
+For help with command line usage, run `maid help`.  For more help, please see the links at the top of this README.
 
 ### Automation
 
-Once you get a hang for what you can do with Maid, let it do its stuff automatically throughout the day.  You'll find your computer stays a little tidier with as you teach it how to handle your common files.
+Once you get a hang for what you can do with Maid, let it do its stuff automatically throughout the day.  You'll find
+your computer stays a little tidier with as you teach it how to handle your common files.
 
 To do this, edit your crontab in your tool of choice:
 
     crontab -e
 
-...and have it invoke the `maid clean` command.  The `--silent` option is provided to keep this from emailing you, if desired.  A log of the actions taken is kept at `~/.maid/maid.log`.
+...and have it invoke the `maid clean` command.  The `--silent` option is provided to keep this from emailing you, if
+desired.  A log of the actions taken is kept at `~/.maid/maid.log`.
 
 Example for every day at 1am:
 
     # minute hour day_of_month month day_of_week command_to_execute
     0 1 * * * /bin/bash -li -c "maid clean --silent"
 
-Both Mac OS X and Ubuntu support callbacks when folders are changed, and that may be a forthcoming feature in Maid.  That said, I find `cron` to take care of most of my needs.
+Both Mac OS X and Ubuntu support callbacks when folders are changed, and that may be a forthcoming feature in Maid.
+That said, I find `cron` to take care of most of my needs.
 
 ## Warranty
 
-THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING
+THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
+IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU
+ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
 
 ## License
 
 GPLv2.  See LICENSE for a copy.
+
+  [documentation]: http://rubydoc.info/gems/maid/Maid/Tools

data/Vagrantfile

@@ -4,6 +4,7 @@
 Vagrant::Config.run do |config|
   # See also: `script/vagrant-test`, `script/vagrant-test-all`
   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.provision(:shell, :path => 'script/vagrant-provision', :args => ENV['MAID_TARGET_RUBY'] || '1.9.3')
 end

data/lib/maid/maid.rb

@@ -4,6 +4,9 @@ require 'logger'
 require 'xdg'
 
 # Maid cleans up according to the given rules, logging what it does.
+#
+# TODO: Rename to something less ambiguous, e.g. "cleaning agent", "cleaner", "vacuum", etc.  Having this class within
+# the `Maid` module makes things confusing.
 class Maid::Maid
   DEFAULTS = {
     :progname     => 'Maid',

data/lib/maid/numeric_extensions.rb

@@ -1,5 +1,6 @@
 module Maid::NumericExtensions
-  # From https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/numeric/time.rb, with some modifications since active_support ruins Logger by overriding its functionality.
+  # From https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/numeric/time.rb, with some
+  # modifications since `active_support` ruins `Logger` by overriding its functionality.
   module Time
     # Enables the use of time calculations and declarations, like 45.minutes + 2.hours + 4.years.
     #

data/lib/maid/rules.sample.rb

@@ -4,7 +4,8 @@
 #
 #     maid clean -n
 #
-# **NOTE:** It's recommended you just use this as a template; if you run these rules on your machine without knowing what they do, you might run into unwanted results!
+# **NOTE:** It's recommended you just use this as a template; if you run these rules on your machine without knowing
+# what they do, you might run into unwanted results!
 #
 # Don't forget, it's just Ruby!  You can define custom methods and use them below:
 # 
@@ -21,7 +22,8 @@
 # * Ask me a question over email (hello@benjaminoakes.com) or Twitter (@benjaminoakes)
 
 Maid.rules do
-  # **NOTE:** It's recommended you just use this as a template; if you run these rules on your machine without knowing what they do, you might run into unwanted results!
+  # **NOTE:** It's recommended you just use this as a template; if you run these rules on your machine without knowing
+  # what they do, you might run into unwanted results!
 
   rule 'Linux ISOs, etc' do
     trash(dir('~/Downloads/*.iso'))
@@ -63,7 +65,8 @@ Maid.rules do
   # NOTE: Currently, only Mac OS X supports `downloaded_from`.
   rule 'Old files downloaded while developing/testing' do
     dir('~/Downloads/*').each do |path|
-      if downloaded_from(path).any? { |u| u.match('http://localhost') || u.match('http://staging.yourcompany.com') } && 1.week.since?(accessed_at(path))
+      if downloaded_from(path).any? { |u| u.match('http://localhost') || u.match('http://staging.yourcompany.com') } &&
+          1.week.since?(accessed_at(path))
         trash(path)
       end
     end

data/lib/maid/tools.rb

@@ -9,7 +9,8 @@ require 'time'
 # * Automatically expand paths (that is, `'~/Downloads/foo.zip'` becomes `'/home/username/Downloads/foo.zip'`)
 # * Respect the `noop` (`dry-run`) option if it is set
 #
-# Some methods are not available on all platforms.  An `ArgumentError` is raised when a command is not available.  See tags such as: [Mac OS X]
+# Some methods are not available on all platforms.  An `ArgumentError` is raised when a command is not available.  See
+# tags such as: [Mac OS X]
 module Maid::Tools
   include Deprecated
 
@@ -34,19 +35,22 @@ module Maid::Tools
       target = File.join(destination, File.basename(source))
 
       unless File.exist?(target)
-        @logger.info("mv #{ source.inspect } #{ destination.inspect }")
+        log("mv #{ source.inspect } #{ destination.inspect }")
         FileUtils.mv(source, destination, @file_options)
       else
-        @logger.warn("skipping #{ source.inspect } because #{ target.inspect } already exists")
+        warn("skipping #{ source.inspect } because #{ target.inspect } already exists")
       end
     end
   end
 
   # Move the given paths to the user's trash.
   #
-  # The path is still moved if a file already exists in the trash with the same name.  However, the current date and time is appended to the filename.
+  # The path is still moved if a file already exists in the trash with the same name.  However, the current date and
+  # time is appended to the filename.
   # 
-  # **Note:** the OS-native "restore" or "put back" functionality for trashed files is not currently supported.  (See [issue #63](https://github.com/benjaminoakes/maid/issues/63).)  However, they can be restored manually, and the Maid log can help assist with this.
+  # **Note:** the OS-native "restore" or "put back" functionality for trashed files is not currently supported.  (See
+  # [issue #63](https://github.com/benjaminoakes/maid/issues/63).)  However, they can be restored manually, and the Maid
+  # log can help assist with this.
   # 
   # ## Options
   #
@@ -69,13 +73,18 @@ module Maid::Tools
   def trash(paths, options = {})
     # ## Implementation Notes
     #
-    # Trashing files correctly is surprisingly hard.  What Maid ends up doing is one the easiest, most foolproof solutions:  moving the file.
+    # Trashing files correctly is surprisingly hard.  What Maid ends up doing is one the easiest, most foolproof
+    # solutions:  moving the file.
     #
-    # Unfortunately, that means it's not possile to restore files automatically in OSX or Ubuntu.  The previous location of the file is lost.
+    # Unfortunately, that means it's not possile to restore files automatically in OSX or Ubuntu.  The previous location
+    # of the file is lost.
     #
-    # OSX support depends on AppleScript or would require a not-yet-written C extension to interface with the OS.  The AppleScript solution is less than ideal: the user has to be logged in, Finder has to be running, and it makes the "trash can sound" every time a file is moved.
+    # OSX support depends on AppleScript or would require a not-yet-written C extension to interface with the OS.  The
+    # AppleScript solution is less than ideal: the user has to be logged in, Finder has to be running, and it makes the
+    # "trash can sound" every time a file is moved.
     #
-    # Ubuntu makes it easy to implement, and there's a Python library for doing so (see `trash-cli`).  However, there's not a Ruby equivalent yet.
+    # Ubuntu makes it easy to implement, and there's a Python library for doing so (see `trash-cli`).  However, there's
+    # not a Ruby equivalent yet.
 
     expand_all(paths).each do |path|
       target = File.join(@trash_path, File.basename(path))
@@ -98,6 +107,8 @@ module Maid::Tools
   end
 
   # Delete the files at the given path recursively.
+  #
+  # **NOTE**: In most cases, `trash` is a safer choice, since the files will be recoverable by retreiving them from the trash.  Once you delete a file using `remove`, it's gone!  Please use `trash` whenever possible and only use `remove` when necessary.
   # 
   # ## Options
   #
@@ -107,7 +118,7 @@ module Maid::Tools
   #
   # `:secure => boolean`
   #
-  # Infrequently needed. See [`FileUtils.remove_entry_secure`](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/fileutils/rdoc/FileUtils.html#method-c-remove_entry_secure)
+  # Infrequently needed. See [`FileUtils.remove_entry_secure`][fures]
   #
   # ## Examples
   #
@@ -119,18 +130,21 @@ module Maid::Tools
   #
   #     remove(['~/Downloads/foo.zip', '~/Downloads/bar.zip'])
   #     remove(dir('~/Downloads/*.zip'))
+  #
+  #   [fures]: http://www.ruby-doc.org/stdlib-1.9.3/libdoc/fileutils/rdoc/FileUtils.html#method-c-remove_entry_secure
   def remove(paths, options = {})
     expand_all(paths).each do |path|
       options = @file_options.merge(options)
 
-      @logger.info("Removing #{ path.inspect }")
+      log("Removing #{ path.inspect }")
       FileUtils.rm_r(path, options)
     end
   end
 
   # Give all files matching the given glob.
   #
-  # Note that the globs are *not* regexps (they're closer to shell globs).  However, some regexp-like notation can be used, e.g. `?`, `[a-z]`, `{tgz,zip}`.  For more details, see Ruby's documentation on `Dir.glob`.
+  # Note that the globs are *not* regexps (they're closer to shell globs).  However, some regexp-like notation can be
+  # used, e.g. `?`, `[a-z]`, `{tgz,zip}`.  For more details, see Ruby's documentation on `Dir.glob`.
   #
   # The matches are sorted lexically to aid in readability when using `--dry-run`.
   #
@@ -177,7 +191,8 @@ module Maid::Tools
   #     move('~/Downloads/Pink Floyd*.mp3', mkdir('~/Music/Pink Floyd/'))
   def mkdir(path, options = {})
     path = expand(path)
-    FileUtils.mkdir_p(path, options)
+    log("mkdir -p #{ path.inspect }")
+    FileUtils.mkdir_p(path, options) # @file_options.merge(options))
     path
   end
 
@@ -191,6 +206,12 @@ module Maid::Tools
   #
   #     find('~/Downloads/') # => [...]
   #
+  # Recursing and filtering using a regular expression:
+  #
+  #     find('~/Downloads/').grep(/\.pdf$/)
+  #
+  # (**Note:** It's just Ruby, so any methods in `Array` and `Enumerable` can be used.)
+  #
   # Recursing with a block:
   #
   #     find('~/Downloads/') do |path|
@@ -315,7 +336,8 @@ module Maid::Tools
   #
   # Pull and push the `git` repository at the given path.
   #
-  # Since this is deprecated, you might also be interested in [SparkleShare](http://sparkleshare.org/), a great `git`-based file syncronization project.
+  # Since this is deprecated, you might also be interested in [SparkleShare](http://sparkleshare.org/), a great
+  # `git`-based file syncronization project.
   #
   # ## Examples
   #
@@ -323,7 +345,7 @@ module Maid::Tools
   def git_piston(path)
     full_path = expand(path)
     stdout = cmd("cd #{full_path.inspect} && git pull && git push 2>&1")
-    @logger.info "Fired git piston on #{full_path.inspect}.  STDOUT:\n\n#{stdout}"
+    log("Fired git piston on #{full_path.inspect}.  STDOUT:\n\n#{stdout}")
   end
 
   deprecated :git_piston, 'SparkleShare (http://sparkleshare.org/)'
@@ -376,11 +398,19 @@ module Maid::Tools
 
     ops << '--delete' if options[:delete]
     stdout = cmd("rsync #{ ops.join(' ') } #{ from.inspect } #{ to.inspect } 2>&1")
-    @logger.info("Fired sync from #{ from.inspect } to #{ to.inspect }.  STDOUT:\n\n#{ stdout }")
+    log("Fired sync from #{ from.inspect } to #{ to.inspect }.  STDOUT:\n\n#{ stdout }")
   end
 
   private
 
+  def log(message)
+    @logger.info(message)
+  end
+
+  def warn(message)
+    @logger.warn(message)
+  end
+
   def expand(path)
     File.expand_path(path)
   end

data/lib/maid/trash_migration.rb

@@ -1,6 +1,7 @@
 # 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.)
+# 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

data/lib/maid/user_agent.rb

@@ -2,7 +2,8 @@ require 'ohai'
 
 # Version information for the host system, kind of like a browser's user agent string.
 #
-# This could potentially be a part of `Platform` or `VERSION` but both of those are used when building the gemspec, which can't depend on other gems.
+# This could potentially be a part of `Platform` or `VERSION` but both of those are used when building the gemspec,
+# which can't depend on other gems.  FIXME: That's no longer accurate, so this could be `Platform.user_agent` instead.
 module Maid::UserAgent
   class << self
     # This used to be called `#to_s`, but that made things difficult when testing.

data/lib/maid/version.rb

@@ -1,3 +1,3 @@
 module Maid
-  VERSION = '0.2.0.beta.1'
+  VERSION = '0.2.0.beta.2'
 end

data/spec/dependency_spec.rb

@@ -1,12 +1,27 @@
+require 'logger'
 require 'ohai'
+require 'rbconfig'
+require 'stringio'
 require 'xdg'
 
 # > What is Dependency Testing?
 # >
-# > Examines an application's requirements for pre-existing software, initial states and configuration in order to maintain proper functionality.
+# > Examines an application's requirements for pre-existing software, initial states and configuration in order to
+# > maintain proper functionality.
 # >
 # > -- http://sqa.fyicenter.com/FAQ/Software-QA-Testing/What_is_Dependency_Testing_.html
 describe 'Dependency expectations' do
+  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
+      io = StringIO.new
+      logger = Logger.new(io)
+      logger.info('my message')
+      logger.formatter = lambda { |_, _, _, msg| msg }
+      io.string.should match(/my message/)
+    end
+  end
+
   describe Ohai do
     before do
       @ohai = Ohai::System.new
@@ -27,11 +42,20 @@ describe 'Dependency expectations' do
     end
   end
 
+  describe RbConfig do
+    it 'identifies the host operating system' do
+      RbConfig::CONFIG['host_os'].should match(/[a-z]+/)
+    end
+  end
+
   describe XDG do
     it 'has DATA_HOME' do
-      # FIXME: This test could be cleaner.  We can't depend on the directory to already exist, even on systems that use the XDG standard.  This seems safe enough for now.
+      # FIXME: This test could be cleaner.  We can't depend on the directory to already exist, even on systems that use
+      # the XDG standard.  This seems safe enough for now.
+      #
+      # More info:
       #
-      # More info: [XDG Base Directory Specification](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html)
+      # * [XDG Base Directory Specification](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html)
       XDG['DATA_HOME'].to_s.should match(%r{^/.*?/\.local/share$})
     end
   end

data/spec/lib/maid/tools_spec.rb

@@ -163,7 +163,8 @@ module Maid
       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.
+        # 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
@@ -191,6 +192,11 @@ module Maid
         File.exist?("#@home/Downloads/Music/Pink.Floyd").should be_true
       end
 
+      it 'should log the creation of the directory' do
+        @logger.should_receive(:info)
+        @maid.mkdir('~/Downlaods/Music/Pink.Floyd')
+      end
+
       it 'returns the path of the created directory' do
         @maid.mkdir('~/Reference/Foo').should == "#@home/Reference/Foo"
       end
@@ -341,7 +347,9 @@ module Maid
       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.
+          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
 

data/spec/lib/maid/user_agent_spec.rb

@@ -4,7 +4,7 @@ module Maid
   describe UserAgent do
     describe 'the user agent string' do
       it 'is formatted with the Maid version, platform version, and Ruby version' do
-	system = {
+        system = {
           'platform' => 'Unix',
           'platform_version' => '1.0',
           'languages' => {
@@ -13,14 +13,14 @@ module Maid
               'platform' => 'pdp7',
             }
           }
-	}
+        }
 
-	system.stub(:all_plugins)
+        system.stub(:all_plugins)
 
-	Ohai::System.stub(:new) { system }
+        Ohai::System.stub(:new) { system }
         ::Maid.stub(:const_get).with(:VERSION) { '0.0.1' }
 
-	UserAgent.value.should == 'Maid/0.0.1 (Unix/1.0; Ruby/1.8.8 pdp7)'
+        UserAgent.value.should == 'Maid/0.0.1 (Unix/1.0; Ruby/1.8.8 pdp7)'
       end
     end
   end

metadata

@@ -1,280 +1,194 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: maid
-version: !ruby/object:Gem::Version 
-  hash: 62196353
+version: !ruby/object:Gem::Version
+  version: 0.2.0.beta.2
   prerelease: 6
-  segments: 
-  - 0
-  - 2
-  - 0
-  - beta
-  - 1
-  version: 0.2.0.beta.1
 platform: ruby
-authors: 
+authors:
 - Benjamin Oakes
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-12-02 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: thor
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &18495240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 95
-        segments: 
-        - 0
-        - 16
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.16.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: deprecated
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *18495240
+- !ruby/object:Gem::Dependency
+  name: deprecated
+  requirement: &18494620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 3
-        - 0
-        - 1
+      - !ruby/object:Gem::Version
         version: 3.0.1
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: maid-xdg
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *18494620
+- !ruby/object:Gem::Dependency
+  name: maid-xdg
+  requirement: &18493960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 127
-        segments: 
-        - 2
-        - 2
-        - 1
-        - 2
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 2.2.1.2
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: ohai
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *18493960
+- !ruby/object:Gem::Dependency
+  name: ohai
+  requirement: &18493180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 6
-        - 14
-        - 0
+      - !ruby/object:Gem::Version
         version: 6.14.0
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: fakefs
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *18493180
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: &18492320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 0
-        - 4
-        - 1
+      - !ruby/object:Gem::Version
         version: 0.4.1
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: guard
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *18492320
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &18490420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 5
-        - 4
+      - !ruby/object:Gem::Version
         version: 1.5.4
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: guard-rspec
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *18490420
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &18475800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 3
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.3.0
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: rb-readline
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *18475800
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: &18474560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 4
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.4.2
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *18474560
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &18473600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 75
-        segments: 
-        - 10
-        - 0
-        - 2
+      - !ruby/object:Gem::Version
         version: 10.0.2
   type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: redcarpet
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: *18473600
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &18470360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 2
-        - 2
+      - !ruby/object:Gem::Version
         version: 2.2.2
   type: :development
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: *18470360
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &18469780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 2
-        - 12
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.12.0
   type: :development
-  version_requirements: *id011
-- !ruby/object:Gem::Dependency 
-  name: timecop
   prerelease: false
-  requirement: &id012 !ruby/object:Gem::Requirement 
+  version_requirements: *18469780
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &18468940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 0
-        - 5
-        - 3
+      - !ruby/object:Gem::Version
         version: 0.5.3
   type: :development
-  version_requirements: *id012
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
+  version_requirements: *18468940
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &18468260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 57
-        segments: 
-        - 0
-        - 8
-        - 3
+      - !ruby/object:Gem::Version
         version: 0.8.3
   type: :development
-  version_requirements: *id013
-- !ruby/object:Gem::Dependency 
-  name: rb-inotify
   prerelease: false
-  requirement: &id014 !ruby/object:Gem::Requirement 
+  version_requirements: *18468260
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: &18466100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 47
-        segments: 
-        - 0
-        - 8
-        - 8
+      - !ruby/object:Gem::Version
         version: 0.8.8
   type: :development
-  version_requirements: *id014
-- !ruby/object:Gem::Dependency 
-  name: rb-fsevent
   prerelease: false
-  requirement: &id015 !ruby/object:Gem::Requirement 
+  version_requirements: *18466100
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &18465080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 9
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
-  version_requirements: *id015
+  prerelease: false
+  version_requirements: *18465080
 description: Be lazy.  Let Maid clean up after you, based on rules you define.
-email: 
+email:
 - hello@benjaminoakes.com
-executables: 
+executables:
 - maid
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .rvmrc
 - .travis.yml
+- AUTHORS.md
 - CONTRIBUTING.md
 - ChangeLog
 - Gemfile
@@ -298,6 +212,7 @@ files:
 - maid.gemspec
 - resources/OneThingWell.png
 - resources/download-for-ubuntu.png
+- resources/hacker-news.png
 - resources/ruby5.gif
 - script/smoke-test
 - script/vagrant-provision
@@ -314,51 +229,30 @@ files:
 - spec/lib/maid/user_agent_spec.rb
 - spec/lib/maid_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/benjaminoakes/maid
-licenses: 
+licenses:
 - GPLv2
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      hash: 25
-      segments: 
-      - 1
-      - 3
-      - 1
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-
 rubyforge_project: maid
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Be lazy.  Let Maid clean up after you, based on rules you define.
-test_files: 
-- spec/dependency_spec.rb
-- spec/lib/maid/app_spec.rb
-- spec/lib/maid/maid_spec.rb
-- spec/lib/maid/numeric_extensions_spec.rb
-- spec/lib/maid/platform_spec.rb
-- spec/lib/maid/rule_spec.rb
-- spec/lib/maid/tools_spec.rb
-- spec/lib/maid/trash_migration_spec.rb
-- spec/lib/maid/user_agent_spec.rb
-- spec/lib/maid_spec.rb
-- spec/spec_helper.rb
+test_files: []
+has_rdoc: