Extract NPM.FormatUtil to deduplicate format_size/format_bytes

Author: dannote

lib/mix/tasks/npm.cache.ex

@@ -18,7 +18,7 @@ defmodule Mix.Tasks.Npm.Cache do
     if File.exists?(cache_dir) do
       {size, count} = dir_stats(cache_dir)
       Mix.shell().info("Cache: #{cache_dir}")
-      Mix.shell().info("Size: #{format_bytes(size)}")
+      Mix.shell().info("Size: #{NPM.FormatUtil.format_size(size)}")
       Mix.shell().info("Packages: #{count}")
     else
       Mix.shell().info("Cache: #{cache_dir} (empty)")
@@ -32,7 +32,7 @@ defmodule Mix.Tasks.Npm.Cache do
     if File.exists?(cache_dir) do
       {size, count} = dir_stats(cache_dir)
       File.rm_rf!(cache_dir)
-      Mix.shell().info("Removed #{count} packages (#{format_bytes(size)})")
+      Mix.shell().info("Removed #{count} packages (#{NPM.FormatUtil.format_size(size)})")
     else
       Mix.shell().info("Cache is already empty.")
     end
@@ -53,8 +53,4 @@ defmodule Mix.Tasks.Npm.Cache do
       end
     end)
   end
-
-  defp format_bytes(bytes) when bytes < 1024, do: "#{bytes} B"
-  defp format_bytes(bytes) when bytes < 1_048_576, do: "#{Float.round(bytes / 1024, 1)} KB"
-  defp format_bytes(bytes), do: "#{Float.round(bytes / 1_048_576, 1)} MB"
 end

lib/mix/tasks/npm.size.ex

@@ -26,7 +26,7 @@ defmodule Mix.Tasks.Npm.Size do
     total_files = NPM.NodeModules.file_count(dir)
 
     Mix.shell().info("node_modules analysis:")
-    Mix.shell().info("  Total size:  #{format_bytes(total_size)}")
+    Mix.shell().info("  Total size:  #{NPM.FormatUtil.format_size(total_size)}")
     Mix.shell().info("  Total files: #{total_files}")
 
     packages = NPM.NodeModules.installed(dir)
@@ -48,11 +48,7 @@ defmodule Mix.Tasks.Npm.Size do
     |> Enum.sort_by(fn {_, size} -> -size end)
     |> Enum.take(top_n)
     |> Enum.each(fn {name, size} ->
-      Mix.shell().info("    #{format_bytes(size)} #{name}")
+      Mix.shell().info("    #{NPM.FormatUtil.format_size(size)} #{name}")
     end)
   end
-
-  defp format_bytes(bytes) when bytes < 1024, do: "#{bytes} B"
-  defp format_bytes(bytes) when bytes < 1_048_576, do: "#{Float.round(bytes / 1024, 1)} KB"
-  defp format_bytes(bytes), do: "#{Float.round(bytes / 1_048_576, 1)} MB"
 end

lib/npm/cache_stats.ex

@@ -73,9 +73,7 @@ defmodule NPM.CacheStats do
   Formats a byte size in human-readable form.
   """
   @spec format_size(non_neg_integer()) :: String.t()
-  def format_size(bytes) when bytes < 1024, do: "#{bytes} B"
-  def format_size(bytes) when bytes < 1_048_576, do: "#{Float.round(bytes / 1024, 1)} KB"
-  def format_size(bytes), do: "#{Float.round(bytes / 1_048_576, 1)} MB"
+  defdelegate format_size(bytes), to: NPM.FormatUtil
 
   defp walk_size(path) do
     case File.stat(path) do

lib/npm/file_size.ex

@@ -55,9 +55,7 @@ defmodule NPM.FileSize do
   Formats a byte size to human-readable string.
   """
   @spec format_size(non_neg_integer()) :: String.t()
-  def format_size(bytes) when bytes < 1024, do: "#{bytes} B"
-  def format_size(bytes) when bytes < 1_048_576, do: "#{Float.round(bytes / 1024, 1)} KB"
-  def format_size(bytes), do: "#{Float.round(bytes / 1_048_576, 1)} MB"
+  defdelegate format_size(bytes), to: NPM.FormatUtil
 
   defp list_files(dir) do
     if File.dir?(dir) do

lib/npm/format_util.ex

@@ -0,0 +1,14 @@
+defmodule NPM.FormatUtil do
+  @moduledoc """
+  Shared formatting utilities.
+  """
+
+  @doc """
+  Formats a byte count as a human-readable string.
+  """
+  @spec format_size(non_neg_integer()) :: String.t()
+  def format_size(bytes) when bytes < 1024, do: "#{bytes} B"
+  def format_size(bytes) when bytes < 1_048_576, do: "#{Float.round(bytes / 1024, 1)} KB"
+  def format_size(bytes) when bytes < 1_073_741_824, do: "#{Float.round(bytes / 1_048_576, 1)} MB"
+  def format_size(bytes), do: "#{Float.round(bytes / 1_073_741_824, 1)} GB"
+end

