jsus 0.2.7 → 0.3.0

data/lib/jsus/middleware.rb

@@ -0,0 +1,178 @@
+require 'rack/utils'
+module Jsus
+  #
+  # Rack middleware
+  #
+  # Just "use Jsus::Middleware" in your rack application and all the requests
+  # to /javascripts/jsus/* are redirected to the middleware.
+  #
+  # Configuration:
+  #
+  # Use Jsus::Middleware.settings= method to change some settings, such as:
+  # :packages_dir - path to where you store your packages
+  # :cache - enable simple file caching
+  # :cache_path - directory for file caching
+  # :prefix - change /jsus/ to something else or remove it altogether (set to nil)
+  # :cache_pool - cache js pool between requests. Can save you some time
+  #               between requests but annoys a lot during development.
+  #
+  #
+  # Examples:
+  #
+  # GET /javascripts/jsus/Mootools.Core+Mootools.More
+  #     merges packages named Mootools.Core and Mootools.More with all the
+  #     dependencies and outputs the result.
+  #
+  # GET /javascripts/jsus/Mootools.More~Mootools.Core
+  #     returns package Mootools.More with all the dependencies MINUS any of
+  #     Mootools.Core dependencies.
+  #
+  # GET /javascripts/jsus/Mootools.Core:Class+Mootools.More:Fx
+  #     same thing but for source files providing Mootools.Core/Class and
+  #     Mootools.More/Fx
+  #
+  #
+  # Also see sinatra example https://github.com/jsus/jsus-sinatra-app
+  #
+  class Middleware
+    include Rack
+    class <<self
+      DEFAULT_SETTINGS = {
+        :packages_dir     => ".",
+        :cache            => false,
+        :cache_path       => nil,
+        :prefix           => "jsus",
+        :cache_pool       => true
+      }.freeze
+
+      def settings
+        @settings ||= DEFAULT_SETTINGS.dup
+      end # settings
+
+      def settings=(new_settings)
+        settings.merge!(new_settings)
+      end # settings=
+
+      def pool
+        @pool ||= Jsus::Pool.new(settings[:packages_dir])
+      end # pool
+
+      def cache?
+        settings[:cache]
+      end # cache?
+
+      def cache
+        @cache ||= cache? ? Util::FileCache.new(settings[:cache_path]) : nil
+      end # cache
+    end # class <<self
+
+    def initialize(app)
+      @app = app
+    end # initialize
+
+    def _call(env)
+      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
+      if components[0] == "require"
+        generate(components[1])
+      else
+        not_found!
+      end
+    end # _call
+
+    def call(env)
+      dup._call(env)
+    end # call
+
+    protected
+
+    def generate(path_string)
+      path_args = parse_path_string(path_string.sub(/.js$/, ""))
+      files = []
+      path_args[:include].each {|tag| files += get_associated_files(tag).to_a }
+      path_args[:exclude].each {|tag| files -= get_associated_files(tag).to_a }
+      if !files.empty?
+        response = Container.new(*files).map {|f| f.content }.join("\n")
+        cache.write(path_string, response) if cache?
+        respond_with(response)
+      else
+        not_found!
+      end
+    end # generate
+
+    # Notice: + is a space after url decoding
+    # input:
+    # "Package:A~Package:C Package:B~Other:D"
+    # output:
+    # {:include => ["Package/A", "Package/B"], :exclude => ["Package/C", "Other/D"]}
+    def parse_path_string(path_string)
+      path_string = " " + path_string unless path_string[0,1] =~ /\+\-/
+      included = []
+      excluded = []
+      path_string.scan(/([ ~])([^ ~]*)/) do |op, arg|
+        arg = arg.gsub(":", "/")
+        if op == " "
+          included << arg
+        else
+          excluded << arg
+        end
+      end
+      {:include => included, :exclude => excluded}
+    end # parse_path_string
+
+    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
+      elsif source_file = pool.lookup(source_file_or_package)
+        pool.lookup_dependencies(source_file) << source_file
+      else
+        []
+      end
+    end # get_associated_files
+
+    def not_found!
+      [404, {"Content-Type" => "text/plain"}, ["Jsus doesn't know anything about this entity"]]
+    end # not_found!
+
+    def respond_with(text)
+      [200, {"Content-Type" => "text/javascript"}, [text]]
+    end # respond_with
+
+
+    def handled_by_jsus?(path)
+      path =~ path_prefix_regex
+    end # handled_by_jsus?
+
+    def path_prefix
+      @path_prefix ||= self.class.settings[:prefix] ? "/javascripts/#{self.class.settings[:prefix]}/" : "/javascripts/"
+    end # path_prefix
+
+    def path_prefix_regex
+      @path_prefix_regex ||= %r{^#{path_prefix}}
+    end # path_prefix_regex
+
+    def pool
+      if cache_pool?
+        self.class.pool
+      else
+        @pool ||= Jsus::Pool.new(self.class.settings[:packages_dir])
+      end
+    end # pool
+
+    def cache?
+      self.class.cache?
+    end # cache?
+
+    def cache
+      self.class.cache
+    end # cache
+
+    def cache_pool?
+      self.class.settings[:cache_pool]
+    end # cache_pool?
+  end # class Middleware
+end # module Jsus

data/lib/jsus/package.rb

@@ -7,7 +7,7 @@ module Jsus
     attr_accessor :directory # directory which this package resides in (full path)
     attr_accessor :pool      # an instance of Pool
     # Constructors
-     
+
     #
     # Creates a package from given directory.
     #
@@ -48,7 +48,7 @@ module Jsus
 
 
     # Public API
-    
+
     # Returns a package.yml header.
     def header
       @header ||= {}
@@ -58,15 +58,15 @@ module Jsus
     def name
       header["name"] ||= ""
     end
-    
+
     # Returns a package description.
     def description
       header["description"] ||= ""
-    end    
+    end
 
     # Returns a filename for compiled package.
     def filename
-      header["filename"] ||= name + ".js"
+      header["filename"] ||= Jsus::Util::Inflection.snake_case(name) + ".js"
     end
 
     # Returns a list of sources filenames.
@@ -81,7 +81,7 @@ module Jsus
     end
 
     # Returns an array of provided tags names including those provided by linked external dependencies.
-    def provides_names      
+    def provides_names
       source_files.map {|s| s.provides_names(:short => true) }.flatten |
       linked_external_dependencies.map {|d| d.provides_names }.flatten
     end
@@ -103,7 +103,7 @@ module Jsus
     def external_dependencies
       source_files.map {|s| s.external_dependencies }.flatten
     end
-    
+
     # Returns an array of external dependencies' names (including resolved ones).
     def external_dependencies_names
       external_dependencies.map {|d| d.name }
@@ -113,7 +113,7 @@ module Jsus
     def linked_external_dependencies
       @linked_external_dependencies ||= Container.new
     end
-    
+
     # Compiles source files and linked external source files into a given category.
     def compile(directory = ".")
       fn = directory ? File.join(directory, filename) : nil
@@ -164,7 +164,7 @@ module Jsus
     end
 
     # Lists the required files for the package.
-    def required_files      
+    def required_files
       source_files.map {|s| s.required_files }.flatten
     end
 
@@ -189,7 +189,7 @@ module Jsus
     end
 
     # Private API
-    
+
     def header=(new_header) # :nodoc:
       @header = new_header
     end

data/lib/jsus/source_file.rb

@@ -1,10 +1,10 @@
 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
@@ -29,7 +29,7 @@ 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
@@ -38,9 +38,11 @@ module Jsus
     #
     def self.from_file(filename, options = {})
       if File.exists?(filename)
-        source = File.read(filename)
+        source = File.open(filename, 'r:utf-8') {|f| f.read }
+        bom = RUBY_VERSION =~ /1.9/ ? "\uFEFF" : "\xEF\xBB\xBF"
+        source.gsub!(bom, "")
         yaml_data = source.match(%r(^/\*\s*(---.*?)\*/)m)
-        if (yaml_data && yaml_data[1] && header = YAML.load(yaml_data[1]))          
+        if (yaml_data && yaml_data[1] && header = YAML.load(yaml_data[1]))
           options[:header]            = header
           options[:relative_filename] = filename
           options[:filename]          = File.expand_path(filename)
@@ -78,7 +80,7 @@ module Jsus
       header["description"]
     end
 
-    # 
+    #
     # Returns an array of dependencies tags. Unordered.
     #
     def dependencies
@@ -95,7 +97,7 @@ module Jsus
     #
     def dependencies_names(options = {})
       dependencies.map {|d| d.name(options) }
-    end    
+    end
     alias_method :requires_names, :dependencies_names
 
     #
@@ -112,15 +114,15 @@ module Jsus
       external_dependencies.map {|d| d.name }
     end
 
-    # 
+    #
     # Returns an array with provides tags.
     #
     def provides
       @provides
     end
-        
-    # 
-    # Returns an array with provides names. 
+
+    #
+    # Returns an array with provides names.
     # Accepts options:
     # * <tt>:short:</tt> -- whether provides should not prepend package name
     #   e.g. 'Class' instead of 'Core/Class' when in package 'Core')
@@ -134,13 +136,13 @@ module Jsus
     def replaces
       @replaces
     end
-    
+
 
     #
     # Returns a tag for source file, which this one is an extension for.
     #
     # E.g.: file Foo.js in package Core provides ['Class', 'Hash']. File Bar.js in package Bar
-    # extends 'Core/Class'. That means its contents would be appended to the Foo.js when compiling 
+    # extends 'Core/Class'. That means its contents would be appended to the Foo.js when compiling
     # the result.
     #
     def extends
@@ -162,7 +164,7 @@ module Jsus
       @extensions = @extensions.flatten.compact.uniq
       @extensions
     end
-        
+
     def extensions=(new_value) # :nodoc:
       @extensions = new_value
     end
@@ -177,14 +179,14 @@ module Jsus
     end
 
     def include_extensions! # :nodoc:
-      if pool        
+      if pool
         provides.each do |p|
           extensions << pool.lookup_extensions(p)
         end
       end
     end
 
-    # 
+    #
     # 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.
     #
@@ -193,7 +195,7 @@ module Jsus
       [filename, extensions.map {|e| e.filename}].flatten
     end
 
-    # 
+    #
     # Returns a hash containing basic info with dependencies/provides tags' names
     # and description for source file.
     #
@@ -209,18 +211,26 @@ module Jsus
       self.to_hash.inspect
     end
     # Private API
-    
+
     def header=(new_header) # :nodoc:
       @header = new_header
       # prepare defaults
       @header["description"] ||= ""
       # handle tags
-      @dependencies = [@header["requires"] || []].flatten
-      @dependencies.map! {|tag_name| Tag.new(tag_name, :package => package) }
-      @provides = [@header["provides"] || []].flatten
-      @provides.map! {|tag_name| Tag.new(tag_name, :package => package) }
-      @extends = (@header["extends"] && !@header["extends"].empty?) ? Tag.new(@header["extends"]) : nil
-      @replaces = @header["replaces"] ? Tag.new(@header["replaces"]) : nil
+      @dependencies = parse_tag_list(Array(@header["requires"]))
+      @provides = parse_tag_list(Array(@header["provides"]))
+
+      @extends = case @header["extends"]
+      when Array then Tag.new(@header["extends"][0])
+      when String then Tag.new(@header["extends"])
+      else nil
+      end
+
+      @replaces = case @header["replaces"]
+      when Array then Tag.new(@header["replaces"][0])
+      when String then Tag.new(@header["replaces"])
+      else nil
+      end
     end
 
     def content=(new_value) # :nodoc:
@@ -230,12 +240,30 @@ module Jsus
     def content # :nodoc:
       include_extensions
       [@content, extensions.map {|e| e.content}].flatten.compact.join("\n")
-    end 
-    
+    end
+
     def original_content # :nodoc:
       @content
     end
 
+    def parse_tag_list(tag_list)
+      tag_list.map do |tag_name|
+        case tag_name
+        when String
+          Tag.new(tag_name, :package => package)
+        when Hash
+          tags = []
+          tag_name.each do |pkg_name, sources|
+            normalized_package_name = pkg_name.sub(/(.+)\/.*$/, "\\1")
+            Array(sources).each do |source|
+              tags << Tag.new([normalized_package_name, source].join("/"))
+            end
+          end
+          tags
+        end
+      end.flatten
+    end # parse_tag_list
+
     # Assigns an instance of Jsus::Pool to the source file.
     # Also performs push to that pool.
     def pool=(new_value)
@@ -247,17 +275,17 @@ module Jsus
     def pool
       @pool
     end
-   
+
     def ==(other) # :nodoc:
       eql?(other)
     end
-    
+
     def eql?(other) # :nodoc:
       other.kind_of?(SourceFile) && filename == other.filename
     end
-    
+
     def hash
       [self.class, filename].hash
     end
   end
-end
+end

data/lib/jsus/tag.rb

@@ -2,15 +2,15 @@ module Jsus
   #
   # Tag is basically just a string that contains a package name and a name for class
   # (or not necessarily a class) which the given SourceFile provides/requires/extends/replaces.
-  #  
+  #
   class Tag
     attr_accessor :package, :external # :nodoc:
 
     # Constructors
-    
+
     #
     # Creates a tag from given name/options.
-    # 
+    #
     # The way it works may seem a bit tricky but actually it parses name/options
     # combinations in different ways and may be best described by examples:
     #
@@ -21,8 +21,8 @@ module Jsus
     #     d = Tag.new("Core/Class", :package => core) # :package_name => "Core", :name => "Class", :external => false
     #     mash = Package.new(...) # let's consider its name is 'Mash'
     #     e = Tag.new("Core/Class", :package => mash) # :package_name => "Core", :name => "Class", :external => true
-    # 
-    # Between all those, tags b,c,d and e are equal, meaning they all use 
+    #
+    # Between all those, tags b,c,d and e are equal, meaning they all use
     # the same spot in Hash or whatever else.
     #
     def initialize(name, options = {})
@@ -60,7 +60,7 @@ module Jsus
     # * +:short:+ -- whether the tag should try using short form
     #
     # Important note: only non-external tags support short forms.
-    # 
+    #
     #    Tag.new('Core/Class').name(:short => true) # => 'Core/Class'
     #    core = Package.new(...) # let's consider its name is 'Core'
     #    Tag.new('Core/Class', :package => core).name(:short => true) # => 'Class'
@@ -91,9 +91,9 @@ module Jsus
         super
       end
     end
-    
+
     # Private API
-    
+
     def self.normalize_name_and_options(name, options = {}) # :nodoc:
       result = {}
       name.gsub!(%r(^(\.)?/), "")
@@ -108,6 +108,7 @@ module Jsus
         end
         result[:name] = name
       end
+      result[:package_name] = normalize_package_name(result[:package_name]) if result[:package_name]
       result
     end
 
@@ -118,7 +119,14 @@ module Jsus
     def self.name_and_options_to_full_name(name, options = {}) # :nodoc:
       normalized_options_to_full_name(normalize_name_and_options(name, options))
     end
-        
+
+    def self.normalize_package_name(name) # :nodoc:
+      package_chunks = name.split("/")
+      package_chunks.map do |pc|
+        Jsus::Util::Inflection.random_case_to_mixed_case(pc)
+      end.join("/")
+    end # normalize_name
+
     def package_name=(new_value) # :nodoc:
       @package_name = new_value
     end
@@ -137,6 +145,6 @@ module Jsus
 
     def inspect # :nodoc
       "<Jsus::Tag: #{name}>"
-    end    
+    end
   end
 end

data/lib/jsus/util/file_cache.rb

@@ -0,0 +1,57 @@
+require 'fileutils'
+module Jsus
+  module Util
+    #
+    # Simple file cache manager.
+    #
+    class FileCache
+      # Initializes filecache to given directory
+      def initialize(path)
+        @path = path
+      end # initialize
+
+      # Creates a file with given value for given key in cache directory
+      #
+      # Returns actual path for stored file.
+      def write(key, value)
+        item_path = generate_path(key)
+        FileUtils.mkdir_p(File.dirname(item_path))
+        File.open(item_path, 'w+') {|f| f.write(value) }
+        item_path
+      end # write
+
+      # If file exists for given cache key, returns path to that file.
+      # If file doesn't exist, returns nil.
+      def read(key)
+        item_path = generate_path(key)
+        File.exists?(item_path) ? item_path : nil
+      end # read
+      alias_method :exists?, :read
+
+      # If file with given key exists, returns path to it.
+      # Otherwise, writes value of yielded block.
+      def fetch(key, &block)
+        read(key) || write(key, yield)
+      end # fetch
+
+      # Deletes cache entry for given key.
+      def delete(key)
+        item_path = generate_path(key)
+        if File.exists?(item_path)
+          FileUtils.rm_f(item_path)
+        end
+      end # delete
+
+      protected
+
+      # Generates path by cache key.
+      #
+      # Default strategy: append key to cache directory
+      # (slashes are replaced with dots)
+      def generate_path(key)
+        key = key.gsub(File::SEPARATOR, ".")
+        File.join(@path, key)
+      end # generate_path
+    end # class FileCache
+  end # module Util
+end # module Jsus

data/lib/jsus/util/inflection.rb

@@ -0,0 +1,39 @@
+module Jsus
+  module Util
+    # Various inflection helpers
+    module Inflection
+      class <<self
+        # Converts strings with various punctuation to pascal case
+        #     hello_world  => HelloWorld
+        #     Oh.My.God    => OhMyGod
+        #     iAmCamelCase => IAmCamelCase
+        #     some_Weird_._punctuation => SomeWeirdPunctuation
+        def random_case_to_mixed_case(string)
+          string.split(/[^a-zA-Z]+/).map {|chunk| capitalize(chunk) }.join
+        end # random_case_to_mixed_case
+
+        # Same as #random_case_to_mixed_case, but preserves dots
+        # color.fx => Color.Fx
+        def random_case_to_mixed_case_preserve_dots(string)
+          string.split(".").map {|c| random_case_to_mixed_case(c) }.join(".")
+        end # random_case_to_mixed_case
+
+        # Capitalizes first letter (doesn't do anything else to other letters, unlike String#capitalize)
+        def capitalize(string)
+          string[0,1].capitalize + string[1..-1].to_s
+        end # capitalize
+
+        # Downcases first letter
+        def decapitalize(string)
+          string[0,1].downcase + string[1..-1].to_s
+        end # decapitalize
+
+        # Translates MixedCase string to camel-case
+        def snake_case(string)
+          decapitalize(string.gsub(/(.)([A-Z])([a-z]+)/) {|_| "#{$1}_#{$2.downcase}#{$3}"}.
+                              gsub(/[^A-Za-z_]+/, "_"))
+        end # snake_case
+      end # class <<self
+    end # module Inflection
+  end # module Util
+end # module Jsus

data/lib/jsus/util.rb

@@ -3,5 +3,7 @@ module Jsus
     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'
   end # Util
 end # Jsus

data/lib/jsus.rb

@@ -24,6 +24,8 @@ module Jsus
   autoload :Packager,   'jsus/packager'
   autoload :Pool,       'jsus/pool'
   autoload :Util,       'jsus/util'
+  autoload :Middleware, 'jsus/middleware'
+
   # Returns whether or not jsus is in verbose mode
   def self.verbose?
     !!@verbose

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

@@ -0,0 +1,16 @@
+/*
+---
+
+script: Core.js
+
+description: Mootools fake core
+
+license: MIT-style license
+
+authors:
+- Valerio Proietti
+
+provides: [Core]
+
+...
+*/

data/spec/data/ComplexDependencies/Mootools/package.yml

@@ -0,0 +1,8 @@
+name: Mootools
+filename: mootools.js
+web: http://mootools.net
+description: Fake mootools package
+license: Public Domain, http://unlicense.org/UNLICENSE
+authors: mootools authors
+sources:
+  - "Source/Core.js"