maid 0.7.0 → 0.8.0.alpha.1

data/.travis.yml

@@ -12,3 +12,4 @@ rvm:
   - 2.1.5
   - 2.2.0
   - 2.2.1
+  - 2.2.2

data/AUTHORS.md

@@ -18,4 +18,5 @@ In alphabetical order:
 * Nico Ritschel (@nicosuave)
 * Pedro Lambert (@p-lambert)
 * Shiro Hazuki (@HazukiShiro)
+* Song Chen Wen (宋辰文, @songchenwen)
 * Vladimir Agafonkin (@mourner)

data/ChangeLog

@@ -1,4 +1,16 @@
-maid (0.7.0) unstable; urgency=low
+maid (0.8.0) unstable; urgency=low
+
+  * Started official support for Ruby 2.2.2.
+  * Song Chen Wen: Added OSX tagging tools (depends on `brew install tag`):
+    "tags", "has_tags?", "contains_tag?", "add_tag", "remove_tag", "set_tag"
+    (Closes: #125)
+  * Song Chen Wen: Added "hidden?", "has_been_used?", "used_at", "added_at"
+    tools, using OSX Spotlight metadata when available
+  * Song Chen Wen: Added Aria2 and Tunder support to "downloading?" tool
+
+ -- Benjamin Oakes <hello@benjaminoakes.com>  TODO
+
+maid (0.7.0) stable; urgency=low
 
   * Stats! { 'collaborators' => 19, 'downloads' => 19988, 'forks' => 49,
     'open_issues' => 40, 'closed_issues' => 105, 'stars' => 1070,
@@ -11,7 +23,7 @@ maid (0.7.0) unstable; urgency=low
   * Itsuki Kurokawa: Add "ignore_child_dirs", "tree_empty?" tools.  (Closes: #144, #145)
   * Bugfix: "copy" now respects the dry-run/noop option
 
- -- Benjamin Oakes <hello@benjaminoakes.com>  TODO
+ -- Benjamin Oakes <hello@benjaminoakes.com>  Sat, 28 Mar 2015 22:13:00 +0000
 
 maid (0.6.1) stable; urgency=low
 

data/lib/maid/tools.rb

@@ -9,6 +9,8 @@ require 'mime/types'
 require 'dimensions'
 require 'zip'
 
+require 'pathname'
+
 # These "tools" are methods available in the Maid DSL.
 #
 # In general, methods are expected to:
@@ -360,7 +362,7 @@ module Maid::Tools
   #
   # See also: `dir_safe`
   def downloading?(path)
-    !!(chrome_downloading?(path) || firefox_downloading?(path) || safari_downloading?(path))
+    !!(chrome_downloading?(path) || firefox_downloading?(path) || safari_downloading?(path) || aria2_downloading?(path) || thunder_downloading?(path))
   end
 
   # Find all duplicate files in the given globs.
@@ -754,6 +756,188 @@ module Maid::Tools
     }
   end
 
+
+  # Get a list of Finder labels of a file or directory. Only available on OS X when you have tag installed.
+  #
+  # ## Example
+  #
+  #     tags("~/Downloads/a.dmg.download") # => ["Unfinished"]
+  def tags(path)
+    unless has_tag_available_and_warn?()
+      return []
+    end
+
+    path = sh_escape(expand(path))
+    raw = cmd("tag -lN #{path}")
+    raw.strip.split(',')
+  end
+
+  # Tell if a file or directory has any Finder labels. Only available on OS X when you have tag installed. 
+  #
+  # ## Example
+  #
+  #     has_tags?("~/Downloads/a.dmg.download") # => true
+  def has_tags?(path)
+    unless has_tag_available_and_warn?()
+      return false
+    end
+
+    ts = tags(path)
+    ts && ts.count > 0
+  end
+
+  # Tell if a file or directory has a certain Finder labels. Only available on OS X when you have tag installed. 
+  #
+  # ## Example
+  #
+  #     contains_tag?("~/Downloads/a.dmg.download", "Unfinished") # => true
+  def contains_tag?(path, tag)
+    unless has_tag_available_and_warn?()
+      return false
+    end
+
+    path = expand(path)
+    ts = tags(path)
+    ts.include? tag
+  end
+
+  # Add a Finder label or a list of labels to a file or directory. Only available on OS X when you have tag installed. 
+  #
+  # ## Example
+  #
+  #     add_tag("~/Downloads/a.dmg.download", "Unfinished")
+  def add_tag(path, tag)
+    unless has_tag_available_and_warn?()
+      return
+    end
+
+    path = expand(path)
+    ts = Array(tag).join(",")
+    log "add tags #{ts} to #{path}"
+    if !@file_options[:noop]
+      cmd("tag -a #{ts} #{sh_escape(path)}")
+    end
+  end
+
+  # Remove a Finder label or a list of labels from a file or directory. Only available on OS X when you have tag installed. 
+  #
+  # ## Example
+  #
+  #     remove_tag("~/Downloads/a.dmg", "Unfinished")
+  def remove_tag(path, tag)
+    unless has_tag_available_and_warn?()
+      return
+    end
+
+    path = expand(path)
+    ts = Array(tag).join(",")
+    log "remove tags #{ts} from #{path}"
+    if !@file_options[:noop]
+      cmd("tag -r #{ts} #{sh_escape(path)}")
+    end
+  end
+
+  # Set Finder label of a file or directory to a label or a list of labels. Only available on OS X when you have tag installed. 
+  #
+  # ## Example
+  #
+  #     set_tag("~/Downloads/a.dmg.download", "Unfinished")
+  def set_tag(path, tag)
+    unless has_tag_available_and_warn?()
+      return
+    end
+
+    path = expand(path)
+    ts = Array(tag).join(",")
+    log "set tags #{ts} to #{path}"
+    if !@file_options[:noop]
+      `tag -s "#{ts}" "#{path}"`
+    end
+  end
+
+  # Tell if a file is hidden  
+  #
+  # ## Example
+  #
+  #     hidden?("~/.maid") # => true
+  def hidden?(path)
+    if Maid::Platform.osx? 
+      attribute = 'kMDItemFSInvisible'
+      raw = cmd("mdls -raw -name #{attribute} #{ sh_escape(path) }")
+      return raw == '1'
+    else
+      p = Pathname.new(expand(path))
+      return p.basename =~ /^\./
+    end
+  end
+
+  # Tell if a file has been used since added  
+  #
+  # ## Example
+  #
+  #     has_been_used?("~/Downloads/downloading.download") # => false
+  def has_been_used?(path)
+    if Maid::Platform.osx? 
+      path = expand(path)
+      raw = cmd("mdls -raw -name kMDItemLastUsedDate #{ sh_escape(path) }")
+      if raw == "(null)"
+        return false
+      end
+      begin
+        DateTime.parse(raw).to_time
+        return true
+      rescue Exception => e
+        return false
+      end
+    else
+      return used_at(path) <=> added_at(path) > 0
+    end
+  end
+
+  # The last used time of a file on OS X, or atime on Linux.
+  #
+  # ## Example
+  #
+  #     used_at("foo.zip") # => Sat Apr 09 10:50:01 -0400 2011
+  def used_at(path)
+    if Maid::Platform.osx? 
+      path = expand(path)
+      raw = cmd("mdls -raw -name kMDItemLastUsedDate #{ sh_escape(path) }")
+      if raw == "(null)"
+        return 3650.day.ago
+      end
+      begin
+        return DateTime.parse(raw).to_time
+      rescue Exception => e
+        return accessed_at(path)
+      end
+    else
+      return accessed_at(path)
+    end
+  end
+
+  # The added time of a file on OS X, or ctime on Linux.
+  #
+  # ## Example
+  #
+  #     added_at("foo.zip") # => Sat Apr 09 10:50:01 -0400 2011
+  def added_at(path)
+    if Maid::Platform.osx? 
+      path = expand(path)
+      raw = cmd("mdls -raw -name kMDItemDateAdded #{ sh_escape(path) }")
+      if raw == "(null)"
+        return 1.second.ago
+      end
+      begin
+        return DateTime.parse(raw).to_time
+      rescue Exception => e
+        return created_at(path)
+      end
+    else
+      return created_at(path)
+    end
+  end
+
   private
 
   def firefox_downloading?(path)
@@ -769,6 +953,30 @@ module Maid::Tools
     path =~ /\.download$/
   end
 
+  def aria2_downloading?(path)
+    File.exist?("#{path}.aria2") || path =~ /\.aria2$/
+  end
+
+  def thunder_downloading?(path)
+    path =~ /\.td$/ || path =~ /\.td.cfg$/
+  end
+
+  def has_tag_available?()
+    return Maid::Platform.osx? && system("which -s tag")
+  end
+
+  def has_tag_available_and_warn?()
+    unless has_tag_available?
+      if Maid::Platform.osx?
+        warn("To use this feature, you need `tag` installed.  Run `brew install tag`")
+      else
+        warn("sorry, tagging is unavailable on your platform")
+      end
+      return false
+    end
+    return true
+  end
+
   def sh_escape(array)
     Escape.shell_command(Array(array))
   end

data/lib/maid/version.rb

@@ -1,4 +1,4 @@
 module Maid
-  VERSION = '0.7.0'
+  VERSION = '0.8.0.alpha.1'
   SUMMARY = 'Be lazy. Let Maid clean up after you, based on rules you define. Think of it as "Hazel for hackers".'
 end

data/spec/lib/maid/tools_spec.rb

@@ -771,5 +771,150 @@ module Maid
         expect(@maid.ignore_child_dirs(src).sort).to eq(expected)
       end
     end
+
+    describe '#tags' do
+      before do
+        @test_file = (@test_dir = '~/.maid/test/') + (@file_name = 'tag.zip')
+        `mkdir -p #{@test_dir}`
+        `touch #{@test_file}`
+        @maid.file_options[:noop] = false
+      end
+
+      after do
+        `rm -r #{@test_dir}`
+        @maid.file_options[:noop] = true
+      end
+
+      it 'get tags from a file that has one' do 
+        if system("which -s tag")
+          @maid.file_options[:noop] = false
+          @maid.add_tag(@test_file, "Test")
+          expect(@maid.tags(@test_file)).to eq(["Test"])
+        end
+      end
+
+      it 'get tags from a file that has serveral tags' do
+        if system("which -s tag")
+          @maid.file_options[:noop] = false
+          @maid.add_tag(@test_file, ["Test", "Twice"])
+          expect(@maid.tags(@test_file)).to eq(["Test", "Twice"])
+        end
+      end
+    end
+
+    describe '#has_tags?' do
+      before do
+        @test_file = (@test_dir = '~/.maid/test/') + (@file_name = 'tag.zip')
+        `mkdir -p #{@test_dir}`
+        `touch #{@test_file}`
+        @maid.file_options[:noop] = false
+      end
+
+      after do
+        `rm -r #{@test_dir}`
+        @maid.file_options[:noop] = true
+      end
+
+      it 'A file with tags' do 
+        if system("which -s tag")
+          @maid.add_tag(@test_file, "Test")
+          expect(@maid.has_tags?(@test_file)).to be(true)
+        end
+      end
+
+      it 'A file without tags' do
+          expect(@maid.has_tags?(@test_file)).to be(false)
+      end
+    end
+
+    describe '#contains_tag?' do
+      before do
+        @test_file = (@test_dir = '~/.maid/test/') + (@file_name = 'tag.zip')
+        `mkdir -p #{@test_dir}`
+        `touch #{@test_file}`
+        @maid.file_options[:noop] = false
+      end
+
+      after do
+        `rm -r #{@test_dir}`
+        @maid.file_options[:noop] = true
+      end
+
+      it 'A file with Test tag' do 
+        if system("which -s tag")
+          @maid.add_tag(@test_file, "Test")
+          expect(@maid.contains_tag?(@test_file, "Test")).to be(true)
+          expect(@maid.contains_tag?(@test_file, "Not there")).to be(false)
+        end
+      end
+    end
+
+    describe '#add_tag' do
+      before do
+        @test_file = (@test_dir = '~/.maid/test/') + (@file_name = 'tag.zip')
+        `mkdir -p #{@test_dir}`
+        `touch #{@test_file}`
+        @maid.file_options[:noop] = false
+      end
+
+      after do
+        `rm -r #{@test_dir}`
+        @maid.file_options[:noop] = true
+      end
+
+      it 'Add Test tag to a file' do 
+        if system("which -s tag")
+          @maid.add_tag(@test_file, "Test")
+          expect(@maid.contains_tag?(@test_file, "Test")).to be(true)
+        end
+      end
+    end
+
+    describe '#remove_tag' do
+      before do
+        @test_file = (@test_dir = '~/.maid/test/') + (@file_name = 'tag.zip')
+        `mkdir -p #{@test_dir}`
+        `touch #{@test_file}`
+        @maid.file_options[:noop] = false
+      end
+
+      after do
+        `rm -r #{@test_dir}`
+        @maid.file_options[:noop] = true
+      end
+
+      it 'Remove Test tag from a file' do 
+        if system("which -s tag")
+          @maid.add_tag(@test_file, "Test")
+          expect(@maid.contains_tag?(@test_file, "Test")).to be(true)
+          @maid.remove_tag(@test_file, "Test")
+          expect(@maid.contains_tag?(@test_file, "Test")).to be(false)
+        end
+      end
+    end
+
+    describe '#set_tag' do
+      before do
+        @test_file = (@test_dir = '~/.maid/test/') + (@file_name = 'tag.zip')
+        `mkdir -p #{@test_dir}`
+        `touch #{@test_file}`
+        @maid.file_options[:noop] = false
+      end
+
+      after do
+        `rm -r #{@test_dir}`
+        @maid.file_options[:noop] = true
+      end
+
+      it 'Set Test tags to a file' do 
+        if system("which -s tag")
+          @maid.set_tag(@test_file, "Test")
+          expect(@maid.contains_tag?(@test_file, "Test")).to be(true)
+          @maid.set_tag(@test_file, ["Test", "Twice"])
+          expect(@maid.contains_tag?(@test_file, "Test")).to be(true)
+          expect(@maid.contains_tag?(@test_file, "Twice")).to be(true)
+        end
+      end
+    end
   end
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: maid
 version: !ruby/object:Gem::Version
-  version: 0.7.0
-  prerelease: 
+  version: 0.8.0.alpha.1
+  prerelease: 6
 platform: ruby
 authors:
 - Benjamin Oakes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-28 00:00:00.000000000 Z
+date: 2015-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape
-  requirement: &10942860 !ruby/object:Gem::Requirement
+  requirement: &6312460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *10942860
+  version_requirements: *6312460
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &10960780 !ruby/object:Gem::Requirement
+  requirement: &6307360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,10 +38,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *10960780
+  version_requirements: *6307360
 - !ruby/object:Gem::Dependency
   name: deprecated
-  requirement: &10981960 !ruby/object:Gem::Requirement
+  requirement: &6305140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -49,10 +49,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *10981960
+  version_requirements: *6305140
 - !ruby/object:Gem::Dependency
   name: dimensions
-  requirement: &10979360 !ruby/object:Gem::Requirement
+  requirement: &6303640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -63,10 +63,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *10979360
+  version_requirements: *6303640
 - !ruby/object:Gem::Dependency
   name: mime-types
-  requirement: &10976100 !ruby/object:Gem::Requirement
+  requirement: &6300180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -74,10 +74,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *10976100
+  version_requirements: *6300180
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &10990880 !ruby/object:Gem::Requirement
+  requirement: &6299560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -85,10 +85,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *10990880
+  version_requirements: *6299560
 - !ruby/object:Gem::Dependency
   name: xdg
-  requirement: &10989700 !ruby/object:Gem::Requirement
+  requirement: &6298260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -96,10 +96,10 @@ dependencies:
         version: 2.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *10989700
+  version_requirements: *6298260
 - !ruby/object:Gem::Dependency
   name: listen
-  requirement: &10987680 !ruby/object:Gem::Requirement
+  requirement: &6296740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: 2.11.0
   type: :runtime
   prerelease: false
-  version_requirements: *10987680
+  version_requirements: *6296740
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
-  requirement: &10985200 !ruby/object:Gem::Requirement
+  requirement: &6295240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,10 +121,10 @@ dependencies:
         version: 3.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *10985200
+  version_requirements: *6295240
 - !ruby/object:Gem::Dependency
   name: exifr
-  requirement: &10983060 !ruby/object:Gem::Requirement
+  requirement: &6293880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -132,10 +132,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *10983060
+  version_requirements: *6293880
 - !ruby/object:Gem::Dependency
   name: geocoder
-  requirement: &11006360 !ruby/object:Gem::Requirement
+  requirement: &6292380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -143,10 +143,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *11006360
+  version_requirements: *6292380
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &11005300 !ruby/object:Gem::Requirement
+  requirement: &6290640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -154,10 +154,10 @@ dependencies:
         version: 0.4.3
   type: :development
   prerelease: false
-  version_requirements: *11005300
+  version_requirements: *6290640
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &11004340 !ruby/object:Gem::Requirement
+  requirement: &6289200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -165,10 +165,10 @@ dependencies:
         version: 2.12.5
   type: :development
   prerelease: false
-  version_requirements: *11004340
+  version_requirements: *6289200
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &11001040 !ruby/object:Gem::Requirement
+  requirement: &6287740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -176,10 +176,10 @@ dependencies:
         version: 4.5.0
   type: :development
   prerelease: false
-  version_requirements: *11001040
+  version_requirements: *6287740
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &11032920 !ruby/object:Gem::Requirement
+  requirement: &6286640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -187,10 +187,10 @@ dependencies:
         version: 10.4.2
   type: :development
   prerelease: false
-  version_requirements: *11032920
+  version_requirements: *6286640
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &11039280 !ruby/object:Gem::Requirement
+  requirement: &6285780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -198,10 +198,10 @@ dependencies:
         version: 3.2.2
   type: :development
   prerelease: false
-  version_requirements: *11039280
+  version_requirements: *6285780
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11056760 !ruby/object:Gem::Requirement
+  requirement: &6284440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -209,10 +209,10 @@ dependencies:
         version: 3.2.0
   type: :development
   prerelease: false
-  version_requirements: *11056760
+  version_requirements: *6284440
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &11055540 !ruby/object:Gem::Requirement
+  requirement: &6282200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -220,10 +220,10 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *11055540
+  version_requirements: *6282200
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &11074300 !ruby/object:Gem::Requirement
+  requirement: &6274480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -231,10 +231,10 @@ dependencies:
         version: 0.8.4
   type: :development
   prerelease: false
-  version_requirements: *11074300
+  version_requirements: *6274480
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &11067880 !ruby/object:Gem::Requirement
+  requirement: &6270600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -242,10 +242,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *11067880
+  version_requirements: *6270600
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &11089020 !ruby/object:Gem::Requirement
+  requirement: &6267620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -253,7 +253,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *11089020
+  version_requirements: *6267620
 description: Be lazy. Let Maid clean up after you, based on rules you define. Think
   of it as "Hazel for hackers".
 email:
@@ -311,7 +311,7 @@ files:
 - spec/fixtures/files/ruby.jpg
 - spec/fixtures/files/sydney.jpg
 - spec/fixtures/files/unknown.foo
-- 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
@@ -340,9 +340,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