vitrine 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c4afcd269b9abc86ecb39b02b1a54c969ef98a2
-  data.tar.gz: 6487d2ed130c0ac7859ec8c7307a720054192396
+  metadata.gz: 2fcf49c459400509a306d68ac41f7fa0eb330322
+  data.tar.gz: 18797aa7373fcd1dd90fc9274f14f8ee133baf0d
 SHA512:
-  metadata.gz: 74a076f0a0c24bbe1e09d03fea87bf85747515104a2e83f6477b43b4950d244970a4c74e3cf465f9fc71e9a61aac2d791f5c733c5aa055b7260052950130dd44
-  data.tar.gz: c1cb7930928de1182867c03b3c8a073d364a847e521c9ad737c75a951d2c7b602781d579e389f25ce9be6f900a630881b1f7cec754e370e4ba5a67a0df1d89f4
+  metadata.gz: 0c07c3645db4170a981d9ffc192222db4ee9f0b7456705c93facacf581f69fe4168926e0778c336d5055dbb8386491f203c8b126ab323ed62a4a0e2903938bc2
+  data.tar.gz: 2f53f0309e7775e470c5325e0dee47c2f7670ca7316e626cf6533bf4442c53d69cc4cab08570fb922d09aec9ef76acbd5d01effb51537a36acc3c009769c8017

data/README.md

@@ -1,6 +1,8 @@
 A nimble web server one-liner for modern web-apps, a bit in the style of
-[lineman](https://github.com/testdouble/lineman), [serve](https://github.com/visionmedia/serve),
-another [serve](https://github.com/jlong/serve) and such. Will display your precious stuff on port 9292.
+[lineman](https://github.com/testdouble/lineman), [middleman](https://github.com/middleman/middleman), [serve](https://github.com/visionmedia/serve), another [serve](https://github.com/jlong/serve) 
+and such. Will display your precious stuff on port 9292.
+
+It does some of what those other projects - only the stuff I need, with less.
 
 ## Core idea of Vitrine
 
@@ -34,8 +36,8 @@ to be able to just yank the file in there and carry on. THe compilation perks in
 
 ## Asset caching
 
-Succesfully compiled assets will be cached to save time on next reload, and ETagged based on their
-mtime.
+Succesfully compiled assets will be ETagged based on their mtime. You should run an HTTP caching
+proxy on top of a Vitrine app in production.
 
 ## Automatic Ruby template pickup
 
@@ -43,8 +45,10 @@ If you have the "views" directory available, Vitrine will try to pick up any usa
 From there on, it's going to try to render it with the automatically picked template engine using the
 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.
+### The "catch-all" template for single-page apps
+ 
+If you are writing an SPA, you can make a template called `catch_all.erb` (or `.haml` or whatever really)
+in your `views` which is going to be the fall-through template for all missing URLs _without_ extension.
 
 ## Automatic reload via Guard
 
@@ -55,14 +59,7 @@ If your project already has a Guardfile, Vitrine will inject live-reloading hook
 
 Vitrine will `etag` all the precompiled assets for faster reloading.
 
-## 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. 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.
-
-## Using as a middleware
+## Using the whole Vitrine as Rack middleware
 
 Most actions in Vitrine will fall through to 404, so `Vitrine::App` can be used as a middleware handler.
 Put Vitrine into your application stack and it will complement your main application very nicely. But don't
@@ -81,6 +78,18 @@ Note that you _need_ to have an `ExecJS` environment on your server for this:
       vitrine.settings.set :root => File.dirname(__FILE__)
     end
 
+But you can also choose to have your JSON-serving API backend at the end of the Rack stack, and `Vitrine`
+on top of it for assets and templating - the choice is entirelly up to you.
+
+## Packaging and baking of assets
+
+This is on the TODO list, primarilly because it's notoriously difficult to splice assets for minification
+preserving their source maps.
+
+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
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/lib/asset_compiler.rb

@@ -29,14 +29,14 @@ class Vitrine::AssetCompiler < Sinatra::Base
   # 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
+      # TODO: handle .sass ext as well
       scss_source_path = File.join(get_public, "#{basename}.scss")
-      mtime_cache(scss_source_path) do
-        # TODO: Examine http://sass-lang.com/documentation/file.SASS_REFERENCE.html
-        # It already has provisions for error display, among other things
-        Sass.compile_file(scss_source_path, cache_location: '/tmp/vitrine/sass-cache')
-      end
+      mtime_cache(scss_source_path)
+      content_type 'text/css', :charset => 'utf-8'
+      
+      # TODO: Examine http://sass-lang.com/documentation/file.SASS_REFERENCE.html
+      # It already has provisions for error display, among other things
+      Sass.compile_file(scss_source_path, cache_location: '/tmp/vitrine/sass-cache')
     rescue Errno::ENOENT # Missing SCSS
       forward_or_halt "No such CSS or SCSS file found"
     rescue Exception => e # CSS syntax error or something alike
@@ -55,10 +55,9 @@ class Vitrine::AssetCompiler < Sinatra::Base
   get /(.+)\.js\.map$/ do | basename |
     begin
       coffee_source = File.join(get_public, "#{basename}.coffee")
+      mtime_cache(coffee_source)
       content_type 'application/json', :charset => 'utf-8'
-      mtime_cache(coffee_source) do
-        Vitrine.build_coffeescript_source_map_body(coffee_source, get_public)
-      end
+      Vitrine.build_coffeescript_source_map_body(coffee_source, get_public)
     rescue Errno::ENOENT # Missing CoffeeScript
       forward_or_halt "No coffeescript file found to generate the map for"
     rescue Exception => e # CS syntax error or something alike
@@ -71,17 +70,16 @@ class Vitrine::AssetCompiler < Sinatra::Base
     # If this file is not found resort back to a coffeescript
     begin
       coffee_source = File.join(get_public, "#{basename}.coffee")
+      mtime_cache coffee_source
       content_type 'text/javascript'
-      mtime_cache(coffee_source) do
-        source_body = File.read(coffee_source)
-        # We could have sent a header, but it's a nice idea to have the
-        # sourcemap header saved if we write out the compiled JS,
-        # whereas otherwise it would have been discarded
-        [
-          "//# sourceMappingURL=#{basename}.js.map", 
-          Vitrine.compile_coffeescript(source_body)
-        ].join("\n")
-      end
+      source_body = File.read(coffee_source)
+      # We could have sent a header, but it's a nice idea to have the
+      # sourcemap header saved if we write out the compiled JS,
+      # whereas otherwise it would have been discarded
+      [
+        "//# sourceMappingURL=#{basename}.js.map", 
+        Vitrine.compile_coffeescript(source_body)
+      ].join("\n")
     rescue Errno::ENOENT # Missing CoffeeScript
       forward_or_halt "No such JS file and could not find a .coffee replacement"
     rescue Exception => e # CS syntax error or something alike
@@ -92,31 +90,17 @@ class Vitrine::AssetCompiler < Sinatra::Base
     end
   end
   
-  def mtime_cache(path, &blk)
+  def mtime_cache(path)
     # 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, get_public]
     cache_sha = Digest::SHA1.hexdigest(Marshal.dump(key))
+    cache_control :public
+    etag cache_sha
     
-    # Store in a temp dir
-    FileUtils.mkdir_p '/tmp/vitrine'
-    p = '/tmp/vitrine/%s' % cache_sha
-    
-    # Only write it out unless a file with the same SHA does not exist
-    unless File.exist?(p)
-      Vitrine.atomic_write(p) do |f|
-        log "---> Recompiling #{path} for #{request.path_info}"
-        f.write(yield)
-      end
-    end
-    
-    # And send out the file that's been written
-    last_modified(File.mtime(p))
-    etag File.mtime(p).to_i.to_s
-    File.read(p)
+    log "---> Vitrine AC: Recompiling #{path} -> #{request.path_info}"
   end
-
   
   # Get path to the public directory, trying (in order:)
   # self.public_dir reader
@@ -132,7 +116,7 @@ class Vitrine::AssetCompiler < Sinatra::Base
     choices.compact.shift
   end
   
-  def forward_or_halt msg
+  def forward_or_halt(msg)
     if @app
       log "Forwarding, #{msg} -> pub #{get_public.inspect}"
       forward 
@@ -141,7 +125,7 @@ class Vitrine::AssetCompiler < Sinatra::Base
     end
   end
   
-  def log(mgs)
+  def log(msg)
     env['captivity.logger'].debug(msg) if env['captivity.logger']
   end
 end

data/lib/server.rb

@@ -22,7 +22,7 @@ module Vitrine::Server
     Rack::Builder.new do
       use Rack::ShowStatus
       use Rack::ShowExceptions
-  
+      
       guardfile_path = options[:root] + '/Guardfile'
       if File.exist?(guardfile_path)
         $stderr.puts "Attaching LiveReload via Guardfile at #{guardfile_path.inspect}"
@@ -70,6 +70,7 @@ module Vitrine::Server
     options = DEFAULTS.merge(passed_options)
     check_dirs_present!(options)
     
+    $stderr.puts "Vitrine v.#{Vitrine::VERSION} booting in dev mode"
     app = build_app(options)
     start_server(app, options)
   end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Vitrine
-  VERSION = '0.0.16'
+  VERSION = '0.0.17'
 end

data/lib/vitrine.rb

@@ -92,8 +92,6 @@ class Vitrine::App < Sinatra::Base
     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

data/vitrine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "vitrine"
-  s.version = "0.0.16"
+  s.version = "0.0.17"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2014-01-06"
+  s.date = "2014-01-08"
   s.description = " Serves ERB templates with live CoffeeScript and SASS "
   s.email = "me@julik.nl"
   s.executables = ["vitrine"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vitrine
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra