filewatcher 2.0.0.beta4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e9ecdeee0c20df3055e1078a67e8194040361fbcea9f1c633f2b33a8177f250
-  data.tar.gz: ba5abe65b765b0cc4c4630aae0cf1e0751c7ea4dec5f39911a9de9510fff7e9e
+  metadata.gz: 59a457d937b483f6b936e5741df3ac777ef58fe43983c36de2fc00f9475e3e32
+  data.tar.gz: aca66c67a07d0d596afa06af04984a42f2d2fe83a6353bf84f11b34199e8379a
 SHA512:
-  metadata.gz: 287d42ea2fb239be62a4a0701f5b84440c409b6dc93c3b8caf5a5c8c87958ab12f4885e146e679f988dc2d2ef9c7d47d77be79ce4b8dd6d0ea97d71d63de9116
-  data.tar.gz: 2a296164258b091771802bbeb7d33690160e235220d30644743abe441d7801259dcad5bcd4216655c1e57549b9052edb45f1b1440a23ba1d84e4981f278a4e90
+  metadata.gz: 384400d7f817cd4d403b977a9f7a52eca5b331a217829c013c42227d468e673f462b8072fae057ca60bf0048a9505994278aab0449f41620172ea97f443ef141
+  data.tar.gz: 17f903b43e2fd857d2b6b2f48bb81a51ebc175bb631089fda561ed082c29dda38e945ef9c6bbd21825310de9690f63021fc4c0bdce1aff132ce97d5323124871

data/lib/filewatcher/snapshot.rb

@@ -30,30 +30,53 @@ class Filewatcher
 
     # Class for one file from snapshot
     class SnapshotFile
-      STATS = %i[mtime].freeze
+      class << self
+        def stats
+          @stats ||= populate_stats %i[mtime]
+        end
+
+        def populate_stats(stats)
+          defined?(super) ? super(stats) : stats
+        end
+
+        def subtractions
+          @subtractions ||= populate_subtractions(
+            created: ->(other) { other.nil? },
+            updated: ->(other) { mtime && mtime > other.mtime }
+          )
+        end
 
-      attr_reader(*STATS)
+        def populate_subtractions(hash)
+          hash = super(hash) if defined?(super)
+          hash
+        end
+      end
+
+      attr_reader :mtime
 
       def initialize(filename)
         @filename = filename
-        STATS.each do |stat|
+        self.class.stats.each do |stat|
           time = File.public_send(stat, filename) if File.exist?(filename)
           instance_variable_set :"@#{stat}", time || Time.new(0)
         end
       end
 
       def -(other)
-        if other.nil?
-          :created
-        elsif other.mtime < mtime
-          :updated
-        end
+        self.class.subtractions.find do |_event, block|
+          instance_exec(other, &block)
+        end&.first
       end
 
       def inspect
+        stats_string =
+          self.class.stats
+            .map { |stat| "#{stat}=#{public_send(stat)&.strftime('%F %T.%9N')&.inspect}" }
+            .join(', ')
+
         <<~OUTPUT
           #<Filewatcher::Snapshot::SnapshotFile:#{object_id}
-            @filename=#{@filename.inspect}, mtime=#{mtime.strftime('%F %T.%9N').inspect}
+            @filename=#{@filename.inspect}, #{stats_string}
           >
         OUTPUT
       end

data/{spec → lib/filewatcher}/spec_helper/ruby_watch_run.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+require_relative 'watch_run'
+
 class Filewatcher
   module SpecHelper
-    class RubyWatchRun < WatchRun
+    ## Ruby API watcher for specs
+    class RubyWatchRun
+      include WatchRun
+
       attr_reader :filewatcher, :thread, :watched, :processed
 
       def initialize(filewatcher:, **args)

data/lib/filewatcher/spec_helper/watch_run.rb

@@ -1,32 +1,24 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-
 class Filewatcher
   module SpecHelper
-    ## Base class for Filewatcher runners in specs
-    class WatchRun
-      extend Forwardable
+    ## Base module for Filewatcher runners in specs
+    module WatchRun
+      include Filewatcher::SpecHelper
 
       TMP_DIR = "#{Dir.getwd}/spec/tmp"
 
-      def_delegators Filewatcher::SpecHelper, :debug, :wait, :system_stat
-
       attr_reader :filename
 
-      def initialize(filename:, action:, directory:)
-        @filename =
-          if filename.match? %r{^(/|~|[A-Z]:)} then filename
-          else File.join(TMP_DIR, filename)
-          end
-        @directory = directory
+      def initialize(filename:, action:)
+        @filename = filename.match?(%r{^(/|~|[A-Z]:)}) ? filename : File.join(TMP_DIR, filename)
         @action = action
         debug "action = #{action}"
       end
 
       def start
         debug 'start'
-        File.write(@filename, 'content1') unless @action == :create
+        File.write(@filename, 'content1') unless %i[create create_dir].include? @action
 
         wait seconds: 1
       end
@@ -50,19 +42,26 @@ class Filewatcher
 
       private
 
+      create_update_action = lambda do
+        ## There is no `File.write` because of strange difference in parallel `File.mtime`
+        ## https://cirrus-ci.com/task/6107605053472768?command=test#L497-L511
+        system "echo 'content2' > #{@filename}"
+        debug_file_mtime
+      end.freeze
+
+      ACTIONS = {
+        create: create_update_action,
+        update: create_update_action,
+        create_dir: -> { FileUtils.mkdir_p(@filename) },
+        delete: -> { FileUtils.remove(@filename) }
+      }.freeze
+
       def make_changes
         debug "make changes, @action = #{@action}, @filename = #{@filename}"
 
-        if @action == :delete
-          FileUtils.remove(@filename)
-        elsif @directory
-          FileUtils.mkdir_p(@filename)
-        else
-          ## There is no `File.write` because of strange difference in parallel `File.mtime`
-          ## https://cirrus-ci.com/task/6107605053472768?command=test#L497-L511
-          system "echo 'content2' > #{@filename}"
-          debug_file_mtime
-        end
+        action = self.class::ACTIONS.fetch(@action) { raise "Unknown action `#{@action}`" }
+
+        instance_exec(&action)
 
         wait seconds: 1
       end

data/lib/filewatcher/spec_helper.rb

@@ -9,22 +9,23 @@ rescue LoadError
 end
 
 require_relative 'spec_helper/watch_run'
+require_relative 'spec_helper/ruby_watch_run'
 
 class Filewatcher
   ## Helper for common spec features between plugins
   module SpecHelper
-    module_function
+    ENVIRONMENT_SPECS_COEFFICIENTS = {
+      -> { ENV.fetch('CI', false) } => 1,
+      -> { RUBY_PLATFORM == 'java' } => 1,
+      -> { Gem::Platform.local.os == 'darwin' } => 1
+    }.freeze
 
     def logger
       @logger ||= Logger.new($stdout, level: :debug)
     end
 
     def environment_specs_coefficients
-      @environment_specs_coefficients ||= {
-        -> { ENV['CI'] } => 1,
-        -> { RUBY_PLATFORM == 'java' } => 1,
-        -> { Gem::Platform.local.os == 'darwin' } => 1
-      }
+      ENVIRONMENT_SPECS_COEFFICIENTS
     end
 
     def wait(seconds: 1, interval: 1, &block)
@@ -62,7 +63,7 @@ class Filewatcher
 
     def system_stat(filename)
       case (host_os = RbConfig::CONFIG['host_os'])
-      when 'linux'
+      when /linux(-gnu)?/
         `stat --printf 'Modification: %y, Change: %z\n' #{filename}`
       when /darwin\d*/
         `stat #{filename}`
@@ -80,5 +81,10 @@ class Filewatcher
       # debug command
       `#{command}`
     end
+
+    ## https://github.com/rubocop/ruby-style-guide/issues/556#issuecomment-828672008
+    # rubocop:disable Style/ModuleFunction
+    extend self
+    # rubocop:enable Style/ModuleFunction
   end
 end

data/lib/filewatcher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Filewatcher
-  VERSION = '2.0.0.beta4'
+  VERSION = '2.0.0'
 end

data/spec/filewatcher_spec.rb

@@ -28,7 +28,6 @@ describe Filewatcher do
 
   let(:filename) { 'tmp_file.txt' }
   let(:action) { :update }
-  let(:directory) { false }
   ## TODO: Check its needless
   let(:every) { false }
   let(:immediate) { false }
@@ -41,8 +40,7 @@ describe Filewatcher do
 
   let(:watch_run) do
     Filewatcher::SpecHelper::RubyWatchRun.new(
-      filename: filename, filewatcher: filewatcher, action: action,
-      directory: directory
+      filename: filename, filewatcher: filewatcher, action: action
     )
   end
 
