feat: send list classes

[dkoo]

All Submissions:

• Have you followed the Newspack Contributing guideline?
• Does your code follow the WordPress' coding standards and VIP Go coding standards?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

Implements a new Send_List class for abstacting ESP-specific list and sublist data into a single schema. Also implements a Send_Lists class for shared util methods and REST API routes (the latter currently won't work because this PR doesn't include the get_send_lists() methods on each provider class).

To support the new REST API routes, moves the newsletters/v1 namespace and the API permissions callback to the main Newspack_Newsletters class, so these can be shared outside of the Newspack_Newsletters_Subscription class.

How to test the changes in this Pull Request:

1. Confirm that all tests pass (and review the tests for expected Send_List behavior)
2. In wp_shell, try the new constructor:

> $send_list = new Newspack\Newsletters\Send_List( [ 'id' => '123', 'name' => 'My Send List', 'type' => 'list', 'entity_type' => 'something', 'count' => 100, 'provider' => 'mailchimp' ] )
= Newspack\Newsletters\Send_List {#14997
    +"provider": "mailchimp",
    +"type": "list",
    +"entity_type": "something",
    +"id": "123",
    +"name": "My Send List",
    +"count": 100,
    +"value": "123",
    +"label": "[SOMETHING] My Send List (100 contacts)",
  }

3. Try out the new methods:

> $send_list->get_id()
= "123"

> $send_list->get_label()
= "[SOMETHING] My Send List (100 contacts)"

> $send_list->set_name( 'My Send List (renamed)' )
= "My Send List (renamed)"

> $send_list->get_name()
= "My Send List (renamed)"

> Newspack\Newsletters\Send_Lists::matches_search( 'renamed', [ $send_list->get( 'name' ) ] )
= true

> Newspack\Newsletters\Send_Lists::matches_id( [ 123 ], $send_list->get( 'id' ) )
= true

> $send_list->to_array()
= [
    "provider" => "mailchimp",
    "type" => "list",
    "entity_type" => "something",
    "id" => "123",
    "name" => "My Send List",
    "count" => 100,
    "label" => "[SOMETHING] My Send List (100 contacts)",
    "value" => "123",
  ]

Other information:

• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes, as applicable?
• Have you successfully ran tests with your changes locally?

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1207992056607959

[miguelpeixe]

The class looks great and I love how clear the tests are!

I have a few comments:

[codecov]

Codecov Report

Attention: Patch coverage is 64.00000% with 81 lines in your changes missing coverage. Please review.

Project coverage is 21.85%. Comparing base (05c1e23) to head (59594c3).

Files with missing lines	Patch %	Lines
includes/class-send-lists.php	25.00%	54 Missing ⚠️
includes/class-send-list.php	90.00%	14 Missing ⚠️
...cludes/class-newspack-newsletters-subscription.php	0.00%	11 Missing ⚠️
includes/class-newspack-newsletters.php	0.00%	2 Missing ⚠️

Additional details and impacted files

@@                     Coverage Diff                      @@
##             epic/update-editor-uis    #1629      +/-   ##
============================================================
+ Coverage                     20.69%   21.85%   +1.15%     
- Complexity                     2379     2431      +52     
============================================================
  Files                            46       48       +2     
  Lines                          8941     9153     +212     
============================================================
+ Hits                           1850     2000     +150     
- Misses                         7091     7153      +62     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[miguelpeixe]

Thank you for the revisions! Class and tests look great!

Let's get this in to review it in action 😎

[leogermani]

Setting the property directly into an undeclared object property has the downside of letting this prop public.

So I can still access $send_list->label which would skip our getter.

We could come up with some ideas to work around that, maybe using overloading somehow, but I think the easiest thing to do is to store all properties inside one private $config property, which will be an array holding all the properties...

makes sense?

[dkoo]

Ah, I didn't realize that! 69e8232 refactors to use a single protected $config property instead of the separate undeclared properties. This also makes the to_array() method a bit simpler.

[miguelpeixe]

@leogermani reviewed the same time as me 😄

[leogermani]

Nice!

When testing methods like this it is always desirable to test some reallly unhappy tests.

For example, what's the expected return if I pass NULL as one of the parameters? or an Object of any kind? or an integer, etc.

[dkoo]

Great idea! f9bd959 adds some of these tests (as well as some missing handling for those weird cases!).

[leogermani]

That's the beauty of writing tests :)

[leogermani]

This is looking pretty good Derrick! Thanks for all the work building it!

I left only one comment regarding how we store the properties in the object. Other than that this is awesome!