vitrine 0.0.6 → 0.0.7

data/Gemfile

@@ -6,6 +6,8 @@ source "http://rubygems.org"
 gem 'sinatra', '~> 1.4', require: 'sinatra/base'
 gem 'coffee-script', '~> 2.2'
 gem 'sass', '~> 3'
+gem 'guard'
+gem 'rack-livereload'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/README.rdoc

@@ -1,24 +1,46 @@
 = vitrine
 
 Is a very small, simple web server one-liner for modern web-apps, a bit in the style of
-lineman, serve and such. Does three things:
+lineman, serve and such. 
 
-* Assumes two directories exist in the tree you are using - "views" and "public"
-* Takes a single line ('vitrine') and starts on the default port (4000)
-* Converts .coffee to .js on the fly using ExecJS. Link to your .coffee files as if they were .js
-   "script.js" will automatically pick up "script.coffee", compile it and serve it to the browser
-* Converts .scss to .css on the fly using Sass. Link to your .scss files as if they were .css
-   "styles.css" will automatically pick up "styles.scss", compile it and serve it to the browser
+== Core idea of Vitrine
 
-CoffeeScript and SASS will be served right from your "public" directory, if there are no stylesheets
-with the same names. Templates from "views" will be used for pages that do not exist in HTML form.
+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.
 
-If you have errors in your CoffeeScript that prevent it from compiling you will get an error in your browser
-console. If you have CSS errors that prevent the SASS stylesheets from compiling you will get an error message
-in front of your body element.
+== How it works.
 
-Vitrine will not do any minification, packaging or baking at this point - it's meant to be like a display case.
-If you have a file called 'layout.erb' (or any other extension) it is going to be used as layout, but you can also do without it.
+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
+
+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.
+
+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.
+
+Vitrine will try to show you sensible errors if your SCSS or CoffeeScript fail to compile.
+
+== Automatic template pickup
+
+If you have "views" 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.
+
+== Automatic reload via Guard
+
+If your project already has a Guardfile, Vitrine will inject live-reloading hooks into your HTML using
+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.
 
 == Contributing to vitrine
  

data/lib/version.rb

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

data/lib/vitrine.rb

@@ -1,6 +1,7 @@
 require 'sinatra/base'
 require 'coffee-script'
 require 'sass'
+require 'pathname'
 
 require_relative 'version'
 
@@ -20,20 +21,23 @@ module Vitrine
     end
   end
   
-  # Will compile all SCSS and CoffeeScript, and also crawl the template tree and generate
-  # HTML for all of the files in the template tree. The resulting files will be copied to
-  # a directory of the build.
-  # def self.build!
-  
   # Run the server, largely stolen from Serve
   def self.run(options = DEFAULTS)
     check_dirs_present!
     
     app = Rack::Builder.new do
-      use Rack::CommonLogger
       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}"
+        # Assume livereload is engaged
+        use Rack::LiveReload
+      else
+        $stderr.puts "No Guardfile found, so there won't be any livereload injection"
+      end
+      
       vitrine = Vitrine::App.new
       vitrine.settings.set :root, options[:root]
       run vitrine
@@ -64,6 +68,8 @@ module Vitrine
   end
 end
 
+require 'rack-livereload'
+
 # A little idiosyncrastic asset server.
 # Does very simple things:
 # * sensible detector for default pages (they render from Sinatra view templates)
@@ -76,15 +82,21 @@ class Vitrine::App < Sinatra::Base
   set :root, File.expand_path(File.dirname(__FILE__))
   set :views, lambda { File.join(settings.root, "views") }
   
-  # Use Rack::TryStatic to attempt to load files from public first
-# require 'rack/contrib/try_static'
-# use Rack::TryStatic,
-#   :root => (settings.root + '/public'),
-#   :urls => %w(/), :try => %w(.html index.html /index.html)
+ 
   
   # For extensionless things try to pick out the related templates
   # from the views directory, and render them with a default layout
   get /^([^\.]+)$/ do | extensionless_path |
+    render_template(extensionless_path)
+  end
+  
+  
+  # Allow "fake" form submits
+  post /^([^\.]+)$/ do | extensionless_path |
+    render_template(extensionless_path)
+  end
+  
+  def render_template(extensionless_path)
     # Find the related view
     specific_view = extensionless_path + ".*"
     view_index = extensionless_path + "/index.*"
@@ -109,14 +121,17 @@ class Vitrine::App < Sinatra::Base
     # If nothing is found just bail
     unless template_path
       err = possible_globs.map{|e| e.inspect }.join(', ')
-      raise "No template found - tried #{er}"
+      raise "No template found - tried #{err}"
     end
     
-    $stderr.puts "Rendering via template #{template_path.inspect}"
+    relative_path = Pathname.new(template_path).relative_path_from(Pathname.new(settings.views))
+    
+    $stderr.puts "-> #{extensionless_path.inspect} : Rendering via template #{relative_path.to_s.inspect}"
     
+    locals = {}
     # Auto-pick the template engine out of the extension
     template_engine = File.extname(template_path).gsub(/^\./, '')
-    render(template_engine, File.read(template_path), :layout => get_layout)
+    render(template_engine, File.read(template_path), :layout => get_layout, :locals => locals)
   end
   
   def get_layout

data/vitrine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "vitrine"
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2013-11-05"
+  s.date = "2013-11-08"
   s.description = " Serves ERB templates with live CoffeeScript and SASS "
   s.email = "me@julik.nl"
   s.executables = ["vitrine"]
@@ -43,6 +43,8 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<sinatra>, ["~> 1.4"])
       s.add_runtime_dependency(%q<coffee-script>, ["~> 2.2"])
       s.add_runtime_dependency(%q<sass>, ["~> 3"])
+      s.add_runtime_dependency(%q<guard>, [">= 0"])
+      s.add_runtime_dependency(%q<rack-livereload>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
@@ -50,6 +52,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<sinatra>, ["~> 1.4"])
       s.add_dependency(%q<coffee-script>, ["~> 2.2"])
       s.add_dependency(%q<sass>, ["~> 3"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<rack-livereload>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
@@ -58,6 +62,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<sinatra>, ["~> 1.4"])
     s.add_dependency(%q<coffee-script>, ["~> 2.2"])
     s.add_dependency(%q<sass>, ["~> 3"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<rack-livereload>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.7"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vitrine
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -59,6 +59,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3'
+- !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
@@ -142,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -735079750998949370
+      hash: 3964899950062154621
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: