diff --git a/.babelrc b/.babelrc new file mode 100644 index 0000000000..cab5d10d92 --- /dev/null +++ b/.babelrc @@ -0,0 +1,3 @@ +{ + "stage": 2 +} diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000000..b6d88cdfe1 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,2 @@ +log/* +.git/* diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000000..14b20f7436 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,29 @@ +# EditorConfig helps developers define and maintain consistent +# coding styles between different editors and IDEs +# editorconfig.org + +root = true + + +[*] +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +indent_style = space +indent_size = 2 + +[*.js] +indent_style = space +indent_size = 2 + +[*.css] +indent_style = space +indent_size = 2 + +[*.html] +indent_style = space +indent_size = 2 + +[*.{diff,md}] +trim_trailing_whitespace = false diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000000..8934c52258 --- /dev/null +++ b/.eslintrc @@ -0,0 +1,23 @@ +{ + "parser": "babel-eslint", + "rules": { + "max-len": [2, 120, 2], + "jsx-quotes": [2, "prefer-double"], + "key-spacing": [2, { + "beforeColon": false, + "afterColon": true, + "mode": "minimum" + }], + "no-var": 2, + "prefer-const": 2 + }, + "env": { + "browser": true, + "mocha": true, + "es6": true + }, + "globals": { + "expect": true + }, + "extends": ["standard", "standard-react"] +} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..57842311ab --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +node_modules/ +__build__/ +__dist__/ +__examples__/ diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000000..8f6716e415 --- /dev/null +++ b/.npmignore @@ -0,0 +1,5 @@ +**/.* +**/__tests__ +**/__examples__ +CONTRIBUTING.md +bower.json diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..06bab27afe --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +### Commit Subjects + +If your patch **changes the API or fixes a bug** please use one of the +following prefixes in your commit subject: + +- `[fixed] ...` +- `[changed] ...` +- `[added] ...` +- `[removed] ...` + +That ensures the subject line of your commit makes it into the +auto-generated changelog. Do not use these tags if your change doesn't +fix a bug and doesn't change the public API. + +Commits with changed, added, or removed, must be reviewed by another +collaborator. + +#### When using `[changed]` or `[removed]`... + +Please include an upgrade path with example code in the commit message. +If it doesn't make sense to do this, then it doesn't make sense to use +`[changed]` or `[removed]` :) + +### Docs + +Please update the README with any API changes, the code and docs should +always be in sync. + +### Development + +- `npm start` runs the dev server to run/develop examples +- `npm test` will run the tests. + +### Build + +Please do not include the output of `npm run build` in your commits, we +only do this when we release. (Also, you probably don't need to build +anyway unless you are fixing something around our global build.) + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..dba13ed2dd --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + 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 +them 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + 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 +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000000..1b8622a493 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# instructure-ui + +[WIP] A React UI component library made by Instructure Inc. + +See the [examples](http://instructure.github.io/instructure-ui/). diff --git a/UPGRADE_GUIDE.md b/UPGRADE_GUIDE.md new file mode 100644 index 0000000000..30d0765f43 --- /dev/null +++ b/UPGRADE_GUIDE.md @@ -0,0 +1,6 @@ +Upgrade Guide +============= + +To see discussion around these API changes, please refer to the +[changelog](/CHANGELOG.md) and visit the commits and issues they +reference. diff --git a/bower.json b/bower.json new file mode 100644 index 0000000000..8f5733a525 --- /dev/null +++ b/bower.json @@ -0,0 +1,27 @@ +{ + "name": "instructure-ui", + "version": "0.0.0", + "homepage": "https://github.com/instructure/instructure-ui", + "author": "Instructure, Inc. Engineering", + "description": "React UI Component Framework for Instructure", + "main": "__dist__/instructure-ui.js", + "keywords": [ + "react", + "react-component", + "instructure" + ], + "license": "AGPL-3.0", + "ignore": [ + "**/.*", + "**/__tests__", + "**/__examples__", + "__build__", + "__examples__", + "lib", + "node_modules", + "package.json", + "CONTRIBUTING.md", + "build.sh", + "docker-compose*" + ] +} diff --git a/build.sh b/build.sh new file mode 100755 index 0000000000..b67a5ce69e --- /dev/null +++ b/build.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +docker/test diff --git a/docker-compose.test.yml b/docker-compose.test.yml new file mode 100644 index 0000000000..73004098fd --- /dev/null +++ b/docker-compose.test.yml @@ -0,0 +1,5 @@ +web: + build: . + dockerfile: docker/Dockerfile.test + environment: + NODE_ENV: test diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000000..439ef7fc9d --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,8 @@ +web: + build: . + ports: + - "8080:8080" + dockerfile: docker/Dockerfile + environment: + VIRTUAL_HOST: instructure-ui.docker + NODE_ENV: development diff --git a/docker/Dockerfile b/docker/Dockerfile new file mode 100644 index 0000000000..325da6210a --- /dev/null +++ b/docker/Dockerfile @@ -0,0 +1,17 @@ +FROM docker.insops.net/instructure/node-passenger:4.2.1 + +USER root + +# Add source and install dependencies + +RUN mkdir -p /src/ +WORKDIR /src/ + +COPY ./package.json /src/ +RUN npm install --ignore-scripts --unsafe-perm +COPY . /src/ + +RUN chown -R docker:docker /src +USER docker + +CMD npm start diff --git a/docker/Dockerfile.test b/docker/Dockerfile.test new file mode 100644 index 0000000000..a0f03a558f --- /dev/null +++ b/docker/Dockerfile.test @@ -0,0 +1,47 @@ +FROM docker.insops.net/instructure/node-passenger:4.2.1 + +USER root + +# Add Chrome +RUN apt-get update \ + && apt-get install -y wget \ + && wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \ + && echo "deb http://dl.google.com/linux/chrome/deb/ stable main" > /etc/apt/sources.list.d/google.list + +# Add Firefox +RUN add-apt-repository -y ppa:mozillateam/firefox-next + +# Install +RUN apt-get update \ + && apt-get install -y firefox google-chrome-stable xvfb + +ENV CHROME_BIN /usr/bin/google-chrome-stable +ENV FIREFOX_BIN /usr/bin/firefox +ENV DISPLAY :99 + +# Add Xvfb init and daemon scripts +COPY docker/xvfb-init /etc/init.d/xvfb +RUN chmod a+x /etc/init.d/xvfb +COPY docker/xvfb-wait /usr/bin/xvfb-wait +RUN chmod a+x /usr/bin/xvfb-wait +COPY docker/xvfb-daemon /usr/bin/xvfb-daemon +RUN chmod a+x /usr/bin/xvfb-daemon + +RUN mkdir /var/xvfb +RUN chown -R docker:docker /var/xvfb + +# Clean up +RUN apt-get clean \ + && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* + +# Add source and install dependencies + +RUN mkdir -p /src/ +WORKDIR /src/ + +COPY ./package.json /src/ +RUN npm install --ignore-scripts --unsafe-perm +COPY . /src/ + +RUN chown -R docker:docker /src +USER docker diff --git a/docker/start b/docker/start new file mode 100755 index 0000000000..88d987d40a --- /dev/null +++ b/docker/start @@ -0,0 +1,9 @@ +#!/bin/bash + +set -ex + +echo "building services..." +docker-compose build + +echo "starting dev server..." +docker-compose up diff --git a/docker/test b/docker/test new file mode 100755 index 0000000000..54f3f95d7b --- /dev/null +++ b/docker/test @@ -0,0 +1,15 @@ +#!/bin/bash + +set -ex + +export COMPOSE_FILE=./docker-compose.test.yml + +echo "pull image..." +docker-compose pull + +echo "building services..." +docker-compose build + +echo "running tests..." +docker-compose run --rm web bash -c "xvfb-daemon npm test" + diff --git a/docker/xvfb-daemon b/docker/xvfb-daemon new file mode 100755 index 0000000000..f52e2969ba --- /dev/null +++ b/docker/xvfb-daemon @@ -0,0 +1,8 @@ +#!/bin/bash +export DISPLAY=:99 +/etc/init.d/xvfb start +timeout 10 xvfb-wait +$@ +exit_value=$? +/etc/init.d/xvfb stop +exit $exit_value diff --git a/docker/xvfb-init b/docker/xvfb-init new file mode 100755 index 0000000000..b6c00086a8 --- /dev/null +++ b/docker/xvfb-init @@ -0,0 +1,27 @@ +#!/bin/bash + +set -e + +XVFB=/usr/bin/Xvfb +XVFBARGS="$DISPLAY -ac -screen 0 1024x768x16 +extension RANDR" +PIDFILE=/var/xvfb/${DISPLAY:1}.pid +case "$1" in + start) + echo -n "Starting virtual X frame buffer: Xvfb" + /sbin/start-stop-daemon --start --quiet --pidfile $PIDFILE --make-pidfile --background --exec $XVFB -- $XVFBARGS + echo "." + ;; + stop) + echo -n "Stopping virtual X frame buffer: Xvfb" + /sbin/start-stop-daemon --stop --quiet --pidfile $PIDFILE + echo "." + ;; + restart) + $0 stop + $0 start + ;; + *) + echo "Usage: /etc/init.d/xvfb {start|stop|restart}" + exit 1 +esac +exit 0 diff --git a/docker/xvfb-wait b/docker/xvfb-wait new file mode 100755 index 0000000000..fb16e0dae2 --- /dev/null +++ b/docker/xvfb-wait @@ -0,0 +1,12 @@ +#!/usr/bin/env bash + +# Exit immediately if a command exits with a non-zero status +set -e + +echo "Waiting for Xvfb to be ready..." +while ! xdpyinfo -display ${DISPLAY}; do + echo -n '' + sleep 0.1 +done + +echo "Done wait-xvfb.sh" diff --git a/karma.conf.js b/karma.conf.js new file mode 100644 index 0000000000..36d6e4fe44 --- /dev/null +++ b/karma.conf.js @@ -0,0 +1,92 @@ +/* eslint no-var: 0 */ + +var fs = require('fs') +var path = require('path') +var REGEX_TEST = /\-test\.js$/ + +function findTests (dir) { + var tests = [] + fs.readdirSync(dir).forEach(function (file) { + var resolvedFile = path.resolve(dir, file) + var stat = fs.statSync(resolvedFile) + if (stat && stat.isDirectory()) { + tests = tests.concat(findTests(resolvedFile)) + } else if (REGEX_TEST.test(resolvedFile)) { + tests.push(resolvedFile) + } + }) + return tests +} + +module.exports = function (config) { + var tests = findTests(path.resolve(process.cwd(), 'lib')) + var conf = { + basePath: '', + + frameworks: ['mocha', 'chai'], + + files: tests, + + preprocessors: {}, + + reporters: ['mocha'], + + port: 9876, + + colors: true, + + logLevel: config.LOG_INFO, + + autoWatch: true, + + browsers: ['chrome_without_security', 'Firefox'], + + customLaunchers: { + chrome_without_security: { + base: 'Chrome', + flags: [ + '--no-default-browser-check', + '--no-first-run', + '--disable-default-apps', + '--disable-popup-blocking', + '--disable-translate', + + // This is necessary in order to get useful error messages that + // happen outside of the test suites (e.g, script load errors). + // + // Without this flag, we get the dreaded "Script Error." message with + // no explanation, and that is due to the cross-origin policies (since + // karma loads our tests files using socket.io from another "origin"). + // + // Additional reading: + // + // - https://github.com/karma-runner/karma/issues/543 + // - http://stackoverflow.com/questions/5913978/cryptic-script-error-reported-in-javascript-in-chrome-and-firefox + // - https://bugs.webkit.org/show_bug.cgi?id=70574 + // - https://groups.google.com/forum/#!topic/angular/VeqlVgUa6Wo + // + '--disable-web-security', + '--no-sandbox' + ] + } + }, + + captureTimeout: 60000, + + singleRun: true, + + webpack: require('./webpack.config.js/test'), + + webpackServer: { + stats: { + colors: true + } + } + } + + tests.forEach(function (test) { + conf.preprocessors[test] = ['webpack', 'sourcemap'] + }) + + config.set(conf) +} diff --git a/lib/components/ContextBox/ContextBox.css b/lib/components/ContextBox/ContextBox.css new file mode 100644 index 0000000000..241e3310a8 --- /dev/null +++ b/lib/components/ContextBox/ContextBox.css @@ -0,0 +1,122 @@ +$background-color: white; +$border-color: #d6d6d6; +$caret-border-color: color($border-color shade(8%)); +$border-radius: 4px; +$caret-size: 8px; + +.root { + box-sizing: border-box; + background: $background-color; + border-radius: $border-radius; + border: 1px solid $border-color; + box-shadow: 0 1px 6px rgba(0,0,0,0.1); + *, *:before, *:after { box-sizing: border-box; } +} + +.content { + overflow: hidden; + border-radius: calc($border-radius - 1); +} + +.caret--left, +.caret--right, +.caret--above, +.caret--below { + position: relative; + min-height: calc($caret-size * 4); + &:before, + &:after { + content: ""; + height: 0; + width: 0; + position: absolute; + pointer-events: none; + border: solid transparent; + border-color: rgba(255,255,255,0); + } + &:before { border-width: calc($caret-size + 1); } + &:after { border-width: $caret-size; } +} + +.caret--left { + &:before, &:after { + right: 100%; + top: 50%; + } + &:after { + border-right-color: $background-color; + margin-top: calc( -($caret-size) ); + } + &:before { + border-right-color: $caret-border-color; + margin-top: calc( -($caret-size + 1) ); + } +} + +.caret--right { + &:before, &:after { + top: 50%; + left: 100%; + } + &:after { + border-left-color: $background-color; + margin-top: calc( -($caret-size) ); + } + &:before { + border-left-color: $caret-border-color; + margin-top: calc( -($caret-size + 1) ); + } +} + +.caret--above { + &:before, &:after { + bottom: 100%; + left: 50%; + } + &:after { + border-bottom-color: $background-color; + margin-left: calc( -($caret-size) ); + } + &:before { + border-bottom-color: $caret-border-color; + margin-left: calc( -($caret-size + 1) ); + } +} + +.caret--below { + &:before, &:after { + top: 100%; + left: 50%; + } + &:after { + border-top-color: $background-color; + margin-left: calc( -($caret-size) ); + } + &:before { + border-top-color: $caret-border-color; + margin-left: calc( -($caret-size + 1) ); + } +} + +@keyframes animate-root { + to { + transform: translate3d(0,0,0); + opacity: 1; + } +} + +.animate--left, +.animate--right, +.animate--above, +.animate--below { + opacity: 0; + animation-duration: 0.3s; + animation-name: animate-root; + animation-timing-function: ease-out; + animation-fill-mode: forwards; +} + +.animate--left { transform: translate3d(-20%,0,0); } +.animate--right { transform: translate3d(20%,0,0); } +.animate--above { transform: translate3d(0,-20%,0); } +.animate--below { transform: translate3d(0,20%,0); } diff --git a/lib/components/ContextBox/ContextBox.js b/lib/components/ContextBox/ContextBox.js new file mode 100644 index 0000000000..040277bf0f --- /dev/null +++ b/lib/components/ContextBox/ContextBox.js @@ -0,0 +1,37 @@ +import React, { Component } from 'react' +import styles from './ContextBox.css' +import classnames from 'classnames' + +class ContextBox extends Component { + render () { + const position = this.props.position + const classes = { + [styles.root]: true, + [styles['caret--' + position]]: this.props.showCaret, + [styles['animate--' + position]]: this.props.animate + } + + return ( +
+
+ { this.props.children } +
+
+ ) + } +} + +ContextBox.propTypes = { + children: React.PropTypes.node.isRequired, + showCaret: React.PropTypes.bool, + animate: React.PropTypes.bool, + position: React.PropTypes.oneOf(['above', 'below', 'left', 'right']) +} + +ContextBox.defaultProps = { + animate: true, + showCaret: false, + position: 'top' +} + +export default ContextBox diff --git a/lib/components/ContextBox/__examples__/example-image.jpg b/lib/components/ContextBox/__examples__/example-image.jpg new file mode 100644 index 0000000000..032f609224 Binary files /dev/null and b/lib/components/ContextBox/__examples__/example-image.jpg differ diff --git a/lib/components/ContextBox/__examples__/examples.css b/lib/components/ContextBox/__examples__/examples.css new file mode 100644 index 0000000000..e3b2128561 --- /dev/null +++ b/lib/components/ContextBox/__examples__/examples.css @@ -0,0 +1,28 @@ +.container { + position: relative; + min-height: 100px; +} +.context { + position: absolute; + top: 0; left: 0; +} +.text { + padding: 18px; + text-align: center; + font-size: 12px; + color: #888; + letter-spacing: 1px; + text-transform: uppercase; + max-width: 300px; +} +.image { + max-width: 300px; + max-height: 300px; + overflow: hidden; + margin: 4px; + box-sizing: border-box; + border-radius: 3px; +} +.image img { + display: block; +} diff --git a/lib/components/ContextBox/__examples__/index.js b/lib/components/ContextBox/__examples__/index.js new file mode 100644 index 0000000000..34619a7d49 --- /dev/null +++ b/lib/components/ContextBox/__examples__/index.js @@ -0,0 +1,89 @@ +import React from 'react' +import ReactDom from 'react-dom' +import ContextBox from '../index' + +import styles from './examples.css' + +import image from './example-image.jpg' + +const Examples = React.createClass({ + render () { + return ( +
+
+
+
+ + +
+ Context box with no caret and top animation +
+
+ +
+
+
+
+ + +
+ Context box with left caret and left animation +
+
+ +
+
+
+
+ + +
+ Context box with right caret and right animation +
+
+ +
+
+
+
+ + +
+ Context box with top caret and top animation +
+
+ +
+
+
+
+ + +
+ Context box with bottom caret and bottom animation +
+
+ +
+
+
+
+ + +
+ Image of flowers +
+
+ Context box with top animation and caret, containing an image +
+
+ +
+
+
+
+ ) + } +}) + +ReactDom.render(, document.getElementById('examples')) diff --git a/lib/components/ContextBox/__tests__/ContextBox-test.js b/lib/components/ContextBox/__tests__/ContextBox-test.js new file mode 100644 index 0000000000..170b6c70a2 --- /dev/null +++ b/lib/components/ContextBox/__tests__/ContextBox-test.js @@ -0,0 +1,4 @@ + +describe('ic-context-box', function () { + it('should have tests') +}) diff --git a/lib/components/ContextBox/index.js b/lib/components/ContextBox/index.js new file mode 100644 index 0000000000..577da9c1fa --- /dev/null +++ b/lib/components/ContextBox/index.js @@ -0,0 +1,2 @@ +import ContextBox from './ContextBox' +export default ContextBox diff --git a/lib/components/ContextBox/package.json b/lib/components/ContextBox/package.json new file mode 100644 index 0000000000..5a4d733158 --- /dev/null +++ b/lib/components/ContextBox/package.json @@ -0,0 +1,26 @@ +{ + "name": "ic-context-box", + "version": "0.0.0", + "description": "A React context box component", + "author": "Instructure, Inc. Engineering", + "main": "./index.js", + "directories": { + "example": "__examples__" + }, + "homepage": "https://github.com/instructure/instructure-ui", + "bugs": "https://github.com/instructure/instructure-ui/issues", + "license": "AGPL-3.0", + "dependencies": { + "babel-runtime": "^6.0.14", + "classnames": "^2.2.0", + "react": "^0.14.1", + "react-dom": "^0.14.1" + }, + "keywords": [ + "react", + "react-component", + "instructure", + "popover", + "context box" + ] +} diff --git a/lib/components/RangeInput/RangeInput.css b/lib/components/RangeInput/RangeInput.css new file mode 100644 index 0000000000..fe48a54fbb --- /dev/null +++ b/lib/components/RangeInput/RangeInput.css @@ -0,0 +1,161 @@ +@define-mixin handle-selector { + &::-webkit-slider-thumb { + @mixin-content; + } + &::-ms-thumb { + @mixin-content; + } + &::-moz-range-thumb { + @mixin-content; + } +} + +@define-mixin track-selector { + &::-webkit-slider-runnable-track { + @mixin-content; + } + &::-moz-range-track { + @mixin-content; + } + &::-ms-track { + @mixin-content; + } +} + +$handle-color: #0096db; +$handle-color-hover: color($handle-color b(30%)); +$handle-border-color-focused: color($handle-color b(30)); +$handle-size: 1.6em; +$handle-shadow: 0 0.2em 0.375em color(black a(30%)); +$slider-color: #E5E5E5; +$value-bg-color: #333; +$value-text-color: #fff; +$label-color: #333; +$label-font-size: 1.25em; + +.root { + + font-size: 1rem; + + * { + box-sizing: border-box; + } + + /* Style range input */ + input[type=range] { + -webkit-appearance: none; + width: 100%; /* for Firefox */ + outline: none; + margin: 0; padding: 0; /* for IE */ + + /* Slider Handle/Thumb */ + @mixin handle-selector { + -webkit-appearance: none; + width: $handle-size; + height: $handle-size; + border-radius: 50%; + background: $handle-color; + box-shadow: $handle-shadow; + cursor: pointer; + transition: all .15s ease-in-out; + + &:hover { + background: $handle-color-hover; + } + } + + &::-webkit-slider-thumb { + margin-top: calc(-$handle-size/4); + } + + &:focus, + &:active { + outline: none; + @mixin handle-selector { + box-shadow: $handle-shadow, + 0 0 0 calc($handle-size/2) color($handle-color a(15%)); + } + } + + /* remove outline in FF */ + &::-moz-focus-inner, + &::-moz-focus-outer { + border: 0; + outline: none; + } + + @mixin track-selector { + height: calc($handle-size/2); + border-radius: 0.312em; + background: $slider-color; + border-color: transparent; + color: transparent; + cursor: pointer; + animate: 0.2s; + } + + &::-ms-track { + background: transparent; + border-width: $handle-size 0; + } + &::-ms-fill-upper, + &::-ms-fill-lower { + background: $slider-color; + + border-radius: calc($handle-size/2); + } + + &::-ms-tooltip { + display: none; + } + } +} + + +/* Label text */ +.label { + margin: 0 0 0.5em; + display: block; + line-height: 1.3; + font-size: $label-font-size; + color: $label-color; +} + +/* Slider + Tooltip */ +.control { + display: flex; + justify-content: center; + align-items: center; +} + +/* Slider */ +.input { + flex: auto; +} + +/* Tooltip/Selected Value */ +.value { + display: inline-block; + position: relative; + width: 4.375em; + color: $value-text-color; + font-size: 1em; + line-height: 1.5; + text-align: center; + border-radius: 0.1875em; + background: $value-bg-color; + padding: 0.312em 0.625em; + margin-left: 0.437em; + + &:after { + content: ""; + position: absolute; + top: 0.5em; + left: -0.4375em; + width: 0; + height: 0; + border-top: 0.5em solid transparent; + border-right: 0.5em solid $value-bg-color; + border-bottom: 0.5em solid transparent; + } +} diff --git a/lib/components/RangeInput/RangeInput.js b/lib/components/RangeInput/RangeInput.js new file mode 100644 index 0000000000..8ffa15a8b4 --- /dev/null +++ b/lib/components/RangeInput/RangeInput.js @@ -0,0 +1,81 @@ +import React, { Component } from 'react' +import styles from './RangeInput.css' + +class RangeInput extends Component { + constructor () { + super() + this.state = {} + } + + /* workaround for https://github.com/facebook/react/issues/554 */ + componentDidMount () { + // https://connect.microsoft.com/IE/Feedback/Details/856998 + this.refs.rangeInput.addEventListener('input', this.handleChange.bind(this), false) + this.refs.rangeInput.addEventListener('change', this.handleChange.bind(this), false) + } + + componentWillUnmount () { + this.refs.rangeInput.removeEventListener('input', this.handleChange, false) + this.refs.rangeInput.removeEventListener('change', this.handleChange, false) + } + /* end workaround */ + + handleChange (event) { + this.setState({ value: event.target.value }) + this.props.onChange(event.target.value) + } + +/* eslint no-unused-vars: 0 */ +/* eslint no-undef: 0 */ + render () { + const { + labelText, + formatValue, + onChange, + ...props + } = this.props + + return ( + + ) + } +} + +RangeInput.propTypes = { + min: React.PropTypes.number.isRequired, + max: React.PropTypes.number.isRequired, + defaultValue: React.PropTypes.number.isRequired, + labelText: React.PropTypes.string.isRequired, + name: React.PropTypes.string.isRequired, + step: React.PropTypes.number, + formatValue: React.PropTypes.func, + onChange: React.PropTypes.func +} + +RangeInput.defaultProps = { + step: 1, + onChange: function () {}, + formatValue: val => val +} + +export default RangeInput diff --git a/lib/components/RangeInput/__examples__/index.js b/lib/components/RangeInput/__examples__/index.js new file mode 100644 index 0000000000..3d12406936 --- /dev/null +++ b/lib/components/RangeInput/__examples__/index.js @@ -0,0 +1,15 @@ +import React from 'react' +import ReactDom from 'react-dom' +import RangeInput from '../index' + +const Examples = React.createClass({ + render () { + return ( +
+ +
+ ) + } +}) + +ReactDom.render(, document.getElementById('examples')) diff --git a/lib/components/RangeInput/__tests__/RangeInput-test.js b/lib/components/RangeInput/__tests__/RangeInput-test.js new file mode 100644 index 0000000000..8e6cd7c15b --- /dev/null +++ b/lib/components/RangeInput/__tests__/RangeInput-test.js @@ -0,0 +1,63 @@ +import React from 'react' +import TestUtils from 'react-addons-test-utils' +import ReactDom from 'react-dom' +import RangeInput from '../index' + +let root +let subject + +const render = function (props) { + props = Object.assign({ + labelText: 'Opacity', + defaultValue: 25, + name: 'opacity', + max: 100, + min: 0 + }, props || {}) + subject = ReactDom.render( + , + root + ) +} + +const findByTag = function (tag) { + return TestUtils.findRenderedDOMComponentWithTag(subject, tag) +} + +describe('ic-range-input', function () { + beforeEach(function () { + root = document.createElement('div') + document.body.appendChild(root) + }) + + afterEach(function () { + ReactDom.unmountComponentAtNode(root) + document.body.removeChild(root) + subject = null + }) + + it('renders an input with type range', function () { + render() + + expect(findByTag('input').type).to.equal('range') + }) + + it('renders an output element with the defaultValue', function () { + render({ + defaultValue: 50 + }) + + expect(findByTag('output').textContent).to.equal('50') + }) + + it('formats the value displayed in the output element', function () { + render({ + defaultValue: 45, + formatValue: function (value) { + return value + '%' + } + }) + + expect(findByTag('output').textContent).to.equal('45%') + }) +}) diff --git a/lib/components/RangeInput/index.js b/lib/components/RangeInput/index.js new file mode 100644 index 0000000000..8bd1f0eaaf --- /dev/null +++ b/lib/components/RangeInput/index.js @@ -0,0 +1,2 @@ +import RangeInput from './RangeInput' +export default RangeInput diff --git a/lib/components/RangeInput/package.json b/lib/components/RangeInput/package.json new file mode 100644 index 0000000000..4c454def7c --- /dev/null +++ b/lib/components/RangeInput/package.json @@ -0,0 +1,25 @@ +{ + "name": "ic-range-input", + "version": "0.0.0", + "description": "A React range input slider component", + "author": "Instructure, Inc. Engineering", + "main": "./index.js", + "directories": { + "example": "__examples__" + }, + "homepage": "https://github.com/instructure/instructure-ui", + "bugs": "https://github.com/instructure/instructure-ui/issues", + "license": "AGPL-3.0", + "dependencies": { + "babel-runtime": "^6.0.14", + "react": "^0.14.1", + "react-dom": "^0.14.1" + }, + "keywords": [ + "react", + "react-component", + "instructure", + "slider", + "range" + ] +} diff --git a/lib/index.html b/lib/index.html new file mode 100644 index 0000000000..41c4dadddf --- /dev/null +++ b/lib/index.html @@ -0,0 +1,22 @@ + + + + {%= o.htmlWebpackPlugin.options.title %} + + + + + +
+ + diff --git a/lib/index.js b/lib/index.js new file mode 100644 index 0000000000..4170d2c9aa --- /dev/null +++ b/lib/index.js @@ -0,0 +1 @@ +exports.RangeInput = require('./components/RangeInput') diff --git a/package.json b/package.json new file mode 100644 index 0000000000..af419f925e --- /dev/null +++ b/package.json @@ -0,0 +1,95 @@ +{ + "name": "instructure-ui", + "version": "0.0.0", + "description": "A React UI component library made by Instructure Inc.", + "author": "Instructure, Inc. Engineering", + "main": "./lib/index.js", + "directories": { + "lib": "lib", + "example": "__examples__", + "dist": "__dist__" + }, + "repository": { + "type": "git", + "url": "https://github.com/instructure/instructure-ui.git" + }, + "homepage": "https://github.com/instructure/instructure-ui", + "bugs": "https://github.com/instructure/instructure-ui/issues", + "scripts": { + "start": "webpack-dev-server --inline --hot -d --progress --config webpack.config.js --content-base __examples__", + "test": "./scripts/test", + "test:watch": "./scripts/test --no-single-run --browsers Chrome", + "clean": "./scripts/clean", + "build:lib": "./scripts/build", + "build:dist": "webpack --config webpack.config.js/dist.js", + "build:minify": "webpack --config webpack.config.js/minify.js", + "build:examples": "webpack --config webpack.config.js/examples.js", + "build": "./scripts/build-all", + "release": "./scripts/release", + "deploy": "./scripts/deploy" + }, + "license": "AGPL-3.0", + "devDependencies": { + "autoprefixer": "^6.0.3", + "babel": "^5.8.23", + "babel-core": "^5.8.25", + "babel-eslint": "^4.1.3", + "babel-loader": "^5.3.2", + "chai": "^3.4.0", + "changelog": "^1.0.7", + "css-loader": "^0.21.0", + "csswring": "^4.0.0", + "eslint": "^1.8.0", + "eslint-config-standard": "^4.4.0", + "eslint-config-standard-react": "^1.1.0", + "eslint-loader": "^1.1.1", + "eslint-plugin-react": "^3.6.3", + "eslint-plugin-standard": "^1.3.1", + "extract-text-webpack-plugin": "^0.8.2", + "file-loader": "^0.8.4", + "glob": "^5.0.15", + "html-webpack-plugin": "^1.6.2", + "karma": "^0.13.14", + "karma-chai": "^0.1.0", + "karma-chrome-launcher": "^0.2.1", + "karma-cli": "^0.1.1", + "karma-firefox-launcher": "^0.1.6", + "karma-ie-launcher": "^0.2.0", + "karma-mocha": "^0.2.0", + "karma-mocha-reporter": "^1.1.1", + "karma-safari-launcher": "^0.1.1", + "karma-sourcemap-loader": "^0.3.6", + "karma-webpack": "^1.7.0", + "lodash": "^3.10.1", + "mocha": "^2.3.3", + "postcss": "^5.0.10", + "postcss-calc": "^5.0.0", + "postcss-color-function": "^2.0.0", + "postcss-discard-comments": "^2.0.2", + "postcss-discard-duplicates": "^2.0.0", + "postcss-loader": "^0.7.0", + "postcss-mixins": "^2.1.1", + "postcss-nested": "^1.0.0", + "postcss-simple-vars": "^1.1.0", + "postcss-url": "^5.0.2", + "react-addons-test-utils": "^0.14.1", + "react-hot-loader": "^1.3.0", + "rf-release": "mzabriskie/rf-release", + "style-loader": "^0.13.0", + "url-loader": "^0.5.6", + "webpack": "^1.12.3", + "webpack-dev-server": "^1.12.1", + "webpack-postcss-tools": "^1.1.1" + }, + "dependencies": { + "babel-runtime": "^6.0.14", + "classnames": "^2.2.0", + "react": "^0.14.2", + "react-dom": "^0.14.2" + }, + "keywords": [ + "react", + "react-component", + "instructure" + ] +} diff --git a/scripts/build b/scripts/build new file mode 100755 index 0000000000..4cf11520d0 --- /dev/null +++ b/scripts/build @@ -0,0 +1,13 @@ +#!/bin/bash + +set -ex + +# Transpile ES6 +babel -d __build__/lib lib + +# Copy package +cp README.md __build__/ +cp .npmignore __build__/ +cp LICENSE __build__/ +node -p 'p=require("./package");p.scripts=p.devDependencies=undefined;JSON.stringify(p,null,2)' > __build__/package.json + diff --git a/scripts/build-all b/scripts/build-all new file mode 100755 index 0000000000..98c5bf3d06 --- /dev/null +++ b/scripts/build-all @@ -0,0 +1,9 @@ +#!/bin/bash + +set -ex + +npm run clean && \ +npm run build:lib && \ +npm run build:dist && \ +npm run build:minify && \ +npm run build:examples diff --git a/scripts/clean b/scripts/clean new file mode 100755 index 0000000000..40ccb14914 --- /dev/null +++ b/scripts/clean @@ -0,0 +1,7 @@ +#!/bin/bash + +set -ex + +rm -rf __build__/ && \ +rm -rf __examples__/ && \ +rm -rf __dist__/ diff --git a/scripts/deploy b/scripts/deploy new file mode 100755 index 0000000000..58fa1b3efd --- /dev/null +++ b/scripts/deploy @@ -0,0 +1,45 @@ +#!/bin/bash + +set -ex + +# make sure working directory is clean +DIRTY=$(git status | grep modified -c) +let DIRTY+=$(git status | grep Untracked -c) + +if [ $DIRTY -gt 0 ] && [ "$1" != "-f" ]; then + echo "\033[0;31m"Refusing to operate on unclean working directory"\033[0m" + echo Use \"git status\" to see which files have been modified + exit 1 +fi + +# delete gh-pages branch +BRANCH=$(git rev-parse --abbrev-ref HEAD) + +if [ "$BRANCH" == "gh-pages" ]; then + git checkout master +fi +git branch -D gh-pages +git push origin :gh-pages + +# build examples +npm run build:examples + +# remove superfluous files +find . -type f | egrep -v ".git/|__examples__/" | xargs rm +find . -type d -empty -delete +rm -rf node_modules + +# move example files to root +mv __examples__/* ./ +rm -rf __examples__/ + +# create gh-pages branch +git checkout -b gh-pages +git rm -rf . +git add . +git commit -m "updating gh-pages" +git push -f origin gh-pages +git checkout $BRANCH + +# restore node modules +npm install diff --git a/scripts/release b/scripts/release new file mode 100755 index 0000000000..90dc6662ea --- /dev/null +++ b/scripts/release @@ -0,0 +1,34 @@ +#!/bin/bash + +set -ex + +if [ "$1" == "--preview" ] || [ "$1" == "-P" ] || [ "$1" == "-p" ]; then + # Preview release + changelog -t preview -s +else + # build task has to be run prior to release module + # the release module is what prompts for next version number + # version is needed in order to update the package.json generated by build task + # we are left prompting for version, and updating build/package.json ourselves + # the version gathered here can then be provided to the release module + + update_version() { + echo "$(node -p "p=require('./${1}');p.version='${2}';JSON.stringify(p,null,2)")" > $1 + echo "Updated ${1} version to ${2}" + } + + current_version=$(node -p "require('./package').version") + + printf "Next version (current is $current_version)? " + read next_version + + if ! [[ $next_version =~ ^[0-9]\.[0-9]+\.[0-9](-.+)? ]]; then + echo "Version must be a valid semver string, e.g. 1.0.2 or 2.3.0-beta.1" + exit 1 + fi + + # Release to npm + npm run build + update_version '__build__/package.json' $next_version + release -v $next_version -f ./__build__ +fi diff --git a/scripts/test b/scripts/test new file mode 100755 index 0000000000..eeae74fc54 --- /dev/null +++ b/scripts/test @@ -0,0 +1,6 @@ +#!/bin/bash + +set -e + +eslint -c .eslintrc lib && \ +NODE_ENV=test karma start karma.conf.js "$@" diff --git a/webpack.config.js/dist.js b/webpack.config.js/dist.js new file mode 100644 index 0000000000..6e34508f1f --- /dev/null +++ b/webpack.config.js/dist.js @@ -0,0 +1,25 @@ +/* eslint no-var: 0 */ + +var path = require('path') +var _ = require('lodash') + +var pkg = require('../package') +var baseDir = process.cwd() +var entry = {} + +entry[pkg.name] = pkg.main + +module.exports = _.extend({ + devtool: 'source-map', + entry: entry, + output: { + path: path.resolve(baseDir, '__dist__'), + filename: '[name].js', + library: pkg.name, + libraryTarget: 'umd' + }, + externals: { + 'react': 'React', + 'react/addons': 'React' + } +}, require('./shared')) diff --git a/webpack.config.js/examples.js b/webpack.config.js/examples.js new file mode 100644 index 0000000000..c478109a77 --- /dev/null +++ b/webpack.config.js/examples.js @@ -0,0 +1,45 @@ +/* eslint no-var: 0 */ + +var path = require('path') +var fs = require('fs') +var glob = require('glob') +var webpack = require('webpack') +var HtmlWebpackPlugin = require('html-webpack-plugin') + +var config = require('./shared') +var baseDir = process.cwd() + +config.entry = { + 'vendor': [ 'react' ] +} + +config.output = { + path: path.resolve(process.cwd(), '__examples__'), + filename: '[name].js' +} + +config.plugins = config.plugins.concat([ + new webpack.optimize.CommonsChunkPlugin('vendor', 'vendor.js') +]) + +var components = glob.sync('lib/components/**/package.json') + +components.forEach(function (component) { + var pkg = JSON.parse(fs.readFileSync(component, 'utf8')) + + var entry = pkg.name + '/example' + + config.entry[entry] = path.resolve(path.dirname(component), pkg.directories.example) + + config.plugins.push( + new HtmlWebpackPlugin({ + title: pkg.name, + template: path.resolve(baseDir, 'lib/index.html'), + inject: 'body', + filename: pkg.name + '/index.html', + chunks: ['vendor', entry] + }) + ) +}) + +module.exports = config diff --git a/webpack.config.js/index.js b/webpack.config.js/index.js new file mode 100644 index 0000000000..49f845795f --- /dev/null +++ b/webpack.config.js/index.js @@ -0,0 +1 @@ +module.exports = require('./examples') diff --git a/webpack.config.js/minify.js b/webpack.config.js/minify.js new file mode 100644 index 0000000000..863b67d190 --- /dev/null +++ b/webpack.config.js/minify.js @@ -0,0 +1,40 @@ +/* eslint no-var: 0 */ + +var path = require('path') +var webpack = require('webpack') + +var pkg = require('../package.json') +var baseDir = process.cwd() + +var config = require('./dist') + +config.devtool = 'source-map' +config.entry = {} +config.entry[pkg.name + '.min'] = path.resolve(baseDir, pkg.main) + +config.plugins = config.plugins.concat( + new webpack.optimize.DedupePlugin(), + new webpack.optimize.UglifyJsPlugin({ + mangle: { + except: ['require', 'export', '$super'] + }, + compress: { + warnings: false, + sequences: true, + dead_code: true, + conditionals: true, + booleans: true, + unused: true, + if_return: true, + join_vars: true, + drop_console: true + } + }) +) + +config.postcss = config.postcss.concat([ + require('csswring'), + require('postcss-discard-duplicates')() +]) + +module.exports = config diff --git a/webpack.config.js/shared.js b/webpack.config.js/shared.js new file mode 100644 index 0000000000..3e63f584fe --- /dev/null +++ b/webpack.config.js/shared.js @@ -0,0 +1,78 @@ +/* eslint no-var: 0 */ + +var ExtractTextPlugin = require('extract-text-webpack-plugin') + +module.exports = { + module: { + preLoaders: [ + { + test: /\.js?$/, + loader: 'eslint', + exclude: /node_modules/ + } + ], + loaders: [ + { + test: /\.js$/, + exclude: /node_modules/, + loader: 'babel?optional=runtime&stage=2' + }, + { + test: /\.css$/, + loader: ExtractTextPlugin.extract( + 'style', + 'css?modules&importLoaders=1&localIdentName=ic-[name]__[local]!postcss' + ) + }, + { + test: /\.png$/, + loader: 'url?mimetype=image/png' + }, + { + test: /\.gif$/, + loader: 'url?mimetype=image/gif' + }, + { + test: /\.jpe?g$/, + loader: 'url?mimetype=image/jpeg' + }, + { + test: /\.woff(2)?(\?v=[0-9]\.[0-9]\.[0-9])?$/, + loader: 'url?limit=10000&minetype=application/font-woff' + }, + { + test: /\.(ttf|eot|svg)(\?v=[0-9]\.[0-9]\.[0-9])?$/, + loader: 'file' + } + ] + }, + + resolve: { + modulesDirectories: [ 'components', 'node_modules' ] + }, + + postcss: [ + // Plugins seem to be first in last out + // https://github.com/postcss/postcss#plugins + require('webpack-postcss-tools').prependTildesToImports, + + require('autoprefixer')({ browsers: ['last 2 versions'] }), + + require('postcss-discard-comments')(), + + require('postcss-mixins')(), + require('postcss-nested')(), + require('postcss-simple-vars')(), + require('postcss-color-function')(), + + require('postcss-calc')(), + + require('postcss-url')({ + url: 'inline' + }) + ], + + plugins: [ + new ExtractTextPlugin('[name].css', { allChunks: true }) + ] +} diff --git a/webpack.config.js/test.js b/webpack.config.js/test.js new file mode 100644 index 0000000000..e8401768f8 --- /dev/null +++ b/webpack.config.js/test.js @@ -0,0 +1,8 @@ +/* eslint no-var: 0 */ + +var _ = require('lodash') + +module.exports = _.extend({ + cache: true, + devtool: 'inline-source-map' +}, require('./shared'))