ruby_json_parser 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 642bf9c4ccd18cfadf48b5ebfa77838c2b27f85e22f3ad87b800709b94697344
-  data.tar.gz: e56908db728c244bd31105f6feb8093d5f5f2b04f56d4d0d04d43c140fdc5077
+  metadata.gz: 495b76a32a7bbf3cd2ce22b934e8c2fa3e377f5218c8566c4fecfd3005c48baa
+  data.tar.gz: cdbe0edae5fd67802ae55d5bdd5fee9ae7289a2ffbefe00585b11974c108c9a1
 SHA512:
-  metadata.gz: 3488592ef9a18ab9e2dbc155c7e9f7c00fab7e523b41de5b9a0624c9462285a0d1b5239f2fc38b7d1723e2945ec4735731ffc52dae554d5146dcc09f54b76e56
-  data.tar.gz: 39da06576d98f82b3d4f023b10e815c4f2f79684b13264414ba62f762d184327dcc0eca7327e8523fa379a957dc275c22b1186ad87134955e4e3b9ce8a31e41c
+  metadata.gz: a6e6bfb6781d793f7e75c80d22dc57bc6a71e4505641381e111bdd17cbd159af130971d506f4f04beaa45e8cc2538cc19b76a86d448c298b2b4d8db11d751c10
+  data.tar.gz: 9ab967c848b3170f401e6895beb5babeb55cf5e5624a8a15cb8b69179e5a9167365cec691d63e9e19cd0ee5fc172f6050b6e569177614b45c2fd5dfb8355a874

data/.rubocop.yml

@@ -33,3 +33,6 @@ Metrics/ClassLength:
 
 Style/RaiseArgs:
   Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false

data/README.md

@@ -1,6 +1,6 @@
 # RubyJsonParser
 
-This library implements a JSON lexer, parser and evaluator in pure Ruby 💎.
+This library implements a JSON lexer, parser, evaluator and syntax highlighter in pure Ruby 💎.
 
 It has been built for educational purposes, to serve as a simple example of what makes parsers tick.
 
@@ -128,6 +128,19 @@ RubyJsonParser.eval('{ "some" }')
 #! RubyJsonParser::SyntaxError: missing key in object literal for value: `"some"`
 ```
 
+### Syntax highlighter
+
+This library implements a JSON syntax highlighter based on a lexer.
+It tokenizes a JSON source string and returns a new string highlighted with [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code)
+
+You can use it by calling `RubyJsonParser.highlight` passing in a string
+with JSON source.
+
+```rb
+RubyJsonParser.highlight('{ "foo": 3, "lol": [5, false, null, dupa] }')
+#=> "\e[95m{\e[0m \e[93m\"foo\"\e[0m\e[35m:\e[0m \e[94m3\e[0m\e[35m,\e[0m \e[93m\"lol\"\e[0m\e[35m:\e[0m \e[95m[\e[0m\e[94m5\e[0m\e[35m,\e[0m \e[32m\e[3mfalse\e[0m\e[35m,\e[0m \e[32m\e[3mnull\e[0m\e[35m,\e[0m \e[48;2;153;51;255m\e[9m\e[30mdupa\e[0m\e[95m]\e[0m \e[95m}\e[0m"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ruby_json_parser/ansi_codes.rb

