DSON 0.0.3 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # DSON
 
-Such serialization! Totally pure-ruby also completely DSON. Wow!
+Such serialization now also parsing! Totally pure-ruby also completely DSON. Wow!
 
 Currently known deficiencies:
 * Number handling (needs to be octal, currently treated as string)
@@ -21,6 +21,8 @@ Or install it yourself as:
 
 ## Usage
 
+*Serialization*
+
 Currently supports a ruby object, hash and array data structure and outputs it's representation in DSON ([Doge Serialized Object notation](http://dogeon.org/)). By way of an example, try:
 
     require 'DSON'
@@ -41,6 +43,16 @@ Correct to the DSON spec.
 
 Try it out with custom ruby objects too!
 
+*Parsing*
+
+Surrently should parse a DSON object given as a string. Not the world's best put together parse but should function reasonably with general DSON strings. Try
+
+    require 'DSON'
+
+    puts DSON.so_parse(
+      'such "ruby" is "pure", "supports" is so "hash" also "array" many wow'
+    )
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/DSON/fork )

data/lib/DSON.rb

@@ -6,4 +6,8 @@ module DSON
   def self.such_serialize_wow(subject)
     DSON::Value.new(subject).such_serialize_wow
   end
+
+  def self.so_parse(string)
+    DSON::Value.so_parse(string)
+  end
 end

data/lib/DSON/value.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+  # -*- encoding : utf-8 -*-
 require 'DSON/value/hash_value'
 require 'DSON/value/array_value'
 require 'DSON/value/string_value'
@@ -23,6 +24,68 @@ module DSON
       ObjectValue.new(value)
     end
 
+    def self.so_parse(dson_string)
+      string_hash, replaced_string = remove_all_strings(dson_string)
+      handle_next(
+        word_array: replaced_string.gsub(/,|\?|!|\./, ' ,').split(' '),
+        string_hash: string_hash
+      )
+    end
+
+    def self.handle_next(options)
+      word_array = options[:word_array]
+
+      fail 'An error has occurred, this could be either user error or a bug. Please check your DSON is valid, and if it is, please raise a GitHub issue' if word_array.empty?
+
+      first_word = word_array.shift
+
+      if first_word == 'such'
+        return HashValue.so_parse(
+          word_array: word_array,
+          parent_hash: {},
+          string_hash: options[:string_hash]
+        )
+      end
+      if first_word == 'so'
+        return ArrayValue.so_parse(
+          word_array: word_array,
+          parent_array: [],
+          string_hash: options[:string_hash]
+        )
+      end
+      return TrueValue.so_parse           if first_word == 'yes'
+      return FalseValue.so_parse          if first_word == 'no'
+      return NilValue.so_parse            if first_word == 'empty'
+
+      options[:first_word] = first_word
+      StringValue.so_parse(options)
+    end
+
+    # Class methods can't be accessed from subclasses if protected...
+    # Find better way if possible
+    def self.remove_first_and_last_words(string)
+      non_whitespace_elements = string.split(' ')
+      non_whitespace_elements.pop
+      non_whitespace_elements.shift
+      non_whitespace_elements.join(' ')
+    end
+
+    def self.remove_first_and_last_elements(array)
+      array.pop
+      array.shift
+    end
+
+    protected
+
+    def self.remove_all_strings(dson_string)
+      string_hash = {}
+      replaced_string = dson_string.gsub(/"(.*?)"/).with_index do |match, index|
+        string_hash[index] = match[1..-2]
+        index
+      end
+      [string_hash, replaced_string]
+    end
+
     def reduce(list, potential_joiners)
       list.each_with_index.reduce('') do |acc, (element, index)|
         is_last = (index == list.size - 1)

data/lib/DSON/value/array_value.rb

@@ -1,9 +1,27 @@
 # -*- encoding : utf-8 -*-
+require 'DSON/value'
+
 module DSON
   module Value
     class ArrayValue
       include Value
 
+      def self.so_parse(options)
+        word_array = options[:word_array]
+        parent_array = options[:parent_array]
+
+        if word_array[0] == 'many'
+          word_array.shift
+          return parent_array
+        end
+        word_array.shift unless (word_array[0] =~ /and|also/).nil?
+
+        # the next value will be the value
+        parent_array.push(DSON::Value.handle_next(options))
+
+        so_parse(options)
+      end
+
       POTENTIAL_JOINERS = [' and' , ' also']
 
       attr_reader :value
@@ -18,6 +36,12 @@ module DSON
         end
         'so ' + reduce(content, POTENTIAL_JOINERS) + 'many'
       end
+
+      AND_ALSO_REGEX = / and | also /
+
+      def self.parse_value(value, acc_array)
+        acc_array.push DSON.so_parse(value)
+      end
     end
   end
 end

data/lib/DSON/value/false_value.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'DSON/value'
 
 require 'singleton'
@@ -8,6 +9,10 @@ module DSON
       include Value
       include Singleton
 
+      def self.so_parse
+        false
+      end
+
       def such_serialize_wow
         'no'
       end

data/lib/DSON/value/hash_value.rb

@@ -6,6 +6,31 @@ module DSON
     class HashValue
       include Value
 
+      def self.so_parse(options)
+        word_array = options[:word_array]
+        parent_hash = options[:parent_hash]
+
+        if word_array[0] == 'wow'
+          word_array.shift
+          return parent_hash
+        end
+        word_array.shift unless (word_array[0] =~ (/\?|\.|,|!/)).nil?
+
+        string_hash = options[:string_hash]
+
+        # The next value will be a key
+        numeric_key = word_array.shift
+        key = string_hash[numeric_key.to_i]
+
+        # remove is
+        word_array.shift
+
+        value = DSON::Value.handle_next(options)
+        parent_hash[key] = value
+
+        so_parse(options)
+      end
+
       POTENTIAL_PUNCTUATION = %w(, . ! ?)
 
       attr_reader :value
@@ -23,6 +48,12 @@ module DSON
         end
         'such ' + reduce(strings, POTENTIAL_PUNCTUATION) + 'wow'
       end
+
+      def self.parse_pair(string, acc_hash)
+        results = string.scan(/"(.*)" is (.*)/)
+        acc_hash[results[0][0]] = DSON::Value.so_parse(results[0][1])
+        acc_hash
+      end
     end
   end
 end

data/lib/DSON/value/nil_value.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'DSON/value'
 
 require 'singleton'
@@ -8,6 +9,10 @@ module DSON
       include Value
       include Singleton
 
+      def self.so_parse
+        nil
+      end
+
       def such_serialize_wow
         'empty'
       end

data/lib/DSON/value/object_value.rb

@@ -16,7 +16,10 @@ module DSON
         # Construct a hash of the instance variables
         object_hash = Hash[
           value.instance_variables.map do |variable|
-            [remove_at_from_attribute_name(variable), value.instance_variable_get(variable)]
+            [
+              remove_at_from_attribute_name(variable),
+              value.instance_variable_get(variable)
+            ]
           end
         ]
 
@@ -25,6 +28,7 @@ module DSON
       end
 
       private
+
       def remove_at_from_attribute_name(attribute_name)
         attribute_name[1..-1]
       end

data/lib/DSON/value/string_value.rb

@@ -8,6 +8,11 @@ module DSON
 
       attr_reader :value
 
+      def self.so_parse(options)
+        numeric_identifier = options[:first_word]
+        options[:string_hash][numeric_identifier.to_i]
+      end
+
       def initialize(value)
         @value = value
       end

data/lib/DSON/value/true_value.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'DSON/value'
 
 require 'singleton'
@@ -8,6 +9,10 @@ module DSON
       include Value
       include Singleton
 
+      def self.so_parse
+        true
+      end
+
       def such_serialize_wow
         'yes'
       end

data/lib/DSON/version.rb

@@ -1,7 +1,7 @@
-# -*- encoding : utf-8 -*
+# -*- encoding : utf-8 -*-
 
 # Part of the DSON module use to keep track of
 # the version
 module DSON
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/spec/lib/example_class.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module DSONSpec
   class TrivialClass
   end

data/spec/parsing_spec.rb

