Enterprise Perl

Total Page:16

File Type:pdf, Size:1020Kb

Enterprise Perl Enterprise Perl Jacinta Richardson Paul Fenwick Enterprise Perl by Jacinta Richardson and Paul Fenwick Copyright © 2009 Jacinta Richardson ([email protected]) Copyright © 2009 Paul Fenwick ([email protected]) Copyright © 2009 Perl Training Australia (http://perltraining.com.au) Conventions used throughout this text are based upon the conventions used in the Netizen training manuals by Kirrily Robert, and found at http://sourceforge.net/projects/spork Distribution of this work is prohibited unless prior permission is obtained from the copyright holder. These notes represent a work-in-progress for Perl Training Australia’s upcoming "Enterprise Perl" course. The OSCON tutorial, "Doing Perl Right", is intended as a heavily condensed version of this course for a conference setting. As these notes are a work-in-progress, the authors apologise for any omissions, mistakes, and completely missing sections that may exist. Updated copies of these notes will become available for free on Perl Training Australia’s course notes page, at http://www.perltraining.com.au/notes.html. This is revision 0.1-alpha-oscon of Perl Training Australia’s "Enterprise Perl" training manual. Table of Contents 1. About Perl Training Australia....................................................................................................... 1 Training.......................................................................................................................................1 Consulting ...................................................................................................................................1 Contact us....................................................................................................................................1 2. Rationale..........................................................................................................................................2 The moving target of "best practice"...........................................................................................2 "Perl Best Practices" by Dr Damian Conway.................................................................... 2 Focus of this course..................................................................................................................... 2 Intended audience ....................................................................................................................... 2 3. Starting a Project............................................................................................................................4 Things to consider....................................................................................................................... 4 Perl’s modules.............................................................................................................................4 Module locations ............................................................................................................... 5 Building a module with Module::Starter ....................................................................................5 Using module-starter ......................................................................................................... 6 Configuration ........................................................................................................... 6 A skeleton tour .................................................................................................................. 6 Encapsulation and big systems ...................................................................................................8 Class exercise .................................................................................................................... 8 Further information ........................................................................................................... 9 4. Accessing Perl’s documentation with perldoc............................................................................10 perldoc.......................................................................................................................................10 Module documentation .............................................................................................................10 Function documentation............................................................................................................11 Questions and answers..............................................................................................................11 General pages............................................................................................................................11 Tutorials...........................................................................................................................11 Writing your own POD (Plain Old Documentation).................................................................12 Paragraphs .......................................................................................................................12 An example......................................................................................................................14 5. Testing ............................................................................................................................................16 Oh no! .......................................................................................................................................16 POD Testing..............................................................................................................................16 Test::Pod ..........................................................................................................................16 Test::Pod::Coverage.........................................................................................................16 Trying it out.....................................................................................................................17 Testing Strategies ......................................................................................................................17 Black box testing .............................................................................................................17 White box testing.............................................................................................................18 Testing your code ......................................................................................................................18 Test::Harness ...................................................................................................................18 Test::More........................................................................................................................19 Coverage testing and Devel::Cover .................................................................................20 Putting it all together, an example.............................................................................................21 Our module......................................................................................................................21 Some tests........................................................................................................................23 Test results.......................................................................................................................24 Results from running test.t directly:...................................................................24 Perl Training Australia (http://perltraining.com.au/) iii Results from running tests using test harness........................................................25 Results from running tests compiled with Devel::Cover.......................................25 Good tests..................................................................................................................................29 Chapter summary ......................................................................................................................30 6. Writing good code.........................................................................................................................31 Perl::Critic - automatically review your code ...........................................................................31 Levels of severity.............................................................................................................31 Perl::Critic online ............................................................................................................31 perlcritic on the command-line........................................................................................31 Understanding the output.......................................................................................32 Excluding and including rules ...............................................................................33 Profiles ...................................................................................................................33 Perl::Critic and testing.....................................................................................................33 Progressive testing .................................................................................................34 Further reading ................................................................................................................34 7. autodie - The art of Klingon Programming ...............................................................................35
Recommended publications
  • [PDF] Beginning Raku
    Beginning Raku Arne Sommer Version 1.00, 22.12.2019 Table of Contents Introduction. 1 The Little Print . 1 Reading Tips . 2 Content . 3 1. About Raku. 5 1.1. Rakudo. 5 1.2. Running Raku in the browser . 6 1.3. REPL. 6 1.4. One Liners . 8 1.5. Running Programs . 9 1.6. Error messages . 9 1.7. use v6. 10 1.8. Documentation . 10 1.9. More Information. 13 1.10. Speed . 13 2. Variables, Operators, Values and Procedures. 15 2.1. Output with say and print . 15 2.2. Variables . 15 2.3. Comments. 17 2.4. Non-destructive operators . 18 2.5. Numerical Operators . 19 2.6. Operator Precedence . 20 2.7. Values . 22 2.8. Variable Names . 24 2.9. constant. 26 2.10. Sigilless variables . 26 2.11. True and False. 27 2.12. // . 29 3. The Type System. 31 3.1. Strong Typing . 31 3.2. ^mro (Method Resolution Order) . 33 3.3. Everything is an Object . 34 3.4. Special Values . 36 3.5. :D (Defined Adverb) . 38 3.6. Type Conversion . 39 3.7. Comparison Operators . 42 4. Control Flow . 47 4.1. Blocks. 47 4.2. Ranges (A Short Introduction). 47 4.3. loop . 48 4.4. for . 49 4.5. Infinite Loops. 53 4.6. while . 53 4.7. until . 54 4.8. repeat while . 55 4.9. repeat until. 55 4.10. Loop Summary . 56 4.11. if . ..
    [Show full text]
  • Bbedit 13.5 User Manual
    User Manual BBEdit™ Professional Code and Text Editor for the Macintosh Bare Bones Software, Inc. ™ BBEdit 13.5 Product Design Jim Correia, Rich Siegel, Steve Kalkwarf, Patrick Woolsey Product Engineering Jim Correia, Seth Dillingham, Matt Henderson, Jon Hueras, Steve Kalkwarf, Rich Siegel, Steve Sisak Engineers Emeritus Chris Borton, Tom Emerson, Pete Gontier, Jamie McCarthy, John Norstad, Jon Pugh, Mark Romano, Eric Slosser, Rob Vaterlaus Documentation Fritz Anderson, Philip Borenstein, Stephen Chernicoff, John Gruber, Jeff Mattson, Jerry Kindall, Caroline Rose, Allan Rouselle, Rich Siegel, Vicky Wong, Patrick Woolsey Additional Engineering Polaschek Computing Icon Design Bryan Bell Factory Color Schemes Luke Andrews Additional Color Schemes Toothpaste by Cat Noon, and Xcode Dark by Andrew Carter. Used by permission. Additional Icons By icons8. Used under license Additional Artwork By Jonathan Hunt PHP keyword lists Contributed by Ted Stresen-Reuter. Previous versions by Carsten Blüm Published by: Bare Bones Software, Inc. 73 Princeton Street, Suite 206 North Chelmsford, MA 01863 USA (978) 251-0500 main (978) 251-0525 fax https://www.barebones.com/ Sales & customer service: [email protected] Technical support: [email protected] BBEdit and the BBEdit User Manual are copyright ©1992-2020 Bare Bones Software, Inc. All rights reserved. Produced/published in USA. Copyrights, Licenses & Trademarks cmark ©2014 by John MacFarlane. Used under license; part of the CommonMark project LibNcFTP Used under license from and copyright © 1996-2010 Mike Gleason & NcFTP Software Exuberant ctags ©1996-2004 Darren Hiebert (source code here) PCRE2 Library Written by Philip Hazel and Zoltán Herczeg ©1997-2018 University of Cambridge, England Info-ZIP Library ©1990-2009 Info-ZIP.
    [Show full text]
  • Intermediate Perl – Session 7
    1.1.2.8 – Intermediate Perl 1.1.2.8.7 Intermediate Perl – Session 7 · POD – plain old documentation · processing command line parameters · processing configuration files 9/23/2008 1.1.2.8.7 - Intermediate Perl - POD, parameters and configuration 1 1.1.2.8 – Intermediate Perl POD – plain old documentation ·embed documentation in your scripts with POD ·POD is very simple because it stands for Plain Old Documentation · it is meant to be easy to use – and it is! · POD is a simple markup language · write documentation once and export it to multiple formats · man, html, text · POD formatting codes are embedded in your script ·Pod::Usage module displays documentation for the script when the script is executed · how handy is that? 9/23/2008 1.1.2.8.7 - Intermediate Perl - POD, parameters and configuration 2 1.1.2.8 – Intermediate Perl POD structure – sections start and end pod with =pod =pod and =cut =head1 NAME script – take over the world in one line of Perl separate paragraphs by =head1 SYNOPSIS new lines script –mode EVIL|GOOD [-debug] use =head1 and =head2 =head1 DESCRIPTION for headings You can take over the world as an EVIL doer or a GOOD doer. Pick one. =head2 EVIL indent code Evil is more fun. =head2 GOOD =over and =back to =over indent text =item * advantages =item * for bullet lists none =item * disadvantages no fun =back =cut 9/23/2008 1.1.2.8.7 - Intermediate Perl - POD, parameters and configuration 3 1.1.2.8 – Intermediate Perl POD structure – ordinary paragraphs ordinary paragraphs # contents of podexample =pod representing text that =head1 EXAMPLE you'd like wrapped and justified have no This is an ordinary paragraph that will be indented, wrapped and maybe even justified.
    [Show full text]
  • "This Book Was a Joy to Read. It Covered All Sorts of Techniques for Debugging, Including 'Defensive' Paradigms That Will Eliminate Bugs in the First Place
    Perl Debugged By Peter Scott, Ed Wright Publisher : Addison Wesley Pub Date : March 01, 2001 ISBN : 0-201-70054-9 Table of • Pages : 288 Contents "This book was a joy to read. It covered all sorts of techniques for debugging, including 'defensive' paradigms that will eliminate bugs in the first place. As coach of the USA Programming Team, I find the most difficult thing to teach is debugging. This is the first text I've even heard of that attacks the problem. It does a fine job. Please encourage these guys to write more." -Rob Kolstad Perl Debugged provides the expertise and solutions developers require for coding better, faster, and more reliably in Perl. Focusing on debugging, the most vexing aspect of programming in Perl, this example-rich reference and how-to guide minimizes development, troubleshooting, and maintenance time resulting in the creation of elegant and error-free Perl code. Designed for the novice to intermediate software developer, Perl Debugged will save the programmer time and frustration in debugging Perl programs. Based on the authors' extensive experience with the language, this book guides developers through the entire programming process, tackling the benefits, plights, and pitfalls of Perl programming. Beginning with a guided tour of the Perl documentation, the book progresses to debugging, testing, and performance issues, and also devotes a chapter to CGI programming in Perl. Throughout the book, the authors espouse defensible paradigms for improving the accuracy and performance of Perl code. In addition, Perl Debugged includes Scott and Wright's "Perls of Wisdom" which summarize key ideas from each of the chapters, and an appendix containing a comprehensive listing of Perl debugger commands.
    [Show full text]
  • EN-Google Hacks.Pdf
    Table of Contents Credits Foreword Preface Chapter 1. Searching Google 1. Setting Preferences 2. Language Tools 3. Anatomy of a Search Result 4. Specialized Vocabularies: Slang and Terminology 5. Getting Around the 10 Word Limit 6. Word Order Matters 7. Repetition Matters 8. Mixing Syntaxes 9. Hacking Google URLs 10. Hacking Google Search Forms 11. Date-Range Searching 12. Understanding and Using Julian Dates 13. Using Full-Word Wildcards 14. inurl: Versus site: 15. Checking Spelling 16. Consulting the Dictionary 17. Consulting the Phonebook 18. Tracking Stocks 19. Google Interface for Translators 20. Searching Article Archives 21. Finding Directories of Information 22. Finding Technical Definitions 23. Finding Weblog Commentary 24. The Google Toolbar 25. The Mozilla Google Toolbar 26. The Quick Search Toolbar 27. GAPIS 28. Googling with Bookmarklets Chapter 2. Google Special Services and Collections 29. Google Directory 30. Google Groups 31. Google Images 32. Google News 33. Google Catalogs 34. Froogle 35. Google Labs Chapter 3. Third-Party Google Services 36. XooMLe: The Google API in Plain Old XML 37. Google by Email 38. Simplifying Google Groups URLs 39. What Does Google Think Of... 40. GooglePeople Chapter 4. Non-API Google Applications 41. Don't Try This at Home 42. Building a Custom Date-Range Search Form 43. Building Google Directory URLs 44. Scraping Google Results 45. Scraping Google AdWords 46. Scraping Google Groups 47. Scraping Google News 48. Scraping Google Catalogs 49. Scraping the Google Phonebook Chapter 5. Introducing the Google Web API 50. Programming the Google Web API with Perl 51. Looping Around the 10-Result Limit 52.
    [Show full text]
  • Name Description
    Perl version 5.10.0 documentation - perlnewmod NAME perlnewmod - preparing a new module for distribution DESCRIPTION This document gives you some suggestions about how to go about writingPerl modules, preparing them for distribution, and making them availablevia CPAN. One of the things that makes Perl really powerful is the fact that Perlhackers tend to want to share the solutions to problems they've faced,so you and I don't have to battle with the same problem again. The main way they do this is by abstracting the solution into a Perlmodule. If you don't know what one of these is, the rest of thisdocument isn't going to be much use to you. You're also missing out onan awful lot of useful code; consider having a look at perlmod, perlmodlib and perlmodinstall before coming back here. When you've found that there isn't a module available for what you'retrying to do, and you've had to write the code yourself, considerpackaging up the solution into a module and uploading it to CPAN so thatothers can benefit. Warning We're going to primarily concentrate on Perl-only modules here, ratherthan XS modules. XS modules serve a rather different purpose, andyou should consider different things before distributing them - thepopularity of the library you are gluing, the portability to otheroperating systems, and so on. However, the notes on preparing the Perlside of the module and packaging and distributing it will apply equallywell to an XS module as a pure-Perl one. What should I make into a module? You should make a module out of any code that you think is going to beuseful to others.
    [Show full text]
  • Coleman-Coding-Freedom.Pdf
    Coding Freedom !" Coding Freedom THE ETHICS AND AESTHETICS OF HACKING !" E. GABRIELLA COLEMAN PRINCETON UNIVERSITY PRESS PRINCETON AND OXFORD Copyright © 2013 by Princeton University Press Creative Commons Attribution- NonCommercial- NoDerivs CC BY- NC- ND Requests for permission to modify material from this work should be sent to Permissions, Princeton University Press Published by Princeton University Press, 41 William Street, Princeton, New Jersey 08540 In the United Kingdom: Princeton University Press, 6 Oxford Street, Woodstock, Oxfordshire OX20 1TW press.princeton.edu All Rights Reserved At the time of writing of this book, the references to Internet Web sites (URLs) were accurate. Neither the author nor Princeton University Press is responsible for URLs that may have expired or changed since the manuscript was prepared. Library of Congress Cataloging-in-Publication Data Coleman, E. Gabriella, 1973– Coding freedom : the ethics and aesthetics of hacking / E. Gabriella Coleman. p. cm. Includes bibliographical references and index. ISBN 978-0-691-14460-3 (hbk. : alk. paper)—ISBN 978-0-691-14461-0 (pbk. : alk. paper) 1. Computer hackers. 2. Computer programmers. 3. Computer programming—Moral and ethical aspects. 4. Computer programming—Social aspects. 5. Intellectual freedom. I. Title. HD8039.D37C65 2012 174’.90051--dc23 2012031422 British Library Cataloging- in- Publication Data is available This book has been composed in Sabon Printed on acid- free paper. ∞ Printed in the United States of America 1 3 5 7 9 10 8 6 4 2 This book 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 !" We must be free not because we claim freedom, but because we practice it.
    [Show full text]
  • The Bioperl Toolkit: Perl Modules for the Life Sciences
    Downloaded from genome.cshlp.org on January 25, 2012 - Published by Cold Spring Harbor Laboratory Press The Bioperl Toolkit: Perl Modules for the Life Sciences Jason E. Stajich, David Block, Kris Boulez, et al. Genome Res. 2002 12: 1611-1618 Access the most recent version at doi:10.1101/gr.361602 Supplemental http://genome.cshlp.org/content/suppl/2002/10/20/12.10.1611.DC1.html Material References This article cites 14 articles, 9 of which can be accessed free at: http://genome.cshlp.org/content/12/10/1611.full.html#ref-list-1 Article cited in: http://genome.cshlp.org/content/12/10/1611.full.html#related-urls Email alerting Receive free email alerts when new articles cite this article - sign up in the box at the service top right corner of the article or click here To subscribe to Genome Research go to: http://genome.cshlp.org/subscriptions Cold Spring Harbor Laboratory Press Downloaded from genome.cshlp.org on January 25, 2012 - Published by Cold Spring Harbor Laboratory Press Resource The Bioperl Toolkit: Perl Modules for the Life Sciences Jason E. Stajich,1,18,19 David Block,2,18 Kris Boulez,3 Steven E. Brenner,4 Stephen A. Chervitz,5 Chris Dagdigian,6 Georg Fuellen,7 James G.R. Gilbert,8 Ian Korf,9 Hilmar Lapp,10 Heikki Lehva¨slaiho,11 Chad Matsalla,12 Chris J. Mungall,13 Brian I. Osborne,14 Matthew R. Pocock,8 Peter Schattner,15 Martin Senger,11 Lincoln D. Stein,16 Elia Stupka,17 Mark D. Wilkinson,2 and Ewan Birney11 1University Program in Genetics, Duke University, Durham, North Carolina 27710, USA; 2National Research Council of
    [Show full text]
  • Advancing Perl Supporting Community
    Advancing Perl Supporting Community 2012 Year End Report Board of Directors Nathan Torkington Chairman Karen Pauley President Jim Brandt Secretary Dan Wright Treasurer Kurt DeMaagd Curtis “Ovid” Poe Allison Randal Kevin Lenzo Director Emeritus Committee Chairs Alberto Simões Grants Heath Bair Conferences Mark Keating Marketing Ya’akov Sloman Community Advocacy Karen Pauley Steering The Perl Foundation 340 S Lemon Ave #6055 Walnut, CA 91789 The Perl Foundation is a business alias for The Yet Another Society, a 501-c-3 charitable organization, incorporated in the state of Michigan. A Look Inside: TPF Inside: A Look President’s Message This has been a great year for The Perl Foundation. Thanks to the generosity of our donors and corporate partners, the commitment of our volunteers, and the vitality and energy of our community, we have been able to continue in our mission to advance the Perl programming language. As you know, TPF depends on donations, both of time and money, to operate. These donations have made it possible for us to provide financial support to key developers of Perl 5 and Perl 6, to continue our efforts in protecting our trademark, and to support many community programs. One of the pillars of Perl is its community. We recently launched an initiative, the Community Advocacy Committee, targeting the growth and health of the Perl community. With the help of this committee we plan to not only improve communication within our own community but to expand our links with other F/OSS communities. This year has been one pointing to a great future for Perl and those who use it.
    [Show full text]
  • COMS 3101 Programming Languages: Perl Lecture 5
    COMS 3101 Programming Languages: Perl Lecture 5 Fall 2013 Instructor: Ilia Vovsha http://www.cs.columbia.edu/~vovsha/coms3101/perl Lecture Outline Packages & Modules Concepts: Subroutine references SbliSymbolic references Garbage collection Saving structures Objects and Classes Next: More OOP, CPAN 5.2 Remarks Pattern matching “cage” can be any character: • m// or // is equivalent to m{} • s/// is equivalent to s{} {} • // are just customary quote characters for pattern matching behavior. In fact you could choose your own character instead of {} (e.g. m ! !) • Convenient if lots of slhlashes in the pattern ref function: returns type of reference (a string) • $rtype = ref($href); # returns “HASH” • $rtype = ref($aref); # returns “ARRAY” • if ( ref($href) eq “HASH” ) { … } 5.3 Packages & Modules Why do we need them? Package or module, what is the difference? ‘use’ vs. ‘require’ Importing from another package Pragmatic modules (ppgragmas) 5.4 Packages (purpose) sub parse_text { # code from one file … $count = $count++; … } sub normalize { # code from another file $count++; … } # Use both functions: parse_text(); normalize(); print “$count\n”; # Which $count? What is its value? 5.5 Packages (definition) Balanced code: abstraction + reuse Every chkhunk of code has its own namespace. In PlPerl, a namespace is called a package Independent of files: • Multiple packages in one file • Single package spanning multiple files • Most common: one package per file Best approach: one package per file where file name is package name
    [Show full text]
  • Name Introduction Quick Checklist
    Perl version 5.10.0 documentation - perlmodstyle NAME perlmodstyle - Perl module style guide INTRODUCTION This document attempts to describe the Perl Community's "best practice"for writing Perl modules. It extends the recommendations found in perlstyle , which should be considered required readingbefore reading this document. While this document is intended to be useful to all module authors, it isparticularly aimed at authors who wish to publish their modules on CPAN. The focus is on elements of style which are visible to the users of a module, rather than those parts which are only seen by the module's developers. However, many of the guidelines presented in this documentcan be extrapolated and applied successfully to a module's internals. This document differs from perlnewmod in that it is a style guiderather than a tutorial on creating CPAN modules. It provides achecklist against which modules can be compared to determine whether they conform to best practice, without necessarily describing in detailhow to achieve this. All the advice contained in this document has been gleaned fromextensive conversations with experienced CPAN authors and users. Everypiece of advice given here is the result of previous mistakes. Thisinformation is here to help you avoid the same mistakes and the extrawork that would inevitably be required to fix them. The first section of this document provides an itemized checklist; subsequent sections provide a more detailed discussion of the items on the list. The final section, "Common Pitfalls", describes some of the most popular mistakes made by CPAN authors. QUICK CHECKLIST For more detail on each item in this checklist, see below.
    [Show full text]
  • Perlmonks.Com with a Gaim Plug-In SEEKING WISDOM
    PROGRAMMING Perl: A Gaim Plugin Get the news from perlmonks.com with a Gaim plug-in SEEKING WISDOM irst-time visitors to perlmonks. The Gaim project offers an instant messenger client that speaks a large com are rubbing their eyes in dis- Fbelief: High-caliber Perl hackers number of protocols. We’ll show you how to extend Gaim with Perl are jumping to answer even the simplest of newbie questions. The reason for this plugins. BY MICHAEL SCHILLI is that the community assigns XP (expe- rience) points for the best replies. And the more XP you have, the higher you answer a question correctly typically However, it can take a few seconds to climb in the ranking, from a novice, to a gets the most XP. Instead of pulling the download the content of a remote web monk, and slowly to expert status. web page with the latest questions time page. Both DNS name resolution and the and time again, it makes sense to script process of retrieving the content of the Best of Class the process and have the script let you requested web page can take some time, Due to the community dynamics on know when a new query arrives. during which the CPU should return to perlmonks.com, the The pmwatcher.pl script described other tasks. The tried-and-trusted POE first person to in this issue fetches the perlmonks. [3] framework provides exactly what we com page with the Newest Nodes at need. The POE kernel runs a single pro- regular intervals, remembering cess (and only a single thread), but uses older entries and sending out an cooperative multitasking between con- instant message when it discovers current tasks to ensure that each one is new postings.
    [Show full text]