demoman 2.0.1 → 2.0.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: bundle exec rake
+before_install:
+  - gem update --system

data/README.md

@@ -1,5 +1,10 @@
 # demoman
 
+
+[![Build Status](https://travis-ci.org/webdestroya/demoman.png)](https://travis-ci.org/webdestroya/demoman)
+[![Code Climate](https://codeclimate.com/github/webdestroya/demoman.png)](https://codeclimate.com/github/webdestroya/demoman)
+[![Coverage Status](https://coveralls.io/repos/webdestroya/demoman/badge.png)](https://coveralls.io/r/webdestroya/demoman)
+
 Demoman allows you to extract metadata from Half-Life and Half-Life 2 demo (.dem) files.
 
 ## Installation
@@ -14,37 +19,37 @@ And add the gem to your Gemfile:
 
 ## Usage
 
+```ruby
+# Load a file
+demo_object = Demoman.from_file("test/test.dem")
 
-    # Load a file
-    demo_object = Demoman.from_file("test/test.dem")
-
-    # OR Load from a string
-    demo_object = Demoman.from_string("##DEMO_DATA##")
+# OR Load from a string
+demo_object = Demoman.from_string("##DEMO_DATA##")
 
 
-    # Server IP Address
-    puts demo_object.server_address
+# Server IP Address
+puts demo_object.server_address
 
 
-    # Player who recorded the demo
-    puts demo_object.player_name
+# Player who recorded the demo
+puts demo_object.player_name
 
-    # The map being played
-    puts demo_object.map
+# The map being played
+puts demo_object.map
 
-    # The game directory (dod, tf2, ...)
-    puts demo_object.game_dir
+# The game directory (dod, tf2, ...)
+puts demo_object.game_dir
 
-    # The duration of the demo (in seconds)
-    puts demo_object.duration
+# The duration of the demo (in seconds)
+puts demo_object.duration
 
-    # The number of ticks in the demo
-    puts demo_object.ticks
+# The number of ticks in the demo
+puts demo_object.ticks
 
-    # The total number of frames
-    puts demo_object.frames
+# The total number of frames
+puts demo_object.frames
+```
 
-</pre>
 
 
 ## Note on Patches/Pull Requests
@@ -57,6 +62,10 @@ And add the gem to your Gemfile:
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+## License
+
+GPLv3
+
 ## Copyright
 
-Copyright (c) 2012 Mitch Dempsey. See LICENSE for details.
+Copyright (c) 2013 Mitch Dempsey. See LICENSE for details.

data/Rakefile

@@ -1,11 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-require 'rake/testtask'
- 
-Rake::TestTask.new do |t|
-  t.libs << 'lib/demoman'
-  t.test_files = FileList['test/*_test.rb']
-  t.verbose = true
-end
- 
-task :default => :test
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/demoman.gemspec

@@ -17,4 +17,10 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", ">= 2.14"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "coveralls"
 end

data/lib/demoman/demo_file.rb

@@ -1,36 +1,144 @@
 module Demoman
 
+  # Parses and provides data about a Half life demo file.
+  #
+  # @see https://developer.valvesoftware.com/wiki/DEM_Format
   class DemoFile
 
-    attr_reader :server_address, :player_name, :map, :game_dir, :demo_protocol, :network_protocol, :type, :duration, :ticks, :frames, :sign_on_length
-    
+
+    # If recorded by a client, then this will be the +IPAddress:Port+ of 
+    # the server.
+    #
+    # If recorded by SourceTV then this will be the hostname of the server.
+    #
+    # @return [String]
+    attr_reader :server_address
+
+    # The name of the player recording the demo.
+    # 
+    # If recorded by SourceTV it will be the name of the SourceTV player.
+    #
+    # @return [String]
+    attr_reader :player_name
+
+    # The current map on the server
+    #
+    # @return [String]
+    attr_reader :map
+
+    # The game directory as reported by the server.
+    # Examples: +tf+, +dod+, etc.
+    #
+    # @return [String]
+    attr_reader :game_dir
+
+    # This is the demo protocol version.
+    # This is almost always +3+
+    #
+    # @return [Integer]
+    attr_reader :demo_protocol
+
+    # This is the network protocol, which varies by game.
+    #
+    # @return [Integer]
+    attr_reader :network_protocol
+
+    # The type of demo. This is usually +HL2DEMO+
+    #
+    # @return [String]
+    attr_reader :type
+
+    # This is the duration of the demo, in seconds.
+    #
+    # @return [Float]
+    attr_reader :duration
+
+    # This is the number of server ticks that occurred.
+    # This is roughly the tick rate of the server multiplied by the duration.
+    #
+    # @return [Integer]
+    attr_reader :ticks
+
+    # The number of frames in the demo
+    #
+    # @return [Integer]
+    attr_reader :frames
+
+    # Length of the signon data (Init for first frame)
+    #
+    # @return [Integer]
+    attr_reader :sign_on_length
+
+    # Initialize a {DemoFile} object.
+    # If the +file+ parameter is provided, then the file is read and parsed.
+    #
+    # @param file [String] path to a demo file
     def initialize(file=nil)
-      
+      @demodata = nil
       unless file.nil?
         io = File.new(file, "r")
         data = io.sysread(4096)
         parse_data data
       end
-      
+
     end
 
+    # Parses the demo file header.
+    #
+    # @param data [String] the raw demo file header data.
+    #
+    # @return [void]
     def parse_data(data)
-      demodata = data.unpack("A8/I/I/A260/A260/A260/A260/f/I/I/I/")
-      @type = demodata[0]
-      @demo_protocol = demodata[1]
-      @network_protocol = demodata[2]
-      @server_address = demodata[3]
-      @player_name = demodata[4]
-      @map = demodata[5]
-      @game_dir = demodata[6]
+      @demodata = nil
+      #                        0 1 2 3    4    5    6    7 8 9 10
+      @demodata = data.unpack("A8/I/I/A260/A260/A260/A260/f/I/I/I/")
+      @type = @demodata[0]
+      @demo_protocol = @demodata[1]
+      @network_protocol = @demodata[2]
+      @server_address = @demodata[3]
+      @player_name = @demodata[4]
+      @map = @demodata[5]
+      @game_dir = @demodata[6]
+
+      @duration = @demodata[7]
+      @ticks = @demodata[8]
+      @frames = @demodata[9]
+      @sign_on_length = @demodata[10]
       
-      @duration = demodata[7]
-      @ticks = demodata[8]
-      @frames = demodata[9]
-      @sign_on_length = demodata[10]
-      nil
+      return self
+    end
+
+
+    # Returns if the demo has been parsed.
+    # *Note:* This does not check if the demo was valid.
+    #
+    # @see #valid?
+    #
+    # @since 2.0.2
+    #
+    # @return [Boolean] true
+    def parsed?
+      !@demodata.nil?
+    end
+
+    # Returns whether or not the parsed demo is considered valid.
+    #
+    # *Note:* This is a somewhat _educated_ guess. As long as the 
+    # values appear to be within a specific range, then the demo
+    # is assumed to be valid.
+    #
+    # @since 2.0.2
+    #
+    # @return [Boolean]
+    def valid?
+      return false unless self.parsed?
+
+      return false unless @demodata.compact.size == 11
+
+      return false unless @type.eql?('HL2DEMO')
+
+      true
     end
-  
 
   end
 

data/lib/demoman/version.rb

@@ -1,3 +1,5 @@
 module Demoman
-  VERSION = "2.0.1"
+
+  # The current version of the +demoman+ gem.
+  VERSION = "2.0.2"
 end

data/lib/demoman.rb

@@ -1,21 +1,32 @@
 require "demoman/version"
 require "demoman/demo_file"
 
+# Handles static creation of {DemoFile} objects
 module Demoman
-  
 
+
+  # Create a {DemoFile} object from a file path
+  #
+  # @param file [String] the path to the +.dem+ file.
+  #
+  # @return [DemoFile]
   def self.from_file(file)
     io = File.new(file, "r")
     data = io.sysread(4096)
-    
+
     Demoman.from_string(data)
   end
-  
+
+  # Create a {DemoFile} object from a raw string
+  #
+  # @param data [String] the raw demo file data
+  #
+  # @return [DemoFile]
   def self.from_string(data)
     demo = DemoFile.new
     demo.parse_data(data)
     demo
   end
-  
-  
+
+
 end

data/spec/demoman/demoman_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Demoman do
+  it "read demo" do
+    demoman = Demoman::DemoFile.new("spec/data/test.dem")
+
+    demoman.server_address.should eq("69.90.189.79:27037")
+    demoman.player_name.should eq("Ham Salad[AOF]")
+    demoman.map.should eq("dod_jagd")
+    demoman.game_dir.should eq("dod")
+    demoman.demo_protocol.should eq(3)
+    demoman.network_protocol.should eq(7)
+    demoman.type.should eq("HL2DEMO")
+    demoman.duration.should eq(13.242424964904785)
+    demoman.ticks.should eq(874)
+    demoman.frames.should eq(390)
+    demoman.sign_on_length.should eq(115449)
+
+    demoman.valid?.should be_true
+
+  end
+
+  it "new style load demo" do
+
+    demoman = Demoman.from_file("spec/data/test.dem")
+
+    demoman.server_address.should eq("69.90.189.79:27037")
+    demoman.player_name.should eq("Ham Salad[AOF]")
+    demoman.map.should eq("dod_jagd")
+    demoman.game_dir.should eq("dod")
+    demoman.demo_protocol.should eq(3)
+    demoman.network_protocol.should eq(7)
+
+    demoman.ticks.should eq(874)
+    demoman.frames.should eq(390)
+    demoman.sign_on_length.should eq(115449)
+
+    demoman.valid?.should be_true
+  end
+
+  it "read from string" do
+    io = File.new("spec/data/test.dem", "r")
+    data = io.sysread(4096)
+
+    demoman = Demoman.from_string(data)
+
+    demoman.server_address.should eq("69.90.189.79:27037")
+    demoman.player_name.should eq("Ham Salad[AOF]")
+    demoman.map.should eq("dod_jagd")
+    demoman.game_dir.should eq("dod")
+    demoman.demo_protocol.should eq(3)
+    demoman.network_protocol.should eq(7)
+
+    demoman.ticks.should eq(874)
+    demoman.frames.should eq(390)
+    demoman.sign_on_length.should eq(115449)
+
+    demoman.valid?.should be_true
+
+  end
+
+  it "loads a SourceTV demo" do
+
+    demoman = Demoman.from_file("spec/data/sourcetv.dem")
+
+    demoman.server_address.should eq("WebDestroya's Stomping Grounds | MitchDB.com")
+    demoman.player_name.should eq("SourceTV Demo")
+    demoman.map.should eq("ctf_well")
+    demoman.game_dir.should eq("tf")
+    demoman.network_protocol.should eq(24)
+    demoman.valid?.should be_true
+  end
+
+  it 'loads jibberish' do
+    demoman = Demoman.from_string("asdasdasdasdasdasdaasdasdasdass")
+    demoman.parsed?.should be_true
+    demoman.valid?.should be_false
+
+    puts demoman.inspect
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "demoman"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: demoman
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
-dependencies: []
+date: 2013-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Library for reading metadata from Half-Life demo files
 email:
 - mrdempsey@gmail.com
@@ -20,6 +100,7 @@ extra_rdoc_files: []
 files:
 - .document
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -28,10 +109,10 @@ files:
 - lib/demoman.rb
 - lib/demoman/demo_file.rb
 - lib/demoman/version.rb
-- test/data/sourcetv.dem
-- test/data/test.dem
-- test/demoman_test.rb
-- test/test_helper.rb
+- spec/data/sourcetv.dem
+- spec/data/test.dem
+- spec/demoman/demoman_spec.rb
+- spec/spec_helper.rb
 homepage: http://www.mitchdb.com/
 licenses:
 - GPL-3
@@ -47,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -983082405090195856
+      hash: 4451018120548773554
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -56,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -983082405090195856
+      hash: 4451018120548773554
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -64,7 +145,7 @@ signing_key:
 specification_version: 3
 summary: Library for reading metadata from Half-Life demo files
 test_files:
-- test/data/sourcetv.dem
-- test/data/test.dem
-- test/demoman_test.rb
-- test/test_helper.rb
+- spec/data/sourcetv.dem
+- spec/data/test.dem
+- spec/demoman/demoman_spec.rb
+- spec/spec_helper.rb

data/test/demoman_test.rb

@@ -1,67 +0,0 @@
-require_relative 'test_helper'
-
-describe Demoman do
-  it "read demo" do
-    demoman = Demoman::DemoFile.new("test/data/test.dem")
-    
-    assert_equal "69.90.189.79:27037", demoman.server_address
-    assert_equal "Ham Salad[AOF]", demoman.player_name
-    assert_equal "dod_jagd", demoman.map
-    assert_equal "dod", demoman.game_dir
-    assert_equal 3, demoman.demo_protocol
-    assert_equal 7, demoman.network_protocol
-    
-    assert_equal 874, demoman.ticks
-    assert_equal 390, demoman.frames
-    assert_equal 115449, demoman.sign_on_length
-    
-    #["HL2DEMO", 3, 7, "69.90.189.79:27037", "Ham Salad[AOF]", "dod_jagd", "dod", 13.2424249649048, 874, 390, 115449]
-    
-  end
-  
-  it "new style load demo" do
-
-    demoman = Demoman.from_file("test/data/test.dem")
-    
-    assert_equal "69.90.189.79:27037", demoman.server_address
-    assert_equal "Ham Salad[AOF]", demoman.player_name
-    assert_equal "dod_jagd", demoman.map
-    assert_equal "dod", demoman.game_dir
-    assert_equal 3, demoman.demo_protocol
-    assert_equal 7, demoman.network_protocol
-    
-    assert_equal 874, demoman.ticks
-    assert_equal 390, demoman.frames
-    assert_equal 115449, demoman.sign_on_length
-  end
-  
-  it "read from string" do
-    io = File.new("test/data/test.dem", "r")
-    data = io.sysread(4096)
-    
-    demoman = Demoman.from_string(data)
-    
-    assert_equal "69.90.189.79:27037", demoman.server_address
-    assert_equal "Ham Salad[AOF]", demoman.player_name
-    assert_equal "dod_jagd", demoman.map
-    assert_equal "dod", demoman.game_dir
-    assert_equal 3, demoman.demo_protocol
-    assert_equal 7, demoman.network_protocol
-    
-    assert_equal 874, demoman.ticks
-    assert_equal 390, demoman.frames
-    assert_equal 115449, demoman.sign_on_length
-    
-  end
-
-  it "loads a SourceTV demo" do
-
-    demoman = Demoman.from_file("test/data/sourcetv.dem")
-    
-    assert_equal "WebDestroya's Stomping Grounds | MitchDB.com", demoman.server_address
-    assert_equal "SourceTV Demo", demoman.player_name
-    assert_equal "ctf_well", demoman.map
-    assert_equal "tf", demoman.game_dir
-  end
-  
-end

data/test/test_helper.rb

@@ -1,3 +0,0 @@
-require 'minitest/autorun'
-require 'minitest/pride'
-require File.expand_path('../../lib/demoman.rb', __FILE__)