appear 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2195b39f50d42701282eccd5bcca70318d9522d6
-  data.tar.gz: c26570e72fae4f929d5c715510d64f671c2dc8ab
+  metadata.gz: 8d114dfa1bdcda18b13325f5d7961b296b09a8b2
+  data.tar.gz: 26fcebb685c8a0adcc5cac80c9bd1a7ce3153eef
 SHA512:
-  metadata.gz: dd03024e868fdeb5a6d19da9d07e7c4387fab5002ebfd9b7a1ff884e4620750c6cbf67cd9273e7c18b208c63914e7b8c93efeccbae52b7552827de880fc4f5a3
-  data.tar.gz: 0d4d9a852ed5477fd9cac3b537ec26740292b3c31220ccdc95248995c98ec5bb833921c00edf086da9bf1f668ed5fad6015f6d26279b23dcf4beb0db5da4cd3b
+  metadata.gz: 12f5f608f578ae6042e987fd20a5082d70c4b8067bfaebaf3e033fcacf66ede064bec3892d1174bf3be16a3168a91b80095ec798354d63f79e067609ab577eef
+  data.tar.gz: 848a59a97371e61417851e9fe8cdf33436d1e4e5ccf9a5d9ec9af0618c091d197babf493c48332ec0f5b975408acda7f0b02513582cf9b929334d74afb345a96

data/.doc-coverage

@@ -1 +1 @@
-73.05
+80.43

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.1
+
+- passing in a PID was broken.
+
 ## 1.1.0
 
 - You no longer have to pass a PID. If no PID is given, `appear` will default

data/lib/appear/command.rb

@@ -4,8 +4,6 @@ require 'appear/instance'
 require 'optparse'
 
 module Appear
-  class InvalidPidError < Error; end
-
   # Entrypoint and manager for the command-line `appear` tool.
   class Command
     def initialize
@@ -13,6 +11,9 @@ module Appear
       @config.silent = true
     end
 
+    # The ui for our command.
+    #
+    # @return [OptionParser]
     def option_parser
       @option_parser ||= OptionParser.new do |o|
         o.banner =  'Usage: appear [OPTION]... [PID]'
@@ -53,15 +54,18 @@ module Appear
       end
     end
 
+    # Execute the command. Will exit(3) with a status; does not return.
+    #
     # @param all_args [Array<String>] something like ARGV
     def execute(all_args)
       argv = option_parser.parse(*all_args)
 
-      pid = Integer(argv[0] || Process.pid, 10)
-
-      start_message = "STARTING. pid: #{pid}"
       if argv.empty?
-        start_message += " (current process pid)"
+        pid = Process.pid
+        start_message = "STARTING. pid: #{pid} (current process pid)"
+      else
+        pid = Integer(argv[0])
+        start_message = "STARTING. pid: #{pid}"
       end
 
       start = Time.now

data/lib/appear/constants.rb

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

data/lib/appear/instance.rb

@@ -11,9 +11,6 @@ require 'appear/tmux'
 require 'appear/revealers'
 
 module Appear
-  class CannotRevealError < Error; end
-  class NoGuiError < CannotRevealError; end
-
   # Instance is the main class in Appear. It constructs all the other services
   # and co-ordinates the actual revealing process.
   class Instance < Service
@@ -40,6 +37,10 @@ module Appear
       super(@all_services)
     end
 
+    # appear the given PID.
+    #
+    # @param pid [Number] process id
+    # @return [Boolean] true if we revealed something, false otherwise.
     def call(pid)
       tree = process_tree(pid)
 

data/lib/appear/join.rb

@@ -21,7 +21,7 @@ module Appear
   class Join
     # @param field [Symbol] the method or hash field name to join on.
     # @param tables [Array<Any>] arrays of any sort of object, so long as it is
-    # either a hash, or implements the given field.
+    #   either a hash, or has a method named `field`.
     # @return [Array<Join>]
     def self.join(field, *tables)
       by_field = Hash.new { |h, k| h[k] = self.new }
@@ -39,6 +39,12 @@ module Appear
       end
     end
 
+    # True if we can access the given field on an object, either by calling
+    # that method on the object, or by accessing using []
+    #
+    # @param obj [Any]
+    # @param field [Symbol, String]
+    # @return [Boolean]
     def self.can_access?(obj, field)
       if obj.respond_to?(field)
         return true
@@ -48,6 +54,12 @@ module Appear
       return false
     end
 
+    # Access the given field on an object.
+    # Raises an error if the field cannot be accessed.
+    #
+    # @param object [Any]
+    # @param field [Symbol, String]
+    # @return [Any] the value at that field
     def self.access(obj, field)
       if obj.respond_to?(field)
         obj.send(field)
@@ -58,21 +70,34 @@ module Appear
       end
     end
 
-    # an instance of Join is a joined object containing all the data in all its
-    # parts. Joins are read from left to right, returning the first non-nil
-    # value encountered.
+    # A Join is a union of data objects. You can use a Join to group objects of
+    # different types, so that you may read from whichever has a given field.
+    #
+    # It is more useful to use self.join to perform a join operation on
+    # collections than to create Join objects directly.
     def initialize(*objs)
       @objs = objs
     end
 
-    def push!(obj, note = nil)
+    # add another data object to this join.
+    #
+    # @param obj [Any]
+    def push!(obj)
       @objs << obj
     end
 
+    # get the number of objects in this join
+    #
+    # @return [Fixnum]
     def joined_count
       @objs.length
     end
 
+    # read a field from the join. Returns the first non-nil value we can read.
+    # @see self.access for information about how fields are accessed.
+    #
+    # @param sym [String, Symbol] the field name
+    # @return [Any, nil]
     def [](sym)
       result = nil
 
@@ -86,6 +111,12 @@ module Appear
       result
     end
 
+    # the {#method_missing} implementation on a Join allows you to access valid
+    # fields with regular accessors.
+    #
+    # @param method [String, Symbol]
+    # @param args [Array<Any>] should have none
+    # @param block [Proc] should have none
     def method_missing(method, *args, &block)
       raise NoMethodError.new("Cannot access #{method.inspect}") unless respond_to?(method)
       raise ArgumentError.new("Passed args to accessor") if args.length > 0
@@ -93,6 +124,9 @@ module Appear
       self[method]
     end
 
+    # @param sym [String, Symbol] name of the method
+    # @param priv [Boolean] default false
+    # @return [Boolean] true if we can respond to the given method name
     def respond_to?(sym, priv = false)
       super(sym, priv) || (@objs.any? { |o| self.class.can_access?(o, sym) })
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appear
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Jake Teton-Landis