muxify 0.1.11 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb12f71a3e0a60ba30fbf33432d33ee0eab24a3a457f034e2531e13259a61569
-  data.tar.gz: b239260fb12f6ae2a18d84fd70414498afa0d5960356eb8b945b1c0eb4b024b9
+  metadata.gz: 99b06fb29cb0313ee692a84da4cfa068931256fd8e19325c3431e45463d4ef76
+  data.tar.gz: ebfe044c5cd37f1f62574fd289a2ec0038ee56ab34f2eb14a80fe0ea6c704827
 SHA512:
-  metadata.gz: cecb6e6a718f341c26d099e08b73c3c12763ce8619c84c7963472ea23c8957c8d8a2e31820b25a8d093400c20a74607a7ab365f9d6cf0f224930681f18510c13
-  data.tar.gz: 9eb3f63e27cceb5c6a09b51a65c827fc2723a41066ae98018cec288d7edd48bcebb2bab3d890c6f60a09b3c4baead5a420f7ff5c21292f6135985e0fd1f9a79c
+  metadata.gz: 1fcf84278243026a0e7c9e5b80cb31924172f1ee3300da85641c174cf768f3183de26aa4c40aacfdf793049a47b4a5f8d5bd46a3a7cdf2b54607d12431628f3e
+  data.tar.gz: 97a6fceaf5887c62cae38a8919bdd35d43aa59ff1b0e5af0119e3ce953b9d665247fae166b9f289d8e39e79eddb0bc3f38b5fa57683c15abd2c39e77b69f351c

data/.travis.yml

@@ -1,8 +1,8 @@
 ---
 language: ruby
 rvm:
-  - 2.7
   - 3.0
+  - 3.1
 deploy:
   provider: rubygems
   on:

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

@@ -64,7 +64,9 @@ Depending on its type, this will create the following tmux windows for a project
 
 ## Customising projects
 
-To add a custom tmux window for a project:
+Each project may have custom windows via a `.muxifyrc` file.
+
+### Using a .muxifyrc in your home directory
 
 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`:
@@ -75,6 +77,23 @@ my_app:
     server: yarn dev
 ```
 
