snooper 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 634956e753d4252eb400d1e90476e5dba0dfb71b
-  data.tar.gz: 48822ec94381e1dde8c9a576aaf3467b1c4192fd
+  metadata.gz: ffb4bc98d8fad3cc57acac6069b1ca64e9f31bf3
+  data.tar.gz: 7d4d1302798e019dc6b0920bf5908faaa45d4ee8
 SHA512:
-  metadata.gz: 6ffcae7b1adb30d9d1a0e3d85ded93dc9b0e67afd7234e1fa52df6c61df60dcc0a80066598aadc3f47e8e81d734fd2342b2f559cc751ef7d071eca2a2ac9e74e
-  data.tar.gz: 294184c9327a8084d66001631931c54db89ce1211ad2d53847e93b3a31fd1315751c184d3a6735a4750c58f287a386e383368be8dae65923db1573010a4ef6b1
+  metadata.gz: bd29330b32b1ce8d0bedde0fbe04e493143c61870dfc709187de1c9d1f747eb026e713e0103b0654ba989db16f456661f4df19f385c83b843cab36ad283b26d1
+  data.tar.gz: 7688ca83d1038ea2e04e567d03a388e8e4bf59e4a0170990ba78da600a11972516d7975fdb363571d28a6d3ca567d514205a0964259a1edacb36ee6d3ba59076

data/bin/snooper

@@ -10,10 +10,13 @@ require 'optparse'
 require 'yaml'
 
 ##
-# Main program loop
+# Internal: Main program loop
+#
+# options - the hash containing the options.
 #
 # Do our stuff, and exit cleanly when interrupted.
-
+#
+# Returns nothing.
 def test_loop(options)
   begin
     dirs = options[:paths].empty? ? './' : options[:paths]
@@ -25,9 +28,9 @@ def test_loop(options)
 end
 
 ##
-# Parse the command line and load the options
+# Internal: Parse the command line and load the options
 #
-
+# Returns a processed options hash
 def get_options
   
   helptext = <<END

data/lib/snooper.rb

@@ -1,4 +1,6 @@
 ##
+# Public: This module provides the snooping abilities.
+# 
 # This program runs in the background watching for file changes. When a file
 # change is dtected a command is run. It is intended to watch repos for changes
 # and run unit tests automatically when source files are changed.
@@ -6,8 +8,7 @@
 # Author::    Will Speak  (@willspeak)
 # Copyright:: Copyright (c) 2013 Will Speak
 # License::   Snoop is open source! See LICENCE.md for more details.
-
-# This module provides the snooping abilities.
+#
 #
 # For most applications calling the +Snooper#watch+ method should be sufficient
 # if Snooper::Snoop objects can be created directly.
@@ -17,9 +18,12 @@ module Snooper
   require 'snooper/version'
 
   ##
-  # Watch for changes in a directory
+  # Public: Watch for changes in a directory
+  #
+  # args - The Hash containing the options. See Snooper::Snoop.new for more
+  #        information
   #
-  # @param args - see Snooper::Snoop.new for more information
+  # Returns the reseult of the run.
   def self.watch(*args)
     george = Snoop.new *args
     george.run

data/lib/snooper/hook.rb

@@ -6,13 +6,13 @@
 module Snooper
   
   ##
-  # File Change Hook
+  # Public: File Change Hook
   #
   # Hooks represent a command that is fired when a given file changes. 
   class Hook
 
     ##
-    # Public : Create a new Hook
+    # Public: Create a new Hook
     #
     # pattern - The String or Regex to match
     # command - The String containig the command to be run
@@ -26,7 +26,7 @@ module Snooper
     end
 
     ##
-    # Public : Fire the hook
+    # Public: Fire the hook
     #
     # Returns the exit code of the command
     def fire
@@ -34,7 +34,7 @@ module Snooper
     end
 
     ##
-    # Public : Run the Hook
+    # Public: Run the Hook
     #
     # path - The String to match agains the hook
     #
@@ -48,7 +48,7 @@ module Snooper
     end
 
     ##
-    # Private : Convert a string, regex, or regex-linke to Regexp
+    # Internal: Convert a string, regex, or regex-linke to Regexp
     #
     # regex - The String or Regexp to convert
     #

data/lib/snooper/snoop.rb

@@ -8,7 +8,7 @@ require 'snooper/hook'
 module Snooper
   
   ##
-  # Watches over a directory, executing a comand when files change
+  # Public: Watches over a directory, executing a comand when files change
   #
   # The fine-grained behaviour of this class is controlled by the parameters
   # passed to the +new+ method.
