maid 0.10.0.pre.alpha.3 → 0.11.0

data/lib/maid/maid.rb

@@ -1,5 +1,4 @@
 require 'fileutils'
-require 'logger'
 require 'xdg'
 
 # Maid cleans up according to the given rules, logging what it does.
@@ -9,13 +8,8 @@ require 'xdg'
 class Maid::Maid
   include Maid::RuleContainer
   DEFAULTS = {
-    progname: 'Maid',
-
     log_device: File.expand_path('~/.maid/maid.log'),
-    # We don't want the log files to grow without check, but 50 MB doesn't seem
-    # too bad.  (We're going with a larger size just for safety right now.)
-    log_shift_age: 5,
-    log_shift_size: 10 * 1_048_576, # 10 * 1 MB
+    logger: ::Maid::Logger,
 
     rules_path: File.expand_path('~/.maid/rules.rb'),
     file_options: { noop: false }, # for `FileUtils`
@@ -34,17 +28,7 @@ class Maid::Maid
   def initialize(options = {})
     options = DEFAULTS.merge(options.reject { |_k, v| v.nil? })
 
-    # TODO: Refactor and simplify (see also https://github.com/benjaminoakes/maid/pull/48#discussion_r1683942)
-    @logger = if options[:logger]
-                options[:logger]
-              else
-                @log_device = options[:log_device]
-                FileUtils.mkdir_p(File.dirname(@log_device)) unless @log_device.is_a?(IO)
-                @logger = Logger.new(@log_device, options[:log_shift_age], options[:log_shift_size])
-              end
-
-    @logger.progname  = options[:progname]
-    @logger.formatter = options[:log_formatter] if options[:log_formatter]
+    @logger = options[:logger].new(device: options[:log_device])
 
     @rules_path   = options[:rules_path]
     @trash_path   = options[:trash_path] || default_trash_path
@@ -87,7 +71,7 @@ class Maid::Maid
     warn e.message
   end
 
-  def watch(path, options = {}, &block)
+  def watch(path, options = {}, &)
     full_path = File.expand_path(path)
 
     unless File.directory?(full_path)
@@ -97,11 +81,11 @@ class Maid::Maid
       raise message
     end
 
-    @watches << ::Maid::Watch.new(self, path, options, &block)
+    @watches << ::Maid::Watch.new(self, path, options, &)
   end
 
-  def repeat(timestring, options = {}, &block)
-    @repeats << ::Maid::Repeat.new(self, timestring, options, &block)
+  def repeat(timestring, options = {}, &)
+    @repeats << ::Maid::Repeat.new(self, timestring, options, &)
   end
 
   # Daemonizes the process by starting all watches and repeats and joining

data/lib/maid/repeat.rb

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

data/lib/maid/rule.rb

@@ -1,6 +1,6 @@
 class Maid::Rule < Struct.new(:description, :instructions, :maid)
   # Follow the instructions of the rule.
-  def follow(*args)
-    maid.instance_exec(*args, &instructions)
+  def follow(*)
+    maid.instance_exec(*, &instructions)
   end
 end

data/lib/maid/rule_container.rb

@@ -3,9 +3,9 @@ module Maid::RuleContainer
   attr_reader :rules
 
   # initialize_rules
-  def initialize_rules(&block)
+  def initialize_rules(&)
     @rules ||= []
-    instance_exec(&block)
+    instance_exec(&)
   end
 
   # Register a rule with a description and instructions (lambda function).

data/lib/maid/tools.rb

@@ -328,7 +328,7 @@ module Maid::Tools
   def mkdir(path, options = {})
     path = expand(path)
     log("mkdir -p #{sh_escape(path)}")
-    FileUtils.mkdir_p(path, **@file_options.merge(options))
+    FileUtils.mkdir_p(path, **@file_options, **options)
     path
   end
 
@@ -727,7 +727,7 @@ module Maid::Tools
   #     where_content_type(dir('~/Downloads/*'), 'public.image')
   def where_content_type(paths, filter_types)
     filter_types = Array(filter_types)
-    Array(paths).select { |p| !(filter_types & content_types(p)).empty? }
+    Array(paths).select { |p| filter_types.intersect?(content_types(p)) }
   end
 
   # Test whether a directory is either empty, or contains only empty
@@ -739,7 +739,7 @@ module Maid::Tools
   #       trash('~/Downloads/foo')
   #     end
   def tree_empty?(root)
-    return nil if File.file?(root)
+    return false if File.file?(root)
     return true if Dir.glob(root + '/*').length == 0
 
     ignore = []

data/lib/maid/trash_migration.rb

@@ -20,6 +20,8 @@ module Maid
       end
 
       def perform
+        # FIXME: This is tightly coupled, we can't pass a custom log device
+        # etc.
         maid = ::Maid::Maid.new(trash_path: correct_trash)
         # Use local variable so it's available in the closure used by `instance_eval`
         path = incorrect_trash

data/lib/maid/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Maid
-  VERSION = '0.10.0-alpha.3'
+  VERSION = '0.11.0'
   SUMMARY = 'Be lazy. Let Maid clean up after you, based on rules you define. ' \
             'Think of it as "Hazel for hackers".'
 end

data/lib/maid/watch.rb

@@ -5,7 +5,7 @@ class Maid::Watch
 
   attr_reader :path, :listener, :logger
 
-  def initialize(maid, path, options = {}, &block)
+  def initialize(maid, path, options = {}, &)
     @maid = maid
 
     if options.nil? || options.empty?
@@ -19,7 +19,7 @@ class Maid::Watch
 
     @logger = maid.logger # TODO: Maybe it's better to create seperate loggers?
     @path = File.expand_path(path)
-    initialize_rules(&block)
+    initialize_rules(&)
   end
 
   def run

data/lib/maid.rb

@@ -4,6 +4,7 @@ Deprecated.set_action(:warn)
 
 # Must be in this order:
 require 'maid/version'
+require 'maid/logger/logger'
 require 'maid/downloading'
 require 'maid/tools'
 require 'maid/rule_container'
@@ -32,8 +33,8 @@ module Maid
     end
 
     # Define rules for the Maid instance.
-    def rules(&block)
-      @instance.instance_exec(&block)
+    def rules(&)
+      @instance.instance_exec(&)
     end
   end
 end

data/maid.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = 'maid'
 
-  s.required_ruby_version = '>= 2.7.0'
+  s.required_ruby_version = '>= 3.2.0'
 
   # Strategy: if possible, use ranges (so there are fewer chances of version conflicts)
   s.add_dependency('deprecated', '~> 3.0.0')
@@ -46,21 +46,26 @@ Gem::Specification.new do |s|
 
   # Strategy: specific versions (since they're just for development)
   s.add_development_dependency('fakefs', '~> 2.4.0')
-  s.add_development_dependency('fuubar')
+  s.add_development_dependency('fuubar', '~> 2.5.1')
   s.add_development_dependency('guard', '~> 2.18.0')
   s.add_development_dependency('guard-bundler', '~> 3.0.1')
   s.add_development_dependency('guard-rspec', '~> 4.7.3')
-  s.add_development_dependency('guard-rubocop')
-  s.add_development_dependency('pry-byebug')
+  s.add_development_dependency('guard-rubocop', '~> 1.5.0')
+  s.add_development_dependency('irb', '~> 1.15.1')
+  s.add_development_dependency('ostruct', '~> 0.6.1')
+  s.add_development_dependency('pry-byebug', '~> 3.10.1')
   s.add_development_dependency('rake', '~> 13.0.6')
-  s.add_development_dependency('rake-notes')
+  s.add_development_dependency('rake-notes', '~> 0.2.2')
   s.add_development_dependency('redcarpet', '~> 3.6.0') # Soft dependency of `yard`
+  s.add_development_dependency('reline', '~> 0.6.0')
   s.add_development_dependency('rspec', '~> 3.12.0')
-  s.add_development_dependency('rubocop')
-  s.add_development_dependency('rubocop-rake')
-  s.add_development_dependency('rubocop-rspec')
-  s.add_development_dependency('simplecov')
+  s.add_development_dependency('rubocop', '~> 1.50')
+  s.add_development_dependency('rubocop-rake', '~> 0.6.0')
+  s.add_development_dependency('rubocop-rspec', '~> 3.5.0')
+  s.add_development_dependency('simplecov', '~> 0.22.0')
   s.add_development_dependency('timecop', '~> 0.9.6')
+  s.add_development_dependency('vcr', '~> 6.1.0')
+  s.add_development_dependency('webmock', '~> 3.18.1')
   s.add_development_dependency('yard', '>= 0.9.11')
 
   # In Vagrant, polling won't cross over the OS boundary if you develop in the host OS but run your tests in the

data/release-please-config.json

@@ -0,0 +1,18 @@
+{
+  "always-update": true,
+  "bootstrap-sha": "d4901ad446c8a614ef80472ed5e6f1ba8c702ed5",
+  "bump-minor-pre-major": true,
+  "bump-patch-for-minor-pre-major": true,
+  "commit-search-depth": 500,
+  "group-pull-request-title-pattern": "chore: release ${version}",
+  "release-search-depth": 400,
+  "release-type": "ruby",
+  "sequential-calls": false,
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "package-name": "maid",
+      "version-file": "lib/maid/version.rb"
+    }
+  }
+}

data/script/docker-test

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+# Run RSpec in a docker container, to avoid mistakenly writing to the live
+# filesystem while developing.
+docker rm -f maid-dev
+docker build -t maid-dev .
+docker run -it --rm --name maid-dev --mount type=bind,src="$(pwd)",target=/usr/src/app maid-dev

data/spec/dependency_spec.rb

@@ -95,7 +95,7 @@ describe 'Dependency expectations' do
     end
   end
 
-  describe Geocoder do
+  describe Geocoder, vcr: { record: :new_episodes } do
     it 'translates latitude and longitude into street addresses' do
       city = Geocoder.search('-33.85608611111111,151.219925').map { |location| location.city }.uniq.compact
       expect(city).to eq(['Sydney'])

data/spec/fakefs_helper.rb

@@ -0,0 +1,13 @@
+# FakeFS is missing #flock, see https://github.com/fakefs/fakefs/issues/433 and
+# https://github.com/whitesmith/rubycritic/commit/57edc6244a9ebea8078a9c1dba32204ee7d1d895
+
+# NOTE: This avoid NotImplementedError on File.flock, but causes a myriad of
+# other issues since it doesn't really provide any locking in practice.
+# If required, include this file in spec_helper.rb to monkey-patch FakeFS.
+module FakeFS
+  class File < StringIO
+    def flock(*)
+      true
+    end
+  end
+end

