jsus 0.2.5 → 0.2.6

data/CHANGELOG

@@ -1,4 +1,8 @@
 = Jsus Changelog
+== Version 0.2.6
+* Moved support classes to Jsus::Util module namespace
+* Now using autoload instead of require's for stuff
+
 == Version 0.2.5
 * Fixed Container#sort not dealing with wildcards, which made it slower but
   at least made it work
@@ -17,7 +21,7 @@ See jsus-examples repo or features dir for more information.
 * Minor CLI reworkings:
   * Deprecated -i and -o options (use plain arguments now)
   * Restored generate-includes customizable root option
-  
+
 == Version 0.2.2
 * Fixed dupes in structure json files
 
@@ -66,7 +70,7 @@ See jsus-examples repo or features dir for more information.
   First robust solution handles this via Pool and eager dependency load.
 
 == Version 0.1.5
-* Introduced new concept, Tag, which is going to be used instead of 
+* Introduced new concept, Tag, which is going to be used instead of
   provides/requires strings
 * Introduced source extensions (monkey-patching, actually)
 * Wrote some basic documentation for the classes

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.6

data/bin/jsus

@@ -1,10 +1,19 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 
-if File.exists?('./lib/jsus.rb')  # override with local version of jsus
-  $:.unshift File.expand_path(Dir.pwd) + "/lib"
-elsif File.exists?(File.expand_path(File.dirname(__FILE__)) + "/../lib/jsus.rb")
-  $:.unshift File.expand_path(File.dirname(__FILE__)) + "/../lib"
+require 'pathname'
+begin
+  gem_home = Pathname.new(ENV["GEM_HOME"]).realpath.to_s
+  current_dir = File.dirname(Pathname.new(__FILE__).realpath.to_s)
+  if current_dir.index(gem_home) != 0 && File.exists?(current_dir + '/../lib/jsus.rb')
+    # If we are outside gem home,
+    # override whatever they got there
+    # with local version of jsus
+    $:.unshift File.expand_path(current_dir + "/../lib")
+  end
+rescue Exception => e
+  # Something weird happened during our checks,
+  # but it's probably nothing.
 end
 require 'jsus'
 
@@ -129,7 +138,7 @@ package.generate_scripts_info(output_dir) unless options[:without_scripts_info]
 package.generate_tree(output_dir) unless options[:without_tree_info]
 
 # Validations
-validators_map = {"mooforge" => Jsus::Validator::Mooforge}
+validators_map = {"mooforge" => Jsus::Util::Validator::Mooforge}
 (options[:validators] || []).each do |validator_name|
   if validator = validators_map[validator_name]
     errors = validator.new(pool.sources.to_a & package.source_files.to_a).validation_errors
@@ -164,7 +173,7 @@ end
 docs_start_time = Time.now
 # Generate documentation
 if options[:documented_classes] && !options[:documented_classes].empty?
-  documenter = Jsus::Documenter.new(:highlight_source => !options[:no_syntax_highlight])
+  documenter = Jsus::Util::Documenter.new(:highlight_source => !options[:no_syntax_highlight])
   package.source_files.each {|source| documenter << source }
   pool.sources.each {|source| documenter << source } if pool
   documenter.only(options[:documented_classes]).generate(output_dir + "/docs")

data/jsus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jsus}
-  s.version = "0.2.5"
+  s.version = "0.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Abramov"]
-  s.date = %q{2011-03-04}
+  s.date = %q{2011-03-07}
   s.default_executable = %q{jsus}
   s.description = %q{Javascript packager and dependency resolver}
   s.email = %q{markizko@gmail.com}
@@ -84,16 +84,17 @@ Gem::Specification.new do |s|
     "jsus.gemspec",
     "lib/jsus.rb",
     "lib/jsus/container.rb",
-    "lib/jsus/documenter.rb",
     "lib/jsus/package.rb",
     "lib/jsus/packager.rb",
     "lib/jsus/pool.rb",
     "lib/jsus/source_file.rb",
     "lib/jsus/tag.rb",
-    "lib/jsus/tree.rb",
-    "lib/jsus/validator.rb",
-    "lib/jsus/validator/base.rb",
-    "lib/jsus/validator/mooforge.rb",
+    "lib/jsus/util.rb",
+    "lib/jsus/util/documenter.rb",
+    "lib/jsus/util/tree.rb",
+    "lib/jsus/util/validator.rb",
+    "lib/jsus/util/validator/base.rb",
+    "lib/jsus/util/validator/mooforge.rb",
     "markup/index_template.haml",
     "markup/stylesheet.css",
     "markup/template.haml",