lib/npm/lockfile_stats.ex

@@ -52,9 +52,7 @@ defmodule NPM.LockfileStats do
   Formats size in human-readable form.
   """
   @spec format_size(non_neg_integer()) :: String.t()
-  def format_size(bytes) when bytes < 1024, do: "#{bytes} B"
-  def format_size(bytes) when bytes < 1_048_576, do: "#{Float.round(bytes / 1024, 1)} KB"
-  def format_size(bytes), do: "#{Float.round(bytes / 1_048_576, 1)} MB"
+  defdelegate format_size(bytes), to: NPM.FormatUtil
 
   defp has_field?(entry, field) do
     case Map.get(entry, field) || Map.get(entry, to_string(field)) do

lib/npm/size.ex

@@ -53,10 +53,7 @@ defmodule NPM.Size do
   Formats a size in bytes as a human-readable string.
   """
   @spec format_size(non_neg_integer()) :: String.t()
-  def format_size(bytes) when bytes < 1024, do: "#{bytes} B"
-  def format_size(bytes) when bytes < 1_048_576, do: "#{Float.round(bytes / 1024, 1)} KB"
-  def format_size(bytes) when bytes < 1_073_741_824, do: "#{Float.round(bytes / 1_048_576, 1)} MB"
-  def format_size(bytes), do: "#{Float.round(bytes / 1_073_741_824, 1)} GB"
+  defdelegate format_size(bytes), to: NPM.FormatUtil
 
   @doc """
   Returns a summary of the node_modules analysis.

mix.lock

@@ -4,7 +4,7 @@
   "dialyxir": {:hex, :dialyxir, "1.4.7", "dda948fcee52962e4b6c5b4b16b2d8fa7d50d8645bbae8b8685c3f9ecb7f5f4d", [:mix], [{:erlex, ">= 0.2.8", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "b34527202e6eb8cee198efec110996c25c5898f43a4094df157f8d28f27d9efe"},
   "earmark_parser": {:hex, :earmark_parser, "1.4.44", "f20830dd6b5c77afe2b063777ddbbff09f9759396500cdbe7523efd58d7a339c", [:mix], [], "hexpm", "4778ac752b4701a5599215f7030989c989ffdc4f6df457c5f36938cc2d2a2750"},
   "erlex": {:hex, :erlex, "0.2.8", "cd8116f20f3c0afe376d1e8d1f0ae2452337729f68be016ea544a72f767d9c12", [:mix], [], "hexpm", "9d66ff9fedf69e49dc3fd12831e12a8a37b76f8651dd21cd45fcf5561a8a7590"},
-  "ex_dna": {:hex, :ex_dna, "1.1.0", "3ced06be2d1648074e79617a4f1592dbe929b08a0357d08ad79b3d0025966147", [:mix], [{:gen_lsp, "~> 0.11", [hex: :gen_lsp, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "0274e36c69bee3bb990097c8138a878c7ac416a8a234730a44e042f90b5eefe0"},
+  "ex_dna": {:hex, :ex_dna, "1.2.0", "cf01b0f06b49e6ba3deb96a235110c1a0d535c9ae205992582c9edc22ff907ec", [:mix], [{:gen_lsp, "~> 0.11", [hex: :gen_lsp, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "6358955a47504fe8bfec898f093fd6727147f7b47bed49045eefacc68321855b"},
   "ex_doc": {:hex, :ex_doc, "0.40.1", "67542e4b6dde74811cfd580e2c0149b78010fd13001fda7cfeb2b2c2ffb1344d", [:mix], [{:earmark_parser, "~> 1.4.44", [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", "bcef0e2d360d93ac19f01a85d58f91752d930c0a30e2681145feea6bd3516e00"},
   "ex_slop": {:hex, :ex_slop, "0.2.0", "28ee70d62975636242dabf47d24e247acfbfdffd9c7cdc5a0d1c396aa42b421d", [:mix], [{:credo, "~> 1.7", [hex: :credo, repo: "hexpm", optional: false]}], "hexpm", "da8ccad55b61eebf7972fee1ab723f5227e58ed052ea09be4f9fe315c5e89cc2"},
   "file_system": {:hex, :file_system, "1.1.1", "31864f4685b0148f25bd3fbef2b1228457c0c89024ad67f7a81a3ffbc0bbad3a", [:mix], [], "hexpm", "7a15ff97dfe526aeefb090a7a9d3d03aa907e100e262a0f8f7746b78f8f87a5d"},