starch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b6a4173185bf8ea05853f031b42dbfac996ca55
+  data.tar.gz: b37598511ef6e085c5627a7946f31523e37cd03d
+SHA512:
+  metadata.gz: 41681de3cf1828e9b02b1952362d86d6694d85d3421e1edff66e0cc251d97e56d023a9c4c7677220ea96b9d866ac32cdcb2b91713a32aac71cf1193375348c31
+  data.tar.gz: afa8d6c38037998b9e70bbd1db167642f1418c002f457deac637ad5f49a4e4923b893cb83b136710f2c88881f89ed4b702cc0486570244ca97717e247855445b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in starch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian O'Keefe
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# 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*
+of your toolchain. Starch gets you:
+
+* A simple directory structure
+* Barebones `bower.json` and `package.json` files for easily saving bower and
+  npm dependencies
+* SASS compilation
+* JS uglification
+* Coffeescript compilation
+* A preview server with livereload
+* The ability to build a production-ready version of your site
+
+## Prerequisites
+
+* [NodeJS](http://nodejs.org) with `npm`
+
+## Installation
+
+    $ gem install starch
+
+## Usage
+
+To scaffold a new site named `mysite`:
+
+    $ starch new 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
+    ├── 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/`
+  * Javascript files should have a `.js` extension and Coffeescript files should
+    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.
+* Images, fonts, and any other static assets should live in `images`, `fonts`,
+  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`.
+
+### Grunt tasks
+
+The entirety of the Starch toolchain is accessible through
+[Grunt](http://gruntjs.com). There are quite a few tasks defined in the
+Gruntfile, but there are only three that you should really care about:
+
+* `grunt serve`: Builds your site for staging and starts a preview server on
+  `http://0.0.0.0:8000`. `livereload` is enabled, so any time the `app`
+  directory changes, the site will be automatically refreshed in your browser.
+  Neat!
+* `grunt build`: Builds your site for production into the `public_html`
+  directory.
+* `grunt clean`: Nukes the `staging` and `public_html` directories. You can be
+  more specific with `grunt clean:staging` and `grunt clean:build`,
+  respectively.
+
+### It's just a scaffolder
+
+Starch is meant to provide a solid starting point for new projects; however, it
+may not always meet your particular needs. You're encouraged to modify the
+generated Gruntfile (or anything else) to meet the requirements of your project.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/starch

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'starch'
+Starch::Generator.start
+

data/features/new.feature

@@ -0,0 +1,27 @@
+Feature: scaffolding a site
+
+  Scenario: Scaffold a new site
+    When I run `bundle exec starch new foo`
+    Then the following directories should exist:
+      | foo |
+      | foo/node_modules |
+      | foo/app |
+      | foo/app/assets/files |
+      | foo/app/assets/fonts |
+      | foo/app/assets/images |
+      | foo/app/assets/js |
+      | foo/app/assets/stylesheets |
+    And the following files should exist:
+      | foo/Gruntfile.js |
+      | foo/package.json |
+      | foo/bower.json |
+      | foo/app/assets/stylesheets/main.scss |
+    And the file "foo/package.json" should contain:
+      """
+      "name": "foo",
+      """
+    And the file "foo/bower.json" should contain:
+      """
+      "name": "foo",
+      """
+    And the output should contain "foo created"

data/features/support/env.rb

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

data/lib/starch.rb

@@ -0,0 +1,3 @@
+require 'starch/version'
+require 'starch/generator'
+

data/lib/starch/generator.rb

@@ -0,0 +1,27 @@
+require 'thor'
+
+module Starch
+  class Generator < Thor
+    include Thor::Actions
+
+    attr_accessor :name
+
+    # gem root relative to here
+    source_root File.expand_path File.join(__FILE__, '..', '..', '..')
+
+    desc 'new [NAME]', 'Scaffold a new site named [NAME]'
+    def new(name)
+      # make sure name can be used in ERB
+      @name = name
+
+      say 'Generating skeleton', :yellow
+      directory 'skel', name
+
+      say 'Running `npm install`', :yellow
+      system "cd #{name}; npm install"
+
+      say "#{name} created", :green
+    end
+  end
+end
+

data/lib/starch/version.rb

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

data/skel/.gitignore

@@ -0,0 +1,4 @@
+node_modules
+.sass-cache
+logs
+staging

data/skel/Gruntfile.js

@@ -0,0 +1,129 @@
+module.exports = function(grunt) {
+  grunt.initConfig({
+    pkg: grunt.file.readJSON('package.json'),
+    clean: {
+      staging: ['staging'],
+      build: ['public_html']
+    },
+    coffee: {
+      staging: {
+        expand: true,
+        cwd: 'app',
+        src: 'assets/js/**/*.coffee',
+        dest: 'staging',
+        ext: '.js'
+      },
+      build: {
+        expand: true,
+        cwd: 'app',
+        src: 'assets/js/**/*.coffee',
+        dest: 'public_html',
+        ext: '.js'
+      }
+    },
+    copy: {
+      staging: {
+        files: [{
+          expand: true,
+          cwd: 'app',
+          src: ['**/*.html', 'assets/{files,fonts,images}/**/*'],
+          dest: 'staging'
+        }]
+      },
+      build: {
+        files: [{
+          expand: true,
+          cwd: 'app',
+          src: ['**/*.html', 'assets/{files,fonts,images}/**/*'],
+          dest: 'public_html'
+        }]
+      }
+    },
+    express: {
+      main: {
+        options: {
+          bases: ["staging"],
+          livereload: true,
+          hostname: '0.0.0.0',
+          port: 8000
+        }
+      }
+    },
+    sass: {
+      staging: {
+        files: [{
+          src: 'app/assets/stylesheets/main.scss',
+          dest: 'staging/assets/stylesheets/main.css'
+        }]
+      },
+      build: {
+        options: {
+          style: 'compressed'
+        },
+        files: [{
+          src: 'app/assets/stylesheets/main.scss',
+          dest: 'public_html/assets/stylesheets/main.css'
+        }]
+      }
+    },
+    uglify: {
+      options: {
+        mangle: false
+      },
+      staging: {
+        options: {
+          beautify: true
+        },
+        files: [{
+          expand: true,
+          cwd: 'app',
+          src: 'assets/js/**/*.js',
+          dest: 'staging'
+        }]
+      },
+      build: {
+        files: [{
+          expand: true,
+          cwd: 'app',
+          src: 'assets/js/**/*.js',
+          dest: 'public_html'
+        }]
+      }
+    },
+    watch: {
+      coffee: {
+        files: 'app/assets/js/**/*.coffee',
+        tasks: 'coffee:staging',
+        options: { livereload: true }
+      },
+      js: {
+        files: 'app/assets/js/**/*.js',
+        tasks: ['uglify:staging'],
+        options: { livereload: true }
+      },
+      sass: {
+        files: 'app/assets/stylesheets/**/*',
+        tasks: ['sass:staging'],
+        options: { livereload: true }
+      },
+      static: {
+        files: ['app/**/*.html', 'app/assets/{files,fonts,images}/**/*'],
+        tasks: ['copy:staging'],
+        options: { livereload: true }
+      }
+    }
+  });
+
+  grunt.loadNpmTasks('grunt-contrib-clean');
+  grunt.loadNpmTasks('grunt-contrib-coffee');
+  grunt.loadNpmTasks('grunt-contrib-copy');
+  grunt.loadNpmTasks('grunt-contrib-sass');
+  grunt.loadNpmTasks('grunt-contrib-uglify');
+  grunt.loadNpmTasks('grunt-contrib-watch');
+  grunt.loadNpmTasks('grunt-express');
+
+  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']);
+};
+

data/skel/bower.json.tt

@@ -0,0 +1,7 @@
+{
+  "name": "<%= name  %>",
+  "version": "0.0.0",
+  "license": "MIT",
+  "private": true
+}
+

data/skel/package.json.tt

@@ -0,0 +1,17 @@
+{
+  "name": "<%= name %>",
+  "version": "0.0.0",
+  "private": true,
+  "author": "<%= `git config user.name`.strip %> <<%= `git config user.email`.strip %>>",
+  "devDependencies": {
+    "grunt": "^0.4.5",
+    "grunt-contrib-clean": "^0.5.0",
+    "grunt-contrib-coffee": "^0.10.1",
+    "grunt-contrib-copy": "^0.5.0",
+    "grunt-contrib-sass": "^0.7.3",
+    "grunt-contrib-uglify": "^0.5.0",
+    "grunt-contrib-watch": "^0.6.1",
+    "grunt-express": "^1.4.0"
+  }
+}
+

data/starch.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'starch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'starch'
+  spec.version       = Starch::VERSION
+  spec.authors       = ["Brian O'Keefe"]
+  spec.email         = ['brian@bokstuff.com']
+  spec.summary       = %q{An opinionated skeleton generator for basic static sites.}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/brianokeefe/starch'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'aruba'
+end
+

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: starch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian O'Keefe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An opinionated skeleton generator for basic static sites.
+email:
+- brian@bokstuff.com
+executables:
+- starch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/starch
+- features/new.feature
+- features/step_definitions/starch_steps.rb
+- features/support/env.rb
+- lib/starch.rb
+- lib/starch/generator.rb
+- lib/starch/version.rb
+- skel/.gitignore
+- skel/Gruntfile.js
+- skel/app/assets/files/.empty_directory
+- skel/app/assets/fonts/.empty_directory
+- skel/app/assets/images/.empty_directory
+- skel/app/assets/js/.empty_directory
+- skel/app/assets/stylesheets/main.scss
+- skel/bower.json.tt
+- skel/package.json.tt
+- starch.gemspec
+homepage: https://github.com/brianokeefe/starch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.3.0
+signing_key: 
+specification_version: 4
+summary: An opinionated skeleton generator for basic static sites.
+test_files:
+- features/new.feature
+- features/step_definitions/starch_steps.rb
+- features/support/env.rb