puma-daemon 0.1.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 354e2bfa89bfc2998f3b70ecd66a9854f0e6ae181f4d58646571afd50c8d85f9
-  data.tar.gz: e9c5d6f64616786ffb204e156546d320afe0cfbdf6a13045156d37b850436b21
+  metadata.gz: e7b8150de79698d1088f01144bb81576619499a8fe9aef1100ff1af34ba494e6
+  data.tar.gz: d5d18c2979ed94fffb92a54dcd84c4376bd4fb38496fb0355a4777f7735fc820
 SHA512:
-  metadata.gz: 478d5657a49012c23b2b215aaa172f2e56b81116570d98dc78c980da0cf58c6b886b334385f41c4eff3eb592534ae27c68b47e4c700137dde2d87927259ac7ab
-  data.tar.gz: 9d95ce3e1b76e153e2eee51e6d3f007aca208afd7ce907d2ee23d07bbc90f6f41e8943964d7800d848fda3c97e1cd400a3cee4f4af5fc646f65f51ef80c1999a
+  metadata.gz: a4795d230cc70bfe87b7477f0fbbf07e323daf828d0e592bfe7c39f163920102e9fd058e9033aef7861d04b756541816b632f467dcff52e68c847e639f4e2f52
+  data.tar.gz: 60ff6ab16ece8f09c415e5be2a967df283159d6415d36ab5047c537b23f402fd3c55066e12c488e1f5f812c92dc478f15a305f8081ceb815e655113bfd84242f

data/.github/workflows/main.yml

@@ -7,20 +7,34 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [3.0.0, 2.7.2, 2.6.6, 2.5.7]
+        ruby-version: [3.2.0, 3.1.3, 3.0.5, 2.7.2, 2.6.6, 2.5.7]
+
+    env:
+      RUBY_VERSION: ${{ matrix.ruby-version }}
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
     steps:
     - uses: actions/checkout@v2
+
     - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
-    - name: Install dependencies
-      run: bundle install
-    - name: Run RSpecs
-      run: bundle exec rspec --color
-    - name: Run Rubocop
+
+    - name: Run Specs
+      run: make test-all
+
+    - name: Rubocop
       run: bundle exec rubocop
