jsus 0.3.3 → 0.3.4

data/.document

@@ -3,3 +3,4 @@ bin/*
 -
 features/**/*.feature
 UNLICENSE
+CHANGELOG

data/.yardopts

@@ -1,9 +1,8 @@
 --markup="markdown" lib/**/*.rb
 --no-private
---no-protected
 --main README.md
 --hide-tag todo
 -
-LICENSE
+UNLICENSE
 CHANGELOG
 docs/*.textile

data/CHANGELOG

@@ -1,4 +1,19 @@
 = Jsus Changelog
+== Version 0.3.4
+Middleware changes:
+* support for /compressed/ path component, which acts like /require/, but
+  compresses the result in the end.
+* Cache result is now stored in subfolders of cache directory (easier to manage
+  with nginx and alike)
+* Improved error reporting (choice of one of multiple modes in middleware settings)
+
+CLI changes:
+* --no-cycle-search option for CLI to improve compilation times
+
+Other changes:
+* Compression routines moved out to Jsus::Util::Compressor class. For now, only
+  yui-compressor method is available
+
 == Version 0.3.3
 * Unfortunate accident with rubygems
 

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/bin/jsus

@@ -73,6 +73,10 @@ module Jsus
             options[:compress] = true
           end
 
+          opts.on('--no-cycle-search', 'disables search for circular dependencies which may take quite some time during compilation') do
+            Jsus.look_for_cycles = false
+          end
+
           opts.on_tail('-v', '--verbose', 'verbose mode, shows various debug messages') do
             Jsus.verbose = true
           end
@@ -276,9 +280,7 @@ module Jsus
     end
 
     def compress_package
-      require 'yui/compressor'
-      compressor = YUI::JavaScriptCompressor.new(:munge => true)
-      compressed_content = compressor.compress(@package_content)
+      compressed_content = Jsus::Util::Compressor.new(@package_content).result
       if compressed_content != ""
         @compression_ratio = compressed_content.size.to_f / @package_content.size.to_f
         compressed_file_name = @package.filename.sub(/.js$/, ".min.js")
@@ -289,8 +291,6 @@ module Jsus
         puts "Compressor command used: #{compressor.command.join(' ')}"
       end
       checkpoint(:compress)
-    rescue LoadError
-      puts 'ERROR: You need "yui-compressor" gem in order to use --compress option'
     end
 
     def generate_supplemental_files

data/jsus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jsus}
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Abramov"]
-  s.date = %q{2011-06-19}
+  s.date = %q{2011-08-30}
   s.default_executable = %q{jsus}
   s.description = %q{Javascript packager and dependency resolver}
   s.email = %q{markizko@gmail.com}
@@ -104,9 +104,11 @@ Gem::Specification.new do |s|
     "lib/jsus/tag.rb",
     "lib/jsus/util.rb",
     "lib/jsus/util/code_generator.rb",
+    "lib/jsus/util/compressor.rb",
     "lib/jsus/util/documenter.rb",
     "lib/jsus/util/file_cache.rb",
     "lib/jsus/util/inflection.rb",
+    "lib/jsus/util/logger.rb",
     "lib/jsus/util/tree.rb",
     "lib/jsus/util/validator.rb",
     "lib/jsus/util/validator/base.rb",
@@ -166,6 +168,8 @@ Gem::Specification.new do |s|
     "spec/data/JsonPackage/Source/SheetParser.CSS.js",
     "spec/data/JsonPackage/Source/sg-regex-tools.js",
     "spec/data/JsonPackage/package.json",
+    "spec/data/MissingDependencies/Source/Widget.js",
+    "spec/data/MissingDependencies/package.yml",
     "spec/data/MooforgeValidation/README",
     "spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/InvalidNoAuthors.js",
     "spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/InvalidNoLicense.js",
@@ -200,6 +204,7 @@ Gem::Specification.new do |s|
     "spec/jsus/util/documenter_spec.rb",
     "spec/jsus/util/file_cache_spec.rb",
     "spec/jsus/util/inflection_spec.rb",
+    "spec/jsus/util/logger_spec.rb",
     "spec/jsus/util/tree_spec.rb",
     "spec/jsus/util/validator/base_spec.rb",
     "spec/jsus/util/validator/mooforge_spec.rb",

data/lib/jsus.rb

@@ -22,6 +22,7 @@ module Jsus
   autoload :Pool,       'jsus/pool'
   autoload :Util,       'jsus/util'
   autoload :Middleware, 'jsus/middleware'
+  autoload :Compressor, 'jsus/compressor'
 
   # In verbose mode jsus shows a lot of warnings like missing dependencies.
   # Default: false
@@ -37,6 +38,7 @@ module Jsus
   # @api public
   def self.verbose=(verbose)
     @verbose = verbose
+    logger.level = verbose ? Logger::DEBUG : Logger::ERROR
   end
 
   # @return [String] Jsus version
@@ -63,4 +65,27 @@ module Jsus
   def self.look_for_cycles=(value)
     @look_for_cycles = value
   end
+
+  # Jsus logger used for all the output. By default uses Logger::ERROR level
+  # severity and screen as output device.
+  #
+  # @return [Jsus::Util::Logger]
+  def self.logger
+    Thread.current[:jsus_logger] ||= Jsus::Util::Logger.new(STDOUT).tap do |logger|
+      logger.level = Logger::ERROR
+      logger.formatter = lambda {|severity, time, progname, msg|
+        "[#{time.strftime("%Y-%m-%d %H:%M:%S")}] [JSUS:#{severity}] #{msg}\n"
+      }
+    end
+  end # self.logger
+
+  # Reassign jsus logger whenever needed (E.g. use rails logger)
+  #
+  # @param value Logger responding to #info, #warn, #debug, #error, #fatal,
+  #              and #buffer
+  # @note In case you use non-jsus logger, you might want to extend it with
+  #       Jsus::Util::Logger::Buffering module.
+  def self.logger=(value)
+    Thread.current[:jsus_logger] = value
+  end # self.logger=
 end

data/lib/jsus/container.rb

@@ -9,7 +9,7 @@ module Jsus
   class Container
     # Instantiates a container from given sources.
     #
-    # @param [SourceFile]
+    # @param [*SourceFile] sources
     def initialize(*sources)
       sources.each do |source|
         push(source)
@@ -20,7 +20,7 @@ module Jsus
 
     # Pushes an item to the container
     #
-    # @param [SourceFile] source pushed file
+    # @param [SourceFile] source source pushed file
     def push(source)
       if source
         if source.kind_of?(Array) || source.kind_of?(Container)
@@ -86,7 +86,7 @@ module Jsus
     #
     # Optionally accepts a filesystem point to calculate relative paths from.
     #
-    # @param [String] root point from which the relative paths are calculated.
+    # @param [String] root root point from which the relative paths are calculated.
     #   When omitted, full paths are returned.
     # @return [Array] ordered list of required files
     # @api public
@@ -131,18 +131,17 @@ module Jsus
       result = []
       if Jsus.look_for_cycles?
         cycles = graph.cycles
+        error_msg = []
         unless cycles.empty?
-          puts "*" * 30
-          puts "ACHTUNG! WARNING! ATTENTION!"
-          puts "*" * 30
-          puts "Jsus has discovered you have circular dependencies in your code."
-          puts "Please resolve them immediately!"
-          puts "List of circular dependencies:"
+          error_msg << "Jsus has discovered you have circular dependencies in your code."
+          error_msg << "Please resolve them immediately!"
+          error_msg << "List of circular dependencies:"
           cycles.each do |cycle|
-            puts "-" * 30
-            puts (cycle + [cycle.first]).map {|sf| sf.filename}.join(" => ")
+            error_msg << "-" * 30
+            error_msg << (cycle + [cycle.first]).map {|sf| sf.filename}.join(" => ")
           end
-          puts "*" * 30
+          error_msg = error_msg.join("\n")
+          Jsus.logger.fatal(error_msg)
         end
       end
       graph.topsort_iterator.each { |item| result << item }

data/lib/jsus/middleware.rb

@@ -33,7 +33,7 @@ module Jsus
   #
   class Middleware
     include Rack
-    class <<self
+    class << self
       # Default settings for Middleware
       DEFAULT_SETTINGS = {
         :packages_dir     => ".",
@@ -41,7 +41,9 @@ module Jsus
         :cache_path       => nil,
         :prefix           => "jsus",
         :cache_pool       => true,
-        :includes_root    => "."
+        :includes_root    => ".",
+        :log_method       => nil, # [:alert, :html, :console]
+        :postproc         => []   # ["mooltie8", "moocompat12"]
       }.freeze
 
       # @return [Hash] Middleware current settings
@@ -94,7 +96,7 @@ module Jsus
     end # class <<self
 
     # Default rack initialization routine
-    # @param [#call] rack chain caller
+    # @param [#call] app rack chain caller
     # @api public
     def initialize(app)
       @app = app
@@ -106,17 +108,23 @@ module Jsus
     # Jsus::Middleware#call method dups current rack app and executes
     # Jsus::Middleware#_call on it.
     #
-    # @param [Hash] rack env
+    # @param [Hash] env rack env
     # @return [#each] rack response
     # @api semipublic
     def _call(env)
+      Jsus.logger.buffer.clear
       path = Utils.unescape(env["PATH_INFO"])
       return @app.call(env) unless handled_by_jsus?(path)
       path.sub!(path_prefix_regex, "")
       components = path.split("/")
       return @app.call(env) unless components.size >= 2
+
+      request_options[:path] = path
       if components[0] == "require"
         generate_requires(components[1])
+      elsif components[0] == "compressed"
+        request_options[:compress] = true
+        generate_requires(components[1])
       elsif components[0] == "include"
         generate_includes(components[1])
       else
@@ -126,7 +134,7 @@ module Jsus
 
     # Rack calling point
     #
-    # @param [Hash] rack env
+    # @param [Hash] env rack env
     # @return [#each] rack response
     # @api public
     def call(env)
@@ -135,16 +143,39 @@ module Jsus
 
     protected
 
+    # Current request options
+    # @return [Hash]
+    def request_options
+      @options ||= {}
+    end # request_options
+
+    # Rack response of not found
+    # @return [#each] 404 response
+    # @api semipublic
+    def not_found!
+      [404, {"Content-Type" => "text/plain"}, ["Jsus doesn't know anything about this entity"]]
+    end # not_found!
+
+    # Respond with given text
+    # @param [String] text text to respond with
+    # @return [#each] 200 response
+    # @api semipublic
+    def respond_with(text)
+      response = formatted_errors + postproc(text)
+      cache_response!(response) if cache?
+      [200, {"Content-Type" => "text/javascript"}, [response]]
+    end # respond_with
+
     # Generates response for /require/ requests.
     #
-    # @param [String] path component to required sources
+    # @param [String] path_string path component to required sources
     # @return [#each] rack response
     # @api semipublic
     def generate_requires(path_string)
       files = path_string_to_files(path_string)
       if !files.empty?
         response = Container.new(*files).map {|f| f.content }.join("\n")
-        cache.write(escape_path_for_cache_key(path_string), response) if cache?
+        response = Jsus::Util::Compressor.new(response).result if request_options[:compress]
         respond_with(response)
       else
         not_found!
@@ -153,7 +184,7 @@ module Jsus
 
     # Generates response for /include/ requests.
     #
-    # @param [String] path component to included sources
+    # @param [String] path_string path component to included sources
     # @return [#each] rack response
     # @api semipublic
     def generate_includes(path_string)
@@ -168,7 +199,7 @@ module Jsus
 
     # Returns list of exlcuded and included source files for given path strings.
     #
-    # @param [String] string with + and ~
+    # @param [String] path_string string with + and ~
     # @return [Hash] hash with source files to include and to exclude
     # @api semipublic
     def path_string_to_files(path_string)
@@ -179,6 +210,26 @@ module Jsus
       files
     end # path_string_to_files
 
+    # Post-processes output (removes different compatibility tags)
+    #
+    # @param [String] source source to post-process
+    # @return [String] post-processed source
+    def postproc(source)
+      Array(self.class.settings[:postproc]).inject(source) do |result, processor|
+        case processor.strip
+        when /^moocompat12$/i
+          result.gsub(/\/\/<1.2compat>.*?\/\/<\/1.2compat>/m, '').
+                 gsub(/\/\*<1.2compat>\*\/.*?\/\*<\/1.2compat>\*\//m, '')
+        when /^mooltie8$/i
+          result.gsub(/\/\/<ltIE8>.*?\/\/<\/ltIE8>/m, '').
+                 gsub(/\/\*<ltIE8>\*\/.*?\/\*<\/ltIE8>\*\//m, '')
+        else
+          Jsus.logger.error "Unknown post-processor: #{processor}"
+          result
+        end
+      end
+    end
+
     # Parses human-readable string with + and ~ operations into a more usable hash.
     # @note + is a space after url decoding
     #
@@ -203,8 +254,9 @@ module Jsus
     end # parse_path_string
 
     # Returns a list of associated files for given source file or source package.
-    # @param [String] canonical source file or source package name or wildcard
-    #    e.g. "Mootools.Core", "Mootools.Core/*", "Mootools.Core/Class", "**/*"
+    # @param [String] source_file_or_package canonical source file or source
+    #    package name or wildcard. E.g. "Mootools.Core", "Mootools.Core/*",
+    #   "Mootools.Core/Class", "**/*"
     # @return [Array] list of source files for given input
     # @api semipublic
     def get_associated_files(source_file_or_package)
