svarlet

svarlet

A sort of inheritance for struct?

Hi,

I would like to get recommendations on how to approach this problem.

I’m writing a client for an API (tumblr). For example, this API let me retrieve all the posts for a given tumblr blog.

Yet, those posts can be of different types such as text, photo, video, audio, … Any post will have one of these type but they all share some common properties like a date, the number of likes, etc. Given their nature, they also have specific properties. Let’s say that audio and video posts have a duration property but text posts don’t.

The way you know that a post is of type X is by checking the type that is one of the common properties.

Until today, I focused on the properties in common between all types and I created a Post struct to represent them. Now I would like to have a way to represent all specific types and ideally without copy-pasting the current Post struct everywhere.

What are my options to represent all types too ?

Tumblr API / Posts

EDIT: If I define all properties of all post types into the one I currently have, this is what I get:

@type t :: %MODULE{
blog_name: String.t,
id: non_neg_integer,
post_url: String.t,
type: String.t,
timestamp: non_neg_integer,
date: String.t,
format: String.t,
reblog_key: String.t,
tags: [String.t],
bookmarklet: boolean,
mobile: boolean,
source_url: String.t, #MOVE TO QUOTE POSTS? see “Notes” column in docs
source_title: String.t, #MOVE TO QUOTE POSTS?
liked: boolean,
state: String.t,
#FOR TEXT POSTS
title: String.t,
body: String.t,
#FOR PHOTO POSTS
photos: , #todo: list of photos objects
caption: String.t,
width: number(),
height: number(),
#FOR QUOTE POSTS
text: String.t,
source: String.t,
#FOR LINK POSTS
title: String.t, #fixme: already defined for text posts
url: String.t,
author: String.t,
excerpt: String.t,
publisher: String.t,
photos: , #fixme: also defined for photo posts
description: String.t,
#FOR CHAT POSTS
title: String.t, #fixme: also defined for link and text posts
body: String.t, #fixme: also defined for text posts
dialogue: , #todo: define a type for the contained objects
#FOR AUDIO POSTS
caption: String.t, #fixme: also defined for photo posts
player: String.t,
plays: non_neg_integer,
album_art: String.t,
artist: String.t,
album: String.t,
track_name: String.t,
track_number: non_neg_integer,
year: non_neg_integer,
#FOR VIDEO POSTS
caption: String.t, #fixme: also defined for audio and photo posts
player: , #fixme: also defined for audio posts AND IT’S A DIFFERENT TYPE!!!
#FOR ANSWERS POSTS
asking_name: String.t,
asking_url: String.t,
question: String.t,
answer: String.t

Most Liked

OvermindDL1

OvermindDL1

Assuming that a post is only a certain type (Text-only, Video-Only, etc.), then I would make a post struct with a post_type argument akin to:

defmodule Post do
  defstruct blog_name: "", id: -1, post_url: "", whatever_else: :blah, post_body: %{}
end

Where :post_body can be any of a set of other structs, such as:

defmodule Post.Text do
  defstruct title: "", body: ""
end

defmodule Post.Photo do
  defstruct photots: [], caption: "", width: -1, height: -1
end

# etc...

If however a post can contain multiple things, say you could have one that has text, video, more text, then a link then just make post_body be a list in the order they should appear.

Would not be hard to map to a database either and you can match on the post_body struct types too.

You can always invert it and have the Post be a Post.Info that is an info subtype of any of the other types too:

defmodule Post.Info do
  defstruct blog_name: "", id: -1, post_url: "", whatever_else: :blah
end

defmodule Post.Text do
  defstruct title: "", body: "", info: %Post.Info{}
end

defmodule Post.Photo do
  defstruct photots: [], caption: "", width: -1, height: -1, info: %Post.Info{}
end

# etc...

Depends on which way makes more sense given the data.

On a side-note, I hate how plug has a lot of ‘built-in keys’, I wish it were a generic map that we could define our own new plug pipelines over that are not webserver oriented without building our own plug type, you could always use a webserver plug struct as a value of a webserver key or something… >.>

bbense

bbense

FWIW, one rule of thumb coming from OO land to Elixir Land.

Everytime you start thinking you need to “inherit” something, instead think about composing something.

Actually that rule works pretty well in OO Land as well.

minhajuddin

minhajuddin

My suggestion would be to just create 4 structs one for each type of Post. You could avoid the duplication by using some macros but it may end up making the code hard to understand.

defmodule Post do
  @base_fields [id: 1, type: "Post"]
  defmacro __using__(fields) do
    fields = @base_fields ++ fields
    quote do
      defstruct unquote(fields)
    end
  end
end

defmodule Video do
  use Post, caption: "This is the best video"
end

defmodule Test do
  def test do
    IO.inspect %Video{}
  end
end

Test.test
#=> prints %Video{caption: "This is the best video", id: 1, type: "Post"}
shaheenery

shaheenery

Thank you very much. I came across this thread while searching for “elixir composing structs.” This is exactly what I was hoping people would recommend.

OvermindDL1

OvermindDL1

I am a huge proponent of composition over God-Objects and OO-style inheritance both. I use a lot of ECS and Data-Flow designs as well as they are related. :slight_smile:

Where Next?

Popular in Questions Top

gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New
New
logicmason
Hi there, I'm working through my first release with elixir/phoenix. I've built a release with distillery and found that it crashes when I...
New
sacepums
Hey guys. I'm new to elixir and im really stocked about it. But I ran into a bit of problem - I need to convert a date sting, for examp...
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
fireproofsocks
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? https://hexdocs.pm/ecto/Ecto.Repo.h...
New
Fl4m3Ph03n1x
About me? ( if you have nothing better to do than reading about some random guy in the internet :stuck_out_tongue: ) Hello all, this is ...
New
sabri
Can someone explain the settings of pool_size of Ecto in config file? and what is the recommend size? Thanks
New
Codball
Mix format works fine if run from the cmd. I’ve followed this to facilitate the implementation into VSC which involves downloading an ext...
New
9mm
I am constructing a JSON object (map) and I need to conditionally set a field. I’m trying to write proper elixir-way code… and I’m at a l...
New

Other popular topics Top

shahryarjb
Hello, I get Persian date from my client and convert it to normal calendar like this: def jalali_string_to_miladi_english_number(persi...
New
lessless
I believe there are people here who are dealing with CSV files import on the daily basis, and since Excel is a really popular tool there ...
New
bsollish-terakeet
Credo is smart enough to check for (something like) this: assert length(the_list) == 0 with this response: Checking if an enum is empt...
New
quazar
How to set Jason to encode all fields in ecto schema, I don’t care about security and implementing only is taking long list of attributes...
New
SoCreat
i’m a new one to elixir which editor can i use vs code? or atom? Thanks! :smiley:
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
hariharasudhan94
I would like to know what is the best IDE for elixir development?
New
aadeshere1
I have a another noob question about loop. Since elixir is immutable, while loop is not directly possible. total = 10 while total != 0 ...
New
ovidiubadita
Hey all, I discovered Elixir and I love it. I always wanted to learn a functional programming and I intended to go for Haskell, but afte...
New
aesmail
Hello guys, I have finally made it. I created an admin interface for a framework. It’s been on my todo list for years and with the curre...
New

We're in Beta

About us Mission Statement