distil 0.10.4 → 0.11.0

data/lib/distil/configurable.rb

@@ -0,0 +1,164 @@
+module Kernel
+
+  def Boolean(string)
+    return true if string == true || string =~ /^true$/i
+    return false if string == false || string.nil? || string =~ /^false$/i
+    raise ArgumentError.new("invalid value for Boolean: \"#{string}\"")
+  end
+
+end
+
+class ValidationError < StandardError
+end
+
+
+class Configurable
+  attr_reader :options
+  
+  @@options= {}
+
+  def get_option(name)
+    return nil if !@options.respond_to?(name)
+    value=@options[name]
+    value.respond_to?(:value_of) ? value.value_of(self) : value
+  end
+  
+  def get_options(settings=nil, parent=nil)
+    keys= @@options.keys
+    values= @@options.map { |k,v| convert_type(v[:type], v[:value]) }
+  
+    s= Struct.new(*keys).new(*values)
+    return s if !settings
+  
+    setting_keys= settings.keys.map { |key| key.to_s }
+  
+    @@options.each { |key, value|
+
+      intersect= value[:aliases] & setting_keys
+      next if !parent && intersect.empty?
+
+      if (intersect.empty?)
+        s[key]= parent[key]
+        next
+      end
+    
+      if (intersect.length>1)
+        raise ArgumentError, "Multiple variants for #{key.to_s} defined: #{intersect.join(", ")}"
+      end
+          
+      setting_key= intersect[0]
+      setting_value= settings[setting_key]
+      settings.delete(setting_key)
+    
+      # decide if any type conversions are needed...
+      setting_value= convert_type(value[:type], setting_value)
+    
+      if (value.has_key?(:valid_values) && !value[:valid_values].include?(setting_value))
+        raise ValidationError, "Invalid value for '#{setting_key}': #{setting_value}"
+      end
+        
+      s[key]= setting_value
+
+    }
+
+    s
+  end
+
+  # option name, [type], [default], [options]
+  def self.option(name, *rest)
+  
+    name_string= name.to_s
+  
+    info= {
+      :aliases=>[name_string, name_string.gsub('_', '-'), name_string.gsub('_', ' ')].uniq
+    }
+
+    arg= rest.shift
+
+    if (arg.is_a?(Class))
+      info[:type]= arg
+      info[:value]= nil
+      arg= rest.shift
+    end
+
+    if (!arg.nil? && !arg.is_a?(Hash))
+      info[:value]= arg
+      info[:type]= arg.class if !info.has_key?(:type)
+      arg= rest.shift
+    end
+
+    # handle named arguments
+    if (arg.is_a?(Hash))
+      if arg.has_key?(:aliases)
+        info[:aliases].concat(arg[:aliases]).uniq!
+        arg.delete(:aliases)
+      end
+      info.merge!(arg)
+    end
+
+    if @@options.has_key?(name)
+      orig= @@options[name]
+      if orig.has_key?(:type) && info.has_key?(:type) && info[:type]!=orig[:type]
+        raise ArgumentError, "Redefinition of option #{self}##{name} changes type"
+      end
+      if orig.has_key?(:value) && !info[:value].nil? && info[:value]!=orig[:value]
+        raise ArgumentError, "Redefinition of option #{name} changes value"
+      end
+      orig[:type]||=info[:type]
+      orig[:value]||=info[:value]
+      orig[:aliases].concat(info[:aliases]).uniq!
+    else
+      @@options[name]= info
+    end
+    
+    self.send :define_method, name do
+      value=@options[name]
+      value.respond_to?(:value_of) ? value.value_of(self) : value
+    end
+    
+    self.send :define_method, "#{name}=" do |value|
+      @options[name]= convert_type(@@options[name][:type], value)
+    end
+    
+    # self.send :protected, "#{name}=".to_s
+    
+  end
+
+  def initialize(options={}, parent=nil)
+    if (parent.is_a?(Configurable))
+      parent_options= parent.options
+    end
+    @options= get_options(options, parent_options)
+    @extras= options
+  end
+  
+  private
+  
+  def convert_type(type, value)
+    case
+    when FalseClass==type || TrueClass==type
+      Boolean(value)
+    when Array==type
+      value.is_a?(String) ? value.split(/\s*,\s*/) : value
+    when Fixnum==type
+      value.to_i
+    when nil==type || NilClass==type
+      value
+    when String==type
+      value ? value.to_s : nil;
+    when value.nil?
+      value
+    else
+      if type.respond_to?(:from_options)
+        type.from_options(value, self)
+      else
+        type.new(value)
+      end
+    end
+  end
+  
+end
+
+Dir.glob("#{File.dirname(__FILE__)}/configurable/*.rb") { |file|
+  require file
+}

data/lib/distil/error-reporter.rb

@@ -0,0 +1,63 @@
+module Distil
+  module ErrorReporter
+    
+    @@warning_count=0
+    @@error_count=0
+    @@ignore_warnings= false
+    
+    def ignore_warnings
+      @@ignore_warnings
+    end
+    
+    def ignore_warnings=(ignore)
+      @@ignore_warnings=ignore
+    end
+    
+    def self.error(message, file=nil, line_number=nil)
+      @@error_count+=1
+      if (file && line_number)
+        printf("%s:%d: error: %s\n", file, line_number, message)
+      else
+        printf("error: %s\n", message)
+      end
+    end
+    
+    def error(message, file=nil, line_number=nil)
+      @@error_count+=1
+      if (file && line_number)
+        printf("%s:%d: error: %s\n", file, line_number, message)
+      else
+        printf("error: %s\n", message)
+      end
+    end
+
+    def self.warning(message, file=nil, line_number=nil)
+      @@warning_count+=1
+      return if (ignore_warnings)
+      if (file && line_number)
+        printf("%s:%d: warning: %s\n", file, line_number, message)
+      else
+        printf("warning: %s\n", message)
+      end
+    end
+
+    def warning(message, file=nil, line_number=nil)
+      @@warning_count+=1
+      return if (ignore_warnings)
+      if (file && line_number)
+        printf("%s:%d: warning: %s\n", file, line_number, message)
+      else
+        printf("warning: %s\n", message)
+      end
+    end
+    
+    def report
+      puts "\n" if (@@error_count>0 || @@warning_count>0)
+      puts "#{@@error_count} error(s), #{@@warning_count} warning(s)#{ignore_warnings ? " ignored" : ""}"
+    end
+    
+  end
+  
+end
+
+

data/lib/distil/product/concatenated.rb

@@ -0,0 +1,85 @@
+module Distil
+  
+  # Mix in for concatenating products
+  module Concatenated
+    
+    # files -> an enumerable collection of SourceFiles
+    # join_string -> a string to use to join the files together
+    # target -> the container of the files
+    
+    def before_files(f)
+    end
+
+    def after_files(f)
+    end
+    
+    def before_externals(f)
+    end
+    
+    def after_externals(f)
+    end
+    
+    def before_file(f, file)
+    end
+    
+    def after_file(f, file)
+    end
+    
+    def filename
+      concatenated_name
+    end
+    
+    def external_files
+      return @external_files if @external_files
+      @external_files= []
+      
+      target.project.external_projects.each { |ext|
+        next if STRONG_LINKAGE!=ext.linkage
+        
+        @external_files << ext.product_name(:concatenated, File.extname(filename)[1..-1])
+      }
+      @external_files
+    end
+    
+    def write_output
+      return if up_to_date
+      @up_to_date= true
+      
+      File.open(filename, "w") { |f|
+        f.write(target.notice_text)
+
+        f.write("\n\n")
+        before_externals(f)
+        f.write("\n\n")
+        
+        external_files.each { |ext|
+          next if !File.exist?(ext)
+          f.write(join_string)
+          f.write(target.get_content_for_file(ext))
+        }
+
+        f.write("\n\n")
+        after_externals(f)
+        f.write("\n\n")
+
+        f.write("\n\n")
+        before_files(f)
+        f.write("\n\n")
+
+        files.each { |file|
+          f.write(join_string)
+          before_file(f, file)
+          f.write(target.get_content_for_file(file))
+          after_file(f, file)
+        }
+        
+        f.write("\n\n")
+        after_files(f)
+        f.write("\n\n");
+        
+      }
+    end
+
+  end
+  
+end

data/lib/distil/product/css-product.rb

