debajit

debajit

I have the following module where as I developed the code I was using doctests to verify if the function did what I expected. The problem is these doctests that I was writing are for functions that eventually became private functions:

  • Removing the doctests for the private functions does not help here as I need the tests — they help with catching regressions and help document the functionality of the code. Without these tests, it may not be clear to someone reading the code what exactly the private function does.

  • I could move the code inside the public function but that results in a big monolithic function and the separate functions help clarify the logic.

What is the recommended way to reconcile this in Elixir? (I seem to run into this problem very often — requiring doctests for private functions, that is)

The only solution I know is to create a separate Impl module and move the private functions as public functions like @pragdave describes here: Redirect . Is this an anti-pattern (given that I would be effectively “exposing” the private functions in a way)? I love this approach, but I was wondering if there was another way to have doctests for private functions — I would presume this would be a common problem?

What is the guidance here? Also, is there a way to remove these warnings for @docs on private functions?

defmodule InverseCaptcha do
  @moduledoc """
  Solves the Inverse Captcha problem.
  http://adventofcode.com/2017/day/1

  Run with:

      mix
      ./inverse_captcha 1122
  """

  def solve_captcha(string) do
    string
    |> string_to_list
    |> sum_of_digits_matching_next
  end

  @doc """
      iex> string_to_list("1122")
      [1, 1, 2, 2]
  """
  defp string_to_list(string) do
    string
    |> String.splitter("", trim: true)
    |> Stream.map(& String.to_integer(&1))
    |> Enum.to_list
  end

  @doc """
  ## Examples

      iex> sum_of_digits_matching_next([1, 1, 2, 2])
      3

      iex> sum_of_digits_matching_next([1, 1, 1, 1])
      4

      iex> sum_of_digits_matching_next([1, 2, 3, 4])
      0

      iex> sum_of_digits_matching_next([9, 1, 2, 1, 2, 1, 2, 9])
      9
  """
  defp sum_of_digits_matching_next(list) do
    list_with_head = (list ++ [hd(list)])

    list_with_head
    |> Enum.zip(tl(list_with_head))
    |> Enum.reduce(0, fn {x, y}, acc ->
         if x == y do
           x + acc
         else
           acc
         end
       end)
  end
end

defmodule InverseCaptcha.CLI do
  def main(args) do
    string = hd(args)
    IO.puts InverseCaptcha.solve_captcha(string)
  end
end

Showing Posts 1 to 5

NobbZ

NobbZ

Private functions are not meant to get tested at all, not per unit test not per doctest. Also private functions are not meant to be documented.

The compiler spits out a warning when you try it. You can remove that warning by removing the documentation.

And last but not least, a doctest is not to verify that the function works as expected, but they are to verify that the examples in your documentation are correct.

There have been some discussions around this on the old mailinglist, on the core mailinglist, and on this forum as well.

utricularia

utricularia

Why wouldn’t you want to unit test a private function? I can more or less understand not documenting it given that they are not meant to be exposed- but unit testing?

imobachgs

imobachgs

I consider private functions just as “implementation details”, so I focus on testing only the module’s public APIs. On the other hand, if your public functions are working as expected, I think you can happily assume that your private functions are working aswell.

About documenting private methods, I understand the reasons to not doing so. But to be honest, I find this documentation useful for other developers contributing to the project.

jwarlander

jwarlander

Sometimes I’ve seen a tendency in my own code for private functions to grow a bit too complex; I usually take that as a hint that maybe they should be public functions in some kind of utility module or similar.

My idea of a “good” private function is mostly along the lines of a one-liner to shorten, and give a proper name to, a part of a larger transformation / pipe sequence.

If it gets more complex, like mapping a set of values to something else, etc, then I definitely feel it should be a public function, either in the current module or another one that fits better.

LostKobrakai

LostKobrakai

Private functions have different semantics than public ones, what Jose explained here quite well: https://forum.elixirforum.com/t/proposal-docp-for-private-function-documentation-and-doctests/3732/2?u=lostkobrakai

— All posts loaded —

Where Next? Top

Trending in Questions Top

Blokh
Hey guys, I’ve got a huge CSV ( around 10 GB ) that needs to be processed hourly Do you guys have any suggestions what is the best prac...
New
kszambelanczyk
Hello! Could someone please give me a help/sample code, how to delete a file from s3 using waffle/waffle_ecto from Phoenix app. I creat...
New
Onor.io
I have what I’ve heard referred to as a “lookup table” in my database. This is a way of assigning codes to common values. One common lo...
New
Trolleger
What approach to take when sending live updates to “random” users Hi! I have a question, I have a little chat app, and when I create a DM...
New
matt-savvy
Anyone here using Honeybadger? My Honeybadger account is being overwhelmed with noise from some bots. Seeing a lot of Bandit.HTTPError...
New
RemyXRenard
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
New
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New

Other Trending Topics Top

garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
New
mcass19
ExRatatui lets you cook up rich terminal UIs in Elixir, powered by Rust’s ratatui via Rustler NIFs. Build interactive terminal applicatio...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
wintermeyer
There are three potential reasons for members of this forum to have a look at https://vutuv.de You are tired or annoyed of LinkedIn. Yo...
New
webofbits
Aludel - LLM Evaluation Workbench Aludel is an embeddable Phoenix LiveView dashboard for evaluating and comparing LLM prompts across mult...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews