# `Benchee.Utility.FileCreation`
[🔗](https://github.com/bencheeorg/benchee/blob/1.5.1/lib/benchee/utility/file_creation.ex#L1)

Methods to easily handle file creation used in plugins.

# `each`

```elixir
@spec each(%{required(String.t() | [String.t()]) => String.t()}, String.t(), fun()) ::
  :ok
```

Open a file for write for all key/value pairs, interleaves the file name with
the key and calls the given function with file, content and filename.

Uses `interleave/2` to get the base filename and
the given keys together to one nice file name, then creates these files and
calls the function with the file and the content from the given map so that
data can be written to the file.

If a directory is specified, it creates the directory.

Expects:

* names_to_content - a map from input name to contents that should go into
the corresponding file
* filename - the base file name as desired by the user
* function - a function that is then called for every file with the associated
file content from the map, defaults to just writing the file content via
`IO.write/2` and printing where it put the file.

## Examples

    # Just writes the contents to a file
    Benchee.Utility.FileCreation.each(%{"My Input" => "_awesome html content_"},
      "my.html",
      fn(file, content) -> IO.write(file, content) end)

# `ensure_directory_exists`

Make sure the directory for the given file name exists.

# `interleave`

```elixir
@spec interleave(String.t(), String.t() | [String.t()]) :: String.t()
```

Gets file name/path, the input name and others together.

Takes a list of values to interleave or just a single value.
Handles the special no_input key to do no work at all.

## Examples

    iex> interleave("abc.csv", "hello")
    "abc_hello.csv"

    iex> interleave("abc.csv", "Big Input")
    "abc_big_input.csv"

    iex> interleave("abc.csv", "String.length/1")
    "abc_string_length_1.csv"

    iex> interleave("bench/abc.csv", "Big Input")
    "bench/abc_big_input.csv"

    iex> interleave(
    ...>   "bench/abc.csv",
    ...>   ["Big Input"]
    ...> )
    "bench/abc_big_input.csv"

    iex> interleave("abc.csv", [])
    "abc.csv"

    iex> interleave(
    ...>   "bench/abc.csv",
    ...>   ["Big Input", "Comparison"]
    ...> )
    "bench/abc_big_input_comparison.csv"

    iex> interleave(
    ...>   "bench/A B C.csv",
    ...>   ["Big Input", "Comparison"]
    ...> )
    "bench/A B C_big_input_comparison.csv"

    iex> interleave(
    ...>   "bench/abc.csv",
    ...>   ["Big Input", "Comparison", "great Stuff"]
    ...> )
    "bench/abc_big_input_comparison_great_stuff.csv"

    iex> marker = Benchee.Benchmark.no_input()
    ...> interleave("abc.csv", marker)
    "abc.csv"
    iex> interleave("abc.csv", [marker])
    "abc.csv"
    iex> interleave(
    ...>   "abc.csv",
    ...>   [marker, "Comparison"]
    ...> )
    "abc_comparison.csv"
    iex> interleave(
    ...>   "abc.csv",
    ...>   ["Something cool", marker, "Comparison"]
    ...> )
    "abc_something_cool_comparison.csv"