csstats 1.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7c268ffc0f969fd2c385d3d3f5ffb54ea1acb17
-  data.tar.gz: fcbe5fc8300570713f890c6c3f20084b5ca4b57f
+  metadata.gz: b6e7d60a406dbc4c07be6f28a230f6cd8609c509
+  data.tar.gz: f0a2a88fc14bd167cc7cc06400cbddaa316a9e56
 SHA512:
-  metadata.gz: f96bea67867c16803c117a0604104a6783e7d48be899842bbf6d86b95995b541547cd9c2c24103c263f752bf5159fe6a6c10f63d2f01051315948fbd0193038e
-  data.tar.gz: 2b0a039d59c8b378d90dfb97eccfa0d37195abe9fc2ffce97deec0375ecdb5f9ebb2ac7b2001ad97b3c8d6f480eca10379788fd6be0fa2ba2b30bde8c51b99c7
+  metadata.gz: 49e281f6effe3c0534b25f0e3f43430b399c726512a9eeb7105fa6f73425c99c220a68ae37260bb377e918833a853269e58507475f11ac860c90137226c910dd
+  data.tar.gz: 9453510b9dcb1b140243e4a0778b073e6339632a26fb12e7afad8d314190ccbb230b3720847e353a1ef236c6272b01428623194a9d0e763d7686bf0135396aed

data/.gitignore

@@ -12,6 +12,8 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/tmp
+spec/fixtures/tmp
 test/tmp
 test/version_tmp
 tmp

data/.hound.yml

@@ -0,0 +1,4 @@
+fail_on_violations: true
+
+ruby:
+  config_file: .rubocop.yml

data/.travis.yml

@@ -1,25 +1,20 @@
 sudo: false
+language: ruby
 
 before_install:
   - gem install bundler
 
 bundler_args: --without development
 
-language: ruby
-
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
   - 2.2.0
   - 2.3.0
   - ruby-head
-  - jruby-19mode
   - jruby-head
-  - rbx
 
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx

data/Gemfile

@@ -2,11 +2,19 @@ source 'https://rubygems.org'
 
 gem 'rake'
 
+group :development do
+  gem 'rubocop', '~> 0.44.1'
+end
+
+group :development, :test do
+  gem 'pry'
+end
+
 group :test do
-  gem 'codeclimate-test-reporter', require: false
-  gem 'coveralls', '~> 0.8.13', require: false
-  gem 'rspec',     '~> 3.4.0'
-  gem 'simplecov', '~> 0.11.2', require: false
+  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
 end
 
 gemspec

data/README.md

@@ -54,7 +54,6 @@ puts player_stats.kills
 This library aims to support and is [tested against][travis] the following Ruby
 implementations:
 
-* Ruby 1.9.3
 * Ruby 2.0.0
 * Ruby 2.1.0
 * Ruby 2.2.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'csstats'
+
+# 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

data/lib/csstats.rb

@@ -1,4 +1,6 @@
 require 'csstats/error'
+require 'csstats/parser'
+require 'csstats/writer'
 require 'csstats/handler'
 
 module CSstats

data/lib/csstats/handler.rb

@@ -1,8 +1,6 @@
-require 'hashie/mash'
-
 module CSstats
   class Handler
-    attr_reader :path, :players, :maxplayers
+    attr_reader :file_path, :max_players
 
     # Public: Initialize file.
     #
@@ -12,16 +10,10 @@ module CSstats
     #
     # Returns nothing.
     def initialize(options = {})
-      @path = options[:path]
-      @maxplayers = options[:maxplayers] || 0
-
-      @players = []
-      raise CSstats::FileNotExist unless File.exist?(path.to_s)
-
-      @file = File.new(path, 'r')
-      _file_version = read_short_data(@file)
+      @file_path = options[:path]
+      @max_players = options[:maxplayers] || 0
 
-      read_players!
+      raise CSstats::FileNotExist unless File.exist?(file_path.to_s)
     end
 
     # Public: Get the player information of specified id.
@@ -49,118 +41,10 @@ module CSstats
       players.find { |player| player.nick == name }
     end
 
-    private
-
-    def read_players!
-      i = 0
-      while !@file.eof? && (maxplayers == 0 || i < maxplayers)
-        player = read_player(@file)
-
-        if player
-          player['rank'] = i + 1
-          players[i] = player
-        end
-
-        i += 1
-      end
-    end
-
-    # Internal: Count player efficiency.
-    #
-    # kills  - The Integer of player kills in game.
-    # deaths - The Integer of player deaths in game.
-    #
-    # Returns The Float of player efficiency.
-    def count_efficiency(kills, deaths)
-      (kills.to_f / (kills.to_f + deaths.to_f) * 100).round(2)
-    end
-
-    # Internal: Count player accuracy.
-    #
-    # hits  - The Integer of player hits in game.
-    # shots - The Integer of player shots in game.
-    #
-    # Returns The Float of player accuracy.
-    def count_accuracy(hits, shots)
-      (hits.to_f / shots.to_f * 100).round(2)
-    end
-
-    # Internal: Read player information from file.
-    #
-    # handle - The File which was opened for reading data.
-    #
-    # Returns The Mash of player information.
-    def read_player(handle)
-      length = read_short_data(handle)
-      return if length == 0
-
-      player_data = Hashie::Mash.new
-
-      player_data.nick = read_string_data(handle, length)
-
-      add_player_uniq(player_data, handle)
-      add_player_general_data(player_data, handle)
-      add_player_calculations(player_data)
-
-      player_data
-    end
-
-    def add_player_uniq(player_data, handle)
-      length = read_short_data(handle)
-      player_data.uniq = read_string_data(handle, length)
-    end
-
-    def add_player_general_data(player_data, handle)
-      data_types = %w(teamkill damage deaths kills shots hits headshots
-                      defusions defused plants explosions - head chest stomach
-                      leftarm rightarm leftleg rightleg -)
-
-      data_types.each { |type| player_data[type] = read_int_data(handle) }
-
-      # Remove all 0x00000000
-      player_data.tap { |x| x.delete('-') }
-    end
-
-    def add_player_calculations(player_data)
-      player_data.acc = count_accuracy(player_data.hits, player_data.shots)
-      player_data.eff = count_efficiency(player_data.kills, player_data.deaths)
-    end
-
-    # Internal: Get the 32bit integer from file.
-    #
-    # handle - The File which was opened for reading data.
-    #
-    # Returns the Integer.
-    def read_int_data(handle)
-      data = handle.read(4)
-      raise CSstats::Error, 'Cannot read int data.' unless data
-
-      data.unpack('V').first
-    end
-
-    # Internal: Get the 16bit integer from file.
-    #
-    # handle - The File which was opened for reading data.
-    #
-    # Returns the Integer.
-    def read_short_data(handle)
-      data = handle.read(2)
-      raise CSstats::Error, 'Cannot read short data.' unless data
-
-      data.unpack('v').first
-    end
-
-    # Internal: Get the String from file.
-    #
-    # handle - The File which was opened for reading data.
-    # len    - The Integer length of string to read.
-    #
-    # Returns the String.
-    def read_string_data(handle, length)
-      data = handle.read(length)
-      raise CSstats::Error, 'Cannot read string data.' unless data
-
-      data.strip
+    def players
+      @players ||= CSstats::Parser::Players.new(
+        file_path, max_players: max_players
+      ).parse
     end
   end
 end

data/lib/csstats/parser.rb

@@ -0,0 +1,9 @@
+require_relative 'parser/file_reader/handler'
+require_relative 'parser/file_reader'
+require_relative 'parser/player'
+require_relative 'parser/players'
+
+module CSstats
+  module Parser
+  end
+end

data/lib/csstats/parser/file_reader.rb

@@ -0,0 +1,39 @@
+require_relative 'file_reader/handler'
+
+module CSstats
+  module Parser
+    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 = Handler.new(file).read_short_data
+
+        read_data(file, &block)
+
+        file.close
+      end
+
+      private
+
+      def read_data(file, &_block)
+        index = 0
+        while !file.eof? && (limit.zero? || index < limit)
+          yield(Handler.new(file), index)
+          index += 1
+        end
+      end
+    end
+  end
+end

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

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

data/lib/csstats/parser/player.rb

@@ -0,0 +1,82 @@
+require 'hashie/mash'
+
+module CSstats
+  module Parser
+    class Player
+      DATA_COLUMNS = %w(
+        teamkill damage deaths kills shots hits headshots defusions defused
+        plants explosions - head chest stomach leftarm rightarm leftleg
+        rightleg -
+      ).freeze
+
+      # Internal: Parse player information from file.
+      #
+      # handler - The File which was opened for reading data.
+      #
+      # Returns The Mash of player information.
+      def parse(handler)
+        length = handler.read_short_data
+        return if length.zero?
+
+        player_data = Hashie::Mash.new
+        player_data.nick = handler.read_string_data(length)
+
+        add_data(player_data, handler)
+
+        player_data
+      end
+
+      private
+
+      def add_data(player_data, handler)
+        add_uniq(player_data, handler)
+        add_general_data(player_data, handler)
+        add_calculations(player_data)
+      end
+
+      def add_uniq(player_data, handler)
+        length = handler.read_short_data
+        player_data.uniq = handler.read_string_data(length)
+      end
+
+      def add_general_data(player_data, handler)
+        DATA_COLUMNS.each { |type| player_data[type] = handler.read_int_data }
+
+        # Remove all 0x00000000
+        player_data.tap { |x| x.delete('-') }
+      end
+
+      def add_calculations(player_data)
+        player_data.acc = count_accuracy(player_data.hits, player_data.shots)
+        player_data.eff = count_efficiency(
+          player_data.kills, player_data.deaths
+        )
+      end
+
+      # Internal: Count player efficiency.
+      #
+      # kills  - The Integer of player kills in game.
+      # deaths - The Integer of player deaths in game.
+      #
+      # Returns The Float of player efficiency.
+      def count_efficiency(kills, deaths)
+        kills_and_deaths = kills.to_f + deaths.to_f
+        return 0.0 if kills_and_deaths.zero?
+
+        (kills.to_f / kills_and_deaths * 100).round(2)
+      end
+
+      # Internal: Count player accuracy.
+      #
+      # hits  - The Integer of player hits in game.
+      # shots - The Integer of player shots in game.
+      #
+      # Returns The Float of player accuracy.
+      def count_accuracy(hits, shots)
+        return 0.0 if shots.to_f.zero?
+
+        (hits.to_f / shots.to_f * 100).round(2)
+      end
+    end
+  end
+end

data/lib/csstats/parser/players.rb

@@ -0,0 +1,42 @@
+module CSstats
+  module Parser
+    class Players
+      attr_reader :file_path, :max_players
+
+      def initialize(file_path, options = {})
+        @file_path = file_path
+        @max_players = options[:max_players] || 0
+      end
+
+      def parse
+        players = []
+
+        file_reader.read do |handler, index|
+          parse_player(handler, index, players)
+        end
+
+        players
+      end
+
+      private
+
+      def parse_player(handler, index, players)
+        player = player_parser.parse(handler)
+        return unless player
+
+        player['rank'] = index + 1
+        players[index] = player
+      end
+
+      def player_parser
+        @player_parser ||= CSstats::Parser::Player.new
+      end
+
+      def file_reader
+        @file_reader ||= CSstats::Parser::FileReader.new(
+          file_path, limit: max_players
+        )
+      end
+    end
+  end
+end

data/lib/csstats/version.rb

@@ -1,3 +1,3 @@
 module CSstats
-  VERSION = '1.0.7'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/csstats/writer.rb

@@ -0,0 +1,8 @@
+require_relative 'writer/file_writer/handler'
+require_relative 'writer/player'
+require_relative 'writer/players'
+
+module CSstats
+  module Writer
+  end
+end

data/lib/csstats/writer/file_writer/handler.rb

@@ -0,0 +1,28 @@
+module CSstats
+  module Writer
+    class FileWriter
+      class Handler
+        attr_reader :handle
+
+        def initialize(handle)
+          @handle = handle
+        end
+
+        def write_int_data(int)
+          data = [int].pack('V')
+          handle.write(data)
+        end
+
+        def write_short_data(int)
+          data = [int].pack('v')
+          handle.write(data)
+        end
+
+        def write_string_data(string)
+          data = "#{string}\x00"
+          handle.write(data)
+        end
+      end
+    end
+  end
+end

data/lib/csstats/writer/player.rb

@@ -0,0 +1,39 @@
+module CSstats
+  module Writer
+    class Player
+      attr_reader :player
+
+      def initialize(player)
+        @player = player
+      end
+
+      def write(handler)
+        write_nick(handler)
+        write_uniq(handler)
+        write_general_data(handler)
+      end
+
+      private
+
+      def write_nick(handler)
+        handler.write_short_data(player.nick.length + 1)
+        handler.write_string_data(player.nick)
+      end
+
+      def write_uniq(handler)
+        handler.write_short_data(player.uniq.length + 1)
+        handler.write_string_data(player.uniq)
+      end
+
+      def write_general_data(handler)
+        CSstats::Parser::Player::DATA_COLUMNS.each do |type|
+          if type == '-'
+            handler.write_int_data(0)
+          else
+            handler.write_int_data(player[type])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/csstats/writer/players.rb

@@ -0,0 +1,24 @@
+module CSstats
+  module Writer
+    class Players
+      attr_reader :players
+
+      def initialize(players)
+        @players = players
+      end
+
+      def write(file_path)
+        file = File.new(file_path, 'w')
+        handler = CSstats::Writer::FileWriter::Handler.new(file)
+
+        handler.write_short_data(11) # File version
+
+        players.each do |player|
+          CSstats::Writer::Player.new(player).write(handler)
+        end
+
+        file.close
+      end
+    end
+  end
+end

data/spec/csstats/parser/player_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe CSstats::Parser::Player do
+  let(:file_stream) { File.new(csstats_file) }
+  let(:handler) { CSstats::Parser::FileReader::Handler.new(file_stream) }
+  subject { described_class.new }
+  let(:player_data) { subject.parse(handler) }
+
+  before do
+    # We need to read first bytes, because it's file version.
+    handler.read_short_data
+  end
+
+  it 'has correct acc' do
+    expect(player_data.acc).to eq(24.3)
+  end
+end

data/spec/csstats/writer/players_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe CSstats::Writer::Players do
+  let(:old_players) { CSstats::Handler.new(path: csstats_file).players }
+  let(:file_path) { tmp_file('test.dat') }
+  let(:new_players) { CSstats::Handler.new(path: file_path).players }
+
+  it 'has correct players count in main file' do
+    expect(old_players.length).to eq(208)
+  end
+
+  context 'new file' do
+    before do
+      CSstats::Writer::Players.new(old_players).write(file_path)
+    end
+
+    it 'has correct players count' do
+      CSstats::Writer::Players.new(old_players).write(file_path)
+      expect(new_players.length).to eq(208)
+    end
+
+    it 'has same players data' do
+      expect(old_players).to eq(new_players)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -20,6 +20,15 @@ RSpec.configure do |config|
 end
 
 def csstats_file
+  fixture_file('csstats.dat')
+end
+
+def fixture_file(filename)
   fixtures = File.expand_path('../fixtures', __FILE__)
-  File.new(fixtures + '/csstats.dat').path
+  File.join(fixtures, filename)
+end
+
+def tmp_file(filename)
+  tmps = File.expand_path('../tmp', __FILE__)
+  File.join(tmps, filename)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csstats
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
 platform: ruby
 authors:
 - Justas Palumickas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-16 00:00:00.000000000 Z
+date: 2016-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -41,11 +41,13 @@ dependencies:
 description: Gem which handle csstats.dat file generated by CSX module in AMX Mod
   X (http://www.amxmodx.org/)
 email: jpalumickas@gmail.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -54,15 +56,28 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/console
 - csstats.gemspec
 - lib/csstats.rb
 - lib/csstats/error.rb
 - lib/csstats/handler.rb
+- lib/csstats/parser.rb
+- lib/csstats/parser/file_reader.rb
+- lib/csstats/parser/file_reader/handler.rb
+- lib/csstats/parser/player.rb
+- lib/csstats/parser/players.rb
 - lib/csstats/version.rb
+- lib/csstats/writer.rb
+- lib/csstats/writer/file_writer/handler.rb
+- lib/csstats/writer/player.rb
+- lib/csstats/writer/players.rb
 - spec/csstats/handler_spec.rb
+- spec/csstats/parser/player_spec.rb
+- spec/csstats/writer/players_spec.rb
 - spec/csstats_spec.rb
 - spec/fixtures/csstats.dat
 - spec/spec_helper.rb
+- spec/tmp/.keep
 homepage: https://github.com/jpalumickas/csstats/
 licenses:
 - MIT
@@ -89,6 +104,9 @@ specification_version: 4
 summary: ''
 test_files:
 - spec/csstats/handler_spec.rb
+- spec/csstats/parser/player_spec.rb
+- spec/csstats/writer/players_spec.rb
 - spec/csstats_spec.rb
 - spec/fixtures/csstats.dat
 - spec/spec_helper.rb
+- spec/tmp/.keep