maid 0.10.0.pre.alpha.2 → 0.10.0.pre.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8d0fa40b9069dd973a12021c729407e1f98719ea96e8ede17aff4426cd8d9eb
-  data.tar.gz: ed334d76e2cdc9ba723e600a6f371efab241ea24c080e7009425dee9a99d52f4
+  metadata.gz: 0be19c0367daaad7154c2649987ff99d97702a964ca2c6af5331fd876da16d7a
+  data.tar.gz: cb3598e65e48db7529b0584c041eb3f87fdbf66b57030d83f2ac981251de74a3
 SHA512:
-  metadata.gz: 4be4e2a2771566d670b9b7a5d5966c334e3ca58c7c204dab7182654821b47b6076dc2ceb0e880de1a2e6966f110fee7422d289ffa058c9ba6861287afd2f60be
-  data.tar.gz: 124d6e7f02282b4772b4a849acfad62efdc3277c08ea0696cd32b57672e199104bf314e53b609c47960e026b2073f4aba55d441de5061600fa9f499f9e90ceae
+  metadata.gz: d887908840f3369f2250226d888563444431f95cd662a50cdaddde49b0883bfb82958788516e9dc56d5329a8eefbdf470c761c1645d004cba2193c050bab60c2
+  data.tar.gz: a6349bb2e1d6e1b7dbd8358c7cf7e5f1955f2ae873d5b3286212c955e3ae11bb3ab743f3291f25c633bbda571caa0f0e90364a151f150789c2c8020698ab84ab

data/.github/workflows/release.yml

@@ -39,7 +39,7 @@ jobs:
           # Uncomment for pre-releases, see
           # https://github.com/maid/maid/wiki/Release-Process
           prerelease: true
-          release-as: v0.10.0-alpha.2
+          release-as: v0.10.0-alpha.3
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.10.0-alpha.2"
+  ".": "0.10.0-alpha.3"
 }

data/.rubocop_todo.yml

@@ -66,7 +66,7 @@ Metrics/MethodLength:
 # Offense count: 4
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 711
+  Max: 753
 
 # Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns.

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.10.0-alpha.3](https://github.com/maid/maid/compare/v0.10.0-alpha.2...v0.10.0-alpha.3) (2023-04-04)
+
+
+### Features
+
+* **maid:** improve `#watch` error message ([#287](https://github.com/maid/maid/issues/287)) ([0894cd6](https://github.com/maid/maid/commit/0894cd69665d5d9fe775b6b3df5a247f22f217d6))
+* **tools:** add option to disable clobbering destination for `#move` ([#284](https://github.com/maid/maid/issues/284)) ([979413f](https://github.com/maid/maid/commit/979413fe284b61b43b33ba2169e72ed23043bcca))
+
 ## [0.10.0-alpha.2](https://github.com/maid/maid/compare/v0.10.0-alpha.1...v0.10.0-alpha.2) (2023-03-28)
 
 

data/Rakefile

@@ -2,6 +2,7 @@ require 'bundler'
 require 'rake'
 require 'rspec/core/rake_task'
 require 'yard'
+require 'rake/notes/rake_task'
 
 task default: :spec
 

data/lib/maid/maid.rb

@@ -88,6 +88,15 @@ class Maid::Maid
   end
 
   def watch(path, options = {}, &block)
+    full_path = File.expand_path(path)
+
+    unless File.directory?(full_path)
+      message = "#{full_path} cannot be a file and it must exist in order to watch it"
+
+      warn(message)
+      raise message
+    end
+
     @watches << ::Maid::Watch.new(self, path, options, &block)
   end
 
@@ -140,7 +149,7 @@ class Maid::Maid
   def default_trash_path
     # TODO: Refactor module declaration so this can be `Platform`
     if Maid::Platform.linux?
-      # See the [FreeDesktop.org Trash specification](http://www.ramendik.ru/docs/trashspec.html)
+      # See the [FreeDesktop.org Trash specification](https://archive.is/cXir4)
       path = "#{XDG['DATA_HOME']}/Trash/files"
     elsif Maid::Platform.osx?
       path = File.expand_path('~/.Trash')

data/lib/maid/tools.rb

@@ -24,33 +24,50 @@ module Maid::Tools
   # For showing deprecation notices
   include Deprecated
 
-  # Move `sources` to a `destination` directory.
+  # Moves `sources` file(s) to a `destination` directory.
   #
   # Movement is only allowed to directories that already exist.  If your
   # intention is to rename, see the `rename` method.
   #
-  # ## Examples
-  #
-  # 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/')
-  def move(sources, destination)
-    expanded_destination = expand(destination)
-
-    if File.directory?(expanded_destination)
+  # @example Single source file
+  #   move('~/Downloads/foo.zip', '~/Archive/Software/Mac OS X/')
+  #
+  # @example Multiple source files
+  #   move(['~/Downloads/foo.zip', '~/Downloads/bar.zip'],
+  #   '~/Archive/Software/Mac OS X/')
+  #   move(dir('~/Downloads/*.zip'), '~/Archive/Software/Mac OS X/')
+  #
+  # @example Overwrite destination file if it already exists
+  #   move('~/Downloads/foo.zip', '~/Archive/Software/Mac OS X/')
+  #   move('~/Downloads/foo.zip', '~/Archive/Software/Mac OS X/', clobber:
+  #   true)
+  #
+  # @example Skip file if it already exists at destination
+  #   move('~/Downloads/foo.zip', '~/Archive/Software/Mac OS X/', clobber:
+  #   false)
+  #
+  # @param sources [String, Array<String>] the paths to the source files to
+  # move
+  # @param destination_dir [String] path of the directory where to move
+  # `sources` to
+  # @param [Hash] kwargs the arguments to modify behaviour
+  # @option kwargs [Boolean] :clobber (true) `true` to overwrite destination
+  # file if it exists, `false` to skip moving file if it exists
+  def move(sources, destination_dir, clobber: true)
+    expanded_destination_dir = expand(destination_dir)
+
+    if File.directory?(expanded_destination_dir)
       expand_all(sources).each do |source|
-        log("move #{sh_escape(source)} #{sh_escape(expanded_destination)}")
-        FileUtils.mv(source, expanded_destination, **@file_options)
+        log("move #{sh_escape(source)} #{sh_escape(expanded_destination_dir)}")
+
+        unless skip_move?(source, expanded_destination_dir, clobber)
+          FileUtils.mv(source, expanded_destination_dir, **@file_options)
+        end
       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(expanded_destination)} is not a" \
-           "directory (use 'mkdir' to create first, or use 'rename')")
+      warn("skipping move because #{sh_escape(expanded_destination_dir)} " \
+           "is not a directory (use 'mkdir' to create first, or use 'rename')")
     end
   end
 
@@ -1006,4 +1023,29 @@ module Maid::Tools
       []
     end
   end
+
+  # Predicate to tell whether the file should be skipped when moving.
+  # @param source_path [String] the path to the source file
+  # @param destination_dir [String] the path to the destination directory
+  # @param clobber [Boolean] `true` to overwrite existing destination file,
+  # `false` otherwise
+  # @return [Boolean] whether to skip the move
+  def skip_move?(source_path, destination_dir, clobber)
+    destination_path = File.join(destination_dir, File.basename(source_path))
+
+    # if the destination file doesn't exist, we can move.
+    return false unless File.exist?(destination_path)
+
+    log("#{destination_path} already exists")
+
+    # figure out whether to overwrite the existing destination file.
+    if clobber
+      log("clobbering enabled, moving #{File.basename(source_path)} anyway")
+
+      return false
+    end
+    log("clobbering disabled, skipping move for #{File.basename(source_path)}")
+
+    true
+  end
 end

data/lib/maid/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Maid
-  VERSION = '0.10.0-alpha.2'
+  VERSION = '0.10.0-alpha.3'
   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

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Benjamin Oakes', 'Coaxial']
   s.email       = ['hello@benjaminoakes.com', 'c+rubygems@64b.it']
-  s.license     = 'GPLv2'
+  s.license     = 'GPL-2.0'
   s.homepage    = 'http://github.com/maid/maid'
   s.summary     = Maid::SUMMARY
   s.description = s.summary
@@ -53,6 +53,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('guard-rubocop')
   s.add_development_dependency('pry-byebug')
   s.add_development_dependency('rake', '~> 13.0.6')
+  s.add_development_dependency('rake-notes')
   s.add_development_dependency('redcarpet', '~> 3.6.0') # Soft dependency of `yard`
   s.add_development_dependency('rspec', '~> 3.12.0')
   s.add_development_dependency('rubocop')

data/spec/lib/maid/maid_spec.rb

@@ -1,12 +1,11 @@
 require 'spec_helper'
 
 module Maid
-  describe Maid do
+  describe Maid, fakefs: true do
     let(:logger) { instance_spy('Logger') }
 
     before do
       allow(Logger).to receive(:new).and_return(logger)
-      allow(FileUtils).to receive(:mkdir_p)
     end
 
     describe '.new' do
@@ -33,8 +32,11 @@ module Maid
       end
 
       it 'makes the log directory in case it does not exist' do
-        expect(FileUtils).to receive(:mkdir_p).with('/home/username/log')
+        expect(File.exist?('/home/username/log')).to be false
+
         Maid.new(log_device: '/home/username/log/maid.log')
+
+        expect(File.exist?('/home/username/log')).to be true
       end
 
       it 'takes a logger object during intialization' do
@@ -58,8 +60,9 @@ module Maid
 
           it 'set the trash to the correct default path' do
             trash_path = "#{@home}/.local/share/Trash/files/"
-            expect(FileUtils).to receive(:mkdir_p).with(trash_path).once
+
             maid = Maid.new
+
             expect(maid.trash_path).to eq(trash_path)
           end
         end
@@ -71,7 +74,7 @@ module Maid
 
           it 'sets the trash to the correct default path' do
             trash_path = "#{@home}/.Trash/"
-            expect(FileUtils).to receive(:mkdir_p).with(trash_path).once
+
             maid = Maid.new
             expect(maid.trash_path).to eq(trash_path)
           end
@@ -86,8 +89,9 @@ module Maid
 
       it 'sets the trash to the given path, if provided' do
         trash_path = '/home/username/tmp/my_trash/'
-        expect(FileUtils).to receive(:mkdir_p).with(trash_path).once
+
         maid = Maid.new(trash_path: trash_path)
+
         expect(maid.trash_path).not_to be_nil
         expect(maid.trash_path).to eq(trash_path)
       end
@@ -198,6 +202,7 @@ module Maid
       before do
         allow(Listen).to receive(:to)
         allow(Listen).to receive(:start)
+        FileUtils.mkdir_p('watch_dir')
         @maid = Maid.new
       end
 
@@ -215,6 +220,8 @@ module Maid
       # FIXME: Example is too long, shouldn't need the rubocop::disable
       it 'accepts a hash of options and passes them to Listen' do # rubocop:disable RSpec/ExampleLength
         hash = { some: :options }
+        FileUtils.mkdir_p('some_dir')
+
         @maid.watch('some_dir', hash) do
           rule 'test' do
           end
@@ -232,9 +239,29 @@ module Maid
 
         @maid.watches.last.run
       end
+
+      context('with a non-existent directory') do
+        let(:maid) { Maid.new }
+
+        it 'raises with an intelligible message' do
+          expect { maid.watch('/doesnt_exist/') }.to raise_error(/file.*exist/)
+        end
+
+        it 'logs an intelligible message' do
+          begin
+            maid.watch('/doesnt_exist')
+            # Suppressing the exception is fine, because we just want to test
+            # that the message is logged when it throws and the test above
+            # checks that the exception is raised.
+          rescue StandardError # rubocop:disable Lint/SuppressedException
+          end
+
+          expect(logger).to have_received(:warn).with(/file.*exist/)
+        end
+      end
     end
 
-    describe '#repeat' do
+    describe '#repeat', fake_zoneinfo: true do
       before do
         @maid = Maid.new
       end

data/spec/lib/maid/tools_spec.rb

@@ -73,6 +73,59 @@ module Maid
           @maid.move([@src_file, another_file], @dst_dir)
         end
       end
+
+      context 'when the destination file already exists' do
+        let(:src_file) { '/tmp/src/test_file' }
+        let(:dst_dir) { '/tmp/dest/' }
+        let(:dst_file) { File.join(dst_dir, File.basename(src_file)) }
+        let(:maid) { Maid.new(logger: @logger) }
+
+        before do
+          FileUtils.mkdir_p(File.dirname(src_file))
+          FileUtils.mkdir_p(dst_dir)
+          FileUtils.touch(src_file)
+          FileUtils.touch(dst_file)
+        end
+
+        after do
+          FileUtils.rm_rf([src_file, dst_file])
+        end
+
+        context 'by default' do
+          let!(:original_mtime) { File.stat(dst_file).mtime }
+
+          before do
+            maid.move(src_file, dst_dir)
+          end
+
+          it 'logs an info message' do
+            expect(@logger).to have_received(:info).with(/already/)
+            expect(@logger).to have_received(:info).with(/anyway/)
+            expect(@logger).not_to have_received(:info).with(/skipping/)
+          end
+
+          it 'overwrites destination' do
+            expect(File.stat(dst_file).mtime).not_to eq(original_mtime)
+          end
+        end
+
+        context 'when clobber: false' do
+          let!(:original_mtime) { File.stat(dst_file).mtime }
+
+          before do
+            maid.move(src_file, dst_dir, clobber: false)
+          end
+
+          it 'logs an info message' do
+            expect(@logger).not_to have_received(:info).with(/anyway/)
+            expect(@logger).to have_received(:info).with(/skipping/)
+          end
+
+          it "doesn't overwrite the destination file" do
+            expect(File.stat(dst_file).mtime).to eq(original_mtime)
+          end
+        end
+      end
     end
 
     describe '#rename' do

data/spec/spec_helper.rb

@@ -25,6 +25,39 @@ RSpec.configure do |config|
   end
   config.include(FakeFS::SpecHelpers, fakefs: true)
   config.raise_errors_for_deprecations!
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  # NOTE: If a test fails because ENOENT /usr/share/zoneinfo/Africa/Abidjan,
+  # add `fake_zoneinfo: true` to the describe:
+  # `describe(MyClass, fake_zoneinfo: true do`
+  config.before(:context, fake_zoneinfo: true) do
+    # Rufus needs zoneinfo data to run, but when using FakeFS,
+    # /usr/share/zoneinfo doesn't exist on the FakeFS.
+    # On Linux, we just have to FakeFS::FileSystem.clone the directory and it
+    # just works.
+    # OSX is, of course, special. /usr/share/zoneinfo is a symlink on that
+    # platform, and `.clone` doesn't seem to be following symlinks. Instead, we
+    # have to copy the zoneinfo data to a temporary directory on the live
+    # filesystem, enable the FakeFS, clone that temporary directory, create
+    # /usr/share/zoneinfo onto the FakeFS, and finally copy the files into it.
+    # This way, they're available in the FakeFS where Rufus can find them.
+    include FakeFS::SpecHelpers
+    FakeFS.activate!
+
+    if Maid::Platform.osx?
+      FakeFS.deactivate!
+      FileUtils.mkdir_p('/tmp/')
+      FileUtils.cp_r('/usr/share/zoneinfo/', '/tmp/')
+      FakeFS.activate!
+      FakeFS::FileSystem.clone('/tmp/zoneinfo/')
+      FileUtils.mkdir_p('/usr/share/')
+      FileUtils.cp_r('/tmp/zoneinfo/', '/usr/share/')
+    end
+
+    FakeFS::FileSystem.clone('/usr/share/zoneinfo') if Maid::Platform.linux?
+  end
 end
 
 RSpec::Matchers.define :have_deprecated_method do |expected|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maid
 version: !ruby/object:Gem::Version
-  version: 0.10.0.pre.alpha.2
+  version: 0.10.0.pre.alpha.3
 platform: ruby
 authors:
 - Benjamin Oakes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-31 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deprecated
@@ -295,6 +295,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rake-notes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -518,7 +532,7 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/maid/maid
 licenses:
-- GPLv2
+- GPL-2.0
 metadata:
   bug_tracker_uri: https://github.com/maid/maid/issues
   changelog_uri: https://github.com/maid/maid/blob/master/CHANGELOG.md
@@ -542,7 +556,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Be lazy. Let Maid clean up after you, based on rules you define. Think of