middleman-hashicorp 0.2.0

data/lib/middleman-hashicorp/releases.rb

@@ -0,0 +1,32 @@
+require "open-uri"
+
+class Middleman::HashiCorp::Releases
+  RELEASES_URL = "https://releases.hashicorp.com".freeze
+
+  class Build < Struct.new(:name, :version, :os, :arch, :url); end
+
+  def self.fetch(product, version)
+    url = "#{RELEASES_URL}/#{product}/#{version}/index.json"
+    r = JSON.parse(open(url).string,
+      create_additions: false,
+      symbolize_names: true,
+    )
+
+    # Convert the builds into the following format:
+    #
+    #     {
+    #       "os" => {
+    #         "arch" => "https://download.url"
+    #       }
+    #     }
+    #
+    {}.tap do |h|
+      r[:builds].each do |b|
+        build = Build.new(*b.values_at(*Build.members))
+
+        h[build.os] ||= {}
+        h[build.os][build.arch] = build.url
+      end
+    end
+  end
+end

data/lib/middleman-hashicorp/rouge.rb

@@ -0,0 +1,16 @@
+require "rouge"
+require "rouge/lexers/javascript"
+
+module Rouge
+  module Lexers
+    class HCL < Ruby
+      title "HCL"
+      desc "HashiCorp Configuration Language"
+
+      tag "hcl"
+      aliases "nomad", "terraform", "tf"
+      filenames "*.hcl", "*.nomad", "*.tf"
+      mimetypes "application/hcl", "text/plain"
+    end
+  end
+end

data/lib/middleman-hashicorp/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module HashiCorp
+    VERSION = "0.2.0"
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require "middleman-hashicorp"

data/middleman-hashicorp.gemspec

@@ -0,0 +1,48 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-hashicorp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'middleman-hashicorp'
+  spec.version       = Middleman::HashiCorp::VERSION
+  spec.authors       = ['Seth Vargo']
+  spec.email         = ['sethvargo@gmail.com']
+  spec.summary       = 'A series of helpers for consistency among HashiCorp\'s middleman sites'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/hashicorp/middleman-hashicorp'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  # Middleman
+  spec.add_dependency 'middleman',             '~> 3.4'
+  spec.add_dependency 'middleman-minify-html', '~> 3.4'
+  spec.add_dependency 'middleman-livereload',  '~> 3.4'
+  spec.add_dependency 'middleman-syntax',      '~> 3.0'
+
+  # Assets
+  spec.add_dependency 'bootstrap-sass', '~> 3.3'
+  spec.add_dependency 'builder',        '~> 3.2'
+  spec.add_dependency 'less',           '~> 2.6'
+  spec.add_dependency 'redcarpet',      '~> 3.2'
+  spec.add_dependency 'therubyracer',   '~> 0.12'
+
+  # Server
+  spec.add_dependency 'rack-contrib',      '~> 1.2'
+  spec.add_dependency 'rack-protection',   '~> 1.5'
+  spec.add_dependency 'rack-rewrite',      '~> 1.5'
+  spec.add_dependency 'thin',              '~> 1.6'
+  spec.add_dependency 'rack-ssl-enforcer', '~> 0.2'
+
+  # Development dependencies
+  spec.add_development_dependency 'rspec', '~> 3.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake',    '~> 10.4'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require "rspec"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end
+
+RSpec::Matchers.define :render_html do |html|
+  diffable
+
+  match do |markdown|
+    @expected = html.strip
+
+    instance = Middleman::HashiCorp::RedcarpetHTML.new
+    instance.middleman_app = middleman_app
+
+    options = Middleman::HashiCorp::RedcarpetHTML::REDCARPET_OPTIONS
+    parser = Redcarpet::Markdown.new(instance, options)
+    @actual = parser.render(markdown).strip
+
+    @expected == @actual
+  end
+end
+
+# The default middleman application server.
+#
+# @return [Middleman::Application]
+def middleman_app
+  @app ||= Middleman::Application.server.inst
+end

