git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[JGIT PATCH 15/22] Added a Rules interface implementation and a factory for it.

From
FKFlorian Koeberle <florianskarten@web.de>
Date
May 10, 2008, 13:00 UTC
Message-ID
<1210424440-13886-16-git-send-email-florianskarten@web.de>
In-Reply-To
<1210424440-13886-1-git-send-email-florianskarten@web.de>
Signed-off-by: Florian Koeberle <florianskarten@web.de>
---
 .../fileiteration/RuleListToObjectConverter.java   |  113 ++++++++++++++++++++
 .../lib/fileiteration/RulesImplementation.java     |   87 +++++++++++++++
 2 files changed, 200 insertions(+), 0 deletions(-)
 create mode 100644 org.spearce.jgit/src/org/spearce/jgit/lib/fileiteration/RuleListToObjectConverter.java
 create mode 100644 org.spearce.jgit/src/org/spearce/jgit/lib/fileiteration/RulesImplementation.java
diff --git a/org.spearce.jgit/src/org/spearce/jgit/lib/fileiteration/RuleListToObjectConverter.java b/org.spearce.jgit/src/org/spearce/jgit/lib/fileiteration/RuleListToObjectConverter.java
new file mode 100644
index 0000000..533a35b
--- /dev/null
+++ b/org.spearce.jgit/src/org/spearce/jgit/lib/fileiteration/RuleListToObjectConverter.java
@@ -0,0 +1,113 @@
+/*
+ *  Copyright (C) 2008 Florian Köberle
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU General Public
+ *  License, version 2, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ */
+package org.spearce.jgit.lib.fileiteration;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+
+class RuleListToObjectConverter {
+	protected Rules createIgnoreRules(Iterator<Rule> ruleIterator) {
+		final List<Rule> rules = getNessesaryRulesFromIterator(ruleIterator);
+		removeUnnecessaryDoNotIgnoreRulesAtTheEndOfTheList(rules);
+		removeUnnecessaryIgnoreRulesNearTheEndOfTheList(rules);
+
+		if (rules.size() == 1) {
+			final Rule rule = rules.get(0);
+			if (rule.getPattern() == FilePattern.MATCH_ALWAYS) {
+				if (rule.isIgnoreAtMatch()) {
+					return Rules.IGNORE_ALL;
+				} else {
+					return Rules.IGNORE_NOTHING;
+				}
+			}
+		} else if (rules.isEmpty()) {
+			return Rules.IGNORE_NOTHING;
+		}
+		return new RulesImplementation(rules, this);
+	}
+
+	private List<Rule> getNessesaryRulesFromIterator(Iterator<Rule> ruleIterator) {
+		final List<Rule> rules = new ArrayList<Rule>();
+		while (ruleIterator.hasNext()) {
+			final Rule subRule = ruleIterator.next();
+			if (subRule.getPattern() == FilePattern.MATCH_NEVER) {
+				continue;
+			}
+			rules.add(subRule);
+			// There is no need for rules after a rule witch match always,
+			// as such a rule would never be the first rule which matches.
+			if (subRule.getPattern() == FilePattern.MATCH_ALWAYS) {
+				break;
+			}
+		}
+		return rules;
+	}
+
+	/**
+	 * Expects that
+	 * {@link #removeUnnecessaryDoNotIgnoreRulesAtTheEndOfTheList(List)} has
+	 * been executed first.
+	 * 
+	 * @param rules
+	 *            rule list to reduce.
+	 */
+	private void removeUnnecessaryIgnoreRulesNearTheEndOfTheList(
+			final List<Rule> rules) {
+		// Why the following optimization makes only sense for the end of the
+		// list:
+		// If there is a "ignore all"- rule,
+		// then it is located at the end of the list
+		// See how the list is filled to prove this statement.
+		if (rules.size() >= 2) {
+			final Rule lastRule = rules.get(rules.size() - 1);
+			assert lastRule.isIgnoreAtMatch() : "Expected that no 'not ignore'-rule is at the end of the list any more";
+			final boolean ignoreAllAtEnd = lastRule.getPattern().equals(
+					FilePattern.MATCH_ALWAYS);
+			if (ignoreAllAtEnd) {
+				while (rules.size() >= 2) {
+					final int ruleBeforeLastIndex = rules.size() - 2;
+					final Rule ruleBeforeLast = rules.get(ruleBeforeLastIndex);
+					if (ruleBeforeLast.isIgnoreAtMatch()) {
+						rules.remove(ruleBeforeLastIndex);
+					} else {
+						break;
+					}
+				}
+			}
+		}
+	}
+
+	private void removeUnnecessaryDoNotIgnoreRulesAtTheEndOfTheList(
+			final List<Rule> rules) {
+		// Why it is save to remove "don't ignore rules" at the end of the list
+		// if there is no "ignore rule" below a "don't ignore rule" then
+		// the path which haven't match jet will never be ignored:
+		// -> if another "don't ignore rule" match then the patch will not be
+		// ignored
+		// -> if no "don't ignore rule" match then the path will not be ignored.
+		while (!rules.isEmpty()) {
+			final int indexOfLastRule = rules.size() - 1;
+			final Rule lastRule = rules.get(indexOfLastRule);
+			if (lastRule.isIgnoreAtMatch()) {
+				break;
+			} else {
+				rules.remove(indexOfLastRule);
+			}
+		}
+	}
+}
diff --git a/org.spearce.jgit/src/org/spearce/jgit/lib/fileiteration/RulesImplementation.java b/org.spearce.jgit/src/org/spearce/jgit/lib/fileiteration/RulesImplementation.java
new file mode 100644
index 0000000..b7bf963
--- /dev/null
+++ b/org.spearce.jgit/src/org/spearce/jgit/lib/fileiteration/RulesImplementation.java
@@ -0,0 +1,87 @@
+/*
+ *  Copyright (C) 2008 Florian Köberle
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU General Public
+ *  License, version 2, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ */
+package org.spearce.jgit.lib.fileiteration;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+
+class RulesImplementation implements Rules {
+	/**
+	 * Complete list of rules. Note that order is: determining rule first.
+	 */
+	private final List<Rule> rulesForTree;
+
+	/**
+	 * {@link Rule} objects which return true at a call of
+	 * {@link Rule#canMatchAtThisDirectoryLevel}.
+	 */
+	private final List<Rule> rulesForThisLevel;
+
+	/**
+	 * Factory used to create {@link Rules} for sub directories.
+	 */
+	private RuleListToObjectConverter factory;
+
+	RulesImplementation(List<Rule> rules, RuleListToObjectConverter factory) {
+		this.rulesForTree = rules;
+		this.factory = factory;
+		this.rulesForThisLevel = new ArrayList<Rule>();
+		for (Rule rule : rules) {
+			if (rule.canMatchAtThisDirectoryLevel()) {
+				this.rulesForThisLevel.add(rule);
+			}
+		}
+	}
+
+	/**
+	 * @see org.spearce.jgit.lib.fileiteration.Rules#toIgnore(java.lang.String,
+	 *      boolean)
+	 */
+	public boolean toIgnore(String fileName, boolean fileIsDirectory) {
+		for (Rule rule : rulesForThisLevel) {
+			if (rule.getPattern().match(fileName, fileIsDirectory)) {
+				return rule.isIgnoreAtMatch();
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * @see org.spearce.jgit.lib.fileiteration.Rules#getRulesForSubDirectory(java.lang.String)
+	 */
+	public Rules getRulesForSubDirectory(final String directoryName) {
+		final Iterator<Rule> subRuleIterator = new Iterator<Rule>() {
+			final Iterator<Rule> ruleIterator = rulesForTree.iterator();
+
+			public boolean hasNext() {
+				return ruleIterator.hasNext();
+			}
+
+			public Rule next() {
+				return ruleIterator.next()
+						.getRuleForSubDirectory(directoryName);
+			}
+
+			public void remove() {
+				throw new UnsupportedOperationException();
+			}
+
+		};
+		return factory.createIgnoreRules(subRuleIterator);
+	}
+}
-- 
1.5.2.5
Previous: Robin RosenbergNext: Florian Koeberle
Message 22 of 35 in “Implementation of a file tree iteration using ignore rules.”
  1. Implementation of a file tree iteration using ignore rules.Florian Koeberle, May 10, 2008
  2. 01/22 Start of an implementation of a git like command line tool.Florian Koeberle, May 10, 2008
  3. 02/22 Replaced Java 6 API useage with Java 5 equivalent.Florian Koeberle, May 10, 2008
  4. 03/22 Added a class Project which represents a project directory and it's repository.Florian Koeberle, May 10, 2008
  5. Robin RosenbergMay 10, 2008
  6. 04/22 Added a "init" command to the git like command line tool.Florian Koeberle, May 10, 2008
  7. 05/22 Added ProjectSeeker class.Florian Koeberle, May 10, 2008
  8. Robin RosenbergMay 10, 2008
  9. 06/22 Added the interface FilePattern.Florian Koeberle, May 10, 2008
  10. 07/22 Added the class Rule.Florian Koeberle, May 10, 2008
  11. 08/22 Added the iterface Rules.Florian Koeberle, May 10, 2008
  12. Robin RosenbergMay 10, 2008
  13. 09/22 Added the class FileTreeIterator and a test for it.Florian Koeberle, May 10, 2008
  14. 10/22 Added class FileTreeIterable.Florian Koeberle, May 10, 2008
  15. 11/22 Added the class StarPattern.Florian Koeberle, May 10, 2008
  16. Robin RosenbergMay 10, 2008
  17. 12/22 Added the class GlobalFilePatternFlorian Koeberle, May 10, 2008
  18. 13/22 Added the class ComplexFilePattern.Florian Koeberle, May 10, 2008
  19. Robin RosenbergMay 10, 2008
  20. 14/22 Added the class IgnoreRuleListFactory.Florian Koeberle, May 10, 2008
  21. Robin RosenbergMay 10, 2008
  22. 15/22 Added a Rules interface implementation and a factory for it.Florian Koeberle, May 10, 2008
  23. 16/22 Added test class OverallIgnoreRulestest.Florian Koeberle, May 10, 2008
  24. 17/22 Added the class TreeFilePattern.Florian Koeberle, May 10, 2008
  25. 18/22 Added InvalidPatternException and PathNotInProjectDirectoryExceptionFlorian Koeberle, May 10, 2008
  26. Robin RosenbergMay 10, 2008
  27. 19/22 Added the class AddRuleListFactory.Florian Koeberle, May 10, 2008
  28. Robin RosenbergMay 10, 2008
  29. 20/22 Added class FileIterableFactoryForAddCommand.Florian Koeberle, May 10, 2008
  30. 21/22 Added test class FileIterableFactoryForAddCommandTest.Florian Koeberle, May 10, 2008
  31. Robin RosenbergMay 10, 2008
  32. 22/22 Added a "add" command to the git like command line tool.Florian Koeberle, May 10, 2008
  33. Robin RosenbergMay 10, 2008
  34. Robin RosenbergMay 10, 2008
  35. Shawn O. PearceMay 11, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.