mixr 0.1.0

data/AUTHORS

@@ -0,0 +1,5 @@
+= Authors
+
+Gregoire Lejeune <gregoire dot lejeune at free dot fr>
+* Maintener
+

data/COPYING

@@ -0,0 +1,18 @@
+Copyright (c) 2008 Gregoire Lejeune
+ 
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+  
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+   
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/ChangeLog

@@ -0,0 +1,2 @@
+0.1.0 :
+* Initial version

data/README

@@ -0,0 +1,52 @@
+= Mixr
+
+== About
+
+Mixr is a tiny memory object caching system
+
+== Licence
+
+Copyright (c) 2008 Gregoire Lejeune
+ 
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+  
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+   
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+== INSTALLATION
+
+	sudo gem install mixr
+	
+== REQUIREMENT
+
+Mixr server was written in erlang[http://www.erlang.org]. So you need it to use Mixr.
+
+== USAGE
+
+First, start the mixr server :
+
+	$ mixr start
+	
+Then do something like this :
+
+	require 'mixr_client'
+
+	m = MixrClient.new( "mixr.myserver.com", 9900 )
+	
+	# store 
+	m["key"] = "value"
+	
+	# fetch
+	my_val = m["key"]

data/bin/mixr

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'fileutils'
+require 'socket'
+
+## If the app run on Windows, check if win32/process is installed
+if /Windows/.match( ENV['OS'] )
+  begin
+    require 'win32/process'
+  rescue LoadError => e
+    warn "`win32-process' is not installed!"
+  end
+end
+
+require 'simple-daemon'
+
+# Get local hostname
+hostname = Socket.gethostname.gsub( /\..*$/, "" )
+
+# Server Directory
+server_directory = File.expand_path(File.join(File.dirname(__FILE__), "..", "mixr_server"))
+
+# mixr server options
+options = { :mixr_directory => "#{ENV['HOME']}/.mixr", :config_file => :default_or_none}
+server_daemonize = true
+
+# Make ~/.mixr or mixr_directory if it doesn't exist
+unless FileTest.directory?( options[:mixr_directory] )
+  FileUtils.mkdir_p( options[:mixr_directory] )
+end
+
+# Compile erlang
+compile_command = "erlc -o #{options[:mixr_directory]} #{File.join(server_directory, 'mixr.erl')}"
+`#{compile_command}`
+
+
+
+
+
+
+SimpleDaemon::WORKING_DIRECTORY = options[:mixr_directory]
+class MixrDaemon < SimpleDaemon::Base
+  @@command = nil
+  
+  def self.command=(s)
+    @@command = s
+  end
+  
+  def self.start
+    fhi = IO.popen( @@command ) 
+    while (line = fhi.gets) 
+    print line 
+    end
+    # exec @@command
+  end
+  
+  def self.stop
+    
+  end
+end
+
+MixrDaemon.command = "cd #{options[:mixr_directory]}; erl -mnesia dir '\"#{options[:mixr_directory]}/Mixr.database\"' -name #{hostname} -noshell -s mixr start -s init stop "
+
+# Start or demonize
+if server_daemonize == true
+  MixrDaemon.daemonize
+else
+  server.start
+end

data/lib/mixr_client.rb

@@ -0,0 +1,213 @@
+# Copyright (c) 2008 Gregoire Lejeune
+#  
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#   
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#    
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+# THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'socket'
+
+class MixrError < StandardError; end
+
+class MixrClient
+  
+  def initialize( h = 'localhost', p = 9900 )
+    @host = h
+    @port = p
+  end
+  
+  private
+  def action( c )
+    socket = TCPSocket.new( @host, @port )
+    socket.write( c )
+    r = socket.read
+    socket.close
+    r
+  end
+  
+  def id
+    @id
+  end
+  
+  public
+  
+  #   hsh.clear -> hsh
+  # 
+  # Removes all key-value pairs from _hsh_.
+  def clear
+    eval(action( "CLEAR@" ))
+    self
+  end
+  
+  #   hsh.keys    => array
+  # 
+  # Returns a new array populated with the keys from this hash.
+  def keys
+    eval(action( "KEYS@" ))
+  end
+  
+  #   hsh.values    => array
+  #
+  # Returns a new array populated with the values from _hsh_.
+  def values
+    eval(action( "VALUES@" ))
+  end
+  
+  #   hsh.each_value {| value | block } -> hsh
+  #
+  # Calls _block_ once for each key in _hsh_, passing the value as a
+  # parameter.
+  def each_value( &b )
+    values.each do |v|
+      yield( v )
+    end
+  end
+  
+  #   hsh.each_key {| key | block } -> hsh
+  # 
+  # Calls _block_ once for each key in _hsh_, passing the key as a
+  # parameter.
+  def each_key( &b )
+    keys.each do |k|
+      yield( k )
+    end
+  end
+  
+  #   hsh.empty?    => true or false
+  # 
+  # Returns +true+ if _hsh_ contains no key-value pairs.
+  def empty?
+    keys.size == 0
+  end
+         
+  #   hsh.each {| key, value | block } -> hsh
+  # 
+  # Calls _block_ once for each key in _hsh_, passing the key and value
+  # to the block as a two-element array. Because of the assignment
+  # semantics of block parameters, these elements will be split out if
+  # the block has two formal parameters. Also see +Hash.each_pair+,
+  # which will be marginally more efficient for blocks with two
+  # parameters.
+  def each( &b )
+    keys.each do |k|
+      yield(k, self[k])
+    end
+    self
+  end
+  
+  #   hsh.delete(key)                   => value
+  #   hsh.delete(key) {|key| block }    => value
+  # 
+  # Deletes and returns a key-value pair from _hsh_ whose key is equal
+  # to _key_. If the key is not found, returns the _default value_. If
+  # the optional code block is given and the key is not found, pass in
+  # the key and return the result of _block_.     
+  def delete( k )
+    begin
+      r = eval(action( "DELETE@#{k}" ))
+    rescue SyntaxError
+      r = nil
+    end
+    if block_given? and r.nil?
+      yield( k ) 
+    else
+      r
+    end
+  end
+  
+  #   hsh[key] = value        => value
+  #   hsh.store(key, value)   => value
+  # 
+  # Element Assignment---Associates the value given by _value_ with the
+  # key given by _key_. _key_ should not have its value changed while
+  # it is in use as a key.
+  def []=( k, v )
+    unless eval(action( "SET@#{k}|#{v}" ))
+      raise MixrError, "Can't set #{k} with value #{v}!"
+    end
+  end
+  alias :store :[]=
+  
+  #   hsh[key]    =>  value
+  #
+  # Element Reference---Retrieves the _value_ object corresponding to
+  # the _key_ object. If not found, returns the a default value
+  def []( k )
+    begin
+      eval(action( "GET@#{k}" ))
+    rescue SyntaxError
+      nil
+    end
+  end
+  
+  #   hsh.fetch(key [, default] )       => obj
+  #   hsh.fetch(key) {| key | block }   => obj
+  # 
+  # Returns a value from the hash for the given key. If the key can't
+  # be found, there are several options: With no other arguments, it
+  # will raise an +IndexError+ exception; if _default_ is given, then
+  # that will be returned; if the optional code block is specified,
+  # then that will be run and its result returned.
+  def fetch( k, d = nil )
+    r = self[k] || d
+    if block_given? and r.nil?
+      r = yield( k )
+    end
+    r
+  end
+  
+  #   hsh.length    =>  fixnum
+  #   hsh.size      =>  fixnum
+  # 
+  # Returns the number of key-value pairs in the hash.
+  def length
+    keys.size
+  end
+  alias :size :length
+  
+  #   hsh.has_key?(key)    => true or false
+  #   hsh.include?(key)    => true or false
+  #   hsh.key?(key)        => true or false
+  #   hsh.member?(key)     => true or false
+  # 
+  # Returns +true+ if the given key is present in _hsh_.
+  def has_key?( k )
+    keys.include?( k )
+  end
+  alias :include? :has_key?
+  alias :key? :has_key?
+  alias :member? :has_key?
+  
+  #   hsh.has_value?(value)    => true or false
+  #   hsh.value?(value)        => true or false
+  #
+  # Returns +true+ if the given value is present for some key in _hsh_.
+  def has_value?( v )
+    values.include?( v )
+  end
+  alias :value? :has_value?
+  
+  def to_hash
+    h = {}
+    self.each do |k, v|
+      h[k] = v
+    end
+    h
+  end
+  
+  def method_missing( id, *args ) 
+    to_hash.send( id.id2name, *args )
+  end
+end

data/mixr_server/mixr.conf_sample

@@ -0,0 +1 @@
+{port, 9900}.

data/mixr_server/mixr.erl

@@ -0,0 +1,140 @@
+% Copyright (c) 2008 Gregoire Lejeune
+%  
+% Permission is hereby granted, free of charge, to any person obtaining a copy
+% of this software and associated documentation files (the "Software"), to
+% deal in the Software without restriction, including without limitation the
+% rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+% sell copies of the Software, and to permit persons to whom the Software is
+% furnished to do so, subject to the following conditions:
+%   
+% The above copyright notice and this permission notice shall be included in
+% all copies or substantial portions of the Software.
+%    
+% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+% THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+% IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+% CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+-module(mixr).
+-author('gregoire.lejeune@free.fr').
+-compile(export_all).
+-import(random).
+-include_lib("stdlib/include/qlc.hrl").
+
+%% The primary key of the table is the first column in the table. So...
+-record(mixr_cache, {key, value}).
+
+%% Version du server
+-define(MIXR_VERSION, "0.1.0").
+
+%% Ceci permet de créer la base Mnesia
+do_this_once() ->
+  mnesia:create_schema([node()]),
+  mnesia:start(),
+  mnesia:create_table(mixr_cache, [{attributes, record_info(fields, mixr_cache)}]),
+  mnesia:stop().
+
+%% Démarrage du serveur.
+start(Port) ->
+	do_this_once(),
+	mnesia:start(),
+	mnesia:wait_for_tables([mixr_cache], 20000),
+  {ok, ListenSocket} = gen_tcp:listen(Port, [binary, {packet, 0}, {active, false}]),
+  io:format("** mixr version ~s Started (port ~p)~n", [?MIXR_VERSION, Port]),
+  loop(ListenSocket).
+start() ->
+  case file:consult("mixr.conf") of
+    {ok, C} ->
+      io:format("** Read config from ./mixr.conf~n"),
+      [{port, P}] = C,
+      start(P);
+    {error, _} ->
+      case file:consult(string:concat(os:getenv("HOME"), "/mixr.conf")) of
+        {ok, C} ->
+          io:format("** Read config from $HOME/mixr.conf~n"),
+          [{port, P}] = C,
+          start(P);
+        {error, _} ->
+          io:format("No configuration file found. Start mixr server on port 9900!"),
+					start(9900)
+      end
+  end.
+
+loop(ListenSocket) ->
+  case gen_tcp:accept(ListenSocket) of
+    {ok, Socket} -> 
+      spawn(fun() -> 
+        handle_connection(Socket) 
+      end),
+      loop(ListenSocket);
+    {error, Reason} ->
+      io:format("Error: ~p~n", [Reason])
+  end.
+
+handle_connection(Socket) ->
+  try communication(Socket)
+  catch
+    error:Reason ->
+      {gen_tcp:send(Socket, io_lib:format("Error: ~p~n", [Reason]))}
+  end,
+  ok = gen_tcp:close(Socket).
+
+communication(Socket) ->
+  {ok, Binary} = gen_tcp:recv(Socket, 0),
+	io:format( "mixr server receive : ~p~n", [Binary]),
+	{ok, [A|D]} = regexp:split( binary_to_list(Binary), "@" ),
+	case A of
+		"KEYS" -> R = keys();
+		"VALUES" -> R = values();
+		"CLEAR" -> R = clear();
+		"DELETE" -> [R] = delete(D);
+		"GET" -> [R] = do_get(D);
+		"SET" -> R = do_set(D)
+	end,
+  gen_tcp:send(Socket, io_lib:format( "~p", [R] )).
+
+keys() ->
+	do(qlc:q([X#mixr_cache.key || X <- mnesia:table(mixr_cache)])).
+
+values() ->
+	do(qlc:q([X#mixr_cache.value || X <- mnesia:table(mixr_cache)])).
+
+clear() ->
+	lists:foreach( fun(E) ->
+			mnesia:transaction( fun() -> mnesia:delete({mixr_cache, E}) end )
+		end, keys() ),
+	true.
+
+delete(T) ->
+	R = do_get(T),
+	[K] = T,
+	mnesia:transaction( fun() -> mnesia:delete({mixr_cache, K}) end ),
+	R.
+	
+do_get(T) ->
+	[K] = T,
+	do(qlc:q([X#mixr_cache.value || X <- mnesia:table(mixr_cache),
+			   X#mixr_cache.key =:= K
+			])).
+	
+do_set(T) ->
+	[D] = T,
+	{ok, [K, V]} = regexp:split( D, "|" ),
+	Row = #mixr_cache{key=K, value=V},
+	F = fun() ->
+		mnesia:write(Row)
+	end,
+	case mnesia:transaction(F) of
+		{aborted, _} -> false;
+		{atomic, _} -> true
+	end.
+
+view() ->
+	io:format( "~p~n", [do(qlc:q([X || X <- mnesia:table(mixr_cache)]))] ).
+	
+do(Q) ->
+    F = fun() -> qlc:e(Q) end,
+    {atomic, Val} = mnesia:transaction(F),
+    Val.