maid 0.2.1 → 0.2.2.beta.1

data/.travis.yml

@@ -1,3 +1,4 @@
 rvm:
   - 1.8.7
   - 1.9.3
+  - 2.0.0

data/ChangeLog

@@ -1,3 +1,12 @@
+maid (0.2.2.beta.1) unstable; urgency=low
+
+  * 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
+
 maid (0.2.1) stable; urgency=low
 
   * Fix YARD generation for http://rubydoc.info/.  (Otherwise identical to

data/Guardfile

@@ -1,6 +1,4 @@
-# A sample Guardfile
 # More info at https://github.com/guard/guard#readme
-
 guard 'rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{ m[1] }_spec.rb" }

data/README.md

@@ -2,8 +2,8 @@
 
 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)
+[Installation](#installation)
+| [Tutorial](#tutorial)
 | [Example](https://github.com/benjaminoakes/maid-example)
 | [User Community](https://github.com/benjaminoakes/maid/wiki)
 | [Documentation][]

data/lib/maid.rb

@@ -1,4 +1,5 @@
 require 'deprecated'
+require 'escape'
 Deprecated.set_action(:warn)
 
 # Must be in this order:

data/lib/maid/tools.rb

@@ -12,6 +12,7 @@ require 'time'
 # 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
+  # For showing deprecation notices
   include Deprecated
 
   # Move from `sources` to `destination`
@@ -35,10 +36,10 @@ module Maid::Tools
       target = File.join(destination, File.basename(source))
 
       unless File.exist?(target)
-        log("mv #{ source.inspect } #{ destination.inspect }")
+        log("mv #{ sh_escape(source) } #{ sh_escape(destination) }")
         FileUtils.mv(source, destination, @file_options)
       else
-        warn("skipping #{ source.inspect } because #{ target.inspect } already exists")
+        warn("skipping #{ sh_escape(source) } because #{ sh_escape(target) } already exists")
       end
     end
   end
@@ -136,7 +137,7 @@ module Maid::Tools
     expand_all(paths).each do |path|
       options = @file_options.merge(options)
 
-      log("Removing #{ path.inspect }")
+      log("Removing #{ sh_escape(path) }")
       FileUtils.rm_r(path, options)
     end
   end
@@ -164,6 +165,10 @@ module Maid::Tools
   #     dir(%w(~/Downloads/*.zip ~/Dropbox/*.zip))
   #     dir('~/{Downloads,Dropbox}/*.zip')
   #
+  # Recursing into subdirectories (see also: `find`):
+  #
+  #     dir('~/Music/**/*.m4a')
+  #
   def dir(globs)
     expand_all(globs).
       map { |glob| Dir.glob(glob) }.
@@ -192,7 +197,7 @@ module Maid::Tools
   #     move('~/Downloads/Pink Floyd*.mp3', mkdir('~/Music/Pink Floyd/'))
   def mkdir(path, options = {})
     path = expand(path)
-    log("mkdir -p #{ path.inspect }")
+    log("mkdir -p #{ sh_escape(path) }")
     FileUtils.mkdir_p(path, @file_options.merge(options))
     path
   end
@@ -239,7 +244,7 @@ module Maid::Tools
   #
   #     locate('foo.zip') # => ['/a/foo.zip', '/b/foo.zip']
   def locate(name)
-    cmd("mdfind -name #{ name.inspect }").split("\n")
+    cmd("mdfind -name #{ sh_escape(name) }").split("\n")
   end
 
   # [Mac OS X] Use Spotlight metadata to determine the site from which a file was downloaded.
@@ -248,7 +253,7 @@ 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 #{ path.inspect }")
+    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] }
   end
@@ -259,7 +264,7 @@ module Maid::Tools
   #
   #     duration_s('foo.mp3') # => 235.705
   def duration_s(path)
-    cmd("mdls -raw -name kMDItemDurationSeconds #{ path.inspect }").to_f
+    cmd("mdls -raw -name kMDItemDurationSeconds #{ sh_escape(path) }").to_f
   end
 
   # List the contents of a zip file.
@@ -268,7 +273,7 @@ module Maid::Tools
   #
   #     zipfile_contents('foo.zip') # => ['foo/foo.exe', 'foo/README.txt']
   def zipfile_contents(path)
-    raw = cmd("unzip -Z1 #{ path.inspect }")
+    raw = cmd("unzip -Z1 #{ sh_escape(path) }")
     raw.split("\n")
   end
 
@@ -280,7 +285,7 @@ module Maid::Tools
   #
   #     disk_usage('foo.zip') # => 136
   def disk_usage(path)
-    raw = cmd("du -s #{ path.inspect }")
+    raw = cmd("du -s #{ sh_escape(path) }")
     # FIXME: This reports in kilobytes, but should probably report in bytes.
     usage_kb = raw.split(/\s+/).first.to_i
    
@@ -345,8 +350,8 @@ module Maid::Tools
   #     git_piston('~/code/projectname')
   def git_piston(path)
     full_path = expand(path)
-    stdout = cmd("cd #{full_path.inspect} && git pull && git push 2>&1")
-    log("Fired git piston on #{full_path.inspect}.  STDOUT:\n\n#{stdout}")
+    stdout = cmd("cd #{ sh_escape(full_path) } && git pull && git push 2>&1")
+    log("Fired git piston on #{ sh_escape(full_path) }.  STDOUT:\n\n#{ stdout }")
   end
 
   deprecated :git_piston, 'SparkleShare (http://sparkleshare.org/)'
@@ -394,16 +399,20 @@ module Maid::Tools
     ops << '-n' if @file_options[:noop]
 
     Array(options[:exclude]).each do |path|
-      ops << "--exclude=#{ path.inspect }"
+      ops << "--exclude=#{ sh_escape(path) }"
     end
 
     ops << '--delete' if options[:delete]
-    stdout = cmd("rsync #{ ops.join(' ') } #{ from.inspect } #{ to.inspect } 2>&1")
-    log("Fired sync from #{ from.inspect } to #{ to.inspect }.  STDOUT:\n\n#{ stdout }")
+    stdout = cmd("rsync #{ ops.join(' ') } #{ sh_escape(from) } #{ sh_escape(to) } 2>&1")
+    log("Fired sync from #{ sh_escape(from) } to #{ sh_escape(to) }.  STDOUT:\n\n#{ stdout }")
   end
 
   private
 
+  def sh_escape(array)
+    Escape.shell_command(Array(array))
+  end
+
   def log(message)
     @logger.info(message)
   end

data/lib/maid/version.rb

@@ -1,3 +1,3 @@
 module Maid
-  VERSION = '0.2.1'
+  VERSION = '0.2.2.beta.1'
 end

data/maid.gemspec

@@ -16,26 +16,29 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = 'maid'
 
-  s.add_dependency('thor', '~> 0.16.0')
-  s.add_dependency('deprecated', '~> 3.0.1')
-  s.add_dependency('ohai', '~> 6.14.0')
-  s.add_dependency('xdg', '~> 2.2.3')
-  s.add_development_dependency('fakefs', '~> 0.4.1')
-  s.add_development_dependency('guard', '~> 1.5.4')
-  s.add_development_dependency('guard-rspec', '~> 2.3.0')
-  s.add_development_dependency('rb-readline', '~> 0.4.2') # To get guard file change detection working properly
-  s.add_development_dependency('rake', '~> 10.0.2')
+  # 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('deprecated', '~> 3.0.0')
+  s.add_dependency('ohai', '>= 6.14.0', '< 6.17.0')
+  s.add_dependency('xdg', '~> 2.2.3') # previous versions had bugs
+
+  # 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('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.3')
-  s.add_development_dependency('yard', '~> 0.8.3')
+  s.add_development_dependency('timecop', '~> 0.5.9.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
   # guest.  One way around this is to force polling instead:
   #
   #     bundle exec guard --force-polling
   #
-  s.add_development_dependency('rb-inotify', '~> 0.8.8')
+  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")

data/spec/lib/maid/tools_spec.rb

@@ -196,6 +196,10 @@ module Maid
         it 'lists files in directories when using regexp-like glob patterns' do
           @maid.dir('~/{Desktop,Downloads}/*.zip').should == [@other_file, @file]
         end
+
+        it 'lists files in directories when using recursive glob patterns' do
+          @maid.dir('~/**/*.zip').should == [@other_file, @file]
+        end
       end
     end
 
@@ -334,7 +338,7 @@ module Maid
       end
 
       it 'should pull and push the given git repository, logging the action' do
-        @maid.should_receive(:cmd).with(%(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
@@ -347,7 +351,7 @@ module Maid
       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.should_receive(:cmd).with(%(rsync -a -u #@home/Downloads/ #@home/Reference 2>&1))
         @maid.sync(@src_dir, @dst_dir)
       end
 
@@ -357,25 +361,25 @@ module Maid
       end
 
       it 'should have no options' do
-        @maid.should_receive(:cmd).with(%(rsync  "#@home/Downloads/" "#@home/Reference" 2>&1))
+        @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.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))
+          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.should_receive(:cmd).with(%(rsync -a -u -n #@home/Downloads/ #@home/Reference 2>&1))
         @maid.sync(@src_dir, @dst_dir)
       end
     end

metadata

@@ -1,52 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: maid
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.2.2.beta.1
+  prerelease: 6
 platform: ruby
 authors:
 - Benjamin Oakes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-25 00:00:00.000000000 Z
+date: 2013-02-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: escape
+  requirement: &7714060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+    - - <
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *7714060
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &9942340 !ruby/object:Gem::Requirement
+  requirement: &7704680 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+    - - <
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.18.0
   type: :runtime
   prerelease: false
-  version_requirements: *9942340
+  version_requirements: *7704680
 - !ruby/object:Gem::Dependency
   name: deprecated
-  requirement: &10005180 !ruby/object:Gem::Requirement
+  requirement: &7703240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *10005180
+  version_requirements: *7703240
 - !ruby/object:Gem::Dependency
   name: ohai
-  requirement: &10003340 !ruby/object:Gem::Requirement
+  requirement: &7702440 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 6.14.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 6.17.0
   type: :runtime
   prerelease: false
-  version_requirements: *10003340
+  version_requirements: *7702440
 - !ruby/object:Gem::Dependency
   name: xdg
-  requirement: &10001860 !ruby/object:Gem::Requirement
+  requirement: &7701440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,65 +74,54 @@ dependencies:
         version: 2.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *10001860
+  version_requirements: *7701440
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &10001120 !ruby/object:Gem::Requirement
+  requirement: &7700740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.4.2
   type: :development
   prerelease: false
-  version_requirements: *10001120
+  version_requirements: *7700740
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &10000560 !ruby/object:Gem::Requirement
+  requirement: &7700040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.4
+        version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *10000560
+  version_requirements: *7700040
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &9999640 !ruby/object:Gem::Requirement
+  requirement: &7699300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *9999640
-- !ruby/object:Gem::Dependency
-  name: rb-readline
-  requirement: &9998740 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.2
-  type: :development
-  prerelease: false
-  version_requirements: *9998740
+  version_requirements: *7699300
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10014900 !ruby/object:Gem::Requirement
+  requirement: &7698640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.2
+        version: 10.0.3
   type: :development
   prerelease: false
-  version_requirements: *10014900
+  version_requirements: *7698640
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &10014020 !ruby/object:Gem::Requirement
+  requirement: &7697940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +129,10 @@ dependencies:
         version: 2.2.2
   type: :development
   prerelease: false
-  version_requirements: *10014020
+  version_requirements: *7697940
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &10012340 !ruby/object:Gem::Requirement
+  requirement: &7687280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,43 +140,43 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *10012340
+  version_requirements: *7687280
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &10011140 !ruby/object:Gem::Requirement
+  requirement: &7686480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 0.5.9.1
   type: :development
   prerelease: false
-  version_requirements: *10011140
+  version_requirements: *7686480
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &10009380 !ruby/object:Gem::Requirement
+  requirement: &7685980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.4
   type: :development
   prerelease: false
-  version_requirements: *10009380
+  version_requirements: *7685980
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &10026320 !ruby/object:Gem::Requirement
+  requirement: &7685520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *10026320
+  version_requirements: *7685520
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &10024260 !ruby/object:Gem::Requirement
+  requirement: &7685040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -175,7 +184,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *10024260
+  version_requirements: *7685040
 description: Be lazy.  Let Maid clean up after you, based on rules you define.  Think
   of it as "Hazel for hackers".
 email:
@@ -247,9 +256,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