guard-helpers 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzQwNWRjMGNlMGQ4Mjk1MDVkYjY1ZmNhMDcwNTg0MzZhNDE3NDEwZg==
+  data.tar.gz: !binary |-
+    YzI2ZGE4NmMyZTA5YmE2Mzk2NTcwMzkzNTk3YTIxMDQ1MDc3MjQ1Nw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZDFiODU3MWQ1MmRjZWM5OWVlMTAyNDRkYzg2NmQzYTc4MTg1OGQ3MjI1NmNk
+    MmRmZjc5ZmNkNmFjYWMyYWFiMWNlMjJiYTA2ODkxMmMyZGZlZjRkM2E5YTcy
+    MWI0YzJhZDRlYTI3NTM0OGY5YTVmYjMyZWJhMWZjZWU0Y2NmMWM=
+  data.tar.gz: !binary |-
+    ZDJlYjI5MzkwNzk2OWYxMTc1MjE3MGZlNmVmYmVmYTdmMTgwNTNmYzAyZGEx
+    NzljNzVjNWM1M2I4ZmFhZTY4NTNjMmUzMmM5MjM2ODE5MmE2OGUyYWViMGJj
+    ZmE1MjU1MDg3YWFjMWU2Y2Y5ZTVhZmU4YTA0N2E0MGE2NWNmNjE=

data/lib/guard/helpers/formatter.rb

@@ -0,0 +1,91 @@
+require 'guard/guard'
+
+# 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 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 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
+
+  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
+
+end
+  end

data/lib/guard/helpers/starter.rb

@@ -0,0 +1,133 @@
+# 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]
+        end
+      end
+    end
+
+    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 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 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
+
+
+  ## 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
+
+  # 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
+  
+  # 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
+        end
+      end
+    end
+    if written.length > 0
+      notify(written)
+    end
+  end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: guard-helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tim Joseph dumol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies: []
+description: ! 'Helper modules to make making Guard plugins easier '
+email: tim@timdumol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/guard/helpers/formatter.rb
+- lib/guard/helpers/starter.rb
+homepage: https://github.com/TimDumol/guard-helpers
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Helper modules to make making Guard plugins easier
+test_files: []