Plugin support by borekb · Pull Request #1075 · versionpress/versionpress

borekb · 2016-06-01T15:36:27Z

Resolves most of #1036.

Update 4th Oct 2016: We're mostly done with this, some smaller things have been moved to separate issues and are linked from #1075 (comment). If you want to provide feedback, please read Plugin-Support.md and leave a comment.

… to be added)

…es ChangeInfo objects moved to static methods in `ChangeInfoFactory`.

# Conflicts: # plugins/versionpress/composer.lock

JanVoracek · 2016-07-11T12:14:07Z

Closed by mistake; reopening.

… custom Bulk*ChangeInfo classes Note: This commit will not pass the tests. I haven't found any easy way how to do this change in small steps. There remains a lot of related changes but is already too big; thus, I will commit it in multiple commits.

…st classes

…ChangeInfo

… etc. are now H2 instead of H3. This allows easier structuring inside them.

…:N references when entity becomes tracked

borekb · 2016-10-03T13:21:17Z

Here are some notes as I reviewed Plugin-Support.md:

It would be good to have a clear name for the set of files in the .versionpress folder. "Plugin definition" is the best I can currently think of.
- Yes let's go with "plugin definition", that's fine.
We have been using the edit action since VersionPress 1.0 (e.g., option/edit), however, the more natural English verb is update. 4.0 would be a chance to fix this. (Feedback from native speakers welcome.)
- We agreed that update is more natural. 'edit' -> 'update' action verb #1120
Do we need the separate _meta_ entity filters, e.g., vp_entity_tags_ vs. vp_meta_entity_tags_? I get that they are slightly different, however, if a single filter name could be used for both cases, it would make the API smaller.
- @JanVoracek will evaluate this – Simplify vp_meta_entity_tags_ #1126.
Is "schema" the right word? Our schema.yml contains quite a bit more. On the other hand, "schema" is quite unique and intuitively connected to a database so it might be OK to call it that.
- We could not come up with a better alternative.
.versionpress makes sense in the plugin folder but for the planned online repo, we need a convention to separate the plugins. See e.g. DefinitelyTyped.
- Something like plugin's slug will be used.
Our term "actions" conflicts with WP actions. Not be a big deal for us but WP developers unfamiliar with VersionPress might be confused. If needs be, we can consider "events" instead.
- As nouns the difference between action and event is that action is something done so as to accomplish a purpose while event is an occurrence; something that happens. -- http://wikidiff.com/event/action
- In the team, we prefer actions over events (quite obviously as we've used that in the past). Hopefully it's ok for WP devs.
Document the slash in Actions

octopuss · 2016-10-03T14:08:04Z

docs/Plugin-Support.md

+- Hooks are defined in `hooks.php`
+
+All files are optional so for example, if a plugin doesn't define any new shortcodes it can omit the `shortcodes.yml` file. Simple plugins like _Hello Dolly_ might even omit everything; they just need to have the `.versionpress` folder so that VersionPress knows the plugin is supported.
+


How will VP versioning mechanism handle this Empty folder ? Empty folders are not versioned by default.

I don't really know. Originally, I didn't intend to use this directory to let VP know if the plugin is supported. It's maybe question to @borekb.

.gitkeep is an option but it's true that we didn't discuss this yet. The empty .versionpress folder seemed to me like the easiest way for a plugin author to declare explicit support for VersionPress even if no definitions are necessary.

Or maybe it could be a .versionpress file?

I think it should be some service. The main reason is that you don't have the files before you install the plugin; therefore, you cannot say whether the plugin is supported or not on the /plugin-install.php page.

Good point. Let's talk about this later, seems like a relative detail.

octopuss · 2016-10-03T14:18:15Z

docs/Plugin-Support.md

+```yaml
+post:
+  table: posts
+  id: ID


What about multi column id ?

VersionPress doesn't support it yet.

octopuss · 2016-10-03T14:50:04Z

docs/Plugin-Support.md

+### Non-database actions
+
+Some actions are not directly related to the database entities, e.g. plugin installation, WP update, etc. VersionPress provides function `vp_force_action` for these actions. VersionPress will use only action specified by parameters of this function and ignore all automatically catched. For example:
+


Add note that priority is ignored when action is forced.

Not only the priority – the actions are ignored entirely. Do you have any suggestion how to reword the sentence?

I wanted to look at this section anyway ("catched" etc.), will try to reword it.

I need an emoji for 🤦 ... catched 🙄

octopuss · 2016-10-03T15:15:04Z

plugins/versionpress/src/ChangeInfos/UntrackedChangeInfo.php

+    public function getPriority()
    {
-        return $this->commitMessage->getUnprefixedSubject();
+        return 0;


When no better is found, why priority is not high instead ?

UntrackedChangeInfo represents manual commit; thus, there are no other ChangeInfo objects to compare with. Plus, ignoring the fact it will not compare with anything, zero is the highest priority.

- Removed section about how VersionPress stores actions in commit messages (it didn't bring enough value for its length) - More clearly described what an action is and what it consists of - There is now clearer distinction between database and non-database actions - Filters are just mentioned but their signature is not described - Some other smaller edits

# Conflicts: # plugins/versionpress/composer.lock

borekb and others added 2 commits June 3, 2016 15:18

[#1036] Added docs/Plugin-Support.md, mostly just sections (content…

c96f75e

… to be added)

[#1036] Most of storages replaced with generic ones. Logic that creat…

c5caaff

…es ChangeInfo objects moved to static methods in `ChangeInfoFactory`.

JanVoracek force-pushed the 1036-plugin-support branch from 8d85892 to c5caaff Compare June 3, 2016 13:22

JanVoracek self-assigned this Jun 3, 2016

JanVoracek added this to the 4.0 milestone Jun 3, 2016

JanVoracek added 12 commits June 6, 2016 15:48

[#1036] Drafted documentation of Data model, Actions and Shortcodes

1693613

[#1036] Described format of the "action file"

7488ed2

[#1036] Drafted an ignore mechanism

308bf8d

[#1036] Removed PostStorage

8dc5d3e

[#1036] Added WP_Mock

1d0906d

[#1036] StorageTests now use WP_Mock

aa42fc5

[#1036] Removed last entity-specific storages

5be84fa

Merge branch 'master' into 1036-plugin-support

088a385

# Conflicts: # plugins/versionpress/composer.lock

[#1036] Hooks extracted into separate files

68f2283

[#1036] Introduced class for mocking hooks

b0e5654

[#1036] Added simple documentation of the HookMock class

3e0477b

[#1036] Wpdb constants returned into WpdbCopy

1011956

vasek closed this Jul 11, 2016

vasek deleted the 1036-plugin-support branch July 11, 2016 11:55

JanVoracek restored the 1036-plugin-support branch July 11, 2016 12:13

JanVoracek reopened this Jul 11, 2016

JanVoracek added 8 commits July 12, 2016 16:57

[#1036] Updated docs of actions

796ee17

[#1036] Updated ChangeInfoEnvelopeTest to use new "ChangeInfo style"

b959a98

[#1036] All entity-specific StorageTests replaced with two generic te…

0b279b9

…st classes

[#1036] actions.yaml renamed to actions.yml

db8afba

[#1036] Restored accidentally removed line from wordpress-schema.yml

c92d090

[#1036] Most of ChangeInfo preprocessors now work with general Entity…

134729c

…ChangeInfo

[#1036] Fixed number of parameters at filters

da43f26

borekb and others added 10 commits September 28, 2016 23:16

[#1036] Made heading structure one level flatter – actions, DB schema…

c35fef6

… etc. are now H2 instead of H3. This allows easier structuring inside them.

[#1036] Moved content from schema-readme.md to Plugin-Support.md

1538c0e

[#1036] The schema section edited (relatively smaller changes)

5ae03f8

[#1036] shortcodes-readme.md content moved to Plugin-Support.md

9e6fb98

[#1036] Shortcodes section edited (relatively minor changes)

0cb4182

[#1036] Described the discovery mechanism (rough draft)

045c6a7

[#1036] Added a section about hooks

ad8a9c9

[#1036] Smaller stylistic updates

4de31b7

[#1036] WpdbMirrorBridge now saves all related "child" entities and M…

b5ba772

…:N references when entity becomes tracked

[#1036] Minor fixes of tests

521f159

JanVoracek added 5 commits October 3, 2016 15:58

[#1036] Added link to .versionpress

e62b566

[#1036] Added documentation of non-database actions

fca418d

[#1036] Updated documentation of ignored columns

2e09be9

[#1036] Updated documentation of ignoring files

48284d0

[#1036] Updated documentation of discovery mechanism

dcb86d5

octopuss reviewed Oct 3, 2016

View reviewed changes

borekb and others added 2 commits October 4, 2016 00:50

Merge branch 'master' into 1036-plugin-support

0a29069

# Conflicts: # plugins/versionpress/composer.lock

JanVoracek force-pushed the 1036-plugin-support branch from 5954ee9 to 0a29069 Compare October 4, 2016 08:11

JanVoracek merged commit 0ecf1d2 into master Oct 5, 2016

JanVoracek deleted the 1036-plugin-support branch October 5, 2016 16:34

borekb mentioned this pull request Oct 8, 2016

Incorrect shell arg escaping on Windows #1132

Closed

JanVoracek mentioned this pull request Oct 10, 2016

List supported entities, their actions and VP tags #804

Closed

JanVoracek mentioned this pull request Oct 18, 2016

Reload all actions.yml after deleting temp directory #1153

Open

		- Hooks are defined in `hooks.php`

		All files are optional so for example, if a plugin doesn't define any new shortcodes it can omit the `shortcodes.yml` file. Simple plugins like _Hello Dolly_ might even omit everything; they just need to have the `.versionpress` folder so that VersionPress knows the plugin is supported.

		### Non-database actions

		Some actions are not directly related to the database entities, e.g. plugin installation, WP update, etc. VersionPress provides function `vp_force_action` for these actions. VersionPress will use only action specified by parameters of this function and ignore all automatically catched. For example:

Conversation

borekb commented Jun 1, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JanVoracek commented Jul 11, 2016

Uh oh!

borekb commented Oct 3, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JanVoracek Oct 4, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

borekb commented Jun 1, 2016 •

edited

Loading

borekb commented Oct 3, 2016 •

edited

Loading

JanVoracek Oct 4, 2016 •

edited

Loading