distil 0.14.0.d → 0.14.0.g

data/Rakefile

@@ -11,7 +11,7 @@ begin
     gemspec.description= gemspec.summary
     gemspec.files= Dir['assets/*', 'lib/**/*', 'bin/*', '[A-Za-z]*', 'vendor/**/*']
     gemspec.files.reject! { |f| File.directory?(f) }
-    gemspec.executables= ['distil']
+    gemspec.executables= ['distil', 'jsl']
     gemspec.extensions= ['vendor/extconf.rb']
     gemspec.add_dependency('json', '>= 1.4.3')
     gemspec.add_dependency('rubyzip', '>=0.9.4')

data/VERSION

@@ -1 +1,2 @@
-0.14.0.d
+0.14.0.g
+

data/bin/distil

@@ -60,15 +60,21 @@ module Distil
   if options[:output_path]
     project.output_path= options[:output_path]
   end
+
+  begin
+    commands= ARGV.empty? ? ['build'] : ARGV
+    commands.each { |cmd|
+      project.send cmd
+    }
   
-  commands= ARGV.empty? ? ['build'] : ARGV
-  commands.each { |cmd|
-    project.send cmd
-  }
-  project.report
-  
-  if true==options['server']
-    start_server(project, options)
+    project.report
+    
+    if true==options['server']
+      start_server(project, options)
+    end
+  rescue BuildFailure
+    project.report
+    exit 1
   end
-  
+
 end

data/bin/jsl

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+LIB_DIR= File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+VENDOR_DIR= File.expand_path(File.join(File.dirname(__FILE__), "..", "vendor"))
+JSL_CONF= "#{LIB_DIR}/jsl.conf"
+LINT_COMMAND= "#{VENDOR_DIR}/jsl-0.3.0/bin/jsl"
+
+args= ARGV.map { |a| "\"#{a}\"" }
+system("#{LINT_COMMAND} #{args.join(" ")}")

data/distil.gemspec

@@ -5,14 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{distil}
-  s.version = "0.14.0.d"
+  s.version = "0.14.0.g"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Watkins"]
-  s.date = %q{2010-12-22}
-  s.default_executable = %q{distil}
+  s.date = %q{2011-01-13}
   s.description = %q{A build tool for Javascript and CSS that takes advantage of best-of-breed helper applications Javascript Lint and JSDoc Toolkit}
-  s.executables = ["distil"]
+  s.executables = ["distil", "jsl"]
   s.extensions = ["vendor/extconf.rb"]
   s.files = [
     "Buildfile",
@@ -20,16 +19,18 @@ Gem::Specification.new do |s|
      "VERSION",
      "assets/distil.js",
      "bin/distil",
-     "bin/distil-old",
+     "bin/jsl",
      "distil.gemspec",
      "distil.tmproj",
      "lib/distil.rb",
      "lib/distil/browser.rb",
+     "lib/distil/build-failure.rb",
      "lib/distil/configurable.rb",
      "lib/distil/error-reporter.rb",
      "lib/distil/file-vendor.rb",
      "lib/distil/hash-additions.rb",
      "lib/distil/javascript-code.rb",
+     "lib/distil/javascript-documentation-generator.rb",
      "lib/distil/javascript-file-validator.rb",
      "lib/distil/library.rb",
      "lib/distil/product.rb",

data/distil.tmproj

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>currentDocument</key>
-	<string>lib/distil/product/javascript-product.rb</string>
+	<string>lib/jsl.conf</string>
 	<key>documents</key>
 	<array>
 		<dict>
@@ -21,102 +21,165 @@
 	<integer>270</integer>
 	<key>metaData</key>
 	<dict>
-		<key>bin/distil</key>
+		<key>Rakefile</key>
 		<dict>
 			<key>caret</key>
 			<dict>
 				<key>column</key>
-				<integer>0</integer>
+				<integer>39</integer>
 				<key>line</key>
-				<integer>38</integer>
+				<integer>13</integer>
 			</dict>
 			<key>firstVisibleColumn</key>
 			<integer>0</integer>
 			<key>firstVisibleLine</key>
 			<integer>0</integer>
 		</dict>
-		<key>lib/distil/configurable.rb</key>
+		<key>VERSION</key>
 		<dict>
 			<key>caret</key>
 			<dict>
 				<key>column</key>
 				<integer>0</integer>
 				<key>line</key>
-				<integer>0</integer>
+				<integer>1</integer>
 			</dict>
 			<key>firstVisibleColumn</key>
 			<integer>0</integer>
 			<key>firstVisibleLine</key>
-			<integer>31</integer>
+			<integer>0</integer>
 		</dict>
-		<key>lib/distil/error-reporter.rb</key>
+		<key>bin/distil</key>
 		<dict>
 			<key>caret</key>
 			<dict>
 				<key>column</key>
 				<integer>0</integer>
 				<key>line</key>
+				<integer>6</integer>
+			</dict>
+			<key>columnSelection</key>
+			<false/>
+			<key>firstVisibleColumn</key>
+			<integer>0</integer>
+			<key>firstVisibleLine</key>
+			<integer>0</integer>
+			<key>selectFrom</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>4</integer>
+			</dict>
+			<key>selectTo</key>
+			<dict>
+				<key>column</key>
 				<integer>0</integer>
+				<key>line</key>
+				<integer>6</integer>
+			</dict>
+		</dict>
+		<key>bin/jsl</key>
+		<dict>
+			<key>caret</key>
+			<dict>
+				<key>column</key>
+				<integer>30</integer>
+				<key>line</key>
+				<integer>8</integer>
 			</dict>
 			<key>firstVisibleColumn</key>
 			<integer>0</integer>
 			<key>firstVisibleLine</key>
-			<integer>18</integer>
+			<integer>0</integer>
 		</dict>
-		<key>lib/distil/library.rb</key>
+		<key>lib/distil/error-reporter.rb</key>
 		<dict>
 			<key>caret</key>
 			<dict>
 				<key>column</key>
 				<integer>0</integer>
 				<key>line</key>
-				<integer>205</integer>
+				<integer>0</integer>
 			</dict>
 			<key>firstVisibleColumn</key>
 			<integer>0</integer>
 			<key>firstVisibleLine</key>
-			<integer>183</integer>
+			<integer>18</integer>
 		</dict>
-		<key>lib/distil/product/javascript-product.rb</key>
+		<key>lib/distil/javascript-file-validator.rb</key>
 		<dict>
 			<key>caret</key>
 			<dict>
 				<key>column</key>
-				<integer>33</integer>
+				<integer>0</integer>
 				<key>line</key>
-				<integer>116</integer>
+				<integer>4</integer>
 			</dict>
+			<key>columnSelection</key>
+			<false/>
 			<key>firstVisibleColumn</key>
 			<integer>0</integer>
 			<key>firstVisibleLine</key>
-			<integer>93</integer>
+			<integer>15</integer>
+			<key>selectFrom</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>2</integer>
+			</dict>
+			<key>selectTo</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>4</integer>
+			</dict>
 		</dict>
-		<key>lib/distil/server.rb</key>
+		<key>lib/jsl.conf</key>
 		<dict>
 			<key>caret</key>
 			<dict>
 				<key>column</key>
-				<integer>84</integer>
+				<integer>0</integer>
 				<key>line</key>
-				<integer>13</integer>
+				<integer>65</integer>
 			</dict>
+			<key>columnSelection</key>
+			<false/>
 			<key>firstVisibleColumn</key>
 			<integer>0</integer>
 			<key>firstVisibleLine</key>
-			<integer>0</integer>
+			<integer>55</integer>
+			<key>selectFrom</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>64</integer>
+			</dict>
+			<key>selectTo</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>65</integer>
+			</dict>
 		</dict>
 	</dict>
 	<key>openDocuments</key>
 	<array>
-		<string>lib/distil/library.rb</string>
 		<string>bin/distil</string>
-		<string>lib/distil/product/javascript-product.rb</string>
-		<string>lib/distil/server.rb</string>
-		<string>lib/distil/configurable.rb</string>
+		<string>bin/jsl</string>
+		<string>VERSION</string>
+		<string>lib/jsl.conf</string>
+		<string>Rakefile</string>
+		<string>lib/distil/javascript-file-validator.rb</string>
 	</array>
 	<key>showFileHierarchyDrawer</key>
 	<false/>
 	<key>windowFrame</key>
-	<string>{{833, 300}, {1087, 878}}</string>
+	<string>{{353, 0}, {1087, 878}}</string>
 </dict>
 </plist>

data/lib/distil/build-failure.rb

@@ -0,0 +1,4 @@
+module Distil
+  class BuildFailure < StandardError
+  end
+end

data/lib/distil/javascript-documentation-generator.rb

@@ -0,0 +1,49 @@
+module Distil
+
+  DOC_COMMENT_REGEX= /(\/\*\*.*?)\*\//m
+  DOC_VALID_FLAGS= [:topic, :deprecated]
+  
+  module JavascriptDocumentationGenerator
+
+    include ErrorReporter
+
+    def extract_doc_comments_from(file)
+      comments= []
+      
+      file.content.scan(DOC_COMMENT_REGEX).each { |m|
+        lines= m[0].split
+        comment= {
+          :ebnf => lines[1],
+          :text => lines[2..-1].join("\n")
+        }
+        
+        # Remove comment characters (otherwise, the string doesn't split
+        # correctly when the line after the comment is empty). Flags are a comma
+        # separated list of options for this comment.
+        flags= lines[0][3..-1]
+        flags.split(',').each { |flag|
+          key, value= flag.split(/\s*:\s*/)
+          if !DOC_VALID_FLAGS.include?(key.to_sym)
+            warning "Invalid documentation qualifier: #{key}", file
+            next
+          end
+          comment[key.to_sym]= case key.to_sym
+            when :topic
+              value
+            when :deprecated
+              true
+            end
+        }
+        
+        # Add the comment to the collection
+        comments << comment
+      }
+
+      comments
+    end
+    
+    def document_file(file)
+      comments= extract_doc_comments_from(file)
+    end
+      
+end

data/lib/distil/javascript-file-validator.rb

@@ -67,8 +67,10 @@ module Distil
       summary= output.pop
       match= summary.match(/(\d+)\s+error\(s\), (\d+)\s+warning\(s\)/)
       if (match)
-        @@error_count+= match[1].to_i
-        @@warning_count+= match[2].to_i
+        errors= match[1].to_i
+        warnings= match[2].to_i
+        @@error_count+= errors
+        @@warning_count+= warnings
       end
     
       output= output.join("\n")
@@ -78,7 +80,8 @@ module Distil
         puts
       end
 
-    end    
+      raise BuildFailure if errors>0 || warnings>0
+    end
   end
   
 end

data/lib/distil/project.rb

@@ -2,8 +2,10 @@ module Distil
   
   BUILD_FILE= 'Buildfile'
   DEFAULT_OUTPUT_FOLDER= 'build'
+  DEFAULT_DOC_OUTPUT_FOLDER= 'doc'
   DEFAULT_LANGUAGE= 'en'
-
+  DEFAULT_DOC_FOLDER= 'doc'
+  
   APPLICATION_TYPE= 'application'
   FRAMEWORK_TYPE= 'framework'
   
@@ -12,15 +14,18 @@ module Distil
     include FileVendor
     include JavascriptFileValidator
     
-    attr_reader :name, :path, :folder, :source_folder, :output_path, :include_paths
+    attr_reader :name, :path, :folder, :source_path, :output_path, :include_paths
     attr_reader :assets, :asset_aliases
     attr_reader :libraries_by_name, :libraries
     attr_reader :languages, :project_type
     attr_reader :source_files
+    attr_reader :doc_output_path
     attr_reader :global_export
     attr_reader :additional_globals
     attr_reader :subprojects
     attr_reader :dependency_aliases
+    attr_reader :doc_src_path
+    attr_reader :doc_output_path
     
     alias_config_key :project_type, :type
 
@@ -60,8 +65,9 @@ module Distil
       @path= path
       @parent= parent
       @folder= File.dirname(@path)
-      @source_folder= @folder
+      @source_path= File.expand_path(@folder)
       @output_path= File.join(@folder, DEFAULT_OUTPUT_FOLDER)
+      @doc_output_path= File.join(@folder, DEFAULT_DOC_OUTPUT_FOLDER)
       @include_paths= [@folder]
       @include_files= []
       @asset_aliases= {}
@@ -92,8 +98,12 @@ module Distil
             self.output_path= File.expand_path(output_folder)
           end
           
+          c.with :doc_folder do |doc_folder|
+            @doc_output_path= File.expand_path(doc_folder)
+          end
+          
           c.with :source_folder do |source_folder|
-            @source_folder= source_folder
+            @source_path= File.expand_path(source_folder)
           end
 
           c.with :export do |export|
@@ -109,10 +119,10 @@ module Distil
             @languages << language
           end
           
-          c.with_each :require do |asset|
-            asset= Library.new(asset, self)
-            @libraries << asset
-            @libraries_by_name[asset.name]= asset
+          c.with_each :require do |library|
+            library= Library.new(library, self)
+            @libraries << library
+            @libraries_by_name[library.name]= library
           end
 
           c.with :source do |source_files|
@@ -228,8 +238,15 @@ module Distil
     
     def relative_output_path_for(thing)
       return nil if !thing
-      # puts "relative_output_path_for: #{thing} #{output_path}"
-      Project.path_relative_to_folder(thing.is_a?(String) ? thing : thing.output_path, output_path)
+      thing_path= thing.is_a?(String) ? thing : thing.output_path
+      # puts "relative_output_path_for:"
+      # puts "  output_path= #{thing_path}"
+      # unless thing.is_a?(String)
+      #   puts "  full_path= #{thing.full_path}"
+      #   puts "  relative_path= #{thing.relative_path}"
+      #   puts "  source_path= #{source_path}"
+      # end
+      Project.path_relative_to_folder(thing_path, output_path)
     end
     
     def notice_text
@@ -266,12 +283,14 @@ module Distil
           next if (a.full_path).starts_with?(output_path)
 
           path= relative_output_path_for(a)
-
+          
           parts= File.dirname(path).split(File::SEPARATOR)
           if ('.'==parts[0])
+            source_path= a.path_relative_to(output_path)
             product_path= File.join(output_path, path)
+            file_path= a.path_relative_to(source_path)
             FileUtils.rm product_path if File.exists? product_path
-            File.symlink path, product_path
+            File.symlink file_path, product_path
             next
           end
 
@@ -280,7 +299,7 @@ module Distil
     
         folders.each { |f|
           target= f
-          source= relative_output_path_for(File.join(source_folder, f))
+          source= relative_output_path_for(File.join(source_path, f))
 
           FileUtils.rm target if File.symlink?(target)
           next if File.directory?(target)
@@ -291,12 +310,17 @@ module Distil
   
     def copy_assets
       assets.each { |a|
-        a.copy_to(output_path, source_folder)
+        a.copy_to(output_path, source_path)
       }
     end
   
     def build_assets
       symlink_assets
+      
+      if !@parent
+        FileUtils.cp(File.join(ASSETS_DIR, 'distil.js'), output_path)
+      end
+      
       # if (RELEASE_MODE==mode)
       #   copy_assets
       # else
@@ -326,7 +350,7 @@ module Distil
       end
       
       matches= glob(file)
-      matches= glob(File.join(source_folder, file)) if matches.empty?
+      matches= glob(File.join(source_path, file)) if matches.empty?
       
       if (matches.empty?)
         error("No matching files found for: #{file}")

data/lib/distil/source-file.rb

@@ -3,7 +3,7 @@ require 'fileutils'
 module Distil
 
   class SourceFile
-    attr_reader :full_path, :project
+    attr_reader :full_path, :project, :dependencies
     attr_accessor :language, :is_asset
     
     class_attr :extension
@@ -14,6 +14,7 @@ module Distil
     def initialize(filepath, project)
       @full_path= File.expand_path(filepath)
       @project= project
+      @dependencies=[]
       project.cache_file(self)
     end
 
@@ -28,7 +29,7 @@ module Distil
     def output_path
       # SourceFiles get copied (or symlinked) into the output folder so that
       # their path is the same as that relative to the source folder
-      @output_path||= File.join(project.output_path, relative_path)
+      @output_path ||= File.join(project.output_path, relative_path)
     end
     
     def relative_path
@@ -36,7 +37,7 @@ module Distil
       if full_path.starts_with?(project.output_path)
         @relative_path= Project.path_relative_to_folder(full_path, project.output_path)
       else
-        @relative_path=Project.path_relative_to_folder(full_path, project.source_folder)
+        @relative_path=Project.path_relative_to_folder(full_path, project.source_path)
       end
     end
     
@@ -88,10 +89,6 @@ module Distil
       Project.path_relative_to_folder(@full_path, folder)
     end
 
-    def dependencies
-      @dependencies||=[]
-    end
-
     def add_dependency(file)
       return if @dependencies.include?(file)
       @dependencies << file
@@ -107,11 +104,11 @@ module Distil
     end
   
     def copy_to(folder, prefix)
-      file_path= self.file_path || relative_to_folder(prefix||"")
-      final_target_folder= File.join(folder, File.dirname(file_path))
+      relative= path_relative_to_folder(prefix)
+      target_path= File.join(folder, relative)
       FileUtils.mkdir_p final_target_folder
-      FileUtils.cp self.full_path, final_target_folder
-      File.join(final_target_folder, File.basename(file_path))
+      FileUtils.cp self.full_path, File.dirname(target_path)
+      target_path
     end
   
   end

data/lib/distil.rb

@@ -61,6 +61,7 @@ class String
   end
 end
 
+require 'distil/build-failure'
 require 'distil/hash-additions'
 require 'distil/javascript-code'
 require 'distil/error-reporter'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: distil
 version: !ruby/object:Gem::Version 
-  hash: 89
+  hash: 84
   prerelease: true
   segments: 
   - 0
   - 14
   - 0
-  - d
-  version: 0.14.0.d
+  - g
+  version: 0.14.0.g
 platform: ruby
 authors: 
 - Jeff Watkins
@@ -16,8 +16,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-22 00:00:00 -08:00
-default_executable: distil
+date: 2011-01-13 00:00:00 -08:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -87,6 +87,7 @@ description: A build tool for Javascript and CSS that takes advantage of best-of
 email: 
 executables: 
 - distil
+- jsl
 extensions: 
 - vendor/extconf.rb
 extra_rdoc_files: []
@@ -97,16 +98,18 @@ files:
 - VERSION
 - assets/distil.js
 - bin/distil
-- bin/distil-old
+- bin/jsl
 - distil.gemspec
 - distil.tmproj
 - lib/distil.rb
 - lib/distil/browser.rb
+- lib/distil/build-failure.rb
 - lib/distil/configurable.rb
 - lib/distil/error-reporter.rb
 - lib/distil/file-vendor.rb
 - lib/distil/hash-additions.rb
 - lib/distil/javascript-code.rb
+- lib/distil/javascript-documentation-generator.rb
 - lib/distil/javascript-file-validator.rb
 - lib/distil/library.rb
 - lib/distil/product.rb

data/bin/distil-old

@@ -1,78 +0,0 @@
-#!/usr/bin/env ruby
-module Distil
-  
-  LIB_DIR= File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
-  VENDOR_DIR= File.expand_path(File.join(File.dirname(__FILE__), "..", "vendor"))
-  ASSETS_DIR= File.expand_path(File.join(File.dirname(__FILE__), "..", "assets"))
-  APP_NAME= File.basename($0)
-
-  $:.unshift(LIB_DIR)
-
-end
-
-require "distil"
-
-arg_settings= {}
-project_file= nil
-args= []
-
-ARGV.each { |v|
-  if (!v[/^-/])
-    args << v
-    next
-  end
-
-  v= v.gsub(/^-+/, '')
-
-  key,value= v.split("=")
-  key.gsub!("-", "_")
-
-  value=true if !value
-
-  if ("f"==key || "file"==key || "buildfile"==key)
-    project_file= value
-    next
-  end
-
-  arg_settings[key]= value
-}
-
-def find_project_file(dir=nil)
-  dir ||= Dir.pwd
-
-  immediate_projects= Dir.glob(File.join(dir, "*.jsproj"))
-  if (!immediate_projects.empty? && 1==immediate_projects.length)
-    return immediate_projects[0]
-  end
-  
-  while dir.length > 1
-    Dir.glob(File.join(dir, '*.jsproj')) { |file|
-      return file if File.basename(dir)===File.basename(file, '.jsproj')
-    }
-    dir = File.dirname(dir)
-  end
-
-end
-
-
-# Change working directory to the folder containing the build YML file.
-project_file||= find_project_file
-
-if !project_file
-  puts "#{Distil::APP_NAME}: can't find project file"
-  exit
-end
-
-Dir.chdir(File.dirname(project_file))
-
-project= Distil::DistilProject.new(project_file, arg_settings)
-
-if 0==args.length
-  args << "build"
-end
-
-args.each { |cmd|
-  project.send cmd
-  exit 1 if project.total_error_count > 0
-  exit 1 if project.warnings_are_errors && project.total_warning_count > 0
-}