guard-helpers 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzQwNWRjMGNlMGQ4Mjk1MDVkYjY1ZmNhMDcwNTg0MzZhNDE3NDEwZg==
+    ODVhMmIyOThjMDE5MGY0ZWVlMDNiMjhiMmE0NDE4OTBlMWQyYmU1Zg==
   data.tar.gz: !binary |-
-    YzI2ZGE4NmMyZTA5YmE2Mzk2NTcwMzkzNTk3YTIxMDQ1MDc3MjQ1Nw==
+    YmY3N2MxYWM3N2E3OGY0ZmI4MWQ0YmQyZDE0NWZlOTkyMzRkMjU1Yw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZDFiODU3MWQ1MmRjZWM5OWVlMTAyNDRkYzg2NmQzYTc4MTg1OGQ3MjI1NmNk
-    MmRmZjc5ZmNkNmFjYWMyYWFiMWNlMjJiYTA2ODkxMmMyZGZlZjRkM2E5YTcy
-    MWI0YzJhZDRlYTI3NTM0OGY5YTVmYjMyZWJhMWZjZWU0Y2NmMWM=
+    NzhiODg0YTBlZjUxY2Y2MjQ0MTBhNTc5ZjlmMzNhMTE2NTgxZmQ3MjdmYjA4
+    NDE4YTkxMGJkMjMyNzU4ODQzYmJkZmUzZjA1MDMzNDlhOWQ0NWM2MGI0ODBi
+    ZWRhMTY1Y2IwMThhMmE0OGE4ZmVjZDViMDUzYmY3ZDEyMTQxYWU=
   data.tar.gz: !binary |-
-    ZDJlYjI5MzkwNzk2OWYxMTc1MjE3MGZlNmVmYmVmYTdmMTgwNTNmYzAyZGEx
-    NzljNzVjNWM1M2I4ZmFhZTY4NTNjMmUzMmM5MjM2ODE5MmE2OGUyYWViMGJj
-    ZmE1MjU1MDg3YWFjMWU2Y2Y5ZTVhZmU4YTA0N2E0MGE2NWNmNjE=
+    ZDlkZDgyM2I5OWUwNjgyMDMwN2MwNDAzOTZiMGI4MGU1YzVmMDVkYWY5OGU2
+    OWIxNWVmYTBlNjdhOWYzNmRhM2RjNzFiYTMzMTVlZWY2MWIwYzc5ODk5NDJk
+    MmQyYTBkNThiMmFiYWQ5MzhkYzA1MTFmZWM2ODQzZmY2NmFiMmM=

data/lib/guard/helpers/formatter.rb

@@ -1,91 +1,96 @@
+require 'guard'
 require 'guard/guard'
+module ::Guard
+  module Helpers
+    module Formatter
+      class << self
+        # Copyright (c) 2010-2012 Michael Kessler
+        # 
+        # Permission is hereby granted, free of charge, to any person obtaining
+        # a copy of this software and associated documentation files (the
+        # "Software"), to deal in the Software without restriction, including
+        # without limitation the rights to use, copy, modify, merge, publish,
+        # distribute, sublicense, and/or sell copies of the Software, and to
+        # permit persons to whom the Software is furnished to do so, subject to
+        # the following conditions:
+        # 
+        # The above copyright notice and this permission notice shall be
+        # included in all copies or substantial portions of the Software.
+        # 
+        # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+        # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+        # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+        # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+        # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+        # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+        # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        # Collects console and system notification methods and enhances them with
+        # some color information.
 
-# Copyright (c) 2010-2012 Michael Kessler
-# 
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-# 
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-# Collects console and system notification methods and enhances them with
-# some color information.
-module ::Guard::Helpers::Formatter class << self
+        # Print an info message to the console.
+        #
+        # @param [String] message the message to print
+        # @param [Hash] options the output options
+        # @option options [Boolean] :reset reset the UI
+        #
+        def info(message, options = { })
+          ::Guard::UI.info(message, options)
+        end
 
