tidings 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 228de1321d524ee89a186eace9228e3623b196427da359390c4ea1cbd41a7895
-  data.tar.gz: 362d9e11a2c6787945ae39b2871a05e2e86dfe4f4e65380597a743189f5490dc
+  metadata.gz: 39ab6e749612d49a63cd3c2794d6c9fd66af4d96695c0487c77068cc9a7465f5
+  data.tar.gz: '09326f79c9abc7982d48a8cc24e2c8a3a54ddf22f23b9e54b2230afea55d47c5'
 SHA512:
-  metadata.gz: 695ca41270ccf3733528294f19e4763fb2161d01b58923d21b89a8c790305a203e4b3e8c81bd21ee71a3f5a5906ba85dbeb2a3f9a1bc8008e9b840f332cfa760
-  data.tar.gz: 790e9090ee80303967de22507844ca594267386a89918d24a11b66a2e17f9f2eb8c7ce99f632d166c9f0e78ada63e535e50a985464fbdb92fd98f22097f5d115
+  metadata.gz: 884c3fe4f465b7c159ea25ea1f2341d7e1c847afb7c853cb90ae8c9ef50183d2df20e1f2aab03c59cc55321fa11492e2c26ab83a29cda4f9235dfeedc0f0694f
+  data.tar.gz: a152a046499ee07075503eddc1630341da08144066b9d8da50a2bfc68d90a1ee5e7dc1c65f536c487d726c5076b935e77f7a6c338da194388de08d914cc6fda7

data/README.md

@@ -4,13 +4,15 @@ A platform optimized file-change watcher.
 
 ## Installation
 
-  $ gem install tidings
+    gem install tidings
 
-## Short example
+## Examples
+
+Tidings registers with the operating system to receive callbacks for changes to the filesystem relative to a path. For every change it reports to anything that responds to: `call(file_or_path, flags)`. For example, a block:
 
 ```ruby
 Tidings.watch('/Users/janice/Code') do |file_or_path, flags|
-  if flags.include(:dir)
+  if flags.include?(:dir)
     puts "Change to directory: #{file_or_path}"
   else
     puts "Change to file: #{file_or_path}"
@@ -18,7 +20,7 @@ Tidings.watch('/Users/janice/Code') do |file_or_path, flags|
 end
 ```
 
-## Long example
+Or a class:
 
 ```ruby
 module MyFileWatcher
@@ -28,4 +30,40 @@ module MyFileWatcher
 end
 
 Tidings.watch('/Users/janice/Code', MyFileWatcher)
-````
+```
+
+Tidings swallows exceptions raised by the watcher because that's useful for ad-hoc scripts. If you don't want this you can either catch them yourself or drop down to Tidings internals.
+
+```ruby
+Tidings.watch(__dir__) do |file|
+  do_something(file)
+rescue Exception => e
+  $stderr.write("🤕 #{e.message}")
+end
+```
+
+You can drop down to use the low-level implementation directly. Either `FSEvent` or `Inotify` will be defined depending on what compiled on your operating system.
+
+```ruby
+require 'tidings'
+
+def watch(path, &block)
+  if const_defined?(:FSEvent)
+    def watch
+      FSEvent.watch(path, block)
+    end
+  elsif const_defined?(:Inotify)
+    def watch
+      Inotify.watch(path, block)
+    end
+  end
+end
+
+watch(__dir__) do |file|
+  puts "Change: #{file}"
+end
+```
+
+## Copyright
+
+MIT license, see COPYING.

data/ext/Makefile

@@ -12,12 +12,12 @@ NULLCMD = :
 #### Start of system configuration section. ####
 
 srcdir = fs_event
-topdir = /Users/manfred/.rbenv/versions/2.5.1/include/ruby-2.5.0
+topdir = /Users/manfred/.rbenv/versions/2.7.2/include/ruby-2.7.0
 hdrdir = $(topdir)
-arch_hdrdir = /Users/manfred/.rbenv/versions/2.5.1/include/ruby-2.5.0/x86_64-darwin17
+arch_hdrdir = /Users/manfred/.rbenv/versions/2.7.2/include/ruby-2.7.0/x86_64-darwin20
 PATH_SEPARATOR = :
 VPATH = $(srcdir):$(arch_hdrdir)/ruby:$(hdrdir)/ruby
-prefix = $(DESTDIR)/Users/manfred/.rbenv/versions/2.5.1
+prefix = $(DESTDIR)/Users/manfred/.rbenv/versions/2.7.2
 rubysitearchprefix = $(rubylibprefix)/$(sitearch)
 rubyarchprefix = $(rubylibprefix)/$(arch)
 rubylibprefix = $(libdir)/$(RUBY_BASE_NAME)
@@ -52,6 +52,7 @@ infodir = $(datarootdir)/info
 docdir = $(datarootdir)/doc/$(PACKAGE)
 oldincludedir = $(SDKROOT)/usr/include
 includedir = $(prefix)/include
+runstatedir = $(localstatedir)/run
 localstatedir = $(prefix)/var
 sharedstatedir = $(prefix)/com
 sysconfdir = $(prefix)/etc
@@ -63,12 +64,13 @@ bindir = $(exec_prefix)/bin
 archdir = $(rubyarchdir)
 
 
+CC_WRAPPER = 
 CC = clang
 CXX = clang++
-LIBRUBY = $(LIBRUBY_A)
+LIBRUBY = $(LIBRUBY_SO)
 LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a
-LIBRUBYARG_SHARED = 
-LIBRUBYARG_STATIC = -l$(RUBY_SO_NAME)-static -framework Foundation
+LIBRUBYARG_SHARED = -l$(RUBY_SO_NAME)
+LIBRUBYARG_STATIC = -l$(RUBY_SO_NAME)-static -framework Security -framework Foundation $(MAINLIBS)
 empty =
 OUTFLAG = -o $(empty)
 COUTFLAG = -o $(empty)
@@ -76,18 +78,19 @@ CSRCFLAG = $(empty)
 
 RUBY_EXTCONF_H = 
 cflags   = $(optflags) $(debugflags) $(warnflags)
-cxxflags = $(optflags) $(debugflags) $(warnflags)
+cxxflags = 
 optflags = -O3
 debugflags = -ggdb3
-warnflags = -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wno-tautological-compare -Wno-parentheses-equality -Wno-constant-logical-operand -Wno-self-assign -Wunused-variable -Wimplicit-int -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wshorten-64-to-32 -Wimplicit-function-declaration -Wdivision-by-zero -Wdeprecated-declarations -Wextra-tokens
+warnflags = -Wall -Wextra -Wdeprecated-declarations -Wdivision-by-zero -Wimplicit-function-declaration -Wimplicit-int -Wmisleading-indentation -Wpointer-arith -Wshorten-64-to-32 -Wwrite-strings -Wmissing-noreturn -Wno-constant-logical-operand -Wno-long-long -Wno-missing-field-initializers -Wno-overlength-strings -Wno-parentheses-equality -Wno-self-assign -Wno-tautological-compare -Wno-unused-parameter -Wno-unused-value -Wunused-variable -Wextra-tokens
+cppflags = 
 CCDLFLAGS = -fno-common
-CFLAGS   = $(CCDLFLAGS)  -O3 -Wno-error=shorten-64-to-32  -pipe $(ARCH_FLAG)
+CFLAGS   = $(CCDLFLAGS) $(cflags)  -fno-common -pipe $(ARCH_FLAG)
 INCFLAGS = -I. -I$(arch_hdrdir) -I$(hdrdir)/ruby/backward -I$(hdrdir) -I$(srcdir)
 DEFS     = 
-CPPFLAGS =  -I/Users/manfred/.rbenv/versions/2.5.1/include  -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE -D_DARWIN_UNLIMITED_SELECT -D_REENTRANT $(DEFS) $(cppflags)
-CXXFLAGS = $(CCDLFLAGS) $(cxxflags) $(ARCH_FLAG)
+CPPFLAGS =  -I/Users/manfred/.rbenv/versions/2.7.2/include  -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE -D_DARWIN_UNLIMITED_SELECT -D_REENTRANT $(DEFS) $(cppflags)
+CXXFLAGS = $(CCDLFLAGS) -g -O2 $(ARCH_FLAG)
 ldflags  = -framework CoreServices
-dldflags = -L/Users/manfred/.rbenv/versions/2.5.1/lib  -Wl,-undefined,dynamic_lookup -Wl,-multiply_defined,suppress 
+dldflags = -L/Users/manfred/.rbenv/versions/2.7.2/lib  -Wl,-undefined,dynamic_lookup -Wl,-multiply_defined,suppress 
 ARCH_FLAG = 
 DLDFLAGS = $(ldflags) $(dldflags) $(ARCH_FLAG)
 LDSHARED = $(CC) -dynamic -bundle
@@ -96,15 +99,15 @@ AR = libtool -static
 EXEEXT = 
 
 RUBY_INSTALL_NAME = $(RUBY_BASE_NAME)
