starch 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b6a4173185bf8ea05853f031b42dbfac996ca55
-  data.tar.gz: b37598511ef6e085c5627a7946f31523e37cd03d
+  metadata.gz: c170d06a472a33880620fe55dbda11895d058cb2
+  data.tar.gz: e28d81bc0d32a6d945648b22a906e4e8cc236b3c
 SHA512:
-  metadata.gz: 41681de3cf1828e9b02b1952362d86d6694d85d3421e1edff66e0cc251d97e56d023a9c4c7677220ea96b9d866ac32cdcb2b91713a32aac71cf1193375348c31
-  data.tar.gz: afa8d6c38037998b9e70bbd1db167642f1418c002f457deac637ad5f49a4e4923b893cb83b136710f2c88881f89ed4b702cc0486570244ca97717e247855445b
+  metadata.gz: 41b9b3c242a16301d1476e16d5770aaa263d19f642895f814de8e4488c02188dbcd7a1b0139499b5d01219d6716957bcd7e4b9e3b7a348a6a31aaaa3b09cf7a5
+  data.tar.gz: 04bd45f2f50b61569abe2ac6c8d1de19bb977c06e4ee30dcd5f02865afc74e18ef8a8f894783d271b7c2bd30c3eff7553e2746d55bb95580133b626bf9fae380

data/README.md

@@ -1,4 +1,5 @@
 # Starch
