seaweed 0.1.0 → 0.1.1

data/lib/required_files.rb

@@ -10,12 +10,13 @@ class RequiredFiles < Hash
   def add name
     file_name = full_path name
     if file_name && !self[name.to_sym]
-      requirements = find_requirements file_name
+      directives = parse_directives file_name
       self[name.to_sym] = {
         :file_name  => file_name,
-        :requires   => requirements
+        :requires   => directives['require']
       }
-      requirements.each { |requirement| add requirement }
+      requested = (directives['require'] | directives['request'])
+      requested.each{ |file| add file }
     end
   end
 
@@ -33,21 +34,24 @@ class RequiredFiles < Hash
       file_path && "#{file_path}/#{name}.coffee"
     end
   
-    # Scans a coffeescript file for requirement directives.
+    # Scans a coffeescript file for #require and #request directives.
     #
     # Example requirement directives:
     #   #require ST
     #   #require ST/Model/Index
-    def find_requirements name
-      requirements = []
+    def parse_directives name
+      directives = {
+        'require' => [],
+        'request' => []
+      }
       File.open name do |file|
         file.each do |line|
-          if line.match /^#require\s+(\S+)\s*$/
-            requirements << $1
+          if line.match /^#(require|request)\s+(\S+)\s*$/
+            directives[$1] << $2
           end
         end
       end
-      requirements
+      directives
     end
   
     # Callback functions for tsort

data/server/server.rb

@@ -3,6 +3,7 @@ require 'sinatra'
 require 'slim'
 require 'coffee-script'
 
+# Patch in Sinatra support for Slim
 module Sinatra
   module Templates
     def slim(template, options={}, locals={})
@@ -11,23 +12,38 @@ module Sinatra
   end
 end
 
+# Configure slim for prettier code formatting
 Slim::Engine.set_default_options :pretty => true
 
+# Hide redundant log messages
+disable :logging
+
+# Dynamically compiles coffeescript, first checking to see if it has changed
 def compile source, target
   begin
+    # Get modified time of source file
     mtime = File.mtime source
-        
+    
+    # If compled JavaScript file already exists and is up to date, return the
+    # existing file instead of compiling again
     return File.read target if File.exists?(target) && File.mtime(target) == mtime
     
+    # Create base dir for compiled file
     dir = target.sub /\/[^\/]+$/, ''
     Dir.mkdir dir unless File.exists? dir
+    
+    # Compile CoffeeScript to JavaScript file
     File.open target, 'w' do |f|
       f.write CoffeeScript.compile(File.read source)
     end
+    
+    # Mark compiled file with same modified date as source
     File.utime mtime, mtime, target
     
+    # Return our newly compiled JavaScript
     File.read target
   rescue CoffeeScript::CompilationError => e
+    # Display CoffeeScript compilation error in a prettier format
     message = if e.message.match /^SyntaxError: (.*) on line (\d+)\D*$/
       "#{source}:#{$2}".ljust(40) + " #{$1}"
     elsif e.message.match /^Parse error on line (\d+): (.*)$/
@@ -36,24 +52,31 @@ def compile source, target
       "#{source} - #{e.message}"
     end
     puts "\e[31m#{message}\e[0m"
+    
+    # Generate JS to display compilation error on HTML page
     html = "<pre class=\"failed\">#{message}</pre>"
     "$(function(){$(document.body).prepend(#{html.to_json});});"
   end
 end
 
+# Processes request for seaweed Spec library
 get "/Spec.js" do
   compile File.expand_path('../../lib/Spec.coffee', __FILE__), "compiled/spec.js"
 end
 
+# Processes request for project lib files
 get %r{^/lib/(.+)\.js$} do |file|
   compile "lib/#{file}.coffee", "compiled/#{file}.js"
 end
 
+# Processes request for project spec files
 get %r{^/spec/(.+)\.js$} do |file|
   compile "spec/#{file}.coffee", "compiled/#{file}.js"
 end
 
+# Processes request for page index
 get "/" do
+  # Build ordered list of required files to run all specs
   requirements = RequiredFiles.new
   requirements.paths = ['spec', 'lib']
   Dir['spec/**/*.spec.coffee'].each do |file|

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: seaweed
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Tobias Cohen
@@ -118,7 +118,6 @@ files:
 - server/views/index.slim
 - lib/required_files.rb
 - lib/Spec.coffee
-- lib/spec.rb
 has_rdoc: true
 homepage: https://github.com/tobico/seaweed
 licenses: 

data/lib/spec.rb

@@ -1,42 +0,0 @@
-#!/usr/bin/env jruby
-require "rubygems"
-require "bundler/setup"
-require "coffee-script"
-require "celerity"
-
-Dir.mkdir 'compiled' unless File.exists? 'compiled'
-raise "Can't create compile directory" unless File.directory? 'compiled'
-
-# Compile coffee scripts
-files = Dir['lib/**/*.coffee', 'spec/**/*.coffee']
-longest_name = files.map(&:length).max
-for file in files
-  begin
-    mtime = File.mtime file
-    
-    outfile = file.sub /^(lib|spec)/, 'compiled'
-    outfile = outfile.sub /\.coffee$/, '.js'
-    
-    next if File.exists?(outfile) && File.mtime(outfile) == mtime
-    
-    dir = outfile.sub /\/[^\/]+$/, ''
-    Dir.mkdir dir unless File.exists? dir
-    File.open outfile, 'w' do |f|
-      f.write CoffeeScript.compile(File.read(file))
-    end
-    File.utime mtime, mtime, outfile
-    puts outfile
-  rescue CoffeeScript::CompilationError => e
-    if e.message.match /^SyntaxError: (.*) on line (\d+)\D*$/
-      puts "\e[31m#{file}:#{$2}".ljust(longest_name + 6) + " #{$1}\e[0m"
-    elsif e.message.match /^Parse error on line (\d+): (.*)$/
-      puts "\e[31m#{file}:#{$1}".ljust(longest_name + 6) + " #{$2}\e[0m"
-    else
-      puts "#{file} - #{e.message}"
-    end
-  end
-end
-
-browser = Celerity::Browser.new
-browser.goto 'http://localhost/~tobico/SeaTurtle/spec/spec.html#terminal'
-puts browser.text