maid 0.4.0.beta.1 → 0.4.0.beta.2

data/.ruby-version

@@ -1 +1 @@
-2.0.0p247
+2.0.0-p247

data/ChangeLog

@@ -1,20 +1,25 @@
 maid (0.4.0) unstable; urgency=low
 
-  * (Work in progress)
+  * New utility methods: "checksum_of", "escape_glob", "files"
+  * New duplicate detection methods: "dupes_in", "newest_dupes_in",
+    "verbose_dupes_in"
+  * New filetype methods: "media_type", "mime_type",
+    "spotlight_content_types", "where_content_type"
   * Ended official support for Ruby 1.8.7 and 1.9.2 (Closes: #108)
   * Update to rubyzip 1.0.0 (Closes: #109)
+  * Remove "ohai" dependency which required native extensions (Closes: #112)
   * Updated other dependencies (Closes: #111)
-  * 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)
+  * Mu Ye: Require "--force" 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)
+  * Bradley Smith: Add "locate" support on Ubuntu (Closes: #67)
+  * Vladimir Agafonkin: Add "escape_glob" method for escaping brackets in paths
+    that will be passed to "dir" (Closes: #104)
   * Changed from ArgumentError to NotImplementedError when a command is
     unsupported on the host OS.
-  * Bradley Smith: Add locate support on Ubuntu (Closes: #67)
-  * Vladimir Agafonkin: Add escape_glob method for escaping brackets in paths
-    that will be passed to dir (Closes: #104)
 
  -- Benjamin Oakes <hello@benjaminoakes.com>  TODO
 

data/README.md

@@ -39,7 +39,7 @@ This project wouldn't be where it is today without its users and contributors.
 ### For Users
 
 [
-[Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)
+![Flattr this git repo](https://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)
@@ -76,7 +76,7 @@ This project wouldn't be where it is today without its users and contributors.
 
 ## Installation
 
-Maid is a gem, so just `gem install maid` like normal.  Please see below for details.
+Maid is a gem, so just `gem install maid` like normal.  If you're unfamiliar with Ruby, please see below for details.
 
 #### Requirements
 
@@ -85,38 +85,42 @@ Modern Ruby versions and Unix-like operating systems should work, but only OS X
 Offically supported:
 
 * **OS:** Mac OS X, Ubuntu
-* **Ruby:** 1.9.3+ (2.0.0  preferred)
+* **Ruby:** 1.9.3+ (2.0.0 preferred)
 
 Some features require OS X.  See the [documentation][] for more details.
 
 ### Manual Installation
 
-First, you need Ruby:
+First, you need Ruby.
+
+Consider `rbenv` or `rvm`, especially if only Ruby 1.8.7 is available (e.g. if you are using an older version of OS X).
+
+System Ruby works fine too, though:
 
 * **Mac OS X:** Ruby 2.0.0 comes preinstalled in OS X 10.9.
 * **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))
 
-Consider `rbenv` or `rvm` if only Ruby 1.8.7 is available (e.g. if you are using an older version of OS X).
-
 Then, you can install via RubyGems.  Open a terminal and run:
 
-    sudo gem install maid
+    gem install maid
+
+(Use `sudo` if using system Ruby.)
 
 At a later date, you can update by running:
 
-    sudo gem update maid
+    gem update maid
 
 If you decide you don't want Maid installed anymore, remove it:
 
-    sudo gem uninstall maid
+    gem uninstall maid
 
 **NOTE:** This does not remove any files under `~/.maid` or crontab entries.  Please remove them at your convenience.
 
 ## 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`).
+cleaning would do (`maid clean -n`) or actually clean (`maid clean -f`).
 
 To generate a [sample rules file](https://github.com/benjaminoakes/maid/blob/master/lib/maid/rules.sample.rb), run:
 
@@ -162,8 +166,8 @@ maid clean --dry-run # Synonyms: -n, --noop
 To run your rules on demand, you can run `maid` manually:
 
 ```bash
-maid clean                    # Run the rules at ~/.maid/rules.rb, logging to ~/.maid/maid.log
-maid clean -r some_rules.rb   # Run the rules in the file 'some_rules.rb', logging to ~/.maid/maid.log
+maid clean -f                 # Run the rules at ~/.maid/rules.rb, logging to ~/.maid/maid.log
+maid clean -fr some_rules.rb  # Run the rules in the file 'some_rules.rb', logging to ~/.maid/maid.log
 ```
 
 So, for example, if this is `some_rules.rb`:
@@ -198,13 +202,13 @@ 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
+...and have it invoke the `maid clean -f` 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"
+    0 1 * * * /bin/bash -li -c "maid clean --force --silent"
 
 ## Warranty
 

data/lib/maid/tools.rb

@@ -314,9 +314,13 @@ module Maid::Tools
 
   # 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.
+  # More often than not, you'll want to use `newest_dupes_in` or
+  # `verbose_dupes_in` instead of using this method directly.
+  #
+  # 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
   #
@@ -325,16 +329,10 @@ module Maid::Tools
   #                                                ['~/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:
+  # Keep the newest dupe:
   #
   #     dupes_in('~/Desktop/*', '~/Downloads/*').each do |dupes|
-  #       trash dupes.sort_by { |p| File.mtime(p) }[1..-1]
+  #       trash dupes.sort_by { |p| File.mtime(p) }[0..-2]
   #     end
   #
   def dupes_in(globs)
@@ -344,13 +342,43 @@ module Maid::Tools
       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
+          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
 
+  # Convenience method that is like `dupes_in` but excludes the oldest dupe.
+  #
+  # ## Example
+  #
+  # Keep the oldest dupe (trash the others):
+  #
+  #     trash newest_dupes_in('~/Downloads/*')
+  #
+  def newest_dupes_in(globs)
+    dupes_in(globs).
+      map { |dupes| dupes.sort_by { |p| File.mtime(p) }[1..-1] }.
+      flatten
+  end
+
+  # Convenience method for `dupes_in` that excludes the dupe with the shortest name.
+  #
+  # This is ideal for dupes like `foo.zip`, `foo (1).zip`, `foo copy.zip`.
+  #
+  # ## Example
+  #
+  # Keep the dupe with the shortest name (trash the others):
+  #
+  #     trash verbose_dupes_in('~/Downloads/*')
+  #
+  def verbose_dupes_in(globs)
+    dupes_in(globs).
+      map { |dupes| dupes.sort_by { |p| File.basename(p).length }[1..-1] }.
+      flatten
+  end
+
   # [Mac OS X] Use Spotlight metadata to determine audio length.
   #
   # ## Examples

data/lib/maid/user_agent.rb

@@ -1,5 +1,3 @@
-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,
@@ -8,14 +6,9 @@ module Maid::UserAgent
   class << self
     # This used to be called `#to_s`, but that made things difficult when testing.
     def value
-      ohai = Ohai::System.new
-      ohai.all_plugins
-
-      maid     = "Maid/#{ ::Maid.const_get(:VERSION) }"
-      platform = "#{ ohai['platform'] }/#{ ohai['platform_version'] }"
-      ruby     = "Ruby/#{ RUBY_VERSION } #{ RUBY_PLATFORM }"
+      maid = "Maid/#{ ::Maid.const_get(:VERSION) }"
       
-      "#{ maid } (#{ platform }; #{ ruby })"
+      "#{ maid } (#{ RUBY_DESCRIPTION })"
     end
   end
 end

data/lib/maid/version.rb

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

data/maid.gemspec

@@ -22,7 +22,6 @@ Gem::Specification.new do |s|
   s.add_dependency('thor', '>= 0.14.0', '< 0.19.0')
   s.add_dependency('deprecated', '~> 3.0.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', '~> 1.0.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.

data/spec/dependency_spec.rb

@@ -1,6 +1,5 @@
 require 'logger'
 require 'mime/types'
-require 'ohai'
 require 'rbconfig'
 require 'stringio'
 require 'xdg'
@@ -38,20 +37,6 @@ describe 'Dependency expectations' do
     end
   end
 
-  describe Ohai do
-    before do
-      @ohai = Ohai::System.new
-      # FIXME: For some reason this is really slow when using `guard`
-      @ohai.require_plugin('os')
-    end
-  
-    it 'has platform information' do
-      @ohai.require_plugin('platform')
-      @ohai['platform'].should match(/[a-z]+/i)
-      @ohai['platform_version'].should match(/[0-9]+/)
-    end
-  end
-
   describe RbConfig do
     it 'identifies the host operating system' do
       RbConfig::CONFIG['host_os'].should match(/[a-z]+/)

data/spec/lib/maid/tools_spec.rb

@@ -532,11 +532,32 @@ module Maid
         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(1.zip bar.zip foo.zip)
+      end
+    end
+
+    describe '#verbose_dupes_in' do
+      it 'should list all but the shortest-named dupe' do
+        dupes = @maid.verbose_dupes_in(file_fixtures_glob)
+
         basenames = dupes.flatten.map { |p| File.basename(p) }
         basenames.should == %w(bar.zip foo.zip)
       end
     end
 
+    describe '#newest_dupes_in' do
+      it 'should list all but the shortest-named dupe' do
+        oldest_path = "#{file_fixtures_path}/foo.zip"
+        FileUtils.touch(oldest_path, :mtime => Time.new(1970, 1, 1))
+
+        dupes = @maid.newest_dupes_in(file_fixtures_glob)
+
+        basenames = dupes.flatten.map { |p| File.basename(p) }
+        basenames.should == %w(bar.zip 1.zip)
+      end
+    end
+
     describe '#mime_type' do
       context 'given a JPEG image' do
         it 'reports "image/jpeg"' do

data/spec/lib/maid/user_agent_spec.rb

@@ -4,19 +4,10 @@ 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 = {
-          'platform' => 'Unix',
-          'platform_version' => '1.0',
-        }
-
-        system.stub(:all_plugins)
-
-        Ohai::System.stub(:new) { system }
-        stub_const('RUBY_VERSION', '1.8.8')
-        stub_const('RUBY_PLATFORM', 'pdp7')
+        stub_const('RUBY_DESCRIPTION', 'ruby 1.8.8p0 (1970-01-01 revision 1) [pdp7-unix]')
         ::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 (ruby 1.8.8p0 (1970-01-01 revision 1) [pdp7-unix])'
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maid
 version: !ruby/object:Gem::Version
-  version: 0.4.0.beta.1
+  version: 0.4.0.beta.2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-25 00:00:00.000000000 Z
+date: 2013-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape
-  requirement: &15074480 !ruby/object:Gem::Requirement
+  requirement: &16846920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *15074480
+  version_requirements: *16846920
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &15072960 !ruby/object:Gem::Requirement
+  requirement: &16846100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,10 +38,10 @@ dependencies:
         version: 0.19.0
   type: :runtime
   prerelease: false
-  version_requirements: *15072960
+  version_requirements: *16846100
 - !ruby/object:Gem::Dependency
   name: deprecated
-  requirement: &15071660 !ruby/object:Gem::Requirement
+  requirement: &16845180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -49,10 +49,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *15071660
+  version_requirements: *16845180
 - !ruby/object:Gem::Dependency
   name: mime-types
-  requirement: &15071040 !ruby/object:Gem::Requirement
+  requirement: &16844620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -60,24 +60,10 @@ dependencies:
         version: '1.21'
   type: :runtime
   prerelease: false
-  version_requirements: *15071040
-- !ruby/object:Gem::Dependency
-  name: ohai
-  requirement: &15070520 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 6.14.0
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 6.18.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *15070520
+  version_requirements: *16844620
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &15069740 !ruby/object:Gem::Requirement
+  requirement: &16843740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -85,10 +71,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *15069740
+  version_requirements: *16843740
 - !ruby/object:Gem::Dependency
   name: xdg
-  requirement: &15069280 !ruby/object:Gem::Requirement
+  requirement: &16842960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -96,10 +82,10 @@ dependencies:
         version: 2.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *15069280
+  version_requirements: *16842960
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &15068800 !ruby/object:Gem::Requirement
+  requirement: &16841920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -107,10 +93,10 @@ dependencies:
         version: 0.4.2
   type: :development
   prerelease: false
-  version_requirements: *15068800
+  version_requirements: *16841920
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &15068340 !ruby/object:Gem::Requirement
+  requirement: &16841040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -118,10 +104,10 @@ dependencies:
         version: 2.2.2
   type: :development
   prerelease: false
-  version_requirements: *15068340
+  version_requirements: *16841040
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &15067880 !ruby/object:Gem::Requirement
+  requirement: &16839820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -129,10 +115,10 @@ dependencies:
         version: 4.0.3
   type: :development
   prerelease: false
-  version_requirements: *15067880
+  version_requirements: *16839820
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &15083620 !ruby/object:Gem::Requirement
+  requirement: &16836680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -140,10 +126,10 @@ dependencies:
         version: 10.1.0
   type: :development
   prerelease: false
-  version_requirements: *15083620
+  version_requirements: *16836680
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &15082820 !ruby/object:Gem::Requirement
+  requirement: &16835760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -151,10 +137,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *15082820
+  version_requirements: *16835760
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &15081680 !ruby/object:Gem::Requirement
+  requirement: &16835060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -162,10 +148,10 @@ dependencies:
         version: 2.14.1
   type: :development
   prerelease: false
-  version_requirements: *15081680
+  version_requirements: *16835060
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &15079900 !ruby/object:Gem::Requirement
+  requirement: &16834140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -173,10 +159,10 @@ dependencies:
         version: 0.6.3
   type: :development
   prerelease: false
-  version_requirements: *15079900
+  version_requirements: *16834140
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &15079120 !ruby/object:Gem::Requirement
+  requirement: &16833200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -184,10 +170,10 @@ dependencies:
         version: 0.8.4
   type: :development
   prerelease: false
-  version_requirements: *15079120
+  version_requirements: *16833200
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &15077800 !ruby/object:Gem::Requirement
+  requirement: &16831180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -195,10 +181,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *15077800
+  version_requirements: *16831180
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &15076800 !ruby/object:Gem::Requirement
+  requirement: &16828880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -206,7 +192,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *15076800
+  version_requirements: *16828880
 description: Be lazy.  Let Maid clean up after you, based on rules you define.  Think
   of it as "Hazel for hackers".
 email:
@@ -253,10 +239,11 @@ files:
 - script/vagrant-test
 - script/vagrant-test-all
 - spec/dependency_spec.rb
+- spec/fixtures/files/1.zip
 - spec/fixtures/files/bar.zip
 - spec/fixtures/files/foo.zip
 - spec/fixtures/files/ruby.jpg
-- spec/fixtures/files/さ.zip
+- ! "spec/fixtures/files/ã\x81\x95.zip"
 - spec/lib/maid/app_spec.rb
 - spec/lib/maid/maid_spec.rb
 - spec/lib/maid/numeric_extensions_spec.rb