csstats 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b6e7d60a406dbc4c07be6f28a230f6cd8609c509
-  data.tar.gz: f0a2a88fc14bd167cc7cc06400cbddaa316a9e56
+SHA256:
+  metadata.gz: eea82615b3acd8120d7a37421c4a8dc927d7fb287b87dc7114398081bb37c6ed
+  data.tar.gz: 06f4df73a2c9be3f1f966c5b92db657c635741b2ebfd6d31940a917777e9bc99
 SHA512:
-  metadata.gz: 49e281f6effe3c0534b25f0e3f43430b399c726512a9eeb7105fa6f73425c99c220a68ae37260bb377e918833a853269e58507475f11ac860c90137226c910dd
-  data.tar.gz: 9453510b9dcb1b140243e4a0778b073e6339632a26fb12e7afad8d314190ccbb230b3720847e353a1ef236c6272b01428623194a9d0e763d7686bf0135396aed
+  metadata.gz: d6209408d58fcf60f9f4627f85f8f9a1683b059e3cdfe1501bf10ab740d6a1ff742d1a2587564314a690476719608fd9ce9bba902016d33308399abc816c5b32
+  data.tar.gz: 6adbfb5ebf1396f25b0e50741b4591381332701c8de674e759f738e11c6605716c4a57897b950fe1f364035a96042053a7bb00f7e2f38755098e6c3981f05d64

data/.rubocop.yml

@@ -1,2 +1,35 @@
+AllCops:
+  TargetRubyVersion: 2.1
+  Include:
+    - '**/Rakefile'
+    - '**/Gemfile'
+
+Layout/AlignParameters:
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
+
+Layout/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/CaseIndentation:
+  Enabled: true
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'

data/.travis.yml

@@ -1,20 +1,36 @@
 sudo: false
-language: ruby
+bundler_args: --without development
 
-before_install:
-  - gem install bundler
+cache:
+  bundler: true
 
-bundler_args: --without development
+env:
+  global:
+    - CC_TEST_REPORTER_ID=b17eed44b7f9100d09d50eb58b2b4e7272022e7245676d04dd30378f69eba6dd
 
+language: ruby
 rvm:
-  - 2.0.0
   - 2.1.0
   - 2.2.0
   - 2.3.0
+  - 2.4.0
+  - 2.5.0
   - ruby-head
-  - jruby-head
+
+before_install:
+  - gem update --system
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script:
+  - bundle exec rspec
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-head

data/Gemfile

@@ -1,9 +1,7 @@
 source 'https://rubygems.org'
 
-gem 'rake'
-
 group :development do
-  gem 'rubocop', '~> 0.44.1'
+  gem 'rubocop', '~> 0.53'
 end
 
 group :development, :test do
@@ -11,10 +9,8 @@ group :development, :test do
 end
 
 group :test do
-  gem 'codeclimate-test-reporter', '~> 0.6.0', require: false
-  gem 'coveralls', '~> 0.8.15', require: false
-  gem 'rspec',     '~> 3.5.0'
-  gem 'simplecov', '~> 0.12.0', require: false
+  gem 'rspec', '~> 3.7'
+  gem 'simplecov', '~> 0.15', require: false
 end
 
 gemspec

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 Justas Palumickas
+Copyright (c) 2018 Justas Palumickas
 
 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

