dm-mnesia 0.2.8

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*.swp

data/Manifest

@@ -0,0 +1,7 @@
+Manifest
+README.rdoc
+Rakefile
+lib/dm-mnesia-adapter.rb
+spec/dm-mnesia-adapter_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.rdoc

@@ -0,0 +1,46 @@
+= dm-mnesia
+
+A DataMapper adapter for Erlang's Mnesia db
+
+==Requirements
+  
+You will need to install Rbridge[http://github.com/grockit/rulang].
+
+==Installation
+  
+  sudo gem install dm-mnesia
+
+==Usage
+
+Require the gem in your enviroment file
+  config.gem "dm-mnesia"
+Initialize a connection using the adapter 
+  connection = { :adapter => 'Mnesia',
+                      :hostname => 'localhost',
+                      :port => 9900,
+                      :ids_table => 'NAME OF THE TABLE TO STORE UNIQUE IDS.',
+                      :id_function=> 'NAME OF AN ERLANG FUNCTION TO CREATE UNIQUE IDS FOR YOUR RECORDS'}
+      DataMapper.setup(:default, connection )
+  
+We used this[http://dudefrommangalore.blogspot.com/2009/03/auto-increment-in-mnesia-database.html] example for the ids_table option </p>
+
+Now you can define your models just like you would if you were using the DataMapper default adapters. All CRUD operations work the same as well.
+
+==Issues  
+
+When using a BinaryString type as a key for your model, you must set it to ":require=>false", otherwise it won't work
+When using a List type, you must assign the value to the column like so:
+  Model.mycolumn = ["value", "value"]
+ 
+
+==To Do List
+
+In certain cases, the read command retrieves all record from Mnesia and filters, sorts them in ruby, more work needs to be done make this more efficient. This won't be a problem if you are working with records around 2000.  
+Add missing Erlang types: Tuple, Atom.
+
+Authors: Chad DePue (mailto:chad@inakanetworks.com), Manuel Gómez (manuel@inakanetworks.com)
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "dm-mnesia"
+    gemspec.summary = "DataMapper adapter for Erlang's mnesia db"
+    gemspec.description = ""
+    gemspec.email = "chad@inakanetworks.com,manuel@inakanetworks.com"
+    gemspec.homepage = "http://github.com/mergoc/dm-mnesia"
+    gemspec.authors = ["Chad DePue","Manuel Gomez"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.8

data/dm-mnesia.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-mnesia}
+  s.version = "0.2.8"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chad DePue", "Manuel Gomez"]
+  s.date = %q{2010-08-30}
+  s.description = %q{}
+  s.email = %q{chad@inakanetworks.com,manuel@inakanetworks.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "Manifest",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "dm-mnesia.gemspec",
+     "lib/dm-mnesia-adapter.rb",
+     "lib/dm-mnesia.rb",
+     "lib/types/binary_string.rb",
+     "lib/types/list.rb",
+     "lib/types/record.rb",
+     "lib/types/tuple.rb",
+     "pkg/dm-mnesia-0.0.0.gem",
+     "spec/dm-mnesia-adapter_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mergoc/dm-mnesia}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{DataMapper adapter for Erlang's mnesia db}
+  s.test_files = [
+    "spec/dm-mnesia-adapter_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/dm-mnesia-adapter.rb

@@ -0,0 +1,265 @@
+require 'dm-core'
+require 'dm-core/adapters/abstract_adapter'       
+require 'rbridge'
+module DataMapper::Adapters
+
+  class MnesiaAdapter < AbstractAdapter      
+
+
+    #Initialize the adapter with the given options
+    # 1. hostname: location of the rbridge server as an Ip or url, default is localhost
+    # 2. port: the port to comunicate with rbridge, default is 9900
+    # 3. mod: rbridge offers several modes of operation. 
+    # 4. ids_table: the table in mnesia that will handle the ids of each record created
+    # 5. id_function: in case an erlang function is wished to be used for record id generations, it can be set here. If the id is a BinaryString, this is required
+    def initialize(name, options)
+      super                                       
+
+      @hosname = @options[:hostname] ||= "localhost"         
+      @port = @options[:port]        ||= 9900 
+      @mod = @options[:mod] 
+      @ids_table = @options[:ids_table]
+      @id_function = @options[:id_function]
+      @con = con
+      @table_attributes = nil
+
+      ## Refreshes the spec table so that spec test run properly
+      con.erl("mnesia:clear_table(heffalump).") if name == :default
+    end
+
+    # Initializes the connection to the rbridge server
+    def con(&blk)
+      # connect to the server
+      if @con.nil?
+        @con = RBridge.new(@mod,@hostname, @port)
+        if @con.erl("1*1.") != 1
+           raise "Error opening connection to database: #{@con.erl("1*1.")}"
+        end
+      end
+      @con
+    end
+
+    # Create function required by the adapter spec
+    def create(resources)
+        resources.each do |resource|
+          initialize_identity_field(resource,get_key(resource))
+          save(con, parse_resource(resource))
+      end
+    end
+    
+    # Read function required by the adapter spec
+    #TODO change query so that the mnesia filters the results
+    # and does not bring all records on the table every time
+    def read(query)
+        temp_records = erl_read(query)
+        records = []
+        temp_records.each do |value|
+          records << value if value
+        end
+      result = query.filter_records(records.reverse)
+      result
+    end
+    
+    # Update function required by the adapter spec
+    def update(attributes, collection)
+      attributes = attributes_as_fields(attributes)
+      collection.each do |resource|
+          attributes = resource.attributes(:field).merge(attributes)
+          save(con, parse_resource(resource))
+        end
+    end
+    
+    # Delete function required by the adapter spec
+    def delete(collection)
+        collection.each do |resource|
+          erl_delete(resource.model,resource.key.first)
+        end
+    end
+    
+
+    protected
+
+    # On record creation the primary id must be generated
+    # If the id_function option is set and the key for the model is a binary string, an erlan function is used.
+    # otherwise, and mnesia unique id table can be used or a random number
+    def get_key resource
+      model = resource.model
+      identity_field = get_identity_field resource
+      if !@id_function.nil? and identity_field.is_a? DataMapper::Property::BinaryString
+        con.erl("#{@id_function}.")  
+      elsif @ids_tables.nil?
+        con.erl("mnesia:dirty_update_counter(#{@ids_table},#{model.to_s.downcase},1).") 
+      else
+        rand(2**32)
+      end
+    end
+    
+
+    # Before update or create the resource must be parse to be properly pass to rbridge
+    def parse_resource(resource)
+      model = resource.model
+      fields = []
+      types = Hash.new 
+      # Get all properties defined on the datamapper model
+      resource.send(:properties).map do |property|
+        if property.is_a? DataMapper::Property::Serial 
+          types[property.name] = 0
+       elsif property.is_a? DataMapper::Property::Integer 
+          types[property.name] = 0
+       elsif property.is_a? DataMapper::Property::Boolean 
+          types[property.name] = false
+       elsif property.is_a? DataMapper::Property::Record 
+          types[property.name] = {}
+       elsif property.is_a? DataMapper::Property::List 
+          types[property.name] = []
+       elsif property.is_a? DataMapper::Property::BinaryString 
+          types[property.name] = 0b100
+       elsif property.is_a? DataMapper::Property::DateTime 
+          types[property.name] = Time.now
+       elsif property.is_a? DataMapper::Property::String 
+          types[property.name] = ""
+      end
+
+
+      end
+
+      # Set the value for the identity field
+     identity_field = get_identity_field resource
+     fields.push(identity_field.dump(resource.key.first))
+
+     # Loop through the attributes defined in the mnesia record
+     # and set the value for each one except the identity field
+     table_attributes(model).each do |p|
+        if p.to_s!= identity_field.field
+          if types[p.to_sym].is_a? Integer
+             value = resource[p.to_sym] == nil ? 'undefined' : resource[p.to_sym] 
+             fields.push(value)
+          elsif types[p.to_sym].is_a? Array
+            field  = resource.model.properties.detect{|f|f.field == p.to_s}
+            value = resource[p.to_sym]
+      		 if resource[p.to_sym].length == 0
+        	    fields.push("'undefined'")
+	         else
+	            fields.push(field.dump(value)) 
+	         end
+          elsif types[p.to_sym].is_a? Hash
+            value = resource[p.to_sym]
+      		 if resource[p.to_sym].nil?
+        	    fields.push("'undefined'")
+	         else
+	            fields.push(value) 
+	         end
+          else
+            if resource[p.to_sym].nil?
+              fields.push("'undefined'")
+            else
+              fields.push("\"" + resource[p.to_sym].to_s + "\"")
+            end
+          end
+          
+        end
+      end
+      "#{model.to_s.downcase},{#{model.to_s.downcase},#{fields.join(',').to_s}}"
+    end
+
+    
+    # Function called by create and update
+    def save(con, record)
+      if !erl_save(con,record)
+        raise WriteError, erl_save(con,record)
+      end
+    end
+
+    # Retrived the attribues defined for the table in mnesia
+    def table_attributes model
+      if @table_attribute.nil?
+        @table_attributes = con.erl("mnesia:table_info(" + model.to_s.downcase + ",attributes).")
+      end
+      @table_attributes
+    end
+
+    # Set the initial value for the identity field on record creation
+    def initialize_identity_field resource, value
+        identity_field = get_identity_field resource
+        identity_field.set(resource,value)
+    end
+
+    # Returns the field object defined as a key in the model
+    def get_identity_field resource
+       resource.model.key(name).detect{|p|p.key?}
+    end
+
+    # Gets the id value from the conditions passed in the query 
+    def get_id_from_conditions conditions
+      conditions.map do |condition|
+            return condition.loaded_value if condition.subject.name == :id
+          end
+      nil
+    end
+
+    # ERLAND FUNCTIONS
+    def erl_save(con,record)
+      con.erl("mnesia:dirty_write(#{record}).")
+    end
+
+    # Reads the recuested records from mnesia and parses them to be pased to the Read function
+    def erl_read query
+       model = query.model  
+       if query.limit.nil?
+        records = con.erl("mnesia:transaction(fun() ->qlc:eval( qlc:q([ X || X <- mnesia:table(#{model.to_s.downcase}) ]))end ).")[1]
+       elsif query.limit == 1 && !get_id_from_conditions(query.conditions).nil?
+             id = get_id_from_conditions(query.conditions)
+             if id.is_a? Integer
+                records = con.erl("mnesia:dirty_read({#{model.to_s.downcase},#{id}}).")
+             else
+                records = con.erl("mnesia:dirty_read({#{model.to_s.downcase},<<\"" + id.to_s + "\">>}).")
+             end
+       elsif query.limit > 1
+         records = con.erl("mnesia:transaction(fun() ->qlc:eval( qlc:next_answers(qlc:cursor(qlc:q([ X || X <- mnesia:table(#{query.model.to_s.downcase}) ])),#{query.limit})    )end ).")[1]
+       else
+          records = con.erl("mnesia:transaction(fun() ->qlc:eval( qlc:q([ X || X <- mnesia:table(#{model.to_s.downcase}) ]))end ).")[1]
+       end
+        
+       result = []
+       attributes = table_attributes model
+       records.each do | r |
+         r.delete(model.to_s.downcase)
+         h = Hash.new
+         r.each_with_index do |item,i|
+           h[attributes[i]] = r[i] == 'undefined' ? nil : r[i]
+         end
+         result << h
+       end
+       result.reverse
+    end
+
+    # Sends the delete command to erland.
+    def erl_delete model, id
+      command = ""
+      if id.is_a? Integer
+        command = "mnesia:dirty_delete({#{model.to_s.downcase},#{id.to_s}})."
+      else
+        command = "mnesia:dirty_delete({#{model.to_s.downcase},<<\"" + id.to_s + "\">>})."
+      end
+      if !con.erl(command)
+        raise WriteError, con.erl(command)
+      end
+      
+    end
+
+    
+    
+
+    class ConnectError < StandardError
+    end
+
+    class WriteError < StandardError
+    end
+
+    class ReadError < StandardError
+    end
+
+
+  end
+
+end

data/lib/dm-mnesia.rb

@@ -0,0 +1,8 @@
+require 'dm-mnesia-adapter'
+module DataMapper
+  class Property
+    autoload :Record, 'types/record'
+    autoload :BinaryString,                'types/binary_string'
+    autoload :List,                'types/list'
+  end
+end

data/lib/types/binary_string.rb

@@ -0,0 +1,37 @@
+module DataMapper
+  class Property
+    class BinaryString < Text
+      def custom?
+        true
+      end
+
+      def primitive?(value)
+        value.kind_of?(::String) 
+      end
+
+      def valid?(value, negated = false)
+        super || dump(value).kind_of?(::String)
+      end
+
+      def load(value)
+        if value.nil?
+          nil
+        elsif value.is_a?(::String)
+          value
+        else
+          raise ArgumentError.new("not sure what type #{value.class}")
+        end
+      end
+
+
+      def dump(value)
+         "<<\"#{value.to_s}\">>"
+      end
+
+      def typecast_to_primitive(value)
+        value.to_s
+      end
+    end 
+  end 
+end 
+

data/lib/types/list.rb

@@ -0,0 +1,43 @@
+module DataMapper
+  class Property
+    class List < Text
+      def custom?
+        true
+      end
+
+      def primitive?(value)
+        value.kind_of?(::Array) || value.kind_of?(::String)
+      end
+
+      def valid?(value, negated = false)
+        super || dump(value).kind_of?(::String)
+      end
+
+      def load(value)
+        if value.nil?
+          Array.new
+        elsif value.is_a?(::Array)
+          value
+        elsif value.is_a?(::String)
+          value
+       else
+          raise ArgumentError.new("not sure what type #{value.class}")
+        end
+      end
+
+
+      def dump(value)
+        if value.is_a?(::String)
+          value
+        else
+          "[#{value.join(",").to_s}]"
+        end
+      end
+
+      def typecast_to_primitive(value)
+        value.to_s
+      end
+    end 
+  end 
+end 
+

data/lib/types/record.rb

@@ -0,0 +1,42 @@
+module DataMapper
+  class Property
+    class Record < Text
+      def custom?
+        true
+      end
+
+      def primitive?(value)
+        value.kind_of?(::Array) || value.kind_of?(::Hash)
+      end
+
+      def valid?(value, negated = false)
+        super || dump(value).kind_of?(::String)
+      end
+
+      def load(value)
+        if value.nil?
+          nil
+        elsif value.is_a?(::Array)
+          klass = value.shift.capitalize
+          theklass = Kernel.const_get(klass).new
+          theklass.send('properties').map(&:name).each_with_index() do |k,i|
+            theklass.send("#{k}=",value[i])
+          end
+          theklass
+       else
+          raise ArgumentError.new("not sure what type #{value.class}")
+        end
+      end
+
+
+      def dump(value)
+        value
+      end
+
+      def typecast_to_primitive(value)
+        value.to_s
+      end
+    end 
+  end 
+end 
+

data/lib/types/tuple.rb

@@ -0,0 +1,12 @@
+require 'dm-core'
+
+module DataMapper
+  class Property
+    class BinaryString < Text
+      def custom?
+        true
+      end
+    end
+  end 
+end 
+

data/spec/dm-mnesia-adapter_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'dm-core/spec/shared/adapter_spec'
+
+describe DataMapper::Adapters::MnesiaAdapter do
+  before :all do
+    @adapter = DataMapper.setup(:default, :adapter   => 'mnesia',
+                                          :hostname  => 'localhost',
+                                          :port      => 9900,
+                                          :mod       => nil,
+                                          :ids_table  => 'unique_ids')
+  end
+
+  it_should_behave_like 'An Adapter'
+
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--loadby random
+--format progress
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'spec'
+
+require 'dm-mnesia'
+
+require 'dm-core'

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: dm-mnesia
+version: !ruby/object:Gem::Version 
+  hash: 7
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 8
+  version: 0.2.8
+platform: ruby
+authors: 
+- Chad DePue
+- Manuel Gomez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-30 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: chad@inakanetworks.com,manuel@inakanetworks.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- Manifest
+- README.rdoc
+- Rakefile
+- VERSION
+- dm-mnesia.gemspec
+- lib/dm-mnesia-adapter.rb
+- lib/dm-mnesia.rb
+- lib/types/binary_string.rb
+- lib/types/list.rb
+- lib/types/record.rb
+- lib/types/tuple.rb
+- pkg/dm-mnesia-0.0.0.gem
+- spec/dm-mnesia-adapter_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mergoc/dm-mnesia
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: DataMapper adapter for Erlang's mnesia db
+test_files: 
+- spec/dm-mnesia-adapter_spec.rb
+- spec/spec_helper.rb