jsus 0.1.6 → 0.1.7

data/CHANGELOG

@@ -1,4 +1,10 @@
 = Jsus Changelog
+== Version 0.1.7
+* Added caching to Jsus::Pool#lookup_direct_dependencies. This addresses some performance
+  issues appeared in 0.1.6
+* Added --benchmark flag to jsus which shows total compile and total execution time
+* Added --generate-includes option to jsus. If enabled, generates a set of includes into
+  includes.js file.
 == Version 0.1.6
 * Fixed an issue with jsus not including internal dependencies for external dependencies.
   First robust solution handles this via Pool and eager dependency load.

data/Manifest

@@ -63,5 +63,4 @@ spec/lib/jsus/pool_spec.rb
 spec/lib/jsus/source_file_spec.rb
 spec/lib/jsus/tag_spec.rb
 spec/shared/class_stubs.rb
-spec/spec.opts
 spec/spec_helper.rb

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'rake'
 require 'echoe'
-Echoe.new('jsus', '0.1.6') do |g|
+Echoe.new('jsus', '0.1.7') do |g|
   g.description    = "Packager/compiler for js-files that resolves dependencies and can compile everything into one file, providing all the neccessary meta-info."
   g.url            = "http://github.com/markiz/jsus"
   g.author         = "Markiz, idea by Inviz (http://github.com/Inviz)"

data/TODO

@@ -1,5 +1,2 @@
-* External dependencies mechanism
 * Disallow circular dependencies
-* Package extensions (e.g. package Core.ext that would be able to extend package Core)
-* Rails integration
-* Documentation, RDocs
+* Rails integration

data/bin/jsus

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 require 'jsus'
+start_time = Time.now
 require 'choice'
 
 
@@ -36,16 +37,55 @@ Choice.options do
          "with tree structure of your package."
   end
 
+  option "generate_includes", :required => false do
+    short "-g"
+    long  "--generate-includes=[ROOT]"
+    desc  "Generates includes.js file that you may use for ad-hoc requiring" <<
+          "of the needed javascripts. Defaults to output_directory."
+  end
+
+  option "benchmark", :required => false do
+    long "--benchmark"
+    short "-b"
+    desc "Performs a benchmark, indicating how much time you needed to" <<
+         "compile the package"
+  end
+
 end
 
 
 pool = if Choice.choices[:dependencies]
   Jsus::Pool.new(Choice.choices[:dependencies])
 end
+compile_start_time = Time.now
 package = Jsus::Package.new(Choice.choices[:input_directory], :pool => pool)
 package.include_dependencies! if Choice.choices[:dependencies]
 package.include_extensions! if Choice.choices[:dependencies]
 output_directory = Choice.choices[:output_directory]
 package.compile(output_directory)
 package.generate_scripts_info(output_directory) unless Choice.choices[:without_scripts_info]
-package.generate_tree(output_directory) unless Choice.choices[:without_tree]
+package.generate_tree(output_directory) unless Choice.choices[:without_tree]
+
+
+# Hack, hack, hack :[
+if Choice.choices[:generate_includes]
+  root = Choice.choices[:generate_includes] == true ? Choice.choices[:output_directory] : Choice.choices[:generate_includes]
+  File.open(File.join(Choice.choices[:output_directory], "includes.js"), "w") do |f|
+    c = Jsus::Container.new(*(package.source_files.to_a + package.linked_external_dependencies.to_a))
+    script = %{(function(prefix) {
+      var sources = %sources%;
+      for (var i = 0, j = sources.length; i < j; i++) document.write('<scr' + 'ipt src="' + (prefix || '') + sources[i] + "></script>");
+    })(window.prefix);}.sub("%sources%", JSON.pretty_generate(c.required_files(root)))
+    f.puts script
+  end
+end
+
+
+
+finish_time = Time.now
+
+
+if Choice.choices[:benchmark]
+  puts "Total execution time:   #{(finish_time - start_time).round(3)}s"
+  puts "Total compilation time: #{(finish_time - compile_start_time).round(3)}s"
+end

