maid 0.1.0.beta.3 → 0.1.0.beta.4

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.8.7
+  - 1.9.2

data/CONTRIBUTING.rdoc

@@ -1,12 +1,24 @@
 = Contributing
 
-This is a Ruby Gem, built using Bundler.  For a walkthrough of how that works, see http://railscasts.com/episodes/245-new-gem-with-bundler.
+Wow, you want to contribute?  That's awesome!  Thanks!
+
+To make things easier on you, I've compiled some Notes and Guidelines.
 
 == Notes
 
-* `rake install` builds and installs the gem, but you'll probably need to do `sudo rake install`.
+* This is a Ruby Gem, built using Bundler.  For a walkthrough of how that works, see http://railscasts.com/episodes/245-new-gem-with-bundler.
+* `rake install` builds and installs the gem, but you'll probably need to do `sudo rake install`.  This lets you test the `maid` command.
 * Keep in mind that the gemspec only looks at files in the VCS (git).
 
 == Guidelines
 
-* Whenever possible, retain compatibility with Ruby 1.8.
+* Looking for something to do?  Anything in the TODO file is a good place to start.
+* Whenever possible, retain compatibility with Ruby 1.8.7.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    maid (0.1.0.beta.3)
+    maid (0.1.0.beta.4)
       thor (~> 0.14.6)
 
 GEM

data/README.rdoc

