html_scss_class_checker 0.1.0 → 0.2.0

data/docs/api.md

@@ -0,0 +1,97 @@
+# API Documentation for HtmlScssClassChecker Gem
+
+The `HtmlScssClassChecker` gem provides a Ruby API for identifying unused or unmatched HTML and SCSS classes in your web projects. This document outlines how to use the gem's API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html_scss_class_checker'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install html_scss_class_checker
+```
+
+## Usage
+
+### Class Extraction
+
+The gem provides methods to extract class names from HTML and SCSS files.
+
+#### HTML Class Extraction
+
+```ruby
+require 'html_scss_class_checker'
+
+html_content = "<div class='test-class another-class'></div>"
+html_classes = HtmlScssClassChecker::ClassExtractor.extract_from_html(html_content)
+
+puts html_classes
+# Output: Set['test-class', 'another-class']
+```
+
+#### SCSS Class Extraction
+
+```ruby
+scss_content = ".test-class { color: red; } .another-class { color: blue; }"
+scss_classes = HtmlScssClassChecker::ClassExtractor.extract_from_scss(scss_content)
+
+puts scss_classes
+# Output: Set['test-class', 'another-class']
+```
+
+### File Processing
+
+You can process individual files to list the classes used in them.
+
+```ruby
+html_file_processor = HtmlScssClassChecker::FileProcessor.new('path/to/file.html', 'html')
+html_classes = html_file_processor.list_classes
+
+scss_file_processor = HtmlScssClassChecker::FileProcessor.new('path/to/style.scss', 'scss')
+scss_classes = scss_file_processor.list_classes
+```
+
+### Class Checking
+
+The main functionality of the gem is to check for unmatched classes between HTML and SCSS files.
+
+```ruby
+config = {
+  'known_classes' => ['known-class1', 'known-class2'],
+  'html_directories' => ['path/to/html/files'],
+  'scss_directories' => ['path/to/scss/files']
+}
+
+checker = HtmlScssClassChecker::ClassChecker.new(config)
+checker.check
+
+puts "Unmatched Classes: #{checker.unmatched_classes.to_a}"
+puts "Classes in each file: #{checker.file_class_mapping}"
+```
+
+## Configuration
+
+The `ClassChecker` requires a configuration hash with the following keys:
+
+- `known_classes`: An array of class names that are known and should not be reported as unmatched.
+- `html_directories`: An array of directories to search for HTML files.
+- `scss_directories`: An array of directories to search for SCSS files.
+
+## Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. Please see [CONTRIBUTING.md](/CONTRIBUTING.md) for details.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/docs/development.md

@@ -1,87 +1,87 @@
-# Development Guide for HtmlScssClassChecker
-
-This document provides guidelines and instructions for developers who wish to contribute to the development of the `HtmlScssClassChecker` gem. This guide covers setting up a development environment, making changes, and submitting contributions.
-
-## Setting Up a Development Environment
-
-1. **Clone the Repository**:
-   First, clone the repository to your local machine. Use the following command, replacing `REPO_URL` with the actual URL of the repository:
-
-   ```bash
-   git clone REPO_URL
-   cd html_scss_class_checker
-   ```
-
-2. **Install Dependencies**:
-   Make sure you have Bundler installed, then run:
-
-   ```bash
-   bundle install
-   ```
-
-   This will install all the necessary dependencies for the gem.
-
-3. **Create a Feature Branch**:
-   When working on a new feature or bug fix, create a new branch:
-
-   ```bash
-   git checkout -b feature/my-new-feature
-   ```
-
-   or
-
-   ```bash
-   git checkout -b bugfix/my-bug-fix
-   ```
-
-## Making Changes
-
-1. **Code Changes**:
-   Make your code changes, ensuring to follow the coding standards and guidelines of the project. Add or modify tests as appropriate for your changes.
-
-2. **Running Tests**:
-   Run the test suite to ensure your changes haven't introduced any regressions:
-
-   ```bash
-   rake spec
-   ```
-
-3. **Update Documentation**:
-   If your changes introduce new features or modify existing behavior, update the documentation accordingly.
-
-4. **Commit Your Changes**:
-   Once you're satisfied with your changes and all tests pass, commit your changes:
-
-   ```bash
-   git add .
-   git commit -m "Add my new feature"
-   ```
-
-## Submitting Contributions
-
-1. **Push Your Branch**:
-   Push the feature or bugfix branch to your fork:
-
-   ```bash
-   git push origin feature/my-new-feature
-   ```
-
-2. **Create a Pull Request**:
-   Go to the original `HtmlScssClassChecker` repository on GitHub and create a new pull request. Provide a clear description of the changes and any relevant issue numbers.
-
-3. **Code Review**:
-   Once your pull request is opened, it will be reviewed by the maintainers. Engage in the code review process, addressing any feedback or comments.
-
-4. **Merging**:
-   After your pull request has been approved, it will be merged into the main branch.
-
-## Additional Resources
-
-- **Ruby Style Guide**: Familiarize yourself with the [Ruby Style Guide](https://github.com/rubocop/ruby-style-guide) to maintain consistency in code.
-- **Testing with RSpec**: Learn more about testing Ruby applications with [RSpec](https://rspec.info/).
-
-## Questions and Support
-
-If you have any questions or need help with setting up your development environment, feel free to open an issue in the repository for assistance.
-
-Thank you for contributing to `HtmlScssClassChecker`!
+# Development Guide for HtmlScssClassChecker
+
+This document provides guidelines and instructions for developers who wish to contribute to the development of the `HtmlScssClassChecker` gem. This guide covers setting up a development environment, making changes, and submitting contributions.
+
+## Setting Up a Development Environment
+
+1. **Clone the Repository**:
+   First, clone the repository to your local machine. Use the following command, replacing `REPO_URL` with the actual URL of the repository:
+
+   ```bash
+   git clone REPO_URL
+   cd html_scss_class_checker
+   ```
+
+2. **Install Dependencies**:
+   Make sure you have Bundler installed, then run:
+
+   ```bash
+   bundle install
+   ```
+
+   This will install all the necessary dependencies for the gem.
+
+3. **Create a Feature Branch**:
+   When working on a new feature or bug fix, create a new branch:
+
+   ```bash
+   git checkout -b feature/my-new-feature
+   ```
+
+   or
+
+   ```bash
+   git checkout -b bugfix/my-bug-fix
+   ```
+
+## Making Changes
+
+1. **Code Changes**:
+   Make your code changes, ensuring to follow the coding standards and guidelines of the project. Add or modify tests as appropriate for your changes.
+
+2. **Running Tests**:
+   Run the test suite to ensure your changes haven't introduced any regressions:
+
+   ```bash
+   rake spec
+   ```
+
+3. **Update Documentation**:
+   If your changes introduce new features or modify existing behavior, update the documentation accordingly.
+
+4. **Commit Your Changes**:
+   Once you're satisfied with your changes and all tests pass, commit your changes:
+
+   ```bash
+   git add .
+   git commit -m "Add my new feature"
+   ```
+
+## Submitting Contributions
+
+1. **Push Your Branch**:
+   Push the feature or bugfix branch to your fork:
+
+   ```bash
+   git push origin feature/my-new-feature
+   ```
+
+2. **Create a Pull Request**:
+   Go to the original `HtmlScssClassChecker` repository on GitHub and create a new pull request. Provide a clear description of the changes and any relevant issue numbers.
+
+3. **Code Review**:
+   Once your pull request is opened, it will be reviewed by the maintainers. Engage in the code review process, addressing any feedback or comments.
+
+4. **Merging**:
+   After your pull request has been approved, it will be merged into the main branch.
+
+## Additional Resources
+
+- **Ruby Style Guide**: Familiarize yourself with the [Ruby Style Guide](https://github.com/rubocop/ruby-style-guide) to maintain consistency in code.
+- **Testing with RSpec**: Learn more about testing Ruby applications with [RSpec](https://rspec.info/).
+
+## Questions and Support
+
+If you have any questions or need help with setting up your development environment, feel free to open an issue in the repository for assistance.
+
+Thank you for contributing to `HtmlScssClassChecker`!

data/docs/testing.md

@@ -1,73 +1,73 @@
-# Testing Guide for HtmlScssClassChecker
-
-This document provides guidelines and best practices for writing and running tests for the `HtmlScssClassChecker` gem. Effective testing is crucial to ensure the reliability and stability of the gem.
-
-## Setting Up for Testing
-
-Before running the tests, ensure that you have set up your development environment as described in [DEVELOPMENT.md](/DEVELOPMENT.md). This setup includes cloning the repository and installing all required dependencies.
-
-## Running Tests
-
-To run the test suite, use the following command:
-
-```bash
-rake spec
-```
-
-This command will execute all tests written in the `spec` directory. Make sure that all tests pass before submitting any changes or pull requests.
-
-## Writing Tests
-
-When adding new features or fixing bugs, it's essential to write corresponding tests. The `HtmlScssClassChecker` gem uses RSpec for testing. Here are some guidelines for writing tests:
-
-1. **Descriptive Test Cases**: Write clear and descriptive test cases. Each test case should express the intended functionality or the specific condition it's testing.
-
-2. **Small and Focused**: Keep tests small and focused on one aspect of the code. Each test should only test one behavior.
-
-3. **Use Contexts**: Group related tests using `context` blocks in RSpec. This helps to organize tests and makes the test file easier to read.
-
-4. **Test Edge Cases**: Consider edge cases and error conditions, not just the happy path.
-
-5. **DRY (Don't Repeat Yourself)**: Reuse test setup code where possible, but avoid complex dependencies between tests.
-
-6. **Mocks and Stubs**: Use mocks and stubs to isolate tests from dependencies, particularly for external services or file access.
-
-## Example Test Structure
-
-Here’s an example structure for an RSpec test in `HtmlScssClassChecker`:
-
-```ruby
-RSpec.describe HtmlScssClassChecker::SomeClass do
-  describe '#some_method' do
-    context 'when some condition is met' do
-      it 'behaves in a certain way' do
-        # Setup
-        # Exercise
-        # Verify
-      end
-    end
-
-    context 'when another condition is met' do
-      it 'behaves in a different way' do
-        # Setup
-        # Exercise
-        # Verify
-      end
-    end
-  end
-end
-```
-
-## Testing Best Practices
-
-- **Independence**: Tests should not rely on the state produced by other tests.
-- **Reproducibility**: Tests should produce the same results regardless of the environment in which they are run.
-- **Automated**: Automate tests as part of your build or CI/CD pipeline.
-
-## Continuous Integration
-
-Consider setting up a Continuous Integration (CI) service like Travis CI, GitHub Actions, or CircleCI to automatically run tests on every commit or pull request. This ensures that all changes are tested before they are merged.
-
----
-
-For more information on RSpec and testing in Ruby, refer to the [RSpec documentation](https://relishapp.com/rspec/). If you encounter any issues or have questions about testing `HtmlScssClassChecker`, feel free to open an issue in the repository.
+# Testing Guide for HtmlScssClassChecker
+
+This document provides guidelines and best practices for writing and running tests for the `HtmlScssClassChecker` gem. Effective testing is crucial to ensure the reliability and stability of the gem.
+
+## Setting Up for Testing
+
+Before running the tests, ensure that you have set up your development environment as described in [DEVELOPMENT.md](/DEVELOPMENT.md). This setup includes cloning the repository and installing all required dependencies.
+
+## Running Tests
+
+To run the test suite, use the following command:
+
+```bash
+rake spec
+```
+
+This command will execute all tests written in the `spec` directory. Make sure that all tests pass before submitting any changes or pull requests.
+
+## Writing Tests
+
+When adding new features or fixing bugs, it's essential to write corresponding tests. The `HtmlScssClassChecker` gem uses RSpec for testing. Here are some guidelines for writing tests:
+
+1. **Descriptive Test Cases**: Write clear and descriptive test cases. Each test case should express the intended functionality or the specific condition it's testing.
+
+2. **Small and Focused**: Keep tests small and focused on one aspect of the code. Each test should only test one behavior.
+
+3. **Use Contexts**: Group related tests using `context` blocks in RSpec. This helps to organize tests and makes the test file easier to read.
+
+4. **Test Edge Cases**: Consider edge cases and error conditions, not just the happy path.
+
+5. **DRY (Don't Repeat Yourself)**: Reuse test setup code where possible, but avoid complex dependencies between tests.
+
+6. **Mocks and Stubs**: Use mocks and stubs to isolate tests from dependencies, particularly for external services or file access.
+
+## Example Test Structure
+
+Here’s an example structure for an RSpec test in `HtmlScssClassChecker`:
+
+```ruby
+RSpec.describe HtmlScssClassChecker::SomeClass do
+  describe '#some_method' do
+    context 'when some condition is met' do
+      it 'behaves in a certain way' do
+        # Setup
+        # Exercise
+        # Verify
+      end
+    end
+
+    context 'when another condition is met' do
+      it 'behaves in a different way' do
+        # Setup
+        # Exercise
+        # Verify
+      end
+    end
+  end
+end
+```
+
+## Testing Best Practices
+
+- **Independence**: Tests should not rely on the state produced by other tests.
+- **Reproducibility**: Tests should produce the same results regardless of the environment in which they are run.
+- **Automated**: Automate tests as part of your build or CI/CD pipeline.
+
+## Continuous Integration
+
+Consider setting up a Continuous Integration (CI) service like Travis CI, GitHub Actions, or CircleCI to automatically run tests on every commit or pull request. This ensures that all changes are tested before they are merged.
+
+---
+
+For more information on RSpec and testing in Ruby, refer to the [RSpec documentation](https://relishapp.com/rspec/). If you encounter any issues or have questions about testing `HtmlScssClassChecker`, feel free to open an issue in the repository.

data/docs/usage.md

@@ -1,89 +1,89 @@
-# HtmlScssClassChecker Usage Guide
-
-This document provides detailed instructions on how to use the `HtmlScssClassChecker` gem. This gem is designed to help front-end developers identify unused or unmatched HTML and SCSS classes, improving the maintainability and efficiency of their codebases.
-
-## Installation
-
-Before using the gem, ensure it is installed in your Ruby environment:
-
-```bash
-gem install html_scss_class_checker
-```
-
-Or, if you are using Bundler, add it to your Gemfile and run `bundle install`:
-
-```ruby
-gem 'html_scss_class_checker'
-```
-
-## Configuration
-
-Create a configuration file named `config.json` in your project root (or another location of your choosing) with the following structure:
-
-```json
-{
-  "known_classes": ["list", "of", "known", "classes"],
-  "html_directories": ["path/to/html/files"],
-  "scss_directories": ["path/to/scss/files"]
-}
-```
-
-- `known_classes`: An array of class names that you expect to find in your HTML and SCSS files.
-- `html_directories`: An array of directories where your HTML files are located.
-- `scss_directories`: An array of directories where your SCSS files are located.
-
-## Basic Usage
-
-To run the class checker, use the following Ruby script:
-
-```ruby
-require 'html_scss_class_checker'
-
-# Load configuration
-config_file = 'config.json'  # Replace with your config file path
-config = JSON.parse(File.read(config_file))
-
-# Initialize and run checker
-checker = HtmlScssClassChecker::ClassChecker.new(config)
-checker.check
-
-# Output unmatched classes
-puts "Unmatched Classes:"
-puts checker.unmatched_classes.to_a
-
-# Output class mapping in each file
-puts "\nClasses in each file:"
-checker.file_class_mapping.each do |file, classes|
-  puts "#{file}: #{classes.to_a}"
-end
-```
-
-This script will read the configuration from `config.json`, initialize the class checker, and then output any unmatched classes along with a mapping of classes to files.
-
-## Advanced Usage
-
-### Custom Configurations
-
-You can modify the `config.json` to suit your project's structure and requirements. For instance, you may have multiple HTML and SCSS directories or a specific set of known classes you want to validate against.
-
-### Integrating with Build Tools
-
-You can integrate `HtmlScssClassChecker` into your build process by creating a Rake task or a script that is run as part of your build or deployment pipeline. This can help in catching class inconsistencies before they reach production.
-
-## Troubleshooting
-
-If you encounter issues while using the gem, consider the following:
-
-- Ensure all paths in your `config.json` are correct and accessible.
-- Check if all necessary dependencies are installed.
-- Validate the format of your `config.json`.
-
-## Contributions and Feedback
-
-Contributions to the `HtmlScssClassChecker` gem are welcome! If you have suggestions for improvement or encounter any issues, please feel free to open an issue or submit a pull request on the repository.
-
----
-
-For further details, refer to the [README.md](/README.md) and the [API Documentation](/docs/api.md) (if available).
-
-This guide assumes a basic understanding of Ruby and gem management. For more information on these topics, visit the [official Ruby documentation](https://www.ruby-lang.org/en/documentation/).
+# HtmlScssClassChecker Usage Guide
+
+This document provides detailed instructions on how to use the `HtmlScssClassChecker` gem. This gem is designed to help front-end developers identify unused or unmatched HTML and SCSS classes, improving the maintainability and efficiency of their codebases.
+
+## Installation
+
+Before using the gem, ensure it is installed in your Ruby environment:
+
+```bash
+gem install html_scss_class_checker
+```
+
+Or, if you are using Bundler, add it to your Gemfile and run `bundle install`:
+
+```ruby
+gem 'html_scss_class_checker'
+```
+
+## Configuration
+
+Create a configuration file named `config.json` in your project root (or another location of your choosing) with the following structure:
+
+```json
+{
+  "known_classes": ["list", "of", "known", "classes"],
+  "html_directories": ["path/to/html/files"],
+  "scss_directories": ["path/to/scss/files"]
+}
+```
+
+- `known_classes`: An array of class names that you expect to find in your HTML and SCSS files.
+- `html_directories`: An array of directories where your HTML files are located.
+- `scss_directories`: An array of directories where your SCSS files are located.
+
+## Basic Usage
+
+To run the class checker, use the following Ruby script:
+
+```ruby
+require 'html_scss_class_checker'
+
+# Load configuration
+config_file = 'config.json'  # Replace with your config file path
+config = JSON.parse(File.read(config_file))
+
+# Initialize and run checker
+checker = HtmlScssClassChecker::ClassChecker.new(config)
+checker.check
+
+# Output unmatched classes
+puts "Unmatched Classes:"
+puts checker.unmatched_classes.to_a
+
+# Output class mapping in each file
+puts "\nClasses in each file:"
+checker.file_class_mapping.each do |file, classes|
+  puts "#{file}: #{classes.to_a}"
+end
+```
+
+This script will read the configuration from `config.json`, initialize the class checker, and then output any unmatched classes along with a mapping of classes to files.
+
+## Advanced Usage
+
+### Custom Configurations
+
+You can modify the `config.json` to suit your project's structure and requirements. For instance, you may have multiple HTML and SCSS directories or a specific set of known classes you want to validate against.
+
+### Integrating with Build Tools
+
+You can integrate `HtmlScssClassChecker` into your build process by creating a Rake task or a script that is run as part of your build or deployment pipeline. This can help in catching class inconsistencies before they reach production.
+
+## Troubleshooting
+
+If you encounter issues while using the gem, consider the following:
+
+- Ensure all paths in your `config.json` are correct and accessible.
+- Check if all necessary dependencies are installed.
+- Validate the format of your `config.json`.
+
+## Contributions and Feedback
+
+Contributions to the `HtmlScssClassChecker` gem are welcome! If you have suggestions for improvement or encounter any issues, please feel free to open an issue or submit a pull request on the repository.
+
+---
+
+For further details, refer to the [README.md](/README.md) and the [API Documentation](/docs/api.md) (if available).
+
+This guide assumes a basic understanding of Ruby and gem management. For more information on these topics, visit the [official Ruby documentation](https://www.ruby-lang.org/en/documentation/).

data/html_scss_class_checker.gemspec

@@ -1,27 +1,31 @@
-Gem::Specification.new do |spec|
-  spec.name          = "html_scss_class_checker"
-  spec.version       = "0.1.0"
-  spec.authors       = ["Thaddeus Thomas"]
-  spec.email         = ["support@vcwtech.com"]
-
-  spec.summary       = %q{A Ruby gem for identifying unused or unmatched HTML and SCSS classes.}
-  spec.description   = %q{HtmlScssClassChecker is designed to streamline the process of frontend development by scanning HTML and SCSS files and identifying classes that are either undefined or unused. This gem aims to facilitate cleaner, more maintainable, and efficient codebases by providing developers with the tools to easily audit and synchronize their HTML and SCSS class definitions. Its an essential tool for web developers looking to optimize their front-end code and ensure consistency across their stylesheets and markup.}
-  spec.homepage      = "http://example.com/gems/html_scss_class_checker"
-  spec.license       = "MIT"
-
-  # Specify which files should be included in the gem
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Add runtime dependency
-  spec.add_runtime_dependency "json"
-
-  # Add development dependencies
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  # Add other development dependencies here
-end
+Gem::Specification.new do |spec|
+  spec.name          = "html_scss_class_checker"
+  spec.version       = "0.2.0"
+  spec.authors       = ["Thaddeus Thomas"]
+  spec.email         = ["thaddeus@vcwtech.com"]
+
+  spec.summary       = %q{A Ruby gem for identifying unused or unmatched HTML and SCSS classes.}
+  spec.description   = %q{HtmlScssClassChecker is designed to streamline the process of frontend development by scanning HTML and SCSS files and identifying classes that are either undefined or unused. This gem aims to facilitate cleaner, more maintainable, and efficient codebases by providing developers with the tools to easily audit and synchronize their HTML and SCSS class definitions. Its an essential tool for web developers looking to optimize their front-end code and ensure consistency across their stylesheets and markup.}
+  spec.homepage      = "https://github.com/Visionary-Code-Works/HtmlScssClassChecker"
+  spec.license       = "MIT"
+
+  # Specify which files should be included in the gem
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Add runtime dependency
+  spec.add_runtime_dependency "json"
+
+  # Add development dependencies
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "yard"
+  # Add other development dependencies here
+end