@@ -0,0 +1,97 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative 'token'
+
+module RubyJsonParser
+  # Contains common ANSI escape codes
+  module ANSICodes
+    RESET = "\e[0m"
+    BOLD = "\e[1m"
+    FAINT = "\e[2m"
+    ITALIC = "\e[3m"
+    UNDERLINE = "\e[4m"
+    SLOW_BLINK = "\e[5m"
+    RAPID_BLINK = "\e[6m"
+    STRIKE = "\e[9m"
+    ENCIRCLED = "\e[51m"
+    FRAMED = "\e[52m"
+    OVERLINE = "\e[53m"
+
+    FOREGROUND_BLACK = "\e[30m"
+    FOREGROUND_RED = "\e[31m"
+    FOREGROUND_GREEN = "\e[32m"
+    FOREGROUND_YELLOW = "\e[33m"
+    FOREGROUND_BLUE = "\e[34m"
+    FOREGROUND_MAGENTA = "\e[35m"
+    FOREGROUND_CYAN = "\e[36m"
+    FOREGROUND_WHITE = "\e[37m"
+
+    FOREGROUND_BRIGHT_BLACK = "\e[90m"
+    FOREGROUND_BRIGHT_RED = "\e[91m"
+    FOREGROUND_BRIGHT_GREEN = "\e[92m"
+    FOREGROUND_BRIGHT_YELLOW = "\e[93m"
+    FOREGROUND_BRIGHT_BLUE = "\e[94m"
+    FOREGROUND_BRIGHT_MAGENTA = "\e[95m"
+    FOREGROUND_BRIGHT_CYAN = "\e[96m"
+    FOREGROUND_BRIGHT_WHITE = "\e[97m"
+
+    BACKGROUND_BLACK = "\e[40m"
+    BACKGROUND_RED = "\e[41m"
+    BACKGROUND_GREEN = "\e[42m"
+    BACKGROUND_YELLOW = "\e[43m"
+    BACKGROUND_BLUE = "\e[44m"
+    BACKGROUND_MAGENTA = "\e[45m"
+    BACKGROUND_CYAN = "\e[46m"
+    BACKGROUND_WHITE = "\e[47m"
+
+    BACKGROUND_BRIGHT_BLACK = "\e[100m"
+    BACKGROUND_BRIGHT_RED = "\e[101m"
+    BACKGROUND_BRIGHT_GREEN = "\e[102m"
+    BACKGROUND_BRIGHT_YELLOW = "\e[103m"
+    BACKGROUND_BRIGHT_BLUE = "\e[104m"
+    BACKGROUND_BRIGHT_MAGENTA = "\e[105m"
+    BACKGROUND_BRIGHT_CYAN = "\e[106m"
+    BACKGROUND_BRIGHT_WHITE = "\e[107m"
+
+    class << self
+      extend T::Sig
+
+      sig { params(r: Integer, g: Integer, b: Integer).returns(String) }
+      def rgb_foreground(r, g, b)
+        "\e[38;2;#{r};#{g};#{b}m"
+      end
+
+      sig { params(r: Integer, g: Integer, b: Integer).returns(String) }
+      def rgb_background(r, g, b)
+        "\e[48;2;#{r};#{g};#{b}m"
+      end
+
+      # Creates a new string prepended with the given ANSI escape codes.
+      # Styles are reset at the end of the string.
+      sig { params(str: String, codes: T::Array[String]).returns(String) }
+      def style(str, codes)
+        return str if codes.length == 0
+
+        buff = String.new
+        codes.each do |code|
+          buff << code
+        end
+        buff << str << RESET
+      end
+
+      # Creates a new string prepended with the given ANSI escape codes.
+      # Styles are reset at the end of the string.
+      sig { params(str: String, codes: String).returns(String) }
+      def style!(str, *codes)
+        return str if codes.length == 0
+
+        buff = String.new
+        codes.each do |code|
+          buff << code
+        end
+        buff << str << RESET
+      end
+    end
+  end
+end

data/lib/ruby_json_parser/ast.rb

@@ -1,7 +1,7 @@
 # typed: strong
 # frozen_string_literal: true
 
-class RubyJsonParser
+module RubyJsonParser
   # Contains the definitions of all AST (Abstract Syntax Tree) nodes.
   # AST is the data structure that is returned by the parser.
   module AST
@@ -49,7 +49,7 @@ class RubyJsonParser
 
       sig { override.params(indent: Integer).returns(String) }
       def inspect(indent = 0)
-        "#{INDENT_UNIT * indent}(invalid `#{token}`)"
+        "#{INDENT_UNIT * indent}(invalid #{token.inspect})"
       end
     end
 

data/lib/ruby_json_parser/evaluator.rb

@@ -3,7 +3,7 @@
 
 require_relative 'token'
 
-class RubyJsonParser
+module RubyJsonParser
   # An evaluator for JSON.
   # Creates Ruby structures based on an JSON AST.
   module Evaluator

data/lib/ruby_json_parser/highlighter.rb