@@ -0,0 +1,37 @@
+module Distil
+
+  class CssProduct < Product
+    include Concatenated
+    extension "css"
+  end
+
+  class CssMinifiedProduct < Product
+    include Minified
+    extension "css"
+  end
+
+  class CssDebugProduct < Product
+    include Debug
+    extension "css"
+
+    def write_output
+      return if up_to_date
+      @up_to_date= true
+      
+      File.open(filename, "w") { |f|
+        f.write(target.notice_text)
+        
+        external_files.each { |ext|
+          next if !File.exist?(ext)
+          f.write("@import url(\"#{relative_path(ext)});\n")
+        }
+      
+        files.each { |file|
+          f.write("@import url(\"#{relative_path(file)}\");\n")
+        }
+      }
+    end
+    
+  end
+  
+end

data/lib/distil/product/debug.rb

@@ -0,0 +1,34 @@
+module Distil
+  
+  # Mix in for concatenating products
+  module Debug
+    
+    # files -> an enumerable collection of SourceFiles
+    # join_string -> a string to use to join the files together
+    # target -> the container of the files
+    
+    def before_files(f)
+    end
+
+    def after_files(f)
+    end
+    
+    def filename
+      debug_name
+    end
+    
+    def external_files
+      return @external_files if @external_files
+      @external_files= []
+      
+      target.project.external_projects.each { |ext|
+        next if STRONG_LINKAGE!=ext.linkage
+        
+        @external_files << ext.product_name(:debug, File.extname(filename)[1..-1])
+      }
+      @external_files
+    end
+
+  end
+  
+end

data/lib/distil/product/javascript-base-product.rb

@@ -0,0 +1,35 @@
+module Distil
+  
+  class JavascriptBaseProduct < Product
+    option :bootstrap_script, "#{ASSETS_DIR}/distil.js"
+    option :bootstrap
+
+    def initialize(settings, target)
+      super(settings, target)
+      
+      @join_string=<<-eos
+        
+        /*jsl:ignore*/;/*jsl:end*/
+        
+      eos
+      
+      if bootstrap.nil?
+        self.bootstrap= (APP_TYPE==target.target_type)
+      end
+    end
+
+    def can_embed_file?(file)
+      ["html", "js"].include?(file.content_type)
+    end
+
+    def bootstrap_source
+      @bootstrap_source||=File.read(bootstrap_script).strip
+    end
+    
+    def copy_bootstrap_script
+      FileUtils.cp bootstrap_script, target.project.output_folder if !bootstrap
+    end
+    
+  end
+  
+end

data/lib/distil/product/javascript-doc-product.rb

@@ -0,0 +1,61 @@
+module Distil
+
+  JSDOC_COMMAND= "#{VENDOR_DIR}/jsdoc-toolkit/jsrun.sh"
+  
+  class JavascriptDocProduct < Product
+
+    option :jsdoc_conf, "#{LIB_DIR}/jsdoc.conf"
+    option :jsdoc_template, "#{VENDOR_DIR}/jsdoc-extras/templates/coherent"
+    option :jsdoc_plugins, "#{VENDOR_DIR}/jsdoc-extras/plugins"
+    option :doc_folder, Interpolated, "$(path)/doc"
+
+    extension "js"
+    
+    def filename
+      File.join(doc_folder, 'index.html')
+    end
+    
+    def write_output
+      return if up_to_date
+      @up_to_date= true
+      
+      return if (!File.exists?(JSDOC_COMMAND))
+
+      tmp= Tempfile.new("jsdoc.conf")
+    
+      template= File.read(jsdoc_conf)
+      doc_files= []
+      
+      files.each { |f|
+        next if !handles_file?(f)
+        p= f.file_path || f.to_s
+        doc_files << "\"#{p}\""
+      }
+
+      conf= replace_tokens(template, {
+                      "DOC_FILES"=>doc_files.join(",\n"),
+                      "DOC_OUTPUT_DIR"=>doc_folder,
+                      "DOC_TEMPLATE_DIR"=>jsdoc_template,
+                      "DOC_PLUGINS_DIR"=>jsdoc_plugins
+                  })
+
+      tmp << conf
+      tmp.close()
+    
+      command= "#{JSDOC_COMMAND} -c=#{tmp.path}"
+    
+      stdin, stdout, stderr= Open3.popen3(command)
+      stdin.close
+      output= stdout.read
+      errors= stderr.read
+
+      tmp.delete
+    
+      puts errors
+      puts output
+      
+    end
+    
+  end
+  
+end

data/lib/distil/product/javascript-product.rb

