filewatcher 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59a457d937b483f6b936e5741df3ac777ef58fe43983c36de2fc00f9475e3e32
-  data.tar.gz: aca66c67a07d0d596afa06af04984a42f2d2fe83a6353bf84f11b34199e8379a
+  metadata.gz: f152abad4db37d701c171c006aa348be75d484a57b5dad570fdb7f9fa9f8e613
+  data.tar.gz: 3ac3b63272cee0295bac2eaefbf131a0933aeea5d0749d61cd8b3d214786a2ee
 SHA512:
-  metadata.gz: 384400d7f817cd4d403b977a9f7a52eca5b331a217829c013c42227d468e673f462b8072fae057ca60bf0048a9505994278aab0449f41620172ea97f443ef141
-  data.tar.gz: 17f903b43e2fd857d2b6b2f48bb81a51ebc175bb631089fda561ed082c29dda38e945ef9c6bbd21825310de9690f63021fc4c0bdce1aff132ce97d5323124871
+  metadata.gz: 944582ed2ecdc9ccd42d562be7ea38a8a242bef6e9798b14d1b93f900926c7ceb0014afabbe39ea41af4d398fd5331ccc378bcb5d0d910aecbe68af60d4b0226
+  data.tar.gz: f772e16b48e71a6e0dfc433cb9b50286e742c753dfc7564fe6eaf367d17b03542e3377acd4943fe5ae440d6079053de5b964f5e6224d5f5ff9124925e1dc9af5

data/lib/filewatcher/spec_helper/watch_run.rb

@@ -1,24 +1,55 @@
 # frozen_string_literal: true
 
+require 'module_methods'
+
 class Filewatcher
   module SpecHelper
     ## Base module for Filewatcher runners in specs
     module WatchRun
+      extend ::ModuleMethods::Extension
+
       include Filewatcher::SpecHelper
 
-      TMP_DIR = "#{Dir.getwd}/spec/tmp"
+      TMP_DIR = 'spec/tmp'
+      ## It's requried to split modifying files from result files like CLI dumpers
+      TMP_FILES_DIR = "#{TMP_DIR}/files"
+
+      attr_reader :initial_files
+
+      ## Class methods for this and inherited modules
+      module ClassMethods
+        def transform_spec_files(file)
+          tmp_files_dir = File.join(Dir.getwd, TMP_FILES_DIR)
+
+          return tmp_files_dir if file.to_s.empty?
+
+          return file if file.match?(%r{^(/|~|[A-Z]:)})
+
+          File.join(tmp_files_dir, file)
+        end
+      end
+
+      def initialize(initial_files:, changes:)
+        @initial_files = initial_files.transform_keys { |key| self.class.transform_spec_files(key) }
 
-      attr_reader :filename
+        @changes = changes
 
-      def initialize(filename:, action:)
-        @filename = filename.match?(%r{^(/|~|[A-Z]:)}) ? filename : File.join(TMP_DIR, filename)
-        @action = action
-        debug "action = #{action}"
+        debug "changes = #{@changes}"
       end
 
       def start
         debug 'start'
-        File.write(@filename, 'content1') unless %i[create create_dir].include? @action
+
+        FileUtils.mkdir_p self.class::TMP_FILES_DIR
+
+        initial_files.each do |initial_file_path, initial_file_data|
+          File.write(
+            File.expand_path(initial_file_path),
+            initial_file_data.fetch(:content, 'content1')
+          )
+        end
+
+        debug "start initial_files = #{initial_files}"
 
         wait seconds: 1
       end
@@ -37,38 +68,50 @@ class Filewatcher
 
       def stop
         debug 'stop'
-        FileUtils.rm_r(@filename) if File.exist?(@filename)
+        FileUtils.rm_r(self.class::TMP_FILES_DIR) if File.exist?(self.class::TMP_FILES_DIR)
       end
 
       private
 
-      create_update_action = lambda do
+      create_update_action = lambda do |change_file, change_data|
+        new_content = change_data.fetch(:content, 'content2')
+
+        FileUtils.mkdir_p File.dirname(change_file)
+
         ## 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
+        system "echo '#{new_content}' > #{change_file}"
+
+        debug_file_mtime(change_file)
       end.freeze
 
-      ACTIONS = {
+      CHANGES = {
         create: create_update_action,
         update: create_update_action,
-        create_dir: -> { FileUtils.mkdir_p(@filename) },
-        delete: -> { FileUtils.remove(@filename) }
+        create_dir: ->(change_file, *_args) { FileUtils.mkdir_p(change_file) },
+        delete: ->(change_file, *_args) { FileUtils.remove(change_file) }
       }.freeze
 
       def make_changes
-        debug "make changes, @action = #{@action}, @filename = #{@filename}"
+        @changes.each do |change_file, change_data|
+          debug "make changes, change_file = #{change_file}, change_data = #{change_data}"
 
-        action = self.class::ACTIONS.fetch(@action) { raise "Unknown action `#{@action}`" }
+          change_event = change_data.fetch(:event, :update)
+          change_event = :create_dir if change_event == :create && change_data[:directory]
 
-        instance_exec(&action)
+          change_block =
+            self.class::CHANGES.fetch(change_event) { raise "Unknown change `#{change_event}`" }
+
+          instance_exec(change_file, change_data, &change_block)
+        end
 
         wait seconds: 1
       end
 
-      def debug_file_mtime
-        debug "stat #{@filename}: #{system_stat(@filename)}"
-        debug "File.mtime = #{File.mtime(@filename).strftime('%F %T.%9N')}"
+      def debug_file_mtime(file)
+        file = File.expand_path file
+        debug "stat #{file}: #{system_stat(file)}"
+        debug "File.mtime = #{File.mtime(file).strftime('%F %T.%9N')}"
       end
     end
   end

data/lib/filewatcher/version.rb

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

data/spec/examples.txt

@@ -0,0 +1,28 @@
+example_id                                 | status | run_time        |
+------------------------------------------ | ------ | --------------- |
+./spec/filewatcher/snapshot_spec.rb[1:1:1] | passed | 0.00075 seconds |
+./spec/filewatcher/snapshot_spec.rb[1:2:1] | passed | 1 second        |
+./spec/filewatcher/version_spec.rb[1:1]    | passed | 0.00079 seconds |
+./spec/filewatcher_spec.rb[1:1:1]          | passed | 0.01153 seconds |
+./spec/filewatcher_spec.rb[1:2:1:1:1]      | passed | 6.02 seconds    |
+./spec/filewatcher_spec.rb[1:2:1:2:1]      | passed | 5.01 seconds    |
+./spec/filewatcher_spec.rb[1:2:1:3:1]      | passed | 5.01 seconds    |
+./spec/filewatcher_spec.rb[1:2:1:4:1]      | passed | 5.01 seconds    |
+./spec/filewatcher_spec.rb[1:2:1:5:1]      | passed | 5.01 seconds    |
+./spec/filewatcher_spec.rb[1:2:1:6:1]      | passed | 5.02 seconds    |
+./spec/filewatcher_spec.rb[1:2:1:7:1]      | passed | 5.02 seconds    |
+./spec/filewatcher_spec.rb[1:2:2:1:1]      | passed | 2 seconds       |
+./spec/filewatcher_spec.rb[1:2:2:1:2:1]    | passed | 2 seconds       |
+./spec/filewatcher_spec.rb[1:2:2:2:1]      | passed | 2 seconds       |
+./spec/filewatcher_spec.rb[1:2:2:2:2:1]    | passed | 2 seconds       |
+./spec/filewatcher_spec.rb[1:3:1:1:1]      | passed | 5.01 seconds    |
+./spec/filewatcher_spec.rb[1:3:1:2:1]      | passed | 5.02 seconds    |
+./spec/filewatcher_spec.rb[1:3:1:3:1]      | passed | 5.01 seconds    |
+./spec/filewatcher_spec.rb[1:3:1:4:1]      | passed | 5.01 seconds    |
+./spec/filewatcher_spec.rb[1:3:1:5:1]      | passed | 5.01 seconds    |
+./spec/filewatcher_spec.rb[1:3:2:1]        | passed | 2.01 seconds    |
+./spec/filewatcher_spec.rb[1:4:1]          | passed | 2 seconds       |
+./spec/filewatcher_spec.rb[1:5:1]          | passed | 7.21 seconds    |
+./spec/filewatcher_spec.rb[1:6:1:1]        | passed | 7.41 seconds    |
+./spec/filewatcher_spec.rb[1:6:2:1]        | passed | 11.41 seconds   |
+./spec/filewatcher_spec.rb[1:7:1]          | passed | 6.01 seconds    |

data/spec/filewatcher_spec.rb

@@ -6,13 +6,9 @@ require_relative '../lib/filewatcher'
 describe Filewatcher do
   subject(:processed) { watch_run.processed }
 
-  before do
-    FileUtils.mkdir_p tmp_dir
-  end
-
   after do
     logger.debug "FileUtils.rm_r #{tmp_dir}"
-    FileUtils.rm_r tmp_dir
+    FileUtils.rm_r tmp_dir if File.exist?(tmp_dir)
 
     Filewatcher::SpecHelper.wait seconds: 5, interval: 0.2 do
       !File.exist?(tmp_dir)
@@ -23,24 +19,46 @@ describe Filewatcher do
     described_class.new(path, options.merge(logger: logger))
   end
 
-  let(:tmp_dir) { Filewatcher::SpecHelper::WatchRun::TMP_DIR }
+  def transform_spec_files(file)
+    ruby_watch_run_class.transform_spec_files(file)
+  end
+
+  let(:ruby_watch_run_class) { Filewatcher::SpecHelper::RubyWatchRun }
+
+  let(:tmp_dir) { ruby_watch_run_class::TMP_DIR }
+  let(:tmp_files_dir) { ruby_watch_run_class::TMP_FILES_DIR }
   let(:logger) { Filewatcher::SpecHelper.logger }
 
-  let(:filename) { 'tmp_file.txt' }
-  let(:action) { :update }
+  let(:raw_file_name) { 'tmp_file.txt' }
+  let(:initial_files) { { raw_file_name => {} } }
+
+  let(:change_event) { :update }
+  let(:change_directory) { false }
+
+  let(:changes) do
+    files = Array(initial_files.keys)
+    files << raw_file_name if files.empty?
+    files.to_h do |file|
+      [transform_spec_files(file), { event: change_event, directory: change_directory }]
+    end
+  end
+
+  let(:result_transformed_filename) do
+    transform_spec_files(initial_files.any? ? initial_files.keys.first : raw_file_name)
+  end
+
   ## TODO: Check its needless
   let(:every) { false }
   let(:immediate) { false }
   let(:interval) { 0.2 }
+  let(:filewatcher_files) { File.expand_path("#{tmp_files_dir}/**/*") }
   let(:filewatcher) do
-    initialize_filewatcher(
-      File.join(tmp_dir, '**', '*'), interval: interval, every: every, immediate: immediate
-    )
+    initialize_filewatcher filewatcher_files, interval: interval, every: every, immediate: immediate
   end
 
   let(:watch_run) do
-    Filewatcher::SpecHelper::RubyWatchRun.new(
-      filename: filename, filewatcher: filewatcher, action: action
+    ruby_watch_run_class.new(
+      initial_files: initial_files, filewatcher: filewatcher, changes: changes
     )
   end
 
@@ -66,8 +84,8 @@ describe Filewatcher do
       context 'with excluding selected file patterns' do
         let(:filewatcher) do
           initialize_filewatcher(
-            File.expand_path('spec/tmp/**/*'),
-            exclude: File.expand_path('spec/tmp/**/*.txt')
+            filewatcher_files,
+            exclude: File.expand_path("#{tmp_files_dir}/**/*.txt")
           )
         end
 
@@ -75,39 +93,79 @@ describe Filewatcher do
       end
 
       context 'with absolute paths including globs' do
-        let(:filewatcher) do
-          initialize_filewatcher(
-            File.expand_path('spec/tmp/**/*')
-          )
-        end
+        let(:filewatcher_files) { File.expand_path("#{tmp_files_dir}/**/*") }
 
-        it { is_expected.to eq [{ watch_run.filename => :updated }] }
+        it { is_expected.to eq [{ result_transformed_filename => :updated }] }
       end
 
       context 'with globs' do
-        let(:filewatcher) { initialize_filewatcher('spec/tmp/**/*') }
+        let(:filewatcher_files) { "#{tmp_files_dir}/**/*" }
 
-        it { is_expected.to eq [{ watch_run.filename => :updated }] }
+        it { is_expected.to eq [{ result_transformed_filename => :updated }] }
       end
 
       context 'with explicit relative paths with globs' do
-        let(:filewatcher) { initialize_filewatcher('./spec/tmp/**/*') }
+        let(:filewatcher_files) { "./#{tmp_files_dir}/**/*" }
 
-        it { is_expected.to eq [{ watch_run.filename => :updated }] }
+        it { is_expected.to eq [{ result_transformed_filename => :updated }] }
       end
 
       context 'with explicit relative paths' do
-        let(:filewatcher) { initialize_filewatcher('./spec/tmp') }
+        let(:filewatcher_files) { "./#{tmp_files_dir}" }
 
-        it { is_expected.to eq [{ watch_run.filename => :updated }] }
+        it { is_expected.to eq [{ result_transformed_filename => :updated }] }
       end
 
       context 'with tilde expansion' do
-        let(:filename) { File.expand_path('~/file_watcher_1.txt') }
+        let(:filewatcher_files) { '~/file_watcher_1.txt' }
+        let(:raw_file_name) { File.expand_path('~/file_watcher_1.txt') }
+
+        it { is_expected.to eq [{ raw_file_name => :updated }] }
+      end
+
+      context 'with Array of paths' do
+        let(:file_1) { 'tmp_file_1.txt' }
+        let(:subdir) { 'subdir' }
+        let(:file_2) { "#{subdir}/tmp_file_2.txt" }
 
-        let(:filewatcher) { initialize_filewatcher('~/file_watcher_1.txt') }
+        let(:filewatcher_files) { ["#{tmp_files_dir}/#{file_1}", "#{tmp_files_dir}/#{subdir}"] }
+
+        let(:initial_files) do
+          {
+            file_1 => {}
+          }
+        end
+
+        let(:changes) do
+          initial_files.to_h { |key, _value| [transform_spec_files(key), { event: :update }] }
+            .merge(
+              transform_spec_files(file_2) => { event: :create }
+            )
+        end
 
-        it { is_expected.to eq [{ filename => :updated }] }
+        let(:expected_changes) do
+          [
+            initial_files.to_h { |key, _value| [transform_spec_files(key), :updated] }
+              .merge(
+                expected_file_2_change
+              )
+          ]
+        end
+
+        let(:expected_file_2_change) do
+          {
+            transform_spec_files(file_2) => :created
+          }
+        end
+
+        specify do
+          ## For case when changes detected separately, in CI for example, probably just slowly
+          expect(processed).to eq(expected_changes)
+            .or contain_exactly(
+              *initial_files.map { |key, _value| { transform_spec_files(key) => :updated } },
+              expected_file_2_change
+            )
+        end
       end
     end
 
@@ -152,51 +210,56 @@ describe Filewatcher do
       end
 
       context 'when there are file deletions' do
-        let(:action) { :delete }
+        let(:change_event) { :delete }
 
-        it { is_expected.to eq [{ watch_run.filename => :deleted }] }
+        it { is_expected.to eq [{ result_transformed_filename => :deleted }] }
       end
 
       context 'when there are file additions' do
-        let(:action) { :create }
+        let(:initial_files) { {} }
+        let(:changes) { { result_transformed_filename => { event: :create } } }
 
-        it { is_expected.to eq [{ watch_run.filename => :created }] }
+        it { is_expected.to eq [{ result_transformed_filename => :created }] }
       end
 
       context 'when there are file updates' do
-        let(:action) { :update }
+        let(:change_event) { :update }
 
-        it { is_expected.to eq [{ watch_run.filename => :updated }] }
+        it { is_expected.to eq [{ result_transformed_filename => :updated }] }
       end
 
       context 'when there are new files in subdirectories' do
-        let(:subdirectory) { File.expand_path('spec/tmp/new_sub_directory') }
+        let(:subdirectory) { File.expand_path("#{tmp_files_dir}/new_sub_directory") }
+
+        let(:initial_files) { {} }
+        let(:created_filename) { File.join(subdirectory, 'file.txt') }
+        let(:changes) { { created_filename => { event: :create } } }
 
-        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 }
+            { subdirectory => :updated, created_filename => :created }
           ]
         end
       end
 
       context 'when there are new subdirectories' do
