k-sato1995/spell_generator

Looking for people who want to start/practice contributing to OSS projects⭐️⭐️

spell_generator's Issues

Removing a noun from SPELL_VERBS

SPELL_VERBS which is supposed to be an array of verbs contains darkness.

The word darkness should be removed from the array.

https://github.com/K-Sato1995/spell_generator/blob/master/lib/spell_generator/spells.rb

Reorganize words sets

Sort words in alphabetical order in each set to simplify addition of new words, avoiding repetitions

origin: https://dev.to/rvictorino/comment/aa5g

Include the travis build status image in the README

Hey there :),

I noticed that there is files for specs, travis, and rubocop. I think it would be good to add the travis status image within the README. I often find this useful to tell me at a quick glance that this project is properly tested and I gain confidence in the code :).

README link to CODE_OF_CONDUCT is broken.

The README link to CODE_OF_CONDUCT is broken. It redirects you to https://github.com/%5BUSERNAME%5D/spell_generator/blob/master/CODE_OF_CONDUCT.md instead of https://github.com/K-Sato1995/spell_generator/blob/master/CODE_OF_CONDUCT.md.

Fix typos in README usage section

• Trailing «r» missing for «Generator»:

SpellGenerator::Generato.new.generate #=> "Symptomatic punch"

• Trailing «r» missing for «Generator»; missing comma between arguments if given output is what's expected:

SpellGenerator::Generato.new.self_generate('Random' 'Fire') #=> "Random Fire"

Fixing this does not require to write code (but requires to execute it to validate solution !)

Gemfile.lock isn't up to date, causing Travis Build to crash.

Travis build is throwing the following error:

You are trying to install in deployment mode after changing
your Gemfile. Run bundle install elsewhere and add the
updated Gemfile.lock to version control.
You have deleted from the Gemfile:

• rubocop

The error message is very descriptive, but if you want more info.

More Info:

The Travis build that failed
StackOverflow Answer

Add more spells

Overview

Add more spells.

Add one or more adjectives to SPELL_SET1 or add one or more verbs to SPELL_SET2 in the link below.

https://github.com/K-Sato1995/spell_generator/blob/master/lib/spell_generator/spells.rb

self_generate misuse should raise an Error

As discussed in #8 :

self_generate() method expects two arguments to be given.

When used with another number of arguments, it is expected to raise a SpellGeneratorError.

However, when used with one argument, for example, self_generate still produces an output without raising any error.

Examples of unexpected behavior:

SpellGenerator::Generator.new.self_generate('RandomFire') #=> RandomFire
SpellGenerator::Generator.new.self_generate('Random' 'Fire') #=> RandomFire (no comma between strings: treated as only one argument, like the line above)

Missing comma in README

Follow-up to #8 :
In README.md «Usage» section, there is a missing comma between function arguments.

SpellGenerator::Generator.new.self_generate('Random' 'Fire') #=> "Random Fire"

Given output does not match code execution in README usage section

In the following usage example:

SpellGenerator::Generator.generate #=> "Brave fire"
SpellGenerator::Generato.new.generate #=> "Symptomatic punch"

Given output is capitalized, but when code is executed, result is lower case:

@K-Sato1995 : what's the fix supposed to be?

• If capitalized output is not an expected feature: adjust README given output to match actual output. In this case, this issue is related to #8.

• If capitalized output is an expected feature: fix code to capitalize ouput

Rename constants for clarity

Hello! Great project!

Just looking through the code and I thought maybe it would make sense to rename SPELL_SET1 to SPELL_ADJECTIVES and perhaps SPELL_SET2 to SPELL_VERBS.

We could also remove the class constants in favor of using SPELL_ADJECTIVES.size in the range at https://github.com/K-Sato1995/spell_generator/blob/master/lib/spell_generator/generator.rb#L13 (for example).

Curious what your thoughts are on this.