space_object 0.1.1 → 0.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGZkZTdlNzAxMjA1YjIxOTA5YTk2NGY0MjY1ZjUzOWMxYTg0N2EyNA==
+    MTU2ZjBhNWE0NWVhZGZhMzM1OTQxMTUzNjYyNDlhMzU1ZTk2ZGQxNQ==
   data.tar.gz: !binary |-
-    ZjBmZWI0OGQxZjRiMzEzNjNjMzliNDRjOTE4Mzk5NTAzNmYwOGU3YQ==
+    MDQ3OWFiOWIyMTIyZjFiODI2NmVlOGEzMGY1MWIyOGM0OTNjNGIyZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OTc1ZmY5ZjY2MjcyOGQ5N2IwOWNkMzg4Zjc3OTU5ZDYwZDY1NTJkMjk3MDE4
-    MGIzNmQ0NGNiMmNlYzAxMGU0MmYwN2E1ZGU4MjFjZWFiZjFiMTY3NzNmMjMw
-    OTIzMmNhY2JkNjc3YjRhOThmZDNkNmJkY2JlMTAzNmUwZWUxNDY=
+    YzcxNWE1N2QxMzczNmEyMzk3M2Q4Yjg0M2EyZmM2OGE0MDI1NGRlZmE5MjZl
+    NGIzYTIzMWMzMTExYTc2NWU1ZGFmNjFkYmIzNTYyNTg5ZWY4N2Q1OTA4Yzc1
+    ODk5YjRjNGZkM2EyZDYzMjQzMzc1MGI3NzE2ZmQ2MGQ5ZDY5Mjg=
   data.tar.gz: !binary |-
-    MWEwM2E4YmJiM2I1MzZhNjE3MWY0ZjhiNThkMjZlNzBkZjgyMjZkZTg5MDk0
-    NjViN2JhMjU2NzU3MDczOGFlZmU2N2RjODk3NzU3MGM1MWI2NTVmNjc2MTg3
-    NWI2NWU2NGViMjBlYTNmMmE2ZDMzNDMxY2FiYzdhMzA3OWIwMzU=
+    MmNjNDY2YTRjMjZkOTY2NzQ1YmU5MmE5OTdlZWJiMWIwNGYwMWNlMmY4ODJi
+    ZGQ2Yzg0YTI3N2I2NmJjZDIwYjRlY2NhYTU5MzZkMGU1MjBiODc0NzY4M2Ey
+    MjViYjg1MDFmYTk2MmUyNjZkYWI4NTJkMTY5MTQ2ZjZlNDBjZmY=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    space_object (0.0.1)
+    space_object (0.1.3)
       activesupport (~> 4.0)
 
 GEM

data/lib/space_object/base.rb

@@ -1,6 +1,72 @@
 require 'active_support/ordered_hash'
+require 'space_object/core_ext/object/space_object'
 
 module SpaceObject
   class Base < ActiveSupport::OrderedHash
+    def [](key)
+      key = convert_key!(key)
+      unless key[' ']
+        super(key)
+      else
+        first_key = key[/^[^ ]+/]
+        value = self[first_key]
+
+        return nil if hash.nil?
+        rest_keys = key[(first_key.length + 1)..-1]
+        value[rest_keys]
+      end
+    end
+
+    def []=(key, value)
+      key = convert_key!(key)
+      unless key[' ']
+        super(key, convert_value!(value))
+      else
+        first_key = key[/^[^ ]+/]
+        value = (self[first_key] ||= self.class.new)
+        value[(first_key.length + 1)..-1] = value
+      end
+    end
+
+    alias_method :store, :[]=
+
+    def default(key = nil)
+      super(key ? convert_key!(key) : nil)
+    end
+
+    def default=(val)
+      super(key ? convert_key!(key) : nil)
+    end
+
+    def fetch(key, *extras)
+      key = convert_key!(key)
+      first_key = key[/^[^ ]+/]
+
+      value = self[first_key]
+      if key[' '].nil? || hash.nil?
+        super(key, *extras)
+      else
+        value.fetch(first_key, *extras)
+      end
+    end
+
+    protected
+    def convert_key(key)
+      key.to_nested_space_key
+    end
+
+    def convert_key!(key)
+      raise(ArgumentError, "#{key.class} cannot be stored as a key in a #{self.class}") unless key.respond_to?(:to_nested_space_key)
+      convert_key(key)
+    end
+
+    def convert_value(val)
+      val.to_space_value
+    end
+
+    def convert_value!(val)
+      raise(ArgumentError, "#{val.class} cannot be stored as a key in a #{self.class}") unless val.respond_to?(:to_space_value)
+      convert_value(val)
+    end
   end
 end

data/lib/space_object/core_ext/object/space_object.rb