@@ -19,14 +19,16 @@ module Snooper
     require 'terminfo'
     
     ##
-    # Create a new source code spy
+    # Public: Create a new source code spy
     #
-    # @param [String, Array] path - the path (or paths) to begin watching
-    # @param [Hash] args - the options hash
-    # [+:filters+] [Array,String,Regexp] Files to include, empty for all
-    # [+:ignored+] [Array,String,Regexp] Paths to ignore
-    # [+:command+] [String] The command to run when changes are detected
-    
+    # path - the String or  Array path (or paths) to begin watching
+    # args - the Hash of options
+    #        :filters - The Array, String or Regexp files to include, empty or
+    #                   to signify no filter.
+    #        :ignored - The Array, String or Regexp paths to ignore. As above.
+    #        :command - The String containing the command to run when changes
+    #                   are detected
+    #        :hooks   - The Array of hashes to be converted into Hook objects
     def initialize(path, args = {})
       to_regex = Proc.new { |r| Regexp.try_convert(r) || Regexp.new(r) }
       
@@ -40,12 +42,12 @@ module Snooper
     end
 
     ##
-    # Public : Create Hook Objects
+    # Public: Create Hook Objects
     #
     # raw_hooks - The Array of maps. Each map should contain the pattern to
     #             match and the command to run.
     #
-    # Returns an Array of Hook
+    # Returns an Array of Hooks
     def create_hooks(raw_hooks)
       raw_hooks.to_a.map do |hook|
         Hook.new hook["pattern"], hook["command"]
@@ -53,11 +55,14 @@ module Snooper
     end
     
     ##
-    # Time Command
+    # Internal: Time Command
     #
     # Run a command and time how long it takes. The exit status of the command
     # and the time taken to run the command are both returned.
-    
+    #
+    # command - The command to run
+    #
+    # Returns the result of the command and the time taken to run it, in seconds
     def time_command(command)
       before = Time.new
       result = system command
@@ -66,11 +71,18 @@ module Snooper
     end
     
     ##
-    # Change callback
+    # Internal: Change callback
     #
     # Called when a filesystem change is detected by +listen+. Runs the command
     # passed to t he constructor and prints a summary of the output.
-    
+    #
+    # modified - The Array of paths that were modified since the last change
+    # added    - The Array of paths that were added since the last change
+    # removed  - The Array of paths that were removed since the last change
+    #
+    # Raises nothing.
+    #
+    # Returns nothing.
     def on_change(modified, added, removed)
       begin
         # Puase the listener to avoid spurious triggers from build output
@@ -105,14 +117,17 @@ module Snooper
     end
   
     ##
-    # Prettify a status line
+    # Internal: Prettify a status line
     #
     # Prints the message at the center of the line, automatically detected
     # from the terminal info. If a block is supplied then the resulting message
     # is post-filtered by it before being returned.
     #
-    # @param message - the message to print
-    
+    # message - the message to print
+    #
+    # Yields the String that has been aligned to the terminal width.
+    #
+    # Returns the prettified String.
     def statusbar(message, time=nil)
       message << " (#{time.round(3)}s)" if time
       message = message.to_s.center TermInfo.screen_width - 1
@@ -120,12 +135,13 @@ module Snooper
     end
     
     ##
-    # Main run loop
+    # Public: Main run loop
     #
     # Registers for filesystem notifications and dispatches them to the
-    # +on_change+ handler. This method also forces a dummy update to ensure that
+    # #on_change handler. This method also forces a dummy update to ensure that
     # tests are run when watching begins.
-    
+    #
+    # Returns the result of the listener
     def run
       
       # Force a change to start with
@@ -137,7 +153,7 @@ module Snooper
         :ignore => @ignored)
       @listener.change &callback_helper
 
-      @listener.start
+      @listener.start!
     end
   end
 end

data/lib/snooper/version.rb

@@ -1,10 +1,14 @@
+# -*- coding: utf-8 -*-
+# Author::    Will Speak  (@willspeak)
+# Copyright:: Copyright (c) 2013 Will Speak
+# License::   Snoop is open source! See LICENCE.md for more details.
+
 module Snooper
   
   ##
-  # The library version for this module
+  # Public: The library version for this module
   #
   # This should conform to SemVer. If this is changed it should be the only
   # thing that changes in the comit.
-  
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snooper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Will Speak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-06 00:00:00.000000000 Z
+date: 2013-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: ruby-terminfo
   requirement: !ruby/object:Gem::Requirement