guard-coffeescript 0.1.2 → 0.1.3

data/README.rdoc

@@ -1,6 +1,6 @@
 = Guard::CoffeeScript
 
-CoffeeScript guard allows to automatically & intelligently compile your CoffeeScripts when files are modified.
+Guard::CoffeeScript compiles you CoffeeScripts automatically when files are modified.
 
 - Tested on Ruby 1.8.7 & 1.9.2.
 
@@ -32,7 +32,7 @@ Please read {guard usage doc}[http://github.com/guard/guard#readme]
 
 == Guardfile
 
-CoffeeScript guard can be really be adapated to all kind of projects.
+CoffeeScript guard can be adapated to all kind of projects.
 Please read {guard doc}[http://github.com/guard/guard#readme] for more info about Guardfile DSL.
 
 === Standard ruby gems
@@ -47,6 +47,37 @@ Please read {guard doc}[http://github.com/guard/guard#readme] for more info abou
       watch('^app/coffeescripts/(.*)\.coffee')
     end
 
+== Options
+
+There following options can be passed to the CoffeeSCript Guard:
+
+    :output => 'javascripts'            # Relative path to the output directory
+    :wrap => false                      # Compile without the top-level function wrapper
+    :shallow => true                    # Do not create nested output directories
+
+=== Nested directories
+
+The guard detects by default nested directories and creates these within the output directory. The detection is based on the match of the watch regular expression:
+
+A file
+
+    /app/coffeescripts/ui/buttons/toggle_button.coffee
+
+that has been detected by the watch
+
+    watch('^app/coffeescripts/(.*)\.coffee')
+
+with an output directory of
+
+    :output => 'public/javascripts/compiled'
+
+will be compiled to
+
+    public/javascripts/compiled/ui/buttons/toggle_button.js
+
+This behaviour can be switched off by passing the option ':shallow => false' to the guard, so that all JavaScripts will
+be compiled directly to the output directory.
+
 == Development
 
 - Source hosted at {GitHub}[http://github.com/netzpirat/guard-coffeescript]
@@ -58,7 +89,7 @@ Pull requests are very welcome! Make sure your patches are well tested.
 
 {Michael Kessler}[http://github.com/netzpirat]
 
-== Kudo
+== Acknowledgment
+
+Many thanks to the {Guard Team}[https://github.com/guard/guard/contributors] and all the authors of the numerous {Guards}[http://github.com/guard]
 
-Many thanks to {Thibaud Guillaume-Gentil}[http://github.com/thibaudgg] for creating the excellent {guard}[http://github.com/guard/guard]
-gem.

data/lib/guard/coffeescript.rb

@@ -5,23 +5,24 @@ require 'guard/watcher'
 module Guard
   class CoffeeScript < Guard
 
-    autoload :Runner, 'guard/coffeescript/runner'
     autoload :Inspector, 'guard/coffeescript/inspector'
+    autoload :Runner, 'guard/coffeescript/runner'
+    autoload :Compiler, 'guard/coffeescript/compiler'
 
     def initialize(watchers = [], options = {})
-      @watchers, @options = watchers, options
-      @options[:output] ||= 'javascripts'
-      @options[:nowrap] ||= false
+      super(watchers, {
+        :output => 'javascripts',
+        :wrap => true,
+        :shallow => false
+      }.merge(options))
     end
 
     def run_all
-      paths = Inspector.clean(Watcher.match_files(self, Dir.glob(File.join('**', '*.coffee'))))
-      Runner.run(paths, options.merge(:message => 'Compile all CoffeeScripts')) unless paths.empty?
+      run_on_change(Watcher.match_files(self, Dir.glob(File.join('**', '*.coffee'))))
     end
 
     def run_on_change(paths)
-      paths = Inspector.clean(paths)
-      Runner.run(paths, options) unless paths.empty?
+      Runner.run(Inspector.clean(paths), watchers, options)
     end
 
   end

data/lib/guard/coffeescript/compiler.rb

@@ -0,0 +1,75 @@
+module Guard
+  class CoffeeScript
+
+    # This has been kindly borrowed from https://github.com/josh/ruby-coffee-script/raw/master/lib/coffee_script.rb
+    # due to namespace conflicts with the guards own CoffeeScript class
+    #
+    # The only change to the original file is to redirect stderr to stdout when executing the compiler,
+    # so that the error messages can easily be parsed and sent to the Growl notifier.
+    #
+    module Compiler
+      class << self
+        def locate_coffee_bin
+          out = `which coffee`
+          if $?.success?
+            out.chomp
+          else
+            raise LoadError, "could not find `coffee` in PATH"
+          end
+        end
+
+        def coffee_bin
+          @@coffee_bin ||= locate_coffee_bin
+        end
+
+        def coffee_bin=(path)
+          @@coffee_bin = path
+        end
+
+        def version
+          `#{coffee_bin} --version`[/(\d|\.)+/]
+        end
+
+        # Compile a script (String or IO) to JavaScript.
+        def compile(script, options = {})
+          args = "-sp"
+
+          if options[:wrap] == false ||
+              options.key?(:bare) ||
+              options.key?(:no_wrap)
+            args += " --#{no_wrap_flag}"
+          end
+
+          execute_coffee(script, args)
+        end
+
+        # Evaluate a script (String or IO) and return the stdout.
+        # Note: the first argument will be process.argv[3], the second
+        # process.argv[4], etc.
+        def evaluate(script, *args)
+          execute_coffee(script, "-s #{args.join(' ')}")
+        end
+
+        private
+          def execute_coffee(script, args)
+            command = "#{coffee_bin} #{args} 2>&1"
+            script  = script.read if script.respond_to?(:read)
+
+            IO.popen(command, "w+") do |f|
+              f << script
+              f.close_write
+              f.read
+            end
+          end
+
+          def no_wrap_flag
+            if `#{coffee_bin} --help`.lines.grep(/--no-wrap/).any?
+              'no-wrap'
+            else
+              'bare'
+            end
+          end
+      end
+    end
+  end
+end

data/lib/guard/coffeescript/runner.rb

@@ -3,46 +3,82 @@ module Guard
     module Runner
       class << self
 
-        def run(paths, options = {})
+        def run(files, watchers, options = {})
+          message = notify_start(files, options)
+          errors = compile_files(files, options, watchers)
+          notify_result(errors, message)
+          
+        rescue LoadError
+          ::Guard::UI.error "Command 'coffee' not found. Please install CoffeeScript."    
+        end
 
-          if coffee_executable_exists?
-            message = options[:message] || "Compile #{paths.join(' ')}"
-            ::Guard::UI.info message, :reset => true
+      private
 
-            output = `#{ coffee_script_command(paths, options) } 2>&1`
+        def notify_start(files, options)
+          message = options[:message] || "Compile #{ files.join(', ') }"
+          ::Guard::UI.info message, :reset => true
+          message
+        end
 
-            puts output
+        def compile_files(files, options, watchers)
+          errors      = []
+          directories = detect_nested_directories(watchers, files, options)
 
-            if $?.to_i == 0
-              message = message.gsub(/^Compile/, 'Successfully compiled')
-              ::Guard::Notifier.notify(message, :title => 'CoffeeScript results')
-            else
-              message = output.split("\n").select { |line| line =~ /^Error:/ }.join("\n")
-              ::Guard::Notifier.notify(message, :title => 'CoffeeScript results', :image => :failed)
+          directories.each do |directory, scripts|
+            directory = File.expand_path(directory)
+            scripts.each do |file|
+              content, success = compile(file, options)
+              process_compile_result(content, file, directory, errors, success)
             end
+          end
+
+          errors
+        end
+
+        def compile(file, options)
+          content = Compiler.compile(File.open(file), options)
+          [content, $?.success?]
+        end
 
+        def process_compile_result(content, file, directory, errors, success)
+          if success
+            FileUtils.mkdir_p(directory) if !File.directory?(directory)
+            File.open(File.join(directory, File.basename(file)), 'w') { |f| f.write(content) }
           else
-            ::Guard::UI.error "Command 'coffee' not found. Please install CoffeeScript."
+            errors << file + ': ' + content.split("\n").select { |line| line =~ /^Error:/ }.join("\n")
+            ::Guard::UI.error(content)
           end
         end
 
-      private
+        def detect_nested_directories(watchers, files, options)
+          return { options[:output] => files } if options[:shallow]
+
+          directories = {}
 
-        def coffee_script_command(paths, options)
-          cmd_parts = []
-          cmd_parts << 'coffee'
-          cmd_parts << '-c'
-          cmd_parts << '--no-wrap' if options[:nowrap]
-          cmd_parts << "-o #{ options[:output] }"
-          cmd_parts << paths.join(' ')
-          cmd_parts.join(' ')
+          watchers.product(files).each do |watcher, file|
+            if matches = file.match(watcher.pattern)
+              target = File.join(options[:output], File.dirname(matches[1]))
+              if directories[target]
+                directories[target] << file
+              else
+                directories[target] = [file]
+              end
+            end
+          end
+
+          directories
         end
 
-        def coffee_executable_exists?
-          system('which coffee > /dev/null 2>/dev/null')
+        def notify_result(errors, message)
+          if errors.empty?
+            message = message.gsub(/^Compile/, 'Successfully compiled')
+            ::Guard::Notifier.notify(message, :title => 'CoffeeScript results')
+          else
+            ::Guard::Notifier.notify(errors.join("\n"), :title => 'CoffeeScript results', :image => :failed)
+          end
         end
 
       end
     end
   end
-end
+end

data/lib/guard/coffeescript/templates/Guardfile

@@ -1,3 +1,3 @@
-guard 'coffeescript', :output => 'public/javascripts/compiled', :nowrap => false do
+guard 'coffeescript', :output => 'public/javascripts/compiled' do
   watch('^app/coffeescripts/(.*)\.coffee')
 end

data/lib/guard/coffeescript/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module CoffeeScriptVersion
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: guard-coffeescript
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Michael Kessler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-29 00:00:00 +02:00
+date: 2010-11-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -92,6 +92,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/guard/coffeescript/compiler.rb
 - lib/guard/coffeescript/inspector.rb
 - lib/guard/coffeescript/runner.rb
 - lib/guard/coffeescript/templates/Guardfile