-    - name: Upload Code Coverage
-      run: bash <(curl -s https://codecov.io/bash)
+
+    - uses: codecov/codecov-action@v3
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
+        directory: coverage
+        env_vars: RUBY_VERSION
+        files: codecov-result.json
+        flags: unittests # optional
+        name: codecov-umbrella # optional
+        fail_ci_if_error: true # optional (default = false)
+        verbose: true # optional (default = false)
 

data/.gitignore

@@ -24,3 +24,5 @@
 **/tmp/
 /tmp/*
 /tmp/pids/*
+/Gemfile
+**/.DS_Store

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 # Changelog
 
+## [v0.2.1](https://github.com/kigster/puma-daemon/tree/v0.2.1) (2023-03-07)
+
+[Full Changelog](https://github.com/kigster/puma-daemon/compare/v0.2.0...v0.2.1)
+
+**Fixed bugs:**
+
+- pumad doesn't work with puma v6 [\#10](https://github.com/kigster/puma-daemon/issues/10)
+- doesn't daemonize [\#9](https://github.com/kigster/puma-daemon/issues/9)
+- Log is not working [\#8](https://github.com/kigster/puma-daemon/issues/8)
+- Currently breaks in a single \(non-cluster\) mode [\#1](https://github.com/kigster/puma-daemon/issues/1)
+
+**Merged pull requests:**
+
+- Hopefully fixing demonization for Puma v5 and v6 [\#11](https://github.com/kigster/puma-daemon/pull/11) ([kigster](https://github.com/kigster))
+
+## [v0.2.0](https://github.com/kigster/puma-daemon/tree/v0.2.0) (2023-03-07)
+
+[Full Changelog](https://github.com/kigster/puma-daemon/compare/v0.1.2...v0.2.0)
+
+**Merged pull requests:**
+
+- Fix README spelling [\#7](https://github.com/kigster/puma-daemon/pull/7) ([lulalala](https://github.com/lulalala))
+
+## [v0.1.2](https://github.com/kigster/puma-daemon/tree/v0.1.2) (2021-03-05)
+
+[Full Changelog](https://github.com/kigster/puma-daemon/compare/v0.1.1...v0.1.2)
+
+**Fixed bugs:**
+
+- uninitialized constant Puma::HAS\_SSL \(NameError\) [\#3](https://github.com/kigster/puma-daemon/issues/3)
+
+**Merged pull requests:**
+
+- Hoping to fix HAS\_SSL error [\#5](https://github.com/kigster/puma-daemon/pull/5) ([kigster](https://github.com/kigster))
+- Adding dockerfiles for testing Puma on Linux [\#2](https://github.com/kigster/puma-daemon/pull/2) ([kigster](https://github.com/kigster))
+
 ## [v0.1.1](https://github.com/kigster/puma-daemon/tree/v0.1.1) (2021-01-24)
 
 [Full Changelog](https://github.com/kigster/puma-daemon/compare/v0.1.0...v0.1.1)

data/Dockerfile.download

@@ -13,7 +13,7 @@
 #    $ bundle exec rspec
 #    $ bundle exec puma -C config/puma.rb spec/fixtures/lobster.ru
 #    
-FROM ruby:3.0.0
+FROM ruby:3.1
 
 RUN apt-get update -y && \
     apt-get install -yqq \

data/{Gemfile → Gemfile.puma-v5}

@@ -5,7 +5,9 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in puma-daemon.gemspec
 gemspec
 
+gem 'puma', '~> 5.0'
 gem 'rake', '~> 13.0'
+
 group :test do
   gem 'codecov', require: false
   gem 'rspec', '~> 3.0'

data/Gemfile.puma-v6

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puma-daemon.gemspec
+gemspec
+
+gem 'puma', '~> 6.0'
+gem 'rake', '~> 13.0'
+
+group :test do
+  gem 'codecov', require: false
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '~> 0.80'
+end

data/Makefile

@@ -16,6 +16,23 @@ PUMAD_HOME			:= $(shell dirname $(MAKEFILE_PATH))
 help:	   			## Prints help message auto-generated from the comments.
 				@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
+puma-v5: 			## Installs puma 5.0.0
+				@ln -nfs Gemfile.puma-v5 Gemfile
+				@bundle install
+
+puma-v6: 			## Installs puma 5.0.0
+				@ln -nfs Gemfile.puma-v6 Gemfile
+				@bundle install
+
+test:				## Runs the test suite
+				@bundle exec rspec
+
+test-all:			## Test all supported Puma Versions
+				make puma-v5
+				make test
+				make puma-v6
+				make test
+				
 docker-build-ruby:		## Builds the Docker image by compiling ruby 3.0.0
 				@docker build -f Dockerfile.build    -t puma-daemon:latest .
 
@@ -28,4 +45,10 @@ docker-build-run: 		docker-build-ruby ## Drops you into a BASH session on ubuntu
 docker-download-run: 		docker-download-ruby ## Drops you into a BASH session on ubuntu with ruby 3.0.0
 				@docker run -it puma-daemon:latest
 
+generate-pdf:			## Regenerates README,pdf from README.adoc
+				@bash -c "[[ -d ~/.bashmatic ]] || git clone https://github.com/kigster/bashmatic ~/.bashmatic"
+				@bash -c "source ~/.bashmatic/init.sh && ~/.bashmatic/bin/adoc2pdf README.adoc"
+
+clean:				## Clean-up
+				@rm -rf Gemfile Gemfile.lock coverage 
  

data/README.adoc

@@ -4,64 +4,132 @@
 :sectnums:
 :icons: font
 
-image:https://github.com/kigster/puma-daemon/workflows/Ruby/badge.svg[link=https://github.com/kigster/puma-daemon/actions?query=workflow%3ARuby] image:https://codecov.io/gh/kigster/puma-daemon/branch/master/graph/badge.svg?token=asxarMSGbz[link=https://codecov.io/gh/kigster/puma-daemon]
+[cols="2,7",width="100%",align="center",options="header"]
+|===
 
-In version 5.0 of the popular Ruby HTTP server https://github.com/puma/puma[Puma] the developers chose to https://github.com/puma/puma/pull/2170/files[drop the daemonization] support from Puma. They did that because the code wasn't actively maintained. Other and perhaps better options now exist (such as `systemd`, etc), not to mention that many people have switched to Kubernetes and Docker, where you generally want to start all servers in the foreground.
+|Badge
+|Type
 
-And yet, on occasion, it was rather useful and straightforward to use the built-in daemonization feature that was cross-platform and is now gone. Some folks are still using this feature and are therefore stuck with Puma version 4, or must wrap Puma either in the `systemd` manifest or `launchctl plist` on Mac OS-X, or a Docker container. Well, **not anymore!** 
+|Test Suite
+|image:https://github.com/kigster/puma-daemon/workflows/Ruby/badge.svg[link=https://github.com/kigster/puma-daemon/actions?query=workflow%3ARuby,width="150"]
 
-NOTE: Add this gem to your dependencies, and make a one line change either in your `config/puma.rb` file, or use `pumad` binary to start Puma as per usual, and you can even leave `-d` flags there (they are ignored when started via `pumad`, and Puma always goes to the background when started that way).
 
-One of the nice features of the old daemonization functionality was that it worked across all platforms. 
+|Licensing
+|image:https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkigster%2Fpuma-daemon.svg?type=shield[link=https://app.fossa.com/projects/git%2Bgithub.com%2Fkigster%2Fpuma-daemon?ref=badge_shield,width="190"]
 
-So, if you want to use the latest and greatest Puma 5+, but have it self-daemonize, this gem is for you.
+|Gem Version
+|image:https://badge.fury.io/rb/puma-daemon.svg["Gem Version",link="https://badge.fury.io/rb/puma-daemon",width="220s"]
 
-== Compatility
+|Test Coverage
+|image:https://codecov.io/gh/kigster/puma-daemon/branch/master/graph/badge.svg?token=asxarMSGbz[link=https://codecov.io/gh/kigster/puma-daemon,width="220"]
 
-We did not restore the daemonization code for JRuby; so at the moment this will work with the MRI distribution,  and possibly others that support `Process.daemon(true)`.
+|Coverage Areas
+|image:https://codecov.io/gh/kigster/puma-daemon/branch/master/graphs/sunburst.svg?token=asxarMSGbz[sunbirst,width="30%",link=https://codecov.io/gh/kigster/puma-daemon,float=left] image:https://codecov.io/gh/kigster/puma-daemon/branch/master/graphs/icicle.svg?token=asxarMSGbz[coverage-graph,width="60%",link=https://codecov.io/gh/kigster/puma-daemon,float=right]
 
-We currently run CI suite on Github Actions against
+|===
 
- * MRI Ruby 3.0.0
- * MRI Ruby 2.7.2
- * MRI Ruby 2.6.6
- * MRI Ruby 2.5.7
+NOTE: You can read this in a nicely formatted https://github.com/kigster/puma-daemon/blob/master/README.pdf[README.pdf] document.
 
+== Usage for the Impatient
 
-== Design Decisions 
+1. Add `gem 'puma-daemon'` to your Gemfile. If you prefer, you can add `require: false` (your Rails instances such as Sidekiq will have no use for this gem).
 
-This gem's goal was to surgically augment Puma's source code to restore daemonization by merely requiring `puma/daemon`. We almost got there, but not quite.
+2. You have two options to daemonize Puma using this gem:
 
-While this was an admirable goal, it has not been accomplished in the current version.  The internals of Puma isn't very easy to monkey-patch or augment. For example, we couldn't think of a way to add back the `-d` flags to the Option Parsing method without having to override the entire method: — which is _not a good solution_, because — what if Puma developers add a new flag in the future? We would have to keep this overridden method frequently updated and potentially choose a different version depending on what version of Puma you are using. That sounds like a nightmare.
+a. In your `config/puma.rb` file, add the following line: `require 'puma/daemon'` at the top, and at the bottom call `daemonize`.
+b. Wherever you use `puma` to start it (except using puma-ctl) replace `puma` with `pumad` and daemonization will be enabled automatically.
 
-It is why instead, we took an approach that requires you — the user — to make a couple of small changes in your Puma configuration to bring daemonization back, or in your scripts, change `puma` to `pumad`, and everything should work. If you run into problems, please https://github.com/kigster/puma-daemon/issues/new[submit an issue].
 
-== Installation
+== Introduction
+
+Let's start with the facts: https://github.com/puma/puma[Puma] is the most popular server to run Ruby and Rails applications. It's both multi-threaded and multi-process, making it one of the only servers that can truly saturate your web hardware. While 100% saturation is probably not what you want, the alternative is paying a fortune for under-utilized hardware. A good rule of thumb is to keep your web servers busy around 70-80% most of the time. Puma let's you do that by configuring the number of workers and threads within each worker.
+
+=== What is Daemonization?
+
+Unix processes have the ability to daemonize and go into the background.
+
+This is not a trivial task: to properly daemonize a process must detach the from controlling terminal and run in the background as a system daemon.
+
+In Ruby this is accomplished with the https://ruby-doc.org/core-3.0.1/Process.html#method-c-daemon[Process.daemon] method, which receives two boolean arguments:
+
+* Unless the first argument `nochdir` is `true`, it will change the current working directory to the root (“/”).
+* Unless the second argument `noclose` is true, `daemon()` will also redirect standard input, standard output and standard error to `/dev/null`.
+* Finally, it will return zero on success, or raise one of ` Errno::*` and pass the control to the subsequent Ruby code, which will now continue executing within a daemon.
+
+=== Why was it removed from Puma v5?
+
+For production deployments, tools like `systemd` offer much better alternative, including ability to cap overall memory and CPU consumed by the Puma and all of its workers using Linux cgroups.
+
+The proliferation of Docker deployments meant that Puma is run on the foreground within a Docker container.
+
+Finally, the code which previously daemonized Puma in version 4 was not really maintained, and for this reason was removed from Puma version 5.
+
+=== What does `puma-daemon` do?
+
+We thought that while the core Puma removing daemonization was the right move, it felt useful in some occastions and so we created this gem to restore the daemonization functionality to Puma v5+.
+
+== Compatibility
+
+=== Ruby Versions
+
+We did not restore the daemon functionality for JRuby; so at the moment this will work with the MRI distribution, and possibly others that support https://ruby-doc.org/core-2.6.1/Process.html#method-c-daemon[`Process.daemon(true, true)`].
+
+For supported MRI Ruby Versions see the https://github.com/kigster/puma-daemon/blob/master/.github/workflows/main.yml#L10[Github Workflow] file.
+
+=== Puma Versions
+
+Currently Puma versions 5 and 6 are supported.
+
+=== Known Issues
+
+Please see the list of open issues on the https://github.com/kigster/puma-daemon/issues[Issues Page].
+Any help is always welcomed.
+
+=== How it works?
+
+This gem's goal was to surgically augment Puma's source code to restore daemonization by merely requiring `puma/daemon`.
+
+We accomplished this goal by adding the daemonization call to the routine `output_header()` which is invoked by both `Puma::Single` runner and the `Puma::Cluster` runner at the very beginning of the launch process.
+While relatively brittle, particularly if the future versions of Puma change this, this approach seems to work with the currently released version of Puma (5 and 6).
+
+If you run into problems, please https://github.com/kigster/puma-daemon/issues/new[submit an issue].
+
+== Examples
 
 Add this line to your application's Gemfile:
 
 [source,ruby]
 ----
 gem 'puma-daemon', require: false
-gem 'puma',  '~> 5'
+gem 'puma',  '~> 5' # or 6
 ----
 
-And then execute:
+In your `config/puma.rb`, eg.
 
- $ bundle install
+[source,ruby]
+----
+require 'puma/daemon'
+bind 'tcp://0.0.0.0:3000'
+workers 2
+threads 4
+daemonize
+----
 
-== Usage
+And then execute:
 
-There were two ways you could daemonize Puma in the past:
+[source,bash]
+----
+bundle install -j 12
+bundle exec puma -C config/puma.rb [rackup.ru]
+----
 
- 1. By specifying `daemonize` or `daemonize(true)` in your config file.
- 2. Or, by passing a `-d` or `--daemonize` command line flag.
+Make sure you have `config.ru` Rackup file in the current folder.
+Checkout the shell script inside the `example` folder for more info.
 
-This gem allows you to daemonize using both ways, but with a small caveat in each case.
 
-Please note that both ways require you to include this gem in your Gemfile, but you may specify it as `require: false` — it will only activate if you explicitly require it, or use `pumad` executable.
+NOTE: Please see the https://github.com/kigster/puma-daemon/tree/master/example[`example`] directory in the source of the gem. It contains `single.sh` and `cluster.sh` scripts that boot Puma via `pumad` binary.
 
-=== Daemonizing via the Config File
+=== Using Config File
 
 If you want to specify `daemonize` in your config file, simply include `require 'puma/daemon'` at the top of your config file:
 
@@ -74,7 +142,7 @@ port 3001
 workers 3
 threads 2,3
 # accepts true or false, and if false is passed will NOT daemonize
-daemonize 
+daemonize
 ----
 
 With this method you can continue using the standard `puma` executable to get it started, but (and this is important) — **you must remove any `-d` or `--daemonize` from the command line**, or Puma v5 and above will fail with an error.
@@ -83,62 +151,73 @@ Here is an example of daemonizing via the config file shown above, and using the
 
 [source,bash]
 ----
-❯ gem install puma-daemon puma -N
-❯ puma -C config/puma.rb config.ru
-
-[98795] Puma starting in cluster mode...
-[98795] * Puma version: 5.1.1 (ruby 2.7.2-p137) ("At Your Service")
-[98795] *  Min threads: 2
-[98795] *  Max threads: 3
-[98795] *  Environment: production
-[98795] *   Master PID: 98795
-[98795] *      Workers: 3
-[98795] *     Restarts: (✔) hot (✔) phased
-[98795] * Listening on http://0.0.0.0:3001
-[98795] *  Puma Daemon: Daemonizing (puma-daemon v0.1.1)...
+❯ cd example
+❯ bundle exec puma -I ../lib -C $(pwd)/puma.rb -w 4 config.ru
+[62235] Puma starting in cluster mode...
+[62235] * Puma version: 6.1.1 (ruby 2.7.6-p219) ("The Way Up")
+[62235] *  Min threads: 0
+[62235] *  Max threads: 16
+[62235] *  Environment: development
+[62235] *   Master PID: 62235
+[62235] *  Puma Daemon: Daemonizing...
+[62235] *  Gem: puma-daemon v0.2.2
+[62235] *  Gem: puma v6.1.1
+[62258] *      Workers: 4
+[62258] *     Restarts: (✔) hot (✔) phased
+[62258] * Listening on unix:///tmp/puma.sock
+[62258] * Listening on http://0.0.0.0:9292
 ----
 
 Note that using this method you can decide whether to daemonize or not by passing true or false to the `daemonize` method.
 
-=== Daemonizing on the Command Line
+=== Using Command Line
 
 If you prefer to make a decision whether to daemonize or not on the command line, you only have to make one chance: replace `puma` with `pumad`.
 
-NOTE: We did not want to conflict with the `puma` gem by introducing another executable under the same name. The executable this gem provides is called `pumad` (where 'd' stands for daemon, and follows standard UNIX convention, as in eg `sshd`, `ftpd`, etc).
+NOTE: We did not want to conflict with the `puma` gem by introducing another executable under the same name.
+The executable this gem provides is called `pumad` (where 'd' stands for daemon, and follows standard UNIX convention, as in eg `sshd`, `ftpd`, etc).
 
-If you replace `puma` with `pumad` — you no longer need to pass any aditional command line flag t ocontinue passing it `-d` or you can remove it (both `-d` and `--daemonize` are stripped out before ARGV is passed onto Puma's CLI parser.)
+If you replace `puma` with `pumad`, you no longer need to pass any additional command line flag (`-d` and `--daemonize`) to daemonize.
+You can continue passing them or you can remove them (these flags are stripped out before ARGV is passed onto Puma's CLI parser.)
 
 [source,bash]
 ----
-❯ gem install puma --version 5.1.1 -N
-❯ gem install puma-daemon -N
-
-❯ pumad -C config/puma.rb spec/rackup/bind.ru
-
-[98795] Puma starting in cluster mode...
-[98795] * Puma version: 5.1.1 (ruby 2.7.2-p137) ("At Your Service")
-[98795] *  Min threads: 2
-[98795] *  Max threads: 8
-[98795] *  Environment: production
-[98795] *   Master PID: 98795
-[98795] *      Workers: 3
-[98795] *     Restarts: (✔) hot (✔) phased
-[98795] * Listening on http://0.0.0.0:3000
-[98795] *  Puma Daemon: Daemonizing (puma-daemon v0.1.1)...
+❯ cd example
+❯ ../exe/pumad -C $(pwd)/puma.rb -w 0 config.ru
+
+Puma starting in single mode...
+* Puma version: 6.1.1 (ruby 2.7.6-p219) ("The Way Up")
+*  Min threads: 0
+*  Max threads: 16
+*  Environment: development
+*          PID: 63179
+*  Puma Daemon: Daemonizing...
+*  Gem: puma-daemon v0.2.2
+*  Gem: puma v6.1.1
+* Listening on unix:///tmp/puma.sock
+* Listening on http://0.0.0.0:9292
 ----
 
 As you can see, at the end it says "Daemonizing".
 
-If you start puma this way, you can still specify `daemonize(false)` in the configuration file to turn it off, but the default is to daemonize. Also, if you start with `pumad` you do not need to include `require 'puma/daemon'` in your configuration file, as the `pumad` binary loads all dependencies prior to parsing the config.
+If you start puma this way, you can still specify `daemonize(false)` in the configuration file to turn it off, but the default is to daemonize.
+Also, if you start with `pumad` you do not need to include `require 'puma/daemon'` in your configuration file, as the `pumad` binary loads all dependencies prior to parsing the config.
 
+== Contributing
 
-== Development
+NOTE: You do need a working `make` utility to use the below commands.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+ * After checking out the repo, run `make puma-v5` or `make puma-v6` to configure your dependent vesion of Puma.
 
-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 the created tag, and push the `.gem` file to https://rubygems.org[rubygems.org].
+ * After that, run `bin/setup` to install dependencies.
 
-== Contributing
+ * Then, run `rake spec` 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 the created tag, and push the `.gem` file to https://rubygems.org[rubygems.org].
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/kigster/puma-daemon.