+If you want a custom window for all projects:
+
+```yaml
+windows:
+  echo_all_projects: "echo 'this will apply to all projects'"
+```
+
+### Using a .muxifyrc in your project directory
+
+1. Create a file called `my_app/.muxifyrc` (given your project is in `my_app`).
+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
+windows:
+  server: yarn dev
+```
+
 ## Thanks
 
 - https://github.com/tmuxinator/tmuxinator

data/Rakefile

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

data/lib/muxify/builder.rb

@@ -1,20 +1,19 @@
 # frozen_string_literal: true
 
-require 'yaml'
+require "yaml"
 
 module Muxify
   class Builder
-    CUSTOM_CONFIG_PATH = File.join(ENV['HOME'], '.muxifyrc')
-    private_constant :CUSTOM_CONFIG_PATH
+    DEFAULT_CUSTOM_CONFIG_PATH = File.join(ENV["HOME"], ".muxifyrc")
+    private_constant :DEFAULT_CUSTOM_CONFIG_PATH
 
-    def self.call(*args)
-      new(*args).to_yaml
+    def self.call(path, **kwargs)
+      new(path, **kwargs).to_yaml
     end
 
-    def initialize(root, name: nil, custom_config_path: CUSTOM_CONFIG_PATH)
+    def initialize(root, name: nil)
       @root = File.expand_path(root)
       @name = name || File.basename(@root)
-      @custom_config_path = custom_config_path
     end
 
     def to_yaml
@@ -23,37 +22,46 @@ module Muxify
 
     private
 
-    attr_reader :root, :name, :custom_config_path
+    attr_reader :root, :name
 
     def config
       {
-        'name' => name,
-        'root' => root,
-        'windows' => windows,
+        "name" => name,
+        "root" => root,
+        "windows" => windows
       }
     end
 
     def windows
-      Windows.new(root).all.tap do |windows|
+      windows = Windows.new(root).all.tap do |windows|
         custom_windows.each do |name, command|
           windows << {name => command}
         end
       end
+
+      windows
+        .each_with_object({}) { |window, result| result[window.keys.first] = window.values.first }
+        .each_with_object([]) { |(k, v), result| result << {k => v} }
     end
 
     def custom_windows
-      return {} unless custom_config.key?('windows')
-
-      YAML.load_file(custom_config_path).dig(name, 'windows') || {}
+      custom_config_paths.each_with_object({}) do |custom_config_path, result|
+        [
+          YAML.safe_load_file(custom_config_path)&.dig(name, "windows"),
+          YAML.safe_load_file(custom_config_path)&.dig("windows")
+        ].compact.each(&result.method(:merge!))
+      end
     end
 
-    def custom_config
-      return {} unless File.exist?(custom_config_path)
-
-      yaml = YAML.load_file(custom_config_path)
-      return {} unless yaml
+    def custom_config_paths
+      [
+        DEFAULT_CUSTOM_CONFIG_PATH,
+        project_custom_config_path,
+      ].compact.uniq.select(&File.method(:exist?))
+    end
 
-      yaml.fetch(name, {})
+    def project_custom_config_path
+      File.join(root, ".muxifyrc")
     end
 
     class Windows
@@ -70,7 +78,7 @@ module Muxify
           *elixir_non_phoenix,
           *phoenix,
           *nodejs,
-          *django,
+          *django
         ]
       end
 
@@ -79,28 +87,28 @@ module Muxify
       attr_reader :root
 
       def shell
-        [{'shell' => init_shell}]
+        [{"shell" => init_shell}]
       end
 
       def init_shell
         return 'echo "Not a git repository."' unless git?
 
-        'git fetch; git status'
+        "git fetch; git status"
       end
 
       def git?
-        directory?('.git')
+        system("git rev-parse &>/dev/null")
       end
 
       def editor
-        [{'editor' => ENV.fetch('EDITOR', 'vim')}]
+        [{"editor" => ENV.fetch("EDITOR", "vim")}]
       end
 
       def logs
         return [] if logfiles.empty?
 
         logfiles.each(&method(:truncate_file))
-        [{'logs' => 'tail -f log/*.log'}]
+        [{"logs" => "tail -f log/*.log"}]
       end
 
       def logfiles
@@ -115,67 +123,67 @@ module Muxify
         return [] unless rails?
 
         [
-          {'db' => 'rails db'},
-          {'console' => 'rails console'},
-          {'server' => File.expand_path('../../bin/rails_server_with_puma_dev', __dir__)},
+          {"db" => "rails db"},
+          {"console" => "rails console"},
+          {"server" => File.join(Muxify.root, "bin/rails_server_with_puma_dev")},
         ]
       end
 
       def rails?
-        exists?('bin/rails')
+        exists?("bin/rails")
       end
 
       def elixir_non_phoenix
         return [] unless elixir_non_phoenix?
 
         [
-          {'console' => 'iex -S mix'},
-          {'server' => 'mix'},
+          {"console" => "iex -S mix"},
+          {"server" => "mix"}
         ]
       end
 
       def elixir_non_phoenix?
-        exists?('mix.exs') && !phoenix?
+        exists?("mix.exs") && !phoenix?
       end
 
       def phoenix
         return [] unless phoenix?
 
         [
-          {'console' => 'iex -S mix phx.server'},
-          {'server' => 'mix phx.server'},
+          {"console" => "iex -S mix phx.server"},
+          {"server" => "mix phx.server"}
         ]
       end
 
       def phoenix?
-        directory?('deps/phoenix')
+        directory?("deps/phoenix")
       end
 
       def nodejs
         return [] unless nodejs?
 
         [
-          {'console' => 'node'},
+          {"console" => "node"}
         ]
       end
 
       def nodejs?
-        exists?('package.json') && !rails?
+        exists?("package.json") && !rails?
       end
 
       def django
         return [] unless django?
 
         [
-          {'db' => 'python manage.py dbshell'},
-          {'console' => 'python manage.py shell'},
-          {'server' => 'python manage.py runserver'},
+          {"db" => "python manage.py dbshell"},
+          {"console" => "python manage.py shell"},
+          {"server" => "python manage.py runserver"}
         ]
       end
 
       def django?
-        python_requirements = File.join(root, 'requirements.txt')
-        File.exist?(python_requirements) && File.read(python_requirements).include?('django')
+        python_requirements = File.join(root, "requirements.txt")
+        File.exist?(python_requirements) && File.read(python_requirements).include?("django")
       end
 
       def directory?(relative_path)

data/lib/muxify/cli.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
-require 'thor'
-require 'muxify/builder'
-require 'muxify/linker'
+require "thor"
+require "muxify/builder"
+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.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.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'
+    desc "version", "Print current version"
     def version
       puts Muxify::VERSION
     end

data/lib/muxify/linker.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'fileutils'
+require "fileutils"
 
 module Muxify
   class Linker
-    TMUXINATOR_CONFIG_PATH = File.expand_path(File.join(ENV.fetch('HOME'), '.tmuxinator')).freeze
+    TMUXINATOR_CONFIG_PATH = File.expand_path(File.join(ENV.fetch("HOME"), ".tmuxinator")).freeze
     private_constant :TMUXINATOR_CONFIG_PATH
 
     def self.call(**args)
@@ -17,7 +17,7 @@ module Muxify
 
     def call
       FileUtils.mkdir_p(TMUXINATOR_CONFIG_PATH)
-      File.open(config_path, 'w') { |f| f << contents }
+      File.open(config_path, "w") { |f| f << contents }
     end
 
     private

data/lib/muxify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Muxify
-  VERSION = '0.1.11'
+  VERSION = "0.2.0"
 end

data/lib/muxify.rb

@@ -1,4 +1,10 @@
 # frozen_string_literal: true
 
-require 'muxify/cli'
-require 'muxify/version'
+require "muxify/cli"
+require "muxify/version"
+
+module Muxify
+  def self.root
+    File.expand_path("..", __dir__)
+  end
+end

data/muxify.gemspec

@@ -1,31 +1,31 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'muxify/version'
+require "muxify/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'muxify'
-  spec.version       = Muxify::VERSION
-  spec.authors       = ['Zubin Henner']
-  spec.email         = ['zubin@users.noreply.github.com']
+  spec.name = "muxify"
+  spec.version = Muxify::VERSION
+  spec.authors = ["Zubin Henner"]
+  spec.email = ["zubin@users.noreply.github.com"]
 
-  spec.summary       = 'Simple tmux project config'
-  spec.homepage      = 'https://github.com/zubin/muxify'
+  spec.summary = "Simple tmux project config"
+  spec.homepage = "https://github.com/zubin/muxify"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'bin'
-  spec.executables   = ['muxify']
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.bindir = "bin"
+  spec.executables = ["muxify"]
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 3.0.0"
 
-  spec.add_dependency 'thor'
-  spec.add_dependency 'tmuxinator'
+  spec.add_dependency "thor"
+  spec.add_dependency "tmuxinator"
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "standard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muxify
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.0
 platform: ruby
 authors:
 - Zubin Henner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - zubin@users.noreply.github.com
 executables:
@@ -104,7 +104,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -125,7 +124,7 @@ files:
 homepage: https://github.com/zubin/muxify
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,15 +132,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Simple tmux project config
 test_files: []

data/.rubocop.yml

@@ -1,15 +0,0 @@
----
-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