hyperion-api 0.1.0 → 0.1.1

data/lib/hyperion.rb

@@ -16,13 +16,19 @@ module Hyperion
   end
 
   def self.pack(type, &block)
-    @packers ||= {}
-    @packers[type] = block
+    packers[type] = block
+  end
+
+  def self.packer_defined?(type)
+    packers.has_key?(type)
   end
 
   def self.unpack(type, &block)
-    @unpackers ||= {}
-    @unpackers[type] = block
+    unpackers[type] = block
+  end
+
+  def self.unpacker_defined?(type)
+    unpackers.has_key?(type)
   end
 
   # Sets the active datastore
@@ -121,6 +127,14 @@ module Hyperion
 
   private
 
+  def self.packers
+    @packers ||= {}
+  end
+
+  def self.unpackers
+    @unpackers ||= {}
+  end
+
   def self.build_query(kind, args)
     kind = Format.format_kind(kind)
     filters = build_filters(args[:filters])

data/lib/hyperion/dev/ds_spec.rb

@@ -1,3 +1,5 @@
+require 'hyperion/types'
+
 shared_examples_for 'Datastore' do
 
   def api
@@ -262,4 +264,25 @@ shared_examples_for 'Datastore' do
 
     end
   end
+
+  Hyperion.defentity(:shirt) do |kind|
+    kind.field(:account_key, :type => Hyperion::Types.foreign_key(:account))
+  end
+
+  Hyperion.defentity(:account) do |kind|
+    kind.field(:first_name)
+  end
+
+  context 'foreign_keys' do
+    it 'saves records with foreign keys' do
+      account = api.save(:kind => :account)
+      account_key = account[:key]
+      shirt  = api.save(:kind => :shirt, :account_key => account_key)
+      found_shirt = api.find_by_key(shirt[:key])
+      found_account = api.find_by_key(account_key)
+      shirt[:account_key].should == account_key
+      found_shirt[:account_key].should == account_key
+      found_account[:key].should == account_key
+    end
+  end
 end

data/lib/hyperion/memory.rb

@@ -1,10 +1,10 @@
 require 'hyperion'
+require 'hyperion/key'
 
 module Hyperion
   class Memory
 
     def initialize(opts={})
-      @id_counter = 0
       @store = {}
     end
 
@@ -48,6 +48,14 @@ module Hyperion
       find(query).length
     end
 
+    def pack_key(kind, key)
+      key
+    end
+
+    def unpack_key(kind, key)
+      key
+    end
+
     private
 
     attr_reader :store
@@ -95,7 +103,7 @@ module Hyperion
     end
 
     def generate_key
-      @id_counter += 1
+      Hyperion::Key.generate_id
     end
 
     def apply_offset(offset, records)

data/lib/hyperion/types.rb

@@ -0,0 +1,22 @@
+require 'hyperion'
+require 'hyperion/format'
+
+module Hyperion
+  class Types
+    class << self
+
+      def foreign_key(kind)
+        kind_key = "#{Format.format_kind(kind)}_key".to_sym
+        unless Hyperion.packer_defined?(kind_key)
+          Hyperion.pack(kind_key) do |key|
+            Hyperion.datastore.pack_key(kind, key)
+          end
+          Hyperion.unpack(kind_key) do |key|
+            Hyperion.datastore.unpack_key(kind, key)
+          end
+        end
+        kind_key
+      end
+    end
+  end
+end

data/spec/hyperion/fake_ds.rb

@@ -1,13 +1,15 @@
 module Hyperion
   class FakeDs
 
-    attr_accessor :saved_records, :queries, :key_queries, :returns
+    attr_accessor :saved_records, :queries, :key_queries, :returns, :key_pack_queries,:key_unpack_queries
 
     def initialize(opts={})
       @saved_records = []
       @returns = []
       @queries = []
       @key_queries = []
+      @key_pack_queries = []
+      @key_unpack_queries = []
     end
 
     def save(records)
@@ -40,5 +42,13 @@ module Hyperion
       returns.shift || 0
     end
 
