Add basic rules examples

A new sub-module with example rules has been added. The example reaction rules provided by it are:

• user login: 5 points
• user register: 10 points
• add some content: 5 points
• edit/review some content: 10 points
• post a comment: 20 points

Someone else is needed to test it before committing!

Please, to do so:

1. download all the required modules: userpoints (latest -dev), typed_data (alpha1), rules (alpha3), dynamic_entity_reference (latest stable), transaction (alpha3)
2. new rule actions are needed to create and execute transactions, apply this two (not-yet committed) patches to the transaction module: #2958236-3: Add execute transaction rule action & #2958093-3: Add create transaction rule action
3. apply the attached patch to the userpoints module
4. enable the new sub-module "User points rules example" (userpoints_rules) provided by this patch
5. rebuild caches from drush, and again from the UI (/admin/config/development/performance) because of this rules bug: #2957985: Reaction rules not triggered after cache rebuild from drush
6. try it doing any of the actions described above

You can edit the provided rules, for example, adding conditions to them or changing the amount of points granted, but note that provided rules (updated or not) are removed if the userpoints_rules sub-module is uninstalled.

Hi SocialNicheGuru, thank you so much for your feedback on this.

I have been trying to reproduce the errors you reported, but I was unable to do it starting from a fresh Drupal 8.5.1 installation (standard profile). However, I found that the configured actions in the provided rules can not be edited, I got a 404 in URLs like:

/admin/config/workflow/rules/reactions/edit/userpoints_rules_earn_on_login/edit/

This doesn't affect to the rule application, I mean, users grant points on login or posting as expected, but it could be related with the errors you got.

About the first one:

https://test1.com/user/login|1||Drupal\rules\Exception\EvaluationException: The context for transaction is NULL, but the context transaction in transaction_execute requires a value.

here the execution action found an empty transaction context. The transaction entity should be created by the previous action, but it doesn't. It appears that, for some reason, it is not possible to create new user points transactions in your system with the default type. Did you alter (or delete) the default transaction type and fields provided by the userpoints_default module?

I need some other information in order to reproduce it:

- drupal version
- php version
- required modules version: typed_data, rules, dynamic_entity_reference & transaction
- full log entries on error

When trying to reproduce the issue described in #4, I noticed the same:

I found that the configured actions in the provided rules can not be edited, I got a 404 in URLs like:

/admin/config/workflow/rules/reactions/edit/userpoints_rules_earn_on_login/edit/

By adding some additional reaction, the existing one can be edited normally. it might be a rules issue, but I have to see it.

As far I can see, rules stores in a single config entity the entire rule. This config entity has an UUID as usual that must be removed from the default configuration provided in userpoints_rules. However, each rule expression has also its own UUID that, unlike the entity UUID, it should be present in configuration.

By design, UUIDs are machine-generated identifiers that shouldn't be stored in any component code or default configuration. I opened an issue about this in the rules module queue, #2964770: Cannot edit reactions of imported rules from module config install

In the mean time, and considering that the purpose of the new submodule is to illustrate the rules integration, I added UUIDs values to provided rules expressions. With this change, the rule action edit links work.

That's another rules issue. Such context selection is valid, validation works when creating new action but fails on edition. Issue post in rules: #2965726: Entity context fields fails on validation on update for entity reference

As a work around, the only affected reaction fetch first the user node author and uses this reference for the target entity context in the transaction creation rule.

Note that rules also requires to rebuild the cache after updating a rule to be applied.

Added actions to set a reference to the reaction related entity. It can be tested with the latest -dev of the transaction module + patch from #2973989-2: Transaction type context refination in rules doesn't work.

The reported issues in #15 and #16 seems to be caused by incomplete configuration in the link field provided by userpoints_default sub-module. Since it is not related to rules examples, I've opened a new issue for that: #3022258: Link field reference has incomplete configuration. Thank's @SocialNicheGuru for the feedback!

We are on the way of a first alpha release, latest patch needs be updated to accommodate to changes in the main module.

Updated patch with 3 changes:

• the sub-module name changes from userpoints_rules to userpoints_rules_example, that matches much better its purpose. In the D7 version already exists a userpoints_rules sub-module that provides integration with rules (not required in the D8 way), and might cause some confusion
• the sub-module is now located in the new modules folder, according to #3022279: Move sub-modules to modules folder
• added dependency on node (core) and token modules. Entity reference fields tokens are provided by the contrib token module

There are no changes in the provided configuration examples.

Default submodule is intended to be used as a starting point for almost any website. Dependency on node or comment is not really required, so I opened an issue to remove it: #3024998: Remove dependencies on node and comment modules in userpoints_default.

In rules example, we have now to ensure that the link entity reference field allows references to content and comment entities.

Transaction 1.0-alpha4 released that provides the required rules integration. No other changes or issues reported, ready to commit.