simon/dog-and-duck
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Pre-alpha release; develop branch splits off here.

Browse source
This commit is contained in:
Simon Brooke 2023-01-10 01:47:15 +00:00
parent 21a4c23c8f
commit 66da871bb8
5 changed files with 94 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored
View file

@ -17,3 +17,5 @@
pom.xml
pom.xml.asc
profiles.clj
report.html

56
README.md
View file

@ -18,7 +18,49 @@ Let us proceed.
## Status
This is a long way pre-alpha. Everything will change. Feel free to play, but do so at your own risk. Contributions welcome.
This is still pre-alpha. Everything will change. There's still a lot of code that was written when I was feeling my way around the problems, which is redundant and should now be pruned. Feel free to play, but do so at your own risk. Contributions welcome.
## Usage
At present, only the duck-typing validator works. To play with it, build the uberjar (or download it from github) and run it with
```
java -jar target/dog-and-duck-0.1.0-standalone.jar -i resources/activitystreams-test-documents/vocabulary-ex10-jsonld.json -f html -o report.html -s info
```
The full range of command-line switches is as follows:
```
-i, --input SOURCE standard input The file or URL to validate
-o, --output DEST standard output The file to write to, defaults to standard out
-f, --format FORMAT :edn The format to output, one of `edn` `csv` `html`
-l, --language LANG en-GB The ISO 639-1 code for the language to output
-s, --severity LEVEL :info The minimum severity of faults to report
-h, --help Print this message and exit
```
Note, though, that internationalisation files for languages other than British English have not yet been written, and that one is not complete.
The following severity levels are understood:
0. `info` things which are not actuallys fault, but issues noted during
validation;
1. `minor` things which I consider to be faults, but which
don't actually breach the spec;
2. `should` instances where the spec says something *SHOULD*
be done, which isn't;
3. `must` instances where the spec says something *MUST*
be done, which isn't;
4. `critical` instances where I believe the fault means that
the object cannot be meaningfully processed.
Note that it is almost certain that in some places I have misinterpreted the spec. Of all 205 documents in the [activitystreams-test-documents repository](https://github.com/w3c-social/activitystreams-test-documents), not a single one passes validation, and that must be wrong.
Nevertheless I think that this is a basis on which a useful validator can be built. Feedback and contributions welcome.
## Documentation
Full documentation is [here](https://simon-brooke.github.io/dog-and-duck/).
## Architecture
@ -86,18 +128,6 @@ Enhanced tools for moderators (I have as yet absolutely no idea what this looks
What the dog does when bored. Essentially, a place where I can learn how to make this stuff work, but perhaps eventually an ActivityPub server in its own right.
## Usage
At present, only the duck-typing functions work. To play with them, use
```clojure
(require '[dog-and-duck.quack.quack :as q])
```
## Documentation
Full documentation is [here](https://simon-brooke.github.io/dog-and-duck/).
## Building
### clj-activitypub

64
doc/intro.md
View file

@ -1,10 +1,10 @@
# Introduction
## The Old Dog and Duck
# The Old Dog and Duck
A Clojure library designed to implement the ActivityPub protocol, obviously.
![The Dog and Duck, Derby](../images/dog-and-duck-beverley.jpg)
![The Dog and Duck, St George's Fields, London, 1647](https://simon-brooke.github.io/dog-and-duck/images/Dog_and_Duck_tavern.jpg)
## Introduction
The Old Dog and Duck is clearly a pub, and it's a pub related to an activity; to whit, hunting ducks with dogs. Yes, of course one could also hunt dogs with ducks, but in practice that doesn't work so well. The point isn't whether or not I approve of hunting ducks with dogs (or vice versa); to be clear, I don't. The point is that it's a pub related to an activity, and is therefore an [ActivityPub](https://www.w3.org/TR/activitypub/).
@ -18,7 +18,49 @@ Let us proceed.
## Status
This is a long way pre-alpha. Everything will change. Feel free to play, but do so at your own risk. Contributions welcome.
This is still pre-alpha. Everything will change. There's still a lot of code that was written when I was feeling my way around the problems, which is redundant and should now be pruned. Feel free to play, but do so at your own risk. Contributions welcome.
## Usage
At present, only the duck-typing validator works. To play with it, build the uberjar (or download it from github) and run it with
```
java -jar target/dog-and-duck-0.1.0-standalone.jar -i resources/activitystreams-test-documents/vocabulary-ex10-jsonld.json -f html -o report.html -s info
```
The full range of command-line switches is as follows:
```
-i, --input SOURCE standard input The file or URL to validate
-o, --output DEST standard output The file to write to, defaults to standard out
-f, --format FORMAT :edn The format to output, one of `edn` `csv` `html`
-l, --language LANG en-GB The ISO 639-1 code for the language to output
-s, --severity LEVEL :info The minimum severity of faults to report
-h, --help Print this message and exit
```
Note, though, that internationalisation files for languages other than British English have not yet been written, and that one is not complete.
The following severity levels are understood:
0. `info` things which are not actuallys fault, but issues noted during
validation;
1. `minor` things which I consider to be faults, but which
don't actually breach the spec;
2. `should` instances where the spec says something *SHOULD*
be done, which isn't;
3. `must` instances where the spec says something *MUST*
be done, which isn't;
4. `critical` instances where I believe the fault means that
the object cannot be meaningfully processed.
Note that it is almost certain that in some places I have misinterpreted the spec. Of all 205 documents in the [activitystreams-test-documents repository](https://github.com/w3c-social/activitystreams-test-documents), not a single one passes validation, and that must be wrong.
Nevertheless I think that this is a basis on which a useful validator can be built. Feedback and contributions welcome.
## Documentation
Full documentation is [here](https://simon-brooke.github.io/dog-and-duck/).
## Architecture
@ -86,18 +128,6 @@ Enhanced tools for moderators (I have as yet absolutely no idea what this looks
What the dog does when bored. Essentially, a place where I can learn how to make this stuff work, but perhaps eventually an ActivityPub server in its own right.
## Usage
At present, only the duck-typing functions work. To play with them, use
```clojure
(require '[dog-and-duck.quack.quack :as q])
```
## Documentation
Full documentation is [here](https://simon-brooke.github.io/dog-and-duck/).
## Building
### clj-activitypub

2
project.clj
View file

@ -1,4 +1,4 @@
(defproject dog-and-duck "0.1.0-SNAPSHOT"
(defproject dog-and-duck "0.1.0"
:cloverage {:output "docs/cloverage"
:codecov? true
:emma-xml? true}

2
src/dog_and_duck/quack/cli.clj
View file

@ -27,7 +27,7 @@
:default :edn
:parse-fn #(keyword %)
:validate [#(#{:csv :edn :html} %) "Expect one of `edn` `csv` `html`"]]
["-l" "--language LANG" "The ISO 639-1 language code for the language to output"
["-l" "--language LANG" "The ISO 639-1 code for the language to output"
:default (-> (locale/get-default) locale/to-language-tag)]
["-s" "--severity LEVEL" "The minimum severity of faults to report"
:default :info