Dictionary Anagram Search

A Java library for searching anagrams in a dictionary with different implementations.

Features

• Multiple dictionary search implementations:
  • SimpleDictionarySearch: Basic implementation for finding anagrams
  • SimpleCachedDictionarySearch: Caches anagram search results
  • PreloadedDictionarySearch: Preloads all anagrams for faster lookups
  • ExpiringCacheDictionarySearch: Caches anagram search results with expiration

Usage

// Create a dictionary
List<String> dictionary = Arrays.asList("StEt", "tEts", "SETt", "etTS", "EstT");

// Create a dictionary search implementation
DictionarySearch search = new SimpleDictionarySearch(dictionary);

// Search for anagrams
List<String> anagrams = search.searchAll("test");
// Returns: ["StEt", "tEts", "SETt", "etTS", "EstT"]

Implementations

SimpleDictionarySearch

Basic implementation that searches for anagrams in the dictionary.

SimpleCachedDictionarySearch

Caches anagram search results to improve performance for repeated searches.

PreloadedDictionarySearch

Preloads all anagrams during initialization for instant lookups.

ExpiringCacheDictionarySearch

Caches anagram search results with a configurable expiration time.

Testing

The project includes comprehensive test coverage for all implementations:

• Base test class DictionarySearchTest with common test cases
• Implementation-specific test classes extending the base test
• Additional tests for caching and expiration functionality
• JaCoCo test coverage reporting with minimum 80% line coverage requirement

Running Tests with Coverage

mvn clean test

This will:

1. Run all tests
2. Generate a coverage report in target/site/jacoco/
3. Fail the build if line coverage is below 80%

Project Structure

src/
├── main/
│   └── java/
│       └── com/
│           └── example/
│               └── labs/
│                   └── search/
│                       ├── DictionarySearch.java
│                       ├── DictionaryUtils.java
│                       ├── ExpiringCacheDictionarySearch.java
│                       ├── PreloadedDictionarySearch.java
│                       ├── SimpleCachedDictionarySearch.java
│                       └── SimpleDictionarySearch.java
└── test/
    └── java/
        └── com/
            └── example/
                └── labs/
                    └── search/
                        ├── DictionarySearchTest.java
                        ├── ExpiringCacheDictionarySearchTest.java
                        ├── PreloadedDictionarySearchTest.java
                        ├── SimpleCachedDictionarySearchTest.java
                        └── SimpleDictionarySearchTest.java

Getting Started

1. Clone the repository:

git clone https://github.com/yourusername/dictionary-search-anagrams-java.git
cd dictionary-search-anagrams-java

2. Build the project:

mvn clean install

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Continuous Integration and Deployment

This project uses GitHub Actions for continuous integration and deployment. The workflow is defined in .github/workflows/maven.yml and includes:

1. Build and Test Process:

   • Runs on every push to main and on pull requests
   • Sets up JDK 21 using Temurin distribution
   • Builds the project using Maven
   • Runs all tests with coverage reporting

2. Code Coverage:

   • Uses JaCoCo for test coverage reporting
   • Generates coverage reports in target/site/jacoco/
   • Uploads coverage reports as workflow artifacts
   • Fails the build if line coverage falls below 80%

3. Coverage Badges:

   • Uses cicirello/jacoco-badge-generator to create dynamic coverage badges
   • Generates both line coverage and branch coverage badges
   • Automatically updates badges after each build
   • Stores badges in the badges directory

Required Permissions

To enable the automatic badge updates, you need to configure the following permissions:

1. Go to your repository's Settings
2. Navigate to Actions > General
3. Under "Workflow permissions", select:
   • "Read and write permissions"
   • "Allow GitHub Actions to create and approve pull requests"

This configuration allows the workflow to:

• Commit and push updated coverage badges
• Create pull requests if needed
• Access repository contents for badge generation

Workflow Artifacts

After each build, you can find:

• Coverage reports in the workflow artifacts
• Updated coverage badges in the badges directory
• Build status and coverage information in the README badges

License

This project is licensed under the MIT License - see the LICENSE.md file for details.