html2slim2 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6ff64c9a5fd086b72c5db5c43df4416f4408052a1bf5e35f920bf1a26df46c5
+  data.tar.gz: 92df93ab18679e51386f70c9045fd168b5507094a070e5a5e219dfbb60795dbe
+SHA512:
+  metadata.gz: 2f56c1abc267eb88573528a0546bf34265da07578923854fc1f82ecbe92a4af262ae6a88059d8d1680d1fda5a3fa19d96245a15a9e5082958679e88d04c373c7
+  data.tar.gz: bd67aa82f0336fa656c93ac391db4c1b6529ed1b5e288c5295c8601c9ef3a501a10f51b4f5a93b7f9608a03a17566fe100b0468712b7b38b1a212bb2df23738b

data/README.md

@@ -0,0 +1,53 @@
+# HTML2Slim2
+
+![Version](https://img.shields.io/gem/v/html2slim2.svg)
+
+<!--
+[![Build Status](https://travis-ci.org/slim-template/html2slim.png?branch=master)](https://travis-ci.org/slim-template/html2slim)
+
+[![Code climate](https://codeclimate.com/github/slim-template/html2slim.png)](https://codeclimate.com/github/slim-template/html2slim)
+-->
+
+Script for converting HTML and ERB files to [slim](http://slim-lang.com/).
+
+## Usage
+
+You may convert files using the included executables `html2slim` and `erb2slim`.
+
+    # html2slim -h
+
+    Usage: html2slim INPUT_FILENAME_OR_DIRECTORY [OUTPUT_FILENAME_OR_DIRECTORY] [options]
+            --trace                      Show a full traceback on error
+        -d, --delete                     Delete HTML files
+        -h, --help                       Show this message
+        -v, --version                    Print version
+
+    # erb2slim -h
+
+    Usage: erb2slim INPUT_FILENAME_OR_DIRECTORY [OUTPUT_FILENAME_OR_DIRECTORY] [options]
+            --trace                      Show a full traceback on error
+        -d, --delete                     Delete ERB files
+        -h, --help                       Show this message
+        -v, --version                    Print version
+
+Alternatively, to convert files or strings on the fly in your application, you may do so by calling `HTML2Slim.convert!(file, format)` where format is either `:html` or `:erb`.
+
+## License
+
+This project is released under the MIT license.
+
+## Author
+
+[Maiz Lulkin](https://github.com/joaomilho) and [contributors](https://github.com/sanadan/html2slim/graphs/contributors)
+
+## Maintained repo
+
+[https://github.com/sanadan/html2slim](https://github.com/sanadan/html2slim)
+
+## OFFICIAL REPO
+
+[https://github.com/slim-template/html2slim](https://github.com/slim-template/html2slim)
+
+## GOOD TO KNOW
+
+ERB requires a full Ruby parser, so it doesn't really work for all use cases, but it's certainly helpful.

data/bin/erb2slim

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'html2slim/command'
+
+cmd = HTML2Slim::ERBCommand.new(ARGV)
+cmd.run

data/bin/html2slim

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'html2slim/command'
+
+cmd = HTML2Slim::HTMLCommand.new(ARGV)
+cmd.run

data/lib/html2slim/command.rb

@@ -0,0 +1,108 @@
+require 'optparse'
+require 'html2slim'
+
+module HTML2Slim
+  class Command
+
+    def initialize(args)
+      @args    = args
+      @options = {}
+    end
+
+    def run
+      @opts = OptionParser.new(&method(:set_opts))
+      @opts.parse!(@args)
+      process!
+      exit 0
+    rescue Exception => ex
+      raise ex if @options[:trace] || SystemExit === ex
+      $stderr.print "#{ex.class}: " if ex.class != RuntimeError
+      $stderr.puts ex.message
+      $stderr.puts '  Use --trace for backtrace.'
+      exit 1
+    end
+
+    protected
+
+    def format
+      @format ||= (self.class.to_s =~ /ERB/ ? :erb : :html)
+    end
+
+    def command_name
+      @command_name ||= format == :html ? "html2slim" : "erb2slim"
+    end
+
+    def set_opts(opts)
+      opts.banner = "Usage: #{command_name} INPUT_FILENAME_OR_DIRECTORY [OUTPUT_FILENAME_OR_DIRECTORY] [options]"
+
+      opts.on('--trace', :NONE, 'Show a full traceback on error') do
+        @options[:trace] = true
+      end
+
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+
+      opts.on_tail('-v', '--version', 'Print version') do
+        puts "#{command_name} #{HTML2Slim::VERSION}"
+        exit
+      end
+
+      opts.on('-d', '--delete', "Delete #{format.upcase} files") do
+        @options[:delete] = true
+      end
+    end
+
+    def process!
+      args = @args.dup
+
+      @options[:input]  = file        = args.shift
+      @options[:output] = destination = args.shift
+
+      @options[:input] = file = "-" unless file
+
+      if File.directory?(@options[:input])
+        Dir["#{@options[:input]}/**/*.#{format}"].each { |file| _process(file, destination) }
+      else
+        _process(file, destination)
+      end
+    end
+
+    private
+
+    def input_is_dir?
+      File.directory? @options[:input]
+    end
+
+    def _process(file, destination = nil)
+      require 'fileutils'
+      slim_file = file.sub(/\.#{format}/, '.slim')
+
+      if input_is_dir? && destination
+        FileUtils.mkdir_p(File.dirname(slim_file).sub(@options[:input].chomp('/'), destination))
+        slim_file.sub!(@options[:input].chomp('/'), destination)
+      else
+        slim_file = destination || slim_file
+      end
+      
+      fail(ArgumentError, "Source and destination files can't be the same.") if @options[:input] != '-' && file == slim_file
+
+      in_file = if @options[:input] == "-"
+        $stdin
+      else
+        File.open(file, 'r')
+      end
+
+      @options[:output] = slim_file && slim_file != '-' ? File.open(slim_file, 'w') : $stdout
+      @options[:output].puts HTML2Slim.convert!(in_file, format)
+      @options[:output].close
+
+      File.delete(file) if @options[:delete]
+    end
+  end
+  class HTMLCommand < Command
+  end
+  class ERBCommand < Command
+  end
+end

data/lib/html2slim/converter.rb

@@ -0,0 +1,53 @@
+require_relative 'nokogiri_monkeypatches'
+
+module HTML2Slim
+  class Converter
+    def initialize(html)
+      nokogiri = html[..1] == '<!' ? Nokogiri.parse(html) : Nokogiri::HTML.fragment(html)
+      @slim = nokogiri.to_slim
+    end
+
+    def to_s
+      @slim
+    end
+  end
+
+  class HTMLConverter < Converter
+    def initialize(file)
+      html = file.read
+      super(html)
+    end
+  end
+
+  class ERBConverter < Converter
+    def initialize(file)
+      erb = file.read
+
+      erb.gsub!(/<%(.+?)\s*\{\s*(\|.+?\|)?\s*%>/) { %(<%#{$1} do #{$2}%>) }
+      # case, if, for, unless, until, while, and blocks...
+      erb.gsub!(/<%(-\s+)?((\s*(case|if|for|unless|until|while) .+?)|.+?do\s*(\|.+?\|)?\s*)-?%>/) do
+        %(<ruby code="#{escape($2)}">)
+      end
+      # else
+      erb.gsub!(/<%-?\s*else\s*-?%>/, %(</ruby><ruby code="else">))
+      # elsif
+      erb.gsub!(/<%-?\s*(elsif .+?)\s*-?%>/) { %(</ruby><ruby code="#{escape($1)}">) }
+      # when
+      erb.gsub!(/<%-?\s*(when .+?)\s*-?%>/) { %(</ruby><ruby code="#{escape($1)}">) }
+      erb.gsub!(/<%\s*(end|}|end\s+-)\s*%>/, %(</ruby>))
+      erb.gsub!(/<%-?\n?(.+?)\s*-?%>/m) { %(<ruby code="#{escape($1)}"></ruby>) }
+
+      super(erb)
+    end
+
+    private
+
+    def escape(str)
+      str.gsub!('&', '&amp;')
+      str.gsub!('"', '&quot;')
+      str.gsub!("\n", '\n')
+      str.gsub!('<', '&lt;')
+      str
+    end
+  end
+end

data/lib/html2slim/nokogiri_monkeypatches.rb

@@ -0,0 +1,138 @@
+require 'nokogiri'
+
+class Nokogiri::XML::Text
+  def to_slim(lvl = 0)
+    str = escape(content)
+    return nil if str.strip.empty?
+
+    ('  ' * lvl) + %(| #{str.gsub(/\s+/, ' ')})
+  end
+
+  private
+
+  def escape(str)
+    str.gsub!('&', '&')
+    str.gsub!('©', '©')
+    str.gsub!("\u00A0", ' ')
+    str.gsub!('»', '»')
+    str.gsub!('<', '&lt;')
+    str.gsub!('>', '&gt;')
+    str
+  end
+end
+
+class Nokogiri::XML::DTD
+  def to_slim(_lvl = 0)
+    if to_xml.include?('xml')
+      to_xml.include?('iso-8859-1') ? 'doctype xml ISO-88591' : 'doctype xml'
+    elsif to_xml.include?('XHTML') || to_xml.include?('HTML 4.01')
+      available_versions = Regexp.union ['Basic', '1.1', 'strict', 'Frameset', 'Mobile', 'Transitional']
+      version = to_xml.match(available_versions).to_s.downcase
+      "doctype #{version}"
+    else
+      'doctype html'
+    end
+  end
+end
+
+class Nokogiri::XML::Element
+  BLANK_RE = /\A[[:space:]]*\z/.freeze
+
+  def slim(lvl = 0)
+    r = '  ' * lvl
+
+    return r + slim_ruby_code(r) if ruby?
+
+    r += name unless skip_tag_name?
+    r += slim_id
+    r += slim_class
+    r += slim_attributes
+    r
+  end
+
+  def to_slim(lvl = 0)
+    if children.count.positive?
+      %(#{slim(lvl)}\n#{children.filter_map { |c| c.to_slim(lvl + 1) }.join("\n")})
+    else
+      slim(lvl)
+    end
+  end
+
+  private
+
+  def slim_ruby_code(r)
+    (code.strip[0] == '=' ? '' : '- ') + code.strip.gsub('\\n', "\n#{r}- ")
+  end
+
+  def code
+    attributes['code'].to_s
+  end
+
+  def skip_tag_name?
+    div? && (has_id? || has_class?)
+  end
+
+  def slim_id
+    has_id? ? "##{self['id']}" : ''
+  end
+
+  def slim_class
+    has_class? ? ".#{self['class'].to_s.strip.split(/\s+/).join('.')}" : ''
+  end
+
+  def slim_attributes
+    remove_attribute('class')
+    remove_attribute('id')
+    has_attributes? ? "[#{attributes_as_html.to_s.strip}]" : ''
+  end
+
+  def has_attributes? # rubocop:disable Naming/PredicateName
+    attributes.to_hash.any?
+  end
+
+  def has_id? # rubocop:disable Naming/PredicateName
+    has_attribute?('id') && !(BLANK_RE === self['id'])
+  end
+
+  def has_class? # rubocop:disable Naming/PredicateName
+    has_attribute?('class') && !(BLANK_RE === self['class'])
+  end
+
+  def ruby?
+    name == 'ruby'
+  end
+
+  def div?
+    name == 'div'
+  end
+
+  def html_quote(str)
+    "\"#{str.gsub('"', '\\"')}\""
+  end
+
+  def attributes_as_html
+    attributes.map do |aname, aval|
+      " #{aname}" + (aval ? "=#{html_quote aval.to_s}" : '')
+    end.join
+  end
+end
+
+class Nokogiri::XML::DocumentFragment
+  def to_slim
+    if children.count.positive?
+      children.filter_map(&:to_slim).join("\n")
+    else
+      ''
+    end
+  end
+end
+
+class Nokogiri::XML::Document
+  def to_slim
+    if children.count.positive?
+      children.filter_map(&:to_slim).join("\n")
+    else
+      ''
+    end
+  end
+end

data/lib/html2slim/version.rb

@@ -0,0 +1,3 @@
+module HTML2Slim
+  VERSION = '0.3.0'
+end

data/lib/html2slim.rb

@@ -0,0 +1,12 @@
+require_relative 'html2slim/version'
+require_relative 'html2slim/converter'
+
+module HTML2Slim
+  def self.convert!(input, format=:html)
+    if format.to_s == "html"
+      HTMLConverter.new(input)
+    else
+      ERBConverter.new(input)
+    end
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: html2slim2
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- sanadan
+- Maiz Lulkin
+bindir: bin
+cert_chain: []
+date: 2025-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails-omakase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Convert HTML to Slim templates. Because HTML sux and Slim rules. That's
+  why.
+email:
+- jecy00@gmail.com
+- maiz@lulk.in
+executables:
+- erb2slim
+- html2slim
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- bin/erb2slim
+- bin/html2slim
+- lib/html2slim.rb
+- lib/html2slim/command.rb
+- lib/html2slim/converter.rb
+- lib/html2slim/nokogiri_monkeypatches.rb
+- lib/html2slim/version.rb
+homepage: https://github.com/sanadan/html2slim
+licenses: []
+metadata: {}
+rdoc_options:
+- "--charset=UTF-8"
+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.6.7
+specification_version: 4
+summary: HTML to Slim converter.
+test_files: []