ppl 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cc246db0a4e91b85f3f04c9c7961ff4e564c9ce91ba87631d4efdabe6c0aec0
-  data.tar.gz: cc829862f67814f88a44a8f50367b7a453d2deee549d2f73af9b4f7c47855b4f
+  metadata.gz: 811a963ed2b1070a5f92fbead6775bcb118c505eb483f677803982243d31b3ef
+  data.tar.gz: 7a6a53a6638676786409b13c8b327fbdbc6e8a3a0d814bf8fc74a7293a4047d7
 SHA512:
-  metadata.gz: e32285452876a1a7312a4a683b18bbdca0ff2e45bea87034def7bd794a0044bbd8c5e6a8b2067da36a12a070345afeb46ff03b8e698ae8dda1003c3bc491f7a4
-  data.tar.gz: aab66b67e9def63ef307be8ea85619d7346f4a77897fbe1dd29bc3db847d1dbe496dfe69007e515da2c282a7f128f516c870d24d069710c6f703888262822cd8
+  metadata.gz: b424d715aadb384bbb924355264a1fd8381f662c9b6958e9cf683d10aaba11a1a793a1348a6a65373d48965871e14c0e6a6ecdc24ecc643a664ae76c7304cc64
+  data.tar.gz: b42f7c2ec5c109eacc4efb37c2e9f910b9ea6c8b2b4edefa667480aeab01c2b6006f786a698a922d24ab8b4afdc50297912d3ab49d7ab2905dc84d81cbcdba5c

data/.editorconfig

@@ -1,3 +1,15 @@
+[*.js]
+indent_style = space
+indent_size = 2
+
+[*.njk]
+indent_style = space
+indent_size = 2
+
+[*.scss]
+indent_style = space
+indent_size = 2
+
 [*.yml]
 indent_style = space
 indent_size = 2

data/.eleventy.js

@@ -0,0 +1,86 @@
+const chokidar = require("chokidar")
+const fs = require("fs-extra")
+const htmlmin = require("html-minifier")
+const sass = require("sass")
+
+function minifyHtml(html) {
+  return htmlmin.minify(html, {
+    useShortDoctype: true,
+    removeComments: true,
+    collapseWhitespace: true
+  })
+}
+
+function monkeypatch(cls, fn) {
+  const orig = cls.prototype[fn.name][`_PS_original`] || cls.prototype[fn.name]
+  function wrapped() {
+    return fn.bind(this, orig).apply(this, arguments)
+  }
+  wrapped[`_PS_original`] = orig
+  cls.prototype[fn.name] = wrapped
+}
+
+const minifyPlugin = {
+  initArguments: {},
+  configFunction: function(eleventyConfig) {
+    eleventyConfig.addTransform(
+      "htmlmin",
+      function(content, outputPath) {
+        if (outputPath && outputPath.endsWith(".html")) {
+          return minifyHtml(content)
+        }
+        return content
+      }
+    )
+  }
+}
+
+function compileSass() {
+  const { css } = sass.renderSync({
+    file: "site/style.scss",
+  })
+  fs.writeFileSync("_site/style.css", css)
+}
+
+module.exports = function(eleventyConfig) {
+  console.log("ppl site")
+
+  fs.ensureDirSync("_site")
+  fs.emptyDirSync("_site")
+
+  eleventyConfig.addPassthroughCopy("site/casts/*.svg")
+  eleventyConfig.addPlugin(minifyPlugin)
+
+  compileSass()
+
+  if (process.argv.includes("--serve")) {
+    setImmediate(function() {
+      const Eleventy = require("@11ty/eleventy/src/Eleventy.js")
+      if (Eleventy.prototype) {
+        function watch(original) {
+          const watcher = chokidar.watch(["./site/style.scss"], {
+            persistent: true
+          })
+          const compileAndReload = eleventyInstance => () => {
+            compileSass()
+            this.eleventyServe.reload()
+          }
+          watcher.on("add", compileAndReload(this))
+          watcher.on("change", compileAndReload(this))
+          return original.apply(this)
+        }
+        monkeypatch(Eleventy, watch)
+      }
+    })
+  }
+
+  const input = "site"
+
+  const dir = {
+    input,
+  }
+
+  return {
+	  dir,
+  }
+}

