snooper 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eeb6e88677b5b8c687e3f8df1133cbc346722bc5
-  data.tar.gz: 06f5c6b9199cc7d690301bd7fb9131df0b0207fe
+  metadata.gz: 634956e753d4252eb400d1e90476e5dba0dfb71b
+  data.tar.gz: 48822ec94381e1dde8c9a576aaf3467b1c4192fd
 SHA512:
-  metadata.gz: ee2d98a6072efa25bf9cc876f678dcaa26a3cdf38b67b1de0214817ed30d426aa343438acfd29ddb9846efaaff3fcf28466d2a82d35fc08dc3d061fe0136ac40
-  data.tar.gz: c91bc76ccaaf03cdaf5f3a05e8792781c7a0829b49b46d301f5edcdc49d8035348466e26dde5acb608ac0a159bc3df34ed995e41e62dfc9d4e340015f6bbcae8
+  metadata.gz: 6ffcae7b1adb30d9d1a0e3d85ded93dc9b0e67afd7234e1fa52df6c61df60dcc0a80066598aadc3f47e8e81d734fd2342b2f559cc751ef7d071eca2a2ac9e74e
+  data.tar.gz: 294184c9327a8084d66001631931c54db89ce1211ad2d53847e93b3a31fd1315751c184d3a6735a4750c58f287a386e383368be8dae65923db1573010a4ef6b1

data/bin/snooper

@@ -51,6 +51,11 @@ END
     opts.on '-c', '--config CONFIGFILE', 'YAML configuration file' do |path|
       config_path = path
     end
+
+    opts.on("--version", "show version information") do
+      puts "Snooper v#{Snooper::VERSION}"
+      exit
+    end
     
     opts.on("-h", "--help", "Show this message") do
       puts opts
@@ -88,7 +93,8 @@ END
     :command => nil,
     :filters => [],
     :ignored => [],
-    :paths => []
+    :paths => [],
+    :hooks => []
   }
   
   yamopts.each do |option, argument|
@@ -100,6 +106,11 @@ END
       argument = argument.split if argument.is_a? String
       options[option.to_sym] += Array(argument)
 
+    when 'hooks'
+      argument.each do |hook|
+        options[:hooks] << hook
+      end
+
     else
       puts "Ignoring unknown option #{option}".red
     end

data/lib/snooper.rb

@@ -14,6 +14,7 @@
 module Snooper
   
   require 'snooper/snoop'
+  require 'snooper/version'
 
   ##
   # Watch for changes in a directory

data/lib/snooper/hook.rb

@@ -0,0 +1,62 @@
+# -*- 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
+
+    ##
+    # Public : Create a new Hook
+    #
+    # pattern - The String or Regex to match
+    # command - The String containig the command to be run
+    #
+    # Returns a new Hook
+    def initialize(pattern, command)
+      raise ArgumentError, "invalid pattern" if pattern == nil
+      raise ArgumentError, "invalid command" if command == nil
+      @command = command
+      @pattern = to_regex pattern
+    end
+
+    ##
+    # Public : Fire the hook
+    #
+    # Returns the exit code of the command
+    def fire
+      system @command
+    end
+
+    ##
+    # Public : Run the Hook
+    #
+    # path - The String to match agains the hook
+    #
+    # Returns the exit code of the command or nil if the path doesn't match
+    def run(path)
+      path = Array(path)
+      path.each do |p|
+        return fire if @pattern.match p
+      end
+      nil
+    end
+
+    ##
+    # Private : Convert a string, regex, or regex-linke to Regexp
+    #
+    # regex - The String or Regexp to convert
+    #
+    # Returns a Regexp
+    def to_regex(regex)
+      Regexp.try_convert(regex) || Regexp.new(regex)
+    end
+
+    private :to_regex
+  end
+end

data/lib/snooper/hook.rb~

@@ -0,0 +1,17 @@
+# -*- 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/snoop.rb

@@ -3,6 +3,8 @@
 # Copyright:: Copyright (c) 2013 Will Speak
 # License::   Snoop is open source! See LICENCE.md for more details.
 
+require 'snooper/hook'
+
 module Snooper
   
   ##
@@ -26,7 +28,7 @@ module Snooper
     # [+:command+] [String] The command to run when changes are detected
     
     def initialize(path, args = {})
-      to_regex = Proc.new { |r| Regexp.new r if not r.is_a?(Regexp) }
+      to_regex = Proc.new { |r| Regexp.try_convert(r) || Regexp.new(r) }
       
       @paths = Array(path)
       @filters = args[:filters]
@@ -34,6 +36,20 @@ module Snooper
       @ignored = args[:ignored]
       @ignored = Array(@ignored).map(&to_regex) if @ignored
       @command = args[:command]
+      @hooks = create_hooks(args[:hooks])
+    end
+
+    ##
+    # 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
+    def create_hooks(raw_hooks)
+      raw_hooks.to_a.map do |hook|
+        Hook.new hook["pattern"], hook["command"]
+      end
     end
     
     ##
@@ -57,7 +73,7 @@ module Snooper
     
     def on_change(modified, added, removed)
       begin
-        # Puase the listener to make sure any build output doesn't mess with things
+        # Puase the listener to avoid spurious triggers from build output
         @listener.pause if @listener
       
         # summarise the changes made
@@ -68,12 +84,16 @@ module Snooper
         statusline << ('+' * added.length).green
         puts "#{statusline} #{changes.length.to_s.magenta.bold} changes"
         
+        @hooks.each do |hook|
+          hook.run changes
+        end
+
         # run the test suite and check the result
         res, time = time_command @command
         if res then
-          puts statusbar "✓ All tests passed (#{time}s)", &:white_on_green
+          puts statusbar "✓ All tests passed", time, &:white_on_green
         else
-          puts statusbar "✗ Tests failed (#{time}s)", &:white_on_red
+          puts statusbar "✗ Tests failed", time, &:white_on_red
         end
         
         # return to listening
@@ -93,7 +113,8 @@ module Snooper
     #
     # @param message - the message to print
     
-    def statusbar(message)
+    def statusbar(message, time=nil)
+      message << " (#{time.round(3)}s)" if time
       message = message.to_s.center TermInfo.screen_width - 1
       block_given? ? yield(message) : message
     end

data/lib/snooper/version.rb

@@ -6,5 +6,5 @@ module Snooper
   # This should conform to SemVer. If this is changed it should be the only
   # thing that changes in the comit.
   
-  VERSION = '0.1.3'
+  VERSION = '1.0.0'
 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" "June 2013" "" ""
+.TH "SNOOPER\-CONFIG" "7" "July 2013" "" ""
 .
 .SH "NAME"
 \fBsnooper\-config\fR \- Configure for Espionage
@@ -37,6 +37,26 @@ Specifies a list of regular expressions \fIfilters\fR to use to filter the chang
 .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
+Hooks
+.
+.P
+Hooks are useful to pefrom special commads upon a subset of the file\-change events\. Each hook is run a single time if any of the filepaths that satisfy \fBfilters:\fR and \fBignored:\fR aslo match the \fBpattern:\fR of the filter\.
+.
+.IP "\(bu" 4
+\fBhooks:\fR \fIhook_list\fR Specifies a list of hooks, where each hook represents a task that should be carried out upon a subset of the triggering events\. The hooks key should contain a list of mappings\. Each mappign should have the two following keys:
+.
+.IP "\(bu" 4
+\fBpattern:\fR \fIregexp\fR The pattern to run the hook on\. This should be of the same format as \fBfilters:\fR and \fBignored:\fR\. Note that hooks can only match a subset of all file changes as controlled by \fBfilters:\fR and \fBignored:\fR\.
+.
+.IP "\(bu" 4
+\fBcommand:\fR \fIcommand_string\fR A command to be run when the hook is triggered\. This is of the same format as the global \fBcommand:\fR key\.
+.
+.IP "" 0
+
+.
+.IP "" 0
+.
 .SH "SEE ALSO"
 snooper(1)
 .

