Qqwy

Qqwy

TypeCheck Core Team

Doctests: defining a struct in your doctest

I am working on the MapDiff library, so it works better when structs are passed to it.

I wrote the following two doctests:

  iex> defmodule Foo do
  ...>  defstruct a: 1, b: 2, c: 3
  ...> end
  ...> MapDiff.diff(%Foo{}, %Foo{a: 3})
  %{changed: :map_change, struct_name: Foo,
    value: %{a: %{added: 3, changed: :primitive_change, removed: 1},
      b: %{changed: :equal, value: 2}, c: %{changed: :equal, value: 3}}}

and:

  iex> defmodule Bar do
  ...> defstruct a: 1, b: 2, c: 3
  ...> end
  ...> defmodule Baz do
  ...> defstruct a: "foo", b: "bar", z: "baz"
  ...> end
  ...> MapDiff.diff(%Bar{}, %Baz{})
  %{added: %Baz{a: "foo", b: "bar", z: "baz"}, changed: :primitive_change,
    removed: %Bar{a: 1, b: 2, c: 3}}

However, this will not compile. When running mix test, the following error is thrown:

Compiling 1 file (.ex)
** (CompileError) (for doctest at) lib/map_diff.ex:105: MapDiffTest.Foo.__struct__/1 is undefined, cannot expand struct MapDiffTest.Foo
    (stdlib) lists.erl:1354: :lists.mapfoldl/3
    test/map_diff_test.exs:3: anonymous fn/3 in :elixir_compiler_1.__MODULE__/1
    (elixir) lib/enum.ex:1755: Enum."-reduce/3-lists^foldl/2-0-"/3
    test/map_diff_test.exs:3: (module)

I think that this is the case because Elixir tries to evaluate the outcome value decoupled from the example, which means that Foo, Bar and Baz (and their respective __struct__/1 implementations) are not in scope.

Now, how can these doctests be rewritten so:

  • they compile.
  • it is clear to people that Foo, Bar and Baz are normal structs they could define themselves?

First 2 of 2 Posts! Switch mode

vic

vic

Asdf Core Team

I guess the best would be to define those example structs somewhere like in test/support then just add a comment about their structure on your docs (indent the code four spaces so that it gets properly highlighted as elixir code) and then just import them for doctest:

@doc """
   For example suppose you define the following structs:

     defmodule Bar do
       defstruct a: 1, b: 2, c: 3
     end

      defmodule Baz do
        defstruct a: "foo", b: "bar", z: "baz"
      end   
   

       iex> import Foo
       iex> import Bar
       iex> MapDiff.diff(%Foo{}, %Bar{})
       %{added: %Baz ....}
"""
Qqwy

Qqwy

TypeCheck Core Team

Yes! This solution works wonderfully :slight_smile: .

I ended up simply defining the structs in the tests/map_diff_test.exs file, inside the MapDiffTest module, before doctest MapDiff is being called, because it seemed the most clear (as long as the code does not become much longer.)

Thank you very much :blush:!

Where Next?

Trending in Questions Top

jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
silverdr
Using Phoenix.LiveView.TagEngine as an EEx.Engine is deprecated! To compile HEEx, use Phoenix.LiveView.TagEngine.compile/2 instead. Sta...
New
saveman71
Hello ! We want new/edit form pages to POST/PUT to their own URL rather than the resources REST defaults (post /things, put /things/:id)...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
michallepicki
I am using Oban and occasionally, shortly after a deployment, a handful of jobs can fail because of dependency on other parts of the syst...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
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
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
akoutmos
@hugobarauna and I (Alex Koutmos) have been hard at work on writing a book on Nerves that takes you from simply blinking LEDs to building...
New

We're in Beta

About us Mission Statement