muxify 0.1.5 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c4737c89a2923ba7fe743328b1431802e3576f1d1e7b9a0225c9a058b9cf3cd
-  data.tar.gz: 158303895c198e9d8ce430397a1c0ff2ee5afec6715b2694a06548f6a80dd91d
+  metadata.gz: d7643b48e39c0bdea0bcbe70da3bc38872eec60fb1256209ab462d3894c81ded
+  data.tar.gz: f8c00a63134eae01e183340963afe1a8bcd63874d7beeb0ed2a6f4129e54ee6c
 SHA512:
-  metadata.gz: 0efec262d17e6d827c2e73afaf64505bded82ce552fafd3cf2b334786629a83acbdc871fb17227a183e247a2deada7d692a961dbe0b80a6bb68b798ce4201f4d
-  data.tar.gz: 62917a4b44014294f0e5bb7dd9c776fe8f7b7785078e00c8c88ee2e85a5706e7c30b3a6bc1c24be2499585502a6aca777dadd2db235401be6c34488cc3f6db73
+  metadata.gz: 9513967b1db9a34a44168798e16619ccd9aff89d1d66046ae466444b3185c3c46b9b44aae223029390c88e7dc512b6bfae62162277987fe18338b4c3bd98b59d
+  data.tar.gz: 4c64b6891a1d6de45f3aa439c73f34da09044038964dd02f4a8d9aa5459e940289be6fffd8ba651b1d58cb4d9b4bff5d761b6e917e0697755e49384ff0d055d7

data/.rspec

@@ -1,2 +1,3 @@
---format documentation
 --color
+--format documentation
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+---
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: no_space
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+Style/Documentation:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -1,5 +1,10 @@
-sudo: false
+---
 language: ruby
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.15.1
+  - 2.7
+  - 3.0
+deploy:
+  provider: rubygems
+  on:
+    branch: main
+  edge: true # opt in to dpl v2

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in muxify.gemspec
 gemspec

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/Rakefile

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
 
+RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: %i[rubocop spec]

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "muxify"
+require 'bundler/setup'
+require 'muxify'
 
 # 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.
@@ -10,5 +11,5 @@ require "muxify"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/muxify

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-if File.directory? File.expand_path('../../.git', __FILE__)
-  $:.unshift File.expand_path('../../lib', __FILE__)
-end
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__) if File.directory? File.expand_path('../.git', __dir__)
 
 require 'bundler/setup'
 require 'muxify'

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/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/lib/muxify/builder.rb

@@ -11,9 +11,10 @@ module Muxify
       new(*args).to_yaml
     end
 
-    def initialize(root, name: nil)
+    def initialize(root, name: nil, custom_config_path: CUSTOM_CONFIG_PATH)
       @root = File.expand_path(root)
       @name = name || File.basename(@root)
+      @custom_config_path = custom_config_path
     end
 
     def to_yaml
@@ -22,7 +23,7 @@ module Muxify
 
     private
 
