Skip to content
This repository was archived by the owner on Jul 31, 2022. It is now read-only.

Commit b5b9819

Browse files
committed
Updated to 1.1.5 version
1 parent 4dd419a commit b5b9819

File tree

13 files changed

+278
-164
lines changed

13 files changed

+278
-164
lines changed

.gitattributes

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
/tests export-ignore
2-
/src/bootstrap.php export-ignore
3-
/vendor export-ignore
42
.gitattributes export-ignore
53
.gitignore export-ignore
64
_config.yml export-ignore
@@ -10,6 +8,7 @@ phpunit.xml.dist export-ignore
108
CONDUCT.md export-ignore
119
contributors.txt export-ignore
1210
README.md export-ignore
11+
phpcs.ruleset.xml export-ignore
1312
README-ES.md export-ignore
1413
.editorconfig export-ignore
1514
composer.lock export-ignore

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@ composer.phar
33
composer.lock
44
composer-test.lock
55
build/artifacts/
6-
artifacts/
6+
vendor/
77
docs/_build
88
docs/*.pyc
99
.git*/
1010
.idea
1111
.DS_STORE
12-
vendor

.travis.yml

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,42 @@ sudo: false
44

55
dist: trusty
66

7+
branches:
8+
only:
9+
- master
10+
711
git:
812
depth: 5
913

1014
php:
1115
- 5.6
1216
- 7.0
1317
- 7.1
18+
- 7.2
1419
- hhvm
1520
- nightly
1621

1722
matrix:
1823
fast_finish: true
24+
include:
25+
- php: 7.1
26+
env: PHPCS=PSR2
27+
1928
allow_failures:
2029
- php: nightly
2130

2231
before_script:
23-
- composer self-update
24-
- composer install
32+
- export PATH="./vendor/bin:$PATH"
33+
- travis_retry composer self-update
34+
- travis_retry composer install --no-interaction --prefer-source --dev
2535

