guard_boilerplate 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (Mar 19, 2011)
+
+Initial release.

data/Gemfile

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

data/README.md

@@ -0,0 +1,146 @@
+# WTF?
+
+In the vein of the [HTML5 Boilerplate](http://html5boilerplate.com) project, this is a simple script that allows you to run [Guard](http://github.com/guard/guard) to refresh your web browser and optionally recompile [Sass](http://sass-lang.com/) files to CSS and/or [Haml](http://haml-lang.com/) files to HTML. Just install it, run`gbp start` in your project directory root and you're off to the races. A Guardfile gets created which you can customize to your tastes.
+
+# tl;dr
+
+Impatient? Have Ruby installed and understand what a gem is? Use the Boilerplates? Rocking Sass and Haml? Great!
+
+1. Install the [LiveReload](https://github.com/mockko/livereload#readme) extension in your browser
+2. Install guard_boilerplate and start a new project:
+        gem install guard_boilerplate
+        mkdir my_site && cd my_site
+        curl -L 'https://github.com/paulirish/html5-boilerplate/tarball/v1.0rc' | tar -xzf - --strip-components 1
+        gbp hamlize && gbp sassify
+        gbp start
+3. Hit the LiveReload **LR** button in your browser
+4. Edit!
+
+Confused? Read on...
+
+# Before!
+
+## Ruby
+
+You will need to have Ruby already installed on your system, but chances are you do already.
+
+### Mac OS X And Linux (RVM)
+
+If you are on Mac OS X or Linux, then [RVM](http://rvm.beginrescueend.com/) to the rescue:
+
+    bash < <( curl http://rvm.beginrescueend.com/releases/rvm-install-head )
+    source "$HOME/.rvm/scripts/rvm"
+    cat <<BASHRC >> "$HOME/.bash_profile"
+     
+    [[ -s "\$HOME/.rvm/scripts/rvm" ]] && . "\$HOME/.rvm/scripts/rvm"
+    BASHRC
+    rvm 1.9.2 install && rvm 1.9.2 --default
+
+### Windows (Rails Installer)
+
+This is slighty more than you'll need, but do yourself a favor and use the [Rails Installer](http://railsinstaller.org/) for Windows. It's fast, painless and as a bonus you'll be ready to crank out a [Ruby on Rails](http://rubyonrails.org/) or [Sinatra](http://www.sinatrarb.com/) web application in 5 minutes flat. \[*pause...*\] See, wasn't that easy?
+
+## LiveReload Browser Extension
+
+Secondly, you will need to install the LiveReload browser extension into your browser-du-jour ([Chrome Chrome Chome!](http://google.com/chrome)). For more detailed instructions, see the LiveReload's [github README](https://github.com/mockko/livereload) and look for the extension installation section.
+
+# Install!
+
+Are you ready?
+
+    gem install guard_boilerplate
+
+Now give yourself a slap on the back.
+
+# Use!
+
+## Refresh Automatically
+
+Change directory into your new web-wonder project directory, and start the listener:
+
+    cd my_site
+    gbp start
+
+Using the bassass [HTML5 Boilerplate](http://html5boilerplate.com/) as your base? I thought
+so. Try this one out, my Mac and Linux pals:
+
+    mkdir my_site && cd my_site
+    curl -L 'https://github.com/paulirish/html5-boilerplate/tarball/v1.0rc' | tar -xzf - --strip-components 1
+    gbp start
+
+LiveReload needs to refresh an `http://` URL (rather than a `file://`), so an embedded HTTP server will fire up by default on port 3000 thanks to the [WEBrick guard](https://github.com/fnichol/guard-webrick).
+
+Finally, if you're sitting there with your browser page open, don't forget to activate the LiveReload extension. Otherwise, it's going to get pretty darn boring. Open your `my_site` project in your text editor, update `index.html`, save, and marvel ;)
+
+## Sass Up Your Stylesheets
+
+Would you rather author Sass stylesheets? Migrate your `*.css` files to `*.scss` files automatically:
+
+    gbp sassify
+
+Your CSS files will be generated back into `css/` on save. Sweet.
+
+## Haml Your Markup
+
+If Haml is your bag, then you can also convert your `*.html` files to `*.haml` with a quick round of:
+
+    gbp hamlize
+
+## Minify Your Haml And SASS Output
+
+To compress your HTML and CSS output (suitable for production):
+
+    gbp minify
+
+## Prettify Your Haml And Sass Output
+
+To generate all your HTML and CSS output (suitable for development):
+
+    gbp prettify
+
+# Customize!
+
+The file that controls "what happens when" is your `Guardfile` which is pretty straight forward. The `'livereload'` block has a bundle of `watch` listeners that are file patterns. Whenever any of these files change, any attached web browsers will be reloaded with LiveReload.
+
+If your images directory was actually `images/` and could contain gifs, then you could modify the `Guardfile` line from:
+
+    watch(%r{img/.+\.(png|jpeg|jpg)})
+
+to:
+
+    watch(%r{images/.+\.(gif|png|jpeg|jpg)})
+
+If you need the HTTP server to run on another port, update the `'webrick'` block to:
+
+    guard 'webrick', :port => 8080 do
+    end
+
+Don't worry, your web browser will keep up.
+
+# Profit!
+
+Just fill in your [Step 2](http://www.youtube.com/watch?v=y-eak9Jz3_k) and you're on your way.
+
+# Development
+
+* Source hosted at [GitHub](http://github.com/fnichol/guard_boilerplate).
+* Report Issues/Questions/Feature requests on [GitHub Issues](http://github.com/fnichol/guard_boilerplate/issues).
+
+Pull requests are very welcome!
+
+# Authors
+
+* [Fletcher Nichol](http://github.com/fnichol) ([@fnichol](http://twitter.com/fnichol))
+
+Special credit to [Natasha Nunn](http://github.com/nnunn) ([@nnunny](http://twitter.com/nnunny)) for giving me the lunch hour power project idea
+
+# References
+
+* [Guard](https://github.com/guard/guard)
+* [Guard-LiveReload plugin](https://github.com/guard/guard-livereload)
+* [Guard-Sass plugin](https://github.com/guard/guard-sass)
+* [Guard-WEBrick plugin](https://github.com/fnichol/guard-webrick)
+* [LiveReload](https://github.com/mockko/livereload)
+* [Sass](http://sass-lang.com/)
+* [RVM](http://rvm.beginrescueend.com/)
+* [Rails Installer](http://railsinstaller.org)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/gbp

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'thor'
+require 'guard'
+require 'fileutils'
+require 'sass'
+require 'haml/html'
+
+class GuardBoilerPlate < Thor
+  include Thor::Actions
+
+  desc "start", "Starts a guard process for development"
+  def start
+    unless File.exists?(File.expand_path(File.join(Dir::pwd, 'Guardfile')))
+      say "\nYou don't have a Guardfile in this directory, let's make it!", :green
+      invoke :init
+    end
+    load File.join(Gem.loaded_specs['guard'].full_gem_path, 'bin', 'guard')
+  end
+
+  desc "init", "Generates a Guardfile in the current working directory"
+  def init
+    copy_file( File.join(%w{templates Guardfile}), "Guardfile")
+    copy_file( File.join(%w{README.md}), "HOWTOUSE.md")
+  end
+
+  desc "sassify", "Migrates CSS files to SCSS files"
+  def sassify
+    if File.directory? "sass"
+      say "\nA sass/ directory already exists, so skipping\n", :red
+    else
+      say "Copying CSS files to SCSS...", :green
+      FileUtils.mkdir_p "sass", :verbose => true
+      Dir["css/**/*.css"].each do |css_file|
+        scss_file = css_file.sub(/^css/, 'sass').sub(/\.css$/, '.scss')
+        FileUtils.mkdir_p(File.dirname(scss_file))
+        FileUtils.cp css_file, scss_file, :verbose => true
+        say "Generated #{scss_file} from #{css_file} (straight copy)", :green
+      end
+    end
+  end
+
+  desc "hamlize", "Migrates your HTML files to Haml files"
+  def hamlize
+    if File.directory? "haml"
+      say "\nA haml/ directory already exists, so skipping\n", :red
+    else
+      say "Converting HTML files to Haml...", :green
+      FileUtils.mkdir_p "haml", :verbose => true
+      Dir["**/*.html"].each { |html_file| html_to_haml(html_file) }
+    end
+  end
+
+  desc "minify", "Compresses your HTML files from Haml and CSS files from SCSS"
+  def minify
+    if File.directory? "haml"
+      say "\nMinifying HTML from Haml...", :green
+      Dir["haml/**/*.haml"].each do |haml_file|
+        haml_to_html(haml_file, :ugly => true)
+      end
+    end
+    if File.directory? "sass"
+      say "\nMinifying CSS from SCSS...", :green
+      Dir["sass/**/*.scss"].each do |scss_file|
+        scss_to_css(scss_file, :style => :compressed)
+      end
+    end
+  end
+
+  desc "prettify", "Pretties your HTML files from Haml and CSS files from SCSS"
+  def prettify
+    if File.directory? "haml"
+      say "\nPrettifying HTML from Haml...", :green
+      Dir["haml/**/*.haml"].each do |haml_file|
+        haml_to_html(haml_file)
+      end
+    end
+    if File.directory? "sass"
+      say "\nPrettifying CSS from SCSS...", :green
+      Dir["sass/**/*.scss"].each do |scss_file|
+        scss_to_css(scss_file)
+      end
+    end
+  end
+
+  def self.source_root
+    File.expand_path(File.join(File.dirname(__FILE__), '..'))
+  end
+
+  private
+
+  def html_to_haml(html_file)
+    haml_file = File.join('haml', html_file.sub(/\.html?$/, '.haml'))
+
+    template = File.open(html_file, 'rb') { |f| f.read }
+    output = Haml::HTML.new(template).render
+    FileUtils.mkdir_p(File.dirname(haml_file))
+    File.open(haml_file, 'w') {|f| f.write(output) }
+    say "Generated #{haml_file} from #{html_file}", :green
+  end
+
+  def haml_to_html(haml_file, options = {})
+    options = { :format => :html5 }.update(options)
+    html_file = haml_file.sub(/^haml\//, '').sub(/\.haml$/, '.html')
+
+    template = File.open(haml_file, 'rb') { |f| f.read }
+    output = Haml::Engine.new(template, options).render
+    File.open(html_file, 'w') {|f| f.write(output) }
+    say "Generated #{html_file} from #{haml_file}", :green
+  end
+
+  def scss_to_css(scss_file, options = {})
+    options = { :syntax => :scss, :style => :expanded }.update(options)
+    css_file = scss_file.sub(/^sass/, 'css').sub(/\.scss$/, '.css')
+
+    template = File.open(scss_file, 'rb') { |f| f.read }
+    output = Sass::Engine.new(template, options).render
+    File.open(css_file, 'w') {|f| f.write(output) }
+    say "Generated #{css_file} from #{scss_file}", :green
+  end
+end
+
+GuardBoilerPlate.start

data/guard_boilerplate.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "version"
+
+Gem::Specification.new do |s|
+  s.name        = "guard_boilerplate"
+  s.version     = GuardBoilerPlate::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Fletcher Nichol"]
+  s.email       = ["fnichol@nichol.ca"]
+  s.homepage    = "http://rubygems.org/gems/guard_boilerplate"
+  s.summary     = %q{A simple script that allows you to run Guard to refresh your web browser and optionally recompile Sass/Haml files}
+  s.description = %q{A simple script that allows you to run Guard to refresh your web browser and optionally recompile Sass/Haml files}
+
+  s.required_rubygems_version = '>= 1.3.6'
+  s.rubyforge_project = "guard_boilerplate"
+
+  s.add_dependency 'thor',              '~> 0.14.6'
+  s.add_dependency 'growl',             '~> 1.0.3'
+  s.add_dependency 'guard',             '~> 0.3.0'
+  s.add_dependency 'guard-livereload',  '~> 0.1.9'
+  s.add_dependency 'guard-sass',        '~> 0.0.6'
+  s.add_dependency 'guard-shell',       '~> 0.1.1'
+  s.add_dependency 'guard-webrick',     '~> 0.1.0'
+  s.add_dependency 'hpricot',           '~> 0.8.4'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/version.rb

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

data/templates/Guardfile

@@ -0,0 +1,23 @@
+# More info at https://github.com/guard/guard#readme
+
+guard 'sass' do
+  watch(%r{sass/.+\.(scss|sass)})
+end
+
+guard 'shell' do
+  watch(%r{haml/(.+)\.haml}) do |m|
+    `haml -f html5 #{File.join("haml", m[1])}.haml #{m[1]}.html`
+    puts "Rebuilt #{m[1]}.html"
+  end
+end
+
+guard 'webrick', :port => 3000 do
+end
+
+guard 'livereload' do
+  watch(%r{.+\.(html|htm)})
+  watch(%r{css/.+\.(css)})
+  watch(%r{sass/.+\.(scss|sass)})
+  watch(%r{img/.+\.(png|jpeg|jpg)})
+  watch(%r{js/.+\.(js)})
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification 
+name: guard_boilerplate
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Fletcher Nichol
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-19 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 14
+        - 6
+        version: 0.14.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: growl
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: guard-livereload
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 1
+        - 9
+        version: 0.1.9
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: guard-sass
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 0
+        - 6
+        version: 0.0.6
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: guard-shell
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: guard-webrick
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 8
+        - 4
+        version: 0.8.4
+  type: :runtime
+  version_requirements: *id008
+description: A simple script that allows you to run Guard to refresh your web browser and optionally recompile Sass/Haml files
+email: 
+- fnichol@nichol.ca
+executables: 
+- gbp
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/gbp
+- guard_boilerplate.gemspec
+- lib/version.rb
+- templates/Guardfile
+has_rdoc: true
+homepage: http://rubygems.org/gems/guard_boilerplate
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: guard_boilerplate
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A simple script that allows you to run Guard to refresh your web browser and optionally recompile Sass/Haml files
+test_files: []
+