maid 0.5.0 → 0.6.0.alpha.1

data/.ruby-version

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

data/.travis.yml

@@ -1,6 +1,11 @@
 language: ruby
 cache: bundler
+os:
+  - linux
+  - osx
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0-preview2
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2

data/AUTHORS.md

@@ -3,6 +3,7 @@ In alphabetical order:
 * Benjamin Oakes (@benjaminoakes)
 * Bradley Smith (@bradleyd)
 * Graham Siener (@gsiener)
+* Jayson Rhynas (@jayrhynas)
 * John Colvin (@JohnColvin)
 * Justin Hileman (@bobthecow)
 * Larry Lv (@larrylv)
@@ -11,5 +12,6 @@ In alphabetical order:
 * Mark Jaquith (@markjaquith)
 * Mikael Hultgren (@blomma)
 * Mu Ye (@yemutex)
+* Pedro Lambert (@p-lambert)
 * Shiro Hazuki (@HazukiShiro)
 * Vladimir Agafonkin (@mourner)

data/ChangeLog

@@ -1,5 +1,15 @@
+maid (0.6.0) unstable; urgency=low
+
+  * Jayson Rhynas: Add Safari download detection to "downloading?" (Closes: #121)
+  * Pedro Lambert: Add support for Rake tasks defined by Maid (Closes: #68, #123)
+
+ -- Benjamin Oakes <hello@benjaminoakes.com>  TODO
+
 maid (0.5.0) stable; urgency=low
 
+  * Stats! { 'collaborators' => 13, 'downloads' => 9570, 'forks' => 38,
+    'open_issues' => 28, 'closed_issues' => 86, 'stars' => 722,
+    'users_sharing_rules' => 25 }
   * Started official support Ruby 2.1.0 (Closes: #114)
   * Shiro Hazuki (public domain code): New utility methods: "dir_safe",
     "downloading?" (Closes: #107)

data/README.md

@@ -85,7 +85,7 @@ 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 or 2.1.0 are preferred)
+* **Ruby:** 1.9.3+ (2.0.0, 2.1.0, or 2.1.1 are preferred)
 
 Some features require OS X.  See the [documentation][] for more details.
 
@@ -210,6 +210,30 @@ 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 --force --silent"
 
+### Rake Tasks
+
+Maid includes helpers that make file managment easier.  You may find them useful if you need to automate tasks in your Ruby projects.  This is available via support for Maid-based Rake tasks:
+
+```ruby
+# File: Rakefile
+require 'maid'
+
+Maid::Rake::Task.new :clean do
+  # Clean up Rubinius-compilied Ruby
+  trash(dir('**/*.rbc'))
+end
+```
+
+In fact, the Maid project uses Maid in [its Rakefile](https://github.com/benjaminoakes/maid/blob/master/Rakefile).
+
+You can also provide a custom description:
+
+```ruby
+Maid::Rake::Task.new clean_torrents: [:dependency], description: 'Clean Torrents' do
+  trash(dir('~/Downloads/*.torrent'))
+end
+```
+
 ## Warranty
 
 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING

data/Rakefile

@@ -1,4 +1,5 @@
 require 'bundler'
+require 'maid'
 require 'rake'
 require 'rspec/core/rake_task'
 require 'yard'
@@ -12,3 +13,12 @@ YARD::Rake::YardocTask.new
 task :console do
   sh('irb -I lib -r maid')
 end
+
+Maid::Rake::Task.new :clean do
+  # Clean up Rubinius-compilied Ruby
+  trash(dir('**/*.rbc'))
+
+  # Get rid of old rubygems packages
+  trash('pkg')
+  mkdir('pkg')
+end

data/lib/maid/rake/single_rule.rb

@@ -0,0 +1,34 @@
+module Maid
+  module Rake
+    class SingleRule
+      attr_writer :maid_instance
+      attr_reader :name, :task
+
+      def initialize(name, task)
+        @name = name
+        @task = task
+      end
+
+      def clean
+        maid_instance.clean
+      end
+
+      def maid_instance
+        @maid_instance ||= ::Maid::Maid.new(rules_path: '/dev/null')
+      end
+
+      def define
+        maid_instance.rule name do
+          maid_instance.instance_eval(&task)
+        end
+        self
+      end
+
+      class << self
+        def perform(name, task)
+          new(name, task).define.clean
+        end
+      end
+    end
+  end
+end

data/lib/maid/rake/task.rb

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/tasklib'
+
+module Maid
+  module Rake
+    class Task < ::Rake::TaskLib
+      DEFAULT_DESCRIPTION = 'Maid Task'
+
+      def initialize(*args, &task)
+        @args      = args
+        @task_proc = task
+        define
+      end
+
+      private
+
+      attr_reader :task_proc
+
+      def args
+        @args.reject(&:empty?)
+      end
+
+      def task_description
+        @task_description ||= begin
+          opts = args.detect { |arg| arg.is_a?(Hash) }
+          (opts && opts.delete(:description)) || DEFAULT_DESCRIPTION
+        end
+      end
+
+      def define
+        desc task_description
+        task *args do |task|
+          SingleRule.perform(task.name, task_proc)
+        end
+      end
+    end
+  end
+end

data/lib/maid/tools.rb

@@ -1,4 +1,4 @@
-require 'digest/md5'
+require 'digest/sha1'
 require 'find'
 require 'fileutils'
 require 'time'
@@ -28,11 +28,11 @@ module Maid::Tools
   # Single path:
   #
   #     move('~/Downloads/foo.zip', '~/Archive/Software/Mac OS X/')
-  # 
+  #
   # Multiple paths:
   #
   #     move(['~/Downloads/foo.zip', '~/Downloads/bar.zip'], '~/Archive/Software/Mac OS X/')
-  #     move(dir('~/Downloads/*.zip'), '~/Archive/Software/Mac OS X/')    
+  #     move(dir('~/Downloads/*.zip'), '~/Archive/Software/Mac OS X/')
   def move(sources, destination)
     destination = expand(destination)
 
@@ -84,11 +84,11 @@ module Maid::Tools
   #
   # 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.
-  # 
+  #
   # ## Options
   #
   # `:remove_over => Fixnum` (e.g. `1.gigabyte`, `1024.megabytes`)
@@ -102,7 +102,7 @@ module Maid::Tools
   # Single path:
   #
   #     trash('~/Downloads/foo.zip')
-  # 
+  #
   # Multiple paths:
   #
   #     trash(['~/Downloads/foo.zip', '~/Downloads/bar.zip'])
@@ -146,7 +146,7 @@ module Maid::Tools
   # 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
   #
   # `:force => boolean`
@@ -234,11 +234,11 @@ module Maid::Tools
     dir(globs).
       select { |f| File.file?(f) }
   end
-  
+
   # Escape characters that have special meaning as a part of path global patterns.
   #
   # Useful when using `dir` with file names that may contain `{ } [ ]` characters.
-  # 
+  #
   # ## Example
   #
   #     escape_glob('test [tmp]') # => 'test \\[tmp\\]'
@@ -328,7 +328,7 @@ module Maid::Tools
   #
   # See also: `dir_safe`
   def downloading?(path)
-    chrome_downloading?(path) || firefox_downloading?(path)
+    !!(chrome_downloading?(path) || firefox_downloading?(path) || safari_downloading?(path))
   end
 
   # Find all duplicate files in the given globs.
@@ -430,7 +430,7 @@ module Maid::Tools
     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
-   
+
     if usage_kb.zero?
       raise "Stopping pessimistically because of unexpected value from du (#{ raw.inspect })"
     else
@@ -493,9 +493,9 @@ module Maid::Tools
   #
   # ## Examples
   #
-  #     checksum_of('foo.zip') # => "ae8dbb203dfd560158083e5de90969c2"
+  #     checksum_of('foo.zip') # => "67258d750ca654d5d3c7b06bd2a1c792ced2003e"
   def checksum_of(path)
-    Digest::MD5.hexdigest(File.read(path))
+    Digest::SHA1.hexdigest(File.read(path))
   end
 
   # @deprecated
@@ -521,7 +521,7 @@ module Maid::Tools
   # The host OS must provide `rsync`.  See the `rsync` man page for a detailed description.
   #
   #     man rsync
-  # 
+  #
   # ## Options
   #
   # `:delete      => boolean`
@@ -610,7 +610,7 @@ module Maid::Tools
   #     media_type('bar.jpg') # => "image"
   def media_type(path)
     type = MIME::Types.type_for(path)[0]
-    
+
     if type
       type.media_type
     end
@@ -634,7 +634,7 @@ module Maid::Tools
   #     where_content_type(dir('~/Downloads/*'), 'image/jpeg')
   #
   # ### Using Spotlight content types
-  # 
+  #
   # Less portable, but richer data in some cases.
   #
   #     where_content_type(dir('~/Downloads/*'), 'public.image')
@@ -654,6 +654,10 @@ module Maid::Tools
     path =~ /\.crdownload$/
   end
 
+  def safari_downloading?(path)
+    path =~ /\.download$/
+  end
+
   def sh_escape(array)
     Escape.shell_command(Array(array))
   end
@@ -681,4 +685,19 @@ module Maid::Tools
     clean = raw[1, raw.length - 2]
     clean.split(/,\s+/).map { |s| t = s.strip; t[1, t.length - 2] }
   end
+
+  # ---
+  # Something @benjaminoakes wrote:
+  
+  # Maid.rules do
+  #   dir('*-2012.pdf').each do |p|
+  #     move(p, normalize_date(p))
+  #   end
+  # end
+
+  def normalize_date(path)
+    basename = File.basename(path, '.pdf')
+    latent_date = Date.strptime(basename, '%m-%d-%Y')
+    latent_date.strftime('%Y.%m.%d.pdf')
+  end
 end

data/lib/maid/version.rb

@@ -1,3 +1,3 @@
 module Maid
-  VERSION = '0.5.0'
+  VERSION = '0.6.0.alpha.1'
 end

data/lib/maid.rb

@@ -11,6 +11,8 @@ require 'maid/maid'
 require 'maid/app'
 require 'maid/numeric_extensions'
 require 'maid/platform'
+require 'maid/rake/single_rule'
+require 'maid/rake/task'
 require 'maid/rule'
 require 'maid/trash_migration'
 require 'maid/user_agent'

data/maid.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
 
   # Strategy: if possible, use ranges (so there are fewer chances of version conflicts)
   s.add_dependency('escape', '>= 0.0.1', '< 0.1.0') # Used for better Ruby 1.8.7 support, could be replaced with `Shellwords`
-  s.add_dependency('thor', '>= 0.14.0', '< 0.19.0')
+  s.add_dependency('thor', '>= 0.14.0', '< 1.0.0')
   s.add_dependency('deprecated', '~> 3.0.0')
   s.add_dependency('mime-types', '~> 2.0')
   s.add_dependency('rubyzip', '~> 1.1.0')
@@ -32,11 +32,11 @@ Gem::Specification.new do |s|
   # Strategy: specific versions (since they're just for development)
   s.add_development_dependency('fakefs', '~> 0.4.2')
   s.add_development_dependency('guard', '~> 2.2.2')
-  s.add_development_dependency('guard-rspec', '~> 4.0.3')
+  s.add_development_dependency('guard-rspec', '~> 4.2.1')
   s.add_development_dependency('rake', '~> 10.1.0')
   s.add_development_dependency('redcarpet', '~> 3.0.0') # Soft dependency of `yard`
-  s.add_development_dependency('rspec', '~> 2.14.1')
-  s.add_development_dependency('timecop', '~> 0.6.3')
+  s.add_development_dependency('rspec', '>= 2.14', '< 3.0')
+  s.add_development_dependency('timecop', '~> 0.7.0')
   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

data/script/vagrant-provision

@@ -22,11 +22,14 @@ function install-pkg-if-ruby {
   fi
 }
 
+sudo apt-get update
+sudo apt-get install -y python-software-properties
+sudo add-apt-repository -y ppa:brightbox/ruby-ng
 sudo apt-get update
 
-# ## Dependencies
-# Installs `ruby 1.9.3p0`
-install-pkg-if-ruby '1.9.3' 'ruby1.9.1'
+## Dependencies
+install-pkg-if-ruby '2.1.0' 'ruby2.1'
+install-pkg-if-ruby '1.9.3' 'ruby1.9.1' # Installs `ruby 1.9.3p0`
 install-pkg-if-ruby 'jruby' 'jruby'
 
 # ## Development dependencies
@@ -38,6 +41,14 @@ install-pkg 'make'
 install-pkg 'libffi-dev'
 install-pkg-if-ruby '1.9.3' 'ruby1.9.1-dev'
 
+# # wget http://cache.ruby-lang.org/pub/ruby/2.1/ruby-2.1.1.tar.gz
+# wget 'http://192.168.0.1:3000/serv/Software/Source/ruby-2.1.1.tar.gz'
+# tar xvfz ruby-2.1.1.tar.gz
+# cd ruby-2.1.1
+# ./configure
+# make
+# sudo make install
+
 sudo gem install bundler
 cd /vagrant
 bundle install

data/spec/dependency_spec.rb

@@ -23,31 +23,31 @@ describe 'Dependency expectations' do
       logger = Logger.new(io)
       logger.info('my message')
       logger.formatter = lambda { |_, _, _, msg| msg }
-      io.string.should match(/my message/)
+      expect(io.string).to match(/my message/)
     end
   end
 
   describe MIME::Types do
     it 'reports media types and sub types when given a path' do
       types = MIME::Types.type_for('anything.jpg')
-      types.length.should == 1
+      expect(types.length).to eq(1)
       type = types[0]
-      type.media_type.should == 'image'
-      type.sub_type.should == 'jpeg'
+      expect(type.media_type).to eq('image')
+      expect(type.sub_type).to eq('jpeg')
     end
 
     context 'when the type is unknown' do
       it 'returns []' do
         types = MIME::Types.type_for('unknown.foo')
-        types.length.should == 0
-        types[0].should be_nil
+        expect(types.length).to eq(0)
+        expect(types[0]).to be_nil
       end
     end
   end
 
   describe RbConfig do
     it 'identifies the host operating system' do
-      RbConfig::CONFIG['host_os'].should match(/[a-z]+/)
+      expect(RbConfig::CONFIG['host_os']).to match(/[a-z]+/)
     end
   end
 
@@ -59,21 +59,21 @@ describe 'Dependency expectations' do
       # More info:
       #
       # * [XDG Base Directory Specification](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html)
-      XDG['DATA_HOME'].to_s.should match(%r{^/.*?/\.local/share$})
+      expect(XDG['DATA_HOME'].to_s).to match(%r{^/.*?/\.local/share$})
     end
   end
 
   describe Zip::File do
     it 'makes entries available with #entries' do
       Zip::File.open("#@file_fixtures_path/foo.zip") do |zip_file|
-        zip_file.entries.map { |entry| entry.name }.sort.should == %w(README.txt foo.exe subdir/anything.txt)
+        expect(zip_file.entries.map { |entry| entry.name }).to match_array(%w(README.txt foo.exe subdir/anything.txt))
       end
     end
 
     it 'supports UTF-8 filenames' do
       # Filename is a Japanese character
       Zip::File.open("#@file_fixtures_path/\343\201\225.zip") do |zip_file|
-        zip_file.entries.map { |entry| entry.name }.should == %w(anything.txt)
+        expect(zip_file.entries.map { |entry| entry.name }).to eq(%w(anything.txt))
       end
     end
   end

data/spec/lib/maid/app_spec.rb

@@ -7,7 +7,7 @@ module Maid
       out = StringIO.new
       $stdout = out
       yield
-      return out
+      out.string
     ensure
       $stdout = STDOUT
     end
@@ -16,7 +16,7 @@ module Maid
       out = StringIO.new
       $stderr = out
       yield
-      return out
+      out.string
     ensure
       $stderr = STDERR
     end
@@ -36,41 +36,41 @@ module Maid
       Maid.stub(:new) { @maid }
     end
 
-    it 'should make a new Maid with the options' do
+    it 'makes a new Maid with the options' do
       opts = { :foo => 'bar' }
       @app.stub(:maid_options).and_return(opts)
-      Maid.should_receive(:new).with(opts).and_return(@maid)
+      expect(Maid).to receive(:new).with(opts).and_return(@maid)
       @app.clean
     end
 
-    it 'should clean when --force is specified' do      
-      @maid.should_receive(:clean)
+    it 'cleans when --force is specified' do      
+      expect(@maid).to receive(:clean)
       App.start(['clean', '--force'])
     end 
 
-    it 'should issue deprecation notice when called without option, but still clean' do
-      @maid.should_receive(:clean).twice
-      capture_stderr { App.start(['clean']) }.string.should match(/deprecated/)
-      capture_stderr { App.start(['clean', '--silent']) }.string.should match(/deprecated/)
+    it 'issues deprecation notice when called without option, but still clean' do
+      expect(@maid).to receive(:clean).twice
+      expect(capture_stderr { App.start(['clean']) }).to match(/deprecated/)
+      expect(capture_stderr { App.start(['clean', '--silent']) }).to match(/deprecated/)
     end
 
-    it 'should not be silent if not given the --silent option' do
-      capture_stdout { App.start(['clean', '--force']) }.string.should_not == ''
+    it 'is not silent if not given the --silent option' do
+      expect(capture_stdout { App.start(['clean', '--force']) }).not_to eq('')
     end
 
-    it 'should be silent if given the --silent option' do
+    it 'is 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', '--noop', '--silent']) }.string.should == ''
-      capture_stdout { App.start(['clean', '--force', '--silent']) }.string.should == ''
+      expect(capture_stdout { App.start(['clean', '--noop', '--silent']) }).to eq('')
+      expect(capture_stdout { App.start(['clean', '--force', '--silent']) }).to eq('')
     end
 
-    it 'should complain about a MISSPELLED option' do
-      capture_stderr { App.start(['clean', '--slient']) }.string.should match(/Unknown/)
-      capture_stderr { App.start(['clean', '--noop', '--slient']) }.string.should match(/Unknown/)
+    it 'complains about a MISSPELLED option' do
+      expect(capture_stderr { App.start(['clean', '--slient']) }).to match(/Unknown/)
+      expect(capture_stderr { App.start(['clean', '--noop', '--slient']) }).to match(/Unknown/)
     end
 
-    it 'should complain about an undefined task' do
-      capture_stderr { App.start(['rules.rb']) }.string.should match(/Could not find/)
+    it 'complains about an undefined task' do
+      expect(capture_stderr { App.start(['rules.rb']) }).to match(/Could not find/)
     end
   end
 
@@ -79,13 +79,13 @@ module Maid
       @app = App.new
     end
 
-    it 'should print out the gem version' do
-      @app.should_receive(:say).with(VERSION)
+    it 'prints out the gem version' do
+      expect(@app).to receive(:say).with(VERSION)
       @app.version
     end
 
     it 'is mapped as --version' do
-      App.start(['--version']).should == @app.version
+      expect(App.start(['--version'])).to eq(@app.version)
     end
 
     context 'with the "long" option' do
@@ -97,10 +97,10 @@ module Maid
         @app.options = options
       end
 
-      it 'should print out the gem version' do
+      it 'prints out the gem version' do
         ua = 'Maid/0.0.1'
         UserAgent.stub(:value) { ua }
-        @app.should_receive(:say).with(ua)
+        expect(@app).to receive(:say).with(ua)
         @app.version
       end
     end
@@ -111,17 +111,17 @@ module Maid
       @app = App.new
     end
 
-    it 'should log to STDOUT for testing purposes when given noop' do
+    it 'logs to STDOUT for testing purposes when given noop' do
       opts = @app.maid_options('noop' => true)
-      opts[:file_options][:noop].should be_true
-      opts[:logger].should be_false
-      opts[:log_device].should == STDOUT
-      opts[:log_formatter].call(nil, nil, nil, 'hello').should == "hello\n"
+      expect(opts[:file_options][:noop]).to be(true)
+      expect(opts[:logger]).to be(false)
+      expect(opts[:log_device]).to eq(STDOUT)
+      expect(opts[:log_formatter].call(nil, nil, nil, 'hello')).to eq("hello\n")
     end
 
-    it 'should set the rules path when given rules' do
+    it 'sets the rules path when given rules' do
       opts = @app.maid_options('rules' => 'maid_rules.rb')
-      opts[:rules_path].should match(/maid_rules.rb$/)
+      expect(opts[:rules_path]).to match(/maid_rules.rb$/)
     end
   end
 end