-  # Print an info message to the console.
-  #
-  # @param [String] message the message to print
-  # @param [Hash] options the output options
-  # @option options [Boolean] :reset reset the UI
-  #
-  def info(message, options = { })
-    ::Guard::UI.info(message, options)
-  end
+        # Print a debug message to the console.
+        #
+        # @param [String] message the message to print
+        # @param [Hash] options the output options
+        # @option options [Boolean] :reset reset the UI
+        #
+        def debug(message, options = { })
+          ::Guard::UI.debug(message, options)
+        end
 
-  # Print a debug message to the console.
-  #
-  # @param [String] message the message to print
-  # @param [Hash] options the output options
-  # @option options [Boolean] :reset reset the UI
-  #
-  def debug(message, options = { })
-    ::Guard::UI.debug(message, options)
-  end
+        # Print a red error message to the console.
+        #
+        # @param [String] message the message to print
+        # @param [Hash] options the output options
+        # @option options [Boolean] :reset reset the UI
+        #
+        def error(message, options = { })
+          ::Guard::UI.error(color(message, ';31'), options)
+        end
 
-  # Print a red error message to the console.
-  #
-  # @param [String] message the message to print
-  # @param [Hash] options the output options
-  # @option options [Boolean] :reset reset the UI
-  #
-  def error(message, options = { })
-    ::Guard::UI.error(color(message, ';31'), options)
-  end
+        # Print a green success message to the console.
+        #
+        # @param [String] message the message to print
+        # @param [Hash] options the output options
+        # @option options [Boolean] :reset reset the UI
+        #
+        def success(message, options = { })
+          stamped_message = "#{Time.now.strftime('%r')} #{message}"
+          ::Guard::UI.info(color(stamped_message, ';32'), options)
+        end
 
-  # Print a green success message to the console.
-  #
-  # @param [String] message the message to print
-  # @param [Hash] options the output options
-  # @option options [Boolean] :reset reset the UI
-  #
-  def success(message, options = { })
-    stamped_message = "#{Time.now.strftime('%r')} #{message}"
-    ::Guard::UI.info(color(stamped_message, ';32'), options)
-  end
+        # Outputs a system notification.
+        #
+        # @param [String] message the message to print
+        # @param [Hash] options the output options
+        # @option options [Symbol, String] :image the image to use, either :failed, :pending or :success, or an image path
+        # @option options [String] :title the title of the system notification
+        #
+        def notify(message, options = { })
+          ::Guard::Notifier.notify(message, options)
+        end
 
-  # Outputs a system notification.
-  #
-  # @param [String] message the message to print
-  # @param [Hash] options the output options
-  # @option options [Symbol, String] :image the image to use, either :failed, :pending or :success, or an image path
-  # @option options [String] :title the title of the system notification
-  #
-  def notify(message, options = { })
-    ::Guard::Notifier.notify(message, options)
-  end
+        private
 
-  private
+        # Print a info message to the console.
+        #
+        # @param [String] text the text to colorize
+        # @param [String] color_code the color code
+        #
+        def color(text, color_code)
+          ::Guard::UI.send(:color_enabled?) ? "\e[0#{ color_code }m#{ text }\e[0m" : text
+        end
 
-  # Print a info message to the console.
-  #
-  # @param [String] text the text to colorize
-  # @param [String] color_code the color code
-  #
-  def color(text, color_code)
-    ::Guard::UI.send(:color_enabled?) ? "\e[0#{ color_code }m#{ text }\e[0m" : text
+      end
+    end
   end
-
 end
-  end

data/lib/guard/helpers/starter.rb

@@ -1,133 +1,144 @@
+require 'guard/guard'
+require 'guard/helpers/formatter'
 # Starter code that can be included into a Guard plugin
