maid 0.8.0.alpha.4 → 0.9.0.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8b5cb25bc23bd40980cdb281cc427eb1d8adaf81e8aa446abe0e93f7d127d7f
+  data.tar.gz: 69ebef7303be657252cc2076bb997db24bf417880e35c14a2735a167f7d9d361
+SHA512:
+  metadata.gz: d48b3b39672ca83f12b5b78a0412529a3abdd8e2124db420fef1bfc2d50a80cef817ba88e1cdc2c2a73fab755c472776a50fbf531d2d4ff9337a5beae0d2f9cd
+  data.tar.gz: b92797a56fc213b486c962c097e1ddddc03bcdd5d50cc5a3ce4f96ffe7f26b288a374c41b071a4b297f30882159c427868c53f222177cd7c2b48eb7b26dc587b

data/.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: Maid
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os:
+          - ubuntu-20.04
+          - ubuntu-22.04
+          - macos-11
+          - macos-12
+        ruby-version:
+          - 2.7
+          - 3.0
+          - 3.1
+          - 3.2
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/.ruby-gemset

@@ -1 +1 @@
-maid
+maid-dev

data/.ruby-version

@@ -1 +1 @@
-2.1.5
+3.1.3

data/AUTHORS.md

@@ -17,6 +17,7 @@ In alphabetical order:
 * Mu Ye (@yemutex)
 * Nico Ritschel (@nicosuave)
 * Pedro Lambert (@p-lambert)
+* Pierre Rock (@coaxial)
 * Shiro Hazuki (@HazukiShiro)
 * Song Chen Wen (宋辰文, @songchenwen)
 * Vladimir Agafonkin (@mourner)

data/ChangeLog

@@ -1,6 +1,14 @@
+maid (0.9.0) unstable; urgency=low
+  * Mark Przepiora: Support passing scheduler options to Rufus
+  * Pierre Rock: Support Ruby 3
+  * Pierre Rock: Update most dependencies
+
+ -- Pierre Rock <coaxial@users.noreply.github.com> Sat, 18 Mar 2023 12:06:00
+ +0100
+
 maid (0.8.0) unstable; urgency=low
 
-  * Started official support for Ruby 2.2.2.
+  * Started official support for Ruby 2.2 - 2.6. (Closes: #174)
   * 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)
@@ -8,8 +16,10 @@ maid (0.8.0) unstable; urgency=low
     tools, using OSX Spotlight metadata when available
   * Song Chen Wen: Added Aria2 and Tunder support to "downloading?" tool
   * Song Chen Wen: Reduce "watch" CPU usage by throttling (Closes: #149, #150)
+  * Phylor: Add command to manage logs (Closes: #169, #143)
   * Updated development dependencies, except for FakeFS (help appreciated!)
   * Updated dependencies: "listen", "rufus-scheduler"
+  * Phylor: Fix geolookup
 
  -- Benjamin Oakes <hello@benjaminoakes.com>  TODO
 

data/README.md

@@ -1,9 +1,8 @@
 # Maid
 
-[![Gem Version](https://badge.fury.io/rb/maid.png)](http://badge.fury.io/rb/maid)
-[![Build Status](https://secure.travis-ci.org/benjaminoakes/maid.png)](http://travis-ci.org/benjaminoakes/maid)
-[![Dependency Status](https://gemnasium.com/benjaminoakes/maid.png)](https://gemnasium.com/benjaminoakes/maid)
-[![Code Climate](https://codeclimate.com/github/benjaminoakes/maid.png)](https://codeclimate.com/github/benjaminoakes/maid)
+[![Gem Version](https://badge.fury.io/rb/maid.svg)](http://badge.fury.io/rb/maid)
+[![Build Status](https://secure.travis-ci.org/benjaminoakes/maid.svg)](http://travis-ci.org/benjaminoakes/maid)
+[![Code Climate](https://codeclimate.com/github/benjaminoakes/maid.svg)](https://codeclimate.com/github/benjaminoakes/maid)
 [![Hakiri](https://hakiri.io/github/benjaminoakes/maid/stable.svg)](https://hakiri.io/github/benjaminoakes/maid/stable)
 [![StackOverflow](http://img.shields.io/badge/stackoverflow-maid-blue.svg)](http://stackoverflow.com/questions/tagged/maid)
 
@@ -86,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.x or 2.1.x are preferred)
+* **Ruby:** 2.7.0+ (3.0.0+ preferred)
 
 Some features require OS X.  See the [documentation][] for more details.
 
@@ -99,7 +98,7 @@ Consider `rbenv` or `rvm`, especially if only Ruby 1.8.7 is available (e.g. if y
 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)
+* **Ubuntu:** Ruby is not preinstalled.  To install Ruby 2.7: `sudo apt-get install ruby2.7`
   ([Interested in a package?](https://github.com/benjaminoakes/maid/issues/3))
 
 Then, you can install via RubyGems.  Open a terminal and run:
@@ -137,7 +136,7 @@ For example, this is a rule:
 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?(accessed_at(path))
         trash(path)
       end
     end

data/Vagrantfile

@@ -3,8 +3,7 @@
 
 Vagrant.configure('2') do |config|
   # See also: `script/vagrant-test`, `script/vagrant-test-all`
-  config.vm.box     = ENV['MAID_TARGET_BOX'] || 'precise64'
-  config.vm.box_url = 'http://files.vagrantup.com/precise64.box' if 'precise64' == config.vm.box
+  config.vm.box     = ENV['MAID_TARGET_BOX'] || 'hashicorp/precise64'
 
   config.vm.provider :virtualbox do |vb|
     # Maid has very low system requirements

data/lib/maid/app.rb

@@ -93,6 +93,27 @@ EOF
     maid.daemonize
   end
 
+  desc 'logs', 'Manages logs written by maid'
+  method_option :path, :type => :boolean, :aliases => %w(-p)
+  method_option :tail, :type => :boolean, :aliases => %w(-t)
+  def logs
+    maid = Maid::Maid.new(maid_options(options))
+
+    if options.path?
+      say maid.log_device
+    else
+      unless File.readable?(maid.log_device)
+        error "Log file #{maid.log_device} does not exist."
+      else
+        if options.tail?
+          system("tail -f #{maid.log_device}")
+        else
+          say `tail #{maid.log_device}`
+        end
+      end
+    end
+  end
+
   no_tasks do
     def maid_options(options)
       h = {}

data/lib/maid/maid.rb

@@ -89,8 +89,8 @@ class Maid::Maid
     @watches << ::Maid::Watch.new(self, path, options, &rules)
   end
 
-  def repeat(timestring, &rules)
-    @repeats << ::Maid::Repeat.new(self, timestring, &rules)
+  def repeat(timestring, options = {}, &rules)
+    @repeats << ::Maid::Repeat.new(self, timestring, options, &rules)
   end
 
   # Daemonizes the process by starting all watches and repeats and joining

data/lib/maid/repeat.rb

@@ -4,17 +4,18 @@ class Maid::Repeat
   
   attr_reader :timestring, :scheduler, :logger
   
-  def initialize(maid, timestring, &rules)
+  def initialize(maid, timestring, options = {}, &rules)
     @maid = maid
     @logger = maid.logger # TODO: Maybe it's better to create seperate loggers?
     @scheduler = Rufus::Scheduler.singleton
     @timestring = timestring
+    @options = options
     initialize_rules(&rules)
   end
 
   def run
     unless rules.empty?
-      @scheduler.repeat(timestring) { follow_rules }
+      @scheduler.repeat(timestring, @options) { follow_rules }
     end
   end
   

data/lib/maid/rules.sample.rb

@@ -40,7 +40,7 @@ Maid.rules do
 
   rule 'Mac OS X applications in zip files' do
     found = dir('~/Downloads/*.zip').select { |path|
-      zipfile_contents(path).any? { |c| c.match(/\.app$/) }
+      zipfile_contents(path).any? { |c| c.match(/\.app\/Contents\//) }
     }
 
     trash(found)

data/lib/maid/tools.rb

@@ -3,7 +3,7 @@ require 'find'
 require 'fileutils'
 require 'time'
 
-require 'exifr'
+require 'exifr/jpeg'
 require 'geocoder'
 require 'mime/types'
 require 'dimensions'
@@ -39,16 +39,16 @@ module Maid::Tools
   #     move(['~/Downloads/foo.zip', '~/Downloads/bar.zip'], '~/Archive/Software/Mac OS X/')
   #     move(dir('~/Downloads/*.zip'), '~/Archive/Software/Mac OS X/')
   def move(sources, destination)
-    destination = expand(destination)
+    expanded_destination = expand(destination)
 
-    if File.directory?(destination)
+    if File.directory?(expanded_destination)
       expand_all(sources).each do |source|
-        log("move #{ sh_escape(source) } #{ sh_escape(destination) }")
-        FileUtils.mv(source, destination, @file_options)
+        log("move #{ sh_escape(source) } #{ sh_escape(expanded_destination) }")
+        FileUtils.mv(source, expanded_destination, @file_options)
       end
     else
       # Unix `mv` warns about the target not being a directory with multiple sources.  Maid checks the same.
-      warn("skipping move because #{ sh_escape(destination) } is not a directory (use 'mkdir' to create first, or use 'rename')")
+      warn("skipping move because #{ sh_escape(expanded_destination) } is not a directory (use 'mkdir' to create first, or use 'rename')")
     end
   end
 
@@ -456,7 +456,7 @@ module Maid::Tools
       gps = EXIFR::JPEG.new(path).gps
       coordinates_string = [gps.latitude, gps.longitude]
       location = Geocoder.search(coordinates_string).first
-      [location.city, location.province, location.country_code].join(', ')
+      [location.city, location.province, location.country_code.upcase].join(', ')
     end
   end
 

data/lib/maid/version.rb

@@ -1,4 +1,4 @@
 module Maid
-  VERSION = '0.8.0.alpha.4'
+  VERSION = '0.9.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/maid.gemspec

@@ -15,43 +15,44 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = 'maid'
 
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.7.0'
 
   # 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', '< 1.0.0')
+  s.add_dependency('thor', '~> 1.2.1')
   s.add_dependency('deprecated', '~> 3.0.0')
   s.add_dependency('dimensions', '>= 1.0.0', '< 2.0')
-  s.add_dependency('mime-types', '~> 2.0')
-  s.add_dependency('rubyzip', '~> 1.1.0')
+  s.add_dependency('mime-types', '~> 3.0', '< 4.0')
+  s.add_dependency('rubyzip', '~> 2.3.2')
   s.add_dependency('xdg', '~> 2.2.3') # previous versions had bugs
-  s.add_dependency('listen', '>= 2.8.0', '< 3.1.0')
-  s.add_dependency('rufus-scheduler', '>= 3.0.6', '< 3.2.0')
-  s.add_dependency('exifr', '~> 1.2.0')
-  s.add_dependency('geocoder', '~> 1.2.0')
-  
+  s.add_dependency('listen', '~> 3.8.0')
+  s.add_dependency('rufus-scheduler', '~> 3.8.2')
+  s.add_dependency('exifr', '~> 1.3.10')
+  s.add_dependency('geocoder', '~> 1.8.1')
+
   # TODO: use one of these two gems instead of `mdfind`.  **But** They have to work on Linux as well.
   #
   #     s.add_dependency('mac-spotlight', '~> 0.0.4')
   #     s.add_dependency('spotlight', '~> 0.0.6')
 
   # Strategy: specific versions (since they're just for development)
-  s.add_development_dependency('fakefs', '~> 0.4.3')
+  s.add_development_dependency('fakefs', '~> 2.4.0')
   s.add_development_dependency('guard', '~> 2.12.5')
   s.add_development_dependency('guard-rspec', '~> 4.6.2')
-  s.add_development_dependency('rake', '~> 10.4.2')
-  s.add_development_dependency('redcarpet', '~> 3.3.2') # Soft dependency of `yard`
-  s.add_development_dependency('rspec', '~> 3.3.0')
-  s.add_development_dependency('timecop', '~> 0.7.0')
-  s.add_development_dependency('yard', '~> 0.8.4')
+  s.add_development_dependency('rake', '~> 13.0.6')
+  s.add_development_dependency('redcarpet', '~> 3.6.0') # Soft dependency of `yard`
+  s.add_development_dependency('rspec', '~> 3.12.0')
+  s.add_development_dependency('timecop', '~> 0.9.6')
+  s.add_development_dependency('yard', '>= 0.9.11')
+  s.add_development_dependency('pry-byebug')
 
   # 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.9.0')
-  s.add_development_dependency('rb-fsevent', '~> 0.9.2')
+  s.add_development_dependency('rb-inotify', '~> 0.10.1')
+  s.add_development_dependency('rb-fsevent', '~> 0.11.2')
 
   s.files         = `git ls-files -z`.split("\0")
   s.test_files    = `git ls-files -z -- {test,spec,features}/*`.split("\0")

data/script/vagrant-test-all

@@ -28,7 +28,7 @@
 # * [Vagrant Boxes List](http://www.vagrantbox.es/)
 # * [Contributing Guide](https://github.com/benjaminoakes/maid/wiki/Contributing)
 
-MAID_TARGET_BOX='precise32' MAID_TARGET_RUBY='1.9.3' script/vagrant-test
-MAID_TARGET_BOX='precise64' MAID_TARGET_RUBY='1.9.3' script/vagrant-test
+MAID_TARGET_BOX='hashicorp/precise32' MAID_TARGET_RUBY='1.9.3' script/vagrant-test
+MAID_TARGET_BOX='hashicorp/precise64' MAID_TARGET_RUBY='1.9.3' script/vagrant-test
 # TODO: Locate and add box for `saucy32`
 # TODO: Locate and add box for `saucy64`

data/spec/dependency_spec.rb

@@ -1,5 +1,5 @@
 require 'dimensions'
-require 'exifr'
+require 'exifr/jpeg'
 require 'logger'
 require 'geocoder'
 require 'mime/types'

data/spec/lib/maid/app_spec.rb

@@ -1,25 +1,26 @@
 require 'spec_helper'
 require 'stringio'
 
+def capture_stdout
+  out = StringIO.new
+  $stdout = out
+  yield
+  out.string
+ensure
+  $stdout = STDOUT
+end
+
+def capture_stderr
+  out = StringIO.new
+  $stderr = out
+  yield
+  out.string
+ensure
+  $stderr = STDERR
+end
+
 module Maid
   describe App, '#clean' do
-    def capture_stdout
-      out = StringIO.new
-      $stdout = out
-      yield
-      out.string
-    ensure
-      $stdout = STDOUT
-    end
-
-    def capture_stderr
-      out = StringIO.new
-      $stderr = out
-      yield
-      out.string
-    ensure
-      $stderr = STDERR
-    end
 
     before do
       @app = App.new
@@ -124,4 +125,53 @@ module Maid
       expect(opts[:rules_path]).to match(/maid_rules.rb$/)
     end
   end
+
+  describe App, '#logs' do
+    before do
+      @maid = double('Maid')
+      @maid.stub(:clean)
+      @maid.stub(:log_device) { '/var/log/maid.log' }
+      @maid.stub(:load_rules)
+      Maid.stub(:new) { @maid }
+    end
+
+    describe 'prints out the log' do
+      before do
+        @log = "A maid log\nAnother log"
+        @log_file = Tempfile.new('maid.log')
+        @log_file.write(@log)
+        @log_file.close
+
+        @maid.stub(:log_device) { @log_file.path }
+      end
+
+      after do
+        @log_file.unlink if !@log_file.nil?
+      end
+
+      it 'dumps the last log entries when invoked without an option' do
+        expect(capture_stdout { App.start(['logs']) }).to eq("#{@log}\n")
+      end
+
+      it 'prints an error when log does not exist' do
+        @maid.stub(:log_device) { '/maid/file-does-not-exist' }
+        message = "Log file #{@maid.log_device} does not exist.\n"
+
+        expect(capture_stderr { App.start(['logs']) }).to eq(message)
+      end
+
+      it 'does not tail when log does not exist' do
+        @maid.stub(:log_device) { '/maid/file-does-not-exist' }
+        message = "Log file #{@maid.log_device} does not exist.\n"
+
+        expect(capture_stderr { App.start(['logs', '--tail']) }).to eq(message)
+      end
+    end
+
+    it 'prints out the log path' do
+      ['--path', '-p'].each do |option|
+        expect(capture_stdout { App.start(['logs', option]) }).to eq("/var/log/maid.log\n")
+      end
+    end
+  end
 end

data/spec/lib/maid/maid_spec.rb

@@ -231,6 +231,21 @@ module Maid
         expect(@maid.repeats.length).to eq(1)
         expect(@maid.repeats.first.timestring).to eq('1s')
       end
+
+      it 'accepts a hash of options and passes them to Rufus' do
+        scheduler = double('scheduler')
+        expect(Rufus::Scheduler).to receive(:singleton).and_return(scheduler)
+
+        hash = { :some => :options }
+        @maid.repeat('1s', hash) do
+          rule 'test' do
+          end
+        end
+
+        expect(scheduler).to receive(:repeat).with('1s', hash)
+
+        @maid.repeats.last.run
+      end
     end
 
     describe '#follow_rules' do