snooper 2.1.5 → 2.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 460124dd221c156c48505c20d5a7fe2019177626
-  data.tar.gz: 9c4cf277e780feb3f6b44897472ed864976745c2
+  metadata.gz: 6f26141250e0dd9dbaca8220c7b6c43c56efd87e
+  data.tar.gz: 7778c3ee706a99d9dbd0e01c9dbb5606fec11c00
 SHA512:
-  metadata.gz: 96316e289f3ef96311c2069127aa3da5abab27ea5eee7447a42eaded86c7909ad3814e4afb078010edd5802cbe1f3ff05b62920e4829d574d820fb9065ead992
-  data.tar.gz: d4f0ac8ff369de89231dad62288e52fd36e3c04d34e4cc6a8d9a166c2b13b25d0c42f83e7d57b093944e4bee3015848969a639c1504e22f55f6d0e241cf92858
+  metadata.gz: a8eac98c5bc31e785dd73bd93171b3d6d9122bd1c33141c4ec3bb2eca4db4186eff521123d9a6c9cd3eaa118cf40ef45d8eb8156eeee5f803b7a5c9be58aa96c
+  data.tar.gz: 9d3aec46e183dc6670450db660d5e41a3b1d02c6668cdb2d97bf368f96424fc00c2376d8ddb06cc93c15df2041fe6afe992df53bad426e048e2f3c6b0e16dc89

data/bin/snooper

@@ -35,6 +35,22 @@ end
 
 options = Snooper::Options.parse ARGV
 
+if options.command == 'init'
+  require 'fileutils'
+
+  target = File.join Dir.pwd, ".snooper.yaml"
+  if File.exists? target
+    fatal_error "Configuration file '#{target}' already exists"
+  end
+
+  source = File.expand_path "../../data/_snooper.yaml", __FILE__
+
+  puts "Creating Snooper configuration file '#{target}'"
+  FileUtils::Verbose::cp source, target
+
+  exit 0
+end
+
 if options.config_path.nil?
   fatal_error "couldn't find a config file. Did you miss a `--config=`?"
 end

data/data/_snooper.yaml

@@ -0,0 +1,56 @@
+# Snooper is open source! - see LICENSE.md in source distributions for
+# details. This file is released into the public domain and may be
+# included in any software distribution, both commercial and non-comercial.
+---
+## Snooper Configuration File
+
+## Base directory
+#
+# relative to this configuration file. All paths are relative to this directory.
+base_path: .
+
+## Command to execute
+#
+# When changes are noticed. This command is run in `base_path:`.
+command: >
+ echo Edit '`command:`' in .snooper.yaml to change the command
+ that is run.
+
+## Paths to Watch
+#
+# Resticts the paths in which changes are watched for. Add just the
+# places you want to monitor here to prevent temporary files or build
+# files triggering re-tests if you don't want them.
+#paths: [bin, test, lib]
+
+## Filters
+#
+# Restricts the types of files that trigger a re-test. If a file path
+# matches any of these regular expressions then the command is
+# executed.
+filters:
+# - \.rb$    # Ruby files
+# - \.h$     # C/C++ header files
+# - \.cpp$   # C++ files
+# - \.c$     # C files
+# - \.py$    # Python files
+
+## Force Polling
+#
+# Use this setting to overide the normal file system watcher and use
+# the polling mode. This may be required for some file system types or
+# when working with some kinds of shared folders.
+# force_poll: true
+
+## Hooks
+#
+# Hooks allow special commands to be performed on a sub-set of the
+# changes. They can be used to re-build specific files or run
+# specialised test cases.
+hooks:
+ - pattern: \.snooper\.yaml$
+   command: >
+    echo The snooper config file was edited!. Look at the '`hooks:`'
+    section in the snooper config file to see how to run command on a
+    subset of changes like this one is.
+...

data/lib/snooper/snoop.rb

@@ -16,7 +16,6 @@ module Snooper
   
     require 'listen'
     require 'colored'
-    require 'terminfo'
     
     ##
     # Public: Create a new source code spy
@@ -117,6 +116,21 @@ module Snooper
       res
     end
 
+    @terminal_width = nil
+
+    ## Internal: Get the Terminal Width
+    #
+    # Returns the width of the terminal, if one is connected, in characters
+    def term_width
+      return @@terminal_width unless @terminal_width == nil
+      begin
+        require 'terminfo'
+        @@terminal_width = TermInfo.screen_width - 1
+      rescue
+        @@terminal_width = 79
+      end
+    end
+
     ##
     # Internal: Prettify a status line
     #
