html_scss_class_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c024f63fc53ed959e7317d0cda0cc20938a20ca90bd147d84263164e64c82d1
+  data.tar.gz: 32ed1e7d158c29ca7fe882e9ca406cb90cd01c7f915b57af4be1a725314b4aa8
+SHA512:
+  metadata.gz: 537969a92541a816ee3bf7af9c5c6ed47b0ce8832011d983d1cfea76bdccf55c276560ff33d3340222a7063560f4a29068e55b30009d7bb8fc04d0662d1b113d
+  data.tar.gz: be4b97c12a848e28dfc676ca7c76bba821ea3c15f867628c00092d30f8ebd93ddcb41253ed35fc3251fd684689af2ae83de2d5af27094aa68b736614f6933a86

data/.gitignore

@@ -0,0 +1,117 @@
+# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
+# Created by https://www.toptal.com/developers/gitignore/api/windows,visualstudiocode,powershell,ruby
+# Edit at https://www.toptal.com/developers/gitignore?templates=windows,visualstudiocode,powershell,ruby
+
+### PowerShell ###
+# Exclude packaged modules
+*.zip
+
+# Exclude .NET assemblies from source
+*.dll
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/windows,visualstudiocode,powershell,ruby
+
+# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
+

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing to HtmlScssClassChecker
+
+Thank you for your interest in contributing to `HtmlScssClassChecker`! This document provides guidelines for contributions to this project. By contributing to this project, you agree to abide by its terms.
+
+## Code of Conduct
+
+Our project adheres to a [Code of Conduct](/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [support@vcwtech.com](mailto:support@vcwtech.com).
+
+## How to Contribute
+
+1. **Report Bugs**: If you find a bug, please open an issue in the repository, using the bug report template. Include as much detail as possible, such as steps to reproduce the bug, expected behavior, and actual behavior.
+
+2. **Suggest Enhancements**: For ideas about new features or improvements, open an issue using the feature request template.
+
+3. **Submit Pull Requests**: Contributions to the codebase are made through pull requests. Before submitting a pull request, please read and follow the pull request guidelines below.
+
+## Pull Request Guidelines
+
+1. **Fork the Repository**: Start by forking the repository and cloning it to your local machine.
+
+2. **Create a New Branch**: Create a branch for your changes, using a name that reflects the purpose of your contribution, such as `feature/add-new-feature` or `bugfix/fix-some-bug`.
+
+3. **Make Your Changes**: Implement your changes, adhering to the coding standards and best practices of the project.
+
+4. **Write Tests**: Add or update tests to cover your changes. Ensure all tests pass.
+
+5. **Document Your Changes**: Update the README or other documentation as necessary to reflect your changes.
+
+6. **Commit Your Changes**: Make sure your commit messages are clear and follow best practices.
+
+7. **Push to Your Fork**: Push your changes to your forked repository.
+
+8. **Open a Pull Request**: Open a pull request against the main repository. Describe your changes and reference any relevant issues.
+
+9. **Code Review**: Once your pull request is open, it will be reviewed by maintainers. Engage in the code review process, addressing any feedback.
+
+## Development Setup
+
+For instructions on setting up a development environment, please refer to [DEVELOPMENT.md](/DEVELOPMENT.md).
+
+## Testing
+
+Before submitting pull requests, ensure that all tests are passing. For information on running and writing tests, see [TESTING.md](/TESTING.md).
+
+## Questions or Suggestions
+
+If you have questions or suggestions, feel free to open an issue or reach out to the maintainers at [support@vcwtech.com](mailto:support@vcwtech.com).
+
+---
+
+We look forward to your contributions and are excited to see what we can build together in this community!

data/Gemfile

@@ -0,0 +1,3 @@
+group :development, :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  specs:
+    diff-lcs (1.5.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+
+PLATFORMS
+  x64-mingw-ucrt
+
+DEPENDENCIES
+  rspec
+
+BUNDLED WITH
+   2.4.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Visionary Code Works
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# HtmlScssClassChecker
+
+HtmlScssClassChecker is a Ruby gem for extracting and comparing class names from HTML and SCSS files. It helps in identifying unmatched or unused classes, enhancing the maintainability of front-end codebases.
+
+## 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
+
+To use HtmlScssClassChecker, you need to set up a configuration JSON file (`config.json`) specifying known classes and directories to be checked:
+
+```json
+{
+  "known_classes": ["class1", "class2"],
+  "html_directories": ["_includes", "_layouts"],
+  "scss_directories": ["_sass"]
+}
+```
+
+Run the checker with:
+
+```ruby
+require 'html_scss_class_checker'
+
+checker = HtmlScssClassChecker::ClassChecker.new(config)
+checker.check
+
+puts "Unmatched Classes:"
+puts checker.unmatched_classes.to_a
+```
+
+More detailed usage instructions will be provided in the [Usage Documentation](/docs/usage.md).
+
+## Contributing
+
+Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change. Please ensure to update tests as appropriate.
+
+See [CONTRIBUTING.md](/CONTRIBUTING.md) for detailed guidelines.
+
+## Documentation
+
+For full documentation, visit [our documentation page](/docs).
+
+## License
+
+Distributed under the MIT License. See [LICENSE](/LICENSE) for more information.
+
+## Additional Resources
+
+[![Update Changelog](https://github.com/Visionary-Code-Works/HtmlScssClassChecker/actions/workflows/changelog-update.yml/badge.svg)](https://github.com/Visionary-Code-Works/HtmlScssClassChecker/actions/workflows/changelog-update.yml)
+
+- [Changelog](/CHANGELOG.md): Detailed list of changes in each version.
+- [Code of Conduct](/CODE_OF_CONDUCT.md): Guidelines for participation in the community.
+- [Development Guide](/docs/development.md): Instructions for setting up a development environment and working on the gem.
+- [Testing Guide](/docs/testing.md): Information on how to run and write tests for the gem.
+- [Usage Documentation](`/docs/usage.md`): Provide detailed instructions on how to use the gem, including various configurations and options.
+- [Contributing Guidelines](`/CONTRIBUTING.md`):** Outline how others can contribute to your project. Include information on coding standards, pull request processes, and issue reporting guidelines.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+# Define a task for running tests (if you're using RSpec)
+Rake::TestTask.new(:spec) do |t|
+  t.libs.push "spec"
+  t.ruby_opts = ["-W0"]  # Suppresses Ruby warnings
+  t.pattern = "spec/**/*_spec.rb"  # Location of spec files
+end
+
+# Set the default task to run tests
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'irb'
+require 'html_scss_class_checker'  # Require your gem
+
+# Start an IRB session with your gem loaded
+IRB.start

data/bin/setup

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'json'
+
+# Example setup tasks
+puts "Setting up the HtmlScssClassChecker gem..."
+
+# Create a default configuration file if it doesn't exist
+config_path = File.join(Dir.pwd, 'config.json')
+unless File.exist?(config_path)
+  default_config = {
+    'known_classes' => [],
+    'html_directories' => ['_includes', '_layouts'],
+    'scss_directories' => ['_sass']
+  }
+
+  File.write(config_path, JSON.pretty_generate(default_config))
+  puts "Created default config.json file."
+end
+
+puts "Setup complete."

data/docs/development.md

@@ -0,0 +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`!

data/docs/testing.md

@@ -0,0 +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.

data/docs/usage.md

@@ -0,0 +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/).

data/html_scss_class_checker.gemspec

@@ -0,0 +1,27 @@
+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

data/lib/html_scss_class_checker/class_checker.rb

@@ -0,0 +1,33 @@
+require 'json'
+require 'set'
+
+module HtmlScssClassChecker
+  class ClassChecker
+    attr_reader :unmatched_classes, :file_class_mapping
+
+    def initialize(config)
+      @known_classes = Set.new(config['known_classes'])
+      @html_directories = config['html_directories']
+      @scss_directories = config['scss_directories']
+      @unmatched_classes = Set.new
+      @file_class_mapping = {}
+    end
+
+    def check
+      process_directories(@html_directories, 'html')
+      process_directories(@scss_directories, 'scss')
+    end
+
+    private
+
+    def process_directories(directories, file_type)
+      directories.each do |directory|
+        Dir.glob("#{directory}/**/*.#{file_type}").each do |file|
+          classes = FileProcessor.new(file, file_type).list_classes
+          @unmatched_classes.merge(classes - @known_classes)
+          @file_class_mapping[file] = classes
+        end
+      end
+    end
+  end
+end

data/lib/html_scss_class_checker/class_extractor.rb

@@ -0,0 +1,14 @@
+require 'json'
+require 'set'
+
+module HtmlScssClassChecker
+  class ClassExtractor
+    def self.extract_from_html(content)
+      content.scan(/class="([^"]+)"/).flatten.map { |cls| cls.split }.flatten.to_set
+    end
+
+    def self.extract_from_scss(content)
+      content.scan(/\.[\w-]+/).flatten.map { |cls| cls.delete_prefix('.') }.to_set
+    end
+  end
+end

data/lib/html_scss_class_checker/file_processor.rb

@@ -0,0 +1,23 @@
+require 'json'
+require 'set'
+
+module HtmlScssClassChecker
+  class FileProcessor
+    def initialize(file_path, file_type)
+      @file_path = file_path
+      @file_type = file_type
+    end
+
+    def list_classes
+      content = File.read(@file_path)
+      case @file_type
+      when 'html'
+        ClassExtractor.extract_from_html(content)
+      when 'scss'
+        ClassExtractor.extract_from_scss(content)
+      else
+        Set.new
+      end
+    end
+  end
+end

data/lib/html_scss_class_checker.rb

@@ -0,0 +1,18 @@
+require 'html_scss_class_checker/class_extractor'
+require 'html_scss_class_checker/file_processor'
+require 'html_scss_class_checker/class_checker'
+
+# Read configuration from JSON file
+config_file = 'config.json'  # Update this path as needed
+config = JSON.parse(File.read(config_file))
+
+checker = HtmlScssClassChecker::ClassChecker.new(config)
+checker.check
+
+puts "Unmatched Classes:"
+puts checker.unmatched_classes.to_a
+
+puts "\nClasses in each file:"
+checker.file_class_mapping.each do |file, classes|
+  puts "#{file}: #{classes.to_a}"
+end

data/scripts/CreateGemStructure.ps1

@@ -0,0 +1,38 @@
+# Define directories and files to create
+$gemName = "html_scss_class_checker"
+$directories = @(
+    "$gemName/bin",
+    "$gemName/lib/$gemName",
+    "$gemName/spec"
+)
+
+$files = @(
+    "$gemName/bin/console",
+    "$gemName/bin/setup",
+    "$gemName/lib/$gemName/class_extractor.rb",
+    "$gemName/lib/$gemName/file_processor.rb",
+    "$gemName/lib/$gemName/class_checker.rb",
+    "$gemName/lib/$gemName.rb",
+    "$gemName/spec/class_extractor_spec.rb",
+    "$gemName/spec/file_processor_spec.rb",
+    "$gemName/spec/class_checker_spec.rb",
+    "$gemName/spec/spec_helper.rb",
+    "$gemName/$gemName.gemspec",
+    "$gemName/Gemfile",
+    "$gemName/Rakefile",
+    "$gemName/LICENSE.txt",
+    "$gemName/README.md",
+    "$gemName/.gitignore"
+)
+
+# Create directories
+foreach ($dir in $directories) {
+    New-Item -Path $dir -ItemType Directory -Force
+}
+
+# Create files
+foreach ($file in $files) {
+    New-Item -Path $file -ItemType File -Force
+}
+
+Write-Host "Gem structure for '$gemName' created successfully."

data/scripts/classes

@@ -0,0 +1 @@
+grep -ohr 'class="[^"]*"' ./ | sort | uniq

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: html_scss_class_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thaddeus Thomas
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: 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.
+email:
+- support@vcwtech.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docs/api.md
+- docs/development.md
+- docs/testing.md
+- docs/usage.md
+- html_scss_class_checker.gemspec
+- lib/html_scss_class_checker.rb
+- lib/html_scss_class_checker/class_checker.rb
+- lib/html_scss_class_checker/class_extractor.rb
+- lib/html_scss_class_checker/file_processor.rb
+- scripts/CreateGemStructure.ps1
+- scripts/classes
+homepage: http://example.com/gems/html_scss_class_checker
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A Ruby gem for identifying unused or unmatched HTML and SCSS classes.
+test_files: []