fsevents_to_vm 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcb778ce441e59e1c508839c74ab72f129315328
+  data.tar.gz: cb6a7c1a54cf648fd54f44d2b17e2321ce0bd645
+SHA512:
+  metadata.gz: db5a302a53c468f1d18c73bb32cf57cec1d05b12cd92a5f00148fbee14af5616fc532e2576359adf71a63ef1fed7d485a0ebe53bbb4064f7d7770c48796fd3cc
+  data.tar.gz: af329d180f4ce7779666d9b01a3ed5287f9b3823c14b90e53501850dd014eafc03f2f73d2dbc111ff1566557f6fa8042770814c6398a23f263cbbea55a4de22b

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## 1.0.0 - 2015-08-05
+
+### Changed
+- Fix for some non-ASCII filenames
+- Expire cache based on event time seen, not mtime
+
+## 0.1.0 - 2015-06-04
+
+### Added
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Brian Palmer
+
+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,27 @@
+# FSEvents To VM
+
+Forward OS X file system events to a VM, designed for use with Dinghy.
+
+This is an early proof-of-concept implementation. If it works well in practice, it will be integrated into Dinghy.
+
+# Installation
+
+This is a ruby gem, but isn't published yet. To install, clone the repo and run:
+
+    $ rake install
+
+## Usage
+
+The Dinghy VM must be running. Then in a terminal run:
+
+    $ fsevents_to_vm start
+
+You can specify a specific directory to watch. This directory must be already mounted in the VM over NFS. By default, this means anything in your home dir:
+
+    $ fsevents_to_vm start ~/projects
+
+## Known Limitations
+
+* Delete events are not forwarded.
+* Multiple events for the same file within the same 1/100th of a second may cause events to be missed.
+* Some directories that you are unlikely to care about are ignored, for example `~/Library`.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fsevents_to_vm"
+
+# 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

data/bin/setup

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

data/exe/fsevents_to_vm

@@ -0,0 +1,4 @@
+require 'fsevents_to_vm/cli'
+
+$0 = 'fsevents_to_vm'
+FseventsToVm::Cli.start(ARGV)

data/fsevents_to_vm.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fsevents_to_vm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fsevents_to_vm"
+  spec.version       = FseventsToVm::VERSION
+  spec.authors       = ["Brian Palmer"]
+  spec.email         = ["brian@codekitchen.net"]
+
+  spec.summary       = %q{forward OS X file system events to a VM, designed for use with Dinghy}
+  spec.homepage      = "https://github.com/codekitchen/fsevents_to_vm"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rb-fsevent", "~> 0.9.5"
+  spec.add_dependency "thor", "~> 0.19.1"
+  spec.add_dependency "net-ssh", "~> 2.9.2"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/fsevents_to_vm/cli.rb

@@ -0,0 +1,31 @@
+require 'thor'
+require 'fsevents_to_vm'
+
+module FseventsToVm
+  class Cli < Thor
+    option :debug, type: :boolean, default: false
+    desc "start PATH",
+      "Watch PATH and forward filesystem touch events to the Dinghy VM."
+    def start(listen_dir = ENV['HOME'])
+      debug = options[:debug]
+
+      watcher = FseventsToVm::Watch.new(listen_dir)
+      path_filter = FseventsToVm::PathFilter.new
+      recursion_filter = FseventsToVm::RecursionFilter.new
+      forwarder = FseventsToVm::SshEmit.new
+
+      if debug
+        puts "Watching #{listen_dir} and forwarding events to Dinghy VM..."
+      end
+
+      watcher.run do |event|
+        next if path_filter.ignore?(event)
+        next if recursion_filter.ignore?(event)
+        if debug
+          puts "touching #{event.mtime}:#{event.path}"
+        end
+        forwarder.event(event)
+      end
+    end
+  end
+end

data/lib/fsevents_to_vm/event.rb

@@ -0,0 +1,10 @@
+module FseventsToVm
+  # path: String
+  # mtime: String
+  # event_time: Time
+  class Event < Struct.new(:path, :mtime, :event_time)
+    def self.format_time(time)
+      time.utc.strftime("%Y%m%d%H%M.%S")
+    end
+  end
+end

