mementus 0.0.1 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDQ4NmJhMTc1NTk1ZTk3MWExOWQyMDdiNWFlODE0M2RhN2MyOGFjMA==
+    Mzg4MDg1OTYxZjllZGJiMWM1OGFjODc5MTcyNDQ1YzIyYmU3NzgwMA==
   data.tar.gz: !binary |-
-    NWZiZjNiMzdjNzNjNjEzNDQ3MmZmOWRhZjI3OTAzOTI0YTk5ZWQzNg==
+    YjcyZWZiNGE0ZTllMWU2MzI1Nzc1Yjg1ZDlkMGUzZGQxMTkyOWJhNg==
 SHA512:
   metadata.gz: !binary |-
-    OTUxYjFiNzY1YzUxMjczMTQ5MzhkNjQzZTZhM2NjMGQwNzhhNjEyYzVkYzZm
-    ZWNmMGYwNGZkZmU3ZDRkNWQ0ZmIzZWFlMTg1OGY1ZGUwOTlkOWNiOGVkZjcz
-    OTcwMzdhMGE3YTU3MzkyYzhlZjExZDMxZTU1Mzk1NjJhNzk4ODc=
+    YjIyNDEyNTQyZWQwYzgzMzhlMzEzYTI5MzQyZDQ2YjE3MGQwYTZmMTljY2Vm
+    MTIxZGVhMDJmYjQ2NWE3MTFjYWU0YjQxYWUyYTgyZTAxODEwM2UwNmIyNzM5
+    YzI3MzI2ZmY4NjU5YmEyMTA4OTg3ZDBlNDM3MzFjZGY3MTVmZTg=
   data.tar.gz: !binary |-
-    ZWRmYmIyMjVhYTdlM2QwYjU3OWJmMjMxOTQ1Mjc4MTE2NWQwZDM4NGZjMjI5
-    NWFhMGU0ZWM4YmJmNjJjMTBkYWI2ZjgzYjBkYjhhZTU5NmNmNzEzODE5MDM0
-    ZDM0ZjkxNmZjYjMwODdjNWU2M2MzNmU2N2IwOTE3ZGZjMzZkNWM=
+    NjZjOGRkZWZhMjE0MDVhM2NhZjk1NDg3NDE3N2JiYzBmMGVmMGY4NDQ5M2Zj
+    N2Y0ZWQ5Y2QyNGRmZWY4YzdhOTJkOWIxNzA5OTYyY2JmOGZmZTJhNWM0ZGU0
+    ZGI3N2NlYzYxYWQwZDUyMDY2NTU2ZjRkMmQwMmIxZTNkNTlhYzc=

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.1
+  - 2.0
+  - 1.9.3
+
+script: bundle exec rspec

data/README.md

@@ -1,6 +1,21 @@
 # Mementus
 
-TODO: Write a gem description
+[![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.
+```
 
 ## Installation
 
@@ -18,7 +33,50 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To define model classes, inherit from the `Mementus::Model` base class and add attributes using the [Virtus API](https://github.com/solnic/virtus):
+
+```ruby
+class Book < Mementus::Model
+  attribute :title, String
+  attribute :author, String
+end
+```
+
+Create new instances by passing data through the constructor or assigning attributes directly:
+
+```ruby
+book1 = Book.new(
+  :title => "Gravity's Rainbow",
+  :author => "Thomas Pynchon"
+)
+
+book2 = Book.new
+book2.title = "The Golden Notebook"
+book2.author = "Doris Lessing"
+```
+
+To write objects to the in-memory index, call their `create` method:
+
+```ruby
+book3 = Book.new(
+  :title => "Crash",
+  :author => "J.G. Ballard"
+)
+
+book3.create
+```
+
+The query API is currently being worked on. Right now to test it out, you can access the relational collection for each model through the `collection` method, and execute basic matching queries using the `where` method:
+
+```ruby
+Book.collection.count
+
+Book.collection.first
+
+Book.where(author: "Doris Lessing")
+
+Book.where(title: "Crash")
+```
 
 ## Contributing
 

data/lib/mementus/model.rb

@@ -0,0 +1,105 @@
+require 'virtus'
+require 'axiom-memory-adapter'
+ 
+module Mementus
+ 
+  # 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.
+  #
+  class Model
+ 
+    @@local_storage = nil
+    @@model_registry = {}
+ 
+    def self.name_to_sym  
+      name_without_namespace = name.split("::").last
+      name_without_namespace.gsub(/([^\^])([A-Z])/,'\1_\2').downcase.to_sym
+    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]]
+      attribute_set.each do |attribute_type|
+        tuple << [attribute_type.name.to_sym, attribute_type.primitive]
+      end
+      tuple
+    end
+ 
+    # TODO: this mapping could be based on declared indexes,
+    # rather than dumping the entire attribute data set here.
+    #
+    def values_tuple
+      tuple = [object_id.to_s]
+      attributes.each do |_, attribute_value|
+        tuple << attribute_value
+      end
+      tuple
+    end
+ 
+    def self.inherited(concrete_model)
+      concrete_model.send(:include, Virtus.model)
+    end
+ 
+    # Create only writes to memory. It's required in order to
+    # index the object's attributes in the query model.
+    #
+    def create
+      ensure_registered(self)
+      local_storage[self.class.name_to_sym].insert([values_tuple])
+    end
+ 
+    def ensure_registered(model)
+      register(model) unless registered?(model)
+    end
+ 
+    def registered?(model)
+      model_registry.has_key? model.class.name_to_sym
+    end
+ 
+    def register(model)
+      model_id = model.class.name_to_sym
+      model_registry[model_id] = true
+      local_storage[model_id] = Axiom::Relation.new(model.schema_tuple)
+    end
+ 
+    def model_registry
+      @@model_registry
+    end
+ 
+    def local_storage
+      unless @@local_storage
+        @@local_storage = Axiom::Adapter::Memory.new
+      end
+      @@local_storage
+    end
+ 
+    def self.collection
+      @@local_storage[name_to_sym]
+    end
+ 
+    # Stub implementation that demonstrates the ObjectSpace
+    # reference grabbing.
+    #
+    # Currently just splats to an array instead of handing back
+    # a chainable scope object.
+    # 
+    def self.where(constraints)
+      self.collection.restrict(constraints).inject([]) do |list, relation|
+        list << ObjectSpace._id2ref(relation[:__object_id].to_i)
+      end
+    end
+ 
+  end
+end

data/lib/mementus/version.rb

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

data/lib/mementus.rb

@@ -1,5 +1,5 @@
-require "mementus/version"
+require 'virtus'
+require 'axiom-memory-adapter'
 
-module Mementus
-  # Your code goes here...
-end
+require_relative 'mementus/version'
+require_relative 'mementus/model'

data/mementus.gemspec

@@ -18,6 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "virtus"
+  spec.add_runtime_dependency "axiom-memory-adapter"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/spec/attribute_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Mementus::Model do
+
+  describe "Attributes" do
+    
+    class PrimaryAttributes < Mementus::Model
+      attribute :name, String
+      attribute :count, Integer
+      attribute :switch, Boolean
+    end
+
+    let(:model) {
+      PrimaryAttributes.new(
+        :name => "a string",
+        :count => 500,
+        :switch => false
+      )
+    }
+
+    it "reads attributes" do
+      expect(model.name).to eq "a string"
+      expect(model.count).to eq 500
+      expect(model.switch).to eq false
+    end
+
+    it "writes attributes" do
+      model.name = "stringstringstring"
+      model.count = 488
+      model.switch = true
+
+      expect(model.name).to eq "stringstringstring"
+      expect(model.count).to eq 488
+      expect(model.switch).to eq true      
+    end
+
+  end
+
+
+end

data/spec/collection_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Mementus::Model do
+
+  describe "Collection" do
+  
+    class Item < Mementus::Model
+      attribute :name, String
+      attribute :order, Integer
+    end
+
+    before(:all) do
+      20.times do |i|
+        item = Item.new
+        item.name = "Item: #{i.to_s}"
+        item.order = i + 1
+        item.create
+      end
+    end
+
+    it "counts created items" do
+      expect(Item.collection.count).to eq 20
+    end
+
+    it "finds item by matching attribute" do
+      expect(Item.where(order: 10).count).to eq 1
+      expect(Item.where(order: 10).first.name).to eq "Item: 9"
+    end
+
+  end
+
+end

data/spec/mapping_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Mementus::Model do
+
+  describe "Mapping" do
+
+    class Mapping < Mementus::Model
+      attribute :description, String
+      attribute :number, Integer
+    end
+
+    let(:mapping) {
+      Mapping.new(
+        :description => "Hello world.",
+        :number => 2014
+      )
+    }
+
+    let(:object_id) {
+        mapping.object_id.to_s
+    }
+
+    it "maps attribute schema to tuple" do
+      schema = [[:__object_id, 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]
+      expect(mapping.values_tuple).to eq values
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'mementus'
+
+RSpec.configure do |config|
+  config.formatter = 'documentation'
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mementus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - maetl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2014-07-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: axiom-memory-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: In-memory data model
 email:
 - me@maetl.net
@@ -46,13 +88,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/mementus.rb
+- lib/mementus/model.rb
 - lib/mementus/version.rb
 - mementus.gemspec
+- spec/attribute_spec.rb
+- spec/collection_spec.rb
+- spec/mapping_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -77,4 +125,8 @@ rubygems_version: 2.1.8
 signing_key: 
 specification_version: 4
 summary: In-memory data model
-test_files: []
+test_files:
+- spec/attribute_spec.rb
+- spec/collection_spec.rb
+- spec/mapping_spec.rb
+- spec/spec_helper.rb