@@ -225,24 +277,9 @@ module Jsus
       end
     end # get_associated_files
 
-    # Rack response of not found
-    # @return [#each] 404 response
-    # @api semipublic
-    def not_found!
-      [404, {"Content-Type" => "text/plain"}, ["Jsus doesn't know anything about this entity"]]
-    end # not_found!
-
-    # Respond with given text
-    # @param [String] text to respond with
-    # @return [#each] 200 response
-    # @api semipublic
-    def respond_with(text)
-      [200, {"Content-Type" => "text/javascript"}, [text]]
-    end # respond_with
-
     # Check whether given path is handled by jsus middleware.
     #
-    # @param [String] path
+    # @param [String] path path
     # @return [Boolean]
     # @api semipublic
     def handled_by_jsus?(path)
@@ -283,6 +320,13 @@ module Jsus
       self.class.cache
     end # cache
 
+    # Saves response into the filesystem
+    # @param [String] response text to store
+    # @return [String] filename
+    def cache_response!(response)
+      cache.write(escape_path_for_cache_key(request_options[:path]), response)
+    end # cache_response!
+
     # @return [Boolean] whether pool is shared between requests
     # @api semipublic
     def cache_pool?
@@ -292,11 +336,34 @@ module Jsus
     # You might or might not need to do some last minute conversions for your cache
     # key. Default behaviour is merely a nginx hack, you may have to use your own
     # function for your web-server.