@@ -3,8 +3,8 @@
 [![Gem Version](https://img.shields.io/gem/v/csstats.svg?style=flat-square)][rubygems]
 [![Build Status](https://img.shields.io/travis/jpalumickas/csstats.svg?style=flat-square)][travis]
 [![Dependency Status](https://img.shields.io/gemnasium/jpalumickas/csstats.svg?style=flat-square)][gemnasium]
-[![Coverage Status](https://img.shields.io/coveralls/jpalumickas/csstats.svg?branch=master&style=flat-square)][coveralls]
-[![Code Climate](https://img.shields.io/codeclimate/github/jpalumickas/csstats.svg?style=flat-square)][codeclimate]
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/jpalumickas/csstats.svg?style=flat-square)][codeclimate]
+[![Test Coverage](https://img.shields.io/codeclimate/c/jpalumickas/csstats.svg?style=flat-square)][codeclimate_coverage]
 
 Gem which handle `csstats.dat` file generated by CSX module
 in AMX Mod X ([http://www.amxmodx.org/][amxx])
@@ -29,14 +29,14 @@ Or install it yourself as:
 require 'csstats'
 
 stats = CSstats.new(path: 'csstats.dat')
-stats.player(2).nick
+stats.players.find(2).nick
 ```
 
-You can set maxplayers value if you need to get specified number of players.
+You can set `max_players` option if you need to get specified number of players.
 
 ```ruby
-stats = CSstats.new(path: 'csstats.dat', maxplayers: 15)
-stats.players_count
+stats = CSstats.new(path: 'csstats.dat', max_players: 15)
+stats.players.count
  # => 15
 ```
 
@@ -44,9 +44,10 @@ You can get player information by specified name.
 
 ```ruby
 stats = CSstats.new(path: 'csstats.dat')
-player_stats = stats.search_by_name('nick')
+player_stats = stats.players.find_by(nick: 'my-super-nick')
 
 puts player_stats.kills
+  # => 3
 ```
 
 ## Supported Ruby Versions
@@ -54,13 +55,14 @@ puts player_stats.kills
 This library aims to support and is [tested against][travis] the following Ruby
 implementations:
 
-* Ruby 2.0.0
 * Ruby 2.1.0
 * Ruby 2.2.0
 * Ruby 2.3.0
+* Ruby 2.4.0
+* Ruby 2.5.0
 
 ## Copyright
-Copyright (c) 2013-2016 Justas Palumickas.
+Copyright (c) 2013-2018 Justas Palumickas.
 See [LICENSE][license] for details.
 
 [rubygems]: https://rubygems.org/gems/csstats
@@ -68,6 +70,7 @@ See [LICENSE][license] for details.
 [gemnasium]: https://gemnasium.com/jpalumickas/csstats
 [coveralls]: https://coveralls.io/r/jpalumickas/csstats
 [codeclimate]: https://codeclimate.com/github/jpalumickas/csstats
+[codeclimate_coverage]: https://codeclimate.com/github/jpalumickas/csstats/test_coverage
 
 [amxx]: http://www.amxmodx.org/
 [license]: https://raw.githubusercontent.com/jpalumickas/csstats/master/LICENSE

data/bin/console

@@ -7,7 +7,7 @@ require 'csstats'
 # 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"
+require 'pry'
 Pry.start
 
 # require 'irb'

data/csstats.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'csstats/version'
 
@@ -14,7 +13,7 @@ Gem::Specification.new do |gem|
                     ' module in AMX Mod X (http://www.amxmodx.org/)'
 
   gem.license = 'MIT'
-  gem.required_ruby_version = '>= 1.9.2'
+  gem.required_ruby_version = '>= 2.1.0'
 
   gem.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables = gem.files.grep(%r{^bin\/}).map { |f| File.basename(f) }
@@ -22,5 +21,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'hashie', '~> 3.4'
-  gem.add_development_dependency 'bundler', '~> 1.6'
+  gem.add_development_dependency 'bundler', '~> 1.16'
 end

data/lib/csstats.rb

@@ -1,13 +1,15 @@
+require 'csstats/columns'
 require 'csstats/error'
+require 'csstats/player'
 require 'csstats/parser'
-require 'csstats/writer'
-require 'csstats/handler'
+require 'csstats/client'
+require 'csstats/players'
 
 module CSstats
   # Alias for CSstats::Handler.new
   #
   # Returns CSstats::Handler
   def self.new(options = {})
-    CSstats::Handler.new(options)
+    CSstats::Client.new(options)
   end
 end

data/lib/csstats/client.rb

@@ -0,0 +1,23 @@
+module CSstats
+  class Client
+    attr_reader :file_path, :max_players
+
+    # Public: Initialize file.
+    #
+    # options - The Hash options:
+    #   :path        - The String of csstats.dat file path (required).
+    #   :max_players - The Integer of how many players to return (optional).
+    #
+    # Returns nothing.
+    def initialize(options = {})
+      @file_path = options[:path]
+      @max_players = options[:max_players] || 0
+
+      raise CSstats::FileNotExist unless File.exist?(file_path.to_s)
+    end
+
+    def players
+      @players ||= CSstats::Players.new(self)
+    end
+  end
+end

data/lib/csstats/columns.rb

@@ -0,0 +1,28 @@
+module CSstats
+  COLUMNS = [
+    { name: :nick, type: :string },
+    { name: :uniq, type: :string },
+    { name: :teamkill, type: :integer },
+    { name: :damage, type: :integer },
+    { name: :deaths, type: :integer },
+    { name: :kills, type: :integer },
+    { name: :shots, type: :integer },
+    { name: :hits, type: :integer },
+    { name: :headshots, type: :integer },
+    { name: :defusions, type: :integer },
+    { name: :defused, type: :integer },
+    { name: :plants, type: :integer },
+    { name: :explosions, type: :integer },
+    {}, # Empty
+    { name: :head, type: :integer },
+    { name: :chest, type: :integer },
+    { name: :stomach, type: :integer },
+    { name: :leftarm, type: :integer },
+    { name: :rightarm, type: :integer },
+    { name: :leftleg, type: :integer },
+    { name: :rightleg, type: :integer },
+    {} # Empty
+  ].freeze
+
+  COLUMN_KEYS = COLUMNS.reject(&:empty?).flat_map { |column| column[:name] }
+end

data/lib/csstats/parser.rb

@@ -1,9 +1,18 @@
-require_relative 'parser/file_reader/handler'
-require_relative 'parser/file_reader'
-require_relative 'parser/player'
-require_relative 'parser/players'
+require_relative 'parser/reader'
+require_relative 'parser/writer'
 
 module CSstats
   module Parser
+    class << self
+      def get_players(client)
+        CSstats::Parser::Reader::Players.new(
+          client.file_path, max_players: client.max_players
+        ).parse
+      end
+
+      def write_players(client, players)
+        CSstats::Parser::Writer::Players.new(client.file_path).write(players)
+      end
+    end
   end
 end

data/lib/csstats/parser/reader.rb

@@ -0,0 +1,11 @@
+require_relative 'reader/file_streamer'
+require_relative 'reader/file_reader'
+require_relative 'reader/player'
+require_relative 'reader/players'
+
+module CSstats
+  module Parser
+    module Reader
+    end
+  end
+end

data/lib/csstats/parser/reader/file_reader.rb

@@ -0,0 +1,45 @@
+require_relative 'file_streamer'
+
+module CSstats
+  module Parser
+    module Reader
+      class FileReader
+        attr_reader :file_path, :limit
+
+        def initialize(file_path, options = {})
+          @file_path = file_path
+          @limit = options[:limit] || 0
+
+          raise CSstats::FileNotExist unless File.exist?(file_path.to_s)
+        end
+
+        def read(&block)
+          return unless block_given?
+
+          file = File.new(file_path, 'r')
+
+          # Need to read first data, which means file version.
+          _file_version = streamer(file).read_short_data
+
+          read_data(file, &block)
+
+          file.close
+        end
+
+        private
+
+        def streamer(file)
+          CSstats::Parser::Reader::FileStreamer.new(file)
+        end
+
+        def read_data(file, &_block)
+          index = 0
+          while !file.eof? && (limit.zero? || index < limit)
+            yield(streamer(file), index)
+            index += 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/csstats/parser/{file_reader/handler.rb → reader/file_streamer.rb}

@@ -1,18 +1,18 @@
 module CSstats
   module Parser
-    class FileReader
-      class Handler
-        attr_reader :handle
+    module Reader
+      class FileStreamer
+        attr_reader :stream
 
-        def initialize(handle)
-          @handle = handle
+        def initialize(stream)
+          @stream = stream
         end
 
         # Internal: Get the 32bit integer from file.
         #
         # Returns the Integer.
         def read_int_data
-          data = handle.read(4)
+          data = stream.read(4)
           raise CSstats::Error, 'Cannot read int data.' unless data
 
           data.unpack('V').first
@@ -22,7 +22,7 @@ module CSstats
         #
         # Returns the Integer.
         def read_short_data
-          data = handle.read(2)
+          data = stream.read(2)
           raise CSstats::Error, 'Cannot read short data.' unless data
 
           data.unpack('v').first
@@ -34,7 +34,7 @@ module CSstats
         #
         # Returns the String.
         def read_string_data(length)
-          data = handle.read(length)
+          data = stream.read(length)
           raise CSstats::Error, 'Cannot read string data.' unless data
 
           data.strip

data/lib/csstats/parser/reader/player.rb

@@ -0,0 +1,41 @@
+module CSstats
+  module Parser
+    module Reader
+      class Player
+        attr_reader :stream
+
+        def initialize(stream)
+          @stream = stream
+        end
+
+        def parse
+          player = CSstats::Player.new
+          parse_columns(player)
+          return unless player.nick
+          player
+        end
+
+        private
+
+        def parse_columns(player)
+          CSstats::COLUMNS.each do |column|
+            next parse_integer if column.empty?
+
+            data = send("parse_#{column[:type]}") || break
+            player.send("#{column[:name]}=", data)
+          end
+        end
+
+        def parse_string
+          length = stream.read_short_data
+          return if length.zero?
+          stream.read_string_data(length)
+        end
+
+        def parse_integer
+          stream.read_int_data
+        end
+      end
+    end
+  end
+end