-module ::Guard::Helpers::Starter
-
-  ## Helper methods
-
-  # Copyright (c) 2010-2012 Michael Kessler
-  # 
-  # Permission is hereby granted, free of charge, to any person obtaining
-  # a copy of this software and associated documentation files (the
-  # "Software"), to deal in the Software without restriction, including
-  # without limitation the rights to use, copy, modify, merge, publish,
-  # distribute, sublicense, and/or sell copies of the Software, and to
-  # permit persons to whom the Software is furnished to do so, subject to
-  # the following conditions:
-  # 
-  # The above copyright notice and this permission notice shall be
-  # included in all copies or substantial portions of the Software.
-  # Detects the output directory for each CoffeeScript file. Builds
-  # the product of all watchers and assigns to each directory
-  # the files to which it belongs to.
-  #
-  # @param [Array<Guard::Watcher>] watchers the Guard watchers in the block
-  # @param [Array<String>] files the CoffeeScript files
-  # @param [Hash] options the options for the execution
-  # @option options [String] :output the output directory
-  # @option options [Boolean] :shallow do not create nested directories
-  #
-  def detect_nested_directories(watchers, files, options)
-    return { options[:output] => files } if options[:shallow]
-
-    directories = { }
-
-    watchers.product(files).each do |watcher, file|
-      if matches = file.match(watcher.pattern)
-        target = matches[1] ? File.join(options[:output], File.dirname(matches[1])).gsub(/\/\.$/, '') : options[:output] || File.dirname(file)
-        if directories[target]
-          directories[target] << file
-        else
-          directories[target] = [file]
+module ::Guard
+  module Helpers
+    module Starter
+
+      ## Helper methods
+
+      # Copyright (c) 2010-2012 Michael Kessler
+      # 
+      # Permission is hereby granted, free of charge, to any person obtaining
+      # a copy of this software and associated documentation files (the
+      # "Software"), to deal in the Software without restriction, including
+      # without limitation the rights to use, copy, modify, merge, publish,
+      # distribute, sublicense, and/or sell copies of the Software, and to
+      # permit persons to whom the Software is furnished to do so, subject to
+      # the following conditions:
+      # 
+      # The above copyright notice and this permission notice shall be
+      # included in all copies or substantial portions of the Software.
+      # Detects the output directory for each CoffeeScript file. Builds
+      # the product of all watchers and assigns to each directory
+      # the files to which it belongs to.
+      #
+      # @param [Array<Guard::Watcher>] watchers the Guard watchers in the block
+      # @param [Array<String>] files the CoffeeScript files
+      # @param [Hash] options the options for the execution
+      # @option options [String] :output the output directory
+      # @option options [Boolean] :shallow do not create nested directories
+      #
+      def detect_nested_directories(watchers, files, options)
+        return { options[:output] => files } if options[:shallow]
+
+        directories = { }
+
+        watchers.product(files).each do |watcher, file|
+          if matches = file.match(watcher.pattern)
+            target = matches[1] ? File.join(options[:output], File.dirname(matches[1])).gsub(/\/\.$/, '') : options[:output] || File.dirname(file)
+            if directories[target]
+              directories[target] << file
+            else
+              directories[target] = [file]
+            end
+          end
         end
-      end
-    end
 
-    directories
-  end
-  # End of copyrighted code
+        directories
+      end
+      # End of copyrighted code
 
-  # The filename of the target file
-  def target_filename(directory, file)
-    File.join(directory, File.basename(file))
-  end
+      # The filename of the target file
+      def target_filename(directory, file)
+        File.join(directory, File.basename(file))
+      end
 
-  # The action to be performed on a file (e.g., compilation)
-  def act_on(directory, file)
-    raise NotImplementedError.new('act_on not implemented')
-  end
+      # The action to be performed on a file (e.g., compilation)
+      def act_on(directory, file)
+        raise NotImplementedError.new('act_on not implemented')
+      end
 
-  # Informs the user of an error
-  def error(message, path)
-    message = "#{self.class.name} ERROR: #{path} with error '#{message}'"
-    Formatter.error message
-    Formatter.notify message, :image => :failed
-  end
+      # Informs the user of an error
+      def error(message, path)
+        message = "#{self.class.name} ERROR: #{path} with error '#{message}'"
+        ::Guard::Helpers::Formatter.error message
+        ::Guard::Helpers::Formatter.notify message, :image => :failed
+      end
 
-  # Informs the user that an action has succeeded.
-  def notify(path, action="COMPILED")
-    message = if paths.length <= 8
-                "#{self.class.name} #{action}: #{paths.join(', ')}" 
-              else 
-                "#{self.class.name} #{action}: #{paths[0..7].join(', ')}, and others." 
-              end
-    Formatter.success message
-    Formatter.notify message, :image => :success
-  end
+      # Informs the user that an action has succeeded.
+      def notify(paths, action="COMPILED")
+        message = if paths.length <= 8
+                    "#{self.class.name} #{action}: #{paths.join(', ')}" 
+                  else 
+                    "#{self.class.name} #{action}: #{paths[0..7].join(', ')}, and others." 
+                  end
+        ::Guard::Helpers::Formatter.success message
+        ::Guard::Helpers::Formatter.notify message, :image => :success
+      end
 
 
-  ## Defaults
-  # Calls #run_all if the :all_on_start option is present.
-  def start
-    run_all if options[:all_on_start]
-  end
+      ## Defaults
+      # Calls #run_all if the :all_on_start option is present.
+      def start
+        run_all if options[:all_on_start]
+      end
 
-  # Call #run_on_change for all files which match this guard.
-  def run_all
-    run_on_changes(Watcher.match_files(self, Dir.glob('**{,/*/**}/*').uniq.compact))
-  end
+      # Call #run_on_change for all files which match this guard.
+      def run_all
+        run_on_changes(Watcher.match_files(self, Dir.glob('**{,/*/**}/*').uniq.compact))
+      end
 
-  # The default action when a path is removed is to remove the matching
-  # compiled file
-  def run_on_removals(paths)
-    paths = paths.select {|path| not options[:exclude] =~ path and File.file? path}
-
-    directories = detect_nested_directories(watchers, paths, options)
-    removed = []
-
-    directories.each do |directory, files|
-      files.each do |file|
-        begin
-          File.delete file
-          removed << file
-        rescue Error::ENOENT
-          # Ignore
+      # The default action when a path is removed is to remove the matching
+      # compiled file
+      def run_on_removals(paths)
+        paths = paths.select {|path| not options[:exclude] =~ path and File.file? path}
+
+        directories = detect_nested_directories(watchers, paths, options)
+        removed = []
+
+        directories.each do |directory, files|
+          files.each do |file|
+            begin
+              File.delete file
+              removed << file
+            rescue Error::ENOENT
+              # Ignore
+            end
+          end
+        end
+        if removed.length > 0
+          notify(removed, "REMOVED")
         end
       end
-    end
-    if removed.length > 0
-      notify(removed, "REMOVED")
-    end
-  end
-  
-  # Run `act_on` on each file that is watched
-  def run_on_changes(paths)
-    paths = paths.select {|path| not options[:exclude] =~ path and File.file? path}
-
-    directories = detect_nested_directories(watchers, paths, options)
-    written = []
-
-    directories.each do |directory, files|
-      files.each do |file|
-        begin
-          act_on(directory, file)
-          written << file
-        rescue Exception => e
-          error(e.message, file)
-          throw :task_has_failed
+
+      # Run `act_on` on each file that is watched
+      def run_on_changes(paths)
+        if options[:all_on_change]
+          paths = Watcher.match_files(self, Dir.glob('**{,/*/**}/*').uniq.compact)
+        end
+        paths = paths.select {|path| not options[:exclude] =~ path and File.file? path}
+
+        directories = detect_nested_directories(watchers, paths, options)
+        written = []
+
+        directories.each do |directory, files|
+          files.each do |file|
+            begin
+              act_on(directory, file)
+              puts 'Wrote!'
+              written << file
+            rescue Exception => e
+              puts 'Error!'
+              error(e.message, file)
+              throw :task_has_failed
+            end
+          end
+        end
+        if written.length > 0
+          notify(written)
         end
       end
     end
-    if written.length > 0
-      notify(written)
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-helpers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tim Joseph dumol