@@ -0,0 +1,292 @@
+# -*- encoding : utf-8 -*-
+require 'DSON'
+
+describe 'simple hashes' do
+
+  it 'parses an empty DSON hash' do
+    dson_string = 'such wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson.keys.size).to eq(0)
+  end
+
+  it 'parses a DSON hash with one element' do
+    dson_string = 'such "dson" is "parsed" wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['dson']).to eq('parsed')
+  end
+
+  it 'parses a DSON hash with two elements with , separator' do
+    dson_string = 'such "dson" is "parsed", "language" is "ruby" wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['dson']).to eq('parsed')
+    expect(parsed_dson['language']).to eq('ruby')
+  end
+
+  it 'parses a DSON hash with two elements with . separator' do
+    dson_string = 'such "dson" is "parsed". "language" is "ruby" wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['dson']).to eq('parsed')
+    expect(parsed_dson['language']).to eq('ruby')
+  end
+
+  it 'parses a DSON hash with two elements with ! separator' do
+    dson_string = 'such "dson" is "parsed"! "language" is "ruby" wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['dson']).to eq('parsed')
+    expect(parsed_dson['language']).to eq('ruby')
+  end
+
+  it 'parses a DSON hash with two elements with ? separator' do
+    dson_string = 'such "dson" is "parsed"? "language" is "ruby" wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['dson']).to eq('parsed')
+    expect(parsed_dson['language']).to eq('ruby')
+  end
+
+  it 'parses a DSON hash with three elements' do
+    dson_string = 'such "dson" is "parsed"! "language" is "ruby". "separators" is "varied" wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['dson']).to eq('parsed')
+    expect(parsed_dson['language']).to eq('ruby')
+    expect(parsed_dson['separators']).to eq('varied')
+  end
+
+end
+
+describe 'parsing simple arrays' do
+
+  it 'parses an empty DSON array' do
+    dson_string = 'so many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson.size).to eq(0)
+  end
+
+  it 'parses a DSON array with one element' do
+    dson_string = 'so "test" many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[0]).to eq('test')
+  end
+
+  it 'parses a DSON array with two elements and "and" separator' do
+    dson_string = 'so "test" and "quality" many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[0]).to eq('test')
+    expect(parsed_dson[1]).to eq('quality')
+  end
+
+  it 'parses a DSON array with twp elements and "also" separator' do
+    dson_string = 'so "test" also "quality" many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[0]).to eq('test')
+    expect(parsed_dson[1]).to eq('quality')
+  end
+
+  it 'parses a DSON array with a mix of separators' do
+    dson_string = 'so "test" also "quality" and "awesome" many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[0]).to eq('test')
+    expect(parsed_dson[1]).to eq('quality')
+    expect(parsed_dson[2]).to eq('awesome')
+  end
+
+  it 'parses an array with " and " and " also " in a value' do
+    dson_string = 'so " and " also " also " and " and " many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[0]).to eq(' and ')
+    expect(parsed_dson[1]).to eq(' also ')
+    expect(parsed_dson[2]).to eq(' and ')
+  end
+
+end
+
+describe 'parsing nested arrays' do
+
+  it 'parses empty nested arrays' do
+    dson_string = 'so so many many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson.size).to eq(1)
+    expect(parsed_dson[0].size).to eq(0)
+  end
+
+  it 'should correctly handle nested arrays with elements' do
+    dson_string = 'so "cheese" also so many many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[0]).to eq('cheese')
+    expect(parsed_dson[1].size).to eq(0)
+  end
+
+  it 'should correctly handle a nested array with an element' do
+    dson_string = 'so so "cheese" many many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[0][0]).to eq('cheese')
+  end
+
+  it 'should correctly handle a more complex nested array' do
+    dson_string = 'so "cheese" and so "cheese" also so "cheese" many many many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[0]).to eq('cheese')
+    expect(parsed_dson[1][0]).to eq('cheese')
+    expect(parsed_dson[1][1][0]).to eq('cheese')
+  end
+
+  it 'parses a hash with " is "" in one of the keys' do
+    dson_string = 'such " is " is "cheese" wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[' is ']).to eq('cheese')
+  end
+
+  it 'parses a hash with " is " in one of the values' do
+    dson_string = 'such "cheese" is " is " wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['cheese']).to eq(' is ')
+  end
+
+  it 'parses a hash with a comma in one of the keys' do
+    dson_string = 'such "," is "cheese" wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[',']).to eq('cheese')
+  end
+
+  it 'parses a hash with an exclaimation mark in one of the values' do
+    dson_string = 'such "cheese" is "," wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['cheese']).to eq(',')
+  end
+
+end
+
+describe 'DSON nested hashes' do
+  it 'should handle a simple nested hash' do
+    dson_string = 'such "nested" is such wow wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['nested'].keys.size).to eq(0)
+  end
+
+  it 'should handle a further nested hash' do
+    dson_string = 'such "nested" is such "further_nested" is such wow wow wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['nested']['further_nested'].keys.size).to eq(0)
+  end
+
+  it 'should handle other elements in this hash' do
+    dson_string = 'such "other" is "true"! "nested" is such wow wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['other']).to eq('true')
+    expect(parsed_dson['nested'].keys.size).to eq(0)
+  end
+
+  it 'should handle elements in a nested hash' do
+    dson_string = 'such "other" is "true". "nested" is such "element" is "great" wow wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['other']).to eq('true')
+    expect(parsed_dson['nested']['element']).to eq('great')
+  end
+
+  it 'should handle multiple elements in the nested hash' do
+    dson_string = 'such "wine" is such "white" is "great"? "red" is "greater" wow wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['wine']['white']).to eq('great')
+    expect(parsed_dson['wine']['red']).to eq('greater')
+  end
+end
+
+describe 'DSON hash and array mixes' do
+
+  it 'should handle an array of empty objects' do
+    dson_string = 'so such wow also such wow many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson.size).to eq(2)
+    expect(parsed_dson[0].keys.size).to eq(0)
+    expect(parsed_dson[1].keys.size).to eq(0)
+  end
+
+  it 'should handle an object with an empty array element' do
+    dson_string = 'such "array" is so many wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['array'].size).to eq(0)
+  end
+
+  it 'should handle an object with an array element' do
+    dson_string = 'such "array" is so "olive" also "grape" many wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['array'][0]).to eq('olive')
+    expect(parsed_dson['array'][1]).to eq('grape')
+  end
+
+  it 'should handle an array with an object element' do
+    dson_string = 'so such "first_name" is "Cyril", "surname" is "Figgis" wow many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[0]['first_name']).to eq('Cyril')
+    expect(parsed_dson[0]['surname']).to eq('Figgis')
+  end
+
+end
+
+describe 'parsing DSON booleans' do
+  it 'should translate yes in a hash to true' do
+    dson_string = 'such "dson" is yes wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['dson']).to be_a(TrueClass)
+  end
+
+  it 'should translate yes in an array to true' do
+    dson_string = 'so yes many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[0]).to be_a(TrueClass)
+  end
+
+  it 'should translate no in a hash to false' do
+    dson_string = 'such "json" is no wow'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson['json']).to be_a(FalseClass)
+  end
+
+  it 'should translate no in an array to false' do
+    dson_string = 'so no many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[0]).to be_a(FalseClass)
+  end
+end
+
+describe 'parsing DSON empty' do
+  it 'should translate empty to nil' do
+    dson_string = 'so empty many'
+    parsed_dson = DSON.so_parse(dson_string)
+
+    expect(parsed_dson[0]).to be_nil
+  end
+end

data/spec/{dson_spec.rb → serialization_spec.rb}

@@ -6,7 +6,7 @@ require_relative 'lib/example_class'
 PUNCTUATION_MATCH = '(,|\.|!|\\?)'
 AND_MATCH = '(and|also)'
 
-describe 'DSON simple hash handling' do
+describe 'simple hashes' do
 
   it 'should be correct with an empty hash' do
     dson_hash = Hash.new
@@ -342,16 +342,16 @@ describe 'ruby objects' do
     ruby_object = DSONSpec::ExampleClass.new('awesome', 'superb')
     dson_string = DSON.such_serialize_wow(ruby_object)
 
-    real_or_imaginary = '("name" is "awesome"|"value" is "superb")'
+    name_or_value = '("name" is "awesome"|"value" is "superb")'
 
     expect(dson_string).to match(
-      /such #{real_or_imaginary}#{PUNCTUATION_MATCH} #{real_or_imaginary} wow/
+      /such #{name_or_value}#{PUNCTUATION_MATCH} #{name_or_value} wow/
     )
   end
 
 end
 
-# TODO fix when we can do octals generically
+# TODO: fix when we can do octals generically
 # describe "DSON numbers" do
 
 #   it "doesn't quote numeric values" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: DSON
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-22 00:00:00.000000000 Z
+date: 2014-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &12407260 !ruby/object:Gem::Requirement
+  requirement: &19948880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *12407260
+  version_requirements: *19948880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &12406820 !ruby/object:Gem::Requirement
+  requirement: &19948380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12406820
+  version_requirements: *19948380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &12406160 !ruby/object:Gem::Requirement
+  requirement: &19947660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12406160
+  version_requirements: *19947660
 - !ruby/object:Gem::Dependency
   name: rubocop
-  requirement: &12405540 !ruby/object:Gem::Requirement
+  requirement: &19947060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12405540
+  version_requirements: *19947060
 - !ruby/object:Gem::Dependency
   name: magic_encoding
-  requirement: &12404980 !ruby/object:Gem::Requirement
+  requirement: &19946380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12404980
+  version_requirements: *19946380
 description: 
 email:
 - imran.pshakir@gmail.com
@@ -90,8 +90,9 @@ files:
 - lib/DSON/value/string_value.rb
 - lib/DSON/value/true_value.rb
 - lib/DSON/version.rb
-- spec/dson_spec.rb
 - spec/lib/example_class.rb
+- spec/parsing_spec.rb
+- spec/serialization_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -118,5 +119,6 @@ signing_key:
 specification_version: 3
 summary: A pure-ruby DSON Serializer
 test_files:
-- spec/dson_spec.rb
 - spec/lib/example_class.rb
+- spec/parsing_spec.rb
+- spec/serialization_spec.rb