vbsmin 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f20bc497c7112197f64f96e3c8c3da2011532550cc2b7394bda862f9f1202390
+  data.tar.gz: 6d15264fe085ef8ab8312aa50052a137b2b756a559064ee7defae8a32c51956d
+SHA512:
+  metadata.gz: 04d51468991b87872b94e50a7941cd9836a4dda21f5354460359fed834362996a8be448e53db896951f7ac99008765b4ea622eadb5368916eba98c34e5fde863
+  data.tar.gz: 79666d44546ff04c6f6b8064d2cb779a61a4b044043d9b4396c96f49b70c7324a479f6f9e8eef55554cc7b1dcd199be1cb46b3a6126e3e78df4337f0dfc4dbea

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Alexandre ZANNI
+
+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/bin/vbsmin

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Ruby internal
+require 'pp'
+# Project internal
+require 'vbsmin'
+# External
+require 'docopt'
+require 'paint'
+
+doc = <<~DOCOPT
+  vbsmin - VBScript minifier
+
+  Usage:
+    vbsmin [options] <filepath>
+    vbsmin -h | --help
+    vbsmin --version
+
+  Options:
+    --no-color      Disable colorized output
+    --debug         Display arguments
+    -h, --help      Show this screen
+    --version       Show version
+
+  Examples:
+    vbsmin samples/pyenv.vbs
+    vbsmin --no-color samples/pyenv.vbs
+DOCOPT
+
+begin
+  args = Docopt.docopt(doc, version: VBSMin::VERSION)
+  Paint.mode = 0 if args['--no-color']
+  pp args if args['--debug']
+  # use case 1, using the tool
+  if args['<filepath>']
+    vm = VBSMin.new
+    vm.minify(args['<filepath>'])
+    print Paint['Original file size: ', :bold]
+    puts Paint["#{vm.input_size} bytes", :red]
+    print Paint['Minified file size: ', :bold]
+    puts Paint["#{vm.output_size} bytes", :green]
+    print Paint['Size saved: ', :bold]
+    puts Paint["#{vm.diff_size} bytes", :green, :inverse]
+    puts "\nOriginal file path: #{vm.original_filepath}"
+    puts "Minified file path: #{vm.min_filepath}"
+  end
+  # use case 2, help: already handled by docopt
+  # use case 3, version: already handled by docopt
+rescue Docopt::Exit => e
+  puts e.message
+end