-    # @param [String] request path minus the prefix
+    # @param [String] path request path minus the prefix
     # @return [String] normalized cache key for given request path
     # @api semipublic
     def escape_path_for_cache_key(path)
       path.gsub(" ", "+")
     end # escape_path_for_cache_key
+
+    # Outputs errors in one or multiple ways.
+    # Set middleware setting :log_method to array with a combination of any of the following:
+    #   :alert   -- generates javascript alert with warning text
+    #   :console -- generates console logging entry
+    #   :html    -- injects error / warning messages directly into html body
+    # @return [String] javascript code containing errors output for various methods
+    # @api semipublic
+    def formatted_errors
+      Array(self.class.settings[:log_method]).inject("") do |result, log_method|
+        result << errors.map do |severity, error|
+          case log_method
+            when :alert   then "alert(#{error.inspect});"
+            when :console then "console.log(#{error.inspect});"
+            when :html    then "document.body.innerHTML = '<font color=red>' + #{error.inspect} + '</font><br/>' + document.body.innerHTML;"
+          end
+        end.compact.join("\n") + "\n"
+      end
+    end # formatted_errors
+
+    def errors
+      Jsus.logger.buffer
+    end # errors
   end # class Middleware
 end # module Jsus

data/lib/jsus/package.rb

@@ -14,7 +14,7 @@ module Jsus
     #
     # Creates a package from given directory.
     #