@@ -0,0 +1,100 @@
+# List of classes to encode mirrors JSON encodable objects in ActiveSupport
+
+require 'time'
+require 'space_object/string_encodable'
+
+class Array
+  def to_space_object
+    each_with_index.map do |item, index|
+      {index => item}.to_space_object
+    end
+  end
+
+  def to_space_value
+    to_space_object
+  end
+end
+
+class Date
+  include SpaceObject::StringEncodable
+end
+
+class DateTime
+  include SpaceObject::StringEncodable
+end
+
+module Enumerable
+  def to_space_object
+    to_a.to_space_object
+  end
+
+  def to_space_value
+    to_space_object
+  end
+end
+
+class FalseClass
+  include SpaceObject::StringEncodable
+end
+
+class Hash
+  def to_space_object
+    SpaceObject::Encoder.new(self).encode
+  end
+end
+
+class NilClass
+  include SpaceObject::StringEncodable
+end
+
+class Numeric
+  include SpaceObject::StringEncodable
+end
+
+class Object
+  # Highly inspired by ActiveSupport
+  def to_space_object
+    hash = respond_to?(:to_hash) ? to_hash : insance_values
+    hash.to_space_object
+  end
+
+  def to_space_value
+    to_space_object
+  end
+end
+
+class Process::Status
+  include SpaceObject::StringEncodable
+end
+
+class Regexp
+  include SpaceObject::StringEncodable
+end
+
+class String
+  include SpaceObject::StringEncodable
+end
+
+class Symbol
+  include SpaceObject::StringEncodable
+end
+
+class Struct
+  # Highly inspired by ActiveSupport
+  def to_space_object
+    hash = Hash[members.zip(values)]
+    hash.to_space_object
+  end
+
+  def to_space_value
+    to_space_object
+  end
+end
+
+class Time
+  include SpaceObject::StringEncodable
+end
+
+class TrueClass
+  include SpaceObject::StringEncodable
+end

data/lib/space_object/encode_error.rb

@@ -0,0 +1,2 @@
+class SpaceObject::EncodeError < StandardError
+end

data/lib/space_object/encoder.rb

@@ -0,0 +1,22 @@
+require 'space_object/base'
+
+module SpaceObject
+  class Encoder
+    def initialize(object, options = {})
+      self.object = object
+      @as_key = !options.has_key?(:key) || options[:key]
+    end
+
+    def encode
+      raise(ArgumentError, "#{@object} is not a Hash") unless @object.is_a?(Hash)
+      @object.inject(Base.new) do |space, (key, val)|
+        space[key.to_space_key] = val.to_space_value
+        space
+      end
+    end
+
+    def object=(object)
+      @object = object
+    end
+  end
+end

data/lib/space_object/parser.rb

@@ -19,6 +19,9 @@ module SpaceObject
       @document =  @document.strip.gsub(/(\r\n|\n\r|\n\n+)/, "\n")
     end
 
+    def populate_space(space, str)
+    end
+
     def parse_string(str)
       str.split(DELIMITER).inject(Base.new) do |obj, space|
         key, value = if matches = KEY_LINE.match(space)
@@ -28,7 +31,7 @@ module SpaceObject
           offset = matches[1].length + 1
           [matches[1], space[offset..-1].gsub(NEST_SPACING, "\n")]
         end
-        key and obj[key] = value
+        (key.nil? || key.empty?) or obj[key] = value
         obj
       end
     end

data/lib/space_object/string_encodable.rb

@@ -0,0 +1,19 @@
+require 'space_object/encode_error'
+
+module SpaceObject
+  module StringEncodable
+    def to_nested_space_key
+      to_s
+    end
+
+    def to_space_key
+      str = to_nested_space_key
+      raise(EncodeError, "`#{str}' contains spaces and cannot be used as a key") if str[' ']
+      str
+    end
+
+    def to_space_value
+      to_s
+    end
+  end
+end

data/lib/space_object/version.rb

@@ -1,4 +1,4 @@
 module SpaceObject
   # space_object version
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/space_object.rb

@@ -1,9 +1,15 @@
 require 'space_object/version'
+require 'space_object/encode_error'
 require 'space_object/base'
 require 'space_object/parser'
+require 'space_object/encoder'
 
 module SpaceObject
   class << self
+    def encode(object)
+      Encoder.new(object).encode
+    end
+
     def parse(document)
       Parser.new(document).parse
     end

data/spec/space_object/base_spec.rb

@@ -1,7 +1,41 @@
 require 'spec_helper'
 
 describe SpaceObject::Base do
-  it 'is an ActiveSupport::OrderedHash' do
-    expect(subject).to be_an(ActiveSupport::OrderedHash)
+  let(:key) { 'foo' }
+  let(:not_contained) { 'baz' }
+  let(:value) { 'bar' }
+
+  it 'is an Enumerable' do
+    expect(subject).to be_an(Enumerable)
+  end
+
+  describe '[]' do
+    subject { SpaceObject.encode({key => value}) }
+
+    it 'returns nil if the key does not exist' do
+      expect(subject[not_contained]).to be_nil
+    end
+
+    it 'returns the value for a key which exists' do
+      expect(subject[key]).to eq(value)
+    end
+
+    it 'can query with a key which implements #to_s' do
+      expect(subject[key.to_sym]).to eq(subject[key])
+    end
+  end
+
+  describe '[]=' do
+    subject { SpaceObject::Base.new }
+
+    it 'can assign with a non-nested key' do
+      subject[key] = value
+      expect(subject[key]).to eq(value)
+    end
+
+    it 'can assign with a key which implements #to_s' do
+      subject[key.to_sym] = value
+      expect(subject[key]).to eq(value)
+    end
   end
 end