data/jsus.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jsus}
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Markiz, idea by Inviz (http://github.com/Inviz)"]
-  s.date = %q{2010-08-25}
+  s.date = %q{2010-08-30}
   s.default_executable = %q{jsus}
   s.description = %q{Packager/compiler for js-files that resolves dependencies and can compile everything into one file, providing all the neccessary meta-info.}
   s.email = %q{markizko@gmail.com}
   s.executables = ["jsus"]
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "TODO", "bin/jsus", "lib/jsus.rb", "lib/jsus/container.rb", "lib/jsus/package.rb", "lib/jsus/packager.rb", "lib/jsus/pool.rb", "lib/jsus/source_file.rb", "lib/jsus/tag.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "TODO", "bin/jsus", "jsus.gemspec", "lib/jsus.rb", "lib/jsus/container.rb", "lib/jsus/package.rb", "lib/jsus/packager.rb", "lib/jsus/pool.rb", "lib/jsus/source_file.rb", "lib/jsus/tag.rb", "spec/data/Basic/README", "spec/data/Basic/app/javascripts/Orwik/Source/Library/Color.js", "spec/data/Basic/app/javascripts/Orwik/Source/Widget/Input/Input.Color.js", "spec/data/Basic/app/javascripts/Orwik/Source/Widget/Input/Input.js", "spec/data/Basic/app/javascripts/Orwik/Source/Widget/Widget.js", "spec/data/Basic/app/javascripts/Orwik/package.yml", "spec/data/ChainDependencies/app/javascripts/Class/Source/Class.js", "spec/data/ChainDependencies/app/javascripts/Class/package.yml", "spec/data/ChainDependencies/app/javascripts/Hash/Source/Hash.js", "spec/data/ChainDependencies/app/javascripts/Hash/package.yml", "spec/data/ChainDependencies/app/javascripts/Mash/Source/Mash.js", "spec/data/ChainDependencies/app/javascripts/Mash/package.yml", "spec/data/Extensions/app/javascripts/Core/Source/Class.js", "spec/data/Extensions/app/javascripts/Core/package.yml", "spec/data/Extensions/app/javascripts/Orwik/Extensions/Class.js", "spec/data/Extensions/app/javascripts/Orwik/package.yml", "spec/data/ExternalDependencies/app/javascripts/Orwik/Source/Test.js", "spec/data/ExternalDependencies/app/javascripts/Orwik/package.yml", "spec/data/ExternalInternalDependencies/Core/Class/Source/Class.js", "spec/data/ExternalInternalDependencies/Core/Class/Source/Type.js", "spec/data/ExternalInternalDependencies/Core/Class/package.yml", "spec/data/ExternalInternalDependencies/Core/Hash/Source/Hash.js", "spec/data/ExternalInternalDependencies/Core/Hash/package.yml", "spec/data/ExternalInternalDependencies/Core/Mash/Source/Mash.js", "spec/data/ExternalInternalDependencies/Core/Mash/package.yml", "spec/data/ExternalInternalDependencies/Test/Source/Library/Color.js", "spec/data/ExternalInternalDependencies/Test/Source/Widget/Input/Input.Color.js", "spec/data/ExternalInternalDependencies/Test/Source/Widget/Input/Input.js", "spec/data/ExternalInternalDependencies/Test/Source/Widget/Widget.js", "spec/data/ExternalInternalDependencies/Test/package.yml", "spec/data/OutsideDependencies/README", "spec/data/OutsideDependencies/app/javascripts/Core/Source/Class/Class.Extras.js", "spec/data/OutsideDependencies/app/javascripts/Core/Source/Class/Class.js", "spec/data/OutsideDependencies/app/javascripts/Core/Source/Native/Hash.js", "spec/data/OutsideDependencies/app/javascripts/Core/package.yml", "spec/data/OutsideDependencies/app/javascripts/Orwik/Source/Library/Color.js", "spec/data/OutsideDependencies/app/javascripts/Orwik/Source/Widget/Input/Input.Color.js", "spec/data/OutsideDependencies/app/javascripts/Orwik/Source/Widget/Input/Input.js", "spec/data/OutsideDependencies/app/javascripts/Orwik/Source/Widget/Widget.js", "spec/data/OutsideDependencies/app/javascripts/Orwik/package.yml", "spec/data/bad_test_source_one.js", "spec/data/bad_test_source_two.js", "spec/data/test_source_one.js", "spec/lib/jsus/container_spec.rb", "spec/lib/jsus/package_spec.rb", "spec/lib/jsus/packager_spec.rb", "spec/lib/jsus/pool_spec.rb", "spec/lib/jsus/source_file_spec.rb", "spec/lib/jsus/tag_spec.rb", "spec/shared/class_stubs.rb", "spec/spec.opts", "spec/spec_helper.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "TODO", "bin/jsus", "lib/jsus.rb", "lib/jsus/container.rb", "lib/jsus/package.rb", "lib/jsus/packager.rb", "lib/jsus/pool.rb", "lib/jsus/source_file.rb", "lib/jsus/tag.rb", "spec/data/Basic/README", "spec/data/Basic/app/javascripts/Orwik/Source/Library/Color.js", "spec/data/Basic/app/javascripts/Orwik/Source/Widget/Input/Input.Color.js", "spec/data/Basic/app/javascripts/Orwik/Source/Widget/Input/Input.js", "spec/data/Basic/app/javascripts/Orwik/Source/Widget/Widget.js", "spec/data/Basic/app/javascripts/Orwik/package.yml", "spec/data/ChainDependencies/app/javascripts/Class/Source/Class.js", "spec/data/ChainDependencies/app/javascripts/Class/package.yml", "spec/data/ChainDependencies/app/javascripts/Hash/Source/Hash.js", "spec/data/ChainDependencies/app/javascripts/Hash/package.yml", "spec/data/ChainDependencies/app/javascripts/Mash/Source/Mash.js", "spec/data/ChainDependencies/app/javascripts/Mash/package.yml", "spec/data/Extensions/app/javascripts/Core/Source/Class.js", "spec/data/Extensions/app/javascripts/Core/package.yml", "spec/data/Extensions/app/javascripts/Orwik/Extensions/Class.js", "spec/data/Extensions/app/javascripts/Orwik/package.yml", "spec/data/ExternalDependencies/app/javascripts/Orwik/Source/Test.js", "spec/data/ExternalDependencies/app/javascripts/Orwik/package.yml", "spec/data/ExternalInternalDependencies/Core/Class/Source/Class.js", "spec/data/ExternalInternalDependencies/Core/Class/Source/Type.js", "spec/data/ExternalInternalDependencies/Core/Class/package.yml", "spec/data/ExternalInternalDependencies/Core/Hash/Source/Hash.js", "spec/data/ExternalInternalDependencies/Core/Hash/package.yml", "spec/data/ExternalInternalDependencies/Core/Mash/Source/Mash.js", "spec/data/ExternalInternalDependencies/Core/Mash/package.yml", "spec/data/ExternalInternalDependencies/Test/Source/Library/Color.js", "spec/data/ExternalInternalDependencies/Test/Source/Widget/Input/Input.Color.js", "spec/data/ExternalInternalDependencies/Test/Source/Widget/Input/Input.js", "spec/data/ExternalInternalDependencies/Test/Source/Widget/Widget.js", "spec/data/ExternalInternalDependencies/Test/package.yml", "spec/data/OutsideDependencies/README", "spec/data/OutsideDependencies/app/javascripts/Core/Source/Class/Class.Extras.js", "spec/data/OutsideDependencies/app/javascripts/Core/Source/Class/Class.js", "spec/data/OutsideDependencies/app/javascripts/Core/Source/Native/Hash.js", "spec/data/OutsideDependencies/app/javascripts/Core/package.yml", "spec/data/OutsideDependencies/app/javascripts/Orwik/Source/Library/Color.js", "spec/data/OutsideDependencies/app/javascripts/Orwik/Source/Widget/Input/Input.Color.js", "spec/data/OutsideDependencies/app/javascripts/Orwik/Source/Widget/Input/Input.js", "spec/data/OutsideDependencies/app/javascripts/Orwik/Source/Widget/Widget.js", "spec/data/OutsideDependencies/app/javascripts/Orwik/package.yml", "spec/data/bad_test_source_one.js", "spec/data/bad_test_source_two.js", "spec/data/test_source_one.js", "spec/lib/jsus/container_spec.rb", "spec/lib/jsus/package_spec.rb", "spec/lib/jsus/packager_spec.rb", "spec/lib/jsus/pool_spec.rb", "spec/lib/jsus/source_file_spec.rb", "spec/lib/jsus/tag_spec.rb", "spec/shared/class_stubs.rb", "spec/spec_helper.rb", "jsus.gemspec"]
   s.homepage = %q{http://github.com/markiz/jsus}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Jsus", "--main", "README"]
   s.require_paths = ["lib"]

data/lib/jsus.rb

@@ -8,6 +8,7 @@ require 'rgl/adjacency'
 require 'rgl/topsort'
 
 require 'fileutils'
+require 'pathname'
 
 require 'jsus/source_file'
 require 'jsus/package'

data/lib/jsus/container.rb

@@ -59,6 +59,17 @@ module Jsus
       self
     end
 
+    # Lists all the required files (dependencies and extensions) for
+    # the sources in the container.    
+    def required_files(root = nil)
+      files = sources.map {|s| s.required_files }.flatten
+      if root
+        root = Pathname.new(File.expand_path(root))
+        files = files.map {|f| Pathname.new(File.expand_path(f)).relative_path_from(root).to_s }
+      end
+      files
+    end
+
     def inspect # :nodoc:
       "#<#{self.class.name}:#{self.object_id} #{self.sources.inspect}>"
     end

data/lib/jsus/pool.rb

@@ -26,6 +26,7 @@ module Jsus
           Package.new(File.dirname(package_path), :pool => self)
         end
       end
+      flush_cache!
     end
     
     
@@ -123,15 +124,30 @@ module Jsus
       self
     end
 
+    #
+    # Drops any cached info
+    #
+    def flush_cache!
+      @cached_dependencies = {}
+    end
+
     (Array.instance_methods - self.instance_methods).each {|m| delegate m, :to => :sources }
     # Private API
     
     # 
     # Looks up direct dependencies for the given source_file or provides tag.
     # You probably will find yourself using #include_dependencies instead.
+    # This method caches results locally, use flush_cache! to drop.
     #
     def lookup_direct_dependencies(source_or_source_key)      
       source = lookup(source_or_source_key)
+      @cached_dependencies[source] ||= lookup_direct_dependencies!(source)
+    end
+
+    #
+    # Performs the actual lookup for #lookup_direct_dependencies
+    #
+    def lookup_direct_dependencies!(source)
       result = source ? (source.dependencies + source.external_dependencies).map {|d| lookup(d)} : []
       Container.new(*result)
     end

data/lib/jsus/source_file.rb

@@ -169,7 +169,7 @@ module Jsus
     # 
     # Returns an array of files required by this files including all the filenames for extensions.
     # SourceFile filename always goes first, all the extensions are unordered.
-    # 
+    #
     def required_files
       [filename, extensions.map {|e| e.filename}].flatten
     end

data/spec/lib/jsus/container_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 
 describe Jsus::Container do
-  let(:simple_source)         { Source.new(:provides => [0], :dependencies => [],  :content => "// simple") }
-  let(:another_simple_source) { Source.new(:provides => [1], :dependencies => [],  :content => "// simple 2") }
-  let(:dependant_source)      { Source.new(:provides => [3], :dependencies => [0], :content => "// simple 3") }
+  let(:simple_source)         { Source.new(:provides => [0], :dependencies => [],  :content => "// simple",   :filename => "/home/jsus/simple.js") }
+  let(:another_simple_source) { Source.new(:provides => [1], :dependencies => [],  :content => "// simple 2", :filename => "/home/jsus/other/simple2.js") }
+  let(:dependant_source)      { Source.new(:provides => [3], :dependencies => [0], :content => "// simple 3", :filename => "/home/dependencies/simple3.js") }
 
   let(:simple_container)        { Jsus::Container.new(simple_source, another_simple_source) }
   let(:container_with_dependency) { Jsus::Container.new(dependant_source, simple_source) }
@@ -53,4 +53,15 @@ describe Jsus::Container do
       }.should_not raise_error
     end
   end
