vitrine 0.0.21 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49fedd846e606aff4360c45e4556e2e414825970
-  data.tar.gz: 5729915ef21f08204acd7c20c19b0d0ab4a425c5
+  metadata.gz: 69628563d51142a39a52b1327d3c863886e83688
+  data.tar.gz: 442bd527960f9ee697af2a42c169d4523e23245d
 SHA512:
-  metadata.gz: f7d58844b0376a6815342d87dc3b44cbd36eaf9825ffdf4401264ced9b67688b4a95c411e5abcc8bae5c06716f43a84e086411855936e71417ff6e351e3afe68
-  data.tar.gz: bcaa8447a233db781468ca3a58e3faf193f88823ae1559b0d180f14b538397e4a3539acd85b243ea244faac5d950d093b93c64b9a141c65e347836052457ae83
+  metadata.gz: 311ab78e5a8d58b5723134c3d733508e8889d92e99cb84f97b0f5c7a3a0a68885256215163a9bf86fe20bf164e9a27f799d62e5d95981b1dd10b83e3e7b64b75
+  data.tar.gz: bd09d14767ea2d5ed4af6fb1d4af9228ca808d73f53371e09cf48736443f82518805cdccf13b1215f2b88d93c373b11a49c4292655025fd8fe12288253131be2

data/README.md

@@ -2,7 +2,19 @@ A nimble web server one-liner for modern web-apps, a bit in the style of
 [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.
+It does some of what those other projects - only the stuff I need, with less. And *with* the stuff that I
+consider essential that still isn't supported where it should be supported. You can see Vitrine as 
+reinventing the wheel for sure, but the reason I wrote it is that I found the other development servers
+giving me death by a thousand paper cuts. Just that really:
+
+For example, `serve` which I loved dearly compiles `.coffee` files to JS with their native extension and
+does not do source maps. It also depends on Compass, so you probably won't be able to put in the newer
+version of SASS required for source maps. Sprockets does not do source maps either. The CoffeeScript
+gem does not propagate the syntax error line to your browser console, so it's notoriously difficult
+to find out where the errors are - because someone refused to accept a PR to the CoffeeScript gem -
+and these small irritating things just go on and on and on. In the meantime, I wanted a comfortable
+dev environment, without resorting to filesystem watching and rebuilding all my assets every time I change
+a character. So there: Vitrine.
 
 ## Core idea of Vitrine
 
@@ -18,26 +30,44 @@ If most of the above is true, Vitrine is just what you need.
 ## All you need is some `public`
 
 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 served straight out
 * `views` - for the templates, in any Ruby templating format you have
 
+This structure fits my preferred stack (Sinatra + Passenger) perfectly and allows running sane
+defaults. It is also migratable to another stack with minimum effort, while still having things
+like asset passthrough via Passenger work out of the box.
+
 ## Automatic compilation
 
 Vitrine is for **development**. It takes runtime compilation to 11 and beyound. Running tasks
 is all fine and good when you build out the app for production, but when iterating on UI it's essential
-to be able to just yank the file in there and carry on. THe compilation perks include:
+to be able to just yank the file in there and carry on. Compilation perks include:
 
 * Any `.scss` file you shove into the `public` directory can be referenced as `.css` from your HTML.
   Ask for `foo.css` and `foo.scss` will be compiled on the fly.
 * Any `.coffee` file you shove into the `public` directory can be references as `.js` from your HTML.
   Ask for `bar.js` and `bar.coffee` will be compiled on the fly.
-* CoffeeScript files will have source-maps out of the box for pleasant browser debugging.
-* Decent error messages will be shown for both invalid SCSS and invalid CoffeeScript.
+* CoffeeScript and SCSS files will have sourcemaps out of the box for pleasant browser debugging 
+  (something Sprockets still cannot do properly)
+* Decent error messages will be shown for both invalid SCSS and invalid CoffeeScript, including
+proper line reference for syntax errors (something Sprockets still cannot do properly)
+
+Vitrine favors **runtime assembly** for JavaScript and CSS. That is: load many files into your page
+in development mode, and build them into one chunk using external tools on deployment only.
+
+This helps accelerating the roundtrip time because if you use asset compilation on every reload
+when designing the UI you can easily get into the compile-concat-minify roundtrip times of more
+than a few seconds. This is too much.
+
+You are totally free to use your own compile-concat-minify pipelines when building for production.
+Unlike Sprockets Vitrine does not force you to inject any specific preprocessor directives into
+your scripts or CSS - this also facilitates debugging a GREAT LOT.
 
 ## Asset caching
 
 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.
+proxy on top of Vitrine if you use it in production.
 
 ## Automatic Ruby template pickup
 

data/lib/asset_compiler.rb

@@ -88,8 +88,8 @@ class Vitrine::AssetCompiler < Sinatra::Base
       # sourcemap header saved if we write out the compiled JS,
       # whereas otherwise it would have been discarded
       [
+        Vitrine.compile_coffeescript(source_body),
         "//# 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"

data/lib/sourcemaps.rb

@@ -5,9 +5,11 @@ module Vitrine
   
   # We need to override the Sass importer
   # so that it gives us URLs relative to the server root for sourcemaps
-  class Imp < Sass::Importers::Filesystem
+  class SassImporter < Sass::Importers::Filesystem
     def public_url(of_filesystem_path)
-      scss_uri = '/' + Pathname.new(of_filesystem_path).relative_path_from(Pathname.new(root)).to_s
+      # Importer defines a basic attribute called "root" which we set when initializing
+      # We have to return the server-relative URL of the path from here
+      '/' + Pathname.new(of_filesystem_path).relative_path_from(Pathname.new(root)).to_s
     end
   end
   
@@ -16,9 +18,9 @@ module Vitrine
     # Compute the paths relative to the webserver public root
     scss_uri = '/' + Pathname.new(scss_path).relative_path_from(Pathname.new(public_folder_path)).to_s
     css_uri = scss_uri.gsub(/\.scss$/, '.css')
-    sourcemap_uri= css_uri + '.map'
+    sourcemap_uri = css_uri + '.map'
     
-    engine_opts = {importer: Imp.new(public_folder_path), sourcemap: true, cache: false}
+    engine_opts = {importer: SassImporter.new(public_folder_path), sourcemap: true, cache: false}
     map_options = {css_path: css_uri, sourcemap_path: sourcemap_uri }
     
     engine = Sass::Engine.for_file(scss_path, engine_opts)
@@ -27,8 +29,8 @@ module Vitrine
     rendered, mapping = engine.render_with_sourcemap(sourcemap_uri)
     
     # Serialize the sourcemap
-    # We need to pass css_uri: so that the generated sourcemap refers to the
-    # file that can be pulled of the server as opposed to a file on the filesystem
+    # We need to pass the map options so that the generated sourcemap refers to the
+    # file that can be pulled off the server as opposed to a file on the filesystem
     sourcemap_body = mapping.to_json(map_options)
     
     # We are using a pre-release version of SASS which still had old sourcemap reference
@@ -36,6 +38,8 @@ module Vitrine
     chunk = Regexp.escape('/*@ sourceMappingURL')
     replacement = '/*# sourceMappingURL'
     re = /^#{chunk}/
+    
+    # And return both
     [rendered.gsub(re,replacement), sourcemap_body]
   end
   

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Vitrine
-  VERSION = '0.0.21'
+  VERSION = '0.0.22'
 end

data/test/test_vitrine_asset_compiler.rb

@@ -18,9 +18,11 @@ class TestVitrineAssetCompiler < Test::Unit::TestCase
     assert_equal 200, last_response.status
     assert_equal 'text/javascript;charset=utf-8', last_response.content_type
     
-    assert last_response.body.include?( 'alert("rockage!")'), 'Should include the compiled function'
-    assert last_response.body.include?( '//# sourceMappingURL=/nice.js.map'),
-      'Should include the reference to the source map'
+    assert_include last_response.body, 'alert("rockage!")', 'Should include the compiled function'
+    assert_include last_response.body, '//# sourceMappingURL=/nice.js.map', 'Should include the reference to the source map'
+    
+    last_line = last_response.body.split("\n").pop
+    assert_include last_line, 'sourceMappingURL'
   end
   
   def test_compiles_coffeescript_sourcemap

data/vitrine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "vitrine"
-  s.version = "0.0.21"
+  s.version = "0.0.22"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2014-01-13"
+  s.date = "2014-01-14"
   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.21
+  version: 0.0.22
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-13 00:00:00.000000000 Z
+date: 2014-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra