csstats 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9065ccdcb64130e7cccf2af1c3abfdd313991478
-  data.tar.gz: d814405281dbabd4d3bc638ff5f759927b60bfd9
+  metadata.gz: 9da3fbfae32bbf6cae85ac94caf59a66fb9fb4f8
+  data.tar.gz: 76547cef1effba619c15eded091132196cafe537
 SHA512:
-  metadata.gz: e97ce568ccb03bd622e5d354f5ca5f97e8bf2cfa83975f5e1361e92b30f141de711fe17b5a8873fb69da1d73d5b41d34dbc1a4d2135912abfd6a44aefb804532
-  data.tar.gz: 224d61e39d3cc63c63c1be20b054ed892f568d399a5412a886eae3eb15b92beea9fc96cacad7088a27e1d0dade71612dcc8eb0ca856285f695906c910828e712
+  metadata.gz: a9d31ba0a0059ad47e1d0bf66f7377b29edba4266151c2402cc886dc9690c3beac93aa002e2d3db8e5de0606b84729fd9bf543a5c0bb601da44eb9de78323f54
+  data.tar.gz: e533af087daa8172936c493196263c9f0264dac75966af80e4e3a1ea1ceb33868769106c7fd12991c336ef4a2b34229133762a20cb1cbecf021cf540aeadd164

data/Gemfile

@@ -3,8 +3,9 @@ source 'https://rubygems.org'
 gem 'rake'
 
 group :test do
+  gem 'coveralls', require: false
   gem 'rspec', '>= 2.13'
-  gem 'simplecov', :require => false
+  gem 'simplecov', require: false
 end
 
 gemspec

data/README.md

@@ -3,8 +3,10 @@
 Gem which handle csstats.dat file generated by CSX module
 in AMX Mod X ([http://www.amxmodx.org/][amxx])
 
+[![Gem Version](https://badge.fury.io/rb/csstats.png)][rubygems]
 [![Build Status](https://secure.travis-ci.org/jpalumickas/csstats.png?branch=master)][travis]
 [![Dependency Status](https://gemnasium.com/jpalumickas/csstats.png?travis)][gemnasium]
+[![Coverage Status](https://coveralls.io/repos/jpalumickas/csstats/badge.png?branch=master)][coveralls]
 
 ## Installation
 
@@ -24,6 +26,17 @@ Or install it yourself as:
 
 ```ruby
 require 'csstats'
+
+stats = CSstats.new(path: 'csstats.dat')
+stats.player(2).nick
+```
+
+You can set maxplayers value if you need to get specified number of players.
+
+```ruby
+stats = CSstats.new(path: 'csstats.dat', maxplayers: 15)
+stats.players_count
+ # => 15
 ```
 
 ## Supported Ruby Versions
@@ -42,6 +55,7 @@ See [LICENSE][] for details.
 [rubygems]: https://rubygems.org/gems/csstats
 [travis]: http://travis-ci.org/jpalumickas/csstats
 [gemnasium]: https://gemnasium.com/jpalumickas/csstats
+[coveralls]: https://coveralls.io/r/jpalumickas/csstats
 
 [amxx]: http://www.amxmodx.org/
 [license]: LICENSE.md

data/lib/csstats.rb

@@ -1,8 +1,12 @@
+require 'csstats/error'
 require 'csstats/handler'
 
 module CSstats
   class << self
 
+    # Alias for CSstats::Handler.new
+    #
+    # Returns CSstats::Handler
     def new(options={})
       CSstats::Handler.new(options)
     end

data/lib/csstats/error.rb

@@ -0,0 +1,3 @@
+module CSstats
+  class Error < StandardError; end
+end

data/lib/csstats/handler.rb

@@ -4,6 +4,13 @@ module CSstats
   class Handler
     attr_accessor :path, :players, :fileversion, :position
 
+    # Initialize file.
+    #
+    # Options:
+    #   path - The String of csstats.dat file.
+    #   maxplayers - The Integer of how many players to return.
+    #
+    # Returns nothing.
     def initialize(options={})
       @path = options[:path]
       @players = []
@@ -17,89 +24,126 @@ module CSstats
 
       @fileversion = read_short_data(handle);
 
-      i = 1
-      while (!handle.eof? && (maxplayers == 0 || i <= maxplayers))
+      i = 0
+      while (!handle.eof? && (maxplayers == 0 || i < maxplayers))
         player = read_player(handle)
         if player
-          player['rank'] = i
+          player['rank'] = i+1
           players[i] = player
         end
         i = i + 1
       end
     end
 
+    # Read player information from file.
+    #
+    # handle - The File which was opened for reading data.
+    #
+    # Returns The Hash (Mash) of player information.
     def read_player(handle)
-      p = Hashie::Mash.new
+      hash = Hashie::Mash.new
       l = read_short_data(handle);
 
       return nil if (l == 0)
 
-      p['nick'] = read_string_data(handle, l)
+      hash['nick'] = read_string_data(handle, l)
       l = read_short_data(handle)
-      p['uniq'] = read_string_data(handle, l)
+      hash['uniq'] = read_string_data(handle, l)
 
-      p['teamkill'] = read_int_data(handle)
-      p['damage'] = read_int_data(handle)
-      p['deaths'] = read_int_data(handle)
-      p['kills'] = read_int_data(handle)
-      p['shots'] = read_int_data(handle)
-      p['hits'] = read_int_data(handle)
-      p['headshots'] = read_int_data(handle)
+      hash['teamkill'] = read_int_data(handle)
+      hash['damage'] = read_int_data(handle)
+      hash['deaths'] = read_int_data(handle)
+      hash['kills'] = read_int_data(handle)
+      hash['shots'] = read_int_data(handle)
+      hash['hits'] = read_int_data(handle)
+      hash['headshots'] = read_int_data(handle)
 
-      p['defusions'] = read_int_data(handle)
-      p['defused'] = read_int_data(handle)
-      p['plants'] = read_int_data(handle)
-      p['explosions'] = read_int_data(handle)
+      hash['defusions'] = read_int_data(handle)
+      hash['defused'] = read_int_data(handle)
+      hash['plants'] = read_int_data(handle)
+      hash['explosions'] = read_int_data(handle)
 
       read_int_data(handle) # 0x00000000
 
-      p['head'] = read_int_data(handle)
-      p['chest'] = read_int_data(handle)
-      p['stomach'] = read_int_data(handle)
-      p['leftarm'] = read_int_data(handle)
-      p['rightarm'] = read_int_data(handle)
-      p['leftleg'] = read_int_data(handle)
-      p['rightleg'] = read_int_data(handle)
+      hash['head'] = read_int_data(handle)
+      hash['chest'] = read_int_data(handle)
+      hash['stomach'] = read_int_data(handle)
+      hash['leftarm'] = read_int_data(handle)
+      hash['rightarm'] = read_int_data(handle)
+      hash['leftleg'] = read_int_data(handle)
+      hash['rightleg'] = read_int_data(handle)
 
       read_int_data(handle) # 0x00000000
 
-      return p
+      return hash
     end
 
+    # Get the 32bit integer from file.
+    #
+    # handle - The File which was opened for reading data.
+    #
+    # Returns the integer.
     def read_int_data(handle)
-      #f = File.new(handle)
-      d  = handle.read(4)
-      d = d.unpack("V")
-      return d[0]
+      data = handle.read(4)
+      raise CSstats::Error, "Cannot read int data." unless data
+      data = data.unpack("V")
+      return data.first
     end
 
+    # Get the 16bit integer from file.
+    #
+    # handle - The File which was opened for reading data.
+    #
+    # Returns the integer.
     def read_short_data(handle)
-      #f = File.new(handle)
-      d  = handle.read(2)
-      #if ($d === false)
-      #  throw new CSstatsException("Can not read data.");
-      d = d.unpack("v")
-      return d[0]
+      data = handle.read(2)
+      raise CSstats::Error, "Cannot read short data." unless data
+      data = data.unpack("v")
+      return data.first
     end
 
-    def read_string_data(handle, len)
-      d  = handle.read(len)
-      #if ($d === false)
-      #  throw new CSstatsException("Can not read data.");
-      d = d.strip
-      return d
+    # Get the string from file.
+    #
+    # handle - The File which was opened for reading data.
+    # len - 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 = data.strip
+      return data
     end
 
+    # Get the player information of specified id.
+    #
+    # id - The Integer of player id.
+    #
+    # Returns the Hash of player information.
     def player(id)
-      unless (@players[id].nil?)
-        @players[id]
+      unless (@players[id-1].nil?)
+        @players[id-1]
       else
         nil
       end
     end
 
+    # Get total players count.
+    #
+    # Returns the Integer of player count.
     def players_count
-      @players.count - 1
+      @players.count
+    end
+
+    # Get player by specified name.
+    #
+    # name - The String of player name.
+    #
+    # Returns the Hash of player information.
+    def search_by_name(name)
+      @players.each do |player|
+        return player if (name == player.nick)
+      end
     end
   end
 end

data/lib/csstats/version.rb

@@ -1,3 +1,3 @@
 module CSstats
-  VERSION = "0.2.0" unless defined?(CSstats::VERSION)
+  VERSION = "1.0.0" unless defined?(CSstats::VERSION)
 end

data/spec/csstats/handler_spec.rb

@@ -14,4 +14,9 @@ describe CSstats::Handler do
     expect(@handler.player(2).nick).to eq "CHMARSON"
   end
 
+  it "should return searched player" do
+    player = @handler.search_by_name("CHMARSON")
+    expect(player.nick).to eq "CHMARSON"
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,7 +1,9 @@
 require 'simplecov'
+require 'coveralls'
 
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
 ]
 SimpleCov.start
 
@@ -14,14 +16,7 @@ RSpec.configure do |config|
   end
 end
 
-def fixture_path
-  File.expand_path("../fixtures", __FILE__)
-end
-
-def fixture(file)
-  File.new(fixture_path + '/' + file)
-end
-
 def csstats_file
-  fixture('csstats.dat').path
+  fixtures = File.expand_path("../fixtures", __FILE__)
+  File.new(fixtures + '/csstats.dat').path
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csstats
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Justas Palumickas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-15 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,6 +56,7 @@ files:
 - Rakefile
 - csstats.gemspec
 - lib/csstats.rb
+- lib/csstats/error.rb
 - lib/csstats/handler.rb
 - lib/csstats/version.rb
 - spec/csstats/handler_spec.rb