+    def pack_key(kind, key)
+      @key_pack_queries << {:kind => kind, :key => key}
+    end
+
+    def unpack_key(kind, key)
+      @key_unpack_queries << {:kind => kind, :key => key}
+    end
+
   end
 end

data/spec/hyperion/shared_examples.rb

@@ -134,7 +134,16 @@ shared_examples_for 'record packing' do |actor|
   it 'prefers the custom packer over the type packer' do
     result = actor.call(:kind => :packable, :two_packer => 'thing')
     result[:two_packer].should == 'gniht'
+
+  Hyperion.defentity(:keyed) do |kind|
+    kind.field(:widget,     :type   => Integer)
+    kind.field(:downed,     :type   => :down)
+    kind.field(:thing,      :type   => :nested_type)
+    kind.field(:bauble,     :packer => lambda {|value| value ? value.reverse : value})
+    kind.field(:bad_packer, :packer => true)
+    kind.field(:two_packer, :type   => Integer, :packer => lambda {|value| value ? value.reverse : value})
   end
+ end
 
   context 'Timestamps' do
 

data/spec/hyperion_spec.rb

@@ -1,4 +1,5 @@
 require 'hyperion'
+require 'hyperion/types'
 require 'hyperion/shared_examples'
 require 'hyperion/fake_ds'
 
@@ -56,6 +57,28 @@ describe Hyperion do
     end
   end
 
+  context 'packer_defined?' do
+    it 'false if a packer has not been defined for the given type' do
+      Hyperion.packer_defined?(:undefined_packer).should == false
+    end
+
+    it 'true if a packer has been defined for the given type' do
+      Hyperion.pack(:thing) {|value| value}
+      Hyperion.packer_defined?(:thing).should == true
+    end
+  end
+
+  context 'unpacker_defined?' do
+    it 'false if a packer has not been defined for the given type' do
+      Hyperion.unpacker_defined?(:undefined_packer).should == false
+    end
+
+    it 'true if a packer has been defined for the given type' do
+      Hyperion.unpack(:thing) {|value| value}
+      Hyperion.unpacker_defined?(:thing).should == true
+    end
+  end
+
   context 'with fake datastore' do
 
     def fake_ds
@@ -235,5 +258,40 @@ describe Hyperion do
       end
 
     end
+
+    Hyperion.defentity(:keyed) do |kind|
+      kind.field(:spouse_key, :type => Hyperion::Types.foreign_key(:spouse))
+    end
+
+    it 'returns the packer key' do
+      Hyperion::Types.foreign_key(:spouse).should == :spouse_key
+    end
+
+    it 'defines a packer for the given kind' do
+      Hyperion.packer_defined?(:spouse_key)
+    end
+
+    it 'defines an unpacker for the given kind' do
+      Hyperion.unpacker_defined?(:spouse_key)
+    end
+
+    it 'formats the kind' do
+      Hyperion::Types.foreign_key(:SPouse).should == :spouse_key
+    end
+
+    it 'asks the current datastore to pack the key' do
+      key = 'the key to pack'
+      Hyperion.save(:kind => :keyed, :spouse_key => key)
+      fake_ds.key_pack_queries.first[:kind].should == :spouse
+      fake_ds.key_pack_queries.first[:key].should == key
+    end
+
+    it 'asks the current datastore to unpack the key' do
+      key = 'the key to pack'
+      fake_ds.returns = [[{:kind => :keyed, :spouse_key => key}]]
+      Hyperion.save(:kind => :keyed)
+      fake_ds.key_unpack_queries.first[:kind].should == :spouse
+      fake_ds.key_unpack_queries.first[:key].should == key
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyperion-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
+date: 2012-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,6 +58,7 @@ files:
 - lib/hyperion/memory.rb
 - lib/hyperion/sort.rb
 - lib/hyperion/query.rb
+- lib/hyperion/types.rb
 - lib/hyperion.rb
 - spec/hyperion_spec.rb
 - spec/hyperion/util_spec.rb