Skip to content

Some code cleanup #221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rjbou wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Some code cleanup #221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
429547f
port to opamlib 2.1
rjbou Nov 17, 2022
6b36e97
use correct opam wording
rjbou Nov 17, 2022
d3c47e2
remove commented code
rjbou Nov 17, 2022
54c9140
remove unused modules
rjbou Nov 17, 2022
3f40967
remove download computation statistics (dead) code
rjbou Nov 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
opam2web
========

A tool to generate a website from an OPAM universe
A tool to generate a website from an opam universe

This utility creates a static website from an OPAM universe, listing all
available packages and their details. A homepage and OPAM documentation is
This utility creates a static website from an opam universe, listing all
available packages and their details. A homepage and opam documentation is
included as well.

The latest release of opam2web is available via
Expand Down Expand Up @@ -112,7 +112,7 @@ opam2web --help
opam2web -o website path:~/myrepo local:default
```
will generate the HTML files corresponding to the repository located in
`~/myrepo` and the remote named `default` in the local OPAM installation.
`~/myrepo` and the remote named `default` in the local opam installation.
Resulting files will be located in the `website` directory.


Expand Down
68 changes: 17 additions & 51 deletions bin/opam2web.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
(* GNU Lesser General Public License version 3.0 with linking *)
(* exception. *)
(* *)
(* OPAM is distributed in the hope that it will be useful, but WITHOUT *)
(* Opam 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. *)
Expand All @@ -17,7 +17,6 @@
open Cmdliner
open Cow
open O2wTypes
open OpamTypes

let ( ++ ) = Html.( ++ )

Expand All @@ -26,7 +25,6 @@ type options = {
out_dir: string;
files_dir: string;
content_dir: string;
logfiles: filename list;
repositories: string list;
root_uri: Uri.t;
blog_source_uri: string;
Expand All @@ -48,20 +46,14 @@ let include_files (path: string) _files_path : unit =
List.iter (fun dir -> OpamFilename.mkdir (OpamFilename.Dir.of_string dir)) pathes

let make_datasets user_options =
let statistics =
O2wStatistics.statistics_set user_options.logfiles
(List.map OpamFilename.Dir.of_string user_options.repositories)
in
let universe =
O2wUniverse.load statistics
O2wUniverse.load
(List.map OpamFilename.Dir.of_string user_options.repositories)
in
universe, statistics
universe

(* Generate a whole static website using the given repository stack *)
let make_website user_options universe statistics ds =
Printf.printf "++ Building the new stats from %s.\n%!"
(OpamStd.List.to_string OpamFilename.prettify user_options.logfiles);
let make_website user_options universe ds =
let content_dir = user_options.content_dir in
Printf.printf "++ Building the package pages.\n%!";
let pages = O2wUniverse.to_pages ~prefix:packages_prefix universe in
Expand All @@ -77,19 +69,15 @@ let make_website user_options universe statistics ds =
files
in
let blog_entries = O2wBlog.get_entries ~content_dir ~pages:blog_pages in
let news = (O2wBlog.make_news blog_entries) in
let news = O2wBlog.make_news blog_entries in
let blog_latest, blog_links =
O2wBlog.make_menu ~srcurl:user_options.blog_source_uri blog_entries
in
let blog_feed = O2wBlog.make_feed ~root:user_options.root_uri blog_entries in
let criteria = ["name"; "popularity"; "date"] in
let criteria_nostats = ["name"; "date"] in
let sortby_links =
match statistics with
| None ->
O2wUniverse.sortby_links ~links:criteria_nostats ~default:"name"
| Some _ ->
O2wUniverse.sortby_links ~links:criteria ~default:"name" in
O2wUniverse.sortby_links ~links:criteria_nostats ~default:"name"
in
let to_html =
O2wUniverse.to_html ~content_dir ~sortby_links universe
in
Expand All @@ -98,29 +86,14 @@ let make_website user_options universe statistics ds =
let compare_pkg =
O2wPackage.compare_date ~reverse:true universe.dates
in
let date = {
[{
menu_source = content_dir;
menu_link = Uri.make ~path:(packages_prefix^"/index-date.html") ();
menu_link_text = "Packages";
menu_link_html = Html.string "Packages";
menu_item = No_menu (1, to_html ~active:"date" ~compare_pkg);
menu_srcurl = None;
} in
match universe.name_popularity with
| None -> [ date ]
| Some s ->
let compare_pkg =
O2wPackage.compare_popularity ~reverse:true s
in
let popularity = {
menu_source = content_dir;
menu_link = Uri.make ~path:(packages_prefix ^ "/index-popularity.html") ();
menu_link_text = "Packages";
menu_link_html = Html.string "Packages";
menu_item = No_menu (1, to_html ~active:"popularity" ~compare_pkg);
menu_srcurl = None;
} in
[ popularity; date ]
}]
in
include_files user_options.out_dir user_options.files_dir;
let about_page =
Expand All @@ -134,7 +107,7 @@ let make_website user_options universe statistics ds =
OpamConsole.warning "%s is not available." filename;
Html.empty in
let doc_menu = menu_of_doc () in
let home_index = O2wHome.to_html ~content_dir ~news ?statistics ds in
let home_index = O2wHome.to_html ~content_dir ~news ds in
let package_index =
to_html ~active:"name" ~compare_pkg:O2wPackage.compare_alphanum in
let opam_title =
Expand Down Expand Up @@ -191,11 +164,6 @@ let normalize d =
else
d

let log_files = Arg.(
value & opt_all string [] & info ["s"; "statistics"]
~docv:"LOG_FILE"
~doc:"An Apache server log file containing download statistics of packages")

let out_dir = Arg.(
value & opt string (Sys.getcwd ()) & info ["o"; "output"]
~docv:"OUT_DIR"
Expand All @@ -216,25 +184,22 @@ let blog_source_uri = Arg.(
~docv:"URI"
~doc:"The base address to point to blog source files")

let build logfiles out_dir content_dir repositories root_uri blog_source_uri =
let build out_dir content_dir repositories root_uri blog_source_uri =
let () =
List.iter (Printf.printf "=== Repository: %s ===\n%!") repositories in
let out_dir = normalize out_dir in
let logfiles = List.map OpamFilename.of_string logfiles in
let root_uri = Uri.of_string root_uri in
let user_options = {
out_dir;
files_dir = "";
content_dir;
logfiles;
repositories;
root_uri;
blog_source_uri;
} in
let universe, statistics = make_datasets user_options in
let universe = make_datasets user_options in
let home_ds = O2wHome.make_datasets universe in
make_website user_options universe statistics home_ds;
O2wUniverse.generate_json ?statistics universe;
make_website user_options universe home_ds;
O2wHome.generate_json home_ds

let default_cmd =
Expand All @@ -251,14 +216,15 @@ let default_cmd =
~doc:"Directories containing the repositories to consider")
in
let info = Cmd.info "opam2web" ~version ~doc ~man in
let term = Term.(const build $ log_files $ out_dir $ content_dir
let term = Term.(const build $ out_dir $ content_dir
$ repositories_arg $ root_uri $ blog_source_uri) in
Cmd.v info term


let () =
OpamArg.preinit_opam_env_variables ();
OpamArg.init_opam_env_variabes OpamCLIVersion.Sourced.current;
OpamFormatConfig.init ();
OpamStd.Config.init ();
OpamCoreConfig.init ();
OpamRepositoryConfig.init ();
OpamSolverConfig.init ();
OpamStateConfig.init ();
Expand Down
1 change: 0 additions & 1 deletion content/home.xhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,5 @@ opam upgrade # Upgrade the installed packages to their latest version
<div class="row">
<t:insert name="stats" />
<t:insert name="updates_last10" />
<t:insert name="packages_top10" />
</div>
</t:seq>
14 changes: 6 additions & 8 deletions opam2web.opam
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,12 @@ depends: [
"cow" {>= "2.3.0"}
"js_of_ocaml" {>= "3.3.0"}
"js_of_ocaml-ppx"
"opam-core" {>= "2.0.0" & < "2.1.0~"}
"opam-format" {>= "2.0.0" & < "2.1.0~"}
"opam-state" {>= "2.0.0" & < "2.1.0~"}
"opam-client" {>= "2.0.0" & < "2.1.0~"}
"opam-file-format" {>="2.1.0" & < "2.1.1"}
"opam-core" {>= "2.1.0"}
"opam-format" {>= "2.1.0"}
"opam-state" {>= "2.1.0"}
"opam-client" {>= "2.1.0"}
"cohttp-lwt-unix"
"yojson" {>= "1.6.0"}
"opam-file-format" {< "2.1.1"}
"cmdliner" {>= "1.0.4"}
"omd" {>= "1.3.1" & < "2.0.0~"}
]
Expand All @@ -32,7 +30,7 @@ build: [
dev-repo: "git+https://github.com/ocaml/opam2web.git"
synopsis: "Tool to generate the opam.ocaml.org website"
description: """
This utility creates a static website from an OPAM universe, listing all
available packages and their details. A homepage and OPAM documentation is
This utility creates a static website from an opam universe, listing all
available packages and their details. A homepage and opam documentation is
included as well.
"""
2 changes: 1 addition & 1 deletion src/js_search/search.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
(* GNU Lesser General Public License version 3.0 with linking *)
(* exception. *)
(* *)
(* OPAM is distributed in the hope that it will be useful, but WITHOUT *)
(* Opam 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. *)
Expand Down
21 changes: 1 addition & 20 deletions src/o2wBlog.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
(* GNU Lesser General Public License version 3.0 with linking *)
(* exception. *)
(* *)
(* OPAM is distributed in the hope that it will be useful, but WITHOUT *)
(* Opam 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. *)
Expand Down Expand Up @@ -276,25 +276,6 @@ let make_redirect ~root entries =
@ Html.meta ["http-equiv", "refresh"; "content", redirect])
@ Html.body Html.empty)

(*
let resolve_urls_in_attr base rewrites attrs =
List.map (fun ((attr,v) as a) ->
if List.mem attr rewrites
then (attr,Uri.(to_string (resolve "http" base (of_string v))))
else a
) attrs

let resolve_urls_in_tag base = function
| (("","img"),attrs) ->
(("","img"),resolve_urls_in_attr base ["","src"] attrs)
| tag -> tag

let rec resolve_urls base = function
| `Data d -> `Data d
| `El (tag, body) ->
`El (resolve_urls_in_tag base tag, List.map (resolve_urls base) body)
*)

let make_feed ~root entries =
let open Cow.Atom in
let to_atom_date date =
Expand Down
2 changes: 1 addition & 1 deletion src/o2wBlog.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
(* GNU Lesser General Public License version 3.0 with linking *)
(* exception. *)
(* *)
(* OPAM is distributed in the hope that it will be useful, but WITHOUT *)
(* Opam 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. *)
Expand Down
2 changes: 1 addition & 1 deletion src/o2wDocumentation.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
(* GNU Lesser General Public License version 3.0 with linking *)
(* exception. *)
(* *)
(* OPAM is distributed in the hope that it will be useful, but WITHOUT *)
(* Opam 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. *)
Expand Down
2 changes: 1 addition & 1 deletion src/o2wDocumentation.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
(* GNU Lesser General Public License version 3.0 with linking *)
(* exception. *)
(* *)
(* OPAM is distributed in the hope that it will be useful, but WITHOUT *)
(* Opam 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. *)
Expand Down
30 changes: 0 additions & 30 deletions src/o2wGlobals.ml
View file
Open in desktop

This file was deleted.

24 changes: 0 additions & 24 deletions src/o2wGlobals.mli
View file
Open in desktop

This file was deleted.

Loading