Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c107a2fe26 | ||
|
|
17853e63d8 | ||
|
|
338e242a59 | ||
|
|
2de4680c6e | ||
|
|
1cffb06981 | ||
|
|
e0f1ba28dd | ||
|
|
45c7f828ef | ||
|
|
9169b6e302 | ||
|
|
c2bdc66b9e | ||
|
|
d16f354a3b | ||
|
|
dd30768354 | ||
|
|
bf1d993b2f | ||
|
|
755639f538 | ||
|
|
97e0b1e1ff | ||
|
|
c2a9c93f02 | ||
|
|
d896f541f1 | ||
|
|
f033672fa8 | ||
|
|
717c72e71b | ||
|
|
9ac830f56b | ||
|
|
0ded67dd60 | ||
|
|
abbf173da7 | ||
|
|
fc1c303481 | ||
|
|
5e1e2e6a83 | ||
|
|
77d708e1bc | ||
|
|
cb0f900b1c | ||
|
|
815420ce0f | ||
|
|
cba11d6941 | ||
|
|
966f8f74ae | ||
|
|
55241d92e2 | ||
|
|
11086ac450 | ||
|
|
0c81857622 | ||
|
|
bd0a2e8a12 | ||
|
|
df50dca83a | ||
|
|
f0969f0aa0 | ||
|
|
ad489d7d80 | ||
|
|
f8afbf3321 | ||
|
|
3b5f10874f | ||
|
|
e17b2470c6 | ||
|
|
8a1c5c38d0 | ||
|
|
00deab98bf | ||
|
|
47f4721c0b | ||
|
|
beb69232c4 | ||
|
|
4b43c7ae20 | ||
|
|
ca49a53ab2 | ||
|
|
1ff0e1ac7a | ||
|
|
ae66125f2e | ||
|
|
3025cc759b | ||
|
|
8f18a5f4ff | ||
|
|
1626f9659b | ||
|
|
9083937177 | ||
|
|
da90bb741e | ||
|
|
51d56274de | ||
|
|
79fcebb407 | ||
|
|
2b588dfb3e | ||
|
|
2ba98f247a | ||
|
|
bc9b5ea700 | ||
|
|
992c240b14 | ||
|
|
79ae08f962 | ||
|
|
5d7ee90cba | ||
|
|
66cf08ea89 | ||
|
|
ad62bb970d | ||
|
|
18eef65839 | ||
|
|
0611069c74 | ||
|
|
f2b31a6626 | ||
|
|
3b41c9f396 | ||
|
|
0eb95c9c75 | ||
|
|
b898f09870 | ||
|
|
e89139bcf0 | ||
|
|
ecad849319 | ||
|
|
2658f3666a | ||
|
|
3907a3062f | ||
|
|
bd9751d669 | ||
|
|
e4ebe291f2 | ||
|
|
6b6bcea76c | ||
|
|
96260316ca | ||
|
|
47f2696820 | ||
|
|
740cc1ff0b |
+3
-3
@@ -11,8 +11,8 @@ test_script:
|
||||
environment:
|
||||
ELIXIR_ASSERT_TIMEOUT: 2000
|
||||
|
||||
configuration: Test
|
||||
|
||||
matrix:
|
||||
allow_failures:
|
||||
- configuration: Test
|
||||
- platform: x86
|
||||
- platform: x64
|
||||
- platform: Any CPU
|
||||
|
||||
+95
-3
@@ -29,8 +29,8 @@ This release also introduces two new attributes associated to function definitio
|
||||
@doc "Breaks a collection into chunks"
|
||||
@since "1.0.0"
|
||||
@deprecated "Use chunk_every/2 instead"
|
||||
def chunk_every(collection, chunk_size) do
|
||||
...
|
||||
def chunk(collection, chunk_size) do
|
||||
chunk_every(collection, chunk_size)
|
||||
end
|
||||
|
||||
The `mix xref` task was also updated to warn if your project calls deprecated code. So if a definition is marked as `@deprecated` and a module invokes it, a warning will be emitted during compilation. This effectively provides libraries and frameworks a mechanism to deprecate code without causing multiple warnings to be printed in runtime and without impacting performance.
|
||||
@@ -123,6 +123,88 @@ Those improvements will help developers better understand the relationship betwe
|
||||
|
||||
Other improvements in Mix include better compiler diagnostics for editor integration, support for the `--slowest N` flag in `mix test` that shows the slowest tests in your suite, and a new `mix profile.eprof` task that provides time based profiling, complementing the existing `mix profile.cprof` (count based) and `mix profile.fprof` (flame based).
|
||||
|
||||
## v1.6.4 (2018-03-16)
|
||||
|
||||
### 1. Bug fixes
|
||||
|
||||
#### Elixir
|
||||
|
||||
* [Code.Formatter] Do not double escape quoted keyword list identifiers
|
||||
* [Kernel] Properly support `into: binary` in Erlang/OTP 20.3
|
||||
|
||||
## v1.6.3 (2018-03-09)
|
||||
|
||||
### 1. Enhancements
|
||||
|
||||
#### Elixir
|
||||
|
||||
* [Code.Formatter] Support comments in the middle of pipelines, `when` and `|` expressions
|
||||
|
||||
### 2. Bug fixes
|
||||
|
||||
#### Elixir
|
||||
|
||||
* [Code.Formatter] Consider commas when breaking groups
|
||||
* [Code.Formatter] Ensure proper precedence between `&` and operators
|
||||
* [Code.Formatter] Consider `.formatter.exs` when formatting stdin
|
||||
|
||||
#### Logger
|
||||
|
||||
* [Logger.Translator] Ensure logger doesn't crash when reporting named `DynamicSupervisor`
|
||||
|
||||
## v1.6.2 (2018-02-28)
|
||||
|
||||
### 1. Enhancements
|
||||
|
||||
#### Mix
|
||||
|
||||
* [mix compile.erlang] Teach Mix erlang compiler alternative spelling for `-behavior` declaration
|
||||
* [mix format] Support the `:subdirectories` configuration that points to other directories with their own `.formatter.exs` file. This is useful in umbrella applications. `mix new --umbrella` has also been changed to use this new configuration by default
|
||||
* [mix format] Include the current environment for missing dependency errors
|
||||
|
||||
### 2. Bug fixes
|
||||
|
||||
#### Elixir
|
||||
|
||||
* [Code.Formatter] Ensure `->` does not exceed line length
|
||||
* [DynamicSupervisor] Properly tag error reports generated by dynamic supervisors so they can be properly translated by `Logger`
|
||||
* [DynamicSupervisor] Consider extra arguments during child restart
|
||||
* [Kernel] Ensure arguments given to a guard defined with `defguard` are evaluated in the correct order
|
||||
* [Module] Do not remove docs for previous function declaration when `@impl true` is used
|
||||
* [Supervisor] Ensure `use Supervisor` properly adds the `@behaviour Supervisor` annotation
|
||||
|
||||
#### Mix
|
||||
|
||||
* [Mix.Shell] Bring back `Mix.Shell.cmd/2` - this arity was defined via a default argument that was accidentally removed
|
||||
|
||||
## v1.6.1 (2018-01-29)
|
||||
|
||||
### 1. Enhancements
|
||||
|
||||
#### Elixir
|
||||
|
||||
* [DynamicSupervisor] Implement `child_spec/1` for DynamicSupervisor
|
||||
* [Kernel] Raise better error messages on invalid map syntax
|
||||
|
||||
### 2. Bug fixes
|
||||
|
||||
#### Elixir
|
||||
|
||||
* [Code.Formatter] Only rearrange `not in` operator if explicitly opted-in
|
||||
* [Code.Formatter] Ensure `do` blocks do not exceed line length on calls with a single argument
|
||||
* [Collectable] Support bitstrings in Collectable and for-comprehensions (regression in v1.6.0)
|
||||
* [GenServer] Do not override user own `@opts` attribute
|
||||
* [Enum] Reintroduce zipping of any enumerable of enumerables in `Enum.zip/1` (regression in v1.6.0)
|
||||
* [Macro] Reorder kw blocks in `Macro.to_string/1` to avoid warnings
|
||||
* [Protocol] Fix protocol consolidation when some chunks may be missing
|
||||
* [Stream] Reintroduce zipping of any enumerable of enumerables in `Stream.zip/1` (regression in v1.6.0)
|
||||
* [Supervisor] Do not override user own `@opts` attribute
|
||||
* [Supervisor] Add `@spec` to second clause of `start_link/2`
|
||||
|
||||
#### ExUnit
|
||||
|
||||
* [ExUnit.Case] Reintroduce `:case` in ExUnit setup/setup_all/test context
|
||||
|
||||
## v1.6.0 (2018-01-17)
|
||||
|
||||
### 1. Enhancements
|
||||
@@ -154,6 +236,7 @@ Other improvements in Mix include better compiler diagnostics for editor integra
|
||||
* [Kernel.ParallelCompiler] Add `compile/2`, `compile_to_path/3` and `require/2` which provide detailed information about warnings and errors
|
||||
* [Kernel.SpecialForms] Support the `uniq: true` flag in `for` comprehensions
|
||||
* [Module] Introduce `@deprecated` and `@since` attributes
|
||||
* [Module] Emit conflicting behaviour warnings if the same behaviour is given more than once
|
||||
* [List] Rearrange equals and inserts for shorter diff scripts in `List.myers_difference/2`
|
||||
* [Record] Allow `:macros` and `:includes` to be given to `Record.extract/2`
|
||||
* [Stream] Add `Stream.intersperse/2`
|
||||
@@ -208,6 +291,7 @@ Other improvements in Mix include better compiler diagnostics for editor integra
|
||||
* [Kernel] Solve a precedence issue between `&` and `|`, such as `[&Foo.bar/1 | &Baz.bat/2]`
|
||||
* [Kernel] Do not load dynamic Elixir modules as `:in_memory` as this value is not officially supported by the code server. Instead, use an empty list, which is the same value used by Erlang.
|
||||
* [Kernel] Validate variable struct name is atom when used in pattern matching
|
||||
* [Kernel] No longer generate documentation for `defdelegate` functions automatically to avoid overriding previously specified `@doc`
|
||||
* [Macro] Fix `Macro.to_string/2` for tuple calls, such as `alias Foo.{Bar, Baz}`
|
||||
* [MapSet] Return valid MapSet when unioning a legacy MapSet
|
||||
* [Regex] Return a leading empty space when splitting on empty pattern. This makes the `split` operation consistent with the other operations in the `Regex` module
|
||||
@@ -228,15 +312,23 @@ Other improvements in Mix include better compiler diagnostics for editor integra
|
||||
|
||||
#### Elixir
|
||||
|
||||
* [GenServer] Warn if `init/1` is not defined in `GenServer`. This brings GenServer closer to the implementation in OTP and aligns all behaviours to require the `init/1` callback
|
||||
* [Inspect.Algebra] `surround/3` and `surround_many/6` are deprecated in favor of `container_doc/6`
|
||||
* [Kernel] Specifying map types with variable keys without defining the type as required/optional is deprecated
|
||||
* [Kernel.ParallelCompiler] `files/2` and `files_to_path/3` are deprecated in favor of `compile/2` and `compile_to_path/3`
|
||||
* [Kernel.ParallelRequire] `files/2` is deprecated in favor of `Kernel.ParallelCompiler.require/2`
|
||||
* [GenServer] Warn if `init/1` is not defined in `GenServer`. This brings GenServer closer to the implementation in OTP and aligns all behaviours to require the `init/1` callback
|
||||
* [Supervisor] The `:simple_one_for_one` strategy is deprecated in favor of `DynamicSupervisor`
|
||||
* [Supervisor] Passing a list of args to `Supervisor.start_child/2` is deprecated in favor of `DynamicSupervisor`
|
||||
* [Task.Supervisor] Passing `:restart` and `:shutdown` to `Task.Supervisor.start_link/2` is deprecated (it should be passed on start child instead)
|
||||
|
||||
#### ExUnit
|
||||
|
||||
* [ExUnit.Formatter] `:case_started` and `:case_finished` events are deprecated in favor of `:module_started` and `:module_finished`
|
||||
|
||||
#### Mix
|
||||
|
||||
* [Mix.Compilers.Erlang] Returning `{:ok, val} | :error` from custom Erlang compilers is deprecated in favor of `{:ok, val, warnings} | {:error, errors, warnings}`
|
||||
|
||||
### 4. Deprecations
|
||||
|
||||
#### Elixir
|
||||
|
||||
@@ -243,13 +243,13 @@ build_man: man/iex.1 man/elixir.1
|
||||
|
||||
man/iex.1:
|
||||
$(Q) cp man/iex.1.in man/iex.1
|
||||
$(Q) sed -i.bak "/{COMMON}/r common" man/iex.1
|
||||
$(Q) sed -i.bak "/{COMMON}/r man/common" man/iex.1
|
||||
$(Q) sed -i.bak "/{COMMON}/d" man/iex.1
|
||||
$(Q) rm -f man/iex.1.bak
|
||||
|
||||
man/elixir.1:
|
||||
$(Q) cp man/elixir.1.in man/elixir.1
|
||||
$(Q) sed -i.bak "/{COMMON}/r common" man/elixir.1
|
||||
$(Q) sed -i.bak "/{COMMON}/r man/common" man/elixir.1
|
||||
$(Q) sed -i.bak "/{COMMON}/d" man/elixir.1
|
||||
$(Q) rm -f man/elixir.1.bak
|
||||
|
||||
|
||||
@@ -2,8 +2,6 @@
|
||||
=========
|
||||
[](https://travis-ci.org/elixir-lang/elixir)
|
||||
[](https://ci.appveyor.com/project/josevalim/elixir)
|
||||
|
||||
|
||||
Elixir is a dynamic, functional language designed for building scalable and maintainable applications.
|
||||
|
||||
|
||||
+12
-5
@@ -139,7 +139,12 @@ defmodule Agent do
|
||||
@typedoc "The agent state"
|
||||
@type state :: term
|
||||
|
||||
@doc false
|
||||
@doc """
|
||||
Returns a specification to start an agent under a supervisor.
|
||||
|
||||
See `Supervisor`.
|
||||
"""
|
||||
@since "1.5.0"
|
||||
def child_spec(arg) do
|
||||
%{
|
||||
id: Agent,
|
||||
@@ -149,17 +154,19 @@ defmodule Agent do
|
||||
|
||||
@doc false
|
||||
defmacro __using__(opts) do
|
||||
quote location: :keep do
|
||||
@opts unquote(opts)
|
||||
quote location: :keep, bind_quoted: [opts: opts] do
|
||||
@doc """
|
||||
Returns a specification to start this module under a supervisor.
|
||||
|
||||
@doc false
|
||||
See `Supervisor`.
|
||||
"""
|
||||
def child_spec(arg) do
|
||||
default = %{
|
||||
id: __MODULE__,
|
||||
start: {__MODULE__, :start_link, [arg]}
|
||||
}
|
||||
|
||||
Supervisor.child_spec(default, @opts)
|
||||
Supervisor.child_spec(default, unquote(Macro.escape(opts)))
|
||||
end
|
||||
|
||||
defoverridable child_spec: 1
|
||||
|
||||
@@ -79,10 +79,19 @@ defmodule Application do
|
||||
* [`:application` module](http://www.erlang.org/doc/man/application.html)
|
||||
* [Applications – OTP Design Principles](http://www.erlang.org/doc/design_principles/applications.html)
|
||||
|
||||
A developer may also implement the `stop/1` callback (automatically defined
|
||||
by `use Application`) which does any application cleanup. It receives the
|
||||
application state and can return any value. Note that shutting down the
|
||||
supervisor is automatically handled by the VM.
|
||||
When an application is shutting down, its `c:stop/1` callback is called after
|
||||
the supervision tree has been stopped by the runtime. This callback allows the
|
||||
application to do any final cleanup. The argument is the state returned by
|
||||
`c:start/2`, if it did, or `[]` otherwise. The return value of `c:stop/1` is
|
||||
ignored.
|
||||
|
||||
By using `Application`, modules get a default implementation of `c:stop/1`
|
||||
that ignores its argument and returns `:ok`, but it can be overridden.
|
||||
|
||||
Application callback modules may also implement the optional callback
|
||||
`c:prep_stop/1`. If present, `c:prep_stop/1` is invoked before the supervision
|
||||
tree is terminated. Its argument is the state returned by `c:start/2`, if it did,
|
||||
or `[]` otherwise, and its return value is passed to `c:stop/1`.
|
||||
|
||||
An application without a supervision tree doesn't define an application
|
||||
module callback in the application definition in `mix.exs` file. Even though
|
||||
@@ -185,16 +194,26 @@ defmodule Application do
|
||||
| {:ok, pid, state}
|
||||
| {:error, reason :: term}
|
||||
|
||||
@doc """
|
||||
Called before stopping the application.
|
||||
|
||||
This function is called before the top-level supervisor is terminated. It
|
||||
receives the state returned by `c:start/2`, if it did, or `[]` otherwise.
|
||||
The return value is later passed to `c:stop/1`.
|
||||
"""
|
||||
@callback prep_stop(state) :: state
|
||||
|
||||
@doc """
|
||||
Called after an application has been stopped.
|
||||
|
||||
This function is called after an application has been stopped, i.e., after its
|
||||
supervision tree has been stopped. It should do the opposite of what the
|
||||
`start/2` callback did, and should perform any necessary cleanup. The return
|
||||
`c:start/2` callback did, and should perform any necessary cleanup. The return
|
||||
value of this callback is ignored.
|
||||
|
||||
`state` is the return value of the `start/2` callback or the return value of
|
||||
the `prep_stop/1` function if the application module defines such a function.
|
||||
`state` is the state returned by `c:start/2`, if it did, or `[]` otherwise.
|
||||
If the optional callback `c:prep_stop/1` is present, `state` is its return
|
||||
value instead.
|
||||
|
||||
`use Application` defines a default implementation of this function which does
|
||||
nothing and just returns `:ok`.
|
||||
@@ -212,7 +231,7 @@ defmodule Application do
|
||||
@callback start_phase(phase :: term, start_type, phase_args :: term) ::
|
||||
:ok | {:error, reason :: term}
|
||||
|
||||
@optional_callbacks start_phase: 3
|
||||
@optional_callbacks start_phase: 3, prep_stop: 1
|
||||
|
||||
@doc false
|
||||
defmacro __using__(_) do
|
||||
|
||||
+222
-105
@@ -10,6 +10,7 @@ defmodule Code.Formatter do
|
||||
@min_line 0
|
||||
@max_line 9_999_999
|
||||
@empty empty()
|
||||
@ampersand_prec Code.Identifier.unary_op(:&) |> elem(1)
|
||||
|
||||
# Operators that do not have space between operands
|
||||
@no_space_binary_operators [:..]
|
||||
@@ -17,8 +18,8 @@ defmodule Code.Formatter do
|
||||
# Operators that do not have newline between operands (as well as => and keywords)
|
||||
@no_newline_binary_operators [:\\, :in]
|
||||
|
||||
# Left associative operators that start on the next line in case of breaks
|
||||
@left_new_line_before_binary_operators [:|>, :~>>, :<<~, :~>, :<~, :<~>, :<|>]
|
||||
# Left associative operators that start on the next line in case of breaks (always pipes)
|
||||
@pipeline_operators [:|>, :~>>, :<<~, :~>, :<~, :<~>, :<|>]
|
||||
|
||||
# Right associative operators that start on the next line in case of breaks
|
||||
@right_new_line_before_binary_operators [:|, :when]
|
||||
@@ -253,6 +254,7 @@ defmodule Code.Formatter do
|
||||
|> Keyword.get(:locals_without_parens, [])
|
||||
|> MapSet.new()
|
||||
|> MapSet.union(@locals_without_parens)
|
||||
|> MapSet.to_list()
|
||||
|
||||
%{
|
||||
locals_without_parens: locals_without_parens,
|
||||
@@ -276,7 +278,8 @@ defmodule Code.Formatter do
|
||||
defp next_eol('\r\n' ++ rest, count), do: next_eol(rest, count + 1)
|
||||
defp next_eol(_, count), do: count
|
||||
|
||||
defp previous_eol([{token, {_, _, count}} | _]) when token in [:eol, :",", :";"] and count > 0 do
|
||||
defp previous_eol([{token, {_, _, count}} | _])
|
||||
when token in [:eol, :",", :";"] and count > 0 do
|
||||
count
|
||||
end
|
||||
|
||||
@@ -324,12 +327,12 @@ defmodule Code.Formatter do
|
||||
|
||||
# Special AST nodes from compiler feedback.
|
||||
|
||||
defp quoted_to_algebra({:special, :clause_args, [args]}, _context, state) do
|
||||
defp quoted_to_algebra({{:special, :clause_args}, _meta, [args]}, _context, state) do
|
||||
{doc, state} = clause_args_to_algebra(args, state)
|
||||
{group(doc), state}
|
||||
end
|
||||
|
||||
defp quoted_to_algebra({:special, :bitstring_segment, [arg, last]}, _context, state) do
|
||||
defp quoted_to_algebra({{:special, :bitstring_segment}, _meta, [arg, last]}, _context, state) do
|
||||
bitstring_segment_to_algebra({arg, -1}, state, last)
|
||||
end
|
||||
|
||||
@@ -453,7 +456,8 @@ defmodule Code.Formatter do
|
||||
{atom_to_algebra(atom), state}
|
||||
end
|
||||
|
||||
defp quoted_to_algebra({:__block__, meta, [integer]}, _context, state) when is_integer(integer) do
|
||||
defp quoted_to_algebra({:__block__, meta, [integer]}, _context, state)
|
||||
when is_integer(integer) do
|
||||
{integer_to_algebra(Keyword.fetch!(meta, :original)), state}
|
||||
end
|
||||
|
||||
@@ -506,8 +510,15 @@ defmodule Code.Formatter do
|
||||
|
||||
# not(left in right)
|
||||
# left not in right
|
||||
defp quoted_to_algebra({:not, meta, [{:in, _, [left, right]}]}, context, state) do
|
||||
binary_op_to_algebra(:in, "not in", meta, left, right, context, state)
|
||||
defp quoted_to_algebra({:not, meta, [{:in, _, [left, right]} = arg]}, context, state) do
|
||||
%{rename_deprecated_at: since} = state
|
||||
|
||||
# TODO: Remove since check on Elixir v2.0 and the OP arrengement is removed.
|
||||
if meta[:operator] == :"not in" || (since && Version.match?(since, "~> 1.5")) do
|
||||
binary_op_to_algebra(:in, "not in", meta, left, right, context, state)
|
||||
else
|
||||
unary_op_to_algebra(:not, meta, arg, context, state)
|
||||
end
|
||||
end
|
||||
|
||||
defp quoted_to_algebra({:fn, meta, [_ | _] = clauses}, _context, state) do
|
||||
@@ -544,7 +555,16 @@ defmodule Code.Formatter do
|
||||
{left, state} =
|
||||
case left_arg do
|
||||
{:__block__, _, [atom]} when is_atom(atom) ->
|
||||
{atom |> Code.Identifier.inspect_as_key() |> string(), state}
|
||||
key =
|
||||
case Code.Identifier.classify(atom) do
|
||||
type when type in [:callable_local, :callable_operator, :not_callable] ->
|
||||
IO.iodata_to_binary([Atom.to_string(atom), ?:])
|
||||
|
||||
_ ->
|
||||
IO.iodata_to_binary([?", Atom.to_string(atom), ?", ?:])
|
||||
end
|
||||
|
||||
{string(key), state}
|
||||
|
||||
{{:., _, [:erlang, :binary_to_atom]}, _, [{:<<>>, _, entries}, :utf8]} ->
|
||||
interpolation_to_algebra(entries, @double_quote, state, "\"", "\":")
|
||||
@@ -661,23 +681,75 @@ defmodule Code.Formatter do
|
||||
# strict or flex mode around.
|
||||
defp binary_op_to_algebra(op, op_string, meta, left_arg, right_arg, context, state) do
|
||||
%{operand_nesting: nesting} = state
|
||||
binary_op_to_algebra(op, op_string, meta, left_arg, right_arg, context, state, nil, nesting)
|
||||
binary_op_to_algebra(op, op_string, meta, left_arg, right_arg, context, state, nesting)
|
||||
end
|
||||
|
||||
defp binary_op_to_algebra(
|
||||
op,
|
||||
op_string,
|
||||
meta,
|
||||
left_arg,
|
||||
right_arg,
|
||||
context,
|
||||
state,
|
||||
parent_info,
|
||||
nesting
|
||||
) do
|
||||
defp binary_op_to_algebra(op, op_string, meta, left_arg, right_arg, context, state, _nesting)
|
||||
when op in @right_new_line_before_binary_operators do
|
||||
op_info = Code.Identifier.binary_op(op)
|
||||
left_context = force_many_args_or_operand(context, :parens_arg)
|
||||
right_context = force_many_args_or_operand(context, :operand)
|
||||
op_string = op_string <> " "
|
||||
left_context = left_op_context(context)
|
||||
right_context = right_op_context(context)
|
||||
|
||||
min_line =
|
||||
case left_arg do
|
||||
{_, left_meta, _} -> line(left_meta)
|
||||
_ -> line(meta)
|
||||
end
|
||||
|
||||
{operands, max_line} =
|
||||
unwrap_right(right_arg, op, meta, right_context, [{{:root, left_context}, left_arg}])
|
||||
|
||||
operand_to_algebra = fn
|
||||
{{:root, context}, arg}, _args, newlines, state ->
|
||||
{doc, state} = binary_operand_to_algebra(arg, context, state, op, op_info, :left, 2)
|
||||
{doc, @empty, newlines, state}
|
||||
|
||||
{{kind, context}, arg}, _args, newlines, state ->
|
||||
{doc, state} = binary_operand_to_algebra(arg, context, state, op, op_info, kind, 0)
|
||||
doc = doc |> nest_by_length(op_string) |> force_keyword(arg)
|
||||
{concat(op_string, doc), @empty, newlines, state}
|
||||
end
|
||||
|
||||
operand_to_algebra_with_comments(
|
||||
operands,
|
||||
meta,
|
||||
min_line,
|
||||
max_line,
|
||||
state,
|
||||
operand_to_algebra
|
||||
)
|
||||
end
|
||||
|
||||
defp binary_op_to_algebra(op, _, meta, left_arg, right_arg, context, state, _nesting)
|
||||
when op in @pipeline_operators do
|
||||
op_info = Code.Identifier.binary_op(op)
|
||||
left_context = left_op_context(context)
|
||||
right_context = right_op_context(context)
|
||||
max_line = line(meta)
|
||||
|
||||
{pipes, min_line} =
|
||||
unwrap_pipes(left_arg, meta, left_context, [{{op, right_context}, right_arg}])
|
||||
|
||||
operand_to_algebra = fn
|
||||
{{:root, context}, arg}, _args, newlines, state ->
|
||||
{doc, state} = binary_operand_to_algebra(arg, context, state, op, op_info, :left, 2)
|
||||
{doc, @empty, newlines, state}
|
||||
|
||||
{{op, context}, arg}, _args, newlines, state ->
|
||||
op_info = Code.Identifier.binary_op(op)
|
||||
op_string = Atom.to_string(op) <> " "
|
||||
{doc, state} = binary_operand_to_algebra(arg, context, state, op, op_info, :right, 0)
|
||||
{concat(op_string, doc), @empty, newlines, state}
|
||||
end
|
||||
|
||||
operand_to_algebra_with_comments(pipes, meta, min_line, max_line, state, operand_to_algebra)
|
||||
end
|
||||
|
||||
defp binary_op_to_algebra(op, op_string, meta, left_arg, right_arg, context, state, nesting) do
|
||||
op_info = Code.Identifier.binary_op(op)
|
||||
left_context = left_op_context(context)
|
||||
right_context = right_op_context(context)
|
||||
|
||||
{left, state} =
|
||||
binary_operand_to_algebra(left_arg, left_context, state, op, op_info, :left, 2)
|
||||
@@ -694,39 +766,6 @@ defmodule Code.Formatter do
|
||||
op_string = " " <> op_string <> " "
|
||||
concat(concat(group(left), op_string), group(right))
|
||||
|
||||
op in @left_new_line_before_binary_operators ->
|
||||
op_string = op_string <> " "
|
||||
|
||||
# If the parent is of the same type (computed via same precedence),
|
||||
# we cannot group the left side yet.
|
||||
left = if op_info == parent_info, do: left, else: group(left)
|
||||
|
||||
doc = glue(left, concat(op_string, group(right)))
|
||||
if Keyword.get(meta, :eol, false), do: force_unfit(doc), else: doc
|
||||
|
||||
op in @right_new_line_before_binary_operators ->
|
||||
op_string = op_string <> " "
|
||||
|
||||
# If the parent is of the same type (computed via same precedence),
|
||||
# we need to nest the left side because of the associativity.
|
||||
left =
|
||||
if op_info == parent_info do
|
||||
nest_by_length(left, op_string)
|
||||
else
|
||||
group(left)
|
||||
end
|
||||
|
||||
# If the right side is of the same type, we will keep recursing
|
||||
# and do the nesting on the left side later on (as written above).
|
||||
right =
|
||||
case right_arg do
|
||||
{^op, _, [_, _]} -> right
|
||||
_ -> right |> nest_by_length(op_string) |> force_keyword(right_arg) |> group()
|
||||
end
|
||||
|
||||
doc = glue(left, concat(op_string, right))
|
||||
if Keyword.get(meta, :eol, false), do: force_unfit(doc), else: doc
|
||||
|
||||
true ->
|
||||
next_break_fits? =
|
||||
op in @next_break_fits_operators and next_break_fits?(right_arg, state) and
|
||||
@@ -760,10 +799,11 @@ defmodule Code.Formatter do
|
||||
end
|
||||
|
||||
defp binary_operand_to_algebra(operand, context, state, parent_op, parent_info, side, nesting) do
|
||||
{parent_assoc, parent_prec} = parent_info
|
||||
|
||||
with {op, meta, [left, right]} <- operand,
|
||||
op_info = Code.Identifier.binary_op(op),
|
||||
{_assoc, prec} <- op_info do
|
||||
{parent_assoc, parent_prec} = parent_info
|
||||
op_string = Atom.to_string(op)
|
||||
|
||||
cond do
|
||||
@@ -771,17 +811,7 @@ defmodule Code.Formatter do
|
||||
# the correct side, we respect the nesting rule to avoid multiple
|
||||
# nestings. This only applies for left associativity or same operator.
|
||||
parent_prec == prec and parent_assoc == side and (side == :left or op == parent_op) ->
|
||||
binary_op_to_algebra(
|
||||
op,
|
||||
op_string,
|
||||
meta,
|
||||
left,
|
||||
right,
|
||||
context,
|
||||
state,
|
||||
parent_info,
|
||||
nesting
|
||||
)
|
||||
binary_op_to_algebra(op, op_string, meta, left, right, context, state, nesting)
|
||||
|
||||
# If the parent requires parens or the precedence is inverted or
|
||||
# it is in the wrong side, then we *need* parenthesis.
|
||||
@@ -790,16 +820,18 @@ defmodule Code.Formatter do
|
||||
parent_op in @required_parens_logical_binary_operands) or parent_prec > prec or
|
||||
(parent_prec == prec and parent_assoc != side) ->
|
||||
{operand, state} =
|
||||
binary_op_to_algebra(op, op_string, meta, left, right, context, state, parent_info, 2)
|
||||
binary_op_to_algebra(op, op_string, meta, left, right, context, state, 2)
|
||||
|
||||
{wrap_in_parens(operand), state}
|
||||
|
||||
# Otherwise, we rely on precedence but also nest.
|
||||
true ->
|
||||
binary_op_to_algebra(op, op_string, meta, left, right, context, state, parent_info, 2)
|
||||
binary_op_to_algebra(op, op_string, meta, left, right, context, state, 2)
|
||||
end
|
||||
else
|
||||
{:&, _, [arg]} when not is_integer(arg) and side == :left ->
|
||||
{:&, _, [arg]}
|
||||
when not is_integer(arg) and side == :left
|
||||
when not is_integer(arg) and parent_assoc == :left and parent_prec > @ampersand_prec ->
|
||||
{doc, state} = quoted_to_algebra(operand, context, state)
|
||||
{wrap_in_parens(doc), state}
|
||||
|
||||
@@ -808,6 +840,45 @@ defmodule Code.Formatter do
|
||||
end
|
||||
end
|
||||
|
||||
defp unwrap_pipes({op, meta, [left, right]}, _meta, context, acc)
|
||||
when op in @pipeline_operators do
|
||||
left_context = left_op_context(context)
|
||||
right_context = right_op_context(context)
|
||||
unwrap_pipes(left, meta, left_context, [{{op, right_context}, right} | acc])
|
||||
end
|
||||
|
||||
defp unwrap_pipes(left, meta, context, acc) do
|
||||
min_line =
|
||||
case left do
|
||||
{_, meta, _} -> line(meta)
|
||||
_ -> line(meta)
|
||||
end
|
||||
|
||||
{[{{:root, context}, left} | acc], min_line}
|
||||
end
|
||||
|
||||
defp unwrap_right({op, meta, [left, right]}, op, _meta, context, acc) do
|
||||
left_context = left_op_context(context)
|
||||
right_context = right_op_context(context)
|
||||
unwrap_right(right, op, meta, right_context, [{{:left, left_context}, left} | acc])
|
||||
end
|
||||
|
||||
defp unwrap_right(right, _op, meta, context, acc) do
|
||||
acc = [{{:right, context}, right} | acc]
|
||||
{Enum.reverse(acc), line(meta)}
|
||||
end
|
||||
|
||||
defp operand_to_algebra_with_comments(operands, meta, min_line, max_line, state, fun) do
|
||||
{docs, comments?, state} =
|
||||
quoted_to_algebra_with_comments(operands, [], min_line, max_line, 1, state, fun)
|
||||
|
||||
if comments? or Keyword.get(meta, :eol, false) do
|
||||
{docs |> Enum.reduce(&line(&2, &1)) |> force_unfit(), state}
|
||||
else
|
||||
{docs |> Enum.reduce(&glue(&2, &1)), state}
|
||||
end
|
||||
end
|
||||
|
||||
## Module attributes
|
||||
|
||||
# @Foo
|
||||
@@ -908,7 +979,8 @@ defmodule Code.Formatter do
|
||||
# Mod.function()
|
||||
# var.function
|
||||
# expression.function(arguments)
|
||||
defp remote_to_algebra({{:., _, [target, fun]}, meta, args}, context, state) when is_atom(fun) do
|
||||
defp remote_to_algebra({{:., _, [target, fun]}, meta, args}, context, state)
|
||||
when is_atom(fun) do
|
||||
{target_doc, state} = remote_target_to_algebra(target, state)
|
||||
fun = remote_fun_to_algebra(target, fun, length(args), state)
|
||||
remote_doc = target_doc |> concat(".") |> concat(string(fun))
|
||||
@@ -988,7 +1060,11 @@ defmodule Code.Formatter do
|
||||
# function(arguments)
|
||||
defp local_to_algebra(fun, meta, args, context, state) when is_atom(fun) do
|
||||
skip_parens =
|
||||
if skip_parens?(fun, meta, args, state), do: :skip_unless_many_args, else: :skip_if_do_end
|
||||
cond do
|
||||
not Keyword.get(meta, :no_parens, false) -> :required
|
||||
local_without_parens?(fun, args, state) -> :skip_unless_many_args
|
||||
true -> :skip_if_do_end
|
||||
end
|
||||
|
||||
{{call_doc, state}, wrap_in_parens?} =
|
||||
call_args_to_algebra(args, meta, context, skip_parens, true, state)
|
||||
@@ -1011,7 +1087,7 @@ defmodule Code.Formatter do
|
||||
#
|
||||
defp call_args_to_algebra([], meta, _context, _parens, _list_to_keyword?, state) do
|
||||
{args_doc, _join, state} =
|
||||
args_to_algebra_with_comments([], meta, false, false, :glue, state, &{&1, &2})
|
||||
args_to_algebra_with_comments([], meta, false, :none, :glue, state, &{&1, &2})
|
||||
|
||||
{{surround("(", args_doc, ")"), state}, false}
|
||||
end
|
||||
@@ -1059,6 +1135,7 @@ defmodule Code.Formatter do
|
||||
call_args_to_algebra_with_no_parens_keywords(meta, left, right, context, extra, state)
|
||||
else
|
||||
next_break_fits? = next_break_fits?(right, state)
|
||||
last_arg_mode = if next_break_fits?, do: :next_break_fits, else: :none
|
||||
force_keyword? = keyword? and force_keyword?(right)
|
||||
non_empty_eol? = left != [] and not next_break_fits? and Keyword.get(meta, :eol, false)
|
||||
join = if generators_count > 1 or force_keyword? or non_empty_eol?, do: :line, else: :glue
|
||||
@@ -1069,12 +1146,16 @@ defmodule Code.Formatter do
|
||||
args,
|
||||
meta,
|
||||
skip_parens?,
|
||||
next_break_fits?,
|
||||
last_arg_mode,
|
||||
join,
|
||||
state,
|
||||
"ed_to_algebra(&1, context, &2)
|
||||
)
|
||||
|
||||
# If we have a single argument, then we won't have an option to break
|
||||
# before the "extra" part, so we ungroup it and build it later.
|
||||
args_doc = ungroup_if_group(args_doc)
|
||||
|
||||
doc =
|
||||
if skip_parens? do
|
||||
" "
|
||||
@@ -1101,12 +1182,12 @@ defmodule Code.Formatter do
|
||||
to_algebra_fun = "ed_to_algebra(&1, context, &2)
|
||||
|
||||
{left_doc, _join, state} =
|
||||
args_to_algebra_with_comments(left, meta, true, false, :glue, state, to_algebra_fun)
|
||||
args_to_algebra_with_comments(left, meta, true, :force_comma, :glue, state, to_algebra_fun)
|
||||
|
||||
{right_doc, _join, state} =
|
||||
args_to_algebra_with_comments(right, meta, false, false, :glue, state, to_algebra_fun)
|
||||
args_to_algebra_with_comments(right, meta, false, :none, :glue, state, to_algebra_fun)
|
||||
|
||||
right_doc = "," |> glue(right_doc) |> force_keyword(right) |> group(:inherit)
|
||||
right_doc = break() |> concat(right_doc) |> force_keyword(right) |> group(:inherit)
|
||||
|
||||
doc =
|
||||
with_next_break_fits(true, right_doc, fn right_doc ->
|
||||
@@ -1122,10 +1203,10 @@ defmodule Code.Formatter do
|
||||
{doc, state}
|
||||
end
|
||||
|
||||
defp skip_parens?(fun, meta, args, %{locals_without_parens: locals_without_parens}) do
|
||||
defp local_without_parens?(fun, args, %{locals_without_parens: locals_without_parens}) do
|
||||
length = length(args)
|
||||
|
||||
length > 0 and Keyword.get(meta, :no_parens, false) and
|
||||
length > 0 and
|
||||
Enum.any?(locals_without_parens, fn {key, val} ->
|
||||
key == fun and (val == :* or val == length)
|
||||
end)
|
||||
@@ -1189,7 +1270,8 @@ defmodule Code.Formatter do
|
||||
["\n" | entries]
|
||||
end
|
||||
|
||||
defp interpolation_to_algebra([entry | entries], escape, state, acc, last) when is_binary(entry) do
|
||||
defp interpolation_to_algebra([entry | entries], escape, state, acc, last)
|
||||
when is_binary(entry) do
|
||||
acc = concat(acc, escape_string(entry, escape))
|
||||
interpolation_to_algebra(entries, escape, state, acc, last)
|
||||
end
|
||||
@@ -1249,7 +1331,7 @@ defmodule Code.Formatter do
|
||||
{args_doc, join, state} =
|
||||
args
|
||||
|> Enum.with_index()
|
||||
|> args_to_algebra_with_comments(meta, false, false, join, state, to_algebra_fun)
|
||||
|> args_to_algebra_with_comments(meta, false, :none, join, state, to_algebra_fun)
|
||||
|
||||
if join == :flex_glue do
|
||||
{"<<" |> concat(args_doc) |> nest(2) |> concat(">>") |> group(), state}
|
||||
@@ -1259,7 +1341,7 @@ defmodule Code.Formatter do
|
||||
end
|
||||
|
||||
defp bitstring_segment_to_algebra({{:<-, meta, [left, right]}, i}, state, last) do
|
||||
left = {:special, :bitstring_segment, [left, last]}
|
||||
left = {{:special, :bitstring_segment}, meta, [left, last]}
|
||||
{doc, state} = quoted_to_algebra({:<-, meta, [left, right]}, :parens_arg, state)
|
||||
{bitstring_wrap_parens(doc, i, last), state}
|
||||
end
|
||||
@@ -1308,7 +1390,7 @@ defmodule Code.Formatter do
|
||||
fun = "ed_to_algebra(&1, :parens_arg, &2)
|
||||
|
||||
{args_doc, _join, state} =
|
||||
args_to_algebra_with_comments(args, meta, false, false, join, state, fun)
|
||||
args_to_algebra_with_comments(args, meta, false, :none, join, state, fun)
|
||||
|
||||
{surround("[", args_doc, "]"), state}
|
||||
end
|
||||
@@ -1319,7 +1401,7 @@ defmodule Code.Formatter do
|
||||
{left_doc, state} = fun.(left, state)
|
||||
|
||||
{right_doc, _join, state} =
|
||||
args_to_algebra_with_comments(right, meta, false, false, join, state, fun)
|
||||
args_to_algebra_with_comments(right, meta, false, :none, join, state, fun)
|
||||
|
||||
args_doc =
|
||||
left_doc
|
||||
@@ -1335,7 +1417,7 @@ defmodule Code.Formatter do
|
||||
fun = "ed_to_algebra(&1, :parens_arg, &2)
|
||||
|
||||
{args_doc, _join, state} =
|
||||
args_to_algebra_with_comments(args, meta, false, false, join, state, fun)
|
||||
args_to_algebra_with_comments(args, meta, false, :none, join, state, fun)
|
||||
|
||||
name_doc = "%" |> concat(name_doc) |> concat("{")
|
||||
{surround(name_doc, args_doc, "}"), state}
|
||||
@@ -1346,7 +1428,7 @@ defmodule Code.Formatter do
|
||||
fun = "ed_to_algebra(&1, :parens_arg, &2)
|
||||
|
||||
{args_doc, join, state} =
|
||||
args_to_algebra_with_comments(args, meta, false, false, join, state, fun)
|
||||
args_to_algebra_with_comments(args, meta, false, :none, join, state, fun)
|
||||
|
||||
if join == :flex_glue do
|
||||
{"{" |> concat(args_doc) |> nest(1) |> concat("}") |> group(), state}
|
||||
@@ -1456,7 +1538,7 @@ defmodule Code.Formatter do
|
||||
defp heredoc_line(["", _ | _]), do: nest(line(), :reset)
|
||||
defp heredoc_line(_), do: line()
|
||||
|
||||
defp args_to_algebra_with_comments(args, meta, skip_parens?, next_break_fits?, join, state, fun) do
|
||||
defp args_to_algebra_with_comments(args, meta, skip_parens?, last_arg_mode, join, state, fun) do
|
||||
min_line = line(meta)
|
||||
max_line = end_line(meta)
|
||||
|
||||
@@ -1464,10 +1546,11 @@ defmodule Code.Formatter do
|
||||
{doc, state} = fun.(arg, state)
|
||||
|
||||
doc =
|
||||
cond do
|
||||
args != [] -> concat(doc, ",")
|
||||
next_break_fits? -> next_break_fits(doc, :enabled)
|
||||
true -> doc
|
||||
case args do
|
||||
[_ | _] -> concat_to_last_group(doc, ",")
|
||||
[] when last_arg_mode == :force_comma -> concat_to_last_group(doc, ",")
|
||||
[] when last_arg_mode == :next_break_fits -> next_break_fits(doc, :enabled)
|
||||
[] when last_arg_mode == :none -> doc
|
||||
end
|
||||
|
||||
{doc, @empty, newlines, state}
|
||||
@@ -1530,10 +1613,16 @@ defmodule Code.Formatter do
|
||||
{args_doc, state} = clause_args_to_algebra(args, min_line, state)
|
||||
{body_doc, state} = block_to_algebra(body, min_line, max_line, state)
|
||||
|
||||
head =
|
||||
args_doc
|
||||
|> ungroup_if_group()
|
||||
|> concat(" ->")
|
||||
|> nest(:cursor)
|
||||
|> group()
|
||||
|
||||
doc =
|
||||
"fn "
|
||||
|> concat(group(nest(args_doc, :cursor)))
|
||||
|> concat(" ->")
|
||||
|> concat(head)
|
||||
|> glue(body_doc)
|
||||
|> nest(2)
|
||||
|> glue("end")
|
||||
@@ -1579,15 +1668,12 @@ defmodule Code.Formatter do
|
||||
{args_doc, state} = clause_args_to_algebra(args, min_line, state)
|
||||
{body_doc, state} = block_to_algebra(body, min_line, max_line, state)
|
||||
|
||||
clause_doc =
|
||||
" ->"
|
||||
|> glue(body_doc)
|
||||
|> nest(2)
|
||||
|
||||
doc =
|
||||
args_doc
|
||||
|> ungroup_if_group()
|
||||
|> concat(" ->")
|
||||
|> group()
|
||||
|> concat(clause_doc)
|
||||
|> concat(break() |> concat(body_doc) |> nest(2))
|
||||
|> wrap_in_parens()
|
||||
|> maybe_force_clauses(clauses)
|
||||
|> group()
|
||||
@@ -1655,7 +1741,15 @@ defmodule Code.Formatter do
|
||||
|
||||
state = %{state | operand_nesting: nesting}
|
||||
{body_doc, state} = block_to_algebra(body, min_line, end_line(meta), state)
|
||||
{concat(args_doc, " ->" |> glue(body_doc) |> nest(2)), state}
|
||||
|
||||
doc =
|
||||
args_doc
|
||||
|> ungroup_if_group()
|
||||
|> concat(" ->")
|
||||
|> group()
|
||||
|> concat(break() |> concat(body_doc) |> nest(2))
|
||||
|
||||
{doc, state}
|
||||
end
|
||||
|
||||
defp add_max_line_to_last_clause([{op, meta, args}], max_line) do
|
||||
@@ -1671,7 +1765,7 @@ defmodule Code.Formatter do
|
||||
fun = &clause_args_to_algebra/2
|
||||
|
||||
{args_docs, _join, state} =
|
||||
args_to_algebra_with_comments([args], meta, false, false, :glue, state, fun)
|
||||
args_to_algebra_with_comments([args], meta, false, :none, :glue, state, fun)
|
||||
|
||||
{args_docs, state}
|
||||
end
|
||||
@@ -1679,7 +1773,7 @@ defmodule Code.Formatter do
|
||||
# fn a, b, c when d -> e end
|
||||
defp clause_args_to_algebra([{:when, meta, args}], state) do
|
||||
{args, right} = split_last(args)
|
||||
left = {:special, :clause_args, [args]}
|
||||
left = {{:special, :clause_args}, meta, [args]}
|
||||
binary_op_to_algebra(:when, "when", meta, left, right, :no_parens_arg, state)
|
||||
end
|
||||
|
||||
@@ -1809,6 +1903,9 @@ defmodule Code.Formatter do
|
||||
|
||||
## Quoted helpers
|
||||
|
||||
defp left_op_context(context), do: force_many_args_or_operand(context, :parens_arg)
|
||||
defp right_op_context(context), do: force_many_args_or_operand(context, :operand)
|
||||
|
||||
defp force_many_args_or_operand(:no_parens_one_arg, _choice), do: :no_parens_arg
|
||||
defp force_many_args_or_operand(:parens_one_arg, _choice), do: :parens_arg
|
||||
defp force_many_args_or_operand(:no_parens_arg, _choice), do: :no_parens_arg
|
||||
@@ -1970,26 +2067,29 @@ defmodule Code.Formatter do
|
||||
)
|
||||
end
|
||||
|
||||
# A literal list is a keyword or (... -> ...)
|
||||
defp last_arg_to_keyword([_ | _] = arg, _list_to_keyword?) do
|
||||
{keyword?(arg), arg}
|
||||
end
|
||||
|
||||
# This is a list of tuples, it can be converted to keywords.
|
||||
defp last_arg_to_keyword({:__block__, _, [[_ | _] = arg]} = block, true) do
|
||||
if keyword?(arg), do: {true, arg}, else: {false, block}
|
||||
end
|
||||
|
||||
# Otherwise we don't have a keyword.
|
||||
defp last_arg_to_keyword(arg, _list_to_keyword?) do
|
||||
{false, arg}
|
||||
end
|
||||
|
||||
defp force_keyword?(keyword) do
|
||||
match?([_, _ | _], keyword) and force_keyword?(keyword, MapSet.new())
|
||||
match?([{_, _}, _ | _], keyword) and force_keyword?(keyword, MapSet.new())
|
||||
end
|
||||
|
||||
defp force_keyword?([{{_, meta, _}, _} | keyword], lines) do
|
||||
line = line(meta)
|
||||
|
||||
if line in lines do
|
||||
if MapSet.member?(lines, line) do
|
||||
false
|
||||
else
|
||||
force_keyword?(keyword, MapSet.put(lines, line))
|
||||
@@ -2034,6 +2134,23 @@ defmodule Code.Formatter do
|
||||
|
||||
## Algebra helpers
|
||||
|
||||
# Relying on the inner document is brittle and error prone.
|
||||
# It would be best if we had a mechanism to apply this.
|
||||
defp concat_to_last_group({:doc_cons, left, right}, concat) do
|
||||
{:doc_cons, left, concat_to_last_group(right, concat)}
|
||||
end
|
||||
|
||||
defp concat_to_last_group({:doc_group, group, mode}, concat) do
|
||||
{:doc_group, {:doc_cons, group, concat}, mode}
|
||||
end
|
||||
|
||||
defp concat_to_last_group(other, concat) do
|
||||
{:doc_cons, other, concat}
|
||||
end
|
||||
|
||||
defp ungroup_if_group({:doc_group, group, _mode}), do: group
|
||||
defp ungroup_if_group(other), do: other
|
||||
|
||||
defp format_to_string(doc) do
|
||||
doc |> Inspect.Algebra.format(:infinity) |> IO.iodata_to_binary()
|
||||
end
|
||||
|
||||
@@ -90,11 +90,40 @@ defimpl Collectable, for: List do
|
||||
end
|
||||
|
||||
defimpl Collectable, for: BitString do
|
||||
def into(original) do
|
||||
def into(original) when is_binary(original) do
|
||||
fun = fn
|
||||
acc, {:cont, x} when is_bitstring(x) -> [acc | x]
|
||||
acc, :done -> IO.iodata_to_binary(acc)
|
||||
_, :halt -> :ok
|
||||
acc, {:cont, x} when is_binary(x) and is_list(acc) ->
|
||||
[acc | x]
|
||||
|
||||
acc, {:cont, x} when is_bitstring(x) and is_bitstring(acc) ->
|
||||
<<acc::bitstring, x::bitstring>>
|
||||
|
||||
acc, {:cont, x} when is_bitstring(x) ->
|
||||
<<IO.iodata_to_binary(acc)::bitstring, x::bitstring>>
|
||||
|
||||
acc, :done when is_bitstring(acc) ->
|
||||
acc
|
||||
|
||||
acc, :done ->
|
||||
IO.iodata_to_binary(acc)
|
||||
|
||||
_, :halt ->
|
||||
:ok
|
||||
end
|
||||
|
||||
{[original], fun}
|
||||
end
|
||||
|
||||
def into(original) when is_bitstring(original) do
|
||||
fun = fn
|
||||
acc, {:cont, x} when is_bitstring(x) ->
|
||||
<<acc::bitstring, x::bitstring>>
|
||||
|
||||
acc, :done ->
|
||||
acc
|
||||
|
||||
_, :halt ->
|
||||
:ok
|
||||
end
|
||||
|
||||
{original, fun}
|
||||
|
||||
@@ -11,21 +11,27 @@ defmodule DynamicSupervisor do
|
||||
|
||||
## Examples
|
||||
|
||||
A dynamic supervisor is started with no children, only with the
|
||||
supervision strategy (the only strategy currently supported is
|
||||
`:one_for_one`):
|
||||
A dynamic supervisor is started with no children, often under a
|
||||
supervisor with the supervision strategy (the only strategy currently
|
||||
supported is `:one_for_one`) and a name:
|
||||
|
||||
{:ok, sup} = DynamicSupervisor.start_link(strategy: :one_for_one)
|
||||
children = [
|
||||
{DynamicSupervisor, strategy: :one_for_one, name: MyApp.DynamicSupervisor}
|
||||
]
|
||||
|
||||
Supervisor.start_link(strategy: :one_for_one)
|
||||
|
||||
The options given in the child specification are documented in `start_link/1`.
|
||||
|
||||
Once the dynamic supervisor is running, we can start children
|
||||
with `start_child/2`, which receives a child specification:
|
||||
|
||||
{:ok, agent1} = DynamicSupervisor.start_child(sup, {Agent, fn -> %{} end})
|
||||
{:ok, agent1} = DynamicSupervisor.start_child(MyApp.DynamicSupervisor, {Agent, fn -> %{} end})
|
||||
Agent.update(agent1, &Map.put(&1, :key, "value"))
|
||||
Agent.get(agent1, & &1)
|
||||
#=> %{key: "value"}
|
||||
|
||||
{:ok, agent2} = DynamicSupervisor.start_child(sup, {Agent, fn -> %{} end})
|
||||
{:ok, agent2} = DynamicSupervisor.start_child(MyApp.DynamicSupervisor, {Agent, fn -> %{} end})
|
||||
Agent.get(agent2, & &1)
|
||||
#=> %{}
|
||||
|
||||
@@ -57,6 +63,65 @@ defmodule DynamicSupervisor do
|
||||
|
||||
A supervisor is bound to the same name registration rules as a `GenServer`.
|
||||
Read more about these rules in the documentation for `GenServer`.
|
||||
|
||||
## Migrating from Supervisor's :simple_one_for_one
|
||||
|
||||
In case you were using the deprecated `:simple_one_for_one` strategy from
|
||||
the `Supervisor` module, you can migrate to the `DynamicSupervisor` in
|
||||
few steps.
|
||||
|
||||
Imagine the given "old" code:
|
||||
|
||||
defmodule MySupervisor do
|
||||
use Supervisor
|
||||
|
||||
def start_link(arg) do
|
||||
Supervisor.start_link(__MODULE__, arg, name: __MODULE__)
|
||||
end
|
||||
|
||||
def start_child(foo, bar, baz) do
|
||||
# This will start child by calling MyWorker.start_link(initial_arg, foo, bar, baz)
|
||||
Supervisor.start_child(__MODULE__, [foo, bar, baz])
|
||||
end
|
||||
|
||||
def init(initial_arg) do
|
||||
children = [
|
||||
# Or the deprecated: worker(MyWorker, [initial_arg])
|
||||
%{id: MyWorker, start: {MyWorker, :start_link, [initial_arg]})
|
||||
]
|
||||
|
||||
Supervisor.init(children, strategy: :simple_one_for_one)
|
||||
end
|
||||
end
|
||||
|
||||
It can be upgraded to the DynamicSupervisor like this:
|
||||
|
||||
defmodule MySupervisor do
|
||||
use DynamicSupervisor
|
||||
|
||||
def start_link(arg) do
|
||||
DynamicSupervisor.start_link(__MODULE__, arg, name: __MODULE__)
|
||||
end
|
||||
|
||||
def start_child(foo, bar, baz) do
|
||||
# If MyWorker is not using the new child specs, we need to pass a map:
|
||||
# spec = %{id: MyWorker, start: {MyWorker, :start_link, [foo, bar, baz]}}
|
||||
spec = {MyWorker, foo: foo, bar: bar, baz: baz}
|
||||
DynamicSupervisor.start_child(__MODULE__, spec)
|
||||
end
|
||||
|
||||
def init(initial_arg) do
|
||||
DynamicSupervisor.init(
|
||||
strategy: :one_for_one,
|
||||
extra_arguments: [initial_arg]
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
The difference is that the `DynamicSupervisor` expects the child specification
|
||||
at the moment `start_child/2` is called, and no longer on the init callback.
|
||||
If there are any initial arguments given on initialization, such as `[initial_arg]`,
|
||||
it can be given in the `:extra_arguments` flag on `DynamicSupervisor.init/1`.
|
||||
"""
|
||||
|
||||
@behaviour GenServer
|
||||
@@ -108,13 +173,30 @@ defmodule DynamicSupervisor do
|
||||
restarts: []
|
||||
]
|
||||
|
||||
@doc """
|
||||
Returns a specification to start a dynamic supervisor under a supervisor.
|
||||
|
||||
See `Supervisor`.
|
||||
"""
|
||||
@since "1.6.1"
|
||||
def child_spec(arg) do
|
||||
%{
|
||||
id: DynamicSupervisor,
|
||||
start: {DynamicSupervisor, :start_link, [arg]},
|
||||
type: :supervisor
|
||||
}
|
||||
end
|
||||
|
||||
@doc false
|
||||
defmacro __using__(opts) do
|
||||
quote location: :keep do
|
||||
quote location: :keep, bind_quoted: [opts: opts] do
|
||||
@behaviour DynamicSupervisor
|
||||
@opts unquote(opts)
|
||||
|
||||
@doc false
|
||||
@doc """
|
||||
Returns a specification to start this module under a supervisor.
|
||||
|
||||
See `Supervisor`.
|
||||
"""
|
||||
def child_spec(arg) do
|
||||
default = %{
|
||||
id: __MODULE__,
|
||||
@@ -122,7 +204,7 @@ defmodule DynamicSupervisor do
|
||||
type: :supervisor
|
||||
}
|
||||
|
||||
Supervisor.child_spec(default, @opts)
|
||||
Supervisor.child_spec(default, unquote(Macro.escape(opts)))
|
||||
end
|
||||
|
||||
defoverridable child_spec: 1
|
||||
@@ -413,7 +495,14 @@ defmodule DynamicSupervisor do
|
||||
|
||||
case mod.init(args) do
|
||||
{:ok, flags} when is_map(flags) ->
|
||||
state = %DynamicSupervisor{mod: mod, args: args, name: name || {self(), mod}}
|
||||
name =
|
||||
cond do
|
||||
is_nil(name) -> {self(), mod}
|
||||
is_atom(name) -> {:local, name}
|
||||
is_tuple(name) -> name
|
||||
end
|
||||
|
||||
state = %DynamicSupervisor{mod: mod, args: args, name: name}
|
||||
|
||||
case init(state, flags) do
|
||||
{:ok, state} -> {:ok, state}
|
||||
@@ -837,8 +926,9 @@ defmodule DynamicSupervisor do
|
||||
|
||||
defp restart_child(:one_for_one, current_pid, child, state) do
|
||||
{{m, f, args} = mfa, restart, shutdown, type, modules} = child
|
||||
%{extra_arguments: extra} = state
|
||||
|
||||
case start_child(m, f, args) do
|
||||
case start_child(m, f, extra ++ args) do
|
||||
{:ok, pid, _} ->
|
||||
state = delete_child(current_pid, state)
|
||||
{:ok, save_child(pid, mfa, restart, shutdown, type, modules, state)}
|
||||
@@ -857,21 +947,21 @@ defmodule DynamicSupervisor do
|
||||
end
|
||||
end
|
||||
|
||||
defp report_error(error, reason, pid, child, %{name: name}) do
|
||||
defp report_error(error, reason, pid, child, %{name: name, extra_arguments: extra}) do
|
||||
:error_logger.error_report(
|
||||
:supervision_report,
|
||||
:supervisor_report,
|
||||
supervisor: name,
|
||||
errorContext: error,
|
||||
reason: reason,
|
||||
offender: extract_child(pid, child)
|
||||
offender: extract_child(pid, child, extra)
|
||||
)
|
||||
end
|
||||
|
||||
defp extract_child(pid, {mfa, restart, shutdown, type, _modules}) do
|
||||
defp extract_child(pid, {{m, f, args}, restart, shutdown, type, _modules}, extra) do
|
||||
[
|
||||
pid: pid,
|
||||
id: :undefined,
|
||||
mfargs: mfa,
|
||||
mfargs: {m, f, extra ++ args},
|
||||
restart_type: restart,
|
||||
shutdown: shutdown,
|
||||
child_type: type
|
||||
|
||||
@@ -2718,10 +2718,10 @@ defmodule Enum do
|
||||
end
|
||||
|
||||
@doc """
|
||||
Zips corresponding elements from a list of enumerables
|
||||
Zips corresponding elements from a finite collection of enumerables
|
||||
into one list of tuples.
|
||||
|
||||
The zipping finishes as soon as any enumerable in the given list completes.
|
||||
The zipping finishes as soon as any enumerable in the given collection completes.
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -2733,10 +2733,11 @@ defmodule Enum do
|
||||
|
||||
"""
|
||||
@spec zip([t]) :: t
|
||||
@spec zip(t) :: t
|
||||
|
||||
def zip([]), do: []
|
||||
|
||||
def zip(enumerables) when is_list(enumerables) do
|
||||
def zip(enumerables) do
|
||||
Stream.zip(enumerables).({:cont, []}, &{:cont, [&1 | &2]})
|
||||
|> elem(1)
|
||||
|> :lists.reverse()
|
||||
|
||||
+35
-4
@@ -3,6 +3,33 @@ import Kernel, except: [round: 1]
|
||||
defmodule Float do
|
||||
@moduledoc """
|
||||
Functions for working with floating-point numbers.
|
||||
|
||||
## Kernel functions
|
||||
|
||||
There are functions related to floating-point numbers on the `Kernel` module
|
||||
too. Here is a list of them:
|
||||
|
||||
* `Kernel.round/1`: rounds a number to the nearest integer.
|
||||
* `Kernel.trunc/1`: returns the integer part of a number.
|
||||
|
||||
## Known issues
|
||||
|
||||
There are some very well known problems with floating-point numbers
|
||||
and arithmetics due to the fact most decimal fractions cannot be
|
||||
represented by a floating-point binary.
|
||||
|
||||
For example, the numbers 0.1 and 0.01 are two of them, what means the result
|
||||
of squaring 0.1 does not give 0.01 neither the closest representable. Here is
|
||||
what happens in this case:
|
||||
|
||||
* The closest representable number to 0.1 is 0.1000000014
|
||||
* The closest representable number to 0.01 is 0.0099999997
|
||||
* Doing 0.1 * 0.1 should return 0.01, but because 0.1 is actually 0.1000000014,
|
||||
the result is 0.010000000000000002, and because this is not the closest
|
||||
representable number to 0.01, you'll get the wrong result for this operation
|
||||
|
||||
There are also other known problems like flooring or rounding numbers. See
|
||||
`round/2` and `floor/2` for more details about them.
|
||||
"""
|
||||
|
||||
import Bitwise
|
||||
@@ -79,13 +106,18 @@ defmodule Float do
|
||||
defp add_dot(acc, false), do: acc <> ".0"
|
||||
|
||||
@doc """
|
||||
Rounds a float to the largest integer less than or equal to `num`.
|
||||
Rounds a float to the largest number less than or equal to `num`.
|
||||
|
||||
`floor/2` also accepts a precision to round a floating-point value down
|
||||
to an arbitrary number of fractional digits (between 0 and 15).
|
||||
The operation is performed on the binary floating point, without a
|
||||
conversion to decimal.
|
||||
|
||||
This function always returns a float. `Kernel.trunc/1` may be used instead to
|
||||
truncate the result to an integer afterwards.
|
||||
|
||||
## Known issues
|
||||
|
||||
The behaviour of `floor/2` for floats can be surprising. For example:
|
||||
|
||||
iex> Float.floor(12.52, 2)
|
||||
@@ -96,9 +128,6 @@ defmodule Float do
|
||||
and therefore the number above is internally represented as 12.51999999,
|
||||
which explains the behaviour above.
|
||||
|
||||
This function always returns a float. `Kernel.trunc/1` may be used instead to
|
||||
truncate the result to an integer afterwards.
|
||||
|
||||
## Examples
|
||||
|
||||
iex> Float.floor(34.25)
|
||||
@@ -174,6 +203,8 @@ defmodule Float do
|
||||
`Kernel.round/1` if you want a function that accepts both floats
|
||||
and integers and always returns an integer.
|
||||
|
||||
## Known issues
|
||||
|
||||
The behaviour of `round/2` for floats can be surprising. For example:
|
||||
|
||||
iex> Float.round(5.5675, 3)
|
||||
|
||||
@@ -161,7 +161,8 @@ defimpl Enumerable, for: GenEvent.Stream do
|
||||
|
||||
defp flush_events(ref) do
|
||||
receive do
|
||||
{_from, {_pid, ^ref}, {notify, _event}} when notify in [:notify, :ack_notify, :sync_notify] ->
|
||||
{_from, {_pid, ^ref}, {notify, _event}}
|
||||
when notify in [:notify, :ack_notify, :sync_notify] ->
|
||||
flush_events(ref)
|
||||
after
|
||||
0 -> :ok
|
||||
|
||||
@@ -567,18 +567,21 @@ defmodule GenServer do
|
||||
|
||||
@doc false
|
||||
defmacro __using__(opts) do
|
||||
quote location: :keep do
|
||||
quote location: :keep, bind_quoted: [opts: opts] do
|
||||
@behaviour GenServer
|
||||
@opts unquote(opts)
|
||||
|
||||
@doc false
|
||||
@doc """
|
||||
Returns a specification to start this module under a supervisor.
|
||||
|
||||
See `Supervisor`.
|
||||
"""
|
||||
def child_spec(arg) do
|
||||
default = %{
|
||||
id: __MODULE__,
|
||||
start: {__MODULE__, :start_link, [arg]}
|
||||
}
|
||||
|
||||
Supervisor.child_spec(default, @opts)
|
||||
Supervisor.child_spec(default, unquote(Macro.escape(opts)))
|
||||
end
|
||||
|
||||
defoverridable child_spec: 1
|
||||
@@ -886,7 +889,8 @@ defmodule GenServer do
|
||||
See `multi_call/4` for more information.
|
||||
"""
|
||||
@spec abcast([node], name :: atom, term) :: :abcast
|
||||
def abcast(nodes \\ [node() | Node.list()], name, request) when is_list(nodes) and is_atom(name) do
|
||||
def abcast(nodes \\ [node() | Node.list()], name, request)
|
||||
when is_list(nodes) and is_atom(name) do
|
||||
msg = cast_msg(request)
|
||||
_ = for node <- nodes, do: do_send({name, node}, msg)
|
||||
:abcast
|
||||
|
||||
@@ -934,7 +934,7 @@ defmodule Inspect.Algebra do
|
||||
do: fits?(w, k, b?, [{apply_nesting(i, k, j), m, x} | t])
|
||||
|
||||
defp fits?(w, k, b?, [{i, m, doc_cons(x, y)} | t]),
|
||||
do: fits?(w, k, b?, [{i, m, x} | [{i, m, y} | t]])
|
||||
do: fits?(w, k, b?, [{i, m, x}, {i, m, y} | t])
|
||||
|
||||
defp fits?(w, k, b?, [{i, m, doc_group(x, _)} | t]),
|
||||
do: fits?(w, k, b?, [{i, m, x} | {:tail, b?, t}])
|
||||
@@ -943,7 +943,7 @@ defmodule Inspect.Algebra do
|
||||
defp format(_, _, []), do: []
|
||||
defp format(w, k, [{_, _, :doc_nil} | t]), do: format(w, k, t)
|
||||
defp format(w, _, [{i, _, :doc_line} | t]), do: [indent(i) | format(w, i, t)]
|
||||
defp format(w, k, [{i, m, doc_cons(x, y)} | t]), do: format(w, k, [{i, m, x} | [{i, m, y} | t]])
|
||||
defp format(w, k, [{i, m, doc_cons(x, y)} | t]), do: format(w, k, [{i, m, x}, {i, m, y} | t])
|
||||
defp format(w, k, [{i, m, doc_color(x, c)} | t]), do: [ansi(c) | format(w, k, [{i, m, x} | t])]
|
||||
defp format(w, k, [{_, _, doc_string(s, l)} | t]), do: [s | format(w, k + l, t)]
|
||||
defp format(w, k, [{_, _, s} | t]) when is_binary(s), do: [s | format(w, k + byte_size(s), t)]
|
||||
|
||||
+35
-15
@@ -2709,7 +2709,10 @@ defmodule Kernel do
|
||||
case function? do
|
||||
true ->
|
||||
value =
|
||||
with {_, doc} when doc_attr? <- Module.get_attribute(env.module, name, stack), do: doc
|
||||
case Module.get_attribute(env.module, name, stack) do
|
||||
{_, doc} when doc_attr? -> doc
|
||||
other -> other
|
||||
end
|
||||
|
||||
try do
|
||||
:elixir_quote.escape(value, false)
|
||||
@@ -2722,13 +2725,21 @@ defmodule Kernel do
|
||||
{val, _} -> val
|
||||
end
|
||||
|
||||
false when doc_attr? ->
|
||||
{escaped, _} = :elixir_quote.escape(stack, false)
|
||||
|
||||
quote do
|
||||
case Module.get_attribute(__MODULE__, unquote(name), unquote(escaped)) do
|
||||
{_, doc} -> doc
|
||||
other -> other
|
||||
end
|
||||
end
|
||||
|
||||
false ->
|
||||
{escaped, _} = :elixir_quote.escape(stack, false)
|
||||
|
||||
quote do
|
||||
with {_, doc} when unquote(doc_attr?) <-
|
||||
Module.get_attribute(__MODULE__, unquote(name), unquote(escaped)),
|
||||
do: doc
|
||||
Module.get_attribute(__MODULE__, unquote(name), unquote(escaped))
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -3330,7 +3341,8 @@ defmodule Kernel do
|
||||
:lists.mapfoldl(fun, acc, list)
|
||||
end
|
||||
|
||||
defp ensure_evaled_element(elem, acc) when is_number(elem) or is_atom(elem) or is_binary(elem) do
|
||||
defp ensure_evaled_element(elem, acc)
|
||||
when is_number(elem) or is_atom(elem) or is_binary(elem) do
|
||||
{elem, acc}
|
||||
end
|
||||
|
||||
@@ -4569,25 +4581,33 @@ defmodule Kernel do
|
||||
|
||||
defp define_guard(kind, guard, env) do
|
||||
case :elixir_utils.extract_guards(guard) do
|
||||
{call, impl} when length(impl) < 2 ->
|
||||
{call, [_, _ | _]} ->
|
||||
raise ArgumentError,
|
||||
"invalid syntax in defguard #{Macro.to_string(call)}, " <>
|
||||
"only a single when clause is allowed"
|
||||
|
||||
{call, impls} ->
|
||||
case Macro.decompose_call(call) do
|
||||
{_name, args} ->
|
||||
validate_variable_only_args!(call, args)
|
||||
|
||||
quoted =
|
||||
quote do
|
||||
require Kernel.Utils
|
||||
Kernel.Utils.defguard(unquote(args), unquote(impl))
|
||||
end
|
||||
case impls do
|
||||
[] ->
|
||||
define(kind, call, nil, env)
|
||||
|
||||
define(kind, call, [do: quoted], env)
|
||||
[guard] ->
|
||||
quoted =
|
||||
quote do
|
||||
require Kernel.Utils
|
||||
Kernel.Utils.defguard(unquote(args), unquote(guard))
|
||||
end
|
||||
|
||||
define(kind, call, [do: quoted], env)
|
||||
end
|
||||
|
||||
_invalid_definition ->
|
||||
raise ArgumentError, "invalid syntax in defguard #{Macro.to_string(call)}"
|
||||
end
|
||||
|
||||
{call, _multiple_impls} ->
|
||||
raise ArgumentError, "invalid syntax in defguard #{Macro.to_string(call)}"
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -356,6 +356,7 @@ defmodule Kernel.ParallelCompiler do
|
||||
{:file_done, child_pid, file, {kind, reason, stack}} ->
|
||||
discard_down(child_pid)
|
||||
print_error(file, kind, reason, stack)
|
||||
cancel_waiting_timer(queued, child_pid)
|
||||
terminate(queued)
|
||||
{:error, [to_error(file, kind, reason, stack)], warnings}
|
||||
|
||||
|
||||
@@ -1776,19 +1776,19 @@ defmodule Kernel.SpecialForms do
|
||||
allows matching on both the *kind* of the caught value as well as the value
|
||||
itself:
|
||||
|
||||
try do
|
||||
exit(:shutdown)
|
||||
catch
|
||||
:exit, value
|
||||
IO.puts "Exited with value #{inspect(value)}"
|
||||
end
|
||||
try do
|
||||
exit(:shutdown)
|
||||
catch
|
||||
:exit, value
|
||||
IO.puts "Exited with value #{inspect(value)}"
|
||||
end
|
||||
|
||||
try do
|
||||
exit(:shutdown)
|
||||
catch
|
||||
kind, value when kind in [:exit, :throw] ->
|
||||
IO.puts "Caught exit or throw with value #{inspect(value)}"
|
||||
end
|
||||
try do
|
||||
exit(:shutdown)
|
||||
catch
|
||||
kind, value when kind in [:exit, :throw] ->
|
||||
IO.puts "Caught exit or throw with value #{inspect(value)}"
|
||||
end
|
||||
|
||||
The `catch` clause also supports `:error` alongside `:exit` and `:throw` as
|
||||
in Erlang, although this is commonly avoided in favor of `raise`/`rescue` control
|
||||
|
||||
@@ -208,9 +208,9 @@ defmodule Kernel.Utils do
|
||||
end)
|
||||
end
|
||||
|
||||
# Finds every reference to `refs` in `expr` and wraps them in an unquote.
|
||||
defp unquote_every_ref(expr, refs) do
|
||||
Macro.postwalk(expr, fn
|
||||
# Finds every reference to `refs` in `guard` and wraps them in an unquote.
|
||||
defp unquote_every_ref(guard, refs) do
|
||||
Macro.postwalk(guard, fn
|
||||
{ref, _meta, context} = var when is_atom(ref) and is_atom(context) ->
|
||||
case {ref, context} in refs do
|
||||
true -> literal_unquote(var)
|
||||
@@ -222,10 +222,10 @@ defmodule Kernel.Utils do
|
||||
end)
|
||||
end
|
||||
|
||||
# Prefaces `expr` with unquoted versions of `refs`.
|
||||
defp unquote_refs_once(expr, refs) do
|
||||
{^expr, used_refs} =
|
||||
Macro.postwalk(expr, [], fn
|
||||
# Prefaces `guard` with unquoted versions of `refs`.
|
||||
defp unquote_refs_once(guard, refs) do
|
||||
{_, used_refs} =
|
||||
Macro.postwalk(guard, [], fn
|
||||
{ref, _meta, context} = var, acc when is_atom(ref) and is_atom(context) ->
|
||||
case {ref, context} in refs and {ref, context} not in acc do
|
||||
true -> {var, [{ref, context} | acc]}
|
||||
@@ -236,14 +236,17 @@ defmodule Kernel.Utils do
|
||||
{node, acc}
|
||||
end)
|
||||
|
||||
for {ref, context} <- :lists.reverse(used_refs) do
|
||||
var = {ref, [], context}
|
||||
quote do: unquote(var) = unquote(literal_unquote(var))
|
||||
end ++ List.wrap(expr)
|
||||
vars = for {ref, context} <- :lists.reverse(used_refs), do: {ref, [], context}
|
||||
exprs = for var <- vars, do: literal_unquote(var)
|
||||
|
||||
quote do
|
||||
{unquote_splicing(vars)} = {unquote_splicing(exprs)}
|
||||
unquote(guard)
|
||||
end
|
||||
end
|
||||
|
||||
defp literal_quote(ast) do
|
||||
{:quote, [], [[do: {:__block__, [], List.wrap(ast)}]]}
|
||||
{:quote, [], [[do: ast]]}
|
||||
end
|
||||
|
||||
defp literal_unquote(ast) do
|
||||
|
||||
@@ -745,7 +745,7 @@ defmodule Macro do
|
||||
end
|
||||
|
||||
# Block keywords
|
||||
kw_keywords = [:do, :catch, :rescue, :after, :else]
|
||||
kw_keywords = [:do, :rescue, :catch, :else, :after]
|
||||
|
||||
defp kw_blocks?([{:do, _} | _] = kw) do
|
||||
Enum.all?(kw, &match?({x, _} when x in unquote(kw_keywords), &1))
|
||||
|
||||
@@ -150,7 +150,8 @@ defmodule MapSet do
|
||||
# If the first set is less than twice the size of the second map,
|
||||
# it is fastest to re-accumulate items in the first set that are not
|
||||
# present in the second set.
|
||||
def difference(%MapSet{map: map1}, %MapSet{map: map2}) when map_size(map1) < map_size(map2) * 2 do
|
||||
def difference(%MapSet{map: map1}, %MapSet{map: map2})
|
||||
when map_size(map1) < map_size(map2) * 2 do
|
||||
map =
|
||||
map1
|
||||
|> Map.keys()
|
||||
|
||||
+51
-35
@@ -297,6 +297,8 @@ defmodule Module do
|
||||
When just a module is provided, the function is assumed to be
|
||||
`__after_compile__/2`.
|
||||
|
||||
Callbacks registered first will run last.
|
||||
|
||||
#### Example
|
||||
|
||||
defmodule MyModule do
|
||||
@@ -312,13 +314,18 @@ defmodule Module do
|
||||
A hook that will be invoked before the module is compiled.
|
||||
|
||||
Accepts a module or a `{module, function_or_macro_name}` tuple. The
|
||||
function/macro must take one argument: the module environment. If it's a
|
||||
macro, its returned value will be injected at the end of the module definition
|
||||
before the compilation starts.
|
||||
function/macro must take one argument: the module environment. If
|
||||
it's a macro, its returned value will be injected at the end of the
|
||||
module definition before the compilation starts.
|
||||
|
||||
When just a module is provided, the function/macro is assumed to be
|
||||
`__before_compile__/1`.
|
||||
|
||||
Callbacks registered first will run last. Any overridable definition
|
||||
will be made concrete before the first callback runs. A definition may
|
||||
be made overridable again in another before compile callback and it
|
||||
will be made concrete one last time after after all callbacks run.
|
||||
|
||||
*Note*: unlike `@after_compile`, the callback function/macro must
|
||||
be placed in a separate module (because when the callback is invoked,
|
||||
the current module does not yet exist).
|
||||
@@ -1195,6 +1202,20 @@ defmodule Module do
|
||||
raise ArgumentError, "expected an Elixir module, got: #{inspect(original)}"
|
||||
end
|
||||
|
||||
@doc false
|
||||
# TODO: Remove in 2.0 - deprecated.
|
||||
def add_doc(module, line, kind, function_tuple, signature \\ [], doc) do
|
||||
assert_not_compiled!(:add_doc, module)
|
||||
|
||||
if kind in [:defp, :defmacrop, :typep] do
|
||||
if doc, do: {:error, :private_doc}, else: :ok
|
||||
else
|
||||
table = data_table_for(module)
|
||||
compile_doc(table, line, kind, function_tuple, signature, doc, __ENV__, false)
|
||||
:ok
|
||||
end
|
||||
end
|
||||
|
||||
@doc false
|
||||
# Used internally to compile documentation.
|
||||
# This function is private and must be used only internally.
|
||||
@@ -1205,22 +1226,17 @@ defmodule Module do
|
||||
pair = {name, arity}
|
||||
|
||||
impl = compile_impl(table, name, env, kind, args)
|
||||
compile_doc(table, pair, env, kind, args, impl)
|
||||
compile_deprecated(table, pair)
|
||||
_deprecated = compile_deprecated(table, pair)
|
||||
_since = compile_since(table)
|
||||
|
||||
# TODO: Store @since and @deprecated alongside the docs
|
||||
{line, doc} = get_doc_info(table, env)
|
||||
compile_doc(table, line, kind, pair, args, doc, env, impl)
|
||||
|
||||
:ok
|
||||
end
|
||||
|
||||
defp compile_doc(table, pair, env, kind, args, impl) do
|
||||
{line, doc} = get_doc_info(table, env, impl)
|
||||
|
||||
# TODO: Store @since alongside the docs
|
||||
_ = get_since_info(table)
|
||||
|
||||
add_doc(table, line, kind, pair, args, doc, env)
|
||||
end
|
||||
|
||||
defp add_doc(_table, line, kind, {name, arity}, _args, doc, env)
|
||||
defp compile_doc(_table, line, kind, {name, arity}, _args, doc, env, _impl)
|
||||
when kind in [:defp, :defmacrop] do
|
||||
if doc do
|
||||
error_message =
|
||||
@@ -1231,23 +1247,37 @@ defmodule Module do
|
||||
end
|
||||
end
|
||||
|
||||
defp add_doc(table, line, kind, pair, args, doc, env) do
|
||||
defp compile_doc(table, line, kind, pair, args, doc, env, impl) do
|
||||
signature = build_signature(args, env)
|
||||
|
||||
case :ets.lookup(table, {:doc, pair}) do
|
||||
[] ->
|
||||
doc = if is_nil(doc) && impl, do: false, else: doc
|
||||
:ets.insert(table, {{:doc, pair}, line, kind, signature, doc})
|
||||
|
||||
[{doc_tuple, line, _current_kind, current_sign, current_doc}] ->
|
||||
signature = merge_signatures(current_sign, signature, 1)
|
||||
doc = if is_nil(doc), do: current_doc, else: doc
|
||||
doc = if is_nil(doc) && impl, do: false, else: doc
|
||||
:ets.insert(table, {doc_tuple, line, kind, signature, doc})
|
||||
end
|
||||
end
|
||||
|
||||
defp compile_since(table) do
|
||||
case :ets.take(table, :since) do
|
||||
[{:since, since, _, _}] when is_binary(since) -> since
|
||||
_ -> nil
|
||||
end
|
||||
end
|
||||
|
||||
defp compile_deprecated(table, pair) do
|
||||
if reason = get_deprecated_info(table) do
|
||||
:ets.insert(table, {{:deprecated, pair}, reason})
|
||||
case :ets.take(table, :deprecated) do
|
||||
[{:deprecated, reason, _, _}] when is_binary(reason) ->
|
||||
:ets.insert(table, {{:deprecated, pair}, reason})
|
||||
reason
|
||||
|
||||
_ ->
|
||||
nil
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1308,7 +1338,7 @@ defmodule Module do
|
||||
|
||||
not Code.ensure_compiled?(behaviour) ->
|
||||
message =
|
||||
"module #{inspect(behaviour)} does not exist (in module #{inspect(env.module)})"
|
||||
"@behaviour #{inspect(behaviour)} does not exist (in module #{inspect(env.module)})"
|
||||
|
||||
unless standard_behaviour?(behaviour) do
|
||||
:elixir_errors.warn(env.line, env.file, message)
|
||||
@@ -1723,27 +1753,13 @@ defmodule Module do
|
||||
value
|
||||
end
|
||||
|
||||
defp get_doc_info(table, env, impl) do
|
||||
defp get_doc_info(table, env) do
|
||||
case :ets.take(table, :doc) do
|
||||
[{:doc, {_, _} = pair, _, _}] ->
|
||||
pair
|
||||
|
||||
[] when impl == false ->
|
||||
{env.line, nil}
|
||||
|
||||
[] ->
|
||||
{env.line, false}
|
||||
end
|
||||
end
|
||||
|
||||
defp get_since_info(table) do
|
||||
:ets.take(table, :since)
|
||||
end
|
||||
|
||||
defp get_deprecated_info(table) do
|
||||
case :ets.take(table, :deprecated) do
|
||||
[{:deprecated, reason, _, _}] -> reason
|
||||
[] -> nil
|
||||
{env.line, nil}
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -61,7 +61,8 @@ defmodule Module.LocalsTracker do
|
||||
@doc """
|
||||
Adds an import dispatch to the given target.
|
||||
"""
|
||||
def add_import(d, function, module, {name, arity}) when is_tuple(function) and is_atom(module) do
|
||||
def add_import(d, function, module, {name, arity})
|
||||
when is_tuple(function) and is_atom(module) do
|
||||
tuple = {:import, name, arity}
|
||||
put_edge(d, tuple, module)
|
||||
put_edge(d, function, tuple)
|
||||
|
||||
@@ -132,7 +132,7 @@ defmodule Port do
|
||||
script in bash:
|
||||
|
||||
#!/bin/sh
|
||||
"$@"
|
||||
"$@" &
|
||||
pid=$!
|
||||
while read line ; do
|
||||
:
|
||||
|
||||
@@ -317,14 +317,16 @@ defmodule Protocol do
|
||||
[
|
||||
{:abstract_code, {_raw, abstract_code}},
|
||||
{:attributes, attributes},
|
||||
{:compile_info, compile_info},
|
||||
{'ExDc', docs},
|
||||
{'ExDp', deprecated}
|
||||
{:compile_info, compile_info} | extra_chunks
|
||||
] = entries
|
||||
|
||||
extra_chunks =
|
||||
for {name, contents} when is_binary(contents) <- extra_chunks,
|
||||
do: {List.to_string(name), contents}
|
||||
|
||||
case attributes[:protocol] do
|
||||
[fallback_to_any: any] ->
|
||||
{:ok, {protocol, any, abstract_code}, {compile_info, docs, deprecated}}
|
||||
{:ok, {protocol, any, abstract_code}, {compile_info, extra_chunks}}
|
||||
|
||||
_ ->
|
||||
{:error, :not_a_protocol}
|
||||
@@ -493,15 +495,11 @@ defmodule Protocol do
|
||||
end
|
||||
|
||||
# Finally compile the module and emit its bytecode.
|
||||
defp compile(protocol, code, {compile_info, docs, deprecated}) do
|
||||
defp compile(protocol, code, {compile_info, extra_chunks}) do
|
||||
opts = Keyword.take(compile_info, [:source])
|
||||
opts = if Code.compiler_options()[:debug_info], do: [:debug_info | opts], else: opts
|
||||
{:ok, ^protocol, binary, _warnings} = :compile.forms(code, [:return | opts])
|
||||
|
||||
case docs do
|
||||
:missing_chunk -> {:ok, binary}
|
||||
_ -> {:ok, :elixir_erl.add_beam_chunks(binary, [{"ExDc", docs}, {"ExDp", deprecated}])}
|
||||
end
|
||||
{:ok, :elixir_erl.add_beam_chunks(binary, extra_chunks)}
|
||||
end
|
||||
|
||||
## Definition callbacks
|
||||
|
||||
@@ -465,7 +465,8 @@ defmodule Regex do
|
||||
end
|
||||
end
|
||||
|
||||
def split(%Regex{re_pattern: compiled}, string, opts) when is_binary(string) and is_list(opts) do
|
||||
def split(%Regex{re_pattern: compiled}, string, opts)
|
||||
when is_binary(string) and is_list(opts) do
|
||||
on = Keyword.get(opts, :on, :first)
|
||||
|
||||
case :re.run(string, compiled, [:global, capture: on]) do
|
||||
@@ -653,7 +654,8 @@ defmodule Regex do
|
||||
string
|
||||
end
|
||||
|
||||
defp apply_list(whole, string, pos, replacement, [[{mpos, _} | _] | _] = list) when mpos > pos do
|
||||
defp apply_list(whole, string, pos, replacement, [[{mpos, _} | _] | _] = list)
|
||||
when mpos > pos do
|
||||
length = mpos - pos
|
||||
<<untouched::binary-size(length), rest::binary>> = string
|
||||
[untouched | apply_list(whole, rest, mpos, replacement, list)]
|
||||
|
||||
@@ -321,7 +321,12 @@ defmodule Registry do
|
||||
start_link([keys: keys, name: name] ++ options)
|
||||
end
|
||||
|
||||
@doc false
|
||||
@doc """
|
||||
Returns a specification to start a registry under a supervisor.
|
||||
|
||||
See `Supervisor`.
|
||||
"""
|
||||
@since "1.5.0"
|
||||
def child_spec(opts) do
|
||||
%{
|
||||
id: Keyword.get(opts, :name, Registry),
|
||||
|
||||
@@ -318,11 +318,11 @@ defmodule Stream do
|
||||
|
||||
"""
|
||||
@spec drop(Enumerable.t(), non_neg_integer) :: Enumerable.t()
|
||||
def drop(enum, n) when n >= 0 do
|
||||
def drop(enum, n) when is_integer(n) and n >= 0 do
|
||||
lazy(enum, n, fn f1 -> R.drop(f1) end)
|
||||
end
|
||||
|
||||
def drop(enum, n) when n < 0 do
|
||||
def drop(enum, n) when is_integer(n) and n < 0 do
|
||||
n = abs(n)
|
||||
|
||||
lazy(enum, {0, [], []}, fn f1 ->
|
||||
@@ -1091,10 +1091,10 @@ defmodule Stream do
|
||||
def zip(left, right), do: zip([left, right])
|
||||
|
||||
@doc """
|
||||
Zips corresponding elements from a list of enumerables
|
||||
Zips corresponding elements from a finite collection of enumerables
|
||||
into one stream of tuples.
|
||||
|
||||
The zipping finishes as soon as any enumerable in the given list completes.
|
||||
The zipping finishes as soon as any enumerable in the given collection completes.
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -1105,7 +1105,12 @@ defmodule Stream do
|
||||
|
||||
"""
|
||||
@spec zip([Enumerable.t()]) :: Enumerable.t()
|
||||
def zip(enumerables) when is_list(enumerables) do
|
||||
@spec zip(Enumerable.t()) :: Enumerable.t()
|
||||
def zip(enumerables) do
|
||||
&prepare_zip(enumerables, &1, &2)
|
||||
end
|
||||
|
||||
defp prepare_zip(enumerables, acc, fun) do
|
||||
step = &do_zip_step(&1, &2)
|
||||
|
||||
enum_funs =
|
||||
@@ -1113,7 +1118,7 @@ defmodule Stream do
|
||||
{&Enumerable.reduce(enum, &1, step), :cont}
|
||||
end)
|
||||
|
||||
&do_zip(enum_funs, &1, &2)
|
||||
do_zip(enum_funs, acc, fun)
|
||||
end
|
||||
|
||||
# This implementation of do_zip/3 works for any number of
|
||||
@@ -1128,6 +1133,10 @@ defmodule Stream do
|
||||
{:suspended, acc, &do_zip(zips, &1, fun)}
|
||||
end
|
||||
|
||||
defp do_zip([], {:cont, acc}, _callback) do
|
||||
{:done, acc}
|
||||
end
|
||||
|
||||
defp do_zip(zips, {:cont, acc}, callback) do
|
||||
try do
|
||||
do_zip_next_tuple(zips, acc, callback, [], [])
|
||||
|
||||
@@ -101,13 +101,10 @@ defmodule Supervisor do
|
||||
|
||||
## Start and shutdown
|
||||
|
||||
When the supervisor starts, it traverses all children and retrieves
|
||||
each child specification. It is at this moment `{Stack, [:hello]}`
|
||||
becomes a child specification by calling `Stack.child_spec([:hello])`.
|
||||
|
||||
Then the supervisor starts each child in the order they are defined.
|
||||
This is done by calling the function defined under the `:start` key
|
||||
in the child specification and typically defaults to `start_link/1`.
|
||||
When the supervisor starts, it traverses all child specifications and
|
||||
then starts each child in the order they are defined. This is done by
|
||||
calling the function defined under the `:start` key in the child
|
||||
specification and typically defaults to `start_link/1`.
|
||||
|
||||
The `start_link/1` (or a custom) is then called for each child process.
|
||||
The `start_link/1` function must return `{:ok, pid}` where `pid` is the
|
||||
@@ -301,7 +298,9 @@ defmodule Supervisor do
|
||||
function.
|
||||
|
||||
You may also completely override the `child_spec/1` function in the Stack module
|
||||
and return your own child specification.
|
||||
and return your own child specification. Note there is no guarantee the `child_spec/1`
|
||||
function will be called by the Supervisor process, as other processes may invoke
|
||||
it to retrieve the child specification before reaching the supervisor.
|
||||
|
||||
## Exit reasons and restarts
|
||||
|
||||
@@ -446,7 +445,8 @@ defmodule Supervisor do
|
||||
has been replaced by the `DynamicSupervisor`. The `:simple_one_for_one`
|
||||
supervisor was similar to `:one_for_one` but suits better when dynamically
|
||||
attaching children. Many functions in this module behaved slightly
|
||||
differently when this strategy is used.
|
||||
differently when this strategy is used. See the `DynamicSupervisor` module
|
||||
for more information and migration strategies.
|
||||
|
||||
## Name registration
|
||||
|
||||
@@ -456,12 +456,15 @@ defmodule Supervisor do
|
||||
|
||||
@doc false
|
||||
defmacro __using__(opts) do
|
||||
quote location: :keep do
|
||||
quote location: :keep, bind_quoted: [opts: opts] do
|
||||
import Supervisor.Spec
|
||||
@behaviour Supervisor
|
||||
@opts unquote(opts)
|
||||
|
||||
@doc false
|
||||
@doc """
|
||||
Returns a specification to start this module under a supervisor.
|
||||
|
||||
See `Supervisor`.
|
||||
"""
|
||||
def child_spec(arg) do
|
||||
default = %{
|
||||
id: __MODULE__,
|
||||
@@ -469,7 +472,7 @@ defmodule Supervisor do
|
||||
type: :supervisor
|
||||
}
|
||||
|
||||
Supervisor.child_spec(default, @opts)
|
||||
Supervisor.child_spec(default, unquote(Macro.escape(opts)))
|
||||
end
|
||||
|
||||
defoverridable child_spec: 1
|
||||
@@ -760,6 +763,10 @@ defmodule Supervisor do
|
||||
name, the supported values are described in the "Name registration"
|
||||
section in the `GenServer` module docs.
|
||||
"""
|
||||
|
||||
# It is important to keep the 2-arity spec because it is a catch
|
||||
# all to start_link(children, options).
|
||||
@spec start_link(module, term) :: on_start
|
||||
@spec start_link(module, term, GenServer.options()) :: on_start
|
||||
def start_link(module, arg, options \\ []) when is_list(options) do
|
||||
case Keyword.get(options, :name) do
|
||||
|
||||
+13
-5
@@ -173,7 +173,12 @@ defmodule Task do
|
||||
|
||||
@type t :: %__MODULE__{}
|
||||
|
||||
@doc false
|
||||
@doc """
|
||||
Returns a specification to start a task under a supervisor.
|
||||
|
||||
See `Supervisor`.
|
||||
"""
|
||||
@since "1.5.0"
|
||||
def child_spec(arg) do
|
||||
%{
|
||||
id: Task,
|
||||
@@ -184,10 +189,13 @@ defmodule Task do
|
||||
|
||||
@doc false
|
||||
defmacro __using__(opts) do
|
||||
quote location: :keep do
|
||||
@opts unquote(opts)
|
||||
quote location: :keep, bind_quoted: [opts: opts] do
|
||||
@doc """
|
||||
Returns a specification to start this module under a supervisor.
|
||||
|
||||
@doc false
|
||||
See `Supervisor`.
|
||||
"""
|
||||
@since "1.5.0"
|
||||
def child_spec(arg) do
|
||||
default = %{
|
||||
id: __MODULE__,
|
||||
@@ -195,7 +203,7 @@ defmodule Task do
|
||||
restart: :temporary
|
||||
}
|
||||
|
||||
Supervisor.child_spec(default, @opts)
|
||||
Supervisor.child_spec(default, unquote(Macro.escape(opts)))
|
||||
end
|
||||
|
||||
defoverridable child_spec: 1
|
||||
|
||||
@@ -5,8 +5,18 @@ defmodule Task.Supervisor do
|
||||
This module defines a supervisor which can be used to dynamically
|
||||
supervise tasks.
|
||||
|
||||
`start_link/1` can be used to start the supervisor. See the `Task`
|
||||
module for more examples.
|
||||
A task supervisor is started with no children, often under a
|
||||
supervisor and a name:
|
||||
|
||||
children = [
|
||||
{Task.Supervisor, name: MyApp.TaskSupervisor}
|
||||
]
|
||||
|
||||
Supervisor.start_link(strategy: :one_for_one)
|
||||
|
||||
The options given in the child specification are documented in `start_link/1`.
|
||||
|
||||
See the `Task` module for more examples.
|
||||
|
||||
## Name registration
|
||||
|
||||
@@ -32,17 +42,33 @@ defmodule Task.Supervisor do
|
||||
@doc """
|
||||
Starts a new supervisor.
|
||||
|
||||
The supported options are:
|
||||
## Examples
|
||||
|
||||
A task supervisor is typically started under a supervision tree using
|
||||
the tuple format:
|
||||
|
||||
{Task.Supervisor, name: MyApp.TaskSupervisor}
|
||||
|
||||
You can also start it by calling `start_link/1` directly:
|
||||
|
||||
Task.Supervisor.start_link(name: MyApp.TaskSupervisor)
|
||||
|
||||
But this is recommended only for scripting and should be avoided in
|
||||
production code. Generally speaking, processes should always be started
|
||||
inside supervision trees.
|
||||
|
||||
## Options
|
||||
|
||||
* `:name` - used to register a supervisor name, the supported values are
|
||||
described under the `Name Registration` section in the `GenServer` module
|
||||
docs;
|
||||
|
||||
* `:max_restarts`, `:max_seconds` and `:max_children` - as specified in `DynamicSupervisor`;
|
||||
* `:max_restarts`, `:max_seconds` and `:max_children` - as specified in
|
||||
`DynamicSupervisor`;
|
||||
|
||||
This function could also receive `:restart` and `:shutdown` as options
|
||||
but those two options have been deprecated and it is now preferred to
|
||||
give them directly to `start_child` and `async` when supported.
|
||||
give them directly to `start_child` and `async`.
|
||||
"""
|
||||
@spec start_link([option]) :: Supervisor.on_start()
|
||||
# TODO: Deprecate passing restart and shutdown here on Elixir v1.8.
|
||||
|
||||
@@ -2,9 +2,9 @@ defmodule Tuple do
|
||||
@moduledoc """
|
||||
Functions for working with tuples.
|
||||
|
||||
Tuples are ordered collections of elements. Tuples can contain elements
|
||||
of any type, and a tuple can contain elements of different types. Curly
|
||||
braces can be used to create tuples:
|
||||
Tuples are composite data types with a fixed number of elements. Tuples
|
||||
can contain elements of any type, and a tuple can contain elements of
|
||||
different types. Curly braces can be used to create tuples:
|
||||
|
||||
iex> {}
|
||||
{}
|
||||
|
||||
@@ -35,6 +35,7 @@ Deprecated feature | Deprecated in | Replaced by (
|
||||
`Enum.partition/2` | [v1.6] | `Enum.split_with/2` (v1.4)
|
||||
`Keyword.replace/3` | [v1.6] | Use `Keyword.fetch/2` + `Keyword.put/3` (v1.0)
|
||||
`Macro.unescape_tokens/1` and `Macro.unescape_tokens/2` | [v1.6] | Use `Enum.map/2` to traverse over the arguments (v1.0)
|
||||
`Module.add_doc/6` | [v1.6] | Use `@doc` instead
|
||||
`Map.replace/3` | [v1.6] | Use `Map.fetch/2` + `Map.put/3` (v1.0)
|
||||
`Range.range?/1` | [v1.6] | Pattern match on `_.._` instead (v1.0)
|
||||
`Atom.to_char_list/1` | [v1.5] | `Atom.to_charlist/1` (v1.3)
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
# Guards
|
||||
|
||||
Guards are a way to augment pattern matching with more complex checks; they are allowed in a predefined set of constructs where pattern matching is allowed.
|
||||
Guards are a way to augment pattern matching with more complex checks. They are allowed in a predefined set of constructs where pattern matching is allowed.
|
||||
|
||||
Not all expressions are allowed in guard clauses, but only a handful of them. This is a deliberate choice. This way, Elixir (and Erlang) can make sure that nothing bad happens while executing guards and no mutations happen anywhere. It also allows the compiler to optimize the code related to guards efficiently.
|
||||
|
||||
## List of allowed expressions
|
||||
|
||||
@@ -100,11 +102,15 @@ In the example above, we show how guards can be used in function clauses. There
|
||||
end
|
||||
```
|
||||
|
||||
* custom guards can also be defined with `Kernel.defguard/1` and `Kernel.defguardp/1`.
|
||||
A custom guard is always defined based on existing guards.
|
||||
|
||||
Other constructs are `for`, `with`, `try`/`rescue`/`catch`/`else`/, and the `match?/2` macro in the `Kernel` module.
|
||||
|
||||
## Failing guards
|
||||
|
||||
Errors in guards do not result in runtime errors, but in guards failing. For example, the `length/1` function only works with lists. If we use it with anything else, a runtime error is raised:
|
||||
In guards, when functions would normally raise exceptions, they cause the guard to fail instead.
|
||||
For example, the `length/1` function only works with lists. If we use it with anything else, a runtime error is raised:
|
||||
|
||||
```elixir
|
||||
iex> length("hello")
|
||||
@@ -125,10 +131,6 @@ iex> case "hello" do
|
||||
|
||||
In many cases, we can take advantage of this. In the code above, we used `length/1` to both check that the given thing is a list *and* check some properties of its length (instead of using `is_list(something) and length(something) > 0`).
|
||||
|
||||
## Expressions in guard clauses
|
||||
|
||||
Not all expressions are allowed in guard clauses, but only a handful of them. This is a deliberate choice: only a predefined set of side-effect-free functions are allowed. This way, Elixir (and Erlang) can make sure that nothing bad happens while executing guards and no mutations happen anywhere. This behaviour is also coherent with pattern match, which is a naturally a side-effect-free operation. Finally, keeping expressions allowed in clauses to a close set of predefined ones allows the compiler to optimize the code related to choosing the right clause.
|
||||
|
||||
## Defining custom guard expressions
|
||||
|
||||
As mentioned before, only the expressions listed in this page are allowed in guards. However, we can take advantage of macros to write custom guards that can simplify our programs or make them more domain-specific. At the end of the day, what matters is that the *output* of the macros (which is what will be compiled) boils down to a combinations of the allowed expressions.
|
||||
@@ -165,6 +167,14 @@ def my_function(number) when is_even(number) do
|
||||
end
|
||||
```
|
||||
|
||||
While it's possible to create custom guards with macros, it's recommended to define them using `defguard` and `defguardp` which perform additional compile-time checks. Here's an example:
|
||||
|
||||
```elixir
|
||||
defmodule MyInteger do
|
||||
defguard is_even(value) when is_integer(value) and rem(value, 2) == 0
|
||||
end
|
||||
```
|
||||
|
||||
## Multiple guards in the same clause
|
||||
|
||||
There exists an additional way to simplify a chain of `or`s in guards: Elixir supports writing "multiple guards" in the same clause. This:
|
||||
|
||||
@@ -26,7 +26,7 @@ Operator
|
||||
`\|` | Right to left
|
||||
`::` | Right to left
|
||||
`when` | Right to left
|
||||
`<-`, `\\` | Left to right
|
||||
`<-` `\\` | Left to right
|
||||
|
||||
## Comparison operators
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{application, elixir,
|
||||
[{description, "elixir"},
|
||||
{vsn, "1.6.0"},
|
||||
{vsn, "1.6.4"},
|
||||
{modules, [
|
||||
elixir
|
||||
]},
|
||||
|
||||
@@ -190,12 +190,15 @@ run_with_location_change(File, E, Callback) ->
|
||||
def_to_clauses(_Kind, Meta, Args, [], nil, E) ->
|
||||
check_args_for_bodiless_clause(Meta, Args, E),
|
||||
[];
|
||||
def_to_clauses(Kind, Meta, _Args, _Guards, nil, E) ->
|
||||
elixir_errors:form_error(Meta, ?key(E, file), elixir_expand, {missing_option, Kind, [do]});
|
||||
def_to_clauses(_Kind, Meta, Args, Guards, [{do, Body}], _E) ->
|
||||
[{Meta, Args, Guards, Body}];
|
||||
def_to_clauses(Kind, Meta, Args, Guards, Body, _E) ->
|
||||
[{Meta, Args, Guards, {'try', [{origin, Kind} | Meta], [Body]}}].
|
||||
def_to_clauses(Kind, Meta, Args, Guards, Body, E) ->
|
||||
case is_list(Body) andalso lists:keyfind(do, 1, Body) of
|
||||
{do, _} ->
|
||||
[{Meta, Args, Guards, {'try', [{origin, Kind} | Meta], [Body]}}];
|
||||
false ->
|
||||
elixir_errors:form_error(Meta, ?key(E, file), elixir_expand, {missing_option, Kind, [do]})
|
||||
end.
|
||||
|
||||
run_on_definition_callbacks(Kind, Module, Name, Args, Guards, Body, E) ->
|
||||
Callbacks = ets:lookup_element(elixir_module:data_table(Module), on_definition, 2),
|
||||
|
||||
@@ -397,6 +397,10 @@ deprecation('Elixir.Macro', unescape_tokens, 1) ->
|
||||
"instead traverse over the arguments using Enum.map/2";
|
||||
deprecation('Elixir.Macro', unescape_tokens, 2) ->
|
||||
"instead traverse over the arguments using Enum.map/2";
|
||||
deprecation('Elixir.Module', add_doc, 5) ->
|
||||
"use @doc instead";
|
||||
deprecation('Elixir.Module', add_doc, 6) ->
|
||||
"use @doc instead";
|
||||
deprecation('Elixir.Range', 'range?', 1) ->
|
||||
"instead pattern match on left..right";
|
||||
deprecation('Elixir.Stream', filter_map, 3) ->
|
||||
|
||||
@@ -3,20 +3,14 @@
|
||||
-include("elixir.hrl").
|
||||
|
||||
translate(Meta, Args, Return, S) ->
|
||||
{AccName, _, SA} = elixir_erl_var:build('_', S),
|
||||
{VarName, _, SV} = elixir_erl_var:build('_', SA),
|
||||
|
||||
Ann = ?ann(Meta),
|
||||
Acc = {var, Ann, AccName},
|
||||
Var = {var, Ann, VarName},
|
||||
|
||||
{Cases, [{do, Expr} | Opts]} = elixir_utils:split_last(Args),
|
||||
|
||||
{TInto, SI} =
|
||||
case lists:keyfind(into, 1, Opts) of
|
||||
{into, Into} -> elixir_erl_pass:translate(Into, SV);
|
||||
false when Return -> {{nil, Ann}, SV};
|
||||
false -> {false, SV}
|
||||
{into, Into} -> elixir_erl_pass:translate(Into, S);
|
||||
false when Return -> {{nil, Ann}, S};
|
||||
false -> {false, S}
|
||||
end,
|
||||
|
||||
TUniq = lists:keyfind(uniq, 1, Opts) == {uniq, true},
|
||||
@@ -27,9 +21,9 @@ translate(Meta, Args, Return, S) ->
|
||||
|
||||
case comprehension_expr(TInto, TExpr) of
|
||||
{inline, TIntoExpr} ->
|
||||
{build_inline(Ann, TCases, TIntoExpr, TInto, TUniq, Var, Acc, SF), SF};
|
||||
build_inline(Ann, TCases, TIntoExpr, TInto, TUniq, SF);
|
||||
{into, TIntoExpr} ->
|
||||
build_into(Ann, TCases, TIntoExpr, TInto, TUniq, Var, Acc, SF)
|
||||
build_into(Ann, TCases, TIntoExpr, TInto, TUniq, SF)
|
||||
end.
|
||||
|
||||
%% In case we have no return, we wrap the expression
|
||||
@@ -95,30 +89,71 @@ collect_filters([], Acc) ->
|
||||
{Acc, []}.
|
||||
|
||||
|
||||
build_inline(Ann, Clauses, Expr, Into, Uniq, _Var, Acc, S) ->
|
||||
build_inline(Ann, Clauses, Expr, Into, Uniq, S) ->
|
||||
case not Uniq and lists:all(fun(Clause) -> element(1, Clause) == bin end, Clauses) of
|
||||
true -> build_comprehension(Ann, Clauses, Expr, Into);
|
||||
false -> build_inline(Ann, Clauses, Expr, Into, Uniq, Acc, S)
|
||||
true -> {build_comprehension(Ann, Clauses, Expr, Into), S};
|
||||
false -> build_inline_each(Ann, Clauses, Expr, Into, Uniq, S)
|
||||
end.
|
||||
|
||||
build_inline(Ann, Clauses, Expr, false, Uniq, Acc, S) ->
|
||||
build_inline_each(Ann, Clauses, Expr, false, Uniq, S) ->
|
||||
InnerFun = fun(InnerExpr, _InnerAcc) -> InnerExpr end,
|
||||
build_reduce(Ann, Clauses, InnerFun, Expr, {nil, Ann}, Uniq, Acc, S);
|
||||
build_inline(Ann, Clauses, Expr, {nil, _} = Into, Uniq, Acc, S) ->
|
||||
{build_reduce(Ann, Clauses, InnerFun, Expr, {nil, Ann}, Uniq, S), S};
|
||||
build_inline_each(Ann, Clauses, Expr, {nil, _} = Into, Uniq, S) ->
|
||||
InnerFun = fun(InnerExpr, InnerAcc) -> {cons, Ann, InnerExpr, InnerAcc} end,
|
||||
ReduceExpr = build_reduce(Ann, Clauses, InnerFun, Expr, Into, Uniq, Acc, S),
|
||||
elixir_erl:remote(Ann, lists, reverse, [ReduceExpr]);
|
||||
build_inline(Ann, Clauses, Expr, {bin, _, _} = Into, Uniq, Acc, S) ->
|
||||
InnerFun = fun(InnerExpr, InnerAcc) -> {cons, Ann, InnerAcc, InnerExpr} end,
|
||||
ReduceExpr = build_reduce(Ann, Clauses, InnerFun, Expr, Into, Uniq, Acc, S),
|
||||
elixir_erl:remote(Ann, erlang, iolist_to_binary, [ReduceExpr]).
|
||||
ReduceExpr = build_reduce(Ann, Clauses, InnerFun, Expr, Into, Uniq, S),
|
||||
{elixir_erl:remote(Ann, lists, reverse, [ReduceExpr]), S};
|
||||
build_inline_each(Ann, Clauses, Expr, {bin, _, []}, Uniq, S) ->
|
||||
{InnerValue, SV} = build_var(Ann, S),
|
||||
|
||||
build_into(Ann, Clauses, Expr, {map, _, []}, Uniq, _Var, Acc, S) ->
|
||||
ReduceExpr = build_inline(Ann, Clauses, Expr, {nil, Ann}, Uniq, Acc, S),
|
||||
{elixir_erl:remote(Ann, maps, from_list, [ReduceExpr]), S};
|
||||
InnerFun = fun(InnerExpr, InnerAcc) ->
|
||||
{'case', Ann, InnerExpr, [
|
||||
{clause, Ann,
|
||||
[InnerValue],
|
||||
[[elixir_erl:remote(Ann, erlang, is_binary, [InnerValue]),
|
||||
elixir_erl:remote(Ann, erlang, is_list, [InnerAcc])]],
|
||||
[{cons, Ann, InnerAcc, InnerValue}]},
|
||||
{clause, Ann,
|
||||
[InnerValue],
|
||||
[[elixir_erl:remote(Ann, erlang, is_bitstring, [InnerValue]),
|
||||
elixir_erl:remote(Ann, erlang, is_bitstring, [InnerAcc])]],
|
||||
[{bin, Ann, [
|
||||
{bin_element, Ann, InnerAcc, default, [bitstring]},
|
||||
{bin_element, Ann, InnerValue, default, [bitstring]}
|
||||
]}]},
|
||||
{clause, Ann,
|
||||
[InnerValue],
|
||||
[[elixir_erl:remote(Ann, erlang, is_bitstring, [InnerValue])]],
|
||||
[{bin, Ann, [
|
||||
{bin_element, Ann, elixir_erl:remote(Ann, erlang, iolist_to_binary, [InnerAcc]), default, [bitstring]},
|
||||
{bin_element, Ann, InnerValue, default, [bitstring]}
|
||||
]}]},
|
||||
{clause, Ann,
|
||||
[InnerValue],
|
||||
[],
|
||||
[elixir_erl:remote(Ann, erlang, error, [{tuple, Ann, [{atom, Ann, badarg}, InnerValue]}])]}
|
||||
]}
|
||||
end,
|
||||
|
||||
build_into(Ann, Clauses, Expr, Into, Uniq, Fun, Acc, S) ->
|
||||
{Kind, SK} = build_var(Ann, S),
|
||||
ReduceExpr = build_reduce(Ann, Clauses, InnerFun, Expr, {nil, Ann}, Uniq, SV),
|
||||
|
||||
{{'case', Ann, ReduceExpr, [
|
||||
{clause, Ann,
|
||||
[InnerValue],
|
||||
[[elixir_erl:remote(Ann, erlang, is_bitstring, [InnerValue])]],
|
||||
[InnerValue]},
|
||||
{clause, Ann,
|
||||
[InnerValue],
|
||||
[],
|
||||
[elixir_erl:remote(Ann, erlang, iolist_to_binary, [InnerValue])]}
|
||||
]}, SV}.
|
||||
|
||||
build_into(Ann, Clauses, Expr, {map, _, []}, Uniq, S) ->
|
||||
{ReduceExpr, SR} = build_inline_each(Ann, Clauses, Expr, {nil, Ann}, Uniq, S),
|
||||
{elixir_erl:remote(Ann, maps, from_list, [ReduceExpr]), SR};
|
||||
build_into(Ann, Clauses, Expr, Into, Uniq, S) ->
|
||||
{Fun, SF} = build_var(Ann, S),
|
||||
{Acc, SA} = build_var(Ann, SF),
|
||||
{Kind, SK} = build_var(Ann, SA),
|
||||
{Reason, SR} = build_var(Ann, SK),
|
||||
{Stack, ST} = build_var(Ann, SR),
|
||||
{Done, SD} = build_var(Ann, ST),
|
||||
@@ -132,7 +167,7 @@ build_into(Ann, Clauses, Expr, Into, Uniq, Fun, Acc, S) ->
|
||||
elixir_erl:remote(Ann, 'Elixir.Collectable', into, [Into])
|
||||
},
|
||||
|
||||
IntoReduceExpr = build_reduce(Ann, Clauses, InnerFun, Expr, Acc, Uniq, Acc, SD),
|
||||
IntoReduceExpr = build_reduce(Ann, Clauses, InnerFun, Expr, Acc, Uniq, SD),
|
||||
|
||||
TryExpr =
|
||||
{'try', Ann,
|
||||
@@ -153,12 +188,14 @@ build_into(Ann, Clauses, Expr, Into, Uniq, Fun, Acc, S) ->
|
||||
|
||||
%% Helpers
|
||||
|
||||
build_reduce(_Ann, Clauses, InnerFun, Expr, Into, false, Acc, S) ->
|
||||
build_reduce_each(Clauses, InnerFun(Expr, Acc), Into, Acc, S);
|
||||
build_reduce(Ann, Clauses, InnerFun, Expr, Into, true, Acc, S) ->
|
||||
build_reduce(Ann, Clauses, InnerFun, Expr, Into, false, S) ->
|
||||
{Acc, SA} = build_var(Ann, S),
|
||||
build_reduce_each(Clauses, InnerFun(Expr, Acc), Into, Acc, SA);
|
||||
build_reduce(Ann, Clauses, InnerFun, Expr, Into, true, S) ->
|
||||
%% Those variables are used only inside the anonymous function
|
||||
%% so we don't need to worry about returning the scope.
|
||||
{Value, SV} = build_var(Ann, S),
|
||||
{Acc, SA} = build_var(Ann, S),
|
||||
{Value, SV} = build_var(Ann, SA),
|
||||
{IntoAcc, SI} = build_var(Ann, SV),
|
||||
{UniqAcc, SU} = build_var(Ann, SI),
|
||||
|
||||
@@ -302,12 +339,12 @@ join_filter(Ann, {nil, Filter}, True, False) ->
|
||||
{clause, Ann, [{atom, Ann, false}], [], [False]}
|
||||
]};
|
||||
join_filter(Ann, {Var, Filter}, True, False) ->
|
||||
Guard =
|
||||
{op, Ann, 'orelse',
|
||||
{op, Ann, '==', Var, {atom, Ann, false}},
|
||||
{op, Ann, '==', Var, {atom, Ann, nil}}},
|
||||
Guards = [
|
||||
[{op, Ann, '==', Var, {atom, Ann, false}}],
|
||||
[{op, Ann, '==', Var, {atom, Ann, nil}}]
|
||||
],
|
||||
|
||||
{'case', Ann, Filter, [
|
||||
{clause, Ann, [Var], [[Guard]], [False]},
|
||||
{clause, Ann, [Var], Guards, [False]},
|
||||
{clause, Ann, [{var, Ann, '_'}], [], [True]}
|
||||
]}.
|
||||
|
||||
@@ -688,7 +688,13 @@ build_op({_Kind, Location, 'in'}, {UOp, _, [Left]}, Right) when ?rearrange_uop(U
|
||||
{UOp, meta_from_location(Location), [{'in', meta_from_location(Location), [Left, Right]}]};
|
||||
|
||||
build_op({_Kind, Location, 'not in'}, Left, Right) ->
|
||||
{'not', meta_from_location(Location), [{'in', meta_from_location(Location), [Left, Right]}]};
|
||||
InMeta = meta_from_location(Location),
|
||||
NotMeta =
|
||||
case ?formatter_metadata() of
|
||||
true -> [{operator, 'not in'} | InMeta];
|
||||
false -> InMeta
|
||||
end,
|
||||
{'not', NotMeta, [{'in', InMeta, [Left, Right]}]};
|
||||
build_op({_Kind, Location, Op}, Left, Right) ->
|
||||
{Op, eol_op(Location) ++ meta_from_location(Location), [Left, Right]}.
|
||||
|
||||
|
||||
@@ -473,6 +473,10 @@ tokenize("\r\n" ++ Rest, Line, Column, Scope, Tokens) ->
|
||||
|
||||
% Others
|
||||
|
||||
tokenize([$%, $[ | Rest], Line, _Column, _Scope, Tokens) ->
|
||||
Reason = {Line, "expected %{ to define a map, got: ", [$%, $[]},
|
||||
{error, Reason, Rest, Tokens};
|
||||
|
||||
tokenize([$%, ${ | T], Line, Column, Scope, Tokens) ->
|
||||
tokenize([${ | T], Line, Column + 1, Scope, [{'%{}', {Line, Column, nil}} | Tokens]);
|
||||
|
||||
|
||||
@@ -201,6 +201,21 @@ defmodule Code.Formatter.CallsTest do
|
||||
assert_format bad, good, @short_length
|
||||
end
|
||||
|
||||
test "with arguments on comma limit" do
|
||||
bad = """
|
||||
import(foo(abc, cde), :next)
|
||||
"""
|
||||
|
||||
good = """
|
||||
import(
|
||||
foo(abc, cde),
|
||||
:next
|
||||
)
|
||||
"""
|
||||
|
||||
assert_format bad, good, @medium_length
|
||||
end
|
||||
|
||||
test "with keyword lists" do
|
||||
assert_same "foo(foo: 1, bar: 2)"
|
||||
|
||||
@@ -263,6 +278,22 @@ defmodule Code.Formatter.CallsTest do
|
||||
assert_format bad, good, @short_length
|
||||
end
|
||||
|
||||
test "without parens on comma limit" do
|
||||
bad = """
|
||||
import foo(abc, cde), :next
|
||||
"""
|
||||
|
||||
good = """
|
||||
import foo(
|
||||
abc,
|
||||
cde
|
||||
),
|
||||
:next
|
||||
"""
|
||||
|
||||
assert_format bad, good, @medium_length
|
||||
end
|
||||
|
||||
test "without parens and with keyword lists preserves multiline" do
|
||||
assert_same """
|
||||
defstruct foo: 1,
|
||||
@@ -276,6 +307,22 @@ defmodule Code.Formatter.CallsTest do
|
||||
"""
|
||||
end
|
||||
|
||||
test "without parens and with keyword lists on comma limit" do
|
||||
bad = """
|
||||
import foo(abc, cde), opts: :next
|
||||
"""
|
||||
|
||||
good = """
|
||||
import foo(
|
||||
abc,
|
||||
cde
|
||||
),
|
||||
opts: :next
|
||||
"""
|
||||
|
||||
assert_format bad, good, @medium_length
|
||||
end
|
||||
|
||||
test "without parens and with keyword lists on line limit" do
|
||||
assert_same "import :atom, opts: [foo: :bar]"
|
||||
|
||||
@@ -434,9 +481,32 @@ defmodule Code.Formatter.CallsTest do
|
||||
)
|
||||
"""
|
||||
|
||||
assert_same """
|
||||
call(
|
||||
:hello,
|
||||
:foo,
|
||||
:bar
|
||||
) do
|
||||
1 + 2
|
||||
end
|
||||
"""
|
||||
|
||||
# Doesn't preserve this because only the beginning has a newline
|
||||
assert_format "call(\nfoo, bar, baz)", "call(foo, bar, baz)"
|
||||
|
||||
# Doesn't preserve because there are no args
|
||||
bad = """
|
||||
call() do
|
||||
1 + 2
|
||||
end
|
||||
"""
|
||||
|
||||
assert_format bad, """
|
||||
call do
|
||||
1 + 2
|
||||
end
|
||||
"""
|
||||
|
||||
# Doesn't preserve because we have a single argument with next break fits
|
||||
bad = """
|
||||
call(
|
||||
|
||||
@@ -56,36 +56,19 @@ defmodule Code.Formatter.CommentsTest do
|
||||
|
||||
assert_format bad, good
|
||||
|
||||
bad = """
|
||||
foo # this is foo
|
||||
|> bar # this is bar
|
||||
|> baz # this is baz
|
||||
"""
|
||||
|
||||
good = """
|
||||
# this is foo
|
||||
# this is bar
|
||||
# this is baz
|
||||
foo
|
||||
|> bar
|
||||
|> baz
|
||||
"""
|
||||
|
||||
assert_format bad, good, @short_length
|
||||
|
||||
bad = """
|
||||
foo # this is foo
|
||||
| bar # this is bar
|
||||
| baz # this is baz
|
||||
++ bar # this is bar
|
||||
++ baz # this is baz
|
||||
"""
|
||||
|
||||
good = """
|
||||
# this is foo
|
||||
# this is bar
|
||||
# this is baz
|
||||
foo
|
||||
| bar
|
||||
| baz
|
||||
foo ++
|
||||
bar ++
|
||||
baz
|
||||
"""
|
||||
|
||||
assert_format bad, good, @short_length
|
||||
@@ -721,6 +704,118 @@ defmodule Code.Formatter.CommentsTest do
|
||||
end
|
||||
end
|
||||
|
||||
describe "operators" do
|
||||
test "with comment before, during and after uniform pipelines" do
|
||||
assert_same """
|
||||
foo
|
||||
# |> bar
|
||||
# |> baz
|
||||
|> bat
|
||||
"""
|
||||
|
||||
bad = """
|
||||
# before
|
||||
foo # this is foo
|
||||
|> bar # this is bar
|
||||
|> baz # this is baz
|
||||
# after
|
||||
"""
|
||||
|
||||
good = """
|
||||
# before
|
||||
# this is foo
|
||||
foo
|
||||
# this is bar
|
||||
|> bar
|
||||
# this is baz
|
||||
|> baz
|
||||
|
||||
# after
|
||||
"""
|
||||
|
||||
assert_format bad, good, @short_length
|
||||
end
|
||||
|
||||
test "with comment before, during and after mixed pipelines" do
|
||||
assert_same """
|
||||
foo
|
||||
# |> bar
|
||||
# |> baz
|
||||
~> bat
|
||||
"""
|
||||
|
||||
bad = """
|
||||
# before
|
||||
foo # this is foo
|
||||
~> bar # this is bar
|
||||
<|> baz # this is baz
|
||||
# after
|
||||
"""
|
||||
|
||||
good = """
|
||||
# before
|
||||
# this is foo
|
||||
foo
|
||||
# this is bar
|
||||
~> bar
|
||||
# this is baz
|
||||
<|> baz
|
||||
|
||||
# after
|
||||
"""
|
||||
|
||||
assert_format bad, good, @short_length
|
||||
end
|
||||
|
||||
test "with comment before, during and after uniform right" do
|
||||
assert_same """
|
||||
foo
|
||||
# | bar
|
||||
# | baz
|
||||
| bat
|
||||
"""
|
||||
|
||||
bad = """
|
||||
# before
|
||||
foo # this is foo
|
||||
| bar # this is bar
|
||||
| baz # this is baz
|
||||
# after
|
||||
"""
|
||||
|
||||
good = """
|
||||
# before
|
||||
# this is foo
|
||||
foo
|
||||
# this is bar
|
||||
| bar
|
||||
# this is baz
|
||||
| baz
|
||||
|
||||
# after
|
||||
"""
|
||||
|
||||
assert_format bad, good, @short_length
|
||||
end
|
||||
|
||||
test "with comment before, during and after mixed right" do
|
||||
assert_same """
|
||||
one
|
||||
# when two
|
||||
# when three
|
||||
when four
|
||||
# | five
|
||||
| six
|
||||
"""
|
||||
end
|
||||
|
||||
test "handles nodes without meta info" do
|
||||
assert_same "(a -> b) |> (c -> d)"
|
||||
assert_same "(a -> b) when c: d"
|
||||
assert_same "(a -> b) when (c -> d)"
|
||||
end
|
||||
end
|
||||
|
||||
describe "containers" do
|
||||
test "with comment outside before, during and after" do
|
||||
assert_same ~S"""
|
||||
|
||||
@@ -178,9 +178,30 @@ defmodule Code.Formatter.ContainersTest do
|
||||
assert_same keyword, @short_length
|
||||
end
|
||||
|
||||
test "with keyword lists on comma line limit" do
|
||||
bad = """
|
||||
[
|
||||
foooo: 1,
|
||||
barrr: 2
|
||||
]
|
||||
"""
|
||||
|
||||
good = """
|
||||
[
|
||||
foooo:
|
||||
1,
|
||||
barrr: 2
|
||||
]
|
||||
"""
|
||||
|
||||
assert_format bad, good, @short_length
|
||||
end
|
||||
|
||||
test "with quoted keyword lists" do
|
||||
assert_same ~S(["with spaces": 1])
|
||||
assert_same ~S(["one #{two} three": 1])
|
||||
assert_same ~S(["\w": 1, "\\w": 2])
|
||||
assert_same ~S(["Elixir.Foo": 1, "Elixir.Bar": 2])
|
||||
assert_format ~S(["Foo": 1, "Bar": 2]), ~S([Foo: 1, Bar: 2])
|
||||
end
|
||||
|
||||
@@ -455,7 +476,7 @@ defmodule Code.Formatter.ContainersTest do
|
||||
}
|
||||
"""
|
||||
|
||||
assert_format bad, good, @short_length
|
||||
assert_format bad, good, line_length: 11
|
||||
end
|
||||
|
||||
test "removes trailing comma" do
|
||||
@@ -559,7 +580,7 @@ defmodule Code.Formatter.ContainersTest do
|
||||
}
|
||||
"""
|
||||
|
||||
assert_format bad, good, @short_length
|
||||
assert_format bad, good, line_length: 11
|
||||
end
|
||||
|
||||
test "removes trailing comma" do
|
||||
|
||||
@@ -329,6 +329,46 @@ defmodule Code.Formatter.GeneralTest do
|
||||
end
|
||||
"""
|
||||
end
|
||||
|
||||
test "with -> on line limit" do
|
||||
bad = """
|
||||
fn ab, cd ->
|
||||
ab + cd
|
||||
end
|
||||
"""
|
||||
|
||||
good = """
|
||||
fn ab,
|
||||
cd ->
|
||||
ab + cd
|
||||
end
|
||||
"""
|
||||
|
||||
assert_format bad, good, @short_length
|
||||
|
||||
bad = """
|
||||
fn
|
||||
ab, cd ->
|
||||
1
|
||||
xy, zw ->
|
||||
2
|
||||
end
|
||||
"""
|
||||
|
||||
good = """
|
||||
fn
|
||||
ab,
|
||||
cd ->
|
||||
1
|
||||
|
||||
xy,
|
||||
zw ->
|
||||
2
|
||||
end
|
||||
"""
|
||||
|
||||
assert_format bad, good, @short_length
|
||||
end
|
||||
end
|
||||
|
||||
describe "anonymous functions types" do
|
||||
|
||||
@@ -345,20 +345,20 @@ defmodule Code.Formatter.IntegrationTest do
|
||||
"""
|
||||
end
|
||||
|
||||
test "no parens keywords right on line limit" do
|
||||
test "no parens keywords at the end of the line" do
|
||||
bad = """
|
||||
defmodule Mod do
|
||||
defp token_list_downcase(<<char, rest::binary>>, acc) when is_whitespace(char) or is_comma(char), do: token_list_downcase(rest, acc)
|
||||
defp token_list_downcase(some_really_long_arg11, some_really_long_arg22, some_really_long_arg33), do: token_list_downcase(rest, acc)
|
||||
def token_list_downcase(<<char, rest::binary>>, acc) when is_whitespace(char) or is_comma(char), do: token_list_downcase(rest, acc)
|
||||
def token_list_downcase(some_really_long_arg11, some_really_long_arg22, some_really_long_arg33), do: token_list_downcase(rest, acc)
|
||||
end
|
||||
"""
|
||||
|
||||
assert_format bad, """
|
||||
defmodule Mod do
|
||||
defp token_list_downcase(<<char, rest::binary>>, acc) when is_whitespace(char) or is_comma(char),
|
||||
def token_list_downcase(<<char, rest::binary>>, acc) when is_whitespace(char) or is_comma(char),
|
||||
do: token_list_downcase(rest, acc)
|
||||
|
||||
defp token_list_downcase(some_really_long_arg11, some_really_long_arg22, some_really_long_arg33),
|
||||
def token_list_downcase(some_really_long_arg11, some_really_long_arg22, some_really_long_arg33),
|
||||
do: token_list_downcase(rest, acc)
|
||||
end
|
||||
"""
|
||||
@@ -382,6 +382,25 @@ defmodule Code.Formatter.IntegrationTest do
|
||||
assert_format bad, good, line_length: 18
|
||||
end
|
||||
|
||||
test "do at the end of the line with single argument" do
|
||||
bad = """
|
||||
defmodule Location do
|
||||
def new(line, column) when is_integer(line) and line >= 0 and is_integer(column) and column >= 0 do
|
||||
%{column: column, line: line}
|
||||
end
|
||||
end
|
||||
"""
|
||||
|
||||
assert_format bad, """
|
||||
defmodule Location do
|
||||
def new(line, column)
|
||||
when is_integer(line) and line >= 0 and is_integer(column) and column >= 0 do
|
||||
%{column: column, line: line}
|
||||
end
|
||||
end
|
||||
"""
|
||||
end
|
||||
|
||||
test "tuples as trees" do
|
||||
bad = """
|
||||
@document Parser.parse(
|
||||
@@ -417,8 +436,8 @@ defmodule Code.Formatter.IntegrationTest do
|
||||
"""
|
||||
end
|
||||
|
||||
test "first argument in a call without parens" do
|
||||
bad = """
|
||||
test "first argument in a call without parens with comments" do
|
||||
assert_same """
|
||||
with bar ::
|
||||
:ok
|
||||
| :invalid
|
||||
@@ -426,28 +445,58 @@ defmodule Code.Formatter.IntegrationTest do
|
||||
| :other
|
||||
"""
|
||||
|
||||
assert_format bad, """
|
||||
# | :unknown
|
||||
with bar ::
|
||||
:ok
|
||||
| :invalid
|
||||
| :other
|
||||
"""
|
||||
|
||||
bad = """
|
||||
assert_same """
|
||||
@spec bar ::
|
||||
:ok
|
||||
| :invalid
|
||||
# | :unknown
|
||||
| :other
|
||||
"""
|
||||
end
|
||||
|
||||
test "capture with operators" do
|
||||
assert_same """
|
||||
"this works" |> (&String.upcase/1) |> (&String.downcase/1)
|
||||
"""
|
||||
|
||||
assert_same """
|
||||
"this works" || (&String.upcase/1) || (&String.downcase/1)
|
||||
"""
|
||||
|
||||
assert_same """
|
||||
"this works" == (&String.upcase/1) == (&String.downcase/1)
|
||||
"""
|
||||
|
||||
bad = """
|
||||
"this works" = (&String.upcase/1) = (&String.downcase/1)
|
||||
"""
|
||||
|
||||
assert_format bad, """
|
||||
# | :unknown
|
||||
@spec bar ::
|
||||
:ok
|
||||
| :invalid
|
||||
| :other
|
||||
"this works" = (&String.upcase/1) = &String.downcase/1
|
||||
"""
|
||||
|
||||
bad = """
|
||||
"this works" ++ (&String.upcase/1) ++ (&String.downcase/1)
|
||||
"""
|
||||
|
||||
assert_format bad, """
|
||||
"this works" ++ (&String.upcase/1) ++ &String.downcase/1
|
||||
"""
|
||||
|
||||
bad = """
|
||||
"this works" | (&String.upcase/1) | (&String.downcase/1)
|
||||
"""
|
||||
|
||||
assert_format bad, """
|
||||
"this works" | (&String.upcase/1) | &String.downcase/1
|
||||
"""
|
||||
|
||||
bad = ~S"""
|
||||
"this works" \\ (&String.upcase/1) \\ (&String.downcase/1)
|
||||
"""
|
||||
|
||||
assert_format bad, ~S"""
|
||||
"this works" \\ &String.upcase/1 \\ &String.downcase/1
|
||||
"""
|
||||
end
|
||||
end
|
||||
|
||||
@@ -121,7 +121,13 @@ defmodule Code.Formatter.OperatorsTest do
|
||||
end
|
||||
|
||||
test "not in" do
|
||||
assert_format "not(foo in bar)", "foo not in bar"
|
||||
assert_format "not foo in bar", "not (foo in bar)"
|
||||
assert_format "not foo in bar", "foo not in bar", rename_deprecated_at: "1.5.0"
|
||||
|
||||
assert_format "not(foo in bar)", "not (foo in bar)"
|
||||
assert_format "not(foo in bar)", "foo not in bar", rename_deprecated_at: "1.5.0"
|
||||
|
||||
assert_same "foo not in bar"
|
||||
assert_same "(not foo) in bar"
|
||||
assert_same "(!foo) in bar"
|
||||
end
|
||||
@@ -806,9 +812,9 @@ defmodule Code.Formatter.OperatorsTest do
|
||||
end
|
||||
|
||||
test "with operators outside" do
|
||||
assert_same "(& &1) == & &2"
|
||||
assert_same "(& &1) and & &2"
|
||||
assert_same "(&foo/1) and &bar/1"
|
||||
assert_same "(& &1) == (& &2)"
|
||||
assert_same "(& &1) and (& &2)"
|
||||
assert_same "(&foo/1) and (&bar/1)"
|
||||
assert_same "[(&IO.puts/1) | &IO.puts/2]"
|
||||
end
|
||||
|
||||
|
||||
@@ -9,6 +9,12 @@ defmodule DynamicSupervisorTest do
|
||||
def init(args), do: args
|
||||
end
|
||||
|
||||
test "can be supervised directly" do
|
||||
children = [{DynamicSupervisor, strategy: :one_for_one, name: :dyn_sup_spec_test}]
|
||||
assert {:ok, _} = Supervisor.start_link(children, strategy: :one_for_one)
|
||||
assert DynamicSupervisor.which_children(:dyn_sup_spec_test) == []
|
||||
end
|
||||
|
||||
describe "use/2" do
|
||||
test "generates child_spec/1" do
|
||||
assert Simple.child_spec([:hello]) == %{
|
||||
@@ -347,6 +353,26 @@ defmodule DynamicSupervisorTest do
|
||||
assert {:error, :max_children} = DynamicSupervisor.start_child(pid, child)
|
||||
end
|
||||
|
||||
test "restarting a child with extra_args successfully restarts child" do
|
||||
parent = self()
|
||||
|
||||
fun = fn ->
|
||||
send(parent, :from_child)
|
||||
:timer.sleep(:infinity)
|
||||
end
|
||||
|
||||
{:ok, sup} = DynamicSupervisor.start_link(strategy: :one_for_one, extra_arguments: [fun])
|
||||
child = %{id: Task, restart: :transient, start: {Task, :start_link, []}}
|
||||
|
||||
assert {:ok, child} = DynamicSupervisor.start_child(sup, child)
|
||||
assert is_pid(child)
|
||||
assert_receive :from_child
|
||||
assert %{active: 1, workers: 1} = DynamicSupervisor.count_children(sup)
|
||||
assert_kill(child, :oops)
|
||||
assert_receive :from_child
|
||||
assert %{workers: 1, active: 1} = DynamicSupervisor.count_children(sup)
|
||||
end
|
||||
|
||||
test "child is restarted when trying again" do
|
||||
child = current_module_worker([:try_again, self()], restart: :permanent)
|
||||
{:ok, pid} = DynamicSupervisor.start_link(strategy: :one_for_one, max_restarts: 2)
|
||||
|
||||
@@ -878,10 +878,7 @@ defmodule EnumTest do
|
||||
assert Enum.zip([[1]]) == [{1}]
|
||||
|
||||
assert Enum.zip([[], [], [], []]) == []
|
||||
|
||||
assert_raise FunctionClauseError, fn ->
|
||||
Enum.zip(%{})
|
||||
end
|
||||
assert Enum.zip(%{}) == []
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -143,8 +143,38 @@ defmodule Kernel.ComprehensionTest do
|
||||
end
|
||||
|
||||
test "for comprehensions into binary" do
|
||||
enum = 1..3
|
||||
assert for(x <- enum, into: "", do: to_bin(x * 2)) == <<2, 4, 6>>
|
||||
enum = 0..3
|
||||
|
||||
assert (for x <- enum, into: "" do
|
||||
to_bin(x * 2)
|
||||
end) == <<0, 2, 4, 6>>
|
||||
|
||||
assert (for x <- enum, into: "" do
|
||||
if Integer.is_even(x), do: <<x::size(2)>>, else: <<x::size(1)>>
|
||||
end) == <<0::size(2), 1::size(1), 2::size(2), 3::size(1)>>
|
||||
end
|
||||
|
||||
test "for comprehensions into dynamic binary" do
|
||||
enum = 0..3
|
||||
into = ""
|
||||
|
||||
assert (for x <- enum, into: into do
|
||||
to_bin(x * 2)
|
||||
end) == <<0, 2, 4, 6>>
|
||||
|
||||
assert (for x <- enum, into: into do
|
||||
if Integer.is_even(x), do: <<x::size(2)>>, else: <<x::size(1)>>
|
||||
end) == <<0::size(2), 1::size(1), 2::size(2), 3::size(1)>>
|
||||
|
||||
into = <<7::size(1)>>
|
||||
|
||||
assert (for x <- enum, into: into do
|
||||
to_bin(x * 2)
|
||||
end) == <<7::size(1), 0, 2, 4, 6>>
|
||||
|
||||
assert (for x <- enum, into: into do
|
||||
if Integer.is_even(x), do: <<x::size(2)>>, else: <<x::size(1)>>
|
||||
end) == <<7::size(1), 0::size(2), 1::size(1), 2::size(2), 3::size(1)>>
|
||||
end
|
||||
|
||||
test "for comprehensions where value is not used" do
|
||||
@@ -238,9 +268,39 @@ defmodule Kernel.ComprehensionTest do
|
||||
assert for(x <- enum, into: [], do: x * 2) == [2, 4, 6]
|
||||
end
|
||||
|
||||
test "list for comprehensions into binaries" do
|
||||
enum = [1, 2, 3]
|
||||
assert for(x <- enum, into: "", do: to_bin(x * 2)) == <<2, 4, 6>>
|
||||
test "list for comprehensions into binary" do
|
||||
enum = [0, 1, 2, 3]
|
||||
|
||||
assert (for x <- enum, into: "" do
|
||||
to_bin(x * 2)
|
||||
end) == <<0, 2, 4, 6>>
|
||||
|
||||
assert (for x <- enum, into: "" do
|
||||
if Integer.is_even(x), do: <<x::size(2)>>, else: <<x::size(1)>>
|
||||
end) == <<0::size(2), 1::size(1), 2::size(2), 3::size(1)>>
|
||||
end
|
||||
|
||||
test "list for comprehensions into dynamic binary" do
|
||||
enum = [0, 1, 2, 3]
|
||||
into = ""
|
||||
|
||||
assert (for x <- enum, into: into do
|
||||
to_bin(x * 2)
|
||||
end) == <<0, 2, 4, 6>>
|
||||
|
||||
assert (for x <- enum, into: into do
|
||||
if Integer.is_even(x), do: <<x::size(2)>>, else: <<x::size(1)>>
|
||||
end) == <<0::size(2), 1::size(1), 2::size(2), 3::size(1)>>
|
||||
|
||||
into = <<7::size(1)>>
|
||||
|
||||
assert (for x <- enum, into: into do
|
||||
to_bin(x * 2)
|
||||
end) == <<7::size(1), 0, 2, 4, 6>>
|
||||
|
||||
assert (for x <- enum, into: into do
|
||||
if Integer.is_even(x), do: <<x::size(2)>>, else: <<x::size(1)>>
|
||||
end) == <<7::size(1), 0::size(2), 1::size(1), 2::size(2), 3::size(1)>>
|
||||
end
|
||||
|
||||
test "map for comprehensions into map" do
|
||||
@@ -278,9 +338,39 @@ defmodule Kernel.ComprehensionTest do
|
||||
assert for(<<x <- bin>>, into: [], do: x * 2) == [2, 4, 6]
|
||||
end
|
||||
|
||||
test "binary for comprehensions into binaries" do
|
||||
bin = <<1, 2, 3>>
|
||||
assert for(<<x <- bin>>, into: "", do: to_bin(x * 2)) == <<2, 4, 6>>
|
||||
test "binary for comprehensions into binary" do
|
||||
bin = <<0, 1, 2, 3>>
|
||||
|
||||
assert (for <<x <- bin>>, into: "" do
|
||||
to_bin(x * 2)
|
||||
end) == <<0, 2, 4, 6>>
|
||||
|
||||
assert (for <<x <- bin>>, into: "" do
|
||||
if Integer.is_even(x), do: <<x::size(2)>>, else: <<x::size(1)>>
|
||||
end) == <<0::size(2), 1::size(1), 2::size(2), 3::size(1)>>
|
||||
end
|
||||
|
||||
test "binary for comprehensions into dynamic binary" do
|
||||
bin = <<0, 1, 2, 3>>
|
||||
into = ""
|
||||
|
||||
assert (for <<x <- bin>>, into: into do
|
||||
to_bin(x * 2)
|
||||
end) == <<0, 2, 4, 6>>
|
||||
|
||||
assert (for <<x <- bin>>, into: into do
|
||||
if Integer.is_even(x), do: <<x::size(2)>>, else: <<x::size(1)>>
|
||||
end) == <<0::size(2), 1::size(1), 2::size(2), 3::size(1)>>
|
||||
|
||||
into = <<7::size(1)>>
|
||||
|
||||
assert (for <<x <- bin>>, into: into do
|
||||
to_bin(x * 2)
|
||||
end) == <<7::size(1), 0, 2, 4, 6>>
|
||||
|
||||
assert (for <<x <- bin>>, into: into do
|
||||
if Integer.is_even(x), do: <<x::size(2)>>, else: <<x::size(1)>>
|
||||
end) == <<7::size(1), 0::size(2), 1::size(1), 2::size(2), 3::size(1)>>
|
||||
end
|
||||
|
||||
test "binary for comprehensions with variable size" do
|
||||
|
||||
@@ -178,6 +178,9 @@ defmodule Kernel.DocsTest do
|
||||
|
||||
@doc false
|
||||
def qux(true), do: false
|
||||
|
||||
Module.add_doc(__MODULE__, __ENV__.line, :def, {:nullary, 0}, [], "add_doc")
|
||||
def nullary, do: 0
|
||||
end
|
||||
)
|
||||
|
||||
@@ -191,6 +194,7 @@ defmodule Kernel.DocsTest do
|
||||
{{:bar, 1}, _, :def, [{:arg, _, nil}], "Multiple bodiless clause doc"},
|
||||
{{:baz, 1}, _, :def, [{:arg, _, nil}], "Multiple bodiless clause and docs"},
|
||||
{{:foo, 1}, _, :def, [{:arg, _, nil}], "Function doc"},
|
||||
{{:nullary, 0}, _, :def, [], "add_doc"},
|
||||
{{:qux, 1}, _, :def, [{:bool, _, Elixir}], false}
|
||||
] = docs[:docs]
|
||||
|
||||
@@ -207,4 +211,42 @@ defmodule Kernel.DocsTest do
|
||||
] = docs[:callback_docs]
|
||||
end
|
||||
end
|
||||
|
||||
test "@impl true doesn't set @doc false if previous implementation has docs" do
|
||||
write_beam(
|
||||
defmodule Docs do
|
||||
defmodule SampleBehaviour do
|
||||
@callback foo(any()) :: any()
|
||||
@callback bar() :: any()
|
||||
@callback baz() :: any()
|
||||
end
|
||||
|
||||
@behaviour SampleBehaviour
|
||||
|
||||
@doc "Foo docs"
|
||||
def foo(nil), do: nil
|
||||
|
||||
@impl true
|
||||
def foo(_), do: false
|
||||
|
||||
@impl true
|
||||
def bar(), do: true
|
||||
|
||||
@doc "Baz docs"
|
||||
@impl true
|
||||
def baz(), do: true
|
||||
|
||||
def fuz(), do: true
|
||||
end
|
||||
)
|
||||
|
||||
docs = Code.get_docs(Docs, :all)
|
||||
|
||||
assert [
|
||||
{{:bar, 0}, _, :def, [], false},
|
||||
{{:baz, 0}, _, :def, [], "Baz docs"},
|
||||
{{:foo, 1}, _, :def, [{:arg1, [], _}], "Foo docs"},
|
||||
{{:fuz, 0}, _, :def, [], nil}
|
||||
] = docs[:docs]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -108,6 +108,12 @@ defmodule Kernel.ErrorsTest do
|
||||
assert_eval_raise SyntaxError, msg, "foo:+1"
|
||||
end
|
||||
|
||||
test "invalid map start" do
|
||||
assert_eval_raise SyntaxError,
|
||||
"nofile:1: expected %{ to define a map, got: %[",
|
||||
"{:ok, %[], %{}}"
|
||||
end
|
||||
|
||||
test "sigil terminator" do
|
||||
assert_eval_raise TokenMissingError,
|
||||
"nofile:3: missing terminator: \" (for sigil ~r\" starting at line 1)",
|
||||
@@ -695,6 +701,12 @@ defmodule Kernel.ErrorsTest do
|
||||
def foo(n) when is_number(n)
|
||||
end
|
||||
'''
|
||||
|
||||
assert_eval_raise CompileError, "nofile:2: missing :do option in \"def\"", '''
|
||||
defmodule Kernel.ErrorsTest.BodyessFunctionWithGuard do
|
||||
def foo(n) when is_number(n), true
|
||||
end
|
||||
'''
|
||||
end
|
||||
|
||||
test "invalid args for bodyless clause" do
|
||||
|
||||
@@ -58,7 +58,7 @@ defmodule Kernel.FnTest do
|
||||
assert (&List.flatten/1).([[0]]) == [0]
|
||||
assert (&List.flatten/1).([[0]]) == [0]
|
||||
assert (&List.flatten(&1)).([[0]]) == [0]
|
||||
assert (&List.flatten(&1)) == &List.flatten/1
|
||||
assert (&List.flatten(&1)) == (&List.flatten/1)
|
||||
end
|
||||
|
||||
test "capture local" do
|
||||
@@ -77,7 +77,7 @@ defmodule Kernel.FnTest do
|
||||
assert (&is_atom/1).(:a)
|
||||
assert (&is_atom/1).(:a)
|
||||
assert (&is_atom(&1)).(:a)
|
||||
assert (&is_atom(&1)) == &is_atom/1
|
||||
assert (&is_atom(&1)) == (&is_atom/1)
|
||||
end
|
||||
|
||||
test "capture macro" do
|
||||
@@ -102,7 +102,7 @@ defmodule Kernel.FnTest do
|
||||
mod = List
|
||||
assert (&mod.flatten(&1)).([1, [2], 3]) == [1, 2, 3]
|
||||
assert (&mod.flatten/1).([1, [2], 3]) == [1, 2, 3]
|
||||
assert (&mod.flatten/1) == &List.flatten/1
|
||||
assert (&mod.flatten/1) == (&List.flatten/1)
|
||||
end
|
||||
|
||||
test "local partial application" do
|
||||
|
||||
@@ -21,6 +21,7 @@ defmodule Kernel.GuardTest do
|
||||
|
||||
defmodule Guards.In.Funs do
|
||||
defguard is_foo(atom) when atom == :foo
|
||||
defguard is_equal(foo, bar) when foo == bar
|
||||
|
||||
def is_foobar(atom) when is_foo(atom) do
|
||||
is_foo(atom)
|
||||
@@ -33,6 +34,13 @@ defmodule Kernel.GuardTest do
|
||||
refute Guards.In.Funs.is_foo(:bar)
|
||||
end
|
||||
|
||||
test "guards do not change code evaluation semantics" do
|
||||
require Guards.In.Funs
|
||||
x = 1
|
||||
assert Guards.In.Funs.is_equal(x = 2, x) == false
|
||||
assert x == 2
|
||||
end
|
||||
|
||||
defmodule Macros.In.Guards do
|
||||
defmacro is_foo(atom) do
|
||||
quote do
|
||||
@@ -365,9 +373,7 @@ defmodule Kernel.GuardTest do
|
||||
:erlang.+(:erlang.+(unquote(foo), unquote(bar)), unquote(baz))
|
||||
end
|
||||
false -> quote do
|
||||
foo = unquote(foo)
|
||||
bar = unquote(bar)
|
||||
baz = unquote(baz)
|
||||
{foo, bar, baz} = {unquote(foo), unquote(bar), unquote(baz)}
|
||||
:erlang.+(:erlang.+(foo, bar), baz)
|
||||
end
|
||||
end
|
||||
@@ -387,8 +393,7 @@ defmodule Kernel.GuardTest do
|
||||
:erlang.+(unquote(foo), unquote(bar))
|
||||
end
|
||||
false -> quote do
|
||||
foo = unquote(foo)
|
||||
bar = unquote(bar)
|
||||
{foo, bar} = {unquote(foo), unquote(bar)}
|
||||
:erlang.+(foo, bar)
|
||||
end
|
||||
end
|
||||
@@ -410,9 +415,7 @@ defmodule Kernel.GuardTest do
|
||||
end
|
||||
false ->
|
||||
quote() do
|
||||
foo = unquote(foo)
|
||||
bar = unquote(bar)
|
||||
baz = unquote(baz)
|
||||
{foo, bar, baz} = {unquote(foo), unquote(bar), unquote(baz)}
|
||||
:erlang.+(:erlang.+(:erlang.+(foo, foo), bar), baz)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -835,8 +835,12 @@ defmodule Kernel.TypespecTest do
|
||||
quote(do: @type(literal_keyword_list_type_key() :: [{binary(), integer()}])),
|
||||
quote(do: @type(literal_empty_map() :: %{})),
|
||||
quote(do: @type(literal_map_with_key() :: %{key: integer()})),
|
||||
quote(do: @type(literal_map_with_required_key() :: %{required(bitstring()) => integer()})),
|
||||
quote(do: @type(literal_map_with_optional_key() :: %{optional(bitstring()) => integer()})),
|
||||
quote(
|
||||
do: @type(literal_map_with_required_key() :: %{required(bitstring()) => integer()})
|
||||
),
|
||||
quote(
|
||||
do: @type(literal_map_with_optional_key() :: %{optional(bitstring()) => integer()})
|
||||
),
|
||||
quote(do: @type(literal_struct_all_fields_any_type() :: %SomeStruct{})),
|
||||
quote(do: @type(literal_struct_all_fields_key_type() :: %SomeStruct{key: integer()})),
|
||||
quote(do: @type(literal_empty_tuple() :: {})),
|
||||
@@ -863,7 +867,9 @@ defmodule Kernel.TypespecTest do
|
||||
quote(do: @type(builtin_list() :: list())),
|
||||
quote(do: @type(builtin_nonempty_list() :: nonempty_list())),
|
||||
quote(do: @type(builtin_maybe_improper_list() :: maybe_improper_list())),
|
||||
quote(do: @type(builtin_nonempty_maybe_improper_list() :: nonempty_maybe_improper_list())),
|
||||
quote(
|
||||
do: @type(builtin_nonempty_maybe_improper_list() :: nonempty_maybe_improper_list())
|
||||
),
|
||||
quote(do: @type(builtin_mfa() :: mfa())),
|
||||
quote(do: @type(builtin_module() :: module())),
|
||||
quote(do: @type(builtin_no_return() :: no_return())),
|
||||
|
||||
@@ -833,7 +833,7 @@ defmodule Kernel.WarningTest do
|
||||
@behaviour UndefinedBehaviour
|
||||
end
|
||||
""")
|
||||
end) =~ "module UndefinedBehaviour does not exist (in module Sample)"
|
||||
end) =~ "@behaviour UndefinedBehaviour does not exist (in module Sample)"
|
||||
after
|
||||
purge(Sample)
|
||||
end
|
||||
@@ -1092,13 +1092,13 @@ defmodule Kernel.WarningTest do
|
||||
end
|
||||
|
||||
test "unused variable in defguard" do
|
||||
capture_err(fn ->
|
||||
Code.eval_string("""
|
||||
defmodule Sample do
|
||||
defguard foo(bar, baz) when bar
|
||||
end
|
||||
""")
|
||||
end) =~ "variable \"baz\" is unused"
|
||||
assert capture_err(fn ->
|
||||
Code.eval_string("""
|
||||
defmodule Sample do
|
||||
defguard foo(bar, baz) when bar
|
||||
end
|
||||
""")
|
||||
end) =~ "variable \"baz\" is unused"
|
||||
after
|
||||
purge(Sample)
|
||||
end
|
||||
@@ -1129,65 +1129,39 @@ defmodule Kernel.WarningTest do
|
||||
end
|
||||
|
||||
test "defguard overriding defmacro" do
|
||||
capture_err(fn ->
|
||||
Code.eval_string("""
|
||||
defmodule Sample do
|
||||
defmacro foo(bar), do: bar == :bar
|
||||
defguard foo(baz) when baz == :baz
|
||||
end
|
||||
""")
|
||||
end) =~ "this clause cannot match because a previous clause at line 2 always matches"
|
||||
assert capture_err(fn ->
|
||||
Code.eval_string("""
|
||||
defmodule Sample do
|
||||
defmacro foo(bar), do: bar == :bar
|
||||
defguard foo(baz) when baz == :baz
|
||||
end
|
||||
""")
|
||||
end) =~ "this clause cannot match because a previous clause at line 2 always matches"
|
||||
after
|
||||
purge(Sample)
|
||||
end
|
||||
|
||||
test "defmacro overriding defguard" do
|
||||
capture_err(fn ->
|
||||
Code.eval_string("""
|
||||
defmodule Sample do
|
||||
defguard foo(baz) when baz == :baz
|
||||
defmacro foo(bar), do: bar == :bar
|
||||
end
|
||||
""")
|
||||
end) =~ "this clause cannot match because a previous clause at line 2 always matches"
|
||||
after
|
||||
purge(Sample)
|
||||
end
|
||||
|
||||
test "defguardp overriding defmacrop" do
|
||||
capture_err(fn ->
|
||||
Code.eval_string("""
|
||||
defmodule Sample do
|
||||
defmacrop foo(bar), do: bar == :bar
|
||||
defguardp foo(baz) when baz == :baz
|
||||
end
|
||||
""")
|
||||
end) =~ "this clause cannot match because a previous clause at line 2 always matches"
|
||||
after
|
||||
purge(Sample)
|
||||
end
|
||||
|
||||
test "defmacrop overriding defguardp" do
|
||||
capture_err(fn ->
|
||||
Code.eval_string("""
|
||||
defmodule Sample do
|
||||
defguardp foo(baz) when baz == :baz
|
||||
defmacrop foo(bar), do: bar == :bar
|
||||
end
|
||||
""")
|
||||
end) =~ "this clause cannot match because a previous clause at line 2 always matches"
|
||||
assert capture_err(fn ->
|
||||
Code.eval_string("""
|
||||
defmodule Sample do
|
||||
defguard foo(baz) when baz == :baz
|
||||
defmacro foo(bar), do: bar == :bar
|
||||
end
|
||||
""")
|
||||
end) =~ "this clause cannot match because a previous clause at line 2 always matches"
|
||||
after
|
||||
purge(Sample)
|
||||
end
|
||||
|
||||
test "defguard needs an implementation" do
|
||||
capture_err(fn ->
|
||||
Code.eval_string("""
|
||||
defmodule Sample do
|
||||
defguard foo(bar)
|
||||
end
|
||||
""")
|
||||
end) =~ "implementation not provided for predefined defguard"
|
||||
assert capture_err(fn ->
|
||||
Code.eval_string("""
|
||||
defmodule Sample do
|
||||
defguard foo(bar)
|
||||
end
|
||||
""")
|
||||
end) =~ "implementation not provided for predefined defmacro foo/1"
|
||||
after
|
||||
purge(Sample)
|
||||
end
|
||||
|
||||
@@ -412,6 +412,45 @@ defmodule MacroTest do
|
||||
assert Macro.to_string(quoted) <> "\n" == expected
|
||||
end
|
||||
|
||||
test "try" do
|
||||
quoted =
|
||||
quote do
|
||||
try do
|
||||
foo
|
||||
catch
|
||||
_, _ ->
|
||||
2
|
||||
rescue
|
||||
ArgumentError ->
|
||||
1
|
||||
after
|
||||
4
|
||||
else
|
||||
_ ->
|
||||
3
|
||||
end
|
||||
end
|
||||
|
||||
expected = """
|
||||
try() do
|
||||
foo
|
||||
rescue
|
||||
ArgumentError ->
|
||||
1
|
||||
catch
|
||||
_, _ ->
|
||||
2
|
||||
else
|
||||
_ ->
|
||||
3
|
||||
after
|
||||
4
|
||||
end
|
||||
"""
|
||||
|
||||
assert Macro.to_string(quoted) <> "\n" == expected
|
||||
end
|
||||
|
||||
test "fn" do
|
||||
assert Macro.to_string(quote(do: fn -> 1 + 2 end)) == "fn -> 1 + 2 end"
|
||||
assert Macro.to_string(quote(do: fn x -> x + 1 end)) == "fn x -> x + 1 end"
|
||||
|
||||
@@ -5,6 +5,7 @@ defmodule NodeTest do
|
||||
|
||||
doctest Node
|
||||
|
||||
@tag :unix
|
||||
test "start/3 and stop/0" do
|
||||
assert Node.stop() == {:error, :not_found}
|
||||
assert {:ok, _} = Node.start(:hello, :shortnames, 15000)
|
||||
|
||||
@@ -36,67 +36,69 @@ defmodule PathTest do
|
||||
assert_raise ArgumentError, ~r/null byte/, fn -> Path.wildcard("foo\0bar") end
|
||||
end
|
||||
|
||||
if windows?() do
|
||||
describe "Windows" do
|
||||
test "relative/1" do
|
||||
assert Path.relative("C:/usr/local/bin") == "usr/local/bin"
|
||||
assert Path.relative("C:\\usr\\local\\bin") == "usr\\local\\bin"
|
||||
assert Path.relative("C:usr\\local\\bin") == "usr\\local\\bin"
|
||||
describe "Windows" do
|
||||
@describetag :windows
|
||||
|
||||
assert Path.relative("/usr/local/bin") == "usr/local/bin"
|
||||
assert Path.relative("usr/local/bin") == "usr/local/bin"
|
||||
assert Path.relative("../usr/local/bin") == "../usr/local/bin"
|
||||
end
|
||||
test "relative/1" do
|
||||
assert Path.relative("C:/usr/local/bin") == "usr/local/bin"
|
||||
assert Path.relative("C:\\usr\\local\\bin") == "usr\\local\\bin"
|
||||
assert Path.relative("C:usr\\local\\bin") == "usr\\local\\bin"
|
||||
|
||||
test "relative_to/2" do
|
||||
assert Path.relative_to("D:/usr/local/foo", "D:/usr/") == "local/foo"
|
||||
assert Path.relative_to("D:/usr/local/foo", "d:/usr/") == "local/foo"
|
||||
assert Path.relative_to("d:/usr/local/foo", "D:/usr/") == "local/foo"
|
||||
assert Path.relative_to("D:/usr/local/foo", "d:/") == "usr/local/foo"
|
||||
assert Path.relative_to("D:/usr/local/foo", "D:/") == "usr/local/foo"
|
||||
assert Path.relative_to("D:/usr/local/foo", "d:") == "D:/usr/local/foo"
|
||||
assert Path.relative_to("D:/usr/local/foo", "D:") == "D:/usr/local/foo"
|
||||
end
|
||||
|
||||
test "type/1" do
|
||||
assert Path.type("C:/usr/local/bin") == :absolute
|
||||
assert Path.type('C:\\usr\\local\\bin') == :absolute
|
||||
assert Path.type("C:usr\\local\\bin") == :volumerelative
|
||||
|
||||
assert Path.type("/usr/local/bin") == :volumerelative
|
||||
assert Path.type('usr/local/bin') == :relative
|
||||
assert Path.type("../usr/local/bin") == :relative
|
||||
end
|
||||
|
||||
test "split/1" do
|
||||
assert Path.split("C:\\foo\\bar") == ["c:/", "foo", "bar"]
|
||||
assert Path.split("C:/foo/bar") == ["c:/", "foo", "bar"]
|
||||
end
|
||||
assert Path.relative("/usr/local/bin") == "usr/local/bin"
|
||||
assert Path.relative("usr/local/bin") == "usr/local/bin"
|
||||
assert Path.relative("../usr/local/bin") == "../usr/local/bin"
|
||||
end
|
||||
else
|
||||
describe "Unix" do
|
||||
test "relative/1" do
|
||||
assert Path.relative("/usr/local/bin") == "usr/local/bin"
|
||||
assert Path.relative("usr/local/bin") == "usr/local/bin"
|
||||
assert Path.relative("../usr/local/bin") == "../usr/local/bin"
|
||||
assert Path.relative("/") == "."
|
||||
assert Path.relative('/') == "."
|
||||
assert Path.relative(['/usr', ?/, "local/bin"]) == "usr/local/bin"
|
||||
end
|
||||
|
||||
test "type/1" do
|
||||
assert Path.type("/usr/local/bin") == :absolute
|
||||
assert Path.type("usr/local/bin") == :relative
|
||||
assert Path.type("../usr/local/bin") == :relative
|
||||
test "relative_to/2" do
|
||||
assert Path.relative_to("D:/usr/local/foo", "D:/usr/") == "local/foo"
|
||||
assert Path.relative_to("D:/usr/local/foo", "d:/usr/") == "local/foo"
|
||||
assert Path.relative_to("d:/usr/local/foo", "D:/usr/") == "local/foo"
|
||||
assert Path.relative_to("D:/usr/local/foo", "d:/") == "usr/local/foo"
|
||||
assert Path.relative_to("D:/usr/local/foo", "D:/") == "usr/local/foo"
|
||||
assert Path.relative_to("D:/usr/local/foo", "d:") == "D:/usr/local/foo"
|
||||
assert Path.relative_to("D:/usr/local/foo", "D:") == "D:/usr/local/foo"
|
||||
end
|
||||
|
||||
assert Path.type('/usr/local/bin') == :absolute
|
||||
assert Path.type('usr/local/bin') == :relative
|
||||
assert Path.type('../usr/local/bin') == :relative
|
||||
test "type/1" do
|
||||
assert Path.type("C:/usr/local/bin") == :absolute
|
||||
assert Path.type('C:\\usr\\local\\bin') == :absolute
|
||||
assert Path.type("C:usr\\local\\bin") == :volumerelative
|
||||
|
||||
assert Path.type(['/usr/', 'local/bin']) == :absolute
|
||||
assert Path.type(['usr/', 'local/bin']) == :relative
|
||||
assert Path.type(['../usr', '/local/bin']) == :relative
|
||||
end
|
||||
assert Path.type("/usr/local/bin") == :volumerelative
|
||||
assert Path.type('usr/local/bin') == :relative
|
||||
assert Path.type("../usr/local/bin") == :relative
|
||||
end
|
||||
|
||||
test "split/1" do
|
||||
assert Path.split("C:\\foo\\bar") == ["c:/", "foo", "bar"]
|
||||
assert Path.split("C:/foo/bar") == ["c:/", "foo", "bar"]
|
||||
end
|
||||
end
|
||||
|
||||
describe "Unix" do
|
||||
@describetag :unix
|
||||
|
||||
test "relative/1" do
|
||||
assert Path.relative("/usr/local/bin") == "usr/local/bin"
|
||||
assert Path.relative("usr/local/bin") == "usr/local/bin"
|
||||
assert Path.relative("../usr/local/bin") == "../usr/local/bin"
|
||||
assert Path.relative("/") == "."
|
||||
assert Path.relative('/') == "."
|
||||
assert Path.relative(['/usr', ?/, "local/bin"]) == "usr/local/bin"
|
||||
end
|
||||
|
||||
test "type/1" do
|
||||
assert Path.type("/usr/local/bin") == :absolute
|
||||
assert Path.type("usr/local/bin") == :relative
|
||||
assert Path.type("../usr/local/bin") == :relative
|
||||
|
||||
assert Path.type('/usr/local/bin') == :absolute
|
||||
assert Path.type('usr/local/bin') == :relative
|
||||
assert Path.type('../usr/local/bin') == :relative
|
||||
|
||||
assert Path.type(['/usr/', 'local/bin']) == :absolute
|
||||
assert Path.type(['usr/', 'local/bin']) == :relative
|
||||
assert Path.type(['../usr', '/local/bin']) == :relative
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -1099,10 +1099,8 @@ defmodule StreamTest do
|
||||
assert Stream.zip([concat, cycle]) |> Enum.to_list() ==
|
||||
[{1, :a}, {2, :b}, {3, :c}, {4, :a}, {5, :b}, {6, :c}]
|
||||
|
||||
assert_raise FunctionClauseError, fn ->
|
||||
enum_of_enums = Stream.cycle([[1, 2], [:a, :b]])
|
||||
Stream.zip(enum_of_enums)
|
||||
end
|
||||
assert Stream.chunk_every([0, 1, 2, 3], 2) |> Stream.zip() |> Enum.to_list() ==
|
||||
[{0, 2}, {1, 3}]
|
||||
end
|
||||
|
||||
test "zip/1 does not leave streams suspended" do
|
||||
|
||||
@@ -92,12 +92,14 @@ defmodule SystemTest do
|
||||
end
|
||||
end
|
||||
|
||||
if windows?() do
|
||||
test "cmd/2 win" do
|
||||
describe "Windows" do
|
||||
@describetag :windows
|
||||
|
||||
test "cmd/2" do
|
||||
assert {"hello\r\n", 0} = System.cmd("cmd", ~w[/c echo hello])
|
||||
end
|
||||
|
||||
test "cmd/3 (with options) win" do
|
||||
test "cmd/3 (with options)" do
|
||||
assert {["hello\r\n"], 0} =
|
||||
System.cmd(
|
||||
"cmd",
|
||||
@@ -113,7 +115,7 @@ defmodule SystemTest do
|
||||
|
||||
@echo "echo-elixir-test"
|
||||
|
||||
test "cmd/2 with absolute and relative Windows paths" do
|
||||
test "cmd/2 with absolute and relative paths" do
|
||||
echo = tmp_path(@echo)
|
||||
File.mkdir_p!(Path.dirname(echo))
|
||||
File.cp!(System.find_executable("cmd"), echo)
|
||||
@@ -132,12 +134,16 @@ defmodule SystemTest do
|
||||
after
|
||||
File.rm_rf!(Path.dirname(tmp_path(@echo)))
|
||||
end
|
||||
else
|
||||
test "cmd/2 unix" do
|
||||
end
|
||||
|
||||
describe "Unix" do
|
||||
@describetag :unix
|
||||
|
||||
test "cmd/2" do
|
||||
assert {"hello\n", 0} = System.cmd("echo", ["hello"])
|
||||
end
|
||||
|
||||
test "cmd/3 (with options) unix" do
|
||||
test "cmd/3 (with options)" do
|
||||
opts = [
|
||||
into: [],
|
||||
cd: System.cwd!(),
|
||||
@@ -152,7 +158,7 @@ defmodule SystemTest do
|
||||
|
||||
@echo "echo-elixir-test"
|
||||
|
||||
test "cmd/2 with absolute and relative Unix paths" do
|
||||
test "cmd/2 with absolute and relative paths" do
|
||||
echo = tmp_path(@echo)
|
||||
File.mkdir_p!(Path.dirname(echo))
|
||||
File.cp!(System.find_executable("echo"), echo)
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
assert_timeout = String.to_integer(System.get_env("ELIXIR_ASSERT_TIMEOUT") || "500")
|
||||
ExUnit.start(trace: "--trace" in System.argv(), assert_receive_timeout: assert_timeout)
|
||||
|
||||
# Beam files compiled on demand
|
||||
path = Path.expand("../../tmp/beams", __DIR__)
|
||||
File.rm_rf!(path)
|
||||
@@ -87,3 +84,12 @@ defmodule CodeFormatterHelpers do
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
assert_timeout = String.to_integer(System.get_env("ELIXIR_ASSERT_TIMEOUT") || "500")
|
||||
exclude = if PathHelpers.windows?(), do: [unix: true], else: [windows: true]
|
||||
|
||||
ExUnit.start(
|
||||
trace: "--trace" in System.argv(),
|
||||
assert_receive_timeout: assert_timeout,
|
||||
exclude: exclude
|
||||
)
|
||||
|
||||
@@ -5,15 +5,25 @@ defmodule ExUnit.Callbacks do
|
||||
This module defines both `setup` and `setup_all` callbacks, as well as
|
||||
the `on_exit/2`, `start_supervised/2` and `stop_supervised/1` functions.
|
||||
|
||||
The setup callbacks are defined via macros and each one can optionally
|
||||
receive a map with metadata, usually referred to as `context`. The context
|
||||
to be used in the tests can be optionally extended by the callbacks by
|
||||
returning a properly structured value (see below).
|
||||
The setup callbacks are defined via macros and each one can
|
||||
optionally receive a map with test state and metadata, usually
|
||||
referred to as `context`. The context to be used in the tests can be
|
||||
optionally extended by the setup callbacks by returning a properly
|
||||
structured value (see below).
|
||||
|
||||
The `setup_all` callbacks are invoked only once per module, before any
|
||||
test runs. All `setup` callbacks are run before each test. No callback
|
||||
runs if the test case has no tests or all tests have been filtered out.
|
||||
|
||||
Both `setup` and `setup_all` can be defined by a block, by passing
|
||||
an atom naming a unary function, or by passing a list of such
|
||||
atoms. Both can opt to receive the current context by specifying it
|
||||
as parameter if defined by a block. Functions used to define a test
|
||||
setup must accept the context as single argument.
|
||||
|
||||
A test module can define mutiple `setup` and `setup_all` callbacks,
|
||||
and they are invoked in order of appearance.
|
||||
|
||||
`start_supervised/2` is used to start processes under a supervisor. The
|
||||
supervisor is linked to the current test process. The supervisor as well
|
||||
as all child processes are guaranteed to terminate before any `on_exit/2`
|
||||
@@ -43,13 +53,10 @@ defmodule ExUnit.Callbacks do
|
||||
|
||||
## Context
|
||||
|
||||
If `setup_all` returns a keyword list, a map, or `{:ok, keywords | map}`,
|
||||
the keyword list/map will be merged into the current context and will be
|
||||
available in all subsequent `setup_all`, `setup`, and the `test` itself.
|
||||
|
||||
Similarly, if `setup` returns a keyword list, map, or `{:ok, keywords | map}`,
|
||||
the returned keyword list/map will be merged into the current context and will
|
||||
be available in all subsequent `setup` and the `test` itself.
|
||||
If `setup_all` or `setup` return a keyword list, a map, or `{:ok,
|
||||
keywords | map}`, the keyword list or map will be merged into the
|
||||
current context and will be available in all subsequent `setup_all`,
|
||||
`setup`, and the `test` itself.
|
||||
|
||||
Returning `:ok` leaves the context unchanged (both in `setup` and `setup_all`
|
||||
callbacks).
|
||||
@@ -132,10 +139,25 @@ defmodule ExUnit.Callbacks do
|
||||
@doc """
|
||||
Defines a callback to be run before each test in a case.
|
||||
|
||||
Pass a block or name of a unary function as atom, or list of such
|
||||
atoms.
|
||||
|
||||
Can return values to be merged into the context, to set up state for
|
||||
tests. See section Context above for details.
|
||||
|
||||
## Examples
|
||||
|
||||
def clean_up_tmp_directory(context) do
|
||||
# perform setup
|
||||
:ok
|
||||
end
|
||||
|
||||
setup :clean_up_tmp_directory
|
||||
|
||||
setup do
|
||||
[conn: Plug.Conn.build_conn()]
|
||||
end
|
||||
|
||||
"""
|
||||
defmacro setup(block) do
|
||||
if Keyword.keyword?(block) do
|
||||
@@ -151,6 +173,12 @@ defmodule ExUnit.Callbacks do
|
||||
@doc """
|
||||
Defines a callback to be run before each test in a case.
|
||||
|
||||
Pass a block or name of a unary function as atom, or list of such
|
||||
atoms.
|
||||
|
||||
Can return values to be merged into the context, to set up state for
|
||||
tests. See section Context above for details.
|
||||
|
||||
## Examples
|
||||
|
||||
setup context do
|
||||
@@ -173,10 +201,25 @@ defmodule ExUnit.Callbacks do
|
||||
@doc """
|
||||
Defines a callback to be run before all tests in a case.
|
||||
|
||||
Pass a block or name of a unary function as atom, or list of such
|
||||
atoms.
|
||||
|
||||
Can return values to be merged into the context, to set up state for
|
||||
tests. See section Context above for details.
|
||||
|
||||
## Examples
|
||||
|
||||
def clean_up_tmp_directory(context) do
|
||||
# perform setup
|
||||
:ok
|
||||
end
|
||||
|
||||
setup_all :clean_up_tmp_directory
|
||||
|
||||
setup_all do
|
||||
[conn: Plug.Conn.build_conn()]
|
||||
end
|
||||
|
||||
"""
|
||||
defmacro setup_all(block) do
|
||||
if Keyword.keyword?(block) do
|
||||
@@ -196,6 +239,12 @@ defmodule ExUnit.Callbacks do
|
||||
@doc """
|
||||
Defines a callback to be run before all tests in a case.
|
||||
|
||||
Pass a block or name of a unary function as atom, or list of such
|
||||
atoms.
|
||||
|
||||
Can return values to be merged into the context, to set up state for
|
||||
tests. See section Context above for details.
|
||||
|
||||
## Examples
|
||||
|
||||
setup_all context do
|
||||
|
||||
@@ -181,22 +181,22 @@ defmodule ExUnit.Runner do
|
||||
end
|
||||
|
||||
defp exec_module_setup(%ExUnit.TestModule{name: module} = test_module) do
|
||||
{:ok, test_module, module.__ex_unit__(:setup_all, %{module: module})}
|
||||
{:ok, test_module, module.__ex_unit__(:setup_all, %{module: module, case: module})}
|
||||
catch
|
||||
kind, error ->
|
||||
failed = failed(kind, error, pruned_stacktrace())
|
||||
{:error, %{test_module | state: failed}}
|
||||
end
|
||||
|
||||
defp run_test(true, config, test, context) do
|
||||
run_test([], config, test, context)
|
||||
defp run_test_with_capture_log(true, config, test, context) do
|
||||
run_test_with_capture_log([], config, test, context)
|
||||
end
|
||||
|
||||
defp run_test(false, config, test, context) do
|
||||
defp run_test_with_capture_log(false, config, test, context) do
|
||||
spawn_test(config, test, context)
|
||||
end
|
||||
|
||||
defp run_test(opts, config, test, context) do
|
||||
defp run_test_with_capture_log(opts, config, test, context) do
|
||||
ref = make_ref()
|
||||
|
||||
try do
|
||||
@@ -224,7 +224,7 @@ defmodule ExUnit.Runner do
|
||||
test =
|
||||
if is_nil(test.state) do
|
||||
capture_log? = Map.get(tags, :capture_log, config.capture_log)
|
||||
run_test(capture_log?, config, test, Map.merge(tags, context))
|
||||
run_test_with_capture_log(capture_log?, config, test, Map.merge(tags, context))
|
||||
else
|
||||
test
|
||||
end
|
||||
|
||||
@@ -21,6 +21,7 @@ defmodule ExUnit.CaseTest do
|
||||
test "tags", context do
|
||||
line = __ENV__.line - 1
|
||||
assert context[:module] == __MODULE__
|
||||
assert context[:case] == __MODULE__
|
||||
assert context[:test] == __ENV__.function |> elem(0)
|
||||
assert context[:line] == line
|
||||
assert context[:async] == true
|
||||
|
||||
@@ -55,10 +55,10 @@ defmodule IEx.Autocomplete do
|
||||
|
||||
@doc false
|
||||
def exports(mod) do
|
||||
if function_exported?(mod, :__info__, 1) do
|
||||
if Code.ensure_loaded?(mod) and function_exported?(mod, :__info__, 1) do
|
||||
mod.__info__(:macros) ++ (mod.__info__(:functions) -- [__info__: 1])
|
||||
else
|
||||
mod.module_info(:exports)
|
||||
mod.module_info(:exports) -- [module_info: 0, module_info: 1]
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -14,8 +14,8 @@ defmodule IEx.Evaluator do
|
||||
old_leader = Process.group_leader()
|
||||
Process.group_leader(self(), leader)
|
||||
|
||||
evaluator? = !!Process.get(:iex_evaluator)
|
||||
Process.put(:iex_evaluator, true)
|
||||
evaluator = Process.get(:iex_evaluator)
|
||||
Process.put(:iex_evaluator, command)
|
||||
|
||||
state = loop_state(server, IEx.History.init(), opts)
|
||||
command == :ack && :proc_lib.init_ack(self())
|
||||
@@ -25,11 +25,16 @@ defmodule IEx.Evaluator do
|
||||
after
|
||||
Process.group_leader(self(), old_leader)
|
||||
|
||||
# If there was an evaluator, nest failures.
|
||||
if evaluator? do
|
||||
send(self(), {:done, server})
|
||||
else
|
||||
Process.delete(:iex_evaluator)
|
||||
cond do
|
||||
is_nil(evaluator) ->
|
||||
Process.delete(:iex_evaluator)
|
||||
|
||||
evaluator != :ack ->
|
||||
# Ensure propagation to non-root level evaluators
|
||||
send(self(), {:done, server})
|
||||
|
||||
true ->
|
||||
:ok
|
||||
end
|
||||
|
||||
:ok
|
||||
|
||||
@@ -605,7 +605,8 @@ defmodule Logger do
|
||||
"""
|
||||
@spec bare_log(level, message | (() -> message | {message, keyword}), keyword) ::
|
||||
:ok | {:error, :noproc} | {:error, term}
|
||||
def bare_log(level, chardata_or_fun, metadata \\ []) when level in @levels and is_list(metadata) do
|
||||
def bare_log(level, chardata_or_fun, metadata \\ [])
|
||||
when level in @levels and is_list(metadata) do
|
||||
case __metadata__() do
|
||||
{true, pdict} ->
|
||||
%{mode: mode, truncate: truncate, level: min_level, utc_log: utc_log?} =
|
||||
|
||||
@@ -694,6 +694,60 @@ defmodule Logger.TranslatorTest do
|
||||
"""
|
||||
end
|
||||
|
||||
test "translates DynamicSupervisor reports abnormal shutdown" do
|
||||
assert capture_log(:info, fn ->
|
||||
trap = Process.flag(:trap_exit, true)
|
||||
child = %{id: __MODULE__, start: {__MODULE__, :abnormal, []}}
|
||||
{:ok, pid} = DynamicSupervisor.start_link(strategy: :one_for_one)
|
||||
{:ok, _pid2} = DynamicSupervisor.start_child(pid, child)
|
||||
Process.exit(pid, :normal)
|
||||
receive do: ({:EXIT, ^pid, _} -> :ok)
|
||||
Process.flag(:trap_exit, trap)
|
||||
end) =~ ~r"""
|
||||
\[error\] Child :undefined of Supervisor #PID<\d+\.\d+\.\d+> \(Supervisor\.Default\) shutdown abnormally
|
||||
\*\* \(exit\) :stop
|
||||
Pid: #PID<\d+\.\d+\.\d+>
|
||||
Start Call: Logger.TranslatorTest.abnormal\(\)
|
||||
"""
|
||||
end
|
||||
|
||||
test "translates DynamicSupervisor reports extra_arguments in in abnormal shutdown" do
|
||||
assert capture_log(:info, fn ->
|
||||
trap = Process.flag(:trap_exit, true)
|
||||
|
||||
{:ok, pid} =
|
||||
DynamicSupervisor.start_link(strategy: :one_for_one, extra_arguments: [:extra])
|
||||
|
||||
child = %{id: __MODULE__, start: {__MODULE__, :abnormal2, [:args]}}
|
||||
{:ok, _pid2} = DynamicSupervisor.start_child(pid, child)
|
||||
Process.exit(pid, :normal)
|
||||
receive do: ({:EXIT, ^pid, _} -> :ok)
|
||||
Process.flag(:trap_exit, trap)
|
||||
end) =~ ~r"""
|
||||
\[error\] Child :undefined of Supervisor #PID<\d+\.\d+\.\d+> \(Supervisor\.Default\) shutdown abnormally
|
||||
\*\* \(exit\) :stop
|
||||
Pid: #PID<\d+\.\d+\.\d+>
|
||||
Start Call: Logger.TranslatorTest.abnormal2\(:extra, :args\)
|
||||
"""
|
||||
end
|
||||
|
||||
test "translates named DynamicSupervisor reports abnormal shutdown" do
|
||||
assert capture_log(:info, fn ->
|
||||
trap = Process.flag(:trap_exit, true)
|
||||
child = %{id: __MODULE__, start: {__MODULE__, :abnormal, []}}
|
||||
{:ok, pid} = DynamicSupervisor.start_link(strategy: :one_for_one, name: __MODULE__)
|
||||
{:ok, _pid2} = DynamicSupervisor.start_child(pid, child)
|
||||
Process.exit(pid, :normal)
|
||||
receive do: ({:EXIT, ^pid, _} -> :ok)
|
||||
Process.flag(:trap_exit, trap)
|
||||
end) =~ ~r"""
|
||||
\[error\] Child :undefined of Supervisor Logger.TranslatorTest shutdown abnormally
|
||||
\*\* \(exit\) :stop
|
||||
Pid: #PID<\d+\.\d+\.\d+>
|
||||
Start Call: Logger.TranslatorTest.abnormal\(\)
|
||||
"""
|
||||
end
|
||||
|
||||
test "translates :supervisor_bridge progress" do
|
||||
assert capture_log(:info, fn ->
|
||||
trap = Process.flag(:trap_exit, true)
|
||||
@@ -787,6 +841,10 @@ defmodule Logger.TranslatorTest do
|
||||
:proc_lib.start_link(__MODULE__, :abnormal_init, [])
|
||||
end
|
||||
|
||||
def abnormal2(:extra, :args) do
|
||||
:proc_lib.start_link(__MODULE__, :abnormal_init, [])
|
||||
end
|
||||
|
||||
def abnormal_init() do
|
||||
Process.flag(:trap_exit, true)
|
||||
:proc_lib.init_ack({:ok, self()})
|
||||
|
||||
@@ -81,7 +81,7 @@ defmodule Mix.Shell do
|
||||
* `:quiet` - overrides the callback to no-op
|
||||
|
||||
"""
|
||||
def cmd(command, options, callback) when is_function(callback, 1) do
|
||||
def cmd(command, options \\ [], callback) when is_function(callback, 1) do
|
||||
callback =
|
||||
if Keyword.get(options, :quiet, false) do
|
||||
fn x -> x end
|
||||
|
||||
@@ -165,6 +165,9 @@ defmodule Mix.Tasks.Compile.Erlang do
|
||||
{:attribute, _, :behaviour, behaviour} ->
|
||||
%{erl | behaviours: [behaviour | erl.behaviours]}
|
||||
|
||||
{:attribute, _, :behavior, behaviour} ->
|
||||
%{erl | behaviours: [behaviour | erl.behaviours]}
|
||||
|
||||
{:attribute, _, :compile, value} when is_list(value) ->
|
||||
%{erl | compile: value ++ erl.compile}
|
||||
|
||||
|
||||
+209
-125
@@ -13,58 +13,62 @@ defmodule Mix.Tasks.Format do
|
||||
|
||||
## Formatting options
|
||||
|
||||
Formatting is done with the `Code.format_string!/2` function.
|
||||
For complete list of formatting options please refer to its
|
||||
description.
|
||||
A `.formatter.exs` file can also be defined for customizing input
|
||||
files and the formatter itself.
|
||||
|
||||
## Task-specific options
|
||||
|
||||
* `--check-formatted` - check that the file is already formatted.
|
||||
This is useful in pre-commit hooks and CI scripts if you want to
|
||||
reject contributions with unformatted code. However, keep in mind,
|
||||
that the formatting output may differ between Elixir versions as
|
||||
improvements and fixes are applied to the formatter.
|
||||
|
||||
* `--check-equivalent` - check if the file after formatting has the
|
||||
same AST. If the ASTs are not equivalent, it is a bug in the code
|
||||
formatter. This option is recommended if you are automatically
|
||||
formatting files.
|
||||
|
||||
* `--dry-run` - do not save files after formatting.
|
||||
|
||||
* `--dot-formatter` - the file with formatter configuration.
|
||||
Defaults to `.formatter.exs` if one is available, see next section.
|
||||
|
||||
If any of the `--check-*` flags are given and a check fails, the formatted
|
||||
contents won't be written to disk nor printed to stdout.
|
||||
|
||||
## `.formatter.exs`
|
||||
|
||||
The formatter will read a `.formatter.exs` in the current directory for
|
||||
formatter configuration. It should return a keyword list with any of the
|
||||
options supported by `Code.format_string!/2`.
|
||||
formatter configuration. Evaluating this file should return a keyword list
|
||||
with any of the options supported by `Code.format_string!/2`.
|
||||
|
||||
The `.formatter.exs` also supports other options:
|
||||
|
||||
* `:inputs` (a list of paths and patterns) - specifies the default inputs
|
||||
to be used by this task. For example, `["mix.exs", "{config,lib,test}/**/*.{ex,exs}"]`.
|
||||
|
||||
* `:subdirectories` (a list of paths and patterns) - specifies subdirectories
|
||||
that have their own formatting rules. Each subdirectory should have a
|
||||
`.formatter.exs` that configures how entries in that subdirectory should be
|
||||
formatted as. Configuration between `.formatter.exs` are not shared nor
|
||||
inherited. If a `.formatter.exs` lists "lib/app" as a subdirectory, the rules
|
||||
in `.formatter.exs` won't be available in `lib/app/.formatter.exs`.
|
||||
Note that the parent `.formatter.exs` must not specify files inside the "lib/app"
|
||||
subdirectory in its `:inputs` configuration. If this happens, the behaviour of
|
||||
which formatter configuration will be picked is unspecified.
|
||||
|
||||
* `:import_deps` (a list of dependencies as atoms) - specifies a list
|
||||
of dependencies whose formatter configuration will be imported.
|
||||
See the "Importing dependencies configuration" section below for more
|
||||
information.
|
||||
When specified, the formatter should run in the same directory as
|
||||
the `mix.exs` file that defines those depednencies. See the "Importing
|
||||
dependencies configuration" section below for more information.
|
||||
|
||||
* `:export` (a keyword list) - specifies formatter configuration to be exported. See the
|
||||
"Importing dependencies configuration" section below.
|
||||
* `:export` (a keyword list) - specifies formatter configuration to be exported.
|
||||
See the "Importing dependencies configuration" section below.
|
||||
|
||||
## Task-specific options
|
||||
|
||||
* `--check-formatted` - check that the file is already formatted.
|
||||
This is useful in pre-commit hooks and CI scripts if you want to
|
||||
reject contributions with unformatted code. However keep in mind
|
||||
that the formatted output may differ between Elixir versions as
|
||||
improvements and fixes are applied to the formatter.
|
||||
|
||||
* `--check-equivalent` - check if the files after formatting have the
|
||||
same AST as before formatting. If the ASTs are not equivalent,
|
||||
it is a bug in the code formatter. This option is recommended if you
|
||||
are automatically formatting files.
|
||||
|
||||
* `--dry-run` - do not save files after formatting.
|
||||
|
||||
* `--dot-formatter` - path to the file with formatter configuration.
|
||||
Defaults to `.formatter.exs` if one is available. See the "`.formatter.exs`"
|
||||
section for more information.
|
||||
|
||||
If any of the `--check-*` flags are given and a check fails, the formatted
|
||||
contents won't be written to disk nor printed to standard output.
|
||||
|
||||
## When to format code
|
||||
|
||||
We recommend developers to format code directly in their editors. Either
|
||||
automatically on save or via an explicit command/key binding. If such option
|
||||
is not yet available in your editor of choice, adding the required integration
|
||||
is relatively simple as it is a matter of invoking
|
||||
We recommend developers to format code directly in their editors, either
|
||||
automatically when saving a file or via an explicit command or key binding. If
|
||||
such option is not yet available in your editor of choice, adding the required
|
||||
integration is usually a matter of invoking:
|
||||
|
||||
cd $project && mix format $file
|
||||
|
||||
@@ -72,7 +76,7 @@ defmodule Mix.Tasks.Format do
|
||||
project.
|
||||
|
||||
It is also possible to format code across the whole project by passing a list
|
||||
of patterns and files to `mix format`, as showed at the top of this task
|
||||
of patterns and files to `mix format`, as shown at the top of this task
|
||||
documentation. This list can also be set in the `.formatter.exs` under the
|
||||
`:inputs` key.
|
||||
|
||||
@@ -80,15 +84,15 @@ defmodule Mix.Tasks.Format do
|
||||
|
||||
This task supports importing formatter configuration from dependencies.
|
||||
|
||||
A dependency that wants to export formatter configuration needs to have a `.formatter.exs` file
|
||||
at the root of the project. In this file, the dependency can export a `:export` option with
|
||||
configuration to export. For now, only one option is supported under `:export`:
|
||||
`:locals_without_parens` (whose value has the same shape as the value of the
|
||||
`:locals_without_parens` in `Code.format_string!/2`).
|
||||
A dependency that wants to export formatter configuration needs to have a
|
||||
`.formatter.exs` file at the root of the project. In this file, the dependency
|
||||
can export a `:export` option with configuration to export. For now, only one
|
||||
option is supported under `:export`: `:locals_without_parens` (whose value has
|
||||
the same shape as the value of the `:locals_without_parens` in `Code.format_string!/2`).
|
||||
|
||||
The functions listed under `:locals_without_parens` in the `:export` option of a dependency
|
||||
can be imported in a project by listing that dependency in the `:import_deps`
|
||||
option of the formatter configuration file of the project.
|
||||
The functions listed under `:locals_without_parens` in the `:export` option of
|
||||
a dependency can be imported in a project by listing that dependency in the
|
||||
`:import_deps` option of the formatter configuration file of the project.
|
||||
|
||||
For example, consider I have a project `my_app` that depends on `my_dep`.
|
||||
`my_dep` wants to export some configuration, so `my_dep/.formatter.exs`
|
||||
@@ -121,94 +125,140 @@ defmodule Mix.Tasks.Format do
|
||||
dry_run: :boolean
|
||||
]
|
||||
|
||||
@deps_manifest "cached_formatter_deps"
|
||||
@manifest "cached_dot_formatter"
|
||||
@manifest_vsn 1
|
||||
|
||||
def run(args) do
|
||||
{opts, args} = OptionParser.parse!(args, strict: @switches)
|
||||
formatter_opts = eval_dot_formatter(opts)
|
||||
formatter_opts = fetch_deps_opts(formatter_opts)
|
||||
{dot_formatter, formatter_opts} = eval_dot_formatter(opts)
|
||||
|
||||
{formatter_opts_and_subs, _sources} =
|
||||
eval_deps_and_subdirectories(dot_formatter, [], formatter_opts, [dot_formatter])
|
||||
|
||||
args
|
||||
|> expand_args(formatter_opts)
|
||||
|> Task.async_stream(&format_file(&1, opts, formatter_opts), ordered: false, timeout: 30000)
|
||||
|> expand_args(dot_formatter, formatter_opts_and_subs)
|
||||
|> Task.async_stream(&format_file(&1, opts), ordered: false, timeout: 30000)
|
||||
|> Enum.reduce({[], [], []}, &collect_status/2)
|
||||
|> check!()
|
||||
end
|
||||
|
||||
defp eval_dot_formatter(opts) do
|
||||
case dot_formatter(opts) do
|
||||
{:ok, dot_formatter} -> eval_file_with_keyword_list(dot_formatter)
|
||||
:error -> []
|
||||
end
|
||||
end
|
||||
|
||||
defp dot_formatter(opts) do
|
||||
cond do
|
||||
dot_formatter = opts[:dot_formatter] -> {:ok, dot_formatter}
|
||||
File.regular?(".formatter.exs") -> {:ok, ".formatter.exs"}
|
||||
true -> :error
|
||||
end
|
||||
end
|
||||
dot_formatter = opts[:dot_formatter] ->
|
||||
{dot_formatter, eval_file_with_keyword_list(dot_formatter)}
|
||||
|
||||
# This function reads exported configuration from the imported dependencies and deals with
|
||||
# caching the result of reading such configuration in a manifest file.
|
||||
defp fetch_deps_opts(formatter_opts) do
|
||||
deps = Keyword.get(formatter_opts, :import_deps, [])
|
||||
|
||||
cond do
|
||||
deps == [] ->
|
||||
formatter_opts
|
||||
|
||||
is_list(deps) ->
|
||||
# Since we have dependencies listed, we write the manifest even if those dependencies
|
||||
# don't export anything so that we avoid lookups everytime.
|
||||
deps_manifest = Path.join(Mix.Project.manifest_path(), @deps_manifest)
|
||||
|
||||
dep_parenless_calls =
|
||||
if deps_dot_formatters_stale?(deps_manifest) do
|
||||
dep_parenless_calls = eval_deps_opts(deps)
|
||||
write_deps_manifest(deps_manifest, dep_parenless_calls)
|
||||
dep_parenless_calls
|
||||
else
|
||||
read_deps_manifest(deps_manifest)
|
||||
end
|
||||
|
||||
Keyword.update(
|
||||
formatter_opts,
|
||||
:locals_without_parens,
|
||||
dep_parenless_calls,
|
||||
&(&1 ++ dep_parenless_calls)
|
||||
)
|
||||
File.regular?(".formatter.exs") ->
|
||||
{".formatter.exs", eval_file_with_keyword_list(".formatter.exs")}
|
||||
|
||||
true ->
|
||||
Mix.raise("Expected :import_deps to return a list of dependencies, got: #{inspect(deps)}")
|
||||
{".formatter.exs", []}
|
||||
end
|
||||
end
|
||||
|
||||
defp deps_dot_formatters_stale?(deps_manifest) do
|
||||
Mix.Utils.stale?([".formatter.exs" | Mix.Project.config_files()], [deps_manifest])
|
||||
# This function reads exported configuration from the imported
|
||||
# dependencies and subdirectories and deals with caching the result
|
||||
# of reading such configuration in a manifest file.
|
||||
defp eval_deps_and_subdirectories(dot_formatter, prefix, formatter_opts, sources) do
|
||||
deps = Keyword.get(formatter_opts, :import_deps, [])
|
||||
subs = Keyword.get(formatter_opts, :subdirectories, [])
|
||||
|
||||
if not is_list(deps) do
|
||||
Mix.raise("Expected :import_deps to return a list of dependencies, got: #{inspect(deps)}")
|
||||
end
|
||||
|
||||
if not is_list(subs) do
|
||||
Mix.raise("Expected :subdirectories to return a list of directories, got: #{inspect(subs)}")
|
||||
end
|
||||
|
||||
if deps == [] and subs == [] do
|
||||
{{formatter_opts, []}, sources}
|
||||
else
|
||||
manifest = Path.join(Mix.Project.manifest_path(), @manifest)
|
||||
|
||||
maybe_cache_in_manifest(dot_formatter, manifest, fn ->
|
||||
{subdirectories, sources} = eval_subs_opts(subs, prefix, sources)
|
||||
{{eval_deps_opts(formatter_opts, deps), subdirectories}, sources}
|
||||
end)
|
||||
end
|
||||
end
|
||||
|
||||
defp read_deps_manifest(deps_manifest) do
|
||||
deps_manifest |> File.read!() |> :erlang.binary_to_term()
|
||||
defp maybe_cache_in_manifest(dot_formatter, manifest, fun) do
|
||||
cond do
|
||||
is_nil(Mix.Project.get()) or dot_formatter != ".formatter.exs" -> fun.()
|
||||
entry = read_manifest(manifest) -> entry
|
||||
true -> write_manifest!(manifest, fun.())
|
||||
end
|
||||
end
|
||||
|
||||
defp write_deps_manifest(deps_manifest, parenless_calls) do
|
||||
File.mkdir_p!(Path.dirname(deps_manifest))
|
||||
File.write!(deps_manifest, :erlang.term_to_binary(parenless_calls))
|
||||
def read_manifest(manifest) do
|
||||
with {:ok, binary} <- File.read(manifest),
|
||||
{:ok, {@manifest_vsn, entry, sources}} <- safe_binary_to_term(binary),
|
||||
expanded_sources = Enum.flat_map(sources, &Path.wildcard(&1, match_dot: true)),
|
||||
false <- Mix.Utils.stale?(Mix.Project.config_files() ++ expanded_sources, [manifest]) do
|
||||
{entry, sources}
|
||||
else
|
||||
_ -> nil
|
||||
end
|
||||
end
|
||||
|
||||
defp eval_deps_opts(deps) do
|
||||
defp safe_binary_to_term(binary) do
|
||||
{:ok, :erlang.binary_to_term(binary)}
|
||||
rescue
|
||||
_ -> :error
|
||||
end
|
||||
|
||||
defp write_manifest!(manifest, {entry, sources}) do
|
||||
File.mkdir_p!(Path.dirname(manifest))
|
||||
File.write!(manifest, :erlang.term_to_binary({@manifest_vsn, entry, sources}))
|
||||
{entry, sources}
|
||||
end
|
||||
|
||||
defp eval_deps_opts(formatter_opts, []) do
|
||||
formatter_opts
|
||||
end
|
||||
|
||||
defp eval_deps_opts(formatter_opts, deps) do
|
||||
deps_paths = Mix.Project.deps_paths()
|
||||
|
||||
for dep <- deps,
|
||||
dep_path = assert_valid_dep_and_fetch_path(dep, deps_paths),
|
||||
dep_dot_formatter = Path.join(dep_path, ".formatter.exs"),
|
||||
File.regular?(dep_dot_formatter),
|
||||
dep_opts = eval_file_with_keyword_list(dep_dot_formatter),
|
||||
parenless_call <- dep_opts[:export][:locals_without_parens] || [],
|
||||
uniq: true,
|
||||
do: parenless_call
|
||||
parenless_calls =
|
||||
for dep <- deps,
|
||||
dep_path = assert_valid_dep_and_fetch_path(dep, deps_paths),
|
||||
dep_dot_formatter = Path.join(dep_path, ".formatter.exs"),
|
||||
File.regular?(dep_dot_formatter),
|
||||
dep_opts = eval_file_with_keyword_list(dep_dot_formatter),
|
||||
parenless_call <- dep_opts[:export][:locals_without_parens] || [],
|
||||
uniq: true,
|
||||
do: parenless_call
|
||||
|
||||
Keyword.update(
|
||||
formatter_opts,
|
||||
:locals_without_parens,
|
||||
parenless_calls,
|
||||
&(&1 ++ parenless_calls)
|
||||
)
|
||||
end
|
||||
|
||||
defp eval_subs_opts(subs, prefix, sources) do
|
||||
{subs, sources} =
|
||||
Enum.flat_map_reduce(subs, sources, fn sub, sources ->
|
||||
prefix = Path.join(prefix ++ [sub])
|
||||
{Path.wildcard(prefix), [Path.join(prefix, ".formatter.exs") | sources]}
|
||||
end)
|
||||
|
||||
Enum.flat_map_reduce(subs, sources, fn sub, sources ->
|
||||
sub_formatter = Path.join(sub, ".formatter.exs")
|
||||
|
||||
if File.exists?(sub_formatter) do
|
||||
formatter_opts = eval_file_with_keyword_list(sub_formatter)
|
||||
|
||||
{formatter_opts_and_subs, sources} =
|
||||
eval_deps_and_subdirectories(:in_memory, [sub], formatter_opts, sources)
|
||||
|
||||
{[{sub, formatter_opts_and_subs}], sources}
|
||||
else
|
||||
{[], sources}
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
defp assert_valid_dep_and_fetch_path(dep, deps_paths) when is_atom(dep) do
|
||||
@@ -226,7 +276,7 @@ defmodule Mix.Tasks.Format do
|
||||
:error ->
|
||||
Mix.raise(
|
||||
"Unknown dependency #{inspect(dep)} given to :import_deps in the formatter configuration. " <>
|
||||
"The dependency is not listed in your mix.exs file"
|
||||
"The dependency is not listed in your mix.exs for environment #{inspect(Mix.env())}"
|
||||
)
|
||||
end
|
||||
end
|
||||
@@ -245,22 +295,20 @@ defmodule Mix.Tasks.Format do
|
||||
opts
|
||||
end
|
||||
|
||||
defp expand_args([], formatter_opts) do
|
||||
if inputs = formatter_opts[:inputs] do
|
||||
expand_files_and_patterns(List.wrap(inputs), ".formatter.exs")
|
||||
else
|
||||
defp expand_args([], dot_formatter, formatter_opts_and_subs) do
|
||||
if no_entries_in_formatter_opts?(formatter_opts_and_subs) do
|
||||
Mix.raise(
|
||||
"Expected one or more files/patterns to be given to mix format " <>
|
||||
"or for a .formatter.exs to exist with an :inputs key"
|
||||
"or for a .formatter.exs to exist with an :inputs or :subdirectories key"
|
||||
)
|
||||
end
|
||||
|
||||
dot_formatter
|
||||
|> expand_dot_inputs([], formatter_opts_and_subs, %{})
|
||||
|> Enum.uniq()
|
||||
end
|
||||
|
||||
defp expand_args(files_and_patterns, _formatter_opts) do
|
||||
expand_files_and_patterns(files_and_patterns, "command line")
|
||||
end
|
||||
|
||||
defp expand_files_and_patterns(files_and_patterns, context) do
|
||||
defp expand_args(files_and_patterns, _dot_formatter, {formatter_opts, subs}) do
|
||||
files =
|
||||
for file_or_pattern <- files_and_patterns,
|
||||
file <- stdin_or_wildcard(file_or_pattern),
|
||||
@@ -269,12 +317,48 @@ defmodule Mix.Tasks.Format do
|
||||
|
||||
if files == [] do
|
||||
Mix.raise(
|
||||
"Could not find a file to format. The files/patterns from #{context} " <>
|
||||
"Could not find a file to format. The files/patterns given to command line " <>
|
||||
"did not point to any existing file. Got: #{inspect(files_and_patterns)}"
|
||||
)
|
||||
end
|
||||
|
||||
files
|
||||
for file <- files do
|
||||
if file == :stdin do
|
||||
{file, formatter_opts}
|
||||
else
|
||||
split = file |> Path.relative_to_cwd() |> Path.split()
|
||||
{file, find_formatter_opts_for_file(split, {formatter_opts, subs})}
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
defp expand_dot_inputs(dot_formatter, prefix, {formatter_opts, subs}, acc) do
|
||||
if no_entries_in_formatter_opts?({formatter_opts, subs}) do
|
||||
Mix.raise("Expected :inputs or :subdirectories key in #{dot_formatter}")
|
||||
end
|
||||
|
||||
map =
|
||||
for input <- List.wrap(formatter_opts[:inputs]),
|
||||
file <- Path.wildcard(Path.join(prefix ++ [input])),
|
||||
do: {file, formatter_opts},
|
||||
into: %{}
|
||||
|
||||
Enum.reduce(subs, Map.merge(acc, map), fn {sub, formatter_opts_and_subs}, acc ->
|
||||
sub_formatter = Path.join(sub, ".formatter.exs")
|
||||
expand_dot_inputs(sub_formatter, [sub], formatter_opts_and_subs, acc)
|
||||
end)
|
||||
end
|
||||
|
||||
defp find_formatter_opts_for_file(split, {formatter_opts, subs}) do
|
||||
Enum.find_value(subs, formatter_opts, fn {sub, formatter_opts_and_subs} ->
|
||||
if List.starts_with?(split, Path.split(sub)) do
|
||||
find_formatter_opts_for_file(split, formatter_opts_and_subs)
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
defp no_entries_in_formatter_opts?({formatter_opts, subs}) do
|
||||
is_nil(formatter_opts[:inputs]) and subs == []
|
||||
end
|
||||
|
||||
defp stdin_or_wildcard("-"), do: [:stdin]
|
||||
@@ -288,7 +372,7 @@ defmodule Mix.Tasks.Format do
|
||||
{File.read!(file), file: file}
|
||||
end
|
||||
|
||||
defp format_file(file, task_opts, formatter_opts) do
|
||||
defp format_file({file, formatter_opts}, task_opts) do
|
||||
{input, extra_opts} = read_file(file)
|
||||
output = IO.iodata_to_binary([Code.format_string!(input, extra_opts ++ formatter_opts), ?\n])
|
||||
|
||||
|
||||
@@ -255,7 +255,8 @@ defmodule Mix.Tasks.New do
|
||||
embed_template(:formatter_umbrella, """
|
||||
# Used by "mix format"
|
||||
[
|
||||
inputs: ["mix.exs", "apps/*/mix.exs", "apps/*/{config,lib,test}/**/*.{ex,exs}"]
|
||||
inputs: ["mix.exs", "config/*.exs"],
|
||||
subdirectories: ["apps/*"]
|
||||
]
|
||||
""")
|
||||
|
||||
|
||||
@@ -152,7 +152,7 @@ defmodule Mix.Tasks.Profile.Eprof do
|
||||
def profile(fun, opts) do
|
||||
fun
|
||||
|> profile_and_analyse(opts)
|
||||
|> print_output
|
||||
|> print_output()
|
||||
end
|
||||
|
||||
defp profile_and_analyse(fun, opts) do
|
||||
@@ -165,11 +165,15 @@ defmodule Mix.Tasks.Profile.Eprof do
|
||||
:eprof.profile([], fun, matching_pattern(opts))
|
||||
|
||||
results =
|
||||
:eprof.dump()
|
||||
|> extract_results
|
||||
|> filter_results(opts)
|
||||
|> sort_results(opts)
|
||||
|> add_totals
|
||||
Enum.map(:eprof.dump(), fn {pid, call_results} ->
|
||||
parsed_calls =
|
||||
call_results
|
||||
|> filter_results(opts)
|
||||
|> sort_results(opts)
|
||||
|> add_totals()
|
||||
|
||||
{pid, parsed_calls}
|
||||
end)
|
||||
|
||||
:eprof.stop()
|
||||
|
||||
@@ -191,9 +195,6 @@ defmodule Mix.Tasks.Profile.Eprof do
|
||||
end
|
||||
end
|
||||
|
||||
defp extract_results([]), do: []
|
||||
defp extract_results([{_pid, call_results}]), do: call_results
|
||||
|
||||
defp filter_results(call_results, opts) do
|
||||
calls_opt = Keyword.get(opts, :calls, 0)
|
||||
time_opt = Keyword.get(opts, :time, 0)
|
||||
@@ -227,14 +228,23 @@ defmodule Mix.Tasks.Profile.Eprof do
|
||||
|
||||
@header ["#", "CALLS", "%", "TIME", "µS/CALL"]
|
||||
|
||||
defp print_output({0, _, _, _}), do: print_function_count(0)
|
||||
defp print_output([]) do
|
||||
print_function_count(0)
|
||||
end
|
||||
|
||||
defp print_output({function_count, call_results, call_count, total_time}) do
|
||||
defp print_output(results) do
|
||||
Enum.each(results, &print_result/1)
|
||||
end
|
||||
|
||||
defp print_result({pid, {function_count, call_results, call_count, total_time}}) do
|
||||
formatted_rows = Enum.map(call_results, &format_row(&1, total_time))
|
||||
formatted_total = format_total(total_time, call_count)
|
||||
|
||||
column_lengths = column_lengths(@header, formatted_rows)
|
||||
|
||||
IO.puts("")
|
||||
|
||||
print_pid_row(pid)
|
||||
print_row(@header, column_lengths)
|
||||
print_row(formatted_total, column_lengths)
|
||||
Enum.each(formatted_rows, &print_row(&1, column_lengths))
|
||||
@@ -244,6 +254,10 @@ defmodule Mix.Tasks.Profile.Eprof do
|
||||
print_function_count(function_count)
|
||||
end
|
||||
|
||||
defp print_pid_row(pid) do
|
||||
IO.puts("Profile results of #{inspect(pid)}")
|
||||
end
|
||||
|
||||
defp format_row({{module, function, arity}, {count, time}}, total_time) do
|
||||
mfa = Exception.format_mfa(module, function, arity)
|
||||
time_percentage = :erlang.float_to_binary(100 * divide(time, total_time), [{:decimals, 2}])
|
||||
|
||||
@@ -63,7 +63,7 @@ defmodule Mix.Tasks.Xref do
|
||||
Prints a file dependency graph where an edge from `A` to `B` indicates
|
||||
that `A` depends on `B`.
|
||||
|
||||
mix xref graph --format dot
|
||||
mix xref graph --format stats
|
||||
|
||||
The following options are accepted:
|
||||
|
||||
|
||||
@@ -249,6 +249,9 @@ defmodule Mix.RebarTest do
|
||||
end
|
||||
end
|
||||
|
||||
# We run only on Unix because Windows has a hard time
|
||||
# removing the rebar executable after executed.
|
||||
@tag [unix: true]
|
||||
test "applies variables from :system_env option when compiling dependencies for Rebar" do
|
||||
Mix.Project.push(RebarAsDepWithEnv)
|
||||
|
||||
@@ -294,6 +297,9 @@ defmodule Mix.RebarTest do
|
||||
end
|
||||
end
|
||||
|
||||
# We run only on Unix because Windows has a hard time
|
||||
# removing the rebar executable after executed.
|
||||
@tag [unix: true]
|
||||
test "applies variables from :system_env option when compiling dependencies for rebar3" do
|
||||
Mix.Project.push(Rebar3AsDep)
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ defmodule Mix.Tasks.FormatTest do
|
||||
end
|
||||
|
||||
test "formats the given files", context do
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!("a.ex", """
|
||||
foo bar
|
||||
""")
|
||||
@@ -26,11 +26,11 @@ defmodule Mix.Tasks.FormatTest do
|
||||
assert File.read!("a.ex") == """
|
||||
foo(bar)
|
||||
"""
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "formats the given pattern", context do
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!("a.ex", """
|
||||
foo bar
|
||||
""")
|
||||
@@ -40,11 +40,11 @@ defmodule Mix.Tasks.FormatTest do
|
||||
assert File.read!("a.ex") == """
|
||||
foo(bar)
|
||||
"""
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "is a no-op if the file is already formatted", context do
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!("a.ex", """
|
||||
foo(bar)
|
||||
""")
|
||||
@@ -52,11 +52,11 @@ defmodule Mix.Tasks.FormatTest do
|
||||
File.touch!("a.ex", {{2000, 1, 1}, {0, 0, 0}})
|
||||
Mix.Tasks.Format.run(["a.ex"])
|
||||
assert File.stat!("a.ex").mtime == {{2000, 1, 1}, {0, 0, 0}}
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "does not write file to disk on dry-run", context do
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!("a.ex", """
|
||||
foo bar
|
||||
""")
|
||||
@@ -66,11 +66,11 @@ defmodule Mix.Tasks.FormatTest do
|
||||
assert File.read!("a.ex") == """
|
||||
foo bar
|
||||
"""
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "reads file from stdin and prints to stdout", context do
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!("a.ex", """
|
||||
foo bar
|
||||
""")
|
||||
@@ -87,11 +87,28 @@ defmodule Mix.Tasks.FormatTest do
|
||||
assert File.read!("a.ex") == """
|
||||
foo(bar)
|
||||
"""
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "reads file from stdin and prints to stdout with formatter", context do
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!(".formatter.exs", """
|
||||
[locals_without_parens: [foo: 1]]
|
||||
""")
|
||||
|
||||
output =
|
||||
capture_io("foo :bar", fn ->
|
||||
Mix.Tasks.Format.run(["-"])
|
||||
end)
|
||||
|
||||
assert output == """
|
||||
foo :bar
|
||||
"""
|
||||
end)
|
||||
end
|
||||
|
||||
test "checks if file is formatted with --check-formatted", context do
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!("a.ex", """
|
||||
foo bar
|
||||
""")
|
||||
@@ -110,7 +127,7 @@ defmodule Mix.Tasks.FormatTest do
|
||||
assert File.read!("a.ex") == """
|
||||
foo(bar)
|
||||
"""
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "checks if stdin is formatted with --check-formatted" do
|
||||
@@ -129,7 +146,7 @@ defmodule Mix.Tasks.FormatTest do
|
||||
end
|
||||
|
||||
test "checks if file is equivalent with --check-equivalent", context do
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!("a.ex", """
|
||||
foo bar
|
||||
""")
|
||||
@@ -139,11 +156,11 @@ defmodule Mix.Tasks.FormatTest do
|
||||
assert File.read!("a.ex") == """
|
||||
foo(bar)
|
||||
"""
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "uses inputs and configuration from .formatter.exs", context do
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!(".formatter.exs", """
|
||||
[
|
||||
inputs: ["a.ex"],
|
||||
@@ -160,11 +177,11 @@ defmodule Mix.Tasks.FormatTest do
|
||||
assert File.read!("a.ex") == """
|
||||
foo bar(baz)
|
||||
"""
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "uses inputs and configuration from --dot-formatter", context do
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!("custom_formatter.exs", """
|
||||
[
|
||||
inputs: ["a.ex"],
|
||||
@@ -181,13 +198,62 @@ defmodule Mix.Tasks.FormatTest do
|
||||
assert File.read!("a.ex") == """
|
||||
foo bar(baz)
|
||||
"""
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "can read exported configuration from subdirectories", context do
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!(".formatter.exs", """
|
||||
[subdirectories: ["lib"]]
|
||||
""")
|
||||
|
||||
File.mkdir_p!("lib")
|
||||
|
||||
File.write!("lib/.formatter.exs", """
|
||||
[inputs: "a.ex", locals_without_parens: [my_fun: 2]]
|
||||
""")
|
||||
|
||||
File.write!("lib/a.ex", """
|
||||
my_fun :foo, :bar
|
||||
other_fun :baz
|
||||
""")
|
||||
|
||||
Mix.Tasks.Format.run([])
|
||||
|
||||
assert File.read!("lib/a.ex") == """
|
||||
my_fun :foo, :bar
|
||||
other_fun(:baz)
|
||||
"""
|
||||
|
||||
Mix.Tasks.Format.run(["lib/a.ex"])
|
||||
|
||||
assert File.read!("lib/a.ex") == """
|
||||
my_fun :foo, :bar
|
||||
other_fun(:baz)
|
||||
"""
|
||||
|
||||
# No caching without a project
|
||||
manifest_path = Path.join(Mix.Project.manifest_path(), "cached_dot_formatter")
|
||||
refute File.regular?(manifest_path)
|
||||
|
||||
# Caching with a project
|
||||
Mix.Project.push(__MODULE__.FormatWithDepsApp)
|
||||
Mix.Tasks.Format.run(["lib/a.ex"])
|
||||
manifest_path = Path.join(Mix.Project.manifest_path(), "cached_dot_formatter")
|
||||
assert File.regular?(manifest_path)
|
||||
|
||||
# Let's check that the manifest gets updated if it's stale.
|
||||
File.touch!(manifest_path, {{1970, 1, 1}, {0, 0, 0}})
|
||||
|
||||
Mix.Tasks.Format.run(["lib/a.ex"])
|
||||
assert File.stat!(manifest_path).mtime > {{1970, 1, 1}, {0, 0, 0}}
|
||||
end)
|
||||
end
|
||||
|
||||
test "can read exported configuration from dependencies", context do
|
||||
Mix.Project.push(__MODULE__.FormatWithDepsApp)
|
||||
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!(".formatter.exs", """
|
||||
[import_deps: [:my_dep]]
|
||||
""")
|
||||
@@ -208,7 +274,7 @@ defmodule Mix.Tasks.FormatTest do
|
||||
my_fun :foo, :bar
|
||||
"""
|
||||
|
||||
manifest_path = Path.join(Mix.Project.manifest_path(), "cached_formatter_deps")
|
||||
manifest_path = Path.join(Mix.Project.manifest_path(), "cached_dot_formatter")
|
||||
assert File.regular?(manifest_path)
|
||||
|
||||
# Let's check that the manifest gets updated if it's stale.
|
||||
@@ -216,13 +282,116 @@ defmodule Mix.Tasks.FormatTest do
|
||||
|
||||
Mix.Tasks.Format.run(["a.ex"])
|
||||
assert File.stat!(manifest_path).mtime > {{1970, 1, 1}, {0, 0, 0}}
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "can read exported configuration from dependencies and subdirectories", context do
|
||||
Mix.Project.push(__MODULE__.FormatWithDepsApp)
|
||||
|
||||
in_tmp(context.test, fn ->
|
||||
File.mkdir_p!("deps/my_dep/")
|
||||
|
||||
File.write!("deps/my_dep/.formatter.exs", """
|
||||
[export: [locals_without_parens: [my_fun: 2]]]
|
||||
""")
|
||||
|
||||
File.mkdir_p!("lib/sub")
|
||||
File.mkdir_p!("lib/not_used_and_wont_raise")
|
||||
|
||||
File.write!(".formatter.exs", """
|
||||
[subdirectories: ["lib"]]
|
||||
""")
|
||||
|
||||
File.write!("lib/.formatter.exs", """
|
||||
[subdirectories: ["*"]]
|
||||
""")
|
||||
|
||||
File.write!("lib/sub/.formatter.exs", """
|
||||
[inputs: "a.ex", import_deps: [:my_dep]]
|
||||
""")
|
||||
|
||||
File.write!("lib/sub/a.ex", """
|
||||
my_fun :foo, :bar
|
||||
other_fun :baz
|
||||
""")
|
||||
|
||||
Mix.Tasks.Format.run([])
|
||||
|
||||
assert File.read!("lib/sub/a.ex") == """
|
||||
my_fun :foo, :bar
|
||||
other_fun(:baz)
|
||||
"""
|
||||
|
||||
Mix.Tasks.Format.run(["lib/sub/a.ex"])
|
||||
|
||||
assert File.read!("lib/sub/a.ex") == """
|
||||
my_fun :foo, :bar
|
||||
other_fun(:baz)
|
||||
"""
|
||||
|
||||
# Update .formatter.exs, check that file is updated
|
||||
File.write!("lib/sub/.formatter.exs", """
|
||||
[inputs: "a.ex"]
|
||||
""")
|
||||
|
||||
File.touch!("lib/sub/.formatter.exs", {{2030, 1, 1}, {0, 0, 0}})
|
||||
Mix.Tasks.Format.run([])
|
||||
|
||||
assert File.read!("lib/sub/a.ex") == """
|
||||
my_fun(:foo, :bar)
|
||||
other_fun(:baz)
|
||||
"""
|
||||
|
||||
# Add a new entry to "lib" and it also gets picked.
|
||||
File.mkdir_p!("lib/extra")
|
||||
|
||||
File.write!("lib/extra/.formatter.exs", """
|
||||
[inputs: "a.ex", locals_without_parens: [other_fun: 1]]
|
||||
""")
|
||||
|
||||
File.write!("lib/extra/a.ex", """
|
||||
my_fun :foo, :bar
|
||||
other_fun :baz
|
||||
""")
|
||||
|
||||
File.touch!("lib/extra/.formatter.exs", {{2030, 1, 1}, {0, 0, 0}})
|
||||
Mix.Tasks.Format.run([])
|
||||
|
||||
assert File.read!("lib/extra/a.ex") == """
|
||||
my_fun(:foo, :bar)
|
||||
other_fun :baz
|
||||
"""
|
||||
end)
|
||||
end
|
||||
|
||||
test "validates subdirectories in :subdirectories", context do
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!(".formatter.exs", """
|
||||
[subdirectories: "oops"]
|
||||
""")
|
||||
|
||||
message = "Expected :subdirectories to return a list of directories, got: \"oops\""
|
||||
assert_raise Mix.Error, message, fn -> Mix.Tasks.Format.run([]) end
|
||||
|
||||
File.write!(".formatter.exs", """
|
||||
[subdirectories: ["lib"]]
|
||||
""")
|
||||
|
||||
File.mkdir_p!("lib")
|
||||
|
||||
File.write!("lib/.formatter.exs", """
|
||||
[]
|
||||
""")
|
||||
|
||||
message = "Expected :inputs or :subdirectories key in lib/.formatter.exs"
|
||||
assert_raise Mix.Error, message, fn -> Mix.Tasks.Format.run([]) end
|
||||
end)
|
||||
end
|
||||
|
||||
test "validates dependencies in :import_deps", context do
|
||||
Mix.Project.push(__MODULE__.FormatWithDepsApp)
|
||||
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!(".formatter.exs", """
|
||||
[import_deps: [:my_dep]]
|
||||
""")
|
||||
@@ -239,14 +408,14 @@ defmodule Mix.Tasks.FormatTest do
|
||||
|
||||
message =
|
||||
"Unknown dependency :nonexistent_dep given to :import_deps in the formatter configuration. " <>
|
||||
"The dependency is not listed in your mix.exs file"
|
||||
"The dependency is not listed in your mix.exs for environment :dev"
|
||||
|
||||
assert_raise Mix.Error, message, fn -> Mix.Tasks.Format.run([]) end
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "raises on invalid arguments", context do
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
assert_raise Mix.Error, ~r"Expected one or more files\/patterns to be given", fn ->
|
||||
Mix.Tasks.Format.run([])
|
||||
end
|
||||
@@ -254,11 +423,11 @@ defmodule Mix.Tasks.FormatTest do
|
||||
assert_raise Mix.Error, ~r"Could not find a file to format", fn ->
|
||||
Mix.Tasks.Format.run(["unknown.whatever"])
|
||||
end
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "raises SyntaxError when parsing invalid source file", context do
|
||||
in_tmp context.test, fn ->
|
||||
in_tmp(context.test, fn ->
|
||||
File.write!("a.ex", """
|
||||
defmodule <%= module %>.Bar do end
|
||||
""")
|
||||
@@ -268,6 +437,6 @@ defmodule Mix.Tasks.FormatTest do
|
||||
end
|
||||
|
||||
assert_received {:mix_shell, :error, ["mix format failed for file: a.ex"]}
|
||||
end
|
||||
end)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -18,6 +18,14 @@ defmodule Mix.Tasks.Profile.EprofTest do
|
||||
end
|
||||
end
|
||||
|
||||
test "profiles evaluated expression in multiple processes", context do
|
||||
in_tmp context.test, fn ->
|
||||
assert capture_io(fn ->
|
||||
Eprof.run(["-e", "spawn(fn -> #{@expr} end)"])
|
||||
end) =~ ~r(String\.Chars\.Integer\.to_string\/1\s+\d)
|
||||
end
|
||||
end
|
||||
|
||||
test "profiles the script", context do
|
||||
in_tmp context.test, fn ->
|
||||
profile_script_name = "profile_script.ex"
|
||||
|
||||
@@ -48,34 +48,31 @@ defmodule Mix.UtilsTest do
|
||||
end
|
||||
|
||||
test "symlink or copy" do
|
||||
in_fixture "archive", fn ->
|
||||
in_fixture("archive", fn ->
|
||||
File.mkdir_p!("_build/archive")
|
||||
result = Mix.Utils.symlink_or_copy(Path.expand("ebin"), Path.expand("_build/archive/ebin"))
|
||||
assert_ebin_symlinked_or_copied(result)
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
test "symlink or copy removes previous directories" do
|
||||
in_fixture "archive", fn ->
|
||||
in_fixture("archive", fn ->
|
||||
File.mkdir_p!("_build/archive/ebin")
|
||||
result = Mix.Utils.symlink_or_copy(Path.expand("ebin"), Path.expand("_build/archive/ebin"))
|
||||
assert_ebin_symlinked_or_copied(result)
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
@windows? match?({:win32, _}, :os.type())
|
||||
unless @windows? do
|
||||
test "symlink or copy erases wrong symlinks" do
|
||||
in_fixture "archive", fn ->
|
||||
File.mkdir_p!("_build/archive")
|
||||
Mix.Utils.symlink_or_copy(Path.expand("priv"), Path.expand("_build/archive/ebin"))
|
||||
@tag unix: true
|
||||
test "symlink or copy erases wrong symlinks" do
|
||||
in_fixture("archive", fn ->
|
||||
File.mkdir_p!("_build/archive")
|
||||
build_ebin = Path.expand("_build/archive/ebin")
|
||||
Mix.Utils.symlink_or_copy(Path.expand("priv"), build_ebin)
|
||||
|
||||
result =
|
||||
Mix.Utils.symlink_or_copy(Path.expand("ebin"), Path.expand("_build/archive/ebin"))
|
||||
|
||||
assert_ebin_symlinked_or_copied(result)
|
||||
end
|
||||
end
|
||||
result = Mix.Utils.symlink_or_copy(Path.expand("ebin"), build_ebin)
|
||||
assert_ebin_symlinked_or_copied(result)
|
||||
end)
|
||||
end
|
||||
|
||||
test "proxy_config reads from env and returns credentials" do
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
Mix.start()
|
||||
Mix.shell(Mix.Shell.Process)
|
||||
Application.put_env(:mix, :colors, enabled: false)
|
||||
ExUnit.start(trace: "--trace" in System.argv())
|
||||
|
||||
exclude = if match?({:win32, _}, :os.type()), do: [unix: true], else: [windows: true]
|
||||
ExUnit.start(trace: "--trace" in System.argv(), exclude: exclude)
|
||||
|
||||
unless {1, 7, 4} <= Mix.SCM.Git.git_version() do
|
||||
IO.puts(:stderr, "Skipping tests with git sparse checkouts...")
|
||||
|
||||
Reference in New Issue
Block a user