@@ -131,7 +145,7 @@ module Snooper
     # 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
+      message = message.to_s.center term_width
       block_given? ? yield(message) : message
     end
     
@@ -144,20 +158,30 @@ module Snooper
     #
     # Returns the result of the listener
     def run
+      evq = Queue.new
+
       if @config.file_path
         dir = File.dirname @config.file_path
         filter = %r{#{File.basename @config.file_path}$}
-        Listen.to dir, relative_paths: false, filter: filter do |*args|
+        @cfg_listener = Listen.to dir do |*args|
           next unless args.reduce(&:+).include? @config.file_path
-          puts statusbar "Re-loading Config File...", &:yellow
-          @listener.stop if @listener
+          if @listener
+            puts statusbar "Re-loading Config File...", &:yellow
+            @listener.stop
+            evq.push true
+          end
         end
+        @cfg_listener.start
       end
 
+      # on C-c tell all listeners to stop
+      Signal.trap "INT", "DEFAULT"
+
       # loop forever listening, each time the above block causes the listener
       # to stop it will re-start listening with the new config.
       while true
         do_listening
+        break unless evq.pop
         @config.reload
       end
     end
@@ -179,12 +203,14 @@ module Snooper
 
         # Force a change to start with
         run_command
-        
+
         params = {
           latency: 0.5,
-          only: @config.filters, ignore: @config.ignored,
         }
 
+        params[:only] = Regexp.new(@config.filters.join("|")) unless @config.filters.empty?
+        params[:ignore] = Regexp.new(@config.ignored.join("|")) unless @config.ignored.empty?
+
         if @config.force_poll
           params[:latency] = @config.force_poll
           params[:force_poll] = true
@@ -194,9 +220,7 @@ module Snooper
           self.on_change *args
         end
         
-        t = @listener.start
-        Signal.trap("INT", "DEFAULT")
-        t.join
+        @listener.start
       end
     end
 

data/lib/snooper/version.rb

@@ -10,5 +10,5 @@ module Snooper
   #
   # This should conform to SemVer. If this is changed it should be the only
   # thing that changes in the comit.
-  VERSION = '2.1.5'
+  VERSION = '2.1.6'
 end

data/man/snooper-config.7.html

@@ -95,7 +95,7 @@
 
 <h2 id="FORMAT">FORMAT</h2>
 
-<p><a class="man-ref" href="snooper.1.html">snooper<span class="s">(1)</span></a> expects a YAML document of key-value pairs; each pair specifies an
+<p><span class="man-ref">snooper<span class="s">(1)</span></span> expects a YAML document of key-value pairs; each pair specifies an
 option. Unknown options are ignored. Options that can contain a list of values
 may also be given a single value.</p>
 
@@ -164,7 +164,7 @@ as the global <code>command:</code> key.</p></dd>
 
 <h2 id="SEE-ALSO">SEE ALSO</h2>
 
-<p><a class="man-ref" href="snooper.1.html">snooper<span class="s">(1)</span></a></p>
+<p><span class="man-ref">snooper<span class="s">(1)</span></span></p>
 
 <h2 id="AUTHORS">AUTHORS</h2>
 

data/man/snooper.1

@@ -9,6 +9,9 @@
 .SH "SYNOPSIS"
 \fBsnooper\fR \fIoptions\fR [\fIcommand_line\fR]*
 .
+.br
+\fBsnooper\fR init
+.
 .SH "DESCRIPTION"
 \fBSnooper\fR is a lightweight test automation tool, it monitors files and folders while you work and re\-runs your tests when you change something\. Snooper doesn\'t care what language you\'re using or what framework you are testing with, it\'s all configureable\.
 .
@@ -27,6 +30,10 @@ Force polling, optionally setting the frequency\. Polling frequency is measured
 \fIcommand_line\fR
 One or more \fIcommand_line\fRs to execute when source files change\. Overides any commands specified in the configuration file\.
 .
+.TP
+\fBinit\fR
+Create a new \fB\.snooper\.yaml\fR configuration file in the current working directory\. Use this to quickly add snooper support to a project\.
+.
 .SH "EXAMPLES"
 \fB$ snooper\fR
 .

data/man/snooper.1.html

@@ -93,7 +93,8 @@
 
 <h2 id="SYNOPSIS">SYNOPSIS</h2>
 
-<p><code>snooper</code> <var>options</var> [<var>command_line</var>]*</p>
+<p><code>snooper</code> <var>options</var> [<var>command_line</var>]*<br />
+<code>snooper</code> init</p>
 
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
 
@@ -104,18 +105,23 @@ testing with, it's all configureable.</p>
 
 <h2 id="OPTIONS">OPTIONS</h2>
 
-<p>Most configuration takes place in the <a class="man-ref" href="snooper-config.7.html">snooper-config<span class="s">(7)</span></a> file. You can however
+<p>Most configuration takes place in the <span class="man-ref">snooper-config<span class="s">(7)</span></span> file. You can however
 override the command that is run. This is useful if you are only working on a
 subsection of a project that has it's own tests.</p>
 
 <dl>
 <dt><code>-c</code>, <code>--config</code> <var>configfile</var></dt><dd><p>Specify the configuration file to use. The default is <code>.snooper.yaml</code> in the
 current directory, or any of it's parent directories.</p></dd>
-<dt><code>-p</code>, <code>--poll</code> [<var>frequency</var>]</dt><dd><p>Force polling, optionally setting the frequency. Polling frequency is measured in seconds. Use this if there seem to be bugs in your builtin OS file
-notification system. <em>Warning</em>: using this option may slow down snooper's
-reaction to file changes and increase resource usage.</p></dd>
+<dt><code>-p</code>, <code>--poll</code> [<var>frequency</var>]</dt><dd><p>Force polling, optionally setting the frequency. Polling frequency
+is measured in seconds. Use this if there seem to be bugs in your
+builtin OS file notification system. <em>Warning</em>: using this option
+may slow down snooper's reaction to file changes and increase
+resource usage.</p></dd>
 <dt><var>command_line</var></dt><dd><p>One or more <var>command_line</var>s to execute when source files change. Overides any
 commands specified in the configuration file.</p></dd>
+<dt class="flush"><code>init</code></dt><dd><p>Create a new <code>.snooper.yaml</code> configuration file in the current
+working directory. Use this to quickly add snooper support to a
+project.</p></dd>
 </dl>
 
 
@@ -136,7 +142,7 @@ when files change.</p>
 
 <h2 id="SEE-ALSO">SEE ALSO</h2>
 
-<p><a class="man-ref" href="snooper-config.7.html">snooper-config<span class="s">(7)</span></a></p>
+<p><span class="man-ref">snooper-config<span class="s">(7)</span></span></p>
 
 <h2 id="AUTHORS">AUTHORS</h2>
 

data/man/snooper.1.ronn

@@ -3,7 +3,8 @@ snooper(1) -- Spy on Tests
 
 ## SYNOPSIS
 
-`snooper` <options> [<command_line>]*
+`snooper` <options> [<command_line>]*  
+`snooper` init
 
 ## DESCRIPTION
 
@@ -23,14 +24,21 @@ subsection of a project that has it's own tests.
    current directory, or any of it's parent directories.
 
  * `-p`, `--poll` [<frequency>]:
-   Force polling, optionally setting the frequency. Polling frequency is measured in seconds. Use this if there seem to be bugs in your builtin OS file
-   notification system. _Warning_: using this option may slow down snooper's
-   reaction to file changes and increase resource usage.
+   Force polling, optionally setting the frequency. Polling frequency
+   is measured in seconds. Use this if there seem to be bugs in your
+   builtin OS file notification system. _Warning_: using this option
+   may slow down snooper's reaction to file changes and increase
+   resource usage.
 
  * <command_line>:
    One or more <command_line>s to execute when source files change. Overides any
    commands specified in the configuration file.
 
+ * `init`:
+   Create a new `.snooper.yaml` configuration file in the current
+   working directory. Use this to quickly add snooper support to a
+   project.
+
 ## EXAMPLES
 
 `$ snooper`
@@ -53,4 +61,3 @@ snooper-config(7)
 ## AUTHORS
 
 Will Speak (@willspeak)
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snooper
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.1.6
 platform: ruby
 authors:
 - Will Speak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-07 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -90,6 +90,7 @@ files:
 - man/snooper.1
 - man/snooper.1.html
 - man/snooper.1.ronn
+- data/_snooper.yaml
 - LICENCE.md
 - README.md
 homepage: http://github.com/iwillspeak/snooper