Restructure the repository

[designpatternsphp]

Restructure the repository

[mac2000]

+1

Especially about moving tests closer to examples

It is hard to look at same code in one place, then navigate somewhere to find tests to see how it can be used

It is good practice to put tests in separate folder and get separate autoload-dev for them for real projects but for this one it will be probably more usable to get it all as coloser as possible to each other...

As about pattern categories there can and probably will be some kind of troubles when some pattern can be in both places

[tonicospinelli]

Oh yeah, easy to read and navigate!

About pattern in two or more categories, can you give a sample?

I don't remember any one 😄

[tonicospinelli]

@domnikl ping

[honzabrecka]

I'm against the categories, but move tests closer is really good idea.

[domnikl]

👍 for moving the patterns into the categories folders and moving tests closer. What do you think of having a tests and src in each pattern dir, like this:

|-- Creational
|   |-- Factory
|   |   |-- src
|   |   |-- tests

[mac2000]

I think that there is no need in src and tests subfolders because there is only one test file usually, so it will obviously be better to have something like this:

|-- Adapter
|    |-- AdapterTest.php <-- test file moved to source
|    |-- Book.php
|    |-- EBookAdapter.php
|    |-- EBookInterface.php
|    |-- Kindle.php
|    |-- PaperBookInterface.php
|    |-- README.md

[tonicospinelli]

@domnikl I agree with @mac2000, no need it, because this repo is only for learning about patterns and give implementation samples.

So, all involved agree to move tests closer of implementation.

For now, create or not create Category Namespace? is the question. 😄

[mac2000]

As I think if there is no cases when one pattern can be in two categories (I do not know such patterns) then moving them to category folders with its own Readme.md will be ok, since it can contain more specific description about this group without bloating main readme.md of repo

[tonicospinelli]

+1
It sounds good for me, @mac2000

Category folder with its own README.md

So, the final proposal is:

|-- Creational
|  |-- README.md
|  |-- Factory
|  |  |-- README.md
|  |  |-- SampleClass.php
|  |  |-- SampleTest.php

[tonicospinelli]

@mac2000 @domnikl @johnikx what are you think about the last proposal?

[domnikl]

@tonicospinelli I love it, but I would want to wait until the three new patterns are merged.

[honzabrecka]

@tonicospinelli Let's do it!

[mac2000]

+1

[tonicospinelli]

no problem, I wait and implements the new patterns

[manchuck]

@tonicospinelli 👍

[njasm]

offtopic: but Since you guys are restructuring folder structure, how about...
A Client class inside each patterns folder, with some sample code on how to show the patterns usage from a clients perspective?.. would be a plus.

[axelitus]

Although having a "real-world" implementation is always a good idea to relate the code to a use-case I think that the pattern source code along with the README.md (which I think will have a description of the use of the pattern) would suffice [what I mean: the efforts should be first on the pattern source code and the README.md file, then perhaps do a(several) real world example(s)...].

+1 on the structure and kudos for the repo!

[malukenho]

+1

[tonicospinelli]

@axelitus is the exactly idea about the restructure.
I liked your suggestion to create different samples of each design pattern. So I think is nice create a README.md to explain the sample implementation.

|-- Creational
|  |-- README.md
|  |-- Factory
|  |  |-- README.md
|  |  |-- Sample1
|  |  |  |-- Class.php
|  |  |  |-- Test.php
|  |  |  |-- README.md

Anyone disagree?

[mac2000]

Isn't test show usage example (look at adapter pattern)

I am afraid that there will be real mess if there will be 100500 examples repeating each other, can you please provide some real world examples of that Sampl1...N

[domnikl]

I think the same as @mac2000, there will be too much examples. Why would someone go through more than one implementation to learn about the pattern? Why isn't one sample enough? What are the advantages of adding more than one?

[tonicospinelli]

For me no problem to have one example for a pattern. It's a new proposal only.

So, thinking about it, I believe we take care to accept PRs with not real situation/implementation like Bridge.

That implementation is really superficial and not show where or why I should implement it. Symfony implements a Brigde very well to provide integration with Doctrine.
DoctrineBrigde

What are you think about it?

So, thinking on it, I believe that is a rule to accept PR than to discuss in this issue 😏

[honzabrecka]

I'd say that one, carefully selected, most understandable and "self-describing" example per pattern is ample. Other, not so common and/or less understandable examples can be listed in read me.

I'm for this:

|-- Creational
|  |-- README.md
|  |-- Factory
|  |  |-- README.md
|  |  |-- Factory.php
|  |  |-- tests
|  |  |  |-- FactoryTest.php

[domnikl]

👍 for @johnikx proposal.

@tonicospinelli then why not add DoctrineBridge to the Readme.md of the bridge pattern as in the other patterns?

[tonicospinelli]

@domnikl nice!! I'll do it.
@johnikx 👍

[domnikl]

#86 has been merged, so I think I can close this?

[tonicospinelli]

sure!!

great job guys!! 👍
closing 😄