demo-reader 0.2.5 → 0.2.6

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.6

data/demo-reader.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{demo-reader}
-  s.version = "0.2.5"
+  s.version = "0.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["aekym"]

data/lib/demo-reader.rb

@@ -1,5 +1,6 @@
 require "demo_reader_warsow"
 require "demo_reader_defrag"
+require "active_support/core_ext/hash"
 
 
 class DemoReader
@@ -8,10 +9,24 @@ class DemoReader
   # tries to parse the given demo file in order to detect first a warsow,
   # then a defrag demo
   #
+  # @param filename path of the demo file to parse
+  # @param opts
+  #   :raise_errors if errors should raise or not, default true
+  #   :hint_for_time string with a time in format m.s.ms (%d{2}\.%d{2}\.%d{3}),
+  #                  default is the given filename
+  #
   # @returns an instance of DemoReaderWarsow or DemoReaderDefrag or nil on failure
   #
-  def self.parse(filename, hint_for_time = nil)
-    try_warsow(filename) || try_defrag(filename, hint_for_time)
+  def self.parse(filename, opts = nil)
+    opts = {} if opts.blank?
+    opts.assert_valid_keys :raise_errors, :hint_for_time
+
+    # set default options when not set
+    #
+    opts[:raise_errors] = true      unless opts[:raise_errors].equal?(false)
+    opts[:hint_for_time] = filename unless opts[:hint_for_time].is_a?(String)
+
+    try_warsow(filename) || try_defrag(filename, opts)
   end
 
 
@@ -23,8 +38,8 @@ class DemoReader
     demo.valid ? demo : nil
   end
 
-  def self.try_defrag(filename, hint_for_time)
-    demo = DemoReaderDefrag.new(filename, hint_for_time)
+  def self.try_defrag(filename, opts)
+    demo = DemoReaderDefrag.new(filename, opts)
 
     demo.valid ? demo : nil
   end

data/lib/demo_reader_defrag.rb

@@ -7,9 +7,9 @@ class DemoReaderDefrag
 
 
 
-  def initialize(filename, hint_for_time = nil)
+  def initialize(filename, opts)
     @filename = filename
-    @hint_for_time = hint_for_time
+    @opts = opts
 
     @game = "Defrag"
     @version = -1
@@ -34,7 +34,7 @@ class DemoReaderDefrag
     out = DM68.parse_file(@filename)
     @raw = YAML.load(out)
 
-    raise out unless @raw
+    conditionally_raise out unless @raw
 
     @version = @raw['server_info']['protocol'].to_i
     @mapname = @raw['server_info']['mapname'].downcase
@@ -46,7 +46,7 @@ class DemoReaderDefrag
     if @raw['server_info']['defrag_vers'].to_i > 0
       @gamemode = @raw['server_info']['df_promode'].to_i.zero? ? 'vq3' : 'cpm'
 
-      time_hint = extract_time_from_filename(@hint_for_time || @filename)
+      time_hint = extract_time_from_filename(@opts[:hint_for_time])
       @time = extract_time(@raw['prints'], time_hint)
 
       @player = extract_player(@raw['prints'], @time)
@@ -72,7 +72,13 @@ class DemoReaderDefrag
 
   protected
 
+  def conditionally_raise(msg)
+    raise msg if @opts[:raise_errors]
+  end
+
   def guessable_time(time)
+    return nil if time.blank?
+
     time = time.sub(/^[0:\.]*/, "") # remove empty min, sec, etc
     parts = time.split(/\.|:/).map(&:to_i)
 
@@ -96,8 +102,8 @@ class DemoReaderDefrag
       arr
     end
 
-    raise "No player was found." if players.empty?
-    raise "Not only one player was found #{players.inspect}." if players.size > 1
+    conditionally_raise "No player was found." if players.empty?
+    conditionally_raise "Not only one player was found #{players.inspect}." if players.size > 1
 
     players.first
   end
@@ -117,7 +123,7 @@ class DemoReaderDefrag
       arr
     end
 
-    raise "No time was found." if times.empty?
+    conditionally_raise "No time was found." if times.empty?
     return times.first if times.one?
 
     # multiple times found
@@ -126,7 +132,7 @@ class DemoReaderDefrag
     time_hint = normalize_time(time_hint) if time_hint.present?
     return time_hint if times.member?(time_hint)
 
-    raise "Not only one time was found #{times.inspect}."
+    conditionally_raise "Not only one time was found #{times.inspect}."
   end
 
   def plain_text(text)

data/test/unit/demo_reader_defrag_dm_68_cpm_test.rb

@@ -18,7 +18,7 @@ class DemoReaderDefragDm68CpmTest < Test::Unit::TestCase
     time_hint = entry.last if entry.size > 4
 
     define_method "test_defrag_dm_#{version}_demo_#{file.gsub(/[^a-z_0-9]/, "_")}" do
-      demo = DemoReader.parse("test/fixtures/defrag/dm_#{version}/#{gamemode}/#{file}.dm_#{version}", time_hint)
+      demo = DemoReader.parse("test/fixtures/defrag/dm_#{version}/#{gamemode}/#{file}.dm_#{version}", :hint_for_time => time_hint)
 
       assert demo.valid
       assert_equal game, demo.game
@@ -31,5 +31,13 @@ class DemoReaderDefragDm68CpmTest < Test::Unit::TestCase
 
   end
 
+  def test_ignore_errors_option
+    demo = DemoReader.parse("test/fixtures/defrag/dm_68/cpm/mega_wood[mdf.cpm]_without_time_hint_\(kreator.Germany\).dm_68",
+                            :raise_errors => false)
+
+    assert demo.valid
+    assert_equal "mega_wood", demo.mapname
+  end
+
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: demo-reader
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - aekym