data/spec/lib/maid/logger/logger_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'maid/logger/logger'
+
+module Maid
+  # FakeFS not required because we're writing the log to /tmp/ and deleting it
+  # after the test.
+  describe Logger do
+    let(:logfile) { '/tmp/maid/test.log' }
+    let(:logger) { described_class.new(device: logfile) }
+
+    after { FileUtils.rm('/tmp/maid/test.log', force: true) }
+
+    levels = %i[debug info warn error fatal unknown]
+    levels.each do |level|
+      it "responds to #{level}" do
+        expect(logger).to respond_to(level)
+      end
+    end
+
+    context 'with a filename' do
+      before { logger.info('test message') }
+
+      it 'creates that file' do
+        expect(File.exist?(logfile)).to be true
+      end
+
+      it 'sets the default progname' do
+        expect(File.read(logfile)).to match(/Maid: /)
+      end
+
+      context 'with the ::Logger::DEBUG log level' do
+        let(:logger) { described_class.new(device: logfile, level: ::Logger::DEBUG) }
+
+        levels.each do |level|
+          it "logs #{level} messages" do
+            logger.send(level, "#{level} test message")
+
+            expect(File.read(logfile)).to match("#{level} test message")
+          end
+        end
+      end
+
+      it 'works with a string' do
+        logger.info('test message')
+
+        expect(File.read(logfile)).to match 'test message'
+      end
+
+      it 'works with a custom progname and a block' do
+        logger.info('TestProgname') { 'test message' }
+
+        expect(File.read(logfile)).to match 'TestProgname: test message'
+      end
+    end
+
+    context 'with an IO' do
+      let(:logger) { described_class.new(device: StringIO.new) }
+
+      it 'is happy' do
+        expect { logger.info('test message') }.not_to raise_error
+      end
+    end
+  end
+end