firefly_server 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 503edf23c62eb6a1a859d9c4f6ef6482cc8db055
+  data.tar.gz: f64555becfe12ca611be5af632ae8bb0e9912b35
+SHA512:
+  metadata.gz: 96582493832c8d2db7b2eee7e9c0569627d21fe55140d4768b9004f57573b8f6e7c87a37ae66ef98151742cc9b185a5e78d724e411e94456a5b0ec3e8d8097f4
+  data.tar.gz: 172b1dd44d161a5d593cda10049d124e8a14ab59b1b23fd4ca1d870250e7d6d51a3b8b4632e273e632fd4874a9982759606fcb4d9c1e4fd9b94f9c458a07f2af

data/.byebug_history

@@ -0,0 +1,23 @@
+c
+q
+`echo 'blah' > /tmp/blah.txt`
+file_watcher.listener.processing?
+c
+`echo 'blah' > /tmp/blah.txt`
+file_watcher.listener.processing?
+file_watcher.listener.state
+file_watcher.listener
+c
+file_watcher.listener.processing?
+file_watcher.listener
+c
+listener.processing?
+listener.transition
+listener.processing?
+listener.paused?
+listener.state
+`echo 'blah' > /tmp/blah.txt`
+listener.public_methods.sort - Object.instance_methods
+listener.started?
+listener.start
+listener

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/tests/tmp/*
+*.swp
+*.gem

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at griffithchaffee@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails-firefly_server.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Griffith Chaffee
+
+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,54 @@
+# FireflyServer
+
+Restarts a web server when watched files or directories are changed. Useful for rails applications the cache classes in development. The server runs in the foreground for easy logging and debugger output.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'firefly_server'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firefly_server
+
+## Usage
+
+Create script `bin/firefly_server`
+
+```ruby
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "firefly_server"
+
+server = FireflyServer.new.configure do |config|
+  rails_root = File.expand_path("../..",  __FILE__)
+  # file watcher
+  config.watch_paths = %w[ app lib config vendor db/schemas bin ].map do |rails_dir|
+    "#{rails_root}/#{rails_dir}"
+  end
+  config.ignore_paths = %w[ app/views app/emails ].map do |rails_dir|
+    "#{rails_root}/#{rails_dir}"
+  end
+  # server
+  config.start_server = "rails server -p 8080 -b 0.0.0.0"
+  config.stop_server  = "pkill -INT -f 'puma'"
+  config.pid_file     = "#{rails_root}/tmp/pids/server.pid"
+end
+
+server.start!
+```
+
+Make script executable: `chmod 700 bin/firefly_server`
+
+Start server: `./bin/firefly_server`
+
+## 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 "firefly_server"
+
+# 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/firefly_server.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "firefly_server/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "firefly_server"
+  spec.version       = FireflyServer::VERSION
+  spec.authors       = ["Griffith Chaffee"]
+  spec.email         = ["griffithchaffee@gmail.com"]
+
+  spec.summary       = %q(Restarts a web server when watched files or directories are changed.)
+  spec.description   = %q(Restarts a web server when watched files or directories are changed. Useful for rails applications the cache classes in development.)
+  spec.homepage      = "https://github.com/griffithchaffee/firefly_server"
+  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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/firefly_server.rb

@@ -0,0 +1,70 @@
+require "listen"
+require "firefly_server/version"
+require "firefly_server/configuration"
+require "firefly_server/file_watcher"
+
+class FireflyServer
+  attr_accessor(*%w[ configuration file_watcher ])
+
+  def initialize(params = {})
+    self.configuration = Configuration.new
+    self.file_watcher = FileWatcher.new(configuration)
+  end
+
+  def configure
+    yield(configuration)
+    self
+  end
+
+  def start!
+    configuration.validate!
+    # trap signals and exit
+    configuration.exit_signals.each do |signal|
+      Signal.trap(signal) do
+        puts "\rStopping Firefly Server"
+        exit 130
+      end
+    end
+    # file_watcher loop
+    file_watcher.watch! do |files|
+      puts "Ignored: #{files.ignored.join(", ")}"   if files.ignored?
+      puts "Modified: #{files.modified.join(", ")}" if files.modified?
+      puts "Added: #{files.added.join(", ")}"       if files.added?
+      puts "Removed: #{files.removed.join(", ")}"   if files.removed?
+      # stop server
+      if files.modified? || files.added? || files.removed?
+        puts "Stopping Server: #{configuration.stop_server}"
+        %x(#{configuration.stop_server})
+      end
+    end
+    # server loop
+    restart_attempt = 0
+    loop do
+      # delete stale PID file
+      File.delete(configuration.pid_file) if File.file?(configuration.pid_file)
+      # start server
+      puts "Starting Server: #{configuration.start_server}"
+      # new fork will have nil initial pid
+      server_pid = fork
+      # new fork
+      if server_pid == nil
+        exec(configuration.start_server)
+      else
+        Process.wait(server_pid)
+        server_pid_status = $? # Process.wait sets $? to pid status
+      end
+      # normal restart
+      if server_pid_status.success?
+        restart_attempt = 0
+      # failed restart
+      else
+        restart_attempt += 1
+        # throttle restart attempts to prevent high CPU usage
+        if restart_attempt >= configuration.restart_attempt_throttle_threshold
+          puts "Throttling restart attempts by sleeping #{configuration.restart_attempt_throttle_sleep} seconds"
+          sleep(configuration.restart_attempt_throttle_sleep)
+        end
+      end
+    end
+  end
+end

data/lib/firefly_server/configuration.rb

@@ -0,0 +1,49 @@
+class FireflyServer
+  class Configuration
+    attr_reader(*%w[
+      exit_signals
+      watch_paths
+      ignore_paths
+      file_change_callbacks
+    ])
+    attr_accessor(*%w[
+      start_server
+      stop_server
+      pid_file
+      restart_attempt_throttle_threshold
+      restart_attempt_throttle_sleep
+    ])
+
+    def initialize(params = {})
+      # defaults
+      self.restart_attempt_throttle_threshold = 3
+      self.restart_attempt_throttle_sleep = 3
+      self.exit_signals = %w[ SIGINT ]
+      # watcher defaults
+      self.watch_paths = []
+      self.ignore_paths = []
+      self.file_change_callbacks = []
+      # override defaults
+      params.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    %w[ exit_signals watch_paths ignore_paths file_change_callbacks ].each do |accessor|
+      define_method("#{accessor}=") { |paths| instance_variable_set("@#{accessor}", Array(paths)) }
+    end
+
+    def validate!
+      # validate require options set
+      %w[ start_server stop_server pid_file ].each do |attribute|
+        if !send(attribute)
+          raise(ArgumentError, "#{attribute} option must be provided")
+        end
+      end
+      if watch_paths.empty?
+        raise(ArgumentError, "watch_paths option must be provided")
+      end
+      self
+    end
+  end
+end

data/lib/firefly_server/file_watcher.rb

@@ -0,0 +1,77 @@
+class FireflyServer
+  class FileWatcher
+    attr_reader(*%w[ listener configuration ])
+
+    def initialize(configuration)
+      @configuration = configuration
+      @listener = nil
+    end
+
+    def on_change(&block)
+      configuration.file_change_callbacks << block if block
+      self
+    end
+
+    def watch!(&file_change_callback)
+      # prevent multiple listeners
+      listener.stop if listener
+      # always mute the Listen logger due to verbosity
+      if !Listen.logger
+        Listen.logger = Logger.new(STDOUT)
+        Listen.logger.level = Logger::WARN
+      end
+      @listener = Listen.to(*configuration.watch_paths) do |modified, added, removed|
+        ignored = []
+        [modified, added, removed].each do |paths|
+          # remove ignored paths
+          paths.reject! do |path|
+            configuration.ignore_paths.any? do |ignore_path|
+              if ignore_path.is_a?(String)
+                ignored << path if path.start_with?(ignore_path)
+                true
+              elsif ignore_path.is_a?(Regexp)
+                ignored << path if path =~ ignore_path
+                true
+              else
+                raise(
+                  ArgumentError,
+                  "unknown ignore path (expected string or regex): #{ignore_path.class} - #{ignore_path.inspect}"
+                )
+              end
+            end
+          end
+        end
+        # trigger change callbacks
+        callbacks = (configuration.file_change_callbacks + [file_change_callback]).compact
+        if !callbacks.empty?
+          change_event = ChangeEvent.new(ignored: ignored, modified: modified, added: added, removed: removed)
+          callbacks.each do |callback|
+            callback.call(change_event)
+          end
+        end
+      end
+      listener.start
+      self
+    end
+
+    class ChangeEvent
+      CATEGORIES = %w[ ignored modified added removed ]
+      attr_writer(*CATEGORIES)
+
+      def initialize(params)
+        params.each do |key, value|
+          send("#{key}=", value)
+        end
+      end
+
+      CATEGORIES.each do |accessor|
+        define_method("#{accessor}?") { send(accessor).any? }
+        define_method("#{accessor}") { Array(instance_variable_get("@#{accessor}")) }
+      end
+
+      def to_h
+        CATEGORIES.map { |category| [category.to_sym, send(category)] }.to_h
+      end
+    end
+  end
+end

data/lib/firefly_server/version.rb

@@ -0,0 +1,3 @@
+class FireflyServer
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: firefly_server
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Griffith Chaffee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-12 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'
+description: Restarts a web server when watched files or directories are changed.
+  Useful for rails applications the cache classes in development.
+email:
+- griffithchaffee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- firefly_server.gemspec
+- lib/firefly_server.rb
+- lib/firefly_server/configuration.rb
+- lib/firefly_server/file_watcher.rb
+- lib/firefly_server/version.rb
+homepage: https://github.com/griffithchaffee/firefly_server
+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.11
+signing_key: 
+specification_version: 4
+summary: Restarts a web server when watched files or directories are changed.
+test_files: []