irb 1.11.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8029dc02923cbb80a77625adad559929050e1e699ef613a2de18cfdc998aef48
-  data.tar.gz: 4b4165fdd602583745cadd66ad9229eab74e473cf613f25c54a8446a2d9b1589
+  metadata.gz: 17969636013c03ffd08d5b53570ec0eda8620855092bd863c5b851e668343007
+  data.tar.gz: 7900a886588ebca5839e2b6fac6d538e58febd2706cdbbe979e098f2950d2d79
 SHA512:
-  metadata.gz: 1a93cf1c63baba6feba0e9b093ce9f0c200556657cab25760acef18370f1e23d3094865c9c1a8f66d6b1544f3715928f9d8d1212f629e6cec83d0f87ab8eb18c
-  data.tar.gz: 0171eda936e605d6ea83f9d0a98381f93f441bee435748c41839a04b2b672cae0fa9ab4ee3c276141df3e3ab40141581e3e7167ad710accf2790de664f5e7b34
+  metadata.gz: e9d8fe7568718ce10db38ed1a85ad92473c21ca81738cadaa8a8258adcf18cdbfc5755c61621c336ac4bc53c57a08ad26311a4fc671fb98ad0cd5130c2e7527e
+  data.tar.gz: 729f6a0f6ba9fe6cfac3e2ed9e752531006f60c386b3e51fd84c877eeb1b3cdcb0fee1a7bf44c3c0bfa7f0f56def8ad8c7d99413b9b96b304d17e0c15d90aa87

data/README.md

@@ -15,6 +15,10 @@ The `irb` command from your shell will start the interpreter.
 - [Debugging with IRB](#debugging-with-irb)
   - [More about `debug.gem`](#more-about-debuggem)
   - [Advantages Over `debug.gem`'s Console](#advantages-over-debuggems-console)
+- [Type Based Completion](#type-based-completion)
+  - [How to Enable IRB::TypeCompletor](#how-to-enable-irbtypecompletor)
+  - [Advantage over Default IRB::RegexpCompletor](#advantage-over-default-irbregexpcompletor)
+  - [Difference between Steep's Completion](#difference-between-steeps-completion)
 - [Configuration](#configuration)
   - [Environment Variables](#environment-variables)
 - [Documentation](#documentation)
@@ -105,15 +109,9 @@ Hello World
 
 The following commands are available on IRB. You can get the same output from the `show_cmds` command.
 
-```
-Workspace
-  cwws           Show the current workspace.
-  chws           Change the current workspace to an object.
-  workspaces     Show workspaces.
-  pushws         Push an object to the workspace stack.
-  popws          Pop a workspace from the workspace stack.
-
+```txt
 IRB
+  exit           Exit the current irb session.
   irb_load       Load a Ruby file.
   irb_require    Require a Ruby file.
   source         Loads a given file in the current session.
@@ -121,6 +119,13 @@ IRB
   show_cmds      List all available commands and their description.
   history        Shows the input history. `-g [query]` or `-G [query]` allows you to filter the output.
 
+Workspace
+  cwws           Show the current workspace.
+  chws           Change the current workspace to an object.
+  workspaces     Show workspaces.
+  pushws         Push an object to the workspace stack.
+  popws          Pop a workspace from the workspace stack.
+
 Multi-irb (DEPRECATED)
   irb            Start a child IRB.
   jobs           List of current sessions.
@@ -149,6 +154,10 @@ Context
   ls             Show methods, constants, and variables. `-g [query]` or `-G [query]` allows you to filter out the output.
   show_source    Show the source code of a given method or constant.
   whereami       Show the source code around binding.irb again.
+
+Aliases
+  $              Alias for `show_source`
+  @              Alias for `whereami`
 ```
 
 ## Debugging with IRB
@@ -242,15 +251,33 @@ IRB's default completion `IRB::RegexpCompletor` uses Regexp. IRB has another exp
 
 ### How to Enable IRB::TypeCompletor
 
-To enable IRB::TypeCompletor, run IRB with `--type-completor` option
+Install [ruby/repl_type_completor](https://github.com/ruby/repl_type_completor/) with:
+```
+$ gem install repl_type_completor
+```
+Or add these lines to your project's Gemfile.
+```ruby
+gem 'irb'
+gem 'repl_type_completor', group: [:development, :test]
+```
+
+Now you can use type based completion by:
+
+Running IRB with the `--type-completor` option
 ```
 $ irb --type-completor
 ```
-Or write the code below to IRB's rc-file.
+
+Or writing this line to IRB's rc-file (e.g. `~/.irbrc`)
 ```ruby
 IRB.conf[:COMPLETOR] = :type # default is :regexp
 ```
-You also need `gem repl_type_completor` to use this feature.
+
+Or setting the environment variable `IRB_COMPLETOR`
+```ruby
+ENV['IRB_COMPLETOR'] = 'type'
+IRB.start
+```
 
 To check if it's enabled, type `irb_info` into IRB and see the `Completion` section.
 ```

data/irb.gemspec

@@ -41,6 +41,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7")
 
-  spec.add_dependency "reline", ">= 0.3.8"
+  spec.add_dependency "reline", ">= 0.4.2"
   spec.add_dependency "rdoc"
 end

data/lib/irb/cmd/exit.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "nop"
+
+module IRB
+  # :stopdoc:
+
+  module ExtendCommand
+    class Exit < Nop
+      category "IRB"
+      description "Exit the current irb session."
+
+      def execute(*)
+        IRB.irb_exit
+      rescue UncaughtThrowError
+        Kernel.exit
+      end
+    end
+  end
+
+  # :startdoc:
+end

data/lib/irb/completion.rb

@@ -406,7 +406,13 @@ module IRB
         else
           select_message(receiver, message, candidates.sort)
         end
-
+      when /^\s*$/
+        # empty input
+        if doc_namespace
+          nil
+        else
+          []
+        end
       else
         if doc_namespace
           vars = (bind.local_variables | bind.eval_instance_variables).collect{|m| m.to_s}

data/lib/irb/context.rb

@@ -573,14 +573,6 @@ module IRB
       @inspect_method.inspect_value(@last_value)
     end
 
-    alias __exit__ exit
-    # Exits the current session, see IRB.irb_exit
-    def exit(ret = 0)
-      IRB.irb_exit(@irb, ret)
-    rescue UncaughtThrowError
-      super
-    end
-
     NOPRINTING_IVARS = ["@last_value"] # :nodoc:
     NO_INSPECTING_IVARS = ["@irb", "@io"] # :nodoc:
     IDNAME_IVARS = ["@prompt_mode"] # :nodoc:

data/lib/irb/extend-command.rb

@@ -16,15 +16,6 @@ module IRB # :nodoc:
     # See #install_alias_method.
     OVERRIDE_ALL = 0x02
 
-    # Quits the current irb context
-    #
-    # +ret+ is the optional signal or message to send to Context#exit
-    #
-    # Same as <code>IRB.CurrentContext.exit</code>.
-    def irb_exit(ret = 0)
-      irb_context.exit(ret)
-    end
-
     # Displays current configuration.
     #
     # Modifying the configuration is achieved by sending a message to IRB.conf.
@@ -35,13 +26,16 @@ module IRB # :nodoc:
     @ALIASES = [
       [:context, :irb_context, NO_OVERRIDE],
       [:conf, :irb_context, NO_OVERRIDE],
-      [:irb_quit, :irb_exit, OVERRIDE_PRIVATE_ONLY],
-      [:exit, :irb_exit, OVERRIDE_PRIVATE_ONLY],
-      [:quit, :irb_exit, OVERRIDE_PRIVATE_ONLY],
     ]
 
 
     @EXTEND_COMMANDS = [
+      [
+        :irb_exit, :Exit, "cmd/exit",
+        [:exit, OVERRIDE_PRIVATE_ONLY],
+        [:quit, OVERRIDE_PRIVATE_ONLY],
+        [:irb_quit, OVERRIDE_PRIVATE_ONLY],
+      ],
       [
         :irb_current_working_workspace, :CurrentWorkingWorkspace, "cmd/chws",
         [:cwws, NO_OVERRIDE],

data/lib/irb/input-method.rb

@@ -291,11 +291,13 @@ module IRB
       @auto_indent_proc = block
     end
 
+    def retrieve_doc_namespace(matched)
+      preposing, _target, postposing, bind = @completion_params
+      @completor.doc_namespace(preposing, matched, postposing, bind: bind)
+    end
+
     def show_doc_dialog_proc
-      doc_namespace = ->(matched) {
-        preposing, _target, postposing, bind = @completion_params
-        @completor.doc_namespace(preposing, matched, postposing, bind: bind)
-      }
+      input_method = self # self is changed in the lambda below.
       ->() {
         dialog.trap_key = nil
         alt_d = [
@@ -311,7 +313,7 @@ module IRB
         cursor_pos_to_render, result, pointer, autocomplete_dialog = context.pop(4)
         return nil if result.nil? or pointer.nil? or pointer < 0
 
-        name = doc_namespace.call(result[pointer])
+        name = input_method.retrieve_doc_namespace(result[pointer])
         # Use first one because document dialog does not support multiple namespaces.
         name = name.first if name.is_a?(Array)
 
@@ -419,8 +421,7 @@ module IRB
         return
       end
 
-      _target, preposing, postposing, bind = @completion_params
-      namespace = @completor.doc_namespace(preposing, matched, postposing, bind: bind)
+      namespace = retrieve_doc_namespace(matched)
       return unless namespace
 
       driver ||= RDoc::RI::Driver.new

data/lib/irb/source_finder.rb

@@ -19,7 +19,7 @@ module IRB
     def find_source(signature, super_level = 0)
       context_binding = @irb_context.workspace.binding
       case signature
-      when /\A[A-Z]\w*(::[A-Z]\w*)*\z/ # Const::Name
+      when /\A(::)?[A-Z]\w*(::[A-Z]\w*)*\z/ # Const::Name
         eval(signature, context_binding) # trigger autoload
         base = context_binding.receiver.yield_self { |r| r.is_a?(Module) ? r : Object }
         file, line = base.const_source_location(signature)
@@ -34,7 +34,8 @@ module IRB
         return unless receiver.respond_to?(method, true)
         file, line = method_target(receiver, super_level, method, "receiver")
       end
-      if file && line && File.exist?(file)
+      # If the line is zero, it means that the target's source is probably in a binary file, which we should ignore.
+      if file && line && !line.zero? && File.exist?(file)
         Source.new(file: file, first_line: line, last_line: find_end(file, line))
       end
     end

data/lib/irb/version.rb

@@ -5,7 +5,7 @@
 #
 
 module IRB # :nodoc:
-  VERSION = "1.11.0"
+  VERSION = "1.11.1"
   @RELEASE_VERSION = VERSION
-  @LAST_UPDATE_DATE = "2023-12-19"
+  @LAST_UPDATE_DATE = "2024-01-08"
 end

data/lib/irb.rb

@@ -705,12 +705,6 @@ require_relative "irb/pager"
 # Command-line option <tt>-W[_level_]<tt>
 # sets warning level; 0=silence, 1=medium, 2=verbose.
 #
-# :stopdoc:
-# === Performance Measurement
-#
-# IRB.conf[:MEASURE] IRB.conf[:MEASURE_CALLBACKS] IRB.conf[:MEASURE_PROC]
-# :startdoc:
-#
 # == Other Features
 #
 # === Load Modules
@@ -771,12 +765,6 @@ require_relative "irb/pager"
 #
 # Note that the configuration file entry overrides the command-line options.
 #
-# :stopdoc:
-# === \Context Mode
-#
-# IRB.conf[:CONTEXT_MODE]
-# :startdoc:
-#
 # === \IRB Name
 #
 # You can specify a name for \IRB.
@@ -815,12 +803,6 @@ require_relative "irb/pager"
 # Each time the configuration is changed,
 # that proc is called with argument +conf+:
 #
-# :stopdoc:
-# === \Locale
-#
-# IRB.conf[:LC_MESSAGES]
-# :startdoc:
-#
 # === Encodings
 #
 # Command-line option <tt>-E _ex_[:_in_]</tt>
@@ -904,8 +886,8 @@ module IRB
   end
 
   # Quits irb
-  def IRB.irb_exit(irb, ret)
-    throw :IRB_EXIT, ret
+  def IRB.irb_exit(*)
+    throw :IRB_EXIT
   end
 
   # Aborts then interrupts irb.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: irb
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.11.1
 platform: ruby
 authors:
 - aycabta
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reline
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +68,7 @@ files:
 - lib/irb/cmd/debug.rb
 - lib/irb/cmd/delete.rb
 - lib/irb/cmd/edit.rb
+- lib/irb/cmd/exit.rb
 - lib/irb/cmd/finish.rb
 - lib/irb/cmd/help.rb
 - lib/irb/cmd/history.rb
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.1
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Interactive Ruby command-line tool for REPL (Read Eval Print Loop).