NAME

spread-revolutionary-date - Spread date and time from Revolutionary (Republican) Calendar

VERSION

version 0.26

DESCRIPTION

spread-revolutionary-date is a Free Software that spreads the current date, expressed in the French Revolutionary calendar, to various social networks: Twitter, Mastodon, and the Freenode Internet Relay Chat network.

Moreover, you can easily extend these defaults targets with any desired one, see "EXTENDING TO NEW TARGETS", and even spread something else than the revolutionary date, see "msgmaker" option and "EXTENDING TO NEW MESSAGE MAKERS".

The French Revolutionary calendar, also called Republican calendar, was introduced during the French Revolution, and used from late 1793 to 1805, and also during the Paris Commune in 1871. This was an attempt to get rid of religious and royalist references found in Gregorian calendar when naming measures of Time. Months were given new names based on nature, each day of the year, instead of being named after an associated saint, had a unique name associated with the rural economy: agricultural tools, common animals, grains, pastures, trees, roots, flowers, fruits, plants, and minerals. But this was also an attempt to give more rational in measuring Time, basing measures on decimal system. Instead of weeks, each month was divided into exactly 3 décades, that is ten days; days were divided into ten hours; hours into 100 minutes; and minutes into 100 seconds.

You must have a registered account on each of the targets you want to spread the revolutionary date. And you must get credentials for spread-revolutionary-date to post on Twitter and Mastodon. Finally, you have to configure spread-revolutionary-date to use these credentials, see "CONFIGURATION" and "COMMAND LINE PARAMETERS" below.

The revolutionary date and time is computed thanks to the DateTime::Calendar::FrenchRevolutionary Perl module, by Jean Forget.

USAGE

  # Just execute the script in your shell
  # to spread current date to configured accounts
  # on Twitter, Mastodon and Freenode:
  $ spread-revolutionary-date

  # Or, since this script does nothing but calling
  # the L<App::SpreadRevolutionaryDate> Perl module,
  # use this one-liner:
  $ perl -MApp::SpreadRevolutionaryDate \
      -e 'App::SpreadRevolutionaryDate->new->spread;'

  # Test spreading to Mastodon only:
  $ spread-revolutionary-date \
      --targets mastodon --test

  # Test spreading to Twitter only in English:
  $ spread-revolutionary-date \
      --targets twitter \
      --test \
      --locale en

  # Spread acab time to Twitter and Freenode
  # explicit channels
  $ spread-revolutionary-date \
      --targets twitter \
      --targets freenode \
      --freenode_channels '#revolution' \
      --freenode_channels '#acab' \
      --revolutionarydate_acab

  # Prompt user for a message to spread to mastodon
  $ spread-revolutionary-date \
      --targets mastodon \
      --msgwriter UserPrompt

CONFIGURATION

Once again: you have to configure spread-revolutionary-date with credentials for registered account on each of the desired targets, so it can spread the revolutionary date on behalf of these accounts.

Configuration options may also be specified as command line parameters, see "COMMAND LINE PARAMETERS" below, which take precedence on options of the configuration file.

The configuration file should lie on ~/.config/spread-revolutionary-date/spread-revolutionary-date.conf or ~/.spread-revolutionary-date.conf. In case a file is found on both paths, the second one is ignored. The configuration file should use the popular INI file format. A sample configuration file can be found in this distribution at etc/sample-spread-revolutionary-date.conf.

General options

These options should appear outside of any section of the configuration file.

targets

This option can be specified multiple times, with values as strings. It explicitly defines targets where the revolutionary date should be spread to. Any value set for this option should be a valid target: any of the three default targets (twitter, mastodon, or freenode) or some new target if you have extended this application (see "EXTENDING TO NEW TARGETS"). If this option is not defined, the revolutionary date is spread on all three default targets: twitter, mastodon, and freenode.

msgmaker

This option can only be specified once, with a value as string. Spread a message computed by the class defined by the value of this option, defaults to RevolutionaryDate. The Value (case sensitive) of this option should correspond to an existing App::SpreadRevolutionaryDate::MsgMaker::Value class consuming App::SpreadRevolutionaryDate::MsgMaker role. Message makers values pre-defined in this distribution are RevolutionaryDate, which spreads the revolutionary date, and PromptUser, which prompts the user for the message to be spread (with confirmation). See "EXTENDING TO NEW MESSAGE MAKERS" for details on using a new value for this option.

