rb-fsevent 0.9.2 → 0.11.1

data/ext/rakefile.rb

@@ -1,47 +1,231 @@
-# vim: fileencoding=UTF-8 nobomb sw=2 ts=2 et
-
-XCODEBUILD = '/usr/bin/xcodebuild'
-XCCONFIG = File.expand_path('rb-fsevent.xcconfig')
-
-namespace :xcode do
-  $target = 'fsevent_watch'
-  $configuration = ENV['FWDEBUG'] ? 'Debug' : 'Release'
-    
-  def xcb(action, extra='')
-    command = [
-      XCODEBUILD,
-      "-target", $target,
-      "-configuration", $configuration,
-      action,
-      "-xcconfig", XCCONFIG,
-      extra
-    ].join(' ')
-    
-    Dir.chdir 'fsevent_watch' do
-      results = `#{command}`
-      STDERR.puts results
-      raise "xcodebuild failure" unless $?.success?
-    end
-  end
-  
-  desc 'run xcodebuild clean'
-  task :clean do
-    xcb 'clean'
+# -*- encoding: utf-8 -*-
+require 'rubygems' unless defined?(Gem)
+require 'pathname'
+require 'date'
+require 'time'
+require 'rake/clean'
+
+raise "unable to find xcodebuild" unless system('which', 'xcodebuild')
+
+
+FSEVENT_WATCH_EXE_VERSION = '0.1.5'
+
+$this_dir = Pathname.new(__FILE__).dirname.expand_path
+$final_exe = $this_dir.parent.join('bin/fsevent_watch')
+
+$src_dir = $this_dir.join('fsevent_watch')
+$obj_dir = $this_dir.join('build')
+
+SRC = Pathname.glob("#{$src_dir}/*.c")
+OBJ = SRC.map {|s| $obj_dir.join("#{s.basename('.c')}.o")}
+
+$now = DateTime.now.xmlschema rescue Time.now.xmlschema
+
+$CC = ENV['CC'] || `which clang || which gcc`.strip
+$CFLAGS = ENV['CFLAGS'] || '-fconstant-cfstrings -fasm-blocks -fstrict-aliasing -Wall'
+$ARCHFLAGS = ENV['ARCHFLAGS'] || '-arch x86_64'
+$DEFINES = "-DNS_BUILD_32_LIKE_64 -DNS_BLOCK_ASSERTIONS -DPROJECT_VERSION=#{FSEVENT_WATCH_EXE_VERSION}"
+
+$GCC_C_LANGUAGE_STANDARD = ENV['GCC_C_LANGUAGE_STANDARD'] || 'gnu11'
+
+# generic developer id name so it'll match correctly for anyone who has only
+# one developer id in their keychain (not that I expect anyone else to bother)
+$CODE_SIGN_IDENTITY = 'Developer ID Application'
+
+$arch = `uname -m`.strip
+$os_release = `uname -r`.strip
+$BUILD_TRIPLE = "#{$arch}-apple-darwin#{$os_release}"
+
+$CCVersion = `#{$CC} --version | head -n 1`.strip
+
+
+CLEAN.include OBJ.map(&:to_s)
+CLEAN.include $obj_dir.join('Info.plist').to_s
+CLEAN.include $obj_dir.join('fsevent_watch').to_s
+CLOBBER.include $final_exe.to_s
+
+
+task :sw_vers do
+  $mac_product_version = `sw_vers -productVersion`.strip
+  $mac_build_version = `sw_vers -buildVersion`.strip
+  $MACOSX_DEPLOYMENT_TARGET = ENV['MACOSX_DEPLOYMENT_TARGET'] || $mac_product_version.sub(/\.\d*$/, '')
+  $CFLAGS = "#{$CFLAGS} -mmacosx-version-min=#{$MACOSX_DEPLOYMENT_TARGET}"
+end
+
+task :get_sdk_info => :sw_vers do
+  $SDK_INFO = {}
+  version_info = `xcodebuild -version -sdk macosx#{$MACOSX_DEPLOYMENT_TARGET}`
+  raise "invalid SDK" unless !!$?.exitstatus
+  version_info.strip.each_line do |line|
+    next if line.strip.empty?
+    next unless line.include?(':')
+    match = line.match(/([^:]*): (.*)/)
+    next unless match
+    $SDK_INFO[match[1]] = match[2]
   end
-  
-  desc 'run xcodebuild build'
-  task :build => :clean do
-    xcb 'build'
+end
+
+task :debug => :sw_vers do
+  $DEFINES = "-DDEBUG #{$DEFINES}"
+  $CFLAGS = "#{$CFLAGS} -O0 -fno-omit-frame-pointer -g"
+end
+
+task :release => :sw_vers do
+  $DEFINES = "-DNDEBUG #{$DEFINES}"
+  $CFLAGS = "#{$CFLAGS} -Ofast"
+end
+
+desc 'configure build type depending on whether ENV var FWDEBUG is set'
+task :set_build_type => :sw_vers do
+  if ENV['FWDEBUG']
+    Rake::Task[:debug].invoke
+  else
+    Rake::Task[:release].invoke
   end
-  
-  desc 'run xcodebuild install'
-  task :install => :build do
-    xcb 'install', "DEPLOYMENT_LOCATION='YES'"
+end
+
+desc 'set build arch to ppc'
+task :ppc do
+  $ARCHFLAGS = '-arch ppc'
+end
+
+desc 'set build arch to x86_64'
+task :x86_64 do
+  $ARCHFLAGS = '-arch x86_64'
+end
+
+desc 'set build arch to i386'
+task :x86 do
+  $ARCHFLAGS = '-arch i386'
+end
+
+desc 'set build arch to arm64'
+task :arm64 do
+  $ARCHFLAGS = '-arch arm64'
+end
+
+task :setup_env => [:set_build_type, :sw_vers, :get_sdk_info]
+
+directory $obj_dir.to_s
+file $obj_dir.to_s => :setup_env
+
+SRC.zip(OBJ).each do |source, object|
+  file object.to_s => [source.to_s, $obj_dir.to_s] do
+    cmd = [
+      $CC,
+      $ARCHFLAGS,
+      "-std=#{$GCC_C_LANGUAGE_STANDARD}",
+      $CFLAGS,
+      $DEFINES,
+      "-I#{$src_dir}",
+      '-isysroot',
+      $SDK_INFO['Path'],
+      '-c', source,
+      '-o', object
+    ]
+    sh(cmd.map {|s| s.to_s}.join(' '))
   end
-  
-  task :remove_turds do
-    rm_rf File.join('fsevent_watch', 'build')
+end
+
+file $obj_dir.join('Info.plist').to_s => [$obj_dir.to_s, :setup_env] do
+  File.open($obj_dir.join('Info.plist').to_s, 'w+') do |file|
+    indentation = ''
+    indent      =  lambda {|num|    indentation = ' ' * num               }
+    add         =  lambda {|str| file << "#{indentation}#{str}\n"   }
+    key         =  lambda {|str| add["<key>#{str}</key>"]           }
+    string      =  lambda {|str| add["<string>#{str}</string>"]     }
+
+
+    add['<?xml version="1.0" encoding="UTF-8"?>']
+    add['<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">']
+    add['<plist version="1.0">']
+
+    indent[2]
+    add['<dict>']
+    indent[4]
+
+    key['CFBundleExecutable']
+    string['fsevent_watch']
+    key['CFBundleIdentifier']
+    string['com.teaspoonofinsanity.fsevent_watch']
+    key['CFBundleName']
+    string['fsevent_watch']
+    key['CFBundleDisplayName']
+    string['FSEvent Watch CLI']
+    key['NSHumanReadableCopyright']
+    string['Copyright (C) 2011-2017 Travis Tilley']
+
+    key['CFBundleVersion']
+    string["#{FSEVENT_WATCH_EXE_VERSION}"]
+    key['LSMinimumSystemVersion']
+    string["#{$MACOSX_DEPLOYMENT_TARGET}"]
+    key['DTSDKBuild']
+    string["#{$SDK_INFO['ProductBuildVersion']}"]
+    key['DTSDKName']
+    string["macosx#{$SDK_INFO['SDKVersion']}"]
+    key['DTSDKPath']
+    string["#{$SDK_INFO['Path']}"]
+    key['BuildMachineOSBuild']
+    string["#{$mac_build_version}"]
+    key['BuildMachineOSVersion']
+    string["#{$mac_product_version}"]
+    key['FSEWCompiledAt']
+    string["#{$now}"]
+    key['FSEWVersionInfoBuilder']
+    string["#{`whoami`.strip}"]
+    key['FSEWBuildTriple']
+    string["#{$BUILD_TRIPLE}"]
+    key['FSEWCC']
+    string["#{$CC}"]
+    key['FSEWCCVersion']
+    string["#{$CCVersion}"]
+    key['FSEWCFLAGS']
+    string["#{$CFLAGS}"]
+
+    indent[2]
+    add['</dict>']
+    indent[0]
+
+    add['</plist>']
   end
 end
 
