Listas

Vamos diretamente a um exemplo prƔtico.

Foi decidido que precisamos de uma listagem de candidatos que foram aprovados no vestibular. Com ela, podemos realizar a operaĆ§Ć£o de aprovar estudantes (adicionando o estudando a lista) e tambĆ©m desaprovar estudantes (removendo o estudando da lista.) Com esse levantamento temos trĆŖs pontos a lidar:

  1. Ter uma lista de estudando aprovados

  2. Conseguir adicionar estudantes nessa lista

  3. Remover estudantes da lista.

Vamos ao primeiro teste:

test/students_test.exs
defmodule StudentsTest do
  use ExUnit.Case

  test "adding a new user on approved list" do
    current_list = ["Paulo", "JoĆ£o"]
    students = ["Iago"]
  
    assert Students.add_to_approved_list(current_list, students) == ["Paulo", "JoĆ£o", "Iago"]
  end
end

Criamos uma variĆ”vel chamada current_list que vai conter nossa lista iniciĆ£o de aprovados. Depois criamos uma variĆ”vel chamada students, que Ć© uma lista de usuĆ”rio. Temo entĆ£o na linha 8 a chamada Students.add_to_approved_list/2. Ele Ć© nossa funĆ§Ć£o que irĆ” adicionar uma lista de usuĆ”rio a uma lista ja existente. O retorno dessa funĆ§Ć£o serĆ” uma nova lista com os estudantes adicionados. Com isso conseguimos criar nossa assertion dizendo que deve ser igual a nova lista.

Vamos rodar esse teste:

mix test test/students_test.exs
warning: Students.add_to_approved_list/2 is undefined (module Students is not available or is yet to be defined)
  test/students_test.exs:9: StudentsTest."test List of students approved adding a new user on approved list"/1



  1) test List of students approved adding a new user on approved list (StudentsTest)
     test/students_test.exs:5
     ** (UndefinedFunctionError) function Students.add_to_approved_list/2 is undefined (module Students is not available)
     code: assert Students.add_to_approved_list(current_list, students) == ["Paulo", "JoĆ£o", "Iago"]
     stacktrace:
       Students.add_to_approved_list(["Paulo", "JoĆ£o"], ["Iago"])
       test/students_test.exs:9: (test)


Finished in 0.02 seconds (0.00s async, 0.02s sync)
1 test, 1 failure

Com somente o teste criado, recebemos a mensagem de que a funĆ§Ć£o Students.add_to_approved_list/2 nĆ£o existe. PrĆ³ximo passo Ć© cria-la.

lib/students.ex
defmodule Students do
  def add_to_approved_list(_, _) do
    []
  end
end

Criamos o mĆ³dulo Students e dentro a funĆ§Ć£o add_to_approved/2. Como jĆ” tinhamos falado, retornaremos uma lista. 

mix test test/students_test.exs
Compiling 1 file (.ex)


  1) test List of students approved adding a new user on approved list (StudentsTest)
     test/students_test.exs:5
     Assertion with == failed
     code:  assert Students.add_to_approved_list(current_list, students) == ["Paulo", "JoĆ£o", "Iago"]
     left:  []
     right: ["Paulo", "JoĆ£o", "Iago"]
     stacktrace:
       test/students_test.exs:9: (test)


Finished in 0.01 seconds (0.00s async, 0.01s sync)
1 test, 1 failure

No teste falhou novamente. Agora acusando que a nossa chamada esta retornando um [] e esperavamos ["Paulo", "JoĆ£o", "Iago"]. Claro, nĆ£o retornamos a lista enviada. Vamos fazer isso para seguir com a implementaĆ§Ć£o. Vamos alterar students.ex. Ao chamar a funĆ§Ć£o, o primeiro argumento que passamos Ć© a lista atual e o segundo argumento Ć© a lista de estudantes a serem adicionados. Vamos primeiro retornar apenas a primeira lista.

lib/students.ex
defmodule Students do
  def add_to_approved_list(current_list, _) do
    current_list
  end
end

Vamos executar novamente o teste:

