DSON 0.0.2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/DSON.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'DSON/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "DSON"
+  spec.version       = DSON::VERSION
+  spec.authors       = ["ishakir"]
+  spec.email         = ["imran.pshakir@gmail.com"]
+  spec.summary       = %q{A pure-ruby DSON Serializer}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "magic_encoding"
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in DSON.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 ishakir
+
+MIT License
+
+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,48 @@
+# DSON
+
+Such serialization! Totally pure-ruby also completely DSON. Wow!
+
+Currently known deficiencies:
+* Number handling (needs to be octal, currently treated as string)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'DSON'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install DSON
+
+## Usage
+
+Currently supports a ruby 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'
+
+    puts DSON.such_serialize_wow({
+      ruby: 'pure',
+      supports: [
+        'hash',
+        'array'
+      ]
+    })
+
+This should output:
+
+    such "ruby" is "pure", "supports" is so "hash" also "array" many wow
+
+Correct to the DSON spec
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/DSON/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/DSON.rb

@@ -0,0 +1,9 @@
+# -*- encoding : utf-8 -*-
+require 'DSON/version'
+require 'DSON/value'
+
+module DSON
+  def self.such_serialize_wow(subject)
+    DSON::Value.new(subject).such_serialize_wow
+  end
+end

data/lib/DSON/value.rb

@@ -0,0 +1,33 @@
+# -*- encoding : utf-8 -*-
+require 'DSON/value/hash_value'
+require 'DSON/value/array_value'
+require 'DSON/value/string_value'
+require 'DSON/value/nil_value'
+require 'DSON/value/true_value'
+require 'DSON/value/false_value'
+require 'DSON/value/numeric_value'
+
+module DSON
+  module Value
+    SPACE = %q( )
+
+    def self.new(value)
+      return HashValue.new(value)    if value.respond_to? :keys
+      return ArrayValue.new(value)   if value.respond_to? :each
+      return NilValue.instance       if value.nil?
+      return TrueValue.instance      if value.is_a? TrueClass
+      return FalseValue.instance     if value.is_a? FalseClass
+      #return NumericValue.new(value) if value.is_a? Fixnum
+      StringValue.new(value)
+    end
+
+    def reduce(list, potential_joiners)
+      list.each_with_index.reduce('') do |acc, (element, index)|
+        is_last = (index == list.size - 1)
+
+        formed_string = is_last ? element : element + potential_joiners.sample
+        acc + formed_string + SPACE
+      end
+    end
+  end
+end

data/lib/DSON/value/array_value.rb

@@ -0,0 +1,23 @@
+# -*- encoding : utf-8 -*-
+module DSON
+  module Value
+    class ArrayValue
+      include Value
+
+      POTENTIAL_JOINERS = [' and' , ' also']
+
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def such_serialize_wow
+        content = value.map do |arr_elem|
+          Value.new(arr_elem).such_serialize_wow
+        end
+        'so ' + reduce(content, POTENTIAL_JOINERS) + 'many'
+      end
+    end
+  end
+end

data/lib/DSON/value/false_value.rb

@@ -0,0 +1,16 @@
+require 'DSON/value'
+
+require 'singleton'
+
+module DSON
+  module Value
+    class FalseValue
+      include Value
+      include Singleton
+      
+      def such_serialize_wow
+        "no"
+      end
+    end
+  end
+end

data/lib/DSON/value/hash_value.rb

@@ -0,0 +1,28 @@
+# -*- encoding : utf-8 -*-
+require 'DSON/value'
+
+module DSON
+  module Value
+    class HashValue
+      include Value
+
+      POTENTIAL_PUNCTUATION = %w(, . ! ?)
+
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def such_serialize_wow
+        strings = value.keys.map do |key|
+          key_str = StringValue.new(key).such_serialize_wow
+          value_str = Value.new(value[key]).such_serialize_wow
+
+          %Q(#{key_str} is #{value_str})
+        end
+        'such ' + reduce(strings, POTENTIAL_PUNCTUATION) + 'wow'
+      end
+    end
+  end
+end

data/lib/DSON/value/nil_value.rb

@@ -0,0 +1,17 @@
+require 'DSON/value'
+
+require 'singleton'
+
+module DSON
+  module Value
+    class NilValue
+      include Value
+      include Singleton
+
+      def such_serialize_wow
+        "empty"
+      end
+
+    end
+  end
+end

data/lib/DSON/value/numeric_value.rb

@@ -0,0 +1,20 @@
+# -*- encoding : utf-8 -*-
+require 'DSON/value'
+
+module DSON
+  module Value
+    class NumericValue
+      include Value
+      
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def such_serialize_wow
+        value
+      end
+    end
+  end
+end

data/lib/DSON/value/string_value.rb

@@ -0,0 +1,20 @@
+# -*- encoding : utf-8 -*-
+require 'DSON/value'
+
+module DSON
+  module Value
+    class StringValue
+      include Value
+      
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def such_serialize_wow
+        "\"#{value}\""
+      end
+    end
+  end
+end

data/lib/DSON/value/true_value.rb

@@ -0,0 +1,16 @@
+require 'DSON/value'
+
+require 'singleton'
+
+module DSON
+  module Value
+    class TrueValue
+      include Value
+      include Singleton
+      
+      def such_serialize_wow
+        "yes"
+      end
+    end
+  end
+end

data/lib/DSON/value/variable_value.rb

@@ -0,0 +1,14 @@
+# -*- encoding : utf-8 -*-
+module DSON
+  class VariableValue
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def such_serialize_wow
+      "\"#{value}\""
+    end
+  end
+end

data/lib/DSON/version.rb

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

data/spec/dson_spec.rb

@@ -0,0 +1,369 @@
+# -*- encoding : utf-8 -*-
+require 'DSON'
+
+PUNCTUATION_MATCH = '(,|\.|!|\\?)'
+AND_MATCH = '(and|also)'
+
+describe 'DSON simple hash handling' do
+
+  it 'should be correct with an empty hash' do
+    dson_hash = Hash.new
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    expect(dson_string).to eq(
+      'such wow'
+    )
+  end
+
+  it 'should be correct with a hash with one element' do
+    dson_hash = {
+      dson: 'awesome'
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    expect(dson_string).to eq(
+      'such "dson" is "awesome" wow'
+    )
+  end
+
+  it 'should be correct with a hash with two elements' do
+    dson_or_ruby = '("dson" is "awesome"|"ruby" is "great")'
+
+    dson_hash = {
+      dson: 'awesome',
+      ruby: 'great'
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    expect(dson_string).to match(
+      /such #{dson_or_ruby}#{PUNCTUATION_MATCH} #{dson_or_ruby} wow/
+    )
+  end
+
+  it 'should be correct with a hash with three elements' do
+    dson_ruby_or_dogescript =
+      '(' \
+        '"dson" is "awesome"' \
+      '|' \
+        '"ruby" is "great"' \
+      '|' \
+        '"dogescript" is "fine"' \
+      ')'
+
+    dson_hash = {
+      dson: 'awesome',
+      ruby: 'great',
+      dogescript: 'fine'
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    regex_string =
+      'such' \
+      ' ' +
+      dson_ruby_or_dogescript +
+      PUNCTUATION_MATCH +
+      ' ' +
+      dson_ruby_or_dogescript +
+      PUNCTUATION_MATCH +
+      ' ' +
+      dson_ruby_or_dogescript +
+      ' ' +
+      'wow'
+
+    expect(dson_string).to match(
+      /#{regex_string}/
+    )
+  end
+
+end
+
+describe 'DSON simple array handling' do
+
+  it 'should correctly handle an empty array' do
+    dson_array = Array.new
+    dson_string = DSON.such_serialize_wow(dson_array)
+
+    expect(dson_string).to eq(
+      'so many'
+    )
+  end
+
+  it 'should correctly handle an array with a single element' do
+    dson_array = %w(cheese)
+    dson_string = DSON.such_serialize_wow(dson_array)
+
+    expect(dson_string).to eq(
+      'so "cheese" many'
+    )
+  end
+
+  it 'should correctly handle an array with two elements' do
+    dson_array = %w(cheese wine)
+    dson_string = DSON.such_serialize_wow(dson_array)
+
+    expect(dson_string).to match(
+      /so "cheese" #{AND_MATCH} "wine" many/
+    )
+  end
+
+  it 'should correctly handle an array with three elements' do
+    dson_array = %w(cheese wine bread)
+    dson_string = DSON.such_serialize_wow(dson_array)
+
+    expect(dson_string).to match(
+      /so "cheese" #{AND_MATCH} "wine" #{AND_MATCH} "bread" many/
+    )
+  end
+
+end
+
+describe 'DSON nested arrays' do
+
+  it 'should correctly handle empty nested arrays' do
+    dson_array = [[]]
+    dson_string = DSON.such_serialize_wow(dson_array)
+
+    expect(dson_string).to eq(
+      'so so many many'
+    )
+  end
+
+  it 'should correctly handle nested arrays with elements' do
+    dson_array = ['cheese', []]
+    dson_string = DSON.such_serialize_wow(dson_array)
+
+    expect(dson_string).to match(
+      /so "cheese" #{AND_MATCH} so many many/
+    )
+  end
+
+  it 'should correctly handle a nested array with an element' do
+    dson_array = [['cheese']]
+    dson_string = DSON.such_serialize_wow(dson_array)
+
+    expect(dson_string).to eq(
+      'so so "cheese" many many'
+    )
+  end
+
+  it 'should correctly handle a more complex nested array' do
+    dson_array = ['cheese', ['cheese', ['cheese']]]
+    dson_string = DSON.such_serialize_wow(dson_array)
+
+    expect(dson_string).to match(
+      /so "cheese" #{AND_MATCH} so "cheese" #{AND_MATCH} so "cheese" many many many/
+    )
+  end
+
+end
+
+describe 'DSON nested hashes' do
+
+  it 'should handle a simple nested hash' do
+    dson_hash = {
+      nested: {}
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    expect(dson_string).to eq(
+      'such "nested" is such wow wow'
+    )
+  end
+
+  it 'should handle a further nested hash' do
+    dson_hash = {
+      nested: {
+        further_nested: {
+        }
+      }
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    expect(dson_string).to eq(
+      'such "nested" is such "further_nested" is such wow wow wow'
+    )
+  end
+
+  it 'should handle other elements in this hash' do
+    dson_hash = {
+      other: 'true',
+      nested: {
+      }
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    other_or_nested = '("other" is "true"|"nested" is such wow)'
+
+    expect(dson_string).to match(
+      /such #{other_or_nested}#{PUNCTUATION_MATCH} #{other_or_nested} wow/
+    )
+  end
+
+  it 'should handle elements in a nested hash' do
+    dson_hash = {
+      other: 'true',
+      nested: {
+        element: 'great'
+      }
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    other_or_nested = '("other" is "true"|"nested" is such "element" is "great" wow)'
+
+    expect(dson_string).to match(
+      /such #{other_or_nested}#{PUNCTUATION_MATCH} #{other_or_nested} wow/
+    )
+  end
+
+  it 'should handle multiple elements in the nested hash' do
+    dson_hash = {
+      wine: {
+        white: 'great',
+        red: 'greater'
+      }
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    white_or_red = '("white" is "great"|"red" is "greater")'
+
+    expect(dson_string).to match(
+      /such "wine" is such #{white_or_red}#{PUNCTUATION_MATCH} #{white_or_red} wow wow/
+    )
+  end
+
+end
+
+describe 'DSON hash and array mixes' do
+
+  it 'should handle an array of empty objects' do
+    dson_array = [
+      {}, {}
+    ]
+    dson_string = DSON.such_serialize_wow(dson_array)
+
+    expect(dson_string).to match(
+      /so such wow #{AND_MATCH} such wow many/
+    )
+  end
+
+  it 'should handle an object with an empty array element' do
+    dson_hash = {
+      array: []
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    expect(dson_string).to eq(
+      'such "array" is so many wow'
+    )
+  end
+
+  it 'should handle an object with an array element' do
+    dson_hash = {
+      array: [
+        'olive',
+        'grape'
+      ]
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    expect(dson_string).to match(
+      /such "array" is so "olive" #{AND_MATCH} "grape" many wow/
+    )
+  end
+
+  it 'should handle an array with an object element' do
+    dson_array = [
+      {
+        first_name: 'Cyril',
+        surname: 'Figgis'
+      }
+    ]
+    dson_string = DSON.such_serialize_wow(dson_array)
+
+    first_or_last_name = '("first_name" is "Cyril"|"surname" is "Figgis")'
+
+    expect(dson_string).to match(
+      /so such #{first_or_last_name}#{PUNCTUATION_MATCH} #{first_or_last_name} wow many/
+    )
+  end
+
+end
+
+describe "DSON empty" do
+
+  it "translates a nil object to empty" do
+    dson_hash = {
+      value: nil
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    expect(dson_string).to eq(
+      'such "value" is empty wow'
+    )
+  end
+
+end
+
+describe "DSON booleans" do
+
+  it "translates a true object to yes" do
+    dson_hash = {
+      value: true
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    expect(dson_string).to eq(
+      'such "value" is yes wow'
+    )
+  end
+
+  it "translates a false object to no" do
+    dson_hash = {
+      value: false
+    }
+    dson_string = DSON.such_serialize_wow(dson_hash)
+
+    expect(dson_string).to eq(
+      'such "value" is no wow'
+    )
+  end
+
+end
+
+#TODO fix when we can do octals generically
+# describe "DSON numbers" do
+
+#   it "doesn't quote numeric values" do
+#     dson_hash = {
+#       value: 13
+#     }
+#     dson_string = DSON.such_serialize_wow(dson_hash)
+
+#     expect(dson_string).to eq(
+#       'such "value" is 13 wow'
+#     )
+#   end
+
+#   it "quotes numeric values represented as strings" do
+#     dson_hash = {
+#       value: "13"
+#     }
+#     dson_string = DSON.such_serialize_wow(dson_hash)
+
+#     expect(dson_string).to eq(
+#       'such "value" is "13" wow'
+#     )
+#   end
+
+#   it "quotes float values" do
+#     dson_hash = {
+#       value: 12.5
+#     }
+#     dson_string = DSON.such_serialize_wow(dson_hash)
+
+#     expect(dson_string).to eq(
+#       'such "value" is 12.5 wow'
+#     )
+#   end
+
+# end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: DSON
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- ishakir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-16 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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: '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: rubocop
+  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: magic_encoding
+  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: 
+email:
+- imran.pshakir@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- DSON.gemspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/DSON.rb
+- lib/DSON/value.rb
+- lib/DSON/value/array_value.rb
+- lib/DSON/value/false_value.rb
+- lib/DSON/value/hash_value.rb
+- lib/DSON/value/nil_value.rb
+- lib/DSON/value/numeric_value.rb
+- lib/DSON/value/string_value.rb
+- lib/DSON/value/true_value.rb
+- lib/DSON/value/variable_value.rb
+- lib/DSON/version.rb
+- spec/dson_spec.rb
+homepage: ''
+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.24
+signing_key: 
+specification_version: 3
+summary: A pure-ruby DSON Serializer
+test_files:
+- spec/dson_spec.rb