vitrine 0.0.7 → 0.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad569a8f77f0b68b74690887547a4b0b59e2de6c
+  data.tar.gz: eedc4cd325749f108a518be915db23b78974b39d
+SHA512:
+  metadata.gz: 7b6937c1067c446acf3f187df58004da35babcc8204450812e56d2ff0baac3c382649b55c0b743690ee6af1d4d798eae3e594225cf498c7b1b53b7d463a0df97
+  data.tar.gz: 9cfb7408119fcf4b81d4b42d71e55ec97724ccefbeeef350751f59b9c6d0d2786cceaca70e9c71216f023ebc6470022376bac981c44e1c12410995f96490e585

data/Gemfile

@@ -1,7 +1,4 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
 gem 'sinatra', '~> 1.4', require: 'sinatra/base'
 gem 'coffee-script', '~> 2.2'

data/README.rdoc

@@ -1,13 +1,17 @@
 = vitrine
 
 Is a very small, simple web server one-liner for modern web-apps, a bit in the style of
-lineman, serve and such. 
+lineman, serve and such. Will display your precious stuff on port 4000.
 
 == Core idea of Vitrine
 
 You want a server that will automatically wrap your CoffeeScript and SASS assets, and allow
 some rudimentary templating. This is practically enough for putting together MVP prototypes,
-especially as far as single-page apps go.
+especially as far as single-page apps go. You want this server to not coerce you into a specific
+SCSS framework, you don't want to scaffold anything, you don't want to have any configs defined and
+you hate running wizards.
+
+If most of the above is true, Vitrine is just what you need.
 
 == How it works.
 
@@ -15,22 +19,40 @@ Vitrine assumes that there are two directories under the current tree:
 * "public" - for the JS, for CSS and SCSS and in general all the static files server straight out
 * "views" - for the templates
 
-== Automatic compilation of assets
+== Automatic compilation of SCSS
+
+Any .scss file you shove into the "public" directory can be referenced as ".css" from your HTML code.
+Vitrine will automatically compile it via SASS.
+
+== Automatic compilation of CoffeeScript and source maps
+
+Same thing applies to CoffeeScript - put .coffee files in "public", and reference them as .js files.
+Vitrine will generate you source maps on the fly for pleasant browser debugging.
 
-From there on, any .scss file you shove into the "public" directory can be referenced as ".css" -
-Vitrine will automatically compile it via SASS. Same thing applies to CoffeeScript - put .coffee
-files in "public", and reference them as .js files.
+== Fallback to precompiled files
 
-Both of the above work as passthrough URLs - if you have real JS in there the files will be served
-as static assets. Also, once you compile the site for deployment your links won't go stale.
+Both SCSS and JS links will fall through to the static versions if you cache them on the server or as a result of
+asset compilation.
 
-Vitrine will try to show you sensible errors if your SCSS or CoffeeScript fail to compile.
+== Sensible error messages when automatic compilation fails
 
-== Automatic template pickup
+Vitrine will try to show you sensible errors if your SCSS or CoffeeScript fail to compile due to syntax errors and
+the like.
 
-If you have "views" available, Vitrine will try to pick up any usable file for any URL without extensions.
+== Do not recompile on every request
+
+Succesfully compiled assets will be stored in your +/tmp+ to save time on next reload, and the
+cache will be automatically flushed when the files are requested from the browser, but only if the modification
+dates of the source files are different than before.
+
+== Automatic Ruby template pickup
+
+If you have the "views" directory available, Vitrine will try to pick up any usable file for any URL without extensions.
 From there on, it's going to try to render it with the automatically picked template engine using the
-standard Sinatra facilities.
+standard Sinatra facilities. You can use HAML, LESS, Slim, ERB, Builder or anything else you like.
+
+If you are writing an SPA, you can make a file called "catch_all.erb" which is going to be the fall-through template
+for all missing URLs without extension.
 
 == Automatic reload via Guard
 
@@ -40,7 +62,9 @@ rack-livereload, so you won't need browser extensions at all.
 == Packaging and baking
 
 At this point the best way to bake a Vitrine site is to crawl it externally, but we are going to implement
-baking at some point.
+baking at some point. The idea is that you will end up upgrading the site to either a Node app or a Ruby app
+with it's own +config.ru+ - if after that point you still wish to use Vitrine, you can use it like a Rack
+middleware.
 
 == Contributing to vitrine
  

