Upload finished Gem V1.0

This commit is contained in:
VetheonGames 2023-08-24 06:26:44 -06:00
parent 1478454227
commit 57a90e341c
20 changed files with 446 additions and 53 deletions

59
.gitignore vendored
View File

@ -1,58 +1,11 @@
# ---> Ruby
*.gem
*.rbc
/.config
/.bundle/
/.yardoc
/_yardoc/
/coverage/
/InstalledFiles
/doc/
/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?--*
# rspec failure tracking
.rspec_status

3
.rspec Normal file
View File

@ -0,0 +1,3 @@
--format documentation
--color
--require spec_helper

13
.rubocop.yml Normal file
View File

@ -0,0 +1,13 @@
AllCops:
TargetRubyVersion: 2.6
Style/StringLiterals:
Enabled: true
EnforcedStyle: double_quotes
Style/StringLiteralsInInterpolation:
Enabled: true
EnforcedStyle: double_quotes
Layout/LineLength:
Max: 120

5
CHANGELOG.md Normal file
View File

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

84
CODE_OF_CONDUCT.md Normal file
View File

@ -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.

12
Gemfile Normal file
View File

@ -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"

21
LICENSE.txt Normal file
View File

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2023 VetheonGames
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.

32
Miniparse.gemspec Normal file
View File

@ -0,0 +1,32 @@
# frozen_string_literal: true
require_relative 'lib/Miniparse/version'
Gem::Specification.new do |spec|
spec.name = 'Miniparse'
spec.version = Miniparse::VERSION
spec.authors = ['VetheonGames']
spec.email = ['ceo@pixelatedstudios.net']
spec.summary = 'A Gem for Validating and Minifying HTML, CSS, and JS smartly'
spec.description = 'Miniparse 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 both
a file (path) and a text return accessible through a variable'
spec.homepage = 'https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Miniparse'
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/Miniparse'
spec.metadata['changelog_uri'] = 'https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Miniparse/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', 'Miniparse.gemspec')
end
spec.files << 'LICENSE.txt'
spec.files << 'README.md'
spec.files << 'Miniparse.gemspec'
spec.require_paths = ['lib']
end

View File

@ -1,2 +1,39 @@
# Miniparse
TODO: Delete this and the text below, and describe your gem
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/Miniparse`. To experiment with that code, run `bin/console` for an interactive prompt.
## Installation
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
Install the gem and add to the application's Gemfile by executing:
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
## Usage
TODO: Write usage instructions here
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/Miniparse. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/Miniparse/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Miniparse project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/Miniparse/blob/master/CODE_OF_CONDUCT.md).

12
Rakefile Normal file
View File

@ -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]

11
bin/console Executable file
View File

@ -0,0 +1,11 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
require "bundler/setup"
require "Miniparse"
# 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__)

8
bin/setup Executable file
View File

@ -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

38
lib/Miniparse.rb Normal file
View File

@ -0,0 +1,38 @@
# frozen_string_literal: true
require_relative 'Miniparse/version'
require_relative 'lang_detect'
require_relative 'lang_minify'
require_relative 'lang_validate'
module Miniparse
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

5
lib/Miniparse/version.rb Normal file
View File

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

13
lib/lang_detect.rb Normal file
View File

@ -0,0 +1,13 @@
# frozen_string_literal: true
module Miniparse
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

38
lib/lang_minify.rb Normal file
View File

@ -0,0 +1,38 @@
# frozen_string_literal: true
module Miniparse
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

78
lib/lang_validate.rb Normal file
View File

@ -0,0 +1,78 @@
# frozen_string_literal: true
require 'English'
module Miniparse
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

4
sig/Miniparse.rbs Normal file
View File

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

11
spec/Miniparse_spec.rb Normal file
View File

@ -0,0 +1,11 @@
# frozen_string_literal: true
RSpec.describe Miniparse do
it "has a version number" do
expect(Miniparse::VERSION).not_to be nil
end
it "does something useful" do
expect(false).to eq(true)
end
end

15
spec/spec_helper.rb Normal file
View File

@ -0,0 +1,15 @@
# frozen_string_literal: true
require "Miniparse"
RSpec.configure do |config|
# Enable flags like --only-failures and --next-failure
config.example_status_persistence_file_path = ".rspec_status"
# Disable RSpec exposing methods globally on `Module` and `main`
config.disable_monkey_patching!
config.expect_with :rspec do |c|
c.syntax = :expect
end
end