-RUBY_SO_NAME = ruby.2.5.1
+RUBY_SO_NAME = ruby.2.7
 RUBYW_INSTALL_NAME = 
 RUBY_VERSION_NAME = $(RUBY_BASE_NAME)-$(ruby_version)
 RUBYW_BASE_NAME = rubyw
 RUBY_BASE_NAME = ruby
 
-arch = x86_64-darwin17
+arch = x86_64-darwin20
 sitearch = $(arch)
-ruby_version = 2.5.0
+ruby_version = 2.7.0
 ruby = $(bindir)/$(RUBY_BASE_NAME)
 RUBY = $(ruby)
 ruby_headers = $(hdrdir)/ruby.h $(hdrdir)/ruby/backward.h $(hdrdir)/ruby/ruby.h $(hdrdir)/ruby/defines.h $(hdrdir)/ruby/missing.h $(hdrdir)/ruby/intern.h $(hdrdir)/ruby/st.h $(hdrdir)/ruby/subst.h $(arch_hdrdir)/ruby/config.h
@@ -134,7 +137,7 @@ extout =
 extout_prefix = 
 target_prefix = 
 LOCAL_LIBS = 
-LIBS =   -lpthread -ldl -lobjc 
+LIBS = $(LIBRUBYARG_SHARED)   
 ORIG_SRCS = fs_event.c
 SRCS = $(ORIG_SRCS) 
 OBJS = fs_event.o

data/ext/extconf.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'mkmf'
 
 case RUBY_PLATFORM
 when /darwin/
-  with_ldflags("-framework CoreServices") do
-    create_makefile("fs_event", "fs_event")
+  with_ldflags('-framework CoreServices') do
+    create_makefile('fs_event', 'fs_event')
   end
 when /linux/
-  create_makefile("inotify", "inotify")
-end
+  create_makefile('inotify', 'inotify')
+end

data/lib/tidings.rb

@@ -1,23 +1,28 @@
+# frozen_string_literal: true
+
 case RUBY_PLATFORM
 when /darwin/
   require 'fs_event'
 when /linux/
   require 'inotify'
 else
-  raise RuntimeError, "Your platform is currently not supported (#{RUBY_PLATFORM})"
+  raise "Your platform is currently not supported (#{RUBY_PLATFORM})"
 end
 
+# Contains the complete Tidings implementation.
+#
+#     Tidings.watch(File.expand_path('~/Code`)) { |file| pp file }
 module Tidings
   autoload :VERSION, 'tidings/version'
   autoload :Watcher, 'tidings/watcher'
 
   def self.log(message)
-    $stderr.puts('Tidings: ' + message.to_s) if $DEBUG
+    warn("Tidings: #{message}") if $DEBUG
   end
 
-  def self.watch(path, processor=nil, &block)
+  def self.watch(path, processor = nil, &block)
     watcher = Tidings::Watcher.new(path, processor || block)
     watcher.start
     watcher
   end
-end
+end

data/lib/tidings/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tidings
-  VERSION = '0.3.0'
-end
+  VERSION = '0.4.0'
+end

data/lib/tidings/watcher.rb

@@ -1,29 +1,34 @@
+# frozen_string_literal: true
+
 module Tidings
+  # Starts a file watcher in a separate process.
   class Watcher
     def initialize(path, processor)
-      @path, @processor, @pid = path, processor, nil
+      @path = path
+      @processor = processor
+      @pid = nil
     end
 
     def start
-      Signal.trap("HUP") { stop }
-      Signal.trap("SIGINT") { stop }
+      Signal.trap('HUP') { stop }
+      Signal.trap('SIGINT') { stop }
       @pid = fork do
         begin
           watch
-        rescue Exception => exception
+        rescue Exception => e
           Tidings.log(
-            "Tidings encountered an uncaught exeption: #{exception.message}"
+            "Tidings encountered an uncaught exeption: #{e.message}"
           )
           exit
         end
       end
       Tidings.log("Tidings running on PID: #{@pid}")
       Process.waitpid(@pid)
-      Tidings.log("Tidings stopped running")
+      Tidings.log('Tidings stopped running')
     end
 
     def stop
-      Process.kill("KILL", @pid)
+      Process.kill('KILL', @pid)
     rescue Errno::ESRCH
     end
 
@@ -37,4 +42,4 @@ module Tidings
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tidings
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Manfred Stienstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-21 00:00:00.000000000 Z
+date: 2021-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fakefs
@@ -63,8 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A platform optimized file-change watcher.