This is an automated email from the git hooks/post-receive script.
gregoa pushed a commit to branch master
in repository libhash-storediterator-perl.
commit fbc839712a97ee6d4a74e7955069ddebc4172987
Author: gregor herrmann <gre...@debian.org>
Date: Sat Oct 29 20:39:16 2016 +0200
New upstream version 0.008
---
.travis.yml | 9 ++
Build.PL | 13 +-
Changes | 22 +++
LICENSE | 379 +++++++++++++++++++++++++++++++++++++++++++++
MANIFEST | 4 +
META.json | 23 ++-
META.yml | 19 ++-
README | 148 ++++++++++--------
appveyor.yml | 21 +++
lib/Hash/StoredIterator.pm | 16 +-
t/Hash-StoredIterator.t | 100 +++++-------
11 files changed, 606 insertions(+), 148 deletions(-)
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..a69365c
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,9 @@
+language: perl
+perl:
+ - "5.22"
+ - "5.20"
+ - "5.18"
+ - "5.16"
+ - "5.14"
+ - "5.12"
+ - "5.10"
diff --git a/Build.PL b/Build.PL
index 9d3531f..49e5acd 100644
--- a/Build.PL
+++ b/Build.PL
@@ -7,14 +7,23 @@ my $build = Module::Build->new(
module_name => 'Hash::StoredIterator',
license => 'perl',
dist_author => 'Chad Granum <exodi...@gmail.com>',
- create_readme => 1,
+ create_readme => 1,
+ create_license => 1,
requires => {
'perl' => '5.10.0',
},
build_requires => {
- 'Fennec' => '2.004',
'ExtUtils::ParseXS' => '3.15',
},
+ test_requires => {
+ 'Test2::Bundle::Extended' => 0,
+ 'Test2::Tools::Spec' => 0,
+ },
+ meta_merge => {
+ resources => {
+ repository => 'https://github.com/exodist/Hash-StoredIterator',
+ },
+ },
);
$build->create_build_script;
diff --git a/Changes b/Changes
new file mode 100644
index 0000000..4952d94
--- /dev/null
+++ b/Changes
@@ -0,0 +1,22 @@
+0.008 Wed Aug 10 22:19:35 PDT 2016
+ Docs
+ * Typo fixes. (David Steinbrunner) [github #3]
+
+ Test Fixes
+ * Silenced eich deprecation warnings. (Schwern)
+
+ Distribution
+ * Added a license file (Schwern)
+ * Testing using Travis and AppVeyor (Schwern)
+ * No longer depending on Fennec, using Test2 instead, reducing the
+ dependency chain. (Schwern)
+ * Repository metadata (David Steinbrunner) [github #4]
+
+0.007 Thu Jul 04 15:39:22 PDT 2013
+ Bug Fixes
+ * Fixed a warning in hmap(). (Chad Granum)
+
+0.006 Tue Jun 18 20:35:09 PDT 2013
+ Features
+ * Deprecated eich(), replaced with iterator(). (Chad Granum)
+ * Deprecated eech(), replaced with hmap(). (Chad Granum)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..24d6ae2
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,379 @@
+This software is copyright (c) 2016 by Chad Granum <exodi...@gmail.com>.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+Terms of the Perl programming language system itself
+
+a) the GNU General Public License as published by the Free
+ Software Foundation; either version 1, or (at your option) any
+ later version, or
+b) the "Artistic License"
+
+--- The GNU General Public License, Version 1, February 1989 ---
+
+This software is Copyright (c) 2016 by Chad Granum <exodi...@gmail.com>.
+
+This is free software, licensed under:
+
+ The GNU General Public License, Version 1, February 1989
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 1, February 1989
+
+ Copyright (C) 1989 Free Software Foundation, Inc.
+ 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The license agreements of most software companies try to keep users
+at the mercy of those companies. By contrast, our General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. The
+General Public License applies to the Free Software Foundation's
+software and to any other program whose authors commit to using it.
+You can use it for your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Specifically, the General Public License is designed to make
+sure that you have the freedom to give away or sell copies of free
+software, that you receive source code or can get it if you want it,
+that you can change the software or use pieces of it in new free
+programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of a such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must tell them their rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License Agreement applies to any program or other work which
+contains a notice placed by the copyright holder saying it may be
+distributed under the terms of this General Public License. The
+"Program", below, refers to any such program or work, and a "work based
+on the Program" means either the Program or any work containing the
+Program or a portion of it, either verbatim or with modifications. Each
+licensee is addressed as "you".
+
+ 1. You may copy and distribute verbatim copies of the Program's source
+code as you receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice and
+disclaimer of warranty; keep intact all the notices that refer to this
+General Public License and to the absence of any warranty; and give any
+other recipients of the Program a copy of this General Public License
+along with the Program. You may charge a fee for the physical act of
+transferring a copy.
+
+ 2. You may modify your copy or copies of the Program or any portion of
+it, and copy and distribute such modifications under the terms of Paragraph
+1 above, provided that you also do the following:
+
+ a) cause the modified files to carry prominent notices stating that
+ you changed the files and the date of any change; and
+
+ b) cause the whole of any work that you distribute or publish, that
+ in whole or in part contains the Program or any part thereof, either
+ with or without modifications, to be licensed at no charge to all
+ third parties under the terms of this General Public License (except
+ that you may choose to grant warranty protection to some or all
+ third parties, at your option).
+
+ c) If the modified program normally reads commands interactively when
+ run, you must cause it, when started running for such interactive use
+ in the simplest and most usual way, to print or display an
+ announcement including an appropriate copyright notice and a notice
+ that there is no warranty (or else, saying that you provide a
+ warranty) and that users may redistribute the program under these
+ conditions, and telling the user how to view a copy of this General
+ Public License.
+
+ d) You may charge a fee for the physical act of transferring a
+ copy, and you may at your option offer warranty protection in
+ exchange for a fee.
+
+Mere aggregation of another independent work with the Program (or its
+derivative) on a volume of a storage or distribution medium does not bring
+the other work under the scope of these terms.
+
+ 3. You may copy and distribute the Program (or a portion or derivative of
+it, under Paragraph 2) in object code or executable form under the terms of
+Paragraphs 1 and 2 above provided that you also do one of the following:
+
+ a) accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of
+ Paragraphs 1 and 2 above; or,
+
+ b) accompany it with a written offer, valid for at least three
+ years, to give any third party free (except for a nominal charge
+ for the cost of distribution) a complete machine-readable copy of the
+ corresponding source code, to be distributed under the terms of
+ Paragraphs 1 and 2 above; or,
+
+ c) accompany it with the information you received as to where the
+ corresponding source code may be obtained. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form alone.)
+
+Source code for a work means the preferred form of the work for making
+modifications to it. For an executable file, complete source code means
+all the source code for all modules it contains; but, as a special
+exception, it need not include source code for modules which are standard
+libraries that accompany the operating system on which the executable
+file runs, or for standard header files or definitions files that
+accompany that operating system.
+
+ 4. You may not copy, modify, sublicense, distribute or transfer the
+Program except as expressly provided under this General Public License.
+Any attempt otherwise to copy, modify, sublicense, distribute or transfer
+the Program is void, and will automatically terminate your rights to use
+the Program under this License. However, parties who have received
+copies, or rights to use copies, from you under this General Public
+License will not have their licenses terminated so long as such parties
+remain in full compliance.
+
+ 5. By copying, distributing or modifying the Program (or any work based
+on the Program) you indicate your acceptance of this license to do so,
+and all its terms and conditions.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the original
+licensor to copy, distribute or modify the Program subject to these
+terms and conditions. You may not impose any further restrictions on the
+recipients' exercise of the rights granted herein.
+
+ 7. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of the license which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+the license, you may choose any version ever published by the Free Software
+Foundation.
+
+ 8. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ Appendix: How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to humanity, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+ To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively convey
+the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) 19yy <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 1, or (at your option)
+ any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301
USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) 19xx name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the
+appropriate parts of the General Public License. Of course, the
+commands you use may be called something other than `show w' and `show
+c'; they could even be mouse-clicks or menu items--whatever suits your
+program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ program `Gnomovision' (a program to direct compilers to make passes
+ at assemblers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+That's all there is to it!
+
+
+--- The Artistic License 1.0 ---
+
+This software is Copyright (c) 2016 by Chad Granum <exodi...@gmail.com>.
+
+This is free software, licensed under:
+
+ The Artistic License 1.0
+
+The Artistic License
+
+Preamble
+
+The intent of this document is to state the conditions under which a Package
+may be copied, such that the Copyright Holder maintains some semblance of
+artistic control over the development of the package, while giving the users of
+the package the right to use and distribute the Package in a more-or-less
+customary fashion, plus the right to make reasonable modifications.
+
+Definitions:
+
+ - "Package" refers to the collection of files distributed by the Copyright
+ Holder, and derivatives of that collection of files created through
+ textual modification.
+ - "Standard Version" refers to such a Package if it has not been modified,
+ or has been modified in accordance with the wishes of the Copyright
+ Holder.
+ - "Copyright Holder" is whoever is named in the copyright or copyrights for
+ the package.
+ - "You" is you, if you're thinking about copying or distributing this
Package.
+ - "Reasonable copying fee" is whatever you can justify on the basis of media
+ cost, duplication charges, time of people involved, and so on. (You will
+ not be required to justify it to the Copyright Holder, but only to the
+ computing community at large as a market that must bear the fee.)
+ - "Freely Available" means that no fee is charged for the item itself, though
+ there may be fees involved in handling the item. It also means that
+ recipients of the item may redistribute it under the same conditions they
+ received it.
+
+1. You may make and give away verbatim copies of the source form of the
+Standard Version of this Package without restriction, provided that you
+duplicate all of the original copyright notices and associated disclaimers.
+
+2. You may apply bug fixes, portability fixes and other modifications derived
+from the Public Domain or from the Copyright Holder. A Package modified in such
+a way shall still be considered the Standard Version.
+
+3. You may otherwise modify your copy of this Package in any way, provided that
+you insert a prominent notice in each changed file stating how and when you
+changed that file, and provided that you do at least ONE of the following:
+
+ a) place your modifications in the Public Domain or otherwise make them
+ Freely Available, such as by posting said modifications to Usenet or an
+ equivalent medium, or placing the modifications on a major archive site
+ such as ftp.uu.net, or by allowing the Copyright Holder to include your
+ modifications in the Standard Version of the Package.
+
+ b) use the modified Package only within your corporation or organization.
+
+ c) rename any non-standard executables so the names do not conflict with
+ standard executables, which must also be provided, and provide a separate
+ manual page for each non-standard executable that clearly documents how it
+ differs from the Standard Version.
+
+ d) make other distribution arrangements with the Copyright Holder.
+
+4. You may distribute the programs of this Package in object code or executable
+form, provided that you do at least ONE of the following:
+
+ a) distribute a Standard Version of the executables and library files,
+ together with instructions (in the manual page or equivalent) on where to
+ get the Standard Version.
+
+ b) accompany the distribution with the machine-readable source of the Package
+ with your modifications.
+
+ c) accompany any non-standard executables with their corresponding Standard
+ Version executables, giving the non-standard executables non-standard
+ names, and clearly documenting the differences in manual pages (or
+ equivalent), together with instructions on where to get the Standard
+ Version.
+
+ d) make other distribution arrangements with the Copyright Holder.
+
+5. You may charge a reasonable copying fee for any distribution of this
+Package. You may charge any fee you choose for support of this Package. You
+may not charge a fee for this Package itself. However, you may distribute this
+Package in aggregate with other (possibly commercial) programs as part of a
+larger (possibly commercial) software distribution provided that you do not
+advertise this Package as a product of your own.
+
+6. The scripts and library files supplied as input to or produced as output
+from the programs of this Package do not automatically fall under the copyright
+of this Package, but belong to whomever generated them, and may be sold
+commercially, and may be aggregated with this Package.
+
+7. C or perl subroutines supplied by you and linked into this Package shall not
+be considered part of this Package.
+
+8. The name of the Copyright Holder may not be used to endorse or promote
+products derived from this software without specific prior written permission.
+
+9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
+MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+
+The End
+
diff --git a/MANIFEST b/MANIFEST
index 2ef9340..187c20e 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -1,6 +1,10 @@
+.travis.yml
+appveyor.yml
Build.PL
+Changes
lib/Hash/StoredIterator.pm
lib/Hash/StoredIterator.xs
+LICENSE
MANIFEST This list of files
META.json
META.yml
diff --git a/META.json b/META.json
index 421b7ab..fd2b0be 100644
--- a/META.json
+++ b/META.json
@@ -4,7 +4,7 @@
"Chad Granum <exodi...@gmail.com>"
],
"dynamic_config" : 1,
- "generated_by" : "Module::Build version 0.4003, CPAN::Meta::Converter
version 2.120921",
+ "generated_by" : "Module::Build version 0.4218",
"license" : [
"perl_5"
],
@@ -17,32 +17,41 @@
"build" : {
"requires" : {
"ExtUtils::CBuilder" : "0",
- "ExtUtils::ParseXS" : "3.15",
- "Fennec" : "2.004"
+ "ExtUtils::ParseXS" : "3.15"
}
},
"configure" : {
"requires" : {
- "Module::Build" : "0.40"
+ "Module::Build" : "0.42"
}
},
"runtime" : {
"requires" : {
"perl" : "v5.10.0"
}
+ },
+ "test" : {
+ "requires" : {
+ "Test2::Bundle::Extended" : "0",
+ "Test2::Tools::Spec" : "0"
+ }
}
},
"provides" : {
"Hash::StoredIterator" : {
"file" : "lib/Hash/StoredIterator.pm",
- "version" : "0.007"
+ "version" : "0.008"
}
},
"release_status" : "stable",
"resources" : {
"license" : [
"http://dev.perl.org/licenses/";
- ]
+ ],
+ "repository" : {
+ "url" : "https://github.com/exodist/Hash-StoredIterator";
+ }
},
- "version" : "0.007"
+ "version" : "0.008",
+ "x_serialization_backend" : "JSON::PP version 2.27400"
}
diff --git a/META.yml b/META.yml
index 74682e9..72c24e8 100644
--- a/META.yml
+++ b/META.yml
@@ -3,24 +3,27 @@ abstract: 'Functions for accessing a hashes internal
iterator.'
author:
- 'Chad Granum <exodi...@gmail.com>'
build_requires:
- ExtUtils::CBuilder: 0
- ExtUtils::ParseXS: 3.15
- Fennec: 2.004
+ ExtUtils::CBuilder: '0'
+ ExtUtils::ParseXS: '3.15'
+ Test2::Bundle::Extended: '0'
+ Test2::Tools::Spec: '0'
configure_requires:
- Module::Build: 0.40
+ Module::Build: '0.42'
dynamic_config: 1
-generated_by: 'Module::Build version 0.4003, CPAN::Meta::Converter version
2.120921'
+generated_by: 'Module::Build version 0.4218, CPAN::Meta::Converter version
2.150005'
license: perl
meta-spec:
url: http://module-build.sourceforge.net/META-spec-v1.4.html
- version: 1.4
+ version: '1.4'
name: Hash-StoredIterator
provides:
Hash::StoredIterator:
file: lib/Hash/StoredIterator.pm
- version: 0.007
+ version: '0.008'
requires:
perl: v5.10.0
resources:
license: http://dev.perl.org/licenses/
-version: 0.007
+ repository: https://github.com/exodist/Hash-StoredIterator
+version: '0.008'
+x_serialization_backend: 'CPAN::Meta::YAML version 0.012'
diff --git a/README b/README
index 2d0b223..53c8732 100644
--- a/README
+++ b/README
@@ -1,27 +1,30 @@
NAME
+
Hash::StoredIterator - Functions for accessing a hashes internal
iterator.
DESCRIPTION
+
In perl all hashes have an internal iterator. This iterator is used by
- the "each()" function, as well as by "keys()" and "values()". Because
- these all share use of the same iterator, they tend to interact badly
- with eachother when nested.
+ the each() function, as well as by keys() and values(). Because these
+ all share use of the same iterator, they tend to interact badly with
+ each other when nested.
- Hash::StoredIterator gives you access to get, set, and init the iterator
- inside a hash. This allows you to store the current iterator, use
- each/keys/values/etc, and then restore the iterator, this helps you to
- ensure you do not interact badly with other users of the iterator.
+ Hash::StoredIterator gives you access to get, set, and init the
+ iterator inside a hash. This allows you to store the current iterator,
+ use each/keys/values/etc, and then restore the iterator, this helps you
+ to ensure you do not interact badly with other users of the iterator.
- Along with low-level get/set/init functions, there are also 2 variations
- of "each()" which let you act upon each key/value pair in a safer way
- than vanilla "each()"
+ Along with low-level get/set/init functions, there are also 2
+ variations of each() which let you act upon each key/value pair in a
+ safer way than vanilla each()
- This module can also export new implementations of "keys()" and
- "values()" which stash and restore the iterator so that they are safe to
- use within "each()".
+ This module can also export new implementations of keys() and values()
+ which stash and restore the iterator so that they are safe to use
+ within each().
SYNOPSIS
+
use Hash::StoredIterator qw{
hmap
hkeys
@@ -31,9 +34,9 @@ SYNOPSIS
hash_set_iterator
hash_init_iterator
};
-
+
my %hash = map { $_ => uc( $_ )} 'a' .. 'z';
-
+
my @keys = hkeys %hash;
my @values = hvalues %hash;
@@ -43,18 +46,17 @@ SYNOPSIS
while( my ( $k, $v ) = $i->() ) {
print "$k: $value\n";
}
-
+
hmap { print "$a: $b\n" } %hash;
-
+
hamp { print "$_: $b\n" } %hash;
-
+
hmap {
my ( $key, $val ) = @_;
print "$key: $val\n";
} %hash;
- It is safe to nest calls to "hmap()", "iterator()", "hkeys()", and
- "hvalues()"
+ It is safe to nest calls to hmap(), iterator(), hkeys(), and hvalues()
hmap {
my ( $key, $val ) = @_;
@@ -62,13 +64,13 @@ SYNOPSIS
my @keys = hkeys( %hash );
} %hash;
- "hmap()" and "iterator()" will also properly handle calls to
- "CORE::each", "CORE::keys", and "Core::values" nested within them.
+ hmap() and iterator() will also properly handle calls to CORE::each,
+ CORE::keys, and Core::values nested within them.
hmap {
my ( $key, $val ) = @_;
print "$key: $val\n";
-
+
# No infinite loop!
my @keys = keys %hash;
} %hash;
@@ -82,90 +84,106 @@ SYNOPSIS
hash_set_iterator( \%hash, $iter );
EXPORTS
+
my $i = iterator %hash
- Get an iterator that can be used to retrieve key/value pairs.
- my $i = iterator %hash;
- while( my ($k, $v) = $i->() ) {
- ...
- }
+ Get an iterator that can be used to retrieve key/value pairs.
- The iterator is a coderef, so you call it like this: "$i-"()>. You
- can also use the sub anywhere you would use any other coderef.
+ my $i = iterator %hash;
+ while( my ($k, $v) = $i->() ) {
+ ...
+ }
+
+ The iterator is a coderef, so you call it like this: $i-()>. You can
+ also use the sub anywhere you would use any other coderef.
hmap( \&callback, %hash )
+
hmap { ... } %hash
- Iterate each key/pair calling "$callback-"( $key, $value )> for each
- set. In addition $a and $_ are set to the key, and $b is set to the
- value. This is done primarily for convenience of matching against
- the key, and short callbacks that will be cluttered by parsing @_
- noise.
- Note: See caveats.
+ Iterate each key/pair calling $callback-( $key, $value )> for each
+ set. In addition $a and $_ are set to the key, and $b is set to the
+ value. This is done primarily for convenience of matching against the
+ key, and short callbacks that will be cluttered by parsing @_ noise.
+
+ Note: See caveats.
my @keys = hkeys( %hash )
- Same as the builtin "keys()", except it stores and restores the
- iterator.
- Note: Overriding the builtin keys(), even locally, causes stange
- interactions with other builtins. When trying to export hkeys as
- keys, a call to "sort keys %hash" would cause undef to be passed
- into keys() as the first and only argument.
+ Same as the builtin keys(), except it stores and restores the
+ iterator.
+
+ Note: Overriding the builtin keys(), even locally, causes strange
+ interactions with other builtins. When trying to export hkeys as
+ keys, a call to sort keys %hash would cause undef to be passed into
+ keys() as the first and only argument.
my @values = hvalues( %hash )
- Same as the builtin "values()", except it stores and restores the
- iterator.
- Note: Overriding the builtin values(), even locally, causes stange
- interactions with other builtins. When trying to export hvalues as
- values, a call to "sort values %hash" would cause undef to be passed
- into values() as the first and only argument.
+ Same as the builtin values(), except it stores and restores the
+ iterator.
+
+ Note: Overriding the builtin values(), even locally, causes strange
+ interactions with other builtins. When trying to export hvalues as
+ values, a call to sort values %hash would cause undef to be passed
+ into values() as the first and only argument.
my $i = hash_get_iterator( \%hash )
- Get the current iterator value.
+
+ Get the current iterator value.
hash_set_iterator( \%hash, $i )
- Set the iterator value.
- Note: Only ever set this to the value retrieved by
- "hash_get_iterator()", setting the iterator in any other way is
- untested, and may result in undefined behavior.
+ Set the iterator value.
+
+ Note: Only ever set this to the value retrieved by
+ hash_get_iterator(), setting the iterator in any other way is
+ untested, and may result in undefined behavior.
hash_init_iterator( \%hash )
- Initialize or reset the hash iterator.
+
+ Initialize or reset the hash iterator.
DEPRECATED
+
These have been deprecated because they were terrible names. eich was
also deprecated because it was unnatural to use.
eich
- use iterator() instead
+
+ use iterator() instead
eech
- use hmap instead
+
+ use hmap instead
CAVEATS
+
Modification of hash during iteration
- Just like with the builtin "each()" modifying the hash between calls
- to each is not recommended and can result in undefined behavior. The
- builtin "each()" does allow for deleting the iterations key, however
- that is NOT supported by this library.
+
+ Just like with the builtin each() modifying the hash between calls to
+ each is not recommended and can result in undefined behavior. The
+ builtin each() does allow for deleting the iterations key, however
+ that is NOT supported by this library.
sort() edge case
- For some reason "[sort hkeys %hash]" and "[sort hkeys(%hash)]" both
- result in a list that has all the keys and values (and strangly not
- in sorted order). However "[sort(hkeys(%hash))]" works fine.
+
+ For some reason [sort hkeys %hash] and [sort hkeys(%hash)] both
+ result in a list that has all the keys and values (and strangely not
+ in sorted order). However [sort(hkeys(%hash))] works fine.
AUTHORS
+
Chad Granum exodi...@gmail.com
COPYRIGHT
+
Copyright (C) 2013 Chad Granum
Hash-StoredIterator is free software; Standard perl licence.
Hash-StoredIterator is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the license for
- more details.
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the license
+ for more details.
diff --git a/appveyor.yml b/appveyor.yml
new file mode 100644
index 0000000..b4364b0
--- /dev/null
+++ b/appveyor.yml
@@ -0,0 +1,21 @@
+branches:
+ except:
+ - /travis/
+skip_tags: true
+
+cache:
+ - C:\strawberry
+
+install:
+ - if not exist "C:\strawberry" cinst strawberryperl -y
+ - set
PATH=C:\strawberry\perl\bin;C:\strawberry\perl\site\bin;C:\strawberry\c\bin;%PATH%
+ - cd C:\projects\%APPVEYOR_PROJECT_NAME%
+ - cpanm --installdeps .
+
+build_script:
+ - perl Build.PL
+ - ./Build
+
+test_script:
+ - ./Build test
+
diff --git a/lib/Hash/StoredIterator.pm b/lib/Hash/StoredIterator.pm
index 604143c..d93550b 100644
--- a/lib/Hash/StoredIterator.pm
+++ b/lib/Hash/StoredIterator.pm
@@ -20,7 +20,11 @@ our @EXPORT_OK = qw{
hvalues
};
-our $VERSION = '0.007';
+our %EXPORT_TAGS = (
+ 'all' => \@EXPORT_OK
+);
+
+our $VERSION = '0.008';
require XSLoader;
XSLoader::load( 'Hash::StoredIterator', $VERSION );
@@ -169,8 +173,8 @@ Hash::StoredIterator - Functions for accessing a hashes
internal iterator.
In perl all hashes have an internal iterator. This iterator is used by the
C<each()> function, as well as by C<keys()> and C<values()>. Because these all
-share use of the same iterator, they tend to interact badly with eachother when
-nested.
+share use of the same iterator, they tend to interact badly with each other
+when nested.
Hash::StoredIterator gives you access to get, set, and init the iterator inside
a hash. This allows you to store the current iterator, use
@@ -277,7 +281,7 @@ B<Note:> See caveats.
Same as the builtin C<keys()>, except it stores and restores the iterator.
-B<Note:> Overriding the builtin keys(), even locally, causes stange
+B<Note:> Overriding the builtin keys(), even locally, causes strange
interactions with other builtins. When trying to export hkeys as keys, a call
to C<sort keys %hash> would cause undef to be passed into keys() as the first
and only argument.
@@ -286,7 +290,7 @@ and only argument.
Same as the builtin C<values()>, except it stores and restores the iterator.
-B<Note:> Overriding the builtin values(), even locally, causes stange
+B<Note:> Overriding the builtin values(), even locally, causes strange
interactions with other builtins. When trying to export hvalues as values, a
call to C<sort values %hash> would cause undef to be passed into values() as
the first and only argument.
@@ -340,7 +344,7 @@ this library.
=item sort() edge case
For some reason C<[sort hkeys %hash]> and C<[sort hkeys(%hash)]> both result in
-a list that has all the keys and values (and strangly not in sorted order).
+a list that has all the keys and values (and strangely not in sorted order).
However C<[sort(hkeys(%hash))]> works fine.
=back
diff --git a/t/Hash-StoredIterator.t b/t/Hash-StoredIterator.t
index 0cf81bd..06cc523 100644
--- a/t/Hash-StoredIterator.t
+++ b/t/Hash-StoredIterator.t
@@ -1,29 +1,7 @@
-package Test::Hash::StoredIterator;
-use strict;
-use warnings;
-
-use Fennec;
-use ExtUtils::testlib;
-
-our $CLASS;
-
-BEGIN {
- $CLASS = 'Hash::StoredIterator';
- my @import = qw{
- eich
- eech
- hkeys
- hvalues
- hash_get_iterator
- hash_set_iterator
- hash_init_iterator
- hmap
- iterator
- };
+use Test2::Bundle::Extended -target => 'Hash::StoredIterator';
+use Test2::Tools::Spec;
- use_ok( $CLASS, @import );
- can_ok( $CLASS, @import );
-}
+use Hash::StoredIterator ':all';
my %hash = ( a => 1, b => 2, c => 3 );
@@ -69,26 +47,28 @@ describe eaches => sub {
my @inner;
my @outer;
- my $o_it;
- while ( my ( $k, $v ) = eich( %hash, $o_it ) ) {
- push @outer => [$k, $v];
- $interference->();
+ warnings {
+ my $o_it;
+ while ( my ( $k, $v ) = eich( %hash, $o_it ) ) {
+ push @outer => [$k, $v];
+ $interference->();
- my $i_it;
- while ( my ( $k, $v ) = eich( %hash, $i_it ) ) {
- push @inner => [$k, $v];
+ my $i_it;
+ while ( my ( $k, $v ) = eich( %hash, $i_it ) ) {
+ push @inner => [$k, $v];
- $interference->();
+ $interference->();
+ }
}
- }
+ };
- is_deeply(
+ is(
[sort { $a->[0] cmp $b->[0] } @outer],
\@want_outer,
"Out loop got all keys"
);
- is_deeply(
+ is(
[sort { $a->[0] cmp $b->[0] } @inner],
\@want_inner,
"Inner loop got all keys multiple times"
@@ -129,13 +109,13 @@ describe eaches => sub {
} %hash;
#>>>
- is_deeply(
+ is(
[sort { $a->[0] cmp $b->[0] } @outer],
\@want_outer,
"Outer loop got all keys"
);
- is_deeply(
+ is(
[sort { $a->[0] cmp $b->[0] } @inner],
\@want_inner,
"Inner loop got all keys multiple times"
@@ -146,19 +126,22 @@ describe eaches => sub {
tests get_from_eich => sub {
my $i;
my $h = {%hash};
- my ( $k, $v ) = eich( %$h, $i );
- ok( $k, "Got a key" );
- ok( $v, "got a value" );
+
+ warnings {
+ my ( $k, $v ) = eich( %$h, $i );
+ ok( $k, "Got a key" );
+ ok( $v, "got a value" );
+ };
};
tests keys_and_vals => sub {
- is_deeply(
+ is(
[sort( hkeys(%hash) )],
[sort keys %hash],
"Same list from both keys and hkeys"
);
- is_deeply(
+ is(
[sort( hvalues(%hash) )],
[sort values %hash],
"Same list from both values and hvalues"
@@ -191,22 +174,19 @@ tests death => sub {
is( $key, $skey, "Iterator was restored" );
};
-tests strange_edge_case => (
- todo => "Not sure what the problem is here...",
- sub {
- is_deeply(
- [sort hkeys %hash],
- [sort keys %hash],
- "Same list from both keys and hkeys"
- );
+tests strange_edge_case => { todo => "Not sure what the problem is here..." }
=> sub {
+ is(
+ [sort hkeys %hash],
+ [sort keys %hash],
+ "Same list from both keys and hkeys"
+ );
- is_deeply(
- [sort hkeys(%hash)],
- [sort keys %hash],
- "Same list from both keys and hkeys"
- );
- },
-);
+ is(
+ [sort hkeys(%hash)],
+ [sort keys %hash],
+ "Same list from both keys and hkeys"
+ );
+};
tests iterator => sub {
my $i = iterator %hash;
@@ -217,13 +197,13 @@ tests iterator => sub {
$i->(),
};
- is_deeply(
+ is(
$nh,
\%hash,
"Copied hash via iterator"
);
- is_deeply(
+ is(
[$i->()],
[],
"End, no more"
--
Alioth's /usr/local/bin/git-commit-notice on
/srv/git.debian.org/git/pkg-perl/packages/libhash-storediterator-perl.git
_______________________________________________
Pkg-perl-cvs-commits mailing list
Pkg-perl-cvs-commits@lists.alioth.debian.org
http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-perl-cvs-commits
