flame_server_toys 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f45aba613713cf69e1168a2ee6dac2391d22f034f707ac8651445d284c37c6a
+  data.tar.gz: e379aac82ee993b8469031b147ba217f83bd3d92f85eba7608c4e8bf53a6dcea
+SHA512:
+  metadata.gz: 02ca275f76b08a1a388a8e1e14bcf25ac0508dde5978fe5744229e8f5e340bb9d42716fb0fa6cf52031b99785335546f5e6cdafb942b739eb74b9fc8e143838e
+  data.tar.gz: 779be44bf684f2351ecbc1e4a59ab9dc7bcfdd05b9599dd2af43e402ba84c5d97bba6b04dc7f6bf7a822a45f67e0cb270840e45092937494801343f338f97222

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## master (unreleased)
+
+## 0.2.2 (2020-09-23)
+
+## 0.2.1 (2020-08-24)
+
+*   Fix system calls.
+
+## 0.2.0 (2020-08-23)
+
+*   Update `toys`.
+
+## 0.1.1 (2020-08-21)
+
+*   Wrap `sh` into `Bundler.with_unbundled_env`.
+    See <https://github.com/dazuma/toys/issues/65>.
+*   Deny `phased-restart` when there is no `prune_bundler` in Puma's config.
+
+## 0.1.0 (2020-08-02)
+
+*   Initial release.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alexander Popov
+
+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 @@
+# Flame Server Toys
+
+[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/flame_server_toys?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/flame_server_toys)
+[![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/flame_server_toys/master.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/flame_server_toys)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/flame_server_toys.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/flame_server_toys)
+[![Depfu](https://img.shields.io/depfu/AlexWayfer/flame_server_toys?style=flat-square)](https://depfu.com/repos/github/AlexWayfer/flame_server_toys)
+[![Inline docs](https://inch-ci.org/github/AlexWayfer/flame_server_toys.svg?branch=master)](https://inch-ci.org/github/AlexWayfer/flame_server_toys)
+[![License](https://img.shields.io/github/license/AlexWayfer/flame_server_toys.svg?style=flat-square)](https://github.com/AlexWayfer/flame_server_toys/blob/master/LICENSE.txt)
+[![Gem](https://img.shields.io/gem/v/flame_server_toys.svg?style=flat-square)](https://rubygems.org/gems/flame_server_toys)
+
+Toys for [Flame](https://github.com/AlexWayfer/flame) web application server management,
+like start, stop, restart, etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flame_server_toys'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install flame_server_toys
+```
+
+## Usage
+
+```ruby
+## .toys/.toys.rb
+require "#{__dir__}/../config/base"
+
+require 'flame_server_toys'
+expand FlameServerToys::Template,
+  config_proc: (proc do
+    MyProject::Config::Base.new
+  end)
+```
+
+On `start` and `restart` commands in `development` environment there will be spawned
+[Filewatchers](https://github.com/filewatcher/filewatcher) from `filewatcher.yaml` file.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+Then, run `toys rspec` to run the tests.
+
+To install this gem onto your local machine, run `toys gem install`.
+
+To release a new version, run `toys gem release %version%`.
+See how it works [here](https://github.com/AlexWayfer/gem_toys#release).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/AlexWayfer/flame_server_toys).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/lib/flame_server_toys.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'flame_server_toys/version'
+require_relative 'flame_server_toys/template'

data/lib/flame_server_toys/template.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'toys-core'
+
+module FlameServerToys
+	## Root template for `server` tool
+	class Template
+		include Toys::Template
+
+		attr_reader :config_proc
+
+		def initialize(config_proc:)
+			@config_proc = config_proc
+		end
+
+		on_expand do |template|
+			tool :server do
+				require_relative 'template/_base'
+
+				subtool_apply do
+					## Order is important because `sh` is overriding in `CommonCode`
+
+					include :exec, exit_on_nonzero_status: true
+
+					include Template::Base::CommonCode
+				end
+
+				require 'gorilla_patch/inflections'
+				using GorillaPatch::Inflections
+
+				%w[start stop restart phased_restart monitor status].each do |subtool|
+					require_relative "template/#{subtool}"
+					expand Template.const_get(subtool.camelize, false), config_proc: template.config_proc
+				end
+			end
+
+			alias_tool :s, :server
+		end
+	end
+end

data/lib/flame_server_toys/template/_base.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'memery'
+require 'yaml'
+
+require_relative '_pids_file'
+
+module FlameServerToys
+	class Template
+		## Base class for toys
+		class Base
+			include Toys::Template
+			include Memery
+
+			def initialize(config_proc:)
+				@config_proc = config_proc
+			end
+
+			memoize def config
+				@config_proc.call
+			end
+
+			## Common code for toys
+			module CommonCode
+				include Memery
+
+				private
+
+				def sh(command, print: true, exit_on_fail: true)
+					options = {}
+					options[:log_level] = Logger::UNKNOWN if print
+					options[:exit_on_nonzero_status] = exit_on_fail
+					super sh_command(command), **options
+				end
+
+				def sh_spawn(command, print: true)
+					puts "spawn #{command}" if print
+					spawn sh_command(command), pgroup: true
+				end
+
+				def sh_command(command)
+					require 'shellwords'
+
+					escaped_command = Shellwords.escape(command)
+					"sh -c #{escaped_command}"
+				end
+
+				def server(command)
+					puts "Environment: #{@config[:environment]}"
+
+					sh "#{context_directory}/exe/setup/ruby.sh"
+					sh("#{context_directory}/exe/setup/node.sh") if %i[start restart].include?(command)
+
+					if %i[stop restart].include?(command)
+						filewatcher_pids_file = pids_file_class.new(:filewatcher)
+						filewatcher_pids_file.kill_each.delete
+					end
+
+					web_server(command)
+				end
+
+				def web_server(command)
+					if @config[:environment] == 'development' && %i[start restart].include?(command)
+						return development_restart
+					end
+
+					waiting_mailing_lock if %i[stop restart phased-restart].include?(command)
+					puma_command command
+				end
+
+				def puma_command(command)
+					## Don't use `bundle exec`: https://github.com/dazuma/toys/issues/65
+					sh "pumactl #{command}"
+				end
+
+				def development_restart
+					spawn_development_filewatchers
+
+					puma_command File.exist?(@config[:server][:puma_pid_file]) ? 'restart' : 'start'
+				rescue SystemExit, Interrupt => e
+					pids_file_class.new(:filewatcher).kill_each.delete
+
+					raise e
+				end
+
+				def spawn_development_filewatchers
+					development_filewatchers =
+						YAML.load_file("#{context_directory}/filewatchers.yaml").map do |args|
+							filewatcher_command args[:pattern], args[:command], exclude: args[:exclude]
+						end
+
+					filewatcher_pids = development_filewatchers.map { |command| sh_spawn command }
+
+					pids_file_class.new(:filewatcher, filewatcher_pids).dump
+				end
+
+				def filewatcher_command(pattern, execute, exclude: nil)
+					## Don't use `bundle exec`, it's already required by `toys`
+					## https://github.com/dazuma/toys/issues/65
+					<<-CMD.split.join(' ')
+						filewatcher #{"--exclude '#{exclude}'" unless exclude.nil?} '#{pattern}' '#{execute}'
+					CMD
+				end
+
+				def waiting_mailing_lock
+					while Dir[File.join(@config[:tmp_dir], 'mailing_*')].any?
+						puts Paint['Mails sending in progress!', :bold, :red]
+						puts 'Waiting...'
+						sleep 1
+					end
+				end
+
+				memoize def pids_file_class
+					subclass = Class.new(PidsFile)
+					pids_dir = @config[:pids_dir]
+					subclass.class_exec do
+						self.pids_dir = pids_dir
+					end
+					subclass
+				end
+			end
+		end
+	end
+end

data/lib/flame_server_toys/template/_pids_file.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'fileutils'
+
+module FlameServerToys
+	class Template
+		## Class for pids files
+		class PidsFile
+			class << self
+				## It will be set in the Base template from received config
+				attr_accessor :pids_dir
+			end
+
+			def initialize(name, *pids)
+				@file = File.join self.class.pids_dir, "#{name}.pids"
+				@pids = pids.any? ? pids : read
+			end
+
+			def dump(pids = @pids)
+				FileUtils.mkdir_p self.class.pids_dir
+				puts "PidsFile dump : #{pids} => #{@file}"
+				File.write @file, pids.join($RS)
+			end
+
+			def read
+				return unless File.exist?(@file)
+
+				@pids = File.read(@file).split($RS).map(&:to_i)
+				puts "PidsFile read : #{@pids}"
+				@pids
+			end
+
+			def kill_each(pids = @pids)
+				Array(pids).each do |pid|
+					puts "PidsFile kill : #{pid}"
+					Process.kill('TERM', -Process.getpgid(pid))
+				rescue Errno::ESRCH
+					puts "Process #{pid} doesn't exist"
+				end
+				self
+			end
+
+			def delete
+				return unless File.exist?(@file)
+
+				File.delete @file
+			end
+		end
+
+		private_constant :PidsFile
+	end
+end

data/lib/flame_server_toys/template/monitor.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FlameServerToys
+	class Template
+		## Monitor server logs
+		class Monitor < Base
+			on_expand do |template|
+				tool :monitor do
+					to_run do
+						@config = template.config
+
+						sh "tail -f #{File.join(@config[:logs_dir], '{stdout,stderr}')}"
+					end
+				end
+			end
+		end
+	end
+end

data/lib/flame_server_toys/template/phased_restart.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FlameServerToys
+	class Template
+		## Phased restart server
+		class PhasedRestart < Base
+			on_expand do |template|
+				tool 'phased-restart' do
+					to_run do
+						@config = template.config
+
+						puma_config = File.read "#{context_directory}/config/puma.rb"
+						unless puma_config.lines.any? { |line| line.start_with? 'prune_bundler' }
+							puts "Don't do phased restart without `prune_bundler` in Puma config."
+							return
+						end
+
+						server 'phased-restart'
+					end
+				end
+			end
+		end
+	end
+end

data/lib/flame_server_toys/template/restart.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FlameServerToys
+	class Template
+		## Restart server
+		class Restart < Base
+			on_expand do |template|
+				tool :restart do
+					to_run do
+						@config = template.config
+
+						server :restart
+					end
+				end
+			end
+		end
+	end
+end

data/lib/flame_server_toys/template/start.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FlameServerToys
+	class Template
+		## Start server
+		class Start < Base
+			on_expand do |template|
+				tool :start do
+					to_run do
+						@config = template.config
+
+						server :start
+					end
+				end
+			end
+		end
+	end
+end

data/lib/flame_server_toys/template/status.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module FlameServerToys
+	class Template
+		## Status of server
+		class Status < Base
+			on_expand do |template|
+				tool :status do
+					to_run do
+						@config = template.config
+
+						puts
+						puts 'Filewatcher:'
+						puts
+						ps_with_grep '[f]ilewatcher'
+						puts
+						puts 'Puma:'
+						puts
+						ps_with_grep '[p]uma[\ :]'
+					end
+
+					private
+
+					def ps_with_grep(pattern)
+						sh "ps aux | grep #{pattern} --color", print: false, exit_on_fail: false
+					end
+				end
+
+				alias_tool :ps, :status
+			end
+		end
+	end
+end

data/lib/flame_server_toys/template/stop.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FlameServerToys
+	class Template
+		## Stop server
+		class Stop < Base
+			on_expand do |template|
+				tool :stop do
+					to_run do
+						@config = template.config
+
+						server :stop
+
+						pids_file_class.new(:filewatcher).kill_each.delete
+					end
+				end
+			end
+		end
+	end
+end

data/lib/flame_server_toys/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FlameServerToys
+	VERSION = '0.2.2'
+end

metadata

@@ -0,0 +1,259 @@
+--- !ruby/object:Gem::Specification
+name: flame_server_toys
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Alexander Popov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: alt_memery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: filewatcher-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: gorilla_patch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: toys-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: gem_toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.91.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.91.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'Toys for Flame web application server management, like start, stop,
+  restart, etc.
+
+  '
+email:
+- alex.wayfer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/flame_server_toys.rb
+- lib/flame_server_toys/template.rb
+- lib/flame_server_toys/template/_base.rb
+- lib/flame_server_toys/template/_pids_file.rb
+- lib/flame_server_toys/template/monitor.rb
+- lib/flame_server_toys/template/phased_restart.rb
+- lib/flame_server_toys/template/restart.rb
+- lib/flame_server_toys/template/start.rb
+- lib/flame_server_toys/template/status.rb
+- lib/flame_server_toys/template/stop.rb
+- lib/flame_server_toys/version.rb
+homepage: https://github.com/AlexWayfer/flame_server_toys
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/AlexWayfer/flame_server_toys
+  homepage_uri: https://github.com/AlexWayfer/flame_server_toys
+  changelog_uri: https://github.com/AlexWayfer/flame_server_toys/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Toys for Flame web application server management
+test_files: []