@@ -162,15 +163,15 @@ Gem::Specification.new do |s|
     "spec/data/bad_test_source_two.js",
     "spec/data/test_source_one.js",
     "spec/jsus/container_spec.rb",
-    "spec/jsus/documenter_spec.rb",
     "spec/jsus/package_spec.rb",
     "spec/jsus/packager_spec.rb",
     "spec/jsus/pool_spec.rb",
     "spec/jsus/source_file_spec.rb",
     "spec/jsus/tag_spec.rb",
-    "spec/jsus/tree_spec.rb",
-    "spec/jsus/validator/base_spec.rb",
-    "spec/jsus/validator/mooforge_spec.rb",
+    "spec/jsus/util/documenter_spec.rb",
+    "spec/jsus/util/tree_spec.rb",
+    "spec/jsus/util/validator/base_spec.rb",
+    "spec/jsus/util/validator/mooforge_spec.rb",
     "spec/shared/class_stubs.rb",
     "spec/spec_helper.rb"
   ]
@@ -181,15 +182,15 @@ Gem::Specification.new do |s|
   s.summary = %q{Javascript packager and dependency resolver}
   s.test_files = [
     "spec/jsus/container_spec.rb",
-    "spec/jsus/documenter_spec.rb",
     "spec/jsus/package_spec.rb",
     "spec/jsus/packager_spec.rb",
     "spec/jsus/pool_spec.rb",
     "spec/jsus/source_file_spec.rb",
     "spec/jsus/tag_spec.rb",
-    "spec/jsus/tree_spec.rb",
-    "spec/jsus/validator/base_spec.rb",
-    "spec/jsus/validator/mooforge_spec.rb",
+    "spec/jsus/util/documenter_spec.rb",
+    "spec/jsus/util/tree_spec.rb",
+    "spec/jsus/util/validator/base_spec.rb",
+    "spec/jsus/util/validator/mooforge_spec.rb",
     "spec/shared/class_stubs.rb",
     "spec/spec_helper.rb"
   ]

data/lib/jsus.rb

@@ -10,32 +10,32 @@ require 'rgl/topsort'
 require 'fileutils'
 require 'pathname'
 
-require 'jsus/source_file'
-require 'jsus/package'
-require 'jsus/tag'
-require 'jsus/container'
-require 'jsus/packager'
-require 'jsus/pool'
-require 'jsus/tree'
-require 'jsus/documenter'
-require 'jsus/validator'
 #
-# Jsus — a library for packaging up your source files.
+# Jsus -- a library for packaging up your source files.
 #
 # For better understanding of jsus ideas start with http://github.com/Markiz/jsus-examples
 #
 #
-
-
 module Jsus
+  autoload :SourceFile, 'jsus/source_file'
+  autoload :Package,    'jsus/package'
+  autoload :Tag,        'jsus/tag'
+  autoload :Container,  'jsus/container'
+  autoload :Packager,   'jsus/packager'
+  autoload :Pool,       'jsus/pool'
+  autoload :Util,       'jsus/util'
+  # Returns whether or not jsus is in verbose mode
   def self.verbose?
     !!@verbose
   end
 
+  # Sets verbose mode to on. In verbose mode jsus shows a lot of warnings
+  # like missing dependencies.
   def self.verbose=(verbose)
     @verbose = verbose
   end
-  
+
+  # Returns current version
   def self.version
     @version ||= File.read(File.dirname(__FILE__) + "/../VERSION")
   end

data/lib/jsus/container.rb

@@ -1,9 +1,9 @@
-#
-# Container is an array which contains source files. Main difference
-# between it and array is the fact that container maintains topological
-# sort for the source files.
-#
 module Jsus
+  #
+  # Container is an array that contains source files. Main difference
+  # from an array is the fact that container maintains topological
+  # sort for the source files.
+  #
   class Container
     #
     # Every argument for initializer is pushed into the container.
@@ -35,7 +35,9 @@ module Jsus
       map {|item| item.respond_to?(:flatten) ? item.flatten : item }.flatten
     end
 