2636
script:
27-
- composer test
37+
- phpunit
38+
- |
39+
if [[ "$PHPCS" ]] ; then
40+
phpcs --standard=phpcs.ruleset.xml $(find . -name '*.php')
41+
fi
42+
phpunit --coverage-clover=coverage.xml
43+
44+
after_success:
45+
- bash <(curl -s https://codecov.io/bash)

CHANGELOG.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# CHANGELOG
22

3+
## 1.1.5 - 2017-11-01
4+
5+
* Implemented `PSR-4 autoloader standard` from all library files.
6+
7+
* Implemented `PSR-2 coding standard` from all library PHP files.
8+
9+
* Implemented `PHPCS` to ensure that PHP code complies with `PSR2` code standards.
10+
11+
* Implemented `Codacy` to automates code reviews and monitors code quality over time.
12+
13+
* Implemented `Codecov` to coverage reports.
14+
15+
* Added `Ip/phpcs.ruleset.xml` file.
16+
17+
* Deleted `Ip/src/bootstrap.php` file.
18+
19+
* Deleted `Ip/tests/bootstrap.php` file.
20+
21+
* Deleted `Ip/vendor` folder.
22+
23+
* Changed `Josantonius\Ip\Test\IpTest` class to `Josantonius\Ip\IpTest` class.
24+
25+
* Added `Josantonius\Ip\Ip::getGlobalValue()` method.
26+
327
## 1.1.4 - 2017-09-14
428

529
* Unit tests supported by `PHPUnit` were added.

README-ES.md

Lines changed: 79 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# PHP Ip library
22

3-
[![Latest Stable Version](https://poser.pugx.org/josantonius/ip/v/stable)](https://packagist.org/packages/josantonius/ip) [![Total Downloads](https://poser.pugx.org/josantonius/ip/downloads)](https://packagist.org/packages/josantonius/ip) [![Latest Unstable Version](https://poser.pugx.org/josantonius/ip/v/unstable)](https://packagist.org/packages/josantonius/ip) [![License](https://poser.pugx.org/josantonius/ip/license)](https://packagist.org/packages/josantonius/ip) [![Travis](https://travis-ci.org/Josantonius/PHP-Ip.svg)](https://travis-ci.org/Josantonius/PHP-Ip)
3+
[![Latest Stable Version](https://poser.pugx.org/josantonius/Ip/v/stable)](https://packagist.org/packages/josantonius/Ip) [![Latest Unstable Version](https://poser.pugx.org/josantonius/Ip/v/unstable)](https://packagist.org/packages/josantonius/Ip) [![License](https://poser.pugx.org/josantonius/Ip/license)](LICENSE) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/9a38ca1727464eb2bbac06a1bb163bce)](https://www.codacy.com/app/Josantonius/PHP-Ip?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Josantonius/PHP-Ip&amp;utm_campaign=Badge_Grade) [![Total Downloads](https://poser.pugx.org/josantonius/Ip/downloads)](https://packagist.org/packages/josantonius/Ip) [![Travis](https://travis-ci.org/Josantonius/PHP-Ip.svg)](https://travis-ci.org/Josantonius/PHP-Ip) [![PSR2](https://img.shields.io/badge/PSR-2-1abc9c.svg)](http://www.php-fig.org/psr/psr-2/) [![PSR4](https://img.shields.io/badge/PSR-4-9b59b6.svg)](http://www.php-fig.org/psr/psr-4/) [![CodeCov](https://codecov.io/gh/Josantonius/PHP-Ip/branch/master/graph/badge.svg)](https://codecov.io/gh/Josantonius/PHP-Ip)
44

55
[English version](README.md)
66

77
Biblioteca PHP para obtener la IP del usuario.
88

99
---
1010

11-
- [Instalación](#instalación)
1211
- [Requisitos](#requisitos)
13-
- [Cómo empezar y ejemplos](#cómo-empezar-y-ejemplos)
12+
- [Instalación](#instalación)
1413
- [Métodos disponibles](#métodos-disponibles)
14+
- [Cómo empezar](#cómo-empezar)
1515
- [Uso](#uso)
1616
- [Tests](#tests)
1717
- [Tareas pendientes](#-tareas-pendientes)
@@ -22,71 +22,120 @@ Biblioteca PHP para obtener la IP del usuario.
2222

2323
---
2424

25-
### Instalación
25+
## Requisitos
26+
27+
Esta clase es soportada por versiones de **PHP 5.6** o superiores y es compatible con versiones de **HHVM 3.0** o superiores.
2628

27-
La mejor forma de instalar esta extensión es a través de [composer](http://getcomposer.org/download/).
29+
## Instalación
2830

29-
Para instalar PHP Ip library, simplemente escribe:
31+
La mejor forma de instalar esta extensión es a través de [Composer](http://getcomposer.org/download/).
32+
33+
Para instalar **PHP Ip library**, simplemente escribe:
3034

3135
$ composer require Josantonius/Ip
3236

33-
El comando anterior sólo instalará los archivos necesarios, si prefieres descargar todo el código fuente (incluyendo tests, directorio vendor, excepciones no utilizadas, documentos...) puedes utilizar:
37+
El comando anterior sólo instalará los archivos necesarios, si prefieres **descargar todo el código fuente** puedes utilizar:
3438

3539
$ composer require Josantonius/Ip --prefer-source
3640

37-
También puedes clonar el repositorio completo con Git:
41+
También puedes **clonar el repositorio** completo con Git:
42+
43+
$ git clone https://github.com/Josantonius/PHP-Ip.git
3844

39-
$ git clone https://github.com/Josantonius/PHP-Ip.git
45+
O **instalarlo manualmente**:
46+
47+
[Descargar Ip.php](https://raw.githubusercontent.com/Josantonius/PHP-Ip/master/src/Ip.php):
48+
49+
$ wget https://raw.githubusercontent.com/Josantonius/PHP-Ip/master/src/Ip.php
50+
51+
## Métodos disponibles
52+
53+
Métodos disponibles en esta biblioteca:
54+
55+
### - Obtener IP del usuario:
56+
57+
```php
58+
Ip::get();
59+
```
60+
61+
**# Return** (string|false) → IP o falso
62+
63+
### - Validar IP:
64+
65+
```php
66+
Ip::validate($ip);
67+
```
4068

41-
### Requisitos
69+
| Atributo | Descripción | Tipo | Requerido | Predeterminado
70+
| --- | --- | --- | --- | --- |
71+
| $ip | Dirección IP a validar. | string || |
4272

43-
Esta biblioteca es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.
73+
**# Return** (boolean)
4474

45-
### Cómo empezar y ejemplos
75+
## Cómo empezar
4676

47-
Para utilizar esta biblioteca, simplemente:
77+
Para utilizar esta biblioteca con **Composer**:
4878

4979
```php
5080
require __DIR__ . '/vendor/autoload.php';
5181

5282
use Josantonius\Ip\Ip;
5383
```
54-
### Métodos disponibles
5584

56-
Métodos disponibles en esta biblioteca:
85+
Si la instalaste **manualmente**, utiliza:
5786

5887
```php
59-
Ip::get();
88+
require_once __DIR__ . '/Ip.php';
89+
90+
use Josantonius\Ip\Ip;
6091
```
61-
### Uso
92+
93+
## Uso
6294

6395
Ejemplo de uso para esta biblioteca:
6496

97+
### - Obtener IP del usuario:
98+
6599
```php
66-
<?php
67-
require __DIR__ . '/vendor/autoload.php';
100+
Ip::get();
101+
```
68102

69-
use Josantonius\Ip\Ip;
103+
### - Validar IP:
104+
105+
```php
106+
$ip = Ip::get();
70107

71-
print_r(Ip::get()); # 66.249.76.29
108+
Ip::validate($ip);
72109
```
73110

74-
### Tests
111+
## Tests
75112

76-
Para ejecutar las [pruebas](tests/Ip/Test) simplemente:
113+
Para ejecutar las [pruebas](tests) necesitarás [Composer](http://getcomposer.org/download/) y seguir los siguientes pasos:
77114

78115
$ git clone https://github.com/Josantonius/PHP-Ip.git
79116

80117
$ cd PHP-Ip
81118

82-
$ phpunit
119+
$ composer install
120+
121+
Ejecutar pruebas unitarias con [PHPUnit](https://phpunit.de/):
122+
123+
$ composer phpunit
124+
125+
Ejecutar pruebas de estándares de código [PSR2](http://www.php-fig.org/psr/psr-2/) con [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer):
126+
127+
$ composer phpcs
128+
129+
Ejecutar todas las pruebas anteriores:
130+
131+
$ composer tests
83132

84-
### ☑ Tareas pendientes
133+
## ☑ Tareas pendientes
85134

86135
- [x] Completar tests
87-
- [ ] Mejorar la documentación
136+
- [x] Mejorar la documentación
88137

89-
### Contribuir
138+
## Contribuir
90139

91140
1. Comprobar si hay incidencias abiertas o abrir una nueva para iniciar una discusión en torno a un fallo o función.
92141
1. Bifurca la rama del repositorio en GitHub para iniciar la operación de ajuste.
@@ -96,15 +145,15 @@ Para ejecutar las [pruebas](tests/Ip/Test) simplemente:
96145

97146
Esto está pensado para proyectos grandes y de larga duración.
98147

99-
### Repositorio
148+
## Repositorio
100149

101150
Los archivos de este repositorio se crearon y subieron automáticamente con [Reposgit Creator](https://github.com/Josantonius/BASH-Reposgit).
102151

103-
### Licencia
152+
## Licencia
104153

105154
Este proyecto está licenciado bajo **licencia MIT**. Consulta el archivo [LICENSE](LICENSE) para más información.
106155

107-
### Copyright
156+
## Copyright
108157

109158
2017 Josantonius, [josantonius.com](https://josantonius.com/)
110159

0 commit comments

Comments
 (0)