pokemon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 940fdaab049a3d0bad4bec4408f9e63e3ffa6c68710ba1a96505cda64391412d
+  data.tar.gz: f682ac2c555e34b37fd82eb07d3a178f65f882b5919f9ee424faeccb738637fd
+SHA512:
+  metadata.gz: bcc0c07b8e41f19a2a452eca03f5c6c1a331e175f721893d96f724922d487ba3acc42b5f016409c6300beae23e188a94685fe269f8b414cea5f01ef0fe03be2e
+  data.tar.gz: 7e00649c7c938f9ce585ab45bd2ffcf331912ca8654707d8f8ba61b45679dea0091f1e9f432b6b9b976772601f0945a1a6ca4f70a79d3e7771397274944e32ab

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mail@noraworld.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pokedex.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'thor'

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    pokemon (0.1.0)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    thor (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pokemon!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  thor
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 noraworld
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,342 @@
+# Pokedex
+Search pokemons you want to know by CLI and Ruby interface.
+
+:warning: This project is forked from [fanzeyi/pokemon.json](https://github.com/fanzeyi/pokemon.json), but independent.
+
+:warning: **This project is WIP!** Stay tuned!
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pokedex'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install pokedex
+```
+
+## Usage
+Pokedex supports both CLI and Ruby interface. You can choose whichever you want.
+
+In Ruby, you should add this line.
+
+```ruby
+require 'pokedex'
+```
+
+And in Ruby, method chaining is available.
+
+```ruby
+Pokedex::Filter.new.type('ice').region('sinnoh').random(3).only('name').take
+```
+
+### All
+Retrieves all pokemons.
+
+For CLI:
+```bash
+$ pokedex
+```
+
+For Ruby:
+```ruby
+Pokedex.all
+```
+
+### ID
+Retrieves pokemons specified by its IDs.
+
+```bash
+$ pokedex 25,133
+```
+
+```ruby
+Pokedex::Filter.new.id(25, 133).take
+```
+
+It is also available to specify pokemons by a range.
+
+```bash
+$ pokedex {100..199}
+```
+
+```ruby
+Pokedex::Filter.new.id(100..199).take
+```
+
+### Name
+Retrieves pokemons specified by its names.
+
+```bash
+$ pokedex growlithe,clefairy,vulpix,eevee
+```
+
+```ruby
+Pokedex::Filter.new.name('growlithe', 'clefairy', 'vulpix', 'eevee').take
+```
+
+Also supports other languages. Languages are auto detected.
+
+```ruby
+Pokedex::Filter.new.name('growlithe', 'ピッピ', '六尾', 'évoli').take
+```
+
+Supported languages (currently):
+
+- English
+- Japanese
+- Chinese
+- French
+
+You can also specify a language.
+
+```ruby
+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.
+
+```bash
+$ pokedex --fuzzy=fla
+```
+
+```ruby
+Pokedex::Filter.new.fuzzy('fla').take
+```
+
+Supported languages (currently):
+
+- English
+- Japanese
+- Chinese
+- French
+
+You can also specify a language.
+
+```ruby
+# 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.
+```bash
+$ pokedex --type=water
+```
+
+```ruby
+Pokedex::Filter.new.type('water').take
+```
+
+#### and
+This example gets pokemons categorized as **Grass and Poison types**.
+
+```bash
+$ pokedex --type={grass,poison}
+```
+
+```ruby
+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**.
+
+```bash
+$ pokedex --type=grass,poison
+```
+
+```ruby
+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**.
+
+```bash
+$ pokedex --type={grass},{poison}
+```
+
+```ruby
+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**.
+
+```bash
+$ pokedex --type={grass,poison},{fire,flying}
+```
+
+```ruby
+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.
+
+```bash
+$ pokedex --region=hoenn,unova
+```
+
+```ruby
+Pokedex::Filter.new.region('hoenn', 'unova').take
+```
+
+Also supports other languages.
+
+```ruby
+Pokedex::Filter.new.region('hoenn', 'イッシュ').take
+```
+
+Supported languages (currently):
+
+- English
+- Japanese
+
+You can also specify a language.
+
+```ruby
+# 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`).
+
+```bash
+$ pokedex --random=3
+```
+
+```ruby
+Pokedex::Filter.new.random(3).take
+```
+
+In Ruby, this is also available.
+
+```ruby
+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.
+
+```ruby
+# 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.
+
+```bash
+$ pokedex --type=fairy --region=kalos --only=id,name
+```
+
+```ruby
+Pokedex::Filter.new.type('fairy').region('kalos').only('id', 'name').take
+```
+
+### Except
+Excludes specific keys from result.
+
+```bash
+$ pokedex --type=fairy --region=kalos --except=type,base
+```
+
+```ruby
+Pokedex::Filter.new.type('fairy').region('kalos').except('type', 'base').take
+```
+
+### Reset
+Deletes all filters. This is only available in Ruby.
+
+```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](https://rubygems.org).
+
+### Dataset
+The pokemon dataset is located under the [data](./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](https://github.com/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](./CODE_OF_CONDUCT.md).
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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](./CODE_OF_CONDUCT.md).