herb 0.1.0-x86_64-linux-gnu

data/lib/herb/ast.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Herb
+  module AST
+  end
+end

data/lib/herb/cli.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "lz_string"
+
+class Herb::CLI
+  attr_accessor :json, :silent
+
+  def initialize(args)
+    @args = args
+    @command = args[0]
+    @file = args[1]
+  end
+
+  def call
+    options
+
+    if silent
+      if result.failed?
+        puts "Failed"
+      else
+        puts "Success"
+      end
+    elsif json
+      puts result.value.to_json
+    else
+      puts result.value.inspect
+    end
+  end
+
+  def directory
+    unless @file
+      puts "No directory provided."
+      puts
+      puts "Usage:"
+      puts "  bundle exec herb #{@command} [directory] [options]"
+      puts
+      puts "Tip: Use `.` for the current directory"
+      puts "  bundle exec herb #{@command} . [options]"
+
+      exit(1)
+    end
+
+    unless File.exist?(@file)
+      puts "Not a directory: '#{@file}'."
+      puts
+    end
+
+    unless File.directory?(@file)
+      puts "Not a directory: '#{@file}'."
+      puts
+    end
+
+    @file
+  end
+
+  def file_content
+    if @file && File.exist?(@file)
+      File.read(@file)
+    elsif @file
+      puts "File doesn't exist: #{@file}"
+      exit(1)
+    else
+      puts "No file provided."
+      puts
+      puts "Usage:"
+      puts "  bundle exec herb #{@command} [file] [options]"
+      exit(1)
+    end
+  end
+
+  def help(exit_code = 0)
+    message = <<~HELP
+      ▗▖ ▗▖▗▄▄▄▖▗▄▄▖ ▗▄▄▖
+      ▐▌ ▐▌▐▌   ▐▌ ▐▌▐▌ ▐▌
+      ▐▛▀▜▌▐▛▀▀▘▐▛▀▚▖▐▛▀▚▖
+      ▐▌ ▐▌▐▙▄▄▖▐▌ ▐▌▐▙▄▞▘
+
+      Herb 🌿 Powerful and seamless HTML-aware ERB parsing.
+
+      Usage:
+        bundle exec herb [command] [options]
+
+      Commands:
+        bundle exec herb lex [file]         Lex a file.
+        bundle exec herb parse [file]       Parse a file.
+        bundle exec herb analyze [path]     Analyze a project by passing a directory to the root of the project
+        bundle exec herb ruby [file]        Extract Ruby from a file.
+        bundle exec herb html [file]        Extract HTML from a file.
+        bundle exec herb prism [file]       Extract Ruby from a file and parse the Ruby source with Prism.
+        bundle exec herb playground [file]  Open the content of the source file in the playground
+        bundle exec herb version            Prints the versions of the Herb gem and the libherb library.
+
+      Options:
+        #{option_parser.to_s.strip.gsub(/^    /, "  ")}
+
+    HELP
+
+    puts message
+
+    exit(exit_code)
+  end
+
+  def result
+    @result ||= case @command
+                when "analyze"
+                  Herb::Project.new(directory).parse!
+                  exit(0)
+                when "parse"
+                  Herb.parse(file_content)
+                when "lex"
+                  Herb.lex(file_content)
+                when "ruby"
+                  puts Herb.extract_ruby(file_content)
+                  exit(0)
+                when "html"
+                  puts Herb.extract_html(file_content)
+                  exit(0)
+                when "playground"
+                  if Dir.pwd.include?("/herb")
+                    system(%(npx concurrently "nx dev playground" "sleep 1 && open http://localhost:5173##{LZString::UriSafe.compress(file_content)}"))
+                    exit(0)
+                  else
+                    puts "This command can currently only be run within the herb repo itself"
+                    exit(1)
+                  end
+                when "help", "-h", "--help"
+                  help
+                when "version", "-v", "--version"
+                  puts Herb.version
+                  exit(0)
+                when String
+                  puts "Unknown command: '#{@command}'"
+                  puts
+
+                  help(1)
+                else
+                  help(1)
+                end
+  end
+
+  def option_parser
+    @option_parser ||= OptionParser.new do |parser|
+      parser.banner = ""
+
+      parser.on_tail("-h", "--help", "Show this message") do
+        help
+        exit(0)
+      end
+
+      parser.on("-j", "--json", "Return result in the JSON format") do
+        self.json = true
+      end
+
+      parser.on("-s", "--silent", "Log no result to stdout") do
+        self.silent = true
+      end
+    end
+  end
+
+  def options
+    option_parser.parse!(@args)
+  end
+end

data/lib/herb/errors.rb

