file_change_observer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d24ad0b2698d233571a5629f04027f0d32b654e
+  data.tar.gz: b39bcb167dc9fc5044ebfb865ee3b2350d68c20e
+SHA512:
+  metadata.gz: 45284603ab33a0c25b21f90a32fa9d401354725c306758f51a82f6f5e1bdf7c53032b2e1fc09db5297ca7f34ae9d6d26d4e0ef8b8a8de72c3f31366f0e667bd3
+  data.tar.gz: de206f8efcb035947b9d7233e4754fdeff7194fca7b51022cd5aed06aed0e9ce3b7129d5bdf2901413048af7af56a7c91e0c4cae059f61169ef7b34eca37ba75

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in file_change_observer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Burke Libbey
+
+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

@@ -0,0 +1,34 @@
+# FileChangeObserver
+
+```ruby
+require 'tmpdir'
+
+tgz_path = Dir.mktmpdir do |dir|
+  FileChangeObserver.tar_changes(dir) do
+    File.write("#{dir}/foo", 'neato')
+    FileUtils.mkdir("#{dir}/bar")
+    File.write("#{dir}/bar/baz", 'it works')
+  end
+end
+
+# -rw-r--r--  0 wheel  wheel       5  2 Oct 15:01 foo
+# -rw-r--r--  0 wheel  wheel       8  2 Oct 15:01 bar/baz
+system("tar tvf #{tgz_path}")
+File.unlink(tgz_path)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'file_change_observer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install file_change_observer

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "file_change_observer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/file_change_observer.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "file_change_observer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "file_change_observer"
+  spec.version       = FileChangeObserver::VERSION
+  spec.authors       = ["Burke Libbey"]
+  spec.email         = ["burke.libbey@shopify.com"]
+
+  spec.summary       = %q{Tar files changed by a block}
+  spec.description   = %q{Tar files changed by a block.}
+  spec.homepage      = "https://github.com/burke/file_change_observer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency "rb-fsevent", ">= 0.10.0"
+end

data/lib/file_change_observer.rb

@@ -0,0 +1,124 @@
+require 'rb-fsevent'
+require 'rubygems/package'
+require 'set'
+require 'fileutils'
+require 'zlib'
+require 'pathname'
+require 'tempfile'
+
+# FileChangeObserver provides a method to invoke a block while capturing all
+# filesystem changes made by that block under a particular subtree as a gzipped
+# tarball.
+module FileChangeObserver
+  LATENCY = 0.01
+  SENTINEL = ".__observe_files_break_now__".freeze
+  ITEM_IS_DIR = 'ItemIsDir'.freeze
+  SYS_SYNC = 36 # syscall number for sync(3) on darwin
+
+  class << self
+    # Watch a directory and generate a gzipped tarball of all the files
+    # changed, modified, or otherwise touched while the given block is runs.
+    #
+    # See observe_changes for a handful of limitations regarding which changes
+    # are included.
+    def tar_changes(from_root, to: gen_tempfile_path, &block)
+      affected_paths = observe_changes(from_root, &block)
+      root_path = Pathname.new(File.realpath(from_root))
+
+      Zlib::GzipWriter.open(to) do |gz_writer|
+        Gem::Package::TarWriter.new(gz_writer) do |tar_writer|
+          affected_paths.each do |file|
+            add_file(tar_writer, file, root_path)
+          end
+        end
+      end
+
+      to
+    end
+
+    # Set up an fsevents handler on the given root directory, and, while
+    # running the given block, collect a set of all the files changed under
+    # that root.
+    #
+    # The tarball does not include any sort of deletion sentinel for files
+    # deleted by the block, and does not include entries for directories (so
+    # empty directories created by the block will not show up in the tarball).
+    #
+    # Additionally, a file doesn't have to be actually *changed* in order to be
+    # returned; anything that generates an `fsevents` event is sufficient.
+    def observe_changes(from_root)
+      affected_paths = Set.new
+      sentinel_path = File.join(from_root, SENTINEL)
+
+      # if the directory was recently created, it *seems* like it needs to
+      # actually be written out before we start the watch, otherwise we don't
+      # receive any events.
+      #
+      # Unfortunately, sync(3) is a slow/expensive operation and a
+      # newly-created direcotry is probably not the most common use-case. As a
+      # compromise, we sync(3) only if the directory appears to have been
+      # created in the past few seconds.
+      if (Time.now - File.stat(from_root).ctime) < 5
+        Kernel.syscall(SYS_SYNC)
+      end
+
+      fsevent = FSEvent.new
+      fsevent.watch(from_root, file_events: true, latency: LATENCY) do |paths, meta|
+        done = false
+        meta['events'].each do |evt|
+          # Don't track directories. We could change this...
+          next if evt['flags'].include?(ITEM_IS_DIR)
+          path = evt['path']
+          # Because macOS delivers these events with a configurable latency, we
+          # have to wait for it to flush its pipeline before we can escape from
+          # the run loop, so we push this sentinel event after invoking the
+          # block. We know we're done when we receive it.
+          if path.end_with?(SENTINEL)
+            done = true
+          else
+            affected_paths << path
+          end
+        end
+        raise Interrupt if done
+      end
+      thr = Thread.new { fsevent.run }
+      # If we yield before the handler is set up, early events will be
+      # discarded.
+      sleep 1e-6 until fsevent.instance_variable_get(:@running)
+
+      yield
+
+      # Once the thread recieves the event for the sentinel_path, it will
+      # return, and #join will return.
+      FileUtils.touch(sentinel_path)
+      thr.join
+      File.unlink(sentinel_path) # clean up
+
+      affected_paths
+    end
+
+    private
+
+    # Generate a path to a valid (non-existent) tempfile.
+    def gen_tempfile_path
+      tf = Tempfile.new('filechanges.tgz')
+      tf_path = tf.path
+      tf.close
+      tf.unlink
+      tf_path
+    end
+
+    # Add a file to the TarWriter. Since our events may correspond to
+    # now-deleted files, we swallow ENOENT.
+    def add_file(tar_writer, file, root_path)
+      stat = File.stat(file)
+      name = Pathname.new(file).relative_path_from(root_path).to_s
+      tar_writer.add_file_simple(name, stat.mode, stat.size) do |io|
+        File.open(file, 'rb') { |f| IO.copy_stream(f, io) }
+      end
+    rescue Errno::ENOENT
+      nil
+    end
+  end
+end
+

data/lib/file_change_observer/version.rb

@@ -0,0 +1,3 @@
+module FileChangeObserver
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: file_change_observer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Burke Libbey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: Tar files changed by a block.
+email:
+- burke.libbey@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- file_change_observer.gemspec
+- lib/file_change_observer.rb
+- lib/file_change_observer/version.rb
+homepage: https://github.com/burke/file_change_observer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Tar files changed by a block
+test_files: []