snooper 2.1.1 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3911c398b1c83b549e996a605f65e79211e2ee4a
-  data.tar.gz: a91ca9f1ff1b114c70e9d9872fa695975b98c752
+  metadata.gz: ecf5d18d47ffc327af5f333db3b4336e68d9549f
+  data.tar.gz: 9de0ed66d00dcdebfd4b689ac20a95d49735a920
 SHA512:
-  metadata.gz: 5bc6a4a0e02acbfee57efe128efb893dc3e8ee40e848b312e257adf07b42ba552c5c775d5d40eb43ecf5f35b7a961e0889331e2913b158208c8f43ee7e962265
-  data.tar.gz: aaadd056771a21fcd7bc14d40baee028da7f87222d12fbafc0227ec2c94b5df50d534f801bc6eec587a0d4a9da316435880b9877d80979d13eca556d80ce68db
+  metadata.gz: 085d681726b0628ae5ca2a681cf8cba65080b109343a4c2d8144d0164ddd98405f80ed82934e7ddd2a97425589b5ece31eaf5f3557dd04a07525bea43901cd40
+  data.tar.gz: 2ed397a6e998f5fe90397208d5a9a0c0f9e372dd2f2be350c3733d282eb0bc0a746d58072d38b56b6a81f0229b3dad5f65d2ac74d993319fd00430bcf309fb50

data/bin/snooper

@@ -34,5 +34,8 @@ end
 # Override the command if one was specified
 config.command = options.command if options.command
 
+# Force polling if command line flag is set
+config.force_poll = options.poll if options.poll
+
 # Run the tests, pusing the target directory
 test_loop config

data/lib/snooper/config.rb

@@ -35,6 +35,9 @@ module Snooper
     # file_path - The location the config was loaded from
     attr_accessor :file_path
 
+    # force_poll - Make sure polling is used
+    attr_accessor :force_poll
+
     ##
     # Public: create a new config object
     #
@@ -77,6 +80,19 @@ module Snooper
       @ignored = rgx_key.call :ignored
 
       @hooks = (options[:hooks] && create_hooks(options[:hooks])) || []
+
+      # Force poll if it is stored in the options file.
+      case options[:force_poll]
+        when true
+        @force_poll = 1.0
+        
+        when false, nil
+        @force_poll = nil
+
+        else
+        @force_poll = options[:force_poll].to_f
+        @force_poll = 1.0 if @force_poll <= 0.0
+      end
     end
 
     ##
@@ -147,6 +163,9 @@ module Snooper
             Hook.new hook_hash["pattern"], hook_hash["command"]
           end
 
+        when 'force_poll'
+          # Boolean conversion is all done by YAML
+
         else
           $stderr.puts "warning: ignoring unknown option #{key}"
         end

data/lib/snooper/hook.rb

@@ -8,7 +8,7 @@ module Snooper
   ##
   # Public: File Change Hook
   #
-  # Hooks represent a command that is fired when a given file changes. 
+  # Hooks represent a command that is fired when a given file changes.
   class Hook
 
     ##

data/lib/snooper/options.rb

@@ -11,7 +11,7 @@ module Snooper
 
     ##
     # Public: Command Line Options
-    ParsedOptions = Struct.new :config_path, :command
+    ParsedOptions = Struct.new :config_path, :command, :poll
 
     ##
     # Public: Parse the command line
@@ -50,6 +50,10 @@ END
           exit
         end
         
+        parser.on("-p", "--poll [FREQUENCY]", "Force filesystem polling.") do |freq|
+          options.poll = freq || true
+        end
+
         parser.on("-h", "--help", "Show this message") do
           puts parser
           exit

data/lib/snooper/snoop.rb

@@ -171,16 +171,32 @@ module Snooper
     # Returns the result of the listener
     def do_listening
       in_dir @config.base_path do
+
+        # Notify people if we are using fallback mode
+        if @config.force_poll
+          puts statusbar "Using polling fallback listener", &:yellow
+        end
+
         # Force a change to start with
         run_command
         
-        callback_helper = Proc.new { |*args| self.on_change *args }
-        
-        @listener = Listen.to(*@config.paths, latency: 0.5,
-                              filter: @config.filters, ignore: @config.ignored)
-        @listener.change &callback_helper
+        params = {
+          latency: 0.5,
+          filter: @config.filters, ignore: @config.ignored,
+        }
 
-        @listener.start!
+        if @config.force_poll
+          params[:latency] = @config.force_poll
+          params[:force_poll] = true
+        end
+
+        @listener = Listen.to(*@config.paths, params) do |*args|
+          self.on_change *args
+        end
+        
+        t = @listener.start
+        Signal.trap("INT", "DEFAULT")
+        t.join
       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.1'
+  VERSION = '2.1.3'
 end

data/man/snooper-config.7

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "SNOOPER\-CONFIG" "7" "July 2013" "" ""
+.TH "SNOOPER\-CONFIG" "7" "October 2013" "" ""
 .
 .SH "NAME"
 \fBsnooper\-config\fR \- Configure for Espionage
@@ -17,7 +17,7 @@ String options
 .
 .TP
 \fBbase_path:\fR \fIdirectory\fR
-Specifies the \fIdirectory\fR that \fBsnooper\fR should base all relative paths from\. This is also the working directory that commands will inherit\.
+Specifies the \fIdirectory\fR that \fBsnooper\fR should base all relative paths from\. This is also the working directory that commands and hooks will inherit\.
 .
 .TP
 \fBcommand:\fR \fIcommand_string\fR
@@ -35,9 +35,26 @@ Specifies a list of \fIdirectories\fR to watch\. Directories can be either relat
 Specifies a list of regular expressions \fIfilters\fR to use to filter the changes\. These should be in a format understood by ruby(1)\'s Regex\.new method\. If none are given then all changes in watched directories trigger testing\.
 .
 .IP
+A file change satisfies these filters if the file path matches any of the regular expressions in \fBfilters\fR and none of those in \fBignored\fR\.
+.
+.IP
 \fINote\fR: as these are regular expressions \fB\e\.c\fR will match both \fBfoo\.c\fR and \fBbar\.cfg\fR, \fB\e\.c$\fR will only match \fB\.c\fR files\.
 .
 .P
+Polling
+.
+.IP "\(bu" 4
+\fBforce_poll\fR: \fIpoll\fR Specifies if the polling fallback mode should be used and controls the polling frequency in seconds\. Include this option if you want to use polling but don\'t want to have to specify it on the command line\. Defaults to false\.
+.
+.IP "" 0
+.
+.P
+This mode can be slower and more buggy but is useful for working around bugs in third party applications that hide filesystem events\. Known to be required when you are snooping on VirtualBox shared folders, or in Dropbox folders\.
+.
+.P
+\fINote\fR: This option can be overridden from the command line with the \fB\-\-poll\fR option\.
+.
+.P
 Hooks
 .
 .P

data/man/snooper-config.7.html

@@ -105,7 +105,7 @@ may also be given a single value.</p>
 
 <dl>
 <dt><code>base_path:</code> <var>directory</var></dt><dd><p>Specifies the <var>directory</var> that <code>snooper</code> should base all relative paths from.
-This is also the working directory that commands will inherit.</p></dd>
+This is also the working directory that commands and hooks will inherit.</p></dd>
 <dt><code>command:</code> <var>command_string</var></dt><dd><p>Specifies the command string to execute when a file change is detected.</p></dd>
 </dl>
 
@@ -121,11 +121,26 @@ changes. These should be in a format understood by <span class="man-ref">ruby<sp
 method. If none are given then all changes in watched directories trigger
 testing.</p>
 
+<p>A file change satisfies these filters if the file path matches any of the
+regular expressions in <code>filters</code> and none of those in <code>ignored</code>.</p>
+
 <p><em>Note</em>: as these are regular expressions <code>\.c</code> will match both
 <code>foo.c</code> and <code>bar.cfg</code>, <code>\.c$</code> will only match <code>.c</code> files.</p></dd>
 </dl>
 
 
+<p>Polling</p>
+
+<ul>
+<li><code>force_poll</code>: <var>poll</var>
+ Specifies if the polling fallback mode should be used and controls the polling frequency in seconds. Include this option if you want to use polling but don't want to have to specify it on the command line. Defaults to false.</li>
+</ul>
+
+
+<p> This mode can be slower and more buggy but is useful for working around bugs in third party applications that hide filesystem events. Known to be required when you are snooping on VirtualBox shared folders, or in Dropbox folders.</p>
+
+<p><em>Note</em>: This option can be overridden from the command line with the <code>--poll</code> option.</p>
+
 <p>Hooks</p>
 
 <p>Hooks are useful to pefrom special commads upon a subset of the file-change
@@ -162,7 +177,7 @@ as the global <code>command:</code> key.</p></li>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>July 2013</li>
+    <li class='tc'>October 2013</li>
     <li class='tr'>snooper-config(7)</li>
   </ol>
 

data/man/snooper-config.7.ronn

@@ -17,7 +17,7 @@ String options
  
  * `base_path:` <directory>:
    Specifies the <directory> that `snooper` should base all relative paths from.
-   This is also the working directory that commands will inherit.
+   This is also the working directory that commands and hooks will inherit.
    
  * `command:` <command_string>:
    Specifies the command string to execute when a file change is detected.
@@ -35,9 +35,21 @@ String Array options
    method. If none are given then all changes in watched directories trigger
    testing.
    
+   A file change satisfies these filters if the file path matches any of the
+   regular expressions in `filters` and none of those in `ignored`.
+   
    _Note_: as these are regular expressions `\.c` will match both
    `foo.c` and `bar.cfg`, `\.c$` will only match `.c` files.
 
+Polling
+
+ * `force_poll`: <poll>
+	Specifies if the polling fallback mode should be used and controls the polling frequency in seconds. Include this option if you want to use polling but don't want to have to specify it on the command line. Defaults to false.
+
+ This mode can be slower and more buggy but is useful for working around bugs in third party applications that hide filesystem events. Known to be required when you are snooping on VirtualBox shared folders, or in Dropbox folders. 
+
+_Note_: This option can be overridden from the command line with the `--poll` option.
+
 Hooks
 
 Hooks are useful to pefrom special commads upon a subset of the file-change

data/man/snooper.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "SNOOPER" "1" "June 2013" "" ""
+.TH "SNOOPER" "1" "October 2013" "" ""
 .
 .SH "NAME"
 \fBsnooper\fR \- Spy on Tests
@@ -17,7 +17,11 @@ Most configuration takes place in the snooper\-config(7) file\. You can however
 .
 .TP
 \fB\-c\fR, \fB\-\-config\fR \fIconfigfile\fR
-Specify the configuration file to use\. The default is \fB\.snooper\.yaml\fR in the current directory\.
+Specify the configuration file to use\. The default is \fB\.snooper\.yaml\fR in the current directory, or any of it\'s parent directories\.
+.
+.TP
+\fB\-p\fR, \fB\-\-poll\fR [\fIfrequency\fR]
+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\. \fIWarning\fR: using this option may slow down snooper\'s reaction to file changes and increase resource usage\.
 .
 .TP
 \fIcommand_line\fR

data/man/snooper.1.html

@@ -110,7 +110,10 @@ 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.</p></dd>
+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><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>
 </dl>
@@ -142,7 +145,7 @@ when files change.</p>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>June 2013</li>
+    <li class='tc'>October 2013</li>
     <li class='tr'>snooper(1)</li>
   </ol>
 

data/man/snooper.1.ronn

@@ -9,7 +9,7 @@ snooper(1) -- Spy on Tests
 
 **Snooper** 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 
+Snooper doesn't care what language you're using or what framework you are
 testing with, it's all configureable.
 
 ## OPTIONS
@@ -20,7 +20,12 @@ subsection of a project that has it's own tests.
 
  * `-c`, `--config` <configfile>:
    Specify the configuration file to use. The default is `.snooper.yaml` in the
-   current directory.
+   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.
 
  * <command_line>:
    One or more <command_line>s to execute when source files change. Overides any

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snooper
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.3
 platform: ruby
 authors:
 - Will Speak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-27 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -28,16 +28,16 @@ dependencies:
   name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: ruby-terminfo
   requirement: !ruby/object:Gem::Requirement
@@ -78,11 +78,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/snooper/config.rb
-- lib/snooper/config.rb~
 - lib/snooper/hook.rb
-- lib/snooper/hook.rb~
 - lib/snooper/options.rb
-- lib/snooper/options.rb~
 - lib/snooper/snoop.rb
 - lib/snooper/version.rb
 - lib/snooper.rb

data/lib/snooper/config.rb~

@@ -1,88 +0,0 @@
-# -*- coding: utf-8 -*-
-# Author::    Will Speak  (@willspeak)
-# Copyright:: Copyright (c) 2013 Will Speak
-# License::   Snooper is open source! See LICENCE.md for more details.
-
-module Snooper
-
-  ##
-  # Public: Snooper Configuration
-  #
-  # This object contains the configuration information that is
-  class Config
-
-    ##
-    # Public: create a new config object
-    #
-    # base_path - The String representing the path from which all the other
-    #             paths should be resolved. Nil to use the current directory.
-    # command   - The command to execute when a change satisfies all the
-    #             predicates. 
-    # options   - The hash containing all of the optinal parameters.
-    #             :paths   - The Array of the paths to watch, relative to the
-    #                        base. Nil or empty to watch the whole directory.
-    #             :filters - THe Array of Regex-like inclusion filters. Nil or
-    #                        empty to trigger on all changes.
-    #             :ignored - The Array of Regex-like ignore filters. Nil or
-    #                        empty to ignore no changes.
-    #             :hooks   - The Array of Hook objects to call when a change
-    #                        satisifies all the predicates and before the
-    #                        command is run. Nil or empty for no hooks.
-  end
-
-=begin
-    ##
-    # Public: Load the config from disk
-    #
-    # path - The String containing the path of the config file
-    #
-    # Returns a new Config.
-    def self.new(path)
-
-      # Load the config file begin yamopts = YAML.load_file path
-      rescue Exception => e puts "Error loading the config: #{e}" exit
-      1 end if not yamopts.is_a? Hash puts "Invalid options file" exit
-      1 end
-      # default config
-      config = {
-        :base_path => '.',
-        :command => nil,
-        :filters => [],
-        :ignored => [],
-        :paths => [],
-        :hooks => []
-      }
-      
-      yamopts.each do |option, argument|
-        case option
-        when 'base_path', 'command'
-          config[option.to_sym] = argument.to_s
-
-        when 'paths', 'filters', 'ignored'
-          argument = argument.split if argument.is_a? String
-          config[option.to_sym] += Array(argument)
-
-        when 'hooks'
-          argument.each do |hook|
-            config[:hooks] << hook
-          end
-
-        else
-          puts "Ignoring unknown option #{option}".red
-        end
-      end
-      
-      [:filters, :ignored].each do |index|
-        config[index].map! { |r| Regexp.try_convert(r) || Regexp.new(r) }
-      end
-
-      if config[:base_path]
-        base = File.expand_path config[:base_path], File.dirname(path)
-        config[:paths].map! { |p| File.expand_path p, base }
-        config[:base_path] = base
-      end
-      
-      config
-    end
-=end
-end

data/lib/snooper/hook.rb~

@@ -1,17 +0,0 @@
-# -*- 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
-  
-  ##
-  # File Change Hook
-  #
-  # Hooks represent a command that is fired when a given file changes. 
-
-  class Hook
-    
-  end
-
-end

data/lib/snooper/options.rb~

@@ -1,71 +0,0 @@
-# -*- coding: utf-8 -*-
-# Author::    Will Speak  (@willspeak)
-# Copyright:: Copyright (c) 2013 Will Speak
-# License::   Snooper is open source! See LICENCE.md for more details.
-
-module Snooper
-
-  module Options
-    ##
-    # Public: Command Line Options
-    ParsedOptions = Struct.new :config_path, :command
-
-    ##
-    # Public: Parse the command line
-    #
-    # arguments - The list of string arguments to be parsed
-    #
-    # Returns an Options struct containing :base_path and :command
-    def parse(arguments)
-      
-      helptext = <<END
-
-Snooper 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.
-
-For more information see snooper(1).
-END
-
-      options = ParsedOptions.new
-      options.config_path = '.snooper.yaml'
-
-      parser = OptionParser.new do |parser|
-        parser.banner =
-          "Useage: #{File.basename __FILE__} [--config <CONFIG> | --help] " + 
-          "[<COMMAND>]*"
-
-        parser.separator helptext
-
-        parser.on '-c', '--config CONFIGFILE', 'YAML configuration file' do |path|
-          config_path = path
-        end
-
-        parser.on("--version", "show version information") do
-          puts "Snooper v#{Snooper::VERSION}"
-          exit
-        end
-        
-        parser.on("-h", "--help", "Show this message") do
-          puts parser
-          exit
-        end
-      end
-
-      # Parse the arguments
-      begin
-        parser.parse! arguments
-      rescue OptionParser::InvalidOption, \
-        OptionParser::MissingArgument, \
-        OptionParser::InvalidArgument => e
-        puts e
-        puts parser
-        exit 1
-      end
-
-      options.command = arguments.join " " if not arguments.empty?
-      options
-    end
-  end
-end