From: Eero Saynatkari <ruby-ml@...>
Date: 2006-10-12T12:38:20+09:00
Subject: [ANN] rs 0.1

--EXKGNeO8l0xGFBjy
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

rs is a project to implement a non-traditional object-oriented shell in Rub=
y.
 =20
The three main features will be the simple power of Ruby as the shell scrip=
ting=20
language, an objectlike interface to files and object piping.=20

This is a preliminary release, mainly to re-introduce the project and
invite developers to join up.

 =20
=3D=3D=3D Authors
See doc/AUTHORS.


=3D=3D=3D Licence
See doc/LICENCE.


=3D=3D=3D Communication
* IRC:=20
  ##rs on irc.freenode.net

* Mailing list:
  http://projects.kittensoft.org/mailman/listinfo/rs-dev_projects.kittensof=
t.org


=3D=3D=3D Documentation
http://projects.kittensoft.org/rs/rdoc/index.html


=3D=3D=3D Features
* Execution of arbitrary Ruby
* Pipes, input redirection
* FileSystemObjects which encapsulate paths and files

A development roadmap is at doc/TODO.roadmap


=3D=3D=3D Download
=3D=3D=3D=3D Developers
Anyone interested in developing rs should read doc/HOWTO.development.

* darcs get http://repos.kittensoft.org/rs
* http://files.kittensoft.org/rs/rs-dev-0.1.tar.gz

=3D=3D=3D=3D Users
* http://files.kittensoft.org/rs/rs-0.1.tar.gz


=3D=3D=3D Installation
It is advised that developers do not install the program locally at=20
this point but rather use bin/rs directly. Users may use the provided
setup.rb script:

  sudo ruby setup.rb all


=3D=3D=3D Using
See doc/HOWTO.using.


=3D=3D=3D Customizing
rs will load ~/.rsrc if it exists. This file is executed as a .rb and
can be used for defining methods, setting $config variables and even
modifying rs itself.


=3D=3D=3D Current issues and bugs
The entire project is in flux. Think of it as an exploratory programming
experiment that will stretch all the way until 0.9 at which point the
real program will be extracted from the codebase at the time.

* Generally not production-ready.
* Cannot be used as a login shell.
* Inconsistent and incomplete internal model.
* The 'lexer' for determining completeness of Ruby statements is very weak.
* Tests, though relatively extensive, mainly ensure that the correct operat=
ion=20
  is present. Work is needed in testing for failure.


=3D=3D=3D Statistic
The codebase is slightly under 500 lines with around 1750 lines of tests
(a 7:2 ratio) with 90+ specifications and 300+ assertions.


=3D=3D=3D Dependencies
=3D=3D=3D=3D Bundled
* Test::Spec by Christian Neukirchen, http://chneukirchen.org. Developers o=
nly.
* FlexMock by Jim Weirich, http://onestepback.org/software/flexmock. Develo=
pers only.

=3D=3D=3D=3D Unbundled
* None


=3D=3D=3D Special thanks
* Everyone who contributed to the original ruSH code.
* The Ruby hackers. I never appreciated the UNIXness of Ruby enough.


=3D=3D=3D Copyright
Copyright (c) 2005-2006 by the Authors. All rights reserved.

--EXKGNeO8l0xGFBjy
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.5 (FreeBSD)

iD8DBQFFLbgc7Nh7RM4TrhIRAhGVAKDOxa8F7fr8gAtCYEQ2EvvJ/DxfDQCgpSbt
RHBIb+1bOoIL8LI9e//B2cY=
=EBLa
-----END PGP SIGNATURE-----

--EXKGNeO8l0xGFBjy--