boilerplate_engine 0.0.1

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 cowboycoded
+
+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,73 @@
+## This repo is currently being used by the Charlotte Ruby Meetup group.  This gem is not intended for production use at this time.  It will be released to gemcutter after the group determines that it is stable.
+
+# boilerplate_engine
+
+boilerplate_engine is used to kick-start your Rails 3 app views.  It uses HTML5 Boilerplate assets and index page as a basis for the views.  The goal of this project is to give you a good starting point and remove some of the mundane tasks involved in setting up a new Rails app.
+
+## Info for CLT Ruby
+
+If you want to contribute to this project, then fork the repo on github and take a look at the source and see how you can improve or add more functionality.  Take a look at https://github.com/paulirish/html5-boilerplate.  The application layout file is based on this project.  If you are not familiar with Rails 3 Engines, do some research on them as well.
+
+All of the tests are in the "test_app" directory.  Instead of using a dummy app, I found it easier to simply add a new blank rails app and bootstrap it with rspec and cucumber.  The initial commit contains only cucumber tests (some of which need to be refactored).  
+
+This project also uses the Yettings gem, which gives you a YAML settings file that contains key/value pairs.  These can be used as site-wide variables in the Engine and the containing Rails app.  boilerplate_engine uses Yettings to allow the user to configure the Engine with things like Google Analytics API key, default title and meta description,etc..  
+
+Rails Generators are used to install the static assets, views, and delete index.html from the public directory.  A controller, view and route are included in the engine for the index page.  This maps to "home#index".  The generator will create a view for the index page, so you can add your own code: 
+
+    /app/views/home/index.html.erb  
+    
+The generator also gives you a new view directory 
+   
+    /app/views/boilerplate/
+    
+This directory contains partials where you can insert extra javascript, css, meta tags, etc..  It also contains a partial named _layout.html.erb.  This file contains the call to "yield".  This partial is sandwiched between the opening "body" tag and the asynchronous javascript at the bottom of the layout.  This is the appropriate file to code anything shared in your layout... like headers, nav bars, etc.   All of the generator code is in:
+
+    /lib/generators/boilerplate_engine/install/install_generator.rb
+
+The generator templates are in this directory
+
+    /lib/generators/boilerplate_engine/install/templates/
+    
+For more info about coding generators, see http://guides.rubyonrails.org/generators.html
+
+## Install
+
+To install in your Rails 3 app, place this in your Gemfile and run "bundle install"
+
+    gem "boilerplate_engine", :git=>"git@github.com:charlotte-ruby/boilerplate_engine.git"
+    
+This will install the gem directly from github.  
+
+You can also install it using a local path, if you have cloned the repository locally:
+
+    gem "boilerplate_engine", :git=>"/path/to/boilerplate_engine"
+
+Next, you need to run the generator to install views and assets into the parent Rails app:
+
+    rails g boilerplate_engine:install
+
+Then you can configure the boilerplate by editing /config/yettings/boilerplate.yml.  You will probably want to change the default title, meta description and author.  You can also exclude things like jquery and analytics.
+
+The final step is to add your code to the views in:
+
+    /app/views/boilerplate
+    
+This is where you want to add any extra javascript, css, or meta tags.  You will also use _layout.html.erb for your template code like nav, headers, footers, etc..
+
+You can override the default title and meta description for individual views with helpers:
+
+    <% head_title "Custom Title Here" %>
+    <% meta_description "Custom Meta Description" %>
+
+## Testing
+
+If you clone the repository locally, you can fire off the tests by doing this:
+
+    cd /path/to/boilerplate_engine/test_app
+    bundle exec cucumber features/  
+  
+
+## TODO List
+1. Convert views from haml to erb.  Not everyone uses haml, so this should not be the default.
+2. Create a flexible template system (and css) that allows you to easily skin your app.
+3. Better tests

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "boilerplate_engine"
+  gem.homepage = "http://github.com/charlotte-ruby/boilerplate_engine"
+  gem.license = "MIT"
+  gem.summary = %Q{Alpha: boilerplate engine for your rails views}
+  gem.description = %Q{Alpha: HTML5 boilerplate translated to a configurable rails engine}
+  gem.email = "john.mcaliley@gmail.com"
+  gem.authors = ["cowboycoded"]
+  gem.add_runtime_dependency 'yettings'
+  gem.add_runtime_dependency 'haml'
+  gem.files.exclude "test_app"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "boilerplate_engine #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/controllers/home_controller.rb

