vdf4r 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Joshua Morris
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# VDF4R
+
+Parse Valve Data Format files easily and quickly.
+
+
+## Context
+
+Valve has its own data format for storing game information. This library lets
+you parse these files into a plain-old Ruby hash easily and quickly.
+
+After that, you can do with the data what you will.
+
+
+## Installation
+
+As normal:
+
+    gem install vdf4r
+
+Or in your Gemfile:
+
+    gem 'vdf4r', '~>0.1.0'
+
+
+## Usage
+
+    require 'vdf4r'
+    require 'pp'
+
+    File.open('vdf_file.txt') do |file|
+      parser = VDF4R::Parser.new(file)
+      pp parser.parse # pretty-printed
+    end
+
+
+## Caveats
+
+This library has only really been used on a few Dota 2 VDF files. It's not
+battle-tested yet, and there are probably some minor issues.
+
+If you find something you'd like to discuss, you can find me on #dota2replay
+on quakenet IRC.
+
+At least one of Dota 2's own VDF files have grammar mistakes.
+(i.e. npc_abilities.txt) If you get an "ungrammatical content" error while
+parsing, you will need to fix the error. It will give you the offending line:
+
+    (RuntimeError)parser.rb:30:in `block in parse': ungrammatical content: '        / Damage.
+    '
+
+Indeed, in the VDF file, there are "comment" lines lacking the proper '//'
+prefix. When I changed the file to contain '// Damage.' it parsed correctly.
+
+I'll think of a way to make the parser more permissive as time allows.
+
+
+## Hacking
+
+Just clone the source from here. If issuing a pull request, make sure your
+change is on a topic branch accompanied by new tests; all behaviors must pass.
+
+
+## License
+
+VDF4R is offered under the MIT license. See [LICENSE](https://github.com/skadistats/vdf4r/blob/master/README.md)
+for the license itself.

data/lib/vdf.tt

@@ -0,0 +1,80 @@
+module VDF4R
+  grammar KeyValues
+    rule line
+      (enter_object / exit_object / comment / key_value / key / blank) endline?
+      {
+        def value
+          elements[0].value
+        end
+      }
+    end
+
+    rule blank
+      whitespace*
+      {
+        def value
+          :blank
+        end
+      }
+    end
+
+    rule key_value
+      whitespace* token whitespace* token whitespace* comment?
+      {
+        def value
+          [elements[1].value, elements[3].value]
+        end
+      }
+    end
+
+    rule key
+      whitespace* token whitespace* comment?
+      {
+        def value
+          [elements[1].value]
+        end
+      }
+    end
+
+    rule token
+      '"' [^"]* '"'
+      {
+        def value
+          elements[1..-2].collect { |e| e.text_value }.join
+        end
+      }
+    end
+
+    rule enter_object
+      whitespace* '{' whitespace* comment? {
+        def value
+          :enter_object
+        end
+      }
+    end
+
+    rule exit_object
+      whitespace* '}' whitespace* comment? {
+        def value
+          :exit_object
+        end
+      }
+    end
+
+    rule comment
+      whitespace* [/]? [/] [^\n]* {
+        def value
+          :comment
+        end
+      }
+    end
+
+    rule whitespace
+      [\t ]
+    end
+
+    rule endline
+      [\r]? [\n]
+    end
+  end
+end

data/lib/vdf4r/parser.rb

@@ -0,0 +1,61 @@
+require 'treetop'
+require 'vdf4r/store'
+
+MAX_RECURSION = 10
+GRAMMAR_PATH  = File.join(File.dirname(__FILE__), '..', 'vdf.tt')
+
+Treetop.load GRAMMAR_PATH
+
+module VDF4R
+  class Parser
+    def initialize(input)
+      case
+      when input.respond_to?(:each_line)
+        @input = input.each_line.to_a
+      when input.respond_to?(:lines)
+        @input = input.lines
+      else
+        raise ArgumentError.new('input must respond to #each_line or #lines')
+      end
+    end
+
+    def parse
+      parser = VDF4R::KeyValuesParser.new
+      store  = Store.new
+      key    = nil
+      path   = []
+
+      @input.each do |line|
+        node = parser.parse(line)
+        raise "ungrammatical content: '#{line}'" if node.nil?
+
+        next if [:blank, :comment].include?(node.value)
+
+        if node.value.respond_to?(:to_ary)
+          case node.value.length
+          when 1
+            key = node.value.first
+          when 2
+            k, v = node.value
+            store.traverse(path)[k] = v
+          end
+        elsif node.value.kind_of?(Symbol)
+          case node.value
+          when :enter_object
+            raise 'no preceding key for object' unless key
+            raise 'too recursive' if path.length > MAX_RECURSION
+            path.push key
+            key = nil
+          when :exit_object
+            raise 'nesting unbalanced (excessive exit)' if path.empty?
+            path.pop
+          end
+        end
+      end
+
+      raise 'nesting unbalanced (insufficient exit)' unless path.empty?
+
+      store
+    end
+  end
+end

data/lib/vdf4r/store.rb

@@ -0,0 +1,11 @@
+module VDF4R
+  class Store < Hash
+    def initialize
+      super { |h, k| h[k] = Store.new } # defaultdict(dict)
+    end
+
+    def traverse(path)
+      path.inject(self) { |current, path_component| current[path_component] }
+    end
+  end
+end

data/lib/vdf4r/version.rb

@@ -0,0 +1,3 @@
+module VDF4R
+  VERSION = '0.1.0'
+end

data/spec/fixtures/bad/excessive_exit.txt

@@ -0,0 +1,5 @@
+"DOTAAbilities"
+{
+  "Version"
+  }
+}

data/spec/fixtures/bad/insufficient_exit.txt

@@ -0,0 +1,5 @@
+"DOTAAbilities"
+{
+  "Version"
+  {
+}

data/spec/fixtures/bad/no_preceding_key.txt

@@ -0,0 +1,5 @@
+"DOTAAbilities"
+{
+  {
+  }
+}

data/spec/fixtures/bad/too_recursive.txt

@@ -0,0 +1,36 @@
+"DOTAAbilities"
+{
+  "1"
+  {
+    "2"
+    {
+      "3"
+      {
+        "4"
+        {
+          "5"
+          {
+            "6"
+            {
+              "7"
+              {            
+                "8"
+                {
+                  "9"
+                  {
+                    "10"
+                    {
+                      "11"
+                      {
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/spec/fixtures/bad/ungrammatical_content.txt

@@ -0,0 +1,4 @@
+"DOTAAbilities"
+{
+  The parser won't understand this line.
+}

data/spec/fixtures/items.txt

@@ -0,0 +1,169 @@
+// Dota Heroes File
+"DOTAAbilities"
+{
+  "Version"   "1"
+
+  //=================================================================================================================
+  // Blink dagger
+  //=================================================================================================================
+  "item_blink"
+  {
+    // General
+    //-------------------------------------------------------------------------------------------------------------
+    "ID"              "1"                           // unique ID number for this item.  Do not change this once established or it will invalidate collected stats.
+    "AbilityBehavior"       "DOTA_ABILITY_BEHAVIOR_POINT | DOTA_ABILITY_BEHAVIOR_DIRECTIONAL | DOTA_ABILITY_BEHAVIOR_ROOT_DISABLES"
+
+    // Stats
+    //-------------------------------------------------------------------------------------------------------------
+    "AbilityCastRange"        "0"
+    "AbilityCastPoint"        "0.0"
+    "AbilityCooldown"       "12.0"
+    "AbilityManaCost"       "0"
+    
+    // Item Info
+    //-------------------------------------------------------------------------------------------------------------
+    "ItemCost"            "2150"
+    "ItemShopTags"          "teleport"
+    "ItemQuality"         "component"
+    "ItemAliases"         "blink dagger"
+    "SideShop"            "1"
+    "ItemDeclarations"        "DECLARE_PURCHASES_TO_TEAMMATES | DECLARE_PURCHASES_IN_SPEECH | DECLARE_PURCHASES_TO_SPECTATORS"
+    
+    // Special  
+    //-------------------------------------------------------------------------------------------------------------
+    "AbilitySpecial"
+    {
+      "01"
+      {
+        "var_type"        "FIELD_INTEGER"
+        "blink_range"     "1200"
+      }
+      "02"
+      {
+        "var_type"        "FIELD_INTEGER"
+        "blink_damage_cooldown" "3"
+      }
+      "03"
+      {
+        "var_type"        "FIELD_INTEGER"
+        "blink_range_clamp" "960"
+      }
+    }
+  }
+
+  //=================================================================================================================
+  // Blades of Attack
+  //=================================================================================================================
+  "item_blades_of_attack"
+  {
+    // General
+    //-------------------------------------------------------------------------------------------------------------
+    "ID"              "2"                           // unique ID number for this item.  Do not change this once established or it will invalidate collected stats.
+    "AbilityBehavior"       "DOTA_ABILITY_BEHAVIOR_PASSIVE"
+
+    // Item Info
+    //-------------------------------------------------------------------------------------------------------------
+    "ItemCost"            "450"
+    "ItemShopTags"          "damage;tutorial"
+    "ItemQuality"         "component"
+    "ItemAliases"         "blades of attack"
+    "SideShop"            "1"
+
+    // Special  
+    //-------------------------------------------------------------------------------------------------------------
+    "AbilitySpecial"
+    {
+      "01"
+      {
+        "var_type"        "FIELD_INTEGER"
+        "bonus_damage"      "9"
+      }
+    }
+  }
+
+  //=================================================================================================================
+  // Broadsword
+  //=================================================================================================================
+  "item_broadsword"
+  {
+    // General
+    //-------------------------------------------------------------------------------------------------------------
+    "ID"              "3"                           // unique ID number for this item.  Do not change this once established or it will invalidate collected stats.
+    "AbilityBehavior"       "DOTA_ABILITY_BEHAVIOR_PASSIVE"
+
+    // Item Info
+    //-------------------------------------------------------------------------------------------------------------
+    "ItemCost"            "1200"
+    "ItemShopTags"          "damage"
+    "ItemQuality"         "component"
+    "ItemAliases"         "broadsword"
+
+    // Special  
+    //-------------------------------------------------------------------------------------------------------------
+    "AbilitySpecial"
+    {
+      "01"
+      {
+        "var_type"        "FIELD_INTEGER"
+        "bonus_damage"      "18"
+      }
+    }
+  }
+
+  //=================================================================================================================
+  // Black King Bar
+  //=================================================================================================================
+  "item_black_king_bar"
+  {
+    // General
+    //-------------------------------------------------------------------------------------------------------------
+    "ID"              "116"                           // unique ID number for this item.  Do not change this once established or it will invalidate collected stats.
+    "AbilityBehavior"       "DOTA_ABILITY_BEHAVIOR_IMMEDIATE | DOTA_ABILITY_BEHAVIOR_NO_TARGET"
+
+    // Stats    
+    //-------------------------------------------------------------------------------------------------------------
+    "AbilityCooldown"       "80 75 70 65 60 55 50"
+
+    // Item Info
+    //-------------------------------------------------------------------------------------------------------------
+    "ItemCost"            "3975"
+    "ItemShopTags"          "str;damage;hard_to_tag"
+    "ItemQuality"         "epic"
+    "ItemAliases"         "bkb;black king bar"
+    "ItemSellable"          "0"
+    "ItemDeclarations"        "DECLARE_PURCHASES_TO_TEAMMATES | DECLARE_PURCHASES_IN_SPEECH | DECLARE_PURCHASES_TO_SPECTATORS"
+    
+    // Special  
+    //-------------------------------------------------------------------------------------------------------------
+    "AbilitySpecial"
+    {
+      "01"
+      {
+        "var_type"        "FIELD_INTEGER"
+        "bonus_strength"    "10"
+      }
+      "02"
+      {
+        "var_type"        "FIELD_INTEGER"
+        "bonus_damage"      "24"
+      }
+      "03"
+      {
+        "var_type"        "FIELD_FLOAT"
+        "duration"        "10.0 9.0 8.0 7.0 6.0 5.0 4.0"
+      }
+      "04"
+      {
+        "var_type"        "FIELD_INTEGER"
+        "max_level"       "6"
+      }
+      "05"
+      {
+        "var_type"        "FIELD_INTEGER"
+        "model_scale"     "30"     // Percentage over model scale
+      }
+    }
+  }
+  
+  // next free ID: 242
+}

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+module FixtureHelpers
+  def with_fixture(name, &block)
+    abspath = File.join(File.dirname(__FILE__), 'fixtures', *name.split('/'))
+    File.open("#{abspath}.txt") do |fixture|
+      yield fixture
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include FixtureHelpers
+end

data/spec/vdf4r/parser_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+require 'vdf4r'
+require 'stringio'
+
+module VDF4R
+  describe Parser do
+    subject { VDF4R::Parser }
+
+    describe 'instantiation' do
+      shared_examples_for "doesn't raise" do
+        it 'does not raise' do
+          expect {
+            subject.new(input)
+          }.not_to raise_error
+        end
+      end
+
+      context 'with string' do
+        let(:input) { 'foo\nbar\n'}
+        it_behaves_like "doesn't raise"
+      end
+
+      context 'with io' do
+        let(:input) { StringIO.new('input') }
+        it_behaves_like "doesn't raise"
+      end
+
+      context 'quacks right' do
+        let(:input) do
+          quacker = Class.new do
+            def lines
+              ['line 1', 'line 2']
+            end
+          end
+          quacker.new
+        end
+
+        it_behaves_like "doesn't raise"        
+      end
+
+      context 'with inappropriate input' do
+        let(:input) { 1234 }
+
+        it 'raises' do
+          expect {
+            subject.new(input)
+          }.to raise_error
+        end
+      end
+    end
+
+    describe 'items.txt fixture translation output' do
+      let(:result) do
+        with_fixture('items') do |fixture|
+          subject.new(fixture).parse
+        end
+      end
+
+      it 'quacks like hash' do
+        expect(result).to respond_to(:keys)
+      end
+
+      it 'has the correct root' do
+        expect(result.keys.length).to eq(1)
+        expect(result.keys).to include('DOTAAbilities')
+      end
+
+      it 'has a sampling of correct top-level child entries' do
+        abilities = result['DOTAAbilities']
+        expect(abilities).to include('item_blink')
+        expect(abilities).to include('item_blades_of_attack')
+        expect(abilities).to include('item_broadsword')
+        expect(abilities).to include('item_black_king_bar')
+      end
+    end
+
+    describe 'bad input' do
+      context 'unbalanced nesting (insufficient exit)' do
+        it 'raises TranslationError' do
+          expect {
+            with_fixture('bad/insufficient_exit') do |fixture|
+              subject.new(fixture).parse
+            end
+          }.to raise_error /insufficient exit/
+        end
+      end
+
+      context 'unbalanced nesting (excessive exit)' do
+        it 'raises TranslationError' do
+          expect {
+            with_fixture('bad/excessive_exit') do |fixture|
+              subject.new(fixture).parse
+            end
+          }.to raise_error /excessive exit/
+        end
+      end
+ 
+      context 'ungrammatical content' do
+        it 'raises TranslationError' do
+          expect {
+            with_fixture('bad/ungrammatical_content') do |fixture|
+              subject.new(fixture).parse
+            end
+          }.to raise_error /ungrammatical content/
+        end
+      end
+
+      context 'too recursive' do
+        it 'raises TranslationError' do
+          expect {
+            with_fixture('bad/too_recursive') do |fixture|
+              subject.new(fixture).parse
+            end
+          }.to raise_error /too recursive/
+        end
+      end
+
+      context 'no preceding key' do
+        it 'raises TranslationError' do
+          expect {
+            with_fixture('bad/no_preceding_key') do |fixture|
+              subject.new(fixture).parse
+            end
+          }.to raise_error /no preceding key/
+        end
+      end
+    end
+  end
+end

data/spec/vdf4r/store_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'vdf4r/store'
+
+module VDF4R
+  describe Store do
+    it 'defaults to a nested store for unknown keys' do
+      subject['foo'].should be_kind_of(Store)
+    end
+
+    it 'preserves original on second access of unknown key' do
+      store = subject['foo']['bar']
+      subject['foo']['bar']['ohai'] = 1
+      subject['foo']['bar'].should === store
+    end
+
+    describe '#traverse' do
+      let(:path) { ['foo', 'bar'] }
+
+      it 'follows path recursively to arbitrary depths' do
+        subject['foo']['bar'] = 'ohai'
+        subject.traverse(path).should eq('ohai')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: vdf4r
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Morris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: ! "# VDF4R\n\nParse Valve Data Format files easily and quickly.\n\n\n##
+  Context\n\nValve has its own data format for storing game information. This library
+  lets\nyou parse these files into a plain-old Ruby hash easily and quickly.\n\nAfter
+  that, you can do with the data what you will.\n\n\n## Installation\n\nAs normal:\n\n
+  \   gem install vdf4r\n\nOr in your Gemfile:\n\n    gem 'vdf4r', '~>0.1.0'\n\n\n##
+  Usage\n\n    require 'vdf4r'\n    require 'pp'\n\n    File.open('vdf_file.txt')
+  do |file|\n      parser = VDF4R::Parser.new(file)\n      pp parser.parse # pretty-printed\n
+  \   end\n\n\n## Caveats\n\nThis library has only really been used on a few Dota
+  2 VDF files. It's not\nbattle-tested yet, and there are probably some minor issues.\n\nIf
+  you find something you'd like to discuss, you can find me on #dota2replay\non quakenet
+  IRC.\n\nAt least one of Dota 2's own VDF files have grammar mistakes.\n(i.e. npc_abilities.txt)
+  If you get an \"ungrammatical content\" error while\nparsing, you will need to fix
+  the error. It will give you the offending line:\n\n    (RuntimeError)parser.rb:30:in
+  `block in parse': ungrammatical content: '        / Damage.\n    '\n\nIndeed, in
+  the VDF file, there are \"comment\" lines lacking the proper '//'\nprefix. When
+  I changed the file to contain '// Damage.' it parsed correctly.\n\nI'll think of
+  a way to make the parser more permissive as time allows.\n\n\n## Hacking\n\nJust
+  clone the source from here. If issuing a pull request, make sure your\nchange is
+  on a topic branch accompanied by new tests; all behaviors must pass.\n\n\n## License\n\nVDF4R
+  is offered under the MIT license. See [LICENSE](https://github.com/skadistats/vdf4r/blob/master/README.md)\nfor
+  the license itself.\n"
+email: onethirtyfive@skadistats.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/vdf.tt
+- lib/vdf4r/parser.rb
+- lib/vdf4r/store.rb
+- lib/vdf4r/version.rb
+- spec/fixtures/bad/excessive_exit.txt
+- spec/fixtures/bad/insufficient_exit.txt
+- spec/fixtures/bad/no_preceding_key.txt
+- spec/fixtures/bad/too_recursive.txt
+- spec/fixtures/bad/ungrammatical_content.txt
+- spec/fixtures/items.txt
+- spec/spec_helper.rb
+- spec/vdf4r/parser_spec.rb
+- spec/vdf4r/store_spec.rb
+- README.md
+- LICENSE
+homepage: https://github.com/skadistats/vdf4r
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Valve Data Format (VDF) file parser
+test_files: []