mix test test/students_test.exs
Compiling 1 file (.ex)


  1) test List of students approved adding a new user on approved list (StudentsTest)
     test/students_test.exs:5
     Assertion with == failed
     code:  assert Students.add_to_approved_list(current_list, students) == ["Paulo", "JoĆ£o", "Iago"]
     left:  ["Paulo", "JoĆ£o"]
     right: ["Paulo", "JoĆ£o", "Iago"]
     stacktrace:
       test/students_test.exs:9: (test)


Finished in 0.01 seconds (0.00s async, 0.01s sync)
1 test, 1 failure

Estamos chegando perto! Agora acusou apenas que nĆ£o temos o estudante Iago em nossa lista. Isso porque o primeiro parĆ¢metro de nossa funĆ§Ć£o esta passando apenas uma lista sem Iago. JĆ” o segundo parĆ¢metro estĆ” passando uma lista e nessa lista possuĆ­mos o nome Iago. Essa segunda lista sĆ£o os estudantes que queremos adicionar na lista de estudantes que passaram. Precisamos unir essas duas listas. Para isso, podemos usar o operador ++/2 do elixir.

lib/students.ex
defmodule Students do
  def add_to_approved_list(current_list, new_students) do
    current_list ++ new_students
  end
end

Alteramos o nome do segundo parĆ¢metro de underline (_) para new_students para podermos usar em nossa funĆ§Ć£o. Tendo os novos estudantes em mĆ£os, adicionamos o operador ++/2 ao lado de current_list e colocamos ao final a lista que queremos fazer a uniĆ£o, no nosso casso new_students. Vamos rodar novamente nosso teste:

mix test test/students_test.exs
Compiling 1 file (.ex)
.
Finished in 0.01 seconds (0.00s async, 0.01s sync)
1 test, 0 failures

Agora temos uma nova lista retornada pela funĆ§Ć£o add_to_approved_list/2 contendo a uniĆ£o de duas listas. Com isso temos dois dos problemas resolvidos.

  1. Ter uma lista de estudando aprovados

  2. Conseguir adicionar estudantes nessa lista

  3. Remover estudantes da lista.

Precisamos agora remover os estudantes que foram desaprovados. Vamos ao teste:

test/students_test.exs
defmodule StudentsTest do
  use ExUnit.Case

  test "removing a user on approved list" do
    current_list = ["Paulo", "JoĆ£o"]
    students = ["JoĆ£o"]

    assert Students.remove_from_approved_list(current_list, students) == ["Paulo"]
  end
end
mix test test/students_test.exs
Compiling 1 file (.ex)
warning: Students.remove_from_approved_list/2 is undefined or private
  test/students_test.exs:16: StudentsTest."test List of students approved removing an user on approved list"/1



  1) test List of students approved removing an user on approved list (StudentsTest)
     test/students_test.exs:12
     ** (UndefinedFunctionError) function Students.remove_from_approved_list/2 is undefined or private
     code: assert Students.remove_from_approved_list(current_list, students) == ["Paulo"]
     stacktrace:
       (hello_world 0.1.0) Students.remove_from_approved_list(["Paulo", "JoĆ£o"], ["JoĆ£o"])
       test/students_test.exs:16: (test)

.
Finished in 0.02 seconds (0.00s async, 0.02s sync)
2 tests, 1 failure

Agora vamos fazer o oposto do que fizemos anteriormente. Queremos remove elementos de uma lista. Choque com a informaĆ§Ć£o, mas o oposot de ++/2 Ć© --/2. Acredito que nem precisaria fazer essa implementaĆ§Ć£o. Mas vou fazer para deixar aqui completo. Vamos a implementaĆ§Ć£o:

lib/students.ex
defmodule Students do
  # ...

  def remove_from_approved_list(current_list, students_to_remove) do
    current_list -- students_to_remove
  end
end

Fizemos a mesma implementaĆ§Ć£o, porem, utilizamos o operador --/2. Pode rodar os testes e ser feliz.

mix test test/students_test.exs
Compiling 1 file (.ex)
..
Finished in 0.01 seconds (0.00s async, 0.01s sync)
2 tests, 0 failures

E nosso escopo esta fechado:

  1. Ter uma lista de estudando aprovados

  2. Conseguir adicionar estudantes nessa lista

  3. Remover estudantes da lista.

Vamos adicionar mais uma tarefa. Queremos saber a quantidade de estudantes que passaram no vestibular. Vamos ao teste:

test/students_test.exs
defmodule StudentsTest do
  use ExUnit.Case

  describe "List of students approved" do
    test "total approved" do
      current_list = ["Paulo", "JoĆ£o"]

      assert Students.total_approved(current_list) == 2
    end
  end
end

mix test test/students_test.exs
warning: Students.total_approved/1 is undefined or private. Did you mean:

      * add_to_approved_list/2

  test/students_test.exs:22: StudentsTest."test List of students approved total approved"/1

.

  1) test List of students approved total approved (StudentsTest)
     test/students_test.exs:19
     ** (UndefinedFunctionError) function Students.total_approved/1 is undefined or private. Did you mean:
     
           * add_to_approved_list/2
     
     code: assert Students.total_approved(current_list) == 2
     stacktrace:
       (hello_world 0.1.0) Students.total_approved(["Paulo", "JoĆ£o"])
       test/students_test.exs:22: (test)

.
Finished in 0.03 seconds (0.00s async, 0.03s sync)
3 tests, 1 failure

NĆ£o possuĆ­mos a funĆ§Ć£o. Logo, temos um erro. Vamos resolver isso criando ela:

lib/students.ex
defmodule Students do
  # ...
  def total_approved(_current_list) do
    2
  end
end

Quando lidamos com totais, sempre esperamos um integer, para manter consistente retornamos dessa funĆ§Ć£o apenas 2 para nosso teste passar. Vamos ver o que o teste nos diz.

mix test test/students_test.exs
Compiling 1 file (.ex)
...
Finished in 0.01 seconds (0.00s async, 0.01s sync)
3 tests, 0 failures

Vamos adicionar uma outra assertion para nosso teste, com uma quantidade diferente de itens na lista. Isso garante que ela funciona bem.

test/students_test.exs
defmodule StudentsTest do
  use ExUnit.Case

  describe "List of students approved" do
    test "total approved" do
      current_list = ["Paulo", "JoĆ£o"]
      another_current_list = ["Carlos", "Cris", "Jill"]

      assert Students.total_approved(current_list) == 2
      assert Students.total_approved(another_current_list) == 3
    end
  end
end

Vamos rodar o teste com a nova assertion:

mix test test/students_test.exs
..

  1) test List of students approved total approved (StudentsTest)
     test/students_test.exs:19
     Assertion with == failed
     code:  assert Students.total_approved(another_current_list) == 3
     left:  2
     right: 3
     stacktrace:
       test/students_test.exs:24: (test)


Finished in 0.02 seconds (0.00s async, 0.02s sync)
3 tests, 1 failure

Algo deu errado. A quantidade esperada na segunda assertion Ć© diferente de dois, que colocamos diretamente na implementaĆ§Ć£o. Precisamos de algo mais dinĆ¢mico. Por sorte (uma brincadeira), temos a funĆ§Ć£o nativa length/1, onde espera uma lista e nos retorna o total de elementos dessa lista. Vamos lĆ”:

defmodule Students do
  # ...
  def total_approved(current_list) do
    length(current_list)
  end
end

Simples nĆ£o? Vamos rodar novamente os testes:

mix test test/students_test.exs
Compiling 1 file (.ex)
...
Finished in 0.02 seconds (0.00s async, 0.02s sync)
3 tests, 0 failures

Muito bem! VocĆŖ estĆ” indo bem. Mas vamos pensar em alguma outra coisa. VocĆŖ Ć© um desses estudantes e quer saber se vocĆŖ passou. Como podemos fazer isso? Vamos ao teste:

test/students_test.exs
defmodule StudentsTest do
  use ExUnit.Case

  describe "List of students approved" do
    test "was student approved?" do
      current_list = ["Iago", "Paulo","JoĆ£o"]

      assert Students.was_approved?(current_list, "Iago") == true
    end
  end
end

mix test test/students_test.exs
warning: Students.was_approved?/2 is undefined or private. Did you mean:

      * total_approved/1

  test/students_test.exs:30: StudentsTest."test List of students approved was student approved?"/1

