Merge pull request #32 from TTRPG-Dev/qmalcolm--better-cli-commands

Grab Bag of CLI refactorings

Author: QMalcolm

lib/cli.ex

@@ -1,5 +1,6 @@
 # credo:disable-for-this-file Credo.Check.Warning.IoInspect
 defmodule ExTTRPGDev.CLI do
+  alias ExTTRPGDev.CLI.Characters
   alias ExTTRPGDev.CLI.Generate
   alias ExTTRPGDev.CLI.Roll
   alias ExTTRPGDev.CLI.RuleSystems
@@ -21,7 +22,8 @@ defmodule ExTTRPGDev.CLI do
         subcommands:
           Roll.commands() ++
             RuleSystems.commands() ++
-            Generate.commands()
+            Generate.commands() ++
+            Characters.commands()
       )
 
     case Optimus.parse!(optimus, argv) do
@@ -31,14 +33,14 @@ defmodule ExTTRPGDev.CLI do
       {[:roll], parse_result} ->
         Roll.handle(parse_result)
 
-      {[:list_systems], _} ->
-        RuleSystems.handle_list_systems()
+      {[:systems | sub_commands], parse_result} ->
+        RuleSystems.handle_systems_subcommands(sub_commands, parse_result)
 
-      {[:system | sub_commands], parse_result} ->
-        RuleSystems.handle_system_subcommands(sub_commands, parse_result)
+      {[:characters | sub_commands], parse_result} ->
+        Characters.handle_characters_subcommands(sub_commands, parse_result)
 
-      {[:gen | sub_commands], _} ->
-        Generate.handle_generate_subcommands(sub_commands)
+      {[:gen | sub_commands], parse_result} ->
+        Generate.handle_generate_subcommands(sub_commands, parse_result)
 
       {unhandled, _parse_result} ->
         str_command =

lib/cli/args.ex

@@ -0,0 +1,20 @@
+defmodule ExTTRPGDev.CLI.Args do
+  @moduledoc """
+  Defines common CLI args
+  """
+  alias ExTTRPGDev.CLI.CustomParsers
+
+  @doc """
+  Argument spec for any command needing to take in the name of a rule system
+  """
+  def system do
+    [
+      system: [
+        value_name: "SYSTEM",
+        help: "A supported system, e.g. basic_fantasy_4e",
+        required: true,
+        parser: &CustomParsers.system_parser(&1)
+      ]
+    ]
+  end
+end

lib/cli/characters.ex

@@ -0,0 +1,42 @@
+# credo:disable-for-this-file Credo.Check.Warning.IoInspect
+defmodule ExTTRPGDev.CLI.Characters do
+  @moduledoc """
+  Defintions for dealing with character CLI commands
+  """
+  alias ExTTRPGDev.Characters.Character
+  alias ExTTRPGDev.CLI.Args
+
+  @doc """
+  Command specifications for character CLI commands
+  """
+  def commands do
+    [
+      characters: [
+        name: "characters",
+        about: "Top level command for characters",
+        subcommands: [
+          gen: [
+            name: "gen",
+            about: "Generate a character for a system",
+            args: Args.system()
+          ]
+        ]
+      ]
+    ]
+  end
+
+  @doc """
+  Handle `characters` CLI command and sub commands
+  """
+  def handle_characters_subcommands([:gen | _subcommands], %Optimus.ParseResult{
+        args: %{system: system}
+      }) do
+    character = system |> Character.gen_character!()
+
+    IO.puts("-- Name: #{character.name}")
+
+    Enum.each(character.ability_scores, fn {ability, scores} ->
+      IO.puts("#{ability}: #{Enum.sum(scores)}")
+    end)
+  end
+end

lib/cli/custom_parsers.ex

@@ -2,6 +2,7 @@ defmodule ExTTRPGDev.CLI.CustomParsers do
   @moduledoc """
   Custom parsers to be used with Optimus args :parse
   """
+  alias ExTTRPGDev.RuleSystems
 
   @doc """
   Parses a string of dice specifications seperated by commas
@@ -17,4 +18,23 @@ defmodule ExTTRPGDev.CLI.CustomParsers do
     |> Enum.map(&String.trim(&1))
     |> Kernel.then(fn result -> {:ok, result} end)
   end
+
+  @doc """
+  Loads the rule system for the given system name
+
+  ## Examples
+
+      iex> ExTTRPGDev.CLI.CustomParsers.system_parser("dnd_5e_srd")
+      {:ok, %ExTTRPGDev.RuleSystems.RuleSystem{}}
+  """
+  def system_parser(system) when is_bitstring(system) do
+    if RuleSystems.is_configured?(system) do
+      system
+      |> RuleSystems.load_system!()
+      |> Kernel.then(fn result -> {:ok, result} end)
+    else
+      {:error,
+       "\"#{system}\" is not configured, run `ex_ttrpg_dev systems list` to list configured systems"}
+    end
+  end
 end

lib/cli/generate.ex

@@ -3,6 +3,8 @@ defmodule ExTTRPGDev.CLI.Generate do
   @moduledoc """
   Definitions for dealing with genenerate CLI commands
   """
+  alias ExTTRPGDev.CLI.Args
+  alias ExTTRPGDev.RuleSystems.RuleSystem
 
   @doc """
   Command specifications for generate commands
@@ -16,6 +18,11 @@ defmodule ExTTRPGDev.CLI.Generate do
           name: [
             name: "name",
             about: "Generate a random name"
+          ],
+          stat_block: [
+            name: "stat-block",
+            about: "Generate stat blocks for characters of the system",
+            args: Args.system()
           ]
         ]
       ]
@@ -25,10 +32,13 @@ defmodule ExTTRPGDev.CLI.Generate do
   @doc """
   Handles generate sub commands
   """
-  def handle_generate_subcommands([command | _subcommands]) do
-    case command do
-      :name ->
-        IO.inspect(Faker.Person.name())
-    end
+  def handle_generate_subcommands([:name | _subcommands], _parse_result),
+    do: IO.inspect(Faker.Person.name())
+
+  def handle_generate_subcommands([:stat_block | _subcommands], %Optimus.ParseResult{
+        args: %{system: system}
+      }) do
+    RuleSystem.gen_ability_scores_assigned(system)
+    |> IO.inspect()
   end
 end

lib/cli/system.ex

@@ -3,7 +3,7 @@ defmodule ExTTRPGDev.CLI.RuleSystems do
   @moduledoc """
   Defintions for dealing with rule system CLI commands
   """
-  alias ExTTRPGDev.Characters.Character
+  alias ExTTRPGDev.CLI.Args
   alias ExTTRPGDev.RuleSystems.Abilities
   alias ExTTRPGDev.RuleSystems.Languages
   alias ExTTRPGDev.RuleSystems.RuleSystem
@@ -14,43 +14,13 @@ defmodule ExTTRPGDev.CLI.RuleSystems do
   """
   def commands do
     [
-      list_systems: [
-        name: "list-systems",
-        about: "List systems that are setup to be used with ExTTRPGDev"
-      ],
-      system: [
-        name: "system",
+      systems: [
+        name: "systems",
         about: "Top level command fo systems",
         subcommands: [
-          gen: [
-            name: "gen",
-            about: "Used for generating things for the system",
-            subcommands: [
-              stat_block: [
-                name: "stat-block",
-                about: "Generate stat blocks for characters of the system",
-                args: [
-                  system: [
-                    value_name: "SYSTEM",
-                    help: "A supported system, e.g. dnd5e",
-                    required: true,
-                    parser: :string
-                  ]
-                ]
-              ],
-              character: [
-                name: "character",
-                about: "Generate characters for system",
-                args: [
-                  system: [
-                    value_name: "SYSTEM",
-                    help: "A supported system, e.g. dnd5e",
-                    required: true,
-                    parser: :string
-                  ]
-                ]
-              ]
-            ]
+          list: [
+            name: "list",
+            about: "List systems that ex_ttrpg_dev knows about"
           ],
           show: [
             name: "show",
@@ -59,50 +29,22 @@ defmodule ExTTRPGDev.CLI.RuleSystems do
               abilities: [
                 name: "abilities",
                 about: "Show the rule systems character abilities",
-                args: [
-                  system: [
-                    value_name: "SYSTEM",
-                    help: "A supported system, e.g. dnd5e",
-                    required: true,
-                    parser: :string
-                  ]
-                ]
+                args: Args.system()
               ],
               languages: [
                 name: "languages",
                 about: "Show the rule systems languages",
-                args: [
-                  system: [
-                    value_name: "SYSTEM",
-                    help: "A supported system, e.g. dnd5e",
-                    required: true,
-                    parser: :string
-                  ]
-                ]
+                args: Args.system()
               ],
               metadata: [
                 name: "metadata",
                 about: "Show system metadata",
-                args: [
-                  system: [
-                    value_name: "SYSTEM",
-                    help: "A supported system, e.g. dnd5e",
-                    required: true,
-                    parser: :string
-                  ]
-                ]
+                args: Args.system()
               ],
               skills: [
                 name: "skills",
                 about: "Show rule system skills",
-                args: [
-                  system: [
-                    value_name: "SYSTEM",
-                    help: "A supported system, e.g. dnd5e",
-                    required: true,
-                    parser: :string
-                  ]
-                ]
+                args: Args.system()
               ]
             ]
           ]
@@ -112,74 +54,28 @@ defmodule ExTTRPGDev.CLI.RuleSystems do
   end
 
   @doc """
