Merge pull request #31 from mroth/fb/28

Format code and lint in CI

Author: halfdan

.github/workflows/tests.yml

@@ -9,19 +9,31 @@ jobs:
     name: Ex${{matrix.elixir}}/OTP${{matrix.otp}}
     strategy:
       matrix:
-        elixir: ["1.15.8", "1.16.3", "1.17.3", "1.18.2"]
-        otp: ["25.3.2", "26.2.5", "27.2.4"]
-        exclude:
-          - elixir: "1.15.8"
-            otp: "27.2.4"
-          - elixir: "1.16.3"
-            otp: "27.2.4"
+        include:
+          - elixir: "1.15"
+            otp: "25"
+          - elixir: "1.18"
+            otp: "27"
+            lint: true
     steps:
       - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1
         with:
           otp-version: ${{matrix.otp}}
           elixir-version: ${{matrix.elixir}}
-      - run: mix deps.get
-      - run: mix compile --warnings-as-errors
-      - run: mix test
+      - name: Install dependencies
+        run: mix deps.get
+
+      - name: Compile
+        run: mix compile --warnings-as-errors
+
+      - name: Run tests
+        run: mix test
+
+      - name: checks that the mix.lock file has no unused deps
+        run: mix deps.unlock --check-unused
+        if: ${{ matrix.lint }}
+
+      - name: check if files are already formatted
+        run: mix format --check-formatted
+        if: ${{ matrix.lint }}

lib/exmoji.ex

@@ -19,23 +19,25 @@ defmodule Exmoji do
   vendor_data_file = "lib/vendor/emoji-data/emoji.json"
   @external_resource vendor_data_file
 
-  rawfile = File.read! vendor_data_file
-  rawdata = Jason.decode! rawfile, keys: :atoms
-  emoji_chars = for char <- rawdata do
-    %EmojiChar{
-      name:         char.name,
-      unified:      char.unified,
-      variations:   char.variations,
-      short_name:   char.short_name,
-      short_names:  char.short_names,
-      text:         char.text
-    }
-  end
-  @emoji_chars emoji_chars
+  rawfile = File.read!(vendor_data_file)
+  rawdata = Jason.decode!(rawfile, keys: :atoms)
+
+  emoji_chars =
+    for char <- rawdata do
+      %EmojiChar{
+        name: char.name,
+        unified: char.unified,
+        variations: char.variations,
+        short_name: char.short_name,
+        short_names: char.short_names,
+        text: char.text
+      }
+    end
 
+  @emoji_chars emoji_chars
 
   @doc """
-  Returns a list of all #{Enum.count @emoji_chars} Emoji characters as `EmojiChar`.
+  Returns a list of all #{Enum.count(@emoji_chars)} Emoji characters as `EmojiChar`.
   """
   def all, do: @emoji_chars
 
@@ -51,7 +53,6 @@ defmodule Exmoji do
   @all_variant_cache Enum.filter(@emoji_chars, &EmojiChar.variant?/1)
   def all_with_variants, do: @all_variant_cache
 
-
   @doc """
   Returns a list of all known Emoji characters rendered as Unicode bitstrings.
 
@@ -67,13 +68,13 @@ defmodule Exmoji do
     case Keyword.get(opts, :include_variants, false) do
       false ->
         Enum.map(@emoji_chars, &EmojiChar.render/1)
+
       true ->
         Enum.map(@emoji_chars, &EmojiChar.chars/1)
-        |> List.flatten
+        |> List.flatten()
     end
   end
 
-
   @doc """
   Returns a list of all known codepoints representing Emoji characters.
 
@@ -83,14 +84,14 @@ defmodule Exmoji do
   def codepoints(opts \\ []) do
     case Keyword.get(opts, :include_variants, false) do
       false ->
-        Enum.map(@emoji_chars, &(&1.unified))
+        Enum.map(@emoji_chars, & &1.unified)
+
       true ->
         Enum.map(@emoji_chars, &EmojiChar.codepoint_ids/1)
-        |> List.flatten
+        |> List.flatten()
     end
   end
 
-
   @doc """
   Finds any `EmojiChar` that contains given string in its official name.
 
@@ -107,24 +108,22 @@ defmodule Exmoji do
   """
   def find_by_name(name) do
     name = String.upcase(name)
-    Enum.filter( @emoji_chars, &(String.contains?(&1.name, name)) )
+    Enum.filter(@emoji_chars, &String.contains?(&1.name, name))
   end
 
-
   @doc """
   Find all `EmojiChar` that match substring in any of their associated short
   name keywords.
   """
   def find_by_short_name(sname) do
     target = String.downcase(sname)
-    Enum.filter( @emoji_chars, &(matches_short_name(&1, target)) )
+    Enum.filter(@emoji_chars, &matches_short_name(&1, target))
   end
 
   defp matches_short_name(%EmojiChar{} = ec, target) do
-    Enum.any?( ec.short_names, &(String.contains?(&1, target)) )
+    Enum.any?(ec.short_names, &String.contains?(&1, target))
   end
 
-
   @doc """
   Finds an `EmojiChar` based on its short name keyword.
 
@@ -133,27 +132,27 @@ defmodule Exmoji do
   a keyword.
   """
   def from_short_name(sname) do
-    sname |> String.downcase |> _from_short_name
+    sname |> String.downcase() |> _from_short_name
   end
 
   for ec <- @emoji_chars, sn <- ec.short_names do
-    defp _from_short_name( unquote(sn) ), do: unquote(Macro.escape(ec))
+    defp _from_short_name(unquote(sn)), do: unquote(Macro.escape(ec))
   end
-  defp _from_short_name(_), do: nil
 
+  defp _from_short_name(_), do: nil
 
   @doc """
   Finds a specific `EmojiChar` based on the unified codepoint ID.
   """
   def from_unified(uid) do
-    uid |> String.upcase |> _from_unified
+    uid |> String.upcase() |> _from_unified
   end
 
   for ec <- @emoji_chars, cp <- EmojiChar.codepoint_ids(ec) do
-    defp _from_unified( unquote(cp) ), do: unquote(Macro.escape(ec))
+    defp _from_unified(unquote(cp)), do: unquote(Macro.escape(ec))
   end
-  defp _from_unified(_), do: nil
 
+  defp _from_unified(_), do: nil
 
   @doc """
   Convert a unified ID directly to its bitstring glyph representation.
@@ -167,11 +166,10 @@ defmodule Exmoji do
   def unified_to_char(uid) do
     uid
     |> String.split("-")
-    |> Enum.map( &(String.to_integer(&1, 16)) )
-    |> List.to_string
+    |> Enum.map(&String.to_integer(&1, 16))
+    |> List.to_string()
   end
 
-
   @doc """
   Convert a native bitstring glyph to its unified codepoint ID.
 
@@ -189,16 +187,15 @@ defmodule Exmoji do
   """
   def char_to_unified(char) do
     char
-    |> String.codepoints
+    |> String.codepoints()
     |> Enum.map(&padded_hex_string/1)
     |> Enum.join("-")
-    |> String.upcase
+    |> String.upcase()
   end
+
   # produce a string representation of the integer value of a codepoint, in hex
   # this should be zero-padded to a minimum of 4 digits
-  defp padded_hex_string(<< cp_int_value :: utf8 >>) do
+  defp padded_hex_string(<<cp_int_value::utf8>>) do
     cp_int_value |> Integer.to_string(16) |> String.pad_leading(4, "0")
   end
-
-
 end

lib/exmoji/emoji_char.ex

@@ -22,14 +22,12 @@ defmodule Exmoji.EmojiChar do
   It also contains a few helper functions to deal with this data type.
   """
 
-  defstruct [
-    name: nil,
-    unified: nil,
-    variations: [],
-    short_name: nil,
-    short_names: [],
-    text: nil
-  ]
+  defstruct name: nil,
+            unified: nil,
+            variations: [],
+            short_name: nil,
+            short_names: [],
+            text: nil
 
   alias Exmoji.EmojiChar
 
@@ -43,13 +41,15 @@ defmodule Exmoji.EmojiChar do
   Emoji characters that contain a possible variant.
   """
   def render(ec, options \\ [variant_encoding: true])
+
   def render(ec, variant_encoding: false) do
     Exmoji.unified_to_char(ec.unified)
   end
+
   def render(ec, variant_encoding: true) do
     case variant?(ec) do
-      true  -> Exmoji.unified_to_char( variant(ec) )
-      false -> Exmoji.unified_to_char( ec.unified )
+      true -> Exmoji.unified_to_char(variant(ec))
+      false -> Exmoji.unified_to_char(ec.unified)
     end
   end
 
@@ -64,7 +64,7 @@ defmodule Exmoji.EmojiChar do
   all possible values to match against when searching for the emoji in a string
   representation.
   """
-  def chars(%EmojiChar{}=emojichar) do
+  def chars(%EmojiChar{} = emojichar) do
     codepoint_ids(emojichar)
     |> Enum.map(&Exmoji.unified_to_char/1)
   end
@@ -114,7 +114,6 @@ defmodule Exmoji.EmojiChar do
   If there is no variant-encoding for a character, returns nil.
   """
   def variant(%EmojiChar{variations: variations}) do
-    List.first variations
+    List.first(variations)
   end
-
 end

lib/exmoji/scanner.ex

@@ -35,7 +35,7 @@ defmodule Exmoji.Scanner do
   #
   # Thus it is kept as public so we can compare it in test...
   fbs_pattern = Exmoji.chars(include_variants: true) |> Enum.join("|")
-  @fbs_regexp Regex.compile!( "(?:#{fbs_pattern})" )
+  @fbs_regexp Regex.compile!("(?:#{fbs_pattern})")
   @doc false
   def rscan(str) do
     Regex.scan(@fbs_regexp, str)
@@ -67,20 +67,21 @@ defmodule Exmoji.Scanner do
 
   # first we sort all known char glyphs by reverse bitsize, so we can use the
   # bigger binary patterns first when defining our pattern match functions.
-  sorted_chars = Enum.sort(
-    Exmoji.chars(include_variants: true),
-    &(&1 > &2)
-  )
+  sorted_chars =
+    Enum.sort(
+      Exmoji.chars(include_variants: true),
+      &(&1 > &2)
+    )
 
   # define functions that pattern match against each emojichar binary at head.
   for glyph <- sorted_chars do
-    defp _bscan(<< unquote(glyph), tail::binary >>, acc) do
+    defp _bscan(<<unquote(glyph), tail::binary>>, acc) do
       _bscan(tail, [unquote(glyph) | acc])
     end
   end
+
   # if nothing is found, cut the head off and move on.
-  defp _bscan(<< _head::utf8, tail::binary >>, acc), do: _bscan(tail, acc)
+  defp _bscan(<<_head::utf8, tail::binary>>, acc), do: _bscan(tail, acc)
   # when we reach the end, return reversed accumulator.
   defp _bscan(<<>>, acc), do: Enum.reverse(acc)
-
 end

mix.exs

@@ -20,9 +20,10 @@ defmodule Exmoji.Mixfile do
 
   defp package do
     [
-      description: "Emoji encoding swiss army knife for dealing with Unicode "
-        <> "and other gotchas.",
-      maintainers: ["Matthew Rothenberg <mroth@mroth.info>"],
+      description:
+        "Emoji encoding swiss army knife for dealing with Unicode " <>
+          "and other gotchas.",
+      maintainers: ["Matthew Rothenberg <mroth@mroth.info>", "Fabian Becker <halfdan@xnorfz.de>"],
       licenses: ["MIT"],
       links: %{
         "GitHub" => @source_url

mix.lock

@@ -1,20 +1,12 @@
 %{
   "benchfella": {:hex, :benchfella, "0.3.5", "b2122c234117b3f91ed7b43b6e915e19e1ab216971154acd0a80ce0e9b8c05f5", [:mix], [], "hexpm", "23f27cbc482cbac03fc8926441eb60a5e111759c17642bac005c3225f5eb809d"},
-  "certifi": {:hex, :certifi, "2.8.0", "d4fb0a6bb20b7c9c3643e22507e42f356ac090a1dcea9ab99e27e0376d695eba", [:rebar3], [], "hexpm", "6ac7efc1c6f8600b08d625292d4bbf584e14847ce1b6b5c44d983d273e1097ea"},
   "earmark": {:hex, :earmark, "1.4.47", "7e7596b84fe4ebeb8751e14cbaeaf4d7a0237708f2ce43630cfd9065551f94ca", [:mix], [], "hexpm", "3e96bebea2c2d95f3b346a7ff22285bc68a99fbabdad9b655aa9c6be06c698f8"},
   "earmark_parser": {:hex, :earmark_parser, "1.4.44", "f20830dd6b5c77afe2b063777ddbbff09f9759396500cdbe7523efd58d7a339c", [:mix], [], "hexpm", "4778ac752b4701a5599215f7030989c989ffdc4f6df457c5f36938cc2d2a2750"},
   "ex_doc": {:hex, :ex_doc, "0.37.3", "f7816881a443cd77872b7d6118e8a55f547f49903aef8747dbcb345a75b462f9", [:mix], [{:earmark_parser, "~> 1.4.42", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "e6aebca7156e7c29b5da4daa17f6361205b2ae5f26e5c7d8ca0d3f7e18972233"},
   "excoveralls": {:hex, :excoveralls, "0.18.5", "e229d0a65982613332ec30f07940038fe451a2e5b29bce2a5022165f0c9b157e", [:mix], [{:castore, "~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "523fe8a15603f86d64852aab2abe8ddbd78e68579c8525ae765facc5eae01562"},
-  "hackney": {:hex, :hackney, "1.18.0", "c4443d960bb9fba6d01161d01cd81173089686717d9490e5d3606644c48d121f", [:rebar3], [{:certifi, "~>2.8.0", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "~>6.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "~>1.0.0", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "~>1.1", [hex: :mimerl, repo: "hexpm", optional: false]}, {:parse_trans, "3.3.1", [hex: :parse_trans, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "~>1.1.0", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}, {:unicode_util_compat, "~>0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "9afcda620704d720db8c6a3123e9848d09c87586dc1c10479c42627b905b5c5e"},
-  "idna": {:hex, :idna, "6.1.1", "8a63070e9f7d0c62eb9d9fcb360a7de382448200fbbd1b106cc96d3d8099df8d", [:rebar3], [{:unicode_util_compat, "~>0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "92376eb7894412ed19ac475e4a86f7b413c1b9fbb5bd16dccd57934157944cea"},
   "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
   "makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},
   "makeup_elixir": {:hex, :makeup_elixir, "1.0.1", "e928a4f984e795e41e3abd27bfc09f51db16ab8ba1aebdba2b3a575437efafc2", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "7284900d412a3e5cfd97fdaed4f5ed389b8f2b4cb49efc0eb3bd10e2febf9507"},
   "makeup_erlang": {:hex, :makeup_erlang, "1.0.2", "03e1804074b3aa64d5fad7aa64601ed0fb395337b982d9bcf04029d68d51b6a7", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "af33ff7ef368d5893e4a267933e7744e46ce3cf1f61e2dccf53a111ed3aa3727"},
-  "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm", "69b09adddc4f74a40716ae54d140f93beb0fb8978d8636eaded0c31b6f099f16"},
-  "mimerl": {:hex, :mimerl, "1.2.0", "67e2d3f571088d5cfd3e550c383094b47159f3eee8ffa08e64106cdf5e981be3", [:rebar3], [], "hexpm", "f278585650aa581986264638ebf698f8bb19df297f66ad91b18910dfc6e19323"},
   "nimble_parsec": {:hex, :nimble_parsec, "1.4.2", "8efba0122db06df95bfaa78f791344a89352ba04baedd3849593bfce4d0dc1c6", [:mix], [], "hexpm", "4b21398942dda052b403bbe1da991ccd03a053668d147d53fb8c4e0efe09c973"},
-  "parse_trans": {:hex, :parse_trans, "3.3.1", "16328ab840cc09919bd10dab29e431da3af9e9e7e7e6f0089dd5a2d2820011d8", [:rebar3], [], "hexpm", "07cd9577885f56362d414e8c4c4e6bdf10d43a8767abb92d24cbe8b24c54888b"},
-  "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.6", "cf344f5692c82d2cd7554f5ec8fd961548d4fd09e7d22f5b62482e5aeaebd4b0", [:make, :mix, :rebar3], [], "hexpm", "bdb0d2471f453c88ff3908e7686f86f9be327d065cc1ec16fa4540197ea04680"},
-  "unicode_util_compat": {:hex, :unicode_util_compat, "0.7.0", "bc84380c9ab48177092f43ac89e4dfa2c6d62b40b8bd132b1059ecc7232f9a78", [:rebar3], [], "hexpm", "25eee6d67df61960cf6a794239566599b09e17e668d3700247bc498638152521"},
 }