mirror of
https://github.com/pry/pry.git
synced 2022-11-09 12:35:05 -05:00
e9c2f383eb
Code is indented using the class Pry::Indent. This class uses an internal stack
that contains the indentation levels for each line of code. Certain keywords
such as "class" or "def" will add data to this stack so that the next line is
indented, other keywords such as "end" or "}" will remove data from the stack,
causing the next line to be un-indented.
Pry::Indent is hooked into Pry#retrieve_line as well as Pry#readline. This means
that both input strings as well as the ones displayed by "show-method" are
indented. Sadly due to the way Readline works input strings are indented similar
to IRB. This means that instead of the following:
> class User
> def initialize
> end
> end
You'll get the following:
> class User
> def initialize
> end
> end
While annoying there doesn't seem to be a way to work around this issue. Luckily
the "show-method" command indents your code properly.
By default indentation is turned on. This can be turned off (or back on) using
the configuration item Pry.config.indent. However, if you turn this option off
after a method is defined "show-method" will still show it with indentation as
indentation happens on input rather than only when code is displayed.
For more information see Pry::Indent#indent in lib/pry/indent.rb.
Signed-off-by: Yorick Peterse <yorickpeterse@gmail.com>
127 lines
2.1 KiB
Ruby
127 lines
2.1 KiB
Ruby
require File.expand_path('../helper', __FILE__)
|
|
|
|
# Please keep in mind that any hash signs ("#") in the heredoc strings are
|
|
# placed on purpose. Without these editors might remove the whitespace on empty
|
|
# lines.
|
|
describe Pry::Indent do
|
|
before do
|
|
@indent = Pry::Indent.new
|
|
end
|
|
|
|
it 'should indent an array' do
|
|
input = "array = [\n10,\n15\n]"
|
|
output = "array = [\n 10,\n 15\n]"
|
|
|
|
@indent.indent(input).should === output
|
|
end
|
|
|
|
it 'should indent a hash' do
|
|
input = "hash = {\n:name => 'Ruby'\n}"
|
|
output = "hash = {\n :name => 'Ruby'\n}"
|
|
|
|
@indent.indent(input).should === output
|
|
end
|
|
|
|
it 'should indent a function' do
|
|
input = "def\nreturn 10\nend"
|
|
output = "def\n return 10\nend"
|
|
|
|
@indent.indent(input).should === output
|
|
end
|
|
|
|
it 'should indent a module and class' do
|
|
input = "module Foo\n# Hello world\nend"
|
|
output = "module Foo\n # Hello world\nend"
|
|
input_class = "class Foo\n# Hello world\nend"
|
|
output_class = "class Foo\n # Hello world\nend"
|
|
|
|
@indent.indent(input).should === output
|
|
@indent.indent(input_class).should === output_class
|
|
end
|
|
|
|
it 'should indent separate lines' do
|
|
@indent.indent('def foo').should === 'def foo'
|
|
@indent.indent('return 10').should === ' return 10'
|
|
@indent.indent('end').should === 'end'
|
|
end
|
|
|
|
it 'should properly indent nested code' do
|
|
input = <<TXT.strip
|
|
module A
|
|
module B
|
|
class C
|
|
attr_accessor :test
|
|
# keep
|
|
def number
|
|
return 10
|
|
end
|
|
end
|
|
end
|
|
end
|
|
TXT
|
|
|
|
output = <<TXT.strip
|
|
module A
|
|
module B
|
|
class C
|
|
attr_accessor :test
|
|
# keep
|
|
def number
|
|
return 10
|
|
end
|
|
end
|
|
end
|
|
end
|
|
TXT
|
|
|
|
@indent.indent(input).should === output
|
|
end
|
|
|
|
it 'should indent statements such as if, else, etc' do
|
|
input = <<TXT.strip
|
|
if a === 10
|
|
#
|
|
elsif a === 15
|
|
#
|
|
else
|
|
#
|
|
end
|
|
#
|
|
while true
|
|
#
|
|
end
|
|
#
|
|
for num in [10, 15, 20]
|
|
#
|
|
end
|
|
#
|
|
for num in [10, 15, 20] do
|
|
#
|
|
end
|
|
TXT
|
|
|
|
output = <<TXT.strip
|
|
if a === 10
|
|
#
|
|
elsif a === 15
|
|
#
|
|
else
|
|
#
|
|
end
|
|
#
|
|
while true
|
|
#
|
|
end
|
|
#
|
|
for num in [10, 15, 20]
|
|
#
|
|
end
|
|
#
|
|
for num in [10, 15, 20] do
|
|
#
|
|
end
|
|
TXT
|
|
|
|
@indent.indent(input).should === output
|
|
end
|
|
end
|