Apply contribution guidelines

[henriquemoody]

TL;DR

• Make sure you're based on the master branch
• Refactor all rules as in #902
• Write a comment with the rule you're going to work on before sending a PR

---

It's been a MAJOR or MINOR version of the library has been released. There are enough things to release the version 2.0 but I need your help.

I wrote new Contribution Guidelines and before I creating the tag 2.0.0 I would like to have all rules with the same standard.

Applying the Contribution Guidelines consist of:

• Add docblocks for classes, methods, and properties
• Add your @author tag to classes you changed
• Set properties as private
• Set classes (Rule and Exception) as final
• Add PHP 7.1 type hinting
• Make rule test extend RuleTestCase (when possible)
• Make sure there is 1 (and 1 only) PHPT file for each rule testing only exceptions

I've done some already but there is still a lot to go, write a comment with the rule name before you start working on it, so two people don't work on the same thing!

Hope you can help!

Rules

• [ ] ~AllOf~ (needs refactoring)
• [x] Alnum
• [x] Alpha
• [x] AlwaysInvalid
• [x] AlwaysValid
• [x] ~AnyOf~ (needs refactoring)
• [x] ArrayType
• [x] ArrayVal
• [x] Attribute
• [x] Base
• [x] Base64
• [x] Between
• [x] BoolType
• [x] BoolVal
• [x] Bsn
• [x] Call
• [x] CallableType
• [x] Callback
• [x] Charset
• [x] Cnh
• [x] Cnpj
• [x] Cntrl
• [x] Consonant
• [x] Contains
• [x] ContainsAny
• [x] Countable
• [x] CountryCode
• [x] Cpf
• [x] CreditCard
• [x] CurrencyCode
• [x] Date
• [x] DateTime
• [x] Digit
• [x] Directory
• [x] ~Domain~ (needs refactoring)
• [x] Each
• [x] Email
• [x] EndsWith
• [x] Equals
• [x] Equivalent
• [x] Even
• [x] Executable
• [x] Exists
• [x] Extension
• [x] Factor
• [x] FalseVal
• [x] Fibonacci
• [x] File
• [x] FilterVar
• [x] Finite
• [x] FloatType
• [x] FloatVal
• [x] Graph
• [x] GreaterThan
• [x] ~HexRgbColor~ (needs refactoring)
• [x] Identical
• [x] IdentityCard
• [x] Image
• [x] Imei
• [x] In
• [x] Infinite
• [x] Instance
• [x] IntType
• [x] IntVal
• [x] Ip
• [x] Isbn
• [x] IterableType
• [x] Json
• [x] ~Key~ (needs refactoring)
• [x] ~KeyNested~ (needs refactoring)
• [x] KeySet
• [x] KeyValue
• [x] LanguageCode
• [x] LeapDate
• [x] LeapYear
• [x] Length
• [x] LessThan
• [x] Lowercase
• [x] Luhn
• [x] MacAddress
• [x] Max
• [x] MaxAge
• [x] Mimetype
• [x] Min
• [x] MinAge
• [x] Multiple
• [x] Negative
• [x] NfeAccessKey
• [x] Nif
• [x] ~No~ (needs refactoring)
• [x] NoWhitespace
• [x] ~NoneOf~ (needs refactoring)
• [x] ~Not~ (needs refactoring)
• [x] NotBlank
• [x] ~NotEmpty~ (needs refactoring)
• [x] NotOptional
• [x] NullType
• [x] Nullable
• [x] Number
• [x] NumericVal
• [x] ObjectType
• [x] Odd
• [x] ~OneOf~ (needs refactoring)
• [x] ~Optional~ (needs refactoring)
• [x] PerfectSquare
• [x] Pesel
• [x] Phone
• [x] PhpLabel
• [x] Pis
• [x] Positive
• [x] ~PostalCode~ (needs refactoring)
• [x] PrimeNumber
• [x] Printable
• [x] Punct
• [x] Readable
• [x] Regex
• [x] ResourceType
• [x] ~Roman~ (needs refactoring)
• [x] ScalarVal
• [x] Sf
• [x] Size
• [x] Slug
• [x] Sorted
• [x] Space
• [x] StartsWith
• [x] StringType
• [x] StringVal
• [x] SubdivisionCode
• [x] Subset
• [x] SymbolicLink
• [x] Time
• [x] Tld
• [x] TrueVal
• [x] Type
• [x] Unique
• [x] Uploaded
• [x] Uppercase
• [x] Url
• [x] Uuid
• [x] Vatin
• [x] Version
• [x] VideoUrl
• [x] Vowel
• [x] When
• [x] Writable
• [x] ~Xdigit~ (needs refactoring)
• [x] Yes
• [x] ~Zend~ (needs refactoring)

Some rules are not on the list, but they are not Easy Pick.

[dcorrea777]

I'm working on Length

[dcorrea777]

@henriquemoody I think the IN rule has already been made, but it has not been checked.

[dcorrea777]

I'm working on:

• NumericVal
• StringVal

[dcorrea777]

I'm working on:

• Pesel
• PhpLabel
• Pis

[dcorrea777]

I'm working on:

• Readable
• Regex

[henriquemoody]

I removed some rules from the list. There are some rules that I still have to figure out what to do with them:

• AllOf
• Alpha
• AnyOf
• Cntrl
• Consonant
• Digit
• Domain
• Graph
• HexRgbColor
• Key
• KeyNested
• No
• NoneOf
• Not
• NotEmpty
• OneOf
• Optional
• Phone
• PostalCode
• Punct
• Regex
• Roman
• Space
• Uuid
• Vowel
• Xdigit
• Yes

I'm picking these ones up. I will take what was already one in #1101 and #1102.

[dcorrea777]

I'm working on:

• NotBlank
• NotOptional

[dcorrea777]

I'm working on LeapYear

[dcorrea777]

I'm working on:

• Luhn
• MacAddress
• Mimetype

[nickl-]

Wah-Wah-Wee-Waa!!! 77% is very nice!!!

=)

[CameronHall]

I'm working on Yes

[dcorrea777]

I'm working on: EndsWith, Executable, Exists, Extension, Factor, FalseVal, Fibonacci, File, Finite

@williamespindola as we talked in the pub, I'll get the rules Extension, Factor, FalseVal, Fibonacci, File, Finite, ok?

[dcorrea777]

I'm working on:

• Version
• VideoUrl
• When
• Writable
• Zend

[CameronHall]

I'm working on;

• Cntrl
• Consonant
• Graph
• HexRgbColor
• Printable
• Punct
• Space
• Vowel
• Xdigit

[leonampd]

I'm working on:

• NfeAccessKey
• Phone

[GusAntoniassi]

Hello, I will pick up SymbolicLink. From what I gathered, it's the only one not being worked on, and the list of available options (including the ones being worked on) would be:

• Size
• Slug
• Sorted
• SymbolicLink
• VideoUrl
• When
• Writable

Is this correct?

[henriquemoody]

Happy to hear you would like to contribue, @GusAntoniassi!

The rules that still need to be updated but that are easy to pick are:

• Cntrl
• Consonant
• Graph
• KeyValue
• NfeAccessKey
• Phone
• Punct
• Size
• Slug
• Sorted
• Space
• StartsWith
• SymbolicLink
• Vowel

However, there are also other rules that needs some refactoring, in which each case needs some speciall discussion:

• AllOf
• AnyOf
• Domain
• HexRgbColor
• Ip
• Key
• KeyNested
• No
• NoneOf
• Not
• NotEmpty
• OneOf
• Optional
• PostalCode
• Regex
• Roman
• Xdigit
• Zend

Feel free to pick any of them!

[henriquemoody]

It's been quite a ride!

The only rule that is missing now is AllOf, the rest is pretty much done, which means that it won't take long to release 2.0! I would need to create some good documentation about the release before doing it, but we are very close!

[sunchayn]

what's wrong with AllOf ? is there anyone working on it ?

[henriquemoody]

The most important thing is that it becomes final. What could be nice was to remove the addRule from AbstractComposite. It's a bit complicated because Validator itself extends it -- which for me justifies having an abstract class. I've started to work on that already, but I will only have time to keep working on it next week, so if anyone would like to work on it, feel free, just let me know!

[henriquemoody]

This is being shipped already!