spell_generator 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3600a0d86743c56befe61fbe9f64e261ac799ee0
-  data.tar.gz: eb186b091e7eb666950a62dac04e1033832ee10b
+  metadata.gz: 01e53af5f06c80e7b16e24e1e81b12b5c1d84dda
+  data.tar.gz: 8503fbd3fc9faf23fd5dbaa1577cc851f3614692
 SHA512:
-  metadata.gz: 4b49a08f015f6af1117d66eb66f92b00b3ed34a031745b894150d0c11b01d469fcbd581a81f87cc496036080dd85344065b9ff13770bbf89cc3e29a04c675b3e
-  data.tar.gz: 6b5271330a5ef94b34eec92b7bb4889e05df96afbdbc1ec54d3fddb9b0cc66b8c9756133249cee9bd35846e4e3d68f5ddb5e06cc899873c3bbbc52307cd7a477
+  metadata.gz: 55ef2ab568d38306175e1eb5d6739160f98acae9a0c9c5ae6873441437a55e9be5feb050fde24e6f37f21e38c1fee746fd982e53ee48d2b4465354ade876f28a
+  data.tar.gz: f04489ec7f2b0acbb7d119774ab5a106ebf4802c4d7f9f50a8a7435ae1c4a91c87f87eb38b5b0ac80d29f974fa2bc832808be1847df75a68bd9bf6fce0d2809b

data/.gitignore

