mementus 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Mzg4MDg1OTYxZjllZGJiMWM1OGFjODc5MTcyNDQ1YzIyYmU3NzgwMA==
+    N2I2NmZkNjY1MGMwYWE0ZGI3ZmRmZjY0OGFlODI1YWQyZjhkMTU5OA==
   data.tar.gz: !binary |-
-    YjcyZWZiNGE0ZTllMWU2MzI1Nzc1Yjg1ZDlkMGUzZGQxMTkyOWJhNg==
+    NDNhZGVhZjZlMWE5NzJmYmY5YjM0ODIxODA0ZDViZWZiNjZmNGExZg==
 SHA512:
   metadata.gz: !binary |-
-    YjIyNDEyNTQyZWQwYzgzMzhlMzEzYTI5MzQyZDQ2YjE3MGQwYTZmMTljY2Vm
-    MTIxZGVhMDJmYjQ2NWE3MTFjYWU0YjQxYWUyYTgyZTAxODEwM2UwNmIyNzM5
-    YzI3MzI2ZmY4NjU5YmEyMTA4OTg3ZDBlNDM3MzFjZGY3MTVmZTg=
+    OWYyMGY5NDc1ODdkNGQ2ZmQ5ZDExZTI2ODA4MjUxZWYyM2RmYmM5NTE3ZTAx
+    NmQ4ODNjZTgxODQyZjdkZjFhYjMzNTQ4YTA2MDQ0YTU4NGY1MjVmMWI2NzZk
+    NTQ4ZjBiNGZmN2I0ODYxN2U2N2RjZDdmZWE3ZTM2YTNhZGJhMGQ=
   data.tar.gz: !binary |-
-    NjZjOGRkZWZhMjE0MDVhM2NhZjk1NDg3NDE3N2JiYzBmMGVmMGY4NDQ5M2Zj
-    N2Y0ZWQ5Y2QyNGRmZWY4YzdhOTJkOWIxNzA5OTYyY2JmOGZmZTJhNWM0ZGU0
-    ZGI3N2NlYzYxYWQwZDUyMDY2NTU2ZjRkMmQwMmIxZTNkNTlhYzc=
+    NTlhZTVmODY1OGQ1MDhmYzU3MWE1NWM0NWUyMmM1MTIwMjY1YmNjZDkyMGJk
+    YzU4MTk2ODA5MGYyMWRlODk4YjZkOGFlZTkzMGNjZGQyNGI3MGI3M2I2NTI4
+    NzFkMGYzNDA1ODFkMTczMGMxOTA0MzdjYTU1MmEwMTI0OTIzMTU=

data/README.md

