muxify 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a099c8cfe54df9755911cfb611b86c5d4ddca1d29ae2d7d97014e6e6a76f9541
-  data.tar.gz: 328da4d2f68dc4c83a15868be3621b2c31fe7dbb5e4201e14c452916a0c8b08b
+  metadata.gz: 98861ef327df42548ffe35e925b221c5c16a44b5623f55a3c7384a41e55a1e3f
+  data.tar.gz: e8cbc88546ae7cae5610e32f1aa3349ea9b687dc682cd79c48fb9c4289024036
 SHA512:
-  metadata.gz: 6cb676527839f166fa76fe11a66b0d0662e810b5253190522251135b41ced6ace77a329be7c88428e16a4e82a96bbbd4c554b09b221484f26682f13d26f69de6
-  data.tar.gz: ea6b93059cfc439e9715642a0bda739c75c17509796fd7187ee89c625369fa6cf50bdc0d056bb263b6d82e71bb8125736d0189363474358e0675670877fc2fea
+  metadata.gz: a9bc6c4c4351d1cc2ed64d82c5de796cda9a956c42d086e05eef2077074f2228cd0ff3952eed55e2d676effcd8f52514024acb6bf3be8e9e813c6f283026cbda
+  data.tar.gz: ca0f1396d5cba5b0c5265d23633dc2a7ede6ce50de492f0d3141a10e9faf3c5b71c6c83a00ba2fe22809dd542b08aef9977259570bbfa54f4632b87944e705c2

data/README.md

@@ -4,15 +4,15 @@ Sets up consistent tmux development environment for projects.
 
 Why?
 
-* Saves time and effort switching projects.
-* Ensures consistent layout which is faster to navigate via muscle memory.
-* Avoids visual and mental overhead of maintaining numerous tabs.
+- Saves time and effort switching projects.
+- Ensures consistent layout which is faster to navigate via muscle memory.
+- Avoids visual and mental overhead of maintaining numerous tabs.
 
 ## Dependencies
 
-* MacOS (may work on Linux)
-* Ruby
-* Tmux (`which tmux || brew install tmux`)
+- MacOS (may work on Linux)
+- Ruby
+- Tmux (`which tmux || brew install tmux`)
 
 ## Installation
 
@@ -41,25 +41,26 @@ $ mux my_app
 
 Depending on its type, this will create the following tmux windows for a project:
 
-* Standard (applies to all projects)
-  * shell (performs `git fetch` when `.git` is present)
-  * editor (invokes terminal editor, defaulting to `vim` when `$EDITOR` is unset)
-  * logs (when present, truncates then tails `log/*.log`)
-* Rails (identified by presence of `bin/rails`)
-  * db (`rails db`)
-  * console (`rails console`)
-* NodeJS (identified by presence of `package.json` when non-Rails)
-  * console (`node`)
-* Elixir (identified by presence of `mix.exs` when non-Phoenix)
-  * console (`iex -S mix`)
-  * server (`mix`)
-* Elixir/Phoenix (identified by presence of `deps/phoenix`)
-  * console (`iex -S mix phoenix.server`)
-  * server (`mix phoenix.server`)
-* Django (identified by `requirements.txt` containing `django`)
-  * db (`python manage.py dbshell`)
-  * console (`python manage.py shell`)
-  * server (`python manage.py runserver`)
+- Standard (applies to all projects)
+  - shell (performs `git fetch` when `.git` is present)
+  - editor (invokes terminal editor, defaulting to `vim` when `$EDITOR` is unset)
+  - logs (when present, truncates then tails `log/*.log`)
+- Rails (identified by presence of `bin/rails`)
+  - db (`rails db`)
+  - console (`rails console`)
+  - server (configures puma-dev then `rails server`; see [code](./bin/rails_server_with_puma_dev))
+- NodeJS (identified by presence of `package.json` when non-Rails)
+  - console (`node`)
+- Elixir (identified by presence of `mix.exs` when non-Phoenix)
+  - console (`iex -S mix`)
+  - server (`mix`)
+- Elixir/Phoenix (identified by presence of `deps/phoenix`)
+  - console (`iex -S mix phoenix.server`)
+  - server (`mix phoenix.server`)
+- Django (identified by `requirements.txt` containing `django`)
+  - db (`python manage.py dbshell`)
+  - console (`python manage.py shell`)
+  - server (`python manage.py runserver`)
 
 ## Customising projects
 
@@ -67,6 +68,7 @@ To add a custom tmux window for a project:
 
 1. Create a file called `~/.muxifyrc`.
 1. Edit it in YAML format; eg to add a tmux window to `my_app` project which is named `server` and invokes `yarn dev`:
+
 ```yaml
 my_app:
   windows:
@@ -75,7 +77,7 @@ my_app:
 
 ## Thanks
 
-* https://github.com/tmuxinator/tmuxinator
+- https://github.com/tmuxinator/tmuxinator
 
 ## Contributing
 

data/bin/rails_server_with_puma_dev

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+
+# Starts rails server with a random port and configures puma-dev
+# Usage:
+#     rails_server_with_puma_dev [HOSTNAME]
+#         HOSTNAME should not include the `.test` extension.
+#         If HOSTNAME isn't supplied, it defaults to current directory name
+#         (underscores are converted to dashes).
+
+set -euo pipefail
+
+min_port=3000
+max_port=4000
+puma_dev_config_path="$HOME/.puma-dev"
+
+find_available_port() {
+  netstat -aln | awk -v min_port="$min_port" -v max_port="$max_port" '
+    $6 == "LISTEN" {
+      if ($4 ~ "[.:][0-9]+$") {
+        split($4, a, /[:.]/);
+        port = a[length(a)];
+        p[port] = 1
+      }
+    }
+    END {
+      for (i = min_port; i < max_port && p[i]; i++) {};
+      if (i == max_port) { exit 1 };
+      print i
+    }
+  '
+}
+
+get_target_hostname() {
+  if (( $# == 0 )); then
+    echo "$(basename "$(pwd)" | tr '_' '-')"
+  else
+    echo $1
+  fi
+}
+
+configure_puma_dev() {
+  target_config_path="$puma_dev_config_path/$host"
+  echo "Configuring puma-dev:  $host.test:$port ($target_config_path)"
+  echo "$port" > "$target_config_path"
+  puma-dev -stop
+  pkill -USR1 puma-dev
+}
+
+target_port="$(find_available_port)"
+target_host="$(get_target_hostname "$@")"
+
+host="$target_host" port="$target_port" configure_puma_dev
+bundle exec rails server -p "$target_port"

data/lib/muxify/builder.rb

@@ -91,6 +91,7 @@ module Muxify
 
       def logs
         return [] if logfiles.empty?
+
         logfiles.each(&method(:truncate_file))
         [{'logs' => 'tail -f log/*.log'}]
       end
@@ -105,6 +106,7 @@ module Muxify
 
       def foreman
         return [] unless foreman?
+
         [{'foreman' => <<-SH.strip}]
         ps aux | grep 'unicorn_rails master' | awk '{print $2}' | xargs kill; foreman start
         SH
@@ -116,9 +118,11 @@ module Muxify
 
       def rails
         return [] unless rails?
+
         [
           {'db' => 'rails db'},
           {'console' => 'rails console'},
+          {'server' => File.expand_path('../../bin/rails_server_with_puma_dev', __dir__)},
         ]
       end
 
@@ -128,6 +132,7 @@ module Muxify
 
       def elixir_non_phoenix
         return [] unless elixir_non_phoenix?
+
         [
           {'console' => 'iex -S mix'},
           {'server' => 'mix'},
@@ -140,6 +145,7 @@ module Muxify
 
       def phoenix
         return [] unless phoenix?
+
         [
           {'console' => 'iex -S mix phoenix.server'},
           {'server' => 'mix phoenix.server'},
@@ -152,6 +158,7 @@ module Muxify
 
       def nodejs
         return [] unless nodejs?
+
         [
           {'console' => 'node'},
         ]
@@ -163,6 +170,7 @@ module Muxify
 
       def django
         return [] unless django?
+
         [
           {'db' => 'python manage.py dbshell'},
           {'console' => 'python manage.py shell'},
@@ -172,7 +180,7 @@ module Muxify
 
       def django?
         python_requirements = File.join(root, 'requirements.txt')
-        File.exists?(python_requirements) && File.read(python_requirements).include?('django')
+        File.exist?(python_requirements) && File.read(python_requirements).include?('django')
       end
 
       def directory?(relative_path)
@@ -180,7 +188,7 @@ module Muxify
       end
 
       def exists?(relative_path)
-        File.exists?(File.join(root, relative_path))
+        File.exist?(File.join(root, relative_path))
       end
     end
   end

data/lib/muxify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Muxify
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muxify
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Zubin Henner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2020-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -96,6 +96,7 @@ files:
 - Rakefile
 - bin/console
 - bin/muxify
+- bin/rails_server_with_puma_dev
 - bin/setup
 - lib/muxify.rb
 - lib/muxify/builder.rb