Scribe - An Alternative Medium Frontend
 
 
 
 
 
 
Go to file
Edward Loveall 5a5f68bcf8
First step rendering a page
The API responds with a bunch of paragraphs which the client converts
into Paragraph objects.

This turns the paragraphs in a PostResponse's Paragraph objects into the
form needed to render them on a page. This includes converting flat list
elements into list elements nested by a UL. And adding a limited markups
along the way.

The array of paragraphs is passed to a recursive function. The function
takes the first paragraph and either wraps the (marked up) contents in a
container tag (like Paragraph or Heading3), and then moves onto the next
tag. If it finds a list, it starts parsing the next paragraphs as a list
instead.

Originally, this was implemented like so:

```crystal
paragraph = paragraphs.shift
if list?
  convert_list([paragraph] + paragraphs)
end
```

However, passing the `paragraphs` after adding it to the already shifted
`paragraph` creates a new object. This means `paragraphs` won't be
mutated and once the list is parsed, it starts with the next element of
the list. Instead, the element is `shift`ed inside each converter.

```crystal
if paragraphs.first == list?
  convert_list(paragraphs)
end

def convert_list(paragraphs)
  paragraph = paragraphs.shift
  # ...
end
```

When rendering, there is an Empty and Container object. These represent
a kind of "null object" for both leafs and parent objects respectively.
They should never actually render. Emptys are filtered out, and
Containers are never created explicitly but this will make the types
pass.

IFrames are a bit of a special case. Each IFrame has custom data on it
that this system would need to be aware of. For now, instead of trying
to parse the seemingly large number of iframe variations and dealing
with embedded iframe problems, this will just keep track of the source
page URL and send the user there with a link.
2021-07-04 16:28:03 -04:00
.github/workflows Initial app 2021-05-01 17:03:38 -04:00
config Add basic response (except images) 2021-05-01 17:39:05 -04:00
db/migrations Initial app 2021-05-01 17:03:38 -04:00
public Initial app 2021-05-01 17:03:38 -04:00
script Add test script 2021-07-04 16:03:25 -04:00
spec First step rendering a page 2021-07-04 16:28:03 -04:00
src First step rendering a page 2021-07-04 16:28:03 -04:00
tasks Initial app 2021-05-01 17:03:38 -04:00
.crystal-version Initial app 2021-05-01 17:03:38 -04:00
.editorconfig Initial app 2021-05-01 17:03:38 -04:00
.gitignore Initial app 2021-05-01 17:03:38 -04:00
.tool-versions Initial app 2021-05-01 17:03:38 -04:00
Procfile Initial app 2021-05-01 17:03:38 -04:00
Procfile.dev Initial app 2021-05-01 17:03:38 -04:00
README.md Initial app 2021-05-01 17:03:38 -04:00
bs-config.js Initial app 2021-05-01 17:03:38 -04:00
package.json Initial app 2021-05-01 17:03:38 -04:00
shard.lock Initial app 2021-05-01 17:03:38 -04:00
shard.yml First step rendering a page 2021-07-04 16:28:03 -04:00
tasks.cr Initial app 2021-05-01 17:03:38 -04:00
webpack.mix.js Initial app 2021-05-01 17:03:38 -04:00
yarn.lock Initial app 2021-05-01 17:03:38 -04:00

README.md

scribe

This is a project written using Lucky. Enjoy!

Setting up the project

  1. Install required dependencies
  2. Update database settings in config/database.cr
  3. Run script/setup
  4. Run lucky dev to start the app

Learning Lucky

Lucky uses the Crystal programming language. You can learn about Lucky from the Lucky Guides.