@@ -0,0 +1,57 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative 'token'
+
+module RubyJsonParser
+  # Color highlighter for JSON. Uses ANSI escape codes.
+  module Highlighter
+    class << self
+      extend T::Sig
+
+      sig { params(source: String).returns(String) }
+      def highlight(source)
+        lexer = Lexer.new(source)
+        buff = String.new
+
+        previous_end = 0
+        lexer.each do |token|
+          span = token.span
+          between_lexemes = T.must source[previous_end...span.start.char_index]
+          buff << between_lexemes if between_lexemes.length > 0
+
+          lexeme_range = span.start.char_index..span.end.char_index
+          lexeme = T.must source[lexeme_range]
+          styles = token_styles(token)
+          buff << ANSICodes.style(lexeme, styles)
+          previous_end = span.end.char_index + 1
+        end
+
+        buff
+      end
+
+      private
+
+      sig { params(token: Token).returns(T::Array[String]) }
+      def token_styles(token)
+        case token.type
+        when Token::NULL, Token::FALSE, Token::TRUE
+          [ANSICodes::FOREGROUND_GREEN, ANSICodes::ITALIC]
+        when Token::COLON, Token::COMMA
+          [ANSICodes::FOREGROUND_MAGENTA]
+        when Token::LBRACE, Token::RBRACE, Token::LBRACKET, Token::RBRACKET
+          [ANSICodes::FOREGROUND_BRIGHT_MAGENTA]
+        when Token::NUMBER
+          [ANSICodes::FOREGROUND_BRIGHT_BLUE]
+        when Token::STRING
+          [ANSICodes::FOREGROUND_BRIGHT_YELLOW]
+        when Token::ERROR
+          [ANSICodes.rgb_background(153, 51, 255), ANSICodes::STRIKE, ANSICodes::FOREGROUND_BLACK]
+        else
+          []
+        end
+      end
+
+    end
+  end
+end

data/lib/ruby_json_parser/lexer.rb

@@ -3,7 +3,7 @@
 
 require_relative 'token'
 
-class RubyJsonParser
+module RubyJsonParser
   # A lexical analyzer (tokenizer) for JSON
   class Lexer
     extend T::Sig
@@ -35,7 +35,7 @@ class RubyJsonParser
 
     sig { returns(Token) }
     def next
-      return Token.new(Token::END_OF_FILE) unless more_tokens?
+      return Token.new(Token::END_OF_FILE, Span.new(Position.new(0), Position.new(0))) unless more_tokens?
 
       scan_token
     end
@@ -68,8 +68,9 @@ class RubyJsonParser
 
     sig { params(type: Symbol, value: T.nilable(String)).returns(Token) }
     def token(type, value = nil)
+      span = Span.new(Position.new(@start_cursor), Position.new(@cursor - 1))
       @start_cursor = @cursor
-      Token.new(type, value)
+      Token.new(type, span, value)
     end
 
     # Returns the current token value.
@@ -342,7 +343,7 @@ class RubyJsonParser
         when 'u'
           unless accept_chars(Token::HEX_DIGITS, 4)
             swallow_rest_of_the_string
-            return Token.new(Token::ERROR, 'invalid unicode escape')
+            return token(Token::ERROR, 'invalid unicode escape')
           end
 
           advance_chars(4)
@@ -350,7 +351,7 @@ class RubyJsonParser
           value_buffer << [last4.hex].pack('U')
         else
           swallow_rest_of_the_string
-          return Token.new(Token::ERROR, "invalid escape `\\#{char}`")
+          return token(Token::ERROR, "invalid escape `\\#{char}`")
         end
       end
     end

data/lib/ruby_json_parser/parser.rb

@@ -1,7 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
-class RubyJsonParser
+module RubyJsonParser
   # JSON parser
   class Parser
     extend T::Sig
@@ -22,7 +22,7 @@ class RubyJsonParser
       # Lexer/Tokenizer that produces tokens
       @lexer = T.let(Lexer.new(source), Lexer)
       # Next token used for predicting productions
-      @lookahead = T.let(Token.new(Token::NONE), Token)
+      @lookahead = T.let(Token.new(Token::NONE, Span.new(Position.new(0), Position.new(0))), Token)
       @errors = T.let([], T::Array[String])
     end
 

data/lib/ruby_json_parser/position.rb

@@ -0,0 +1,29 @@
+# typed: strong
+# frozen_string_literal: true
+
+module RubyJsonParser
+  # A position of a single character in a piece of text
+  class Position
+    extend T::Sig
+
+    sig { returns(Integer) }
+    attr_reader :char_index
+
+    sig { params(char_index: Integer).void }
+    def initialize(char_index)
+      @char_index = char_index
+    end
+
+    sig { params(other: Object).returns(T::Boolean) }
+    def ==(other)
+      return false unless other.is_a?(Position)
+
+      @char_index == other.char_index
+    end
+
+    sig { returns(String) }
+    def inspect
+      "P(#{char_index.inspect})"
+    end
+  end
+end

data/lib/ruby_json_parser/result.rb

@@ -1,7 +1,7 @@
 # typed: strong
 # frozen_string_literal: true
 
-class RubyJsonParser
+module RubyJsonParser
   # The result of parsing a JSON string/file.
   # Combines an AST (Abstract Syntax Tree) and a list of errors.
   class Result

data/lib/ruby_json_parser/span.rb