-    # @param [String] path to directory containing a package
+    # @param [String] directory path to directory containing a package
     # @param [Hash] options
     # @option options [Jsus::Pool] :pool which pool the package should belong to.
     # @raise an error when the given directory doesn't contain a package.yml or package.json
@@ -27,6 +27,7 @@ module Jsus
       elsif File.exists?(File.join(directory, 'package.json'))
         self.header           = JSON.load(File.open(File.join(directory, 'package.json'), 'r:utf-8') {|f| f.read })
       else
+        Jsus::Middleware.errors << "Directory #{directory} does not contain a valid package.yml / package.json file!"
         raise "Directory #{directory} does not contain a valid package.yml / package.json file!"
       end
       Dir.chdir(directory) do
@@ -39,7 +40,7 @@ module Jsus
               source_files << source_file
             end
           else
-            puts "Warning: #{source} is not found for #{name}" if Jsus.verbose?
+            Jsus.logger.warn "#{source} is not found for #{name}"
           end
         end
       end
@@ -130,7 +131,7 @@ module Jsus
     end
 
     # Compiles source files and linked external source files into a given category.
-    # @param [String, nil] directory to output the result into
+    # @param [String, nil] directory directory to output the result into
     # @return [String] content of merged source files
     # @api public
     def compile(directory = ".")
@@ -139,8 +140,8 @@ module Jsus
     end
 
     # Generates tree structure for files in package into a json file.
-    # @param [String] directory to output the result
-    # @param [String] resulting filename
+    # @param [String] directory directory to output the result
+    # @param [String] filename resulting filename
     # @return [Hash] hash with tree structure
     # @api public
     def generate_tree(directory = ".", filename = "tree.json")
@@ -162,8 +163,8 @@ module Jsus
     end
 
     # Generates info about resulting compiled package into a json file.
-    # @param [String] directory to output the result
-    # @param [String] resulting filename
+    # @param [String] directory directory to output the result
+    # @param [String] filename resulting filename
     # @return [Hash] hash with scripts info
     # @api public
     def generate_scripts_info(directory = ".", filename = "scripts.json")
@@ -228,13 +229,13 @@ module Jsus
     # Private API
 
 
-    # @param [Hash] parsed header
+    # @param [Hash] new_header parsed header
     # @api private
     def header=(new_header)
       @header = new_header
     end
 
-    # @param [Enumerable] external dependencies
+    # @param [Enumerable] new_value external dependencies
     # @api private
     def linked_external_dependencies=(new_value)
       @linked_external_dependencies = new_value

data/lib/jsus/packager.rb

@@ -12,7 +12,7 @@ module Jsus
     #
     # Inits packager with the given sources.
     #
-    # @param [SourceFile] source files
+    # @param [*SourceFile] sources source files
     # @api public
     def initialize(*sources)
       self.container = Container.new(*sources)
@@ -27,7 +27,7 @@ module Jsus
     # Concatenates all the sources' contents into a single string.
     # If given a filename, outputs into a file.
     #
-    # @param [String, nil] output file name
+    # @param [String, nil] output_file output file name
     # @return [String] concatenated source files
     # @api public
     def pack(output_file = nil)

data/lib/jsus/pool.rb

@@ -12,7 +12,7 @@ module Jsus
     #
     # Basic constructor.
     #
-    # @param [Array, String, nil] directory or list of directories to load source
+    # @param [Array, String, nil] dir_or_dirs directory or list of directories to load source
     #   packages from.
     # @api public
     def initialize(dir_or_dirs = nil)
@@ -49,7 +49,7 @@ module Jsus
     #
     # If given a source file, returns the input.
     #
-    # @param [String, Jsus::Tag, Jsus::SourceFile]
+    # @param [String, Jsus::Tag, Jsus::SourceFile] source_or_key
     # @return [Jsus::SourceFile]
     # @api public
     def lookup(source_or_key)
@@ -70,7 +70,7 @@ module Jsus
     #
     # Looks up for dependencies for given file recursively.
     #
-    # @param [String, Jsus::Tag, Jsus::SourceFile]
+    # @param [String, Jsus::Tag, Jsus::SourceFile] source_or_source_key
     # @return [Jsus::Container] container with all the dependencies
     # @api public
     def lookup_dependencies(source_or_source_key)
@@ -87,7 +87,7 @@ module Jsus
       result.sort!
     end
 
-    # @param [String, Jsus::Tag]
+    # @param [String, Jsus::Tag] tag_or_tag_key
     # @return [Array] array with source files with extensions for given tag.
     # @api public
     def lookup_extensions(tag_or_tag_key)
@@ -98,7 +98,8 @@ module Jsus
     #
     # Pushes an item into a pool.
     #
-    # @param [Jsus::SourceFile, Jsus::Package, Array] items to push
+    # @param [Jsus::SourceFile, Jsus::Package, Array] source_or_sources_or_package
+    #    items to push
     # @return [self]
     # @api public
     def <<(source_or_sources_or_package)
@@ -112,8 +113,8 @@ module Jsus
           extensions_map[source.extends] << source
         else
           source.provides.each do |p|
-            if provides_map[p] && provides_map[p] != source && provides_map[p].filename != source.filename && Jsus.verbose?
-              puts "Redeclared #{p.to_s} in #{source.filename} (previously declared in #{provides_map[p].filename})"
+            if provides_map[p] && provides_map[p] != source && provides_map[p].filename != source.filename
+              Jsus.logger.warn "Redeclared #{p.to_s} in #{source.filename} (previously declared in #{provides_map[p].filename})"
             end
             provides_map[p] = source
           end
@@ -147,7 +148,7 @@ module Jsus
     # You probably will find yourself using #include_dependencies instead.
     # This method caches results locally, use flush_cache! to drop.
     #
-    # @param [String, Jsus::Tag, Jsus::SourceFile]
+    # @param [String, Jsus::Tag, Jsus::SourceFile] source_or_source_key
     # @return [Array] array of direct dependencies for given entity
     # @api private
     def lookup_direct_dependencies(source_or_source_key)
@@ -158,7 +159,7 @@ module Jsus
     #
     # Performs the actual lookup for #lookup_direct_dependencies
     #
-    # @param [String, Jsus::Tag, Jsus::SourceFile]
+    # @param [String, Jsus::Tag, Jsus::SourceFile] source
     # @return [Array] array of direct dependencies for given entity
     # @api private
     def lookup_direct_dependencies!(source)
@@ -166,8 +167,8 @@ module Jsus
 
       source.dependencies.map do |dependency|
         result = provides_tree.glob("/#{dependency}")
-        if (!result || (result.is_a?(Array) && result.empty?)) && Jsus.verbose?
-          puts "#{source.filename} is missing #{dependency.is_a?(SourceFile) ? dependency.filename : dependency.to_s}"
+        if (!result || (result.is_a?(Array) && result.empty?))
+          Jsus.logger.warn "#{source.filename} is missing #{dependency.is_a?(SourceFile) ? dependency.filename : dependency.to_s}"
         end
         result
       end.flatten.map {|tag| lookup(tag) }
@@ -187,7 +188,7 @@ module Jsus
 
 
     # Registers the source in both trees
-    # @param [Jsus::SourceFile]
+    # @param [Jsus::SourceFile] source
     # @api private
     def add_source_to_trees(source)
       if source.package

data/lib/jsus/source_file.rb

@@ -39,7 +39,7 @@ module Jsus
     #
     # Initializes a SourceFile given the filename and options
     #
-    # @param [String]
+    # @param [String] filename
     # @param [Hash] options
     # @option options [Jsus::Pool] :pool owning pool
     # @option options [Jsus::Package] :package owning package
@@ -158,7 +158,7 @@ module Jsus
       extends && !extends.empty?
     end
 
-    # @return [Array] array of included extensions for given source.
+    # @return [Array] new_value array of included extensions for given source.
     # @api public
     def extensions
       @extensions ||= []
@@ -166,7 +166,7 @@ module Jsus
       @extensions
     end
 
-    # @param [Array] list of extensions for given file
+    # @param [Array] new_value list of extensions for given file
     # @api semipublic
     def extensions=(new_value)
       @extensions = new_value
@@ -219,7 +219,7 @@ module Jsus
     end
 
     # Parses header and gets info from it.
-    # @param [String] header content
+    # @param [String] new_header header content
     # @api private
     def header=(new_header)
       @header = new_header
@@ -242,7 +242,7 @@ module Jsus
       end
     end
 
-    # @param [String] file content
+    # @param [String] new_value file content
     # @api private
     def content=(new_value)
       @content = new_value
@@ -261,7 +261,7 @@ module Jsus
       @content
     end
 
-    # @param [Enumerable] list of tags
+    # @param [Enumerable] tag_list list of tags
     # @return [Array] normalized tags list
     # @api private
     def parse_tag_list(tag_list)
@@ -284,7 +284,7 @@ module Jsus
 
     # Assigns an instance of Jsus::Pool to the source file.
     # Also performs push to that pool.
-    # @param [Jsus::Pool]
+    # @param [Jsus::Pool] new_value
     # @api private
     def pool=(new_value)
       @pool = new_value

data/lib/jsus/tag.rb

@@ -32,7 +32,7 @@ module Jsus
     # Between all those, tags b,c,d and e are equal, meaning they all use
     # the same spot in Hash or wherever else.
     #
-    # @param [String] tag name
+    # @param [String] name tag name
     # @param [Hash] options
     # @option options [String] :package_name owner package name
     # @option options [Jsus::Package] :package :owner package

data/lib/jsus/util.rb

@@ -1,11 +1,13 @@
 module Jsus
   # Utility namespace.
   module Util
+    autoload :Compressor,    'jsus/util/compressor'
     autoload :Tree,          'jsus/util/tree'
     autoload :Documenter,    'jsus/util/documenter'
     autoload :Validator,     'jsus/util/validator'
     autoload :Inflection,    'jsus/util/inflection'
     autoload :FileCache,     'jsus/util/file_cache'
     autoload :CodeGenerator, 'jsus/util/code_generator'
+    autoload :Logger,        'jsus/util/logger'
   end # Util
 end # Jsus

data/lib/jsus/util/code_generator.rb

@@ -3,6 +3,7 @@ module Jsus
     # Code generation routines.
     module CodeGenerator
       class <<self
+        # @param [Array] paths list of paths
         # @return [String] javascript for includes for a list of given paths
         # @api public
         def generate_includes(paths)

data/lib/jsus/util/compressor.rb

@@ -0,0 +1,21 @@
+module Jsus
+  module Util
+    class Compressor
+      attr_reader :result
+      def initialize(source, options = {}) # todo - non-java compressor
+        @result = compress_with_yui(source)
+      end # initialize
+
+      def compress_with_yui(source)
+        begin
+          require 'yui/compressor'
+          compressor = YUI::JavaScriptCompressor.new(:munge => true)
+          compressed_content = compressor.compress(source)
+        rescue LoadError
+          Jsus.logger.fatal 'ERROR: You need "yui-compressor" gem in order to use --compress option'
+        end
+        compressed_content
+      end # compress_with_yui
+    end # class Compressor
+  end # module Util
+end # module Jsus

data/lib/jsus/util/documenter.rb

@@ -24,7 +24,7 @@ module Jsus
 
       # Generates documentation tree into the given directory.
       #
-      # @param [String] output directory
+      # @param [String] doc_dir output directory
       # @api public
       def generate(doc_dir = Dir.pwd)
         #FileUtils.rm_rf(doc_dir)
@@ -49,7 +49,7 @@ module Jsus
 
       # Adds a source file to the documented source tree
       #
-      # @param [Jsus::SourceFile] pushed source
+      # @param [Jsus::SourceFile] source pushed source
       # @api public
       def <<(source) # :nodoc:
         filename = File.basename(source.filename)
@@ -88,7 +88,7 @@ module Jsus
 
       # Sets documenter to exclusive scope for documentation.
       # Exclusive scope overrides all the other scopes.
-      # @param [Array, String] documentation scope
+      # @param [Array, String] scope documentation scope
       # @api public
       def only(scope)
         result = clone
@@ -99,7 +99,7 @@ module Jsus
       # Sets documenter to additive scope for documentation.
       # Additive scopes match any of the pathspecs given
       #
-      # @param [Array, String] documentation scope
+      # @param [Array, String] scope documentation scope
       # @api public
       def or(scope)
         result = clone

data/lib/jsus/util/file_cache.rb

@@ -56,11 +56,10 @@ module Jsus
 
       # Generates path by cache key.
       #
-      # Default strategy: append key to cache directory
-      # (slashes are replaced with dots)
+      # Default strategy: relative path references via ../ are escaped.
       # @api private
       def generate_path(key)
-        key = key.gsub(File::SEPARATOR, ".")
+        key = key.gsub(%r{(^|/)\.\./}, ".")
         File.join(@path, key)
       end # generate_path
     end # class FileCache

data/lib/jsus/util/logger.rb

@@ -0,0 +1,35 @@
+require 'logger'
+module Jsus
+  module Util
+    # Extension of ruby logger allowing for message buffering.
+    class Logger < ::Logger
+      module Buffering
+        # Buffer storing logged messages
+        def buffer
+          @buffer ||= []
+        end # buffer
+
+        def buffer=(value)
+          @buffer = value
+        end # buffer=
+
+        def add(severity, message = nil, progname = nil, &block)
+          unless @logdev.nil? or severity < @level
+            if message.nil?
+              if block_given?
+                message = yield
+              else
+                message = progname
+                progname = @progname
+              end
+            end
+            buffer << [severity, message]
+          end
+          super
+        end # add
+      end # module Buffering
+
+      include Buffering
+    end # class Logger
+  end # module Util
+end # module Jsus

data/lib/jsus/util/tree.rb