@@ -9,3 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
+
+# tags
+.tags
+.tags1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spell_generator (0.1.1)
+    spell_generator (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,25 @@
+[![Build Status](https://travis-ci.org/K-Sato1995/spell_generator.svg?branch=master)](https://travis-ci.org/K-Sato1995/spell_generator)
+
 # SpellGenerator
-This is a pretty useless gem I created for practice.
+
+It generates a random spell.
+
+## Why I created this project
+
+Welcome!! I created this project specifically for helping people take the first step of their OSS journeys⭐️⭐️.
+
+Contributing to an OSS project can be intimidating if you don't know how to do to it or have never experienced it. But if you know the process of making a PR and have already done it before, it can be very simple and fun.  
+That's why I want you to contribute to this project by opening an issue or making a PR to practice/start contributing to other OSS projects✨✨!!
+
+Originally I started this project with [this post](https://dev.to/ksato1995/anybody-who-wants-to-start-practice-contributing-to-oss-projects-59np) on [dev.to](https://dev.to/).
+
+## If you are not a begginer
+
+You can contribute to the project and the whole dev community by opening an issue here or helping new devs to complete their PRs😊.  
+Some wonderful people have already opened some issues and also created PRs.
+I wholeheartedly appreciate them🙏🙏.
+
+Or you are always very welcome to tackle any issue, even if you are not a begginer,
 
 ## Installation
 
@@ -18,22 +38,61 @@ Or install it yourself as:
     $ gem install spell_generator
 
 ## Usage
+
 You can do two things with this gem.
 
 (1) Create a random spell.
 
 ```ruby
-SpellGenerator::Generator.generate #=> "Brave fire"
-SpellGenerator::Generato.new.generate #=> "Symptomatic punch"
+SpellGenerator::Generator.generate #=> "brave fire"
+SpellGenerator::Generator.new.generate #=> "symptomatic punch"
 ```
 
 (2) Create a spell.
 
 ```ruby
-SpellGenerator::Generato.new.self_generate('Random' 'Fire') #=> "Random Fire"
+SpellGenerator::Generator.new.self_generate('Random' 'Fire') #=> "Random Fire"
+```
+
+## How to run examples
+
+First, you have to move to the directory of this project in your terminal.
+
+```
+$ cd spell_generator
+```
+
+Second, run the command below.
+
+```
+$ ruby examples/spells.rb
+```
+
+That's it☀️!
+
+It would output some random spells for ya.
+
+```ruby
+"efficient blow"
+"entire stab"
+"Random Fire"
+```
+
+## How to run the test
+
+First, you have to move to the directory of this project in your terminal.
+
+```
+$ cd spell_generator
+```
+
+Second, run the command below.
+
+```
+$ rake spec
 ```
 
-Told you it's useless.
+That's it☀️!
 
 ## License
 
@@ -41,4 +100,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SpellGenerator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/spell_generator/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SpellGenerator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/K-Sato1995/spell_generator/blob/master/CODE_OF_CONDUCT.md).

data/examples/spells.rb

@@ -0,0 +1,10 @@
+require_relative '../lib/spell_generator'
+
+# Generate.generate (Class method)
+p SpellGenerator::Generator.generate
+
+# Generator#generate (Instance method)
+p SpellGenerator::Generator.new.generate
+
+# Generator#self_generate (Instance method)
+p SpellGenerator::Generator.new.self_generate('Random', 'Fire') #=> Random Fire

data/lib/spell_generator.rb

@@ -1,5 +1,5 @@
-require_relative "spell_generator/version.rb"
-require_relative "spell_generator/generator.rb"
+require_relative 'spell_generator/version.rb'
+require_relative 'spell_generator/generator.rb'
 
 module SpellGenerator
 end

data/lib/spell_generator/generator.rb

@@ -1,24 +1,19 @@
 require_relative 'spells'
+require_relative 'spell_generator_error'
 
 class SpellGenerator::Generator
-  SPELL_SET1_NUMBER = SPELL_SET1.size
-  SPELL_SET2_NUMBER = SPELL_SET2.size
-
-  class << self
-    def generate
-      spell_part1 = SPELL_SET1[rand(0...SPELL_SET1_NUMBER)]
-      spell_part2 = SPELL_SET2[rand(0...SPELL_SET2_NUMBER)]
-      "#{spell_part1} #{spell_part2}"
-    end
+  def self.generate
+    new.generate
   end
 
   def generate
-    spell_part1 = SPELL_SET1[rand(0...SPELL_SET1_NUMBER)]
-    spell_part2 = SPELL_SET2[rand(0...SPELL_SET2_NUMBER)]
+    spell_part1 = SPELL_ADJECTIVES[rand(0...SPELL_ADJECTIVES.size)]
+    spell_part2 = SPELL_VERBS[rand(0...SPELL_VERBS.size)]
     "#{spell_part1} #{spell_part2}"
   end
 
   def self_generate(*spell_parts)
+    raise SpellGeneratorError, 'Require more than 2 values' if spell_parts.size == 1
     spell_parts.join(' ')
   end
 end

data/lib/spell_generator/spell_generator_error.rb

@@ -0,0 +1,2 @@
+class SpellGeneratorError < StandardError
+end

data/lib/spell_generator/spells.rb

@@ -1,7 +1,12 @@
-SPELL_SET1 = %w[accurate sufficient ugly useful immediate entire healthy hot efficient
-                dramatic threatening brave greedy racial regular glorious pretty alcoholic
-                instinctive symptomatic merciful cute perpetual average astonishing shallow
-                shallow hateful sacred divine].freeze
+SPELL_ADJECTIVES = %w[abandoned accurate adorable alcoholic amazing astonishing average awesome better 
+                brave burning cautious cute divine dramatic efficient entire freezing friendly 
+                glorious greedy hateful healthy hot immediate instinctive lame magnificent 
+                marvelous merciful perpetual poisonous pretty quirky racial regular sacred 
+                shallow sickening sufficient symptomatic terrific threatening tyrannical ugly 
+                useful zany malevolent outrageous].freeze
 
-SPELL_SET2 = %w[fire thunder attack blow smash strike smack cut poke stab punch kick kiss
-                flame darkness storm favor jump step hunt].freeze
+SPELL_VERBS = %w[accept attach attack bet bind blow burn buy carry choose chop commit curse cut 
+                decide doubt explain favor feed fire flame flood frost get give hunt improve 
+                include inform invest jump kick kiss lift love maintain manage organize overcome 
+                paint peel plan poke possess pounce pretend pull punch read realize slap smack 
+                smash stab step storm strike thunder typhoon wish write].freeze

data/lib/spell_generator/version.rb

@@ -1,3 +1,3 @@
 module SpellGenerator
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'.freeze
 end

data/rubocop.yml

@@ -0,0 +1,59 @@
+AllCops:
+  Exclude:
+    - bin/*
+    - db/schema.rb
+    - db/migrate/*
+    - db/seeds/original.rb
+    - vendor/**/*
+    - node_modules/**/*
+    - tmp/*
+    - Guardfile
+    - Gemfile
+    - config/puma.rb
+    - config/spring.rb
+    - config/initializers/devise.rb
+    - db/data.rb
+    - spec/rails_helper.rb
+
+  DisplayCopNames: true
+
+# Missing magic comment # frozen_string_literal: true.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Missing top-level class documentation comment.
+Style/Documentation:
+  Enabled: false
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/TrailingBlankLines:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - config/environments/*
+
+# Use only ascii symbols in comments.
+AsciiComments:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 33
+
+Metrics/MethodLength:
+  Max: 22
+
+Metrics/LineLength:
+  Max: 200

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spell_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - K-Sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-16 00:00:00.000000000 Z
+date: 2019-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,10 +70,13 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/spells.rb
 - lib/spell_generator.rb
 - lib/spell_generator/generator.rb
+- lib/spell_generator/spell_generator_error.rb
 - lib/spell_generator/spells.rb
 - lib/spell_generator/version.rb
+- rubocop.yml
 - spell_generator.gemspec
 homepage: https://github.com/K-Sato1995/hola_sato/blob/master/spell_generator.gemspec
 licenses: