spar 1.0 → 1.0.5

data/README.md

@@ -1,14 +1,38 @@
 # Introduction
 
-Spar, the *Single Page Application Rocketship*, is an opinionated framework that aims to ease single-page web-app development by addressing major challenges:
+Spar is an opinionated framework that makes developing and deploying single-page web apps and static websites using modern front-end technology like SASS, Haml, and Coffeescript a cinch.
 
-  * Asset organization
-  * Compilation pipeline
-  * Build & deployment support
+We created Spar to decouple front-end development and deployment from specific backend languages like ruby, python, or Java. 
 
-Additionally, Spar provides templates & example projects for either a bare-bones project, or one with some of our favorite tools pre-included.
+Who should use Spar? 
+	
+  * Developers who have completely decoupled web applications (i.e. Old New Twitter) who want to do front-end development with state of the art tools like Coffeescript and SASS independent of their backend API stack.
+  
+  * Designers who love using modern technology like SASS, Less, and Haml but don't feel comfortable running and deploying apps in frameworks like Rails or Django.
+  
+  * Anyone who needs to make simple static websites and host them as static files on S3 (i.e. for really really cheap).
 
-Under the hood, Spar is a Sprockets-based, Rails-derived project. Spar uses Sprockets to provide a powerful asset-pipeline, while stripping out legacy web-app support and introducing tools & patterns specific to single-page apps.
+Under the hood, Spar uses Rack and Sprockets to provide a powerful asset pipeline similar to Rail's asset pipeline. If you're familiar with the Rail's asset pipeline, you'll feel right at home with Spar. 
+
+What makes Spar different?
+
+  * Intepret configuration variables in your assets. For instance, setup an `api_url` variable that's different for your development vs. production environments.
+  
+  * No server-side language knowledge necessary. If you know how to type a few commands into the terminal you'll be good to go.
+  
+  * Built in support for CSS, Sass, Less, HTML, Haml, Javascript, Coffeescript, Compass, Haml-Coffeescript templating, and more.
+  
+If you run into issues, please use the [issues page](https://github.com/GoBoundless/spar/issues) to report them and we'll help you out.
+
+# Example Spar Applications
+
+For your reference, and to build on top of, we've created two example applications using Spar.
+
+The first is the quintessential TODO application as popularized by [addyosmani](http://addyosmani.github.com/todomvc/). The second, is a bootstrap application containing some of our favorite tools to kick-start the pretty (jQuery, Backbone, and Twitter Bootstrap).
+
+Both can be found at our [spar-examples](https://github.com/GoBoundless/spar-examples) repo.
+
+You can also see a demo of the TODO app [here](http://spar-demo-todo.boundless.com).
 
 # Requirements
 
@@ -161,14 +185,6 @@ Or, in CSS:
 ```
 You only need to do this for additional root-level Javascript and CSS based files, as Spar deploys all images, pages, and static files automatically.
 
-# Example Spar Applications
-
-For your reference, and to build on top of, we've created two example applications using Spar.
-
-The first is the quintessential TODO application as popularized by [addyosmani](http://addyosmani.github.com/todomvc/). The second, is a bootstrap application containing some of our favorite tools to kick-start the pretty (jQuery, Backbone, and Twitter Bootstrap).
-
-Both can be found at our [spar-examples](https://github.com/BoundlessLearning/spar-examples) repo.
-
 # Deploying Your Spar App
 
 Spar supports three different deployment methods out of the box:
@@ -216,56 +232,16 @@ production:
   deploy_bucket: "mysite.test.com"
 ```
 
-You'll need to enter your own credentials. You can find your S3 credentials on the [AWS Security Credentials](https://portal.aws.amazon.com/gp/aws/securityCredentials) page. 
-
-Next, you'll need visit the [AWS  S3 Console](https://console.aws.amazon.com/s3/home) and create a bucket to host your app. We suggest using the same as your fully qualified domain name. You should not use this bucket for anything else.
-
-![click here](http://spar-screenshots.s3.amazonaws.com/s3_click_here.png)
-
-![create bucket](http://spar-screenshots.s3.amazonaws.com/s3_create_bucket.png)
-
-Next, you'll need to turn on [S3 Website Hosting](http://aws.typepad.com/aws/2011/02/host-your-static-website-on-amazon-s3.html) in the S3 console.
-
-![bucket properties](http://spar-screenshots.s3.amazonaws.com/s3_bucket_properties.png)
-
-![enable website](http://spar-screenshots.s3.amazonaws.com/s3_enable_website.png)
-
-You'll need to create a new `CNAME` record. How this works is up to your hosting provider, but it should look something like this.
-
-    app.example.com. IN CNAME app.example.com.s3-website-us-east-1.amazonaws.com.
-
-### About Logging
-
-You'll probably want to be able to log requests to your site. Even though your app uses cutting edge webscale tools like Airbrake, Loggly, Google Analytics, MixPanel, et al, eventually you'll want to know how many people hit you with IE6 or NoScript, and you gave them the middle finger.
-
-Create a bucket log using the [AWS  S3 Console](https://console.aws.amazon.com/s3/home). Give it a name like `logs.example.com` and update either your app's CloudFront distribution or your app's S3 bucket to write its log files to this log bucket.
-
-![enable logging](http://spar-screenshots.s3.amazonaws.com/s3_enable_logging.png)
+Now Spar will dpeloy your app directly to an S3 bucket. To learn more and see how to setup an S3 bucket as a website, see the [S3 Deployment Wiki Page](https://github.com/GoBoundless/spar/wiki/S3-Deployment)
 
 
 ## CloudFront Deployment
 
-Cloudfront deployment is very similar to S3 deployment, but you need to add a `cloudfront_distribution` property to your config file:
-
-```yaml
-production:
-  deploy_strategy: cloudfront
-  aws_key: "my_access_key"
-  aws_secret: "my+super+secret+access+key"
-  deploy_bucket: "mysite.test.com"
-  cloudfront_distribution: "distribution+id"
-```
-Cloudfront will turn your fast site into a *really* fast site. From the [AWS  CloudFront Console](https://console.aws.amazon.com/cloudfront/home), create a new distribution *with the website form of your bucket name as the origin* and save the ID in your config.yml.
-
-Take note of the **Domain Name** field (something like `d242ood0j0gl2v.cloudfront.net`). You will need to replace the CNAME you created earlier.
-
-    app.example.com. IN CNAME d242ood0j0gl2v.cloudfront.net.
-
-Now, every time you deploy, Spar will automatically issue CloudFront invalidation requests for index.html (and anything else without a hash value). CloudFront invalidations usually take around 8 minutes, but they can take quite a bit lot longer when Amazon is having problems.
+For details on Cloudfront deploys please see the [Cloudfront Deployment Wiki Page](https://github.com/GoBoundless/spar/wiki/Cloudfront-Deployment)
 
 # Issues & Bugs
 
-Please use our Github [issue tracker](https://github.com/BoundlessLearning/spar/issues) for Spar.
+Please use our Github [issue tracker](https://github.com/GoBoundless/spar/issues) for Spar.
 
 # License
 

data/lib/spar.rb

@@ -2,6 +2,11 @@ require 'rack'
 require 'pathname'
 require 'sprockets'
 require 'haml'
+require 'sass'
+require 'sprockets-sass'
+require 'compass'
+require 'coffee-script'
+require 'haml_coffee_assets'
 
 module Spar
   autoload :Version, 'spar/version'
@@ -71,6 +76,9 @@ module Spar
     @sprockets ||= begin
       env = Sprockets::Environment.new(root)
 
+      HamlCoffeeAssets.config.namespace  = "window.HAML"
+      HamlCoffeeAssets.config.escapeHtml = false
+
       if settings['compress']
         env.js_compressor  = Compressor::JS.new
         env.css_compressor = Compressor::CSS.new
@@ -83,7 +91,7 @@ module Spar
         env.append_path(root.join('vendor', child_folder))
         Gem.loaded_specs.each do |name, gem|
           env.append_path(File.join(gem.full_gem_path, 'vendor', 'assets', child_folder))
-          env.append_path(File.join(gem.full_gem_path, 'app', 'assets', 'assets', child_folder))
+          env.append_path(File.join(gem.full_gem_path, 'app', 'assets', child_folder))
         end
       end
 
@@ -94,8 +102,6 @@ module Spar
       end
 
       env.register_engine '.haml',    Tilt::HamlTemplate
-      env.register_engine '.md',      Tilt::BlueClothTemplate
-      env.register_engine '.textile', Tilt::RedClothTemplate
 
       env.register_postprocessor 'text/css',               Spar::DirectiveProcessor
       env.register_postprocessor 'application/javascript', Spar::DirectiveProcessor

data/lib/spar/cli.rb

@@ -26,10 +26,9 @@ module Spar
     desc 'deploy', 'Deploy the project.'
 
     def deploy(environment='production')
-      say "Deploying: #{Spar.root}"
-
       Spar.environment = environment
-      
+      say "Deploying #{Spar.root} to the #{Spar.environment} environment"
+
       if strategy = Spar.settings['deploy_strategy']
         require "spar/deployers/#{strategy}_deployer"
 
@@ -44,6 +43,7 @@ module Spar
     desc 'version', 'Show the current version of Spar'
 
     def version
+      require 'spar/version'
       puts "Spar Version #{Spar::VERSION}"
     end
 

data/lib/spar/compiler.rb

@@ -42,16 +42,18 @@ module Spar
         }
       elsif logical_path =~ /\w+\.(?!js|css).+/
         return {
-          :digest         => Spar.settings['digests'], 
+          :digest         => Spar.settings['digest'], 
           :cache_control  => Spar.settings['cache_control']
         }
       elsif file_path = Spar.sprockets.resolve(logical_path)
         file = File.open(file_path, "rb").read
         if header = file[Sprockets::DirectiveProcessor::HEADER_PATTERN, 0]
-          if directive = header.lines.peek[Sprockets::DirectiveProcessor::DIRECTIVE_PATTERN, 1]
-            name, *args = Shellwords.shellwords(directive)
-            if name == 'deploy'
-              return deploy_directive_info(*args)
+          header.lines.each do |header|
+            if directive = header[Sprockets::DirectiveProcessor::DIRECTIVE_PATTERN, 1]
+              name, *args = Shellwords.shellwords(directive)
+              if name == 'deploy'
+                return deploy_directive_info(*args)
+              end
             end
           end
         end
@@ -65,7 +67,7 @@ module Spar
         options[arg.split(':')[0]] = arg.split(':')[1]
       end
       {
-        :digest         => Spar.settings['digests'],
+        :digest         => Spar.settings['digest'],
         :cache_control  => options['cache_control'] || Spar.settings['cache_control']
       }
     end

data/lib/spar/deployers/cloudfront_deployer.rb

@@ -1,4 +1,5 @@
 require 'cloudfront-invalidator'
+require 'spar/deployers/s3_deployer'
 
 class CloudfrontDeployer < S3Deployer
 
@@ -30,4 +31,4 @@ class CloudfrontDeployer < S3Deployer
     super
   end
 
-end
+end

data/lib/spar/exceptions.rb

@@ -319,9 +319,6 @@ TEMPLATE = <<-HTML # :nodoc:
       </table>
       <div class="clear"></div>
     </div> <!-- /RACK ENV -->
-
-    <p id="explanation">You're seeing this error because you have
-enabled the <code>show_exceptions</code> setting.</p>
   </div> <!-- /WRAP -->
   </body>
 </html>

data/lib/spar/generators/templates/base/config.yml

@@ -5,7 +5,7 @@ default:
 
 development:
   debug: true
-  
+
 production:
   debug: false
   digest: true

data/lib/spar/generators/templates/pages/haml/app/pages/index.html.haml

@@ -1,11 +1,18 @@
-!!! Strict
+!!! 5
 %html
   %head
-    %title Spar App
+    %title New Spar App
     [{ stylesheet_link_tag(application) }]
+    
   %body
-    %h1
-      Nice app!
-    %h2
-      Point LiveReload to the directory of this project if you want to use it. No extensions or JS required.
+    #wrap
+      %img{src: "[{ path_to(spar.png) }]", width: 200}
+      #summary
+        %h1 Spar
+        %h2 Welcome to your new Spar app.
+        %p 
+          If you have any questions, please checkout out the 
+          %a{href: "https://github.com/GoBoundless/spar", target: "_blank"} README
+          on Github. Have Fun!
+
     [{ javascript_include_tag(application) }]

data/lib/spar/generators/templates/pages/html/app/pages/index.html

@@ -1,16 +1,22 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<!DOCTYPE html>
 <html>
   <head>
-    <title>Spar App</title>
+    <title>New Spar App</title>
     [{ stylesheet_link_tag(application) }]
   </head>
   <body>
-    <h1>
-      Nice app!
-    </h1>
-    <h2>
-      Point LiveReload to the directory of this project if you want to use it. No extensions or JS required.
-    </h2>
+    <div id='wrap'>
+      <img src='[{ path_to(spar.png) }]' width='200' />
+      <div id='summary'>
+        <h1>Spar</h1>
+        <h2>Welcome to your new Spar app.</h2>
+        <p>
+          If you have any questions, please checkout out the
+          <a href='https://github.com/GoBoundless/spar' target='_blank'>README</a>
+          on Github. Have Fun!
+        </p>
+      </div>
+    </div>
     [{ javascript_include_tag(application) }]
   </body>
-</html>
+</html>

data/lib/spar/generators/templates/styles/css/app/stylesheets/application.css

@@ -13,6 +13,47 @@
  *= require_tree .
  */
 
+* {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  outline: 0; }
+
+html {
+  min-height: 100%;
+  height: 100%; }
+
 body {
+  min-height: 100%;
+  height: 100%;
+  background: #eeeeee;
+  margin: 0;
+  padding: 0;
+  font-family: "Lucida Grande", "Lucida Sans Unicode", "Garuda"; }
+
+#wrap {
+  min-height: 100%;
+  height: 100%;
+  width: 1000px;
   background: white;
-}
+  margin: 0 auto;
+  padding: 0 50px 0 50px;
+  border-left: 1px solid #dddddd;
+  border-right: 1px solid #dddddd;
+  text-align: center; }
+
+img {
+  margin-top: 80px; }
+
+a {
+  color: #be292b; }
+
+h1 {
+  margin: 0 0 0.1em 0;
+  font-size: 72px;
+  color: #be292b; }
+
+h2 {
+  margin: 0 0 1em 0;
+  font-size: 22px;
+  color: #333333; }

data/lib/spar/generators/templates/styles/sass/app/stylesheets/application.css.sass

@@ -11,5 +11,47 @@
 //= require_self
 //= require_tree .
 
+*
+  margin: 0
+  padding: 0
+  border: 0
+  outline: 0
+
+html
+  min-height: 100%
+  height: 100%
+
 body
-  background: white
+  min-height: 100%
+  height: 100%
+  background: #EEEEEE
+  margin: 0
+  padding: 0
+  font-family: "Lucida Grande", "Lucida Sans Unicode", "Garuda"
+
+#wrap
+  min-height: 100%
+  height: 100%
+  width: 1000px
+  background: #FFFFFF
+  margin: 0 auto
+  padding: 0 50px 0 50px
+  border-left: 1px solid #DDDDDD
+  border-right: 1px solid #DDDDDD
+  text-align: center
+
+img
+  margin-top: 80px
+
+a
+  color: #BE292B
+
+h1
+  margin: 0 0 0.1em 0
+  font-size: 72px
+  color: #BE292B
+
+h2
+  margin: 0 0 1em 0
+  font-size: 22px
+  color: #333333

data/lib/spar/helpers.rb

@@ -72,7 +72,7 @@ module Spar
       end
 
       def digest_for(logical_path, options={})
-        if Spar.settings['digests'] && !Spar.settings['debug'] && asset = Spar.sprockets.find_asset(logical_path, options)
+        if Spar.settings['digest'] && !Spar.settings['debug'] && asset = Spar.sprockets.find_asset(logical_path, options)
           return asset.digest_path
         end
         return logical_path

data/lib/spar/version.rb

@@ -1,3 +1,3 @@
 module Spar
-  VERSION = "1.0"
+  VERSION = "1.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spar
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-26 00:00:00.000000000 Z
+date: 2012-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -197,11 +197,36 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: sprockets-sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: compass
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.12.2
@@ -210,20 +235,23 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.12.2
 - !ruby/object:Gem::Dependency
-  name: sprockets-sass
+  name: haml_coffee_assets
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.5'
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -231,10 +259,10 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.5'
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -323,22 +351,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.4.2
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  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: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -371,22 +383,6 @@ dependencies:
     - - ! '>='
       - !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: yui-compressor
   requirement: !ruby/object:Gem::Requirement
@@ -404,7 +400,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bluecloth
+  name: cloudfront-invalidator
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -419,9 +415,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Spar uses Sprockets to provide an asset development environment very
-  similar to the asset pipeline found in Rails. It allows you to use all the awesome
-  features of the asset pipeline without all the heft of Rails.
+description: Spar uses Rack and Sprockets to provide an asset development environment
+  very similar to the asset pipeline found in Rails. It also has built in deployment
+  tasks for deploying your entire site to AWS S3 and Cloudfront.
 email:
 - matt@boundless.com
 executables:
@@ -443,8 +439,10 @@ files:
 - lib/spar/deployers/s3_deployer.rb
 - lib/spar/directive_processor.rb
 - lib/spar/exceptions.rb
+- lib/spar/generators/templates/base/app/images/spar.png
 - lib/spar/generators/templates/base/config.yml
 - lib/spar/generators/templates/base/README
+- lib/spar/generators/templates/base/static/favicon.ico
 - lib/spar/generators/templates/pages/haml/app/pages/index.html.haml
 - lib/spar/generators/templates/pages/html/app/pages/index.html
 - lib/spar/generators/templates/scripts/coffee/app/javascripts/application.js.coffee
@@ -458,7 +456,7 @@ files:
 - lib/spar/tasks.rb
 - lib/spar/version.rb
 - lib/spar.rb
-homepage: http://github.com/BoundlessLearning/spar
+homepage: http://goboundless.github.com/spar
 licenses: []
 post_install_message: 
 rdoc_options: []