diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml deleted file mode 100644 index 167d740..0000000 --- a/.github/workflows/tests.yml +++ /dev/null @@ -1,46 +0,0 @@ -name: tests - -on: - push: - branches: - - main - pull_request: - schedule: - - cron: '0 0 * * *' - -permissions: - contents: read - -jobs: - tests: - runs-on: ubuntu-22.04 - - strategy: - fail-fast: true - matrix: - php: [8.1, 8.2, 8.3] - - name: PHP ${{ matrix.php }} - - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Setup PHP - uses: shivammathur/setup-php@v2 - with: - php-version: ${{ matrix.php }} - extensions: curl, mbstring, zip - ini-values: error_reporting=E_ALL - tools: composer:v2 - coverage: none - - - name: Install dependencies - uses: nick-fields/retry@v2 - with: - timeout_minutes: 5 - max_attempts: 5 - command: composer update --prefer-stable --prefer-dist --no-interaction --no-progress - - - name: Execute tests - run: vendor/bin/phpunit diff --git a/.gitignore b/.gitignore index 12ff5a2..d83e6c9 100644 --- a/.gitignore +++ b/.gitignore @@ -9,5 +9,3 @@ Thumbs.db .phpunit.result.cache phpstan.neon phpstan-baseline.neon -CODE_OF_CONDUCT.md -SECURITY.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..494abbb --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +dewanakretarta29@gmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/README.MD b/README.MD index 0695a38..777fe41 100644 --- a/README.MD +++ b/README.MD @@ -1 +1,96 @@ -# Simple filter kata kotor dengan regex +
+ + + +# Simple Profanity Filter with Regex + +This is a simple project that filters out profane words using regex in PHP. It provides functions to check, filter, and remove unwanted words from a text using regex patterns that account for similar characters. + +## Features + +- **Profanity Check**: Check if a string contains any unwanted words. +- **Profanity Filter**: Remove unwanted words from a text. +- **Profanity Masking**: Replace unwanted words with a masking character, such as `*`. + +## Installation + +To install this package, you can use Composer: + +1. Run the following command in your project directory: + + ```bash + composer require kamu/aman + ``` + +2. Add the list of words you want to filter in the db/lists.php file. + + ```php + return [ + 'badword1', + 'badword2', + // Add more words you want to filter + ]; + ``` + +## Usage + +You can use the Aman class to filter profanity in your application. + +### Example Usage + +1. Check for Profane Words + + ```php + use Kamu\Aman; + + $text = "This is an example with bad words."; + $filter = Aman::factory(); + + if ($filter->check($text)) { + echo "This text contains profanity."; + } else { + echo "This text is clean."; + } + ``` + +2. Mask Profane Words + + ```php + $text = "This is an example with bad words."; + $maskedText = $filter->masking($text, '*'); + echo $maskedText; // Output: "This is an example with *** ****." + ``` + +3. Remove Profane Words + + ```php + $text = "This is an example with bad words."; + $cleanText = $filter->filter($text); + echo $cleanText; // Output: "This is an example with ." + ``` + +4. Get Profane Words from Text + + ```php + $text = "This is an example with bad words."; + $badWords = $filter->words($text); + print_r($badWords); // Output: ['bad', 'words'] + ``` + +## Contributing + +I'm very open to those of you who want to contribute to the Aman! + +## Security Vulnerabilities + +If you find any security vulnerabilities in this Aman, please email DKL via [dewanakretarta29@gmail.com](mailto:dewanakretarta29@gmail.com). + +## License + +Aman is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..cd870f6 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,20 @@ +# Security Policy + +The development take all security issues seriously. Please do not make public any uncovered flaws. + +## Supported Versions + +Currently supported project versions with security updates: + +| Version | Supported | +| ------- | ------------------ | +| 1.1.1 | :white_check_mark: | +| < 1.0.1 | :x: | + +## Reporting a Vulnerability + +If you discover a security vulnerability, please send an e-mail to Dewana Kretarta Lokeswara via dewanakretarta29@gmail.com + +## Comments on this Policy + +If you have suggestions on how this process could be improved please submit a Pull Request. diff --git a/img/aman.png b/img/aman.png new file mode 100644 index 0000000..82c0d4f Binary files /dev/null and b/img/aman.png differ