@@ -146,52 +144,59 @@ describe Filewatcher do
   end
 
   describe '#watch' do
-    before do
-      FileUtils.mkdir_p subdirectory if defined? subdirectory
+    context 'when action is known' do
+      before do
+        FileUtils.mkdir_p subdirectory if defined? subdirectory
 
-      watch_run.run
-    end
+        watch_run.run
+      end
 
-    describe 'detecting file deletions' do
-      let(:action) { :delete }
+      context 'when there are file deletions' do
+        let(:action) { :delete }
 
-      it { is_expected.to eq [{ watch_run.filename => :deleted }] }
-    end
+        it { is_expected.to eq [{ watch_run.filename => :deleted }] }
+      end
 
-    context 'when there are file additions' do
-      let(:action) { :create }
+      context 'when there are file additions' do
+        let(:action) { :create }
 
-      it { is_expected.to eq [{ watch_run.filename => :created }] }
-    end
+        it { is_expected.to eq [{ watch_run.filename => :created }] }
+      end
 
-    context 'when there are file updates' do
-      let(:action) { :update }
+      context 'when there are file updates' do
+        let(:action) { :update }
 
-      it { is_expected.to eq [{ watch_run.filename => :updated }] }
-    end
+        it { is_expected.to eq [{ watch_run.filename => :updated }] }
+      end
+
+      context 'when there are new files in subdirectories' do
+        let(:subdirectory) { File.expand_path('spec/tmp/new_sub_directory') }
 
-    context 'when there are new files in subdirectories' do
-      let(:subdirectory) { File.expand_path('spec/tmp/new_sub_directory') }
+        let(:filename) { File.join(subdirectory, 'file.txt') }
+        let(:action) { :create }
+        let(:every) { true }
+        ## https://github.com/filewatcher/filewatcher/pull/115#issuecomment-674581595
+        let(:interval) { 0.4 }
+
+        it do
+          expect(processed).to eq [
+            { subdirectory => :updated, watch_run.filename => :created }
+          ]
+        end
+      end
 
-      let(:filename) { File.join(subdirectory, 'file.txt') }
-      let(:action) { :create }
-      let(:every) { true }
-      ## https://github.com/filewatcher/filewatcher/pull/115#issuecomment-674581595
-      let(:interval) { 0.4 }
+      context 'when there are new subdirectories' do
+        let(:filename) { 'new_sub_directory' }
+        let(:action) { :create_dir }
 
-      it do
-        expect(processed).to eq [
-          { subdirectory => :updated, watch_run.filename => :created }
-        ]
+        it { is_expected.to eq [{ watch_run.filename => :created }] }
       end
     end
 
-    context 'when there are new subdirectories' do
-      let(:filename) { 'new_sub_directory' }
-      let(:directory) { true }
-      let(:action) { :create }
+    context 'when action is unknown' do
+      let(:action) { :foo }
 
-      it { is_expected.to eq [{ watch_run.filename => :created }] }
+      specify { expect { watch_run.run }.to raise_error(RuntimeError, 'Unknown action `foo`') }
     end
   end
 

data/spec/spec_helper.rb

@@ -10,8 +10,6 @@ end
 
 require_relative '../lib/filewatcher/spec_helper'
 
-require_relative 'spec_helper/ruby_watch_run'
-
 ## For case when required from dumpers
 if Object.const_defined?(:RSpec)
   RSpec::Matchers.define :include_all_files do |expected|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filewatcher
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta4
+  version: 2.0.0
 platform: ruby
 authors:
 - Thomas Flemming
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,56 +31,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: gem_toys
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.12.1
 - !ruby/object:Gem::Dependency
   name: toys
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.4
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.4
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -101,14 +101,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.36.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.36.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -150,17 +150,18 @@ files:
 - lib/filewatcher/snapshot.rb
 - lib/filewatcher/snapshots.rb
 - lib/filewatcher/spec_helper.rb
+- lib/filewatcher/spec_helper/ruby_watch_run.rb
 - lib/filewatcher/spec_helper/watch_run.rb
 - lib/filewatcher/version.rb
 - spec/filewatcher/snapshot_spec.rb
 - spec/filewatcher/version_spec.rb
 - spec/filewatcher_spec.rb
 - spec/spec_helper.rb
-- spec/spec_helper/ruby_watch_run.rb
 homepage: http://github.com/filewatcher/filewatcher
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -169,17 +170,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Lightweight filewatcher.