@@ -0,0 +1,352 @@
+# frozen_string_literal: true
+
+# NOTE: This file is generated by the templates/template.rb script and should not be
+# modified manually. See /Users/marcoroth/Development/herb-release/templates/lib/herb/errors.rb.erb
+
+module Herb
+  module Errors
+    class Error
+      attr_reader :type
+      attr_reader :location
+      attr_reader :message
+
+      def initialize(type, location, message)
+        @type = type
+        @location = location
+        @message = message
+      end
+
+      def to_hash
+        {
+          type: type,
+          location: location&.to_hash,
+          message: message,
+        }
+      end
+
+      def error_name
+        self.class.name.split("::").last
+      end
+
+      def to_json(*args)
+        to_hash.to_json(*args)
+      end
+    end
+
+    class UnexpectedError < Error
+      attr_reader :description
+      attr_reader :expected
+      attr_reader :found
+
+      def initialize(type, location, message, description, expected, found)
+        super(type, location, message)
+
+        @description = description
+        @expected = expected
+        @found = found
+      end
+
+      def inspect
+        tree_inspect.rstrip.gsub(/\s+$/, "")
+      end
+
+      def to_hash
+        super.merge({
+          description: description,
+          expected: expected,
+          found: found,
+        })
+      end
+
+      def tree_inspect(indent = 0)
+        output = +""
+
+        output += %(@ #{error_name} #{location.tree_inspect}\n)
+        output += %(├── message: #{message.inspect}\n)
+        output += %(├── description: #{description.inspect}\n)
+        output += %(├── expected: #{expected.inspect}\n)
+        output += %(└── found: #{found.inspect}\n)
+        output += %(\n)
+
+        output.gsub(/^/, "    " * indent)
+      end
+    end
+
+    class UnexpectedTokenError < Error
+      attr_reader :expected_type
+      attr_reader :found
+
+      def initialize(type, location, message, expected_type, found)
+        super(type, location, message)
+
+        @expected_type = expected_type
+        @found = found
+      end
+
+      def inspect
+        tree_inspect.rstrip.gsub(/\s+$/, "")
+      end
+
+      def to_hash
+        super.merge({
+          expected_type: expected_type,
+          found: found,
+        })
+      end
+
+      def tree_inspect(indent = 0)
+        output = +""
+
+        output += %(@ #{error_name} #{location.tree_inspect}\n)
+        output += %(├── message: #{message.inspect}\n)
+        output += %(├── expected_type: #{expected_type.inspect}\n)
+        output += %(└── found: #{found ? found.tree_inspect : "∅"}\n)
+        output += %(\n)
+
+        output.gsub(/^/, "    " * indent)
+      end
+    end
+
+    class MissingOpeningTagError < Error
+      attr_reader :closing_tag
+
+      def initialize(type, location, message, closing_tag)
+        super(type, location, message)
+
+        @closing_tag = closing_tag
+      end
+
+      def inspect
+        tree_inspect.rstrip.gsub(/\s+$/, "")
+      end
+
+      def to_hash
+        super.merge({
+          closing_tag: closing_tag,
+        })
+      end
+
+      def tree_inspect(indent = 0)
+        output = +""
+
+        output += %(@ #{error_name} #{location.tree_inspect}\n)
+        output += %(├── message: #{message.inspect}\n)
+        output += %(└── closing_tag: #{closing_tag ? closing_tag.tree_inspect : "∅"}\n)
+        output += %(\n)
+
+        output.gsub(/^/, "    " * indent)
+      end
+    end
+
+    class MissingClosingTagError < Error
+      attr_reader :opening_tag
+
+      def initialize(type, location, message, opening_tag)
+        super(type, location, message)
+
+        @opening_tag = opening_tag
+      end
+
+      def inspect
+        tree_inspect.rstrip.gsub(/\s+$/, "")
+      end
+
+      def to_hash
+        super.merge({
+          opening_tag: opening_tag,
+        })
+      end
+
+      def tree_inspect(indent = 0)
+        output = +""
+
+        output += %(@ #{error_name} #{location.tree_inspect}\n)
+        output += %(├── message: #{message.inspect}\n)
+        output += %(└── opening_tag: #{opening_tag ? opening_tag.tree_inspect : "∅"}\n)
+        output += %(\n)
+
+        output.gsub(/^/, "    " * indent)
+      end
+    end
+
+    class TagNamesMismatchError < Error
+      attr_reader :opening_tag
+      attr_reader :closing_tag
+
+      def initialize(type, location, message, opening_tag, closing_tag)
+        super(type, location, message)
+
+        @opening_tag = opening_tag
+        @closing_tag = closing_tag
+      end
+
+      def inspect
+        tree_inspect.rstrip.gsub(/\s+$/, "")
+      end
+
+      def to_hash
+        super.merge({
+          opening_tag: opening_tag,
+          closing_tag: closing_tag,
+        })
+      end
+
+      def tree_inspect(indent = 0)
+        output = +""
+
+        output += %(@ #{error_name} #{location.tree_inspect}\n)
+        output += %(├── message: #{message.inspect}\n)
+        output += %(├── opening_tag: #{opening_tag ? opening_tag.tree_inspect : "∅"}\n)
+        output += %(└── closing_tag: #{closing_tag ? closing_tag.tree_inspect : "∅"}\n)
+        output += %(\n)
+
+        output.gsub(/^/, "    " * indent)
+      end
+    end
+
+    class QuotesMismatchError < Error
+      attr_reader :opening_quote
+      attr_reader :closing_quote
+
+      def initialize(type, location, message, opening_quote, closing_quote)
+        super(type, location, message)
+
+        @opening_quote = opening_quote
+        @closing_quote = closing_quote
+      end
+
+      def inspect
+        tree_inspect.rstrip.gsub(/\s+$/, "")
+      end
+
+      def to_hash
+        super.merge({
+          opening_quote: opening_quote,
+          closing_quote: closing_quote,
+        })
+      end
+
+      def tree_inspect(indent = 0)
+        output = +""
+
+        output += %(@ #{error_name} #{location.tree_inspect}\n)
+        output += %(├── message: #{message.inspect}\n)
+        output += %(├── opening_quote: #{opening_quote ? opening_quote.tree_inspect : "∅"}\n)
+        output += %(└── closing_quote: #{closing_quote ? closing_quote.tree_inspect : "∅"}\n)
+        output += %(\n)
+
+        output.gsub(/^/, "    " * indent)
+      end
+    end
+
+    class VoidElementClosingTagError < Error
+      attr_reader :tag_name
+      attr_reader :expected
+      attr_reader :found
+
+      def initialize(type, location, message, tag_name, expected, found)
+        super(type, location, message)
+
+        @tag_name = tag_name
+        @expected = expected
+        @found = found
+      end
+
+      def inspect
+        tree_inspect.rstrip.gsub(/\s+$/, "")
+      end
+
+      def to_hash
+        super.merge({
+          tag_name: tag_name,
+          expected: expected,
+          found: found,
+        })
+      end
+
+      def tree_inspect(indent = 0)
+        output = +""
+
+        output += %(@ #{error_name} #{location.tree_inspect}\n)
+        output += %(├── message: #{message.inspect}\n)
+        output += %(├── tag_name: #{tag_name ? tag_name.tree_inspect : "∅"}\n)
+        output += %(├── expected: #{expected.inspect}\n)
+        output += %(└── found: #{found.inspect}\n)
+        output += %(\n)
+
+        output.gsub(/^/, "    " * indent)
+      end
+    end
+
+    class UnclosedElementError < Error
+      attr_reader :opening_tag
+
+      def initialize(type, location, message, opening_tag)
+        super(type, location, message)
+
+        @opening_tag = opening_tag
+      end
+
+      def inspect
+        tree_inspect.rstrip.gsub(/\s+$/, "")
+      end
+
+      def to_hash
+        super.merge({
+          opening_tag: opening_tag,
+        })
+      end
+
+      def tree_inspect(indent = 0)
+        output = +""
+
+        output += %(@ #{error_name} #{location.tree_inspect}\n)
+        output += %(├── message: #{message.inspect}\n)
+        output += %(└── opening_tag: #{opening_tag ? opening_tag.tree_inspect : "∅"}\n)
+        output += %(\n)
+
+        output.gsub(/^/, "    " * indent)
+      end
+    end
+
+    class RubyParseError < Error
+      attr_reader :error_message
+      attr_reader :diagnostic_id
+      attr_reader :level
+
+      def initialize(type, location, message, error_message, diagnostic_id, level)
+        super(type, location, message)
+
+        @error_message = error_message
+        @diagnostic_id = diagnostic_id
+        @level = level
+      end
+
+      def inspect
+        tree_inspect.rstrip.gsub(/\s+$/, "")
+      end
+
+      def to_hash
+        super.merge({
+          error_message: error_message,
+          diagnostic_id: diagnostic_id,
+          level: level,
+        })
+      end
+
+      def tree_inspect(indent = 0)
+        output = +""
+
+        output += %(@ #{error_name} #{location.tree_inspect}\n)
+        output += %(├── message: #{message.inspect}\n)
+        output += %(├── error_message: #{error_message.inspect}\n)
+        output += %(├── diagnostic_id: #{diagnostic_id.inspect}\n)
+        output += %(└── level: #{level.inspect}\n)
+        output += %(\n)
+
+        output.gsub(/^/, "    " * indent)
+      end
+    end
+
+  end
+end

data/lib/herb/lex_result.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Herb
+  class LexResult < Result
+    attr_reader :value
+
+    def initialize(value, source, warnings, errors)
+      @value = TokenList.new(value)
+      super(source, warnings, errors)
+    end
+
+    def success?
+      errors.empty?
+    end
+
+    def failed?
+      errors.any?
+    end
+  end
+end

data/lib/herb/libherb/array.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Herb
+  module LibHerb
+    attach_function :array_get, [:pointer, :int], :pointer
+    attach_function :array_capacity, [:pointer], :size_t
+    attach_function :array_size, [:pointer], :size_t
+
+    class Array
+      extend Forwardable
+
+      attr_reader :pointer, :item_class
+
+      def_delegators :items, :first, :last, :[]
+
+      def initialize(pointer, item_class)
+        @pointer = pointer
+        @item_class = item_class
+      end
+
+      def capacity
+        LibHerb.array_capacity(pointer)
+      end
+
+      def size
+        LibHerb.array_size(pointer)
+      end
+
+      def item_pointers
+        size.times.map { |item|
+          LibHerb.array_get(pointer, item)
+        }
+      end
+
+      def items
+        item_pointers.map { |item_pointer|
+          item_class.new(item_pointer)
+        }
+      end
+
+      def inspect
+        %(#<#{self.class} size=#{size} capacity=#{capacity} item_class=#{item_class} pointer=#{pointer}>)
+      end
+    end
+  end
+end

data/lib/herb/libherb/ast_node.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Herb
+  module LibHerb
+    attach_function :ast_node_type, [:pointer], :int
+    attach_function :ast_node_type_to_string, [:pointer], :string
+    attach_function :ast_node_children, [:pointer], :pointer
+    attach_function :ast_node_child_count, [:pointer], :size_t
+    attach_function :ast_pretty_print_node, [:pointer, :size_t, :size_t, :pointer], :void
+    attach_function :ast_node_free, [:pointer], :void
+
+    class ASTNode
+      attr_reader :pointer
+
+      def initialize(pointer)
+        @pointer = pointer
+      end
+
+      def type_int
+        LibHerb.ast_node_type(pointer)
+      end
+
+      def type
+        LibHerb.ast_node_type_to_string(pointer)
+      end
+
+      def child_count
+        LibHerb.ast_node_child_count(pointer)
+      end
+
+      def children
+        LibHerb::Array.new(
+          LibHerb.ast_node_children(pointer),
+          ASTNode
+        )
+      end
+
+      def inspect
+        LibHerb::Buffer.with do |output|
+          LibHerb.ast_pretty_print_node(pointer, 0, 0, output.pointer)
+
+          output.read.force_encoding("utf-8") # TODO: remove force_encoding
+        end
+      end
+    end
+  end
+end

data/lib/herb/libherb/buffer.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Herb
+  module LibHerb
+    attach_function :buffer_init, [:pointer], :bool
+    attach_function :buffer_free, [:pointer], :void
+    attach_function :buffer_value, [:pointer], :pointer
+    attach_function :buffer_length, [:pointer], :size_t
+    attach_function :buffer_capacity, [:pointer], :size_t
+    attach_function :buffer_sizeof, [], :size_t
+    attach_function :buffer_append, [:pointer, :pointer], :void
+
+    class Buffer
+      SIZEOF = LibHerb.buffer_sizeof
+
+      attr_reader :pointer
+
+      def initialize(pointer)
+        @pointer = pointer
+      end
+
+      def append(string)
+        LibHerb.buffer_append(pointer, string)
+      end
+
+      def value
+        LibHerb.buffer_value(pointer)
+      end
+
+      def length
+        LibHerb.buffer_length(pointer)
+      end
+
+      def capacity
+        LibHerb.buffer_capacity(pointer)
+      end
+
+      def read
+        value.read_string(length)
+      end
+
+      def self.with
+        FFI::MemoryPointer.new(SIZEOF) do |pointer|
+          raise "couldn't allocate Buffer" unless LibHerb.buffer_init(pointer)
+
+          return yield new(pointer)
+        ensure
+          LibHerb.buffer_free(pointer)
+        end
+      end
+    end
+  end
+end

data/lib/herb/libherb/extract_result.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Herb
+  class ExtractResult
+    extend Forwardable
+
+    def_delegators :@buffer, :read
+
+    attr_accessor :buffer
+
+    def initialize(pointer)
+      @buffer = LibHerb::Buffer.new(pointer)
+    end
+  end
+end