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

[JGIT PATCH v4 14/24] Added class AddRulesFactory.

From
FKFlorian Koeberle <florianskarten@web.de>
Date
Jun 13, 2008, 18:35 UTC
Message-ID
<1213382121-19786-14-git-send-email-florianskarten@web.de>
In-Reply-To
<4852BCCA.4030404@web.de>
Signed-off-by: Florian Koeberle <florianskarten@web.de>
---
 .../jgit/treewalk/rules/AddRulesFactory.java       |  127 ++++++++++++++++++++
 1 files changed, 127 insertions(+), 0 deletions(-)
 create mode 100644 org.spearce.jgit/src/org/spearce/jgit/treewalk/rules/AddRulesFactory.java
diff --git a/org.spearce.jgit/src/org/spearce/jgit/treewalk/rules/AddRulesFactory.java b/org.spearce.jgit/src/org/spearce/jgit/treewalk/rules/AddRulesFactory.java
new file mode 100644
index 0000000..767b5c7
--- /dev/null
+++ b/org.spearce.jgit/src/org/spearce/jgit/treewalk/rules/AddRulesFactory.java
@@ -0,0 +1,127 @@
+/*
+ * Copyright (C) 2008, Florian Köberle <florianskarten@web.de>
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above
+ *   copyright notice, this list of conditions and the following
+ *   disclaimer in the documentation and/or other materials provided
+ *   with the distribution.
+ *
+ * - Neither the name of the Git Development Community nor the
+ *   names of its contributors may be used to endorse or promote
+ *   products derived from this software without specific prior
+ *   written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.spearce.jgit.treewalk.rules;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.spearce.jgit.errors.InvalidPatternException;
+import org.spearce.jgit.errors.PathNotInProjectDirectoryException;
+import static org.spearce.jgit.lib.Constants.REPOSITORY_DIRECTORY_NAME;
+
+/**
+ * This class is designed to serve the needs of someone who want to implement a
+ * git-add command and needs to determine the files to add.
+ * 
+ */
+public class AddRulesFactory {
+	private final RuleListToObjectConverter converter = new RuleListToObjectConverter();
+
+	private final IgnoreRuleListFactory ignoreRuleListFactory = new IgnoreRuleListFactory();
+
+	private final AddRuleListFactory addRuleListFactory = new AddRuleListFactory();
+
+	/**
+	 * @param workTreeDirectory
+	 *            The directory with the files of the project under version
+	 *            control.
+	 * @param workingDirectory
+	 *            a directory within the workTreeDirectory.
+	 * @param filePatternsOfAddCommand
+	 *            the file patterns passed to the add command.
+	 * @return a {@link Rules} containing the specified rules, the .gitignore
+	 *         and the .git/info/exclude rules.
+	 * @throws InvalidPatternException
+	 *             if a pattern is invalid.
+	 * @throws PathNotInProjectDirectoryException
+	 *             if the directory workingDirectory is not in workTreeDirectory
+	 * @throws IOException
+	 *             for some reasons.
+	 */
+	public Rules createRules(File workTreeDirectory, File workingDirectory,
+			List<String> filePatternsOfAddCommand)
+			throws InvalidPatternException, PathNotInProjectDirectoryException,
+			IOException {
+		final Rule gitDirectoryIgnoreRule = createGitDirectoryIgnoreRule();
+		final File gitDirectory = new File(workTreeDirectory,
+				REPOSITORY_DIRECTORY_NAME);
+		final List<Rule> ignoreRuleListFromFiles = createExcludeRules(
+				workTreeDirectory, gitDirectory);
+		final List<Rule> includeRules = addRuleListFactory.createRuleList(
+				workTreeDirectory, workingDirectory, filePatternsOfAddCommand);
+		final List<Rule> ruleList = new ArrayList<Rule>();
+
+		ruleList.add(gitDirectoryIgnoreRule);
+		ruleList.addAll(ignoreRuleListFromFiles);
+		ruleList.addAll(includeRules);
+		ruleList.add(new Rule(true, FilePattern.MATCH_ALWAYS));
+
+		return converter.createIgnoreRules(ruleList.iterator());
+	}
+
+	private List<Rule> createExcludeRules(File projectDirectory,
+			File gitDirectory) throws InvalidPatternException {
+		final List<File> possibleIgnoreFiles = new ArrayList<File>(2);
+		possibleIgnoreFiles.add(new File(projectDirectory, ".gitignore"));
+		possibleIgnoreFiles.add(new File(new File(gitDirectory, "info"),
+				"exclude"));
+
+		final List<File> ignoreFiles = new ArrayList<File>();
+		for (File possibleIgnoreFile : possibleIgnoreFiles) {
+			if (possibleIgnoreFile.isFile()) {
+				ignoreFiles.add(possibleIgnoreFile);
+			}
+		}
+
+		try {
+			return ignoreRuleListFactory.createIgnoreRuleList(ignoreFiles);
+		} catch (FileNotFoundException e) {
+			throw new RuntimeException("unexpected removal of ignore files", e);
+		}
+	}
+
+	private Rule createGitDirectoryIgnoreRule() throws InvalidPatternException {
+		final FilePattern gitDirectoryPattern = new FilePathPattern(
+				REPOSITORY_DIRECTORY_NAME, true, true);
+		final Rule gitDirectoryIgnoreRule = new Rule(true, gitDirectoryPattern);
+		return gitDirectoryIgnoreRule;
+	}
+}
-- 
1.5.4.3
Previous: Florian KoeberleNext: Florian Koeberle
Message 15 of 26 in “Implementation of fnmatch and the ignore rules”
  1. Implementation of fnmatch and the ignore rulesFlorian Köberle, Jun 13, 2008
  2. 01/24 Added the package fnmatch and two exceptions.Florian Koeberle, Jun 13, 2008
  3. 02/24 Added the interface FilePattern.Florian Koeberle, Jun 13, 2008
  4. 03/24 Added the class Rule.Florian Koeberle, Jun 13, 2008
  5. 04/24 Added the iterface Rules.Florian Koeberle, Jun 13, 2008
  6. 05/24 Added the class FileNamePattern.Florian Koeberle, Jun 13, 2008
  7. 06/24 Added the class FilePathPattern.Florian Koeberle, Jun 13, 2008
  8. 07/24 Added the class IgnoreRuleListFactory.Florian Koeberle, Jun 13, 2008
  9. 08/24 Added a Rules interface implementation and a factory for it.Florian Koeberle, Jun 13, 2008
  10. 09/24 Added test class OverallIgnoreRulestest.Florian Koeberle, Jun 13, 2008
  11. 10/24 Added the class PathNotInProjectDirectoryException.Florian Koeberle, Jun 13, 2008
  12. 11/24 Added the class AddRuleListFactory.Florian Koeberle, Jun 13, 2008
  13. 12/24 Formatted Constants class.Florian Koeberle, Jun 13, 2008
  14. 13/24 Added constant REPOSITORY_DIRECTORY_NAME to Constants class.Florian Koeberle, Jun 13, 2008
  15. 14/24 Added class AddRulesFactory.Florian Koeberle, Jun 13, 2008
  16. 15/24 Added the class LightFileTreeIterator and a test for it.Florian Koeberle, Jun 13, 2008
  17. 16/24 Added class LightFileTreeIterable.Florian Koeberle, Jun 13, 2008
  18. 17/24 Added path related constants to the Constants class.Florian Koeberle, Jun 13, 2008
  19. 18/24 Added WorkTree class which can be constructed over Repository.Florian Koeberle, Jun 13, 2008
  20. 19/24 Added the class NoGitRepositoryFoundException.Florian Koeberle, Jun 13, 2008
  21. 20/24 Formatted Repository class.Florian Koeberle, Jun 13, 2008
  22. 21/24 Added findWorkTree method to Repository class.Florian Koeberle, Jun 13, 2008
  23. 22/24 Formatted RepositoryTestCase.Florian Koeberle, Jun 13, 2008
  24. 23/24 Added a super class for RepositoryTestCase with a createTemporaryDirectory() method.Florian Koeberle, Jun 13, 2008
  25. 24/24 Added the test class AddCommandIterationTest.Florian Koeberle, Jun 13, 2008
  26. Robin RosenbergJun 18, 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.