-task :default => ['xcode:install', 'xcode:remove_turds']
+desc 'generate an Info.plist used for code signing as well as embedding build settings into the resulting binary'
+task :plist => $obj_dir.join('Info.plist').to_s
+
+
+file $obj_dir.join('fsevent_watch').to_s => [$obj_dir.to_s, $obj_dir.join('Info.plist').to_s] + OBJ.map(&:to_s) do
+  cmd = [
+    $CC,
+    $ARCHFLAGS,
+    "-std=#{$GCC_C_LANGUAGE_STANDARD}",
+    $CFLAGS,
+    $DEFINES,
+    "-I#{$src_dir}",
+    '-isysroot',
+    $SDK_INFO['Path'],
+    '-framework CoreFoundation -framework CoreServices',
+    '-sectcreate __TEXT __info_plist',
+    $obj_dir.join('Info.plist')
+  ] + OBJ + [
+    '-o', $obj_dir.join('fsevent_watch')
+  ]
+  sh(cmd.map {|s| s.to_s}.join(' '))
+end
+
+desc 'compile and link build/fsevent_watch'
+task :build => $obj_dir.join('fsevent_watch').to_s
+
+desc 'codesign build/fsevent_watch binary'
+task :codesign => :build do
+  sh "codesign -s '#{$CODE_SIGN_IDENTITY}' #{$obj_dir.join('fsevent_watch')}"
+end
+
+directory $this_dir.parent.join('bin')
+
+desc 'replace bundled fsevent_watch binary with build/fsevent_watch'
+task :replace_exe => [$this_dir.parent.join('bin'), :build] do
+  sh "mv #{$obj_dir.join('fsevent_watch')} #{$final_exe}"
+end
+
+task :default => [:replace_exe, :clean]

data/lib/otnetstring.rb

@@ -0,0 +1,85 @@
+# Copyright (c) 2011 Konstantin Haase
+#
+# 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.
+
+
+require 'stringio'
+
+module OTNetstring
+  class Error < StandardError; end
+
+  class << self
+    def parse(io, encoding = 'internal', fallback_encoding = nil)
+      fallback_encoding = io.encoding if io.respond_to? :encoding
+      io = StringIO.new(io) if io.respond_to? :to_str
+      length, byte = "", nil
+
+      while byte.nil? || byte =~ /\d/
+        length << byte if byte
+        byte = io.read(1)
+      end
+
+      if length.size > 9
+        raise Error, "#{length} is longer than 9 digits"
+      elsif length !~ /\d+/
+        raise Error, "Expected '#{byte}' to be a digit"
+      end
+      length = Integer(length)
+
+      case byte
+      when '#' then Integer io.read(length)
+      when ',' then with_encoding io.read(length), encoding, fallback_encoding
+      when '~' then
+        raise Error, "nil has length of 0, #{length} given" unless length == 0
+      when '!' then io.read(length) == 'true'
+      when '[', '{'
+        array = []
+        start = io.pos
+        array << parse(io, encoding, fallback_encoding) while io.pos - start < length
+        raise Error, 'Nested element longer than container' if io.pos - start != length
+        byte == "{" ? Hash[*array] : array
+      else
+        raise Error, "Unknown type '#{byte}'"
+      end
+    end
+
+    def encode(obj, string_sep = ',')
+      case obj
+      when String   then with_encoding "#{obj.bytesize}#{string_sep}#{obj}", "binary"
+      when Integer  then encode(obj.inspect, '#')
+      when NilClass then "0~"
+      when Array    then encode(obj.map { |e| encode(e) }.join, '[')
+      when Hash     then encode(obj.map { |a,b| encode(a)+encode(b) }.join, '{')
+      when FalseClass, TrueClass then encode(obj.inspect, '!')
+      else raise Error, 'cannot encode %p' % obj
+      end
+    end
+
+    private
+
+    def with_encoding(str, encoding, fallback = nil)
+      return str unless str.respond_to? :encode
+      encoding = Encoding.find encoding if encoding.respond_to? :to_str
+      encoding ||= fallback
+      encoding ? str.encode(encoding) : str
+    rescue EncodingError
+      str.force_encoding(encoding)
+    end
+  end
+end

data/lib/rb-fsevent/fsevent.rb

@@ -1,3 +1,7 @@
+# -*- encoding: utf-8 -*-
+
+require 'otnetstring'
+
 class FSEvent
   class << self
     class_eval <<-END
@@ -38,26 +42,67 @@ class FSEvent
     # please note the use of IO::select() here, as it is used specifically to
     # preserve correct signal handling behavior in ruby 1.8.
     while @running && IO::select([@pipe], nil, nil, nil)
-      if line = @pipe.readline
-        modified_dir_paths = line.split(':').select { |dir| dir != "\n" }
-        callback.call(modified_dir_paths)
+      # managing the IO ourselves allows us to be careful and never pass an
+      # incomplete message to OTNetstring.parse()
+      message = ""
+      length = ""
+      byte = nil
+
+      reading_length = true
+      found_length = false
+
+      while reading_length
+        byte = @pipe.read_nonblock(1)
+        if "#{byte}" =~ /\d/
+          length << byte
+          found_length = true
+        elsif found_length == false
+          next
+        else
+          reading_length = false
+        end
+      end
+      length = Integer(length, 10)
+      type = byte
+
+      message << "#{length}#{type}"
+      message << @pipe.read(length)
+
+      decoded = OTNetstring.parse(message)
+      modified_paths = decoded["events"].map {|event| event["path"]}
+      # passing the full info as a second block param feels icky, but such is
+      # the trap of backward compatibility.
+      case callback.arity
+        when 1
+          callback.call(modified_paths)
+        when 2
+          callback.call(modified_paths, decoded)
       end
     end
-  rescue Interrupt, IOError
+  rescue Interrupt, IOError, Errno::EBADF
   ensure
     stop
   end
 
   def stop
     unless @pipe.nil?
-      Process.kill('KILL', @pipe.pid)
+      Process.kill('KILL', @pipe.pid) if process_running?(@pipe.pid)
       @pipe.close
     end
-  rescue IOError
+  rescue IOError, Errno::EBADF
   ensure
     @running = false
   end
 
+  def process_running?(pid)
+    begin
+      Process.kill(0, pid)
+      true
+    rescue Errno::ESRCH
+      false
+    end
+  end
+
   if RUBY_VERSION < '1.9'
     def open_pipe
       IO.popen("'#{self.class.watcher_path}' #{options_string} #{shellescaped_paths}")
@@ -99,11 +144,12 @@ class FSEvent
   private
 
   def parse_options(options={})
-    opts = []
+    opts = ['--format=otnetstring']
     opts.concat(['--since-when', options[:since_when]]) if options[:since_when]
     opts.concat(['--latency', options[:latency]]) if options[:latency]
     opts.push('--no-defer') if options[:no_defer]
     opts.push('--watch-root') if options[:watch_root]
+    opts.push('--file-events') if options[:file_events]
     # ruby 1.9's IO.popen(array-of-stuff) syntax requires all items to be strings
     opts.map {|opt| "#{opt}"}
   end

data/lib/rb-fsevent/version.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 class FSEvent
-  VERSION = "0.9.2"
+  VERSION = '0.11.1'
 end

data/lib/rb-fsevent.rb

@@ -1,2 +1,3 @@
+# -*- encoding: utf-8 -*-
 require 'rb-fsevent/fsevent'
-require 'rb-fsevent/version'
+require 'rb-fsevent/version'

data/rb-fsevent.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rb-fsevent/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rb-fsevent'
+  s.version     = FSEvent::VERSION
+  s.authors     = ['Thibaud Guillaume-Gentil', 'Travis Tilley']
+  s.email       = ['thibaud@thibaud.gg', 'ttilley@gmail.com']
+  s.homepage    = 'http://rubygems.org/gems/rb-fsevent'
+  s.summary     = 'Very simple & usable FSEvents API'
+  s.description = 'FSEvents API with Signals catching (without RubyCocoa)'
+  s.license     = 'MIT'
+
+  s.metadata = {
+    'source_code_uri' => 'https://github.com/thibaudgg/rb-fsevent'
+  }
+
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  s.require_path = 'lib'
+
+  s.add_development_dependency 'rspec',       '~> 3.6'
+  s.add_development_dependency 'guard-rspec', '~> 4.2'
+  s.add_development_dependency 'rake',        '~> 12.0'
+end

metadata

@@ -1,118 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: rb-fsevent
 version: !ruby/object:Gem::Version
-  version: 0.9.2
-  prerelease: 
+  version: 0.11.1
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 - Travis Tilley
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-09-24 00:00:00.000000000 Z
+date: 2022-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '12.0'
 description: FSEvents API with Signals catching (without RubyCocoa)
 email:
-- thibaud@thibaud.me
+- thibaud@thibaud.gg
 - ttilley@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
 - bin/fsevent_watch
+- ext/LICENSE
+- ext/fsevent_watch/FSEventsFix.c
+- ext/fsevent_watch/FSEventsFix.h
+- ext/fsevent_watch/TSICTString.c
+- ext/fsevent_watch/TSICTString.h
+- ext/fsevent_watch/cli.c
+- ext/fsevent_watch/cli.h
+- ext/fsevent_watch/common.h
+- ext/fsevent_watch/compat.c
+- ext/fsevent_watch/compat.h
+- ext/fsevent_watch/defines.h
+- ext/fsevent_watch/main.c
+- ext/fsevent_watch/signal_handlers.c
+- ext/fsevent_watch/signal_handlers.h
+- ext/rakefile.rb
+- lib/otnetstring.rb
+- lib/rb-fsevent.rb
 - lib/rb-fsevent/fsevent.rb
 - lib/rb-fsevent/version.rb
-- lib/rb-fsevent.rb
-- ext/fsevent_watch/fsevent_watch/cli.c
-- ext/fsevent_watch/fsevent_watch/cli.h
-- ext/fsevent_watch/fsevent_watch/common.h
-- ext/fsevent_watch/fsevent_watch/compat.c
-- ext/fsevent_watch/fsevent_watch/compat.h
-- ext/fsevent_watch/fsevent_watch/main.c
-- ext/fsevent_watch/fsevent_watch/TSICTString.c
-- ext/fsevent_watch/fsevent_watch/TSICTString.h
-- ext/fsevent_watch/fsevent_watch.xcodeproj/project.pbxproj
-- ext/fsevent_watch/Info.plist
-- ext/fsevent_watch/LICENSE
-- ext/fsevent_watch/xcconfig/Common.xcconfig
-- ext/fsevent_watch/xcconfig/Debug.xcconfig
-- ext/fsevent_watch/xcconfig/fsevent_watch.xcconfig
-- ext/fsevent_watch/xcconfig/Release.xcconfig
-- ext/rakefile.rb
-- ext/rb-fsevent.xcconfig
-- LICENSE
-- README.rdoc
+- rb-fsevent.gemspec
 homepage: http://rubygems.org/gems/rb-fsevent
-licenses: []
-post_install_message: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/thibaudgg/rb-fsevent
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: rb-fsevent
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
 summary: Very simple & usable FSEvents API
 test_files: []