Merge pull request #6 from tmattio/master

Upstream v3.ocaml.org fork

Author: kayceesrk

.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build-and-test:
+    strategy:
+      fail-fast: false
+
+      matrix:
+        os:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+
+        ocaml-compiler:
+          - 4.12.x
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Use OCaml ${{ matrix.ocaml-compiler }}
+        uses: ocaml/setup-ocaml@v2
+        with:
+          ocaml-compiler: ${{ matrix.ocaml-compiler }}
+          dune-cache: ${{ matrix.os != 'macos-latest' }}
+
+      - name: Install ocamlformat
+        run: opam install ocamlformat.0.18.0
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+
+      - name: Install opam packages
+        run: opam install . --with-test
+
+      - name: Check formatting
+        run: make fmt
+        if: ${{ matrix.os == 'ubuntu-latest' && always() }}
+
+      - name: Run build
+        run: make build
+
+      - name: Run the unit tests
+        run: make test
+        timeout-minutes: 1

.gitignore

@@ -1,7 +1,9 @@
-*.native
-_build
-*~
-*.swp
-setup.data
-setup.log
-index.html
+# Dune generated files
+_build/
+*.install
+
+# Merlin configuring file for Vim and Emacs
+.merlin
+
+# Local OPAM switch
+_opam/

.merlin

@@ -0,0 +1,4 @@
+version = 0.20.1
+profile = conventional
+parse-docstrings = true
+wrap-comments = true

.ocamlformat

@@ -11,4 +11,3 @@ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-

LICENSE

@@ -1,41 +1,43 @@
-# OASIS_START
-# DO NOT EDIT (digest: a3c674b4239234cbbe53afe090018954)
-
-SETUP = ocaml setup.ml
-
-build: setup.data
-	$(SETUP) -build $(BUILDFLAGS)
-
-doc: setup.data build
-	$(SETUP) -doc $(DOCFLAGS)
-
-test: setup.data build
-	$(SETUP) -test $(TESTFLAGS)
+.DEFAULT_GOAL := all
 
+.PHONY: all
 all:
-	$(SETUP) -all $(ALLFLAGS)
+	opam exec -- dune build --root . @install
 
-install: setup.data
-	$(SETUP) -install $(INSTALLFLAGS)
+.PHONY: deps
+deps: ## Install development dependencies
+	opam install -y dune-release ocamlformat utop ocaml-lsp-server
+	opam install --deps-only --with-test --with-doc -y .
 
-uninstall: setup.data
-	$(SETUP) -uninstall $(UNINSTALLFLAGS)
+.PHONY: create_switch
+create_switch: ## Create an opam switch without any dependency
+	opam switch create . --no-install -y
 
-reinstall: setup.data
-	$(SETUP) -reinstall $(REINSTALLFLAGS)
+.PHONY: switch
+switch: ## Create an opam switch and install development dependencies
+	opam install . --deps-only --with-doc --with-test
+	opam install -y dune-release ocamlformat utop ocaml-lsp-server
 
-clean:
-	$(SETUP) -clean $(CLEANFLAGS)
+.PHONY: build
+build: ## Build the project, including non installable libraries and executables
+	opam exec -- dune build --root .
 
-distclean:
-	$(SETUP) -distclean $(DISTCLEANFLAGS)
+.PHONY: test
+test: ## Run the unit tests
+	opam exec -- dune runtest --root .
 
-setup.data:
-	$(SETUP) -configure $(CONFIGUREFLAGS)
+.PHONY: clean
+clean: ## Clean build artifacts and other generated files
+	opam exec -- dune clean --root .
 
-configure:
-	$(SETUP) -configure $(CONFIGUREFLAGS)
+.PHONY: doc
+doc: ## Generate odoc documentation
+	opam exec -- dune build --root . @doc
 
-.PHONY: build doc test all install uninstall reinstall clean distclean configure
+.PHONY: fmt
+fmt: ## Format the codebase with ocamlformat
+	opam exec -- dune build --root . --auto-promote @fmt
 
-# OASIS_STOP
+.PHONY: watch
+watch: ## Watch for the filesystem and rebuild on every change
+	opam exec -- dune build --root . --watch

Makefile

@@ -1,11 +1,58 @@
 # River
 
-A library for aggregating RSS2 and Atom feeds in OCaml.
+[![Actions Status](https://github.com/tmattio/river/workflows/CI/badge.svg)](https://github.com/tmattio/river/actions)
 
-Features:
+RSS2 and Atom feed aggregator for OCaml
 
-* Performs deduplication.
-* Supports pagination and generating well-formed html prefix snippets.
-* Support for generating aggregate feeds.
-* Sorts the posts from most recent to oldest.
-* Depends on ocamlnet for html parsing.
+
+## Features
+
+- Performs deduplication.
+- Supports pagination and generating well-formed html prefix snippets.
+- Support for generating aggregate feeds.
+- Sorts the posts from most recent to oldest.
+- Depends on ocamlnet for html parsing.
+
+## Installation
+
+```bash
+opam install river
+```
+
+## Usage
+
+Here's an example program that aggregates the feeds from different sources:
+
+```ocaml
+let sources =
+  River.
+    [
+      { name = "KC Sivaramakrishnan"; url = "http://kcsrk.info/atom-ocaml.xml" };
+      {
+        name = "Amir Chaudhry";
+        url = "http://amirchaudhry.com/tags/ocamllabs-atom.xml";
+      };
+    ]
+
+let () =
+  let feeds = List.map River.fetch sources in
+  let posts = River.posts feeds in
+  let entries = River.create_atom_entries posts in
+  let feed =
+    let authors = [ Syndic.Atom.author "OCaml Blog" ] in
+    let id = Uri.of_string "https://ocaml.org/atom.xml" in
+    let links = [ Syndic.Atom.link ~rel:Self id ] in
+    let title : Syndic.Atom.text_construct =
+      Text "OCaml Blog: Read the latest OCaml news from the community."
+    in
+    let updated = Ptime.of_float_s (Unix.gettimeofday ()) |> Option.get in
+    Syndic.Atom.feed ~authors ~links ~id ~title ~updated entries
+  in
+  let out_channel = open_out "example/atom.xml" in
+  Syndic.Atom.output feed (`Channel out_channel);
+  close_out out_channel
+```
+
+## Contributing
+
+Take a look at our [Contributing Guide](CONTRIBUTING.md).