@@ -0,0 +1,131 @@
+module Distil
+
+  class JavascriptProduct < JavascriptBaseProduct
+    include Concatenated
+
+    extension "js"
+    
+    option :global_export, :aliases=>['export']
+    option :additional_globals, [], :aliases=>['globals']
+    
+    def initialize(settings, target)
+      super(settings, target)
+      
+      @options.global_export=target.name if true==global_export
+    end
+
+    def before_externals(f)
+      f.puts("/*#nocode+*/")
+      f.puts(bootstrap_source) if bootstrap
+    end
+
+    def after_externals(f)
+    end
+    
+    def before_files(f)
+
+      if 0 != assets.length
+        asset_references= []
+        asset_map= []
+        assets.each { |a|
+          if can_embed_file?(a)
+            content= target.get_content_for_file(a)
+            content= content.gsub("\\", "\\\\").gsub("\n", "\\n").gsub("\"", "\\\"").gsub("'", "\\\\'")
+            asset_references << "\"#{target.alias_for_asset(a)}\": \"#{content}\""
+          else
+            asset_alias= target.alias_for_asset(a)
+            asset_path= relative_path(a)
+            next if asset_alias==asset_path
+            asset_map << "'#{asset_alias}': '#{asset_path}'" 
+          end
+        }
+
+        f << <<-EOS
+        
+distil.module('#{target.name}', {
+  folder: '',
+  asset_map: {
+    #{asset_map.join(",\n    ")}
+  },
+  assets: {
+    #{asset_references.join(",\n    ")}
+  }
+});
+
+
+EOS
+      end
+
+      if global_export
+        exports= [global_export, *additional_globals].join(", ")
+        f.puts "(function(#{exports}){"
+      end
+    end
+    
+    def after_files(f)
+      if global_export
+        exports= ["window.#{global_export}={}", *additional_globals].join(", ")
+        f.puts "})(#{exports});"
+      end
+
+      f.puts "\n\n/*#nocode-*/\n\n"
+      
+      f.puts "distil.kick();" if bootstrap
+      
+    end
+    
+  end
+
+  class JavascriptMinifiedProduct < Product
+    include Minified
+    extension "js"
+  end
+
+  class JavascriptDebugProduct < JavascriptBaseProduct
+    include Debug
+    extension "js"
+  
+    def write_output
+      return if up_to_date
+      @up_to_date= true
+      
+      copy_bootstrap_script
+      
+      required_files= files.map { |file| "'#{relative_path(file)}'" }
+      asset_map= []
+      assets.each { |a|
+        asset_alias= target.alias_for_asset(a)
+        asset_path= relative_path(a)
+        next if asset_alias==asset_path
+        asset_map << "'#{asset_alias}': '#{asset_path}'" 
+      }
+      
+      external_files.each { |ext|
+        next if !File.exist?(ext)
+        required_files.unshift("'#{relative_path(ext)}'")
+      }
+      
+      File.open(filename, "w") { |f|
+        f.write(target.notice_text)
+        f.write("#{bootstrap_source}\n\n") if bootstrap
+        files.each { |file|
+          f.write("/*jsl:import #{relative_path(file)}*/\n")
+        }
+        f.write(<<-EOS)
+//distil.debug= true;
+
+distil.module('#{target.name}', {
+  folder: '',
+  required: [#{required_files.join(", ")}],
+  asset_map: {
+    #{asset_map.join(",\n    ")}
+  }
+});
+EOS
+      }
+
+    end
+    
+  end
+
+end

data/lib/distil/product/minified.rb

@@ -0,0 +1,32 @@
+module Distil
+
+  COMPRESSOR= File.expand_path("#{VENDOR_DIR}/yuicompressor-2.4.2.jar")
+    
+  module Minified
+    
+    def filename
+      minified_name
+    end
+    
+    def external_files
+      []
+    end
+    
+    def write_output
+      return if up_to_date
+      @up_to_date= true
+      
+    	# Run the Y!UI Compressor
+    	system "java -jar #{COMPRESSOR} #{concatenated_name} -o #{filename}"
+    	
+    	if 'css'==extension
+    		buffer= File.read(filename)
+    		File.open(filename, "w") { |f|
+    		  f.write(buffer.gsub(/\}/,"}\n").gsub(/.*@import url\(\".*\"\);/,''))
+  		  }
+      end 
+    end
+  
+  end
+
+end