Legoktm has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/405914 )
Change subject: Initial commit
......................................................................
Initial commit
Bug: T147167
Change-Id: I94630c5b587b98b48ae66ce455f2480407955732
---
A .editorconfig
A .gitattributes
A .gitignore
A .phpcs.xml
A .travis.yml
A CODE_OF_CONDUCT.md
A COPYING
A Doxyfile
A composer.json
A phpunit.xml.dist
A src/ObjectFactory.php
A tests/ObjectFactoryTest.php
12 files changed, 854 insertions(+), 0 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/libs/ObjectFactory refs/changes/14/405914/1
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..c2dfc46
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,6 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = tab
+indent_size = tab
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..749e6a3
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,10 @@
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.gitreview export-ignore
+.travis.yml export-ignore
+Doxyfile export-ignore
+composer.json export-ignore
+.phpcs.xml export-ignore
+phpunit.xml.dist export-ignore
+tests/ export-ignore
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..11a1c3a
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,5 @@
+/coverage
+/doc
+/vendor
+/composer.lock
+/.idea
diff --git a/.phpcs.xml b/.phpcs.xml
new file mode 100644
index 0000000..851e890
--- /dev/null
+++ b/.phpcs.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset>
+ <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki"/>
+ <file>.</file>
+ <arg name="encoding" value="UTF-8"/>
+ <arg name="extensions" value="php"/>
+ <exclude-pattern>coverage</exclude-pattern>
+ <exclude-pattern>vendor</exclude-pattern>
+ <exclude-pattern>doc/html</exclude-pattern>
+</ruleset>
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..446a8da
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,12 @@
+sudo: false
+language: php
+php:
+ - "5.5"
+ - "5.6"
+ - "7.0"
+ - "7.1"
+ - "hhvm"
+install:
+ - composer install
+script:
+- composer test
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..7815dda
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,2 @@
+The development of this software is covered by a [Code of Conduct](https://www.mediawiki.org/wiki/Code_of_Conduct).
+
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..fac0fee
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,341 @@
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
+
diff --git a/Doxyfile b/Doxyfile
new file mode 100644
index 0000000..85d7730
--- /dev/null
+++ b/Doxyfile
@@ -0,0 +1,26 @@
+# Doxyfile for ObjectFactory
+#
+# See <http://www.stack.nl/~dimitri/doxygen/manual/config.html>
+# for help on how to use this file to configure Doxygen.
+
+PROJECT_NAME = "ObjectFactory"
+PROJECT_BRIEF = "Construct objects from configuration instructions"
+OUTPUT_DIRECTORY = doc
+JAVADOC_AUTOBRIEF = YES
+QT_AUTOBRIEF = YES
+WARN_NO_PARAMDOC = YES
+INPUT = README.md src/
+FILE_PATTERNS = *.php
+RECURSIVE = YES
+USE_MDFILE_AS_MAINPAGE = README.md
+HTML_DYNAMIC_SECTIONS = YES
+GENERATE_TREEVIEW = YES
+TREEVIEW_WIDTH = 250
+GENERATE_LATEX = NO
+HAVE_DOT = YES
+DOT_FONTNAME = Helvetica
+DOT_FONTSIZE = 10
+TEMPLATE_RELATIONS = YES
+CALL_GRAPH = NO
+CALLER_GRAPH = NO
+DOT_MULTI_TARGETS = YES
diff --git a/composer.json b/composer.json
new file mode 100644
index 0000000..655bde7
--- /dev/null
+++ b/composer.json
@@ -0,0 +1,37 @@
+{
+ "name": "wikimedia/object-factory",
+ "description": "Construct objects from configuration instructions",
+ "license": "GPL-2.0+",
+ "homepage": "https://www.mediawiki.org/wiki/ObjectFactory",
+ "authors": [.
+ {
+ "name": "Bryan Davis",
+ "email": "bdavis@wikimedia.org"
+ }
+ ],
+ "autoload": {
+ "classmap": ["src/"]
+ },
+ "require": {
+ "php": ">=5.5.9"
+ },
+ "require-dev": {
+ "jakub-onderka/php-parallel-lint": "0.9.2",
+ "jakub-onderka/php-console-highlighter": "0.3.2",
+ "mediawiki/mediawiki-codesniffer": "15.0.0",
+ "mediawiki/minus-x": "0.2.1",
+ "phpunit/phpunit": "4.8.36"
+ },
+ "scripts": {
+ "test": [.
+ "parallel-lint . --exclude vendor",
+ "phpunit",
+ "phpcs -sp",
+ "minus-x check ."
+ ],
+ "fix": [
+ "phpcbf",
+ "minus-x fix ."
+ ]
+ }
+}
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
new file mode 100644
index 0000000..f9881af
--- /dev/null
+++ b/phpunit.xml.dist
@@ -0,0 +1,14 @@
+<phpunit colors="true"
+ beStrictAboutTestsThatDoNotTestAnything="true"
+ beStrictAboutOutputDuringTests="true">
+ <testsuites>
+ <testsuite name="ObjectFactory Tests">
+ <directory>./tests</directory>
+ </testsuite>
+ </testsuites>
+ <filter>
+ <whitelist addUncoveredFilesFromWhitelist="true">
+ <directory suffix=".php">./src</directory>
+ </whitelist>
+ </filter>
+</phpunit>
diff --git a/src/ObjectFactory.php b/src/ObjectFactory.php
new file mode 100644
index 0000000..08c2462
--- /dev/null
+++ b/src/ObjectFactory.php
@@ -0,0 +1,205 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+namespace Wikimedia;
+
+use Closure;
+use InvalidArgumentException;
+use ReflectionClass;
+use ReflectionException;
+
+/**
+ * Construct objects from configuration instructions.
+ *
+ * @copyright © 2014 Wikimedia Foundation and contributors
+ */
+class ObjectFactory {
+
+ /**
+ * Instantiate an object based on a specification array.
+ *
+ * The specification array must contain a 'class' key with string value
+ * that specifies the class name to instantiate or a 'factory' key with
+ * a callable (is_callable() === true). It can optionally contain
+ * an 'args' key that provides arguments to pass to the
+ * constructor/callable.
+ *
+ * Values in the arguments collection which are Closure instances will be
+ * expanded by invoking them with no arguments before passing the
+ * resulting value on to the constructor/callable. This can be used to
+ * pass IDatabase instances or other live objects to the
+ * constructor/callable. This behavior can be suppressed by adding
+ * closure_expansion => false to the specification.
+ *
+ * The specification may also contain a 'calls' key that describes method
+ * calls to make on the newly created object before returning it. This
+ * pattern is often known as "setter injection". The value of this key is
+ * expected to be an associative array with method names as keys and
+ * argument lists as values. The argument list will be expanded (or not)
+ * in the same way as the 'args' key for the main object.
+ *
+ * @param array $spec Object specification
+ * @return object
+ * @throws InvalidArgumentException when object specification does not
+ * contain 'class' or 'factory' keys
+ * @throws ReflectionException when 'args' are supplied and 'class'
+ * constructor is non-public or non-existent
+ */
+ public static function getObjectFromSpec( $spec ) {
+ $args = isset( $spec['args'] ) ? $spec['args'] : [];
+ $expandArgs = !isset( $spec['closure_expansion'] ) ||
+ $spec['closure_expansion'] === true;
+
+ if ( $expandArgs ) {
+ $args = static::expandClosures( $args );
+ }
+
+ if ( isset( $spec['class'] ) ) {
+ $clazz = $spec['class'];
+ if ( !$args ) {
+ $obj = new $clazz();
+ } else {
+ $obj = static::constructClassInstance( $clazz, $args );
+ }
+ } elseif ( isset( $spec['factory'] ) ) {
+ $obj = call_user_func_array( $spec['factory'], $args );
+ } else {
+ throw new InvalidArgumentException(
+ 'Provided specification lacks both factory and class parameters.'
+ );
+ }
+
+ if ( isset( $spec['calls'] ) && is_array( $spec['calls'] ) ) {
+ // Call additional methods on the newly created object
+ foreach ( $spec['calls'] as $method => $margs ) {
+ if ( $expandArgs ) {
+ $margs = static::expandClosures( $margs );
+ }
+ call_user_func_array( [ $obj, $method ], $margs );
+ }
+ }
+
+ return $obj;
+ }
+
+ /**
+ * Iterate a list and call any closures it contains.
+ *
+ * @param array $list List of things
+ * @return array List with any Closures replaced with their output
+ */
+ protected static function expandClosures( $list ) {
+ return array_map( function ( $value ) {
+ if ( is_object( $value ) && $value instanceof Closure ) {
+ // If $value is a Closure, call it.
+ return $value();
+ } else {
+ return $value;
+ }
+ }, $list );
+ }
+
+ /**
+ * Construct an instance of the given class using the given arguments.
+ *
+ * PHP's `call_user_func_array()` doesn't work with object construction so
+ * we have to use other measures. Starting with PHP 5.6.0 we could use the
+ * "splat" operator (`...`) to unpack the array into an argument list.
+ * Sadly there is no way to conditionally include a syntax construct like
+ * a new operator in a way that allows older versions of PHP to still
+ * parse the file. Instead, we will try a loop unrolling technique that
+ * works for 0-10 arguments. If we are passed 11 or more arguments we will
+ * take the performance penalty of using
+ * `ReflectionClass::newInstanceArgs()` to construct the desired object.
+ *
+ * @param string $clazz Class name
+ * @param array $args Constructor arguments
+ * @return mixed Constructed instance
+ */
+ public static function constructClassInstance( $clazz, $args ) {
+ // $args should be a non-associative array; show nice error if that's not the case
+ if ( $args && array_keys( $args ) !== range( 0, count( $args ) - 1 ) ) {
+ throw new InvalidArgumentException( __METHOD__ . ': $args cannot be an associative array' );
+ }
+
+ // TODO: when PHP min version supported is >=5.6.0 replace this
+ // with `return new $clazz( ... $args );`.
+ $obj = null;
+ switch ( count( $args ) ) {
+ case 0:
+ $obj = new $clazz();
+ break;
+ case 1:
+ $obj = new $clazz( $args[0] );
+ break;
+ case 2:
+ $obj = new $clazz( $args[0], $args[1] );
+ break;
+ case 3:
+ $obj = new $clazz( $args[0], $args[1], $args[2] );
+ break;
+ case 4:
+ $obj = new $clazz( $args[0], $args[1], $args[2], $args[3] );
+ break;
+ case 5:
+ $obj = new $clazz(
+ $args[0], $args[1], $args[2], $args[3], $args[4]
+ );
+ break;
+ case 6:
+ $obj = new $clazz(
+ $args[0], $args[1], $args[2], $args[3], $args[4],
+ $args[5]
+ );
+ break;
+ case 7:
+ $obj = new $clazz(
+ $args[0], $args[1], $args[2], $args[3], $args[4],
+ $args[5], $args[6]
+ );
+ break;
+ case 8:
+ $obj = new $clazz(
+ $args[0], $args[1], $args[2], $args[3], $args[4],
+ $args[5], $args[6], $args[7]
+ );
+ break;
+ case 9:
+ $obj = new $clazz(
+ $args[0], $args[1], $args[2], $args[3], $args[4],
+ $args[5], $args[6], $args[7], $args[8]
+ );
+ break;
+ case 10:
+ $obj = new $clazz(
+ $args[0], $args[1], $args[2], $args[3], $args[4],
+ $args[5], $args[6], $args[7], $args[8], $args[9]
+ );
+ break;
+ default:
+ // Fall back to using ReflectionClass and curse the developer
+ // who decided that 11+ args was a reasonable method
+ // signature.
+ $ref = new ReflectionClass( $clazz );
+ $obj = $ref->newInstanceArgs( $args );
+ }
+ return $obj;
+ }
+}
diff --git a/tests/ObjectFactoryTest.php b/tests/ObjectFactoryTest.php
new file mode 100644
index 0000000..99890dc
--- /dev/null
+++ b/tests/ObjectFactoryTest.php
@@ -0,0 +1,186 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+namespace Wikimedia\Test;
+
+use Closure;
+use Wikimedia\ObjectFactory;
+use PHPUnit_Framework_TestCase;
+
+class ObjectFactoryTest extends PHPUnit_Framework_TestCase {
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::getObjectFromSpec
+ */
+ public function testClosureExpansionDisabled() {
+ $obj = ObjectFactory::getObjectFromSpec( [.
+ 'class' => ObjectFactoryTestFixture::class,
+ 'args' => [.
+ function () {
+ return 'wrapped';
+ },
+ 'unwrapped',
+ ],
+ 'calls' => [.
+ 'setter' => [ function () {
+ return 'wrapped';
+ }, ],
+ ],
+ 'closure_expansion' => false,
+ ] );
+ $this->assertInstanceOf( Closure::class, $obj->args[0] );
+ $this->assertSame( 'wrapped', $obj->args[0]() );
+ $this->assertSame( 'unwrapped', $obj->args[1] );
+ $this->assertInstanceOf( Closure::class, $obj->setterArgs[0] );
+ $this->assertSame( 'wrapped', $obj->setterArgs[0]() );
+ }
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::getObjectFromSpec
+ * @covers \Wikimedia\ObjectFactory::expandClosures
+ */
+ public function testClosureExpansionEnabled() {
+ $obj = ObjectFactory::getObjectFromSpec( [.
+ 'class' => ObjectFactoryTestFixture::class,
+ 'args' => [.
+ function () {
+ return 'wrapped';
+ },
+ 'unwrapped',
+ ],
+ 'calls' => [.
+ 'setter' => [ function () {
+ return 'wrapped';
+ }, ],
+ ],
+ 'closure_expansion' => true,
+ ] );
+ $this->assertInternalType( 'string', $obj->args[0] );
+ $this->assertSame( 'wrapped', $obj->args[0] );
+ $this->assertSame( 'unwrapped', $obj->args[1] );
+ $this->assertInternalType( 'string', $obj->setterArgs[0] );
+ $this->assertSame( 'wrapped', $obj->setterArgs[0] );
+
+ $obj = ObjectFactory::getObjectFromSpec( [.
+ 'class' => ObjectFactoryTestFixture::class,
+ 'args' => [ function () {
+ return 'unwrapped';
+ }, ],
+ 'calls' => [.
+ 'setter' => [ function () {
+ return 'unwrapped';
+ }, ],
+ ],
+ ] );
+ $this->assertInternalType( 'string', $obj->args[0] );
+ $this->assertSame( 'unwrapped', $obj->args[0] );
+ $this->assertInternalType( 'string', $obj->setterArgs[0] );
+ $this->assertSame( 'unwrapped', $obj->setterArgs[0] );
+ }
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::getObjectFromSpec
+ */
+ public function testGetObjectFromFactory() {
+ $args = [ 'a', 'b' ];
+ $obj = ObjectFactory::getObjectFromSpec( [.
+ 'factory' => function ( $a, $b ) {
+ return new ObjectFactoryTestFixture( $a, $b );
+ },
+ 'args' => $args,
+ ] );
+ $this->assertSame( $args, $obj->args );
+ }
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::getObjectFromSpec
+ * @expectedException \InvalidArgumentException
+ */
+ public function testGetObjectFromInvalid() {
+ $args = [ 'a', 'b' ];
+ $obj = ObjectFactory::getObjectFromSpec( [.
+ // Missing 'class' or 'factory'
+ 'args' => $args,
+ ] );
+ }
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::getObjectFromSpec
+ * @dataProvider provideConstructClassInstance
+ */
+ public function testGetObjectFromClass( $args ) {
+ $obj = ObjectFactory::getObjectFromSpec( [
+ 'class' => ObjectFactoryTestFixture::class,
+ 'args' => $args,
+ ] );
+ $this->assertSame( $args, $obj->args );
+ }
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::constructClassInstance
+ * @dataProvider provideConstructClassInstance
+ */
+ public function testConstructClassInstance( $args ) {
+ $obj = ObjectFactory::constructClassInstance(
+ ObjectFactoryTestFixture::class, $args
+ );
+ $this->assertSame( $args, $obj->args );
+ }
+
+ public static function provideConstructClassInstance() {
+ // These args go to 11. I thought about making 10 one louder, but 11!
+ return [
+ '0 args' => [ [] ],
+ '1 args' => [ [ 1, ] ],
+ '2 args' => [ [ 1, 2, ] ],
+ '3 args' => [ [ 1, 2, 3, ] ],
+ '4 args' => [ [ 1, 2, 3, 4, ] ],
+ '5 args' => [ [ 1, 2, 3, 4, 5, ] ],
+ '6 args' => [ [ 1, 2, 3, 4, 5, 6, ] ],
+ '7 args' => [ [ 1, 2, 3, 4, 5, 6, 7, ] ],
+ '8 args' => [ [ 1, 2, 3, 4, 5, 6, 7, 8, ] ],
+ '9 args' => [. [ 1, 2, 3, 4, 5, 6, 7, 8, 9, ] ],
+ '10 args' => [. [. 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ] ],
+ '11 args' => [. [. 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, ] ],
+ ];
+ }
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::constructClassInstance
+ * @expectedException \InvalidArgumentException
+ */
+ public function testNamedArgs() {
+ $args = [ 'foo' => 1, 'bar' => 2, 'baz' => 3 ];
+ $obj = ObjectFactory::constructClassInstance(
+ ObjectFactoryTestFixture::class, $args
+ );
+ }
+}
+
+class ObjectFactoryTestFixture {
+ public $args;
+ public $setterArgs;
+ public function __construct( /*...*/ ) {
+ $this->args = func_get_args();
+ }
+ public function setter( /*...*/ ) {
+ $this->setterArgs = func_get_args();
+ }
+}
--
To view, visit https://gerrit.wikimedia.org/r/405914
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I94630c5b587b98b48ae66ce455f2480407955732
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/libs/ObjectFactory
Gerrit-Branch: master
Gerrit-Owner: Legoktm <legoktm@member.fsf.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
Change subject: Initial commit
......................................................................
Initial commit
Bug: T147167
Change-Id: I94630c5b587b98b48ae66ce455f2480407955732
---
A .editorconfig
A .gitattributes
A .gitignore
A .phpcs.xml
A .travis.yml
A CODE_OF_CONDUCT.md
A COPYING
A Doxyfile
A composer.json
A phpunit.xml.dist
A src/ObjectFactory.php
A tests/ObjectFactoryTest.php
12 files changed, 854 insertions(+), 0 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/libs/ObjectFactory refs/changes/14/405914/1
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..c2dfc46
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,6 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = tab
+indent_size = tab
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..749e6a3
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,10 @@
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.gitreview export-ignore
+.travis.yml export-ignore
+Doxyfile export-ignore
+composer.json export-ignore
+.phpcs.xml export-ignore
+phpunit.xml.dist export-ignore
+tests/ export-ignore
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..11a1c3a
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,5 @@
+/coverage
+/doc
+/vendor
+/composer.lock
+/.idea
diff --git a/.phpcs.xml b/.phpcs.xml
new file mode 100644
index 0000000..851e890
--- /dev/null
+++ b/.phpcs.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset>
+ <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki"/>
+ <file>.</file>
+ <arg name="encoding" value="UTF-8"/>
+ <arg name="extensions" value="php"/>
+ <exclude-pattern>coverage</exclude-pattern>
+ <exclude-pattern>vendor</exclude-pattern>
+ <exclude-pattern>doc/html</exclude-pattern>
+</ruleset>
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..446a8da
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,12 @@
+sudo: false
+language: php
+php:
+ - "5.5"
+ - "5.6"
+ - "7.0"
+ - "7.1"
+ - "hhvm"
+install:
+ - composer install
+script:
+- composer test
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..7815dda
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,2 @@
+The development of this software is covered by a [Code of Conduct](https://www.mediawiki.org/wiki/Code_of_Conduct).
+
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..fac0fee
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,341 @@
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
+
diff --git a/Doxyfile b/Doxyfile
new file mode 100644
index 0000000..85d7730
--- /dev/null
+++ b/Doxyfile
@@ -0,0 +1,26 @@
+# Doxyfile for ObjectFactory
+#
+# See <http://www.stack.nl/~dimitri/doxygen/manual/config.html>
+# for help on how to use this file to configure Doxygen.
+
+PROJECT_NAME = "ObjectFactory"
+PROJECT_BRIEF = "Construct objects from configuration instructions"
+OUTPUT_DIRECTORY = doc
+JAVADOC_AUTOBRIEF = YES
+QT_AUTOBRIEF = YES
+WARN_NO_PARAMDOC = YES
+INPUT = README.md src/
+FILE_PATTERNS = *.php
+RECURSIVE = YES
+USE_MDFILE_AS_MAINPAGE = README.md
+HTML_DYNAMIC_SECTIONS = YES
+GENERATE_TREEVIEW = YES
+TREEVIEW_WIDTH = 250
+GENERATE_LATEX = NO
+HAVE_DOT = YES
+DOT_FONTNAME = Helvetica
+DOT_FONTSIZE = 10
+TEMPLATE_RELATIONS = YES
+CALL_GRAPH = NO
+CALLER_GRAPH = NO
+DOT_MULTI_TARGETS = YES
diff --git a/composer.json b/composer.json
new file mode 100644
index 0000000..655bde7
--- /dev/null
+++ b/composer.json
@@ -0,0 +1,37 @@
+{
+ "name": "wikimedia/object-factory",
+ "description": "Construct objects from configuration instructions",
+ "license": "GPL-2.0+",
+ "homepage": "https://www.mediawiki.org/wiki/ObjectFactory",
+ "authors": [.
+ {
+ "name": "Bryan Davis",
+ "email": "bdavis@wikimedia.org"
+ }
+ ],
+ "autoload": {
+ "classmap": ["src/"]
+ },
+ "require": {
+ "php": ">=5.5.9"
+ },
+ "require-dev": {
+ "jakub-onderka/php-parallel-lint": "0.9.2",
+ "jakub-onderka/php-console-highlighter": "0.3.2",
+ "mediawiki/mediawiki-codesniffer": "15.0.0",
+ "mediawiki/minus-x": "0.2.1",
+ "phpunit/phpunit": "4.8.36"
+ },
+ "scripts": {
+ "test": [.
+ "parallel-lint . --exclude vendor",
+ "phpunit",
+ "phpcs -sp",
+ "minus-x check ."
+ ],
+ "fix": [
+ "phpcbf",
+ "minus-x fix ."
+ ]
+ }
+}
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
new file mode 100644
index 0000000..f9881af
--- /dev/null
+++ b/phpunit.xml.dist
@@ -0,0 +1,14 @@
+<phpunit colors="true"
+ beStrictAboutTestsThatDoNotTestAnything="true"
+ beStrictAboutOutputDuringTests="true">
+ <testsuites>
+ <testsuite name="ObjectFactory Tests">
+ <directory>./tests</directory>
+ </testsuite>
+ </testsuites>
+ <filter>
+ <whitelist addUncoveredFilesFromWhitelist="true">
+ <directory suffix=".php">./src</directory>
+ </whitelist>
+ </filter>
+</phpunit>
diff --git a/src/ObjectFactory.php b/src/ObjectFactory.php
new file mode 100644
index 0000000..08c2462
--- /dev/null
+++ b/src/ObjectFactory.php
@@ -0,0 +1,205 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+namespace Wikimedia;
+
+use Closure;
+use InvalidArgumentException;
+use ReflectionClass;
+use ReflectionException;
+
+/**
+ * Construct objects from configuration instructions.
+ *
+ * @copyright © 2014 Wikimedia Foundation and contributors
+ */
+class ObjectFactory {
+
+ /**
+ * Instantiate an object based on a specification array.
+ *
+ * The specification array must contain a 'class' key with string value
+ * that specifies the class name to instantiate or a 'factory' key with
+ * a callable (is_callable() === true). It can optionally contain
+ * an 'args' key that provides arguments to pass to the
+ * constructor/callable.
+ *
+ * Values in the arguments collection which are Closure instances will be
+ * expanded by invoking them with no arguments before passing the
+ * resulting value on to the constructor/callable. This can be used to
+ * pass IDatabase instances or other live objects to the
+ * constructor/callable. This behavior can be suppressed by adding
+ * closure_expansion => false to the specification.
+ *
+ * The specification may also contain a 'calls' key that describes method
+ * calls to make on the newly created object before returning it. This
+ * pattern is often known as "setter injection". The value of this key is
+ * expected to be an associative array with method names as keys and
+ * argument lists as values. The argument list will be expanded (or not)
+ * in the same way as the 'args' key for the main object.
+ *
+ * @param array $spec Object specification
+ * @return object
+ * @throws InvalidArgumentException when object specification does not
+ * contain 'class' or 'factory' keys
+ * @throws ReflectionException when 'args' are supplied and 'class'
+ * constructor is non-public or non-existent
+ */
+ public static function getObjectFromSpec( $spec ) {
+ $args = isset( $spec['args'] ) ? $spec['args'] : [];
+ $expandArgs = !isset( $spec['closure_expansion'] ) ||
+ $spec['closure_expansion'] === true;
+
+ if ( $expandArgs ) {
+ $args = static::expandClosures( $args );
+ }
+
+ if ( isset( $spec['class'] ) ) {
+ $clazz = $spec['class'];
+ if ( !$args ) {
+ $obj = new $clazz();
+ } else {
+ $obj = static::constructClassInstance( $clazz, $args );
+ }
+ } elseif ( isset( $spec['factory'] ) ) {
+ $obj = call_user_func_array( $spec['factory'], $args );
+ } else {
+ throw new InvalidArgumentException(
+ 'Provided specification lacks both factory and class parameters.'
+ );
+ }
+
+ if ( isset( $spec['calls'] ) && is_array( $spec['calls'] ) ) {
+ // Call additional methods on the newly created object
+ foreach ( $spec['calls'] as $method => $margs ) {
+ if ( $expandArgs ) {
+ $margs = static::expandClosures( $margs );
+ }
+ call_user_func_array( [ $obj, $method ], $margs );
+ }
+ }
+
+ return $obj;
+ }
+
+ /**
+ * Iterate a list and call any closures it contains.
+ *
+ * @param array $list List of things
+ * @return array List with any Closures replaced with their output
+ */
+ protected static function expandClosures( $list ) {
+ return array_map( function ( $value ) {
+ if ( is_object( $value ) && $value instanceof Closure ) {
+ // If $value is a Closure, call it.
+ return $value();
+ } else {
+ return $value;
+ }
+ }, $list );
+ }
+
+ /**
+ * Construct an instance of the given class using the given arguments.
+ *
+ * PHP's `call_user_func_array()` doesn't work with object construction so
+ * we have to use other measures. Starting with PHP 5.6.0 we could use the
+ * "splat" operator (`...`) to unpack the array into an argument list.
+ * Sadly there is no way to conditionally include a syntax construct like
+ * a new operator in a way that allows older versions of PHP to still
+ * parse the file. Instead, we will try a loop unrolling technique that
+ * works for 0-10 arguments. If we are passed 11 or more arguments we will
+ * take the performance penalty of using
+ * `ReflectionClass::newInstanceArgs()` to construct the desired object.
+ *
+ * @param string $clazz Class name
+ * @param array $args Constructor arguments
+ * @return mixed Constructed instance
+ */
+ public static function constructClassInstance( $clazz, $args ) {
+ // $args should be a non-associative array; show nice error if that's not the case
+ if ( $args && array_keys( $args ) !== range( 0, count( $args ) - 1 ) ) {
+ throw new InvalidArgumentException( __METHOD__ . ': $args cannot be an associative array' );
+ }
+
+ // TODO: when PHP min version supported is >=5.6.0 replace this
+ // with `return new $clazz( ... $args );`.
+ $obj = null;
+ switch ( count( $args ) ) {
+ case 0:
+ $obj = new $clazz();
+ break;
+ case 1:
+ $obj = new $clazz( $args[0] );
+ break;
+ case 2:
+ $obj = new $clazz( $args[0], $args[1] );
+ break;
+ case 3:
+ $obj = new $clazz( $args[0], $args[1], $args[2] );
+ break;
+ case 4:
+ $obj = new $clazz( $args[0], $args[1], $args[2], $args[3] );
+ break;
+ case 5:
+ $obj = new $clazz(
+ $args[0], $args[1], $args[2], $args[3], $args[4]
+ );
+ break;
+ case 6:
+ $obj = new $clazz(
+ $args[0], $args[1], $args[2], $args[3], $args[4],
+ $args[5]
+ );
+ break;
+ case 7:
+ $obj = new $clazz(
+ $args[0], $args[1], $args[2], $args[3], $args[4],
+ $args[5], $args[6]
+ );
+ break;
+ case 8:
+ $obj = new $clazz(
+ $args[0], $args[1], $args[2], $args[3], $args[4],
+ $args[5], $args[6], $args[7]
+ );
+ break;
+ case 9:
+ $obj = new $clazz(
+ $args[0], $args[1], $args[2], $args[3], $args[4],
+ $args[5], $args[6], $args[7], $args[8]
+ );
+ break;
+ case 10:
+ $obj = new $clazz(
+ $args[0], $args[1], $args[2], $args[3], $args[4],
+ $args[5], $args[6], $args[7], $args[8], $args[9]
+ );
+ break;
+ default:
+ // Fall back to using ReflectionClass and curse the developer
+ // who decided that 11+ args was a reasonable method
+ // signature.
+ $ref = new ReflectionClass( $clazz );
+ $obj = $ref->newInstanceArgs( $args );
+ }
+ return $obj;
+ }
+}
diff --git a/tests/ObjectFactoryTest.php b/tests/ObjectFactoryTest.php
new file mode 100644
index 0000000..99890dc
--- /dev/null
+++ b/tests/ObjectFactoryTest.php
@@ -0,0 +1,186 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+namespace Wikimedia\Test;
+
+use Closure;
+use Wikimedia\ObjectFactory;
+use PHPUnit_Framework_TestCase;
+
+class ObjectFactoryTest extends PHPUnit_Framework_TestCase {
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::getObjectFromSpec
+ */
+ public function testClosureExpansionDisabled() {
+ $obj = ObjectFactory::getObjectFromSpec( [.
+ 'class' => ObjectFactoryTestFixture::class,
+ 'args' => [.
+ function () {
+ return 'wrapped';
+ },
+ 'unwrapped',
+ ],
+ 'calls' => [.
+ 'setter' => [ function () {
+ return 'wrapped';
+ }, ],
+ ],
+ 'closure_expansion' => false,
+ ] );
+ $this->assertInstanceOf( Closure::class, $obj->args[0] );
+ $this->assertSame( 'wrapped', $obj->args[0]() );
+ $this->assertSame( 'unwrapped', $obj->args[1] );
+ $this->assertInstanceOf( Closure::class, $obj->setterArgs[0] );
+ $this->assertSame( 'wrapped', $obj->setterArgs[0]() );
+ }
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::getObjectFromSpec
+ * @covers \Wikimedia\ObjectFactory::expandClosures
+ */
+ public function testClosureExpansionEnabled() {
+ $obj = ObjectFactory::getObjectFromSpec( [.
+ 'class' => ObjectFactoryTestFixture::class,
+ 'args' => [.
+ function () {
+ return 'wrapped';
+ },
+ 'unwrapped',
+ ],
+ 'calls' => [.
+ 'setter' => [ function () {
+ return 'wrapped';
+ }, ],
+ ],
+ 'closure_expansion' => true,
+ ] );
+ $this->assertInternalType( 'string', $obj->args[0] );
+ $this->assertSame( 'wrapped', $obj->args[0] );
+ $this->assertSame( 'unwrapped', $obj->args[1] );
+ $this->assertInternalType( 'string', $obj->setterArgs[0] );
+ $this->assertSame( 'wrapped', $obj->setterArgs[0] );
+
+ $obj = ObjectFactory::getObjectFromSpec( [.
+ 'class' => ObjectFactoryTestFixture::class,
+ 'args' => [ function () {
+ return 'unwrapped';
+ }, ],
+ 'calls' => [.
+ 'setter' => [ function () {
+ return 'unwrapped';
+ }, ],
+ ],
+ ] );
+ $this->assertInternalType( 'string', $obj->args[0] );
+ $this->assertSame( 'unwrapped', $obj->args[0] );
+ $this->assertInternalType( 'string', $obj->setterArgs[0] );
+ $this->assertSame( 'unwrapped', $obj->setterArgs[0] );
+ }
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::getObjectFromSpec
+ */
+ public function testGetObjectFromFactory() {
+ $args = [ 'a', 'b' ];
+ $obj = ObjectFactory::getObjectFromSpec( [.
+ 'factory' => function ( $a, $b ) {
+ return new ObjectFactoryTestFixture( $a, $b );
+ },
+ 'args' => $args,
+ ] );
+ $this->assertSame( $args, $obj->args );
+ }
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::getObjectFromSpec
+ * @expectedException \InvalidArgumentException
+ */
+ public function testGetObjectFromInvalid() {
+ $args = [ 'a', 'b' ];
+ $obj = ObjectFactory::getObjectFromSpec( [.
+ // Missing 'class' or 'factory'
+ 'args' => $args,
+ ] );
+ }
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::getObjectFromSpec
+ * @dataProvider provideConstructClassInstance
+ */
+ public function testGetObjectFromClass( $args ) {
+ $obj = ObjectFactory::getObjectFromSpec( [
+ 'class' => ObjectFactoryTestFixture::class,
+ 'args' => $args,
+ ] );
+ $this->assertSame( $args, $obj->args );
+ }
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::constructClassInstance
+ * @dataProvider provideConstructClassInstance
+ */
+ public function testConstructClassInstance( $args ) {
+ $obj = ObjectFactory::constructClassInstance(
+ ObjectFactoryTestFixture::class, $args
+ );
+ $this->assertSame( $args, $obj->args );
+ }
+
+ public static function provideConstructClassInstance() {
+ // These args go to 11. I thought about making 10 one louder, but 11!
+ return [
+ '0 args' => [ [] ],
+ '1 args' => [ [ 1, ] ],
+ '2 args' => [ [ 1, 2, ] ],
+ '3 args' => [ [ 1, 2, 3, ] ],
+ '4 args' => [ [ 1, 2, 3, 4, ] ],
+ '5 args' => [ [ 1, 2, 3, 4, 5, ] ],
+ '6 args' => [ [ 1, 2, 3, 4, 5, 6, ] ],
+ '7 args' => [ [ 1, 2, 3, 4, 5, 6, 7, ] ],
+ '8 args' => [ [ 1, 2, 3, 4, 5, 6, 7, 8, ] ],
+ '9 args' => [. [ 1, 2, 3, 4, 5, 6, 7, 8, 9, ] ],
+ '10 args' => [. [. 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ] ],
+ '11 args' => [. [. 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, ] ],
+ ];
+ }
+
+ /**
+ * @covers \Wikimedia\ObjectFactory::constructClassInstance
+ * @expectedException \InvalidArgumentException
+ */
+ public function testNamedArgs() {
+ $args = [ 'foo' => 1, 'bar' => 2, 'baz' => 3 ];
+ $obj = ObjectFactory::constructClassInstance(
+ ObjectFactoryTestFixture::class, $args
+ );
+ }
+}
+
+class ObjectFactoryTestFixture {
+ public $args;
+ public $setterArgs;
+ public function __construct( /*...*/ ) {
+ $this->args = func_get_args();
+ }
+ public function setter( /*...*/ ) {
+ $this->setterArgs = func_get_args();
+ }
+}
--
To view, visit https://gerrit.wikimedia.org/r/405914
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I94630c5b587b98b48ae66ce455f2480407955732
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/libs/ObjectFactory
Gerrit-Branch: master
Gerrit-Owner: Legoktm <legoktm@member.fsf.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits