Added codemeta2cff tool

Author: rsdoiel

CITATION.cff

@@ -0,0 +1,9 @@
+
+cff-version: 1.1.0
+message: "If you use this software, please cite it as below."
+authors:
+   - family-names: Doiel
+     given-names: Robert
+     orcid: https://orcid.org/0000-0003-0900-6903
+
+date-released: 2021-07-15

INSTALL.md

@@ -42,7 +42,7 @@ The basic recipe
 + Test
 
 
-### Mac OS X
+### Mac OS
 
 1. Download the zip file
 2. Unzip the zip file
@@ -127,9 +127,7 @@ downloading the zip file.
 Compiling from source
 ---------------------
 
-_datatools_ is "go gettable" if you have gotten xlsx v1.0.5 package from [github.com/tealeg/xlsx](https://github.com/tealeg/xlsx).  The datatools package does not support versions v2.x and greater of xlsx. Below are the steps
-I use today with "go get" command to download the dependant packages
-as well as _datatools_'s source code.
+_datatools_ is "go gettable" if you have previously gotten xlsx v1.0.5 package from [github.com/tealeg/xlsx](https://github.com/tealeg/xlsx).  The datatools package does not support versions v2.x and greater of xlsx. Below are the steps I use today with "go get" command to download the dependant packages as well as _datatools_'s source code.
 
 Setting up the right version of xlsx for datatools
 

Makefile

@@ -31,6 +31,7 @@ Excel Workbooks and plain text files or content.
 + [xlsx2csv](docs/xlsx2csv/) - a tool for converting Excel Workbooks sheets to CSV files
 + [xlsx2json](docs/xlsx2json/) - a tool for converting Excel Workbooks to JSON files
 + [yaml2json](docs/yaml2json/) - a tool for converting YAML files to JSON
++ [codemeta2cff](docs/codemeta2cff) - a tool to convert a codemeta.json file into a CITATION.cff file.
 
 
 Compiled versions are provided for Linux (amd64), Mac OS X (amd64),

README.md

@@ -0,0 +1,101 @@
+// codemeta2cff.go converts a codemeta.json file to CITATION.cff.
+//
+// Author: R. S. Doiel <[email protected]>
+//
+// Copyright (c) 2021, Caltech
+// All rights not granted herein are expressly reserved by Caltech.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice,
+// this list of conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice,
+// this list of conditions and the following disclaimer in the documentation
+// and/or other materials provided with the distribution.
+//
+// 3. Neither the name of the copyright holder nor the names of its contributors
+// may be used to endorse or promote products derived from this software without
+// specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+//
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+	"path"
+
+	// Caltech Library Package
+	"github.com/caltechlibrary/datatools"
+)
+
+func usage(appName string, exitCode int) {
+	out := os.Stderr
+	if exitCode == 0 {
+		out = os.Stdout
+	}
+	fmt.Fprintf(out, `
+USAGE: %s
+
+    %s
+
+Reads codemeta.json file and writes CITATION.cff.
+
+OPTIONS
+
+    -h, -help      display help
+
+EXAMPLE
+
+    %s
+
+datatools v%s
+`, appName, appName, appName, datatools.Version)
+	os.Exit(exitCode)
+}
+
+func main() {
+	// command line name and options support
+	appName := path.Base(os.Args[0])
+	help, version := false, false
+	args := []string{}
+	// Setup to parse command line
+	flag.BoolVar(&help, "h", false, "display help")
+	flag.BoolVar(&help, "help", false, "display help")
+	flag.BoolVar(&version, "version", false, "display version")
+	flag.Parse()
+
+	args = flag.Args()
+
+	// Process options and run report
+	if help {
+		usage(appName, 0)
+	}
+	if version {
+		fmt.Printf("datatools, %s v%s\n", appName, datatools.Version)
+		os.Exit(0)
+	}
+	if len(args) != 0 {
+		fmt.Printf("This command always reads codemeta.json creating/replacing CITATION.cff\n\n")
+		usage(appName, 1)
+	}
+	err := datatools.CodemetaToCitationCff("codemeta.json", "CITATION.cff")
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "ERROR: %s\n", err)
+		os.Exit(1)
+	}
+}

RELEASES.html

@@ -6,7 +6,7 @@
     "codeRepository": "https://github.com/caltechlibrary/datatools",
     "issueTracker": "https://github.com/caltechlibrary/datatools/issues",
     "license": "https://data.caltech.edu/license",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "author": [
         {
             "@type": "Person",

RELEASES.md

@@ -0,0 +1,101 @@
+package codemeta
+
+import (
+	"encoding/json"
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/caltechlibrary/doitools"
+)
+
+type PersonOrOrganization struct {
+	// ORCID is use for person id
+	Id   string `json:"@id"`
+	Type string `json:"@type"`
+	// Name is used by organizations
+	Name string `json:"name,omitempty"`
+	// Given/Family are used by individual persons
+	GivenName   string `json:"givenName,omitempty"`
+	FamilyName  string `json:"familyName,omitempty"`
+	Affiliation string `json:"affiliation"`
+	Email       string `json:"email"`
+}
+
+type Codemeta struct {
+	// Terms used by Caltech Library codemeta.json
+	// Id should be the DOI if available
+	Context           string                  `json:"@context"`
+	Type              string                  `json:"@type"`
+	Name              string                  `json:"name"`
+	Description       string                  `json:"description"`
+	CodeRepository    string                  `json:"codeRepository"`
+	IssueTracker      string                  `json:"issueTracker"`
+	License           string                  `json:"license"`
+	Version           string                  `json:"version"`
+	Author            []*PersonOrOrganization `json:"author"`
+	Contributor       []*PersonOrOrganization `json:"contributor,omitempty"`
+	Editor            []*PersonOrOrganization `json:"editor,omitempty"`
+	DevelopmentStatus string                  `json:"developmentStatus"`
+	DownloadURL       string                  `json:"downloadUrl"`
+	Keywords          []string                `json:"keywords"`
+	Maintainer        string                  `json:"maintainer,omitempty"`
+	Funder            []*PersonOrOrganization `json:"funder,omitempty"`
+	CopyrightHolder   []*PersonOrOrganization `json:"copyrightHolder,omitempty"`
+	CopyrightYear     string                  `json:"copyrightYear,omitempty"`
+	Created           string                  `json:"dateCreated,omitempty"`
+	Updated           string                  `json:"dateModified,omitempty"`
+	Published         string                  `json:"datePublished,omitempty"`
+	Identifier        string                  `json:"identifier,omitempty"` //FIXME: Is this where I can put the DOI
+
+	// Additional codemeta Terms are defined at https://codemeta.github.io/terms/
+}
+
+func (person *PersonOrOrganization) ToJSON() ([]byte, error) {
+	return json.MarshalIndent(person, "", "\t")
+}
+
+func (cm *Codemeta) ToJSON() ([]byte, error) {
+	return json.MarshalIndent(cm, "", "\t")
+}
+
+func (person *PersonOrOrganization) ToCFF() ([]byte, error) {
+	if (person.FamilyName == "") || (person.GivenName == "") || (strings.HasPrefix(person.Id, "https://orcid.org/") == false) {
+		return []byte(""), fmt.Errorf("Missing family name, given name or ORCID")
+	}
+	return []byte(fmt.Sprintf(`
+   - family-names: %s
+     given-names: %s
+     orcid: %s`, person.FamilyName, person.GivenName, person.Id)), nil
+}
+
+// ToCff crosswalks a Codemeta data structure rendering
+// CITATION.cff document as an array of byte.
+// Based on documentation at https://citation-file-format.github.io/
+func (cm *Codemeta) ToCff() ([]byte, error) {
+	src := []byte(`
+cff-version: 1.1.0
+message: "If you use this software, please cite it as below."
+authors:`)
+	for _, person := range cm.Author {
+		if text, err := person.ToCFF(); err == nil {
+			src = append(src, text...)
+		}
+	}
+	if strings.HasPrefix(cm.Identifier, "https://doi.org/") {
+		if doi, err := doitools.NormalizeDOI(cm.Identifier); err == nil {
+			src = append(src, []byte(fmt.Sprintf(`
+doi: %s`, doi))...)
+		}
+	}
+	if cm.Published != "" {
+		src = append(src, []byte(fmt.Sprintf(`
+date-released: %s`, cm.Published))...)
+	} else {
+		now := time.Now()
+		dt := now.Format("2006-01-02")
+		src = append(src, []byte(fmt.Sprintf(`
+date-released: %s`, dt))...)
+	}
+	return src, nil
+}