filewatcher 0.5.4 → 2.0.0.beta1

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start
+
+if ENV['CODECOV_TOKEN']
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+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|
+    match do |actual|
+      expected.all? { |file| actual.include? File.expand_path(file) }
+    end
+  end
+end

data/spec/spec_helper/ruby_watch_run.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class Filewatcher
+  module SpecHelper
+    class RubyWatchRun < WatchRun
+      attr_reader :filewatcher, :thread, :watched, :processed
+
+      def initialize(filewatcher:, **args)
+        super(**args)
+        @filewatcher = filewatcher
+
+        @mutex = Mutex.new
+      end
+
+      def start
+        super
+        @thread = thread_initialize
+        # thread needs a chance to start
+        wait seconds: 1
+        wait do
+          keep_watching = filewatcher.keep_watching
+          debug "keep_watching = #{keep_watching}"
+          keep_watching
+        end
+      end
+
+      def stop
+        thread.exit
+
+        wait do
+          thread.stop?
+        end
+
+        super
+      end
+
+      def wait(seconds: 1)
+        super seconds: seconds, interval: filewatcher.interval
+      end
+
+      private
+
+      def make_changes
+        super
+
+        # Some OS, file systems and Ruby interpretators
+        # doesn't catch milliseconds of `File.mtime`
+        wait do
+          @mutex.synchronize do
+            debug "processed = #{processed}"
+            debug "processed.any? = #{processed.any?}"
+            processed.any?
+          end
+        end
+      end
+
+      def thread_initialize
+        @watched ||= 0
+        @processed = []
+        Thread.new { setup_filewatcher }
+      end
+
+      def setup_filewatcher
+        debug 'setup_filewatcher'
+        debug filewatcher.inspect
+        filewatcher.watch do |changes|
+          debug filewatcher.inspect
+          @mutex.synchronize do
+            debug "watch callback: changes = #{changes.inspect}"
+            increment_watched
+            @processed.push(changes)
+            # debug 'pushed to processed'
+          end
+        end
+      end
+
+      def increment_watched
+        @watched += 1
+      end
+    end
+  end
+end

metadata

@@ -1,106 +1,156 @@
 --- !ruby/object:Gem::Specification
 name: filewatcher
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 2.0.0.beta1
 platform: ruby
 authors:
 - Thomas Flemming
-autorequire: 
+- Alexander Popov
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-27 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: trollop
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.91.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.91.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: bacon
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.43'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-description: Detect changes in filesystem. Works anywhere.
+        version: '1.43'
+description: Detect changes in file system. Works anywhere.
 email:
 - thomas.flemming@gmail.com
-executables:
-- filewatcher
+- alex.wayfer@gmail.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
-- README.md
-- Rakefile
-- bin/filewatcher
 - lib/filewatcher.rb
-- test/fixtures/file1.txt
-- test/fixtures/file2.txt
-- test/fixtures/file3.rb
-- test/fixtures/file4.rb
-- test/fixtures/subdir/file5.rb
-- test/fixtures/subdir/file6.rb
-- test/test_filewatcher.rb
-homepage: http://github.com/thomasfl/filewatcher
+- lib/filewatcher/cycles.rb
+- lib/filewatcher/snapshot.rb
+- lib/filewatcher/snapshots.rb
+- lib/filewatcher/spec_helper.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: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
-summary: Lighweight filewatcher.
-test_files:
-- test/fixtures/file1.txt
-- test/fixtures/file2.txt
-- test/fixtures/file3.rb
-- test/fixtures/file4.rb
-- test/fixtures/subdir/file5.rb
-- test/fixtures/subdir/file6.rb
-- test/test_filewatcher.rb
+summary: Lightweight filewatcher.
+test_files: []

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2009 - 2014 Thomas Flemming
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,269 +0,0 @@
-Filewatcher
-===========
-
-[![Gem Version](https://badge.fury.io/rb/filewatcher.svg)](http://badge.fury.io/rb/filewatcher)
-[![Build Status](https://secure.travis-ci.org/thomasfl/filewatcher.png?branch=master)](http://travis-ci.org/thomasfl/filewatcher)
-[![Dependency Status](https://gemnasium.com/thomasfl/filewatcher.png?travis)](https://gemnasium.com/thomasfl/filewatcher)
-[![Code Climate](https://codeclimate.com/github/thomasfl/filewatcher.png)](https://codeclimate.com/github/thomasfl/filewatcher)
-
-Lightweight filewatcher weighing less than 200 LoC. No dependencies or platform specific code. Works everywhere. Monitors changes in the filesystem by polling. Has no config files. When running filewatcher from the command line, you specify which files to monitor and what action to perform on updates.
-
-For example to search recursively for javascript files and run jshint when a file is updated, added, renamed or deleted:
-
-Linux/OSX:
-
-    $ filewatcher '**/*.js' 'jshint $FILENAME'
-
-In Windows:
-
-    > filewatcher "**/*.js" "jshint %FILENAME%"
-
-Install
--------
-
-Needs Ruby and Rubygems:
-
-    $ [sudo] gem install filewatcher
-
-Command line utility
---------------------
-
-Filewatcher scans the filesystem and execute shell commands when files are
-updated, added, renamed or deleted.
-
-    Usage:
-        filewatcher [--restart][--list][--dontwait] "<filename>" "<shell command>"
-
-    Where
-        filename: filename(s) to scan.
-        shell command: shell command to execute when a file is changed
-
-Examples
---------
-
-Run the echo command when the file myfile is changed:
-
-    $ filewatcher "myfile" "echo 'myfile has changed'"
-
-Run any javascript in the current directory when it is updated in Windows
-Powershell:
-
-    > filewatcher *.js "node %FILENAME%"
-
-In Linux/OSX:
-
-    $ filewatcher *.js 'node $FILENAME'
-
-Place filenames or filenames in quotes to use ruby filename globbing instead
-of shell filename globbing. This will make filewatcher look for files in
-subdirectories too. To watch all javascript files in subdirectories in Windows:
-
-    > filewatcher "**/*.js" "node %FILENAME%"
-
-In Linux/OSX:
-
-    > filewatcher '**/*.js' 'node $FILENAME'
-
-Try to run the updated file as a script when it is updated by using the
---exec/-e option. Works with files with file extensions that looks like a
-python, ruby, perl, php, javascript or awk script.
-
-    $ filewatcher -e *.rb
-
-Print a list of all files matching *.css first and then output the filename
-when a file is beeing updated by using the --list/-l option:
-
-    $ filewatcher -l '**/*.css' 'echo file: $FILENAME'
-
-Watch the "src" and "test" folders recursively, and run test when the
-filesystem gets updated:
-
-    $ filewatcher "src test" "ruby test/test_suite.rb"
-
-Restart long running commands
------------------------------
-
-The `--restart` option kills the command if it's still running when a filesystem change happens. Can be used to restart locally running webservers on updates, or kill long running tests and restart on updates. This option often makes filewatcher faster in general. To not wait for tests to finish:
-
-    $ filewatcher --restart "**/*.rb" "rake test"
-
-The `--dontwait` option starts the command on startup without waiting for filesystem updates. To start a webserver and have it automatically restart when html files are updated:
-
-    $ filewatcher --restart --dontwait "**/*.html" "python -m SimpleHTTPServer"
-
-Available enviroment variables
-------------------------------
-
-The environment variable $FILENAME is available in the shell command argument.
-On unix like systems the command has to be enclosed in single quotes. To run
-node whenever a javascript file is updated:
-
-    $ filewatcher *.js 'node $FILENAME'
-
-Environment variables available from the command string:
-
-    BASENAME           File basename.
-    FILENAME           Relative filename.
-    ABSOLUTE_FILENAME  Asolute filename.
-    RELATIVE_FILENAME  Same as FILENAME but starts with "./"
-    EVENT              Event type. Is either 'changed', 'delete' or 'new'.
-    DIRNAME            Absolute directory name.
-
-Command line options
---------------------
-
-Useful command line options:
-
-            --list, -l:   Print name of matching files on startup
-         --restart, -r:   Run command in separate fork and kill it on filesystem updates
-        --dontwait, -d:   Run the command before any filesystem updates
-         --spinner, -s:   Display an animated spinner while scanning
-
-Other command line options:
-
-         --version, -v:   Print version and exit
-            --help, -h:   Show this message
-    --interval, -i <f>:   Interval in seconds to scan filesystem. Defaults to 0.5 seconds.
-            --exec, -e:   Execute file as a script when file is updated
-     --include, -n <s>:   Include files (default: *)
-     --exclude, -x <s>:   Exclude file(s) matching (default: "")
-
-Ruby API
---------
-
-Watch a list of files and directories:
-
-    require 'filewatcher'
-
-    FileWatcher.new(["lib/", "Rakefile"]).watch do |filename|
-      puts "Changed " + filename
-    end
-
-Watch a single directory, for changes in all files and subdirectories:
-
-    FileWatcher.new("lib/").watch do |filename|
-      ...
-    end
-
-Notice that the previous is equivalent to the following:
-
-    FileWatcher.new("lib/**/*").watch do |filename|
-      ...
-    end
-
-Watch files and dirs in the given directory - and not in subdirectories:
-
-    FileWatcher.new("lib/*").watch do |filename|
-      ...
-    end
-
-Watch an absolute directory:
-
-    FileWatcher.new("/tmp/foo").watch do |filename|
-      ...
-    end
-
-To detect if a file is updated, added or deleted:
-
-    FileWatcher.new(["README.rdoc"]).watch() do |filename, event|
-      if(event == :changed)
-        puts "File updated: " + filename
-      end
-      if(event == :delete)
-        puts "File deleted: " + filename
-      end
-      if(event == :new)
-        puts "Added file: " + filename
-      end
-    end
-
-When a file is renamed it is detected as a new file followed by a file deletion.
-
-The API takes some of the same options as the command line interface. To watch all files recursively except files that matches *.rb, display a spinner and only wait for 0.1 seconds between each scan:
-
-    FileWatcher.new('**/*.*', exclude: '**/*.rb', spinner: true, interval: 0.1).watch() do |filename|
-        puts filename
-    end
-
-To do the same from the command line, use the same options:
-
-    $ filewatcher '**/*.*' --exclude '**/*.rb' --spinner --interval 0.1 'echo $FILENAME'
-
-Use patterns to match filenames in current directory and subdirectories. The
-pattern is not a regular expression; instead it follows rules similar to shell
-filename globbing. See Ruby
-[documentation](http://www.ruby-doc.org/core-2.1.1/File.html#method-c-fnmatch)
-for syntax.
-
-    FileWatcher.new(["*.rb", "*.xml"]).watch do |filename|
-      puts "Updated " + filename
-    end
-
-Start, pause, resume, stop, and finalize a running watch. This is particularly
-useful when the update block takes a while to process each file (eg. sending
-over the network)
-
-    filewatcher = FileWatcher.new(["*.rb"])
-    thread = Thread.new(filewatcher){|fw| fw.watch{|f| puts "Updated " + f}}
-      ...
-    filewatcher.pause       # block stops responding to filesystem changes
-    filewatcher.finalize    # Ensure all filesystem changes made prior to
-                            # pausing are handled.
-      ...
-    filewatcher.resume       # block begins responding again, but is not given
-                             # changes made between #pause_watch and
-                             # #resume_watch
-      ...
-    filewatcher.end        # block stops responding to filesystem changes
-                           # and takes a final snapshot of the filesystem
-    thread.join
-
-    filewatcher.finalize   # Ensure all filesystem changes made prior to
-                           # ending the watch are handled.
-
-If basename, relative filename or absolute filename is necessary use the standard lib 'pathname' like this:
-
-    require 'pathname'
-
-    FileWatcher.new(["**/*.*"]).watch() do |filename|
-      path = Pathname.new(filename)
-      puys "Basename         : " + path.basename.to_s
-      puts "Relative filename: " + File.join(Pathname.new('.').to_s, path.to_s)
-      puts "Absolute filename: " + File.join(Pathname.new('.').realpath.to_s, path.to_s)
-    end
-
-The filewatcher library is a single file with 180 LOC (including comments)
-with no dependencies.
-
-Changelog
----------
- * 0.5.3 Exclude files. More environment variables. Options in ruby api.
- * 0.5.2 Start, stop and finalize API.
- * 0.5.1 Kill and restart long running command with --restart option.
-
-Credits
--------
-This project would not be where it is today without the generous help provided by people reporting issues and these contributors:
-
- * Penn Taylor: Spinner displayed in the terminal and Start, pause, resume, stop, and finalize a running watch.
-
- * Franco Leonardo Bulgarelli: Support for absolute and globbed paths by  https://github.com/flbulgarelli
-
- * Kristoffer Roupé https://github.com/kitofr Command line globbing by
-
-This gem was initially inspired by Tom Lieber's blogg posting: http://alltom.com/pages/detecting-file-changes-with-ruby
-
-Note on Patches/Pull Requests
------------------------------
-
-*   Fork the project.
-*   Make your feature addition or bug fix.
-*   Add tests for it. This is important so I don't break it in a future version unintentionally.
-*   Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-*   Send me a pull request. Bonus points for topic branches.
-
-
-Copyright
----------
-
-Copyright (c) 2011 - 2015 Thomas Flemming. See LICENSE for details.