data/spec/unit/helper_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+require "middleman-hashicorp/extension"
+
+class Middleman::HashiCorpExtension
+  describe "#github_url" do
+    before(:all) do
+      app = middleman_app
+      @instance = Middleman::HashiCorpExtension.new(
+        app,
+        bintray_enabled: false,
+        name: "consul",
+        version: "0.1.0",
+        github_slug: "hashicorp/this_project",
+      )
+      @instance.app = app # unclear why this needs to be set after, but it must
+    end
+
+    it "returns the project's GitHub URL if no argument is supplied" do
+      expect(@instance.app.github_url).to match("https://github.com/hashicorp/this_project")
+    end
+
+    it "returns false if github_slug has not been set" do
+      slugless_app = Middleman::Application.server.inst
+      slugless_instance = Middleman::HashiCorpExtension.new(
+        slugless_app,
+        name: "consul",
+        version: "0.1.0",
+        bintray_enabled: false,
+      )
+      slugless_instance.app = slugless_app
+      expect(slugless_instance.app.github_url).to eq(false)
+    end
+  end
+
+  describe "#path_in_repository" do
+    before(:each) do
+      app = middleman_app
+      @instance = Middleman::HashiCorpExtension.new(
+        app,
+        bintray_enabled: false,
+        name: "consul",
+        version: "0.1.0",
+        github_slug: "hashicorp/this_project",
+        website_root: "website",
+      )
+      @instance.app = app
+    end
+
+    context "when a resource's path string is not within its source_file string" do
+      it "returns a resource's path relative to its source repository's root directory" do
+        current_page = Middleman::Sitemap::Resource.new(
+          @instance.app.sitemap,
+          "intro/examples/cross-provider.html",
+          "/some/bunch/of/directories/intro/examples/cross-provider.markdown")
+        path_in_repository = @instance.app.path_in_repository(current_page)
+        expect(path_in_repository).to match("website/source/intro/examples/cross-provider.markdown")
+      end
+    end
+
+    context "when a resource's path string lies within its source_file string" do
+      it "returns a resource's path relative to its source repository's root directory" do
+        current_page = Middleman::Sitemap::Resource.new(
+          @instance.app.sitemap,
+          "docs/index.html",
+          "/some/bunch/of/directories/website/source/docs/index.html.markdown")
+        path_in_repository = @instance.app.path_in_repository(current_page)
+        expect(path_in_repository).to match("website/source/docs/index.html.markdown")
+      end
+    end
+  end
+end

data/spec/unit/markdown_spec.rb

