ai_games-parser 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5b41a1a1e251dcd3c7658f53b2bfd67fb7bb7b6
-  data.tar.gz: 98a93a6bc74c86b847ee4ec2a4b3494d8f33cfa4
+  metadata.gz: 104e313efe3bb5652763cac019387c01c317ea19
+  data.tar.gz: 45d018cea9e91843c1a01d79cf61d19276de1e7b
 SHA512:
-  metadata.gz: 438b3eb049af5df64296331270d331ecfcf9f1a8e210f9a80c86ea84a602aae4a5acd31b56ad9e3cc7327b7473ec972d4249918d309c3a1efb5897328517478a
-  data.tar.gz: 07a2bd52130a50a9432cc632871b516c06ce899ebd4e6ac81c12d553b4a815efef7be4b9f47008326aa08fa6914aa6d9419007e576be85c409b5c759a8c62a06
+  metadata.gz: 093861ab9761b09a16508d6000df2cab157ebce6d2320e4f3f09fa3d86e2eba09ecbc1499687a08887a462006a2a3dd9704ffb07620721b886d2011f74165a4e
+  data.tar.gz: ac727de7853114168711c4422872ae6f20175de53d842b4dcc2daa4f74784d89bed2a3b552787be303382c2b13f832a82291eb8c17a62dc82a667452687b14df

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- bin/

data/.rubocop.yml

@@ -1,6 +1,3 @@
 AllCops:
   Exclude:
     - 'bin/**/*'
-
-Style/Documentation:
-  Enabled: false

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.1.0
-before_install: gem install bundler -v 1.10.6
+  - 2.3.0
+before_install: gem install bundler

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ai_games-parser.gemspec
 gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Jan David Nose
+Copyright (c) 2016 Jan David Nose
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,9 @@
 # AIGames::Parser
 
