My first gem

Rails
1

Hello all,

I just published my first gem, I’ve extracted it out from a project
I’m working on and just hope it would be useful to others, and get
some community improvment/suggestions.

The code is located on github here http://github.com/arjes/Cache-Column

Hopefully the README has enough details show what my inevitable goal
was.

I have a few questions that I found poorly answered via google
searches.

  1. Whats the best/most accepted way to document the functions in the
    gem.

  2. Whats the best way to write tests for the gem. Right now I have a
    test app since I usually use cucumber

Thanks for your time,
Brian

2

Hi Brian,

On Sat, Aug 21, 2010 at 6:33 PM, PsiPro [email protected] wrote:

Hello all,

I just published my first gem, I’ve extracted it out from a project
I’m working on and just hope it would be useful to others, and get
some community improvment/suggestions.

Congratulations!

The code is located on github here http://github.com/arjes/Cache-Column

Hopefully the README has enough details show what my inevitable goal
was.

I have a few questions that I found poorly answered via google
searches.

  1. Whats the best/most accepted way to document the functions in the
    gem.

Rdoc

  1. Whats the best way to write tests for the gem. Right now I have a
    test app since I usually use cucumber

Test::Unit

Best regards,
Bill

3

2010/8/22 PsiPro [email protected]

I visited your repository. I have already installed cache-column, and I
would like to experiment with it. Congratulations!!![?][?][?]

I have a few questions that I found poorly answered via google
searches.

  1. Whats the best/most accepted way to document the functions in the
    gem.

Let me agree with Bill that RDoc is your friend. Most gems, if not all
use
it. So it has become not only an easy-to-use solution but also the
standard
way of documenting methods even within your “own” application.

I hope these links may be of benefit to you:

  1. Whats the best way to write tests for the gem. Right now I have a
    test app since I usually use cucumber

As Bill said, TEST::Unit is also your friend. It is easy to use, and “in
most cases” you may not need extra gems to be installed for you to run
Test::Unit. Cucumber is best suited for behavioural driven development.
i.e.
you are more interested in defining how your application should behave.
I’m
not saying Cucumber is bad. It nice when you are trying to create an
application from a “bird’s eye view”.In addition, it is “documentation”
oriented. You exploit most of its powers when you are trying to high
level
documentation. Myself, I use Cucumber Features mainly as tools for
bridging
myself (a developer) to the users/clients, but not necessarily for “unit
testing” of methods.

Edmond
Software Developer | Baobab Health Trust (http://www.baobabhealth.org/)
|Malawi

Cell: +265 999 465 137 | +265 881 234 717
Skype: ceekays

“Many people doubt open source software and probably don’t realize that
there is an alternative… which is just as good…” – Kevin Scannell