[lnkForumImage]
TotalShareware - Download Free Software
Confronta i prezzi di migliaia di prodotti.
Asp Forum
 Home | Login | Register | Search 


 

Forums >

comp.lang.ruby

[ANN] HighLine 0.4.0

James Gray

5/7/2005 4:52:00 PM

HighLine 0.4.0 Released
=======================

Not a lot of features in this release, but two that sure are nice to
have. This version brings word wrap and paged printing capabilities
to all output HighLine's output. Limits for both operations are
adjustable with new accessors `wrap_at =` and `page_at =` on all
HighLine objects.

Let me just say a big thanks to Greg Brown, who did a lot of the
initial work on getting word wrap into HighLine. Thanks Greg!

If anyone uses this, feedback is welcome
(james@grayproductions.net). I do have a TODO list of features I
would like to add, but I'm also open to suggestions of how to grow
the project and make in useful to all.

What is HighLine?
-----------------

(from the README)

HighLine was designed to ease the tedious tasks of doing console
input and output with low-level methods like gets() and puts().
HighLine provides a robust system for requesting data from a user,
without needing to code all the error checking and validation rules
and without needing to convert the typed Strings into what your
program really needs. Just tell HighLine what you're after, and let
it do all the work.

What's new in this release?
---------------------------

(highlights from the CHANGELOG)

* Implemented line wrapping with adjustable limit.
* Implemented paged printing with adjustable limit.

Plus documentation and examples for the new features.

Where can I learn more?
-----------------------

HighLine is hosted on RubyForge.

Project page: http://rubyforge.org/projects...
Documentation: http://highline.ruby...
Downloads: http://rubyforge.org/frs/?gr...

How do I get HighLine?
----------------------

HighLine is a gem, so as long as you have RubyGems installed it's as
simple as:

$ sudo gem install highline

If you need to install RubyGems, you can download it from:

http://rubyforge.org/frs/?group_id=126&relea...

HighLine can also be installed manually. Just download the latest
release and follow the instructions in INSTALL:

http://rubyforge.org/frs/?gr...&release_id=2143

James Edward Gray II
28 Answers

Vincent Foley

5/7/2005 9:16:00 PM

0

Hello James,

good job on the new release, I plan to use HighLine in an application I
am building right now, however I would really like it if you could add
an ask_password method. Right now, I use this small hackish method:

# File lib/helpers.rb, line 12
12: def self.ask_password(prompt)
13: print prompt
14: system("stty -echo echonl")
15: pass = gets.chomp
16: system("stty echo -echonl")
17: return pass
18: end

Maybe something to add to your TODO :)

Vincent.

James Gray

5/7/2005 9:29:00 PM

0

On May 7, 2005, at 4:19 PM, Vincent Foley wrote:

> Maybe something to add to your TODO :)

Did you check the TODO? :D

Seriously, I thank you for the request. It is already on the list
and I will add it.

My biggest problem here is that I'm trying to keep HighLine pretty
cross-platform (Unix and Windows is enough for me). I understand the
method you just posted, but if anyone can tell me the Window's
equivalent it would sure help me along...

Thanks!

James Edward Gray II

Andre Nathan

5/7/2005 9:38:00 PM

0

James Edward Gray II said:
> I understand the method you just posted, but if anyone can tell me
> the Window's equivalent it would sure help me along...

Dunno about Windows but I think that using ruby-termios would be
better then calling an external program.

I'm using something like this in ruby-managesieve's sievectl utility
(IIRC I just copied it from one of the usage examples in the termios
lib :)

oldt = Termios.tcgetattr(STDIN)
newt = oldt.dup
newt.lflag &= ~Termios::ECHO
Termios.tcsetattr(STDIN, Termios::TCSANOW, newt)
print 'Password: '
info['password'] = STDIN.gets
Termios.tcsetattr(STDIN, Termios::TCSANOW, oldt)

Regards,
Andre

Ryan Leavengood

5/7/2005 9:48:00 PM

0

Vincent Foley wrote:
> Hello James,
>
> good job on the new release, I plan to use HighLine in an application I
> am building right now, however I would really like it if you could add
> an ask_password method. Right now, I use this small hackish method:
>
> # File lib/helpers.rb, line 12
> 12: def self.ask_password(prompt)
> 13: print prompt
> 14: system("stty -echo echonl")
> 15: pass = gets.chomp
> 16: system("stty echo -echonl")
> 17: return pass
> 18: end
>
> Maybe something to add to your TODO :)

Especially if you can do it multi-platform (the above does not work on
Windows.)

Here is a Windows version that I just wrote:

require 'Win32API'

@getch = Win32API.new("crtdll", "_getch", [], 'L')

def ask_password(prompt)
print prompt
pass = ''
while ((c = @getch.call) != 13)
pass << c.chr
end
pass
end

pass = ask_password("Please give me your password: ")
puts
puts "Got '#{pass}'"
__END__

There may be a better way, but this works. James, feel free to put this
in HighLine, just give me the credit :)

Obviously this will need to be partitioned for the different platforms.

Another cool thing is you could take a block that checks the password
for strength :)

Ryan

Ryan Leavengood

5/7/2005 10:01:00 PM

0

James Edward Gray II wrote:
>
> My biggest problem here is that I'm trying to keep HighLine pretty
> cross-platform (Unix and Windows is enough for me). I understand the
> method you just posted, but if anyone can tell me the Window's
> equivalent it would sure help me along...

You can see that in my other response.

Something else I was just thinking is that if you could get the Unix
version of getch as a proc object, it could be used instead of the
Win32API version I used. I believe that can be gotten from the Curses
library.

That would minimize the difference between each platform, and wouldn't
require external programs like Vincent's does.

My only concern would be whether the enter key was always decimal 13 on
each machine...I do know that newlines in text files on each platform
are different (CRLF on Windows, CR in Unix, LF in Mac...though maybe OS
X is like Unix.)

Ryan

Logan Capaldo

5/7/2005 10:05:00 PM

0

On 5/7/05, Ryan Leavengood <mrcode@netrox.net> wrote:
[snip]
> My only concern would be whether the enter key was always decimal 13 on
> each machine...I do know that newlines in text files on each platform
> are different (CRLF on Windows, CR in Unix, LF in Mac...though maybe OS
> X is like Unix.)
>
> Ryan
>
>

I think you have that a little backwards. unix is LF, and Mac is CR
although OS X is LF also.

Darwin Logan-Capaldos-Computer.local 7.9.0 Darwin Kernel Version
7.9.0: Wed Mar 30 20:11:17 PST 2005;
root:xnu/xnu-517.12.7.obj~1/RELEASE_PPC Power Macintosh powerpc
logan:/Users/logan% irb
irb(main):001:0> ?\n
=> 10

Ryan Leavengood

5/7/2005 10:40:00 PM

0

Logan Capaldo wrote:
>
> I think you have that a little backwards. unix is LF, and Mac is CR
> although OS X is LF also.
>
> Darwin Logan-Capaldos-Computer.local 7.9.0 Darwin Kernel Version
> 7.9.0: Wed Mar 30 20:11:17 PST 2005;
> root:xnu/xnu-517.12.7.obj~1/RELEASE_PPC Power Macintosh powerpc
> logan:/Users/logan% irb
> irb(main):001:0> ?\n
> => 10

Yes, you are right. Hmmm, this is kind of confusing though. Does ?\n
return 13 on a non-OS-X Mac? I would think that \n and \r would always
mean NL (i.e. decimal 10) and CR (i.e. decimal 13), no matter what the
operating system.

But for the matter at hand, I just want to make sure that pressing the
enter key on a Unix and Mac machine always produces decimal 13.

Ryan

James Gray

5/7/2005 11:22:00 PM

0

On May 7, 2005, at 4:48 PM, Ryan Leavengood wrote:

> Here is a Windows version that I just wrote:
>
> require 'Win32API'
>
> @getch = Win32API.new("crtdll", "_getch", [], 'L')
>
> def ask_password(prompt)
> print prompt
> pass = ''
> while ((c = @getch.call) != 13)
> pass << c.chr
> end
> pass
> end
>
> pass = ask_password("Please give me your password: ")
> puts
> puts "Got '#{pass}'"
> __END__
>
> There may be a better way, but this works. James, feel free to put
> this in HighLine, just give me the credit :)

I have a question about this solution. You're stopping when you see
a carriage-return above, but what does Windows really tact onto the
end of the line? Is it a carriage return line feed pair, as I
suspect? Put another way, if you changed the above from 13 to 10,
would it still work?

Thanks.

James Edward Gray II

P.S. I'm not a Window's user. That should be painfully obvious by
now, but I just wanted to explain why I'm asking so many dumb
questions. :)

James Gray

5/7/2005 11:27:00 PM

0

On May 7, 2005, at 4:48 PM, Ryan Leavengood wrote:

> require 'Win32API'
>
> @getch = Win32API.new("crtdll", "_getch", [], 'L')
>
> def ask_password(prompt)
> print prompt
> pass = ''
> while ((c = @getch.call) != 13)
> pass << c.chr
> end
> pass
> end
>
> pass = ask_password("Please give me your password: ")
> puts
> puts "Got '#{pass}'"
> __END__

Last question on this, I promise. Does Windows echo the carriage
return (and possibly line feed), when character reading like this?

James Edward Gray II

Ryan Leavengood

5/7/2005 11:49:00 PM

0

James Edward Gray II wrote:
>
> I have a question about this solution. You're stopping when you see a
> carriage-return above, but what does Windows really tact onto the end
> of the line?

Nothing, by using getch I get every character and DOS/Windows doesn't do
anything. That is why I put that extra puts there. Otherwise the result
looks like this:

Please give me your password: Got 'ryan'

> Is it a carriage return line feed pair, as I suspect?

Nope.

> Put another way, if you changed the above from 13 to 10, would it still
> work?

Nope. In that case you have to type Ctrl-J to end, whereas with 13 you
can hit the enter key or type Ctrl-M. I'm starting to think you will see
the same behavior on Unix and Mac.

> Last question on this, I promise. Does Windows echo the carriage
> return (and possibly line feed), when character reading like this?

As I said above, it echoes nothing.

I'm definitely thinking my solution would make a good general
multi-platform password prompter, with only the implementation of getch
requiring multi-platform code.

Ryan