puma-fsevent_cleanup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '02215109366be71de07240a667411257092375b6'
+  data.tar.gz: 8de61acd35e7180f60fb4e555d0bdeb7ee6c7805
+SHA512:
+  metadata.gz: '0608405bf213f8ae814bd852e4a803350442f62c099a02112c862c9bf663c4705004a0a6bd4af31cac53a0c24ea9715f52ba22c00ef3b8511cbc2897b7d1991d'
+  data.tar.gz: d233d9fbf1df1662362a2b6e82a4a0c322abc87d701f3ce4c0286d4467cb7d97ae0c918192d23ca90e5b76d3bbfe93a0bda4c71260d0888d291f0810d04dfc08

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.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joon Lee
+
+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,68 @@
+# Puma::FseventCleanup
+
+Puma plugin to fix running too many fsevent_watch processes.
+Based on https://gist.github.com/steakknife/b318a570803b08c1548c7f51c18c0753
+
+## Problem (on macOS only)
+
+- `Listen` fires up a `fsevent_watch` for every directory watched
+- Puma is a **threaded** server, restarting it doesn't restart the Ruby process
+- The development server + spring uses `Listen` to hot-reload code (models, views, controllers, etc.)
+- Restarting the server doesn't call `#stop` on the `Listen` instances
+- Tons and tons of `fsevent_watch` appear until `fork()` fails
+
+
+## Solution
+
+- Call `#stop` on all `Listen` instances (including yours), to kill off unneeded `fsevent_watch`
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+group :development, :test do
+  gem 'puma-fsevent_cleanup'
+end
+```
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puma-fsevent_cleanup
+
+Add this to your `config/puma.rb`
+
+```ruby
+# config/puma.rb
+
+# kill off fsevent_watch in development
+plugin :fsevent_cleanup
+```
+
+**Notes**
+
+1. Works with MRI
+1. Won't work with JRuby unless ObjectSpace is enabled
+1. Might not work on Rubinius
+1. Don't use `bin/rails s` use `bin/bundle exec puma` because Rails + Puma + `rails c` is broken (both try to write `tmp/pids/server.pid`, rails doesn't like threaded servers restarting themselves)
+
+
+## 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/actmd/puma-fsevent_cleanup.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 'puma/fsevent_cleanup'
+
+# 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,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/lib/puma/fsevent_cleanup/version.rb

@@ -0,0 +1,5 @@
+module Puma
+  module FseventCleanup
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/puma/fsevent_cleanup.rb

@@ -0,0 +1,9 @@
+require 'puma/fsevent_cleanup/version'
+require 'puma/plugin/add_plugin_restart_hook'
+require 'puma/plugin/fsevent_cleanup'
+
+module Puma
+  module FseventCleanup
+    # Your code goes here...
+  end
+end

data/lib/puma/plugin/add_plugin_restart_hook.rb

@@ -0,0 +1,21 @@
+require 'puma/plugin'
+
+Puma::Plugin.create do
+  def config(dsl)
+    Puma::Launcher.class_eval do
+      def fire_plugins_restart
+        @config.plugins.fire_restarts self
+      end
+    end
+
+    Puma::PluginLoader.class_eval do
+      def fire_restarts(launcher)
+        @instances.each do |i|
+          i.restart(launcher) if i.respond_to? :restart
+        end
+      end
+    end
+
+    dsl.on_restart(&:fire_plugins_restart)
+  end
+end

data/lib/puma/plugin/fsevent_cleanup.rb

@@ -0,0 +1,14 @@
+require 'puma/plugin'
+
+Puma::Plugin.create do
+  def config(dsl)
+    dsl.plugin :add_plugin_restart_hook
+  end
+
+  # call #stop on all FSEvent instances
+  # this should close pipes and make fsevent_watch'es die
+  def restart(_launcher)
+    return unless defined? FSEvent
+    ObjectSpace.each_object(FSEvent, &:stop)
+  end
+end

data/puma-fsevent_cleanup.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puma/fsevent_cleanup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'puma-fsevent_cleanup'
+  spec.version       = Puma::FseventCleanup::VERSION
+  spec.authors       = ['Joon Lee']
+  spec.email         = ['joon@act.md']
+
+  spec.summary       = 'Puma plugin to fix running too many fsevent_watch processes'
+  spec.description   = 'Puma plugin to fix running too many fsevent_watch processes'
+  spec.homepage      = 'https://github.com/actmd/puma-fsevent_cleanup'
+  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.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'puma', '~> 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: puma-fsevent_cleanup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joon Lee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: Puma plugin to fix running too many fsevent_watch processes
+email:
+- joon@act.md
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/puma/fsevent_cleanup.rb
+- lib/puma/fsevent_cleanup/version.rb
+- lib/puma/plugin/add_plugin_restart_hook.rb
+- lib/puma/plugin/fsevent_cleanup.rb
+- puma-fsevent_cleanup.gemspec
+homepage: https://github.com/actmd/puma-fsevent_cleanup
+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.8
+signing_key: 
+specification_version: 4
+summary: Puma plugin to fix running too many fsevent_watch processes
+test_files: []