Make tests compatible with Elixir 1.16 and 1.17

.github/workflows/ci.yaml

@@ -21,7 +21,7 @@ jobs:
       - run: mix credo --strict --format=sarif
 
   # dialyzer:
-  #   runs-on: ${{ matrix.os || 'ubuntu-20.04' }}
+  #   runs-on: ${{ matrix.os || 'ubuntu-22.04' }}
 
   #   steps:
   #     - uses: actions/[email protected]
@@ -53,7 +53,7 @@ jobs:
   #     - run: mix dialyzer --format github
 
   test:
-    runs-on: ${{ matrix.os || 'ubuntu-20.04' }}
+    runs-on: ${{ matrix.os || 'ubuntu-22.04' }}
     steps:
       - uses: actions/[email protected]
       - uses: actions/[email protected]
@@ -70,50 +70,30 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - elixir: 1.11.x
-            otp: 21.x
-            os: ubuntu-20.04
-          - elixir: 1.11.x
-            otp: 22.x
-            os: ubuntu-20.04
-          - elixir: 1.11.x
-            otp: 23.x
-            os: ubuntu-20.04
-          - elixir: 1.12.x
-            otp: 22.x
-            os: ubuntu-20.04
-          - elixir: 1.12.x
-            otp: 23.x
-            os: ubuntu-20.04
-          - elixir: 1.12.x
-            otp: 24.x
-            os: ubuntu-20.04
-          - elixir: 1.13.x
-            otp: 22.x
-            os: ubuntu-20.04
-          - elixir: 1.13.x
-            otp: 23.x
-            os: ubuntu-20.04
-          - elixir: 1.13.x
-            otp: 24.x
-            os: ubuntu-20.04
-          - elixir: 1.14.x
-            otp: 23.x
-            os: ubuntu-20.04
-          - elixir: 1.14.x
+          - elixir: 1.15.x
             otp: 24.x
-            os: ubuntu-20.04
-          - elixir: 1.14.x
+            os: ubuntu-24.04
+          - elixir: 1.15.x
             otp: 25.x
-            os: ubuntu-20.04
+            os: ubuntu-24.04
           - elixir: 1.15.x
+            otp: 26.x
+            os: ubuntu-24.04
+          - elixir: 1.16.x
             otp: 24.x
-            os: ubuntu-20.04
-          - elixir: 1.15.x
+            os: ubuntu-24.04
+          - elixir: 1.16.x
+            otp: 25.x
+            os: ubuntu-24.04
+          - elixir: 1.16.x
+            otp: 26.x
+            os: ubuntu-24.04
+          - elixir: 1.17.x
             otp: 25.x
-            os: ubuntu-20.04
-          # Something changed in otp 26 for seed and single test started producing failures
-          # it does not affect functionality, only CI
-          # - elixir: 1.15.x
-          #   otp: 26.x
-          #   os: ubuntu-20.04
+            os: ubuntu-24.04
+          - elixir: 1.17.x
+            otp: 26.x
+            os: ubuntu-24.04
+          - elixir: 1.17.x
+            otp: 27.x
+            os: ubuntu-24.04

CHANGELOG.md