@@ -57,6 +57,9 @@ module Jsus
         attr_accessor :path_components
 
         # Initializes full path and value for the node
+        # @param [String] full_path full path to node
+        # @param [Object] value
+        # @api public
         def initialize(full_path, value = nil)
           self.full_path = full_path
           self.value = value
@@ -81,7 +84,7 @@ module Jsus
           @children ||= []
         end
 
-        # @param [String] basename
+        # @param [String] name basename
         # @return [Jsus::Util::Tree::Node] direct node child with given basename
         # @api public
         def find_child(name)
@@ -89,7 +92,7 @@ module Jsus
         end
 
         # Creates a child with given name and value
-        # @param [String] node name
+        # @param [String] name node name
         # @param [Object] value
         # @return [Jsus::Util::Tree::Node]
         # @api public

data/lib/jsus/util/validator/base.rb

@@ -18,7 +18,8 @@ module Jsus
         end
         alias_method :sources, :source_files
 
-        # @param [Jsus::Pool, Jsus::Container, Array] source files for validation
+        # @param [Jsus::Pool, Jsus::Container, Array] pool_or_array_or_container
+        #    source files for validation
         # @api public
         def source_files=(pool_or_array_or_container)
           case pool_or_array_or_container
@@ -45,7 +46,7 @@ module Jsus
         end
 
         # Shortcut for creating and validating a list of items
-        # @param [*Array] args for #new
+        # @param [*Array] args passed to #new
         # @api public
         def self.validate(*args)
           new(*args).validate

data/spec/data/ComplexDependencies/Mootools/Source/Core.js

@@ -13,4 +13,12 @@ authors:
 provides: [Core]
 
 ...
-*/
+*/
+
+//<ltIE8>
+var IE7 = true;
+//</ltIE8>
+
+//<1.2compat>
+var compatibilityMode = true;
+//</1.2compat>

data/spec/data/MissingDependencies/Source/Widget.js

@@ -0,0 +1,17 @@
+/*
+---
+
+script: Widget.js
+
+description: An abstract class for all your widgets out there.
+
+license: MIT-style license
+
+authors:
+- Mark Abramov
+
+requires: [MissingDependency]
+provides: [Widget]
+
+...
+*/

data/spec/data/MissingDependencies/package.yml

@@ -0,0 +1,9 @@
+name: Package
+filename: package.js
+web: http://github.com/jsus/jsus
+description: "Package with a missing dependency, raises an error"
+license: MIT-Style License, http://mootools.net/license
+copyright: "Mark Abramov"
+authors: "Mark Abramov"
+sources:
+  - "Source/Widget.js"

data/spec/jsus/middleware_spec.rb

@@ -7,6 +7,8 @@ describe Jsus::Middleware do
   def new_server
     Sinatra.new do
       use Jsus::Middleware
+      Jsus.logger  = Jsus::Util::Logger.new('/dev/null')
+      Jsus.verbose = true
       set :port, 4567
       set :raise_errors, true
       set :show_exceptions, false
@@ -24,6 +26,7 @@ describe Jsus::Middleware do
   before(:all) do
     @server = new_server
     @server_thread = Thread.new { suppress_output { @server.run! } }
+    Jsus::Middleware.settings = {:cache_pool => false}
   end
 
   after(:all) { @server_thread.kill }
@@ -256,14 +259,85 @@ describe Jsus::Middleware do
   end
 
   describe "caching" do
+    let(:packages_dir) { File.expand_path("spec/data/ComplexDependencies") }
     let(:cache_path) { "spec/tmp" }
-    before(:each) { Jsus::Middleware.settings = {:cache => true, :cache_path => cache_path} }
+    before(:each) { Jsus::Middleware.settings = {:cache => true, :cache_path => cache_path, :packages_dir => packages_dir} }
     after(:each) { FileUtils.rm_rf(cache_path) }
     let(:path) { "/javascripts/jsus/require/Package.js" }
     it "should save output of requests to files" do
       result = get(path).body
-      File.exists?("#{cache_path}/Package.js").should be_true
-      File.read("#{cache_path}/Package.js").should == result
+      File.exists?("#{cache_path}/require/Package.js").should be_true
+      File.read("#{cache_path}/require/Package.js").should == result
+    end
+
+    it "should not allow relative file paths hacks" do
+      FileUtils.rm_f("/tmp/testzor")
+      new_path = path + "/../../../../../../../../../../../../../../../tmp/testzor"
+      result = get(new_path).body
+      File.exists?("/tmp/testzor").should be_false
     end
   end
