Shlomi Fish avatar Shlomi Fish committed f304182

Add the ::DataDir role.

It is now really XML::GrammarBase specific but I'm too lazy to put it in
a separate CPAN distro.

Comments (0)

Files changed (3)

XML-GrammarBase/MANIFEST

 Changes
 inc/Test/Run/Builder.pm
 lib/XML/GrammarBase.pm
+lib/XML/GrammarBase/Role/DataDir.pm
 lib/XML/GrammarBase/Role/RelaxNG.pm
 lib/XML/GrammarBase/Role/XSLT.pm
 Makefile.PL

XML-GrammarBase/lib/XML/GrammarBase/Role/DataDir.pm

+package XML::GrammarBase::Role::RelaxNG;
+
+use strict;
+use warnings;
+
+
+=head1 NAME
+
+XML::GrammarBase::Role::DataDir - provide the data_dir accessor.
+
+=head1 VERSION
+
+Version 0.0.1
+
+=cut
+
+use Moo::Role;
+
+use MooX 'late';
+
+use File::ShareDir qw(dist_dir);
+
+our $VERSION = '0.0.1';
+
+has 'module_base' => (isa => 'Str', is => 'rw');
+has 'data_dir' => (isa => 'Str', is => 'rw',
+    default => sub { return shift->_calc_default_data_dir(); },
+    lazy => 1,
+);
+
+sub _calc_default_data_dir
+{
+    my ($self) = @_;
+
+    return dist_dir( $self->module_base() );
+}
+
+sub _undefize
+{
+    my $v = shift;
+
+    return defined($v) ? $v : "(undef)";
+}
+
+sub dist_path
+{
+    my ($self, $basename) = @_;
+
+    return File::Spec->catfile($self->data_dir, $basename);
+}
+
+sub dist_path_slot
+{
+    my ($self, $slot) = @_;
+
+    return $self->dist_path($self->$slot());
+}
+
+=head1 SYNOPSIS
+
+    package MyClass::WithDataDir;
+
+    use MooX 'late';
+
+    with ('XML::GrammarBase::Role::DataDir');
+
+    has '+module_base' => (default => 'XML::Grammar::MyGrammar');
+
+    package main;
+
+    my $obj = MyClass::WithDataDir->new(
+        data_dir => "/path/to/data-dir",
+    );
+
+=head1 SLOTS
+
+=head2 module_base
+
+The basename of the module - used for dist dir.
+
+=head2 data_dir
+
+The data directory where the XML assets can be found (the RELAX NG schema, etc.)
+
+=head1 METHODS
+
+=head2 $self->dist_path($basename)
+
+Returns the $basename relative to data_dir().
+
+Utility method.
+
+=head2 $self->dist_path_slot($slot)
+
+Returns the basename of $self->$slot() relative to data_dir().
+
+Utility method.
+
+=head1 AUTHOR
+
+Shlomi Fish, C<< <shlomif at cpan.org> >>
+
+=head1 BUGS
+
+Please report any bugs or feature requests to C<bug-xml-grammarbase at rt.cpan.org>, or through
+the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=XML-GrammarBase>.  I will be notified, and then you'll
+automatically be notified of progress on your bug as I make changes.
+
+
+
+
+=head1 SUPPORT
+
+You can find documentation for this module with the perldoc command.
+
+    perldoc XML::GrammarBase
+
+You can also look for information at:
+
+=over 4
+
+=item * RT: CPAN's request tracker
+
+L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=XML-GrammarBase>
+
+=item * AnnoCPAN: Annotated CPAN documentation
+
+L<http://annocpan.org/dist/XML-GrammarBase>
+
+=item * CPAN Ratings
+
+L<http://cpanratings.perl.org/d/XML-GrammarBase>
+
+=item * Search CPAN
+
+L<http://search.cpan.org/dist/XML-GrammarBase/>
+
+=back
+
+
+=head1 ACKNOWLEDGEMENTS
+
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2009 Shlomi Fish.
+
+This program is distributed under the MIT (X11) License:
+L<http://www.opensource.org/licenses/mit-license.php>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+=cut
+
+1; # End of XML::GrammarBase::RelaxNG::Validate
+

XML-GrammarBase/lib/XML/GrammarBase/Role/RelaxNG.pm

 use File::ShareDir qw(dist_dir);
 use XML::LibXML;
 
+with ('XML::GrammarBase::Role::DataDir');
+
 our $VERSION = '0.0.1';
 
-has 'module_base' => (isa => 'Str', is => 'rw');
-has 'data_dir' => (isa => 'Str', is => 'rw',
-    default => sub { return shift->_calc_default_data_dir(); },
-    lazy => 1,
-);
 has 'rng_schema_basename' => (isa => 'Str', is => 'rw');
 has '_rng' =>
 (
     lazy => 1,
 );
 
-sub _calc_default_data_dir
-{
-    my ($self) = @_;
-
-    return dist_dir( $self->module_base() );
-}
-
 sub _calc_default_rng_schema
 {
     my ($self) = @_;
     return $rngschema;
 }
 
-sub _undefize
-{
-    my $v = shift;
-
-    return defined($v) ? $v : "(undef)";
-}
-
 sub rng_validate_dom
 {
     my ($self, $source_dom) = @_;
     return $self->rng_validate_dom($dom);
 }
 
-sub dist_path
-{
-    my ($self, $basename) = @_;
-
-    return File::Spec->catfile($self->data_dir, $basename);
-}
-
-sub dist_path_slot
-{
-    my ($self, $slot) = @_;
-
-    return $self->dist_path($self->$slot());
-}
-
 =head1 SYNOPSIS
 
     package XML::Grammar::MyGrammar::RelaxNG::Validate;
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.