# Summary

This module integrates the Site Catalyst analytics software into a Drupal site. All future development of what used to be the siteCatalyst module will happen here because it is now owned by Adobe and renamed to AdobeAnalytics Module.

# Project URL

https://www.drupal.org/project/adobe_analytics

# Where is the code?

D7 : https://www.drupal.org/project/sitecatalyst
D8 dev release: https://www.drupal.org/project/adobe_analytics/releases/8.x-1.x-dev
http://git.drupal.org/sandbox/panshulk1/2641758.git

# Estimated completion date

Need review

# Dependencies

N/A

# Who's doing the port?

Module Maintainers :
Kuldev Singh
Panshul Khurana

# What help do they need?

Review

# D8 roadmap

#2700715: D8 Port of Adobe Analytics (SiteCatalyst) to D8

# Background and reference information

N/A

Comments

panshulk created an issue. See original summary.

zeeshan_khan’s picture

Issue summary: View changes

We need git details in Issue description for review process Thanks!

gauravjeet’s picture

Issue summary: View changes

@panshulk - please create an issue here. You can refer to the current projects for creating your issue.

You need to make some edits in the text above :
- Put [sitecatalyst] as the short code,
- Put cgit repository code here (Browse Code repository link available at the bottom right side of the sandbox page) - Where is the code?
- Fill in a tentative Estimated completion date (, if any)
- Put name of the module maintainers in Who's doing the port?

panshulk’s picture

Title: [adobeanalytics]AdobeAnalytics » [sitecatalyst]AdobeAnalytics
Issue summary: View changes
zeeshan_khan’s picture

Issue summary: View changes
zeeshan_khan’s picture

Category: Plan » Task
zeeshan_khan’s picture

Status: Needs review » Needs work

Git errors:

Git default branch is not set, see the documentation on setting a default branch.
Review of the 8.x-1.x branch (commit ac8b272):

Remove all .idea files from your repository.
Remove all backup files from your repository:

./adobeanalytics.routing.yml~
./adobeanalytics.yml~
./adobeanalytics.info.yml~
./sitecatalyst.info.yml~
./adobeanalytics.links.menu.yml~
./AdobeAnalytics(20.3).example.txt~
./adobeanalytics.install~
./README.txt~
./sitecatalyst.links.menu.yml~
./adobeanalytics.module~
./upgrade-info.html~
./adobeanalytics.libraries.yml~
./sitecatalyst.routing.yml~
./adobeanalytics.info~
Bad line endings were found, always use unix style terminators. See https://www.drupal.org/coding-standards#indenting

./.idea/.name: ASCII text, with no line terminators

Coder Sniffer has found some issues with your code (please check the Drupal coding standards). See attachment.
DrupalPractice has found some issues with your code, but could be false positives.
FILE: /var/www/drupal-7-pareview/pareview_temp/src/AdobeAnalyticsHelper.php
---------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
---------------------------------------------------------------------------
51 | WARNING | Unused variable $context.
---------------------------------------------------------------------------

Time: 93ms; Memory: 5.75Mb

Codespell has found some spelling errors in your code.

./adobeanalytics.install~:133: loosing ==> losing
./README.txt~:51: refering ==> referring
./README.txt~:54: refering ==> referring
./README.txt:51: refering ==> referring
./README.txt:54: refering ==> referring
./adobeanalytics.module~:486: wierd ==> weird
No automated test cases were found, did you consider writing Simpletests or PHPUnit tests? This is not a requirement but encouraged for professional software development.
This automated report was generated with PAReview.sh, your friendly project application review script. You can also use the online version to check your project. You have to get a review bonus to get a review from me.

FILE: ...ar/www/drupal-7-pareview/pareview_temp/adobeanalytics.permissions.yml
---------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------
4 | ERROR | [x] Expected 1 newline at end of file; 0 found
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

FILE: ...l-7-pareview/pareview_temp/config/install/adobeanalytics.settings.yml
---------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------
8 | ERROR | [x] Expected 1 newline at end of file; 3 found
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

FILE: /var/www/drupal-7-pareview/pareview_temp/adobeanalytics.module
---------------------------------------------------------------------------
FOUND 15 ERRORS AND 2 WARNINGS AFFECTING 17 LINES
---------------------------------------------------------------------------
9 | ERROR | [ ] Doc comment short description must be on a single
| | line, further text should be a separate paragraph
17 | ERROR | [x] There must be one blank line after the last USE
| | statement; 4 found;
20 | ERROR | [ ] More than 2 empty lines are not allowed
21 | ERROR | [ ] More than 2 empty lines are not allowed
39 | ERROR | [ ] Variable "safeMarkup" is camel caps format. do not
| | use mixed case (camelCase), use lower case and _
40 | ERROR | [ ] Variable "adobeAnalyticsHelper" is camel caps format.
| | do not use mixed case (camelCase), use lower case and
| | _
79 | ERROR | [ ] Variable "safeMarkup" is camel caps format. do not
| | use mixed case (camelCase), use lower case and _
82 | ERROR | [ ] Variable "adobeAnalyticsHelper" is camel caps format.
| | do not use mixed case (camelCase), use lower case and
| | _
83 | ERROR | [ ] Variable "adobeAnalyticsHelper" is camel caps format.
| | do not use mixed case (camelCase), use lower case and
| | _
94 | ERROR | [ ] Variable "safeMarkup" is camel caps format. do not
| | use mixed case (camelCase), use lower case and _
96 | WARNING | [ ] Line exceeds 80 characters; contains 123 characters
113 | ERROR | [ ] Variable "safeMarkup" is camel caps format. do not
| | use mixed case (camelCase), use lower case and _
121 | ERROR | [ ] Variable "adobeAnalyticsHelper" is camel caps format.
| | do not use mixed case (camelCase), use lower case and
| | _
146 | ERROR | [ ] More than 2 empty lines are not allowed
148 | WARNING | [ ] Format should be "* Implements hook_foo().", "*
| | Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "*
| | Implements hook_foo_BAR_ID_bar() for
| | xyz-bar.html.twig.", or "* Implements
| | hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.".
153 | ERROR | [ ] Variable "adobeAnalyticsHelper" is camel caps format.
| | do not use mixed case (camelCase), use lower case and
| | _
165 | ERROR | [ ] Variable "adobeAnalyticsHelper" is camel caps format.
| | do not use mixed case (camelCase), use lower case and
| | _
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

FILE: ...pal-7-pareview/pareview_temp/src/Form/AdobeanalyticsAdminSettings.php
---------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not
| | begin with a file doc comment
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

FILE: /var/www/drupal-7-pareview/pareview_temp/src/AdobeAnalyticsHelper.php
---------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not
| | begin with a file doc comment
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

FILE: /var/www/drupal-7-pareview/pareview_temp/README.txt
---------------------------------------------------------------------------
FOUND 15 ERRORS AND 2 WARNINGS AFFECTING 14 LINES
---------------------------------------------------------------------------
42 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 4
43 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 4
45 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 4
46 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
48 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
49 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
51 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
52 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
54 | WARNING | [ ] Line exceeds 80 characters; contains 84 characters
54 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
55 | WARNING | [ ] Line exceeds 80 characters; contains 81 characters
55 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
56 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
56 | ERROR | [x] Expected 1 space after closing parenthesis; found 2
57 | ERROR | [x] Line indented incorrectly; expected 6 spaces, found 8
58 | ERROR | [x] Line indented incorrectly; expected 8 spaces, found 10
59 | ERROR | [x] Line indented incorrectly; expected 8 spaces, found 10
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 15 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

Time: 209ms; Memory: 8.25Mb

zeeshan_khan’s picture

Title: [sitecatalyst]AdobeAnalytics » [sitecatalyst] AdobeAnalytics

@Panshul - if you're porting SiteCatalyst to D8 then I request you to use same naming convention it will be easy for existing users to understand your module.

panshulk’s picture

@Zeeshan - The module is renamed according to the discussion here.

mobaid’s picture

Confirmed on the renaming.

panshulk’s picture

Status: Needs work » Needs review
zeeshan_khan’s picture

Status: Needs review » Needs work

Automated Review:
Please fix coding standard and git issues first then I'll do a Manual review of your project.
You have not done any manual review, you need to do at least 3 manual reviews to get review bonus that will boost up you project review process. Make sure to read through the source code of the other projects, as requested on the review bonus page.

Git errors:

Git default branch is not set, see the documentation on setting a default branch.
Review of the 8.x-1.x branch (commit cacf819):

Remove all .idea files from your repository.
Remove all backup files from your repository:

./adobeanalytics.routing.yml~
./adobeanalytics.yml~
./adobeanalytics.info.yml~
./sitecatalyst.info.yml~
./config/install/adobeanalytics.settings.yml~
./adobeanalytics.links.menu.yml~
./AdobeAnalytics(20.3).example.txt~
./src/Form/AdobeanalyticsAdminSettings.php~
./src/AdobeAnalyticsHelper.php~
./adobeanalytics.install~
./README.txt~
./sitecatalyst.links.menu.yml~
./adobeanalytics.module~
./upgrade-info.html~
./adobeanalytics.libraries.yml~
./sitecatalyst.routing.yml~
./adobeanalytics.info~
Bad line endings were found, always use unix style terminators. See https://www.drupal.org/coding-standards#indenting

./.idea/.name: ASCII text, with no line terminators

Coder Sniffer has found some issues with your code (please check the Drupal coding standards). See attachment.
DrupalPractice has found some issues with your code, but could be false positives.
FILE: /var/www/drupal-7-pareview/pareview_temp/src/AdobeAnalyticsHelper.php
---------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
---------------------------------------------------------------------------
52 | WARNING | Unused variable $context.
---------------------------------------------------------------------------

Time: 91ms; Memory: 5.75Mb

Codespell has found some spelling errors in your code.

./adobeanalytics.install~:133: loosing ==> losing
./README.txt~:51: refering ==> referring
./README.txt~:54: refering ==> referring
./README.txt:51: refering ==> referring
./README.txt:54: refering ==> referring
No automated test cases were found, did you consider writing Simpletests or PHPUnit tests? This is not a requirement but encouraged for professional software development.
This automated report was generated with PAReview.sh, your friendly project application review script. You can also use the online version to check your project. You have to get a review bonus to get a review from me.

FILE: ...ar/www/drupal-7-pareview/pareview_temp/adobeanalytics.permissions.yml
---------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------
4 | ERROR | [x] Expected 1 newline at end of file; 0 found
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

FILE: ...l-7-pareview/pareview_temp/config/install/adobeanalytics.settings.yml
---------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------
8 | ERROR | [x] Expected 1 newline at end of file; 3 found
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

FILE: /var/www/drupal-7-pareview/pareview_temp/adobeanalytics.module
---------------------------------------------------------------------------
FOUND 15 ERRORS AND 2 WARNINGS AFFECTING 17 LINES
---------------------------------------------------------------------------
9 | ERROR | [ ] Doc comment short description must be on a single
| | line, further text should be a separate paragraph
17 | ERROR | [x] There must be one blank line after the last USE
| | statement; 4 found;
20 | ERROR | [ ] More than 2 empty lines are not allowed
21 | ERROR | [ ] More than 2 empty lines are not allowed
39 | ERROR | [ ] Variable "safeMarkup" is camel caps format. do not
| | use mixed case (camelCase), use lower case and _
40 | ERROR | [ ] Variable "adobeAnalyticsHelper" is camel caps format.
| | do not use mixed case (camelCase), use lower case and
| | _
79 | ERROR | [ ] Variable "safeMarkup" is camel caps format. do not
| | use mixed case (camelCase), use lower case and _
82 | ERROR | [ ] Variable "adobeAnalyticsHelper" is camel caps format.
| | do not use mixed case (camelCase), use lower case and
| | _
83 | ERROR | [ ] Variable "adobeAnalyticsHelper" is camel caps format.
| | do not use mixed case (camelCase), use lower case and
| | _
94 | ERROR | [ ] Variable "safeMarkup" is camel caps format. do not
| | use mixed case (camelCase), use lower case and _
96 | WARNING | [ ] Line exceeds 80 characters; contains 123 characters
113 | ERROR | [ ] Variable "safeMarkup" is camel caps format. do not
| | use mixed case (camelCase), use lower case and _
121 | ERROR | [ ] Variable "adobeAnalyticsHelper" is camel caps format.
| | do not use mixed case (camelCase), use lower case and
| | _
146 | ERROR | [ ] More than 2 empty lines are not allowed
148 | WARNING | [ ] Format should be "* Implements hook_foo().", "*
| | Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "*
| | Implements hook_foo_BAR_ID_bar() for
| | xyz-bar.html.twig.", or "* Implements
| | hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.".
153 | ERROR | [ ] Variable "adobeAnalyticsHelper" is camel caps format.
| | do not use mixed case (camelCase), use lower case and
| | _
165 | ERROR | [ ] Variable "adobeAnalyticsHelper" is camel caps format.
| | do not use mixed case (camelCase), use lower case and
| | _
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