@@ -10,6 +10,8 @@ Maid is inspired by the Mac OS X shareware program Hazel[http://www.noodlesoft.c
 
 Your rules are defined in Ruby, so easy rules are easy and difficult rules are possible.
 
+http://travis-ci.org/benjaminoakes/maid.png ({More info}[http://travis-ci.org/benjaminoakes/maid])
+
 == Installation
 
 Maid is currently in beta, but I encourage you to give it a try.  I'm using it on several computers daily.
@@ -40,7 +42,7 @@ Maid rules are defined using Ruby, with some common operations made easier with
   Maid.rules do
     rule 'Old files downloaded while developing/testing' do
       dir('~/Downloads/*').each do |path|
-        if downloaded_from(path).any? {|u| u.match 'http://localhost'} && 1.week.since? last_accessed(path)
+        if downloaded_from(path).any? {|u| u.match 'http://localhost'} && 1.week.since?(last_accessed(path))
           trash(path)
         end
       end
@@ -92,138 +94,11 @@ Example for every day at 1am:
 
 Both Mac OS X and Linux 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.
 
-== Sample and Ideas
-
-Here's a sampling from my <tt>~/.maid/rules.rb</tt> file to get you started:
-  
-  software_archive_path = '~/Reference/Software/'
-
-  osx_app_extensions = %w[app dmg pkg wdgt]
-  osx_app_patterns = osx_app_extensions.map { |ext| (/\.#{ext}\/$/) }
-  linux_app_archive_path = "#{software_archive_path}/Linux/"
-  osx_app_archive_path = "#{software_archive_path}/Mac OS X/"
-  win_app_archive_path = "#{software_archive_path}/Windows XP/"
-
-  Maid.rules do
-    rule 'Files downloaded while developing' do
-      dir('~/Downloads/*').select do |path|
-        if downloaded_from(path).any? { |url| url.match(/^http:\/\/localhost:/) || url.match('staging.yourcompany.com') }
-          trash(path)
-        end
-      end
-    end
-
-    rule 'MP3s likely to be music' do
-      dir('~/Downloads/*.mp3').each do |path|
-        if duration_s(path) > 30.0
-          move(path, '~/Music/iTunes/iTunes Media/Automatically Add to iTunes/')
-        end
-      end
-    end
-
-    rule 'Accidentally downloaded HTML' do # this basically only happens to me on accident
-      dir('~/Downloads/*.html').each do |path|
-        trash(path)
-      end
-    end
-
-    rule 'Linux ISOs, etc' do
-      dir('~/Downloads/*.iso').each do |path|
-        move(path, software_archive_path)
-      end
-    end
-
-    rule 'Linux applications in Debian packages' do
-      dir('~/Downloads/*.deb').each do |path|
-        move(path, linux_app_archive_path)
-      end
-    end
+== Sample
 
-    rule 'Mac OS X applications in disk images' do
-      dir('~/Downloads/*.dmg').each do |path|
-        move(path, osx_app_archive_path)
-      end
-    end
-
-    rule 'Mac OS X applications in zip files' do
-      dir('~/Downloads/*.zip').select do |path|
-        candidates = zipfile_contents(path)
-        candidates.any? { |c| osx_app_patterns.any? { |re| c.match(re) } }
-      end.each do |path|
-        move(path, osx_app_archive_path)
-      end
-    end
-
-    rule 'Windows applications' do
-      dir('~/Downloads/*.exe').each do |path|
-        move(path, win_app_archive_path)
-      end
-    end
+For a sample rules file, run:
 
-    rule 'Windows applications in zip files' do
-      dir('~/Downloads/*.zip').select do |path|
-        candidates = zipfile_contents(path)
-        candidates.any? { |candidate| candidate.match(/\.exe$/) }
-      end.each do |path|
-        move(path, win_app_archive_path)
-      end
-    end
-
-    rule 'Accidental Wikipedia downloads' do
-      dir('~/Downloads/*').each do |path|
-        if downloaded_from(path).any? { |url| url.match('wikipedia') }
-          trash(path)
-        end
-      end
-    end
-
-    # If you store your working files in ~/Outbox/ (like Ethan Schoonover's "Kinkless Desktop"), you can have them automatically filed away...
-
-    rule 'JS snippets I write' do
-      dir('~/Outbox/*.js').each do |path|
-        if 1.weeks.ago > File.atime(path)
-          move(path, '~/Projects/snippets/javascript/')
-        end
-      end
-    end
-      
-    rule 'Ruby snippets' do
-      dir('~/Outbox/*.rb').each do |path|
-        if 1.week.ago > File.atime(path)
-          move(path, '~/Projects/snippets/ruby/')
-        end
-      end
-    end
-
-    rule 'Email drafts' do
-      dir('~/Outbox/*.eml').each do |path|
-        if 1.week.ago > File.atime(path)
-          move(path, '~/Archive/Misc Drafts/')
-        end
-      end
-    end
-    
-    rule 'Misc notes' do
-      %w[md markdown rtf txt].inject([]) { |all, ext| all + dir("~/Outbox/*.#{ext}") }.each do |path|
-        if 1.week.ago > File.atime(path)
-          move(path, '~/Archive/Misc Notes/')
-        end
-      end
-    end
-
-    rule 'Misc Screenshots' do
-      dir('~/Outbox/Screen shot *').each do |path|
-        if 1.week.ago > File.atime(path)
-          move(path, '~/Archive/Misc Screenshots/')
-        end
-      end
-    end
-     
-    rule 'Clear my working "temp" directory' do
-      trash('~/tmp')
-      FileUtils.mkdir_p(File.expand_path('~/tmp'))
-    end
-  end
+    maid sample
 
 == Warranty
 

data/TODO.rdoc

@@ -0,0 +1,45 @@
+= TODO
+
+== v0.1.0
+
+It's in beta right now.  Here's what's left for the first release:
+
+* Turn off forced noop before release
+
+== Future Releases
+
+Some of these might not happen, but they're being thought about.  Feel free to add your own.
+
+* Better user documentation of the DSL (in Maid::Tools)
+* Man pages, e.g. maid(1) and maid(5)
+  * I've read http://ozmm.org/posts/man_what.html and http://rcrowley.org/articles/man-pages-vs-rubygems.html and I'm not too happy with the available tools for this
+* Use a Cocoa interface to get Spotlight results
+* "Watch" rules that use Folder Actions on OS X (and icron on Linux?).  Something like:
+
+    Maid.rules do
+      watch '~/Downloads' do
+        rule 'watch rule 1' do
+          # ...
+        end
+
+        rule 'watch rule 2' do
+          # ...
+        end
+      end
+
+      rule 'normal rule 3' do
+        # ...
+      end
+    end
+
+* Guard has some similar "watch" functionality.  Here's what they use:
+  * FSEvent support on Mac OS X 10.5+ (without RubyCocoa!, rb-fsevent gem, >= 0.3.5 required).
+  * Inotify support on Linux (rb-inotify gem, >= 0.5.1 required).
+  * Directory Change Notification support on Windows (rb-fchange, >= 0.0.2 required).
+  * Polling on the other operating systems (help us to support more OS).
+  * Automatic & Super fast (when polling is not used) files modifications detection (even new files are detected).
+* Possibly: notifications
+  * Growl notifications (growlnotify & growl gem required).
+  * Libnotify notifications (libnotify gem required).
+
+* GUI for configuring easy rules

data/lib/maid/app.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 require 'rubygems'
 require 'thor'
 
@@ -5,6 +7,10 @@ class Maid::App < Thor
   check_unknown_options!
   default_task 'clean'
 
+  def self.sample_rules_path
+    File.join(File.dirname(Maid::Maid::DEFAULTS[:rules_path]), 'rules.sample.rb')
+  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]
@@ -22,6 +28,16 @@ class Maid::App < Thor
     say Maid::VERSION
   end
 
+  desc 'sample', "Create sample rules at #{self.sample_rules_path}"
+  def sample
+    path = self.class.sample_rules_path
+
+    FileUtils.mkdir_p(File.dirname(path))
+    File.open(path, 'w').puts(File.read(File.join(File.dirname(__FILE__), 'rules.sample.rb')))
+
+    say "Sample rules created at #{path.inspect}", :green
+  end
+
   no_tasks do
     def maid_options(options)
       h = {}
@@ -29,8 +45,11 @@ class Maid::App < Thor
       if options['noop']
         # You're testing, so a simple log goes to STDOUT and no actions are taken
         h[:file_options] = {:noop => true}
-        h[:log_device] = STDOUT
-        h[:log_formatter] = lambda { |_, _, _, msg| "#{msg}\n" }
+
+        unless options['silent']
+          h[:log_device] = STDOUT
+          h[:log_formatter] = lambda { |_, _, _, msg| "#{msg}\n" }
+        end
       end
 
       if options['rules']

data/lib/maid/maid.rb

@@ -82,7 +82,7 @@ class Maid::Maid
     if supported_command?(command)
       %x(#{command})
     else
-      raise ArgumentError, "Unsupported command: #{command.inspect}"
+      raise ArgumentError, "Unsupported system command: #{command.inspect}"
     end
   end
 

data/lib/maid/rules.sample.rb

@@ -0,0 +1,60 @@
+# Sample Maid rules file -- a sampling to get you started.
+#
+# To use, remove ".sample" from the filename.  Test using:
+#
+#     maid -n
+#
+# For more help on Maid:
+#
+#   * Run `maid help`
+#   * Read the README at http://github.com/benjaminoakes/maid
+#   * For more DSL helper methods, please see the documentation of Maid::Tools.
+#   * Come up with some cool tools of your own?  Fork, make your changes, and send me a pull request on GitHub!
+#   * Ask me a question over email (hello@benjaminoakes.com) or twitter (@benjaminoakes)
+#
+Maid.rules do
+  rule 'MP3s likely to be music' do
+    dir('~/Downloads/*.mp3').each do |path|
+      if duration_s(path) > 30.0
+        move(path, '~/Music/iTunes/iTunes Media/Automatically Add to iTunes/')
+      end
+    end
+  end
+
+  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?(last_accessed(path))
+        trash(path)
+      end
+    end
+  end
+
+  rule 'Linux ISOs, etc' do
+    dir('~/Downloads/*.iso').each { |p| trash p }
+  end
+
+  rule 'Linux applications in Debian packages' do
+    dir('~/Downloads/*.deb').each { |p| trash p }
+  end
+
+  rule 'Mac OS X applications in disk images' do
+    dir('~/Downloads/*.dmg').each { |p| trash p }
+  end
+
+  rule 'Mac OS X applications in zip files' do
+    dir('~/Downloads/*.zip').select do |path|
+      candidates = zipfile_contents(path)
+      candidates.any? { |c| c.match(/\.app$/) }
+    end.each { |p| trash p }
+  end
+
+  rule 'Misc Screenshots' do
+    dir('~/Desktop/Screen shot *').each do |path|
+      if 1.week.since?(last_accessed(path))
+        move(path, '~/Documents/Misc Screenshots/')
+      end
+    end
+  end
+
+  # Add your own rules here.
+end

data/lib/maid/version.rb

@@ -1,3 +1,3 @@
 module Maid
-  VERSION = "0.1.0.beta.3"
+  VERSION = "0.1.0.beta.4"
 end

data/script/micro-maid.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env sh
+# Script for testing Maid from scratch on MicroCore Linux (a 10 MB Linux distribution which is enough to run Maid)
+
+if [ `whoami` == 'root' ]; then
+  mkdir maid
+  cd maid
+  tce-fetch.sh ruby.tcz
+  tce-load -i ruby.tcz
+  wget http://production.cf.rubygems.org/rubygems/rubygems-1.8.5.tgz
+  tar xvfz rubygems-1.8.5.tgz
+  cd rubygems-1.8.5
+  ruby setup.rb
+  # wget http://githubredir.debian.net/github/benjaminoakes/maid/0~master.tar.gz -O maid-master.tar.gz
+  # tar xvfz maid-master.tar.gz
+  gem install maid --pre
+else
+  echo This should be run as root.
+fi

data/spec/lib/maid/app_spec.rb

@@ -45,6 +45,10 @@ module Maid
       @app.clean
     end
 
+    it 'should not be silent if not given the --silent option' do
+      capture_stdout { App.start(['clean']) }.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 == ''
@@ -59,6 +63,12 @@ module Maid
     end
   end
 
+  describe App, 'sample rules' do
+    it 'should be able to run' do
+      lambda { App.start(%w[clean --silent --noop --rules=lib/maid/rules.sample.rb]) }.should_not raise_error(SyntaxError)
+    end
+  end
+
   describe App, '#version' do
     it 'should print out the gem version' do
       app = App.new

data/spec/lib/maid/tools_spec.rb

@@ -49,7 +49,8 @@ module Maid
       end
 
       it 'should use a safe path if the target exists' do
-        Timecop.freeze(Time.parse('2011-05-22T16:53:52-04:00')) do
+        # Without an offset, ISO8601 parses to local time, which is what we want here.
+        Timecop.freeze(Time.parse('2011-05-22T16:53:52')) do
           File.stub!(:exist?).and_return(true)
           @maid.should_receive(:move).with(@path, "#{@trash_path}/foo.zip 2011-05-22-16-53-52")
           @maid.trash(@path)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: maid
 version: !ruby/object:Gem::Version 
-  hash: 62196405
+  hash: 62196411
   prerelease: 6
   segments: 
   - 0
   - 1
   - 0
   - beta
-  - 3
-  version: 0.1.0.beta.3
+  - 4
+  version: 0.1.0.beta.4
 platform: ruby
 authors: 
 - Benjamin Oakes
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-02 00:00:00 Z
+date: 2011-06-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thor
@@ -111,6 +111,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rspec
+- .travis.yml
 - CONTRIBUTING.rdoc
 - Gemfile
 - Gemfile.lock
@@ -118,15 +119,18 @@ files:
 - Maidfile
 - README.rdoc
 - Rakefile
+- TODO.rdoc
 - bin/maid
 - lib/maid.rb
 - lib/maid/app.rb
 - lib/maid/maid.rb
 - lib/maid/numeric_extensions.rb
 - lib/maid/rule.rb
+- lib/maid/rules.sample.rb
 - lib/maid/tools.rb
 - lib/maid/version.rb
 - maid.gemspec
+- script/micro-maid.sh
 - spec/lib/maid/app_spec.rb
 - spec/lib/maid/maid_spec.rb
 - spec/lib/maid/numeric_extensions_spec.rb