nuri_game-data_query_handler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7bb0994c4614fb254f5fd898a18df2c20a7863bd8c703454ddff2c06da0cb4fe
+  data.tar.gz: 26acea7cae600db7e4972c7d8da33b7f24f7f88c71290acde56b2dd1aafbfb02
+SHA512:
+  metadata.gz: 84b4c9bb2083245c1334a8d9e5eee5c9b88a2e7435b4ca18eb5ce68034698f944c2189f2fafd9cd8f1f505fd6aada9fadd176d1d6b7ebba5faa846e3667e0f86
+  data.tar.gz: 286355f433d0cbde53656fb782a6d08637cdc0338ecf509b62fde8bfeb4325d810ebda8cd16817dea35bd72408f8a5671bb370e56e764947b8972de65e7541be

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/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nuri_game-data_query_handler.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    nuri_game-data_query_handler (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  nuri_game-data_query_handler!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.4

data/README.md

@@ -0,0 +1,80 @@
+# NuriGame::DataQueryHandler
+
+A simple helper to make data queries on objects inside an Enumerable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nuri_game-data_query_handler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nuri_game-data_query_handler
+
+## Usage
+
+### Create your own DataQueryHandler
+
+```ruby
+require "nuri_game/data_query_handler" #< I'm not sure, it's my first gem
+
+class YourDataQuery < NuriGame::DataQueryHandler
+  def initialize(error_handler = nil)
+    super(error_handler)
+    # Do stuff here like @data = some_enumerable_data
+  end
+  
+  # Overwrite handle_object_query or try2fetch_object if you want more specific queries
+  # You can also overwrite query or query! to make sure your handler doesn't do unexpected things (like calling a sub handler if you don't want to).
+end
+```
+
+### Use a DataQueryHandler
+
+Lets assume dqh, dq2 and dq3 are data query handlers
+
+#### Add dq2 & dq3 to dqh
+```ruby
+dqh.add_query_handler(:first_handler, dq2)
+dqh.add_query_handler(:second_handler, dq3)
+```
+Note : You cannot add two DataQueryHandler on the same symbol, it'll raise ArgumentError with message "Query Handler <name> already added."
+
+#### Get an object of dq2
+```ruby
+object = dqh.query(:first_handler, id: id_in_the_enum)
+```
+Note : When an object is not found, a IndexError (if id is a number) or a KeyError (otherwise) is raised.
+Note2 : The enumerator cannot contain nil values, they're considered as non existing object since nil contain **no data**.
+
+#### Get a property of an object of dq3
+```ruby
+property_value = dqh.query(:second_handler, :self, :property, id: id_in_the_enum)
+# or
+property_value = dqh.query!(:second_handler, :property, id: id_in_the_enum)
+```
+Note : query! doesn't raise an ArgumentError when doesn't find the query_handler :property, it does the same as telling :self before :property in query.
+
+#### Get a hash of properties of an object of dq2
+```ruby
+hash = dqh.query(:first_handler, :self, :prop1, :prop2, :propn, id: id_in_the_enum)
+# pr
+hash = dqh.query!(:first_handler, :prop1, :prop2, :propn, id: id_in_the_enum)
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/NuriYuri/nuri_game-data_query_handler.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nuri_game/data_query_handler"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nuri_game/data_query_handler.rb

@@ -0,0 +1,149 @@
+require "nuri_game/data_query_handler/version"
+
+# NuriGame namespace containing all the utility made by Nuri Yuri in order to make Games.
+module NuriGame
+  # Root class describing the basic data query handler to make data query in your game
+  #
+  # Usage :
+  #   class YourDataQuery < NuriGame::DataQueryHandler
+  #     def initialize(error_handler = nil)
+  #       super(error_handler)
+  #       # Do stuff here like @data = some_enumerable_data
+  #     end
+  #   # [...]
+  #
+  # You can custom #try2fetch_object and #handle_object_query to make more specific queries
+  class DataQueryHandler
+    # Create a new Data Query Handler
+    # @param error_handler [Class, nil] the error handler to use to display the errors (should respond to #warning #error with parameters klass, message)
+    # @param data [Enumerable] the preloaded data of the data query handler
+    def initialize(error_handler = nil, data: nil)
+      @sub_query_handlers = { self: nil }
+      @data = data
+      @error_handler = error_handler
+    end
+    
+    # Function that invoke the query handler (recursively and stricly) in order to perform a data query
+    #
+    # When a query handle is not found but there's a object in the kwarg, the properties of the object are returned
+    #
+    # @example 
+    #   Return the id, atk and dfe of a Monster object
+    #     data_query_handle.query(:self, :id, :atk, :dfe, object: monster)
+    #   Get a monster from the :monster query_handle
+    #     data_query_handle.query(:monster, :self, id: monster_id)
+    # @param handle [Symbol] name of the query handler (:self means were not requesting a sub query)
+    # @param args [Array] list of argument to send to the query handler including the sub query handlers
+    # @param kwarg [Hash<Symbol => Object>] list of keyword arguments to explain the query
+    # @return [Object] result of the query
+    def query(handle, *args, **kwarg)
+      if (object = kwarg[:object])
+        handle_object_query(object, args)
+      elsif (query_handler = @sub_query_handlers[handle])
+        query_handler.query(*args, **kwarg)
+      elsif handle != :self
+        raise_error(ArgumentError, 'Query Handler %<name>s not found!', name: handle)
+      else
+        perform_data_query(args, kwarg)
+      end
+    end
+    
+    # Function that invoke the query handler (recursively but not strictly) in order to perform a data query
+    #
+    # When a query handle is not found but there's a object in the kwarg, the properties of the object are returned
+    #
+    # @example 
+    #   Return the id, atk and dfe of a Monster object
+    #     data_query_handle.query!(:id, :atk, :dfe, object: monster)
+    #   Get a monster from the :monster query_handle
+    #     data_query_handle.query!(:monster, id: monster_id)
+    # @param args [Array] list of argument to send to the query handler including the sub query handlers
+    # @param kwarg [Hash<Symbol => Object>] list of keyword arguments to explain the query
+    # @return [Object] result of the query
+    def query!(*args, **kwarg)
+      if (object = kwarg[:object])
+        handle_object_query(object, args)
+      elsif (query_handler = @sub_query_handlers[args.first])
+        query_handler.query!(*args[1..-1], **kwarg)
+      else
+        perform_data_query(args, kwarg)
+      end
+    end
+    
+    # Function that adds a query handler to the sub_query_handlers
+    # @param name [Symbol]
+    # @param query_handler [DataQueryHandler]
+    def add_query_handler(name, query_handler)
+      raise_error(TypeError, 'Expected name to be a Symbol, got %<klass>s (%<value>s)', klass: name.class, value: name) unless name.is_a?(Symbol)
+      raise_error(TypeError, 'Expected query_handler to be a DataQueryHandler, got %<klass>s', klass: query_handler.class) unless query_handler.is_a?(DataQueryHandler)
+      raise_error(ArgumentError, 'Query Handler %<name>s already added.', name: name) if @sub_query_handlers.has_key?(name)
+      @sub_query_handlers[name] = query_handler
+    end
+    
+    private
+    
+    # Function that handle the property query on an object
+    # @param object [Object]
+    # @param properties [Array<Symbol>]
+    # @return [Hash, object] if no properties, returns the object, otherwise, return a Hash associating the properties to the values
+    def handle_object_query(object, properties)
+      if properties.empty?
+        object
+      elsif properties.size == 1
+        return object.public_send(properties.first)
+      else
+        hash = {}
+        properties.each { |key| hash[key] = object.public_send(key) }
+        hash
+      end
+    end
+    
+    # Function that perform a query on the data held by the query handle (this one will only be able to handle id query)
+    # @param args [Array<Symbol>] list of properties
+    # @param kwarg [Hash<Symbol => Object>] list of keyword used to find the object
+    # @return [Object]
+    def perform_data_query(args, kwarg)
+      if @data && !@data.empty?
+        return query(:self, *args, object: try2fetch_object(args, kwarg))
+      end
+      raise_error(RuntimeError, 'Data is %<information>s.', information: @data ? 'empty' : 'not loaded')
+    end
+    
+    # Function that tries to fetch the object from data
+    # @param args [Array<Symbol>] list of properties
+    # @param kwarg [Hash<Symbol => Object>] list of keyword used to find the object
+    # @return [Object]
+    def try2fetch_object(args, kwarg)
+      if (id = kwarg[:id])
+        unless (object = @data[id]).nil?
+          object
+        else
+          raise_warning(id.is_a?(Integer) ? IndexError : KeyError, 'data[%<key>s] does not exist', key: id.inspect)
+        end
+      else
+        keys = kwarg.keys.reject { |key| key == :id }.join(', ')
+        raise_warning(KeyError, '%<keys>s couldn\'t be understood for this request', keys: keys)
+      end
+    end
+    
+    # Function that raise a warning with a specific class, message and the format of the message
+    # @param klass [StandardError] the class to use to raise the error
+    # @param message [String] the error message (unformated)
+    # @param format_args [Array] the args to use in order to format message
+    # @param format_kwarg [Hash] the kwargs to use in order to format message
+    def raise_warning(klass, message, *format_args, **format_kwarg)
+      message = format(message, *format_args, **format_kwarg)
+      @error_handler ? @error_handler.warning(klass, message) : warn(format('[%<klass>s] : %<message>s', klass: klass, message: message))
+    end
+    
+    # Function that raise an error with a specific class, message and the format of the message
+    # @param klass [StandardError] the class to use to raise the error
+    # @param message [String] the error message (unformated)
+    # @param format_args [Array] the args to use in order to format message
+    # @param format_kwarg [Hash] the kwargs to use in order to format message
+    def raise_error(klass, message, *format_args, **format_kwarg)
+      message = format(message, *format_args, **format_kwarg)
+      @error_handler ? @error_handler.error(klass, message) : raise(klass, message)
+    end
+  end
+end

data/lib/nuri_game/data_query_handler/version.rb

@@ -0,0 +1,5 @@
+module NuriGame
+  class DataQueryHandler
+    VERSION = "0.1.0"
+  end
+end

data/nuri_game-data_query_handler.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nuri_game/data_query_handler/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nuri_game-data_query_handler"
+  spec.version       = NuriGame::DataQueryHandler::VERSION
+  spec.authors       = ["Nuri Yuri"]
+  spec.email         = ["hostmaster@pokemonworkshop.com"]
+
+  spec.summary       = %q{A simple helper to make data queries on objects inside an Enumerable.}
+  spec.homepage      = "https://gitlab.com/NuriYuri/nuri_game-data_query_handler#nurigamedataqueryhandler"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: nuri_game-data_query_handler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nuri Yuri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- hostmaster@pokemonworkshop.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nuri_game/data_query_handler.rb
+- lib/nuri_game/data_query_handler/version.rb
+- nuri_game-data_query_handler.gemspec
+homepage: https://gitlab.com/NuriYuri/nuri_game-data_query_handler#nurigamedataqueryhandler
+licenses: []
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A simple helper to make data queries on objects inside an Enumerable.
+test_files: []