SAP/abapGit
1
0
Fork 0
mirror of https://github.com/abapGit/abapGit.git synced 2025-05-01 12:20:51 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Patch / git add -p: Add and remove sections

Browse Source 
After this commit is applied it is possible to add and remove
sections of code on the stage/patch page.
This commit is contained in:
Christian Günter 2019-02-25 15:55:12 +01:00 committed by Lars Hvam
parent 9225e0ea0d
commit 389512f690
2 changed files with 291 additions and 146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

366
src/ui/zabapgit_js_common.w3mi.data.js
View File

@ -985,109 +985,14 @@ function setKeyBindings(oKeyMap){
Patch / git add -p Patch / git add -p
*/ */
function CSSPatchClassCombination(sClassLinkClicked, sClassCorrespondingLink){ function Patch() { }
this.sClassLinkClicked = sClassLinkClicked;
this.sClassCorrespondingLink = sClassCorrespondingLink;
}
function Patch() { Patch.prototype.ID = {
STAGE: "stage"
};
this.CSS_CLASS = { Patch.prototype.ACTION = {
ADD: "add",
REMOVE: "remove",
PATCH: "patch",
PATCH_ACTIVE: "patch-active"
};
this.ID = {
STAGE: "stage",
PATCH_ADD_ALL: "patch_add_all",
PATCH_REMOVE_ALL: "patch_remove_all"
};
this.ACTION = {
PATCH_STAGE: "patch_stage" PATCH_STAGE: "patch_stage"
};
this.ADD_REMOVE = new CSSPatchClassCombination(this.CSS_CLASS.ADD, this.CSS_CLASS.REMOVE);
this.REMOVE_ADD = new CSSPatchClassCombination(this.CSS_CLASS.REMOVE, this.CSS_CLASS.ADD);
}
Patch.prototype.preparePatch = function(){
this.registerClickHandlerSingleLine();
this.registerClickHandlerAllFile();
};
Patch.prototype.registerClickHandlerSingleLine = function(){
// registers the link handlers for add and remove single lines
this.registerClickHandlerForPatchLink(this.ADD_REMOVE);
this.registerClickHandlerForPatchLink(this.REMOVE_ADD);
};
Patch.prototype.registerClickHandlerAllFile = function(){
// registers the link handlers for add and remove all changes for a file
this.registerClickHandlerForPatchLinkAll("#" + this.ID.PATCH_ADD_ALL, this.ADD_REMOVE);
this.registerClickHandlerForPatchLinkAll("#" + this.ID.PATCH_REMOVE_ALL, this.REMOVE_ADD);
};
Patch.prototype.registerClickHandlerForPatchLink = function(oClassCombination) {
// register onclick handler. When a link is clicked it is
// deactivated and its corresponding link gets active
//
// e.g. if you click on 'add' add is deactivated and 'remove'
// is activated.
var elLinkAll = document.querySelectorAll("." + this.CSS_CLASS.PATCH + " a." + oClassCombination.sClassLinkClicked);
[].forEach.call(elLinkAll,function(elLink){
elLink.addEventListener("click",function(oEvent){
this.togglePatchActiveForClassLink(oEvent, elLink, oClassCombination);
}.bind(this));
}.bind(this));
};
Patch.prototype.togglePatchActive = function(oEvent, elClicked, elCorrespondingLink){
if (!elClicked.classList.contains(this.CSS_CLASS.PATCH_ACTIVE)){
elClicked.classList.toggle(this.CSS_CLASS.PATCH_ACTIVE);
elCorrespondingLink.classList.toggle(this.CSS_CLASS.PATCH_ACTIVE);
}
oEvent.preventDefault();
};
Patch.prototype.togglePatchActiveForClassLink = function(oEvent, elClicked, oClassCombination) {
var sCorrespondingLinkId = this.getCorrespodingLinkId(elClicked.id, oClassCombination);
var elCorrespondingLink = document.querySelector('[ID="' + this.escape(sCorrespondingLinkId) + '"]');
this.togglePatchActive(oEvent, elClicked, elCorrespondingLink);
};
Patch.prototype.getCorrespodingLinkId = function(sClickedLinkId, oClassCombination){
// e.g.
//
// add_patch_z_test_git_add_p.prog.abap_28 => remove_patch_z_test_git_add_p.prog.abap_28
//
// and vice versa
var oRegexPatchClassPrefix = new RegExp("^" + oClassCombination.sClassLinkClicked );
return sClickedLinkId.replace(oRegexPatchClassPrefix, oClassCombination.sClassCorrespondingLink);
}; };
Patch.prototype.escape = function(sFileName){ Patch.prototype.escape = function(sFileName){
@ -1096,27 +1001,249 @@ Patch.prototype.escape = function(sFileName){
.replace(/#/g, "\\#"); .replace(/#/g, "\\#");
}; };
Patch.prototype.patchLinkClickAll = function(oClassCombination) { /*
return function(oEvent) { We have three type of cascading links, each of them has two verbs, add and remove.
Which means that by clicking a file or section link all corresponding line links are clicked.
var sTableId = oEvent.srcElement.parentElement.parentElement.parentElement.parentElement.id; The id of the link indicates its semantics and its membership.
var elAddAll = document.querySelectorAll('[ID="' + this.escape(sTableId) + '"] a.' + oClassCombination.sClassLinkClicked);
[].forEach.call(elAddAll,function(elem){ */
this.togglePatchActiveForClassLink(oEvent, elem, oClassCombination);
}.bind(this));
oEvent.preventDefault(); /*
1) file links
}; example id of file link
patch_file_add_zcl_abapgit_user_exit.clas.abap
\________/ ^ \_____________________________/
| | |
| | |____ file name
| |
| verb [add|remove]
|
constant prefix
*/
function PatchFile(sId){
var oRegex = new RegExp("(" + this.ID.FILE + ")_(add|remove)_(.*$)");
var oMatch = sId.match(oRegex);
this.id = sId;
this.prefix = oMatch[1];
this.verb = oMatch[2];
this.file_name = oMatch[3];
}
PatchFile.prototype.ID = {
FILE: "patch_file",
ADD: "patch_file_add",
REMOVE: "patch_file_remove"
}; };
Patch.prototype.registerClickHandlerForPatchLinkAll = function(sSelector, oClassCombination){ /*
2) section links within a file
example id of section link
patch_section_add_zcl_abapgit_user_exit.clas.abap_1
\___________/ ^ \_____________________________/ ^
| | | |
| | file name |
| | |
| verb [add|remove] ------ section
|
constant prefix
*/
function PatchSection(sId){
var oRegex = new RegExp("(" + this.ID.SECTION + ")_(add|remove)_(.*)_(\\d+$)");
var oMatch = sId.match(oRegex);
this.id = sId;
this.prefix = oMatch[1];
this.verb = oMatch[2];
this.file_name = oMatch[3];
this.section = oMatch[4];
}
PatchSection.prototype.ID = {
SECTION: "patch_section",
ADD: "patch_section_add",
REMOVE: "patch_section_remove"
};
/*
3) line links within a section
example id of line link
patch_line_add_zcl_abapgit_user_exit.clas.abap_1_25
\________/ ^ \_____________________________/ ^ ^
^ | ^ | |
| | | | ------- line number
| | file name |
| | section
| verb [add|remove]
|
constant prefix
*/
function PatchLine(sId){
var oRegex = new RegExp("(" + this.ID.LINE + ")_(add|remove)_(.*)_(\\d+)_(\\d+$)");
var oMatch = sId.match(oRegex);
this.id = sId;
this.prefix = oMatch[1];
this.verb = oMatch[2];
this.file_name = oMatch[3];
this.section = oMatch[4];
this.line = oMatch[5];
this.corresponding_verb = this.CORRESPONDING_VERBS[this.verb];
this.elem = document.querySelector("#" + Patch.prototype.escape(this.id));
this.correspondingLink = this.getCorrespodingLink();
}
PatchLine.prototype.ID = {
LINE: "patch_line",
ADD: "patch_line_add",
REMOVE: "patch_line_remove"
};
PatchLine.prototype.CSS_CLASS = {
PATCH: "patch",
PATCH_ACTIVE: "patch-active"
};
PatchLine.prototype.CORRESPONDING_VERBS = {
add: "remove",
remove: "add"
};
PatchLine.prototype.getCorrespodingLinkId = function(){
// e.g.
//
// patch_line_add_z_test_git_add_p.prog.abap_3_28 => patch_line_remove_z_test_git_add_p.prog.abap_3_28
//
// and vice versa
var oRegexPatchIdPrefix = new RegExp("^" + this.ID.LINE + "_" + this.verb );
return this.id.replace(oRegexPatchIdPrefix, this.ID.LINE + "_" + this.corresponding_verb);
};
PatchLine.prototype.toggle = function(){
if (!this.elem.classList.contains(this.CSS_CLASS.PATCH_ACTIVE)){
this.elem.classList.toggle(this.CSS_CLASS.PATCH_ACTIVE);
this.correspondingLink.classList.toggle(this.CSS_CLASS.PATCH_ACTIVE);
}
};
PatchLine.prototype.getCorrespodingLink = function(){
var sCorrespondingLinkId = this.getCorrespodingLinkId();
return document.querySelector('[ID="' + Patch.prototype.escape(sCorrespondingLinkId) + '"]');
};
Patch.prototype.preparePatch = function(){
this.registerClickHandlerForFiles();
this.registerClickHandlerForSections();
this.registerClickHandlerForLines();
};
Patch.prototype.registerClickHandlerForFiles = function(){
// registers the link handlers for add and remove files
this.registerClickHandlerForPatchFile("a[id^='" + PatchFile.prototype.ID.ADD + "']");
this.registerClickHandlerForPatchFile("a[id^='" + PatchFile.prototype.ID.REMOVE + "']");
};
Patch.prototype.registerClickHandlerForSections = function(){
// registers the link handlers for add and remove sections
this.registerClickHandlerForPatchSection("a[id^='" + PatchSection.prototype.ID.ADD + "']");
this.registerClickHandlerForPatchSection("a[id^='" + PatchSection.prototype.ID.REMOVE + "']");
};
Patch.prototype.registerClickHandlerForLines = function(){
// registers the link handlers for add and remove lines
this.registerClickHandlerForPatchLine("a[id^='" + PatchLine.prototype.ID.ADD + "']");
this.registerClickHandlerForPatchLine("a[id^='" + PatchLine.prototype.ID.REMOVE + "']");
};
Patch.prototype.registerClickHandlerForSelector = function(sSelector, fnCallback){
var elAll = document.querySelectorAll(sSelector); var elAll = document.querySelectorAll(sSelector);
[].forEach.call(elAll, function(elem){ [].forEach.call(elAll, function(elem){
elem.addEventListener("click", this.patchLinkClickAll(oClassCombination).bind(this)); elem.addEventListener("click", fnCallback.bind(this));
}.bind(this));
};
Patch.prototype.registerClickHandlerForPatchFile = function(sSelector){
this.registerClickHandlerForSelector(sSelector, this.patchLinkClickFile);
};
Patch.prototype.registerClickHandlerForPatchSection = function(sSelector){
this.registerClickHandlerForSelector(sSelector, this.patchLinkClickSection);
};
Patch.prototype.registerClickHandlerForPatchLine = function(sSelector) {
this.registerClickHandlerForSelector(sSelector, this.patchLinkClickLine);
};
Patch.prototype.patchLinkClickLine = function(oEvent){
this.togglePatchForElem(oEvent.srcElement);
oEvent.preventDefault();
};
Patch.prototype.togglePatchForElem = function(elLink) {
new PatchLine(elLink.id).toggle();
};
Patch.prototype.getAllLineLinksForId = function(sId, sIdPrefix){
var oRegex = new RegExp("^" + sIdPrefix);
sId = sId.replace(oRegex, PatchLine.prototype.ID.LINE);
return document.querySelectorAll("a[id^='"+ this.escape(sId) + "']");
};
Patch.prototype.getAllLineLinksForFile = function(oFile){
return this.getAllLineLinksForId(oFile.id, PatchFile.prototype.ID.FILE);
};
Patch.prototype.getAllLineLinksForSection = function(oSection){
return this.getAllLineLinksForId(oSection.id, PatchSection.prototype.ID.SECTION);
};
Patch.prototype.patchLinkClickFile = function(oEvent) {
var oFile = new PatchFile(oEvent.srcElement.id);
var elAllLineLinksOfFile = this.getAllLineLinksForFile(oFile);
[].forEach.call(elAllLineLinksOfFile,function(elem){
this.togglePatchForElem(elem);
}.bind(this));
oEvent.preventDefault();
};
Patch.prototype.patchLinkClickSection = function(oEvent){
var oSection = new PatchSection(oEvent.srcElement.id);
this.clickAllLineLinksInSection(oEvent, oSection.section);
oEvent.preventDefault();
};
Patch.prototype.clickAllLineLinksInSection = function(oEvent){
var oSection = new PatchSection(oEvent.srcElement.id);
var elAllLineLinksOfSection = this.getAllLineLinksForSection(oSection);
[].forEach.call(elAllLineLinksOfSection,function(elem){
this.togglePatchForElem(elem);
oEvent.preventDefault();
}.bind(this)); }.bind(this));
}; };
@ -1137,37 +1264,34 @@ Patch.prototype.stagePatch = function() {
// Collect add and remove info and submit to backend // Collect add and remove info and submit to backend
var aAddPatch = this.collectActiveElementsForSelector("." + this.CSS_CLASS.PATCH +" a." + this.CSS_CLASS.ADD); var aAddPatch = this.collectActiveElementsForId( PatchLine.prototype.ID.ADD );
var aRemovePatch = this.collectActiveElementsForSelector("." + this.CSS_CLASS.PATCH + " a." + this.CSS_CLASS.REMOVE); var aRemovePatch = this.collectActiveElementsForId( PatchLine.prototype.ID.REMOVE );
submitSapeventForm({"add": aAddPatch, "remove": aRemovePatch}, this.ACTION.PATCH_STAGE, "post"); submitSapeventForm({"add": aAddPatch, "remove": aRemovePatch}, this.ACTION.PATCH_STAGE, "post");
}; };
Patch.prototype.collectActiveElementsForSelector = function(sSelector){ Patch.prototype.collectActiveElementsForId = function(sId){
var sSelector = "." + PatchLine.prototype.CSS_CLASS.PATCH + " a[id^='" + sId + "']";
return [].slice.call(document.querySelectorAll(sSelector)) return [].slice.call(document.querySelectorAll(sSelector))
.filter(function(elem){ .filter(function(elem){
return elem.classList.contains(this.CSS_CLASS.PATCH_ACTIVE); return elem.classList.contains(PatchLine.prototype.CSS_CLASS.PATCH_ACTIVE);
}.bind(this)) }).map(function(elem){
.map(function(elem){
return elem.id; return elem.id;
}); });
}; };
function preparePatch(){ function preparePatch(){
var oPatch = new Patch(); var oPatch = new Patch();
oPatch.preparePatch(); oPatch.preparePatch();
} }
function registerStagePatch(){ function registerStagePatch(){
var oPatch = new Patch(); var oPatch = new Patch();
oPatch.registerStagePatch(); oPatch.registerStagePatch();
} }
/********************************************************** /**********************************************************

61
src/ui/zcl_abapgit_gui_page_diff.clas.abap
View File

@ -64,7 +64,8 @@ CLASS zcl_abapgit_gui_page_diff DEFINITION
mv_repo_key TYPE zif_abapgit_persistence=>ty_repo-key, mv_repo_key TYPE zif_abapgit_persistence=>ty_repo-key,
mv_seed TYPE string, " Unique page id to bind JS sessionStorage mv_seed TYPE string, " Unique page id to bind JS sessionStorage
mv_patch_mode TYPE abap_bool, mv_patch_mode TYPE abap_bool,
mo_stage TYPE REF TO zcl_abapgit_stage. mo_stage TYPE REF TO zcl_abapgit_stage,
mv_section_count TYPE i.
METHODS render_diff METHODS render_diff
IMPORTING is_diff TYPE ty_file_diff IMPORTING is_diff TYPE ty_file_diff
@ -529,15 +530,17 @@ CLASS ZCL_ABAPGIT_GUI_PAGE_DIFF IMPLEMENTATION.
METHOD get_patch_data. METHOD get_patch_data.
DATA: lv_section TYPE string.
CLEAR: ev_filename, ev_line_index. CLEAR: ev_filename, ev_line_index.
IF iv_action <> c_patch_action-add AND iv_action <> c_patch_action-remove. IF iv_action <> c_patch_action-add AND iv_action <> c_patch_action-remove.
zcx_abapgit_exception=>raise( |Invalid action { iv_action }| ). zcx_abapgit_exception=>raise( |Invalid action { iv_action }| ).
ENDIF. ENDIF.
FIND FIRST OCCURRENCE OF REGEX iv_action && `_patch_(.*)_(\d+)` FIND FIRST OCCURRENCE OF REGEX `patch_line_` && iv_action && `_(.*)_(\d)+_(\d+)`
IN iv_patch IN iv_patch
SUBMATCHES ev_filename ev_line_index. SUBMATCHES ev_filename lv_section ev_line_index.
IF sy-subrc <> 0. IF sy-subrc <> 0.
zcx_abapgit_exception=>raise( |Invalid patch| ). zcx_abapgit_exception=>raise( |Invalid patch| ).
ENDIF. ENDIF.
@ -591,6 +594,8 @@ CLASS ZCL_ABAPGIT_GUI_PAGE_DIFF IMPLEMENTATION.
CREATE OBJECT ro_html. CREATE OBJECT ro_html.
mv_section_count = mv_section_count + 1.
IF is_diff_line-beacon > 0. IF is_diff_line-beacon > 0.
lt_beacons = is_diff-o_diff->get_beacons( ). lt_beacons = is_diff-o_diff->get_beacons( ).
READ TABLE lt_beacons INTO lv_beacon INDEX is_diff_line-beacon. READ TABLE lt_beacons INTO lv_beacon INDEX is_diff_line-beacon.
@ -598,11 +603,30 @@ CLASS ZCL_ABAPGIT_GUI_PAGE_DIFF IMPLEMENTATION.
lv_beacon = '---'. lv_beacon = '---'.
ENDIF. ENDIF.
ro_html->add( '<thead class="nav_line">' ). ro_html->add( '<thead class="nav_line">' ).
ro_html->add( '<tr>' ). ro_html->add( '<tr>' ).
IF mv_patch_mode = abap_true.
ro_html->add( |<th class="patch">| ).
ro_html->add_a( iv_txt = |{ c_patch_action-add }|
iv_act = |patch_section_add('{ is_diff-filename }','{ mv_section_count }')|
iv_id = |patch_section_add_{ is_diff-filename }_{ mv_section_count }|
iv_class = |patch_section_add|
iv_typ = zif_abapgit_definitions=>c_action_type-dummy ).
ro_html->add_a( iv_txt = |{ c_patch_action-remove }|
iv_act = |patch_section_remove('{ is_diff-filename }', '{ mv_section_count }')|
iv_id = |patch_section_remove_{ is_diff-filename }_{ mv_section_count }|
iv_class = |patch_section_remove|
iv_typ = zif_abapgit_definitions=>c_action_type-dummy ).
ro_html->add( '</th>' ).
ELSE.
ro_html->add( '<th class="num"></th>' ). ro_html->add( '<th class="num"></th>' ).
ENDIF.
IF mv_unified = abap_true. IF mv_unified = abap_true.
ro_html->add( '<th class="num"></th>' ). ro_html->add( '<th class="num"></th>' ).
ro_html->add( |<th>@@ { is_diff_line-new_num } @@ { lv_beacon }</th>| ). ro_html->add( |<th>@@ { is_diff_line-new_num } @@ { lv_beacon }</th>| ).
@ -624,6 +648,8 @@ CLASS ZCL_ABAPGIT_GUI_PAGE_DIFF IMPLEMENTATION.
CREATE OBJECT ro_html. CREATE OBJECT ro_html.
CLEAR: mv_section_count.
li_progress = zcl_abapgit_progress=>get_instance( lines( mt_diff_files ) ). li_progress = zcl_abapgit_progress=>get_instance( lines( mt_diff_files ) ).
ro_html->add( |<div id="diff-list" data-repo-key="{ mv_repo_key }">| ). ro_html->add( |<div id="diff-list" data-repo-key="{ mv_repo_key }">| ).
@ -900,31 +926,24 @@ CLASS ZCL_ABAPGIT_GUI_PAGE_DIFF IMPLEMENTATION.
IF iv_patch_line_possible = abap_true. IF iv_patch_line_possible = abap_true.
lv_id = |patch_{ lv_object }_{ iv_index }|. lv_id = |{ lv_object }_{ mv_section_count }_{ iv_index }|.
io_html->add( |<td class="{ c_css_class-patch }">| ). io_html->add( |<td class="{ c_css_class-patch }">| ).
lv_left_class = |{ c_patch_action-add } |.
lv_right_class = |{ c_patch_action-remove } |.
IF is_diff_line-patch_flag = abap_true. IF is_diff_line-patch_flag = abap_true.
lv_left_class = c_css_class-patch_active.
lv_left_class = lv_left_class && |{ c_css_class-patch_active }|.
ELSE. ELSE.
lv_right_class = c_css_class-patch_active.
lv_right_class = lv_right_class && |{ c_css_class-patch_active }|.
ENDIF. ENDIF.
io_html->add_a( iv_txt = |{ c_patch_action-add }| io_html->add_a( iv_txt = |{ c_patch_action-add }|
iv_act = || iv_act = ||
iv_id = |{ c_patch_action-add }_{ lv_id }| iv_id = |patch_line_{ c_patch_action-add }_{ lv_id }|
iv_typ = zif_abapgit_definitions=>c_action_type-dummy iv_typ = zif_abapgit_definitions=>c_action_type-dummy
iv_class = lv_left_class ). iv_class = lv_left_class ).
io_html->add_a( iv_txt = |{ c_patch_action-remove }| io_html->add_a( iv_txt = |{ c_patch_action-remove }|
iv_act = || iv_act = ||
iv_id = |{ c_patch_action-remove }_{ lv_id }| iv_id = |patch_line_{ c_patch_action-remove }_{ lv_id }|
iv_typ = zif_abapgit_definitions=>c_action_type-dummy iv_typ = zif_abapgit_definitions=>c_action_type-dummy
iv_class = lv_right_class ). iv_class = lv_right_class ).
@ -945,13 +964,15 @@ CLASS ZCL_ABAPGIT_GUI_PAGE_DIFF IMPLEMENTATION.
io_html->add( |<th class="patch">| ). io_html->add( |<th class="patch">| ).
io_html->add_a( iv_txt = |{ c_patch_action-add }| io_html->add_a( iv_txt = |{ c_patch_action-add }|
iv_act = |patch_add_all('{ is_diff-filename }')| iv_act = |patch_file_add('{ is_diff-filename }')|
iv_id = |patch_add_all| iv_id = |patch_file_add_{ is_diff-filename }|
iv_class = |patch_file_add|
iv_typ = zif_abapgit_definitions=>c_action_type-dummy ). iv_typ = zif_abapgit_definitions=>c_action_type-dummy ).
io_html->add_a( iv_txt = |{ c_patch_action-remove }| io_html->add_a( iv_txt = |{ c_patch_action-remove }|
iv_act = |patch_remove_all('{ is_diff-filename }')| iv_act = |patch_file_remove('{ is_diff-filename }')|
iv_id = |patch_remove_all| iv_id = |patch_file_remove_{ is_diff-filename }|
iv_class = |patch_file_remove|
iv_typ = zif_abapgit_definitions=>c_action_type-dummy ). iv_typ = zif_abapgit_definitions=>c_action_type-dummy ).
io_html->add( '</th>' ). io_html->add( '</th>' ).