data/lib/fsevents_to_vm/path_filter.rb

@@ -0,0 +1,11 @@
+module FseventsToVm
+  class PathFilter
+    def initialize
+      @filter = %r{#{ENV['HOME']}/(Library|\.)|/\.(git|hg|svn)/}
+    end
+
+    def ignore?(event)
+      !!@filter.match(event.path)
+    end
+  end
+end

data/lib/fsevents_to_vm/recursion_filter.rb

@@ -0,0 +1,27 @@
+module FseventsToVm
+  class RecursionFilter
+    attr_reader :recent_events
+    
+    def initialize
+      @recent_events = {}
+    end
+
+    def ignore?(event)
+      purge_old_events!
+      existing_event = @recent_events[event.path]
+      if existing_event && existing_event.mtime == event.mtime
+        true
+      else
+        @recent_events[event.path] = event
+        false
+      end
+    end
+
+    private
+
+    def purge_old_events!
+      cutoff = Time.now - 30
+      @recent_events.reject! { |path, event| event.event_time < cutoff }
+    end
+  end
+end

data/lib/fsevents_to_vm/ssh_emit.rb

@@ -0,0 +1,19 @@
+require 'net/ssh'
+require 'shellwords'
+require 'tempfile'
+
+module FseventsToVm
+  class SshEmit
+    def initialize
+      @ssh_config = Tempfile.new('fsevents-ssh-config')
+      @ssh_config.write(`cd /usr/local/var/dinghy/vagrant && vagrant ssh-config --host dinghy`)
+      raise("Could not read Vagrant VM ssh config") unless $?.success?
+      @ssh_config.flush
+      @ssh = Net::SSH.start('dinghy', 'docker', config: @ssh_config.path)
+    end
+
+    def event(event)
+      @ssh.exec!("touch -m -c -t #{event.mtime} #{Shellwords.escape event.path}".force_encoding(Encoding::BINARY))
+    end
+  end
+end

data/lib/fsevents_to_vm/version.rb

@@ -0,0 +1,3 @@
+module FseventsToVm
+  VERSION = "1.0.0"
+end

data/lib/fsevents_to_vm/watch.rb

@@ -0,0 +1,31 @@
+require 'rb-fsevent'
+
+module FseventsToVm
+  class Watch
+    def initialize(*listen_dirs)
+      @listen_dirs = listen_dirs
+      @fs = FSEvent.new
+    end
+
+    def run
+      @fs.watch(@listen_dirs, file_events: true) do |files|
+        files.each do |file|
+          event = build_event(file)
+          yield event if event
+        end
+      end
+      @fs.run
+    end
+
+    private
+
+    def build_event(filepath)
+      mtime = Event.format_time(File.stat(filepath).mtime)
+      Event.new(filepath, mtime, Time.now)
+    rescue Errno::ENOENT
+      # TODO: handling delete events is tricky due to race conditions with rapid
+      # delete/create.
+      nil
+    end
+  end
+end

data/lib/fsevents_to_vm.rb

@@ -0,0 +1,10 @@
+require "fsevents_to_vm/version"
+
+require 'fsevents_to_vm/event'
+require 'fsevents_to_vm/watch'
+require 'fsevents_to_vm/path_filter'
+require 'fsevents_to_vm/recursion_filter'
+require 'fsevents_to_vm/ssh_emit'
+
+module FseventsToVm
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: fsevents_to_vm
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Palmer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: 
+email:
+- brian@codekitchen.net
+executables:
+- fsevents_to_vm
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/fsevents_to_vm
+- fsevents_to_vm.gemspec
+- lib/fsevents_to_vm.rb
+- lib/fsevents_to_vm/cli.rb
+- lib/fsevents_to_vm/event.rb
+- lib/fsevents_to_vm/path_filter.rb
+- lib/fsevents_to_vm/recursion_filter.rb
+- lib/fsevents_to_vm/ssh_emit.rb
+- lib/fsevents_to_vm/version.rb
+- lib/fsevents_to_vm/watch.rb
+homepage: https://github.com/codekitchen/fsevents_to_vm
+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.4.7
+signing_key: 
+specification_version: 4
+summary: forward OS X file system events to a VM, designed for use with Dinghy
+test_files: []