+
+  describe "#required_files" do
+    subject { container_with_dependency }
+    it "should return includes for all the sources" do
+      subject.required_files.should == [simple_source.filename, dependant_source.filename]
+    end
+
+    it "should generate routes from given root" do
+      subject.required_files("/home/jsus").should == ["simple.js", "../dependencies/simple3.js"]
+    end
+  end
 end

data/spec/shared/class_stubs.rb

@@ -5,12 +5,17 @@ class Source
   attr_accessor :provides
   attr_accessor :dependencies
   attr_accessor :content
+  attr_accessor :filename
 
   def initialize(options = {})
     options.each do |attr, value|
       send("#{attr}=", value)
     end
   end
+
+  def required_files
+    [filename]
+  end
 end
 
 

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'spec'
+require 'rspec'
 # require 'ruby-debug'
 
 $LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), ".."))

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: jsus
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: false
   segments: 
   - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 7
+  version: 0.1.7
 platform: ruby
 authors: 
 - Markiz, idea by Inviz (http://github.com/Inviz)
@@ -15,8 +14,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-25 00:00:00 +04:00
-default_executable: 
+date: 2010-08-30 00:00:00 +04:00
+default_executable: jsus
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -40,7 +38,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -54,7 +51,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -68,7 +64,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -82,7 +77,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -115,7 +109,6 @@ files:
 - Rakefile
 - TODO
 - bin/jsus
-- jsus.gemspec
 - lib/jsus.rb
 - lib/jsus/container.rb
 - lib/jsus/package.rb
@@ -173,8 +166,8 @@ files:
 - spec/lib/jsus/source_file_spec.rb
 - spec/lib/jsus/tag_spec.rb
 - spec/shared/class_stubs.rb
-- spec/spec.opts
 - spec/spec_helper.rb
+- jsus.gemspec
 has_rdoc: true
 homepage: http://github.com/markiz/jsus
 licenses: []
@@ -194,7 +187,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -203,7 +195,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 11
       segments: 
       - 1
       - 2

data/spec/spec.opts

@@ -1,4 +0,0 @@
---colour
---format progress
---loadby mtime
---reverse