oakdex-pokemon 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e56029d18b8aa9b927c1f4c27516793cc715743
+  data.tar.gz: 167153d816542a894030ba366b252f43dec22f06
+SHA512:
+  metadata.gz: 1022ae90f08279c4b6d95fbaed0aba5cd0b24c94ac77ecc096118585697b761c98d37204bef1f1dc8900e9d2efd63b7d49a3d01d91122a70a92cecdd0ce95ba6
+  data.tar.gz: 14e9093e9c5095bedfa3addd8b7576566db1091cbd977c2a3c15139e7b9ce792d94a41dc1c3d823659189fbc100faf0cab78b8990a66633eb8384bae009f11bb

data/README.md

@@ -0,0 +1,73 @@
+# <img src="https://v20.imgup.net/oakdex_logfbad.png" alt="fixer" width=282>
+
+[![Gem Version](https://badge.fury.io/rb/oakdex-pokemon.svg)](https://badge.fury.io/rb/oakdex-pokemon) [![Build Status](https://travis-ci.org/jalyna/oakdex-pokemon.svg?branch=master)](https://travis-ci.org/jalyna/oakdex-pokemon) [![Maintainability](https://api.codeclimate.com/v1/badges/9917f32f23833238aef9/maintainability)](https://codeclimate.com/github/jalyna/oakdex-pokemon/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/9917f32f23833238aef9/test_coverage)](https://codeclimate.com/github/jalyna/oakdex-pokemon/test_coverage)
+
+Based on [oakdex-pokedex](https://github.com/jalyna/oakdex-pokedex).
+
+Used as a representation for Pokémon across other Projects like [oakdex-battle](https://github.com/jalyna/oakdex-battle) and [oakdex-breeding](https://github.com/jalyna/oakdex-breeding).
+
+## Getting Started
+
+```ruby
+require 'oakdex/pokemon'
+
+pikachu = Oakdex::Pokemon.create('Pikachu', level: 12)
+bulbasaur = Oakdex::Pokemon.create('Bulbasaur', { # many options available
+  exp: 120,
+  gender: 'female',
+  ability: 'Soundproof',
+  nature: 'Bashful',
+  item: 'Earth Plate',
+  hp: 2,
+  iv: {
+    hp: 8,
+    atk: 12,
+    def: 31,
+    sp_atk: 12,
+    sp_def: 5,
+    speed: 14
+  },
+  ev: {
+    hp: 8,
+    atk: 12,
+    def: 99,
+    sp_atk: 4,
+    sp_def: 12,
+    speed: 14
+  },
+  moves: [
+    ['Swords Dance', 12, 30],
+    ['Cut', 40, 44]
+  ],
+  original_trainer: 'Cool trainer name',
+  item_id: 'Lucky Egg',
+  wild: true
+})
+
+pikachu.gender # => female
+pikachu.name # => Pikachu
+pikachu.level # => 12
+pikachu.moves.map { |p| "#{p.name} #{p.pp}" } # => ["Quick Attack 30", "Tail Whip 30", "Growl 40", "Thunder Shock 30"]
+pikachu.hp # => 34
+pikachu.atk # => 18
+pikachu.current_hp # => 34
+pikachu.traded? # => false
+pikachu.change_hp_by(38)
+pikachu.current_hp # => 0
+pikachu.change_pp_by('Thunder Shock', -1)
+pikachu.moves.map { |p| "#{p.name} #{p.pp}" } # => ["Quick Attack 30", "Tail Whip 30", "Growl 40", "Thunder Shock 29"]
+```
+
+## Contributing
+
+I would be happy if you want to add your contribution to the project. In order to contribute, you just have to fork this repository.
+
+Please respect the [Code of Conduct](//github.com/jalyna/oakdex-pokemon/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+MIT License. See the included MIT-LICENSE file.
+
+## Credits
+
+Logo Icon by [Roundicons Freebies](http://www.flaticon.com/authors/roundicons-freebies).

data/lib/oakdex.rb

@@ -0,0 +1,3 @@
+# Main Namespace Oakdex
+module Oakdex
+end

data/lib/oakdex/pokemon.rb

@@ -0,0 +1,122 @@
+require 'forwardable'
+require 'oakdex/pokedex'
+
+require 'oakdex/pokemon/stat'
+require 'oakdex/pokemon/move'
+require 'oakdex/pokemon/factory'
+
+module Oakdex
+  # Represents detailed pokemon instance
+  class Pokemon
+    extend Forwardable
+
+    BATTLE_STATS = %i[hp atk def sp_atk sp_def speed]
+
+    def_delegators :@species, :types
+
+    attr_accessor :trainer
+    attr_reader :species
+
+    def self.create(species_name, options = {})
+      species = Oakdex::Pokedex::Pokemon.find!(species_name)
+      Factory.create(species, options)
+    end
+
+    def initialize(species, attributes = {})
+      @species = species
+      @attributes = attributes
+    end
+
+    def name
+      @species.names['en']
+    end
+
+    def gender
+      @attributes[:gender]
+    end
+
+    def moves
+      @attributes[:moves]
+    end
+
+    def current_hp
+      @attributes[:hp]
+    end
+
+    def moves_with_pp
+      moves.select { |m| m.pp > 0 }
+    end
+
+    def wild?
+      @attributes[:wild]
+    end
+
+    def original_trainer
+      @attributes[:original_trainer]
+    end
+
+    def item_id
+      @attributes[:item_id]
+    end
+
+    def amie
+      {
+        affection: 0,
+        fullness: 0,
+        enjoyment: 0
+      }.merge(@attributes[:amie] || {})
+    end
+
+    def amie_level(amie_stat)
+      5 - [255, 150, 100, 50, 1, 0].find_index do |treshold|
+        amie[amie_stat] >= treshold
+      end
+    end
+
+    def traded?
+      return false if trainer.nil? || original_trainer.nil?
+      return false unless trainer.respond_to?(:name)
+      trainer.name != original_trainer
+    end
+
+    def change_hp_by(hp_change)
+      @attributes[:hp] = if hp_change < 0
+                           [@attributes[:hp] + hp_change, 0].max
+                         else
+                           [@attributes[:hp] + hp_change, hp].min
+                         end
+    end
+
+    def change_pp_by(move_name, pp_change)
+      move = moves.find { |m| m.name == move_name }
+      return unless move
+      move.pp = if pp_change < 0
+                  [move.pp + pp_change, 0].max
+                else
+                  [move.pp + pp_change, move.max_pp].min
+                end
+    end
+
+    def level
+      Stat.level_by_exp(@species.leveling_rate, @attributes[:exp])
+    end
+
+    BATTLE_STATS.each do |stat|
+      define_method stat do
+        initial_stat(stat)
+      end
+    end
+
+    private
+
+    def initial_stat(stat)
+      Stat.initial_stat(stat,
+                        level:      level,
+                        nature:     @attributes[:nature],
+                        iv:         @attributes[:iv],
+                        ev:         @attributes[:ev],
+                        base_stats: @species.base_stats
+                       )
+    end
+  end
+end

data/lib/oakdex/pokemon/factory.rb

@@ -0,0 +1,153 @@
+module Oakdex
+  class Pokemon
+    # Creates Pokemon instance and prefills attributes
+    class Factory
+      REQUIRED_ATTRIBUTES = %i[exp gender ability nature hp iv ev moves]
+      OPTIONAL_ATTRIBUTES = %i[
+        original_trainer
+        wild
+        item_id
+        amie
+      ]
+
+      class << self
+        def create(species, options = {})
+          factory = new(species, options)
+          attributes = Hash[(REQUIRED_ATTRIBUTES +
+            OPTIONAL_ATTRIBUTES).map do |attr|
+                              [attr, factory.send(attr)]
+                            end]
+          Pokemon.new(species, attributes)
+        end
+      end
+
+      def initialize(species, options = {})
+        @species = species
+        @options = options
+      end
+
+      private
+
+      def original_trainer
+        @options[:original_trainer]
+      end
+
+      def wild
+        @options[:wild]
+      end
+
+      def item_id
+        @options[:item_id]
+      end
+
+      def amie
+        @options[:amie]
+      end
+
+      def moves
+        if @options[:moves]
+          @options[:moves].map do |move_data|
+            Move.new(
+              Oakdex::Pokedex::Move.find!(move_data[0]),
+              move_data[1],
+              move_data[2]
+            )
+          end
+        else
+          (generate_available_moves + additional_moves).take(4)
+        end
+      end
+
+      def generate_available_moves
+        available_moves.sample(4).map do |move_name|
+          move_type = Oakdex::Pokedex::Move.find!(move_name)
+          Move.new(move_type, move_type.pp, move_type.pp)
+        end
+      end
+
+      def additional_moves
+        return [] unless @options[:additional_moves]
+        @options[:additional_moves].map do |move_name|
+          move_type = Oakdex::Pokedex::Move.find!(move_name)
+          Move.new(move_type, move_type.pp, move_type.pp)
+        end
+      end
+
+      def available_moves
+        @species.learnset.map do |m|
+          m['move'] if m['level'] && m['level'] <= level
+        end.compact
+      end
+
+      def ability
+        if @options['ability']
+          Oakdex::Pokedex::Ability.find!(@options['ability'])
+        else
+          Oakdex::Pokedex::Ability.find!(abilities.sample['name'])
+        end
+      end
+
+      def abilities
+        @species.abilities.select { |a| !a['hidden'] && !a['mega'] }
+      end
+
+      def exp
+        @options[:exp] || Stat.exp_by_level(
+          @species.leveling_rate,
+          @options[:level]
+        )
+      end
+
+      def level
+        Stat.level_by_exp(@species.leveling_rate, exp)
+      end
+
+      def hp
+        return @options[:hp] if @options[:hp]
+        Stat.initial_stat(:hp,
+                          level: level,
+                          iv: iv,
+                          ev: ev,
+                          base_stats: @species.base_stats,
+                          nature: nature
+                         )
+      end
+
+      def iv
+        return @options[:iv] if @options[:iv]
+        @iv ||= Hash[Pokemon::BATTLE_STATS.map do |stat|
+          [stat, rand(0..31)]
+        end]
+      end
+
+      def ev
+        return @options[:ev] if @options[:ev]
+        @ev ||= Hash[Pokemon::BATTLE_STATS.map do |stat|
+          [stat, 0]
+        end]
+      end
+
+      def gender
+        return @options[:gender] if @options[:gender]
+        return 'neuter' unless @species.gender_ratios
+        calculate_gender
+      end
+
+      def calculate_gender
+        if rand(1..1000) <= @species.gender_ratios['male'] * 10
+          'male'
+        else
+          'female'
+        end
+      end
+
+      def nature(options = {})
+        @nature ||= if options[:nature]
+                      Oakdex::Pokedex::Nature.find!(options[:nature])
+                    else
+                      Oakdex::Pokedex::Nature.all.values.sample
+                    end
+      end
+    end
+  end
+end

data/lib/oakdex/pokemon/move.rb

@@ -0,0 +1,27 @@
+require 'forwardable'
+
+module Oakdex
+  class Pokemon
+    # Represents Pokemon Move with PP
+    class Move
+      extend Forwardable
+
+      attr_reader :max_pp
+      attr_accessor :pp
+
+      def_delegators :@move_type, :target, :priority, :accuracy,
+                     :category, :power, :type, :stat_modifiers,
+                     :in_battle_properties
+
+      def initialize(move_type, pp, max_pp)
+        @move_type  = move_type
+        @pp         = pp
+        @max_pp     = max_pp
+      end
+
+      def name
+        @move_type.names['en']
+      end
+    end
+  end
+end

data/lib/oakdex/pokemon/stat.rb

@@ -0,0 +1,70 @@
+module Oakdex
+  class Pokemon
+    # Calculates Pokemon Stats
+    class Stat
+      class << self
+        def initial_stat(stat, options = {})
+          first_part = initial_stat_first_part(stat, options)
+          (
+            if stat == :hp
+              first_part + options[:level] + 10
+            elsif stat.to_s == options[:nature].increased_stat
+              (first_part + 5) * 1.1
+            elsif stat.to_s == options[:nature].decreased_stat
+              (first_part + 5) * 0.9
+            else
+              first_part + 5
+            end
+          ).to_i
+        end
+
+        def exp_by_level(leveling_rate, level)
+          case leveling_rate
+          when 'Fast' then ((4.0 * level**3) / 5).to_i
+          when 'Slow' then ((5.0 * level**3) / 4).to_i
+          when 'Medium Slow' then medium_slow_exp(level)
+          when 'Fluctuating' then fluctuating_exp(level)
+          else level**3
+          end
+        end
+
+        def level_by_exp(leveling_rate, exp)
+          level = 2
+          level += 1 while exp_by_level(leveling_rate, level) <= exp
+          level - 1
+        end
+
+        private
+
+        def medium_slow_exp(level)
+          (
+            ((6.0 / 5) * level**3) - 15 * level**2 + (100 * level) - 140
+          ).to_i
+        end
+
+        def fluctuating_exp(level)
+          (
+          if level <= 15
+            level**3 * ((((level + 1) / 3.0) + 24) / 50)
+          elsif level <= 36
+            level**3 * ((level + 14) / 50.0)
+          else
+            level**3 * (((level / 2.0) + 32) / 50)
+          end
+          ).to_i
+        end
+
+        def initial_stat_first_part(stat, options = {})
+          (
+            (
+              2.0 *
+              options[:base_stats][stat.to_s] +
+              options[:iv][stat] +
+              (options[:ev][stat] / 4)
+            ) * options[:level]
+          ) / 100
+        end
+      end
+    end
+  end
+end

data/lib/oakdex/pokemon/version.rb

@@ -0,0 +1,5 @@
+module Oakdex
+  class Pokemon
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: oakdex-pokemon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jalyna Schroeder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oakdex-pokedex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: Pokémon Instance Representer, based on oakdex-pokedex
+email: jalyna.schroeder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/oakdex.rb
+- lib/oakdex/pokemon.rb
+- lib/oakdex/pokemon/factory.rb
+- lib/oakdex/pokemon/move.rb
+- lib/oakdex/pokemon/stat.rb
+- lib/oakdex/pokemon/version.rb
+homepage: http://github.com/jalyna/oakdex-pokemon
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Pokémon Instance Representer
+test_files: []