@@ -0,0 +1,2 @@
+class HomeController < ApplicationController
+end

data/app/helpers/boilerplate_engine_helper.rb

@@ -0,0 +1,19 @@
+module BoilerplateEngineHelper
+  def head_title(title = nil)
+    content_for(:head_title) { title } and return if title
+    content_for?(:head_title) ? content_for(:head_title) : BoilerplateYetting.default_head_title
+  end
+  
+  def meta_description(meta_description = nil)
+    content_for(:meta_description) { meta_description } and return if meta_description
+    content_for?(:meta_description) ? content_for(:meta_description) : BoilerplateYetting.default_meta_description
+  end
+  
+  def notice
+    flash[:notice] rescue ""
+  end
+  
+  def alert
+    flash[:alert] rescue ""
+  end
+end

data/app/views/boilerplate/_asynch_javascript.html.erb

@@ -0,0 +1,18 @@
+<% if BoilerplateYetting.jquery %>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script>
+  <script>window.jQuery || document.write("<script src='/boilerplate_engine/javascripts/libs/jquery-1.5.1.min.js'>\x3C/script>")</script>
+<% end %>
+
+<!--[if lt IE 7 ]>
+<script src="/boilerplate_engine/javascripts/libs/dd_belatedpng.js"></script>
+<script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script>
+<![endif]-->
+
+<% if BoilerplateYetting.google_analytics_key %>
+  <script>
+  var _gaq=[["_setAccount","UA-XXXXX-X"],["_trackPageview"]];
+  (function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];g.async=1;
+  g.src=("https:"==location.protocol?"//ssl":"//www")+".google-analytics.com/ga.js";
+  s.parentNode.insertBefore(g,s)}(document,"script"));
+  </script>
+<% end %>

data/app/views/boilerplate/_body.html.erb

@@ -0,0 +1 @@
+<body>

data/app/views/boilerplate/_css.html.erb

@@ -0,0 +1,10 @@
+<!-- CSS: implied media="all" -->
+<%= stylesheet_link_tag("/boilerplate_engine/stylesheets/style.css") %>
+
+<% if BoilerplateYetting.handheld_stylesheet %>
+  <%= stylesheet_link_tag("/boilerplate_engine/stylesheets/handheld.css") %>
+<% end %>
+
+<% if BoilerplateYetting.load_all_stylesheets %>
+  <%= stylesheet_link_tag :all %>
+<% end %>

data/app/views/boilerplate/_doctype.html.erb

@@ -0,0 +1 @@
+<!DOCTYPE html>

data/app/views/boilerplate/_flash.html.erb

@@ -0,0 +1,2 @@
+<div id="flash-notice"><%= notice %></div>
+<div id="flash-alert"><%= alert %></div>

data/app/views/boilerplate/_head_javascript.html.erb

@@ -0,0 +1,4 @@
+<script src="/boilerplate_engine/javascripts/libs/modernizr-1.7.min.js"></script>
+<% if BoilerplateYetting.load_all_javascripts %>
+  <%= javascript_include_tag :all %>
+<% end %>

data/app/views/boilerplate/_html_tag_browser_hacks.html.erb

@@ -0,0 +1,4 @@
+<!--[if lt IE 7 ]> <html lang="en"> <![endif]-->
+<!--[if IE 7 ]>    <html lang="en"> <![endif]-->
+<!--[if IE 8 ]>    <html lang="en"> <![endif]-->
+<!--[if (gte IE 9)|!(IE)]><!--> <html lang="en"> <!--<![endif]-->

data/app/views/boilerplate/_icons.html.erb

@@ -0,0 +1,3 @@
+<!-- Place favicon.ico & apple-touch-icon.png in the root of your domain and delete these references -->
+<link rel="shortcut icon" href="/favicon.ico">
+<link rel="apple-touch-icon" href="/apple-touch-icon.png">

data/app/views/boilerplate/_layout.html.erb

@@ -0,0 +1 @@
+<%= yield %>

data/app/views/boilerplate/_meta_tags.html.erb

@@ -0,0 +1,5 @@
+<meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+<meta name="description" content="<%= meta_description %>">
+<meta name="author" content="<%= BoilerplateYetting.author %>">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">

