Module: IRB::ExtendCommandBundle

Defined in:
lib/irb/extend-command.rb,
lib/irb/ext/use-loader.rb

Overview

Installs the default irb extensions command bundle.

Constant Summary collapse

EXCB =

:nodoc:

ExtendCommandBundle
NO_OVERRIDE =

See #install_alias_method.

0
OVERRIDE_PRIVATE_ONLY =

See #install_alias_method.

0x01
OVERRIDE_ALL =

See #install_alias_method.

0x02

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.def_extend_command(cmd_name, cmd_class, load_file = nil, *aliases) ⇒ Object

Evaluate the given cmd_name on the given cmd_class Class.

Will also define any given aliases for the method.

The optional load_file parameter will be required within the method definition.


144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/irb/extend-command.rb', line 144

def self.def_extend_command(cmd_name, cmd_class, load_file = nil, *aliases)
  case cmd_class
  when Symbol
	cmd_class = cmd_class.id2name
  when String
  when Class
	cmd_class = cmd_class.name
  end

  if load_file
	line = __LINE__; eval %[
	  def #{cmd_name}(*opts, &b)
 require "#{load_file}"
 arity = ExtendCommand::#{cmd_class}.instance_method(:execute).arity
 args = (1..(arity < 0 ? ~arity : arity)).map {|i| "arg" + i.to_s }
 args << "*opts" if arity < 0
 args << "&block"
 args = args.join(", ")
 line = __LINE__; eval %[
   def #{cmd_name}(\#{args})
		ExtendCommand::#{cmd_class}.execute(irb_context, \#{args})
   end
 ], nil, __FILE__, line
 send :#{cmd_name}, *opts, &b
	  end
	], nil, __FILE__, line
  else
	line = __LINE__; eval %[
	  def #{cmd_name}(*opts, &b)
 ExtendCommand::#{cmd_class}.execute(irb_context, *opts, &b)
	  end
	], nil, __FILE__, line
  end

  for ali, flag in aliases
	@ALIASES.push [ali, cmd_name, flag]
  end
end

.extend_object(obj) ⇒ Object

Installs alias methods for the default irb commands on the given object using #install_alias_method.


211
212
213
214
215
216
217
218
# File 'lib/irb/extend-command.rb', line 211

def self.extend_object(obj)
  unless (class << obj; ancestors; end).include?(EXCB)
	super
	for ali, com, flg in @ALIASES
	  obj.install_alias_method(ali, com, flg)
	end
  end
end

.install_extend_commandsObject

Installs the default irb commands:

irb_current_working_workspace

Context#main

irb_change_workspace

Context#change_workspace

irb_workspaces

Context#workspaces

irb_push_workspace

Context#push_workspace

irb_pop_workspace

Context#pop_workspace

irb_load

#irb_load

irb_require

#irb_require

irb_source

IrbLoader#source_file

irb

IRB.irb

irb_jobs

JobManager

irb_fg

JobManager#switch

irb_kill

JobManager#kill

irb_help

[email protected]+line+options


132
133
134
135
136
# File 'lib/irb/extend-command.rb', line 132

def self.install_extend_commands
  for args in @EXTEND_COMMANDS
	def_extend_command(*args)
  end
end

.irb_original_method_name(method_name) ⇒ Object

:nodoc:


205
206
207
# File 'lib/irb/extend-command.rb', line 205

def self.irb_original_method_name(method_name) # :nodoc:
  "irb_" + method_name + "_org"
end

Instance Method Details

#install_alias_method(to, from, override = NO_OVERRIDE) ⇒ Object

Installs alias methods for the default irb commands, see ::install_extend_commands.


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/irb/extend-command.rb', line 185

def install_alias_method(to, from, override = NO_OVERRIDE)
  to = to.id2name unless to.kind_of?(String)
  from = from.id2name unless from.kind_of?(String)

  if override == OVERRIDE_ALL or
	  (override == OVERRIDE_PRIVATE_ONLY) && !respond_to?(to) or
	  (override == NO_OVERRIDE) &&  !respond_to?(to, true)
	target = self
	(class << self; self; end).instance_eval{
	  if target.respond_to?(to, true) &&
   !target.respond_to?(EXCB.irb_original_method_name(to), true)
 alias_method(EXCB.irb_original_method_name(to), to)
	  end
	  alias_method to, from
	}
  else
	print "irb: warn: can't alias #{to} from #{from}.\n"
  end
end

#irb_contextObject

Displays current configuration.

Modifing the configuration is achieved by sending a message to IRB.conf.


35
36
37
# File 'lib/irb/extend-command.rb', line 35

def irb_context
  IRB.CurrentContext
end

#irb_exit(ret = 0) ⇒ Object

Quits the current irb context

ret is the optional signal or message to send to Context#exit

Same as IRB.CurrentContext.exit.


28
29
30
# File 'lib/irb/extend-command.rb', line 28

def irb_exit(ret = 0)
  irb_context.exit(ret)
end

#irb_load(*opts, &b) ⇒ Object

Loads the given file similarly to Kernel#load, see IrbLoader#irb_load


23
24
25
# File 'lib/irb/ext/use-loader.rb', line 23

def irb_load(*opts, &b)
  ExtendCommand::Load.execute(irb_context, *opts, &b)
end

#irb_require(*opts, &b) ⇒ Object

Loads the given file similarly to Kernel#require


27
28
29
# File 'lib/irb/ext/use-loader.rb', line 27

def irb_require(*opts, &b)
  ExtendCommand::Require.execute(irb_context, *opts, &b)
end