data/lib/atomic_write.rb

@@ -0,0 +1,35 @@
+module Vitrine
+  # Stolen from Rails
+  def self.atomic_write(file_name, temp_dir = Dir.tmpdir)
+    require 'tempfile' unless defined?(Tempfile)
+    require 'fileutils' unless defined?(FileUtils)
+  
+    temp_file = Tempfile.new(File.basename(file_name), temp_dir)
+    temp_file.binmode
+    yield temp_file
+    temp_file.close
+  
+    begin
+      # Get original file permissions
+      old_stat = File.stat(file_name)
+    rescue Errno::ENOENT
+      # No old permissions, write a temp file to determine the defaults
+      check_name = File.join(File.dirname(file_name), ".permissions_check.#{Thread.current.object_id}.#{Process.pid}.#{rand(1000000)}")
+      open(check_name, "w") { }
+      old_stat = File.stat(check_name)
+      File.unlink(check_name)
+    end
+
+    # Overwrite original file with temp file
+    FileUtils.mv(temp_file.path, file_name)
+
+    # Set correct permissions on new file
+    begin
+      File.chown(old_stat.uid, old_stat.gid, file_name)
+      # This operation will affect filesystem ACL's
+      File.chmod(old_stat.mode, file_name)
+    rescue Errno::EPERM
+      # Changing file ownership failed, moving on.
+    end
+  end
+end

data/lib/sourcemaps.rb

@@ -0,0 +1,23 @@
+require 'pathname'
+require 'json'
+
+module Vitrine
+  def self.build_coffeescript_source_map_body(full_coffeescript_file_path, public_dir_path)
+    
+    script = File.read(full_coffeescript_file_path)
+    
+    # We need to feed paths ON THE SERVER so that the browser can connect the coffee file, the map and the JS file
+    # - specify coffee source file explicitly (see http://coffeescript.org/documentation/docs/sourcemap.html#section-8)
+    # The paths need to be slash-prepended (server-absolute)
+    relative_path = '/' + Pathname.new(full_coffeescript_file_path).relative_path_from(Pathname.new(public_dir_path)).to_s
+    relative_js_path = '/' + relative_path.gsub(/\.coffee$/, '.js')
+    
+    options = {sourceMap: true}
+    
+    # coffee requires filename option to work with source maps (see http://coffeescript.org/documentation/docs/coffee-script.html#section-4)
+    options[:filename] = relative_js_path
+    options[:sourceFiles] = [relative_path]
+    
+    CoffeeScript.compile(script, options)["v3SourceMap"]
+  end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Vitrine
-  VERSION = '0.0.7'
+  VERSION = '0.0.9'
 end

data/lib/vitrine.rb

@@ -1,12 +1,16 @@
 require 'sinatra/base'
 require 'coffee-script'
+#require 'coffee-script-source'
 require 'sass'
 require 'pathname'
 
 require_relative 'version'
+require_relative 'atomic_write'
+require_relative 'sourcemaps'
 
 module Vitrine
   DEFAULTS = { root: Dir.getwd, port: 4000, host: '127.0.0.1' }
+  SEED = rand
   
   def self.check_dirs_present!
     views = DEFAULTS[:root] + '/views'
@@ -133,18 +137,15 @@ class Vitrine::App < Sinatra::Base
     template_engine = File.extname(template_path).gsub(/^\./, '')
     render(template_engine, File.read(template_path), :layout => get_layout, :locals => locals)
   end
-  
-  def get_layout
-    layouts = Dir.glob(File.join(settings.views, 'layout.*'))
-    layouts.any? ? :layout : false
-  end
+
   
   # Try to find SCSS replacement for missing CSS
   get /(.+)\.css/ do | basename |
     begin
       content_type 'text/css', :charset => 'utf-8'
+      # TODO: has no handling for .sass
       scss_source_path = File.join(settings.root, 'public', "#{basename}.scss")
-      Sass.compile_file(scss_source_path)
+      mtime_cache(scss_source_path) { Sass.compile_file(scss_source_path) }
     rescue Errno::ENOENT # Missing SCSS
       halt 404, "No such CSS or SCSS file found"
     rescue Exception => e # CSS syntax error or something alike
@@ -154,18 +155,64 @@ class Vitrine::App < Sinatra::Base
     end
   end
   
