Peeky

Peeky is a Ruby GEM for peaking into ruby classes and extracting meta

As a Ruby Developer, I should be able to Reverse engineer classes and methods, so that I can document and understand them

Development radar

Tasks next on list

As a Developer, I can use Peeky with a simple API, so that I use Peeky quickly

As a Developer, I can quickly build requirements, so that I can document project features

Stories and tasks

Stories - completed

As a Developer, I can render a class with instance attributes and methods, So that I can quickly mock out an entire class

As a Developer, I can render method signature with debug code, So that mock out a method with parameter logging

As a Developer, I can see the method signature of a method, So that I understand it's parameters

As a Developer, I can render a method with minimal parameter calls, So that I know the minimum parameters when calling a method

As a Developer, I can tell if a method is attr_, so that I can format methods using attr_ notation

As a Developer, I should be able to interrogate class instance information, so that I can reverse engineer a ruby class

Tasks - completed

As a Developer, I can render a class with RDoc documentation, so that I do not have to manually type RDoc references

As a Developer, I can read detailed API documentation on Peaky, so that I use Peeky quickly

Setup GitHub Action (test and lint)

Setup new Ruby GEM