jsus 0.3.6 → 0.4.0

data/lib/jsus/container.rb

@@ -11,6 +11,10 @@ module Jsus
     #
     # @param [*SourceFile] sources
     def initialize(*sources)
+      @sources        = []
+      @normal_sources = []
+      @extensions     = []
+      @replacements   = []
       sources.each do |source|
         push(source)
       end
@@ -23,10 +27,18 @@ module Jsus
     # @param [SourceFile] source source pushed file
     def push(source)
       if source
-        if source.kind_of?(Array) || source.kind_of?(Container)
+        if source.kind_of?(Array)
           source.each {|s| self.push(s) }
+        elsif source.kind_of?(Container)
+          source.all_sources.each {|s| self.push(s) }
         else
-          sources.push(source) unless sources.include?(source)
+          if source.extension?
+            @extensions << source unless @extensions.include?(source)
+          elsif source.replacement?
+            @replacements << source unless @replacements.include?(source)
+          else
+            @normal_sources << source unless @normal_sources.include?(source)
+          end
         end
       end
       clear_cache!
@@ -41,23 +53,24 @@ module Jsus
       map {|item| item.respond_to?(:flatten) ? item.flatten : item }.flatten
     end
 
-    # 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.
+    # Contains the source files.
     #
     # @return [Array]
-    # @api semipublic
+    # @api public
     def sources
-      @sources ||= []
+      sort!
+      @sources
     end
     alias_method :to_a, :sources
 
-    # Sets sources to new value.
+    # Includes all sources, even those that would normally be replaced.
+    # Without any order.
     #
+    # @return [Array]
     # @api semipublic
-    def sources=(new_value) # :nodoc:
-      @sources = new_value
-    end
+    def all_sources
+      @normal_sources + @extensions + @replacements
+    end # all_sources
 
     # Topologically sorts items in container if required.
     #
@@ -65,8 +78,10 @@ module Jsus
     # @api semipublic
     def sort!
       unless sorted?
-        remove_replaced_files!
-        self.sources = topsort
+        @sources = topsort
+        insert_extensions!
+        insert_replacements!
+        @sources.uniq!
         @sorted = true
       end
       self
@@ -106,6 +121,23 @@ module Jsus
       "#<#{self.class.name}:#{self.object_id} #{self.sources.inspect}>"
     end
 
+    # Returns all the tags provided by source files.
+    # @return [Array]
+    # @api public
+    def provides
+      sort!
+      sources.map {|s| s.provides }.flatten
+    end # provides
+
+    # Returns all the tags required by source files, except for those which are
+    # provided by other files in the container (i.e. unresolved dependencies)
+    # @return [Array]
+    # @api public
+    def requires
+      sort!
+      sources.map {|s| s.requires }.flatten - provides
+    end # requires
+
     # Private API
 
     # Performs topological sort inside current container.
@@ -114,7 +146,7 @@ module Jsus
     def topsort
       graph = RGL::DirectedAdjacencyGraph.new
       # init vertices
-      items = sources
+      items = @normal_sources
       items.each {|item| graph.add_vertex(item) }
       # init edges
       items.each do |item|
@@ -177,58 +209,47 @@ module Jsus
     def provides_tree!
       tree = Util::Tree.new
       # Provisions
-      sources.each do |file|
-        file.provides.each do |tag|
-          tree[tag] = file
+      @normal_sources.each do |file|
+        provisions = file.provides
+        if replacement = @replacements.detect {|r| provisions.any? {|tag| tag == r.replaces } }
+          file = replacement
         end
-      end
-      # Replacements
-      sources.each do |file|
-        if file.replaces
-          tree[file.replaces] = file
+        provisions.each do |tag|
+          tree[tag] = file
         end
       end
       tree
     end
 
-    # Removes files which are marked as replaced by other sources.
-    #
     # @api private
-    def remove_replaced_files!
-      sources.reject! do |sf|
-        !sf.provides.empty? && sf.provides.any? { |tag| replacements_tree[tag] && replacements_tree[tag] != sf }
+    def insert_extensions!
+      @extensions.each do |ext|
+        ext_tag = ext.extends
+        @sources.dup.each_with_index do |src, i|
+          if src.provides.any? {|tag| tag == ext_tag }
+            @sources.insert(i+1, ext)
+            break
+          end
+        end
       end
-    end
-
-    # Cached tree of what source files replace.
-    #
-    # @api private
-    # @return [Jsus::Util::Tree]
-    def replacements_tree
-      @replacements_tree ||= replacements_tree!
-    end
+    end # insert_extensions!
 