-    attr_reader :root, :name
+    attr_reader :root, :name, :custom_config_path
 
     def config
       {
@@ -41,9 +42,18 @@ module Muxify
     end
 
     def custom_windows
-      return {} unless File.exist?(CUSTOM_CONFIG_PATH)
+      return {} unless custom_config.key?('windows')
 
-      YAML.load_file(CUSTOM_CONFIG_PATH).dig(name, 'windows')
+      YAML.load_file(custom_config_path).dig(name, 'windows') || {}
+    end
+
+    def custom_config
+      return {} unless File.exist?(custom_config_path)
+
+      yaml = YAML.load_file(custom_config_path)
+      return {} unless yaml
+
+      yaml.fetch(name, {})
     end
 
     class Windows
@@ -56,7 +66,6 @@ module Muxify
           *shell,
           *editor,
           *logs,
-          *foreman,
           *rails,
           *elixir_non_phoenix,
           *phoenix,
@@ -74,11 +83,9 @@ module Muxify
       end
 
       def init_shell
-        if git?
-          'git fetch; git status'
-        else
-          'echo "Not a git repository."'
-        end
+        return 'echo "Not a git repository."' unless git?
+
+        'git fetch; git status'
       end
 
       def git?
@@ -91,6 +98,7 @@ module Muxify
 
       def logs
         return [] if logfiles.empty?
+
         logfiles.each(&method(:truncate_file))
         [{'logs' => 'tail -f log/*.log'}]
       end
@@ -103,22 +111,13 @@ module Muxify
         File.truncate(path, 0)
       end
 
-      def foreman
-        return [] unless foreman?
-        [{'foreman' => <<-SH.strip}]
-        ps aux | grep 'unicorn_rails master' | awk '{print $2}' | xargs kill; foreman start
-        SH
-      end
-
-      def foreman?
-        # TODO?
-      end
-
       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 +127,7 @@ module Muxify
 
       def elixir_non_phoenix
         return [] unless elixir_non_phoenix?
+
         [
           {'console' => 'iex -S mix'},
           {'server' => 'mix'},
@@ -140,6 +140,7 @@ module Muxify
 
       def phoenix
         return [] unless phoenix?
+
         [
           {'console' => 'iex -S mix phoenix.server'},
           {'server' => 'mix phoenix.server'},
@@ -152,6 +153,7 @@ module Muxify
 
       def nodejs
         return [] unless nodejs?
+
         [
           {'console' => 'node'},
         ]
@@ -163,6 +165,7 @@ module Muxify
 
       def django
         return [] unless django?
+
         [
           {'db' => 'python manage.py dbshell'},
           {'console' => 'python manage.py shell'},
@@ -172,7 +175,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 +183,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/cli.rb

@@ -6,19 +6,24 @@ require 'muxify/linker'
 
 module Muxify
   class CLI < Thor
-    desc "add", "Adds tmuxinator config for current (or supplied) path"
+    desc 'add', 'Adds tmuxinator config for current (or supplied) path'
     def add(root = Dir.pwd)
-      Muxify::Linker.(root: root)
+      Muxify::Linker.call(root: root)
     end
 
-    desc "debug", "Prints tmuxinator config of current (or supplied) path to stdout"
+    desc 'debug', 'Prints tmuxinator config of current (or supplied) path to stdout'
     def debug(root = Dir.pwd)
-      puts Muxify::Builder.(root)
+      puts Muxify::Builder.call(root)
     end
 
-    desc "stop", "Kills tmux session"
+    desc 'stop', 'Kills tmux session'
     def stop(name = File.basename(Dir.pwd))
       Kernel.system("tmux kill-session -t #{name}")
     end
+
+    desc 'version', 'Print current version'
+    def version
+      puts Muxify::VERSION
+    end
   end
 end

data/lib/muxify/linker.rb

@@ -7,8 +7,8 @@ module Muxify
     TMUXINATOR_CONFIG_PATH = File.expand_path(File.join(ENV.fetch('HOME'), '.tmuxinator')).freeze
     private_constant :TMUXINATOR_CONFIG_PATH
 
-    def self.call(*args)
-      new(*args).call
+    def self.call(**args)
+      new(**args).call
     end
 
     def initialize(root:)

data/lib/muxify/version.rb

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

data/muxify.gemspec

@@ -7,10 +7,10 @@ require 'muxify/version'
 Gem::Specification.new do |spec|
   spec.name          = 'muxify'
   spec.version       = Muxify::VERSION
-  spec.authors       = ["Zubin Henner"]
+  spec.authors       = ['Zubin Henner']
   spec.email         = ['zubin@users.noreply.github.com']
 
-  spec.summary       = "Simple tmux project config"
+  spec.summary       = 'Simple tmux project config'
   spec.homepage      = 'https://github.com/zubin/muxify'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'bin'
   spec.executables   = ['muxify']
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.add_dependency 'thor'
   spec.add_dependency 'tmuxinator'
@@ -26,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muxify
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.10
 platform: ruby
 authors:
 - Zubin Henner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2021-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - zubin@users.noreply.github.com
@@ -90,12 +104,17 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
 - bin/muxify
+- bin/rails_server_with_puma_dev
+- bin/rake
+- bin/rspec
+- bin/rubocop
 - bin/setup
 - lib/muxify.rb
 - lib/muxify/builder.rb
@@ -114,14 +133,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Simple tmux project config