data/.eleventyignore

@@ -0,0 +1 @@
+gh-pages

data/.github/workflows/build.yml

@@ -8,22 +8,50 @@ on:
       - trunk
 
 jobs:
-  test:
+  build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+
       - uses: actions/setup-ruby@v1
         with:
           ruby-version: 3.0.0
+
       - uses: jwlawson/actions-setup-cmake@v1.8
         with:
           cmake-version: "3.16.x"
+
       - name: Install dependencies
-        run: bundle install
+        run: |
+          bundle install
+          yarn install --pure-lockfile
+
       - name: rspec
         run: bundle exec rake spec
+
       - name: cucumber
         run: bundle exec rake features
+
+      - name: eleventy
+        run: make _site
+
+      - uses: nwtgck/actions-netlify@v1.1
+        with:
+          publish-dir: "./_site"
+          production-branch: trunk
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          deploy-message: ${{ github.event.head_commit.message }}
+          enable-pull-request-comment: false
+          enable-commit-comment: false
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+        timeout-minutes: 1
+
       - uses: dawidd6/action-publish-gem@v1
         continue-on-error: true
         if: ${{ github.ref == 'refs/heads/trunk' }}

data/.gitignore

@@ -2,4 +2,6 @@ Gemfile.lock
 ppl-*.gem
 tmp
 _site
