dotrun 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d30a89973859aef0fcbddae7d70afa665fdf4d0
+  data.tar.gz: d3c63f1014c587e9ddd182e6880daf1e25cb7d73
+SHA512:
+  metadata.gz: 376b7ad9fa17b681cee2c7e76ff3be0177a76ec2340889364c1572d2f71338297c192bced49cf43dbcb58282b9f05c8fec9b486b6b0a39da5057b973d4b40fe3
+  data.tar.gz: f4ddfe997fb2e639a6f60642e311cee4f561e68caa57f5b8d3a67062bffdcfa45bddb8292b58e1d125561f19c85d50c4a6930c3a3490abdd9d5836c435f2eefd

data/README.md

@@ -0,0 +1,78 @@
+# dotrun
+A super simple app runner script
+
+## The Problem
+Every app I work on seems to have a different way of running it, and I couldn't keep track. I wanted to be able to navigate to any app directory in the terminal and run a simple command to launch the app in focus.
+
+## The Solution
+This simple ruby script expects a file called `.run` in the current directory with an instruction to execute. Put the script somewhere on your machine, make it executable with `chmod +x` and symlink it to somewhere in your path (e.g., `ln -s /usr/local/dotrun /path/to/dotrun.rb`) and you can run it from anywhere that you've defined a `.run` file.
+
+Simply navigate to the directory of your app, and run
+```
+dotrun
+```
+and it will run the command you've specified. It will also clear your terminal and tell you some useful information like the current git branch, and hitting `Ctrl+C` will terminate the process (gracefully, hopefully).
+
+For even more usefulness, you can provide multiple commands in the file to specify different things to launch. For example:
+
+```yaml
+server: unicorn_rails --host 127.0.0.1
+console: rails c
+sidekiq: bundle exec sidekiq
+log: tail -f log/development.log
+```
+
+You can then run
+```
+dotrun server
+```
+to run the unicorn script above.
+
+### List directives
+To get a list of possible directives for the current directory:
+```
+dotrun -?
+```
+
+### Run multiple commands at once
+**This feature requires that [ttab](https://www.npmjs.com/package/ttab) is installed.** Run multiple commands in different tabs of your terminal window by specifying an array of commands in your `.run` directives file. For example:
+
+```yaml
+default:
+  - server
+  - log
+  - console
+server: unicorn_rails --host 127.0.0.1
+console: rails c
+log: tail -f log/development.log
+```
+
+When you run `dotrun` in this case, each command will open up in a new terminal tab. You can also specify many of these multi-directives by including other array items in the yaml configuration.
+
+---
+
+## License
+Feel free to use this if you think it might be valuable to you! This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org>

data/bin/dotrun

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'dotrun'
+Dotrun.new.run(ARGV[0])

data/lib/dotrun.rb

@@ -0,0 +1,108 @@
+require 'yaml'
+require 'colorize'
+
+class Dotrun
+  
+  DIRECTIVES_PATH = ".run"
+  
+  # The main operation method. This is called when running `dotrun` from the command line.
+  def run(*args)
+    print_help_and_exit if args.first == "-?"
+    directive = args.first || "default"
+    command = command_for(directive)
+    
+    if command.is_a?(Array)
+      exec_multiple_directives directive, command
+    else
+      exec_directive directive, command
+    end
+  end
+
+  protected
+  
+  # Prints out the usage instructions and available command directives for the current directory.
+  def print_help_and_exit
+    puts "Usage: dotrun [directive]\n".light_black
+    print "Available directives for ".blue
+    print "#{File.basename(File.expand_path("."))}".blue.bold
+    puts ":".blue
+    for key, command in directives
+      print "  #{key.to_s.ljust(10)}".magenta
+      print " -> ".light_black
+      command_string = "#{command.length > 60 ? (command[0..60] + "...".light_black) : command}"
+      puts command.is_a?(Array) ? command.join(", ").magenta : command_string
+    end
+    puts ""
+    exit
+  end
+  
+  # Clears the screen, prints a header, and the git branch (if available).
+  def prep_screen
+    system("clear")
+    print "Current project is ".blue
+    print "#{File.basename(File.expand_path("."))}".blue.on_light_white
+    
+    if File.exist?(".git")
+      branch = `git rev-parse --abbrev-ref HEAD`
+      print " (current branch: ".blue
+      print branch.strip.blue.on_light_white
+      print ")".blue
+    end
+    puts ""
+  end
+  
+  # Execute one of the directives in the list from the `.run` file.
+  def exec_directive(directive, command)
+    prep_screen
+    puts "Running #{directive} directive: \"#{command}\"...".green
+    puts "Use Ctrl-C to stop".green
+    puts ""
+    trap( :INT ) { puts "Terminating...".magenta }
+    
+    fork { exec command }
+    Process.wait
+    puts "All done.\r\n".light_blue
+  end
+
+  # Execute multiple commands in multiple tabs using `ttab`
+  def exec_multiple_directives(directive, command)
+    check_for_ttab
+    prep_screen
+    puts "\n\n\n"
+    puts "Running multiple directives in separate tabs:".green
+    for d in command
+      print "  #{d}".ljust(20).magenta
+      sleep 2
+      system %(ttab -G eval "dotrun #{d}; exit")
+      puts " ✔︎".magenta
+    end
+    puts ""
+    puts "Running!\r\n".light_blue
+  end
+  
+  # Returns all of the directives as a Ruby object.
+  def directives
+    @directives ||= load_directives
+  end
+
+  # Convenience method for fetching the command designated for the specified directive.
+  def command_for(directive)
+    directives[directive] || abort("Couldn't find the `#{directive}` directive in your config.\r\n".red)
+  end
+
+  # Load up the `.run` file from the current directory and populate the @directives instance variable.
+  def load_directives
+    abort("No .run file detected in current directory.\r\n".red) unless File.exist?(DIRECTIVES_PATH)
+    loaded = YAML.load_file(DIRECTIVES_PATH)
+    @directives = loaded.is_a?(String) ? { default: loaded } : loaded
+  end
+  
+  # Checks if the `ttab` utility exists on the machine and errors out if not.
+  def check_for_ttab
+    msg = "It doesn't appear that ttab is installed. Please run "
+    msg << "npm install ttab -g ".bold
+    msg << "\r\nto install the utility in order to use the multi-command feature."
+    abort(msg.red) unless system("which ttab")
+  end
+  
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: dotrun
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple app runner tool
+email: matt@dreamsis.com
+executables:
+- dotrun
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/dotrun
+- lib/dotrun.rb
+homepage: https://github.com/mattharris5/dotrun
+licenses:
+- Unlicense
+metadata: {}
+post_install_message: "\e[1;94;49m\r\n** Important dependency note for dotrun gem**\e[0m\r\n\e[0;94;49mIf
+  you want to load multiple commands in separate tabs, you need to install ttab first.
+  For simplicity, this tool is not included in this package. (Sorry! If anyone makes
+  a ruby port let me know.) Use `npm install ttab -g` to easily install this useful
+  utility.\r\n\e[0m"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Simply run your app
+test_files: []