muxify 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a6e6f97b36dc14f43538a9f0dccf799fa491bd2bcd93a02f7b91dae66f8658e
-  data.tar.gz: 1d5c6318d531b81298e1b614afe4bac91e8934f08561cbc7d07f9bc2c342cbc4
+  metadata.gz: 9c4737c89a2923ba7fe743328b1431802e3576f1d1e7b9a0225c9a058b9cf3cd
+  data.tar.gz: 158303895c198e9d8ce430397a1c0ff2ee5afec6715b2694a06548f6a80dd91d
 SHA512:
-  metadata.gz: 4391690e58c6dbcb96e0609a28424e091d4567842f4911115a8ca5b6b7026debe0cff2782a08ddc3cd24aaaea444b745c6d81838ebb5a55264d198761510e721
-  data.tar.gz: ea8fabcfa1c5b8e84c84945e1041fa8ebd5ccb761acbc01884512d1021bf8d2d699fb31109dfb18c66c8664a027ac49e48e3fd490b40b1caf19a3142efbfa27e
+  metadata.gz: 0efec262d17e6d827c2e73afaf64505bded82ce552fafd3cf2b334786629a83acbdc871fb17227a183e247a2deada7d692a961dbe0b80a6bb68b798ce4201f4d
+  data.tar.gz: 62917a4b44014294f0e5bb7dd9c776fe8f7b7785078e00c8c88ee2e85a5706e7c30b3a6bc1c24be2499585502a6aca777dadd2db235401be6c34488cc3f6db73

data/Gemfile

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

data/README.md

@@ -1,19 +1,76 @@
 # Muxify
 
-Simple tmux project config.
+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.
+
+## Dependencies
+
+* MacOS (may work on Linux)
+* Ruby
+* Tmux (`which tmux || brew install tmux`)
 
 ## Installation
 
 ```sh
-which tmux || brew install tmux
-sudo gem install muxify
+$ gem install muxify
 ```
 
 ## Usage
 
 ```sh
-muxify add /path/to/my_app
-mux my_app
+$ muxify -h
+
+Commands:
+  muxify add             # Adds tmuxinator config for current (or supplied) path
+  muxify debug           # Prints tmuxinator config of current (or supplied) path to stdout
+  muxify help [COMMAND]  # Describe available commands or one specific command
+  muxify stop            # Kills tmux session
+```
+
+For example, add a project like so:
+
+```sh
+$ muxify add /path/to/my_app
+$ 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`)
+
+## Customising projects
+
+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:
+    server: yarn dev
 ```
 
 ## Thanks

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/lib/muxify/builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module Muxify
@@ -39,7 +41,9 @@ module Muxify
     end
 
     def custom_windows
-      YAML.load_file(CUSTOM_CONFIG_PATH).dig(name, 'windows') || {}
+      return {} unless File.exist?(CUSTOM_CONFIG_PATH)
+
+      YAML.load_file(CUSTOM_CONFIG_PATH).dig(name, 'windows')
     end
 
     class Windows
@@ -86,10 +90,19 @@ module Muxify
       end
 
       def logs
-        return [] if Dir["#{root}/log/*.log"].empty?
+        return [] if logfiles.empty?
+        logfiles.each(&method(:truncate_file))
         [{'logs' => 'tail -f log/*.log'}]
       end
 
+      def logfiles
+        @logfiles ||= Dir["#{root}/log/*.log"]
+      end
+
+      def truncate_file(path)
+        File.truncate(path, 0)
+      end
+
       def foreman
         return [] unless foreman?
         [{'foreman' => <<-SH.strip}]

data/lib/muxify/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'muxify/builder'
 require 'muxify/linker'

data/lib/muxify/linker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 
 module Muxify

data/lib/muxify/version.rb

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

data/lib/muxify.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'muxify/cli'
 require 'muxify/version'

data/muxify.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'muxify/version'
 
@@ -9,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Zubin Henner"]
   spec.email         = ['zubin@users.noreply.github.com']
 
-  spec.summary       = %q{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|
@@ -22,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'thor'
   spec.add_dependency 'tmuxinator'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muxify
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Zubin Henner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2020-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -42,44 +42,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: 
 email:
 - zubin@users.noreply.github.com
@@ -121,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simple tmux project config