oakdex-pokedex 0.3.0 → 0.4.0

data/data/schemas/type.json

@@ -0,0 +1,97 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "title": "Type",
+  "definitions": {
+    "translations": {
+      "type": "object",
+      "properties": {
+        "cz": {
+          "type": "string"
+        },
+        "dk": {
+          "type": "string"
+        },
+        "fr": {
+          "type": "string"
+        },
+        "de": {
+          "type": "string"
+        },
+        "gr": {
+          "type": "string"
+        },
+        "it": {
+          "type": "string"
+        },
+        "pl": {
+          "type": "string"
+        },
+        "tr": {
+          "type": "string"
+        },
+        "en": {
+          "type": "string"
+        },
+        "jp": {
+          "type": "string"
+        },
+        "es": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "en",
+        "de"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "properties": {
+    "names": {
+      "$ref": "#/definitions/translations"
+    },
+    "color": {
+      "description": "Hex color",
+      "type": "string",
+      "pattern": "^#[A-Fa-f0-9]{6}$"
+    },
+    "effectivness": {
+      "type": "object",
+      "patternProperties": {
+        "Normal|Fighting|Flying|Poison|Ground|Rock|Bug|Ghost|Steel|Fire|Water|Grass|Electric|Psychic|Ice|Dragon|Dark|Fairy": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 2
+        }
+      },
+      "required": [
+        "Normal",
+        "Fighting",
+        "Flying",
+        "Poison",
+        "Ground",
+        "Rock",
+        "Bug",
+        "Ghost",
+        "Steel",
+        "Fire",
+        "Water",
+        "Grass",
+        "Electric",
+        "Psychic",
+        "Ice",
+        "Dragon",
+        "Dark",
+        "Fairy"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "names",
+    "effectivness",
+    "color"
+  ],
+  "additionalProperties": false
+}

data/lib/oakdex/pokedex.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'json-schema'
 require 'oakdex/pokedex/not_found'
 require 'oakdex/pokedex/type'
 require 'oakdex/pokedex/nature'

data/lib/oakdex/pokedex/base.rb

@@ -21,6 +21,12 @@ module Oakdex
           @all ||= map_json_data(json_folder, self)
         end
 
+        def add_to_all(custom_entries)
+          @all = @all.merge(custom_entries.map do |data|
+            [data['names']['en'], new(data)]
+          end.to_h)
+        end
+
         def find(name)
           all[name]
         end
@@ -30,6 +36,10 @@ module Oakdex
             (raise NotFound, "#{name} (#{json_folder}) could not be found")
         end
 
+        def reset!
+          @all = nil
+        end
+
         def where(conditions = {})
           all.values.select do |entry|
             conditions.all? do |name, value|

data/lib/oakdex/pokedex/invalid_pokemon_error.rb

@@ -0,0 +1,7 @@
+module Oakdex
+  module Pokedex
+    # Exception if custom pokemon is invalid
+    class InvalidPokemonError < StandardError
+    end
+  end
+end

data/lib/oakdex/pokedex/pokemon.rb

@@ -1,4 +1,5 @@
 require 'oakdex/pokedex/base'
+require 'oakdex/pokedex/pokemon_importer'
 
 module Oakdex
   module Pokedex
@@ -28,12 +29,21 @@ module Oakdex
       end
 
       class << self
+        def import!(custom_pokemon)
+          PokemonImporter.new(custom_pokemon).import!
+        end
+
         def all_by_id
           @all_by_id ||= Hash[all.map do |_k, pokemon|
             [pokemon.national_id, pokemon]
           end]
         end
 
+        def add_to_all(custom_entries)
+          @all_by_id = nil
+          super(custom_entries)
+        end
+
         def find(name)
           all[name] || all_by_id[name]
         end

data/lib/oakdex/pokedex/pokemon_importer.rb

@@ -0,0 +1,57 @@
+require 'oakdex/pokedex/invalid_pokemon_error'
+
+module Oakdex
+  module Pokedex
+    # Handles Pokemon Import
+    class PokemonImporter
+      def initialize(custom_pokemon)
+        pokemon_list = if custom_pokemon.is_a?(Array)
+                         custom_pokemon
+                       else
+                         JSON.parse(custom_pokemon)
+                       end
+        @pokemon = pokemon_list.map do |p|
+          p.is_a?(Hash) ? p : JSON.parse(p)
+        end
+      end
+
+      def import!
+        validate!
+        Oakdex::Pokedex::Pokemon.add_to_all(@pokemon)
+      end
+
+      private
+
+      def validate!
+        @pokemon.each do |p|
+          begin
+            JSON::Validator.validate!(schema, p)
+          rescue JSON::Schema::ValidationError => e
+            pname = pokemon_name(p) || 'Unknown'
+            raise InvalidPokemonError, "Invalid #{pname}: #{e.message}"
+          end
+        end
+      end
+
+      def schema
+        @schema ||= JSON.parse(File.read(schema_path)).tap do |schema|
+          schema['properties']['national_id']['minimum'] = 10_001
+          schema['properties']['national_id'].delete('maximum')
+          schema['definitions']['pokemon']['enum'] = [nil] + available_pokemon
+        end
+      end
+
+      def available_pokemon
+        Pokemon.all.keys + @pokemon.map { |p| pokemon_name(p) }.compact
+      end
+
+      def pokemon_name(data)
+        data.dig('names', 'en') ? data['names']['en'] : nil
+      end
+
+      def schema_path
+        "#{Oakdex::Pokedex.data_dir}/schemas/pokemon.json"
+      end
+    end
+  end
+end

data/lib/oakdex/pokedex/version.rb

@@ -1,5 +1,5 @@
 module Oakdex
   module Pokedex
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: oakdex-pokedex
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jalyna Schroeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-06 00:00:00.000000000 Z
-dependencies: []
+date: 2019-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Pokedex for Gen 1-7, in JSON and accessible through Ruby.
 email: jalyna.schroeder@gmail.com
 executables: []
@@ -24,6 +38,14 @@ files:
 - data/nature.json
 - data/pokemon.json
 - data/region.json
+- data/schemas/ability.json
+- data/schemas/egg_group.json
+- data/schemas/generation.json
+- data/schemas/move.json
+- data/schemas/nature.json
+- data/schemas/pokemon.json
+- data/schemas/region.json
+- data/schemas/type.json
 - data/type.json
 - lib/oakdex.rb
 - lib/oakdex/pokedex.rb
@@ -31,10 +53,12 @@ files:
 - lib/oakdex/pokedex/base.rb
 - lib/oakdex/pokedex/egg_group.rb
 - lib/oakdex/pokedex/generation.rb
+- lib/oakdex/pokedex/invalid_pokemon_error.rb
 - lib/oakdex/pokedex/move.rb
 - lib/oakdex/pokedex/nature.rb
 - lib/oakdex/pokedex/not_found.rb
 - lib/oakdex/pokedex/pokemon.rb
+- lib/oakdex/pokedex/pokemon_importer.rb
 - lib/oakdex/pokedex/region.rb
 - lib/oakdex/pokedex/type.rb
 - lib/oakdex/pokedex/version.rb
@@ -58,7 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Comprehensive Pokedex for Gen 1-7