appear 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9681e2caa004fa47ac9de625c11820765c0d989
-  data.tar.gz: a8a034aa39551ed9310040e79785b198da7471e9
+  metadata.gz: 2195b39f50d42701282eccd5bcca70318d9522d6
+  data.tar.gz: c26570e72fae4f929d5c715510d64f671c2dc8ab
 SHA512:
-  metadata.gz: 3e1c8106d98906c6a873ce0f767c715e3a6501717c8bd149df3688d3ca1c7a4a0275486d2da2d11f177aa846511d6fac6fb696bfdce835c7f98e1aaf2e6c6b80
-  data.tar.gz: 664bd25942f049a19902d3a9e34724b6910dd0a01ec3901affe77a7ee8d5b072168ad47f4fc8a38051ccdbda8e9a967317b7ca5a46c2f53aafbe97ebc566d4a7
+  metadata.gz: dd03024e868fdeb5a6d19da9d07e7c4387fab5002ebfd9b7a1ff884e4620750c6cbf67cd9273e7c18b208c63914e7b8c93efeccbae52b7552827de880fc4f5a3
+  data.tar.gz: 0d4d9a852ed5477fd9cac3b537ec26740292b3c31220ccdc95248995c98ec5bb833921c00edf086da9bf1f668ed5fad6015f6d26279b23dcf4beb0db5da4cd3b

data/CHANGELOG.md

@@ -1,8 +1,18 @@
 # Changelog
 
+## 1.1.0
+
+- You no longer have to pass a PID. If no PID is given, `appear` will default
+  to the current process.
+- by default, `appear` will print no output. Pass -v or --verbose for timing
+  and logging information. It previously printed the PID and timing
+  information by default, and then more extensive logs with --verbose.
+- improved help output
+- added --version command line option
+
 ## 1.0.3
 
-remove some binding.pry that really shouldn't have been there
+- remove some binding.pry that really shouldn't have been there
 
 ## 1.0.2
 

data/README.md

@@ -23,16 +23,23 @@ currently only supports macOS.
 ## usage
 
 ```
-Usage: appear [options] PID - appear PID in your user interface
+Usage: appear [OPTION]... [PID]
+Appear PID in your user interface.
+Appear will use the current process PID by default.
+
+Options:
     -l, --log-file [PATH]            log to a file
     -v, --verbose                    tell many tales about how the appear process is going
-        --record-runs                record every executed command as a JSON file
+        --record-runs                record every executed command as a JSON file in the appear spec folder
+        --version                    show version information, then exit
+    -?, -h, --help                   show this help, then exit
+
+Exit status:
+  0  if successfully revealed something,
+  1  if an exception occured,
+  2  if there were no errors, but nothing was revealed.
 ```
 
-Appear will exit 0 if it managed to reveal something.
-Appear will exit 1 if an exception occured.
-Appear will exit 2 if there were no errors, but nothing was revealed.
-
 ## supported terminal emulators
 
 macOS:

data/lib/appear/command.rb

@@ -15,7 +15,12 @@ module Appear
 
     def option_parser
       @option_parser ||= OptionParser.new do |o|
-        o.banner = 'Usage: appear [options] PID - appear PID in your user interface'
+        o.banner =  'Usage: appear [OPTION]... [PID]'
+        o.separator 'Appear PID in your user interface.'
+        o.separator 'Appear will use the current process PID by default.'
+        o.separator ''
+        o.separator 'Options:'
+
         o.on('-l', '--log-file [PATH]', 'log to a file') do |file|
           @config.log_file = file
         end
@@ -24,26 +29,47 @@ module Appear
           @config.silent = false if flag
         end
 
-        o.on('--record-runs', 'record every executed command as a JSON file') do |flag|
+        o.on('--record-runs', 'record every executed command as a JSON file in the appear spec folder') do |flag|
           @config.record_runs = flag
         end
+
+        o.on('--version', 'show version information, then exit') do
+          puts "appear #{Appear::VERSION}"
+          puts "  author: Jake Teton-Landis"
+          puts "  repo: https://github.com/airbnb/appear"
+          exit 2
+        end
+
+        o.on('-?', '-h', '--help', 'show this help, then exit') do
+          puts o
+          exit 2
+        end
+
+        o.separator ''
+        o.separator 'Exit status:'
+        o.separator '  0  if successfully revealed something,'
+        o.separator '  1  if an exception occured,'
+        o.separator '  2  if there were no errors, but nothing was revealed.'
       end
     end
 
+    # @param all_args [Array<String>] something like ARGV
     def execute(all_args)
-      argv = option_parser.parse!(all_args)
+      argv = option_parser.parse(*all_args)
+
+      pid = Integer(argv[0] || Process.pid, 10)
 
-      pid = argv[0].to_i
-      if pid == 0
-        raise InvalidPidError.new("Invalid PID #{argv[0].inspect} given (parsed to 0).")
+      start_message = "STARTING. pid: #{pid}"
+      if argv.empty?
+        start_message += " (current process pid)"
       end
 
       start = Time.now
       revealer = Appear::Instance.new(@config)
-      revealer.output("STARTING. pid: #{pid}")
+      revealer.log(start_message)
       result = revealer.call(pid)
       finish = Time.now
-      revealer.output("DONE. total time: #{finish - start} seconds, success: #{result}")
+      revealer.log("DONE. total time: #{finish - start} seconds, success: #{result}")
 
       if result
         # success! revealed something!

data/lib/appear/constants.rb

@@ -1,7 +1,7 @@
 require 'pathname'
 
 module Appear
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 
   # root error for our library; all other errors inherit from this one.
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appear
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Jake Teton-Landis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-09 00:00:00.000000000 Z
+date: 2016-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler