RRule Library missing

[juergenweb]

It seems that the RRule lib will not be included in the download from the module directory - can you please check if they are present in your case. I cannot find them on my site.

[elabx]

The module needs to be installed through composer, sorry for not being explicit in the README.

[juergenweb]

Ok, I see! This is really written a little bit confusing, because you have written "install with composer OR download it from the module directory".

I am not using composer at the moment, but I have used it somewhere in the past with Laravel, so I might have to install it first.
I guess that a lot of other people do not use composer as well for PW, so do you have thought about adding the RRule lib to the module as well instead of installing it via Composer?

I am not sure, but I guess that I have used this library in the past and you do not really need all of the files for recurring events as I can remember.

On my FrontendForms module I have integrated the Valitron library for form validation. To be honest, this is only a single file and not a bunch of files, but the workflow should be the same for integrating an external library inside a module.

I have integrated the files via the PW classloader - you can take a look here. The integration is very easy and works like a charme.

I always check from time to time if the Valitron lib has been updated - if yes, I copy the new version to my module, check it if there are unwanted side effects and bump up the module version to the next number - but this is not very often the case, because the library do not change every week.

I guess including the RRule lib inside the modue would be more comfortable for all users and would animate more users try out your module, but it is up to you. I know updating of the RRule lib would be easier with composer.

[juergenweb]

If you decide that you want to include the RRule lib directly inside your module instead of the composer installation, I can show you how. I have added it on my local installation and it works. The time to realize this takes about 3 minutes to copy the files to the module and to add the classloader at the top of 2 files - thats all.
So please let me know if you want to realize that.

Best regards

[pideluxe]

I also think including php-rrule in the module is better, because it normally should not be used by any other module (very special use case) and also that the library is mature (last update before 2.4.0 was two years ago). So you don't have to expect updates very often.

[juergenweb]

Ok, in Austria it is lunch time at the moment. Afterwards I will give you a brief description on how to implement it. You will be wondering how easy this could be realized.

Read you later :-)

[juergenweb]

Oh sorry, I have not recognized, that comment was from another user ;-). So please let me know if you want to include it in the module and need help!!

[elabx]

Hi @juergenweb @pideluxe ! Thanks a lot for your input!

This is a topic on which I think I won't prioritize on and will leave as is for now :(

I understand this can also be a barrier for developers not used to composer but from my POV it's such a widely adopted tool in the PHP ecosystem that it just feel like a reasonable decision to include dependencies within the scope of composer.

I'm more worried about the "broken" experience of installing this module without composer. Maybe I should be more strict through the installation process and check this dependencies beforehand.

I also find it hard to make the excuse for myself because I use dependencies through composer a lot so it was kinda straightforward for me to do it like this.

Thanks for your understanding!

[juergenweb]

I understand your POV and as written above, it is your decision ;-)

But in this case I think the usage of composer has not an advantage, because the lib is older and the last update is long ago. The lib has also no benefit for other modules (except someone creates another recurring module) and it will lock out users that do not use composer.

On the other hand, the user experience is more convenient on downloads and you get rid of the dependency that composer must be installed. The check inside the installation process is no longer needed.

Comparing pros and cons using composer is in my opinion 1:0 for do not using composer in this case ;-)