vdf4r 0.1.1 → 0.1.2

data/README.md

@@ -19,7 +19,7 @@ As normal:
 
 Or in your Gemfile:
 
-    gem 'vdf4r', '~>0.1.0'
+    gem 'vdf4r', '~>0.1.1'
 
 
 ## Usage
@@ -62,5 +62,5 @@ 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)
+VDF4R is offered under the MIT license. See [LICENSE](https://github.com/skadistats/vdf4r/blob/master/LICENSE)
 for the license itself.

data/lib/vdf.tt

@@ -1,19 +1,39 @@
 module VDF4R
   grammar KeyValues
     rule line
-      (enter_object / exit_object / comment / key_value / key / blank) endline?
+      (enter_object / exit_object /
+      comment /
+      key_enter_value / key_continue_value / key_exit_value / key_value / key /
+      blank) endline?
       {
         def value
-          elements[0].value
+          [:line, elements[0].value]
         end
       }
     end
 
-    rule blank
-      whitespace*
+    rule enter_object
+      whitespace* '{' whitespace* comment?
+      {
+        def value
+          [:enter_object, nil]
+        end
+      }
+    end
+
+    rule exit_object
+      whitespace* '}' whitespace* comment?
       {
         def value
-          :blank
+          [:exit_object, nil]
+        end
+      }
+    end
+
+    rule comment
+      whitespace* '//' [^\n]* {
+        def value
+          [:comment, nil]
         end
       }
     end
@@ -22,7 +42,7 @@ module VDF4R
       whitespace* token whitespace* token whitespace* comment?
       {
         def value
-          [elements[1].value, elements[3].value]
+          [:key_value, [elements[1].value, elements[3].value]]
         end
       }
     end
@@ -31,50 +51,96 @@ module VDF4R
       whitespace* token whitespace* comment?
       {
         def value
-          [elements[1].value]
+          [:key, [elements[1].value]]
         end
       }
     end
 
-    rule token
-      '"' [^"]* '"'
+    rule key_enter_value
+      whitespace* token whitespace* token_delimiter token_content+ &endline
       {
         def value
-          elements[1..-2].collect { |e| e.text_value }.join
+          key           = elements[1].value
+          partial_value = elements[4...-1].collect { |e| e.text_value }.join
+
+          [:key_enter_value, [elements[1].value, partial_value]]
         end
       }
     end
 
-    rule enter_object
-      whitespace* '{' whitespace* comment? {
+    rule key_continue_value
+      token_content+ &endline
+      {
         def value
-          :enter_object
+          partial_value = elements[1...-1].collect { |e| e.text_value }.join
+
+          [:key_enter_value, [partial_value]]
         end
       }
     end
 
-    rule exit_object
-      whitespace* '}' whitespace* comment? {
+    rule key_exit_value
+      token_content* token_delimiter whitespace* &endline
+      {
         def value
-          :exit_object
+          partial_value = elements[1...-3].collect { |e| e.text_value }.join
+
+          [:key_enter_value, [partial_value]]
         end
       }
     end
 
-    rule comment
-      whitespace* [/]? [/] [^\n]* {
+    rule continue_value
+      [^"]+
+    end
+
+    rule exit_value
+      [^"]+ delimiter_token
+    end
+
+    rule blank
+      whitespace*
+      {
+        def value
+          [:blank, nil]
+        end
+      }
+    end
+
+    rule token
+      token_delimiter token_content* token_delimiter
+      {
         def value
-          :comment
+          elements[1..-2].collect { |e| e.text_value }.join
+        end
+      }
+    end
+
+    rule token_delimiter
+      '"'
+    end
+
+    rule token_content
+      [^"\r\n{}]
+      {
+        def value
+          elements[0].text_value
         end
       }
     end
 
     rule whitespace
       [\t ]
+      {
+        [:whitespace, nil]
+      }
     end
 
     rule endline
       [\r]? [\n]
+      {
+        [:endline, nil]
+      }
     end
   end
-end
+end

data/lib/vdf4r/parser.rb

@@ -8,6 +8,16 @@ Treetop.load GRAMMAR_PATH
 
 module VDF4R
   class Parser
+    class << self
+      def clean(input)
+        input.gsub(/\\"/, '&quot;')
+      end
+
+      def dirty(input)
+        input.gsub('&quot;', '\"')
+      end
+    end
+
     def initialize(input)
       case
       when input.respond_to?(:each_line)
@@ -20,36 +30,54 @@ module VDF4R
     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
+      parser        = VDF4R::KeyValuesParser.new
+      store         = Store.new
+      key           = nil
+      partial_value = nil
+      path          = []
+
+      @input.each_with_index do |line, index|
+        node = parser.parse(Parser.clean(line))
+
+        if node.nil?
+          raise "ungrammatical content at line #{index+1}: '#{line}'" if node.nil?
+        end
+
+        begin
+          _, (encounter, context) = node.value
+        rescue NoMethodError => e
+          
+        end
+
+        case encounter
+        when :blank, :comment
+          # do nothing
+        when :enter_object
+          raise 'no preceding key for object' unless key
+          raise 'too recursive' if path.length > MAX_RECURSION
+          raise 'enter during multi-line value' if partial_value
+          path.push key
+          key = nil
+        when :exit_object
+          raise 'nesting unbalanced (excessive exit)' if path.empty?
+          raise 'exit during multi-line value' if partial_value
+          path.pop
+        when :key_value
+          k, v = context
+          store.traverse(path)[k] = Parser.dirty(v)
+        when :key
+          key = context[0]
+        when :key_enter_value
+          key, partial_value = context
+        when :key_continue_value
+          # raise unless value is non-nil
+          partial_value += "\n#{context[0]}"
+        when :key_exit_value
+          v = partial_value + "\n#{context[0]}"
+          partial_value = nil
+          store.traverse(path)[k] = Parser.dirty(v)
+        else
+          raise 'unknown node value'
         end
       end
 

data/lib/vdf4r/version.rb

@@ -1,3 +1,3 @@
 module VDF4R
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/fixtures/bad/ungrammatical_content.txt

@@ -1,4 +1,4 @@
 "DOTAAbilities"
 {
-  The parser won't understand this line.
+  {The parser won't understand this line since it uses reserved characters.}
 }

data/spec/vdf4r/parser_spec.rb

@@ -7,6 +7,25 @@ module VDF4R
   describe Parser do
     subject { VDF4R::Parser }
 
+    describe 'class methods' do
+      context 'input safety' do
+        let(:dirty) { '"foo\"\"bar\""' }
+        let(:clean) { '"foo""bar""' }
+
+        describe '#clean' do
+          it 'replaces escaped quotes with token' do
+            expect(subject.clean(dirty)).to eq(clean)
+          end
+        end
+
+        describe '#dirty' do
+          it 'replaces tokens with escaped quote' do
+            expect(subject.dirty(clean)).to eq(dirty)
+          end
+        end
+      end
+    end
+
     describe 'instantiation' do
       shared_examples_for "doesn't raise" do
         it 'does not raise' do
@@ -50,7 +69,7 @@ module VDF4R
       end
     end
 
-    describe 'items.txt fixture translation output' do
+    describe 'usage example (items.txt)' do
       let(:result) do
         with_fixture('items') do |fixture|
           subject.new(fixture).parse
@@ -75,54 +94,54 @@ module VDF4R
       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/
+    describe 'usage example (dota_english.txt)' do
+      let(:result) do
+        with_fixture('dota_english') do |fixture|
+          subject.new(fixture).parse
         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/
+      it "doesn't raise" do
+        expect {
+          result
+        }.not_to raise_error
+      end
+    end
+
+    describe 'bad input' do
+      def parse_fixture(fixture_name)
+        with_fixture(fixture_name) do |fixture|
+          subject.new(fixture).parse
         end
       end
+
+      it 'raises on unbalanced nesting (insufficient exit)' do
+        expect { parse_fixture('bad/insufficient_exit') }.to raise_error /insufficient exit/
+      end
+
+      it 'raises on unbalanced nesting (excessive exit)' do
+        expect { parse_fixture('bad/excessive_exit') }.to raise_error /excessive exit/
+      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
+      it 'raises on ungrammatical content' do
+        expect { parse_fixture('bad/ungrammatical_content') }.to raise_error /ungrammatical content/
       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
+      it 'raises when too recursive' do
+        expect { parse_fixture('bad/too_recursive') }.to raise_error /too recursive/
       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/
+      it 'raises on no preceding key' do
+        expect { parse_fixture('bad/no_preceding_key') }.to raise_error /no preceding key/
+      end
+
+      describe 'multi-line values' do
+        it 'raises on enter' do
+          expect { parse_fixture('bad/multi_line_enter') }.to raise_error /enter/
+        end
+
+        it 'raises on exit' do
+          expect { parse_fixture('bad/multi_line_exit') }.to raise_error /exit/
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vdf4r
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -78,12 +78,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1856681965695248353
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1856681965695248353
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2