data/man/snooper-config.7.html

@@ -126,6 +126,31 @@ testing.</p>
 </dl>
 
 
+<p>Hooks</p>
+
+<p>Hooks are useful to pefrom special commads upon a subset of the file-change
+events. Each hook is run a single time if any of the filepaths that satisfy
+<code>filters:</code> and <code>ignored:</code> aslo match the <code>pattern:</code> of the filter.</p>
+
+<ul>
+<li><p><code>hooks:</code> <var>hook_list</var>
+ Specifies a list of hooks, where each hook represents a task that should
+ be carried out upon a subset of the triggering events. The hooks key should
+ contain a list of mappings. Each mappign should have the two following keys:</p>
+
+<ul>
+<li><p><code>pattern:</code> <var>regexp</var>
+The pattern to run the hook on. This should be of the same format as
+<code>filters:</code> and <code>ignored:</code>. Note that hooks can only match a subset of all
+file changes as controlled by <code>filters:</code> and <code>ignored:</code>.</p></li>
+<li><p><code>command:</code> <var>command_string</var>
+A command to be run when the hook is triggered. This is of the same format
+as the global <code>command:</code> key.</p></li>
+</ul>
+</li>
+</ul>
+
+
 <h2 id="SEE-ALSO">SEE ALSO</h2>
 
 <p><a class="man-ref" href="snooper.1.html">snooper<span class="s">(1)</span></a></p>
@@ -137,7 +162,7 @@ testing.</p>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>June 2013</li>
+    <li class='tc'>July 2013</li>
     <li class='tr'>snooper-config(7)</li>
   </ol>
 

data/man/snooper-config.7.ronn

@@ -7,7 +7,7 @@ Configuration of `snooper` is controlled through a YAML file.
 
 ## FORMAT
 
-snooper(1) expects a YAML document of key-value pairs; each pair specifies an 
+snooper(1) 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.
 
@@ -25,8 +25,8 @@ String options
 String Array options
 
  * `paths:` <directories>:
-   Specifies a list of <directories> to watch. Directories can be either 
-   relative or absolute paths. If no paths are specified the default is to 
+   Specifies a list of <directories> to watch. Directories can be either
+   relative or absolute paths. If no paths are specified the default is to
    watch `base_path`.
 
  * `filters:` <filters>, `ignored:` <filters>:
@@ -38,6 +38,26 @@ String Array options
    _Note_: as these are regular expressions `\.c` will match both
    `foo.c` and `bar.cfg`, `\.c$` will only match `.c` files.
 
+Hooks
+
+Hooks are useful to pefrom special commads upon a subset of the file-change
+events. Each hook is run a single time if any of the filepaths that satisfy
+`filters:` and `ignored:` aslo match the `pattern:` of the filter.
+   
+ * `hooks:` <hook_list>
+    Specifies a list of hooks, where each hook represents a task that should
+    be carried out upon a subset of the triggering events. The hooks key should
+    contain a list of mappings. Each mappign should have the two following keys:
+
+    * `pattern:` <regexp>
+      The pattern to run the hook on. This should be of the same format as
+      `filters:` and `ignored:`. Note that hooks can only match a subset of all
+      file changes as controlled by `filters:` and `ignored:`.
+
+    * `command:` <command_string>
+      A command to be run when the hook is triggered. This is of the same format
+      as the global `command:` key.
+
 ## SEE ALSO
 
 snooper(1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snooper
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Will Speak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2013-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -80,6 +80,8 @@ extra_rdoc_files:
 - LICENCE.md
 - README.md
 files:
+- lib/snooper/hook.rb
+- lib/snooper/hook.rb~
 - lib/snooper/snoop.rb
 - lib/snooper/version.rb
 - lib/snooper.rb