@@ -2,20 +2,7 @@
 
 [![Build Status](https://travis-ci.org/maetl/mementus.svg?branch=master)](https://travis-ci.org/maetl/mementus)
 
-```ruby
-# Proof of concept for a toy ORM that combines some aspects of the
-# ActiveRecord API with an in-memory query model based on the Axiom
-# relational algebra API.
-#
-# The weirdest trick is that the data stored in the relational model
-# is a read-only index that never gets re-materialised back into the
-# model objects themselves (though Axiom does seem to be capable of
-# doing this).
-# 
-# Instead of returning mapped data from queries, the Ruby object_id
-# is used as a reference to point to the existing instance in the
-# runtime object space.
-```
+Proof of concept for a toy ORM that combines some aspects of the ActiveRecord API with an in-memory query model based on the Axiom relational algebra API.
 
 ## Installation
 

data/lib/mementus/model.rb

@@ -1,5 +1,6 @@
 require 'virtus'
 require 'axiom-memory-adapter'
+require 'mini_cache'
  
 module Mementus
  
@@ -7,15 +8,6 @@ module Mementus
   # ActiveRecord API with an in-memory query model based on the Axiom
   # relational algebra API.
   #
-  # The weirdest trick is that the data stored in the relational model
-  # is a read-only index that never gets re-materialised back into the
-  # model objects themselves (though Axiom does seem to be capable of
-  # doing this).
-  # 
-  # Instead of returning mapped data from queries, the Ruby object_id
-  # is used as a reference to point to the existing instance in the
-  # runtime object space.
-  #
   class Model
  
     @@local_storage = nil
@@ -25,12 +17,18 @@ module Mementus
       name_without_namespace = name.split("::").last
       name_without_namespace.gsub(/([^\^])([A-Z])/,'\1_\2').downcase.to_sym
     end
+
+    # Unique cache identifier for this instance
+    #
+    def cache_key
+      "#{self.class.name_to_sym.to_s}-#{object_id.to_s}"
+    end
  
     # TODO: this mapping could be based on declared indexes,
     # rather than dumping the entire attribute schema here.
     #
     def schema_tuple
-      tuple = [[:__object_id, String]]
+      tuple = [[:__cache_key, String]]
       attribute_set.each do |attribute_type|
         tuple << [attribute_type.name.to_sym, attribute_type.primitive]
       end
@@ -41,7 +39,7 @@ module Mementus
     # rather than dumping the entire attribute data set here.
     #
     def values_tuple
-      tuple = [object_id.to_s]
+      tuple = [cache_key]
       attributes.each do |_, attribute_value|
         tuple << attribute_value
       end
@@ -58,6 +56,7 @@ module Mementus
     def create
       ensure_registered(self)
       local_storage[self.class.name_to_sym].insert([values_tuple])
+      self.class.cache_put(self.cache_key, self)
     end
  
     def ensure_registered(model)
@@ -79,27 +78,64 @@ module Mementus
     end
  
     def local_storage
-      unless @@local_storage
-        @@local_storage = Axiom::Adapter::Memory.new
-      end
-      @@local_storage
+      @@local_storage ||= Axiom::Adapter::Memory.new
     end
  
     def self.collection
       @@local_storage[name_to_sym]
     end
+
+    def self.all
+      self.collection.inject([]) do |list, relation|
+        list << self.cache_get(relation[:__cache_key])
+      end
+    end
  
-    # Stub implementation that demonstrates the ObjectSpace
-    # reference grabbing.
+    # The where operation restricts the collection based on the
+    # passed in constraints.
+    #
+    # Pass in a key-value hash to restrict based on matching attributes by equality.
     #
-    # Currently just splats to an array instead of handing back
-    # a chainable scope object.
+    # Pass in a block to construct a more specialised predicate match.
     # 
     def self.where(constraints)
       self.collection.restrict(constraints).inject([]) do |list, relation|
-        list << ObjectSpace._id2ref(relation[:__object_id].to_i)
+        list << self.cache_get(relation[:__cache_key])
       end
     end
+
+    # Order the collection by attribute and direction
+    # TODO: pass relations as scopes
+    def self.order(constraints)
+      ordered_relations = self.collection.sort_by do |relation|
+        constraints.keys.inject([]) do |list, constraint|
+          direction = constraints[constraint].to_sym
+          direction = :asc unless direction == :desc
+          list << relation.send(constraint.to_sym).send(direction)
+        end
+      end
+      self.materialize(ordered_relations)
+    end
+
+    private
+
+    def self.materialize(collection)
+      collection.inject([]) do |list, relation|
+        list << self.cache_get(relation[:__cache_key])
+      end
+    end
+
+    def self.cache
+      @@cache ||= {}
+    end
+
+    def self.cache_put(cache_key, object)
+      self.cache[cache_key] = object
+    end
+
+    def self.cache_get(cache_key)
+      self.cache[cache_key]
+    end
  
   end
 end

data/lib/mementus/version.rb

@@ -1,3 +1,3 @@
 module Mementus
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/mementus.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["me@maetl.net"]
   spec.description   = %q{In-memory data model}
   spec.summary       = %q{In-memory data model}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/maetl/mementus"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/spec/collection_spec.rb

@@ -22,11 +22,23 @@ describe Mementus::Model do
       expect(Item.collection.count).to eq 20
     end
 
-    it "finds item by matching attribute" do
+    it "provides materialized objects" do
+      expect(Item.all.count).to eq 20
+      expect(Item.all.first.name).to eq "Item: 0"
+    end
+
+    it "finds item by equality match" do
       expect(Item.where(order: 10).count).to eq 1
       expect(Item.where(order: 10).first.name).to eq "Item: 9"
     end
 
+    it "finds items by predicate match" do
+      collection = Item.order(order: :desc)
+      expect(collection.count).to eq 20
+      expect(collection.first.name).to eq "Item: 19"
+      expect(collection.last.name).to eq "Item: 0"
+    end
+
   end
 
 end

data/spec/mapping_spec.rb

@@ -16,17 +16,17 @@ describe Mementus::Model do
       )
     }
 
-    let(:object_id) {
-        mapping.object_id.to_s
+    let(:cache_key) {
+      mapping.cache_key
     }
 
     it "maps attribute schema to tuple" do
-      schema = [[:__object_id, String], [:description, String], [:number, Integer]]
+      schema = [[:__cache_key, String], [:description, String], [:number, Integer]]
       expect(mapping.schema_tuple).to eq schema
     end
 
     it "maps attribute values to tuple" do
-      values = [object_id, "Hello world.", 2014]
+      values = [mapping.cache_key, "Hello world.", 2014]
       expect(mapping.values_tuple).to eq values
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mementus
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - maetl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-06 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -101,7 +101,7 @@ files:
 - spec/collection_spec.rb
 - spec/mapping_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/maetl/mementus
 licenses:
 - MIT
 metadata: {}