commit 2549892fc826deaba473bcebf0c054e84b65898b · dunkirk.sh/gleam-bible-search

+94 -12
README.md
···

       1
       1
       -
       # bible_search_gleam

     

       1
       1
       +
       # Lab 6 - Gleamified

     

       2
       2
        
       

     

       3
       3
       -
       [![Package Version](https://img.shields.io/hexpm/v/bible_search_gleam)](https://hex.pm/packages/bible_search_gleam)

     

       4
       4
       -
       [![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/bible_search_gleam/)

     

       3
       3
       +
       [![Package Version](https://img.shields.io/hexpm/v/bible_search)](https://hex.pm/packages/bible_search)

     

       4
       4
       +
       [![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/bible_search/)

     

       5
       5
        
       

     

       6
       6
       -
       ```sh

     

       7
       7
       -
       gleam add bible_search_gleam@1

     

       8
       8
       -
       ```

     

       9
       6
        
       ```gleam

     

       10
       10
       -
       import bible_search_gleam

     

       7
       7
       +
       pub fn bible_scan(

     

       8
       8
       +
         reference reference: Reference,

     

       9
       9
       +
         bible bible: String,

     

       10
       10
       +
       ) -> ScanResult {

     

       11
       11
       +
         let inital_state =

     

       12
       12
       +
           ScanState(

     

       13
       13
       +
             phase: Book,

     

       14
       14
       +
             ref: reference,

     

       15
       15
       +
             found_book: False,

     

       16
       16
       +
             found_chapter: False,

     

       17
       17
       +
             verse_text: Error("Verse not found"),

     

       18
       18
       +
           )

     

       19
       19
       +
       

     

       20
       20
       +
         let bible_lines = string.split(bible, "\n")

     

       11
       21
        
       

     

       12
       12
       -
       pub fn main() -> Nil {

     

       13
       13
       -
         // TODO: An example of the project in use

     

       22
       22
       +
         let result =

     

       23
       23
       +
           list.fold(bible_lines, inital_state, fn(state, line) -> ScanState {

     

       24
       24
       +
             case state.phase {

     

       25
       25
       +
               Done -> state

     

       26
       26
       +
               Book ->

     

       27
       27
       +
                 case line {

     

       28
       28
       +
                   "THE BOOK OF " <> book ->

     

       29
       29
       +
                     case book == state.ref.book {

     

       30
       30
       +
                       True -> ScanState(..state, phase: Chapter, found_book: True)

     

       31
       31
       +
                       False -> state

     

       32
       32
       +
                     }

     

       33
       33
       +
                   _ -> state

     

       34
       34
       +
                 }

     

       35
       35
       +
               Chapter ->

     

       36
       36
       +
                 case line {

     

       37
       37
       +
                   "CHAPTER " <> chapter ->

     

       38
       38
       +
                     case result.unwrap(int.parse(chapter), 0) == state.ref.chapter {

     

       39
       39
       +
                       True -> ScanState(..state, phase: Verse, found_chapter: True)

     

       40
       40
       +
                       False -> state

     

       41
       41
       +
                     }

     

       42
       42
       +
                   _ -> state

     

       43
       43
       +
                 }

     

       44
       44
       +
               Verse ->

     

       45
       45
       +
                 fn() {

     

       46
       46
       +
                   let parts = string.split(line, " ")

     

       47
       47
       +
                   case parts {

     

       48
       48
       +
                     [first, ..rest] ->

     

       49
       49
       +
                       case result.unwrap(int.parse(first), 0) == state.ref.verse {

     

       50
       50
       +
                         True ->

     

       51
       51
       +
                           ScanState(

     

       52
       52
       +
                             ..state,

     

       53
       53
       +
                             phase: Done,

     

       54
       54
       +
                             verse_text: Ok(string.join(rest, " ")),

     

       55
       55
       +
                           )

     

       56
       56
       +
                         False -> state

     

       57
       57
       +
                       }

     

       58
       58
       +
                     _ -> state

     

       59
       59
       +
                   }

     

       60
       60
       +
                 }()

     

       61
       61
       +
             }

     

       62
       62
       +
           })

     

       63
       63
       +
       

     

       64
       64
       +
         ScanResult(ref: reference, verse: result.verse_text)

     

       14
       65
        
       }

     

       15
       66
        
       ```

     

       16
       67
        
       

     

       17
       17
       -
       Further documentation can be found at <https://hexdocs.pm/bible_search_gleam>.

     

       68
       68
       +
       For this lab the program must parse `OT.txt` (format below) to find specific references and produce scoped errors if the reference isn't found.

     

       69
       69
       +
       

     

       70
       70
       +
       ```text

     

       71
       71
       +
       THE BOOK OF GENESIS

     

       72
       72
       +
       

     

       73
       73
       +
       CHAPTER 1

     

       74
       74
       +
       1 In the beginning God created the heaven and the earth.

     

       75
       75
       +
       2 And the earth was without form, and void; and darkness [was] upon the face of the deep. And the Spirit of God moved upon the face of the waters.

     

       76
       76
       +
       3 And God said, Let there be light: and there was light.

     

       77
       77
       +
       4 And God saw the light, that [it was] good: and God divided the light from the darkness.

     

       78
       78
       +
       

     

       79
       79
       +
       THE BOOK OF PSALMS

     

       80
       80
       +
       

     

       81
       81
       +
       PSALM 1

     

       82
       82
       +
       1 Blessed [is] the man that walketh not in the counsel of the ungodly, nor standeth in the way of sinners, nor sitteth in the seat of the scornful.

     

       83
       83
       +
       2 But his delight [is] in the law of the LORD; and in his law doth he meditate day and night.

     

       84
       84
       +
       3 And he shall be like a tree planted by the rivers of water, that bringeth forth his fruit in his season; his leaf also shall not wither; and whatsoever he doeth shall prosper.

     

       85
       85
       +
       ```

     

       18
       86
        
       

     

       19
       87
        
       ## Development

     

       88
       88
       +
       

     

       89
       89
       +
       You need to have the [gleam runtime](https://gleam.run/getting-started/installing/) installed as well as erlang for the beam runtime.

     

       20
       90
        
       

     

       21
       91
        
       ```sh

     

       22
       22
       -
       gleam run   # Run the project

     

       23
       23
       -
       gleam test  # Run the tests

     

       92
       92
       +
       gleam run

     

       93
       93
       +
       gleam test # runs all the test functions in /tests postfixed with _test

     

       24
       94
        
       ```

     

       95
       95
       +
       

     

       96
       96
       +
       <p align="center">

     

       97
       97
       +
           <img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/main/.github/images/line-break.svg" />

     

       98
       98
       +
       </p>

     

       99
       99
       +
       

     

       100
       100
       +
       <p align="center">

     

       101
       101
       +
           <i><code>&copy 2025-present <a href="https://github.com/taciturnaxololt">Kieran Klukas</a></code></i>

     

       102
       102
       +
       </p>

     

       103
       103
       +
       

     

       104
       104
       +
       <p align="center">

     

       105
       105
       +
           <a href="https://github.com/cu-cs1210/lab-6-kieranklukas/blob/main/LICENSE.md"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>

     

       106
       106
       +
       </p>