data/app/views/boilerplate/_title_tag.html.erb

@@ -0,0 +1 @@
+<title><%= head_title %></title>

data/app/views/home/index.html.erb

@@ -0,0 +1 @@
+Index Page

data/app/views/layouts/application.html.erb

@@ -0,0 +1,20 @@
+<%= render "boilerplate/doctype" %>
+<%= render "boilerplate/html_tag_browser_hacks" %>
+<head>
+  <%= render "boilerplate/meta_tags" %>
+  <%= render "boilerplate/meta_tags_addons" %>
+  <%= render "boilerplate/title_tag" %>
+  <%= render "boilerplate/icons" %>
+  <%= render "boilerplate/css" %>
+  <%= render "boilerplate/css_addons" %>
+  <%= render "boilerplate/head_javascript" %>
+  <%= render "boilerplate/head_javascript_addons" %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+  <%= render "boilerplate/flash" %>
+  <%= render "boilerplate/layout" %>
+  <%= render "boilerplate/asynch_javascript" %>
+  <%= render "boilerplate/asynch_javascript_addons" %>
+</body>
+</html>

data/boilerplate_engine.gemspec

@@ -0,0 +1,102 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{boilerplate_engine}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["cowboycoded"]
+  s.date = %q{2011-05-23}
+  s.description = %q{Alpha: HTML5 boilerplate translated to a configurable rails engine}
+  s.email = %q{john.mcaliley@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "app/controllers/home_controller.rb",
+    "app/helpers/boilerplate_engine_helper.rb",
+    "app/views/boilerplate/_asynch_javascript.html.erb",
+    "app/views/boilerplate/_asynch_javascript_addons.html.erb",
+    "app/views/boilerplate/_body.html.erb",
+    "app/views/boilerplate/_css.html.erb",
+    "app/views/boilerplate/_css_addons.html.erb",
+    "app/views/boilerplate/_doctype.html.erb",
+    "app/views/boilerplate/_flash.html.erb",
+    "app/views/boilerplate/_head_javascript.html.erb",
+    "app/views/boilerplate/_head_javascript_addons.html.erb",
+    "app/views/boilerplate/_html_tag_browser_hacks.html.erb",
+    "app/views/boilerplate/_icons.html.erb",
+    "app/views/boilerplate/_layout.html.erb",
+    "app/views/boilerplate/_meta_tags.html.erb",
+    "app/views/boilerplate/_meta_tags_addons.html.erb",
+    "app/views/boilerplate/_title_tag.html.erb",
+    "app/views/home/index.html.erb",
+    "app/views/layouts/application.html.erb",
+    "boilerplate_engine.gemspec",
+    "config/routes.rb",
+    "lib/boilerplate_engine.rb",
+    "lib/boilerplate_engine/engine.rb",
+    "lib/boilerplate_engine/railties/tasks.rake",
+    "lib/generators/boilerplate_engine/install/USAGE",
+    "lib/generators/boilerplate_engine/install/install_generator.rb",
+    "lib/generators/boilerplate_engine/install/templates/apple-touch-icon-114x114-precomposed.png",
+    "lib/generators/boilerplate_engine/install/templates/apple-touch-icon-57x57-precomposed.png",
+    "lib/generators/boilerplate_engine/install/templates/apple-touch-icon-72x72-precomposed.png",
+    "lib/generators/boilerplate_engine/install/templates/apple-touch-icon-precomposed.png",
+    "lib/generators/boilerplate_engine/install/templates/apple-touch-icon.png",
+    "lib/generators/boilerplate_engine/install/templates/crossdomain.xml",
+    "lib/generators/boilerplate_engine/install/templates/humans.txt",
+    "lib/generators/boilerplate_engine/install/templates/javascripts/libs/dd_belatedpng.js",
+    "lib/generators/boilerplate_engine/install/templates/javascripts/libs/jquery-1.5.2.js",
+    "lib/generators/boilerplate_engine/install/templates/javascripts/libs/jquery-1.5.2.min.js",
+    "lib/generators/boilerplate_engine/install/templates/javascripts/libs/modernizr-1.7.min.js",
+    "lib/generators/boilerplate_engine/install/templates/javascripts/plugins.js",
+    "lib/generators/boilerplate_engine/install/templates/robots.txt",
+    "lib/generators/boilerplate_engine/install/templates/stylesheets/handheld.css",
+    "lib/generators/boilerplate_engine/install/templates/stylesheets/style.css",
+    "lib/generators/boilerplate_engine/install/templates/yettings/boilerplate.yml"
+  ]
+  s.homepage = %q{http://github.com/charlotte-ruby/boilerplate_engine}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Alpha: boilerplate engine for your rails views}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<yettings>, [">= 0"])
+      s.add_runtime_dependency(%q<haml>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<yettings>, [">= 0"])
+      s.add_dependency(%q<haml>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<yettings>, [">= 0"])
+    s.add_dependency(%q<haml>, [">= 0"])
+  end
+end
+

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  root :to => "home#index"
+end

data/lib/boilerplate_engine.rb

@@ -0,0 +1,4 @@
+PATH = File.dirname(__FILE__) + "/boilerplate_engine"
+require "#{PATH}/engine.rb"
+require "haml"
+require "yettings"

data/lib/boilerplate_engine/engine.rb

@@ -0,0 +1,10 @@
+require "boilerplate_engine"
+require "rails"
+
+module BoilerplateEngine
+  class Engine < Rails::Engine
+    config.to_prepare do
+      ActionView::Base.send(:include, BoilerplateEngineHelper)
+    end
+  end
+end

data/lib/generators/boilerplate_engine/install/install_generator.rb

@@ -0,0 +1,44 @@
+require 'rails/generators'
+require 'rails/generators/migration'     
+
+module BoilerplateEngine
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.join(File.dirname(__FILE__), 'templates')
+  
+    def create_static_assets
+      copy_file "apple-touch-icon-114x114-precomposed.png", "public/apple-touch-icon-114x114-precomposed.png"
+      copy_file "apple-touch-icon-72x72-precomposed.png", "public/apple-touch-icon-72x72-precomposed.png"
+      copy_file "apple-touch-icon.png", "public/apple-touch-icon.png"
+      copy_file "apple-touch-icon-57x57-precomposed.png", "public/apple-touch-icon-57x57-precomposed.png"
+      copy_file "apple-touch-icon-precomposed.png", "public/apple-touch-icon-precomposed.png"
+      copy_file "crossdomain.xml", "public/crossdomain.xml"
+      copy_file "robots.txt", "public/robots.txt"
+      copy_file "humans.txt", "public/humans.txt"      
+      copy_file "javascripts/libs/dd_belatedpng.js", "public/boilerplate_engine/javascripts/libs/dd_belatedpng.js"
+      copy_file "javascripts/libs/jquery-1.5.2.js", "public/boilerplate_engine/javascripts/libs/jquery-1.5.2.js"
+      copy_file "javascripts/libs/jquery-1.5.2.min.js", "public/boilerplate_engine/javascripts/libs/jquery-1.5.2.min.js"
+      copy_file "javascripts/libs/modernizr-1.7.min.js", "public/boilerplate_engine/javascripts/libs/modernizr-1.7.min.js"
+      copy_file "javascripts/plugins.js", "public/boilerplate_engine/javascripts/plugins.js"
+      copy_file "stylesheets/style.css", "public/boilerplate_engine/stylesheets/style.css"
+      copy_file "stylesheets/handheld.css", "public/boilerplate_engine/stylesheets/handheld.css"
+    end
+    
+    def create_view_overrides
+      create_file "app/views/boilerplate/_css_addons.html.erb"
+      create_file "app/views/boilerplate/_head_javascript_addons.html.erb"
+      create_file "app/views/boilerplate/_asynch_javascript_addons.html.erb"
+      create_file "app/views/boilerplate/_meta_tags_addons.html.erb"
+      create_file "app/views/boilerplate/_layout.html.erb", "<%= yield %>"
+      copy_file "../../../../../app/views/layouts/application.html.erb", "app/views/layouts/application.html.erb"
+      copy_file "../../../../../app/views/home/index.html.erb", "app/views/home/index.html.erb"
+    end
+    
+    def create_yettings
+      copy_file "yettings/boilerplate.yml", "config/yettings/boilerplate.yml"
+    end
+    
+    def delete_index_html
+      remove_file "public/index.html"
+    end
+  end
+end