lmkplz 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82e82948b2d9a2add011652c29c20d66d70dbc11
+  data.tar.gz: dabc6102fb266bac86539dde32c6a87f31091bdf
+SHA512:
+  metadata.gz: 55531253878e6a32db5158490b154b31b5c9a7152da45a7cbaafdcf73467643c1e6d067c2f175cf8102d0fc939a6f4f0d0c391cf6ced2c7b3e77094578cee424
+  data.tar.gz: 755269235fb0fd7481cf7e313487bf3c96e190de857a134d3e15a74311ae2ba3b88b7881570cdb0a63854f65b97f2980bafd7fea5a0ba8f4862e5297967c68a3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Zach Ahn
+
+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,50 @@
+# LMKPLZ
+
+(Let Me Know PLeaZe)
+
+Lmkplz is a gem that lets you know when it notices filesystem changes.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "lmkplz"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lmkplz
+
+You will also probably need to have [Rust](https://www.rust-lang.org/) installed
+to compile the backend
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/zachahn/lmkplz.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/lib/lmkplz/encasement.rb

@@ -0,0 +1,74 @@
+module Lmkplz
+  class Encasement
+    def initialize
+      @callback_mutex = Mutex.new
+      @add_paths_mutex = Mutex.new
+      @add_paths_queue = []
+      @gather_event_duration_ms = 200
+      @callbacks = Hash.new { -> {} }
+    end
+
+    def self.define_settable_callback(name)
+      define_method("on_#{name}") do |&block|
+        @callback_mutex.synchronize { @callbacks[name] = block }
+      end
+    end
+
+    define_settable_callback :success
+    define_settable_callback :failure
+    define_settable_callback :timeout
+    define_settable_callback :end
+
+    def malloc
+      kkttyl
+
+      @add_paths_mutex.synchronize do
+        while @add_paths_queue.any?
+          add(@add_paths_queue.pop)
+        end
+      end
+    end
+
+    def free
+      if !active?
+        return
+      end
+
+      Metal.kkttyl_free(kkttyl)
+      @kkttyl = nil
+    end
+
+    def add(dir)
+      if active?
+        Metal.kkttyl_add(kkttyl, dir)
+      else
+        @add_paths_mutex.synchronize do
+          @add_paths_queue.push(dir)
+        end
+      end
+    end
+
+    def await
+      if !active?
+        raise "Call #malloc before #await"
+      end
+
+      callbacks =
+        @callback_mutex.synchronize do
+          @callbacks.values_at(:success, :failure, :timeout, :end)
+        end
+
+      Metal.kkttyl_await(kkttyl, 40, *callbacks)
+    end
+
+    def active?
+      !!@kkttyl
+    end
+
+    private
+
+    def kkttyl
+      @kkttyl ||= Metal.kkttyl_new(@gather_event_duration_ms)
+    end
+  end
+end

data/lib/lmkplz/file_filter.rb

@@ -0,0 +1,47 @@
+module Lmkplz
+  class FileFilter
+    def initialize(only: nil, except: nil)
+      @matcher =
+        if only && except
+          raise "`only` and `except` params are mutually exclusive"
+        elsif only
+          -> (path) { path =~ only }
+        elsif except
+          -> (path) { path !~ except }
+        else
+          -> (_path) { true }
+        end
+    end
+
+    def call(modified_raw, created_raw, removed_raw)
+      paths =
+        [modified_raw, created_raw, removed_raw]
+          .map(&method(:match_or_empty))
+          .map(&method(:empty_to_nil))
+
+      if paths.none?
+        return
+      end
+
+      yield(*paths)
+    end
+
+    private
+
+    def match_or_empty(path)
+      if @matcher.call(path)
+        path
+      else
+        ""
+      end
+    end
+
+    def empty_to_nil(path)
+      if path == ""
+        nil
+      else
+        path
+      end
+    end
+  end
+end

data/lib/lmkplz/metal.rb

@@ -0,0 +1,44 @@
+module Lmkplz
+  module External
+    def self.path
+      if $USE_DEBUG_KKTTYL
+        warn "Using debug build"
+        debug_path
+      else
+        release_path
+      end
+    end
+
+    def self.release_path
+      "ext/kkttyl/target/release/libkkttyl.#{FFI::Platform::LIBSUFFIX}"
+    end
+
+    def self.debug_path
+      "ext/kkttyl/target/debug/libkkttyl.#{FFI::Platform::LIBSUFFIX}"
+    end
+  end
+
+  module Metal
+    extend FFI::Library
+
+    ffi_lib External.path
+
+    callback :success_callback, %i[string string string], :void
+    callback :failure_callback, %i[], :void
+    callback :timeout_callback, %i[], :void
+    callback :end_callback, %i[], :void
+
+    attach_function :kkttyl_new, %i[uint64], :pointer
+    attach_function :kkttyl_free, %i[pointer], :void
+    attach_function :kkttyl_add, %i[pointer string], :void
+    attach_function :kkttyl_await, \
+      %i[
+        pointer
+        uint64
+        success_callback
+        failure_callback
+        timeout_callback
+        end_callback
+      ], :void
+  end
+end

data/lib/lmkplz/repeatedly.rb

@@ -0,0 +1,47 @@
+module Lmkplz
+  class Repeatedly
+    attr_reader :callbacker
+
+    def initialize(*paths, only: nil, except: nil, &block)
+      @block = block
+      @file_filter = FileFilter.new(only: only, except: except)
+      paths.each { |path| interface.add(path) }
+
+      interface.on_success do |m, c, r|
+        @file_filter.call(m, c, r) do |mm, cc, rr|
+          @block.call(mm, cc, rr)
+        end
+      end
+    end
+
+    def start
+      interface.malloc
+      the_loop
+
+      nil
+    end
+
+    def pause
+      if @the_loop.nil?
+        return
+      end
+
+      the_loop.kill
+      @the_loop = nil
+    end
+
+    private
+
+    def the_loop
+      @the_loop ||= Thread.new do
+        loop do
+          interface.await
+        end
+      end
+    end
+
+    def interface
+      @interface ||= Encasement.new
+    end
+  end
+end

data/lib/lmkplz/version.rb

@@ -0,0 +1,3 @@
+module Lmkplz
+  VERSION = "0.0.1".freeze
+end

data/lib/lmkplz.rb

@@ -0,0 +1,12 @@
+require "ffi"
+require "thread"
+require "logger"
+
+# Private
+require "lmkplz/encasement"
+require "lmkplz/file_filter"
+require "lmkplz/metal"
+require "lmkplz/version"
+
+# Public
+require "lmkplz/repeatedly"

data/lmkplz.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lmkplz/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "lmkplz"
+  spec.version = Lmkplz::VERSION
+  spec.authors = ["Zach Ahn"]
+  spec.email = ["engineering@zachahn.com"]
+
+  spec.summary = "LMK when a file changes"
+  spec.description = "Filesystem watcher"
+  spec.license = "MIT"
+
+  spec.files =
+    `git ls-files -z`
+      .split("\x0")
+      .+(Dir.glob("ext/kkttyl/target/release/libkkttyl.*"))
+      .reject { |f| f.match(%r{^(bin|test|spec|features|ext)/}) }
+      .reject { |f| f == "Rakefile" }
+      .reject { |f| f.match(/^\./) }
+      .reject { |f| f.match(%r{\Aext/kkttyl/.*\.d\z}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "ffi", "~> 1.9"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "the_bath_of_zahn"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: lmkplz
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zach Ahn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: the_bath_of_zahn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Filesystem watcher
+email:
+- engineering@zachahn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/lmkplz.rb
+- lib/lmkplz/encasement.rb
+- lib/lmkplz/file_filter.rb
+- lib/lmkplz/metal.rb
+- lib/lmkplz/repeatedly.rb
+- lib/lmkplz/version.rb
+- lmkplz.gemspec
+homepage: 
+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: LMK when a file changes
+test_files: []