bookends 0.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0afe580982cefaaaf366a337b970d463e012a6de
-  data.tar.gz: 7310cdefffb24ae207aa3e133c5cdf8246f7e468
+  metadata.gz: 155c86552c822026db6fc2df938b995f7b18eb78
+  data.tar.gz: 0cbdea32aa3fe30b3621e103006ac74e3e5c9ba9
 SHA512:
-  metadata.gz: b65d2c5be5360dc30775c6702dfa156ed6117b4c77ffd53b1068b8a0465412387f25a87904e004e5ff8e1e2eec880db293e57392d9ca01b96b79203760627bc0
-  data.tar.gz: cddf3716609911800f7a7507383e8c62ac1afb0c0ea56bc80c6f60a15d876d89c25841399c0152acc6e745600ec4e9ebd8cae0c156f38a2945bca0bc0097241e
+  metadata.gz: a863a62527004f7a9195c10d2cdc6b7a7e7cffc4948f6a8c30d8ef05096965261c94c8ae4a0917ef25f4335b13343cda6ec79ca40d388fd8ca33e6fa43e5b653
+  data.tar.gz: 4f21b39d2ef8a6c34442350f7104962787bf6420601d0ee3417e54a6ddbb5a775222f957c59bf665b1def240cc7c9f989d86c012367b9aa02bc7b4a9f6303d74

data/.gitignore

@@ -11,3 +11,6 @@
 .ruby-gemset
 /spec/dummy/tmp/
 /spec/dummy/log/
+/fixtures/dummy-rails/tmp/
+/fixtures/dummy-rails/log/
+.DS_Store

data/README.md

