guard-coffeescript 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4efe9a6c2d20f53277808c0ecac3363fd384c296
-  data.tar.gz: b77baf675bad3beae577351f9c6c3af593dd83f3
+  metadata.gz: 887d4228743c3c6c58f84dc764a8405e970d27be
+  data.tar.gz: 8d2b16ee663c98be7a22c730909bec4a5c9fd384
 SHA512:
-  metadata.gz: 6f8a4f2e07387e25247dd3c6a8e590c865d40a9538b5e734a04eeeca1673278dd2dd1b1ce6d939e8336af61268d530751ddde2b4c94048a04a6371a4b80e5b39
-  data.tar.gz: fc1704c85997a7eccb89ece38c5e1dde02e21b2d759a507a7c4ff748e4fdcb0cd9d271e239aae21e7960d681991cca7ddc97d2f9f20629c44c123b5e7ba6fbb1
+  metadata.gz: f2fec52e08b973acfa91184d7e471fa86bf39a16b7c3ada117fa3f0514a8ae15800ead30c80faaf6e0458685ce829e24ddd677e4f70a4f72809b284773d94e38
+  data.tar.gz: 3c541bcb267c644d37aa5b9690fdc3110422fa13e40e3313066608259d10b91ea39e6f868c876e0618b20031ac95391f6523a49de71e896a50dba1022ed3ea33

data/lib/guard/coffeescript.rb

@@ -1,34 +1,31 @@
-require 'guard'
-require 'guard/guard'
-require 'guard/watcher'
+require 'guard/compat/plugin'
 
 module Guard
-
   # The CoffeeScript guard that gets notifications about the following
   # Guard events: `start`, `stop`, `reload`, `run_all` and `run_on_change`.
   #
-  class CoffeeScript < Guard
-
-    autoload :Formatter, 'guard/coffeescript/formatter'
-    autoload :Inspector, 'guard/coffeescript/inspector'
-    autoload :Runner, 'guard/coffeescript/runner'
+  class CoffeeScript < Plugin
+    require 'guard/coffeescript/formatter'
+    require 'guard/coffeescript/inspector'
+    require 'guard/coffeescript/runner'
 
     DEFAULT_OPTIONS = {
-        :bare         => false,
-        :shallow      => false,
-        :hide_success => false,
-        :noop         => false,
-        :error_to_js  => false,
-        :all_on_start => false,
-        :source_map   => false
+      bare: false,
+      shallow: false,
+      hide_success: false,
+      noop: false,
+      error_to_js: false,
+      all_on_start: false,
+      source_map: false
     }
 
     # Initialize Guard::CoffeeScript.
     #
-    # @param [Array<Guard::Watcher>] watchers the watchers in the Guard block
+
     # @param [Hash] options the options for the Guard
     # @option options [String] :input the input directory
     # @option options [String] :output the output directory
+    # @option options [Array<Guard::Watcher>] :watchers the watchers in the Guard block
     # @option options [Boolean] :bare do not wrap the output in a top level function
     # @option options [Boolean] :shallow do not create nested directories
     # @option options [Boolean] :hide_success hide success message notification
@@ -36,16 +33,23 @@ module Guard
     # @option options [Boolean] :noop do not generate an output file
     # @option options [Boolean] :source_map generate the source map files
     #
-    def initialize(watchers = [], options = {})
-      watchers = [] if !watchers
+
+    attr_reader :patterns
+
+    def initialize(options = {})
       defaults = DEFAULT_OPTIONS.clone
 
