drhuffman12/ci_matrix CouchDB (2.x? and 3.x?) (#2)

* drhuffman12/ci_matrix initial prep * drhuffman12/ci_matrix Copy Github CI w/ matrix re multiple Crystal versions. TODO: edit to include multiple CouchDB versions (or at least one 'latest') * drhuffman12/ci_matrix Copy over "scripts/regen_docs". * drhuffman12/ci_matrix Add 'docs' folder. * drhuffman12/ci_matrix Expand tests for "CouchDB::VERSION" * drhuffman12/ci_matrix Re-gen doc's and add to repo. * drhuffman12/ci_matrix Matrix-ize CouchDB 2 vs 3 checks in CircleCI * drhuffman12/ci_matrix Disable Github Workflows/Actions; trying CircleCI matrix instead. * drhuffman12/ci_matrix remove github workflow related files (no longer needed)
drhuffman12 · Sep 6, 2021 · fa450b9 · fa450b9
1 parent 4e4c9b5
commit fa450b9
Show file tree

Hide file tree

Showing 24 changed files with 8,467 additions and 6 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,11 +1,11 @@
 version: 2
 jobs:
-  build:
+  build_couchdb_2:
     docker:
       - image: crystallang/crystal:nightly
         environment:
           TEST_DB: "http://admin:1234@localhost:5984"
-      - image: couchdb:2.3
+      - image: couchdb:2
         environment:
           COUCHDB_USER: "admin"
           COUCHDB_PASSWORD: 1234
@@ -21,11 +21,33 @@ jobs:
       - store_artifacts:
           path: docs
           destination: /docs
+  build_couchdb_3:
+    docker:
+      - image: crystallang/crystal:nightly
+        environment:
+          TEST_DB: "http://admin:1234@localhost:5984"
+      - image: couchdb:3
+        environment:
+          COUCHDB_USER: "admin"
+          COUCHDB_PASSWORD: 1234
+    environment:
+    steps:
+      - checkout
+      - run: crystal --version
+      - run: shards install
+      - run: crystal spec --junit_output=test_results
+      - store_test_results:
+          path: test_results
+      - run: crystal docs --project-name $(basename $(pwd)) --project-version $(shards version)
+      - store_artifacts:
+          path: docs
+          destination: /docs
 workflows:
   version: 2
   commit:
     jobs:
-      - build
+      - build_couchdb_2
+      - build_couchdb_3
   nightly:
     triggers:
       - schedule:
@@ -35,4 +57,5 @@ workflows:
               only:
                 - master
     jobs:
-      - build
+      - build_couchdb_2
+      - build_couchdb_3
diff --git a/.gitignore b/.gitignore
@@ -1,9 +1,12 @@
-/doc/
 /lib/
 /bin/
+/tmp/
 /.shards/
 
 # Libraries don't need dependency lock
 # Dependencies will be locked in application that uses them
 /shard.lock
-/docs
+# /docs
+
+/test-results/
+spec/tmp/
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,8 @@
+FROM crystallang/crystal:nightly-alpine-build
+
+WORKDIR /app
+ADD . /app
+
+RUN shards install --ignore-crystal-version
+RUN shards update --ignore-crystal-version
+# RUN shards build
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,9 @@
+version: '3'
+services:
+  app:
+    build: .
+    volumes:
+      - ./:/app
+  volumes:
+    - tmp/db:/opt/couchdb/etc/local.d
+
diff --git a/docs/CouchDB.html b/docs/CouchDB.html
@@ -0,0 +1,286 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="generator" content="Crystal Docs 1.0.0">
+<meta name="crystal_docs.project_version" content="0.4.0">
+<meta name="crystal_docs.project_name" content="couchdb.cr">
+
+
+
+<link href="css/style.css" rel="stylesheet" type="text/css" />
+<script type="text/javascript" src="js/doc.js"></script>
+
+  <meta name="repository-name" content="couchdb.cr">
+  <title>CouchDB - couchdb.cr 0.4.0</title>
+  <script type="text/javascript">
+    CrystalDocs.base_path = "";
+  </script>
+</head>
+<body>
+
+<svg class="hidden">
+  <symbol id="octicon-link" viewBox="0 0 16 16">
+    <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
+  </symbol>
+</svg>
+<div class="sidebar">
+  <div class="sidebar-header">
+    <div class="search-box">
+      <input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
+    </div>
+
+    <div class="project-summary">
+      <h1 class="project-name">
+        <a href="index.html">
+          couchdb.cr
+        </a>
+      </h1>
+
+      <span class="project-version">
+        0.4.0
+      </span>
+    </div>
+  </div>
+
+  <div class="search-results hidden">
+    <ul class="search-list"></ul>
+  </div>
+
+  <div class="types-list">
+    <ul>
+
+  <li class="parent open current" data-id="couchdb.cr/CouchDB" data-name="couchdb">
+      <a href="CouchDB.html">CouchDB</a>
+
+        <ul>
+
+  <li class=" " data-id="couchdb.cr/CouchDB/Client" data-name="couchdb::client">
+      <a href="CouchDB/Client.html">Client</a>
+
+    </li>
+
+  <li class=" " data-id="couchdb.cr/CouchDB/Database" data-name="couchdb::database">
+      <a href="CouchDB/Database.html">Database</a>
+
+    </li>
+
+  <li class=" " data-id="couchdb.cr/CouchDB/FindQuery" data-name="couchdb::findquery">
+      <a href="CouchDB/FindQuery.html">FindQuery</a>
+
+    </li>
+
+  <li class="parent " data-id="couchdb.cr/CouchDB/Response" data-name="couchdb::response">
+      <a href="CouchDB/Response.html">Response</a>
+
+        <ul>
+
+  <li class=" " data-id="couchdb.cr/CouchDB/Response/ActiveTask" data-name="couchdb::response::activetask">
+      <a href="CouchDB/Response/ActiveTask.html">ActiveTask</a>
+
+    </li>
+
+  <li class=" " data-id="couchdb.cr/CouchDB/Response/DocumentStatus" data-name="couchdb::response::documentstatus">
+      <a href="CouchDB/Response/DocumentStatus.html">DocumentStatus</a>
+
+    </li>
+
+  <li class=" " data-id="couchdb.cr/CouchDB/Response/FindResults" data-name="couchdb::response::findresults(t)">
+      <a href="CouchDB/Response/FindResults.html">FindResults</a>
+
+    </li>
+
+  <li class=" " data-id="couchdb.cr/CouchDB/Response/Result" data-name="couchdb::response::result">
+      <a href="CouchDB/Response/Result.html">Result</a>
+
+    </li>
+
+  <li class=" " data-id="couchdb.cr/CouchDB/Response/Results" data-name="couchdb::response::results">
+      <a href="CouchDB/Response/Results.html">Results</a>
+
+    </li>
+
+  <li class=" " data-id="couchdb.cr/CouchDB/Response/ServerInfo" data-name="couchdb::response::serverinfo">
+      <a href="CouchDB/Response/ServerInfo.html">ServerInfo</a>
+
+    </li>
+
+  <li class=" " data-id="couchdb.cr/CouchDB/Response/Status" data-name="couchdb::response::status">
+      <a href="CouchDB/Response/Status.html">Status</a>
+
+    </li>
+
+  <li class=" " data-id="couchdb.cr/CouchDB/Response/Vendor" data-name="couchdb::response::vendor">
+      <a href="CouchDB/Response/Vendor.html">Vendor</a>
+
+    </li>
+
+</ul>
+
+
+    </li>
+
+  <li class=" " data-id="couchdb.cr/CouchDB/URL" data-name="couchdb::url">
+      <a href="CouchDB/URL.html">URL</a>
+
+    </li>
+
+</ul>
+
+
+    </li>
+
+</ul>
+
+  </div>
+</div>
+
+
+<div class="main-content">
+<h1 class="type-name">
+
+  <span class="kind">module</span> CouchDB
+
+</h1>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  <h2>
+    <a id="defined-in" class="anchor" href="#defined-in">
+  <svg class="octicon-link" aria-hidden="true">
+    <use href="#octicon-link"/>
+  </svg>
+</a>
+    Defined in:
+  </h2>
+
+
+      couchdb.cr
+
+    <br/>
+
+
+      couchdb/client.cr
+
+    <br/>
+
+
+      couchdb/database.cr
+
+    <br/>
+
+
+      couchdb/find_query.cr
+
+    <br/>
+
+
+      couchdb/version.cr
+
+    <br/>
+
+
+
+
+
+    <h2>
+      <a id="constant-summary" class="anchor" href="#constant-summary">
+  <svg class="octicon-link" aria-hidden="true">
+    <use href="#octicon-link"/>
+  </svg>
+</a>
+      Constant Summary
+    </h2>
+
+  <dl>
+
+      <dt class="entry-const" id="VERSION">
+        <strong>VERSION</strong> = <code>{{ (<span class="s">`shards version \&quot;/home/drhuffman/_tmp_/github/drhuffman12/couchdb.cr/src/couchdb\&quot;`</span>).chomp.stringify }}</code>
+      </dt>
+
+
+  </dl>
+
+
+
+
+
+
+
+
+
+  <h2>
+    <a id="macro-summary" class="anchor" href="#macro-summary">
+  <svg class="octicon-link" aria-hidden="true">
+    <use href="#octicon-link"/>
+  </svg>
+</a>
+    Macro Summary
+  </h2>
+  <ul class="list-summary">
+
+      <li class="entry-summary">
+        <a href="#mapping(**properties)-macro" class="signature"><strong>mapping</strong>(**properties)</a>
+
+      </li>
+
+  </ul>
+
+
+
+<div class="methods-inherited">
+
+</div>
+
+
+
+
+
+
+
+
+  <h2>
+    <a id="macro-detail" class="anchor" href="#macro-detail">
+  <svg class="octicon-link" aria-hidden="true">
+    <use href="#octicon-link"/>
+  </svg>
+</a>
+    Macro Detail
+  </h2>
+
+    <div class="entry-detail" id="mapping(**properties)-macro">
+      <div class="signature">
+
+        macro <strong>mapping</strong>(**properties)
+
+        <a class="method-permalink" href="#mapping(**properties)-macro">#</a>
+      </div>
+
+      <br/>
+      <div>
+
+      </div>
+    </div>
+
+
+
+</div>
+
+</body>
+</html>