@@ -0,0 +1,206 @@
+require "spec_helper"
+require "middleman-hashicorp/extension"
+
+module Middleman::HashiCorp
+  describe RedcarpetHTML do
+    it "adds links to code list elements" do
+      markdown = <<-EOH.gsub(/^ {8}/, "")
+        This is a list:
+
+        - `one`
+        - `two` has some `code` inside
+        - `three has ^ and spaces` with text
+        - four
+      EOH
+      output = <<-EOH.gsub(/^ {8}/, "")
+        <p>This is a list:</p>
+
+        <ul>
+        <li><a name="one" /><a href="#one"><code>one</code></a>
+        </li>
+        <li><a name="two" /><a href="#two"><code>two</code></a> has some <code>code</code> inside
+        </li>
+        <li><a name="three_has_and_spaces" /><a href="#three_has_and_spaces"><code>three has ^ and spaces</code></a> with text
+        </li>
+        <li>four
+        </li>
+        </ul>
+      EOH
+
+      expect(markdown).to render_html(output)
+    end
+
+    it "adds links to code list elements when they have newlines" do
+      markdown = <<-EOH.gsub(/^ {8}/, "")
+        This is a list:
+
+        - `one`
+
+        - `two` has some `code` inside
+
+        - `three has ^ and spaces` with text
+
+        - four
+      EOH
+      output = <<-EOH.gsub(/^ {8}/, "")
+        <p>This is a list:</p>
+
+        <ul>
+        <li><p><a name="one" /><a href="#one"><code>one</code></a></p>
+        </li>
+        <li><p><a name="two" /><a href="#two"><code>two</code></a> has some <code>code</code> inside</p>
+        </li>
+        <li><p><a name="three_has_and_spaces" /><a href="#three_has_and_spaces"><code>three has ^ and spaces</code></a> with text</p>
+        </li>
+        <li><p>four</p>
+        </li>
+        </ul>
+      EOH
+
+      expect(markdown).to render_html(output)
+    end
+
+    it "does not add links if they already exist" do
+      markdown = <<-EOH.gsub(/^ {8}/, "")
+        - [`/one`](#link_one): Some text
+        - [`/two`](#link_two)
+        - `three` is a regular auto-link
+        - [`/four`](#link_four) - Same as one but with a -
+      EOH
+      output = <<-EOH.gsub(/^ {8}/, "")
+        <ul>
+        <li><a href="#link_one"><code>/one</code></a>: Some text
+        </li>
+        <li><a href="#link_two"><code>/two</code></a>
+        </li>
+        <li><a name="three" /><a href="#three"><code>three</code></a> is a regular auto-link
+        </li>
+        <li><a href="#link_four"><code>/four</code></a> - Same as one but with a -
+        </li>
+        </ul>
+      EOH
+
+      expect(markdown).to render_html(output)
+    end
+
+    it "adds links to unordered lists with unrelated content links" do
+      markdown = <<-EOH.gsub(/^ {8}/, "")
+        - `one`
+
+        - `two` - has a [link_two](#link_two) inside
+
+        - `three`: is regular but with a colon
+      EOH
+      output = <<-EOH.gsub(/^ {8}/, "")
+        <ul>
+        <li><p><a name="one" /><a href="#one"><code>one</code></a></p>
+        </li>
+        <li><p><a name="two" /><a href="#two"><code>two</code></a> - has a <a href="#link_two">link_two</a> inside</p>
+        </li>
+        <li><p><a name="three" /><a href="#three"><code>three</code></a>: is regular but with a colon</p>
+        </li>
+        </ul>
+      EOH
+
+      expect(markdown).to render_html(output)
+    end
+
+    it "supports markdown inside HTML" do
+      markdown = <<-EOH.gsub(/^ {8}/, "")
+        This is some markdown
+
+        <div class="center">
+          **Here** is some _html_ though! ;)
+        </div>
+      EOH
+      output = <<-EOH.gsub(/^ {8}/, "")
+        <p>This is some markdown</p>
+        <div class="center">
+        <p><strong>Here</strong> is some <em>html</em> though! ;)</p>
+        </div>
+      EOH
+
+      expect(markdown).to render_html(output)
+    end
+
+    it "uses the proper options for recursive markdown" do
+      markdown = <<-EOH.gsub(/^ {8}/, "")
+        This is some markdown
+
+        <div class="center">
+          **Here** is some _html_ though! ;)
+
+          no_intra_emphasis still applies, as does ~~strikethrough~~.
+        </div>
+      EOH
+      output = <<-EOH.gsub(/^ {8}/, "")
+        <p>This is some markdown</p>
+        <div class="center">
+        <p><strong>Here</strong> is some <em>html</em> though! ;)</p>
+        <p>no_intra_emphasis still applies, as does <del>strikethrough</del>.</p>
+        </div>
+      EOH
+
+      expect(markdown).to render_html(output)
+    end
+
+    it "supports alert boxes" do
+      markdown = <<-EOH.gsub(/^ {8}/, "")
+        => This is a success note
+
+        -> This is an info note
+
+        ~> This is a _warning_ note
+
+        !> This is a danger note
+
+        And this is a regular paragraph!
+      EOH
+      output = <<-EOH.gsub(/^ {8}/, "")
+        <div class="alert alert-success" role="alert">
+        <p>This is a success note</p>
+        </div>
+        <div class="alert alert-info" role="alert">
+        <p>This is an info note</p>
+        </div>
+        <div class="alert alert-warning" role="alert">
+        <p>This is a <em>warning</em> note</p>
+        </div>
+        <div class="alert alert-danger" role="alert">
+        <p>This is a danger note</p>
+        </div>
+        <p>And this is a regular paragraph!</p>
+      EOH
+
+      expect(markdown).to render_html(output)
+    end
+
+    it "supports TOC data" do
+      markdown = <<-EOH.gsub(/^ {8}/, "")
+        # Hello World
+        ## Subpath
+      EOH
+      output = <<-EOH.gsub(/^ {8}/, "")
+        <h1 id="hello-world">Hello World</h1>
+
+        <h2 id="subpath">Subpath</h2>
+      EOH
+
+      expect(markdown).to render_html(output)
+    end
+
+    it "supports fenced code blocks" do
+      markdown = <<-EOH.gsub(/^ {8}/, "")
+        ```ruby
+        puts "hi"
+        ```
+      EOH
+      output = <<-EOH.gsub(/^ {8}/, "")
+        <pre><code class="ruby">puts &quot;hi&quot;
+        </code></pre>
+      EOH
+
+      expect(markdown).to render_html(output)
+    end
+  end
+end

data/spec/unit/releases_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+require "middleman-hashicorp/releases"
+
+describe Middleman::HashiCorp::Releases do
+  context "when the product does not exist" do
+    it "returns an error" do
+      expect {
+        described_class.fetch("nope", "")
+      }.to raise_error(OpenURI::HTTPError)
+    end
+  end
+
+  context "when the version does not exist" do
+    it "returns an error" do
+      expect {
+        described_class.fetch("vagrant", "0.0.0")
+      }.to raise_error(OpenURI::HTTPError)
+    end
+  end
+
+  it "returns the JSON representation of the version" do
+    r = described_class.fetch("consul", "0.1.0")
+    expect(r["darwin"]).to eq(
+      "amd64" => "https://releases.hashicorp.com/consul/0.1.0/consul_0.1.0_darwin_amd64.zip",
+    )
+    expect(r["linux"]).to eq(
+      "386" => "https://releases.hashicorp.com/consul/0.1.0/consul_0.1.0_linux_386.zip",
+      "amd64" => "https://releases.hashicorp.com/consul/0.1.0/consul_0.1.0_linux_amd64.zip",
+    )
+    expect(r["windows"]).to eq(
+      "386" => "https://releases.hashicorp.com/consul/0.1.0/consul_0.1.0_windows_386.zip",
+    )
+  end
+end