-      if options[:input]
-        defaults.merge!({ :output => options[:input] })
-        watchers << ::Guard::Watcher.new(%r{^#{ options[:input] }/(.+\.(?:coffee|coffee\.md|litcoffee))$})
-      end
+      @patterns = options.dup.delete(:patterns) || []
 
-      super(watchers, defaults.merge(options))
+      msg = 'Invalid :patterns argument. Expected: Array, got %s'
+      fail ArgumentError, format(msg, @patterns.inspect) unless @patterns.is_a?(Array)
+
+      msg = ':input option not provided (see current template Guardfile)'
+      fail msg unless options[:input]
+
+      options[:output] = options[:input] unless options[:output]
+
+      super(defaults.merge(options))
     end
 
     # Gets called once when Guard starts.
@@ -61,7 +65,14 @@ module Guard
     # @raise [:task_has_failed] when stop has failed
     #
     def run_all
-      run_on_modifications(Watcher.match_files(self, Dir.glob('**{,/*/**}/*.{coffee,coffee.md,litcoffee}')))
+      found = Dir.glob('**{,/*/**}/*.{coffee,coffee.md,litcoffee}')
+      found.select! do |file|
+        @patterns.any? do |pattern|
+          pattern.match(file)
+        end
+      end
+
+      run_on_modifications(found)
     end
 
     # Gets called when watched paths and files have changes.
@@ -70,7 +81,7 @@ module Guard
     # @raise [:task_has_failed] when stop has failed
     #
     def run_on_modifications(paths)
-      changed_files, success = Runner.run(Inspector.clean(paths), watchers, options)
+      _changed_files, success = Runner.run(Inspector.clean(paths), @patterns, options)
 
       throw :task_has_failed unless success
     end
@@ -81,8 +92,7 @@ module Guard
     # @raise [:task_has_failed] when run_on_change has failed
     #
     def run_on_removals(paths)
-      Runner.remove(Inspector.clean(paths, :missing_ok => true), watchers, options)
+      Runner.remove(Inspector.clean(paths, missing_ok: true), @patterns, options)
     end
-
   end
 end

data/lib/guard/coffeescript.rb.orig

@@ -0,0 +1,88 @@
+require 'guard'
+require 'guard/guard'
+require 'guard/watcher'
+
+module Guard
+
+  # The CoffeeScript guard that gets notifications about the following
+  # Guard events: `start`, `stop`, `reload`, `run_all` and `run_on_change`.
+  #
+  class CoffeeScript < Guard
+
+    autoload :Formatter, 'guard/coffeescript/formatter'
+    autoload :Inspector, 'guard/coffeescript/inspector'
+    autoload :Runner, 'guard/coffeescript/runner'
+
+    DEFAULT_OPTIONS = {
+        :bare         => false,
+        :shallow      => false,
+        :hide_success => false,
+        :noop         => false,
+        :error_to_js  => false,
+        :all_on_start => false,
+        :source_map   => false
+    }
+
+    # Initialize Guard::CoffeeScript.
+    #
+    # @param [Array<Guard::Watcher>] watchers the watchers in the Guard block
+    # @param [Hash] options the options for the Guard
+    # @option options [String] :input the input directory
+    # @option options [String] :output the output directory
+    # @option options [Boolean] :bare do not wrap the output in a top level function
+    # @option options [Boolean] :shallow do not create nested directories
+    # @option options [Boolean] :hide_success hide success message notification
+    # @option options [Boolean] :all_on_start generate all JavaScripts files on start
+    # @option options [Boolean] :noop do not generate an output file
+    # @option options [Boolean] :source_map generate the source map files
+    #
+    def initialize(watchers = [], options = {})
+      watchers = [] if !watchers
+      defaults = DEFAULT_OPTIONS.clone
+
+      if options[:input]
+        defaults.merge!({ :output => options[:input] })
+        watchers << ::Guard::Watcher.new(%r{^#{ options[:input] }/(.+\.(?:coffee|coffee\.md|litcoffee))$})
+      end
+
+      super(watchers, defaults.merge(options))
+    end
+
+    # Gets called once when Guard starts.
+    #
+    # @raise [:task_has_failed] when stop has failed
+    #
+    def start
+      run_all if options[:all_on_start]
+    end
+
+    # Gets called when all files should be regenerated.
+    #
+    # @raise [:task_has_failed] when stop has failed
+    #
+    def run_all
+      run_on_modifications(Watcher.match_files(self, Dir.glob('**{,/*/**}/*.{coffee,coffee.md,litcoffee}')))
+    end
+
+    # Gets called when watched paths and files have changes.
+    #
+    # @param [Array<String>] paths the changed paths and files
+    # @raise [:task_has_failed] when stop has failed
+    #
+    def run_on_modifications(paths)
+      changed_files, success = Runner.run(Inspector.clean(paths), watchers, options)
+
+      throw :task_has_failed unless success
+    end
+
+    # Called on file(s) deletions that the Guard watches.
+    #
+    # @param [Array<String>] paths the deleted files or paths
+    # @raise [:task_has_failed] when run_on_change has failed
+    #
+    def run_on_removals(paths)
+      Runner.remove(Inspector.clean(paths, :missing_ok => true), watchers, options)
+    end
+
+  end
+end

data/lib/guard/coffeescript/formatter.rb

@@ -1,21 +1,19 @@
 module Guard
   class CoffeeScript
-
     # The Guard::CoffeeScript formatter collects console and
     # system notification methods and enhances them with
     # some color information.
     #
     module 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)
+        def info(message, options = {})
+          Compat::UI.info(message, options)
         end
 
         # Print a debug message to the console.
@@ -24,8 +22,8 @@ module Guard
         # @param [Hash] options the output options
         # @option options [Boolean] :reset reset the UI
         #
-        def debug(message, options = { })
-          ::Guard::UI.debug(message, options)
+        def debug(message, options = {})
+          Compat::UI.debug(message, options)
         end
 
         # Print a red error message to the console.
@@ -34,8 +32,8 @@ module Guard
         # @param [Hash] options the output options
         # @option options [Boolean] :reset reset the UI
         #
-        def error(message, options = { })
-          ::Guard::UI.error(color(message, ';31'), options)
+        def error(message, options = {})
+          Compat::UI.error(color(message, ';31'), options)
         end
 
         # Print a green success message to the console.
@@ -44,9 +42,9 @@ module Guard
         # @param [Hash] options the output options
         # @option options [Boolean] :reset reset the UI
         #
-        def success(message, options = { })
+        def success(message, options = {})
           stamped_message = "#{Time.now.strftime('%r')} #{message}"
-          ::Guard::UI.info(color(stamped_message, ';32'), options)
+          Compat::UI.info(color(stamped_message, ';32'), options)
         end
 
         # Outputs a system notification.
@@ -56,8 +54,8 @@ module Guard
         # @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)
+        def notify(message, options = {})
+          Compat::UI.notify(message, options)
         end
 
         private
@@ -68,9 +66,8 @@ module Guard
         # @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
+          Compat::UI.send(:color_enabled?) ? "\e[0#{ color_code }m#{ text }\e[0m" : text
         end
-
       end
     end
   end

data/lib/guard/coffeescript/formatter.rb.orig

@@ -0,0 +1,74 @@
+module Guard
+  class CoffeeScript
+    # The Guard::CoffeeScript formatter collects console and
+    # system notification methods and enhances them with
+    # some color information.
+    #
+    module 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
+  end
+end

data/lib/guard/coffeescript/inspector.rb

@@ -1,12 +1,10 @@
 module Guard
   class CoffeeScript
-
     # The inspector verifies of the changed paths are valid
     # for Guard::CoffeeScript.
     #
     module Inspector
       class << self
-
         # Clean the changed paths and return only valid
         # CoffeeScript files.
         #
@@ -31,9 +29,8 @@ module Guard
         # @return [Boolean] when the file valid
         #
         def coffee_file?(path, options)
-          path =~ /\.(?:coffee|coffee\.md|litcoffee)$/ && (options[:missing_ok] || File.exists?(path))
+          path =~ /\.(?:coffee|coffee\.md|litcoffee)$/ && (options[:missing_ok] || File.exist?(path))
         end
-
       end
     end
   end

data/lib/guard/coffeescript/runner.rb

@@ -4,7 +4,6 @@ module Guard
   class CoffeeScript
     module Runner
       class << self
-
         attr_accessor :last_run_failed
 
         # The CoffeeScript runner handles the CoffeeScript compilation,
@@ -12,7 +11,7 @@ module Guard
         # to the console and triggers optional system notifications.
         #
         # @param [Array<String>] files the spec files or directories
-        # @param [Array<Guard::Watcher>] watchers the Guard watchers in the block
+        # @param [Array<Regexp>] patterns the patterns in the block
         # @param [Hash] options the options for the execution
         # @option options [String] :input the input directory
         # @option options [String] :output the output directory
@@ -23,11 +22,10 @@ module Guard
         # @option options [Boolean] :source_map generate the source map files
         # @return [Array<Array<String>, Boolean>] the result for the compilation run
         #
-        def run(files, watchers, options = { })
+        def run(files, patterns, options = {})
           notify_start(files, options)
-          changed_files, errors = compile_files(files, watchers, options)
+          changed_files, errors = compile_files(files, patterns, options)
           notify_result(changed_files, errors, options)
-
           [changed_files, errors.empty?]
         end
 
@@ -35,30 +33,30 @@ module Guard
         # locating the output javascript file and removing it.
         #
         # @param [Array<String>] files the spec files or directories
-        # @param [Array<Guard::Watcher>] watchers the Guard watchers in the block
+        # @param [Array<Regexp>] patterns the patterns in the block
         # @param [Hash] options the options for the removal
         # @option options [String] :output the output directory
         # @option options [Boolean] :shallow do not create nested directories
         #
-        def remove(files, watchers, options = { })
+        def remove(files, patterns, options = {})
           removed_files = []
-          directories   = detect_nested_directories(watchers, files, options)
+          directories   = detect_nested_directories(files, patterns, options)
 
           directories.each do |directory, scripts|
             scripts.each do |file|
               javascript = javascript_file_name(file, directory)
-              if File.exists?(javascript)
+              if File.exist?(javascript)
                 FileUtils.remove_file(javascript)
                 removed_files << javascript
               end
             end
           end
 
-          if removed_files.length > 0
-            message = "Removed #{ removed_files.join(', ') }"
-            Formatter.success(message)
-            Formatter.notify(message, :title => 'CoffeeScript results')
-          end
+          return unless removed_files.length > 0
+
+          message = "Removed #{ removed_files.join(', ') }"
+          Formatter.success(message)
+          Formatter.notify(message, title: 'CoffeeScript results')
         end
 
         private
@@ -71,20 +69,19 @@ module Guard
         #
         def notify_start(files, options)
           message = options[:message] || (options[:noop] ? 'Verify ' : 'Compile ') + files.join(', ')
-          Formatter.info(message, :reset => true)
+          Formatter.info(message, reset: true)
         end
 
         # Compiles all CoffeeScript files and writes the JavaScript files.
         #
         # @param [Array<String>] files the files to compile
-        # @param [Array<Guard::Watcher>] watchers the Guard watchers in the block
         # @param [Hash] options the options for the execution
         # @return [Array<Array<String>, Array<String>] the result for the compilation run
         #
-        def compile_files(files, watchers, options)
+        def compile_files(files, patterns, options)
           errors        = []
           changed_files = []
-          directories   = detect_nested_directories(watchers, files, options)
+          directories   = detect_nested_directories(files, patterns, options)
 
           directories.each do |directory, scripts|
             scripts.each do |file|
@@ -92,7 +89,7 @@ module Guard
                 js, map = compile(file, options)
                 changed_files << write_javascript_file(js, map, file, directory, options)
 
-              rescue => e
+              rescue RuntimeError, ::CoffeeScript::EngineError, ::CoffeeScript::CompilationError => e
                 error_message = file + ': ' + e.message.to_s
 
                 if options[:error_to_js]
@@ -123,6 +120,7 @@ module Guard
           if options[:source_map]
             file_options.merge! options_for_source_map(filename, options)
             result = ::CoffeeScript.compile(file, file_options)
+            fail 'CoffeeScript.compile returned nil' if result.nil?
             js, map = result['js'], result['v3SourceMap']
           else
             js  = ::CoffeeScript.compile(file, file_options)
@@ -147,9 +145,7 @@ module Guard
             file_options[:bare] = file_options[:bare].include?(filename)
           end
 
-          if file[/\.(?:coffee\.md|litcoffee)$/]
-            file_options[:literate] = true
-          end
+          file_options[:literate] = true if file[/\.(?:coffee\.md|litcoffee)$/]
 
           file_options
         end
@@ -164,10 +160,10 @@ module Guard
           filename = Pathname.new(filename).relative_path_from(Pathname.new(options[:input])).to_s if options[:input]
 
           {
-            :sourceMap => true,
-            :generatedFile => filename.gsub(/((?:js\.)?(?:coffee|coffee\.md|litcoffee))$/, 'js'),
-            :sourceFiles => [filename],
-            :sourceRoot => options[:source_root] || options[:input] || '',
+            sourceMap: true,
+            generatedFile: filename.gsub(/((?:js\.)?(?:coffee|coffee\.md|litcoffee))$/, 'js'),
+            sourceFiles: [filename],
+            sourceRoot: options[:source_root] || options[:input] || ''
           }
         end
 
@@ -190,10 +186,10 @@ module Guard
 
           if options[:source_map]
             map_name = filename + '.map'
-            js += "\n/*\n//@ sourceMappingURL=#{File.basename(map_name)}\n*/\n"
+            js += "\n//# sourceMappingURL=#{File.basename(map_name)}\n"
           end
 
-          FileUtils.mkdir_p(File.expand_path(directory)) if !File.directory?(directory)
+          FileUtils.mkdir_p(File.expand_path(directory)) unless File.directory?(directory)
           File.open(File.expand_path(filename), 'w') { |f| f.write(js) }
 
           if options[:source_map]
@@ -215,28 +211,28 @@ module Guard
         end
 
         # Detects the output directory for each CoffeeScript file. Builds
-        # the product of all watchers and assigns to each directory
+        # the product of all patterns 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 [Array<Regexp>] patterns the patterns in the block
         # @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)
+        def detect_nested_directories(files, patterns, options)
           return { options[:output] => files } if options[:shallow]
 
-          directories = { }
+          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
+          patterns.product(files).each do |pattern, file|
+            next unless (matches = file.match(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
 
@@ -251,18 +247,17 @@ module Guard
         # @option options [Boolean] :hide_success hide success message notification
         # @option options [Boolean] :noop do not generate an output file
         #
-        def notify_result(changed_files, errors, options = { })
+        def notify_result(changed_files, errors, options = {})
           if !errors.empty?
             self.last_run_failed = true
-            Formatter.notify(errors.join("\n"), :title => 'CoffeeScript results', :image => :failed, :priority => 2)
+            Formatter.notify(errors.join("\n"), title: 'CoffeeScript results', image: :failed, priority: 2)
           elsif !options[:hide_success] || last_run_failed
             self.last_run_failed = false
             message = "Successfully #{ options[:noop] ? 'verified' : 'generated' } #{ changed_files.join(', ') }"
             Formatter.success(message)
-            Formatter.notify(message, :title => 'CoffeeScript results')
+            Formatter.notify(message, title: 'CoffeeScript results')
           end
         end
-
       end
     end
   end