Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 1.0.0 #2

Merged
merged 31 commits into from
Aug 3, 2018
Merged

Release 1.0.0 #2

merged 31 commits into from
Aug 3, 2018

Conversation

vhrychenko
Copy link
Contributor

@vhrychenko vhrychenko commented Jun 13, 2018

Please confirm

  • No new OS components - or they have been approved by the legal department
  • All new or heavily changed classes get an "A" rating (Scrutinizer), except Facades, Factories, QueryContainers and Tests

Documentation

  • Functional documentation provided or in progress?
  • Integration guide for projects provided or not needed?
  • Migration guides for all contained majors provided or not needed?

Release Table

Module Release Type Constraints
AkeneoPim major

Release Notes

  • 1.0 version for akeneo-pim module.

Module AkeneoPim

Patch: Backwards-compatible bug fix

Def of done (by the responsible developer):

  • All changes are backwards-compatible. The outdated code is marked as deprecated.
  • The change is isolated and not mixed with any cleanups or other changes.
  • New code fits the architecture rules.
  • All new or changed business logic is covered by functional tests (in Zed business layer).
Change log
  • 1.0 version for akeneo-pim module.

Copy link

@gerner-spryker gerner-spryker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really liked it how the adapted client is wrapped everywhere, but it still feels a bit mixed in some places. The Akenea namespace is introduced in the middle of the module, it feels a bit wrong. I will try to come up with an actual alternative proposal if i can.

composer.json Outdated
@@ -2,7 +2,8 @@
"name": "spryker-eco/akeneo-pim",
"description": "Akeneo PIM Integration Module",
"require": {
"akeneo/api-php-client": "^1.0@beta"
"akeneo/api-php-client": "^1.0@beta",
"php-http/guzzle6-adapter": "*"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please clarify version

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kernel is also missing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kernel is added

@@ -0,0 +1,10 @@
# IDEs

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The config.dist.php feels much more like an integration/migration guide. Why was it provided in the code base?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also jobs.dist.php

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with this notice. Removed.

@@ -2,7 +2,8 @@
"name": "spryker-eco/akeneo-pim",
"description": "Akeneo PIM Integration Module",
"require": {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

php >=7.1 is missing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@@ -13,11 +13,9 @@
*/

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove default class comment

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@@ -13,11 +13,9 @@
*/
class AkeneoPimConstants
{

const HOST = 'akeneo.host';

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

public access modifier is missing from constants (php7.1>)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

}

/**
* @inheritdoc

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


use Akeneo\Pim\ApiClient\AkeneoPimClient;

abstract class AbstractApiAdapter implements ApiAdapterInterface

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this class be implemented by the other classes in this directory? Currently there is no usage

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this abstract class is a redundant class here.

/**
* @var \SprykerEco\Service\AkeneoPim\Api\Wrapper\WrapperFactoryInterface
*/
private $wrapperFactory;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why private?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to protected

* @param int $pageSize The size of the page returned by the server.
* @param array $queryParameters Additional query parameters to pass in the request
*
* @return \Akeneo\Pim\ApiClient\Pagination\ResourceCursorInterface

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix the return types

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is wrong here?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Service returns a 3rd party class, and actually it doesn't :)

*.sublime-*
*.AppleDouble
*.AppleDB
*.AppleDesktop

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add phpstan level 7 check (phpstan.json)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

/**
* @return \SprykerEco\Service\AkeneoPim\Api\Adapter\AdapterFactoryInterface
*/
public function createAkeneoPimAdapterFactory()

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PHP7 Typehints please

}

/**
* @inheritdoc

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where are curved brackets?

Copy link

@PhilinTv PhilinTv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Injected namespaces should be in dependency folder.
    Please move adapters to Modules/Dependency/External.

  2. Apply PHP7 convention

  • const visibility
  • typehints

@alex-galych alex-galych merged commit f715a2c into master Aug 3, 2018
build:
dependencies:
before:
- composer config repositories.spryker composer https://code.spryker.com/repo/private
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove outdated repo info.

@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018 SPRYKER SYSTEMS GMBH
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not the right template.
Please see confluence!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

6 participants