@@ -10,7 +10,7 @@ Bookends assumes the presence of:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'bookends'
+gem 'bookends', group: :development
 ```
 
 And then execute:
@@ -19,17 +19,22 @@ And then execute:
 
 ## Usage
 
-* `rails g bookends:install`
-* add `@import 'bookends/footer';` to your application.scss
-* add `<%= render 'bookends/footer' %>` to your layout where you want the footer.
-* ensure that your JavaScript manifest includes the bookends JavaScript
-  * e.g. `//= require_tree ./bookends`
+    $ bookends install
+
+## Sites using bookends
+Please make sure the owners of the following properties are apprised of changes
+to bookends:
+
+* [www](https://github.com/heroku/www)
+* [blog](https://github.com/heroku/blog)
+* [engineering](https://github.com/heroku/engineering)
+* [elements](https://github.com/heroku/elements)
 
 ## Development
 
 ### Spin up
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`rake rspec` to run the tests.
+`rake` to run the tests.
 
 ### Install and release
 To install this gem onto your local machine, run `bundle exec rake install`. To
@@ -40,24 +45,23 @@ git commits and tags, and push the `.gem` file to
 
 See all rake tasks with `rake -T`
 
-### Working on the gem
-```
-$ cd spec/dummy
-$ rails s
-$ open http://localhost:3000
-```
-From there you can edit the files in
-`lib/generators/bookends/install/templates`. Note that images will have to be
-copied over to the dummy app in `/spec`. Also note
-`spec/dummy/config/application.rb` adds directories from lib into the dummy
-app's load path. Add more directories as needed.
-
 ### Testing it in an app locally
-1. `gem 'bookends', path: 'path/to/local/copy` in the other application's Gemfile
-2. `bundle install` from the other application
-3. `rails g bookends:install` from the other application
-4. boot up the other application
-5. If you make changes to bookends, make sure to run the installer from step 3.
+#### Rails version
+1. `gem 'bookends', path: 'path/to/local/copy` in the Rails application's Gemfile
+2. `bundle install` from the Rails application
+3. `bookends install` from the Rails application
+4. boot up the Rails application
+5. If you make changes to Bookends's templates, make sure to run the installer from step 3.
+
+#### Jekyll version
+1. `gem install bookends --local ../bookends/pkg/bookends-<latest_pkg>` from the
+   root of the Jekyll project. 
+  * Run `rake build` from bookends if there are no `*.gem` files in
+    `bookends/pkg/`
+2. `bundle install` from the Jekyll application
+3. `bookends install` from the Jekyll application
+4. boot up the Jekyll application
+5. If you make changes to Bookends's templates, make sure to run the installer from step 3.
 
 ## Contributing
 

data/Rakefile

@@ -1,6 +1,10 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'rubygems'
+require 'cucumber'
+require 'cucumber/rake/task'
 
-RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
 
-task :default => :spec
+task :default => :features

data/bin/bookends

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/bookends/cli'
+
+Bookends::CLI.start

data/bookends.gemspec

@@ -14,10 +14,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://www.heroku.com"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = %w(bookends)
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "thor", "~> 0.19"
+
   spec.add_development_dependency "rails", ">= 3.2.22"
   spec.add_development_dependency "sass-rails"
   spec.add_development_dependency "bundler", "~> 1.10"
@@ -25,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "jquery-rails"
+  spec.add_development_dependency "aruba", "~> 0.11"
 end

data/fixtures/dummy-jekyll/README.md

@@ -0,0 +1,64 @@
+# Writing a post
+
+As much or as little support as you'd like is available in writing a post. If you prefer less support in writing a post you can begin with simply an idea. To begin to with an idea visit the [Trello board](https://trello.com/b/KkLCAvMg/engineering-blog) and add your idea there. From there you can get support to work on an outline and draft and test it as we prepare to ship.
+
+If you already have a concrete idea and simply are ready to ship it. Then:
+
+1. Prep it to post as described below
+1. Add it to the [Trello board](https://trello.com/b/5tmlTvpy/engineering-blog) as a draft, and mentioned craig
+1. Include appropriate details of whose seen it and what feedback you've gotten.
+
+# Prepping a post for publishing
+
+1. Clone this repo
+1. Create a new branch
+1. Add your post to `_posts`. It should be a [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) file.
+Name the file with the date YYYY-MM-DD at the front, and with the '.md' extension.
+1. Run `jekyll serve` and preview your post.
+1. Push your branch to github and submit a PR.
+1. Craig will review and publish.
+
+### Local Setup and Editing
+
+```console
+$ gem install jekyll
+$ jekyll serve
+$ open http://127.0.0.1:4000
+$ mate public
+```
+
+Use `from-gdoc` if pasting from a Google Doc:
+
+```console
+$ paste | bin/from-gdoc > _posts/2014-05-my-slug.md
+```
+
+### Platform Setup
+
+```console
+$ export DEPLOY=...  # production/staging/you
+$ bin/platform-setup
+```
+
+### Updating Syntax Highlighting Assets
+
+Select the the relevant items from the
+[Prism](http://prismjs.com/download.html) site and update
+`assets/prism.{js,css}` accordingly.
+
+#### Prism lanaguge support selections
+* markup
+* css
+* clike
+* ruby
+* docker
+* elixir
+* erlang
+* git
+* go
+* java
+* php
+* python
+* scss
+* sql
+* yaml

data/fixtures/dummy-jekyll/_config.yml

@@ -0,0 +1,8 @@
+title: Heroku Engineering Blog
+description: ""
+baseurl: ""
+url: "http://engineering.heroku.com"
+markdown: kramdown
+kramdown:
+  input: GFM
+google_tag_manager_account: GTM-JD26

data/fixtures/dummy-jekyll/_layouts/default.html

@@ -0,0 +1,118 @@
+<!DOCTYPE html>
+<html>
+  {% include head.html %}
+
+  <body>
+    {% if site.google_tag_manager_account != '' %}
+      <noscript><iframe src="//www.googletagmanager.com/ns.html?id={{ site.google_tag_manager_account }}">
+                      height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+      <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+      j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+        '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+      })(window,document,'script','dataLayer','{{ site.google_tag_manager_account }}');</script>
+    {% endif %}
+
+    <header id="header">
+      <div id="navigation" role="navigation">
+        <span class="mobile-nav">
+          Show nav
+          <span></span>
+          <span></span>
+          <span></span>
+          <span></span>
+        </span>
+
+        <div class="wrapper wrapper-full">
+          <h1 id="logo">
+            <a href="https://www.heroku.com/home">Heroku</a>
+          </h1>
+
+          <div class="nav-wrapper">
+
+            <ul class="main-nav">
+              <li class="has-dropdown">
+                <a href="https://www.heroku.com/platform">Products</a>
+                <ul class="dropdown">
+                  <li><a href="https://www.heroku.com/platform" class="platform">Heroku Platform</a></li>
+                  <li><a href="https://www.heroku.com/postgres" class="postgres">Heroku Postgres</a></li>
+                  <li><a href="https://www.heroku.com/redis" class="redis">Heroku Redis</a></li>
+                  <li><a href="https://www.heroku.com/connect" class="connect">Heroku Connect</a></li>
+                  <li><a href="https://www.heroku.com/enterprise" class="enterprise">Heroku Enterprise</a></li>
+                </ul>
+              </li>
+              <li class="has-dropdown">
+                <a href="https://elements.heroku.com/">Elements</a>
+                <ul class="dropdown">
+                  <li><a href="https://elements.heroku.com/addons" class="addons">Add-ons</a></li>
+                  <li><a href="https://elements.heroku.com/buttons" class="buttons">Buttons</a></li>
+                  <li><a href="https://elements.heroku.com/buildpacks" class="buildpacks">Buildpacks</a></li>
+                </ul>
+              </li>
+              <li><a href="https://www.heroku.com/pricing">Pricing</a></li>
+              <li><a href="https://devcenter.heroku.com">Documentation</a></li>
+              <li><a href="https://www.heroku.com/support">Support</a></li>
+
+              <li class="has-dropdown">
+                <a href="#" class="more">More</a>
+                <div class="dropdown more">
+                  <section class="more-resources">
+                    <span class="more-title">Additional Resources</span>
+                    <ul>
+                      <li><a href="https://www.heroku.com/what">What is Heroku?</a></li>
+                      <li><a href="https://www.heroku.com/help">Help Center</a></li>
+                      <li><a href="https://www.heroku.com/customers">Customers</a></li>
+                      <li><a href="https://www.heroku.com/careers">Careers</a></li>
+                    </ul>
+                  </section>
+                  <section class="more-languages">
+                    <span class="more-title">Languages</span>
+                    <ul>
+                      <li><a href="https://www.heroku.com/node">Node</a></li>
+                      <li><a href="https://www.heroku.com/ruby">Ruby</a></li>
+                      <li><a href="https://www.heroku.com/java">Java</a></li>
+                      <li><a href="https://www.heroku.com/php">PHP</a></li>
+                      <li><a href="https://www.heroku.com/python">Python</a></li>
+                      <li><a href="https://www.heroku.com/go">Go</a></li>
+                      <li><a href="https://www.heroku.com/scala">Scala</a></li>
+                      <li><a href="https://www.heroku.com/clojure">Clojure</a></li>
+                    </ul>
+                  </section>
+                  <section id="more-blog" class="more-blog">
+                    <span class="more-title">Heroku Blog</span>
+                    <h3><a class="js-blog-link" href="https://blog.heroku.com">Heroku Blog</a></h3>
+                    <p class="js-blog-date"></p>
+                    <p class="js-blog-content">Find out what's new with Heroku on our blog.</p>
+                    <a href="https://blog.heroku.com" class="button btn-default btn-sm btn-inline">Visit Blog</a>
+                  </section>
+                </div>
+              </li>
+            </ul>
+
+            <ul class="tool-nav">
+              <li>
+                <form action="https://blog.heroku.com/search" class="site-search" id="site-search" method="get">
+                  <div class="gsc-input">
+                    <input name="utf8" type="hidden" value="✓">
+                    <input autocomplete="off" type="text" name="q" title="search" class="gsc-input" style="width: 100%; padding: 0px; border: none; margin: -0.0625em 0px 0px; height: 1.25em; outline: none;" dir="ltr" spellcheck="false">
+                    <span class="gsc-search-button">
+                      <input type="submit" class="search-button">
+                    </span>
+                  </div>
+                </form>
+              </li>
+            </ul>
+          </div>
+        </div>
+      </div>
+    </header>
+
+    <div class="container-fluid">
+      {{ content }}
+    </div>
+
+    {% include bookends/footer.html %}
+    {% include body-close.html %}
+  </body>
+
+</html>

data/fixtures/dummy-jekyll/_layouts/post.html

@@ -0,0 +1,14 @@
+---
+layout: default
+---
+
+<h1>{{ page.title }}</h1>
+<div class="byline">
+  {{ page.date | date: "%B %-d, %Y" }}
+
+  {% if page.author_name %}
+    by <address class="author"><a rel="author" href="{{ page.author_url }}">{{ page.author_name }}</a></address>
+  {% endif %}
+</div>
+
+{{ content }}