Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

added switch to disallow nesting of same sections #21

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

added switch to disallow nesting of same sections #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
561972c
added switch to disallow nesting of same sections
maybeec Jun 11, 2020
73c878f
bugfix
maybeec Jun 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions ...n/java/org/jvnet/hudson/plugins/collapsingconsolesections/CollapsingSectionAnnotator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,19 @@
*/
package org.jvnet.hudson.plugins.collapsingconsolesections;

import hudson.MarkupText;
import hudson.Util;
import hudson.console.ConsoleAnnotator;
import hudson.model.Run;
import java.io.Serializable;
import java.util.Arrays;
import java.util.List;
import java.util.Stack;
import java.util.regex.Matcher;

import javax.annotation.Nonnull;

import hudson.MarkupText;
import hudson.Util;
import hudson.console.ConsoleAnnotator;
import hudson.model.Run;

public class CollapsingSectionAnnotator extends ConsoleAnnotator<Object> {

@Nonnull
Expand Down Expand Up @@ -63,7 +65,7 @@
}

while (!currentSections.empty()) {
SectionDefinition currentSection = currentSections.peek();
SectionDefinition currentSection = currentSections.peek();
if (currentSection.getSectionEndPattern().matcher(text.getText().trim()).matches()) {
popSection(text);
if (currentSection.isCollapseOnlyOneLevel()) {
Expand All @@ -75,6 +77,11 @@
}

for (SectionDefinition section : sections) {
if(!currentSections.empty()
&& currentSections.peek().getSectionDisplayName().equals(section.getSectionDisplayName())
&& !section.isAllowNesting()) {
continue;

Check warning on line 83 in src/main/java/org/jvnet/hudson/plugins/collapsingconsolesections/CollapsingSectionAnnotator.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Not covered lines 

Lines 80-83 are not covered by tests
}
Matcher m = section.getSectionStartPattern().matcher(text.getText().trim());
if (m.matches()) {
pushSection(text, m, section);
Expand Down
26 changes: 16 additions & 10 deletions src/main/java/org/jvnet/hudson/plugins/collapsingconsolesections/CollapsingSectionNote.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,29 @@
*/
package org.jvnet.hudson.plugins.collapsingconsolesections;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import hudson.Extension;
import hudson.MarkupText;
import hudson.console.ConsoleAnnotationDescriptor;
import hudson.console.ConsoleAnnotator;
import hudson.console.ConsoleNote;
import hudson.util.FormValidation;
import java.lang.reflect.Array;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

import net.sf.json.JSONObject;

import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import hudson.Extension;
import hudson.MarkupText;
import hudson.console.ConsoleAnnotationDescriptor;
import hudson.console.ConsoleAnnotator;
import hudson.console.ConsoleNote;
import hudson.util.FormValidation;

/**
*
* @author dty
Expand All @@ -56,19 +60,21 @@ public class CollapsingSectionNote extends ConsoleNote {
private String sectionEndPattern;
private boolean collapseOnlyOneLevel;
private boolean collapseSection;
private boolean allowNesting;

@DataBoundConstructor
public CollapsingSectionNote(@Nonnull String sectionDisplayName, @Nonnull String sectionStartPattern, @Nonnull String sectionEndPattern, boolean collapseOnlyOneLevel, boolean collapseSection) {
public CollapsingSectionNote(@Nonnull String sectionDisplayName, @Nonnull String sectionStartPattern, @Nonnull String sectionEndPattern, boolean collapseOnlyOneLevel, boolean collapseSection, boolean allowNesting) {
this.sectionDisplayName = sectionDisplayName;
this.sectionStartPattern = sectionStartPattern;
this.sectionEndPattern = sectionEndPattern;
this.collapseOnlyOneLevel = collapseOnlyOneLevel;
this.collapseSection = collapseSection;
this.allowNesting = allowNesting;
}

@Deprecated
public CollapsingSectionNote(String sectionDisplayName, String sectionStartPattern, String sectionEndPattern, boolean collapseOnlyOneLevel) {
this(sectionDisplayName, sectionStartPattern, sectionEndPattern, collapseOnlyOneLevel, false);
this(sectionDisplayName, sectionStartPattern, sectionEndPattern, collapseOnlyOneLevel, false, false);
}

@Nonnull
Expand Down Expand Up @@ -101,7 +107,7 @@ public boolean isCollapseOnlyOneLevel() {

@Nonnull
public SectionDefinition getDefinition() {
return new SectionDefinition(sectionDisplayName, sectionStartPattern, sectionEndPattern, collapseOnlyOneLevel, collapseSection);
return new SectionDefinition(sectionDisplayName, sectionStartPattern, sectionEndPattern, collapseOnlyOneLevel, collapseSection, allowNesting);
}

@Override
Expand Down
24 changes: 19 additions & 5 deletions src/main/java/org/jvnet/hudson/plugins/collapsingconsolesections/SectionDefinition.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;

import javax.annotation.Nonnull;

/**
Expand All @@ -39,21 +40,30 @@
private Pattern end;
private boolean collapseOnlyOneLevel;
private boolean collapseSection;
private boolean allowNesting;

/**
* @deprecated Use {@link #SectionDefinition(java.lang.String, java.lang.String, java.lang.String, boolean, boolean)} instead.
* @deprecated Use {@link #SectionDefinition(java.lang.String, java.lang.String, java.lang.String, boolean, boolean, boolean)} instead.
*/
@Deprecated
public SectionDefinition(String sectionName, String sectionStartPattern, String sectionEndPattern) {
this(sectionName, sectionStartPattern, sectionEndPattern, false, false);
this(sectionName, sectionStartPattern, sectionEndPattern, false, false, false);
}

/**
* @deprecated Use {@link #SectionDefinition(java.lang.String, java.lang.String, java.lang.String, boolean, boolean)} instead.
* @deprecated Use {@link #SectionDefinition(java.lang.String, java.lang.String, java.lang.String, boolean, boolean, boolean)} instead.
*/
@Deprecated
public SectionDefinition(String sectionName, String sectionStartPattern, String sectionEndPattern, boolean collapseOnlyOneLevel) {
this(sectionName, sectionStartPattern, sectionEndPattern, collapseOnlyOneLevel, false);
this(sectionName, sectionStartPattern, sectionEndPattern, collapseOnlyOneLevel, false, false);
}

/**
* @deprecated Use {@link #SectionDefinition(java.lang.String, java.lang.String, java.lang.String, boolean, boolean, boolean)} instead.
*/
@Deprecated
public SectionDefinition(String sectionName, String sectionStartPattern, String sectionEndPattern, boolean collapseOnlyOneLevel, boolean collapseSection) {
this(sectionName, sectionStartPattern, sectionEndPattern, collapseOnlyOneLevel, collapseSection, false);

Check warning on line 66 in src/main/java/org/jvnet/hudson/plugins/collapsingconsolesections/SectionDefinition.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Not covered lines 

Lines 58-66 are not covered by tests
}

/**
Expand All @@ -65,12 +75,13 @@
* @param collapseSection If {@code true}, the section should be collapsed by default
* @throws PatternSyntaxException One of the patterns is invalid
*/
public SectionDefinition(@Nonnull String sectionName, @Nonnull String sectionStartPattern, @Nonnull String sectionEndPattern, boolean collapseOnlyOneLevel, boolean collapseSection) throws PatternSyntaxException {
public SectionDefinition(@Nonnull String sectionName, @Nonnull String sectionStartPattern, @Nonnull String sectionEndPattern, boolean collapseOnlyOneLevel, boolean collapseSection, boolean allowNesting) throws PatternSyntaxException {
name = sectionName;
start = Pattern.compile(sectionStartPattern);
end = Pattern.compile(sectionEndPattern);
this.collapseOnlyOneLevel = collapseOnlyOneLevel;
this.collapseSection = collapseSection;
this.allowNesting = allowNesting;
}

@Nonnull
Expand Down Expand Up @@ -111,4 +122,7 @@
public boolean isCollapseOnlyOneLevel() {
return collapseOnlyOneLevel;
}
public boolean isAllowNesting() {
return allowNesting;

Check warning on line 126 in src/main/java/org/jvnet/hudson/plugins/collapsingconsolesections/SectionDefinition.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Not covered line 

Line 126 is not covered by tests
}
}
3 changes: 3 additions & 0 deletions ...ces/org/jvnet/hudson/plugins/collapsingconsolesections/CollapsingSectionNote/global.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ THE SOFTWARE.
<f:entry title="${%Collapse Sections}" field="collapseSection">
<f:checkbox title="${%Collapse Sections by default}" checked="${instance.collapseSection}"/>
</f:entry>
<f:entry title="${%Allow Nesting}" field="allowNesting">
<f:checkbox title="${%Allow Nesting Sections}" checked="${instance.allowNesting}"/>
</f:entry>
<f:entry title="">
<div align="right">
<f:repeatableDeleteButton value="Delete ${descriptor.displayName}"/>
Expand Down
3 changes: 3 additions & 0 deletions ...net/hudson/plugins/collapsingconsolesections/CollapsingSectionNote/help-allowNesting.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<div>
Determines whether nesting of the same section should be allowed.
</div>