+[![Gem Version](https://badge.fury.io/rb/starch.svg)](http://badge.fury.io/rb/starch)
 
 Starch is an opinionated skeleton generator for basic static site development.
 It will get you going on new sites quickly by generating the meat and *potatoes*
@@ -7,6 +8,7 @@ of your toolchain. Starch gets you:
 * A simple directory structure
 * Barebones `bower.json` and `package.json` files for easily saving bower and
   npm dependencies
+* Templates and partials via Handlebars
 * SASS compilation
 * JS uglification
 * Coffeescript compilation
@@ -30,27 +32,45 @@ To scaffold a new site named `mysite`:
 Starch will create a directory `mysite` within the current directory that looks
 like this:
 
-    mysite
     ├── Gruntfile.js
     ├── app
-    │   └── assets
-    |       ├── files
-    |       ├── fonts
-    |       ├── images
-    │       ├── js
-    │       └── stylesheets
-    │           └── main.scss
+    │   ├── assets
+    │   │   ├── files
+    │   │   ├── fonts
+    │   │   ├── images
+    │   │   ├── js
+    │   │   └── stylesheets
+    │   │       └── main.scss
+    │   ├── pages
+    │   ├── partials
+    │   └── templates
+    │       └── default.hbt
     ├── bower.json
     ├── node_modules
     │   └── ...
     └── package.json
 
-* Your site's HTML can live anywhere in the `app` directory (preferably outside
-  of `assets`)
-* Javascript and Coffeescript should live in `app/assets/js/`
+* Your site's HTML files should live in `app/assets/pages/` with `.html`
+  extensions.
+  * These files will be parsed with Handlebars.
+  * You can include a YAML block (in between two lines of `---`) at the top of
+    the file with frontmatter. The data provided here will be available in the
+    file and in the file's template.
+* Partials should live in `app/assets/partials/` with `.hbp` extensions.
+  * You can use partials in your HTML files and in your templates in standard
+    Handlebars fashion ( `{{> my-partial-name}}` ).
+    * If you want to use a partial that is deeply nested, you don't need to
+      specify the path - just use the partial's name.
+* Templates should live in `app/assets/templates/` with `.hbt` extensions.
+  * `default.hbt` is the default template and needs to exist, otherwise you're
+    gonna have a bad time.
+  * You can change the template that a given `.html` file uses by specifying
+    `template: some-template-name` in the file's frontmatter.
+  * Use `{{{body}}}` in your templates where the HTML should be rendered.
+* Javascript and Coffeescript should live in `app/assets/js/`.
   * Javascript files should have a `.js` extension and Coffeescript files should
-    have a `.coffee` extension
-* SASS should live in `app/assets/stylesheets/`
+    have a `.coffee` extension.
+* SASS should live in `app/assets/stylesheets/`.
   * The only SASS file that will be compiled is
     `app/assets/stylesheets/main.scss`. This file should be used to import the
     rest of your SASS.
@@ -58,10 +78,13 @@ like this:
   and `files` (all in `app/assets`), respectively. These files will be copied
   1:1 without any additional processing.
 
-By default, your site will be built 1:1 with the `app` directory, so you can
-reference assets in your site like: `/assets/images/spuds.png`.
+When your site is staged or built, the `assets` directory will be placed in the
+root of the destination directory, alongside the rendered contents of the
+`pages` directory. For example, `app/pages/index.html` will end up as
+`/index.html`, and you can reference assets in your site like:
+`/assets/images/spuds.png`.
 
-### Grunt tasks
+### Grunt tasks - staging, building, cleaning
 
 The entirety of the Starch toolchain is accessible through
 [Grunt](http://gruntjs.com). There are quite a few tasks defined in the
@@ -85,7 +108,7 @@ generated Gruntfile (or anything else) to meet the requirements of your project.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/starch/fork )
+1. Fork it ( https://github.com/brianokeefe/starch/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,7 +1,6 @@
 require 'bundler/gem_tasks'
 require 'cucumber/rake/task'
 
-Bundler::GemHelper.install_tasks
 Cucumber::Rake::Task.new
 
 task :default => :cucumber

data/features/new.feature

@@ -11,11 +11,15 @@ Feature: scaffolding a site
       | foo/app/assets/images |
       | foo/app/assets/js |
       | foo/app/assets/stylesheets |
+      | foo/app/pages |
+      | foo/app/partials |
+      | foo/app/templates |
     And the following files should exist:
       | foo/Gruntfile.js |
       | foo/package.json |
       | foo/bower.json |
       | foo/app/assets/stylesheets/main.scss |
+      | foo/app/templates/default.hbt |
     And the file "foo/package.json" should contain:
       """
       "name": "foo",

data/features/support/env.rb

@@ -1,6 +1,6 @@
 require 'aruba/cucumber'
 
 Before do
-  @aruba_timeout_seconds = 30
+  @aruba_timeout_seconds = 60
 end
 

data/lib/starch/version.rb

@@ -1,3 +1,3 @@
 module Starch
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/skel/Gruntfile.js

@@ -26,7 +26,7 @@ module.exports = function(grunt) {
         files: [{
           expand: true,
           cwd: 'app',
-          src: ['**/*.html', 'assets/{files,fonts,images}/**/*'],
+          src: 'assets/{files,fonts,images}/**/*',
           dest: 'staging'
         }]
       },
@@ -34,7 +34,7 @@ module.exports = function(grunt) {
         files: [{
           expand: true,
           cwd: 'app',
-          src: ['**/*.html', 'assets/{files,fonts,images}/**/*'],
+          src: 'assets/{files,fonts,images}/**/*',
           dest: 'public_html'
         }]
       }
@@ -49,6 +49,31 @@ module.exports = function(grunt) {
         }
       }
     },
+    generator: {
+      options: {
+        defaultTemplate: 'default',
+        frontmatterType: 'yaml',
+        partialsGlob: 'app/partials/**/*.hbp',
+        templateExt: 'hbt',
+        templates: 'app/templates'
+      },
+      staging: {
+        files: [{
+          cwd: 'app/pages',
+          src: '**/*.html',
+          dest: 'staging',
+          ext: '.html'
+        }]
+      },
+      build: {
+        files: [{
+          cwd: 'app/pages',
+          src: '**/*.html',
+          dest: 'public_html',
+          ext: '.html'
+        }]
+      }
+    },
     sass: {
       staging: {
         files: [{
@@ -96,6 +121,11 @@ module.exports = function(grunt) {
         tasks: 'coffee:staging',
         options: { livereload: true }
       },
+      html: {
+        files: 'app/{pages,partials,templates}/**/*',
+        tasks: ['generator:staging'],
+        options: { livereload: true }
+      },
       js: {
         files: 'app/assets/js/**/*.js',
         tasks: ['uglify:staging'],
@@ -107,7 +137,7 @@ module.exports = function(grunt) {
         options: { livereload: true }
       },
       static: {
-        files: ['app/**/*.html', 'app/assets/{files,fonts,images}/**/*'],
+        files: 'app/assets/{files,fonts,images}/**/*',
         tasks: ['copy:staging'],
         options: { livereload: true }
       }
@@ -121,9 +151,10 @@ module.exports = function(grunt) {
   grunt.loadNpmTasks('grunt-contrib-uglify');
   grunt.loadNpmTasks('grunt-contrib-watch');
   grunt.loadNpmTasks('grunt-express');
+  grunt.loadNpmTasks('grunt-generator');
 
   grunt.registerTask('serve', ['stage', 'express', 'watch']);
-  grunt.registerTask('stage', ['clean:staging', 'copy:staging', 'sass:staging', 'coffee:staging', 'uglify:staging']);
-  grunt.registerTask('build', ['clean:build', 'copy:build', 'sass:build', 'coffee:build', 'uglify:build']);
+  grunt.registerTask('stage', ['clean:staging', 'generator:staging', 'copy:staging', 'sass:staging', 'coffee:staging', 'uglify:staging']);
+  grunt.registerTask('build', ['clean:build', 'generator:build', 'copy:build', 'sass:build', 'coffee:build', 'uglify:build']);
 };
 

data/skel/app/templates/default.hbt

@@ -0,0 +1,10 @@
+<!doctype html>
+<html>
+  <head>
+    <title>{{page.title}}</title>
+  </head>
+  <body>
+    {{{body}}}
+  </body>
+</html>
+

data/skel/package.json.tt

@@ -11,7 +11,8 @@
     "grunt-contrib-sass": "^0.7.3",
     "grunt-contrib-uglify": "^0.5.0",
     "grunt-contrib-watch": "^0.6.1",
-    "grunt-express": "^1.4.0"
+    "grunt-express": "^1.4.0",
+    "grunt-generator": "^0.4.0"
   }
 }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: starch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Brian O'Keefe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-12 00:00:00.000000000 Z
+date: 2014-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -93,6 +93,9 @@ files:
 - skel/app/assets/images/.empty_directory
 - skel/app/assets/js/.empty_directory
 - skel/app/assets/stylesheets/main.scss
+- skel/app/pages/.empty_directory
+- skel/app/partials/.empty_directory
+- skel/app/templates/default.hbt
 - skel/bower.json.tt
 - skel/package.json.tt
 - starch.gemspec