game_validator 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c542c118accd6ade4435166b23b621d9298c626b3c3101c8a6115b977cca209
-  data.tar.gz: bf75c56e76161880e4472e716f569345cc474013536453d6a81774508995c6d0
+  metadata.gz: 919eea6127e5739639bfd7034cf90ac44f4686dcc98fe8bd05d5cec91214458e
+  data.tar.gz: 2169e75bd4797488853984472902d076da7c032eee445ba89ad02a5db98f7fac
 SHA512:
-  metadata.gz: 61fd8aec87cb1d995351ba027b8b428c80ba953808f2dc2cf3be4538b8ae8af99426bbe581ec8fafde8eaf3eb57dccb60756d3881bf0e2bb26d44a2855a142fc
-  data.tar.gz: e9441c97742f8c52ae4cb861334312ced67d8867e765ab743d6a72bc1cde38908913ff5235770e8819506f505bdaff94b68a65d3db2d2e6dfbe05cbcb0b761b2
+  metadata.gz: c9002a19d864067465f51a27cf344087d75f94b22704e2b6bccb07d38d3b9c2d56470bddac6a13a90874b7f8c34feb8e88a2afdf5b318294e0b6a7e6c1ff7438
+  data.tar.gz: 41e821d0ab7d559142a95dce2afd1032a4926a846e0be6d338f65abbc74804310668e922176940244eebbef5d096a994f5ea80e1832a7aa825fbf16b16307ab7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    game_validator (0.1.0)
+    game_validator (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,9 @@
 # GameValidator
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/game_validator`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is a wrapper on 'dry-validation' to validate the entire input in two or more passes.
+
+The first pass will verify only that the user is valid and the player action is valid.  If and only if the first pass is successful, a second pass will be made to verify the input against a validator specific to the user's admin status, and to the player_action selected. 
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,7 +23,65 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The base class of this gem is GameValidator::Validator.  It requires two dependencies.  The first, with key <b>validate_player_action_and_user</b>, is a built in class GameValidator::Validator::Base, while the second, <b>full_validator_for</b>, should be created by the application builder.
+
+validate_player_action_and_user, where the legal player actions are 'run' and 'hide', and the player whose turn it is has an id of 1, is most easily initialized with the below code
+```
+GameValidator::Validator::Base::new(legal_options: ['run', 'hide'], next_player_id: 1)
+```
+
+To create the various action specific validators, wrap Dry::Validation::Contract in a manner such as this
+```
+class RunValidator
+  extend Dry::Initializer
+  option :validate, default: ->{Validator::new}
+  
+  class Validator < Dry::Validation::Contract
+    schema do
+      required(:player_action).filled(:string, eql?: 'run')
+      required(:where).filled(:string, included_in?: ['here', 'there'])
+    end
+  end
+  
+  class Executor
+    extend Dry::Initializer
+    option :where
+    def call(change_orders:, **args)
+      change_orders.push(Node::new(where: where))
+      change_orders
+    end
+  end
+  
+  class Node
+    extend Dry::Initializer
+    option :where
+    def accept(visitor)
+      visitor.handle_run_node(where)
+    end
+  end
+
+  def call(input)
+    result = validate(input)
+    result.success? ? Executor::new(where: result[:where]) : result
+  end
+end
+```
+You then need to arrange all of the possible validators in a hash, with either a String or Hash key the value being the value of player_action, or a two element array as the key, the first element being the string value of player_action, and whether the validator is for an admin or non admin as the second element.  If the same validator should apply whether or not the user is an admin or not, the same element should be added twice, with the admin portion being both true and false
+
+```
+full_validator = {
+  'run' => run_validator,
+  ['hide', true] => hide_admin_validator,
+  ['hide', false] => hide_non_admin_validator # using a hash with two elements as the key in the event I need different validators for admin and non-admin
+}
+```
+
+In this fashion, you create the full validator as follows
+```
+GameValidator::Validator::new(
+  validate_player_action_and_user: GameValidator::Validator::Base::new(legal_options: ['run', 'hide'], next_player_id: 1),
+  full_validator_for: full_validator)
+```
 
 ## Development
 
@@ -37,3 +96,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+    extend Dry::Initializer
+    option :where

data/game_validator.gemspec

@@ -2,7 +2,7 @@ lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "game_validator/version"
 
-Gem::Specification.new 'game_validator', '0.2.0' do |spec|
+Gem::Specification.new 'game_validator', '0.3.0' do |spec|
   spec.name          = 'game_validator'
   spec.version       = GameValidator::VERSION
   spec.authors       = ['Colin Horner']

data/lib/game_validator/validator.rb

@@ -1,6 +1,7 @@
 # frozen string_literal: true
 
 require 'game_validator/validator/base'
+require 'game_validator/validator/full_validator_coercer'
 
 module GameValidator
   class Validator

data/lib/game_validator/validator/full_validator_coercer.rb

@@ -0,0 +1,38 @@
+# frozen string_literal: true
+
+require 'dry-types'
+
+module GameValidator
+  class Validator
+    class FullValidatorCoercer
+      def call(validator_hash)
+        Types::Hash.call(validator_hash) # throw exception if not given a hash
+        result = {}
+        validator_hash.each do |key, value|
+          if key.is_a?(Array)
+            if key.length != 2
+              raise Dry::Types::ConstraintError::new("Array keys must have two elements given #{key}", key)
+            end
+            if !key.first.is_a?(String) && !key.first.is_a?(Symbol)
+              raise Dry::Types::ConstraintError::new("first part of array key must be a String or Symbol, given #{key}", key)
+            end
+            if !key.last.eql?(true) && !key.last.eql?(false)
+              raise Dry::Types::ConstraintError::new("last part of array key must be a boolean, given #{key}", key)
+            end
+            result[["#{key.first}".freeze, key.last]] = Types.Interface(:call).call(value)
+          elsif key.is_a?(String) || key.is_a?(Symbol)
+            if key.length.eql?(0)
+              raise Dry::Types::ConstraintError::new('Empty String or Symbol key not permitted', key)
+            end
+            result[["#{key}".freeze, false]] = Types.Interface(:call).call(value)
+            result[["#{key}".freeze, true]] = Types.Interface(:call).call(value)
+          else
+            raise Dry::Types::ConstraintError::new('key must be a String, Symbol, or an Array', key)
+          end
+        end
+        result
+      end
+    end
+  end
+end
+

data/lib/game_validator/version.rb

@@ -1,3 +1,3 @@
 module GameValidator
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: game_validator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Colin Horner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,6 +143,7 @@ files:
 - lib/game_validator.rb
 - lib/game_validator/validator.rb
 - lib/game_validator/validator/base.rb
+- lib/game_validator/validator/full_validator_coercer.rb
 - lib/game_validator/validator/result.rb
 - lib/game_validator/validator/result/failure.rb
 - lib/game_validator/validator/result/failure/builder.rb