-    # Contains the source files in the correct order.
+    # Contains the source files. Please, don't use sources directly, if you
+    # depend on them to be topologically sorted. Use collection methods like
+    # inject/reject/map directly on the container instead.
     def sources
       @sources ||= []
     end
@@ -86,8 +88,11 @@ module Jsus
       # init edges
       items.each do |item|
         item.dependencies.each do |dependency|
-          cache[dependency] ||= provides_tree.glob("/" + dependency.to_s).map {|node| node.value }
-          cache[dependency].each do |required_item|
+          # If we can find items that provide the required dependency...
+          # (dependency could be a wildcard as well, hence items)
+          dependency_cache[dependency] ||= provides_tree.glob(dependency)
+          # ... we draw an edge from every required item to the dependant item
+          dependency_cache[dependency].each do |required_item|
             graph.add_edge(required_item, item)
           end
         end
@@ -97,50 +102,47 @@ module Jsus
       result
     end
 
-    def cache # :nodoc:
-      @cache ||= {}
+    def dependency_cache # :nodoc:
+      @dependency_cache ||= {}
     end
 
     def provides_tree # :nodoc:
       @provides_tree ||= provides_tree!
     end
 
+    # Provides tree contains
     def provides_tree! # :nodoc:
-      tree = Tree.new
+      tree = Util::Tree.new
       # Provisions
       sources.each do |file|
         file.provides.each do |tag|
-          tree["/#{tag}"] = file
+          tree[tag] = file
         end
       end
       # Replacements
       sources.each do |file|
         if file.replaces
-          tree["/#{file.replaces}"] = file
+          tree[file.replaces] = file
         end
       end
       tree
     end
 
-    def remove_replaced_files!
+    def remove_replaced_files! # :nodoc:
       sources.reject! do |sf|
-        !sf.provides.empty? && sf.provides.any? { |tag|
-          replacements_tree["/#{tag}"] &&
-          replacements_tree["/#{tag}"].value &&
-          replacements_tree["/#{tag}"].value != sf
-        }
+        !sf.provides.empty? && sf.provides.any? { |tag| replacements_tree[tag] && replacements_tree[tag] != sf }
       end
     end
 
-    def replacements_tree
+    def replacements_tree # :nodoc:
       @replacements_tree ||= replacements_tree!
     end
 
-    def replacements_tree!
-      tree = Tree.new
+    def replacements_tree! # :nodoc:
+      tree = Util::Tree.new
       sources.each do |file|
         if file.replaces
-          tree["/#{file.replaces}"] = file
+          tree[file.replaces] = file
         end
       end
       tree
@@ -149,19 +151,20 @@ module Jsus
     def clear_cache! # :nodoc:
       @provides_tree = nil
       @replacements_tree = nil
-      @cache = nil
-      @sorted = nil
+      @dependency_cache = nil
+      @sorted = false
     end
 
 
     CACHE_CLEAR_METHODS = [
-      "map!", "reject!", "inject!"
+      "map!", "reject!", "inject!", "collect!", "delete", "delete_at"
     ] # :nodoc:
 
     DELEGATED_METHODS = [
       "==", "to_a", "map", "map!", "each", "inject", "inject!",
-      "reject", "reject!", "detect", "size", "length", "[]",
-      "empty?", "index", "include?", "select", "-", "+", "|", "&"
+      "collect", "collect!", "reject", "reject!", "detect", "size", 
+      "length", "[]", "empty?", "index", "include?", "select", 
+      "delete_if", "delete", "-", "+", "|", "&"
     ] # :nodoc:
     # delegates most Enumerable methods to #sources
     (DELEGATED_METHODS).each do |m|

data/lib/jsus/package.rb

@@ -1,9 +1,8 @@
-#
-# Package is basically a list of source files with some meta info.
-#
-
-
 module Jsus
+  #
+  # Package is a (self-contained) unit with all the info required to build
+  # a javascript package.
+  #
   class Package
     attr_accessor :directory # directory which this package resides in (full path)
     attr_accessor :pool      # an instance of Pool
@@ -13,7 +12,7 @@ module Jsus
     # Creates a package from given directory.
     #
     # Accepts options:
-    # * +:pool:+ — which pool the package should belong to.
+    # * +:pool:+ -- which pool the package should belong to.
     #
     # Raises an error when the given directory doesn't contain a package.yml or package.json
     # file with meta info.

data/lib/jsus/packager.rb