+  # Generate a sourcemap for CoffeeScript files
+  get /(.+)\.js\.map$/ do | basename |
+    begin
+      coffee_source = File.join(settings.root, 'public', "#{basename}.coffee")
+      content_type 'application/json', :charset => 'utf-8'
+      mtime_cache(coffee_source) do
+        Vitrine.build_coffeescript_source_map_body(coffee_source, File.join(settings.root, 'public'))
+      end
+    rescue Errno::ENOENT # Missing CoffeeScript
+      halt 404, "No coffeescript file found to generate the map for"
+    rescue Exception => e # CS syntax error or something alike
+      # inject it into the document
+      'console.error(%s)' % [e.class, "\n", "--> ", e.message].join.inspect
+    end
+  end
+  
   # Try to find CoffeeScript replacement for missing JS
-  get /(.+)\.js/ do | basename |
+  get /(.+)\.js$/ do | basename |
     # If this file is not found resort back to a coffeescript
     begin
-      coffee_source = File.read(File.join(settings.root, 'public', "#{basename}.coffee"))
+      coffee_source = File.join(settings.root, 'public', "#{basename}.coffee")
       content_type 'text/javascript', :charset => 'utf-8'
-      CoffeeScript.compile(coffee_source)
+      mtime_cache(coffee_source) do
+        ["//# sourceMappingURL=#{basename}.js.map", CoffeeScript.compile(File.read(coffee_source))].join("\n")
+      end
     rescue Errno::ENOENT # Missing CoffeeScript
       halt 404, "No such JS file and could not find a .coffee replacement"
     rescue Exception => e # CS syntax error or something alike
       # inject it into the document
       'console.error(%s)' % [e.class, "\n", "--> ", e.message].join.inspect
     end
-  end    
+  end
+  
+  
+  def mtime_cache(path, &blk)
+    # Mix in the request URL into the cache key so that we can hash
+    # .map sourcemaps and .js compiles based off of the same file path
+    # and mtime
+    
+    key = [File.expand_path(path), File.mtime(path), request.path_info, Vitrine::SEED]
+    cache_sha = Digest::SHA1.hexdigest(Marshal.dump(key))
+    
+    p = File.join('/tmp', cache_sha)
+    if File.exist?(p)
+      return File.read(p)
+    else
+      Vitrine.atomic_write(p) do |f|
+        $stderr.puts "---> Recompiling #{path}"
+        body = yield
+        f.write(body)
+        return body
+      end
+    end
+  end
+  
+  def get_layout
+    layouts = Dir.glob(File.join(settings.views, 'layout.*'))
+    layouts.any? ? :layout : false
+  end
+  
 end

data/vitrine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "vitrine"
-  s.version = "0.0.7"
+  s.version = "0.0.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2013-11-08"
+  s.date = "2013-11-11"
   s.description = " Serves ERB templates with live CoffeeScript and SASS "
   s.email = "me@julik.nl"
   s.executables = ["vitrine"]
@@ -24,6 +24,8 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "bin/vitrine",
+    "lib/atomic_write.rb",
+    "lib/sourcemaps.rb",
     "lib/version.rb",
     "lib/vitrine.rb",
     "test/helper.rb",
@@ -33,11 +35,11 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/julik/vitrine"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
+  s.rubygems_version = "2.0.6"
   s.summary = "Quickie micro-app preview server"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<sinatra>, ["~> 1.4"])

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: vitrine
 version: !ruby/object:Gem::Version
-  version: 0.0.7
-  prerelease: 
+  version: 0.0.9
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-08 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-script
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,39 +55,34 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-livereload
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -134,12 +118,11 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.7
-description: ! ' Serves ERB templates with live CoffeeScript and SASS '
+description: ' Serves ERB templates with live CoffeeScript and SASS '
 email: me@julik.nl
 executables:
 - vitrine
@@ -154,6 +137,8 @@ files:
 - README.rdoc
 - Rakefile
 - bin/vitrine
+- lib/atomic_write.rb
+- lib/sourcemaps.rb
 - lib/version.rb
 - lib/vitrine.rb
 - test/helper.rb
@@ -162,29 +147,25 @@ files:
 homepage: http://github.com/julik/vitrine
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3964899950062154621
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Quickie micro-app preview server
 test_files: []