...

  1) test List of students approved was student approved? (StudentsTest)
     test/students_test.exs:27
     ** (UndefinedFunctionError) function Students.was_approved?/2 is undefined or private. Did you mean:
     
           * total_approved/1
     
     code: assert Students.was_approved?(current_list, "Iago") == true
     stacktrace:
       (hello_world 0.1.0) Students.was_approved?(["Iago", "Paulo", "JoĆ£o"], "Iago")
       test/students_test.exs:30: (test)


Finished in 0.03 seconds (0.00s async, 0.03s sync)
4 tests, 1 failure

Criamos um teste que chama uma funĆ§Ć£o was_approved?/2, onde o primeiro argumento Ć© a lista de aprovados e o segundo argumento Ć© uma string com o nome do estudante que queremos saber se foi aprovado.

O nome da funĆ§Ć£o possui uma interrogaĆ§Ć£o, dando a entender que queremos uma resposta de verdadeiro ou falso, isso Ć© uma convenĆ§Ć£o que tambĆ©m adotamos no Elixir, vocĆŖ pode ver mais sobre isso no capĆ­tulo de conveƧƵes.

Vamos resolver esse teste:

defmodule Students do
  # ...
  def was_approved?(_approved_list, _student) do
    true
  end
end

Criamos a funĆ§Ć£o no mĆ³dulo Students e retornamos uma valor estĆ”tico true. Assim nosso teste passarĆ”.

mix test test/students_test.exs
Compiling 1 file (.ex)
....
Finished in 0.02 seconds (0.00s async, 0.02s sync)
4 tests, 0 failures

Vamos adicionar agora um caso de que o estudante que procuramos nĆ£o passou.

test/students_test.exs
defmodule StudentsTest do
  use ExUnit.Case

  describe "List of students approved" do
    test "was student approved?" do
      current_list = ["Iago", "Paulo","JoĆ£o"]

      assert Students.was_approved?(current_list, "Iago") == true
      assert Students.was_approved?(current_list, "Rui") == false
    end
  end
end

Para isso, apenas adicionamos a linha 9 a nosso teste, procuranod por um estudante chamado Rui que nĆ£o existe em nossa lista. Vamos rodar o teste:

mix test test/students_test.exs
..

  1) test List of students approved was student approved? (StudentsTest)
     test/students_test.exs:27
     Assertion with == failed
     code:  assert Students.was_approved?(current_list, "Rui") == false
     left:  true
     right: false
     stacktrace:
       test/students_test.exs:31: (test)

.
Finished in 0.03 seconds (0.00s async, 0.03s sync)
4 tests, 1 failure

A resposta para se Rui passou nos exames Ć© true, mas na verdade esperavamos por false. Isso devido ao retorno de nossa funĆ§Ć£o ser estĆ”tico. Precisamos de algo mais dinĆ¢mico para nos salvar agora.

Temos um operador em elixir chamado in/2. Ele verificar se existe um elemento em nossa lista. A leitura desse operador fica muito interessante: 1 in [1,2,3]. Vamos aplica-lo em nosso cĆ³digo:

defmodule Students do
  # ...
  def was_approved?(approved_list, student) do
    student in approved_list
  end
end

Adicionamos o operador in na linha 4. TambĆ©m removemos o underline (_) dos dois parĆ¢metros da funĆ§Ć£o, para podermos utiliza-las. vamos rodar o teste:

mix test test/students_test.exs
Compiling 1 file (.ex)
....
Finished in 0.02 seconds (0.00s async, 0.02s sync)
4 tests, 0 failures

Perfeito! As funƧƵes de lista para estudantes estĆ£o tomando forma e ficando claras em seus objetivos. Precisamos so de mais duas funcionalidades. Me ligaram ainda pouco pedindo que adicionacemos a possibilidade de saber o primeiro e ultimo estudante de nossa lista. Falei que nĆ£o seria um problema, que vocĆŖ jĆ” estava dominando a listagem. Vamos escopar isso

Desafio final

  1. Obter primeiro estudante da lista

  2. Obter Ćŗltimo estudante da lista

Vamos comeƧar do primeiro. Criaremos seu teste:

test/students_test.exs
defmodule StudentsTest do
  use ExUnit.Case

  describe "List of students approved" do
    # ...
    test "first the list" do
      current_list = ["Iago", "Paulo", "JoĆ£o"]

      assert Students.first(current_list) == "Iago"
    end
  end
end

mix test test/students_test.exs
warning: Students.first/1 is undefined or private
  test/students_test.exs:37: StudentsTest."test List of students approved first the list"/1

.

  1) test List of students approved first the list (StudentsTest)
     test/students_test.exs:34
     ** (UndefinedFunctionError) function Students.first/1 is undefined or private
     code: assert Students.first(current_list) == "Iago"
     stacktrace:
       (hello_world 0.1.0) Students.first(["Iago", "Paulo", "JoĆ£o"])
       test/students_test.exs:37: (test)

...
Finished in 0.03 seconds (0.00s async, 0.03s sync)
5 tests, 1 failure

Vamos implementar a funĆ§Ć£o first/1, onde recebe a lista que queremos obter o primeiro. Elixir tem um mĆ³dulo de List que nos ajuda a listar com algumas coisas relacionadas a lista. Para resolver nosso problema aqui, temos a funĆ§Ć£o List.first/1, onde o argumento passado Ć© a lista e a resposta Ć© o elemento da lista, exatamente o que precisamos.

lib/students.ex
defmodule Students do
  # ...
  def first(current_list) do
    List.first(current_list)
  end
end

mix test test/students_test.exs
Compiling 1 file (.ex)
.....
Finished in 0.02 seconds (0.00s async, 0.02s sync)
5 tests, 0 failures

Simples nĆ£o? Agora precisamos lidar com o Ćŗtilmo da lista. Te desafio a pensar qual funĆ§Ć£o usaremos para resolver isso. Enquanto pensa, vamos para o teste:

test/students_test.exs
defmodule StudentsTest do
  use ExUnit.Case

  describe "List of students approved" do
    # ...
    test "last in the list" do
      current_list = ["Iago", "Paulo", "JoĆ£o"]

      assert Students.last(current_list) == "JoĆ£o"
    end
  end
end

mix test test/students_test.exs
warning: Students.last/1 is undefined or private
  test/students_test.exs:43: StudentsTest."test List of students approved last in the list"/1

...

  1) test List of students approved last in the list (StudentsTest)
     test/students_test.exs:40
     ** (UndefinedFunctionError) function Students.last/1 is undefined or private
     code: assert Students.last(current_list) == "JoĆ£o"
     stacktrace:
       (hello_world 0.1.0) Students.last(["Iago", "Paulo", "JoĆ£o"])
       test/students_test.exs:43: (test)

..
Finished in 0.03 seconds (0.00s async, 0.03s sync)
6 tests, 1 failure

Vamos implementar a funĆ§Ć£o que nĆ£o existe. Pensou na funĆ§Ć£o que usariamos para ser oposto a List.first/1? Ɖ isso mesmo, List.last/1. Vamos implementar nosso cĆ³digo.

lib/students.ex
defmodule Students do
  # ...
  def last(current_list) do
    List.last(current_list)
  end
end

mix test test/students_test.exs
Compiling 1 file (.ex)
......
Finished in 0.02 seconds (0.00s async, 0.02s sync)
6 tests, 0 failures

ConclusĆ£o

Ɠtimo! Agora temos muitas ferramentas para lidar com listas. Listas sĆ£o simples, mas podemos tirar grandes vantagens dela ao dia-a-dia de trabalho. Ela sempre estarĆ” presente e muitas vezes podem se tornar bem complexa. O domĆ­nio de operaƧƵes e funƧƵes de auxĆ­lio ira te ajudar na jornada.

VocĆŖ deve ter ficado com a impressĆ£o de faltar algo. Sim, temos um buraco aqui. Que tipo de aprendizado de lista nĆ£o ensina como a percorremos. Por isso o prĆ³ximo capĆ­tulo falarĆ” sobre estruturas de repetiĆ§Ć£o.

PreviousEstruturasNextEstruturas de repetiĆ§Ć£o

Last updated

Was this helpful?