+
+  describe "post processing" do
+    let(:packages_dir) { File.expand_path("spec/data/ComplexDependencies") }
+    before(:each) { Jsus::Middleware.settings = {:packages_dir => packages_dir} }
+    let("path") { "/javascripts/jsus/require/Package.js" }
+    it "should not do anything if postprocs setting is empty" do
+      Jsus::Middleware.settings = {:postproc => []}
+      get(path).body.should include("//<ltIE8>")
+    end
+
+    it "should not do anything if postprocs setting is nil" do
+      Jsus::Middleware.settings = {:postproc => nil}
+      get(path).body.should include("//<ltIE8>")
+    end
+
+    it "should remove <ltIE8> tags if postproc setting contains mooltIE8" do
+      get(path).body.should include("//<ltIE8>")
+      Jsus::Middleware.settings = {:postproc => "mooltIE8"}
+      get(path).body.should_not include("//<ltIE8>")
+    end
+
+    it "should remove <1.2compat> tags if postproc setting contains moocompat12" do
+      get(path).body.should include("//<1.2compat>")
+      Jsus::Middleware.settings = {:postproc => "moocompat12"}
+      get(path).body.should_not include("//<1.2compat>")
+    end
+  end # describe "post processing"
+
+  describe "errors logging" do
+    let(:packages_dir) { File.expand_path("spec/data/MissingDependencies") }
+    before(:each) { Jsus::Middleware.settings = {:packages_dir => packages_dir} }
+
+    let(:path) { "/javascripts/jsus/require/Package.js" }
+    context "by default" do
+      it "should not output errors" do
+        output = get(path).body
+        output.should_not include("console.log")
+        output.should_not include("alert")
+        output.should_not include("document.body.innerHTML")
+      end
+    end # context "by default"
+
+    context "with console log method" do
+      before(:each) { Jsus::Middleware.settings = {:log_method => [:console] } }
+      it "should output errors to js console" do
+        get(path).body.should include("console.log")
+      end
+    end # context "with console log method"
+
+    context "with alert method" do
+      before(:each) { Jsus::Middleware.settings = {:log_method => [:alert] } }
+      it "should output errors via js alerts" do
+        get(path).body.should include("alert")
+      end
+    end # context "with console log method"
+
+    context "with html method" do
+      before(:each) { Jsus::Middleware.settings = {:log_method => [:html] } }
+      it "should output errors via html modification" do
+        get(path).body.should include("document.body.innerHTML")
+      end
+    end # context "with console log method"
+  end # describe "errors logging"
 end

data/spec/jsus/util/file_cache_spec.rb

@@ -20,6 +20,13 @@ describe Jsus::Util::FileCache do
       fn = subject.write(key, value)
       File.exists?("/tmp/test").should be_false
     end
+
+    it "should allow creation of subfolders" do
+      key = "test/hello"
+      fn = subject.write(key, value)
+      File.exists?("#{cache_dir}/#{key}").should be_true
+      File.read("#{cache_dir}/#{key}").should == value
+    end
   end
 
   describe "#read" do
@@ -37,6 +44,11 @@ describe Jsus::Util::FileCache do
       File.open("/tmp/test", "w+") {|f| f.puts "Hello, world!" }
       subject.read(key).should == nil
     end
+
+    it "should allow to read from subfolders" do
+      fn = subject.write("test/hello", value)
+      subject.read("test/hello").should == fn
+    end
   end
 
   describe "#fetch" do

data/spec/jsus/util/logger_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Jsus::Util::Logger do
+  subject { described_class.new("/dev/null") }
+
+  context "buffering" do
+    it "should store incoming messages in the buffer" do
+      subject.info "Something happened"
+      subject.buffer.should == [[Logger::INFO, "Something happened"]]
+    end
+
+    it "should not store messages not crossing the threshold" do
+      subject.level = Logger::FATAL
+      subject.info "Something happened"
+      subject.buffer.should == []
+    end
+
+    it "should allow block form logging" do
+      subject.info { "Something happened" }
+      subject.buffer.should == [[Logger::INFO, "Something happened"]]
+    end
+  end # context "buffering"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jsus
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Mark Abramov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-19 00:00:00 +04:00
+date: 2011-08-30 00:00:00 +04:00
 default_executable: jsus
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -325,9 +325,11 @@ files:
 - lib/jsus/tag.rb
 - lib/jsus/util.rb
 - lib/jsus/util/code_generator.rb
+- lib/jsus/util/compressor.rb
 - lib/jsus/util/documenter.rb
 - lib/jsus/util/file_cache.rb
 - lib/jsus/util/inflection.rb
+- lib/jsus/util/logger.rb
 - lib/jsus/util/tree.rb
 - lib/jsus/util/validator.rb
 - lib/jsus/util/validator/base.rb
@@ -387,6 +389,8 @@ files:
 - spec/data/JsonPackage/Source/SheetParser.CSS.js
 - spec/data/JsonPackage/Source/sg-regex-tools.js
 - spec/data/JsonPackage/package.json
+- spec/data/MissingDependencies/Source/Widget.js
+- spec/data/MissingDependencies/package.yml
 - spec/data/MooforgeValidation/README
 - spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/InvalidNoAuthors.js
 - spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/InvalidNoLicense.js
@@ -421,6 +425,7 @@ files:
 - spec/jsus/util/documenter_spec.rb
 - spec/jsus/util/file_cache_spec.rb
 - spec/jsus/util/inflection_spec.rb
+- spec/jsus/util/logger_spec.rb
 - spec/jsus/util/tree_spec.rb
 - spec/jsus/util/validator/base_spec.rb
 - spec/jsus/util/validator/mooforge_spec.rb