data/spec/space_object/encoder_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe SpaceObject::Encoder do
+  let(:valid_example) { {:hello => 'world', 'foo' => :bar, 'foobar' => {'baz' => 'zip'}} }
+  let(:invalid_example) { { 'keys are not allowed' => 'value' } }
+  let(:wrong_class) { ['foo'] }
+
+  describe '#encode' do
+    it 'only encodes Hash objects' do
+      expect { SpaceObject::Encoder.new(wrong_class).encode }.to raise_error(ArgumentError)
+    end
+
+    it 'encodes a compliant Hash as a SpaceObject::Base' do |variable|
+      space = SpaceObject::Encoder.new(valid_example).encode
+      expect(space['hello']).to eq('world')
+      expect(space['foo']).to eq('bar')
+      expect(space['foobar baz']).to eq('zip')
+    end
+
+    it 'raises a SpaceObject::EncodeError if an invalid key is present' do
+      expect { SpaceObject::Encoder.new(invalid_example).encode }.to raise_error(SpaceObject::EncodeError)
+    end
+  end
+end

data/spec/space_object/parser_spec.rb

@@ -19,22 +19,22 @@ describe SpaceObject::Parser do
     end
 
     context 'when given a key-value pair' do
-      it_has_behavior 'correctness', 'key value', SpaceObject::Base.try_convert({'key' => 'value'})
+      it_has_behavior 'correctness', 'key value', SpaceObject.encode({'key' => 'value'})
     end
 
     context 'when given multiple key-value pairs' do
-      it_has_behavior 'correctness', "1 2\na b", SpaceObject::Base.try_convert({'1' => '2', 'a' => 'b'})
+      it_has_behavior 'correctness', "1 2\na b", SpaceObject.encode({'1' => '2', 'a' => 'b'})
     end
 
     context 'when given a nested space' do
       document = "foo\n" +
         " bar\n" +
         " baz foobar"
-      expected = SpaceObject::Base.try_convert({
-        'foo' => SpaceObject::Base.try_convert({
-          'bar' => SpaceObject::Base.new,
+      expected = SpaceObject.encode({
+        'foo' => {
+          'bar' => {},
           'baz' => 'foobar'
-        })
+        }
       })
       it_has_behavior 'correctness', document, expected
     end

data/spec/space_object_spec.rb

@@ -5,21 +5,45 @@ describe SpaceObject do
     expect(subject.const_get('VERSION')).not_to be_empty
   end
 
+  describe(:encode) do
+    let(:hash) { {'foo' => 'bar'} }
+    let(:encoder) { SpaceObject::Encoder.new(hash) }
+
+    before(:each) {
+      @instance = encoder
+      @instance.stub(:encode)
+      SpaceObject::Encoder.stub(:new).and_return(@instance)
+
+      SpaceObject.encode(hash)
+    }
+
+    it "creates a new SpaceObject::Encoder" do
+      expect(SpaceObject::Encoder).to have_received(:new).with(hash)
+    end
+
+    it "calls SpaceObject::Parser#encode" do
+      expect(@instance).to have_received(:encode)
+    end
+  end
+
   describe "::parse" do
     let(:test_document) { 'foo bar' }
+    let(:parser) { SpaceObject::Parser.new(test_document) }
 
     before(:each) {
-      @instance = SpaceObject::Parser.new(test_document)
+      @instance = parser
+      @instance.stub(:parse)
       SpaceObject::Parser.stub(:new).and_return(@instance)
+
+      SpaceObject.parse(test_document)
     }
 
     it "creates a new SpaceObject::Parser" do
-      SpaceObject.parse(test_document) and expect(SpaceObject::Parser).to have_received(:new).with(test_document)
+      expect(SpaceObject::Parser).to have_received(:new).with(test_document)
     end
 
     it "calls SpaceObject::Parser#parse" do
-      @instance.stub(:parse)
-      SpaceObject.parse(test_document) and expect(@instance).to have_received(:parse)
+      expect(@instance).to have_received(:parse)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: space_object
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Robert Fruchtman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2013-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -83,10 +83,15 @@ files:
 - Rakefile
 - lib/space_object.rb
 - lib/space_object/base.rb
+- lib/space_object/core_ext/object/space_object.rb
+- lib/space_object/encode_error.rb
+- lib/space_object/encoder.rb
 - lib/space_object/parser.rb
+- lib/space_object/string_encodable.rb
 - lib/space_object/version.rb
 - space_object.gemspec
 - spec/space_object/base_spec.rb
+- spec/space_object/encoder_spec.rb
 - spec/space_object/parser_spec.rb
 - spec/space_object_spec.rb
 - spec/spec_helper.rb
@@ -116,6 +121,7 @@ specification_version: 4
 summary: A lightweight language for objects
 test_files:
 - spec/space_object/base_spec.rb
+- spec/space_object/encoder_spec.rb
 - spec/space_object/parser_spec.rb
 - spec/space_object_spec.rb
 - spec/spec_helper.rb