-    # Returns tree of what source files replace.
-    #
     # @api private
-    # @return [Jsus::Util::Tree]
-    def replacements_tree!
-      tree = Util::Tree.new
-      sources.each do |file|
-        if file.replaces
-          tree[file.replaces] = file
+    def insert_replacements!
+      @replacements.each do |repl|
+        @sources.each_with_index do |src, i|
+          if src.provides.any? {|tag| tag == repl.replaces }
+            @sources[i] = repl
+            break
+          end
         end
       end
-      tree
-    end
+    end # insert_replacements!
 
     # Clears all caches for given container.
     #
     # @api private
     def clear_cache!
-      @provides_tree = nil
-      @replacements_tree = nil
-      @dependency_cache = nil
       @sorted = false
     end
 
@@ -246,9 +267,8 @@ module Jsus
     ]
 
     (DELEGATED_METHODS).each do |m|
-      class_eval <<-EVAL
+      class_eval(<<-EVAL, __FILE__, __LINE__ + 1)
         def #{m}(*args, &block)
-          sort!
           #{"clear_cache!" if CACHE_CLEAR_METHODS.include?(m)}
           self.sources.send(:#{m}, *args, &block)
         end

data/lib/jsus/middleware.rb

@@ -175,7 +175,7 @@ module Jsus
     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")
+        response = Container.new(*files).map {|f| f.source }.join("\n")
         response = Jsus::Util::Compressor.compress(response, :method => self.class.settings[:compression_method]) if request_options[:compress]
         respond_with(response)
       else
@@ -262,8 +262,7 @@ module Jsus
     # @api semipublic
     def get_associated_files(source_file_or_package)
       if package = pool.packages.detect {|pkg| pkg.name == source_file_or_package}
-        package.include_dependencies!
-        package.linked_external_dependencies.to_a + package.source_files.to_a
+        pool.compile_package(package).to_a
       elsif source_file = pool.lookup(source_file_or_package)
         pool.lookup_dependencies(source_file).to_a << source_file
       else

data/lib/jsus/package.rb

@@ -3,6 +3,7 @@ module Jsus
   # Package is a (self-contained) unit with all the info required to build
   # a javascript package.
   #
+
   class Package
     # directory which this package resides in (full path)
     attr_accessor :directory
@@ -10,29 +11,27 @@ module Jsus
     attr_accessor :pool
 
     # Constructors
-
     #
     # Creates a package from given directory.
     #
     # @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
-    # file with meta info.
+    # @raise [RuntimeError] when the given directory doesn't contain a
+    #                       package.yml or package.json file with meta info.
     # @api public
-    def initialize(directory, options = {})
+    def initialize(directory)
       self.directory          = File.expand_path(directory)
-      if File.exists?(File.join(directory, 'package.yml'))
-        self.header           = YAML.load_file(File.join(directory, 'package.yml'))
+      @header = if File.exists?(File.join(directory, 'package.yml'))
+        YAML.load_file(File.join(directory, 'package.yml'))
       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 })
+        JSON.load(Jsus::Util.read_file(File.join(directory, 'package.json')))
       else
         Jsus.logger.fatal "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
-        files.each do |source|
-          source_file = SourceFile.from_file(source, :package => self)
+        files.each do |filename|
+          source_file = SourceFile.from_file(filename, :namespace => name)
+          source_file.package = self
           if source_file
             if source_file.extension?
               extensions << source_file
@@ -40,14 +39,10 @@ module Jsus
               source_files << source_file
             end
           else
-            Jsus.logger.warn "#{source} is not found for #{name}"
+            Jsus.logger.warn "#{filename} is not found for #{name}"
           end
         end
       end
-      if options[:pool]
-        self.pool = options[:pool]
-        self.pool << self
-      end
     end
 
 
@@ -82,115 +77,23 @@ module Jsus
     def files
       header["files"] = header["files"] || header["sources"] || []
     end
-    alias_method :sources, :files
 
-    # @return [Array] an array of provided tags including those provided by linked external dependencies.
+    # @return [Array] an array of provided tags
     # @api public
     def provides
-      source_files.map {|s| s.provides }.flatten | linked_external_dependencies.map {|d| d.provides }.flatten
-    end
-
-    # @return [Array] an array of provided tags names including those provided by linked external dependencies.
-    # @api public
-    def provides_names
-      source_files.map {|s| s.provides_names(:short => true) }.flatten |
-      linked_external_dependencies.map {|d| d.provides_names }.flatten
+      source_files.map {|s| s.provides }.flatten
     end
+    alias_method :provisions, :provides
 
-    # @return [Array] an array of unresolved dependencies' tags for the package.
+    # @return [Array] array dependencies tags for all source files in the package
     # @api public
     def dependencies
       result = source_files.map {|source| source.dependencies }.flatten
-      result |= linked_external_dependencies.map {|d| d.dependencies}.flatten
       result -= provides
       result
     end
-
-    # @return [Array] an array of unresolved dependencies' names.
-    # @api public
-    def dependencies_names
-      dependencies.map {|d| d.name(:short => true) }
-    end
-
-    # @return [Array] an array of external dependencies' tags (including resolved ones).
-    # @api public
-    def external_dependencies
-      source_files.map {|s| s.external_dependencies }.flatten
-    end
-
-    # @return [Array] an array of external dependencies' names (including resolved ones).
-    # @api public
-    def external_dependencies_names
-      external_dependencies.map {|d| d.name }
-    end
-
-    # @return [Jsus::Container] source files with external dependencies in correct order.
-    # @api public
-    def linked_external_dependencies
-      @linked_external_dependencies ||= Container.new
-    end
-
-    # Compiles source files and linked external source files into a given category.
-    # @param [String, nil] directory directory to output the result into
-    # @return [String] content of merged source files
-    # @api public
-    def compile(directory = ".")
-      fn = directory ? File.join(directory, filename) : nil
-      Packager.new(*(source_files.to_a + linked_external_dependencies.to_a)).pack(fn)
-    end
-
-    # Generates tree structure for files in package into a json file.
-    # @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")
-      FileUtils.mkdir_p(directory)
-      result = ActiveSupport::OrderedHash.new
-      source_files.each do |source|
-        components = File.dirname(source.relative_filename).split(File::SEPARATOR)
-        # deleting source dir by convention
-        components.delete("Source")
-        node = result
-        components.each do |component|
-          node[component] ||= ActiveSupport::OrderedHash.new
-          node = node[component]
-        end
-        node[File.basename(source.filename, ".js")] = source.to_hash
-      end
-      File.open(File.join(directory, filename), "w") { |resulting_file| resulting_file << JSON.pretty_generate(result) }
-      result
-    end
-
-    # Generates info about resulting compiled package into a json file.
-    # @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")
-      FileUtils.mkdir_p directory
-      File.open(File.join(directory, filename), "w") { |resulting_file| resulting_file << JSON.pretty_generate(self.to_hash) }
-      self.to_hash
-    end
-
-    # Looks up all the external dependencies in the pool.
-    # @api semipublic
-    def include_dependencies!
-      source_files.each do |source|
-        if pool
-          deps = pool.lookup_dependencies(source).to_a - @source_files.to_a
-          linked_external_dependencies << deps
-        end
-      end
-    end
-
-    # Executes #include_extensions for all the source files.
-    # @api semipublic
-    def include_extensions!
-      source_files.each do |source|
-        source.include_extensions!
-      end
-    end
+    alias_method :requires, :dependencies
+    alias_method :requirements, :dependencies
 
     # Lists the required files for the package.
     # @return [Array] ordered list of full paths to required files.
@@ -200,30 +103,31 @@ module Jsus
     end
 
     # Hash representation of the package.
+    # @return [Hash]
     # @api public
     def to_hash
       {
         name => {
-          :desc => description,
-          :provides => provides_names,
-          :requires => dependencies_names
+          :description => description,
+          :provides    => provides.map {|tag| tag.name },
+          :requires    => requires.map {|tag| tag.namespace == name ? tag.name : tag.full_name }
         }
       }
     end
 
 
-    # Container with source files
-    # @return [Jsus::Container]
+    # Array with source files
+    # @return [Array]
     # @api semipublic
     def source_files
-      @source_files ||= Container.new
+      @source_files ||= []
     end
 
-    # Container with extensions (they aren't compiled or included into #reqired_files list)
-    # @return [Jsus::Container]
+    # Array with extensions
+    # @return [Array]
     # @api semipublic
     def extensions
-      @extensions ||= Container.new
+      @extensions ||= []
     end
 
     # Private API
@@ -234,11 +138,5 @@ module Jsus
     def header=(new_header)
       @header = new_header
     end
-
-    # @param [Enumerable] new_value external dependencies
-    # @api private
-    def linked_external_dependencies=(new_value)
-      @linked_external_dependencies = new_value
-    end
   end
 end