guard-coffeescript 0.4.0 → 0.4.1

data/lib/guard/coffeescript/inspector.rb

@@ -1,8 +1,18 @@
 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.
+        #
+        # @param [Array<String>] paths the changed paths
+        # @return [Array<String>] the valid spec files
+        #
         def clean(paths)
           paths.uniq!
           paths.compact!
@@ -11,16 +21,29 @@ module Guard
           paths
         end
 
-      private
+        private
 
+        # Tests if the file is valid.
+        #
+        # @param [String] file the file
+        # @return [Boolean] when the file valid
+        #
         def coffee_file?(path)
           coffee_files.include?(path)
         end
 
+        # Scans the project and keeps a list of all
+        # CoffeeScript files.
+        #
+        # @see #clear_coffee_files_list
+        # @return [Array<String>] the valid files
+        #
         def coffee_files
           @coffee_files ||= Dir.glob('**/*.coffee')
         end
 
+        # Clears the list of CoffeeScript files in this project.
+        #
         def clear_coffee_files_list
           @coffee_files = nil
         end

data/lib/guard/coffeescript/runner.rb

@@ -5,9 +5,24 @@ module Guard
     module Runner
       class << self
 
-        def run(files, watchers, options = {})
+        # The CoffeeScript runner handles the CoffeeScript compilation,
+        # creates nested directories and the output file, writes the result
+        # to the console and triggers optional system notifications.
+        #
+        # @param [Array<String>] paths the spec files or directories
+        # @param [Array<Guard::Watcher>] watchers the Guard watchers 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
+        # @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] :noop do not generate an output file
+        # @return [Array<Array<String>, Boolean>] the result for the compilation run
+        #
+        def run(files, watchers, options = { })
           notify_start(files, options)
-          changed_files, errors = compile_files(files, options, watchers)
+          changed_files, errors = compile_files(files, watchers, options)
           notify_result(changed_files, errors, options)
 
           [changed_files, errors.empty?]
@@ -16,14 +31,27 @@ module Guard
           Formatter.error("ExecJS engine error: " + e.message)
         end
 
-      private
+        private
 
+        # Generates a start compilation notification.
+        #
+        # @param [Array<String>] files the generated files
+        # @param [Hash] options the options for the execution
+        # @option options [Boolean] :noop do not generate an output file
+        #
         def notify_start(files, options)
           message = options[:message] || (options[:noop] ? 'Verify ' : 'Compile ') + files.join(', ')
           Formatter.info(message, :reset => true)
         end
 
-        def compile_files(files, options, watchers)
+        # 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)
           errors        = []
           changed_files = []
           directories   = detect_nested_directories(watchers, files, options)
@@ -32,7 +60,7 @@ module Guard
             scripts.each do |file|
               begin
                 content = compile(file, options)
-                changed_files << process_compile_result(content, file, directory, options)
+                changed_files << write_javascript_file(content, file, directory, options)
               rescue ExecJS::ProgramError => e
                 error_message = file + ': ' + e.message.to_s
                 errors << error_message
@@ -44,21 +72,42 @@ module Guard
           [changed_files.compact, errors]
         end
 
+        # Compile the CoffeeScripts
+        #
+        # @param [String] file the CoffeeScript file
+        # @param [Hash] options the options for the execution
+        #
         def compile(file, options)
           file_options = options_for_file(file, options)
           ::CoffeeScript.compile(File.read(file), file_options)
         end
 
+        # Gets the CoffeeScript compilation options.
+        #
+        # @param [String] file the CoffeeScript file
+        # @param [Hash] options the options for the execution
+        # @option options [Boolean] :bare do not wrap the output in a top level function
+        #
         def options_for_file(file, options)
           return options unless options[:bare].respond_to? :include?
-          file_options = options.clone
-          filename = file[/([^\/]*)\.coffee/]
+
+          file_options        = options.clone
+          filename            = file[/([^\/]*)\.coffee/]
           file_options[:bare] = file_options[:bare].include?(filename)
 
           file_options
         end
 
