Change multi-line `do:` function definitions to `do` (#3)

Change the cases where a `do:` is followed by a `mix format` mandated
line break, or if the expression following the `do:` would span multiple
lines anyway.

The only exception to the rule above is the first change in the
changeset, as this was done for the function style of `initial_rating`
to be consistent with `initial_rating_deviation`.
This commit is contained in:
Mikael Muszynski 2020-01-19 15:54:18 +01:00 committed by James
parent 1175f6b2c2
commit db54b10e93
2 changed files with 31 additions and 19 deletions

View File

@ -56,7 +56,10 @@ defmodule Glicko.Player do
""" """
@spec initial_rating(version) :: rating @spec initial_rating(version) :: rating
def initial_rating(_version = :v1), do: 1500.0 def initial_rating(_version = :v1), do: 1500.0
def initial_rating(_version = :v2), do: :v1 |> initial_rating |> scale_rating_to(:v2)
def initial_rating(_version = :v2) do
:v1 |> initial_rating |> scale_rating_to(:v2)
end
@doc """ @doc """
The recommended initial rating deviation value for a new player. The recommended initial rating deviation value for a new player.
@ -64,8 +67,9 @@ defmodule Glicko.Player do
@spec initial_rating_deviation(version) :: rating_deviation @spec initial_rating_deviation(version) :: rating_deviation
def initial_rating_deviation(_version = :v1), do: 350.0 def initial_rating_deviation(_version = :v1), do: 350.0
def initial_rating_deviation(_version = :v2), def initial_rating_deviation(_version = :v2) do
do: :v1 |> initial_rating_deviation |> scale_rating_deviation_to(:v2) :v1 |> initial_rating_deviation |> scale_rating_deviation_to(:v2)
end
@doc """ @doc """
The recommended initial volatility value for a new player. The recommended initial volatility value for a new player.
@ -79,11 +83,12 @@ defmodule Glicko.Player do
If not overriden, will use the default values for an unrated player. If not overriden, will use the default values for an unrated player.
""" """
@spec new_v1(rating: rating, rating_deviation: rating_deviation) :: v1 @spec new_v1(rating: rating, rating_deviation: rating_deviation) :: v1
def new_v1(opts \\ []) when is_list(opts), def new_v1(opts \\ []) when is_list(opts) do
do: { {
Keyword.get(opts, :rating, initial_rating(:v1)), Keyword.get(opts, :rating, initial_rating(:v1)),
Keyword.get(opts, :rating_deviation, initial_rating_deviation(:v1)) Keyword.get(opts, :rating_deviation, initial_rating_deviation(:v1))
} }
end
@doc """ @doc """
Creates a new v2 player. Creates a new v2 player.
@ -91,12 +96,13 @@ defmodule Glicko.Player do
If not overriden, will use default values for an unrated player. If not overriden, will use default values for an unrated player.
""" """
@spec new_v2(rating: rating, rating_deviation: rating_deviation, volatility: volatility) :: v2 @spec new_v2(rating: rating, rating_deviation: rating_deviation, volatility: volatility) :: v2
def new_v2(opts \\ []) when is_list(opts), def new_v2(opts \\ []) when is_list(opts) do
do: { {
Keyword.get(opts, :rating, initial_rating(:v2)), Keyword.get(opts, :rating, initial_rating(:v2)),
Keyword.get(opts, :rating_deviation, initial_rating_deviation(:v2)), Keyword.get(opts, :rating_deviation, initial_rating_deviation(:v2)),
Keyword.get(opts, :volatility, initial_volatility()) Keyword.get(opts, :volatility, initial_volatility())
} }
end
@doc """ @doc """
Converts a v2 player to a v1. Converts a v2 player to a v1.
@ -108,11 +114,12 @@ defmodule Glicko.Player do
@spec to_v1(player :: t) :: v1 @spec to_v1(player :: t) :: v1
def to_v1({rating, rating_deviation}), do: {rating, rating_deviation} def to_v1({rating, rating_deviation}), do: {rating, rating_deviation}
def to_v1({rating, rating_deviation, _}), def to_v1({rating, rating_deviation, _}) do
do: { {
rating |> scale_rating_to(:v1), rating |> scale_rating_to(:v1),
rating_deviation |> scale_rating_deviation_to(:v1) rating_deviation |> scale_rating_deviation_to(:v1)
} }
end
@doc """ @doc """
Converts a v1 player to a v2. Converts a v1 player to a v2.
@ -125,12 +132,13 @@ defmodule Glicko.Player do
def to_v2({rating, rating_deviation, volatility}, _volatility), def to_v2({rating, rating_deviation, volatility}, _volatility),
do: {rating, rating_deviation, volatility} do: {rating, rating_deviation, volatility}
def to_v2({rating, rating_deviation}, volatility), def to_v2({rating, rating_deviation}, volatility) do
do: { {
rating |> scale_rating_to(:v2), rating |> scale_rating_to(:v2),
rating_deviation |> scale_rating_deviation_to(:v2), rating_deviation |> scale_rating_deviation_to(:v2),
volatility volatility
} }
end
@doc """ @doc """
A version agnostic method for getting a player's rating. A version agnostic method for getting a player's rating.
@ -185,11 +193,12 @@ defmodule Glicko.Player do
be 95% confident about a players strength being in a small interval of values. be 95% confident about a players strength being in a small interval of values.
""" """
@spec rating_interval(player :: t) :: {rating_low :: float, rating_high :: float} @spec rating_interval(player :: t) :: {rating_low :: float, rating_high :: float}
def rating_interval(player, as_version \\ nil), def rating_interval(player, as_version \\ nil) do
do: { {
rating(player, as_version) - rating_deviation(player, as_version) * 2, rating(player, as_version) - rating_deviation(player, as_version) * 2,
rating(player, as_version) + rating_deviation(player, as_version) * 2 rating(player, as_version) + rating_deviation(player, as_version) * 2
} }
end
@doc """ @doc """
Scales a player's rating. Scales a player's rating.

15
mix.exs
View File

@ -5,8 +5,8 @@ defmodule Glicko.Mixfile do
Implementation of the Glicko rating system Implementation of the Glicko rating system
""" """
def project, def project do
do: [ [
app: :glicko, app: :glicko,
version: "0.6.0", version: "0.6.0",
elixir: "~> 1.9", elixir: "~> 1.9",
@ -15,19 +15,22 @@ defmodule Glicko.Mixfile do
package: package(), package: package(),
description: @description description: @description
] ]
end
defp deps, defp deps do
do: [ [
{:inch_ex, "~> 0.5", only: :docs}, {:inch_ex, "~> 0.5", only: :docs},
{:ex_doc, "~> 0.16", only: :dev, runtime: false}, {:ex_doc, "~> 0.16", only: :dev, runtime: false},
{:credo, "~> 0.8", only: [:dev, :test], runtime: false} {:credo, "~> 0.8", only: [:dev, :test], runtime: false}
] ]
end
defp package, defp package do
do: [ [
name: :glicko, name: :glicko,
maintainers: ["James Dyson"], maintainers: ["James Dyson"],
licenses: ["MIT"], licenses: ["MIT"],
links: %{"GitHub" => "https://github.com/avitex/elixir-glicko"} links: %{"GitHub" => "https://github.com/avitex/elixir-glicko"}
] ]
end
end end