io-watch 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d6ca67070f5fe227f2e06b5c5fa8bc2498a640aa88fb7e21a21da0bf5a09434
-  data.tar.gz: 8973b98b3412da62ddcca9850ab04c3c69b1e00ab15e35e2bddf275a99f20823
+  metadata.gz: 14f3ccb0d7a3066e70e3ab6e25221c585f1a17034e0e9731fe85637e6797b4d8
+  data.tar.gz: 35d7f43fd20d2ef7cf68558c787344cc49c614498e98e8ccfc25bfca08d5b5d6
 SHA512:
-  metadata.gz: db38f21e23045fb052299ee4974ee4cecd283ea406f32dd5a5e453ef7125c8d0a9086589ed6d0b8c0977311071367b2ba2429f93f71127f7e335b8f451208de4
-  data.tar.gz: c6c6af9a7975ea6912b582bddc8b52ac0ef480de0a30c83d70c1781036e46eb93d97b87c58b0e12a558d29bff57955c8a75db483d97b427775b2da13ad557481
+  metadata.gz: 045d52cf0bc46fcc1410af1eb75362b21584561350996baa58c0b87a8b0216d24013d18ed97542d9c987f4b457b828b115f10f0ad5848734842194b45f2b09a0
+  data.tar.gz: 1d1a110f3d8f85e1d4f74fd2b55d927d4c91a3b02bbf506ce4b1f20272b67ba6c8830d3e265fa4948feac4de1ee5d2531ca76c8f2211255b21cc9d5cab33644f

data/bin/io-watch

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'console'
 require 'io/watch'

data/ext/configure

@@ -43,7 +43,7 @@ esac
 cat > Makefile <<EOF
 TARGET = io-watch
 CC = $CC
-CFLAGS = -Wall -Wextra
+CFLAGS = -Wall -Wextra -Werror
 LDFLAGS = $LDFLAGS
 SOURCES = $SOURCES
 OBJECTS = \$(SOURCES:.c=.o)
@@ -74,4 +74,4 @@ uninstall:
 .PHONY: all clean install uninstall
 EOF
 
-echo "Configuration complete. Run 'make' to build the project."
+echo "Configuration complete. Run 'make' to build the project."

data/ext/io/watch/fsevent.c

@@ -44,6 +44,7 @@ void IO_Watch_FSEvent_callback(
 	const FSEventStreamEventFlags eventFlags[],
 	const FSEventStreamEventId eventIds[]) {
 	
+	(void)streamRef; // unused
 	const char **eventPaths = (const char**)eventData;
 	struct IO_Watch *watch = context;
 	
@@ -104,4 +105,4 @@ void IO_Watch_run(struct IO_Watch *watch) {
 	}
 	free(pathsToWatch);
 	CFRelease(pathsToWatchArray);
-}
+}

data/lib/io/watch/monitor.rb

@@ -9,6 +9,7 @@ class IO
 	module Watch
 		# Represents a list of roots to watch for changes.
 		class Monitor
+			# The path to the compiled `io-watch` command.
 			def self.command_path
 				if extension_path = Gem.loaded_specs['io-watch']&.extension_dir
 					if File.exist?(extension_path)

data/lib/io/watch/version.rb

@@ -5,6 +5,6 @@
 
 class IO
 	module Watch
-		VERSION = '0.6.2'
+		VERSION = '0.6.3'
 	end
 end

data/lib/io/watch.rb

@@ -6,8 +6,11 @@
 require_relative 'watch/version'
 require_relative 'watch/monitor'
 
+# @namespace
 class IO
+	# @namespace
 	module Watch
+		# Create a new monitor.
 		def self.new(...)
 			Monitor.new(...)
 		end

data/license.md

@@ -1,6 +1,7 @@
 # MIT License
 
 Copyright, 2024, by Samuel Williams.  
+Copyright, 2024, by Étienne Barrié.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -4,6 +4,10 @@ Monitor the file-system for changes.
 
 [![Development Status](https://github.com/socketry/io-watch/workflows/Test/badge.svg)](https://github.com/socketry/io-watch/actions?workflow=Test)
 
+## Motivation
+
+Previously, I was using the `listen` gem in combination with `rb-inotify` or `rb-fsevent` to watch for file-system changes. However, those libraries have been around for an extremely long time and have accumulated a lot of cruft. In addition, I don't like having to multiplex in application code depending on the underlying platform. I created this library to provide a simple, unified interface for watching directories for changes. This is the most consistently supported behaviour across all platforms, and fits the needs of most applications without a huge amount of complexity.
+
 ## Usage
 
 Please see the [project documentation](https://socketry.github.io/io-watch/) for more details.

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: io-watch
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Samuel Williams
+- Étienne Barrié
 autorequire:
 bindir: bin
 cert_chain: