@dotinc/ogre-react 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# v0.2.1 (Sun Mar 13 2022)
+
+#### ⚠️ Pushed to `main`
+
+- npm release of ogre-react ([@nadilas](https://github.com/nadilas))
+
+#### Authors: 1
+
+- [@nadilas](https://github.com/nadilas)

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 dot Industries, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/OgreGraph.tsx

@@ -0,0 +1,29 @@
+import React, {useEffect, useState} from 'react'
+import {Gitgraph} from '@gitgraph/react'
+import {RepositoryObject} from '@dotinc/ogre'
+import {formatGit2Json} from './git2json'
+
+export interface OgreGraphProps {
+  repository: RepositoryObject<any>
+}
+
+export const OgreGraph: React.FC<OgreGraphProps> = ({repository}) => {
+  const [graphData, setGraphData] = useState<any[] | undefined>(undefined)
+
+  useEffect(() => {
+    if (!graphData) {
+      const history = repository.getHistory()
+      setGraphData(formatGit2Json(history))
+    }
+  }, [repository])
+
+  return !graphData
+    ? null
+    : (
+      <Gitgraph>
+        {(gitgraph) => {
+          gitgraph.import(graphData)
+        }}
+      </Gitgraph>
+    )
+}

package/git2json.tsx

@@ -0,0 +1,53 @@
+import {cleanAuthor, Commit, createHeadRefValue, History, isTagRef, Reference, REFS_HEAD_KEY} from '@dotinc/ogre'
+
+const findRefs = (commit: Commit, refs: Map<string, Reference>) => {
+  const list = []
+  const headRef = refs.get(REFS_HEAD_KEY)
+  for (const [key, ref] of refs.entries()) {
+    if (ref.value === commit.hash) {
+      if (isTagRef(key)) {
+        list.push(`tag: ${ref.name}`)
+      } else {
+        list.push(ref.name)
+      }
+      // also check if HEAD is pointing to this ref
+      if (headRef && headRef.value === createHeadRefValue(key)) {
+        list.push(headRef.name)
+      }
+    }
+  }
+  return list
+}
+// format
+export const formatGit2Json = (history: History) => {
+  const {commits, refs} = history
+  return commits.reverse().map(c => {
+    const [name, email] = cleanAuthor(c.author)
+
+    return {
+      'refs': findRefs(c, refs),
+      'hash': c.hash,
+      'hashAbbrev': c.hash.substring(0, 8),
+      'tree': c.tree,
+      'treeAbbrev': c.tree.substring(0, 8),
+      // FIXME there is only one parent at the moment on ogre
+      'parents': c.parent ? [c.parent] : [],
+      'parentsAbbrev': c.parent ? [c.parent.substring(0, 8)] : [],
+      committer: {
+        name,
+        email,
+        date: c.timestamp.getMilliseconds()
+      },
+      author: {
+        name,
+        email,
+        timestamp: c.timestamp.getMilliseconds()
+      },
+      'subject': c.message,
+      'body': '',
+      'notes': '',
+      // MAYBE? map changes to {additions: number, deletions: number, file: string}
+      'stats': []
+    }
+  })
+}

package/index.tsx

@@ -0,0 +1,2 @@
+export * from './OgreGraph'
+export {formatGit2Json} from './git2json'

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@dotinc/ogre-react",
+  "version": "0.2.1",
+  "main": "./index.tsx",
+  "types": "./index.tsx",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dotindustries/ogre.git"
+  },
+  "dependencies": {
+    "@dotinc/ogre": "^0.2.0",
+    "@gitgraph/react": "^1.6.0"
+  },
+  "devDependencies": {
+    "@types/react": "^17.0.39",
+    "@types/react-dom": "^17.0.13",
+    "config": "^0.1.1",
+    "tsconfig": "^0.1.1",
+    "typescript": "^4.5.3"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "gitHead": "df481b3cb9b0e16853561759ea26c44c3e268286"
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "tsconfig/react-library.json",
+  "include": ["."],
+  "exclude": ["dist", "build", "node_modules"],
+  "compilerOptions": {
+    "downlevelIteration": true
+  }
+}