FILE: ...pal-7-pareview/pareview_temp/src/Form/AdobeanalyticsAdminSettings.php
---------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not
| | begin with a file doc comment
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

FILE: /var/www/drupal-7-pareview/pareview_temp/src/AdobeAnalyticsHelper.php
---------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 2 LINES
---------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not
| | begin with a file doc comment
29 | ERROR | [x] Spaces must be used to indent lines; tabs are not
| | allowed
29 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 1
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

FILE: /var/www/drupal-7-pareview/pareview_temp/README.txt
---------------------------------------------------------------------------
FOUND 21 ERRORS AND 2 WARNINGS AFFECTING 16 LINES
---------------------------------------------------------------------------
42 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 4
43 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 4
44 | ERROR | [x] Spaces must be used to indent lines; tabs are not
| | allowed
44 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 1
44 | ERROR | [ ] Variable "configVar" is camel caps format. do not use
| | mixed case (camelCase), use lower case and _
44 | ERROR | [x] Expected one space after the comma, 0 found
45 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 4
45 | ERROR | [ ] Variable "configVar" is camel caps format. do not use
| | mixed case (camelCase), use lower case and _
46 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
48 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
49 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
51 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
52 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
54 | WARNING | [ ] Line exceeds 80 characters; contains 84 characters
54 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
55 | WARNING | [ ] Line exceeds 80 characters; contains 81 characters
55 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
56 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 6
56 | ERROR | [x] Expected 1 space after closing parenthesis; found 2
57 | ERROR | [x] Line indented incorrectly; expected 6 spaces, found 8
58 | ERROR | [x] Line indented incorrectly; expected 8 spaces, found 10
59 | ERROR | [x] Line indented incorrectly; expected 8 spaces, found 10
79 | ERROR | [x] Concat operator must be surrounded by a single space
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 19 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

heddn’s picture

Can we use this issue as a meta issue to track the status and open an issue in the project's issue queue for the actual work?

heddn’s picture

I've opened #2700715: D8 Port of Adobe Analytics (SiteCatalyst) to D8 to do just that. And also linked in #2682257: [D8]AdobeAnalytics, which is the full project application for
panshulk.

panshulk’s picture

Status: Needs work » Reviewed & tested by the community

Thanks @heddn for the support :)

zeeshan_khan’s picture

Status: Reviewed & tested by the community » Needs work

Hi @panshulk,

Please update the issue opened by @heddn with all the details.
There's a fatal Error in your module: PHP Fatal error: Can't use method return value in write context in ./src/Form/AdobeanalyticsAdminSettings.php on line 91
Errors parsing ./src/Form/AdobeanalyticsAdminSettings.php

panshulk’s picture

Status: Needs work » Needs review

Hi @Zeeshan_khan

Thank you for the review :)
I have updated the issue opened by @heddn with all the details. Also the fatal error on line 91 in AdobeanalyticsAdminSettings.php has been fixed.

MustangGB’s picture

Category: Task » Plan
zeeshan_khan’s picture

Status: Needs review » Reviewed & tested by the community

Changing status to RTBC as per the fixes here: https://www.drupal.org/node/2700715

mmjvb’s picture

Are you going to provide an RC or Stable version?
Current status suggests there to be an RC, only see a dev !

mmjvb’s picture

Issue summary: View changes
Status: Reviewed & tested by the community » Needs work

With only a dev release Status should be `Needs work`
See https://www.drupal.org/project/adobe_analytics

apaderno’s picture

Status: Needs work » Needs review

The project has an alpha release.

zeeshan_khan’s picture

Status: Needs review » Reviewed & tested by the community

I have checked and tested module on drupal 8 and drupal 9 everything looks fine to me.

apaderno’s picture

Assigned: panshulk » Unassigned
Status: Reviewed & tested by the community » Needs review

In this queue, the status has a different meaning. Needs review is used when the project has an alpha or beta release; Reviewed & tested by the community is used when the project has a release candidate release, as described in this project page.

zeeshan_khan’s picture

@apaderno - what do you purpose here, should I create a stable release for the project or anything else needs to be done here?

apaderno’s picture

I would not create a stable release just to close this issue.
Since the status of this issue is not shown in the project page, I would just ignore this issue. Users do not check these issues to understand if a module will have a Drupal 8/9/10 release.