wirb 2.2.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bb7682a36323e7f6091949c181a0d0dba6749959d8fe8722786c78f68b4b965
-  data.tar.gz: b09786d2784b0bfffa33a2106537a756ae442b79495accfe5038e42ca6e0573d
+  metadata.gz: 3bad0568e8c6cdae110f6c5c0bb966199fcb8e0b07a70661798f70b935eb2aa9
+  data.tar.gz: b18ff8d1e52c62b9b98bc4dd6711c04854ffa0035623ca1fd97edb61ddd3cd99
 SHA512:
-  metadata.gz: cde9e32b55bdcb44d9f8b39211198aa426ef7c23b0e95bea38dddf0cbd6ea2a13531a07687f753a32201dd91f6eeed5d18ded3dd9e9df27892e5530fc92a38f9
-  data.tar.gz: 387112604206f5727d2df2689efc2077e642eefc467242523f1b7caa12d6d3f1bfd7683b88acc90de6eb4716c4453c3770593d4cd7200c3fc8783da740b302f5
+  metadata.gz: 280a3023dbcc80524f36a56099518697cbba22c7f004b038610e506ed0ad19798992eb063f1c71952124d9b35be9fdeec9b6ed17a00f891361615c53312739e2
+  data.tar.gz: 70a538972df7321bd79d88366217e48f9ba4175b35e70fef45d8fb65ba2f116b018991449038d920cca026add3039a4deaa5098ed27da040594f68b9ed3cd3a8

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# Change Log
+
+## 3.0.0
+* Require Ruby 3
+* Relax Ruby version requirement to allow Ruby 4.0
+* Support Ruby 3.4 hash inspects
+* Support Ruby 4.0 concise set syntax
+
 ## 2.2.2
 * Relax Ruby version requirement to allow 3.0
 
@@ -95,7 +103,7 @@
 * Fix stupid rescue bug (no more wirb crashes)
 
 ## 0.2.3 / 0.2.4
-* Support for rubygems-test <gem-testers.org>
+* Support for rubygems-test
 
 ## 0.2.2
 * Always return inspected string (even when errors happen) and endless-loop

data/COPYING.txt

@@ -1,4 +1,4 @@
-Copyright (C) 2011-2020 Jan Lelis <https://janlelis.com>
+Copyright (C) 2011-2025 Jan Lelis <https://janlelis.com>
 Copyright (C) 2006-2009 Paul Duncan <pabs@pablotron.org>
 
 Permission is hereby granted, free of charge, to any person obtaining a

data/README.md

@@ -1,19 +1,16 @@
 ## WIRB Interactive Ruby [![version](https://badge.fury.io/rb/wirb.svg)](https://badge.fury.io/rb/wirb) [<img src="https://github.com/janlelis/wirb/workflows/Test/badge.svg" />](https://github.com/janlelis/wirb/actions?query=workflow%3ATest)
 
-The **WIRB** gem syntax highlights Ruby objects. Works best as your default REPL inspector (see usage section below), but does not require IRB.
+The **WIRB** gem adds syntax highlighting to inspected Ruby objects. It covers core Ruby classes/modules and most of standard library. Works best as your default REPL inspector, but also works without IRB.
 
-Supported Rubies: 3.0, 2.7, 2.6, 2.5
+Supports Ruby 3.x and 4.0.
 
