Generate build infrastructure with hall, add tests
This commit is contained in:
parent
c393784573
commit
05f019b269
17 changed files with 669 additions and 1 deletions
65
.gitignore
vendored
Normal file
65
.gitignore
vendored
Normal file
|
@ -0,0 +1,65 @@
|
||||||
|
*.eps
|
||||||
|
*.go
|
||||||
|
*.log
|
||||||
|
*.pdf
|
||||||
|
*.png
|
||||||
|
*.tar.xz
|
||||||
|
*.tar.gz
|
||||||
|
*.tmp
|
||||||
|
*~
|
||||||
|
.#*
|
||||||
|
\#*\#
|
||||||
|
,*
|
||||||
|
/ABOUT-NLS
|
||||||
|
/INSTALL
|
||||||
|
/aclocal.m4
|
||||||
|
/autom4te.cache
|
||||||
|
/build-aux/ar-lib
|
||||||
|
/build-aux/compile
|
||||||
|
/build-aux/config.guess
|
||||||
|
/build-aux/config.rpath
|
||||||
|
/build-aux/config.sub
|
||||||
|
/build-aux/depcomp
|
||||||
|
/build-aux/install-sh
|
||||||
|
/build-aux/mdate-sh
|
||||||
|
/build-aux/missing
|
||||||
|
/build-aux/test-driver
|
||||||
|
/build-aux/texinfo.tex
|
||||||
|
/config.status
|
||||||
|
/configure
|
||||||
|
/doc/*.1
|
||||||
|
/doc/.dirstamp
|
||||||
|
/doc/contributing.*.texi
|
||||||
|
/doc/*.aux
|
||||||
|
/doc/*.cp
|
||||||
|
/doc/*.cps
|
||||||
|
/doc/*.fn
|
||||||
|
/doc/*.fns
|
||||||
|
/doc/*.html
|
||||||
|
/doc/*.info
|
||||||
|
/doc/*.info-[0-9]
|
||||||
|
/doc/*.ky
|
||||||
|
/doc/*.pg
|
||||||
|
/doc/*.toc
|
||||||
|
/doc/*.t2p
|
||||||
|
/doc/*.tp
|
||||||
|
/doc/*.vr
|
||||||
|
/doc/*.vrs
|
||||||
|
/doc/stamp-vti
|
||||||
|
/doc/version.texi
|
||||||
|
/doc/version-*.texi
|
||||||
|
/m4/*
|
||||||
|
/pre-inst-env
|
||||||
|
/test-env
|
||||||
|
/test-tmp
|
||||||
|
/tests/*.trs
|
||||||
|
GPATH
|
||||||
|
GRTAGS
|
||||||
|
GTAGS
|
||||||
|
Makefile
|
||||||
|
Makefile.in
|
||||||
|
config.cache
|
||||||
|
stamp-h[0-9]
|
||||||
|
tmp
|
||||||
|
/.version
|
||||||
|
/doc/stamp-[0-9]
|
3
AUTHORS
Normal file
3
AUTHORS
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
Contributors to Guile Geohash 0.1:
|
||||||
|
|
||||||
|
Ray Miller <ray@1729.org.uk>
|
3
COPYING
Normal file
3
COPYING
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
This project's license is GPL 3+.
|
||||||
|
|
||||||
|
You can read the full license at https://www.gnu.org/licenses/gpl.html.
|
1
ChangeLog
Normal file
1
ChangeLog
Normal file
|
@ -0,0 +1 @@
|
||||||
|
For a complete log, please see the Git commit log at <https://github.com/ray1729/guile-geohash/PATH/TO/LOG>.
|
54
HACKING
Normal file
54
HACKING
Normal file
|
@ -0,0 +1,54 @@
|
||||||
|
# -*- mode: org; coding: utf-8; -*-
|
||||||
|
|
||||||
|
#+TITLE: Hacking geohash
|
||||||
|
|
||||||
|
* Contributing
|
||||||
|
|
||||||
|
By far the easiest way to hack on geohash is to develop using Guix:
|
||||||
|
|
||||||
|
#+BEGIN_SRC bash
|
||||||
|
# Obtain the source code
|
||||||
|
cd /path/to/source-code
|
||||||
|
guix shell -Df guix.scm
|
||||||
|
# In the new shell, run:
|
||||||
|
hall build --execute && autoreconf -vif && ./configure && make check
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
You may also want to set your directory as an authorized directory for
|
||||||
|
`guix shell' so it works without arguments. To do that, simply run
|
||||||
|
|
||||||
|
#+BEGIN_SRC bash
|
||||||
|
echo $(pwd) >> $HOME/.config/guix/shell-authorized-directories
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
You can now hack this project's files to your heart's content, whilst
|
||||||
|
testing them from your `guix shell' shell.
|
||||||
|
|
||||||
|
To try out any scripts in the project you can now use
|
||||||
|
|
||||||
|
#+BEGIN_SRC bash
|
||||||
|
./pre-inst-env scripts/${script-name}
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
If you'd like to tidy the project again, but retain the ability to test the
|
||||||
|
project from the commandline, simply run:
|
||||||
|
|
||||||
|
#+BEGIN_SRC bash
|
||||||
|
./hall clean --skip "scripts/${script-name},pre-inst-env" --execute
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
** Manual Installation
|
||||||
|
|
||||||
|
If you do not yet use Guix, you will have to install this project's
|
||||||
|
dependencies manually:
|
||||||
|
- autoconf
|
||||||
|
- automake
|
||||||
|
- pkg-config
|
||||||
|
- texinfo
|
||||||
|
- guile-hall
|
||||||
|
|
||||||
|
Once those dependencies are installed you can run:
|
||||||
|
|
||||||
|
#+BEGIN_SRC bash
|
||||||
|
hall build -x && autoreconf -vif && ./configure && make check
|
||||||
|
#+END_SRC
|
73
Makefile.am
Normal file
73
Makefile.am
Normal file
|
@ -0,0 +1,73 @@
|
||||||
|
bin_SCRIPTS =
|
||||||
|
|
||||||
|
nodist_noinst_SCRIPTS = pre-inst-env
|
||||||
|
|
||||||
|
GOBJECTS = $(SOURCES:%.scm=%.go)
|
||||||
|
|
||||||
|
moddir=$(prefix)/share/guile/site/$(GUILE_EFFECTIVE_VERSION)
|
||||||
|
godir=$(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache
|
||||||
|
ccachedir=$(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache
|
||||||
|
|
||||||
|
nobase_dist_mod_DATA = $(SOURCES) $(NOCOMP_SOURCES)
|
||||||
|
nobase_go_DATA = $(GOBJECTS)
|
||||||
|
|
||||||
|
# Make sure source files are installed first, so that the mtime of
|
||||||
|
# installed compiled files is greater than that of installed source
|
||||||
|
# files. See
|
||||||
|
# <http://lists.gnu.org/archive/html/guile-devel/2010-07/msg00125.html>
|
||||||
|
# for details.
|
||||||
|
guile_install_go_files = install-nobase_goDATA
|
||||||
|
$(guile_install_go_files): install-nobase_dist_modDATA
|
||||||
|
|
||||||
|
GUILE_WARNINGS = -Wunbound-variable -Warity-mismatch -Wformat
|
||||||
|
SUFFIXES = .scm .go
|
||||||
|
.scm.go:
|
||||||
|
$(AM_V_GEN)$(top_builddir)/pre-inst-env $(GUILE_TOOLS) compile $(GUILE_TARGET) $(GUILE_WARNINGS) -o "$@" "$<"
|
||||||
|
|
||||||
|
SOURCES = geohash.scm \
|
||||||
|
geohash/hconfig.go \
|
||||||
|
geohash/hconfig.scm
|
||||||
|
|
||||||
|
TESTS = tests/geohash.scm
|
||||||
|
|
||||||
|
TEST_EXTENSIONS = .scm
|
||||||
|
SCM_LOG_DRIVER = \
|
||||||
|
$(top_builddir)/pre-inst-env \
|
||||||
|
$(GUILE) --no-auto-compile -e main \
|
||||||
|
$(top_srcdir)/build-aux/test-driver.scm
|
||||||
|
|
||||||
|
# Tell 'build-aux/test-driver.scm' to display only source file names,
|
||||||
|
# not indivdual test names.
|
||||||
|
AM_SCM_LOG_DRIVER_FLAGS = --brief=yes
|
||||||
|
|
||||||
|
AM_SCM_LOG_FLAGS = --no-auto-compile -L "$(top_srcdir)"
|
||||||
|
|
||||||
|
AM_TESTS_ENVIRONMENT = abs_top_srcdir="$(abs_top_srcdir)"
|
||||||
|
|
||||||
|
info_TEXINFOS = doc/geohash.texi \
|
||||||
|
doc/version.texi
|
||||||
|
|
||||||
|
EXTRA_DIST = README \
|
||||||
|
HACKING \
|
||||||
|
COPYING \
|
||||||
|
doc/.dirstamp \
|
||||||
|
doc/stamp-vti \
|
||||||
|
doc/guile-geohash.info \
|
||||||
|
guix.scm \
|
||||||
|
.gitignore \
|
||||||
|
hall.scm \
|
||||||
|
build-aux/test-driver.scm \
|
||||||
|
$(TESTS)
|
||||||
|
|
||||||
|
ACLOCAL_AMFLAGS = -I m4
|
||||||
|
|
||||||
|
AM_DISTCHECK_DVI_TARGET = info # Disable DVI as part of distcheck
|
||||||
|
|
||||||
|
clean-go:
|
||||||
|
-$(RM) $(GOBJECTS)
|
||||||
|
.PHONY: clean-go
|
||||||
|
|
||||||
|
CLEANFILES = \
|
||||||
|
$(BUILT_SOURCES) \
|
||||||
|
$(GOBJECTS) \
|
||||||
|
$(TESTS:tests/%.scm=%.log)
|
14
NEWS
Normal file
14
NEWS
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
# -*- mode: org; coding: utf-8; -*-
|
||||||
|
|
||||||
|
#+TITLE: Guile Geohash NEWS – history of user-visible changes
|
||||||
|
#+STARTUP: content hidestars
|
||||||
|
|
||||||
|
Copyright © (2024) Ray Miller <ray@1729.org.uk>
|
||||||
|
|
||||||
|
Copying and distribution of this file, with or without modification,
|
||||||
|
are permitted in any medium without royalty provided the copyright
|
||||||
|
notice and this notice are preserved.
|
||||||
|
|
||||||
|
Please send Guile Geohash bug reports to ray@1729.org.uk.
|
||||||
|
|
||||||
|
* Publication at 0.1
|
4
README
Normal file
4
README
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
# -*- mode: org; coding: utf-8; -*-
|
||||||
|
|
||||||
|
#+TITLE: README for Guile Geohash
|
||||||
|
|
179
build-aux/test-driver.scm
Normal file
179
build-aux/test-driver.scm
Normal file
|
@ -0,0 +1,179 @@
|
||||||
|
;;;; test-driver.scm - Guile test driver for Automake testsuite harness
|
||||||
|
|
||||||
|
(define script-version "2019-01-15.13") ;UTC
|
||||||
|
|
||||||
|
;;; Copyright © 2015, 2016 Mathieu Lirzin <mthl@gnu.org>
|
||||||
|
;;; Copyright © 2019 Alex Sassmannshausen <alex@pompo.co>
|
||||||
|
;;;
|
||||||
|
;;; This program is free software; you can redistribute it and/or modify it
|
||||||
|
;;; under the terms of the GNU General Public License as published by
|
||||||
|
;;; the Free Software Foundation; either version 3 of the License, or (at
|
||||||
|
;;; your option) any later version.
|
||||||
|
;;;
|
||||||
|
;;; This program is distributed in the hope that it will be useful, but
|
||||||
|
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
;;; GNU General Public License for more details.
|
||||||
|
;;;
|
||||||
|
;;; You should have received a copy of the GNU General Public License
|
||||||
|
;;; along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
;;;; Commentary:
|
||||||
|
;;;
|
||||||
|
;;; This script provides a Guile test driver using the SRFI-64 Scheme API for
|
||||||
|
;;; test suites. SRFI-64 is distributed with Guile since version 2.0.9.
|
||||||
|
;;;
|
||||||
|
;;; This script is a lightly modified version of the orignal written by
|
||||||
|
;;; Matthieu Lirzin. The changes make it suitable for use as part of the
|
||||||
|
;;; guile-hall infrastructure.
|
||||||
|
;;;
|
||||||
|
;;;; Code:
|
||||||
|
|
||||||
|
(use-modules (ice-9 getopt-long)
|
||||||
|
(ice-9 pretty-print)
|
||||||
|
(srfi srfi-26)
|
||||||
|
(srfi srfi-64))
|
||||||
|
|
||||||
|
(define (show-help)
|
||||||
|
(display "Usage:
|
||||||
|
test-driver --test-name=NAME --log-file=PATH --trs-file=PATH
|
||||||
|
[--expect-failure={yes|no}] [--color-tests={yes|no}]
|
||||||
|
[--enable-hard-errors={yes|no}] [--brief={yes|no}}] [--]
|
||||||
|
TEST-SCRIPT [TEST-SCRIPT-ARGUMENTS]
|
||||||
|
The '--test-name', '--log-file' and '--trs-file' options are mandatory.
|
||||||
|
"))
|
||||||
|
|
||||||
|
(define %options
|
||||||
|
'((test-name (value #t))
|
||||||
|
(log-file (value #t))
|
||||||
|
(trs-file (value #t))
|
||||||
|
(color-tests (value #t))
|
||||||
|
(expect-failure (value #t)) ;XXX: not implemented yet
|
||||||
|
(enable-hard-errors (value #t)) ;not implemented in SRFI-64
|
||||||
|
(brief (value #t))
|
||||||
|
(help (single-char #\h) (value #f))
|
||||||
|
(version (single-char #\V) (value #f))))
|
||||||
|
|
||||||
|
(define (option->boolean options key)
|
||||||
|
"Return #t if the value associated with KEY in OPTIONS is 'yes'."
|
||||||
|
(and=> (option-ref options key #f) (cut string=? <> "yes")))
|
||||||
|
|
||||||
|
(define* (test-display field value #:optional (port (current-output-port))
|
||||||
|
#:key pretty?)
|
||||||
|
"Display 'FIELD: VALUE\n' on PORT."
|
||||||
|
(if pretty?
|
||||||
|
(begin
|
||||||
|
(format port "~A:~%" field)
|
||||||
|
(pretty-print value port #:per-line-prefix "+ "))
|
||||||
|
(format port "~A: ~S~%" field value)))
|
||||||
|
|
||||||
|
(define* (result->string symbol #:key colorize?)
|
||||||
|
"Return SYMBOL as an upper case string. Use colors when COLORIZE is #t."
|
||||||
|
(let ((result (string-upcase (symbol->string symbol))))
|
||||||
|
(if colorize?
|
||||||
|
(string-append (case symbol
|
||||||
|
((pass) "[0;32m") ;green
|
||||||
|
((xfail) "[1;32m") ;light green
|
||||||
|
((skip) "[1;34m") ;blue
|
||||||
|
((fail xpass) "[0;31m") ;red
|
||||||
|
((error) "[0;35m")) ;magenta
|
||||||
|
result
|
||||||
|
"[m") ;no color
|
||||||
|
result)))
|
||||||
|
|
||||||
|
(define* (test-runner-gnu test-name #:key color? brief? out-port trs-port)
|
||||||
|
"Return an custom SRFI-64 test runner. TEST-NAME is a string specifying the
|
||||||
|
file name of the current the test. COLOR? specifies whether to use colors,
|
||||||
|
and BRIEF?, well, you know. OUT-PORT and TRS-PORT must be output ports. The
|
||||||
|
current output port is supposed to be redirected to a '.log' file."
|
||||||
|
|
||||||
|
(define (test-on-test-begin-gnu runner)
|
||||||
|
;; Procedure called at the start of an individual test case, before the
|
||||||
|
;; test expression (and expected value) are evaluated.
|
||||||
|
(let ((result (cute assq-ref (test-result-alist runner) <>)))
|
||||||
|
(format #t "test-name: ~A~%" (result 'test-name))
|
||||||
|
(format #t "location: ~A~%"
|
||||||
|
(string-append (result 'source-file) ":"
|
||||||
|
(number->string (result 'source-line))))
|
||||||
|
(test-display "source" (result 'source-form) #:pretty? #t)))
|
||||||
|
|
||||||
|
(define (test-on-test-end-gnu runner)
|
||||||
|
;; Procedure called at the end of an individual test case, when the result
|
||||||
|
;; of the test is available.
|
||||||
|
(let* ((results (test-result-alist runner))
|
||||||
|
(result? (cut assq <> results))
|
||||||
|
(result (cut assq-ref results <>)))
|
||||||
|
(unless brief?
|
||||||
|
;; Display the result of each test case on the console.
|
||||||
|
(format out-port "~A: ~A - ~A~%"
|
||||||
|
(result->string (test-result-kind runner) #:colorize? color?)
|
||||||
|
test-name (test-runner-test-name runner)))
|
||||||
|
(when (result? 'expected-value)
|
||||||
|
(test-display "expected-value" (result 'expected-value)))
|
||||||
|
(when (result? 'expected-error)
|
||||||
|
(test-display "expected-error" (result 'expected-error) #:pretty? #t))
|
||||||
|
(when (result? 'actual-value)
|
||||||
|
(test-display "actual-value" (result 'actual-value)))
|
||||||
|
(when (result? 'actual-error)
|
||||||
|
(test-display "actual-error" (result 'actual-error) #:pretty? #t))
|
||||||
|
(format #t "result: ~a~%" (result->string (result 'result-kind)))
|
||||||
|
(newline)
|
||||||
|
(format trs-port ":test-result: ~A ~A~%"
|
||||||
|
(result->string (test-result-kind runner))
|
||||||
|
(test-runner-test-name runner))))
|
||||||
|
|
||||||
|
(define (test-on-group-end-gnu runner)
|
||||||
|
;; Procedure called by a 'test-end', including at the end of a test-group.
|
||||||
|
(let ((fail (or (positive? (test-runner-fail-count runner))
|
||||||
|
(positive? (test-runner-xpass-count runner))))
|
||||||
|
(skip (or (positive? (test-runner-skip-count runner))
|
||||||
|
(positive? (test-runner-xfail-count runner)))))
|
||||||
|
;; XXX: The global results need some refinements for XPASS.
|
||||||
|
(format trs-port ":global-test-result: ~A~%"
|
||||||
|
(if fail "FAIL" (if skip "SKIP" "PASS")))
|
||||||
|
(format trs-port ":recheck: ~A~%"
|
||||||
|
(if fail "yes" "no"))
|
||||||
|
(format trs-port ":copy-in-global-log: ~A~%"
|
||||||
|
(if (or fail skip) "yes" "no"))
|
||||||
|
(when brief?
|
||||||
|
;; Display the global test group result on the console.
|
||||||
|
(format out-port "~A: ~A~%"
|
||||||
|
(result->string (if fail 'fail (if skip 'skip 'pass))
|
||||||
|
#:colorize? color?)
|
||||||
|
test-name))
|
||||||
|
#f))
|
||||||
|
|
||||||
|
(let ((runner (test-runner-null)))
|
||||||
|
(test-runner-on-test-begin! runner test-on-test-begin-gnu)
|
||||||
|
(test-runner-on-test-end! runner test-on-test-end-gnu)
|
||||||
|
(test-runner-on-group-end! runner test-on-group-end-gnu)
|
||||||
|
(test-runner-on-bad-end-name! runner test-on-bad-end-name-simple)
|
||||||
|
runner))
|
||||||
|
|
||||||
|
;;;
|
||||||
|
;;; Entry point.
|
||||||
|
;;;
|
||||||
|
|
||||||
|
(define (main . args)
|
||||||
|
(let* ((opts (getopt-long (command-line) %options))
|
||||||
|
(option (cut option-ref opts <> <>)))
|
||||||
|
(cond
|
||||||
|
((option 'help #f) (show-help))
|
||||||
|
((option 'version #f) (format #t "test-driver.scm ~A" script-version))
|
||||||
|
(else
|
||||||
|
(let ((log (open-file (option 'log-file "") "w0"))
|
||||||
|
(trs (open-file (option 'trs-file "") "wl"))
|
||||||
|
(out (duplicate-port (current-output-port) "wl")))
|
||||||
|
(redirect-port log (current-output-port))
|
||||||
|
(redirect-port log (current-warning-port))
|
||||||
|
(redirect-port log (current-error-port))
|
||||||
|
(test-with-runner
|
||||||
|
(test-runner-gnu (option 'test-name #f)
|
||||||
|
#:color? (option->boolean opts 'color-tests)
|
||||||
|
#:brief? (option->boolean opts 'brief)
|
||||||
|
#:out-port out #:trs-port trs)
|
||||||
|
(load-from-path (option 'test-name #f)))
|
||||||
|
(close-port log)
|
||||||
|
(close-port trs)
|
||||||
|
(close-port out))))
|
||||||
|
(exit 0)))
|
39
configure.ac
Normal file
39
configure.ac
Normal file
|
@ -0,0 +1,39 @@
|
||||||
|
dnl -*- Autoconf -*-
|
||||||
|
|
||||||
|
AC_INIT(guile-geohash, 0.1)
|
||||||
|
AC_SUBST(HVERSION, "\"0.1\"")
|
||||||
|
AC_SUBST(AUTHOR, "\"Ray Miller\"")
|
||||||
|
AC_SUBST(COPYRIGHT, "'(2024)")
|
||||||
|
AC_SUBST(LICENSE, gpl3+)
|
||||||
|
AC_CONFIG_SRCDIR(geohash.scm)
|
||||||
|
AC_CONFIG_AUX_DIR([build-aux])
|
||||||
|
AM_INIT_AUTOMAKE([1.12 gnu silent-rules subdir-objects color-tests parallel-tests -Woverride -Wno-portability])
|
||||||
|
AM_SILENT_RULES([yes])
|
||||||
|
|
||||||
|
AC_CONFIG_FILES([Makefile])
|
||||||
|
AC_CONFIG_FILES([pre-inst-env], [chmod +x pre-inst-env])
|
||||||
|
|
||||||
|
dnl Search for 'guile' and 'guild'. This macro defines
|
||||||
|
dnl 'GUILE_EFFECTIVE_VERSION'.
|
||||||
|
GUILE_PKG([3.0 2.2 2.0])
|
||||||
|
GUILE_PROGS
|
||||||
|
GUILE_SITE_DIR
|
||||||
|
if test "x$GUILD" = "x"; then
|
||||||
|
AC_MSG_ERROR(['guild' binary not found; please check your guile-2.x installation.])
|
||||||
|
fi
|
||||||
|
|
||||||
|
if test "$cross_compiling" != no; then
|
||||||
|
GUILE_TARGET="--target=$host_alias"
|
||||||
|
AC_SUBST([GUILE_TARGET])
|
||||||
|
fi
|
||||||
|
|
||||||
|
dnl Hall auto-generated guile-module dependencies
|
||||||
|
|
||||||
|
|
||||||
|
dnl Installation directories for .scm and .go files.
|
||||||
|
guilemoduledir="${datarootdir}/guile/site/$GUILE_EFFECTIVE_VERSION"
|
||||||
|
guileobjectdir="${libdir}/guile/$GUILE_EFFECTIVE_VERSION/site-ccache"
|
||||||
|
AC_SUBST([guilemoduledir])
|
||||||
|
AC_SUBST([guileobjectdir])
|
||||||
|
|
||||||
|
AC_OUTPUT
|
60
doc/geohash.texi
Normal file
60
doc/geohash.texi
Normal file
|
@ -0,0 +1,60 @@
|
||||||
|
\input texinfo
|
||||||
|
@c -*-texinfo-*-
|
||||||
|
|
||||||
|
@c %**start of header
|
||||||
|
@setfilename guile-geohash.info
|
||||||
|
@documentencoding UTF-8
|
||||||
|
@settitle Guile Geohash Reference Manual
|
||||||
|
@c %**end of header
|
||||||
|
|
||||||
|
@include version.texi
|
||||||
|
|
||||||
|
@copying
|
||||||
|
Copyright @copyright{} 2024 Ray Miller
|
||||||
|
|
||||||
|
Permission is granted to copy, distribute and/or modify this document
|
||||||
|
under the terms of the GNU Free Documentation License, Version 1.3 or
|
||||||
|
any later version published by the Free Software Foundation; with no
|
||||||
|
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
|
||||||
|
copy of the license is included in the section entitled ``GNU Free
|
||||||
|
Documentation License''.
|
||||||
|
@end copying
|
||||||
|
|
||||||
|
@dircategory The Algorithmic Language Scheme
|
||||||
|
@direntry
|
||||||
|
* Guile Geohash: (guile-geohash).
|
||||||
|
@end direntry
|
||||||
|
|
||||||
|
@titlepage
|
||||||
|
@title The Guile Geohash Manual
|
||||||
|
@author Ray Miller
|
||||||
|
|
||||||
|
@page
|
||||||
|
@vskip 0pt plus 1filll
|
||||||
|
Edition @value{EDITION} @*
|
||||||
|
@value{UPDATED} @*
|
||||||
|
|
||||||
|
@insertcopying
|
||||||
|
@end titlepage
|
||||||
|
|
||||||
|
@contents
|
||||||
|
|
||||||
|
@c *********************************************************************
|
||||||
|
@node Top
|
||||||
|
@top Guile Geohash
|
||||||
|
|
||||||
|
This document describes Guile Geohash version @value{VERSION}.
|
||||||
|
|
||||||
|
@menu
|
||||||
|
* Introduction:: Why Guile Geohash?
|
||||||
|
@end menu
|
||||||
|
|
||||||
|
@c *********************************************************************
|
||||||
|
@node Introduction
|
||||||
|
@chapter Introduction
|
||||||
|
|
||||||
|
INTRODUCTION HERE
|
||||||
|
|
||||||
|
This documentation is a stub.
|
||||||
|
|
||||||
|
@bye
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
(define base32 "0123456789bcdefghjkmnpqrstuvwxyz")
|
(define base32 "0123456789bcdefghjkmnpqrstuvwxyz")
|
||||||
|
|
||||||
(define* (encode lat lon #:key (precision 12))
|
(define* (encode lat lon #:key (precision 6))
|
||||||
(define desired-precision (min precision max-precision))
|
(define desired-precision (min precision max-precision))
|
||||||
(let loop ((lat-min -90.0)
|
(let loop ((lat-min -90.0)
|
||||||
(lat-max 90.0)
|
(lat-max 90.0)
|
||||||
|
|
35
geohash/hconfig.scm
Normal file
35
geohash/hconfig.scm
Normal file
|
@ -0,0 +1,35 @@
|
||||||
|
(define-module
|
||||||
|
(geohash hconfig)
|
||||||
|
#:use-module
|
||||||
|
(srfi srfi-26)
|
||||||
|
#:export
|
||||||
|
(%version
|
||||||
|
%author
|
||||||
|
%license
|
||||||
|
%copyright
|
||||||
|
%gettext-domain
|
||||||
|
G_
|
||||||
|
N_
|
||||||
|
init-nls
|
||||||
|
init-locale))
|
||||||
|
|
||||||
|
(define %version "0.1")
|
||||||
|
|
||||||
|
(define %author "Ray Miller")
|
||||||
|
|
||||||
|
(define %license 'gpl3+)
|
||||||
|
|
||||||
|
(define %copyright '(2024))
|
||||||
|
|
||||||
|
(define %gettext-domain "guile-geohash")
|
||||||
|
|
||||||
|
(define G_ identity)
|
||||||
|
|
||||||
|
(define N_ identity)
|
||||||
|
|
||||||
|
(define (init-nls) "Dummy as no NLS is used" #t)
|
||||||
|
|
||||||
|
(define (init-locale)
|
||||||
|
"Dummy as no NLS is used"
|
||||||
|
#t)
|
||||||
|
|
40
guix.scm
Normal file
40
guix.scm
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
(use-modules
|
||||||
|
(gnu packages)
|
||||||
|
(gnu packages autotools)
|
||||||
|
(gnu packages guile)
|
||||||
|
(gnu packages guile-xyz)
|
||||||
|
(gnu packages pkg-config)
|
||||||
|
(gnu packages texinfo)
|
||||||
|
(guix build-system gnu)
|
||||||
|
(guix download)
|
||||||
|
(guix gexp)
|
||||||
|
((guix licenses) #:prefix license:)
|
||||||
|
(guix packages)
|
||||||
|
(srfi srfi-1))
|
||||||
|
|
||||||
|
(package
|
||||||
|
(name "guile-geohash")
|
||||||
|
(version "0.1")
|
||||||
|
(source
|
||||||
|
(local-file
|
||||||
|
(dirname (current-filename))
|
||||||
|
#:recursive?
|
||||||
|
#t
|
||||||
|
#:select?
|
||||||
|
(lambda (file stat)
|
||||||
|
(not (any (lambda (my-string)
|
||||||
|
(string-contains file my-string))
|
||||||
|
(list ".git" ".dir-locals.el" "guix.scm"))))))
|
||||||
|
(build-system gnu-build-system)
|
||||||
|
(arguments `())
|
||||||
|
(native-inputs
|
||||||
|
(list autoconf automake pkg-config texinfo))
|
||||||
|
(inputs (list guile-3.0))
|
||||||
|
(propagated-inputs (list))
|
||||||
|
(synopsis "Geohash encoding and decoding")
|
||||||
|
(description
|
||||||
|
"A geohash is a convenient way of expressing a location (anywhere in the world) using a short alphanumeric string, with greater precision obtained with longer strings. This implementation is based on a Javascript implementation (c) Chris Veness 2014-2019 / MIT Licence.")
|
||||||
|
(home-page
|
||||||
|
"https://github.com/ray1729/guile-geohash")
|
||||||
|
(license license:gpl3+))
|
||||||
|
|
43
hall.scm
Normal file
43
hall.scm
Normal file
|
@ -0,0 +1,43 @@
|
||||||
|
(hall-description
|
||||||
|
(name "geohash")
|
||||||
|
(prefix "guile")
|
||||||
|
(version "0.1")
|
||||||
|
(author "Ray Miller")
|
||||||
|
(email "ray@1729.org.uk")
|
||||||
|
(copyright (2024))
|
||||||
|
(synopsis "Geohash encoding and decoding")
|
||||||
|
(description
|
||||||
|
"A geohash is a convenient way of expressing a location (anywhere in the world) using a short alphanumeric string, with greater precision obtained with longer strings. This implementation is based on a Javascript implementation (c) Chris Veness 2014-2019 / MIT Licence.")
|
||||||
|
(home-page
|
||||||
|
"https://github.com/ray1729/guile-geohash")
|
||||||
|
(license gpl3+)
|
||||||
|
(dependencies `())
|
||||||
|
(skip ())
|
||||||
|
(features
|
||||||
|
((guix #t)
|
||||||
|
(use-guix-specs-for-dependencies #f)
|
||||||
|
(native-language-support #f)
|
||||||
|
(licensing #f)))
|
||||||
|
(files (libraries
|
||||||
|
((scheme-file "geohash")
|
||||||
|
(directory
|
||||||
|
"geohash"
|
||||||
|
((compiled-scheme-file "hconfig")
|
||||||
|
(scheme-file "hconfig")))))
|
||||||
|
(tests ((directory "tests" ((scheme-file "geohash")))))
|
||||||
|
(programs ((directory "scripts" ())))
|
||||||
|
(documentation
|
||||||
|
((symlink "README" "README.org")
|
||||||
|
(text-file "HACKING")
|
||||||
|
(text-file "COPYING")
|
||||||
|
(directory
|
||||||
|
"doc"
|
||||||
|
((texi-file "geohash")
|
||||||
|
(text-file ".dirstamp")
|
||||||
|
(text-file "stamp-vti")
|
||||||
|
(texi-file "version")
|
||||||
|
(info-file "guile-geohash")))))
|
||||||
|
(infrastructure
|
||||||
|
((scheme-file "guix")
|
||||||
|
(text-file ".gitignore")
|
||||||
|
(scheme-file "hall")))))
|
13
pre-inst-env.in
Normal file
13
pre-inst-env.in
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
abs_top_srcdir="`cd "@abs_top_srcdir@" > /dev/null; pwd`"
|
||||||
|
abs_top_builddir="`cd "@abs_top_builddir@" > /dev/null; pwd`"
|
||||||
|
|
||||||
|
GUILE_LOAD_COMPILED_PATH="$abs_top_builddir${GUILE_LOAD_COMPILED_PATH:+:}$GUILE_LOAD_COMPILED_PATH"
|
||||||
|
GUILE_LOAD_PATH="$abs_top_builddir:$abs_top_srcdir${GUILE_LOAD_PATH:+:}:$GUILE_LOAD_PATH"
|
||||||
|
export GUILE_LOAD_COMPILED_PATH GUILE_LOAD_PATH
|
||||||
|
|
||||||
|
PATH="$abs_top_builddir/scripts:$PATH"
|
||||||
|
export PATH
|
||||||
|
|
||||||
|
exec "$@"
|
42
tests/geohash.scm
Normal file
42
tests/geohash.scm
Normal file
|
@ -0,0 +1,42 @@
|
||||||
|
(define-module (test-geohash)
|
||||||
|
#:use-module (geohash)
|
||||||
|
#:use-module (ice-9 receive)
|
||||||
|
#:use-module (srfi srfi-64))
|
||||||
|
|
||||||
|
(define (approximately? test-expr expected error)
|
||||||
|
(and (>= test-expr (- expected error))
|
||||||
|
(<= test-expr (+ expected error))))
|
||||||
|
|
||||||
|
(test-begin "geohash")
|
||||||
|
|
||||||
|
(test-equal "encode Jutland"
|
||||||
|
"u4pruy"
|
||||||
|
(encode 57.648 10.410 #:precision 6))
|
||||||
|
|
||||||
|
(test-assert "decode Jutland"
|
||||||
|
(receive (lat lon) (decode "u4pruy")
|
||||||
|
(and (approximately? lat 57.648 0.0001)
|
||||||
|
(approximately? lon 10.410 0.0001))))
|
||||||
|
|
||||||
|
(test-equal "encode Curitiba"
|
||||||
|
"6gkzwgjz"
|
||||||
|
(encode -25.38262 -49.26561 #:precision 8))
|
||||||
|
|
||||||
|
(test-assert "decode Curitiba"
|
||||||
|
(receive (lat lon) (decode "6gkzwgjz")
|
||||||
|
(and (approximately? lat -25.38262 0.000001)
|
||||||
|
(approximately? lon -49.26561 0.000001))))
|
||||||
|
|
||||||
|
(test-equal "neighbours"
|
||||||
|
'((n . "gbpb") (ne . "u000") (e . "spbp") (se . "spbn") (s . "ezzy") (sw . "ezzw") (w . "ezzx") (nw . "gbp8"))
|
||||||
|
(neighbours "ezzz"))
|
||||||
|
|
||||||
|
(test-equal "encode max precision"
|
||||||
|
"wy85bj0hbp21"
|
||||||
|
(encode 37.25 123.75 #:precision 12))
|
||||||
|
|
||||||
|
(test-equal "encode default precision"
|
||||||
|
"wy85bj"
|
||||||
|
(encode 37.25 123.75))
|
||||||
|
|
||||||
|
(test-end)
|
Loading…
Reference in a new issue