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.

[henriquemoody]

I'm getting the Between

[henriquemoody]

I'm getting the KeySet

[paulkarikari]

I'm getting AllOf

[DaniloBenevides]

I'm getting Uppercase

[nickl-]

Well done! whoop whoop!!

Unfortunately I'm not quite free right now... knee deep in java, but will try and wriggle my way out before this is done.

[paulkarikari]

while working on AllOf , I realized it is being extended by other Rules, hence setting the class as final is not feasible. Also adding type hinting will cause a cascade of incompatible interfaces and function signatures. I suggest the following task should be tackled in one phase and the other two should be tackled in another phase with much diligence.

• Add docblocks for classes, methods, and properties
• Add @author tag to classes (script that helps doing that: https://gist.github.com/henriquemoody/d4409df72a86dd07b9a794635ce0995a)
• Set properties as final (if it is not extended by other classes)
• Make rule test extend RuleTestCase (when possible)
• Make sure there is 1 (and 1 only) PHPT file for each rule testing only exceptions

---

Next Phase

• Set classes (Rule and Exception) as final (if it is extended by other classes)
• Add PHP 7 type hinting

@henriquemoody @nickl- any taughts ?

[henriquemoody]

Some rules require more than applying the guidelines. I updated the list of Rules in the description of this issue, mentioning only the ones that are easy to work on, I'll pick up myself because of the more structural changes.

If you can pick other rule that will be simpler that would be the cool. If you have something already done already in the "AllOf" rule, you can just send it as it, and I'll pick it up from there you left! But I think we should try to apply the complete list at once, there are too many rules to do into more steps, IMO.

Thanks for your feedback, @koficodes! 🐼

[paulkarikari]

Well noted. will pick another rule for now. Thanks for the quick response. :+1:

[williamespindola]

I'm getting the Contains

[paulkarikari]

I'm getting Even

[DaniloBenevides]

Im getting Lowercase

[williamespindola]

Guys I found a bug on Contains rule during the work. I would send a patch but looking at the history of file this problem exists for a long time ago. I think that we can continue this work and I will join the fix with apply of this issue. What you think about that? About the problem. The Contains rule do not check if an item of array has no identical value because it checks if is array before execute the verification with no identical. This will work v:contains('foo')->check('fool') but this don't v:contains('foo')->check(['fool', 'bar'])

[henriquemoody]

@williamespindola while applying the contribution guidelines I've found a few bugs myself!

However, if I understood what you said correctly that's the expected behaviour.

If you're searching in a string, you need a match in the string:

v:contains('foo')->validate('fool'); // true
v:contains('foo')->validate('fol'); // false

If you're searching in an array, you need a match in the array:

v:contains('foo')->validate(['foo', 'bar'); // true
v:contains('foo')->validate(['fol', 'bar'); // false

It's inverted behaviour of "In".

[henriquemoody]

I'm getting IterableType

[williamespindola]

@henriquemoody I don't know if I get it wrong. But the Contais rule have a flag on constructor to match value identical or not. Then if we passe true it will sought for exactly foo but whether we pass false or nothing this will sought for a similar e.g. foo == fool take a look https://3v4l.org/mYGVe

[williamespindola]

I'm getting Countable

[williamespindola]

I'm getting Cpf

[williamespindola]

I'm getting AlwaysInvalid and AlwaysValid

[williamespindola]

I'm working on ArrayVal, Base64, Base, BoolType and BoolVal

[DaniloBenevides]

I am getting FloatVal and FloatType

[IsmaelElias]

i'm getting Positive

[IsmaelElias]

I'm getting Negative

[DaniloBenevides]

I am getting Odd

[IsmaelElias]

I'm getting PrimeNumber

[paulkarikari]

I'm getting email

[DaniloBenevides]

I'm getting NoWhitespace

[nickl-]

31% completed... this is taking for ever =(

Good job so far guys!

[williamespindola]

working on Bsn, Callback, Charset, Cnh, Cnpj

[DaniloBenevides]

I'm getting PerfectSquare.

[williamespindola]

I'm getting CountryCode, CreditCard, CurrencyCode, Directory and Each

[IsmaelElias]

I'm getting Number

[paulkarikari]

I'm getting :

• Tld
• TrueVal
• Type
• Unique
• Uploaded

[henriquemoody]

There is a new version of the script: https://gist.github.com/henriquemoody/d4409df72a86dd07b9a794635ce0995a

[williamespindola]

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

[nickl-]

52% Whoop whoop!! It's all downhill from here =)

Go-go-go!!

[DaniloBenevides]

I'm getting intVal and Multiple

[nickl-]

Only 54% now, what's happening? We were doing so well!

I saw @henriquemoody agreed to release v1.1.19 is this the reason progress is impacted?

Come on guys almost there, lets get this done!

[nickl-]

I must've missed the memo... has this development now stopped?

[henriquemoody]

Not at all! I did spend quite some time on the version 1.1.19, there were quite a few bugs. In retrospect, that was a bad decision. Now I'm struggling for a few days with the merge of the branch 1.1 into master. However, it should not stop! As soon as I merge the 1.0 I'm right back into the 2.0!

How about you, @koficodes, @DaniloBenevides, and @williamespindola?

And thanks for pushing it forward, @nickl-!

[williamespindola]

I'll be back Just solving some issue in my work

[DaniloBenevides]

I'll be back too! Tomorrow i will try to back to the rhythm

[DaniloBenevides]

I'm getting Image and Imei

[nickl-]

It seems our progress is still stuck at 54% completion.

Is there any obstacles preventing this from moving forward which we could move out of the way or is this purely due to availability constraints?

How about a commitment to get 55%? @DaniloBenevides are you done with Imei and Image yet? @williamespindola has the Sky Labs mainframe authorised your return yet? =)

Lets get this wheel turning again, what do you say?

[nickl-]

Added tick to Multiple rule #1051 ...no progress was really getting me down =)

[DaniloBenevides]

I'm working on Imei Rule , will try to finish till weekend. I think i can try 5 rules per week from next monday. :smile:

[nickl-]

@DaniloBenevides Go get them tiger! =)

gl

[DaniloBenevides]

I'm getting Infinite , Instance and In

[DaniloBenevides]

I'm getting Ip , Json, KeyValue, LanguageCode, LeapDate

[nickl-]

58% complete... steady as she goes.

Nice! =)

[IsmaelElias]

I'm working on:

• Sf
• Size
• Slug
• Sorted
• StartsWith