From: Guillermo Roditi Date: Sat, 23 Feb 2008 22:13:11 +0000 (+0000) Subject: initial checkin X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=3890b670fd4eee3b2fb8782dc4372adf52557cc1;p=gitmo%2FMooseX-AutoDoc.git initial checkin --- 3890b670fd4eee3b2fb8782dc4372adf52557cc1 diff --git a/Changes b/Changes new file mode 100644 index 0000000..e69de29 diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..78c5d0d --- /dev/null +++ b/MANIFEST @@ -0,0 +1,40 @@ +Changes +inc/Module/AutoInstall.pm +inc/Module/Install.pm +inc/Module/Install/AutoInstall.pm +inc/Module/Install/Base.pm +inc/Module/Install/Can.pm +inc/Module/Install/Fetch.pm +inc/Module/Install/Include.pm +inc/Module/Install/Makefile.pm +inc/Module/Install/Metadata.pm +inc/Module/Install/Win32.pm +inc/Module/Install/WriteAll.pm +lib/MooseX/AutoDoc.pm +lib/MooseX/AutoDoc/View.pm +lib/MooseX/AutoDoc/View/TT.pm +Makefile.PL +MANIFEST This list of files +META.yml +README +t/000-load.t +t/001-basic.t +t/002-attributes.t +t/100-class.t +t/101-class.t +t/102-class.t +t/103-class.t +t/104-class.t +t/105-class.t +t/200-role.t +t/201-role.t +t/202-role.t +t/lib/AutoDocTest/Role/Role1.pm +t/lib/AutoDocTest/Role/Role2.pm +t/lib/AutoDocTest/Role/Role3.pm +t/lib/AutoDocTest1.pm +t/lib/AutoDocTest2.pm +t/lib/AutoDocTest3.pm +t/lib/AutoDocTest4.pm +t/lib/AutoDocTest5.pm +t/lib/AutoDocTest6.pm diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..88c4f9d --- /dev/null +++ b/META.yml @@ -0,0 +1,20 @@ +--- +abstract: Automatically generate documentation stubs for Moose-based classes. +author: ~ +build_requires: + Test::More: 0 +distribution_type: module +generated_by: Module::Install version 0.68 +license: unknown +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.3.html + version: 1.3 +name: MooseX-AutoDoc +no_index: + directory: + - inc + - t +requires: + Moose: 0.36 + Template: 0 +version: undef diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..8ca5e97 --- /dev/null +++ b/Makefile @@ -0,0 +1,832 @@ +# This Makefile is for the MooseX::AutoDoc extension to perl. +# +# It was generated automatically by MakeMaker version +# 6.42 (Revision: 41145) from the contents of +# Makefile.PL. Don't edit this file, edit Makefile.PL instead. +# +# ANY CHANGES MADE HERE WILL BE LOST! +# +# MakeMaker ARGV: () +# +# MakeMaker Parameters: + +# ABSTRACT => q[Automatically generate documentation stubs for Moose-based classes.] +# DIR => [] +# DISTNAME => q[MooseX-AutoDoc] +# NAME => q[MooseX::AutoDoc] +# NO_META => q[1] +# PL_FILES => { } +# PREREQ_PM => { Test::More=>q[0], Template=>q[0], Moose=>q[0.36] } +# VERSION => q[undef] +# dist => { PREOP=>q[$(PERL) -I. "-MModule::Install::Admin" -e "dist_preop(q($(DISTVNAME)))"] } +# test => { TESTS=>q[t/000-load.t t/001-basic.t t/002-attributes.t t/003-moosex-types.t t/100-class.t t/101-class.t t/102-class.t t/103-class.t t/104-class.t t/105-class.t t/200-role.t t/201-role.t t/202-role.t] } + +# --- MakeMaker post_initialize section: + + +# --- MakeMaker const_config section: + +# These definitions are from config.sh (via /usr/lib/perl/5.8/Config.pm) + +# They may have been overridden via Makefile.PL or on the command line +AR = ar +CC = cc +CCCDLFLAGS = -fPIC +CCDLFLAGS = -Wl,-E +DLEXT = so +DLSRC = dl_dlopen.xs +EXE_EXT = +FULL_AR = /usr/bin/ar +LD = cc +LDDLFLAGS = -shared -L/usr/local/lib +LDFLAGS = -L/usr/local/lib +LIBC = /lib/libc-2.6.1.so +LIB_EXT = .a +OBJ_EXT = .o +OSNAME = linux +OSVERS = 2.6.15.7 +RANLIB = : +SITELIBEXP = /usr/local/share/perl/5.8.8 +SITEARCHEXP = /usr/local/lib/perl/5.8.8 +SO = so +VENDORARCHEXP = /usr/lib/perl5 +VENDORLIBEXP = /usr/share/perl5 + + +# --- MakeMaker constants section: +AR_STATIC_ARGS = cr +DIRFILESEP = / +DFSEP = $(DIRFILESEP) +NAME = MooseX::AutoDoc +NAME_SYM = MooseX_AutoDoc +VERSION = undef +VERSION_MACRO = VERSION +VERSION_SYM = undef +DEFINE_VERSION = -D$(VERSION_MACRO)=\"$(VERSION)\" +XS_VERSION = undef +XS_VERSION_MACRO = XS_VERSION +XS_DEFINE_VERSION = -D$(XS_VERSION_MACRO)=\"$(XS_VERSION)\" +INST_ARCHLIB = blib/arch +INST_SCRIPT = blib/script +INST_BIN = blib/bin +INST_LIB = blib/lib +INST_MAN1DIR = blib/man1 +INST_MAN3DIR = blib/man3 +MAN1EXT = 1p +MAN3EXT = 3pm +INSTALLDIRS = site +DESTDIR = +PREFIX = $(SITEPREFIX) +PERLPREFIX = /usr +SITEPREFIX = /usr/local +VENDORPREFIX = /usr +INSTALLPRIVLIB = /usr/share/perl/5.8 +DESTINSTALLPRIVLIB = $(DESTDIR)$(INSTALLPRIVLIB) +INSTALLSITELIB = /usr/local/share/perl/5.8.8 +DESTINSTALLSITELIB = $(DESTDIR)$(INSTALLSITELIB) +INSTALLVENDORLIB = /usr/share/perl5 +DESTINSTALLVENDORLIB = $(DESTDIR)$(INSTALLVENDORLIB) +INSTALLARCHLIB = /usr/lib/perl/5.8 +DESTINSTALLARCHLIB = $(DESTDIR)$(INSTALLARCHLIB) +INSTALLSITEARCH = /usr/local/lib/perl/5.8.8 +DESTINSTALLSITEARCH = $(DESTDIR)$(INSTALLSITEARCH) +INSTALLVENDORARCH = /usr/lib/perl5 +DESTINSTALLVENDORARCH = $(DESTDIR)$(INSTALLVENDORARCH) +INSTALLBIN = /usr/bin +DESTINSTALLBIN = $(DESTDIR)$(INSTALLBIN) +INSTALLSITEBIN = /usr/local/bin +DESTINSTALLSITEBIN = $(DESTDIR)$(INSTALLSITEBIN) +INSTALLVENDORBIN = /usr/bin +DESTINSTALLVENDORBIN = $(DESTDIR)$(INSTALLVENDORBIN) +INSTALLSCRIPT = /usr/bin +DESTINSTALLSCRIPT = $(DESTDIR)$(INSTALLSCRIPT) +INSTALLSITESCRIPT = /usr/local/bin +DESTINSTALLSITESCRIPT = $(DESTDIR)$(INSTALLSITESCRIPT) +INSTALLVENDORSCRIPT = /usr/bin +DESTINSTALLVENDORSCRIPT = $(DESTDIR)$(INSTALLVENDORSCRIPT) +INSTALLMAN1DIR = /usr/share/man/man1 +DESTINSTALLMAN1DIR = $(DESTDIR)$(INSTALLMAN1DIR) +INSTALLSITEMAN1DIR = /usr/local/man/man1 +DESTINSTALLSITEMAN1DIR = $(DESTDIR)$(INSTALLSITEMAN1DIR) +INSTALLVENDORMAN1DIR = /usr/share/man/man1 +DESTINSTALLVENDORMAN1DIR = $(DESTDIR)$(INSTALLVENDORMAN1DIR) +INSTALLMAN3DIR = /usr/share/man/man3 +DESTINSTALLMAN3DIR = $(DESTDIR)$(INSTALLMAN3DIR) +INSTALLSITEMAN3DIR = /usr/local/man/man3 +DESTINSTALLSITEMAN3DIR = $(DESTDIR)$(INSTALLSITEMAN3DIR) +INSTALLVENDORMAN3DIR = /usr/share/man/man3 +DESTINSTALLVENDORMAN3DIR = $(DESTDIR)$(INSTALLVENDORMAN3DIR) +PERL_LIB = +PERL_ARCHLIB = /usr/lib/perl/5.8 +LIBPERL_A = libperl.a +FIRST_MAKEFILE = Makefile +MAKEFILE_OLD = Makefile.old +MAKE_APERL_FILE = Makefile.aperl +PERLMAINCC = $(CC) +PERL_INC = /usr/lib/perl/5.8/CORE +PERL = /usr/bin/perl "-Iinc" +FULLPERL = /usr/bin/perl "-Iinc" +ABSPERL = $(PERL) +PERLRUN = $(PERL) +FULLPERLRUN = $(FULLPERL) +ABSPERLRUN = $(ABSPERL) +PERLRUNINST = $(PERLRUN) "-I$(INST_ARCHLIB)" "-Iinc" "-I$(INST_LIB)" +FULLPERLRUNINST = $(FULLPERLRUN) "-I$(INST_ARCHLIB)" "-Iinc" "-I$(INST_LIB)" +ABSPERLRUNINST = $(ABSPERLRUN) "-I$(INST_ARCHLIB)" "-Iinc" "-I$(INST_LIB)" +PERL_CORE = 0 +PERM_RW = 644 +PERM_RWX = 755 + +MAKEMAKER = /usr/local/share/perl/5.8.8/ExtUtils/MakeMaker.pm +MM_VERSION = 6.42 +MM_REVISION = 41145 + +# FULLEXT = Pathname for extension directory (eg Foo/Bar/Oracle). +# BASEEXT = Basename part of FULLEXT. May be just equal FULLEXT. (eg Oracle) +# PARENT_NAME = NAME without BASEEXT and no trailing :: (eg Foo::Bar) +# DLBASE = Basename part of dynamic library. May be just equal BASEEXT. +MAKE = make +FULLEXT = MooseX/AutoDoc +BASEEXT = AutoDoc +PARENT_NAME = MooseX +DLBASE = $(BASEEXT) +VERSION_FROM = +OBJECT = +LDFROM = $(OBJECT) +LINKTYPE = dynamic +BOOTDEP = + +# Handy lists of source code files: +XS_FILES = +C_FILES = +O_FILES = +H_FILES = +MAN1PODS = +MAN3PODS = lib/MooseX/AutoDoc/View/TT.pm + +# Where is the Config information that we are using/depend on +CONFIGDEP = $(PERL_ARCHLIB)$(DFSEP)Config.pm $(PERL_INC)$(DFSEP)config.h + +# Where to build things +INST_LIBDIR = $(INST_LIB)/MooseX +INST_ARCHLIBDIR = $(INST_ARCHLIB)/MooseX + +INST_AUTODIR = $(INST_LIB)/auto/$(FULLEXT) +INST_ARCHAUTODIR = $(INST_ARCHLIB)/auto/$(FULLEXT) + +INST_STATIC = +INST_DYNAMIC = +INST_BOOT = + +# Extra linker info +EXPORT_LIST = +PERL_ARCHIVE = +PERL_ARCHIVE_AFTER = + + +TO_INST_PM = lib/MooseX/AutoDoc.pm \ + lib/MooseX/AutoDoc/View.pm \ + lib/MooseX/AutoDoc/View/TT.pm + +PM_TO_BLIB = lib/MooseX/AutoDoc/View/TT.pm \ + blib/lib/MooseX/AutoDoc/View/TT.pm \ + lib/MooseX/AutoDoc/View.pm \ + blib/lib/MooseX/AutoDoc/View.pm \ + lib/MooseX/AutoDoc.pm \ + blib/lib/MooseX/AutoDoc.pm + + +# --- MakeMaker platform_constants section: +MM_Unix_VERSION = 6.42 +PERL_MALLOC_DEF = -DPERL_EXTMALLOC_DEF -Dmalloc=Perl_malloc -Dfree=Perl_mfree -Drealloc=Perl_realloc -Dcalloc=Perl_calloc + + +# --- MakeMaker tool_autosplit section: +# Usage: $(AUTOSPLITFILE) FileToSplit AutoDirToSplitInto +AUTOSPLITFILE = $(ABSPERLRUN) -e 'use AutoSplit; autosplit($$ARGV[0], $$ARGV[1], 0, 1, 1)' -- + + + +# --- MakeMaker tool_xsubpp section: + + +# --- MakeMaker tools_other section: +SHELL = /bin/sh +CHMOD = chmod +CP = cp +MV = mv +NOOP = $(SHELL) -c true +NOECHO = @ +RM_F = rm -f +RM_RF = rm -rf +TEST_F = test -f +TOUCH = touch +UMASK_NULL = umask 0 +DEV_NULL = > /dev/null 2>&1 +MKPATH = $(ABSPERLRUN) "-MExtUtils::Command" -e mkpath +EQUALIZE_TIMESTAMP = $(ABSPERLRUN) "-MExtUtils::Command" -e eqtime +ECHO = echo +ECHO_N = echo -n +UNINST = 0 +VERBINST = 0 +MOD_INSTALL = $(ABSPERLRUN) -MExtUtils::Install -e 'install({@ARGV}, '\''$(VERBINST)'\'', 0, '\''$(UNINST)'\'');' -- +DOC_INSTALL = $(ABSPERLRUN) "-MExtUtils::Command::MM" -e perllocal_install +UNINSTALL = $(ABSPERLRUN) "-MExtUtils::Command::MM" -e uninstall +WARN_IF_OLD_PACKLIST = $(ABSPERLRUN) "-MExtUtils::Command::MM" -e warn_if_old_packlist +MACROSTART = +MACROEND = +USEMAKEFILE = -f +FIXIN = $(PERLRUN) "-MExtUtils::MY" -e "MY->fixin(shift)" + + +# --- MakeMaker makemakerdflt section: +makemakerdflt : all + $(NOECHO) $(NOOP) + + +# --- MakeMaker dist section: +TAR = tar +TARFLAGS = cvf +ZIP = zip +ZIPFLAGS = -r +COMPRESS = gzip --best +SUFFIX = .gz +SHAR = shar +PREOP = $(PERL) -I. "-MModule::Install::Admin" -e "dist_preop(q($(DISTVNAME)))" +POSTOP = $(NOECHO) $(NOOP) +TO_UNIX = $(NOECHO) $(NOOP) +CI = ci -u +RCS_LABEL = rcs -Nv$(VERSION_SYM): -q +DIST_CP = best +DIST_DEFAULT = tardist +DISTNAME = MooseX-AutoDoc +DISTVNAME = MooseX-AutoDoc-undef + + +# --- MakeMaker macro section: + + +# --- MakeMaker depend section: + + +# --- MakeMaker cflags section: + + +# --- MakeMaker const_loadlibs section: + + +# --- MakeMaker const_cccmd section: + + +# --- MakeMaker post_constants section: + + +# --- MakeMaker pasthru section: + +PASTHRU = LIBPERL_A="$(LIBPERL_A)"\ + LINKTYPE="$(LINKTYPE)"\ + PREFIX="$(PREFIX)" + + +# --- MakeMaker special_targets section: +.SUFFIXES : .xs .c .C .cpp .i .s .cxx .cc $(OBJ_EXT) + +.PHONY: all config static dynamic test linkext manifest blibdirs clean realclean disttest distdir + + + +# --- MakeMaker c_o section: + + +# --- MakeMaker xs_c section: + + +# --- MakeMaker xs_o section: + + +# --- MakeMaker top_targets section: +all :: pure_all manifypods + $(NOECHO) $(NOOP) + + +pure_all :: config pm_to_blib subdirs linkext + $(NOECHO) $(NOOP) + +subdirs :: $(MYEXTLIB) + $(NOECHO) $(NOOP) + +config :: $(FIRST_MAKEFILE) blibdirs + $(NOECHO) $(NOOP) + +help : + perldoc ExtUtils::MakeMaker + + +# --- MakeMaker blibdirs section: +blibdirs : $(INST_LIBDIR)$(DFSEP).exists $(INST_ARCHLIB)$(DFSEP).exists $(INST_AUTODIR)$(DFSEP).exists $(INST_ARCHAUTODIR)$(DFSEP).exists $(INST_BIN)$(DFSEP).exists $(INST_SCRIPT)$(DFSEP).exists $(INST_MAN1DIR)$(DFSEP).exists $(INST_MAN3DIR)$(DFSEP).exists + $(NOECHO) $(NOOP) + +# Backwards compat with 6.18 through 6.25 +blibdirs.ts : blibdirs + $(NOECHO) $(NOOP) + +$(INST_LIBDIR)$(DFSEP).exists :: Makefile.PL + $(NOECHO) $(MKPATH) $(INST_LIBDIR) + $(NOECHO) $(CHMOD) 755 $(INST_LIBDIR) + $(NOECHO) $(TOUCH) $(INST_LIBDIR)$(DFSEP).exists + +$(INST_ARCHLIB)$(DFSEP).exists :: Makefile.PL + $(NOECHO) $(MKPATH) $(INST_ARCHLIB) + $(NOECHO) $(CHMOD) 755 $(INST_ARCHLIB) + $(NOECHO) $(TOUCH) $(INST_ARCHLIB)$(DFSEP).exists + +$(INST_AUTODIR)$(DFSEP).exists :: Makefile.PL + $(NOECHO) $(MKPATH) $(INST_AUTODIR) + $(NOECHO) $(CHMOD) 755 $(INST_AUTODIR) + $(NOECHO) $(TOUCH) $(INST_AUTODIR)$(DFSEP).exists + +$(INST_ARCHAUTODIR)$(DFSEP).exists :: Makefile.PL + $(NOECHO) $(MKPATH) $(INST_ARCHAUTODIR) + $(NOECHO) $(CHMOD) 755 $(INST_ARCHAUTODIR) + $(NOECHO) $(TOUCH) $(INST_ARCHAUTODIR)$(DFSEP).exists + +$(INST_BIN)$(DFSEP).exists :: Makefile.PL + $(NOECHO) $(MKPATH) $(INST_BIN) + $(NOECHO) $(CHMOD) 755 $(INST_BIN) + $(NOECHO) $(TOUCH) $(INST_BIN)$(DFSEP).exists + +$(INST_SCRIPT)$(DFSEP).exists :: Makefile.PL + $(NOECHO) $(MKPATH) $(INST_SCRIPT) + $(NOECHO) $(CHMOD) 755 $(INST_SCRIPT) + $(NOECHO) $(TOUCH) $(INST_SCRIPT)$(DFSEP).exists + +$(INST_MAN1DIR)$(DFSEP).exists :: Makefile.PL + $(NOECHO) $(MKPATH) $(INST_MAN1DIR) + $(NOECHO) $(CHMOD) 755 $(INST_MAN1DIR) + $(NOECHO) $(TOUCH) $(INST_MAN1DIR)$(DFSEP).exists + +$(INST_MAN3DIR)$(DFSEP).exists :: Makefile.PL + $(NOECHO) $(MKPATH) $(INST_MAN3DIR) + $(NOECHO) $(CHMOD) 755 $(INST_MAN3DIR) + $(NOECHO) $(TOUCH) $(INST_MAN3DIR)$(DFSEP).exists + + + +# --- MakeMaker linkext section: + +linkext :: $(LINKTYPE) + $(NOECHO) $(NOOP) + + +# --- MakeMaker dlsyms section: + + +# --- MakeMaker dynamic section: + +dynamic :: $(FIRST_MAKEFILE) $(INST_DYNAMIC) $(INST_BOOT) + $(NOECHO) $(NOOP) + + +# --- MakeMaker dynamic_bs section: + +BOOTSTRAP = + + +# --- MakeMaker dynamic_lib section: + + +# --- MakeMaker static section: + +## $(INST_PM) has been moved to the all: target. +## It remains here for awhile to allow for old usage: "make static" +static :: $(FIRST_MAKEFILE) $(INST_STATIC) + $(NOECHO) $(NOOP) + + +# --- MakeMaker static_lib section: + + +# --- MakeMaker manifypods section: + +POD2MAN_EXE = $(PERLRUN) "-MExtUtils::Command::MM" -e pod2man "--" +POD2MAN = $(POD2MAN_EXE) + + +manifypods : pure_all \ + lib/MooseX/AutoDoc/View/TT.pm + $(NOECHO) $(POD2MAN) --section=3 --perm_rw=$(PERM_RW) \ + lib/MooseX/AutoDoc/View/TT.pm $(INST_MAN3DIR)/MooseX::AutoDoc::View::TT.$(MAN3EXT) + + + + +# --- MakeMaker processPL section: + + +# --- MakeMaker installbin section: + + +# --- MakeMaker subdirs section: + +# none + +# --- MakeMaker clean_subdirs section: +clean_subdirs : + $(NOECHO) $(NOOP) + + +# --- MakeMaker clean section: + +# Delete temporary files but do not touch installed files. We don't delete +# the Makefile here so a later make realclean still has a makefile to use. + +clean :: clean_subdirs + - $(RM_F) \ + *$(LIB_EXT) core \ + core.[0-9] $(INST_ARCHAUTODIR)/extralibs.all \ + core.[0-9][0-9] $(BASEEXT).bso \ + pm_to_blib.ts core.[0-9][0-9][0-9][0-9] \ + $(BASEEXT).x $(BOOTSTRAP) \ + perl$(EXE_EXT) tmon.out \ + *$(OBJ_EXT) pm_to_blib \ + $(INST_ARCHAUTODIR)/extralibs.ld blibdirs.ts \ + core.[0-9][0-9][0-9][0-9][0-9] *perl.core \ + core.*perl.*.? $(MAKE_APERL_FILE) \ + perl $(BASEEXT).def \ + core.[0-9][0-9][0-9] mon.out \ + lib$(BASEEXT).def perlmain.c \ + perl.exe so_locations \ + $(BASEEXT).exp + - $(RM_RF) \ + blib + - $(MV) $(FIRST_MAKEFILE) $(MAKEFILE_OLD) $(DEV_NULL) + + +# --- MakeMaker realclean_subdirs section: +realclean_subdirs : + $(NOECHO) $(NOOP) + + +# --- MakeMaker realclean section: +# Delete temporary files (via clean) and also delete dist files +realclean purge :: clean realclean_subdirs + - $(RM_F) \ + $(MAKEFILE_OLD) $(FIRST_MAKEFILE) + - $(RM_RF) \ + $(DISTVNAME) + + +# --- MakeMaker metafile section: +metafile : + $(NOECHO) $(NOOP) + + +# --- MakeMaker signature section: +signature : + cpansign -s + + +# --- MakeMaker dist_basics section: +distclean :: realclean distcheck + $(NOECHO) $(NOOP) + +distcheck : + $(PERLRUN) "-MExtUtils::Manifest=fullcheck" -e fullcheck + +skipcheck : + $(PERLRUN) "-MExtUtils::Manifest=skipcheck" -e skipcheck + +manifest : + $(PERLRUN) "-MExtUtils::Manifest=mkmanifest" -e mkmanifest + +veryclean : realclean + $(RM_F) *~ */*~ *.orig */*.orig *.bak */*.bak *.old */*.old + + + +# --- MakeMaker dist_core section: + +dist : $(DIST_DEFAULT) $(FIRST_MAKEFILE) + $(NOECHO) $(ABSPERLRUN) -l -e 'print '\''Warning: Makefile possibly out of date with $(VERSION_FROM)'\''' \ + -e ' if -e '\''$(VERSION_FROM)'\'' and -M '\''$(VERSION_FROM)'\'' < -M '\''$(FIRST_MAKEFILE)'\'';' -- + +tardist : $(DISTVNAME).tar$(SUFFIX) + $(NOECHO) $(NOOP) + +uutardist : $(DISTVNAME).tar$(SUFFIX) + uuencode $(DISTVNAME).tar$(SUFFIX) $(DISTVNAME).tar$(SUFFIX) > $(DISTVNAME).tar$(SUFFIX)_uu + +$(DISTVNAME).tar$(SUFFIX) : distdir + $(PREOP) + $(TO_UNIX) + $(TAR) $(TARFLAGS) $(DISTVNAME).tar $(DISTVNAME) + $(RM_RF) $(DISTVNAME) + $(COMPRESS) $(DISTVNAME).tar + $(POSTOP) + +zipdist : $(DISTVNAME).zip + $(NOECHO) $(NOOP) + +$(DISTVNAME).zip : distdir + $(PREOP) + $(ZIP) $(ZIPFLAGS) $(DISTVNAME).zip $(DISTVNAME) + $(RM_RF) $(DISTVNAME) + $(POSTOP) + +shdist : distdir + $(PREOP) + $(SHAR) $(DISTVNAME) > $(DISTVNAME).shar + $(RM_RF) $(DISTVNAME) + $(POSTOP) + + +# --- MakeMaker distdir section: +create_distdir : + $(RM_RF) $(DISTVNAME) + $(PERLRUN) "-MExtUtils::Manifest=manicopy,maniread" \ + -e "manicopy(maniread(),'$(DISTVNAME)', '$(DIST_CP)');" + +distdir : create_distdir + $(NOECHO) $(NOOP) + + + +# --- MakeMaker dist_test section: +disttest : distdir + cd $(DISTVNAME) && $(ABSPERLRUN) Makefile.PL + cd $(DISTVNAME) && $(MAKE) $(PASTHRU) + cd $(DISTVNAME) && $(MAKE) test $(PASTHRU) + + + +# --- MakeMaker dist_ci section: + +ci : + $(PERLRUN) "-MExtUtils::Manifest=maniread" \ + -e "@all = keys %{ maniread() };" \ + -e "print(qq{Executing $(CI) @all\n}); system(qq{$(CI) @all});" \ + -e "print(qq{Executing $(RCS_LABEL) ...\n}); system(qq{$(RCS_LABEL) @all});" + + +# --- MakeMaker distmeta section: +distmeta : create_distdir metafile + $(NOECHO) cd $(DISTVNAME) && $(ABSPERLRUN) -MExtUtils::Manifest=maniadd -e 'eval { maniadd({q{META.yml} => q{Module meta-data (added by MakeMaker)}}) } ' \ + -e ' or print "Could not add META.yml to MANIFEST: $${'\''@'\''}\n"' -- + + + +# --- MakeMaker distsignature section: +distsignature : create_distdir + $(NOECHO) cd $(DISTVNAME) && $(ABSPERLRUN) -MExtUtils::Manifest=maniadd -e 'eval { maniadd({q{SIGNATURE} => q{Public-key signature (added by MakeMaker)}}) } ' \ + -e ' or print "Could not add SIGNATURE to MANIFEST: $${'\''@'\''}\n"' -- + $(NOECHO) cd $(DISTVNAME) && $(TOUCH) SIGNATURE + cd $(DISTVNAME) && cpansign -s + + + +# --- MakeMaker install section: + +install :: all pure_install doc_install + $(NOECHO) $(NOOP) + +install_perl :: all pure_perl_install doc_perl_install + $(NOECHO) $(NOOP) + +install_site :: all pure_site_install doc_site_install + $(NOECHO) $(NOOP) + +install_vendor :: all pure_vendor_install doc_vendor_install + $(NOECHO) $(NOOP) + +pure_install :: pure_$(INSTALLDIRS)_install + $(NOECHO) $(NOOP) + +doc_install :: doc_$(INSTALLDIRS)_install + $(NOECHO) $(NOOP) + +pure__install : pure_site_install + $(NOECHO) $(ECHO) INSTALLDIRS not defined, defaulting to INSTALLDIRS=site + +doc__install : doc_site_install + $(NOECHO) $(ECHO) INSTALLDIRS not defined, defaulting to INSTALLDIRS=site + +pure_perl_install :: + $(NOECHO) $(MOD_INSTALL) \ + read $(PERL_ARCHLIB)/auto/$(FULLEXT)/.packlist \ + write $(DESTINSTALLARCHLIB)/auto/$(FULLEXT)/.packlist \ + $(INST_LIB) $(DESTINSTALLPRIVLIB) \ + $(INST_ARCHLIB) $(DESTINSTALLARCHLIB) \ + $(INST_BIN) $(DESTINSTALLBIN) \ + $(INST_SCRIPT) $(DESTINSTALLSCRIPT) \ + $(INST_MAN1DIR) $(DESTINSTALLMAN1DIR) \ + $(INST_MAN3DIR) $(DESTINSTALLMAN3DIR) + $(NOECHO) $(WARN_IF_OLD_PACKLIST) \ + $(SITEARCHEXP)/auto/$(FULLEXT) + + +pure_site_install :: + $(NOECHO) $(MOD_INSTALL) \ + read $(SITEARCHEXP)/auto/$(FULLEXT)/.packlist \ + write $(DESTINSTALLSITEARCH)/auto/$(FULLEXT)/.packlist \ + $(INST_LIB) $(DESTINSTALLSITELIB) \ + $(INST_ARCHLIB) $(DESTINSTALLSITEARCH) \ + $(INST_BIN) $(DESTINSTALLSITEBIN) \ + $(INST_SCRIPT) $(DESTINSTALLSITESCRIPT) \ + $(INST_MAN1DIR) $(DESTINSTALLSITEMAN1DIR) \ + $(INST_MAN3DIR) $(DESTINSTALLSITEMAN3DIR) + $(NOECHO) $(WARN_IF_OLD_PACKLIST) \ + $(PERL_ARCHLIB)/auto/$(FULLEXT) + +pure_vendor_install :: + $(NOECHO) $(MOD_INSTALL) \ + read $(VENDORARCHEXP)/auto/$(FULLEXT)/.packlist \ + write $(DESTINSTALLVENDORARCH)/auto/$(FULLEXT)/.packlist \ + $(INST_LIB) $(DESTINSTALLVENDORLIB) \ + $(INST_ARCHLIB) $(DESTINSTALLVENDORARCH) \ + $(INST_BIN) $(DESTINSTALLVENDORBIN) \ + $(INST_SCRIPT) $(DESTINSTALLVENDORSCRIPT) \ + $(INST_MAN1DIR) $(DESTINSTALLVENDORMAN1DIR) \ + $(INST_MAN3DIR) $(DESTINSTALLVENDORMAN3DIR) + +doc_perl_install :: + $(NOECHO) $(ECHO) Appending installation info to $(DESTINSTALLARCHLIB)/perllocal.pod + -$(NOECHO) $(MKPATH) $(DESTINSTALLARCHLIB) + -$(NOECHO) $(DOC_INSTALL) \ + "Module" "$(NAME)" \ + "installed into" "$(INSTALLPRIVLIB)" \ + LINKTYPE "$(LINKTYPE)" \ + VERSION "$(VERSION)" \ + EXE_FILES "$(EXE_FILES)" \ + >> $(DESTINSTALLARCHLIB)/perllocal.pod + +doc_site_install :: + $(NOECHO) $(ECHO) Appending installation info to $(DESTINSTALLARCHLIB)/perllocal.pod + -$(NOECHO) $(MKPATH) $(DESTINSTALLARCHLIB) + -$(NOECHO) $(DOC_INSTALL) \ + "Module" "$(NAME)" \ + "installed into" "$(INSTALLSITELIB)" \ + LINKTYPE "$(LINKTYPE)" \ + VERSION "$(VERSION)" \ + EXE_FILES "$(EXE_FILES)" \ + >> $(DESTINSTALLARCHLIB)/perllocal.pod + +doc_vendor_install :: + $(NOECHO) $(ECHO) Appending installation info to $(DESTINSTALLARCHLIB)/perllocal.pod + -$(NOECHO) $(MKPATH) $(DESTINSTALLARCHLIB) + -$(NOECHO) $(DOC_INSTALL) \ + "Module" "$(NAME)" \ + "installed into" "$(INSTALLVENDORLIB)" \ + LINKTYPE "$(LINKTYPE)" \ + VERSION "$(VERSION)" \ + EXE_FILES "$(EXE_FILES)" \ + >> $(DESTINSTALLARCHLIB)/perllocal.pod + + +uninstall :: uninstall_from_$(INSTALLDIRS)dirs + $(NOECHO) $(NOOP) + +uninstall_from_perldirs :: + $(NOECHO) $(UNINSTALL) $(PERL_ARCHLIB)/auto/$(FULLEXT)/.packlist + +uninstall_from_sitedirs :: + $(NOECHO) $(UNINSTALL) $(SITEARCHEXP)/auto/$(FULLEXT)/.packlist + +uninstall_from_vendordirs :: + $(NOECHO) $(UNINSTALL) $(VENDORARCHEXP)/auto/$(FULLEXT)/.packlist + + +# --- MakeMaker force section: +# Phony target to force checking subdirectories. +FORCE : + $(NOECHO) $(NOOP) + + +# --- MakeMaker perldepend section: + + +# --- MakeMaker makefile section: +# We take a very conservative approach here, but it's worth it. +# We move Makefile to Makefile.old here to avoid gnu make looping. +$(FIRST_MAKEFILE) : Makefile.PL $(CONFIGDEP) + $(NOECHO) $(ECHO) "Makefile out-of-date with respect to $?" + $(NOECHO) $(ECHO) "Cleaning current config before rebuilding Makefile..." + -$(NOECHO) $(RM_F) $(MAKEFILE_OLD) + -$(NOECHO) $(MV) $(FIRST_MAKEFILE) $(MAKEFILE_OLD) + - $(MAKE) $(USEMAKEFILE) $(MAKEFILE_OLD) clean $(DEV_NULL) + $(PERLRUN) Makefile.PL + $(NOECHO) $(ECHO) "==> Your Makefile has been rebuilt. <==" + $(NOECHO) $(ECHO) "==> Please rerun the $(MAKE) command. <==" + false + + + +# --- MakeMaker staticmake section: + +# --- MakeMaker makeaperl section --- +MAP_TARGET = perl +FULLPERL = /usr/bin/perl + +$(MAP_TARGET) :: static $(MAKE_APERL_FILE) + $(MAKE) $(USEMAKEFILE) $(MAKE_APERL_FILE) $@ + +$(MAKE_APERL_FILE) : $(FIRST_MAKEFILE) pm_to_blib + $(NOECHO) $(ECHO) Writing \"$(MAKE_APERL_FILE)\" for this $(MAP_TARGET) + $(NOECHO) $(PERLRUNINST) \ + Makefile.PL DIR= \ + MAKEFILE=$(MAKE_APERL_FILE) LINKTYPE=static \ + MAKEAPERL=1 NORECURS=1 CCCDLFLAGS= + + +# --- MakeMaker test section: + +TEST_VERBOSE=0 +TEST_TYPE=test_$(LINKTYPE) +TEST_FILE = test.pl +TEST_FILES = t/000-load.t t/001-basic.t t/002-attributes.t t/003-moosex-types.t t/100-class.t t/101-class.t t/102-class.t t/103-class.t t/104-class.t t/105-class.t t/200-role.t t/201-role.t t/202-role.t +TESTDB_SW = -d + +testdb :: testdb_$(LINKTYPE) + +test :: $(TEST_TYPE) subdirs-test + +subdirs-test :: + $(NOECHO) $(NOOP) + + +test_dynamic :: pure_all + PERL_DL_NONLAZY=1 $(FULLPERLRUN) "-MExtUtils::Command::MM" "-e" "test_harness($(TEST_VERBOSE), 'inc', '$(INST_LIB)', '$(INST_ARCHLIB)')" $(TEST_FILES) + +testdb_dynamic :: pure_all + PERL_DL_NONLAZY=1 $(FULLPERLRUN) $(TESTDB_SW) "-Iinc" "-I$(INST_LIB)" "-I$(INST_ARCHLIB)" $(TEST_FILE) + +test_ : test_dynamic + +test_static :: test_dynamic +testdb_static :: testdb_dynamic + + +# --- MakeMaker ppd section: +# Creates a PPD (Perl Package Description) for a binary distribution. +ppd : + $(NOECHO) $(ECHO) '' > $(DISTNAME).ppd + $(NOECHO) $(ECHO) ' $(DISTNAME)' >> $(DISTNAME).ppd + $(NOECHO) $(ECHO) ' Automatically generate documentation stubs for Moose-based classes.' >> $(DISTNAME).ppd + $(NOECHO) $(ECHO) ' ' >> $(DISTNAME).ppd + $(NOECHO) $(ECHO) ' ' >> $(DISTNAME).ppd + $(NOECHO) $(ECHO) ' ' >> $(DISTNAME).ppd + $(NOECHO) $(ECHO) ' ' >> $(DISTNAME).ppd + $(NOECHO) $(ECHO) ' ' >> $(DISTNAME).ppd + $(NOECHO) $(ECHO) ' ' >> $(DISTNAME).ppd + $(NOECHO) $(ECHO) ' ' >> $(DISTNAME).ppd + $(NOECHO) $(ECHO) ' ' >> $(DISTNAME).ppd + $(NOECHO) $(ECHO) ' ' >> $(DISTNAME).ppd + $(NOECHO) $(ECHO) '' >> $(DISTNAME).ppd + + +# --- MakeMaker pm_to_blib section: + +pm_to_blib : $(TO_INST_PM) + $(NOECHO) $(ABSPERLRUN) -MExtUtils::Install -e 'pm_to_blib({@ARGV}, '\''$(INST_LIB)/auto'\'', '\''$(PM_FILTER)'\'')' -- \ + lib/MooseX/AutoDoc/View/TT.pm blib/lib/MooseX/AutoDoc/View/TT.pm \ + lib/MooseX/AutoDoc/View.pm blib/lib/MooseX/AutoDoc/View.pm \ + lib/MooseX/AutoDoc.pm blib/lib/MooseX/AutoDoc.pm + $(NOECHO) $(TOUCH) pm_to_blib + + +# --- MakeMaker selfdocument section: + + +# --- MakeMaker postamble section: + + +# End. +# Postamble by Module::Install 0.68 +# --- Module::Install::Admin::Makefile section: + +realclean purge :: + $(RM_F) $(DISTVNAME).tar$(SUFFIX) + $(RM_RF) inc MANIFEST.bak _build + $(PERL) -I. "-MModule::Install::Admin" -e "remove_meta()" + +reset :: purge + +upload :: test dist + cpan-upload -verbose $(DISTVNAME).tar$(SUFFIX) + +grok :: + perldoc Module::Install + +distsign :: + cpansign -s + +# --- Module::Install::AutoInstall section: + +config :: installdeps + $(NOECHO) $(NOOP) + +checkdeps :: + $(PERL) Makefile.PL --checkdeps + +installdeps :: + $(NOECHO) $(NOOP) + diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..eb0bd3c --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,18 @@ +#! /usr/bin/perl -w + +# Load the Module::Install bundled in ./inc/ +use inc::Module::Install; + +# Define metadata +name 'MooseX-AutoDoc'; +abstract 'Automatically generate documentation stubs for Moose-based classes.'; +all_from 'lib/MooseX/AutoDoc.pm'; + +# Specific dependencies +requires 'Moose' => '0.36'; +requires 'Template'; #version TBD + +build_requires 'Test::More' => 0; + +auto_install; +WriteAll; diff --git a/README b/README new file mode 100644 index 0000000..427ef54 --- /dev/null +++ b/README @@ -0,0 +1,4 @@ +perl Makefile.PL +make test +sudo make install +make clean \ No newline at end of file diff --git a/blib/arch/.exists b/blib/arch/.exists new file mode 100644 index 0000000..e69de29 diff --git a/blib/arch/auto/MooseX/AutoDoc/.exists b/blib/arch/auto/MooseX/AutoDoc/.exists new file mode 100644 index 0000000..e69de29 diff --git a/blib/bin/.exists b/blib/bin/.exists new file mode 100644 index 0000000..e69de29 diff --git a/blib/lib/MooseX/.exists b/blib/lib/MooseX/.exists new file mode 100644 index 0000000..e69de29 diff --git a/blib/lib/MooseX/AutoDoc.pm b/blib/lib/MooseX/AutoDoc.pm new file mode 100644 index 0000000..c2b3e1d --- /dev/null +++ b/blib/lib/MooseX/AutoDoc.pm @@ -0,0 +1,318 @@ +package MooseX::AutoDoc; + +use Moose; +use Carp; +use Class::MOP; +use Moose::Meta::Role; +use Moose::Meta::Class; +use Scalar::Util qw/blessed/; + +# Create a special TypeConstraint for the View so you can just set it +# with a class name and it'll DWIM +{ + use Moose::Util::TypeConstraints; + + subtype 'AutoDocView' + => as 'Object' + => where { $_->isa('MooseX::AutoDoc::View') } + => message { "Value should be a subclass of MooseX::AutoDoc::View" } ; + + coerce 'AutoDocView' + => from 'Str' + => via { Class::MOP::load_class($_); $_->new }; + + no Moose::Util::TypeConstraints; +} + +#view object +has view => (is => 'rw', isa => 'AutoDocView', coerce => 1, lazy_build => 1); + +#type constraint library to name mapping to make nice links +has tc_to_lib_map => (is => 'rw', isa => 'HashRef', lazy_build => 1); + +#method metaclasses to ignore to avoid documenting some methods +has ignored_method_metaclasses => (is => 'rw', isa => 'HashRef', lazy_build => 1); + +#defaults to artistic... +has license_text => (is => 'rw', isa => 'Str', lazy_build => 1); + +#how can i get the data about the current user? +has authors => (is => 'rw', isa => 'ArrayRef[HashRef]', + predicate => 'has_authors'); + +sub _build_view { "MooseX::AutoDoc::View::TT" } + +sub _build_tc_to_lib_map { + my %types = map {$_ => 'Moose::Util::TypeConstraints'} + qw/Any Item Bool Undef Defined Value Num Int Str Role Maybe ClassName Ref + ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef FileHandle Object/; + return \ %types; +} + +sub _build_ignored_method_metaclasses { + return { + 'Moose::Meta::Role::Method' => 1, + 'Moose::Meta::Method::Accessor' => 1, + 'Moose::Meta::Method::Constructor' => 1, + 'Class::MOP::Method::Accessor' => 1, + 'Class::MOP::Method::Generated' => 1, + 'Class::MOP::Method::Constructor' => 1, + }; + +# 'Moose::Meta::Method::Overridden' => 1, +# 'Class::MOP::Method::Wrapped' => 1, +} + +sub _build_license_text { + "This library is free software; you can redistribute it and/or modify it " + ."under the same terms as Perl itself."; +} + +#make the actual POD +sub generate_pod_for_role { + my ($self, $role, $view_args) = @_; + + carp("${role} is already loaded. This will cause inacurate output.". + "if ${role} is the consumer of any roles.") + if Class::MOP::is_class_loaded( $role ); + + my $spec = $self->role_info($role); + my $vars = { + role => $spec, + license => $self->license_text, + authors => $self->has_authors ? $self->authors : [], + }; + return $self->view->render_role($vars, $view_args); +} + +#make the actual POD +sub generate_pod_for_class { + my ($self, $class, $view_args) = @_; + + carp("${class} is already loaded. This will cause inacurate output.". + "if ${class} is the consumer of any roles.") + if Class::MOP::is_class_loaded( $class ); + + my $spec = $self->class_info($class); + my $vars = { + class => $spec, + license => $self->license_text, + authors => $self->has_authors ? $self->authors : [], + }; + + return $self->view->render_class($vars, $view_args); +} + + +# *_info methods +sub role_info { + my ($self, $role) = @_; + + my (@roles_to_apply, $rmeta, $original_apply); + { #intercept role application so we can accurately generate + #method and attribute information for the parent class. + #this is fragile, but there is not better way that i am aware of + + $rmeta = Moose::Meta::Role->meta; + $rmeta->make_mutable if $rmeta->is_immutable; + $original_apply = $rmeta->get_method("apply")->body; + $rmeta->remove_method("apply"); + $rmeta->add_method("apply", sub{push(@roles_to_apply, [@_])}); + + eval { Class::MOP::load_class($role); }; + confess "Failed to load class ${role} $@" if $@; + } + + my $meta = $role->meta; + my $anon = Moose::Meta::Class->create_anon_class; + $original_apply->($meta, $anon); + + my @attributes = map{ $anon->get_attribute($_) } sort $anon->get_attribute_list; + + my %ignored_method_metaclasses = %{ $self->ignored_method_metaclasses }; + delete $ignored_method_metaclasses{'Moose::Meta::Role::Method'}; + my @methods = + grep{ ! exists $ignored_method_metaclasses{$_->meta->name} } + map { $anon->get_method($_) } + grep { $_ ne 'meta' } #it wasnt getting filtered on the anon class.. + sort $anon->get_method_list; + my @method_specs = map{ $self->method_info($_) } @methods; + my @attribute_specs = map{ $self->attribute_info($_) } @attributes; + + { #fix Moose::Meta::Role and apply the roles that were delayed + $rmeta->remove_method("apply"); + $rmeta->add_method("apply", $original_apply); + $rmeta->make_immutable; + shift(@$_)->apply(@$_) for @roles_to_apply; + } + + my @roles = + sort{ $a->name cmp $b->name } + map { $_->isa("Moose::Meta::Role::Composite") ? @{$_->get_roles} : $_ } + @{ $meta->get_roles }; + + my @role_specs = map{ $self->consumed_role_info($_) } @roles; + + my $spec = { + name => $meta->name, + roles => \ @role_specs, + methods => \ @method_specs, + attributes => \ @attribute_specs, + }; + + return $spec; +} + + +sub class_info { + my ($self, $class) = @_; + + my (@roles_to_apply, $rmeta, $original_apply); + { #intercept role application so we can accurately generate + #method and attribute information for the parent class. + #this is fragile, but there is not better way that i am aware of + + $rmeta = Moose::Meta::Role->meta; + $rmeta->make_mutable if $rmeta->is_immutable; + $original_apply = $rmeta->get_method("apply")->body; + $rmeta->remove_method("apply"); + $rmeta->add_method("apply", sub{push(@roles_to_apply, [@_])}); + + eval { Class::MOP::load_class($class); }; + confess "Failed to load class ${class} $@" if $@; + } + + my $meta = $class->meta; + + my @attributes = map{ $meta->get_attribute($_) } sort $meta->get_attribute_list; + my @superclasses = map{ $_->meta } + grep { $_ ne 'Moose::Object' } $meta->superclasses; + + my @methods = + grep{ ! exists $self->ignored_method_metaclasses->{$_->meta->name} } + map { $meta->get_method($_) } + grep { $_ ne 'meta' } #it wasnt getting filtered on the anon class.. + sort $meta->get_method_list; + + my @method_specs = map{ $self->method_info($_) } @methods; + my @attribute_specs = map{ $self->attribute_info($_) } @attributes; + my @superclass_specs = map{ $self->superclass_info($_) } @superclasses; + + { #fix Moose::Meta::Role and apply the roles that were delayed + $rmeta->remove_method("apply"); + $rmeta->add_method("apply", $original_apply); + $rmeta->make_immutable; + shift(@$_)->apply(@$_) for @roles_to_apply; + } + + my @roles = sort{ $a->name cmp $b->name } + map { $_->isa("Moose::Meta::Role::Composite") ? @{$_->get_roles} : $_ } + @{ $meta->roles }; + my @role_specs = map{ $self->consumed_role_info($_) } @roles; + + my $spec = { + name => $meta->name, + roles => \ @role_specs, + methods => \ @method_specs, + attributes => \ @attribute_specs, + superclasses => \ @superclass_specs, + }; + + return $spec; +} + +sub attribute_info{ + my($self, $attr) = @_;; + my $attr_name = $attr->name; + my $spec = { name => $attr_name }; + my $info = $spec->{info} = {}; + + $info->{clearer} = $attr->clearer if $attr->has_clearer; + $info->{builder} = $attr->builder if $attr->has_builder; + $info->{predicate} = $attr->predicate if $attr->has_predicate; + + + my $description = $attr->is_required ? 'Required ' : 'Optional '; + if( defined(my $is = $attr->_is_metadata) ){ + $description .= 'read-only ' if $is eq 'ro'; + $description .= 'read-write ' if $is eq 'rw'; + + #If we have 'is' info only write out this info if it != attr_name + $info->{writer} = $attr->writer + if $attr->has_writer && $attr->writer ne $attr_name; + $info->{reader} = $attr->reader + if $attr->has_reader && $attr->reader ne $attr_name; + $info->{accessor} = $attr->accessor + if $attr->has_accessor && $attr->accessor ne $attr_name; + } else { + $info->{writer} = $attr->writer if $attr->has_writer; + $info->{reader} = $attr->reader if $attr->has_reader; + $info->{accessor} = $attr->accessor if $attr->has_accessor; + } + + if( defined(my $lazy = $attr->is_lazy) ){ + $description .= 'lazy-building '; + } + $description .= 'value'; + if( defined(my $isa = $attr->_isa_metadata) ){ + my $link_to; + if( blessed $isa ){ + my $from_type_lib; + while( blessed $isa ){ + $isa = $isa->name; + } + my @parts = split '::', $isa; + my $type_name = pop @parts; + my $type_lib = join "::", @parts; + if(eval{$type_lib->isa("MooseX::Types::Base")}){ + $link_to = $type_lib; + $isa = $type_name; + } + } else { + my ($isa_base) = ($isa =~ /^(.*?)(?:\[.*\])?$/); + if (exists $self->tc_to_lib_map->{$isa_base}){ + $link_to = $self->tc_to_lib_map->{$isa_base}; + } + my $isa = $isa_base; + } + if(defined $link_to){ + $isa = "L<${isa}|${link_to}>"; + } + $description .= " of type ${isa}"; + } + if( $attr->should_auto_deref){ + $description .=" that will be automatically dereferenced by ". + "the reader / accessor"; + } + if( $attr->has_documentation ){ + $description .= "\n\n" . $attr->documentation; + } + $spec->{description} = $description; + + return $spec; +} + +sub superclass_info { + my($self, $superclass) = @_; + my $spec = { name => $superclass->name }; + return $spec; +} + +sub method_info { + my($self, $method) = @_; + my $spec = { name => $method->name }; + return $spec; +} + +sub consumed_role_info { + my($self, $role) = @_;; + my $spec = { name => $role->name }; + return $spec; +} + +1; + +__END__; + + + diff --git a/blib/lib/MooseX/AutoDoc/View.pm b/blib/lib/MooseX/AutoDoc/View.pm new file mode 100644 index 0000000..4c36ebf --- /dev/null +++ b/blib/lib/MooseX/AutoDoc/View.pm @@ -0,0 +1,11 @@ +package MooseX::AutoDoc::View; + +use Moose; + +has args => (is => 'ro', predicate => 'has_args'); + +#twi different methods because it really does make more sense this way +sub render_role { confess "Unimplemented Method"; } +sub render_class { confess "Unimplemented Method"; } + +1; diff --git a/blib/lib/MooseX/AutoDoc/View/TT.pm b/blib/lib/MooseX/AutoDoc/View/TT.pm new file mode 100644 index 0000000..aa46923 --- /dev/null +++ b/blib/lib/MooseX/AutoDoc/View/TT.pm @@ -0,0 +1,351 @@ +package MooseX::AutoDoc::View::TT; + +use Moose; +use Scalar::Util qw/blessed/; +use Template; + +extends 'MooseX::AutoDoc::View'; + +has _tt => (is => 'ro', isa => 'Template', lazy_build => 1); +has '+args' => (isa => 'HashRef'); + +sub _build__tt { + my $self = shift; + Template->new($self->has_args ? $self->args : {}) + || confess $Template::ERROR; +} + +has role_template => (is => 'rw', isa => 'Str', lazy_build => 1); +has class_template => (is => 'rw', isa => 'Str', lazy_build => 1); + +has role_template_blocks => (is => 'rw', isa => 'HashRef', lazy_build => 1); +has class_template_blocks => (is => 'rw', isa => 'HashRef', lazy_build => 1); + +sub _build_role_template { "[% USE wrap; PROCESS role_block; %]" } +sub _build_class_template { "[% USE wrap; PROCESS class_block; %]" } + +sub render_role { + my ($self, $vars, $options) = @_; + my $tt = $self->_tt; + my $output; + my $template = $self->role_template. " ".$self->_role_blocks; + $tt->process(\ $template, $vars, \ $output, %{ $options || {}}) + || confess $tt->error; + return $output; +} + +sub render_class { + my ($self, $vars, $options) = @_; + my $tt = $self->_tt; + my $output; + my $template = $self->class_template. " ".$self->_class_blocks; + $tt->process(\ $template, $vars, \ $output, %{ $options || {}}) + || confess $tt->error; + return $output; +} + + +sub _class_blocks { + my $self= shift; + my $blocks = $self->class_template_blocks; + return join "", + map { " [%- BLOCK ${_} %] ".$blocks->{$_}." [% END; -%] "} + keys %$blocks; +} + +sub _role_blocks { + my $self= shift; + my $blocks = $self->role_template_blocks; + return join "", + map { " [%- BLOCK ${_} %] ".$blocks->{$_}." [% END; -%] "} + keys %$blocks; +} + +1; + +sub _build_class_template_blocks{ + my $blocks = {}; + $blocks->{name_block} = q^ +=head1 NAME + +[% class.name %] +^; + + $blocks->{synopsys_block} = q^ +=head1 SYNOPSYS + + use [% class.name %]; + #TODO + [% class.name %]->new(); +^; + + $blocks->{description_block} = q^ +=head1 DESCRIPTION + +[%- IF class.superclasses.size == 1 %] +[% 'This class is a subclass of L<' _ class.superclasses.first.name _'>' _ +' and inherits all it\'s methods and attributes.' FILTER wrap(80,'','') %] + +[%- ELSIF class.superclasses.size > 1 %] +This class is a subclass of the following classes and inherits all their +methods and attributes; + +=over 4 +[%- FOREACH superclass = class.superclasses %] + +=item L<[% superclass.name %]> +[%- END %] + +=back + +[%- END -%] +^; + + $blocks->{roles_consumed_block} = q^ +[%- IF class.roles.size %] +=head1 ROLES CONSUMED + +The following roles are consumed by this class. Unless otherwise indicated, all +methods, modifiers and attributes present in those roles are applied to this +class. + +=over 4 +[% FOREACH role_consumed = class.roles; + PROCESS role_consumed_block; + END %] +=back +[% END -%] +^; + + $blocks->{role_consumed_block} = q^ +=item L<[% role_consumed.name %]> +^; + + $blocks->{attributes_block} = q^ +[%- IF class.attributes.size %] +=head1 ATTRIBUTES + +Unless noted otherwise, you may set any of these attributes at C time by +passing key / value pairs to C where the key is the name of the attribute +you wish to set. Unless noted otherwise accessor methods for attributes also +share the same name as the attribute. +[% + FOREACH attribute = class.attributes; + PROCESS attribute_block; + END; +END; +-%] +^; + + $blocks->{attribute_block} = q^ +=head2 [% attribute.name %] +[%- IF attribute.info.size %] + +=over 4 +[% FOREACH pair IN attribute.info.pairs %] +=item B<[% pair.key %]> - [% pair.value %] +[% END %] +=back +[%- END; %] + +[% attribute.description FILTER wrap(80, '',''); %] +^; + + $blocks->{methods_block} = q^ +=head1 METHODS + +=head2 new $key => $value + +Instantiate a new object. Please refer to L for a list of valid +key options. +[% + FOREACH method = class.methods; + PROCESS method_block; + END; +%] +=head2 meta + +Retrieve the metaclass instance. Please see L and +L for more information. +^; + + $blocks->{method_block} = q^ +=head2 [% method.name %] + +Description of [% method.name %] +^; + + $blocks->{authors_block} = q^ +=head1 AUTHORS +[% + FOREACH author = authors; + PROCESS author_block; + END; +-%] +^; + + $blocks->{author_block} = q^ +[% +IF author.name.length; author.name _ ' '; END; +IF author.handle.length; '(' _ author.name _ ') '; END; +IF author.email.length; '<' _ author.email _ '>'; END; +%] +^; + + $blocks->{license_block} = q^ +=head1 COPYRIGHT AND LICENSE + +[% license FILTER wrap(80, '', '') %] +^; + + $blocks->{class_block} = q^ +[% +PROCESS name_block; +PROCESS synopsys_block; +PROCESS description_block; +PROCESS roles_consumed_block; +PROCESS attributes_block; +PROCESS methods_block; +PROCESS authors_block; +PROCESS license_block; +%] +=cut +^; + + return $blocks; +} + +sub _build_role_template_blocks{ + my $blocks = {}; + + $blocks->{name_block} = q^ +=head1 NAME + +[% role.name %] +^; + + $blocks->{synopsys_block} = q^ +=head1 SYNOPSYS + + use Moose; + with '[% role.name %]'; +^; + + $blocks->{description_block} = q^ +=head1 DESCRIPTION + +When consumed, this role will apply to the consuming class all the methods, +method modifiers, and attributes it is composed of. +^; + + $blocks->{roles_consumed_block} = q^ +[%- IF role.roles.size %] +=head1 ROLES CONSUMED + +The following roles are consumed by this role. Unless otherwise indicated, all +methods, modifiers and attributes present in those roles will also be applied +to any class or role consuming this role. + +=over 4 +[% FOREACH role_consumed = role.roles; + PROCESS role_consumed_block; + END %] +=back +[% END -%] +^; + + $blocks->{role_consumed_block} = q^ +=item L<[% role_consumed.name %]> +^; + + $blocks->{attributes_block} = q^ +[%- IF role.attributes.size %] +=head1 ATTRIBUTES + +Unless noted otherwise, you may set any of these attributes on consuming +classes at C time by passing key / value pairs to C where the key +is the name of the attribute you wish to set. Unless noted otherwise accessor +methods for attributes also share the same name as the attribute. +[% + FOREACH attribute = role.attributes; + PROCESS attribute_block; + END; +END; +-%] +^; + + $blocks->{attribute_block} = q^ +=head2 [% attribute.name %] +[%- IF attribute.info.size %] + +=over 4 +[% FOREACH pair IN attribute.info.pairs %] +=item B<[% pair.key %]> - [% pair.value %] +[% END %] +=back +[%- END; %] + +[% attribute.description FILTER wrap(80, '',''); %] +^; + + $blocks->{methods_block} = q^ +=head1 METHODS +[% + FOREACH method = role.methods; + PROCESS method_block; + END; +%] +=head2 meta + +Retrieve the role metaclass instance. Please see L; +^; + + $blocks->{method_block} = q^ +=head2 [% method.name %] + +Description of [% method.name %] +^; + + $blocks->{authors_block} = q^ +=head1 AUTHORS +[% + FOREACH author = authors; + PROCESS author_block; + END; +-%] +^; + + $blocks->{author_block} = q^ +[% +IF author.name.length; author.name _ ' '; END; +IF author.handle.length; '(' _ author.name _ ') '; END; +IF author.email.length; '<' _ author.email _ '> '; END; +%] +^; + + $blocks->{license_block} = q^ +=head1 COPYRIGHT AND LICENSE + +[% license FILTER wrap(80, '', '') %] +^; + + $blocks->{role_block} = q^ +[% +PROCESS name_block; +PROCESS synopsys_block; +PROCESS description_block; +PROCESS roles_consumed_block; +PROCESS attributes_block; +PROCESS methods_block; +PROCESS authors_block; +PROCESS license_block; +%] +=cut +^; + + return $blocks; +} + +1; + +__END__; diff --git a/blib/lib/auto/MooseX/AutoDoc/.exists b/blib/lib/auto/MooseX/AutoDoc/.exists new file mode 100644 index 0000000..e69de29 diff --git a/blib/man1/.exists b/blib/man1/.exists new file mode 100644 index 0000000..e69de29 diff --git a/blib/man3/.exists b/blib/man3/.exists new file mode 100644 index 0000000..e69de29 diff --git a/blib/script/.exists b/blib/script/.exists new file mode 100644 index 0000000..e69de29 diff --git a/inc/Module/AutoInstall.pm b/inc/Module/AutoInstall.pm new file mode 100644 index 0000000..7efc552 --- /dev/null +++ b/inc/Module/AutoInstall.pm @@ -0,0 +1,768 @@ +#line 1 +package Module::AutoInstall; + +use strict; +use Cwd (); +use ExtUtils::MakeMaker (); + +use vars qw{$VERSION}; +BEGIN { + $VERSION = '1.03'; +} + +# special map on pre-defined feature sets +my %FeatureMap = ( + '' => 'Core Features', # XXX: deprecated + '-core' => 'Core Features', +); + +# various lexical flags +my ( @Missing, @Existing, %DisabledTests, $UnderCPAN, $HasCPANPLUS ); +my ( $Config, $CheckOnly, $SkipInstall, $AcceptDefault, $TestOnly ); +my ( $PostambleActions, $PostambleUsed ); + +# See if it's a testing or non-interactive session +_accept_default( $ENV{AUTOMATED_TESTING} or ! -t STDIN ); +_init(); + +sub _accept_default { + $AcceptDefault = shift; +} + +sub missing_modules { + return @Missing; +} + +sub do_install { + __PACKAGE__->install( + [ + $Config + ? ( UNIVERSAL::isa( $Config, 'HASH' ) ? %{$Config} : @{$Config} ) + : () + ], + @Missing, + ); +} + +# initialize various flags, and/or perform install +sub _init { + foreach my $arg ( + @ARGV, + split( + /[\s\t]+/, + $ENV{PERL_AUTOINSTALL} || $ENV{PERL_EXTUTILS_AUTOINSTALL} || '' + ) + ) + { + if ( $arg =~ /^--config=(.*)$/ ) { + $Config = [ split( ',', $1 ) ]; + } + elsif ( $arg =~ /^--installdeps=(.*)$/ ) { + __PACKAGE__->install( $Config, @Missing = split( /,/, $1 ) ); + exit 0; + } + elsif ( $arg =~ /^--default(?:deps)?$/ ) { + $AcceptDefault = 1; + } + elsif ( $arg =~ /^--check(?:deps)?$/ ) { + $CheckOnly = 1; + } + elsif ( $arg =~ /^--skip(?:deps)?$/ ) { + $SkipInstall = 1; + } + elsif ( $arg =~ /^--test(?:only)?$/ ) { + $TestOnly = 1; + } + } +} + +# overrides MakeMaker's prompt() to automatically accept the default choice +sub _prompt { + goto &ExtUtils::MakeMaker::prompt unless $AcceptDefault; + + my ( $prompt, $default ) = @_; + my $y = ( $default =~ /^[Yy]/ ); + + print $prompt, ' [', ( $y ? 'Y' : 'y' ), '/', ( $y ? 'n' : 'N' ), '] '; + print "$default\n"; + return $default; +} + +# the workhorse +sub import { + my $class = shift; + my @args = @_ or return; + my $core_all; + + print "*** $class version " . $class->VERSION . "\n"; + print "*** Checking for Perl dependencies...\n"; + + my $cwd = Cwd::cwd(); + + $Config = []; + + my $maxlen = length( + ( + sort { length($b) <=> length($a) } + grep { /^[^\-]/ } + map { + ref($_) + ? ( ( ref($_) eq 'HASH' ) ? keys(%$_) : @{$_} ) + : '' + } + map { +{@args}->{$_} } + grep { /^[^\-]/ or /^-core$/i } keys %{ +{@args} } + )[0] + ); + + while ( my ( $feature, $modules ) = splice( @args, 0, 2 ) ) { + my ( @required, @tests, @skiptests ); + my $default = 1; + my $conflict = 0; + + if ( $feature =~ m/^-(\w+)$/ ) { + my $option = lc($1); + + # check for a newer version of myself + _update_to( $modules, @_ ) and return if $option eq 'version'; + + # sets CPAN configuration options + $Config = $modules if $option eq 'config'; + + # promote every features to core status + $core_all = ( $modules =~ /^all$/i ) and next + if $option eq 'core'; + + next unless $option eq 'core'; + } + + print "[" . ( $FeatureMap{ lc($feature) } || $feature ) . "]\n"; + + $modules = [ %{$modules} ] if UNIVERSAL::isa( $modules, 'HASH' ); + + unshift @$modules, -default => &{ shift(@$modules) } + if ( ref( $modules->[0] ) eq 'CODE' ); # XXX: bugward combatability + + while ( my ( $mod, $arg ) = splice( @$modules, 0, 2 ) ) { + if ( $mod =~ m/^-(\w+)$/ ) { + my $option = lc($1); + + $default = $arg if ( $option eq 'default' ); + $conflict = $arg if ( $option eq 'conflict' ); + @tests = @{$arg} if ( $option eq 'tests' ); + @skiptests = @{$arg} if ( $option eq 'skiptests' ); + + next; + } + + printf( "- %-${maxlen}s ...", $mod ); + + if ( $arg and $arg =~ /^\D/ ) { + unshift @$modules, $arg; + $arg = 0; + } + + # XXX: check for conflicts and uninstalls(!) them. + if ( + defined( my $cur = _version_check( _load($mod), $arg ||= 0 ) ) ) + { + print "loaded. ($cur" . ( $arg ? " >= $arg" : '' ) . ")\n"; + push @Existing, $mod => $arg; + $DisabledTests{$_} = 1 for map { glob($_) } @skiptests; + } + else { + print "missing." . ( $arg ? " (would need $arg)" : '' ) . "\n"; + push @required, $mod => $arg; + } + } + + next unless @required; + + my $mandatory = ( $feature eq '-core' or $core_all ); + + if ( + !$SkipInstall + and ( + $CheckOnly + or _prompt( + qq{==> Auto-install the } + . ( @required / 2 ) + . ( $mandatory ? ' mandatory' : ' optional' ) + . qq{ module(s) from CPAN?}, + $default ? 'y' : 'n', + ) =~ /^[Yy]/ + ) + ) + { + push( @Missing, @required ); + $DisabledTests{$_} = 1 for map { glob($_) } @skiptests; + } + + elsif ( !$SkipInstall + and $default + and $mandatory + and + _prompt( qq{==> The module(s) are mandatory! Really skip?}, 'n', ) + =~ /^[Nn]/ ) + { + push( @Missing, @required ); + $DisabledTests{$_} = 1 for map { glob($_) } @skiptests; + } + + else { + $DisabledTests{$_} = 1 for map { glob($_) } @tests; + } + } + + $UnderCPAN = _check_lock(); # check for $UnderCPAN + + if ( @Missing and not( $CheckOnly or $UnderCPAN ) ) { + require Config; + print +"*** Dependencies will be installed the next time you type '$Config::Config{make}'.\n"; + + # make an educated guess of whether we'll need root permission. + print " (You may need to do that as the 'root' user.)\n" + if eval '$>'; + } + print "*** $class configuration finished.\n"; + + chdir $cwd; + + # import to main:: + no strict 'refs'; + *{'main::WriteMakefile'} = \&Write if caller(0) eq 'main'; +} + +# Check to see if we are currently running under CPAN.pm and/or CPANPLUS; +# if we are, then we simply let it taking care of our dependencies +sub _check_lock { + return unless @Missing; + + if ($ENV{PERL5_CPANPLUS_IS_RUNNING}) { + print <<'END_MESSAGE'; + +*** Since we're running under CPANPLUS, I'll just let it take care + of the dependency's installation later. +END_MESSAGE + return 1; + } + + _load_cpan(); + + # Find the CPAN lock-file + my $lock = MM->catfile( $CPAN::Config->{cpan_home}, ".lock" ); + return unless -f $lock; + + # Check the lock + local *LOCK; + return unless open(LOCK, $lock); + + if ( + ( $^O eq 'MSWin32' ? _under_cpan() : == getppid() ) + and ( $CPAN::Config->{prerequisites_policy} || '' ) ne 'ignore' + ) { + print <<'END_MESSAGE'; + +*** Since we're running under CPAN, I'll just let it take care + of the dependency's installation later. +END_MESSAGE + return 1; + } + + close LOCK; + return; +} + +sub install { + my $class = shift; + + my $i; # used below to strip leading '-' from config keys + my @config = ( map { s/^-// if ++$i; $_ } @{ +shift } ); + + my ( @modules, @installed ); + while ( my ( $pkg, $ver ) = splice( @_, 0, 2 ) ) { + + # grep out those already installed + if ( defined( _version_check( _load($pkg), $ver ) ) ) { + push @installed, $pkg; + } + else { + push @modules, $pkg, $ver; + } + } + + return @installed unless @modules; # nothing to do + return @installed if _check_lock(); # defer to the CPAN shell + + print "*** Installing dependencies...\n"; + + return unless _connected_to('cpan.org'); + + my %args = @config; + my %failed; + local *FAILED; + if ( $args{do_once} and open( FAILED, '.#autoinstall.failed' ) ) { + while () { chomp; $failed{$_}++ } + close FAILED; + + my @newmod; + while ( my ( $k, $v ) = splice( @modules, 0, 2 ) ) { + push @newmod, ( $k => $v ) unless $failed{$k}; + } + @modules = @newmod; + } + + if ( _has_cpanplus() ) { + _install_cpanplus( \@modules, \@config ); + } else { + _install_cpan( \@modules, \@config ); + } + + print "*** $class installation finished.\n"; + + # see if we have successfully installed them + while ( my ( $pkg, $ver ) = splice( @modules, 0, 2 ) ) { + if ( defined( _version_check( _load($pkg), $ver ) ) ) { + push @installed, $pkg; + } + elsif ( $args{do_once} and open( FAILED, '>> .#autoinstall.failed' ) ) { + print FAILED "$pkg\n"; + } + } + + close FAILED if $args{do_once}; + + return @installed; +} + +sub _install_cpanplus { + my @modules = @{ +shift }; + my @config = _cpanplus_config( @{ +shift } ); + my $installed = 0; + + require CPANPLUS::Backend; + my $cp = CPANPLUS::Backend->new; + my $conf = $cp->configure_object; + + return unless $conf->can('conf') # 0.05x+ with "sudo" support + or _can_write($conf->_get_build('base')); # 0.04x + + # if we're root, set UNINST=1 to avoid trouble unless user asked for it. + my $makeflags = $conf->get_conf('makeflags') || ''; + if ( UNIVERSAL::isa( $makeflags, 'HASH' ) ) { + # 0.03+ uses a hashref here + $makeflags->{UNINST} = 1 unless exists $makeflags->{UNINST}; + + } else { + # 0.02 and below uses a scalar + $makeflags = join( ' ', split( ' ', $makeflags ), 'UNINST=1' ) + if ( $makeflags !~ /\bUNINST\b/ and eval qq{ $> eq '0' } ); + + } + $conf->set_conf( makeflags => $makeflags ); + $conf->set_conf( prereqs => 1 ); + + + + while ( my ( $key, $val ) = splice( @config, 0, 2 ) ) { + $conf->set_conf( $key, $val ); + } + + my $modtree = $cp->module_tree; + while ( my ( $pkg, $ver ) = splice( @modules, 0, 2 ) ) { + print "*** Installing $pkg...\n"; + + MY::preinstall( $pkg, $ver ) or next if defined &MY::preinstall; + + my $success; + my $obj = $modtree->{$pkg}; + + if ( $obj and defined( _version_check( $obj->{version}, $ver ) ) ) { + my $pathname = $pkg; + $pathname =~ s/::/\\W/; + + foreach my $inc ( grep { m/$pathname.pm/i } keys(%INC) ) { + delete $INC{$inc}; + } + + my $rv = $cp->install( modules => [ $obj->{module} ] ); + + if ( $rv and ( $rv->{ $obj->{module} } or $rv->{ok} ) ) { + print "*** $pkg successfully installed.\n"; + $success = 1; + } else { + print "*** $pkg installation cancelled.\n"; + $success = 0; + } + + $installed += $success; + } else { + print << "."; +*** Could not find a version $ver or above for $pkg; skipping. +. + } + + MY::postinstall( $pkg, $ver, $success ) if defined &MY::postinstall; + } + + return $installed; +} + +sub _cpanplus_config { + my @config = (); + while ( @_ ) { + my ($key, $value) = (shift(), shift()); + if ( $key eq 'prerequisites_policy' ) { + if ( $value eq 'follow' ) { + $value = CPANPLUS::Internals::Constants::PREREQ_INSTALL(); + } elsif ( $value eq 'ask' ) { + $value = CPANPLUS::Internals::Constants::PREREQ_ASK(); + } elsif ( $value eq 'ignore' ) { + $value = CPANPLUS::Internals::Constants::PREREQ_IGNORE(); + } else { + die "*** Cannot convert option $key = '$value' to CPANPLUS version.\n"; + } + } else { + die "*** Cannot convert option $key to CPANPLUS version.\n"; + } + } + return @config; +} + +sub _install_cpan { + my @modules = @{ +shift }; + my @config = @{ +shift }; + my $installed = 0; + my %args; + + _load_cpan(); + require Config; + + if (CPAN->VERSION < 1.80) { + # no "sudo" support, probe for writableness + return unless _can_write( MM->catfile( $CPAN::Config->{cpan_home}, 'sources' ) ) + and _can_write( $Config::Config{sitelib} ); + } + + # if we're root, set UNINST=1 to avoid trouble unless user asked for it. + my $makeflags = $CPAN::Config->{make_install_arg} || ''; + $CPAN::Config->{make_install_arg} = + join( ' ', split( ' ', $makeflags ), 'UNINST=1' ) + if ( $makeflags !~ /\bUNINST\b/ and eval qq{ $> eq '0' } ); + + # don't show start-up info + $CPAN::Config->{inhibit_startup_message} = 1; + + # set additional options + while ( my ( $opt, $arg ) = splice( @config, 0, 2 ) ) { + ( $args{$opt} = $arg, next ) + if $opt =~ /^force$/; # pseudo-option + $CPAN::Config->{$opt} = $arg; + } + + local $CPAN::Config->{prerequisites_policy} = 'follow'; + + while ( my ( $pkg, $ver ) = splice( @modules, 0, 2 ) ) { + MY::preinstall( $pkg, $ver ) or next if defined &MY::preinstall; + + print "*** Installing $pkg...\n"; + + my $obj = CPAN::Shell->expand( Module => $pkg ); + my $success = 0; + + if ( $obj and defined( _version_check( $obj->cpan_version, $ver ) ) ) { + my $pathname = $pkg; + $pathname =~ s/::/\\W/; + + foreach my $inc ( grep { m/$pathname.pm/i } keys(%INC) ) { + delete $INC{$inc}; + } + + my $rv = $args{force} ? CPAN::Shell->force( install => $pkg ) + : CPAN::Shell->install($pkg); + $rv ||= eval { + $CPAN::META->instance( 'CPAN::Distribution', $obj->cpan_file, ) + ->{install} + if $CPAN::META; + }; + + if ( $rv eq 'YES' ) { + print "*** $pkg successfully installed.\n"; + $success = 1; + } + else { + print "*** $pkg installation failed.\n"; + $success = 0; + } + + $installed += $success; + } + else { + print << "."; +*** Could not find a version $ver or above for $pkg; skipping. +. + } + + MY::postinstall( $pkg, $ver, $success ) if defined &MY::postinstall; + } + + return $installed; +} + +sub _has_cpanplus { + return ( + $HasCPANPLUS = ( + $INC{'CPANPLUS/Config.pm'} + or _load('CPANPLUS::Shell::Default') + ) + ); +} + +# make guesses on whether we're under the CPAN installation directory +sub _under_cpan { + require Cwd; + require File::Spec; + + my $cwd = File::Spec->canonpath( Cwd::cwd() ); + my $cpan = File::Spec->canonpath( $CPAN::Config->{cpan_home} ); + + return ( index( $cwd, $cpan ) > -1 ); +} + +sub _update_to { + my $class = __PACKAGE__; + my $ver = shift; + + return + if defined( _version_check( _load($class), $ver ) ); # no need to upgrade + + if ( + _prompt( "==> A newer version of $class ($ver) is required. Install?", + 'y' ) =~ /^[Nn]/ + ) + { + die "*** Please install $class $ver manually.\n"; + } + + print << "."; +*** Trying to fetch it from CPAN... +. + + # install ourselves + _load($class) and return $class->import(@_) + if $class->install( [], $class, $ver ); + + print << '.'; exit 1; + +*** Cannot bootstrap myself. :-( Installation terminated. +. +} + +# check if we're connected to some host, using inet_aton +sub _connected_to { + my $site = shift; + + return ( + ( _load('Socket') and Socket::inet_aton($site) ) or _prompt( + qq( +*** Your host cannot resolve the domain name '$site', which + probably means the Internet connections are unavailable. +==> Should we try to install the required module(s) anyway?), 'n' + ) =~ /^[Yy]/ + ); +} + +# check if a directory is writable; may create it on demand +sub _can_write { + my $path = shift; + mkdir( $path, 0755 ) unless -e $path; + + return 1 if -w $path; + + print << "."; +*** You are not allowed to write to the directory '$path'; + the installation may fail due to insufficient permissions. +. + + if ( + eval '$>' and lc(`sudo -V`) =~ /version/ and _prompt( + qq( +==> Should we try to re-execute the autoinstall process with 'sudo'?), + ((-t STDIN) ? 'y' : 'n') + ) =~ /^[Yy]/ + ) + { + + # try to bootstrap ourselves from sudo + print << "."; +*** Trying to re-execute the autoinstall process with 'sudo'... +. + my $missing = join( ',', @Missing ); + my $config = join( ',', + UNIVERSAL::isa( $Config, 'HASH' ) ? %{$Config} : @{$Config} ) + if $Config; + + return + unless system( 'sudo', $^X, $0, "--config=$config", + "--installdeps=$missing" ); + + print << "."; +*** The 'sudo' command exited with error! Resuming... +. + } + + return _prompt( + qq( +==> Should we try to install the required module(s) anyway?), 'n' + ) =~ /^[Yy]/; +} + +# load a module and return the version it reports +sub _load { + my $mod = pop; # class/instance doesn't matter + my $file = $mod; + + $file =~ s|::|/|g; + $file .= '.pm'; + + local $@; + return eval { require $file; $mod->VERSION } || ( $@ ? undef: 0 ); +} + +# Load CPAN.pm and it's configuration +sub _load_cpan { + return if $CPAN::VERSION; + require CPAN; + if ( $CPAN::HandleConfig::VERSION ) { + # Newer versions of CPAN have a HandleConfig module + CPAN::HandleConfig->load; + } else { + # Older versions had the load method in Config directly + CPAN::Config->load; + } +} + +# compare two versions, either use Sort::Versions or plain comparison +sub _version_check { + my ( $cur, $min ) = @_; + return unless defined $cur; + + $cur =~ s/\s+$//; + + # check for version numbers that are not in decimal format + if ( ref($cur) or ref($min) or $cur =~ /v|\..*\./ or $min =~ /v|\..*\./ ) { + if ( ( $version::VERSION or defined( _load('version') )) and + version->can('new') + ) { + + # use version.pm if it is installed. + return ( + ( version->new($cur) >= version->new($min) ) ? $cur : undef ); + } + elsif ( $Sort::Versions::VERSION or defined( _load('Sort::Versions') ) ) + { + + # use Sort::Versions as the sorting algorithm for a.b.c versions + return ( ( Sort::Versions::versioncmp( $cur, $min ) != -1 ) + ? $cur + : undef ); + } + + warn "Cannot reliably compare non-decimal formatted versions.\n" + . "Please install version.pm or Sort::Versions.\n"; + } + + # plain comparison + local $^W = 0; # shuts off 'not numeric' bugs + return ( $cur >= $min ? $cur : undef ); +} + +# nothing; this usage is deprecated. +sub main::PREREQ_PM { return {}; } + +sub _make_args { + my %args = @_; + + $args{PREREQ_PM} = { %{ $args{PREREQ_PM} || {} }, @Existing, @Missing } + if $UnderCPAN or $TestOnly; + + if ( $args{EXE_FILES} and -e 'MANIFEST' ) { + require ExtUtils::Manifest; + my $manifest = ExtUtils::Manifest::maniread('MANIFEST'); + + $args{EXE_FILES} = + [ grep { exists $manifest->{$_} } @{ $args{EXE_FILES} } ]; + } + + $args{test}{TESTS} ||= 't/*.t'; + $args{test}{TESTS} = join( ' ', + grep { !exists( $DisabledTests{$_} ) } + map { glob($_) } split( /\s+/, $args{test}{TESTS} ) ); + + my $missing = join( ',', @Missing ); + my $config = + join( ',', UNIVERSAL::isa( $Config, 'HASH' ) ? %{$Config} : @{$Config} ) + if $Config; + + $PostambleActions = ( + $missing + ? "\$(PERL) $0 --config=$config --installdeps=$missing" + : "\$(NOECHO) \$(NOOP)" + ); + + return %args; +} + +# a wrapper to ExtUtils::MakeMaker::WriteMakefile +sub Write { + require Carp; + Carp::croak "WriteMakefile: Need even number of args" if @_ % 2; + + if ($CheckOnly) { + print << "."; +*** Makefile not written in check-only mode. +. + return; + } + + my %args = _make_args(@_); + + no strict 'refs'; + + $PostambleUsed = 0; + local *MY::postamble = \&postamble unless defined &MY::postamble; + ExtUtils::MakeMaker::WriteMakefile(%args); + + print << "." unless $PostambleUsed; +*** WARNING: Makefile written with customized MY::postamble() without + including contents from Module::AutoInstall::postamble() -- + auto installation features disabled. Please contact the author. +. + + return 1; +} + +sub postamble { + $PostambleUsed = 1; + + return << "."; + +config :: installdeps +\t\$(NOECHO) \$(NOOP) + +checkdeps :: +\t\$(PERL) $0 --checkdeps + +installdeps :: +\t$PostambleActions + +. + +} + +1; + +__END__ + +#line 1003 diff --git a/inc/Module/Install.pm b/inc/Module/Install.pm new file mode 100644 index 0000000..89a8653 --- /dev/null +++ b/inc/Module/Install.pm @@ -0,0 +1,281 @@ +#line 1 +package Module::Install; + +# For any maintainers: +# The load order for Module::Install is a bit magic. +# It goes something like this... +# +# IF ( host has Module::Install installed, creating author mode ) { +# 1. Makefile.PL calls "use inc::Module::Install" +# 2. $INC{inc/Module/Install.pm} set to installed version of inc::Module::Install +# 3. The installed version of inc::Module::Install loads +# 4. inc::Module::Install calls "require Module::Install" +# 5. The ./inc/ version of Module::Install loads +# } ELSE { +# 1. Makefile.PL calls "use inc::Module::Install" +# 2. $INC{inc/Module/Install.pm} set to ./inc/ version of Module::Install +# 3. The ./inc/ version of Module::Install loads +# } + +use 5.004; +use strict 'vars'; + +use vars qw{$VERSION}; +BEGIN { + # All Module::Install core packages now require synchronised versions. + # This will be used to ensure we don't accidentally load old or + # different versions of modules. + # This is not enforced yet, but will be some time in the next few + # releases once we can make sure it won't clash with custom + # Module::Install extensions. + $VERSION = '0.68'; +} + +# Whether or not inc::Module::Install is actually loaded, the +# $INC{inc/Module/Install.pm} is what will still get set as long as +# the caller loaded module this in the documented manner. +# If not set, the caller may NOT have loaded the bundled version, and thus +# they may not have a MI version that works with the Makefile.PL. This would +# result in false errors or unexpected behaviour. And we don't want that. +my $file = join( '/', 'inc', split /::/, __PACKAGE__ ) . '.pm'; +unless ( $INC{$file} ) { + die <<"END_DIE"; +Please invoke ${\__PACKAGE__} with: + + use inc::${\__PACKAGE__}; + +not: + + use ${\__PACKAGE__}; + +END_DIE +} + +# If the script that is loading Module::Install is from the future, +# then make will detect this and cause it to re-run over and over +# again. This is bad. Rather than taking action to touch it (which +# is unreliable on some platforms and requires write permissions) +# for now we should catch this and refuse to run. +if ( -f $0 and (stat($0))[9] > time ) { + die << "END_DIE"; +Your installer $0 has a modification time in the future. + +This is known to create infinite loops in make. + +Please correct this, then run $0 again. + +END_DIE +} + +use Cwd (); +use File::Find (); +use File::Path (); +use FindBin; + +*inc::Module::Install::VERSION = *VERSION; +@inc::Module::Install::ISA = __PACKAGE__; + +sub autoload { + my $self = shift; + my $who = $self->_caller; + my $cwd = Cwd::cwd(); + my $sym = "${who}::AUTOLOAD"; + $sym->{$cwd} = sub { + my $pwd = Cwd::cwd(); + if ( my $code = $sym->{$pwd} ) { + # delegate back to parent dirs + goto &$code unless $cwd eq $pwd; + } + $$sym =~ /([^:]+)$/ or die "Cannot autoload $who - $sym"; + unshift @_, ($self, $1); + goto &{$self->can('call')} unless uc($1) eq $1; + }; +} + +sub import { + my $class = shift; + my $self = $class->new(@_); + my $who = $self->_caller; + + unless ( -f $self->{file} ) { + require "$self->{path}/$self->{dispatch}.pm"; + File::Path::mkpath("$self->{prefix}/$self->{author}"); + $self->{admin} = "$self->{name}::$self->{dispatch}"->new( _top => $self ); + $self->{admin}->init; + @_ = ($class, _self => $self); + goto &{"$self->{name}::import"}; + } + + *{"${who}::AUTOLOAD"} = $self->autoload; + $self->preload; + + # Unregister loader and worker packages so subdirs can use them again + delete $INC{"$self->{file}"}; + delete $INC{"$self->{path}.pm"}; +} + +sub preload { + my ($self) = @_; + + unless ( $self->{extensions} ) { + $self->load_extensions( + "$self->{prefix}/$self->{path}", $self + ); + } + + my @exts = @{$self->{extensions}}; + unless ( @exts ) { + my $admin = $self->{admin}; + @exts = $admin->load_all_extensions; + } + + my %seen; + foreach my $obj ( @exts ) { + while (my ($method, $glob) = each %{ref($obj) . '::'}) { + next unless $obj->can($method); + next if $method =~ /^_/; + next if $method eq uc($method); + $seen{$method}++; + } + } + + my $who = $self->_caller; + foreach my $name ( sort keys %seen ) { + *{"${who}::$name"} = sub { + ${"${who}::AUTOLOAD"} = "${who}::$name"; + goto &{"${who}::AUTOLOAD"}; + }; + } +} + +sub new { + my ($class, %args) = @_; + + # ignore the prefix on extension modules built from top level. + my $base_path = Cwd::abs_path($FindBin::Bin); + unless ( Cwd::abs_path(Cwd::cwd()) eq $base_path ) { + delete $args{prefix}; + } + + return $args{_self} if $args{_self}; + + $args{dispatch} ||= 'Admin'; + $args{prefix} ||= 'inc'; + $args{author} ||= ($^O eq 'VMS' ? '_author' : '.author'); + $args{bundle} ||= 'inc/BUNDLES'; + $args{base} ||= $base_path; + $class =~ s/^\Q$args{prefix}\E:://; + $args{name} ||= $class; + $args{version} ||= $class->VERSION; + unless ( $args{path} ) { + $args{path} = $args{name}; + $args{path} =~ s!::!/!g; + } + $args{file} ||= "$args{base}/$args{prefix}/$args{path}.pm"; + + bless( \%args, $class ); +} + +sub call { + my ($self, $method) = @_; + my $obj = $self->load($method) or return; + splice(@_, 0, 2, $obj); + goto &{$obj->can($method)}; +} + +sub load { + my ($self, $method) = @_; + + $self->load_extensions( + "$self->{prefix}/$self->{path}", $self + ) unless $self->{extensions}; + + foreach my $obj (@{$self->{extensions}}) { + return $obj if $obj->can($method); + } + + my $admin = $self->{admin} or die <<"END_DIE"; +The '$method' method does not exist in the '$self->{prefix}' path! +Please remove the '$self->{prefix}' directory and run $0 again to load it. +END_DIE + + my $obj = $admin->load($method, 1); + push @{$self->{extensions}}, $obj; + + $obj; +} + +sub load_extensions { + my ($self, $path, $top) = @_; + + unless ( grep { lc $_ eq lc $self->{prefix} } @INC ) { + unshift @INC, $self->{prefix}; + } + + foreach my $rv ( $self->find_extensions($path) ) { + my ($file, $pkg) = @{$rv}; + next if $self->{pathnames}{$pkg}; + + local $@; + my $new = eval { require $file; $pkg->can('new') }; + unless ( $new ) { + warn $@ if $@; + next; + } + $self->{pathnames}{$pkg} = delete $INC{$file}; + push @{$self->{extensions}}, &{$new}($pkg, _top => $top ); + } + + $self->{extensions} ||= []; +} + +sub find_extensions { + my ($self, $path) = @_; + + my @found; + File::Find::find( sub { + my $file = $File::Find::name; + return unless $file =~ m!^\Q$path\E/(.+)\.pm\Z!is; + my $subpath = $1; + return if lc($subpath) eq lc($self->{dispatch}); + + $file = "$self->{path}/$subpath.pm"; + my $pkg = "$self->{name}::$subpath"; + $pkg =~ s!/!::!g; + + # If we have a mixed-case package name, assume case has been preserved + # correctly. Otherwise, root through the file to locate the case-preserved + # version of the package name. + if ( $subpath eq lc($subpath) || $subpath eq uc($subpath) ) { + open PKGFILE, "<$subpath.pm" or die "find_extensions: Can't open $subpath.pm: $!"; + my $in_pod = 0; + while ( ) { + $in_pod = 1 if /^=\w/; + $in_pod = 0 if /^=cut/; + next if ($in_pod || /^=cut/); # skip pod text + next if /^\s*#/; # and comments + if ( m/^\s*package\s+($pkg)\s*;/i ) { + $pkg = $1; + last; + } + } + close PKGFILE; + } + + push @found, [ $file, $pkg ]; + }, $path ) if -d $path; + + @found; +} + +sub _caller { + my $depth = 0; + my $call = caller($depth); + while ( $call eq __PACKAGE__ ) { + $depth++; + $call = caller($depth); + } + return $call; +} + +1; diff --git a/inc/Module/Install/AutoInstall.pm b/inc/Module/Install/AutoInstall.pm new file mode 100644 index 0000000..3a490fb --- /dev/null +++ b/inc/Module/Install/AutoInstall.pm @@ -0,0 +1,61 @@ +#line 1 +package Module::Install::AutoInstall; + +use strict; +use Module::Install::Base; + +use vars qw{$VERSION $ISCORE @ISA}; +BEGIN { + $VERSION = '0.68'; + $ISCORE = 1; + @ISA = qw{Module::Install::Base}; +} + +sub AutoInstall { $_[0] } + +sub run { + my $self = shift; + $self->auto_install_now(@_); +} + +sub write { + my $self = shift; + $self->auto_install(@_); +} + +sub auto_install { + my $self = shift; + return if $self->{done}++; + + # Flatten array of arrays into a single array + my @core = map @$_, map @$_, grep ref, + $self->build_requires, $self->requires; + + my @config = @_; + + # We'll need Module::AutoInstall + $self->include('Module::AutoInstall'); + require Module::AutoInstall; + + Module::AutoInstall->import( + (@config ? (-config => \@config) : ()), + (@core ? (-core => \@core) : ()), + $self->features, + ); + + $self->makemaker_args( Module::AutoInstall::_make_args() ); + + my $class = ref($self); + $self->postamble( + "# --- $class section:\n" . + Module::AutoInstall::postamble() + ); +} + +sub auto_install_now { + my $self = shift; + $self->auto_install(@_); + Module::AutoInstall::do_install(); +} + +1; diff --git a/inc/Module/Install/Base.pm b/inc/Module/Install/Base.pm new file mode 100644 index 0000000..49dfde6 --- /dev/null +++ b/inc/Module/Install/Base.pm @@ -0,0 +1,70 @@ +#line 1 +package Module::Install::Base; + +$VERSION = '0.68'; + +# Suspend handler for "redefined" warnings +BEGIN { + my $w = $SIG{__WARN__}; + $SIG{__WARN__} = sub { $w }; +} + +### This is the ONLY module that shouldn't have strict on +# use strict; + +#line 41 + +sub new { + my ($class, %args) = @_; + + foreach my $method ( qw(call load) ) { + *{"$class\::$method"} = sub { + shift()->_top->$method(@_); + } unless defined &{"$class\::$method"}; + } + + bless( \%args, $class ); +} + +#line 61 + +sub AUTOLOAD { + my $self = shift; + local $@; + my $autoload = eval { $self->_top->autoload } or return; + goto &$autoload; +} + +#line 76 + +sub _top { $_[0]->{_top} } + +#line 89 + +sub admin { + $_[0]->_top->{admin} or Module::Install::Base::FakeAdmin->new; +} + +sub is_admin { + $_[0]->admin->VERSION; +} + +sub DESTROY {} + +package Module::Install::Base::FakeAdmin; + +my $Fake; +sub new { $Fake ||= bless(\@_, $_[0]) } + +sub AUTOLOAD {} + +sub DESTROY {} + +# Restore warning handler +BEGIN { + $SIG{__WARN__} = $SIG{__WARN__}->(); +} + +1; + +#line 138 diff --git a/inc/Module/Install/Can.pm b/inc/Module/Install/Can.pm new file mode 100644 index 0000000..ec66fdb --- /dev/null +++ b/inc/Module/Install/Can.pm @@ -0,0 +1,82 @@ +#line 1 +package Module::Install::Can; + +use strict; +use Module::Install::Base; +use Config (); +### This adds a 5.005 Perl version dependency. +### This is a bug and will be fixed. +use File::Spec (); +use ExtUtils::MakeMaker (); + +use vars qw{$VERSION $ISCORE @ISA}; +BEGIN { + $VERSION = '0.68'; + $ISCORE = 1; + @ISA = qw{Module::Install::Base}; +} + +# check if we can load some module +### Upgrade this to not have to load the module if possible +sub can_use { + my ($self, $mod, $ver) = @_; + $mod =~ s{::|\\}{/}g; + $mod .= '.pm' unless $mod =~ /\.pm$/i; + + my $pkg = $mod; + $pkg =~ s{/}{::}g; + $pkg =~ s{\.pm$}{}i; + + local $@; + eval { require $mod; $pkg->VERSION($ver || 0); 1 }; +} + +# check if we can run some command +sub can_run { + my ($self, $cmd) = @_; + + my $_cmd = $cmd; + return $_cmd if (-x $_cmd or $_cmd = MM->maybe_command($_cmd)); + + for my $dir ((split /$Config::Config{path_sep}/, $ENV{PATH}), '.') { + my $abs = File::Spec->catfile($dir, $_[1]); + return $abs if (-x $abs or $abs = MM->maybe_command($abs)); + } + + return; +} + +# can we locate a (the) C compiler +sub can_cc { + my $self = shift; + my @chunks = split(/ /, $Config::Config{cc}) or return; + + # $Config{cc} may contain args; try to find out the program part + while (@chunks) { + return $self->can_run("@chunks") || (pop(@chunks), next); + } + + return; +} + +# Fix Cygwin bug on maybe_command(); +if ( $^O eq 'cygwin' ) { + require ExtUtils::MM_Cygwin; + require ExtUtils::MM_Win32; + if ( ! defined(&ExtUtils::MM_Cygwin::maybe_command) ) { + *ExtUtils::MM_Cygwin::maybe_command = sub { + my ($self, $file) = @_; + if ($file =~ m{^/cygdrive/}i and ExtUtils::MM_Win32->can('maybe_command')) { + ExtUtils::MM_Win32->maybe_command($file); + } else { + ExtUtils::MM_Unix->maybe_command($file); + } + } + } +} + +1; + +__END__ + +#line 157 diff --git a/inc/Module/Install/Fetch.pm b/inc/Module/Install/Fetch.pm new file mode 100644 index 0000000..e0dd6db --- /dev/null +++ b/inc/Module/Install/Fetch.pm @@ -0,0 +1,93 @@ +#line 1 +package Module::Install::Fetch; + +use strict; +use Module::Install::Base; + +use vars qw{$VERSION $ISCORE @ISA}; +BEGIN { + $VERSION = '0.68'; + $ISCORE = 1; + @ISA = qw{Module::Install::Base}; +} + +sub get_file { + my ($self, %args) = @_; + my ($scheme, $host, $path, $file) = + $args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return; + + if ( $scheme eq 'http' and ! eval { require LWP::Simple; 1 } ) { + $args{url} = $args{ftp_url} + or (warn("LWP support unavailable!\n"), return); + ($scheme, $host, $path, $file) = + $args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return; + } + + $|++; + print "Fetching '$file' from $host... "; + + unless (eval { require Socket; Socket::inet_aton($host) }) { + warn "'$host' resolve failed!\n"; + return; + } + + return unless $scheme eq 'ftp' or $scheme eq 'http'; + + require Cwd; + my $dir = Cwd::getcwd(); + chdir $args{local_dir} or return if exists $args{local_dir}; + + if (eval { require LWP::Simple; 1 }) { + LWP::Simple::mirror($args{url}, $file); + } + elsif (eval { require Net::FTP; 1 }) { eval { + # use Net::FTP to get past firewall + my $ftp = Net::FTP->new($host, Passive => 1, Timeout => 600); + $ftp->login("anonymous", 'anonymous@example.com'); + $ftp->cwd($path); + $ftp->binary; + $ftp->get($file) or (warn("$!\n"), return); + $ftp->quit; + } } + elsif (my $ftp = $self->can_run('ftp')) { eval { + # no Net::FTP, fallback to ftp.exe + require FileHandle; + my $fh = FileHandle->new; + + local $SIG{CHLD} = 'IGNORE'; + unless ($fh->open("|$ftp -n")) { + warn "Couldn't open ftp: $!\n"; + chdir $dir; return; + } + + my @dialog = split(/\n/, <<"END_FTP"); +open $host +user anonymous anonymous\@example.com +cd $path +binary +get $file $file +quit +END_FTP + foreach (@dialog) { $fh->print("$_\n") } + $fh->close; + } } + else { + warn "No working 'ftp' program available!\n"; + chdir $dir; return; + } + + unless (-f $file) { + warn "Fetching failed: $@\n"; + chdir $dir; return; + } + + return if exists $args{size} and -s $file != $args{size}; + system($args{run}) if exists $args{run}; + unlink($file) if $args{remove}; + + print(((!exists $args{check_for} or -e $args{check_for}) + ? "done!" : "failed! ($!)"), "\n"); + chdir $dir; return !$?; +} + +1; diff --git a/inc/Module/Install/Include.pm b/inc/Module/Install/Include.pm new file mode 100644 index 0000000..001d0c6 --- /dev/null +++ b/inc/Module/Install/Include.pm @@ -0,0 +1,34 @@ +#line 1 +package Module::Install::Include; + +use strict; +use Module::Install::Base; + +use vars qw{$VERSION $ISCORE @ISA}; +BEGIN { + $VERSION = '0.68'; + $ISCORE = 1; + @ISA = qw{Module::Install::Base}; +} + +sub include { + shift()->admin->include(@_); +} + +sub include_deps { + shift()->admin->include_deps(@_); +} + +sub auto_include { + shift()->admin->auto_include(@_); +} + +sub auto_include_deps { + shift()->admin->auto_include_deps(@_); +} + +sub auto_include_dependent_dists { + shift()->admin->auto_include_dependent_dists(@_); +} + +1; diff --git a/inc/Module/Install/Makefile.pm b/inc/Module/Install/Makefile.pm new file mode 100644 index 0000000..17bd8a7 --- /dev/null +++ b/inc/Module/Install/Makefile.pm @@ -0,0 +1,237 @@ +#line 1 +package Module::Install::Makefile; + +use strict 'vars'; +use Module::Install::Base; +use ExtUtils::MakeMaker (); + +use vars qw{$VERSION $ISCORE @ISA}; +BEGIN { + $VERSION = '0.68'; + $ISCORE = 1; + @ISA = qw{Module::Install::Base}; +} + +sub Makefile { $_[0] } + +my %seen = (); + +sub prompt { + shift; + + # Infinite loop protection + my @c = caller(); + if ( ++$seen{"$c[1]|$c[2]|$_[0]"} > 3 ) { + die "Caught an potential prompt infinite loop ($c[1]|$c[2]|$_[0])"; + } + + # In automated testing, always use defaults + if ( $ENV{AUTOMATED_TESTING} and ! $ENV{PERL_MM_USE_DEFAULT} ) { + local $ENV{PERL_MM_USE_DEFAULT} = 1; + goto &ExtUtils::MakeMaker::prompt; + } else { + goto &ExtUtils::MakeMaker::prompt; + } +} + +sub makemaker_args { + my $self = shift; + my $args = ($self->{makemaker_args} ||= {}); + %$args = ( %$args, @_ ) if @_; + $args; +} + +# For mm args that take multiple space-seperated args, +# append an argument to the current list. +sub makemaker_append { + my $self = sShift; + my $name = shift; + my $args = $self->makemaker_args; + $args->{name} = defined $args->{$name} + ? join( ' ', $args->{name}, @_ ) + : join( ' ', @_ ); +} + +sub build_subdirs { + my $self = shift; + my $subdirs = $self->makemaker_args->{DIR} ||= []; + for my $subdir (@_) { + push @$subdirs, $subdir; + } +} + +sub clean_files { + my $self = shift; + my $clean = $self->makemaker_args->{clean} ||= {}; + %$clean = ( + %$clean, + FILES => join(' ', grep length, $clean->{FILES}, @_), + ); +} + +sub realclean_files { + my $self = shift; + my $realclean = $self->makemaker_args->{realclean} ||= {}; + %$realclean = ( + %$realclean, + FILES => join(' ', grep length, $realclean->{FILES}, @_), + ); +} + +sub libs { + my $self = shift; + my $libs = ref $_[0] ? shift : [ shift ]; + $self->makemaker_args( LIBS => $libs ); +} + +sub inc { + my $self = shift; + $self->makemaker_args( INC => shift ); +} + +my %test_dir = (); + +sub _wanted_t { + /\.t$/ and -f $_ and $test_dir{$File::Find::dir} = 1; +} + +sub tests_recursive { + my $self = shift; + if ( $self->tests ) { + die "tests_recursive will not work if tests are already defined"; + } + my $dir = shift || 't'; + unless ( -d $dir ) { + die "tests_recursive dir '$dir' does not exist"; + } + require File::Find; + %test_dir = (); + File::Find::find( \&_wanted_t, $dir ); + $self->tests( join ' ', map { "$_/*.t" } sort keys %test_dir ); +} + +sub write { + my $self = shift; + die "&Makefile->write() takes no arguments\n" if @_; + + my $args = $self->makemaker_args; + $args->{DISTNAME} = $self->name; + $args->{NAME} = $self->module_name || $self->name || $self->determine_NAME($args); + $args->{VERSION} = $self->version || $self->determine_VERSION($args); + $args->{NAME} =~ s/-/::/g; + if ( $self->tests ) { + $args->{test} = { TESTS => $self->tests }; + } + if ($] >= 5.005) { + $args->{ABSTRACT} = $self->abstract; + $args->{AUTHOR} = $self->author; + } + if ( eval($ExtUtils::MakeMaker::VERSION) >= 6.10 ) { + $args->{NO_META} = 1; + } + if ( eval($ExtUtils::MakeMaker::VERSION) > 6.17 and $self->sign ) { + $args->{SIGN} = 1; + } + unless ( $self->is_admin ) { + delete $args->{SIGN}; + } + + # merge both kinds of requires into prereq_pm + my $prereq = ($args->{PREREQ_PM} ||= {}); + %$prereq = ( %$prereq, + map { @$_ } + map { @$_ } + grep $_, + ($self->build_requires, $self->requires) + ); + + # merge both kinds of requires into prereq_pm + my $subdirs = ($args->{DIR} ||= []); + if ($self->bundles) { + foreach my $bundle (@{ $self->bundles }) { + my ($file, $dir) = @$bundle; + push @$subdirs, $dir if -d $dir; + delete $prereq->{$file}; + } + } + + if ( my $perl_version = $self->perl_version ) { + eval "use $perl_version; 1" + or die "ERROR: perl: Version $] is installed, " + . "but we need version >= $perl_version"; + } + + $args->{INSTALLDIRS} = $self->installdirs; + + my %args = map { ( $_ => $args->{$_} ) } grep {defined($args->{$_})} keys %$args; + + my $user_preop = delete $args{dist}->{PREOP}; + if (my $preop = $self->admin->preop($user_preop)) { + $args{dist} = $preop; + } + + my $mm = ExtUtils::MakeMaker::WriteMakefile(%args); + $self->fix_up_makefile($mm->{FIRST_MAKEFILE} || 'Makefile'); +} + +sub fix_up_makefile { + my $self = shift; + my $makefile_name = shift; + my $top_class = ref($self->_top) || ''; + my $top_version = $self->_top->VERSION || ''; + + my $preamble = $self->preamble + ? "# Preamble by $top_class $top_version\n" + . $self->preamble + : ''; + my $postamble = "# Postamble by $top_class $top_version\n" + . ($self->postamble || ''); + + local *MAKEFILE; + open MAKEFILE, "< $makefile_name" or die "fix_up_makefile: Couldn't open $makefile_name: $!"; + my $makefile = do { local $/; }; + close MAKEFILE or die $!; + + $makefile =~ s/\b(test_harness\(\$\(TEST_VERBOSE\), )/$1'inc', /; + $makefile =~ s/( -I\$\(INST_ARCHLIB\))/ -Iinc$1/g; + $makefile =~ s/( "-I\$\(INST_LIB\)")/ "-Iinc"$1/g; + $makefile =~ s/^(FULLPERL = .*)/$1 "-Iinc"/m; + $makefile =~ s/^(PERL = .*)/$1 "-Iinc"/m; + + # Module::Install will never be used to build the Core Perl + # Sometimes PERL_LIB and PERL_ARCHLIB get written anyway, which breaks + # PREFIX/PERL5LIB, and thus, install_share. Blank them if they exist + $makefile =~ s/^PERL_LIB = .+/PERL_LIB =/m; + #$makefile =~ s/^PERL_ARCHLIB = .+/PERL_ARCHLIB =/m; + + # Perl 5.005 mentions PERL_LIB explicitly, so we have to remove that as well. + $makefile =~ s/("?)-I\$\(PERL_LIB\)\1//g; + + # XXX - This is currently unused; not sure if it breaks other MM-users + # $makefile =~ s/^pm_to_blib\s+:\s+/pm_to_blib :: /mg; + + open MAKEFILE, "> $makefile_name" or die "fix_up_makefile: Couldn't open $makefile_name: $!"; + print MAKEFILE "$preamble$makefile$postamble" or die $!; + close MAKEFILE or die $!; + + 1; +} + +sub preamble { + my ($self, $text) = @_; + $self->{preamble} = $text . $self->{preamble} if defined $text; + $self->{preamble}; +} + +sub postamble { + my ($self, $text) = @_; + $self->{postamble} ||= $self->admin->postamble; + $self->{postamble} .= $text if defined $text; + $self->{postamble} +} + +1; + +__END__ + +#line 363 diff --git a/inc/Module/Install/Metadata.pm b/inc/Module/Install/Metadata.pm new file mode 100644 index 0000000..f77d68a --- /dev/null +++ b/inc/Module/Install/Metadata.pm @@ -0,0 +1,336 @@ +#line 1 +package Module::Install::Metadata; + +use strict 'vars'; +use Module::Install::Base; + +use vars qw{$VERSION $ISCORE @ISA}; +BEGIN { + $VERSION = '0.68'; + $ISCORE = 1; + @ISA = qw{Module::Install::Base}; +} + +my @scalar_keys = qw{ + name module_name abstract author version license + distribution_type perl_version tests installdirs +}; + +my @tuple_keys = qw{ + build_requires requires recommends bundles +}; + +sub Meta { shift } +sub Meta_ScalarKeys { @scalar_keys } +sub Meta_TupleKeys { @tuple_keys } + +foreach my $key (@scalar_keys) { + *$key = sub { + my $self = shift; + return $self->{values}{$key} if defined wantarray and !@_; + $self->{values}{$key} = shift; + return $self; + }; +} + +foreach my $key (@tuple_keys) { + *$key = sub { + my $self = shift; + return $self->{values}{$key} unless @_; + + my @rv; + while (@_) { + my $module = shift or last; + my $version = shift || 0; + if ( $module eq 'perl' ) { + $version =~ s{^(\d+)\.(\d+)\.(\d+)} + {$1 + $2/1_000 + $3/1_000_000}e; + $self->perl_version($version); + next; + } + my $rv = [ $module, $version ]; + push @rv, $rv; + } + push @{ $self->{values}{$key} }, @rv; + @rv; + }; +} + +# configure_requires is currently a null-op +sub configure_requires { 1 } + +# Aliases for build_requires that will have alternative +# meanings in some future version of META.yml. +sub test_requires { shift->build_requires(@_) } +sub install_requires { shift->build_requires(@_) } + +# Aliases for installdirs options +sub install_as_core { $_[0]->installdirs('perl') } +sub install_as_cpan { $_[0]->installdirs('site') } +sub install_as_site { $_[0]->installdirs('site') } +sub install_as_vendor { $_[0]->installdirs('vendor') } + +sub sign { + my $self = shift; + return $self->{'values'}{'sign'} if defined wantarray and ! @_; + $self->{'values'}{'sign'} = ( @_ ? $_[0] : 1 ); + return $self; +} + +sub dynamic_config { + my $self = shift; + unless ( @_ ) { + warn "You MUST provide an explicit true/false value to dynamic_config, skipping\n"; + return $self; + } + $self->{'values'}{'dynamic_config'} = $_[0] ? 1 : 0; + return $self; +} + +sub all_from { + my ( $self, $file ) = @_; + + unless ( defined($file) ) { + my $name = $self->name + or die "all_from called with no args without setting name() first"; + $file = join('/', 'lib', split(/-/, $name)) . '.pm'; + $file =~ s{.*/}{} unless -e $file; + die "all_from: cannot find $file from $name" unless -e $file; + } + + $self->version_from($file) unless $self->version; + $self->perl_version_from($file) unless $self->perl_version; + + # The remaining probes read from POD sections; if the file + # has an accompanying .pod, use that instead + my $pod = $file; + if ( $pod =~ s/\.pm$/.pod/i and -e $pod ) { + $file = $pod; + } + + $self->author_from($file) unless $self->author; + $self->license_from($file) unless $self->license; + $self->abstract_from($file) unless $self->abstract; +} + +sub provides { + my $self = shift; + my $provides = ( $self->{values}{provides} ||= {} ); + %$provides = (%$provides, @_) if @_; + return $provides; +} + +sub auto_provides { + my $self = shift; + return $self unless $self->is_admin; + + unless (-e 'MANIFEST') { + warn "Cannot deduce auto_provides without a MANIFEST, skipping\n"; + return $self; + } + + # Avoid spurious warnings as we are not checking manifest here. + + local $SIG{__WARN__} = sub {1}; + require ExtUtils::Manifest; + local *ExtUtils::Manifest::manicheck = sub { return }; + + require Module::Build; + my $build = Module::Build->new( + dist_name => $self->name, + dist_version => $self->version, + license => $self->license, + ); + $self->provides(%{ $build->find_dist_packages || {} }); +} + +sub feature { + my $self = shift; + my $name = shift; + my $features = ( $self->{values}{features} ||= [] ); + + my $mods; + + if ( @_ == 1 and ref( $_[0] ) ) { + # The user used ->feature like ->features by passing in the second + # argument as a reference. Accomodate for that. + $mods = $_[0]; + } else { + $mods = \@_; + } + + my $count = 0; + push @$features, ( + $name => [ + map { + ref($_) ? ( ref($_) eq 'HASH' ) ? %$_ + : @$_ + : $_ + } @$mods + ] + ); + + return @$features; +} + +sub features { + my $self = shift; + while ( my ( $name, $mods ) = splice( @_, 0, 2 ) ) { + $self->feature( $name, @$mods ); + } + return $self->{values}->{features} + ? @{ $self->{values}->{features} } + : (); +} + +sub no_index { + my $self = shift; + my $type = shift; + push @{ $self->{values}{no_index}{$type} }, @_ if $type; + return $self->{values}{no_index}; +} + +sub read { + my $self = shift; + $self->include_deps( 'YAML', 0 ); + + require YAML; + my $data = YAML::LoadFile('META.yml'); + + # Call methods explicitly in case user has already set some values. + while ( my ( $key, $value ) = each %$data ) { + next unless $self->can($key); + if ( ref $value eq 'HASH' ) { + while ( my ( $module, $version ) = each %$value ) { + $self->can($key)->($self, $module => $version ); + } + } + else { + $self->can($key)->($self, $value); + } + } + return $self; +} + +sub write { + my $self = shift; + return $self unless $self->is_admin; + $self->admin->write_meta; + return $self; +} + +sub version_from { + my ( $self, $file ) = @_; + require ExtUtils::MM_Unix; + $self->version( ExtUtils::MM_Unix->parse_version($file) ); +} + +sub abstract_from { + my ( $self, $file ) = @_; + require ExtUtils::MM_Unix; + $self->abstract( + bless( + { DISTNAME => $self->name }, + 'ExtUtils::MM_Unix' + )->parse_abstract($file) + ); +} + +sub _slurp { + my ( $self, $file ) = @_; + + local *FH; + open FH, "< $file" or die "Cannot open $file.pod: $!"; + do { local $/; }; +} + +sub perl_version_from { + my ( $self, $file ) = @_; + + if ( + $self->_slurp($file) =~ m/ + ^ + use \s* + v? + ([\d_\.]+) + \s* ; + /ixms + ) + { + my $v = $1; + $v =~ s{_}{}g; + $self->perl_version($1); + } + else { + warn "Cannot determine perl version info from $file\n"; + return; + } +} + +sub author_from { + my ( $self, $file ) = @_; + my $content = $self->_slurp($file); + if ($content =~ m/ + =head \d \s+ (?:authors?)\b \s* + ([^\n]*) + | + =head \d \s+ (?:licen[cs]e|licensing|copyright|legal)\b \s* + .*? copyright .*? \d\d\d[\d.]+ \s* (?:\bby\b)? \s* + ([^\n]*) + /ixms) { + my $author = $1 || $2; + $author =~ s{E}{<}g; + $author =~ s{E}{>}g; + $self->author($author); + } + else { + warn "Cannot determine author info from $file\n"; + } +} + +sub license_from { + my ( $self, $file ) = @_; + + if ( + $self->_slurp($file) =~ m/ + ( + =head \d \s+ + (?:licen[cs]e|licensing|copyright|legal)\b + .*? + ) + (=head\\d.*|=cut.*|) + \z + /ixms + ) + { + my $license_text = $1; + my @phrases = ( + 'under the same (?:terms|license) as perl itself' => 'perl', 1, + 'GNU public license' => 'gpl', 1, + 'GNU lesser public license' => 'gpl', 1, + 'BSD license' => 'bsd', 1, + 'Artistic license' => 'artistic', 1, + 'GPL' => 'gpl', 1, + 'LGPL' => 'lgpl', 1, + 'BSD' => 'bsd', 1, + 'Artistic' => 'artistic', 1, + 'MIT' => 'mit', 1, + 'proprietary' => 'proprietary', 0, + ); + while ( my ($pattern, $license, $osi) = splice(@phrases, 0, 3) ) { + $pattern =~ s{\s+}{\\s+}g; + if ( $license_text =~ /\b$pattern\b/i ) { + if ( $osi and $license_text =~ /All rights reserved/i ) { + warn "LEGAL WARNING: 'All rights reserved' may invalidate Open Source licenses. Consider removing it."; + } + $self->license($license); + return 1; + } + } + } + + warn "Cannot determine license info from $file\n"; + return 'unknown'; +} + +1; diff --git a/inc/Module/Install/Win32.pm b/inc/Module/Install/Win32.pm new file mode 100644 index 0000000..4f808c7 --- /dev/null +++ b/inc/Module/Install/Win32.pm @@ -0,0 +1,65 @@ +#line 1 +package Module::Install::Win32; + +use strict; +use Module::Install::Base; + +use vars qw{$VERSION $ISCORE @ISA}; +BEGIN { + $VERSION = '0.68'; + $ISCORE = 1; + @ISA = qw{Module::Install::Base}; +} + +# determine if the user needs nmake, and download it if needed +sub check_nmake { + my $self = shift; + $self->load('can_run'); + $self->load('get_file'); + + require Config; + return unless ( + $^O eq 'MSWin32' and + $Config::Config{make} and + $Config::Config{make} =~ /^nmake\b/i and + ! $self->can_run('nmake') + ); + + print "The required 'nmake' executable not found, fetching it...\n"; + + require File::Basename; + my $rv = $self->get_file( + url => 'http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe', + ftp_url => 'ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe', + local_dir => File::Basename::dirname($^X), + size => 51928, + run => 'Nmake15.exe /o > nul', + check_for => 'Nmake.exe', + remove => 1, + ); + + if (!$rv) { + die <<'END_MESSAGE'; + +------------------------------------------------------------------------------- + +Since you are using Microsoft Windows, you will need the 'nmake' utility +before installation. It's available at: + + http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe + or + ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe + +Please download the file manually, save it to a directory in %PATH% (e.g. +C:\WINDOWS\COMMAND\), then launch the MS-DOS command line shell, "cd" to +that directory, and run "Nmake15.exe" from there; that will create the +'nmake.exe' file needed by this module. + +You may then resume the installation process described in README. + +------------------------------------------------------------------------------- +END_MESSAGE + } +} + +1; diff --git a/inc/Module/Install/WriteAll.pm b/inc/Module/Install/WriteAll.pm new file mode 100644 index 0000000..078797c --- /dev/null +++ b/inc/Module/Install/WriteAll.pm @@ -0,0 +1,43 @@ +#line 1 +package Module::Install::WriteAll; + +use strict; +use Module::Install::Base; + +use vars qw{$VERSION $ISCORE @ISA}; +BEGIN { + $VERSION = '0.68'; + $ISCORE = 1; + @ISA = qw{Module::Install::Base}; +} + +sub WriteAll { + my $self = shift; + my %args = ( + meta => 1, + sign => 0, + inline => 0, + check_nmake => 1, + @_ + ); + + $self->sign(1) if $args{sign}; + $self->Meta->write if $args{meta}; + $self->admin->WriteAll(%args) if $self->is_admin; + + if ( $0 =~ /Build.PL$/i ) { + $self->Build->write; + } else { + $self->check_nmake if $args{check_nmake}; + unless ( $self->makemaker_args->{'PL_FILES'} ) { + $self->makemaker_args( PL_FILES => {} ); + } + if ($args{inline}) { + $self->Inline->write; + } else { + $self->Makefile->write; + } + } +} + +1; diff --git a/lib/MooseX/AutoDoc.pm b/lib/MooseX/AutoDoc.pm new file mode 100644 index 0000000..c2b3e1d --- /dev/null +++ b/lib/MooseX/AutoDoc.pm @@ -0,0 +1,318 @@ +package MooseX::AutoDoc; + +use Moose; +use Carp; +use Class::MOP; +use Moose::Meta::Role; +use Moose::Meta::Class; +use Scalar::Util qw/blessed/; + +# Create a special TypeConstraint for the View so you can just set it +# with a class name and it'll DWIM +{ + use Moose::Util::TypeConstraints; + + subtype 'AutoDocView' + => as 'Object' + => where { $_->isa('MooseX::AutoDoc::View') } + => message { "Value should be a subclass of MooseX::AutoDoc::View" } ; + + coerce 'AutoDocView' + => from 'Str' + => via { Class::MOP::load_class($_); $_->new }; + + no Moose::Util::TypeConstraints; +} + +#view object +has view => (is => 'rw', isa => 'AutoDocView', coerce => 1, lazy_build => 1); + +#type constraint library to name mapping to make nice links +has tc_to_lib_map => (is => 'rw', isa => 'HashRef', lazy_build => 1); + +#method metaclasses to ignore to avoid documenting some methods +has ignored_method_metaclasses => (is => 'rw', isa => 'HashRef', lazy_build => 1); + +#defaults to artistic... +has license_text => (is => 'rw', isa => 'Str', lazy_build => 1); + +#how can i get the data about the current user? +has authors => (is => 'rw', isa => 'ArrayRef[HashRef]', + predicate => 'has_authors'); + +sub _build_view { "MooseX::AutoDoc::View::TT" } + +sub _build_tc_to_lib_map { + my %types = map {$_ => 'Moose::Util::TypeConstraints'} + qw/Any Item Bool Undef Defined Value Num Int Str Role Maybe ClassName Ref + ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef FileHandle Object/; + return \ %types; +} + +sub _build_ignored_method_metaclasses { + return { + 'Moose::Meta::Role::Method' => 1, + 'Moose::Meta::Method::Accessor' => 1, + 'Moose::Meta::Method::Constructor' => 1, + 'Class::MOP::Method::Accessor' => 1, + 'Class::MOP::Method::Generated' => 1, + 'Class::MOP::Method::Constructor' => 1, + }; + +# 'Moose::Meta::Method::Overridden' => 1, +# 'Class::MOP::Method::Wrapped' => 1, +} + +sub _build_license_text { + "This library is free software; you can redistribute it and/or modify it " + ."under the same terms as Perl itself."; +} + +#make the actual POD +sub generate_pod_for_role { + my ($self, $role, $view_args) = @_; + + carp("${role} is already loaded. This will cause inacurate output.". + "if ${role} is the consumer of any roles.") + if Class::MOP::is_class_loaded( $role ); + + my $spec = $self->role_info($role); + my $vars = { + role => $spec, + license => $self->license_text, + authors => $self->has_authors ? $self->authors : [], + }; + return $self->view->render_role($vars, $view_args); +} + +#make the actual POD +sub generate_pod_for_class { + my ($self, $class, $view_args) = @_; + + carp("${class} is already loaded. This will cause inacurate output.". + "if ${class} is the consumer of any roles.") + if Class::MOP::is_class_loaded( $class ); + + my $spec = $self->class_info($class); + my $vars = { + class => $spec, + license => $self->license_text, + authors => $self->has_authors ? $self->authors : [], + }; + + return $self->view->render_class($vars, $view_args); +} + + +# *_info methods +sub role_info { + my ($self, $role) = @_; + + my (@roles_to_apply, $rmeta, $original_apply); + { #intercept role application so we can accurately generate + #method and attribute information for the parent class. + #this is fragile, but there is not better way that i am aware of + + $rmeta = Moose::Meta::Role->meta; + $rmeta->make_mutable if $rmeta->is_immutable; + $original_apply = $rmeta->get_method("apply")->body; + $rmeta->remove_method("apply"); + $rmeta->add_method("apply", sub{push(@roles_to_apply, [@_])}); + + eval { Class::MOP::load_class($role); }; + confess "Failed to load class ${role} $@" if $@; + } + + my $meta = $role->meta; + my $anon = Moose::Meta::Class->create_anon_class; + $original_apply->($meta, $anon); + + my @attributes = map{ $anon->get_attribute($_) } sort $anon->get_attribute_list; + + my %ignored_method_metaclasses = %{ $self->ignored_method_metaclasses }; + delete $ignored_method_metaclasses{'Moose::Meta::Role::Method'}; + my @methods = + grep{ ! exists $ignored_method_metaclasses{$_->meta->name} } + map { $anon->get_method($_) } + grep { $_ ne 'meta' } #it wasnt getting filtered on the anon class.. + sort $anon->get_method_list; + my @method_specs = map{ $self->method_info($_) } @methods; + my @attribute_specs = map{ $self->attribute_info($_) } @attributes; + + { #fix Moose::Meta::Role and apply the roles that were delayed + $rmeta->remove_method("apply"); + $rmeta->add_method("apply", $original_apply); + $rmeta->make_immutable; + shift(@$_)->apply(@$_) for @roles_to_apply; + } + + my @roles = + sort{ $a->name cmp $b->name } + map { $_->isa("Moose::Meta::Role::Composite") ? @{$_->get_roles} : $_ } + @{ $meta->get_roles }; + + my @role_specs = map{ $self->consumed_role_info($_) } @roles; + + my $spec = { + name => $meta->name, + roles => \ @role_specs, + methods => \ @method_specs, + attributes => \ @attribute_specs, + }; + + return $spec; +} + + +sub class_info { + my ($self, $class) = @_; + + my (@roles_to_apply, $rmeta, $original_apply); + { #intercept role application so we can accurately generate + #method and attribute information for the parent class. + #this is fragile, but there is not better way that i am aware of + + $rmeta = Moose::Meta::Role->meta; + $rmeta->make_mutable if $rmeta->is_immutable; + $original_apply = $rmeta->get_method("apply")->body; + $rmeta->remove_method("apply"); + $rmeta->add_method("apply", sub{push(@roles_to_apply, [@_])}); + + eval { Class::MOP::load_class($class); }; + confess "Failed to load class ${class} $@" if $@; + } + + my $meta = $class->meta; + + my @attributes = map{ $meta->get_attribute($_) } sort $meta->get_attribute_list; + my @superclasses = map{ $_->meta } + grep { $_ ne 'Moose::Object' } $meta->superclasses; + + my @methods = + grep{ ! exists $self->ignored_method_metaclasses->{$_->meta->name} } + map { $meta->get_method($_) } + grep { $_ ne 'meta' } #it wasnt getting filtered on the anon class.. + sort $meta->get_method_list; + + my @method_specs = map{ $self->method_info($_) } @methods; + my @attribute_specs = map{ $self->attribute_info($_) } @attributes; + my @superclass_specs = map{ $self->superclass_info($_) } @superclasses; + + { #fix Moose::Meta::Role and apply the roles that were delayed + $rmeta->remove_method("apply"); + $rmeta->add_method("apply", $original_apply); + $rmeta->make_immutable; + shift(@$_)->apply(@$_) for @roles_to_apply; + } + + my @roles = sort{ $a->name cmp $b->name } + map { $_->isa("Moose::Meta::Role::Composite") ? @{$_->get_roles} : $_ } + @{ $meta->roles }; + my @role_specs = map{ $self->consumed_role_info($_) } @roles; + + my $spec = { + name => $meta->name, + roles => \ @role_specs, + methods => \ @method_specs, + attributes => \ @attribute_specs, + superclasses => \ @superclass_specs, + }; + + return $spec; +} + +sub attribute_info{ + my($self, $attr) = @_;; + my $attr_name = $attr->name; + my $spec = { name => $attr_name }; + my $info = $spec->{info} = {}; + + $info->{clearer} = $attr->clearer if $attr->has_clearer; + $info->{builder} = $attr->builder if $attr->has_builder; + $info->{predicate} = $attr->predicate if $attr->has_predicate; + + + my $description = $attr->is_required ? 'Required ' : 'Optional '; + if( defined(my $is = $attr->_is_metadata) ){ + $description .= 'read-only ' if $is eq 'ro'; + $description .= 'read-write ' if $is eq 'rw'; + + #If we have 'is' info only write out this info if it != attr_name + $info->{writer} = $attr->writer + if $attr->has_writer && $attr->writer ne $attr_name; + $info->{reader} = $attr->reader + if $attr->has_reader && $attr->reader ne $attr_name; + $info->{accessor} = $attr->accessor + if $attr->has_accessor && $attr->accessor ne $attr_name; + } else { + $info->{writer} = $attr->writer if $attr->has_writer; + $info->{reader} = $attr->reader if $attr->has_reader; + $info->{accessor} = $attr->accessor if $attr->has_accessor; + } + + if( defined(my $lazy = $attr->is_lazy) ){ + $description .= 'lazy-building '; + } + $description .= 'value'; + if( defined(my $isa = $attr->_isa_metadata) ){ + my $link_to; + if( blessed $isa ){ + my $from_type_lib; + while( blessed $isa ){ + $isa = $isa->name; + } + my @parts = split '::', $isa; + my $type_name = pop @parts; + my $type_lib = join "::", @parts; + if(eval{$type_lib->isa("MooseX::Types::Base")}){ + $link_to = $type_lib; + $isa = $type_name; + } + } else { + my ($isa_base) = ($isa =~ /^(.*?)(?:\[.*\])?$/); + if (exists $self->tc_to_lib_map->{$isa_base}){ + $link_to = $self->tc_to_lib_map->{$isa_base}; + } + my $isa = $isa_base; + } + if(defined $link_to){ + $isa = "L<${isa}|${link_to}>"; + } + $description .= " of type ${isa}"; + } + if( $attr->should_auto_deref){ + $description .=" that will be automatically dereferenced by ". + "the reader / accessor"; + } + if( $attr->has_documentation ){ + $description .= "\n\n" . $attr->documentation; + } + $spec->{description} = $description; + + return $spec; +} + +sub superclass_info { + my($self, $superclass) = @_; + my $spec = { name => $superclass->name }; + return $spec; +} + +sub method_info { + my($self, $method) = @_; + my $spec = { name => $method->name }; + return $spec; +} + +sub consumed_role_info { + my($self, $role) = @_;; + my $spec = { name => $role->name }; + return $spec; +} + +1; + +__END__; + + + diff --git a/lib/MooseX/AutoDoc/View.pm b/lib/MooseX/AutoDoc/View.pm new file mode 100644 index 0000000..4c36ebf --- /dev/null +++ b/lib/MooseX/AutoDoc/View.pm @@ -0,0 +1,11 @@ +package MooseX::AutoDoc::View; + +use Moose; + +has args => (is => 'ro', predicate => 'has_args'); + +#twi different methods because it really does make more sense this way +sub render_role { confess "Unimplemented Method"; } +sub render_class { confess "Unimplemented Method"; } + +1; diff --git a/lib/MooseX/AutoDoc/View/TT.pm b/lib/MooseX/AutoDoc/View/TT.pm new file mode 100644 index 0000000..aa46923 --- /dev/null +++ b/lib/MooseX/AutoDoc/View/TT.pm @@ -0,0 +1,351 @@ +package MooseX::AutoDoc::View::TT; + +use Moose; +use Scalar::Util qw/blessed/; +use Template; + +extends 'MooseX::AutoDoc::View'; + +has _tt => (is => 'ro', isa => 'Template', lazy_build => 1); +has '+args' => (isa => 'HashRef'); + +sub _build__tt { + my $self = shift; + Template->new($self->has_args ? $self->args : {}) + || confess $Template::ERROR; +} + +has role_template => (is => 'rw', isa => 'Str', lazy_build => 1); +has class_template => (is => 'rw', isa => 'Str', lazy_build => 1); + +has role_template_blocks => (is => 'rw', isa => 'HashRef', lazy_build => 1); +has class_template_blocks => (is => 'rw', isa => 'HashRef', lazy_build => 1); + +sub _build_role_template { "[% USE wrap; PROCESS role_block; %]" } +sub _build_class_template { "[% USE wrap; PROCESS class_block; %]" } + +sub render_role { + my ($self, $vars, $options) = @_; + my $tt = $self->_tt; + my $output; + my $template = $self->role_template. " ".$self->_role_blocks; + $tt->process(\ $template, $vars, \ $output, %{ $options || {}}) + || confess $tt->error; + return $output; +} + +sub render_class { + my ($self, $vars, $options) = @_; + my $tt = $self->_tt; + my $output; + my $template = $self->class_template. " ".$self->_class_blocks; + $tt->process(\ $template, $vars, \ $output, %{ $options || {}}) + || confess $tt->error; + return $output; +} + + +sub _class_blocks { + my $self= shift; + my $blocks = $self->class_template_blocks; + return join "", + map { " [%- BLOCK ${_} %] ".$blocks->{$_}." [% END; -%] "} + keys %$blocks; +} + +sub _role_blocks { + my $self= shift; + my $blocks = $self->role_template_blocks; + return join "", + map { " [%- BLOCK ${_} %] ".$blocks->{$_}." [% END; -%] "} + keys %$blocks; +} + +1; + +sub _build_class_template_blocks{ + my $blocks = {}; + $blocks->{name_block} = q^ +=head1 NAME + +[% class.name %] +^; + + $blocks->{synopsys_block} = q^ +=head1 SYNOPSYS + + use [% class.name %]; + #TODO + [% class.name %]->new(); +^; + + $blocks->{description_block} = q^ +=head1 DESCRIPTION + +[%- IF class.superclasses.size == 1 %] +[% 'This class is a subclass of L<' _ class.superclasses.first.name _'>' _ +' and inherits all it\'s methods and attributes.' FILTER wrap(80,'','') %] + +[%- ELSIF class.superclasses.size > 1 %] +This class is a subclass of the following classes and inherits all their +methods and attributes; + +=over 4 +[%- FOREACH superclass = class.superclasses %] + +=item L<[% superclass.name %]> +[%- END %] + +=back + +[%- END -%] +^; + + $blocks->{roles_consumed_block} = q^ +[%- IF class.roles.size %] +=head1 ROLES CONSUMED + +The following roles are consumed by this class. Unless otherwise indicated, all +methods, modifiers and attributes present in those roles are applied to this +class. + +=over 4 +[% FOREACH role_consumed = class.roles; + PROCESS role_consumed_block; + END %] +=back +[% END -%] +^; + + $blocks->{role_consumed_block} = q^ +=item L<[% role_consumed.name %]> +^; + + $blocks->{attributes_block} = q^ +[%- IF class.attributes.size %] +=head1 ATTRIBUTES + +Unless noted otherwise, you may set any of these attributes at C time by +passing key / value pairs to C where the key is the name of the attribute +you wish to set. Unless noted otherwise accessor methods for attributes also +share the same name as the attribute. +[% + FOREACH attribute = class.attributes; + PROCESS attribute_block; + END; +END; +-%] +^; + + $blocks->{attribute_block} = q^ +=head2 [% attribute.name %] +[%- IF attribute.info.size %] + +=over 4 +[% FOREACH pair IN attribute.info.pairs %] +=item B<[% pair.key %]> - [% pair.value %] +[% END %] +=back +[%- END; %] + +[% attribute.description FILTER wrap(80, '',''); %] +^; + + $blocks->{methods_block} = q^ +=head1 METHODS + +=head2 new $key => $value + +Instantiate a new object. Please refer to L for a list of valid +key options. +[% + FOREACH method = class.methods; + PROCESS method_block; + END; +%] +=head2 meta + +Retrieve the metaclass instance. Please see L and +L for more information. +^; + + $blocks->{method_block} = q^ +=head2 [% method.name %] + +Description of [% method.name %] +^; + + $blocks->{authors_block} = q^ +=head1 AUTHORS +[% + FOREACH author = authors; + PROCESS author_block; + END; +-%] +^; + + $blocks->{author_block} = q^ +[% +IF author.name.length; author.name _ ' '; END; +IF author.handle.length; '(' _ author.name _ ') '; END; +IF author.email.length; '<' _ author.email _ '>'; END; +%] +^; + + $blocks->{license_block} = q^ +=head1 COPYRIGHT AND LICENSE + +[% license FILTER wrap(80, '', '') %] +^; + + $blocks->{class_block} = q^ +[% +PROCESS name_block; +PROCESS synopsys_block; +PROCESS description_block; +PROCESS roles_consumed_block; +PROCESS attributes_block; +PROCESS methods_block; +PROCESS authors_block; +PROCESS license_block; +%] +=cut +^; + + return $blocks; +} + +sub _build_role_template_blocks{ + my $blocks = {}; + + $blocks->{name_block} = q^ +=head1 NAME + +[% role.name %] +^; + + $blocks->{synopsys_block} = q^ +=head1 SYNOPSYS + + use Moose; + with '[% role.name %]'; +^; + + $blocks->{description_block} = q^ +=head1 DESCRIPTION + +When consumed, this role will apply to the consuming class all the methods, +method modifiers, and attributes it is composed of. +^; + + $blocks->{roles_consumed_block} = q^ +[%- IF role.roles.size %] +=head1 ROLES CONSUMED + +The following roles are consumed by this role. Unless otherwise indicated, all +methods, modifiers and attributes present in those roles will also be applied +to any class or role consuming this role. + +=over 4 +[% FOREACH role_consumed = role.roles; + PROCESS role_consumed_block; + END %] +=back +[% END -%] +^; + + $blocks->{role_consumed_block} = q^ +=item L<[% role_consumed.name %]> +^; + + $blocks->{attributes_block} = q^ +[%- IF role.attributes.size %] +=head1 ATTRIBUTES + +Unless noted otherwise, you may set any of these attributes on consuming +classes at C time by passing key / value pairs to C where the key +is the name of the attribute you wish to set. Unless noted otherwise accessor +methods for attributes also share the same name as the attribute. +[% + FOREACH attribute = role.attributes; + PROCESS attribute_block; + END; +END; +-%] +^; + + $blocks->{attribute_block} = q^ +=head2 [% attribute.name %] +[%- IF attribute.info.size %] + +=over 4 +[% FOREACH pair IN attribute.info.pairs %] +=item B<[% pair.key %]> - [% pair.value %] +[% END %] +=back +[%- END; %] + +[% attribute.description FILTER wrap(80, '',''); %] +^; + + $blocks->{methods_block} = q^ +=head1 METHODS +[% + FOREACH method = role.methods; + PROCESS method_block; + END; +%] +=head2 meta + +Retrieve the role metaclass instance. Please see L; +^; + + $blocks->{method_block} = q^ +=head2 [% method.name %] + +Description of [% method.name %] +^; + + $blocks->{authors_block} = q^ +=head1 AUTHORS +[% + FOREACH author = authors; + PROCESS author_block; + END; +-%] +^; + + $blocks->{author_block} = q^ +[% +IF author.name.length; author.name _ ' '; END; +IF author.handle.length; '(' _ author.name _ ') '; END; +IF author.email.length; '<' _ author.email _ '> '; END; +%] +^; + + $blocks->{license_block} = q^ +=head1 COPYRIGHT AND LICENSE + +[% license FILTER wrap(80, '', '') %] +^; + + $blocks->{role_block} = q^ +[% +PROCESS name_block; +PROCESS synopsys_block; +PROCESS description_block; +PROCESS roles_consumed_block; +PROCESS attributes_block; +PROCESS methods_block; +PROCESS authors_block; +PROCESS license_block; +%] +=cut +^; + + return $blocks; +} + +1; + +__END__; diff --git a/pm_to_blib b/pm_to_blib new file mode 100644 index 0000000..e69de29 diff --git a/t/000-load.t b/t/000-load.t new file mode 100644 index 0000000..6166e3c --- /dev/null +++ b/t/000-load.t @@ -0,0 +1,11 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use Test::More tests => 3; + +BEGIN { + use_ok( 'MooseX::AutoDoc' ); + use_ok( 'MooseX::AutoDoc::View' ); + use_ok( 'MooseX::AutoDoc::View::TT' ); +} diff --git a/t/001-basic.t b/t/001-basic.t new file mode 100644 index 0000000..f252108 --- /dev/null +++ b/t/001-basic.t @@ -0,0 +1,29 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use MooseX::AutoDoc; +use FindBin '$Bin'; +use lib "$Bin/lib"; + +use Test::More tests => 6; + +BEGIN{ + use_ok("AutoDocTest1"); +} + +ok( + defined(my $autodoc = eval {MooseX::AutoDoc->new}), + "Was instantiated successfully" + ); +die "Failed to instantiate MooseX::AutoDoc" unless $autodoc; + +ok( + defined(my $view = eval {$autodoc->view}), + "Was instantiated successfully" + ); +die "Failed to instantiate MooseX::AutoDoc::View::TT" unless $view; +can_ok $view, "render_class", "render_role"; + +ok length($view->role_template), "Role template appears to have been loaded successfully"; +ok length($view->class_template), "Class template appears to have been loaded successfully"; diff --git a/t/002-attributes.t b/t/002-attributes.t new file mode 100644 index 0000000..07e90e1 --- /dev/null +++ b/t/002-attributes.t @@ -0,0 +1,120 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use MooseX::AutoDoc; +use FindBin '$Bin'; +use lib "$Bin/lib"; + +use Test::More tests => 7; +use AutoDocTest1; + +my $autodoc = MooseX::AutoDoc->new; +my $meta = AutoDocTest1->meta; +my %attributes = map { $_ => $meta->get_attribute($_) } + $meta->get_attribute_list; + +#attr 1 +{ + my $target = + { + name => 'attr1', + info => {}, + description => 'Optional read-only value' + }; + + my $spec = $autodoc->attribute_info($attributes{attr1}); + + is_deeply($spec, $target); +} + +#attr 2 +{ + my $target = + { + name => 'attr2', + info => {}, + description => 'Optional read-write value of type L' + }; + + my $spec = $autodoc->attribute_info($attributes{attr2}); + + is_deeply($spec, $target); +} + +#attr 3 +{ + my $target = + { + 'info' => {}, + 'name' => 'attr3', + 'description' => 'Optional read-write value of type L' + }; + + my $spec = $autodoc->attribute_info($attributes{attr3}); + + is_deeply($spec, $target); +} + +#attr 4 +{ + my $target = + { + 'info' => {}, + 'name' => 'attr4', + 'description' => 'Required read-write value of type L' + }; + + my $spec = $autodoc->attribute_info($attributes{attr4}); + + is_deeply($spec, $target); +} + +#attr 5 +{ + my $target = + { + 'info' => {}, + 'name' => 'attr5', + 'description' => 'Required read-write value of type L that will be automatically dereferenced by the reader / accessor' + }; + + my $spec = $autodoc->attribute_info($attributes{attr5}); + + is_deeply($spec, $target); +} + +#attr 6 +{ + my $target = + { + 'info' => { + 'predicate' => 'has_attr6', + 'builder' => '_build_attr6', + 'clearer' => 'clear_attr6' + }, + 'name' => 'attr6', + 'description' => 'Required read-write lazy-building value' + }; + + my $spec = $autodoc->attribute_info($attributes{attr6}); + + is_deeply($spec, $target); +} + +#attr 7 +{ + my $target = + { + 'info' => { + 'reader' => 'attr7', + 'writer' => '_attr7' + }, + 'name' => 'attr7', + 'description' => 'Optional value' + }; + + my $spec = $autodoc->attribute_info($attributes{attr7}); + + is_deeply($spec, $target); +} diff --git a/t/003-moosex-types.t b/t/003-moosex-types.t new file mode 100644 index 0000000..b30dcc6 --- /dev/null +++ b/t/003-moosex-types.t @@ -0,0 +1,26 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use MooseX::AutoDoc; +use FindBin '$Bin'; +use lib "$Bin/lib"; + +use Test::More; +use Class::MOP; + +my $has_mx_types = eval { Class::MOP::load_class("MooseX::Types"); }; +unless($has_mx_types) { + plan skip_all => 'MooseX::Types is required for this test'; + exit; +} + +Class::MOP::load_class("AutoDocTest7"); +plan tests => 1; +my $autodoc = MooseX::AutoDoc->new; +my $attr = AutoDocTest7->meta->get_attribute("typed_attr"); +my $spec = $autodoc->attribute_info($attr); +my $target = 'Optional value of type L{description}, qr/$target/; + diff --git a/t/100-class.t b/t/100-class.t new file mode 100644 index 0000000..4357657 --- /dev/null +++ b/t/100-class.t @@ -0,0 +1,22 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use MooseX::AutoDoc; +use FindBin '$Bin'; +use lib "$Bin/lib"; +use Test::More tests => 1; + +my $autodoc = MooseX::AutoDoc->new; +my $spec = $autodoc->class_info("AutoDocTest1"); + +#we already tested this.. +delete $spec->{attributes}; + +my $target = { + name => 'AutoDocTest1', + roles => [], + superclasses => [], + methods => [{ name => 'bar'},{ name => 'foo'}], + }; +is_deeply($target, $spec); diff --git a/t/101-class.t b/t/101-class.t new file mode 100644 index 0000000..fb6e197 --- /dev/null +++ b/t/101-class.t @@ -0,0 +1,26 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use MooseX::AutoDoc; +use FindBin '$Bin'; +use lib "$Bin/lib"; + +use Test::More tests => 1; + +my $autodoc = MooseX::AutoDoc->new; +my $spec = $autodoc->class_info("AutoDocTest2"); + +my $target = { + name => 'AutoDocTest2', + roles => [], + superclasses => [{name => 'AutoDocTest1'}], + methods => [{ name => 'bar'}], + attributes => + [{ + info => {'reader' => 'attr8', 'writer' => '_attr8'}, + description => 'Optional value', + name => 'attr8', + }] + }; +is_deeply($target, $spec); diff --git a/t/102-class.t b/t/102-class.t new file mode 100644 index 0000000..b003edf --- /dev/null +++ b/t/102-class.t @@ -0,0 +1,21 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use MooseX::AutoDoc; +use FindBin '$Bin'; +use lib "$Bin/lib"; +use Test::More tests => 1; + +my $autodoc = MooseX::AutoDoc->new; +my $spec = $autodoc->class_info("AutoDocTest3"); + +my $target = { + name => 'AutoDocTest3', + roles => [ { name => 'AutoDocTest::Role::Role1' } ], + superclasses => [{name => 'AutoDocTest2'}], + methods => [], + attributes => [], + }; + +is_deeply($target, $spec); diff --git a/t/103-class.t b/t/103-class.t new file mode 100644 index 0000000..afb0999 --- /dev/null +++ b/t/103-class.t @@ -0,0 +1,27 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use MooseX::AutoDoc; +use FindBin '$Bin'; +use lib "$Bin/lib"; +use Test::More tests => 1; + +my $autodoc = MooseX::AutoDoc->new; +my $spec = $autodoc->class_info("AutoDocTest4"); + +my $target = { + name => 'AutoDocTest4', + roles => [ + { name => 'AutoDocTest::Role::Role1'} , + { name => 'AutoDocTest::Role::Role2' } + ], + superclasses => [ + {name => 'AutoDocTest4BaseA'}, + {name => 'AutoDocTest4BaseB'} + ], + methods => [], + attributes => [] + }; + +is_deeply($target, $spec); diff --git a/t/104-class.t b/t/104-class.t new file mode 100644 index 0000000..b87a4dd --- /dev/null +++ b/t/104-class.t @@ -0,0 +1,21 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use MooseX::AutoDoc; +use FindBin '$Bin'; +use lib "$Bin/lib"; +use Test::More tests => 1; + +my $autodoc = MooseX::AutoDoc->new; +my $spec = $autodoc->class_info("AutoDocTest5"); + +my $target = { + name => 'AutoDocTest5', + roles => [], + superclasses => [{name => 'AutoDocTest3'}], + methods => [], + attributes => [], + }; + +is_deeply($target, $spec); diff --git a/t/105-class.t b/t/105-class.t new file mode 100644 index 0000000..92c9c1b --- /dev/null +++ b/t/105-class.t @@ -0,0 +1,21 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use MooseX::AutoDoc; +use FindBin '$Bin'; +use lib "$Bin/lib"; +use Test::More tests => 1; + +my $autodoc = MooseX::AutoDoc->new; +my $spec = $autodoc->class_info("AutoDocTest6"); + +my $target = { + name => 'AutoDocTest6', + roles => [{ name => 'AutoDocTest::Role::Role3'}], + superclasses => [], + methods => [], + attributes => [], + }; + +is_deeply($target, $spec); diff --git a/t/200-role.t b/t/200-role.t new file mode 100644 index 0000000..0e50f44 --- /dev/null +++ b/t/200-role.t @@ -0,0 +1,25 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use MooseX::AutoDoc; +use FindBin '$Bin'; +use lib "$Bin/lib"; +use Test::More tests => 1; + +my $autodoc = MooseX::AutoDoc->new; +my $spec = $autodoc->role_info("AutoDocTest::Role::Role1"); + +my $target = { + name => 'AutoDocTest::Role::Role1', + roles => [], + methods => [{ name => 'role_1'}], + attributes => [ + { + name => 'role_1_attr', + info => {}, + description => 'Optional read-write value' + }, + ], + }; +is_deeply($target, $spec); diff --git a/t/201-role.t b/t/201-role.t new file mode 100644 index 0000000..18b5c22 --- /dev/null +++ b/t/201-role.t @@ -0,0 +1,25 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use MooseX::AutoDoc; +use FindBin '$Bin'; +use lib "$Bin/lib"; +use Test::More tests => 1; + +my $autodoc = MooseX::AutoDoc->new; +my $spec = $autodoc->role_info("AutoDocTest::Role::Role2"); + +my $target = { + name => 'AutoDocTest::Role::Role2', + roles => [], + methods => [{ name => 'role_2'}], + attributes => [ + { + name => 'role_2_attr', + info => {}, + description => 'Optional read-write value' + }, + ], + }; +is_deeply($target, $spec); diff --git a/t/202-role.t b/t/202-role.t new file mode 100644 index 0000000..e070193 --- /dev/null +++ b/t/202-role.t @@ -0,0 +1,28 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use MooseX::AutoDoc; +use FindBin '$Bin'; +use lib "$Bin/lib"; +use Test::More tests => 1; + +my $autodoc = MooseX::AutoDoc->new; +my $spec = $autodoc->role_info("AutoDocTest::Role::Role3"); + +my $target = { + name => 'AutoDocTest::Role::Role3', + roles => [ + {name => 'AutoDocTest::Role::Role1',}, + {name => 'AutoDocTest::Role::Role2',} + ], + methods => [{ name => 'role_3'}], + attributes => [ + { + name => 'role_3_attr', + info => {}, + description => 'Optional read-write value' + }, + ], + }; +is_deeply($target, $spec); diff --git a/t/lib/AutoDocTest/Role/Role1.pm b/t/lib/AutoDocTest/Role/Role1.pm new file mode 100644 index 0000000..1f5b07e --- /dev/null +++ b/t/lib/AutoDocTest/Role/Role1.pm @@ -0,0 +1,10 @@ +package AutoDocTest::Role::Role1; + +use Moose::Role; +has role_1_attr => (is => 'rw'); + +sub role_1{ + +} + +1; diff --git a/t/lib/AutoDocTest/Role/Role2.pm b/t/lib/AutoDocTest/Role/Role2.pm new file mode 100644 index 0000000..0c98709 --- /dev/null +++ b/t/lib/AutoDocTest/Role/Role2.pm @@ -0,0 +1,10 @@ +package AutoDocTest::Role::Role2; + +use Moose::Role; +has role_2_attr => (is => 'rw'); + +sub role_2{ + +} + +1; diff --git a/t/lib/AutoDocTest/Role/Role3.pm b/t/lib/AutoDocTest/Role/Role3.pm new file mode 100644 index 0000000..37592c5 --- /dev/null +++ b/t/lib/AutoDocTest/Role/Role3.pm @@ -0,0 +1,13 @@ +package AutoDocTest::Role::Role3; + +use Moose::Role; + +with 'AutoDocTest::Role::Role1', 'AutoDocTest::Role::Role2'; + +has role_3_attr => (is => 'rw'); + +sub role_3{ + +} + +1; diff --git a/t/lib/AutoDocTest1.pm b/t/lib/AutoDocTest1.pm new file mode 100644 index 0000000..1fd979c --- /dev/null +++ b/t/lib/AutoDocTest1.pm @@ -0,0 +1,21 @@ +package AutoDocTest1; + +use Moose; + +has attr1 => (is => 'ro'); +has attr2 => (is => 'rw', isa => 'HashRef'); +has attr3 => (is => 'rw', isa => 'ArrayRef[Str]'); +has attr4 => (is => 'rw', isa => 'ArrayRef[Str]', required => 1); +has attr5 => (is => 'rw', isa => 'ArrayRef[Str]', required => 1, auto_deref => 1); +has attr6 => (is => 'rw', lazy_build => 1); +has attr7 => (reader => 'attr7', writer => '_attr7'); + +sub foo { + +} + +sub bar { + +} + +1; diff --git a/t/lib/AutoDocTest2.pm b/t/lib/AutoDocTest2.pm new file mode 100644 index 0000000..30b4052 --- /dev/null +++ b/t/lib/AutoDocTest2.pm @@ -0,0 +1,13 @@ +package AutoDocTest2; + +use Moose; + +extends 'AutoDocTest1'; + +has attr8 => (reader => 'attr8', writer => '_attr8'); + +override bar => sub { + +}; + +1; diff --git a/t/lib/AutoDocTest3.pm b/t/lib/AutoDocTest3.pm new file mode 100644 index 0000000..00b3360 --- /dev/null +++ b/t/lib/AutoDocTest3.pm @@ -0,0 +1,9 @@ +package AutoDocTest3; + +use Moose; + +extends 'AutoDocTest2'; + +with 'AutoDocTest::Role::Role1'; + +1; diff --git a/t/lib/AutoDocTest4.pm b/t/lib/AutoDocTest4.pm new file mode 100644 index 0000000..73dbe53 --- /dev/null +++ b/t/lib/AutoDocTest4.pm @@ -0,0 +1,16 @@ +package AutoDocTest4; +use Moose; + +extends 'AutoDocTest4BaseA','AutoDocTest4BaseB'; + +with 'AutoDocTest::Role::Role1', 'AutoDocTest::Role::Role2'; + +package AutoDocTest4BaseA; +use Moose; + +1; + +package AutoDocTest4BaseB; +use Moose; + +1; diff --git a/t/lib/AutoDocTest5.pm b/t/lib/AutoDocTest5.pm new file mode 100644 index 0000000..93375e0 --- /dev/null +++ b/t/lib/AutoDocTest5.pm @@ -0,0 +1,7 @@ +package AutoDocTest5; + +use Moose; + +extends 'AutoDocTest3'; + +1; diff --git a/t/lib/AutoDocTest6.pm b/t/lib/AutoDocTest6.pm new file mode 100644 index 0000000..e5fcf52 --- /dev/null +++ b/t/lib/AutoDocTest6.pm @@ -0,0 +1,7 @@ +package AutoDocTest6; + +use Moose; + +with 'AutoDocTest::Role::Role3'; + +1; diff --git a/t/lib/AutoDocTest7.pm b/t/lib/AutoDocTest7.pm new file mode 100644 index 0000000..d2807e0 --- /dev/null +++ b/t/lib/AutoDocTest7.pm @@ -0,0 +1,8 @@ +package AutoDocTest7; + +use Moose; +use AutoDocTestTypes qw( TestType ); + +has typed_attr => (isa => TestType); + +1; diff --git a/t/lib/AutoDocTestTypes.pm b/t/lib/AutoDocTestTypes.pm new file mode 100644 index 0000000..7826512 --- /dev/null +++ b/t/lib/AutoDocTestTypes.pm @@ -0,0 +1,11 @@ +package AutoDocTestTypes; + +use MooseX::Types -declare => [qw( TestType )]; +use MooseX::Types::Moose 'Object'; + +# type definition +subtype TestType, + as Object, + where { 1 }; + +1;