-Older Rubies, should work: 2.4, 2.3, 2.2, 2.1, 2.0, rubinius
-
-Ancient Rubies (1.9, 1.8): Please use [WIRB 1.0](https://github.com/janlelis/wirb/tree/1.0.3)
+Please note that WIRB also works well for Ruby 1 and Ruby 2 - just install the latest WIRB version possible to install.
 
 ## Features
 
 * Syntax highlighting for inspected Ruby objects
-* No monkey patches anywhere
 * Support for generic objects, especially enumerators, and nested generic objects
-* Supports common standard library objects, like `Set`
+* Supports common standard library objects
 * Color schemas customizable via YAML
 
 ## Install
@@ -37,15 +34,17 @@ To activate WIRB permanently, you can add this to the `~/.irbrc` file:
     require 'wirb'
     Wirb.start
 
-Another way would be to use [Irbtools](https://irb.tools), which activate WIRB automatically.
+Another way would be to use [Irbtools](https://github.com/janlelis/irbtools), which activates WIRB automatically.
 
 ## `Kernel#wp`
 
-WIRB comes with a pretty printing utility (similar to awesome_print):
+WIRB comes with a pretty printing utility:
 
     require 'wirb/wp'
     wp some_object
 
+Other than similar tools like *pp* or *awesome_print*, it will not change the format the highlighted objects by adding whitespace, but only adds colors.
+
 ### Bundled Schemas
 
 These are the bundled color schemas. You can load one with `Wirb.load_schema(:name)`
@@ -54,20 +53,15 @@ These are the bundled color schemas. You can load one with `Wirb.load_schema(:na
 * `:colorless` (only uses :bright, :underline and :inverse effect)
 * `:ultra` (by @venantius, matches the colorscheme from [Ultra](https://github.com/venantius/ultra) over in Clojure-land)
 
-### Usage with Rails
-
-If you run into problems using WIRB with Rails, try [the solution in this issue](https://github.com/janlelis/wirb/issues/12#issuecomment-249492524).
 
 ## Also See
 
-* Gem that allows you to configure views for specific objects:
-  [hirb](https://github.com/cldwalker/hirb)
 * WIRB is part of: [Irbtools](https://github.com/janlelis/irbtools)
 * More about terminal colors: [Paint](https://github.com/janlelis/paint)
 
 ## Credits
 
-Copyright (c) 2011-2020 Jan Lelis <https://janlelis.com> see COPYING for details.
+Copyright (c) 2011-2025 Jan Lelis <https://janlelis.com> see COPYING for details.
 
 First tokenizer version was based on the [wirble](https://rubygems.org/gems/wirble) gem:
 Copyright (C) 2006-2009 Paul Duncan <pabs@pablotron.org>

data/Rakefile

@@ -35,3 +35,11 @@ task :gemspec do
   gemspec.validate
 end
 
+
+# # #
+# Start an IRB session using WIRB as inspector
+
+desc "#{gemspec.name} | wIRB"
+task :irb do
+  sh "irb -f -I ./lib -r #{gemspec.name.gsub '-','/'} --inspect wirb"
+end

data/lib/wirb/schema_builder.rb

@@ -9,12 +9,12 @@ module Wirb
 
        schema = normalize_schema(schema_yaml)
        schema[:name] = schema_name.to_sym
-       schema
+       schema.freeze
      end
 
      def self.resolve_schema_yaml(yaml_path)
        if yaml_path.is_a? Symbol # bundled themes
-         datadir = Gem.loaded_specs['wirb'].datadir
+         datadir = File.expand_path(File.dirname(__FILE__) + "/../../data/wirb/").freeze
          [yaml_path.to_s, YAML.load_file(File.join(datadir, "#{yaml_path}.yml"))]
        else
          [File.basename(yaml_path).gsub(/\.yml$/, ''), YAML.load_file(yaml_path)]

data/lib/wirb/tokenizer.rb

@@ -58,14 +58,29 @@ module Wirb
         case @state[-1]
         when nil, :hash, :array, :enumerator, :set, :variable # default state
           case c
-          when '"'      then push_state[:string]
-          when '/'      then push_state[:regexp]
-          when '#'      then push_state[:object]
-          when /[A-Z]/  then push_state[:class,    :repeat]
-          when /[a-z]/  then push_state[:word,     :repeat]
-          when /[0-9-]/ then push_state[:number,   :repeat]
-          when '.'      then push_state[:range,    :repeat]
-          when /\=/     then push_state[:equal,    :repeat]
+          when '"'
+            push_state[:string]
+
+          when '/'
+            push_state[:regexp]
+
+          when '#'
+            push_state[:object]
+
+          when /[A-Z]/
+            push_state[:class, :repeat]
+
+          when /[a-z]/
+            push_state[:word, :repeat]
+
+          when /[0-9-]/
+            then push_state[:number, :repeat]
+
+          when '.'
+            push_state[:range, :repeat]
+
+          when /\=/
+            push_state[:equal, :repeat]
 
           when /\s/
             if get_state[:variable]
@@ -91,6 +106,7 @@ module Wirb
 
           when '>'
             pop_state[:repeat]
+
           when '('
             peek = chars[i+1..-1].join
             if peek =~ /^-?(?:Infinity|NaN|[0-9.e]+)[+-](?:Infinity|NaN|[0-9.e]+)\*?i\)/
@@ -144,18 +160,18 @@ module Wirb
           end
 
         when :class
-          case c
-          when /[a-z0-9_]/i
+          if c =~ /[a-z0-9_]/i
             @token << c
-          else
-            if @token =~ /^(Infinity|NaN)$/
-              set_state[:special_number, :repeat]
-            elsif c ==':' && nc == ':'
-              pass_state[]
-              pass[:class_separator, '::']
-            elsif !(c == ':' && lc == ':')
-              pass_state[:remove, :repeat]
-            end
+          elsif c == ":" && get_previous_state[:hash]
+            pass_custom_state[:symbol, :remove, :repeat]
+            @refers_seen[-1] = true
+          elsif @token =~ /^(Infinity|NaN)$/
+            set_state[:special_number, :repeat]
+          elsif c ==':' && nc == ':'
+            pass_state[]
+            pass[:class_separator, '::']
+          elsif !(c == ':' && lc == ':')
+            pass_state[:remove, :repeat]
           end
 
         when :symbol
@@ -192,10 +208,15 @@ module Wirb
           end
 
         when :string
-          if c == '"' && ( !( @token =~ /\\+$/; $& ) || $&.size % 2 == 0 ) # allow escaping of " and
-            pass[:open_string, '"']                              # work around \\
-            pass_state[:remove]
-            pass[:close_string, '"']
+          if c == '"' && ( !( @token =~ /\\+$/; $& ) || $&.size % 2 == 0 ) # allow escaping of " and work around \\
+            if nc == ':' && get_previous_state[:hash]
+              set_state[:symbol_string, :repeat]
+              @refers_seen[-1] = true
+            else
+              pass[:open_string, '"']
+              pass_state[:remove]
+              pass[:close_string, '"']
+            end
           else
             @token << c
           end
@@ -221,6 +242,9 @@ module Wirb
           if c =~ /[a-z0-9_]/i
             @token << c
             pass_custom_state[@token.to_sym, :remove] if %w[nil false true].include?(@token)
+          elsif c == ":"
+            pass_custom_state[:symbol, :remove, :repeat]
+            @refers_seen[-1] = true
           else
             pass_state[:remove, :repeat]
           end
@@ -337,7 +361,7 @@ module Wirb
                 set_state[@token.to_sym]
               else
                 set_state[:object_description]
-                if @token == "enumerator" && RUBY_ENGINE != "rbx"
+                if @token == "enumerator"
                   push_state[:enumerator]
                 end
               end

data/lib/wirb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wirb
-  VERSION = '2.2.2'
+  VERSION = '3.0.0'
 end

data/spec/spec_helper.rb

@@ -2,6 +2,12 @@ require 'wirb'
 require 'wirb/wp'
 require 'ruby_engine'
 
+# CONFIG
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :should }
+end
+
 # TOKENIZER
 
 def tokenizer(filename)
@@ -80,3 +86,15 @@ end
 OBJECT_ID = /0x[0-9a-f]+/
 
 def ws(obj) puts Wirb::Tokenizer.run(obj.inspect).map{|*x| x.inspect + ','}*$/ end
+
+def spaced_hashes?
+  RUBY_VERSION >= "3.4.0"
+end
+
+def symbol_hash_keys?
+  RUBY_VERSION >= "3.4.0"
+end
+
+def concise_set?
+  RUBY_VERSION >= "4.0.0"
+end