locale

This option can only be specified once, with a value as string. Spread with chosen language. As of App::SpreadRevolutionaryDate 0.11 locale is limited to 'fr', 'en', 'it' or 'es' for RevolutionaryDate and 'fr', 'en', 'it', 'es' or 'de'. Defaults to 'fr' for RevolutionaryDate and 'en' otherwise. To add more languages see "INTERNATIONALIZATION AND LOCALIZATION".

test

This boolean option takes no value, either it is defined or not. If defined, do not actually spread the revolutionary date, just print it on standard output for Twitter and Mastodon, and send it on configured test channels for Freenode (see "test_channels" below).

DEPRECATED acab

This option is deprecated starting from version 0.09 of this distribution and may be removed in future release. Please use "acab" option in [revolutionarydate] section, as described below.

DEPRECATED twitter

This option is deprecated starting from version 0.07 of this distribution and may be removed in future release. Please use "targets" option, as described above. Spread on Twitter explicitly. If none of the twitter, mastodon, freenode option is set, the revolutionary date is spread on all of these three targets.

DEPRECATED mastodon

This option is deprecated starting from version 0.07 of this distribution and may be removed in future release. Please use "targets" option, as described above. Spread on Mastodon explicitly. If none of the twitter, mastodon, freenode option is set, the revolutionary date is spread on all of these three targets.

DEPRECATED freenode

This option is deprecated starting from version 0.07 of this distribution and may be removed in future release. Please use "targets" option, as described above. Spread on Freenode explicitly. If none of the twitter, mastodon, freenode option is set, the revolutionary date is spread on all of these three targets.

Twitter options

These options are credentials for spread-revolutionary-date to spread on a Twitter account. You have to get them from your Twitter API account with write access level. They should be defined in the [twitter] section of the configuration file.

consumer_key

This option can only be specified once, with a value as string: your Twitter Consumer API key for this application.

consumer_secret

This option can only be specified once, with a value as string: your Twitter Consumer API secret key for this application.

access_token

This option can only be specified once, with a value as string: your Twitter Access token for this application.

access_token_secret

This option can only be specified once, with a value as string: your Twitter Access token secret for this application.

Mastodon options

These options are credentials for spread-revolutionary-date to spread on a Mastodon account. You have to get them from your Mastodon instance API account with write scope. Note that Mastodon is a decentralized network with multiple instances, the previous link is for mstdn.fr instance, please replace url with your preferred instance. They should be defined in the [mastodon] section of the configuration file.

instance

This option can only be specified once, with a value as string: the domain name of your instance, eg: mastodon.social, mstdn.fr, etc.

client_id

This option can only be specified once, with a value as string: your Mastodon Client key for this application.

client_secret

This option can only be specified once, with a value as string: your Mastodon Client secret for this application.

access_token

This option can only be specified once, with a value as string: your Mastodon Access token for this application.

Freenode options

The first two options are credentials for spread-revolutionary-date to spread on a Freenode account. See https://freenode.net/kb/answer/registration to find out how to register an account on Freenode. They should be defined in the [twitter] section of the configuration file.

nickname

This option can only be specified once, with a value as string: your Freenode nickname.

password

This option can only be specified once, with a value as string: your Freenode password.

channels

This option can be specified multiple times, with values as strings. spread-revolutionary-date will spread on every channel specified with this option. This option should be specified at least one time if "test" option is not set. It is ignored if "test" option is set.

test_channels

This option can be specified multiple times, with values as strings. spread-revolutionary-date will spread on every channel specified with this option. This option should be specified at least one time if "test" option is set. It is ignored if "test" option is not set.

RevolutionaryDate options

These options change the way revolutionary date is computed when "msgmaker" option is RevolutionaryDate. They should be defined in the [revolutionarydate] section of the configuration file.

acab

This boolean option takes no value, either it is defined or not, defaults to false. If defined, instead of spreading the current date and time, pretend that decimal time is 1:31:20 (which corresponds to 03:08:56 UTC, 04:08:56 Paris winter time, or 05:08:56 Paris summer time, in sexagesimal scale used by common Anglo-Babylonian Time).

This boolean option takes no value, either it is defined or not, defaults to true. If defined, a link to the wikipedia page, in language defined by the locale option, corresponding to the feast of the day, is added to the date to be spread.

PromptUser option

