use insertion order to sort attributes when formulating arguments for Getopt::Long

[gitmo/MooseX-Getopt.git] / t / 110_sort_usage_by_attr_order.t

diff --git a/t/110_sort_usage_by_attr_order.t b/t/110_sort_usage_by_attr_order.t
new file mode 100644 (file)
index 0000000..1e41e79
--- /dev/null
+++ b/t/110_sort_usage_by_attr_order.t
@@ -0,0 +1,39 @@
+
+# The usage information prints the 'documentation' value for all Getopt
+# attributes, except the order is not deterministic (rather, it uses the order
+# in which the attributes are stored in the metaclass 'attributes' hash).
+# Let's sort them by insertion order, which should lead to nicer output:
+# If MooseX::Getopt is applied early, the help options will be on top
+# the help options will always be on top (assuming this role is applied
+# early), followed by options added by parent classes and roles, and then
+# options added by this class.
+
+use strict; use warnings;
+use Test::More tests => 1;
+use Test::Exception;
+
+{
+    package MyClass;
+    use strict; use warnings;
+    use Moose;
+    with 'MooseX::Getopt';
+
+    has $_ => (
+        is => 'ro', isa => 'Str',
+        traits => ['Getopt'],
+        documentation => 'Documentation for "' . $_ . '"',
+    ) foreach qw(foo bar baz);
+}
+
+my $obj = MyClass->new_with_options();
+
+my $expected = <<USAGE;
+usage: 110_sort_usage_by_attr_order.t [-?] [long options...]
+       -? --usage --help  Prints this usage information.
+       --foo              Documentation for "foo"
+       --bar              Documentation for "bar"
+       --baz              Documentation for "baz"
+USAGE
+
+is($obj->usage->text, $expected, 'Usage text has nicely sorted options');
+