data/lib/vbsmin.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+# Ruby internal
+require 'fileutils'
+# Project internal
+require 'vbsmin/version'
+
+# Global VBSmin class
+class VBSMin
+  # Constants
+  include Version
+
+  # @return [Integer] Size (in bytes) of the original file
+  attr_reader :input_size
+
+  # @return [Integer] Size (in bytes) of the minified file
+  attr_reader :output_size
+
+  # @return [Integer] Saved size (in bytes)
+  attr_reader :diff_size
+
+  # @return [String] Path of the original file
+  attr_reader :original_filepath
+
+  # @return [String] Path of the minified file
+  attr_reader :min_filepath
+
+  # Instantiate a VBSmin object
+  def initialize
+    @input_size = nil
+    @output_size = nil
+    @diff_size = nil
+    @original_filepath = nil
+    @min_filepath = nil
+  end
+
+  # Minify a VBScript file (make a minified copy: file.min.vbs)
+  # @param filepath [String] Path to the VBS file to minify
+  # @return [String] Path of the minified file
+  def minify(filepath)
+    @original_filepath = filepath
+    # Count number of line of input
+    input_lines = IO.readlines(filepath).length
+    # File streaming
+    File.open(min_ext, 'w') do |output|
+      File.foreach(filepath).with_index(1) do |line, i|
+        eol = ':' # End of file char
+        # Remove inline comment (must be before whitespace striping)
+        line = inline_comment(line)
+        # Remove leading and trailing whitespaces: null, horizontal tab, line feed,
+        # vertical tab, form feed, carriage return, space
+        line.strip!
+        # Remove comments except inline ones (must be after whitespace striping)
+        line = '' if line[0] == "'" || line[0..2].upcase == 'REM'
+        # Remove space when several spaces between two keywords
+        line = internal_space(line)
+        # Remove line splitting
+        line[-1] = '' && eol = '' if line[-2..] == ' _'
+        # Write processed line unless it is a blank line or the last line
+        unless line.empty?
+          output.write(line)
+          output.write(eol) unless i == input_lines
+        end
+      end
+    end
+    calc_size
+    return @min_filepath
+  end
+
+  private
+
+  # Create the path of the minified file from the path of the original file
+  def min_ext
+    extension = File.extname(@original_filepath).downcase
+    abort 'Not a .vbs file' unless extension == '.vbs'
+    min_filepath = @original_filepath.chomp(extension) + '.min.vbs'
+    @min_filepath = min_filepath
+    return min_filepath
+  end
+
+  # Calculate the size of the files and the saved size
+  def calc_size
+    @input_size = File.size(@original_filepath)
+    @output_size = File.size(@min_filepath)
+    @diff_size = @input_size - @output_size
+  end
+
+  # DO NOT USE, use internal_space instead()
+  def internal_space_old(line)
+    arr = []
+    single_quote = line.count('"')
+    # This method won't work when there is two consecutive double quote
+    # so we must replace them else they will get removed.
+    line.gsub!('""', '☠')
+    line.split('"').each_with_index do |item, i|
+      # if odd number of double quote we are in a string else we are out
+      # process only if out of a string
+      item.gsub!(/ +/, ' ') if i.even?
+      arr.push(item)
+    end
+    output = arr.join('"')
+    output.gsub!('☠', '""')
+    output += '"' unless single_quote == output.count('"')
+    return output
+  end
+
+  # Remove extra spaces (several spaces between two keywords except in a string)
+  # More reliable than internal_space_old which use string replacement and string
+  # split
+  def internal_space(line)
+    # For each single quote, if there is an odd number of double quote before
+    # we are in a string, but if there is an even number of double quote before
+    # we are out of a string.
+    double_quote = 0
+    previous_char = nil
+    output = ''
+    i = 0
+    line.each_char do |c|
+      double_quote += 1 if c == '"'
+      output += c unless previous_char == ' ' && c == ' ' && double_quote.even?
+      i += 1
+      previous_char = c
+    end
+    return output
+  end
+
+  # Remove inline comments
+  # In VBS there is no single quote strings so it's safe to remove until the end
+  # of string when ecountering a single quote.
+  # The only case to handle if is a single quote appears in a double quote string.
+  def inline_comment(line)
+    # For each single quote, if there is an odd number of double quote before
+    # we are in a string, but if there is an even number of double quote before
+    # we are out of a string so this is an inline comment and we can remove all
+    # that comes after.
+    double_quote = 0
+    i = 0
+    line.each_char do |c|
+      double_quote += 1 if c == '"'
+      if c == "'" && double_quote.even?
+        line = line[...i]
+        break
+      end
+      i += 1
+    end
+    return line
+  end
+end

data/lib/vbsmin/version.rb

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

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: vbsmin
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alexandre ZANNI
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: commonmarker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: VBScript minifier CLI tool and library
+email: alexandre.zanni@engineer.com
+executables:
+- vbsmin
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- bin/vbsmin
+- lib/vbsmin.rb
+- lib/vbsmin/version.rb
+homepage: https://noraj.github.io/vbsmin/
+licenses:
+- MIT
+metadata:
+  yard.run: yard
+  bug_tracker_uri: https://github.com/noraj/vbsmin/issues
+  changelog_uri: https://github.com/noraj/vbsmin/blob/master/docs/CHANGELOG.md
+  documentation_uri: https://noraj.github.io/vbsmin/
+  homepage_uri: https://noraj.github.io/vbsmin/
+  source_code_uri: https://github.com/noraj/vbsmin/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: VBScript minifier
+test_files: []