annetheagile / bc-ruby Goto Github PK

[x]Issue#01 Bug when use CLI and add a batch price - integers aren't auto-converted from string.
=> Fixed in v.1.04

My tests of the API for Rspec have a bug, not cross platform for mac. See test;
https://github.com/AnneTheAgile/bc-ruby/blob/master/specLib/zRspec_spec.rb
it 'Must call the bat file, not Rspec, on windows,' do

Mac RubyMine had path issues so I am using Windows right now.

[x]Issue#05: Add this ChangeLog.md and Readme.md. Examples; https://raw.github.com/colszowka/simplecov/a38915db28552cf1a51748f104d34d86a2e897bc/CHANGELOG.md https://raw.github.com/colszowka/simplecov/a38915db28552cf1a51748f104d34d86a2e897bc/README.md

= Fixed in v 1.04

Tools not yet investigated. Code Coverage was checked simply using RubyMine built in checker.

[x]Issue#03 Refactor prompt loops to use a generic, customized prompter plus yield to create specific objects.
Ruby-tip, Cannot pass two blocks for two different yield's, so printing the resultant object is now delegated.
=> done in v.1.04

[x]Issue#02 Add @LiVe variable to explicitly decide whether to show initialization 'hello' messaging, which is shared between API and CLI.
=> fixed in v.1.04

Confusing, difficult to read commit logs are considered to be possibly the number one worst Technical Debt offender.

The 'let' code was not working as per the documentation. Possibly it was an issue with the different versions of Rspec i was playing with. I was on beta v2 for most of the time?
See this file for some machinations I tried so far;
https://github.com/AnneTheAgile/bc-ruby/blob/master/specZFut/zRspec_let_spec.rb

My code is probably not fully up to Sandi's rules. For example, do I have iteration in the same method as computation? I think so.

Ruby Roundtable NYC Meetup POODiR Part-1 with urls for videos by Sandi Metz;
https://github.com/skmetz/poodr
http://www.meetup.com/nycruby/events/151714002/

Ruby Roundtable NYC Meetup POODiR Part-2 postponed today 140213r;
http://www.meetup.com/nycruby/events/159148242/

I have a bit of a concern though about passing Hashmaps to constructors, which certainly makes some changes easier but hides dependencies. See Flaw #2: Digging into Collaborators , http://misko.hevery.com/code-reviewers-guide/

I was lucky to have a mini code review from a NYC Rubyist and HackerSchool alum, Danielle Sucher. She thought it would be fine for me to post her email as one of my tasks.

From: Danielle Sucher
Sent: Mar 27, 2014 10:05 PM
To: Anne Moroney Web
Subject: Re: Peer Review Recources

So, a few thoughts at first glance: -

Your variable/method names are not very Ruby-ish. The Ruby community prefers snake_case rather than camelCase, except for class/module names. I'm also not super clear on why you keep prefixing argument names with a (ie aMap).

You have "if x != nil" in a few places. It's more idiomatic to just use truthy/falsy values directly, so that'd be "if !x" or "unless x" instead.

Your namespacing feels a bit redundant. Why Money::Money and Store::Store, &c? What was the purpose of enclosing those like that?

Methods like validAsProductID feel like an indication that you might want a ProjectId object that knows how to validate itself.

Ruby methods return the value of their last line, so using an explicit "return" in the last line is generally not done.

I like that you're storing money as pennies.

I'm really confused by all the commented out stuff, like in https://github.com/AnneTheAgile/bc-ruby/blob/master/specZFut/zRspec_let_spec.rb . Best to just delete it and trust that it's in git if you need it.

Overall, I think it's largely the naming and documentation that's really confusing to me here. More of a communication thing than a code organization thing, really.

Issue#04: Added RDOC files accessible at ./doc/index.html. Reultant metric: 36% of 64 item documented, .
[]Ruby-tip; To generate API Doc for project; On windows, in root, $ rdoc.bat ./lib