/ 
Rails-Assets-0.02
River stage zero No dependents
/ Rails::Assets::Base

NAME

Rails::Assets::Base - Files Finder and Custom Data Structures for Rails::Assets.

VERSION

Version 0.02

SYNOPSIS

This module provide some utilities functions

use Rails::Assets::Base;

my $template_hash = prepare_extensions_refs($assets_extensions);
my ($assets_hash, $assets_paths, $reversed_ext) =
  prepare_assets_refs($assets_directories, $assets_extensions);
...

EXPORT

prepare_extensions_refs

Uses format_extensions_list to find the assets types and returns the following data structure:

my $expected_extensions_refs = {
  fonts => [()],
  images => [()],
  javascripts => [()],
  stylesheets => [()],
};

prepare_assets_refs

Returns ($assets, $assets_path, $reversed_ext) where :

  • $assets is an Hash reference as prepare_extensions_refs

  • $assets_path is Array reference containing $Rails::Assets::ASSETS_DIR and their subfolders named as $assets keys

  • $reversed_ext is an Hash reference created reversing key value of $assets

find_files

Takes an array reference of directories as argument and returns a sorted list of files for all subfolder

SUBROUTINES/METHODS

format_extensions_list

This subroutine takes as argument an $assets_extensions reference and returns an array reference of assets types

my $assets_extensions = {
  fonts => [qw(.ttf)],
  images => [qw(.png)],
  javascripts => [qw(.js)],
  stylesheets => [qw(.css)],
};

my $assets_ext = [qw(fonts images javascripts stylesheets)];
is_deeply(
  Rails::Assets::Base::format_extensions_list($assets_extensions),
  $assets_ext, 'format_extensions_list() works with an HASH reference'
);
is_deeply(
  Rails::Assets::Base::format_extensions_list($assets_ext),
  $assets_ext, 'format_extensions_list() works with an ARRAY reference'
);

my $invalid_ref = sub { return 1 };
eval { Rails::Assets::Base::format_extensions_list($invalid_ref) } or my $at = $@;
like(
  $at, qr/Invalid extension argument provided/,
  'format_extensions_list() dies with a message when invalid reference provided'
);

AUTHOR

Mauro Berlanda, <kupta at cpan.org>

BUGS

Please report any bugs or feature requests to bug-rails-assets at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Rails-Assets. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

Pull Requests, Issues, Stars and Forks on the project github repository are welcome!

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Rails::Assets::Base

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2017 Mauro Berlanda.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.