-        def process_compile_result(content, file, directory, options)
+        # Analyzes the CoffeeScript compilation output and creates the
+        # nested directories and writes the output file.
+        #
+        # @param [String] content the JavaScript content
+        # @param [String] file the CoffeeScript file name
+        # @param [String] directory the output directory
+        # @param [Hash] options the options for the execution
+        # @option options [Boolean] :noop do not generate an output file
+        #
+        def write_javascript_file(content, file, directory, options)
           FileUtils.mkdir_p(File.expand_path(directory)) if !File.directory?(directory) && !options[:noop]
           filename = File.join(directory, File.basename(file.gsub(/(js\.coffee|coffee)$/, 'js')))
           File.open(File.expand_path(filename), 'w') { |f| f.write(content) } if !options[:noop]
@@ -66,10 +115,20 @@ module Guard
           filename
         end
 
+        # 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 = {}
+          directories = { }
 
           watchers.product(files).each do |watcher, file|
             if matches = file.match(watcher.pattern)
@@ -85,7 +144,15 @@ module Guard
           directories
         end
 
-        def notify_result(changed_files, errors, options = {})
+        # Writes console and system notifications about the result of the compilation.
+        #
+        # @param [Array<String>] changed_files the changed JavaScript files
+        # @param [Array<String>] errors the error messages
+        # @param [Hash] options the options for the execution
+        # @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 = { })
           if !errors.empty?
             Formatter.notify(errors.join("\n"), :title => 'CoffeeScript results', :image => :failed, :priority => 2)
           elsif !options[:hide_success]

data/lib/guard/coffeescript/version.rb

@@ -1,5 +1,6 @@
 module Guard
   module CoffeeScriptVersion
-    VERSION = '0.4.0'
+    # Guard::CoffeeScript version that is used for the Gem specification
+    VERSION = '0.4.1'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: guard-coffeescript
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Michael Kessler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-03 00:00:00 Z
+date: 2011-09-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: guard
@@ -93,6 +93,38 @@ dependencies:
         version: "2.6"
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 7
+        - 2
+        version: 0.7.2
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: kramdown
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 45
+        segments: 
+        - 0
+        - 13
+        - 3
+        version: 0.13.3
+  type: :development
+  version_requirements: *id007
 description: Guard::CoffeeScript automatically generates your JavaScripts from your CoffeeScripts
 email: 
 - michi@netzpiraten.ch
@@ -104,16 +136,11 @@ extra_rdoc_files: []
 
 files: 
 - lib/guard/coffeescript/formatter.rb
-- lib/guard/coffeescript/formatter.rbc
 - lib/guard/coffeescript/inspector.rb
-- lib/guard/coffeescript/inspector.rbc
 - lib/guard/coffeescript/runner.rb
-- lib/guard/coffeescript/runner.rbc
 - lib/guard/coffeescript/templates/Guardfile
 - lib/guard/coffeescript/version.rb
-- lib/guard/coffeescript/version.rbc
 - lib/guard/coffeescript.rb
-- lib/guard/coffeescript.rbc
 - LICENSE
 - README.md
 homepage: http://github.com/netzpirat/guard-coffeescript

data/lib/guard/coffeescript.rbc