@@ -0,0 +1,33 @@
+# typed: strong
+# frozen_string_literal: true
+
+module RubyJsonParser
+  # A collection of two positions: start and end
+  class Span
+    extend T::Sig
+
+    sig { returns(Position) }
+    attr_reader :start
+
+    sig { returns(Position) }
+    attr_reader :end
+
+    sig { params(start: Position, end_pos: Position).void }
+    def initialize(start, end_pos)
+      @start = start
+      @end = end_pos
+    end
+
+    sig { params(other: Object).returns(T::Boolean) }
+    def ==(other)
+      return false unless other.is_a?(Span)
+
+      @start == other.start && @end == other.end
+    end
+
+    sig { returns(String) }
+    def inspect
+      "S(#{@start.inspect}, #{@end.inspect})"
+    end
+  end
+end

data/lib/ruby_json_parser/token.rb

@@ -3,7 +3,7 @@
 
 require 'set'
 
-class RubyJsonParser
+module RubyJsonParser
   # Represents a single token (word) produced by the lexer.
   class Token
     extend T::Sig
@@ -57,9 +57,13 @@ class RubyJsonParser
     sig { returns(T.nilable(String)) }
     attr_reader :value
 
-    sig { params(type: Symbol, value: T.nilable(String)).void }
-    def initialize(type, value = nil)
+    sig { returns(Span) }
+    attr_reader :span
+
+    sig { params(type: Symbol, span: Span, value: T.nilable(String)).void }
+    def initialize(type, span, value = nil)
       @type = type
+      @span = span
       @value = value
     end
 
@@ -67,14 +71,14 @@ class RubyJsonParser
     def ==(other)
       return false unless other.is_a?(Token)
 
-      type == other.type && value == other.value
+      type == other.type && value == other.value && span == other.span
     end
 
     sig { returns(String) }
     def inspect
-      return "Token(#{type.inspect})" if value.nil?
+      return "Token(#{type.inspect}, #{span.inspect})" if value.nil?
 
-      "Token(#{type.inspect}, #{value.inspect})"
+      "Token(#{type.inspect}, #{span.inspect}, #{value.inspect})"
     end
 
     # Converts a token into a human-readable string.

data/lib/ruby_json_parser/version.rb

@@ -1,6 +1,6 @@
 # typed: strong
 # frozen_string_literal: true
 
-class RubyJsonParser # rubocop:disable Style/StaticClass
-  VERSION = '0.1.0'
+module RubyJsonParser
+  VERSION = '0.2.0'
 end

data/lib/ruby_json_parser.rb

@@ -4,8 +4,12 @@
 require 'sorbet-runtime'
 
 require_relative 'ruby_json_parser/version'
+require_relative 'ruby_json_parser/position'
+require_relative 'ruby_json_parser/span'
 require_relative 'ruby_json_parser/token'
 require_relative 'ruby_json_parser/lexer'
+require_relative 'ruby_json_parser/ansi_codes'
+require_relative 'ruby_json_parser/highlighter'
 require_relative 'ruby_json_parser/ast'
 require_relative 'ruby_json_parser/result'
 require_relative 'ruby_json_parser/parser'
@@ -13,7 +17,7 @@ require_relative 'ruby_json_parser/evaluator'
 
 # Implements a JSON lexer, parser and evaluator in pure Ruby.
 # Built for educational purposes.
-class RubyJsonParser
+module RubyJsonParser
   extend T::Sig
 
   # JSON syntax error
@@ -71,6 +75,17 @@ class RubyJsonParser
     def eval(source)
       Evaluator.eval(source)
     end
+
+    # Tokenizes the given source string and creates a new
+    # colorized string using ANSI escape codes.
+    sig do
+      params(
+        source: String,
+      ).returns(String)
+    end
+    def highlight(source)
+      Highlighter.highlight(source)
+    end
   end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_json_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mateusz Drewniak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -37,11 +37,15 @@ files:
 - README.md
 - Rakefile
 - lib/ruby_json_parser.rb
+- lib/ruby_json_parser/ansi_codes.rb
 - lib/ruby_json_parser/ast.rb
 - lib/ruby_json_parser/evaluator.rb
+- lib/ruby_json_parser/highlighter.rb
 - lib/ruby_json_parser/lexer.rb
 - lib/ruby_json_parser/parser.rb
+- lib/ruby_json_parser/position.rb
 - lib/ruby_json_parser/result.rb
+- lib/ruby_json_parser/span.rb
 - lib/ruby_json_parser/token.rb
 - lib/ruby_json_parser/version.rb
 - sorbet/config