If "msgmaker" option is PromptUser, instead of spreading the revolutionary date, prompts the user (with confirmation) for the message to be spread, with a default value (if user enters nothing when prompted).

default

This option can only be specified once, with a value as string. If default option is set, the user is not prompted and this default message is spread. If default option is not defined, the default message is 'Goodbye old world, hello revolutionary worlds' if the user enters nothing when prompted. The default option should be defined in the [promptuser] section of the configuration file. It is only used if "msgmaker" option is PromptUser.

COMMAND LINE PARAMETERS

Any command line parameter, other than the first three ones below, takes precedence on the corresponding option specified on the confiuration file, see "CONFIGURATION" above.

Command line only parameters

--conf | -c <file>

Use <file> path as configuration file, instead of the default ones, see "CONFIGURATION" above.

--version | -v

Prints out the version of spread-revolutionary-date.

--help | -h | -?

Prints out help with command line parameters.

General parameters

--targets | -tg <target>

Same as "targets" configuration option above.

--msgmaker | -mm <MsgMakerClass>

Same as "msgmaker" configuration option above.

--locale | -l <fr|en|it|es>

Same as "locale" configuration option above.

--test | --no | -n

Same as "test" configuration option above.

DEPRECATED --acab | -a

Same as "acab" configuration option above.

DEPRECATED --twitter | -t

Same as "DEPRECATED twitter" configuration option above.

DEPRECATED --mastodon | -m

Same as "DEPRECATED mastodon" configuration option above.

DEPRECATED --freenode | -f

Same as "DEPRECATED freenode" configuration option above.

Twitter parameters

These parameters specify credentials for spread-revolutionary-date to spread on a Twitter account. You have to get them from your Twitter API account with write access level.

--twitter_consumer_key | -tck <key>

Same as "consumer_key" configuration option above.

--twitter_consumer_secret | -tcs <secret>

Same as "consumer_secret" configuration option above.

--twitter_access_token | -tat <token>

Same as "access_token" configuration option above.

--twitter_access_token_secret | -tats <token secret>

Same as "access_token_secret" configuration option above.

Mastodon parameters

These parameters specify credentials for spread-revolutionary-date to spread on a Mastodon account. You have to get them from your Mastodon instance API account with write scope. Note that Mastodon is a decentralized network with multiple instances, the previous link is for mstdn.fr instance, please replace url with your preferred instance.

--mastodon_instance | -mi <instance>

Same as "instance" configuration option above.

--mastodon_client_id | -mci <id>

Same as "client_id" configuration option above.

--mastodon_client_secret | -mcs <secret>

Same as "client_secret" configuration option above.

--mastodon_access_token | -mat <token>

Same as "access_token" configuration option above.

Freenode parameters

The first two parameters are credentials for spread-revolutionary-date to spread on a Freenode account. See https://freenode.net/kb/answer/registration to find out how to register an account on Freenode.

--freenode_nickname | -fn <nick>

Same as "nickname" configuration option above.

--freenode_password | -fp <passwd>

Same as "password" configuration option above.

--freenode_channels | -fc <channel>

Same as "channels" configuration option above.

--freenode_test_channels | -tc <channel>

Same as "test_channels" configuration option above.

RevolutionaryDate parameters

--revolutionarydate_acab | -ra

Same as "acab" configuration option above.

Same as "wikipedia_link" configuration option above.

PromptUser parameter

--promptuser_default <msg> | -pud <msg>

Same as "default" configuration option above.

EXTENDING TO NEW TARGETS

Starting from version 0.07, this distribution takes advantage of Moose, the postmodern object system for Perl 5, allowing to easily extend spread-revolutionary-date to other targets than the default ones (Twitter, Mastondon and Freenode.

To add a new target, you should write a new class in the App::SpreadRevolutionaryDate::Target:: namespace (that is: the class should be App::SpreadRevolutionaryDate::Target::Mytarget for a new Mytarget target), that consumes the App::SpreadRevolutionaryDate::Target role. See "DESCRIPTION" in App::SpreadRevolutionaryDate::Target for a comprehensive description of this role.

The name of the target should be added as a value of the "targets" option in lower case.

Such a target class is actually just a wrapper. Usually a target has to use an existing specific module (which can be a Moose class or not) to perform the actual work of posting a message according the specific target protocol, after having complied with any potential required authentication. Such authentication should be carried on by the constructor or, along with posting, by the required spread method of the target class.

To perform authentication and to post a message, there is a strong likelihood that the new target requires specific parameters (e.g.: tokens, keys, account name, password, channels, etc.). These parameters should be defined as required attributes of the target class. Values for such attributes should be set in the configuration file, inside a section named after the target in lower case ([mytarget]), or as command line parameters prefixed with the name of the target in lower case, followed by an underscore (--mytarget_myparam).

Should you extend spread-revolutionary-date to a new target, we advise you to have a look on how default targets are implemented: App::SpreadRevolutionaryDate::Target::Twitter with Net::Twitter::Lite::WithAPIv1_1 worker, App::SpreadRevolutionaryDate::Target::Mastodon with Mastodon::Client worker. Both are using OAuth2 protocol to perform authentication. The third default target, App::SpreadRevolutionaryDate::Target::Freenode, uses a chatbot: App::SpreadRevolutionaryDate::Target::Freenode::Bot subclassing Bot::BasicBot. You can also see a very simple example with a test file provided in this distribution at t/new_target.t, which just prints out the revolutionary date on the standard output using core module IO::Handle.

EXTENDING TO NEW MESSAGE MAKERS

It is even easier to spread whatever you want instead of the revolutionary date. You should write a new class in the App::SpreadRevolutionaryDate::MsgMaker:: namespace (that is: the class should be App::SpreadRevolutionaryDate::MsgMaker::MyMsgMaker for a new MyMsgMaker message maker), that consumes the App::SpreadRevolutionaryDate::MsgMaker role. See "DESCRIPTION" in App::SpreadRevolutionaryDate::MsgMaker for a comprehensive description of this role.

The name of the message maker should be set as a value of the "msgmaker" option in lower case.

Such a message maker class is actually just a wrapper. Usually a message maker has to use an existing specific module (which can be a Moose class or not) to craft the message. App::SpreadRevolutionaryDate::MsgMaker::RevolutionaryDate uses DateTime::Calendar::FrenchRevolutionary, while App::SpreadRevolutionaryDate::MsgMaker::PromptUser is based on IO::Prompt::Hooked. You may need for example LWP to extract the message from a fetched web page or service, or XML::Feed to build it from a RSS feed, or DBI to retrieve it from a database, or nothing at all to spread a fixed message, etc.

If your new message maker class needs specific parameters (other than locale, which comes with App::SpreadRevolutionaryDate::MsgMaker role), they should be defined as attributes of this class. Values for such attributes should be set in the configuration file, inside a section named after the message maker in lower case ([mymsgmaker]), or as command line parameters prefixed with the name of the message maker in lower case, followed by an underscore (--mytarget_myparam).

Have a look to the App::SpreadRevolutionaryDate::MsgMaker::PromptUser class, it shows a simple example on how to extend spread-revolutionary-date to a new message maker.

INTERNATIONALIZATION AND LOCALIZATION

Starting from version 0.11, this distribution uses the widespread internationalization and localization system gettext, commonly used for writing multilingual programs. See GNU gettext documentation for details. From the point of view of a translator, this is rather simple.

Translators can find a portable object template po/App-SpreadRevolutionaryDate.pot which includes all translatable strings used by spread-revolutionary-date (but not translations of days, months, feasts used in the French Revolutionary Calendar, see below). They can copy this template to a portable object file of their language and translate strings of this file. For example, a German translator would work on po/de.po. All strings to be translated are laid down in lines beginning with msgid keyword, and translations should go on the next line beginning with keyword msgstr. E.g.:

  msgid "Please, enter message to spread"

A German translator would have to replace the next line:

 msgstr ""

by:

 msgstr "Bitte geben Sie die Nachricht zu verbreiten ein"

When the string to be translated includes some words in curly braces, these words are actually named variables and should be left as is in the translation. E.g.:

  msgid "or {abort} to abort"
  msgstr "oder {abort}, um abzubrechen"

And that's it! As of version 0.11 of spread-revolutionary-date, there is only about a dozen of strings to translate, mainly for PromptUser message maker. But with the possibility to extend to other message makers, you may need more and more strings to be translated.

Translating days, months and feasts used in the RevolutionaryDate message maker do not use the gettext system. Mainly because it uses DateTime::Calendar::FrenchRevolutionary which proposes French and English translations in dedicated Perl modules. spread-revolutionary-date keeps the same way for translating expressions used in the French revolutionary calendar, but, thanks to Moose::Role App::SpreadRevolutionaryDate::MsgMaker::RevolutionaryDate::Locale, translatable nominal groups have been isolated from other Perl code. Their translations lie in a consuming class in the App::SpreadRevolutionaryDate::MsgMaker::RevolutionaryDate::Locale:: namespace for each translated language. These classes are named after the two-letter (ISO 639-1) or three-letter (ISO 639-2 and hISO 639-3) lowercase abbreviation of the corresponding language. For example, a German translator would work on App::SpreadRevolutionaryDate::MsgMaker::RevolutionaryDate::Locale::de class.

Just copy the French class (from lib/App/SpreadRevolutionaryDate/MsgMaker/RevolutionaryDate/Locale/fr.pm file) into the desired language, change the name of the class and replace every French string. E.g.: the names of the months should be replace in:

  has '+months' => (
    default => sub {[
      'Vendémiaire', 'Brumaire',  'Frimaire',
      'Nivôse',      'Pluviôse',  'Ventôse',
      'Germinal',    'Floréal',   'Prairial',
      'Messidor',    'Thermidor', 'Fructidor',
      'jour complémentaire',
    ]},
  );

by names in German:

  has '+months' => (
    default => sub {[
      'Herbstmonat',    'Nebelmonat',  'Reifmonat',
      'Schneemonat',    'Regenmonat',  'Windmonat',
      'Keimmonat',      'Blütenmonat', 'Wiesenmonat',
      'Erntemonat',     'Hitzemonat',  'Fruchtmonat',
      'Ergänzungstage',
    ]},
  );

Feasts include a special trick, because they can be used in sentences like this is feast name day or c'est le jour de la feast name. Depending on the language, it could then be prefixed or suffixed: in English it is suffixed by day, whereas in French it is prefixed by jour de la . Prefixes are translated as an array of strings, while the suffix is translated in a single string. The reason is that in languages where the feast of the day is prefixed, the prefix often depends on the gender or the number of the noun used for the feast, or whereas this noun starts by a vowel, and other factors depending on the language. Therefore, each translation of the feast of each day should starts with a digit specifying the index (starting from 0) in the translated array of prefixes to use for this word. E.g.: with prefixes translated by ['jour du ', 'jour de la ', "jour de l'", 'jour des '], some feast can be translated by '1carotte', '2amaranthe', '0panais' (because you say: jour de la carotte, with prefix number 1, jour de l'amaranthe, with prefix number 2, and jour du panais, with prefix number 0. If the language does not use any prefix before the feast of the day, each translation for the feast of the day should start with 0, and the array of prefixes should include an empty string as its single element. If the language does not use a suffix after the feast of the day, the translation of the sufix should be an empty string.

Note also that any space in the name of the feast of the day should be replaced by an underscore (_).

Finally, these translation classes include a mapping between the feast of the day and the wikipedia entry for this word. This is useful when the feast of the day corresponds to an ambiguous entry, or a different word, in wikipedia. If the wikipedia entry is the same as the feast of the day, you can omit it. If the wikipedia entry is different from the feast of the day, you should add a line in the appropriate group of mappings for the considered month (groups of mappings are numbered from 1 to 13). In the left part of this new mapping you should use the feast of the day as you have translated it, but without the number indicating the prefix and with spaces, not underscores. And in the right part of this new mapping, you should use the wikipedia entry, i.e. the end of the wikipedia url. E.g.:

  has '+wikipedia_entries' => (
    default => sub {{
      2 => {
        'water chestnut' => 'Water_caltrop',
      },
      8 => {
        'hoe'            => 'Hoe_(tool)',
      },
    }},
  );

Because of the trick on prefix and suffix for feasts and the needed mapping for wikipedia entries, using the gettext system would be quite difficult. It wouldn't be an issue for translating names of months or days. But for consistency reasons, I'd rather group all these translations used in the French Revolutionary Calendar in the same translation class. Nevertheless, I'm open to find solutions if you think it would be easier to translate everything with the gettext system.

SEE ALSO

App::SpreadRevolutionaryDate
DateTime::Calendar::FrenchRevolutionary
AppConfig
Net::Twitter::Lite::WithAPIv1_1
Mastodon::Client
Bot::BasicBot

AUTHOR

Gérald Sédrati-Dinet <gibus@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2019 by Gérald Sédrati-Dinet.

This is free software, licensed under:

  The GNU General Public License, Version 3, June 2007