-
+yarn-error.log
+node_modules
+site/casts/*.svg

data/Rakefile

@@ -1,5 +1,5 @@
 task :features => [:disable_config] do
-  system "bundle exec cucumber"
+  system "bundle exec cucumber --publish-quiet"
 end
 
 task :spec do

data/features/step_definitions/ppl_steps.rb

@@ -20,7 +20,7 @@ end
 
 Then /^there should be (\d+) contacts?$/ do |n|
   contact_list = ppl("ls").strip.split("\n")
-  contact_list.length.should eq n.to_i
+  expect(contact_list.length).to eq n.to_i
   if contact_list[0]
     @contact_id = contact_list[0].split(":").first
   end
@@ -33,84 +33,84 @@ end
 
 Then /^(bob) should have (\d+) nicknames?$/ do |name, number|
   @nicknames = ppl("nick #{name}").split("\n")
-  @nicknames.length.should eq number.to_i
+  expect(@nicknames.length).to eq number.to_i
 end
 
 Then /^(bob) should have (\d+) organizations?$/ do |name, number|
   @organizations = ppl("org #{name}").split("\n")
-  @organizations.length.should eq number.to_i
+  expect(@organizations.length).to eq number.to_i
 end
 
 Then /^(bob) should have (\d+) phone numbers?$/ do |name, number|
   @phone_numbers = ppl("phone #{name}").split("\n")
-  @phone_numbers.length.should eq number.to_i
+  expect(@phone_numbers.length).to eq number.to_i
 end
 
 Then /^(bob) should have (\d+) postal addresse?s?$/ do |name, number|
   @postal_addresses = ppl("post #{name}").split("\n")
-  @postal_addresses.length.should eq number.to_i
+  expect(@postal_addresses.length).to eq number.to_i
 end
 
 Then /^(bob) should have (\d+) URLs?$/ do |name, number|
   @urls = ppl("url #{name}").split("\n")
-  @urls.length.should eq number.to_i
+  expect(@urls.length).to eq number.to_i
 end
 
 And /^its ID should be "([^"]+)"$/ do |id|
-  @contact_id.should eq id
+  expect(@contact_id).to eq id
 end
 
 And /^its name should be "([^"]+)"$/ do |name|
-  ppl("name #{@contact_id}").should eq name
+  expect(ppl("name #{@contact_id}")).to eq name
 end
 
 Then(/^the (\d+).. email address should be "([^"]+)"$/) do |nth, address|
-  @email_addresses[nth.to_i - 1].strip.should eq address
+  expect(@email_addresses[nth.to_i - 1].strip).to eq address
 end
 
 Then /^running "ppl ([^"]+)" should output (\d+) lines?$/ do |command, lines|
   @output = ppl(command).split("\n")
-  @output.length.should eq lines.to_i
+  expect(@output.length).to eq lines.to_i
 end
 
 And /^the (\d+).. line should be "([^"]+)"$/ do |nth, line|
-  @output[nth.to_i - 1].should eq line
+  expect(@output[nth.to_i - 1]).to eq line
 end
 
 Then(/^the (\d+).. nickname should be "([^"]+)"$/) do |nth, nickname|
-  @nicknames[nth.to_i - 1].should eq nickname
+  expect(@nicknames[nth.to_i - 1]).to eq nickname
 end
 
 Then(/^the (\d+).. organization should be "([^"]+)"$/) do |nth, organization|
-  @organizations[nth.to_i - 1].should eq organization
+  expect(@organizations[nth.to_i - 1]).to eq organization
 end
 
 Then(/^the (\d+).. phone number should be "([^"]+)"$/) do |nth, phone_number|
-  @phone_numbers[nth.to_i - 1].should eq phone_number
+  expect(@phone_numbers[nth.to_i - 1]).to eq phone_number
 end
 
 Then(/^the (\d+).. postal address should be "([^"]+)"$/) do |nth, address|
-  @postal_addresses[nth.to_i - 1].should eq address
+  expect(@postal_addresses[nth.to_i - 1]).to eq address
 end
 
 Then(/^the (\d+).. URL should be "([^"]+)"$/) do |nth, url|
-  @urls[nth.to_i - 1].should eq url
+  expect(@urls[nth.to_i - 1]).to eq url
 end
 
 And /^"([^"]+)" should be the favourite email address$/ do |email_address|
-  @email_addresses.should include "*  #{email_address}"
+  expect(@email_addresses).to include "*  #{email_address}"
   @email_addresses.each do |line|
     if line.include? "*"
-      line.should eq "*  #{email_address}"
+      expect(line).to eq "*  #{email_address}"
     end
   end
 end
 
 And /^"([^"]+)" should be the preferred phone number$/ do |phone_number|
-  @phone_numbers.should include "*  #{phone_number}"
+  expect(@phone_numbers).to include "*  #{phone_number}"
   @phone_numbers.each do |line|
     if line.include? "*"
-      line.should eq "*  #{phone_number}"
+      expect(line).to eq "*  #{phone_number}"
     end
   end
 end
@@ -118,25 +118,25 @@ end
 And /^"([^"]+)" should be the preferred postal address$/ do |postal_address|
   @postal_addresses.each do |line|
     if line.include? "*"
-      line.should include "*  #{postal_address}"
+      expect(line).to include "*  #{postal_address}"
     end
   end
 end
 
 And /^there should be no favourite email address$/ do
   @email_addresses.each do |line|
-    line.should_not include "*"
+    expect(line).not_to include "*"
   end
 end
 
 And /^there should be no preferred phone number$/ do
   @phone_numbers.each do |line|
-    line.should_not include "*"
+    expect(line).not_to include "*"
   end
 end
 
 Then /^(bob)'s birthday should be "([^"]+)"$/ do |id, birthday|
-  ppl("bday #{id}").should eq birthday
+  expect(ppl("bday #{id}")).to eq birthday
 end
 
 And /^(bob)'s name is "([^"]+)"$/ do |id, name|

data/gh-pages/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gem 'github-pages'

data/gh-pages/_config.yml

@@ -0,0 +1,5 @@
+source: .
+destination: _site
+exclude: [.git, Gemfile, Gemfile.lock, .gitignore, README.md, Rakefile]
+url: "https://hensmith.github.io/ppl"
+permalink: "/news/:title"

data/gh-pages/_includes/changelog.html

@@ -0,0 +1,23 @@
+{% include header.html %}
+
+<h2>
+  Version {{page.title}}
+  <small>
+    {{page.summary}}
+  </small>
+</h2>
+
+<div class="row commands">
+
+  <div class="span8">
+    {{content}}
+  </div>
+
+  <div class="span4">
+    {% include development-sidebar.html %}
+  </div>
+
+</div>
+
+{% include footer.html %}
+

data/gh-pages/_includes/development-sidebar.html

@@ -0,0 +1,25 @@
+<dl class="nav-sidebar">
+
+  {% if page.title == "Development" %}<dt class="active">{% else %}<dt>{% endif %}
+    <a href="{{site.url}}/development">Introduction</a>
+  </dt>
+  {% if page.title == "Development" %}<dd class="active">{% else %}<dd>{% endif %}
+    The very basics
+  </dd>
+
+  {% if page.title == "Changelog" or page.layout == "changelog" %}<dt class="active">{% else %}<dt>{% endif %}
+    <a href="{{site.url}}/development/changelog">Changelog</a>
+  </dt>
+  {% if page.title == "Changelog" or page.layout == "changelog" %}<dd class="active">{% else %}<dd>{% endif %}
+    The story so far
+  </dd>
+
+  {% if page.title == "Roadmap" %}<dt class="active">{% else %}<dt>{% endif %}
+    <a href="{{site.url}}/development/roadmap">Roadmap</a>
+  </dt>
+  {% if page.title == "Roadmap" %}<dd class="active">{% else %}<dd>{% endif %}
+    The plan for the the future
+  </dd>
+
+</dl>
+

data/gh-pages/_includes/footer.html

@@ -0,0 +1,22 @@
+
+    </div>
+    </div>
+
+    <footer class="global">
+      <div class="footer container">
+        <div class="row">
+          <div class="span12">
+            The contents of this site are available under the terms of the <a
+            href="http://www.gnu.org/copyleft/fdl.html">GNU Free Documentation
+            License</a>.
+          </div>
+        </div>
+      </div>
+    </footer>
+
+    <script src="{{site.url}}/javascript/flatstrap/jquery.js"></script>
+    <script src="{{site.url}}/javascript/flatstrap/bootstrap.min.js"></script>
+
+  </body>
+</html>
+

data/gh-pages/_includes/header.html

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta property="og:title" content="{{page.title}}" />
+    <meta property="og:url" content="{{site.url}}{{page.url}}" />
+    <meta property="og:type" content="website" />
+    <title>{{page.title}}</title>
+
+    <link href='https://fonts.googleapis.com/css?family=Inconsolata:400,700' rel='stylesheet' type='text/css'>
+    <link href='https://fonts.googleapis.com/css?family=Arvo' rel='stylesheet' type='text/css'>
+
+    <link href="{{ site.url }}/stylesheets/flatstrap.css" rel="stylesheet" />
+    <link href="{{ site.url }}/stylesheets/ppl.css" rel="stylesheet" type="text/css" />
+  </head>
+  <body>
+
+    <div class="navbar navbar-static-top">
+      <div class="navbar-inner">
+        <div class="container">
+
+          {% if page.url != "/index.html" %}
+            <a class="brand" href="{{site.url}}/">ppl</a>
+          {% endif %}
+
+          <ul class="nav pull-right">
+            {% if page.section == "documentation" %}<li class="active">{% else %}<li>{% endif %}
+              <a href="{{site.url}}/documentation">Documentation</a>
+            </li>
+            {% if page.section == "news" %}<li class="active">{% else %}<li>{% endif %}
+              <a href="{{site.url}}/news">News</a>
+            </li>
+            {% if page.section == "development" %}<li class="active">{% else %}<li>{% endif %}
+              <a href="{{site.url}}/development">Development</a>
+            </li>
+          </ul>
+        </div>
+      </div>
+    </div>
+
+    <div class="content">
+    <div class="container global">
+