-  Handle list-systems CLI command
+  Handle `systems` CLI command and sub commands
   """
-  def handle_list_systems() do
+  def handle_systems_subcommands([:list], _) do
     ExTTRPGDev.RuleSystems.list_systems()
     |> IO.inspect(label: "Configured Systems")
   end
 
-  @doc """
-  Handle `system` CLI command and sub commands
-  """
-  def handle_system_subcommands([command | subcommands], %Optimus.ParseResult{
+  def handle_systems_subcommands([:show | subcommands], %Optimus.ParseResult{
         args: %{system: system}
       }) do
-    loaded_system =
-      system
-      |> ExTTRPGDev.RuleSystems.assert_configured!()
-      |> ExTTRPGDev.RuleSystems.load_system!()
-
-    case command do
-      :gen ->
-        handle_system_generation_subcommands(subcommands, loaded_system)
-
-      :show ->
-        handle_system_show_subcommands(subcommands, loaded_system)
-    end
-  end
-
-  @doc """
-  Handle generation commands for a rule system
-  """
-  def handle_system_generation_subcommands(
-        [command | _subcommands],
-        %RuleSystem{} = system
-      ) do
-    case command do
-      :stat_block ->
-        RuleSystem.gen_ability_scores_assigned(system)
-        |> IO.inspect()
-
-      :character ->
-        character = Character.gen_character!(system)
-        IO.puts("-- Name: #{character.name}")
-
-        Enum.each(character.ability_scores, fn {ability, scores} ->
-          IO.puts("#{ability}: #{Enum.sum(scores)}")
-        end)
-    end
-  end
-
-  @doc """
-  Hand showing a rule system's components
-  """
-  def handle_system_show_subcommands(
-        [command | _subcommands],
-        %RuleSystem{} = system
-      ) do
-    case command do
-      :abilities ->
+    case subcommands do
+      [:abilities] ->
         show_abilities(system)
 
-      :languages ->
+      [:languages] ->
         show_languages(system)
 
-      :metadata ->
+      [:metadata] ->
         Map.get(system, :metadata)
         |> IO.inspect()
 
-      :skills ->
+      [:skills] ->
         show_skills(system)
     end
   end

test/custom_parsers_test.exs

@@ -1,5 +1,19 @@
 defmodule ExTTRPGDevTest.CLI.CustomParsers do
   use ExUnit.Case
 
-  doctest ExTTRPGDev.CLI.CustomParsers
+  alias ExTTRPGDev.CLI.CustomParsers
+  alias ExTTRPGDev.RuleSystems.RuleSystem
+
+  doctest ExTTRPGDev.CLI.CustomParsers,
+    except: [
+      system_parser: 1
+    ]
+
+  def system_parser_test do
+    # If no error was raised, then all is good
+    {:ok, %RuleSystem{}} = CustomParsers.system_parser("dnd_5e_srd")
+
+    # Should raise an error
+    assert_raise RuntimeError, CustomParsers.system_parser("unknown_system")
+  end
 end