Add new show command (#43)

This command expands the configuration file's @inherit rules and prints the final configuration nicely formatted, similar to what `dump-nconf <config-file>` does.
serge-community · Jul 25, 2019 · 1a2871d · 1a2871d
1 parent 8853c60
commit 1a2871d
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 0 deletions.
diff --git a/CHANGES b/CHANGES
@@ -121,6 +121,8 @@ Revision history
           (in addition to extracting them as translation hints).
 
         - Added support for `use_keys_as_context` job parameter (#89).
+
+        - Added new `show` command to display expanded .serge configurations (#40).
 
         - Miscellaneous smaller fixes and improvements.
 

diff --git a/doc/pod/serge-show.pod b/doc/pod/serge-show.pod
@@ -0,0 +1,19 @@
+=head1 NAME
+
+serge-show - Show expanded version of a configuration file
+
+=head1 SYNOPSIS
+
+C<< serge show <configuration-file> >>
+
+Where C<< <configuration-file> >> is a path to a specific .serge file.
+
+=head1 DESCRIPTION
+
+B<serge-show> prints out the interpreted configuration file by applying all
+inheritance rules. This is useful to check the full configuration that will be
+used by Serge.
+
+=head1 SEE ALSO
+
+Part of L<serge> suite.
diff --git a/lib/Serge/Command/show.pm b/lib/Serge/Command/show.pm
@@ -0,0 +1,34 @@
+package Serge::Command::show;
+use parent Serge::Command;
+
+use strict;
+
+use Config::Neat::Inheritable;
+use Config::Neat::Render;
+
+sub get_commands {
+    return {
+        show => {
+            handler => \&run,
+            info => 'Show expanded version of a configuration file',
+            need_config => 1,
+        },
+    }
+}
+
+sub run {
+    my ($self) = @_;
+
+    my @config_files = $self->{parent}->get_config_files;
+    die "Multiple configuration files not allowed\n" unless $#config_files == 0;
+
+    my $cfg = Config::Neat::Inheritable->new();
+    my $data = $cfg->parse_file($config_files[0]);
+
+    my $renderer = Config::Neat::Render->new();
+    print $renderer->render($data);
+
+    return 0;
+}
+
+1;