@@ -1,1150 +0,0 @@
-!RBIX
-6235178746665710376
-x
-M
-1
-n
-n
-x
-10
-__script__
-i
-55
-5
-7
-0
-64
-47
-49
-1
-1
-15
-5
-7
-2
-64
-47
-49
-1
-1
-15
-5
-7
-3
-64
-47
-49
-1
-1
-15
-99
-7
-4
-65
-49
-5
-2
-13
-99
-12
-7
-6
-12
-7
-7
-12
-65
-12
-49
-8
-4
-15
-49
-6
-0
-15
-2
-11
-I
-6
-I
-0
-I
-0
-I
-0
-n
-p
-9
-s
-5
-guard
-x
-7
-require
-s
-11
-guard/guard
-s
-13
-guard/watcher
-x
-5
-Guard
-x
-11
-open_module
-x
-15
-__module_init__
-M
-1
-n
-n
-x
-5
-Guard
-i
-31
-5
-66
-99
-7
-0
-45
-1
-2
-65
-49
-3
-3
-13
-99
-12
-7
-4
-12
-7
-5
-12
-65
-12
-49
-6
-4
-15
-49
-4
-0
-11
-I
-6
-I
-0
-I
-0
-I
-0
-n
-p
-7
-x
-12
-CoffeeScript
-x
-5
-Guard
-n
-x
-10
-open_class
-x
-14
-__class_init__
-M
-1
-n
-n
-x
-12
-CoffeeScript
-i
-95
-5
-66
-5
-7
-0
-7
-1
-64
-47
-49
-2
-2
-15
-5
-7
-3
-7
-4
-64
-47
-49
-2
-2
-15
-5
-7
-5
-7
-6
-64
-47
-49
-2
-2
-15
-99
-7
-7
-7
-8
-65
-67
-49
-9
-0
-49
-10
-4
-15
-99
-7
-11
-7
-12
-65
-67
-49
-9
-0
-49
-10
-4
-15
-99
-7
-13
-7
-14
-65
-67
-49
-9
-0
-49
-10
-4
-15
-5
-48
-15
-15
-99
-7
-16
-7
-17
-65
-67
-49
-9
-0
-49
-10
-4
-11
-I
-5
-I
-0
-I
-0
-I
-0
-n
-p
-18
-x
-9
-Formatter
-s
-28
-guard/coffeescript/formatter
-x
-8
-autoload
-x
-9
-Inspector
-s
-28
-guard/coffeescript/inspector
-x
-6
-Runner
-s
-25
-guard/coffeescript/runner
-x
-10
-initialize
-M
-1
-n
-n
-x
-10
-initialize
-i
-201
-23
-0
-10
-9
-35
-0
-19
-0
-15
-23
-1
-10
-23
-44
-43
-0
-78
-49
-1
-1
-19
-1
-15
-20
-0
-9
-30
-1
-8
-34
-35
-0
-19
-0
-15
-44
-43
-0
-4
-3
-49
-1
-1
-13
-7
-2
-3
-49
-3
-2
-15
-13
-7
-4
-3
-49
-3
-2
-15
-13
-7
-5
-3
-49
-3
-2
-15
-19
-2
-15
-20
-1
-7
-6
-49
-7
-1
-9
-185
-20
-2
-44
-43
-0
-79
-49
-1
-1
-13
-7
-8
-20
-1
-7
-6
-49
-7
-1
-49
-3
-2
-15
-49
-9
-1
-15
-20
-0
-44
-43
-10
-43
-11
-13
-71
-12
-47
-9
-154
-47
-49
-13
-0
-13
-44
-43
-14
-7
-15
-20
-1
-7
-6
-49
-16
-1
-47
-101
-17
-7
-18
-63
-3
-78
-49
-12
-2
-47
-49
-19
-1
-15
-8
-180
-44
-43
-14
-7
-15
-20
-1
-7
-6
-49
-16
-1
-47
-101
-17
-7
-18
-63
-3
-78
-49
-12
-2
-49
-12
-1
-49
-20
-1
-8
-186
-1
-15
-20
-0
-20
-2
-20
-1
-49
-21
-1
-54
-52
-19
-2
-11
-I
-a
-I
-3
-I
-0
-I
-2
-n
-p
-22
-x
-4
-Hash
-x
-16
-new_from_literal
-x
-4
-bare
-x
-3
-[]=
-x
-7
-shallow
-x
-12
-hide_success
-x
-5
-input
-x
-2
-[]
-x
-6
-output
-x
-6
-merge!
-x
-5
-Guard
-x
-7
-Watcher
-x
-3
-new
-x
-8
-allocate
-x
-6
-Regexp
-s
-1
-^
-x
-6
-delete
-x
-4
-to_s
-s
-14
-/(.+\.coffee)$
-x
-10
-initialize
-x
-2
-<<
-x
-5
-merge
-p
-29
-I
--1
-I
-c
-I
-17
-I
-d
-I
-22
-I
-0
-I
-23
-I
-12
-I
-2c
-I
-f
-I
-34
-I
-10
-I
-3c
-I
-11
-I
-43
-I
-e
-I
-46
-I
-14
-I
-4f
-I
-15
-I
-6a
-I
-16
-I
-b9
-I
-14
-I
-ba
-I
-0
-I
-bb
-I
-19
-I
-c9
-x
-70
-/Users/michi/Repositories/guard-coffeescript/lib/guard/coffeescript.rb
-p
-3
-x
-8
-watchers
-x
-7
-options
-x
-8
-defaults
-x
-17
-method_visibility
-x
-15
-add_defn_method
-x
-7
-run_all
-M
-1
-n
-n
-x
-7
-run_all
-i
-31
-5
-45
-0
-1
-5
-45
-2
-3
-45
-4
-5
-7
-6
-64
-7
-7
-64
-49
-8
-2
-49
-9
-1
-49
-10
-2
-47
-49
-11
-1
-11
-I
-7
-I
-0
-I
-0
-I
-0
-n
-p
-12
-x
-7
-Watcher
-n
-x
-3
-Dir
-n
-x
-4
-File
-n
-s
-2
-**
-s
-8
-*.coffee
-x
-4
-join
-x
-4
-glob
-x
-11
-match_files
-x
-13
-run_on_change
-p
-5
-I
--1
-I
-1c
-I
-0
-I
-1d
-I
-1f
-x
-70
-/Users/michi/Repositories/guard-coffeescript/lib/guard/coffeescript.rb
-p
-0
-x
-13
-run_on_change
-M
-1
-n
-n
-x
-13
-run_on_change
-i
-43
-45
-0
-1
-45
-2
-3
-20
-0
-49
-4
-1
-5
-48
-5
-5
-48
-6
-49
-7
-3
-97
-37
-19
-1
-15
-37
-19
-2
-15
-15
-2
-15
-5
-20
-1
-47
-49
-8
-1
-15
-20
-2
-11
-I
-7
-I
-3
-I
-1
-I
-1
-n
-p
-9
-x
-6
-Runner
-n
-x
-9
-Inspector
-n
-x
-5
-clean
-x
-8
-watchers
-x
-7
-options
-x
-3
-run
-x
-6
-notify
-p
-9
-I
--1
-I
-20
-I
-0
-I
-21
-I
-20
-I
-22
-I
-28
-I
-24
-I
-2b
-x
-70
-/Users/michi/Repositories/guard-coffeescript/lib/guard/coffeescript.rb
-p
-3
-x
-5
-paths
-x
-13
-changed_files
-x
-7
-success
-x
-7
-private
-x
-6
-notify
-M
-1
-n
-n
-x
-6
-notify
-i
-12
-44
-43
-0
-49
-1
-0
-56
-2
-50
-3
-0
-11
-I
-3
-I
-1
-I
-1
-I
-1
-n
-p
-4
-x
-5
-Guard
-x
-6
-guards
-M
-1
-p
-2
-x
-9
-for_block
-t
-n
-x
-6
-notify
-i
-36
-57
-19
-0
-15
-45
-0
-1
-20
-0
-21
-1
-0
-49
-2
-2
-19
-1
-15
-20
-1
-49
-3
-0
-9
-28
-1
-8
-35
-20
-0
-20
-1
-49
-4
-1
-11
-I
-6
-I
-2
-I
-1
-I
-1
-n
-p
-5
-x
-7
-Watcher
-n
-x
-11
-match_files
-x
-6
-empty?
-x
-13
-run_on_change
-p
-9
-I
-0
-I
-2a
-I
-4
-I
-2b
-I
-12
-I
-2c
-I
-23
-I
-0
-I
-24
-x
-70
-/Users/michi/Repositories/guard-coffeescript/lib/guard/coffeescript.rb
-p
-2
-x
-5
-guard
-x
-5
-paths
-x
-4
-each
-p
-5
-I
--1
-I
-29
-I
-0
-I
-2a
-I
-c
-x
-70
-/Users/michi/Repositories/guard-coffeescript/lib/guard/coffeescript.rb
-p
-1
-x
-13
-changed_files
-p
-17
-I
-2
-I
-8
-I
-d
-I
-9
-I
-18
-I
-a
-I
-23
-I
-c
-I
-31
-I
-1c
-I
-3f
-I
-20
-I
-4d
-I
-27
-I
-51
-I
-29
-I
-5f
-x
-70
-/Users/michi/Repositories/guard-coffeescript/lib/guard/coffeescript.rb
-p
-0
-x
-13
-attach_method
-p
-3
-I
-2
-I
-6
-I
-1f
-x
-70
-/Users/michi/Repositories/guard-coffeescript/lib/guard/coffeescript.rb
-p
-0
-x
-13
-attach_method
-p
-9
-I
-0
-I
-1
-I
-9
-I
-2
-I
-12
-I
-3
-I
-1b
-I
-5
-I
-37
-x
-70
-/Users/michi/Repositories/guard-coffeescript/lib/guard/coffeescript.rb
-p
-0