+[![Build Status](https://travis-ci.org/jdno/ai_games-parser.svg?branch=develop)](https://travis-ci.org/jdno/ai_games-parser)
+[![Code Climate](https://codeclimate.com/github/jdno/ai_games-parser/badges/gpa.svg)](https://codeclimate.com/github/jdno/ai_games-parser)
+[![Test Coverage](https://codeclimate.com/github/jdno/ai_games-parser/badges/coverage.svg)](https://codeclimate.com/github/jdno/ai_games-parser/coverage)
+
 This gem provides a parser that can be used to communicate with the game engine
 in The AI Games' competitions. By extending it, the parser can be customized to
 work in any competition.
@@ -22,7 +26,9 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The gem provides an abstract parser in `AIGames::Parser`. Extend this class, and
+overwrite the method `parse(command_array)` to customize your parser for the
+specific challenge.
 
 ## Development
 
@@ -39,5 +45,22 @@ the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the
-[MIT License](http://opensource.org/licenses/MIT).
+Copyright (c) 2016 [Jan David Nose](https://github.com)
+
+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/ai_games-parser.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ai_games/parser/version'
+require 'ai_games/parser'
 
 Gem::Specification.new do |spec|
   spec.name          = 'ai_games-parser'

data/lib/ai_games/parser.rb

@@ -1,7 +1,83 @@
-require 'ai_games/parser/version'
-
 module AIGames
-  module Parser
-    # Your code goes here...
+  # This class provides an abstract parser that can be extended to implement
+  # the logic that is required for a specific competition. It provides methods
+  # to communicate with the game engine, but does NOT contain any logic how to
+  # parse the engine's commands. This is totally up to the implementations of
+  # this class.
+  class Parser
+    VERSION = '0.3.0'
+
+    # Initializes the parser. Pass in options using a hash structure.
+    def initialize(options = nil)
+      initialize_streams options if options
+    end
+
+    # Starts the main loop. This loop runs until the game engine closes the
+    # console line. During the loop, the parser reads from the game engine,
+    # sanitizes the input a little bit, and then passes it to a method that
+    # needs to be overwritten by parsers extending this interface.
+    def run
+      AIGames::Logger.info 'Parser.run : Starting loop'
+
+      loop do
+        command = read_from_engine
+        break if command.nil?
+
+        command.strip!
+        next if command.length == 0
+
+        response = parse split_line command
+        write_to_engine response unless response.nil? || response.length < 1
+      end
+
+      AIGames::Logger.info 'Parser.run : Stopping loop'
+    end
+
+    # Parses the given command array. This method MUST return a valid response
+    # string that can be send to the engine.
+    # rubocop:disable Lint/UnusedMethodArgument
+    def parse(command_array)
+      fail 'Method must be overwritten'
+    end
+    # rubocop:enable Lint/UnusedMethodArgument
+
+    private
+
+    # Initializes the input and output streams that the parser uses. The
+    # expected format for the options is a hash with the keys `:input` and
+    # `:output`. Use this to mock `STDIN` and `STDOUT` for tests.
+    def initialize_streams(options)
+      @input = options[:input] if options.key? :input
+      @output = options[:output] if options.key? :output
+    end
+
+    # Returns the input stream. If no stream has been configured, $stdin is
+    # returned.
+    def input
+      @input ||= $stdin
+    end
+
+    # Returns the output stream. If no stream has been configured, $stdout is
+    # returned.
+    def output
+      @output ||= $stdout
+    end
+
+    # Reads from the input stream.
+    def read_from_engine
+      input.gets
+    end
+
+    # Writes to the output stream.
+    def write_to_engine(string)
+      output.puts string
+      output.flush
+    end
+
+    # Formats a command line for further processing. The input is split at the
+    # whitespace character, and all its parts are converted to downcase.
+    def split_line(line)
+      line.split(' ').map(&:downcase)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ai_games-parser
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jan David Nose
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ai_games-logger
@@ -90,6 +90,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -102,8 +103,6 @@ files:
 - bin/console
 - bin/setup
 - lib/ai_games/parser.rb
-- lib/ai_games/parser/abstract_parser.rb
-- lib/ai_games/parser/version.rb
 homepage: https://github.com/jdno/ai_games-parser
 licenses:
 - MIT
@@ -124,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Skeleton for a parser for The AI Games' competitions

data/lib/ai_games/parser/abstract_parser.rb

@@ -1,104 +0,0 @@
-# Copyright (c) 2015 Jan David Nose
-#
-# 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.
-require 'ai_games/logger'
-
-module AIGames
-  module Parser
-    # This class provides an abstract parser that can be extended to implement
-    # the logic that is required for a specific competition. It provides methods
-    # to communicate with the game engine, but does NOT contain any logic how to
-    # parse the engine's commands. This is totally up to the implementations of
-    # this class.
-    class AbstractParser
-      # Initializes the parser. Pass in options using a hash structure.
-      def initialize(options = nil)
-        initialize_streams options if options
-      end
-
-      # Starts the main loop. This loop runs until the game engine closes the
-      # console line. During the loop, the parser reads from the game engine,
-      # sanitizes the input a little bit, and then passes it to a method that
-      # needs to be overwritten by parsers extending this interface.
-      def run
-        AIGames::Logger.info 'Parser.run : Starting loop'
-
-        loop do
-          command = read_from_engine
-          break if command.nil?
-
-          command.strip!
-          next if command.length == 0
-
-          response = parse split_line command
-          write_to_engine response unless response.nil? || response.length < 1
-        end
-
-        AIGames::Logger.info 'Parser.run : Stopping loop'
-      end
-
-      # Parses the given command array. This method MUST return a valid response
-      # string that can be send to the engine.
-      # rubocop:disable Lint/UnusedMethodArgument
-      def parse(command_array)
-        fail 'Method must be overwritten'
-      end
-      # rubocop:enable Lint/UnusedMethodArgument
-
-      private
-
-      # Initializes the input and output streams that the parser uses. The
-      # expected format for the options is a hash with the keys `:input` and
-      # `:output`. Use this to mock `STDIN` and `STDOUT` for tests.
-      def initialize_streams(options)
-        @input = options[:input] if options.key? :input
-        @output = options[:output] if options.key? :output
-      end
-
-      # Returns the input stream. If no stream has been configured, $stdin is
-      # returned.
-      def input
-        @input ||= $stdin
-      end
-
-      # Returns the output stream. If no stream has been configured, $stdout is
-      # returned.
-      def output
-        @output ||= $stdout
-      end
-
-      # Reads from the input stream.
-      def read_from_engine
-        input.gets
-      end
-
-      # Writes to the output stream.
-      def write_to_engine(string)
-        output.puts string
-        output.flush
-      end
-
-      # Formats a command line for further processing. The input is split at the
-      # whitespace character, and all its parts are converted to downcase.
-      def split_line(line)
-        line.split(' ').map(&:downcase)
-      end
-    end
-  end
-end

data/lib/ai_games/parser/version.rb

@@ -1,5 +0,0 @@
-module AIGames
-  module Parser
-    VERSION = '0.2.1'
-  end
-end