package sihl

  1. Overview
  2. Docs
The Sihl web framework

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (35)

Authors

  1. J
    Josef Erben
  2. A
    Aron Erben
  3. M
    Miko Nieminen

Maintainers

  1. J
    josef@oxidizing.io

Sources

3.0.4.tar.gz
md5=8a2754d6e5b9eafb8ff332abdb1ceb7d
sha512=3230a1315686b0b6f90a41ceda27ab036e178184ab13d5a98f64d6d987caf4a8a5d94ed78bc8e79b0ee3b40ccbb1dbdc71ffe171f1aef1f18aba81fc720e3a1b

doc/src/sihl/gen.ml.html

Source file gen.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
let service =
  Core_command.make
    ~name:"gen.model"
    ~help:
      "<database> <service name> <name>:<type> <name>:<type> <name>:<type> ... \n\
       Supported types are: int | float | bool | string | datetime \n\
       Supported databases are: mariadb | postgresql"
    ~description:
      "Generates a model consisting of a service, an entityt, a repository, \
       tests and migrations."
    (function
      | database :: model_name :: schema ->
        (match Gen_core.schema_of_string schema with
        | Ok schema ->
          Gen_model.generate database model_name schema;
          Lwt.return @@ Some ()
        | Error msg ->
          print_endline msg;
          raise @@ Core_command.Exception "")
      | _ -> Lwt.return None)
;;

let view =
  Core_command.make
    ~name:"gen.view"
    ~help:
      "<model name> <name>:<type> <name>:<type> <name>:<type> ... \n\
       Supported types are: int, float, bool, string, datetime"
    ~description:
      "Generates an HTML view that contains a form to create and update a \
       resource."
    (function
      | name :: schema ->
        (match Gen_core.schema_of_string schema with
        | Ok schema ->
          Gen_view.generate name schema;
          Lwt.return @@ Some ()
        | Error msg ->
          print_endline msg;
          raise @@ Core_command.Exception "")
      | [] -> Lwt.return None)
;;

let html_help model_name module_name =
  Format.sprintf
    {|
Resource '%ss' created. To finalize the generation:

1.) Copy this route

    let %s =
      Sihl.Web.choose
        ~middlewares:
          [ Sihl.Web.Middleware.csrf ()
          ; Sihl.Web.Middleware.flash ()
          ]
        Sihl.Web.Rest.(
          resource_of_service
            "%ss"
            %s.schema
            ~view:(module View_%s : VIEW with type t = %s.t)
            (module %s : SERVICE with type t = %s.t))
    ;;

into your `routes/routes.ml` and mount it with the HTTP service. Don't forget to add '%s' and 'view_%s' to `routes/dune`.

2.) Add the migration

    Database.%s.migration

to the list of migrations in `run/run.ml` before running `sihl migrate`.

3.) You should also run `make format` to apply your styling rules.

4.) Visit http://localhost:3000/%ss
|}
    model_name
    model_name
    model_name
    module_name
    model_name
    module_name
    module_name
    module_name
    model_name
    model_name
    module_name
    model_name
;;

let html =
  Core_command.make
    ~name:"gen.html"
    ~help:
      "<database> <service name> <name>:<type> <name>:<type> <name>:<type> ... \n\
       Supported types are: int, float, bool, string, datetime \n\
       Supported databases are: mariadb | postgresql"
    ~description:
      "Generates a controller, HTML views, a service, tests and migrations for \
       an HTML resource. This generator is a combination of gen.service and \
       gen.view."
    (function
      | database :: model_name :: schema ->
        (match Gen_core.schema_of_string schema with
        | Ok schema ->
          let module_name = String.capitalize_ascii model_name in
          Gen_model.generate database model_name schema;
          Gen_view.generate model_name schema;
          print_endline @@ html_help model_name module_name;
          Lwt.return @@ Some ()
        | Error msg ->
          print_endline msg;
          raise @@ Core_command.Exception "")
      | _ -> Lwt.return None)
;;

let commands = [ service; view; html ]