slinky 0.5.0 → 0.6.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2

data/Gemfile

@@ -2,21 +2,22 @@ source "http://rubygems.org"
 
 gem "eventmachine", ">= 0.12.0"
 gem "eventmachine_httpserver", ">= 0.2.0"
-gem "em-proxy", ">= 0.1.5"
-gem "rainbow", ">= 1.1.1"
+gem "em-proxy", ">= 0.1.6"
+gem "rainbow", ">= 1.1.3"
 gem "haml", ">= 3.0.0"
 gem "sass", ">= 3.1.1"
 gem "coffee-script", ">= 2.2.0"
 gem "mime-types", ">= 1.16"
 gem "yui-compressor", ">= 0.9.6"
+gem "listen", ">= 0.4.5"
 
 group :development do
-  gem "rspec", "~> 2.3.0"
+  gem "rspec", "~> 2.10.0"
   gem "yard", "~> 0.6.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.0"
   gem 'cover_me', '>= 1.0.0.rc6'
-  gem "fakefs"
-  gem "em-http-request"
+  gem "fakefs", '~> 0.4.0'
+  gem "em-http-request", '~> 1.0.0'
 #  gem "em-synchrony", ">= 0"
 end

data/README.md

@@ -1,4 +1,4 @@
-#Slinky
+#Slinky 
 
 Slinky helps you write rich web applications using compiled web
 languages like SASS, HAML and CoffeeScript. The slinky server
@@ -11,6 +11,8 @@ Once you're ready for production the slinky builder will compile all of
 your sources and concatenate and minify your javascript and css,
 leaving you a directory that's ready to be pushed to your servers.
 
+[![Build Status](https://secure.travis-ci.org/mwylde/slinky.png)](http://travis-ci.org/mwylde/slinky)
+
 ## Quickstart
 
 ```
@@ -82,7 +84,37 @@ a
   color: red
 ```
 
-### Configuration
+### Specifing dependencies
+
+As HAML and SASS scripts can include external content as part of their
+build process, it may be that you would like to specify that files are
+to be recompiled whenever other files change. For example, you may use
+mustache templates defined each in their own file, but have set up
+your HAML file to include them all into the HTML. Thus when one of the
+mustache files changes, you would like the HAML file to be recompiled
+so that the templates can be updated also.
+
+These relationships are specified as "dependencies," and like requirements
+they are incdicated through a special `slinky_depends("file")` directive in 
+your source files. For our template example, the index.haml files might look 
+like this:
+
+```haml
+slinky_depends("scripts/templates/*.mustache")
+!!!5
+
+%html
+  %head
+    %title My App
+    slinky_styles
+    slinky_scripts
+    - Dir.glob("./scripts/templates/*.mustache") do |f|
+      - name = File.basename(f).split(".")[0..-2].join(".")
+      %script{:id => name, :type => "text/x-handlebars-template"}= File.read(f)
+  %body
+```
+
+## Configuration
 
 Slinky can optionally be configured using a yaml file. By default, it
 looks for a file called `slinky.yaml` in the source directory, but you
@@ -90,7 +122,7 @@ can also supply a file name on the command line using `-c`.
 
 There are currently two directives supported:
 
-#### Proxies
+### Proxies
 
 Slinky has a built-in proxy server which lets you test ajax requests
 with your actual backend servers. To set it up, your slinky.yaml file
@@ -128,7 +160,7 @@ an AJAX request is outstanding. However, when run locally the request
 returns so quickly that you can't even see the loading indicator. By
 adding in a lag this problem is remedied.
 
-####  Ignores
+###  Ignores
 
 By default slinky will include every javascript and css file it finds
 into the combined scripts.js and styles.css files. However, it may be

data/Rakefile

@@ -13,12 +13,12 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "slinky"
-  gem.homepage = "http://github.com/mwylde/slinky"
+  gem.homepage = "http://mwylde.github.com/slinky/"
   gem.license = "MIT"
   gem.summary = %Q{Static file server for javascript apps}
-  gem.description = %Q{A static file server for rich javascript apps that automatically compiles SASS, HAML, CoffeeScript and more}
-  gem.email = "mwylde@wesleyan.edu"
-  gem.authors = ["mwylde"]
+  gem.description = %Q{A static file server for rich web apps that automatically compiles SASS, HAML, CoffeeScript and more}
+  gem.email = "micah@micahw.com"
+  gem.authors = ["Micah Wylde"]
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/slinky.rb

@@ -10,6 +10,7 @@ require 'rainbow'
 require 'optparse'
 require 'mime/types'
 require 'yui/compressor'
+require 'listen'
 
 require "#{ROOT}/slinky/em-popen3"
 require "#{ROOT}/slinky/compilers"
@@ -20,6 +21,7 @@ require "#{ROOT}/slinky/proxy_server"
 require "#{ROOT}/slinky/server"
 require "#{ROOT}/slinky/runner"
 require "#{ROOT}/slinky/builder"
+require "#{ROOT}/slinky/listener"
 
 # load compilers
 Dir.glob("#{ROOT}/slinky/compilers/*.rb").each{|compiler|

data/lib/slinky/builder.rb

@@ -2,7 +2,11 @@ module Slinky
   class Builder
     def self.build dir, build_dir, config
       manifest = Manifest.new(dir, config, :build_to => build_dir, :devel => false)
-      manifest.build
+      begin
+        manifest.build
+      rescue BuildFailedError
+        $stderr.puts "Build failed"
+      end
     end
   end
 end

data/lib/slinky/compiled_file.rb

@@ -80,11 +80,11 @@ module Slinky
     # Calls the supplied callback with the path of the compiled file,
     # compiling the source file first if necessary.
     def file &cb
-      if needs_update?
-        compile &cb
-      else
-        cb.call @output_path, nil, nil, nil
-      end
+      #if needs_update?
+      compile &cb
+      #else
+      #  cb.call @output_path, nil, nil, nil
+      #end
     end
 
     # Returns whether the source file has changed since it was last

data/lib/slinky/listener.rb

@@ -0,0 +1,35 @@
+Thread.abort_on_exception = true
+
+module Slinky
+  class Listener
+    def initialize manifest
+      @manifest = manifest
+    end
+
+    def run
+      
+      listener = Listen.to(@manifest.dir)
+      listener.change do |mod, add, rem|
+        handle_mod(mod) if mod.size > 0
+        handle_add(add) if add.size > 0
+        handle_rem(rem) if rem.size > 0
+      end
+      listener.start(false)
+    end
+
+    def handle_mod files
+    end
+    
+    def handle_add files
+      EM.next_tick {
+        @manifest.add_all_by_path files
+      }
+    end
+    
+    def handle_rem files
+      EM.next_tick {
+        @manifest.remove_all_by_path files
+      }
+    end
+  end
+end

data/lib/slinky/manifest.rb

@@ -1,13 +1,18 @@
 # -*- coding: utf-8 -*-
 require 'pathname'
+require 'digest/md5'
 
 module Slinky
   # extensions of files that can contain build directives
   DIRECTIVE_FILES = %w{js css html haml sass scss coffee}
+  DEPENDS_DIRECTIVE = /^[^\n\w]*(slinky_depends)\((".*"|'.+'|)\)[^\n\w]*$/
   REQUIRE_DIRECTIVE = /^[^\n\w]*(slinky_require)\((".*"|'.+'|)\)[^\n\w]*$/
   SCRIPTS_DIRECTIVE = /^[^\n\w]*(slinky_scripts)[^\n\w]*$/
   STYLES_DIRECTIVE  = /^[^\n\w]*(slinky_styles)[^\n\w]*$/
-  BUILD_DIRECTIVES = Regexp.union(REQUIRE_DIRECTIVE, SCRIPTS_DIRECTIVE, STYLES_DIRECTIVE)
+  BUILD_DIRECTIVES = Regexp.union(DEPENDS_DIRECTIVE,
+                                  REQUIRE_DIRECTIVE,
+                                  SCRIPTS_DIRECTIVE,
+                                  STYLES_DIRECTIVE)
   CSS_URL_MATCHER = /url\(['"]?([^'"\/][^\s)]+\.[a-z]+)(\?\d+)?['"]?\)/
 
   # Raised when a compilation fails for any reason
@@ -46,7 +51,23 @@ module Slinky
       else
         @files.reject{|f| @config.ignores.any?{|p| f.in_tree? p}}
       end
-    end    
+    end
+
+    # Adds a file to the manifest, updating the dependency graph
+    def add_all_by_path paths
+      manifest_update paths do |path|
+        md = find_by_path(File.dirname(path)).first
+        mf = md.add_file(File.basename(path))
+      end
+    end
+
+    # Removes a file from the manifest
+    def remove_all_by_path paths
+      manifest_update paths do |path|
+        mf = find_by_path(path).first()
+        mf.parent.remove_file(mf)
+      end
+    end
 
     # Finds the file at the given path in the manifest if one exists,
     # otherwise nil.
@@ -54,8 +75,8 @@ module Slinky
     # @param String path the path of the file relative to the manifest
     #
     # @return ManifestFile the manifest file at that path if one exists
-    def find_by_path path
-      @manifest_dir.find_by_path path
+    def find_by_path path, allow_multiple = false
+      @manifest_dir.find_by_path path, allow_multiple
     end
     
     def scripts_string
@@ -71,19 +92,21 @@ module Slinky
     def compress ext, output, compressor
       scripts = dependency_list.reject{|x| x.output_path.extname != ext}
 
-      s = scripts.collect{|s|
-        f = File.open(s.build_to.to_s, 'rb'){|f| f.read}
-        (block_given?) ? (yield s, f) : f
-      }.join("\n")
+      if scripts.size > 0
+        s = scripts.collect{|s|
+          f = File.open(s.build_to.to_s, 'rb'){|f| f.read}
+          (block_given?) ? (yield s, f) : f
+        }.join("\n")
 
-      File.open(output, "w+"){|f|
-        f.write(compressor.compress(s)) 
-      }
-      scripts.collect{|s| FileUtils.rm(s.build_to)}
+        File.open(output, "w+"){|f|
+          f.write(compressor.compress(s)) 
+        }
+        scripts.collect{|s| FileUtils.rm(s.build_to)}
+      end
     end
     
     def compress_scripts
-      compressor = YUI::JavaScriptCompressor.new(:munge => true)
+      compressor = YUI::JavaScriptCompressor.new(:munge => false)
       compress(".js", "#{@build_to}/scripts.js", compressor)
     end
 
@@ -118,9 +141,11 @@ module Slinky
       graph = []
       files(false).each{|mf|
         mf.directives[:slinky_require].each{|rf|
-          required = mf.parent.find_by_path(rf)
-          if required
-            graph << [required, mf]
+          required = mf.parent.find_by_path(rf, true)
+          if required.size > 0
+            required.each{|x|
+              graph << [x, mf]
+            }
           else
             error = "Could not find file #{rf} required by #{mf.source}"
             $stderr.puts error.foreground(:red)
@@ -175,6 +200,27 @@ module Slinky
         files_rec c
       end
     end
+
+    def invalidate_cache
+      @files = nil
+      @dependency_graph = nil
+    end
+
+    def manifest_update paths
+      paths.each{|path|
+        if path[0] == '/'
+          path = Pathname.new(path).relative_path_from(Pathname.new(@dir).expand_path).to_s
+        end
+        yield path
+      }
+      invalidate_cache
+      files.each{|f|
+        if f.directives.include?(:slinky_scripts) || f.directives.include?(:slinky_styles)
+          f.invalidate
+          f.process
+        end
+      }
+    end
   end
 
   class ManifestDir
@@ -191,10 +237,9 @@ module Slinky
         # skip the build dir
         next if Pathname.new(File.absolute_path(path)) == Pathname.new(build_dir)
         if File.directory? path
-          build_dir = (@build_dir + File.basename(path)).cleanpath
-          @children << ManifestDir.new(path, self, build_dir, manifest)
+          add_child(path)
         else
-           @files << ManifestFile.new(path, @build_dir, manifest, self)
+          add_file(path)
         end
       end
     end
@@ -203,15 +248,28 @@ module Slinky
     # otherwise nil.
     #
     # @param String path the path of the file relative to the directory
+    # @param Boolean allow_multiple if enabled, can return multiple paths
+    #   according to glob rules
     #
-    # @return ManifestFile the manifest file at that path if one exists
-    def find_by_path path
+    # @return [ManifestFile] the manifest file at that path if one exists
+    def find_by_path path, allow_multiple = false
       components = path.to_s.split(File::SEPARATOR).reject{|x| x == ""}
       case components.size
       when 0
-        self
+        [self]
       when 1
-        @files.find{|f| f.matches? components[0]}
+        path = [@dir, components[0]].join(File::SEPARATOR)
+        if (Dir.exists?(path) rescue false)
+          c = @children.find{|d|
+            Pathname.new(d.dir).cleanpath == Pathname.new(path).cleanpath
+          }
+          unless c
+            c = add_child(path)
+          end
+          [c]
+        else
+          @files.find_all{|f| f.matches? components[0], allow_multiple}
+        end
       else
         if components[0] == ".."
           @parent.find_by_path components[1..-1].join(File::SEPARATOR)
@@ -219,24 +277,63 @@ module Slinky
           child = @children.find{|d|
             Pathname.new(d.dir).basename.to_s == components[0]
           }
-          child ? child.find_by_path(components[1..-1].join(File::SEPARATOR)) : nil
+          if child
+            child.find_by_path(components[1..-1].join(File::SEPARATOR),
+                               allow_multiple)
+          else
+            []
+          end
         end
       end
     end
 
+    # Adds a child directory
+    def add_child path
+      if Dir.exists? path
+        build_dir = (@build_dir + File.basename(path)).cleanpath
+        md = ManifestDir.new(path, self, build_dir, @manifest)
+        @children << md
+        md
+      end
+    end
+    
+    # Adds a file on the filesystem to the manifest
+    #
+    # @param String path The path of the file
+    def add_file path
+      file = File.basename(path)
+      full_path = [@dir, file].join(File::SEPARATOR)
+      if File.exists? full_path
+        mf = ManifestFile.new(full_path, @build_dir, @manifest, self)
+        @files << mf
+        mf
+      end
+    end
+
+    # Removes a file from the manifest
+    #
+    # @param ManifestFile mf The file to be deleted
+    def remove_file mf
+      @files.delete(mf)
+    end
+    
     def build
-      if !@build_dir.exist?
-        @build_dir.mkdir
+      unless Dir.exists?(@build_dir.to_s)
+        FileUtils.mkdir(@build_dir.to_s)
       end
       (@files + @children).each{|m|
         m.build
       }
     end
+
+    def to_s
+      "<ManifestDir:'#{@dir}'>"
+    end
   end
 
   class ManifestFile
     attr_accessor :source, :build_path
-    attr_reader :last_built, :directives, :parent, :manifest
+    attr_reader :last_built, :directives, :parent, :manifest, :updated
 
     def initialize source, build_path, manifest, parent = nil, options = {:devel => false}
       @parent = parent
@@ -251,17 +348,32 @@ module Slinky
       @devel = true if options[:devel]
     end
 
+    def invalidate
+      @last_built = Time.new(0)
+      @last_md5 = nil
+    end
+
     # Predicate which determines whether the supplied name is the same
     # as the file's name, taking into account compiled file
     # extensions. For example, if mf refers to "/tmp/test/hello.sass",
     # `mf.matches? "hello.sass"` and `mf.matches? "hello.css"` should
     # both return true.
     #
-    # @param [String] a filename
-    # @return [Bool] True if the filename matches, false otherwise
-    def matches? s
+    # @param String a filename
+    # @param Bool match_glob if true, matches according to glob rules
+    # @return Bool True if the filename matches, false otherwise
+    def matches? s, match_glob = false
       name = Pathname.new(@source).basename.to_s
-      name == s || output_path.basename.to_s == s
+      output = output_path.basename.to_s
+      # check for stars that are not escaped
+      r = /(?<!\\)\*/
+      if match_glob && s.match(r)
+        a = s.split(r)
+        r2 = a.reduce{|a, x| /#{a}.*#{x}/}
+        name.match(r2) || output.match(r2)
+      else
+        name == s || output == s
+      end
     end
 
     # Predicate which determines whether the file is the supplied path
@@ -313,7 +425,7 @@ module Slinky
         end
       end
 
-      directives
+      @directives = directives
     end
 
     # If there are any build directives for this file, the file is
@@ -323,19 +435,16 @@ module Slinky
     # @return String the path of the de-directivefied file
     def handle_directives path, to = nil
       if @directives.size > 0
-        begin
-          out = File.read(path)
-          out.gsub!(REQUIRE_DIRECTIVE, "")
-          out.gsub!(SCRIPTS_DIRECTIVE, @manifest.scripts_string)
-          out.gsub!(STYLES_DIRECTIVE, @manifest.styles_string)
-          to = to ||  Tempfile.new("slinky").path
-          File.open(to, "w+"){|f|
-            f.write(out)
-          }
-          to
-        rescue
-          nil
-        end
+        out = File.read(path)
+        out.gsub!(DEPENDS_DIRECTIVE, "")
+        out.gsub!(REQUIRE_DIRECTIVE, "")
+        out.gsub!(SCRIPTS_DIRECTIVE, @manifest.scripts_string)
+        out.gsub!(STYLES_DIRECTIVE, @manifest.styles_string)
+        to = to || Tempfile.new("slinky").path + ".cache"
+        File.open(to, "w+"){|f|
+          f.write(out)
+        }
+        to
       else
         path
       end
@@ -357,14 +466,45 @@ module Slinky
       path ? Pathname.new(path) : nil
     end
 
+    # Gets the md5 hash of the source file
+    def md5
+      Digest::MD5.hexdigest(File.read(@source)) rescue nil
+    end
+
     # Gets manifest file ready for serving or building by handling the
     # directives and compiling the file if neccesary.
     # @param String path to which the file should be compiled
     #
     # @return String the path of the processed file, ready for serving
     def process to = nil
-      # mangle file appropriately
-      handle_directives (compile @source), to
+      return if @processing # prevent infinite recursion
+      start_time = Time.now
+      hash = md5
+      if hash != @last_md5
+        find_directives
+      end
+
+      depends = @directives[:slinky_depends].map{|f|
+        p = parent.find_by_path(f, true)
+        $stderr.puts "File #{f} depended on by #{@source} not found".foreground(:red) unless p.size > 0
+        p
+      }.flatten.compact if @directives[:slinky_depends]
+      depends ||= []
+      @processing = true
+      # process each file on which we're dependent, watching out for 
+      # infinite loops
+      depends.each{|f| f.process }
+      @processing = false
+
+      # get hash of source file
+      if @last_path && hash == @last_md5 && depends.all?{|f| f.updated < start_time}
+        @last_path
+      else
+        @last_md5 = hash
+        @updated = Time.now
+        # mangle file appropriately
+        @last_path = handle_directives (compile @source), to
+      end
     end
 
     # Path to which the file will be built
@@ -379,8 +519,12 @@ module Slinky
         FileUtils.mkdir_p(@build_path)
       end
       to = build_to
-      path = process to
-      
+      begin 
+        path = process to
+      rescue
+        raise BuildFailedError
+      end
+
       if !path
         raise BuildFailedError
       elsif path != to
@@ -389,5 +533,9 @@ module Slinky
       end
       to
     end
+
+    def to_s
+      "<Slinky::ManifestFile '#{@source}'>"
+    end
   end
 end