-        let(:filename) { 'new_sub_directory' }
-        let(:action) { :create_dir }
+        let(:initial_files) { {} }
+        let(:raw_file_name) { 'new_sub_directory' }
+        let(:change_event) { :create }
+        let(:change_directory) { true }
 
-        it { is_expected.to eq [{ watch_run.filename => :created }] }
+        it { is_expected.to eq [{ result_transformed_filename => :created }] }
       end
     end
 
     context 'when action is unknown' do
-      let(:action) { :foo }
+      let(:change_event) { :foo }
 
-      specify { expect { watch_run.run }.to raise_error(RuntimeError, 'Unknown action `foo`') }
+      specify { expect { watch_run.run }.to raise_error(RuntimeError, 'Unknown change `foo`') }
     end
   end
 
@@ -214,11 +277,10 @@ describe Filewatcher do
   def write_tmp_files(range)
     logger.debug "#{__method__} #{range}"
 
-    directory = 'spec/tmp'
-    FileUtils.mkdir_p directory
+    FileUtils.mkdir_p tmp_files_dir
 
     range.to_a.map do |n|
-      File.write(file = "#{directory}/file#{n}.txt", "content#{n}")
+      File.write(file = "#{tmp_files_dir}/file#{n}.txt", "content#{n}")
 
       Filewatcher::SpecHelper.wait seconds: 1
 

data/spec/spec_helper.rb

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
 require 'simplecov'
-SimpleCov.start
 
-if ENV['CODECOV_TOKEN']
-  require 'codecov'
-  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+if ENV['CI']
+  require 'simplecov-cobertura'
+  SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
 end
 
+SimpleCov.start
+
 require_relative '../lib/filewatcher/spec_helper'
 
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = "#{__dir__}/examples.txt"
+end
+
 ## 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
+  version: 2.1.0
 platform: ruby
 authors:
 - Thomas Flemming
@@ -9,8 +9,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-11-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: module_methods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -59,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.2
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -95,20 +109,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.39.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.39.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +195,7 @@ files:
 - lib/filewatcher/spec_helper/ruby_watch_run.rb
 - lib/filewatcher/spec_helper/watch_run.rb
 - lib/filewatcher/version.rb
+- spec/examples.txt
 - spec/filewatcher/snapshot_spec.rb
 - spec/filewatcher/version_spec.rb
 - spec/filewatcher_spec.rb
@@ -180,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
 summary: Lightweight filewatcher.