@@ -1,10 +1,10 @@
-#
-# Packager is a plain simple class accepting several source files 
-# and joining their contents.
-#
-# It uses Container for storage which means it automatically sorts sources.
-#
 module Jsus
+  #
+  # Packager is a plain simple class accepting several source files 
+  # and joining their contents.
+  #
+  # It uses Container for storage which means it automatically sorts sources.
+  #
   class Packager
     attr_accessor :container  # :nodoc:
 

data/lib/jsus/pool.rb

@@ -1,13 +1,10 @@
-#
-# Pool class is designed for three purposes:
-# * Maintain connections between SourceFiles and/or Packages
-# * Resolve dependencies
-# * Look up extensions
-#
-#
-
-
 module Jsus
+  #
+  # Pool class is designed for three purposes:
+  # * Maintain connections between SourceFiles and/or Packages
+  # * Resolve dependencies
+  # * Look up extensions
+  #
   class Pool
 
     # Constructors
@@ -160,7 +157,7 @@ module Jsus
       return [] unless source
 
       source.dependencies.map do |dependency|
-        result = provides_tree.glob("/#{dependency}").map {|node| node.value }
+        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}"
         end
@@ -172,14 +169,14 @@ module Jsus
     # Returs a tree, containing all the sources
     #
     def source_tree
-      @source_tree ||= Tree.new
+      @source_tree ||= Util::Tree.new
     end
 
     #
     # Returns a tree containing all the provides tags
     #
     def provides_tree
-      @provides_tree ||= Tree.new
+      @provides_tree ||= Util::Tree.new
     end
 
 

data/lib/jsus/source_file.rb

@@ -1,12 +1,12 @@
-#
-# SourceFile is a base for any Jsus operation.
-# 
-# It contains basic info about source as well as file content.
-#
-#
 module Jsus
+  # Generic exception for 'bad' source files (no yaml header, for example)
   class BadSourceFileException < Exception; end
   
+  #
+  # SourceFile is a base for any Jsus operation.
+  # 
+  # It contains basic info about source as well as file content.
+  #
   class SourceFile
     attr_accessor :relative_filename, :filename, :package # :nodoc:
     # Constructors
@@ -16,11 +16,11 @@ module Jsus
     # You probably should use SourceFile.from_file instead.
     #
     # But if you know what you are doing, it accepts the following values:
-    # * +package+ — an instance of Package, normally passed by a parent
-    # * +relative_filename+ — used in Package, for generating tree structure of the source files
-    # * +filename+ — full filename for the given package
-    # * +content+ — file content of the source file
-    # * +pool+ — an instance of Pool
+    # * +package+ -- an instance of Package, normally passed by a parent
+    # * +relative_filename+ -- used in Package, for generating tree structure of the source files
+    # * +filename+ -- full filename for the given package
+    # * +content+ -- file content of the source file
+    # * +pool+ -- an instance of Pool
     def initialize(options = {})
       [:package, :header, :relative_filename, :filename, :content, :pool].each do |field|
         send("#{field}=", options[field]) if options[field]
@@ -31,8 +31,8 @@ module Jsus
     # Initializes a SourceFile given the filename and options
     # 
     # options:
-    # * <tt>:pool:</tt> — an instance of Pool
-    # * <tt>:package:</tt> — an instance of Package
+    # * <tt>:pool:</tt> -- an instance of Pool
+    # * <tt>:package:</tt> -- an instance of Package
     #
     # returns either an instance of SourceFile or nil when it's not possible to parse the input
     #
@@ -89,7 +89,7 @@ module Jsus
     #
     # Returns an array with names of dependencies. Unordered.
     # Accepts options:
-    # * <tt>:short:</tt> — whether inner dependencies should not prepend package name
+    # * <tt>:short:</tt> -- whether inner dependencies should not prepend package name
     #   e.g. 'Class' instead of 'Core/Class' when in package 'Core').
     #   Doesn't change anything for external dependencies
     #
@@ -122,7 +122,7 @@ module Jsus
     # 
     # Returns an array with provides names. 
     # Accepts options:
-    # * <tt>:short:</tt> — whether provides should not prepend package name
+    # * <tt>:short:</tt> -- whether provides should not prepend package name
     #   e.g. 'Class' instead of 'Core/Class' when in package 'Core')
     def provides_names(options = {})
       provides.map {|p| p.name(options)}