Pokedex

Search pokemons you want to know by a CLI or a Ruby interface.

⚠️ This project is forked from fanzeyi/pokemon.json, but independent.

⚠️ This project is WIP! Stay tuned!

Installation

⚠️ The gem name is pokemon, not pokedex. Please be careful.

Add this line to your application’s Gemfile.

gem 'pokemon'

And then execute this.

$ bundle install

Or install it yourself.

$ gem install pokemon

Usage

Pokedex supports both a CLI and a Ruby interface. You can choose whichever you want.

In Ruby, you should add this line.

require 'pokedex'

And in Ruby, method chaining is available.

Pokedex::Filter.new.type('ice').region('sinnoh').random(3).only('name').take

All

Retrieves all pokemons.

For CLI:

$ pokedex

For Ruby:

Pokedex.all

ID

Retrieves pokemons specified by its IDs.

$ pokedex 25,133

Pokedex::Filter.new.id(25, 133).take

It is also available to specify pokemons by a range.

$ pokedex {100..199}

Pokedex::Filter.new.id(100..199).take

Name

Retrieves pokemons specified by its names.

$ pokedex growlithe,clefairy,vulpix,eevee

Pokedex::Filter.new.name('growlithe', 'clefairy', 'vulpix', 'eevee').take

Also supports other languages. Languages are auto detected.

Pokedex::Filter.new.name('growlithe', 'ピッピ', '六尾', 'évoli').take

Supported languages (currently):

• English
• Japanese
• Chinese
• French

You can also specify a language.

Pokedex::Filter.new.name('growlithe', lang: 'english').take # => [{"id"=>58, "name"=>{"english"=>"Growlithe", "japanese"=>"ガーディ", "chinese"=>"卡蒂狗", "french"=>"Caninos"}, "type"=>["Fire"], "base"=>{"HP"=>55, "Attack"=>70, "Defense"=>45, "Sp. Attack"=>70, "Sp. Defense"=>50, "Speed"=>60}}]

# French name is not detected because the language is set as English
Pokedex::Filter.new.name('caninos', lang: 'english').take # => []

Fuzzy

Retrieves pokemons specified by a part of its names. This is useful when the pokemon’s name which you want to know is ambiguous.

$ pokedex --fuzzy=fla

Pokedex::Filter.new.fuzzy('fla').take

Supported languages (currently):

• English
• Japanese
• Chinese
• French

You can also specify a language.

# French name is excluded
Pokedex::Filter.new.fuzzy('fla', lang: 'english').take

Type

Retrieves pokemons categorized as specific types.

This below is an example for taking pokemons categorized as a Water type.

$ pokedex --type=water

Pokedex::Filter.new.type('water').take

and

This example gets pokemons categorized as Grass and Poison types.

$ pokedex --type={grass,poison}

Pokedex::Filter.new.type(['grass', 'poison']).take

Please note that this doesn’t contain the pokemons categorized as Grass and other type except for Poison type, only Grass type, Poison and other type except for Grass type, and only Poison type.

Type 1	Type 2	Include?
Grass		false
Poison		false
Grass	Poison	true
Bug	Grass	false
Bug	Poison	false

or

This example gets pokemons categorized as Grass or Poison types.

$ pokedex --type=grass,poison

Pokedex::Filter.new.type('grass', 'poison').take

Please note that this also contains the pokemons categorized as Grass and other type and Poison and other type (of course Grass and Poison types).

Type 1	Type 2	Include?
Grass		true
Poison		true
Grass	Poison	true
Bug	Grass	true
Bug	Poison	true

single

This example gets pokemons categorized as only Grass type and only Poison type.

$ pokedex --type={grass},{poison}

Pokedex::Filter.new.type(['grass'], ['poison']).take

Please note that this doesn’t contain the pokemons categorized as Grass and other type and Poison and other type.

Type 1	Type 2	Include?
Grass		true
Poison		true
Grass	Poison	false
Bug	Grass	false
Bug	Poison	false

and/or

This example gets pokemons categorized as Grass and Poison types or Fire and Flying types.

$ pokedex --type={grass,poison},{fire,flying}

Pokedex::Filter.new.type(['grass', 'poison'], ['fire', 'flying']).take

Type 1	Type 2	Include?
Grass		false
Poison		false
Grass	Poison	true
Bug	Grass	false
Bug	Poison	false
Fire		false
Flying		false
Fire	Flying	true
Bug	Fire	false
Bug	Flying	false

Region

Retrieves pokemons living in specific regions.

$ pokedex --region=hoenn,unova

Pokedex::Filter.new.region('hoenn', 'unova').take

Also supports other languages.

Pokedex::Filter.new.region('hoenn', 'イッシュ').take

Supported languages (currently):

• English
• Japanese

You can also specify a language.

# Japanese names are excluded
Pokedex::Filter.new.region('ホウエン', 'イッシュ', lang: 'english').take # => []

Random

Retrieves pokemons at random. Specifies argument which is the number of pokemons to be chosen (default is 1).

$ pokedex --random=3

Pokedex::Filter.new.random(3).take

In Ruby, this is also available.

Pokedex::Filter.new.ichooseyou!

The differences between Pokedex::Filter#random and Pokedex::Filter#ichooseyou! are whether it needs Pokedex::Filter#take or not, and whether it can take multiple pokemons or not.

# These are the same (of course the results are different because these take pokemons at random)
Pokedex::Filter.new.region('johto').random.take
Pokedex::Filter.new.region('johto').ichooseyou!

# Pokedex::Filter#ichooseyou! can only take a single pokemon
Pokedex::Filter.new.region('johto').ichooseyou!(3) # => ArgumentError

Only

Includes only specific keys from result.

$ pokedex --type=fairy --region=kalos --only=id,name

Pokedex::Filter.new.type('fairy').region('kalos').only('id', 'name').take

Except

Excludes specific keys from result.

$ pokedex --type=fairy --region=kalos --except=type,base

Pokedex::Filter.new.type('fairy').region('kalos').except('type', 'base').take

Reset

Deletes all filters. This is only available in Ruby.

# Create a new instance
pokemons = Pokedex::Filter.new

# Gyarados is not a Dragon type
pokemons.type('dragon').name('gyarados').take # => []

# Reset all filters
pokemons.reset

pokemons.type('water').name('gyarados').take # => [{"id"=>130, "name"=>{"english"=>"Gyarados", "japanese"=>"ギャラドス", "chinese"=>"暴鲤龙", "french"=>"Léviator"}, "type"=>["Water", "Flying"], "base"=>{"HP"=>95, "Attack"=>125, "Defense"=>79, "Sp. Attack"=>60, "Sp. Defense"=>100, "Speed"=>81}}]

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Dataset

The pokemon dataset is located under the data directory and written in JSON. You can add new pokemons, types, regions, and languages by pull requests. Thank you for your cooperation!

Contributing

Bug reports and pull requests are welcome on GitHub at noraworld/pokedex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Pokedex project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.