Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartherbert committed Oct 21, 2011
0 parents commit aa84122
Show file tree
Hide file tree
Showing 24 changed files with 664 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.build
dist
.tmp
nbproject
review
vendor
8 changes: 8 additions & 0 deletions .hgignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
syntax: glob

.build
.dist
nbproject
review
tmp
vendor
29 changes: 29 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
New BSD License
===============

Copyright (c) 2011, Stuart Herbert
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the names of the copyright holders nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
ContractLib
===========

**ContractLib** is a simple-to-use PHP component for easily enforcing programming contracts throughout your PHP components. These programming contracts can go a long way to helping you, and the users of your components, develop more robust code..

System-Wide Installation
------------------------

ContractLib should be installed using the [PEAR Installer](http://pear.php.net). This installer is the PHP community's de-facto standard for installing PHP components.

sudo pear channel-discover pear.phix-project.org
sudo pear install --alldeps phix/ContractLib

As A Dependency On Your Component
---------------------------------

If you are creating a component that relies on ContractLib, please make sure that you add LicenseLib to your component's package.xml file:

```xml
<dependencies>
<required>
<package>
<name>ContractLib</name>
<channel>pear.phix-project.org</channel>
<min>1.0.0</min>
<max>1.999.9999</max>
</package>
</required>
</dependencies>
```

Usage
-----

The best documentation for ContractLib are the unit tests, which are shipped in the package. You will find them installed into your PEAR repository, which on Linux systems is normally /usr/share/php/test.

You can find them online on GitHub: http://github.com/stuartherbert/ContractLib/

Development Environment
-----------------------

If you want to patch or enhance this component, you will need to create a suitable development environment, by [installing phix](http://phix-project.org#install).

You can then clone the git repository:

# PropertiesLib
git clone git@github.com:stuartherbert/ContractLib.git

Then, install a local copy of this component's dependencies to complete the development environment:

# build vendor/ folder
phing build-vendor

To make life easier for you, common tasks (such as running unit tests, generating code review analytics, and creating the PEAR package) have been automated using [phing](http://phing.info). You'll find the automated steps inside the build.xml file that ships with the component.

Run the command 'phing' in the component's top-level folder to see the full list of available automated tasks.

License
-------

See LICENSE.txt for full license details.
6 changes: 6 additions & 0 deletions build.local.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<project default="local-help">
<target name="local-help">
<echo message="This component has no local build targets." />
</target>
</project>
<!-- vim: set tabstop=2 shiftwidth=2 expandtab: -->
13 changes: 13 additions & 0 deletions build.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
project.name=ContractLib
project.channel=pear.phix-project.org
project.majorVersion=1
project.minorVersion=0
project.patchLevel=0
project.snapshot=true

checkstyle.standard=Zend

component.type=php-library
component.version=11

pear.local=/var/www/${project.channel}
Loading

0 comments on commit aa84122

Please sign in to comment.