@@ -10,6 +10,9 @@ Change log itself follows [Keep a CHANGELOG](http://keepachangelog.com) format.
 
 ### Added
 
+- Test with Elixir 1.16 and 1.17 on CI [[@ypconstante](https://github.com/ypconstante)]
+- Test with OTP 26 and 27 on CI [[@ypconstante](https://github.com/ypconstante)]
+
 ### Changed
 
 ### Deprecated
@@ -19,6 +22,7 @@ Change log itself follows [Keep a CHANGELOG](http://keepachangelog.com) format.
 ### Fixed
 
 - Fix compile and runtime warnings on Elixir 1.17 [[@ypconstante](https://github.com/ypconstante)]
+- `Faker.Internet.slug` and `Faker.Markdown.markdown/0` results won't change between Elixir versions [[@ypconstante](https://github.com/ypconstante)]
 
 ### Security
 

lib/faker.ex

@@ -130,6 +130,14 @@ defmodule Faker do
     Application.get_env(:faker, :random_module).random_bytes(total)
   end
 
+  @doc """
+  Returns a shuffled enum.
+  """
+  @spec shuffle(Enum.t()) :: list()
+  def shuffle(enum) do
+    Application.get_env(:faker, :random_module).shuffle(enum)
+  end
+
   defmacro localize(function) do
     quote do
       def unquote(function)() do

lib/faker/commerce/hy.ex

@@ -13,12 +13,6 @@ defmodule Faker.Commerce.Hy do
 
       iex> Faker.Commerce.Hy.color()
       "մոխրագույն"
-      iex> Faker.Commerce.Hy.color()
-      "կանաչ"
-      iex> Faker.Commerce.Hy.color()
-      "երկնագույն"
-      iex> Faker.Commerce.Hy.color()
-      "մանուշակագույն"
   """
   @spec color() :: String.t()
   def color do
@@ -32,12 +26,6 @@ defmodule Faker.Commerce.Hy do
 
       iex> Faker.Commerce.Hy.department()
       "Համակարգիչներ"
-      iex> Faker.Commerce.Hy.department()
-      "Երաժշտություն"
-      iex> Faker.Commerce.Hy.department()
-      "Գրքեր"
-      iex> Faker.Commerce.Hy.department()
-      "Էլեկտրոնիկա"
   """
   @spec department() :: String.t()
   sampler(:department, [
@@ -72,12 +60,6 @@ defmodule Faker.Commerce.Hy do
 
       iex> Faker.Commerce.Hy.product_name()
       "հիանալի բրոնզե գլխարկ"
-      iex> Faker.Commerce.Hy.product_name()
-      "ֆանտաստիկ դանակ"
-      iex> Faker.Commerce.Hy.product_name()
-      "պլաստիկից աթոռ"
-      iex> Faker.Commerce.Hy.product_name()
-      "ալյումինե վերնաշապիկ"
   """
   @spec product_name() :: String.t()
   def product_name, do: product_name(Faker.random_between(0, 2))
@@ -96,12 +78,6 @@ defmodule Faker.Commerce.Hy do
 
       iex> Faker.Commerce.Hy.product_name_adjective()
       "ֆանտաստիկ"
-      iex> Faker.Commerce.Hy.product_name_adjective()
-      "հիանալի"
-      iex> Faker.Commerce.Hy.product_name_adjective()
-      "միջակ"
-      iex> Faker.Commerce.Hy.product_name_adjective()
-      "նրբագեղ"
   """
   @spec product_name_adjective() :: String.t()
   sampler(:product_name_adjective, [
@@ -130,12 +106,6 @@ defmodule Faker.Commerce.Hy do
 
       iex> Faker.Commerce.Hy.product_name_material()
       "փայտե"
-      iex> Faker.Commerce.Hy.product_name_material()
-      "գրանիտե"
-      iex> Faker.Commerce.Hy.product_name_material()
-      "բրոնզե"
-      iex> Faker.Commerce.Hy.product_name_material()
-      "մարմարե"
   """
   @spec product_name_material() :: String.t()
   sampler(:product_name_material, [
@@ -165,12 +135,6 @@ defmodule Faker.Commerce.Hy do
 
       iex> Faker.Commerce.Hy.product_name_product()
       "վերնաշապիկ"
-      iex> Faker.Commerce.Hy.product_name_product()
-      "ստեղնաշար"
-      iex> Faker.Commerce.Hy.product_name_product()
-      "վերնաշապիկ"
-      iex> Faker.Commerce.Hy.product_name_product()
-      "գլխարկ"
   """
   @spec product_name_product() :: String.t()
   sampler(:product_name_product, [

lib/faker/file.ex

@@ -30,8 +30,8 @@ defmodule Faker.File do
       ~w(video/mpeg video/mp4 video/ogg video/quicktime video/webm video/x-matroska video/x-ms-wmv video/x-flv)
   }
 
-  @categories_extensions Map.keys(@extensions)
-  @categories_mimes Map.keys(@mimes)
+  @categories_extensions @extensions |> Map.keys() |> Enum.sort()
+  @categories_mimes @mimes |> Map.keys() |> Enum.sort()
 
   @doc """
   Returns a random file extension
@@ -40,12 +40,6 @@ defmodule Faker.File do
 
       iex> Faker.File.file_extension()
       "wav"
-      iex> Faker.File.file_extension()
-      "wav"
-      iex> Faker.File.file_extension()
-      "doc"
-      iex> Faker.File.file_extension()
-      "mov"
   """
   @spec file_extension() :: String.t()
   def file_extension do
@@ -62,12 +56,9 @@ defmodule Faker.File do
 
       iex> Faker.File.file_extension(:video)
       "mov"
+
       iex> Faker.File.file_extension(:image)
-      "tiff"
-      iex> Faker.File.file_extension(:audio)
-      "flac"
-      iex> Faker.File.file_extension(:office)
-      "xls"
+      "bmp"
   """
   @spec file_extension(atom) :: String.t()
   def file_extension(category) do
@@ -83,12 +74,6 @@ defmodule Faker.File do
 
       iex> Faker.File.file_name()
       "aliquam.jpg"
-      iex> Faker.File.file_name()
-      "deleniti.doc"
-      iex> Faker.File.file_name()
-      "qui.jpg"
-      iex> Faker.File.file_name()
-      "quibusdam.csv"
   """
   @spec file_name() :: String.t()
   def file_name do
@@ -105,10 +90,6 @@ defmodule Faker.File do
       "aliquam.txt"
       iex> Faker.File.file_name(:video)
       "sint.mp4"
-      iex> Faker.File.file_name(:image)
-      "consequatur.bmp"
-      iex> Faker.File.file_name(:audio)
-      "qui.wav"
   """
   @spec file_name(atom) :: String.t()
   def file_name(category) do
@@ -122,12 +103,6 @@ defmodule Faker.File do
 
       iex> Faker.File.mime_type()
       "text/css"
-      iex> Faker.File.mime_type()
-      "message/http"
-      iex> Faker.File.mime_type()
-      "application/ogg"
-      iex> Faker.File.mime_type()
-      "model/x3d+xml"
   """
   @spec mime_type :: String.t()
   def mime_type do
@@ -145,12 +120,6 @@ defmodule Faker.File do
 
       iex> Faker.File.mime_type(:image)
       "image/vnd.microsoft.icon"
-      iex> Faker.File.mime_type(:audio)
-      "audio/mp4"
-      iex> Faker.File.mime_type(:application)
-      "application/xop+xml"
-      iex> Faker.File.mime_type(:video)
-      "video/mpeg"
   """
   @spec mime_type(atom) :: String.t()
   def mime_type(category) do

lib/faker/finance/stock.ex

@@ -12,12 +12,6 @@ defmodule Faker.Finance.Stock do
 
       iex> Faker.Finance.Stock.ticker()
       "7401.N225"
-      iex> Faker.Finance.Stock.ticker()
-      "4786.HK"
-      iex> Faker.Finance.Stock.ticker()
-      "6766.N225"
-      iex> Faker.Finance.Stock.ticker()
-      "5166.N225"
   """
   @spec ticker() :: String.t()
   def ticker do
@@ -34,20 +28,9 @@ defmodule Faker.Finance.Stock do
 
       iex> Faker.Finance.Stock.ticker(:reuters, :nikkei225)
       "2110.N225"
-      iex> Faker.Finance.Stock.ticker(:reuters, :nikkei225)
-      "7401.N225"
-      iex> Faker.Finance.Stock.ticker(:reuters, :nikkei225)
-      "9835.N225"
-      iex> Faker.Finance.Stock.ticker(:reuters, :nikkei225)
-      "8304.N225"
-      iex> Faker.Finance.Stock.ticker(:reuters, :sehk)
-      "7564.HK"
-      iex> Faker.Finance.Stock.ticker(:reuters, :sehk)
-      "3609.HK"
-      iex> Faker.Finance.Stock.ticker(:reuters, :sehk)
-      "1085.HK"
+
       iex> Faker.Finance.Stock.ticker(:reuters, :sehk)
-      "5849.HK"
+      "8517.HK"
   """
   def ticker(:reuters, :nikkei225) do
     "#{Faker.random_between(1000, 9999)}.N225"

lib/faker/fruit/en.ex

@@ -8,13 +8,13 @@ defmodule Faker.Fruit.En do
   @doc """
   Returns a fruit.
   ## Examples
-      iex> Faker.Fruit.En.fruit
+      iex> Faker.Fruit.En.fruit()
       "Kiwano"
-      iex> Faker.Fruit.En.fruit
+      iex> Faker.Fruit.En.fruit()
       "Sugarcane"
-      iex> Faker.Fruit.En.fruit
+      iex> Faker.Fruit.En.fruit()
       "Pineapple"
-      iex> Faker.Fruit.En.fruit
+      iex> Faker.Fruit.En.fruit()
       "Lemon"
   """
   @spec fruit() :: String.t()

lib/faker/fruit/pt_br.ex

@@ -10,13 +10,13 @@ defmodule Faker.Fruit.PtBr do
 
   ## Examples
 
-      iex> Faker.Fruit.PtBr.fruit
+      iex> Faker.Fruit.PtBr.fruit()
       "Fruta-do-conde"
-      iex> Faker.Fruit.PtBr.fruit
+      iex> Faker.Fruit.PtBr.fruit()
       "Bergamota"
-      iex> Faker.Fruit.PtBr.fruit
+      iex> Faker.Fruit.PtBr.fruit()
       "Quixaba"
-      iex> Faker.Fruit.PtBr.fruit
+      iex> Faker.Fruit.PtBr.fruit()
       "Amora"
   """
   @spec fruit() :: String.t()

lib/faker/gov/it.ex

@@ -13,13 +13,13 @@ defmodule Faker.Gov.It do
 
   ## Examples
 
-      iex> Faker.Gov.It.fiscal_id
+      iex> Faker.Gov.It.fiscal_id()
       "ELRCEA64C50A918F"
-      iex> Faker.Gov.It.fiscal_id
+      iex> Faker.Gov.It.fiscal_id()
       "ZSLNKH22M34H480J"
-      iex> Faker.Gov.It.fiscal_id
+      iex> Faker.Gov.It.fiscal_id()
       "OCPCVO90M50F353I"
-      iex> Faker.Gov.It.fiscal_id
+      iex> Faker.Gov.It.fiscal_id()
       "PQYRFX94R54C681K"
   """
   @spec fiscal_id() :: binary()