Miniparser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0f1628ed2308d38a4f6770e20fefafed643600019cfc6d120d791dafbd1e9b2
+  data.tar.gz: 615e5495cab6b7b543fbeaeb1f43481461fedbcbda2d5017e15f905d2a9ad737
+SHA512:
+  metadata.gz: 4111f751778605a9dfcc54f4176c5561ce20564743e35117e8746675c9cb9547ffea9dea5acff78ded5266014f7bad86e1acb5c99c286794435ba0a11350e718
+  data.tar.gz: 5e4a8fd2377205e39cfcab82ecbbf5fafb44b9d4d55b77596ced731f5b902e15103b6fc116174c75a9022e41f4e3fc780fc01dccf9d90802595b4073cd357bd5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-23
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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 ceo@pixelatedstudios.net. 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.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in Miniparse.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 PixelRidge-Softworks
+
+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/Miniparser.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/Miniparser/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'Miniparser'
+  spec.version = Miniparser::VERSION
+  spec.authors = ['VetheonGames']
+  spec.email = ['ceo@pixelatedstudios.net']
+
+  spec.summary = 'A Gem for Validating and Minifying HTML, CSS, and JS smartly'
+  spec.description = 'Miniparser works pretty simply. You pass the Gem some input (HTML, JS, or CSS), and it will
+                      validate it, return the validated status, then minify it, and return the minified version as either
+                      a file (path) and a text return, respective to what input it got'
+  spec.homepage = 'https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Miniparser'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.2.2'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Miniparser'
+  spec.metadata['changelog_uri'] = 'https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Miniparser/src/branch/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.glob('{bin,lib,sig}/**/*') + Dir.glob('*').reject do |f|
+                                                  f.start_with?('spec', '.rspec', 'Miniparser.gemspec')
+                                                end
+  spec.files << 'LICENSE'
+  spec.files << 'README.md'
+  spec.files << 'Miniparser.gemspec'
+
+  spec.require_paths = ['lib']
+end

data/README.md

@@ -0,0 +1,61 @@
+# Miniparse
+
+Miniparse is a Ruby gem that takes code as input (HTML, JavaScript, or CSS), determines the code language, validates it, and then minifies it. It returns whether the code is valid or not, and if valid, provides the minified code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Miniparse'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install Miniparse
+```
+
+## Usage
+
+Miniparse provides two main methods to process either a file or a string containing HTML, JavaScript, or CSS code.
+
+### Processing a File
+
+You can process a file by calling the `type_file` method and passing the file path as an argument:
+
+```ruby
+result = Miniparse::Processor.type_file('path/to/yourfile.html')
+```
+
+### Processing a String
+
+You can process a string containing code by calling the `type_string` method:
+
+```ruby
+result = Miniparse::Processor.type_string('<html><head></head><body></body></html>')
+```
+
+Both methods return a hash containing the validation status, any errors, and the minified code if the input was valid:
+
+```ruby
+{
+  valid: true or false,
+  errors: "Error message if any",
+  minified_code: "Minified code if valid"
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome. Please adhere to the code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "Miniparser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/Miniparser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Miniparser
+  VERSION = "1.0.0"
+end

data/lib/Miniparser.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'Miniparser/version'
+require_relative 'lang_detect'
+require_relative 'lang_minify'
+require_relative 'lang_validate'
+
+module Miniparser
+  class Error < StandardError; end
+
+  class Processor
+    def self.type_file(file_path)
+      code = File.read(file_path)
+      result = process_code(code)
+      if result[:valid]
+        output_file_path = file_path.gsub(/(\.\w+)$/, '_minified\1')
+        File.write(output_file_path, result[:minified_code])
+        result[:minified_code] = output_file_path
+      end
+      result
+    end
+
+    def self.type_string(code_string)
+      process_code(code_string)
+    end
+
+    def self.process_code(code)
+      language_detector = LanguageDetector.new
+      language = language_detector.detect(code)
+      validator = Validator.new(language)
+      valid, errors = validator.validate(code)
+      minifier = Minifier.new(language)
+      minified_code = minifier.minify(code) if valid
+
+      { valid:, errors:, minified_code: }
+    end
+  end
+end

data/lib/lang_detect.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Miniparser
+  class LanguageDetector
+    def detect(code)
+      return :html if code.match?(/<\s*html.*>|<\s*head.*>|<\s*body.*>/i)
+      return :css if code.match?(/^\s*(\.\w+|#\w+|body)\s*\{/)
+      return :js if code.match?(/function\s+\w+\s*\(|var\s+\w+\s*=|let\s+\w+\s*=|const\s+\w+\s*=/)
+
+      :unknown
+    end
+  end
+end

data/lib/lang_minify.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Miniparser
+  class Minifier
+    def initialize(language)
+      @language = language
+    end
+
+    def minify(code)
+      case @language
+      when :html
+        minify_html(code)
+      when :js
+        minify_js(code)
+      when :css
+        minify_css(code)
+      else
+        raise "Unknown language: #{@language}"
+      end
+    end
+
+    private
+
+    def minify_html(code)
+      code.gsub(%r{>\s*</}, '> </').gsub(/>\s+</, '><').strip
+    end
+
+    def minify_js(code)
+      # Remove single-line and multi-line comments, and all unnecessary whitespace
+      code.gsub(%r{//.*$}, '').gsub(%r{/\*.*?\*/}m, '').gsub(/\s+/, ' ').strip
+    end
+
+    def minify_css(code)
+      # Remove comments and all unnecessary whitespace, including newlines
+      code.gsub(%r{/\*.*?\*/}m, '').gsub(/\s+/, '').strip
+    end
+  end
+end

data/lib/lang_validate.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'English'
+module Miniparser
+  class Validator
+    def initialize(language)
+      @language = language
+    end
+
+    def validate(code)
+      case @language
+      when :html
+        validate_html(code)
+      when :css
+        validate_css(code)
+      when :js
+        validate_js(code)
+      else
+        raise "Unknown language: #{@language}"
+      end
+    end
+
+    private
+
+    def validate_html(code)
+      # List of self-closing singleton tags in HTML5
+      singleton_tags = %w[area base br col embed hr img input link meta param source track wbr]
+
+      # Stack to keep track of opening tags
+      stack = []
+
+      # Iterate through all the tags in the code
+      code.scan(%r{</?\w+[^>]*>}) do |tag|
+        tag_name = tag.match(%r{</?(\w+)})[1]
+
+        # Ignore singleton tags and declarations like <!DOCTYPE html>
+        next if singleton_tags.include?(tag_name) || tag.start_with?('<!')
+
+        if tag.start_with?('</') # Closing tag
+          # Check if the closing tag matches the last opening tag
+          if stack.last == tag_name
+            stack.pop
+          else
+            return [false, "Mismatched HTML tags: expected </#{stack.last}> but found #{tag}"]
+          end
+        else # Opening tag
+          stack.push(tag_name)
+        end
+      end
+
+      # Check if there are any unmatched opening tags
+      if stack.empty?
+        [true, nil]
+      else
+        [false, "Mismatched HTML tags: unmatched <#{stack.last}>"]
+      end
+    end
+
+    def validate_css(code)
+      # Basic validation: check for balanced curly braces
+      valid = code.count('{') == code.count('}')
+      [valid, valid ? nil : 'Mismatched CSS curly braces']
+    end
+
+    require 'tempfile'
+    require 'shellwords'
+
+    def validate_js(code)
+      Tempfile.create(['temp', '.js']) do |temp_file|
+        temp_file.write(code)
+        temp_file.close
+        output = `node -c #{Shellwords.escape(temp_file.path)} 2>&1`
+        success = $CHILD_STATUS.success?
+        [success, success ? nil : output]
+      end
+    end
+  end
+end

data/sig/Miniparser.rbs

@@ -0,0 +1,4 @@
+module Miniparser
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: Miniparser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- VetheonGames
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-24 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  Miniparser works pretty simply. You pass the Gem some input (HTML, JS, or CSS), and it will
+                        validate it, return the validated status, then minify it, and return the minified version as either
+                        a file (path) and a text return, respective to what input it got
+email:
+- ceo@pixelatedstudios.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- Miniparser.gemspec
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/Miniparser.rb
+- lib/Miniparser/version.rb
+- lib/lang_detect.rb
+- lib/lang_minify.rb
+- lib/lang_validate.rb
+- sig/Miniparser.rbs
+homepage: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Miniparser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Miniparser
+  source_code_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Miniparser
+  changelog_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Miniparser/src/branch/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.0.dev
+signing_key:
+specification_version: 4
+summary: A Gem for Validating and Minifying HTML, CSS, and JS smartly
+test_files: []