This repository has been archived by the owner on Jul 12, 2018. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Use go_script gem; update guides_style_18f, nav
In addition to the gem updates, the sidebar item now reads "Making repo descriptions short and clear" to match the title on that page. The nav bar highlight doesn't work unless the titles match.
- Loading branch information
Mike Bland
committed
Sep 1, 2015
1 parent
d08c607
commit 003da41
Showing
4 changed files
with
46 additions
and
135 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,141 +1,54 @@ | ||
| #! /usr/bin/env ruby | ||
| # | ||
| # 18F Guides Jekyll template | ||
| # | ||
| # Written in 2015 by Mike Bland (michael.bland@gsa.gov) | ||
| # on behalf of the 18F team, part of the US General Services Administration: | ||
| # https://18f.gsa.gov/ | ||
| # | ||
| # To the extent possible under law, the author(s) have dedicated all copyright | ||
| # and related and neighboring rights to this software to the public domain | ||
| # worldwide. This software is distributed without any warranty. | ||
| # | ||
| # You should have received a copy of the CC0 Public Domain Dedication along | ||
| # with this software. If not, see | ||
| # <https://creativecommons.org/publicdomain/zero/1.0/>. | ||
| # | ||
| # @author Mike Bland (michael.bland@gsa.gov) | ||
| # | ||
| # ---- | ||
| # | ||
| # ./go script: unified development environment interface | ||
| # | ||
| # Inspired by: | ||
| # http://www.thoughtworks.com/insights/blog/praise-go-script-part-i | ||
| # http://www.thoughtworks.com/insights/blog/praise-go-script-part-ii | ||
| # | ||
| # Author: Mike Bland (michael.bland@gsa.gov) | ||
| # Date: 2015-04-15 | ||
|
|
||
| MIN_VERSION = "2.1.5" | ||
| require 'English' | ||
|
|
||
| unless RUBY_VERSION >= MIN_VERSION | ||
| puts <<EOF | ||
| Dir.chdir File.dirname(__FILE__) | ||
|
|
||
| *** ABORTING: Unsupported Ruby version *** | ||
| Ruby version #{MIN_VERSION} or greater is required to work with the Hub, but | ||
| this Ruby is version #{RUBY_VERSION}. Consider using a version manager such as | ||
| rbenv (https://github.com/sstephenson/rbenv) or rvm (https://rvm.io/) | ||
| to install a Ruby version specifically for Hub development. | ||
| EOF | ||
| exit 1 | ||
| def try_command_and_restart(command) | ||
| exit $CHILD_STATUS.exitstatus unless system command | ||
| exec RbConfig.ruby, *[$PROGRAM_NAME].concat(ARGV) | ||
| end | ||
|
|
||
| def exec_cmd(cmd) | ||
| exit $?.exitstatus unless system(cmd) | ||
| begin | ||
| require 'bundler/setup' if File.exist? 'Gemfile' | ||
| rescue LoadError | ||
| try_command_and_restart 'gem install bundler' | ||
| rescue SystemExit | ||
| try_command_and_restart 'bundle install' | ||
| end | ||
|
|
||
| def init | ||
| begin | ||
| require 'bundler' | ||
| rescue LoadError | ||
| puts "Installing Bundler gem..." | ||
| exec_cmd 'gem install bundler' | ||
| puts "Bundler installed; installing gems" | ||
| end | ||
| exec_cmd 'bundle install' | ||
| begin | ||
| require 'go_script' | ||
| rescue LoadError | ||
| try_command_and_restart 'gem install go_script' unless File.exist? 'Gemfile' | ||
| abort "Please add \"gem 'go_script'\" to your Gemfile" | ||
| end | ||
|
|
||
| def update_gems | ||
| exec_cmd 'bundle update' | ||
| exec_cmd 'git add Gemfile.lock' | ||
| end | ||
| require 'guides_style_18f' | ||
|
|
||
| JEKYLL_BUILD_CMD = "exec jekyll build --trace" | ||
| JEKYLL_SERVE_CMD = "exec jekyll serve --trace" | ||
| extend GoScript | ||
| check_ruby_version '2.1.5' | ||
|
|
||
| def serve | ||
| exec "bundle #{JEKYLL_SERVE_CMD}" | ||
| end | ||
| command_group :dev, 'Development commands' | ||
|
|
||
| def build | ||
| exec_cmd "bundle #{JEKYLL_BUILD_CMD}" | ||
| def_command :update_nav, 'Update the \'navigation:\' data in _config.yml' do | ||
| GuidesStyle18F.update_navigation_configuration Dir.pwd | ||
| end | ||
|
|
||
| # Groups a set of commands by common function. | ||
| class CommandGroup | ||
| attr_accessor :description, :commands | ||
| private_class_method :new | ||
| @@groups = Array.new | ||
|
|
||
| # @param description [String] short description of the group | ||
| # @param commands [Hash<Symbol,String>] mapping from command function name | ||
| # to a brief description; each key must be the name of a function in this | ||
| # script | ||
| def initialize(description, commands) | ||
| @description = description | ||
| @commands = commands | ||
| end | ||
|
|
||
| def to_s | ||
| padding = @commands.keys.max_by {|i| i.size}.size + 2 | ||
| ["\n#{@description}"].concat( | ||
| @commands.map {|name, desc| " %-#{padding}s#{desc}" % name}).join("\n") | ||
| end | ||
|
|
||
| def self.add_group(description, commands) | ||
| @@groups << new(description, commands) | ||
| end | ||
|
|
||
| def self.groups | ||
| @@groups | ||
| end | ||
|
|
||
| def self.check_command_exists(command_symbol) | ||
| all_commands = @@groups.map {|i| i.commands.keys}.flatten | ||
| unless all_commands.member? command_symbol | ||
| puts "Unknown option or command: #{command_symbol}" | ||
| usage(exitstatus: 1) | ||
| end | ||
| end | ||
| def_command :update_theme, 'Update the guides_style_18f gem' do | ||
| exec_cmd 'bundle update --source guides_style_18f' | ||
| end | ||
|
|
||
| CommandGroup.add_group( | ||
| 'Development commands', | ||
| { | ||
| :init => 'Set up the dev environment', | ||
| :update_gems => 'Execute Bundler to update gem set', | ||
| :serve => 'Serves the site at localhost:4000', | ||
| :build => 'Builds the site', | ||
| }) | ||
|
|
||
| def usage(exitstatus: 0) | ||
| puts <<EOF | ||
| Usage: #{$0} [options] [command] | ||
| def_command :update_gems, 'Update Ruby gems' do |gems| | ||
| update_gems gems | ||
| end | ||
|
|
||
| options: | ||
| -h,--help Show this help | ||
| EOF | ||
| CommandGroup.groups.each {|s| puts s} | ||
| exit exitstatus | ||
| def_command :serve, 'Serve the site at localhost:4000' do | ||
| serve_jekyll | ||
| end | ||
|
|
||
| usage(exitstatus: 1) unless ARGV.size == 1 | ||
| command = ARGV.shift | ||
| usage if ['-h', '--help'].include? command | ||
| def_command :build, 'Build the site' do | ||
| build_jekyll | ||
| end | ||
|
|
||
| command = command.to_sym | ||
| CommandGroup.check_command_exists command | ||
| send command | ||
| execute_command ARGV |