diametric 0.0.4 → 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2Y1ODQ4NGMzNjA0ZjY3ODIzNDk2NjIwMGUxNDA4YjViYjM2ZmE5Mg==
+  data.tar.gz: !binary |-
+    NTA1YWRhN2YwM2M0Y2RhOGJlN2NmMGNlMTZmY2E4NWQwZjE2OTc2Nw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YjA4N2I5ZWNkMWZiZTE4NDlkODRmMTYwMjM2ZGNlYjEzNzVlZTY5ZWMzYWM0
+    MjcyZWZjMGYyNWNjMzZjMTNiYTRmODI0ZGJiMjlhMDIyMmEyMWM0M2RiYjhl
+    MjA1NzdiYTdjMDExYmZhYmZlNzlkMWI4YjQ1NWEwODIxYzQzZDc=
+  data.tar.gz: !binary |-
+    N2U0NzQ0NjM2YWRkMjU2NTM4ODM2Njc3NWY0NzVlOTVlMDMzYWVmNmI4MTI5
+    ZGUzNDFmZjQ3ZGFhNWZmMzIzMWJiNjNlMWI1MmUxNzJhZjgxOTAwODFkNTQ1
+    YzBiZTJlYTcxOTU2MmY5MTVkZWU1N2YzYWFmMTY1MDU3OWQwN2U=

data/Gemfile

@@ -1,25 +1,28 @@
+# -*- ruby -*-
+
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in diametric.gemspec
-gemspec
+gem 'edn', '~> 1.0.2'
+gem 'activesupport', '~> 3.2.14'
+gem 'activemodel', '~> 3.2.14'
+gem 'datomic-client', '~> 0.4.1'
+gem 'rubyzip', '~> 0.9.9'
 
-# Development-only dependencies
-gem 'rake'
-gem 'rspec'
-gem 'pry'
+gem 'lock_jar', '~> 0.7.5', :platform => :jruby
+gem 'jruby-openssl', '~> 0.8.8', :platform => :jruby
+gem 'uuid', '~> 2.3.7'
 
-gem 'guard'
-gem 'guard-rspec'
-gem 'rb-inotify', :require => false
-gem 'rb-fsevent', :require => false
-gem 'rb-fchange', :require => false
+gem 'rspec', '~> 2.14.1'
+gem 'pry', '~> 0.9.12.2'
 
-platform :mri do
-  gem 'yard', :group => :development
-  gem 'redcarpet', :group => :development
+group :test, :development do
+  gem 'rake-compiler', '~> 0.9.1', :platform => :jruby
+  gem 'guard', '~> 1.8.2'
+  gem 'guard-rspec', '~> 3.0.2'
+  gem 'rb-inotify', :platform => :mri
+  gem 'rb-fsevent', :platform => :mri
+  gem 'rb-fchange',  :platform => :mri
+  gem 'yard',  :platform => :mri
+  gem 'redcarpet',  :platform => :mri
 end
 
-platform :jruby do
-  gem 'jruby-openssl'
-  gem 'lock_jar'
-end

data/Jarfile

@@ -1,6 +1,20 @@
 repository 'http://clojars.org/repo/'
 repository 'https://repository.jboss.org/nexus/content/groups/public/'
+repository 'http://files.couchbase.com/maven2/'
+
+datomic_names = File.read(File.join(File.dirname(__FILE__), "datomic_version.yml"))
+require 'yaml'
+datomic_versions = YAML.load(datomic_names)
+
+if ENV['DIAMETRIC_ENV'] && (ENV['DIAMETRIC_ENV'] == "pro")
+  datomic_version = datomic_versions["pro"]
+else
+  datomic_version = datomic_versions["free"]
+end
+version = /(\d|\.)+/.match(datomic_version)[0]
+datomic_version.slice!(version)
+artifactId = datomic_version.chop
 
 group :default, :runtime do
-  jar "com.datomic:datomic-free:0.8.3664"
+  jar "com.datomic:#{artifactId}:#{version}"
 end

data/README.md

@@ -20,6 +20,7 @@ Other than highlights below, there are documents on Wiki.
 
 - [Getting Started](https://github.com/relevance/diametric/wiki/Getting-Started)
 - [Rails Integration](https://github.com/relevance/diametric/wiki/Rails-Integration-%28Experimental%29)
+- [Seattle Example](https://github.com/relevance/diametric/wiki/Seattle-Example)
 
 
 ## Entity API
@@ -46,11 +47,12 @@ class Person
   attribute :email, String, :cardinality => :many
   attribute :birthday, DateTime
   attribute :iq, Integer
-  attribute :website, URI
 end
 
+# To see what schema data will be produced:
 Person.schema
-# Datomic transaction:
+
+# The schema will be mapped to Datomic transaction data below:
 # [{:db/id #db/id[:db.part/db]
 #   :db/ident :person/name
 #   :db/valueType :db.type/string
@@ -71,33 +73,38 @@ Person.schema
 #   :db/ident :person/iq
 #   :db/valueType :db.type/long
 #   :db/cardinality :db.cardinality/one
-#   :db.install/_attribute :db.part/db}
-#  {:db/id #db/id[:db.part/db]
-#   :db/ident :person/website
-#   :db/valueType :db.type/uri
-#   :db/cardinality :db.cardinality/one
 #   :db.install/_attribute :db.part/db}]
 
-Person.attributes
-# [:dbid, :name, :email, :birthday, :iq, :website]
+# To check what attributes are in Person model:
+Person.attributes.keys
+# [:dbid, :name, :email, :birthday, :iq]
 
+# To create an instance from a query result
 person = Person.new(Hash[*(Person.attributes.zip(results_from_query).flatten)])
 # or
 person = Person.from_query(results_from_query)
 
+# To update/set values of a model:
 person.iq = 180
+
+# Below will help to understand what transaction data will be produced:
 person.tx_data(:iq)
-# Datomic transaction:
+
+# It will be mapped to the Datomic transaction data:
 # [{:db/id person.dbid
 #   :person/iq 180}]
 
+# To create new model instance:
 person = Person.new(:name => "Peanut")
 person.tx_data
-# Datomic transaction:
+# Datomic transaction data will be:
 # [{:db/id #db/id[:db.part/user]
 #   :person/name "Peanut"}]
 ```
 
+In addition to `attribute`, Diametric supports `enum` type. This is often used on Datomic.
+For details, see [Seattle Example](https://github.com/relevance/diametric/wiki/Seattle-Example)
+
 ## Query API
 
 The query API is used for generating Datomic queries, whether to send via an external client or via the persistence API. The two methods used to generate a query are `.where` and `.filter`, both of which are chainable. 
@@ -141,8 +148,9 @@ query.data
 
 ## Persistence API
 
-The persistence API comes in two flavors: REST- and peer-based.
-For the most part, they have the same API.
+The persistence API comes in two flavors: REST- and Peer-based.
+Although REST-bases API supports CRUD operations like a legacy RDBMS,
+it is a subset of Peer-based API.
 
 The suitable persistent module will be selected based on URI to connect datomic.
 You don't need to care which module should be included.
@@ -151,7 +159,7 @@ However, if you like to inlcude REST or Peer module explicitely, you can write i
 
 ### Peer
 
-With Peer connection, you can create objects that know how to store themselves to Datomic through a Datomic peer.
+With Peer connection, you can create objects that know how to store themselves to Datomic through a Datomic Peer.
 
 Peer connection as well as "require `diametric/persistence/peer`" are only available on JRuby.
 When you install the `diametric` gem with JRuby, all `.jar` files needed to run Datomic will be downloaded.

data/Rakefile

@@ -1,5 +1,5 @@
 begin
-  require "bundler/gem_tasks"
+  require 'rake'
   require 'rspec/core/rake_task'
 rescue LoadError
 end
@@ -31,3 +31,19 @@ desc "Run all RSpec tests"
 require 'rspec'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
+
+
+# setting for rake compiler
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
+  require 'lock_jar'
+  LockJar.lock
+  locked_jars = LockJar.load
+
+  require 'rake/javaextensiontask'
+  Rake::JavaExtensionTask.new('diametric') do |ext|
+    jruby_home = ENV['MY_RUBY_HOME'] # this is available of rvm
+    jars = ["#{jruby_home}/lib/jruby.jar"] + FileList['lib/*.jar'] + locked_jars
+    ext.classpath = jars.map {|x| File.expand_path x}.join ':'
+    ext.name = 'diametric_service'
+  end
+end

data/bin/datomic-rest

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+options = {}
+
+opts = OptionParser.new do |opts|
+  opts.define_head "Usage: datomic-rest -p port -a db_alias -u uri"
+  opts.separator ""
+  opts.separator "Example:"
+  opts.separator "  datomc-rest -p 9000 -a free -u datomic:mem://"
+
+  opts.on("-p", "--port [port]", Integer, "Port number") do |v|
+    options[:port] = v
+  end
+
+  opts.on("-a", "--alias [alias]", String,  "Alias name") do |v|
+    options[:db_alias] = v
+  end
+
+  opts.on("-u", "--uri [uri]", String, "URI") do |v|
+    options[:uri] = v
+  end
+end
+opts.parse!
+
+DATOMIC_NAME = File.read(File.join(File.dirname(__FILE__), "..", "datomic_version.cnf"))
+
+require 'diametric/rest_service'
+
+service = Diametric::RestService.new
+PID = service.start(options)
+
+puts "Datomic REST service is running (PID = #{PID})" unless PID.nil?

data/bin/download-datomic

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+DATOMIC_NAME = File.read(File.join(File.dirname(__FILE__), "..", "datomic_version.cnf"))
+
+require 'diametric/rest_service'
+
+if Diametric::RestService.downloaded?
+    puts "Datomic #{DATOMIC_NAME} is already present in vendor/datomic"
+else
+    puts "Now, downloading..."
+    Diametric::RestService.download
+    puts "Done. #{DATOMIC_NAME} has been downloaded in vendor/datomic"
+end

data/datomic_version.yml

@@ -0,0 +1,4 @@
+free:
+  datomic-free-0.8.4122
+pro:
+  datomic-pro-0.8.4122

data/diametric.gemspec

@@ -1,3 +1,4 @@
+# -*- ruby -*-
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -16,17 +17,19 @@ as entities into a Datomic database.
 EOF
   gem.homepage      = "https://github.com/relevance/diametric"
 
-  gem.files         = %w(Gemfile Jarfile Jarfile.lock LICENSE.txt README.md Rakefile diametric.gemspec) + Dir.glob('lib/**/*')
+  gem.files         = %w(Gemfile Jarfile LICENSE.txt README.md Rakefile datomic_version.yml diametric.gemspec) + Dir.glob('lib/**/*') + Dir.glob('ext/**/*') + Dir.glob('spec/**/*')
   gem.executables   = []
   gem.test_files    = Dir.glob("spec/**/*.rb")
   gem.require_paths = ["lib"]
+  gem.executables = ["datomic-rest", "download-datomic"]
 
-  gem.add_dependency 'edn', '~> 1.0'
-  gem.add_dependency 'activesupport', '>= 3.0.0'
-  gem.add_dependency 'activemodel', '>= 3.0.0'
+  gem.add_dependency 'edn', '~> 1.0.2'
+  gem.add_dependency 'activesupport', '~> 3.2.14'
+  gem.add_dependency 'activemodel', '~> 3.2.14'
   gem.add_dependency 'datomic-client', '~> 0.4.1'
-  gem.add_dependency 'rspec', '~> 2.12.0'
-  gem.add_dependency 'lock_jar', '= 0.7.2' if defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
+  gem.add_dependency 'rubyzip', '~> 0.9.9'
+  gem.add_dependency 'uuid', '~> 2.3.7'
+  gem.add_dependency 'rspec', '~> 2.14.1'
 
   gem.extensions = ['Rakefile']
 end

data/ext/diametric/DiametricCollection.java

@@ -0,0 +1,147 @@
+package diametric;
+
+import java.util.Collection;
+import java.util.Iterator;
+
+import org.jruby.Ruby;
+import org.jruby.RubyClass;
+import org.jruby.RubyObject;
+import org.jruby.anno.JRubyClass;
+import org.jruby.anno.JRubyMethod;
+import org.jruby.javasupport.JavaUtil;
+import org.jruby.runtime.Block;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+
+@JRubyClass(name = "Diametric::Persistence::Collection")
+public class DiametricCollection extends RubyObject {
+    // should be a Ruby's Enumerable
+    private static final long serialVersionUID = 7656855654760249694L;
+    private Collection query_result = null;
+
+    public DiametricCollection(Ruby runtime, RubyClass klazz) {
+        super(runtime, klazz);
+    }
+    
+    void init(Object result) {
+        if (result instanceof Collection) {
+            this.query_result = (Collection)result;
+        } else {
+            throw new RuntimeException("Wrong type of query result");
+        }
+    }
+
+    Object toJava() {
+        return query_result;
+    }
+
+    @JRubyMethod
+    public IRubyObject to_java(ThreadContext context) {
+        return JavaUtil.convertJavaToUsableRubyObject(context.getRuntime(), query_result);
+    }
+    
+    @JRubyMethod(name="==", required=1)
+    public IRubyObject op_equal(ThreadContext context, IRubyObject arg) {
+        Ruby runtime = context.getRuntime();
+        if (arg instanceof DiametricCollection) {
+            DiametricCollection other = (DiametricCollection)arg;
+            if (query_result.toString().equals(other.toJava().toString())) {
+                return runtime.getTrue();
+            } else {
+                return runtime.getFalse();
+            }
+        } else {
+            return runtime.getFalse();
+        }
+    }
+
+    @JRubyMethod
+    public IRubyObject to_s(ThreadContext context) {
+        return context.getRuntime().newString(query_result.toString());
+    }
+    
+    @JRubyMethod(name = "all?")
+    public static IRubyObject all_p(ThreadContext context, IRubyObject self, final Block block) {
+        return context.getRuntime().getNil();
+    }
+
+    @JRubyMethod(name = "any?")
+    public static IRubyObject any_p(ThreadContext context, IRubyObject self, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject chunk(ThreadContext context, IRubyObject self, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject chunk(ThreadContext context, IRubyObject self, final IRubyObject initialState, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject collect(ThreadContext context, IRubyObject self, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject collect_concat(ThreadContext context, IRubyObject self, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject count(ThreadContext context, IRubyObject self, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject count(ThreadContext context, IRubyObject self, final IRubyObject methodArg, final Block block) {
+        return context.getRuntime().getNil();
+    }
+
+    @JRubyMethod
+    public static IRubyObject cycle(ThreadContext context, IRubyObject self, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject cycle(ThreadContext context, IRubyObject self, IRubyObject arg, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject detect(ThreadContext context, IRubyObject self, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject detect(ThreadContext context, IRubyObject self, IRubyObject ifnone, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject drop(ThreadContext context, IRubyObject self, IRubyObject n, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject drop_while(ThreadContext context, IRubyObject self, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject each_cons(ThreadContext context, IRubyObject self, IRubyObject arg, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod(rest = true)
+    public static IRubyObject each_entry(ThreadContext context, final IRubyObject self, final IRubyObject[] args, final Block block) {
+        return context.getRuntime().getNil();
+    }
+    
+    @JRubyMethod
+    public static IRubyObject each_slice(ThreadContext context, IRubyObject self, IRubyObject arg, final Block block) {
+        return context.getRuntime().getNil();
+    }
+}

data/ext/diametric/DiametricConnection.java

@@ -0,0 +1,113 @@
+package diametric;
+
+import java.util.Date;
+import java.util.List;
+
+import org.jruby.Ruby;
+import org.jruby.RubyClass;
+import org.jruby.RubyObject;
+import org.jruby.RubyTime;
+import org.jruby.anno.JRubyClass;
+import org.jruby.anno.JRubyMethod;
+import org.jruby.javasupport.JavaUtil;
+import org.jruby.javasupport.util.RuntimeHelpers;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+
+@JRubyClass(name = "Diametric::Persistence::Connection")
+public class DiametricConnection extends RubyObject {
+    private static final long serialVersionUID = 3806301567154638371L;
+    //conn should a datomic.Connection type
+    private Object conn = null;
+
+    public DiametricConnection(Ruby runtime, RubyClass klazz) {
+        super(runtime, klazz);
+    }
+
+    void init(Object conn) {
+        this.conn = conn;
+    }
+
+    Object toJava() {
+        return conn;
+    }
+
+    @JRubyMethod
+    public IRubyObject to_java(ThreadContext context) {
+        return JavaUtil.convertJavaToUsableRubyObject(context.getRuntime(), conn);
+    }
+
+    @JRubyMethod
+    public IRubyObject db(ThreadContext context) {
+        try {
+            Object database = clojure.lang.RT.var("datomic.api", "db").invoke(conn);
+            RubyClass clazz = (RubyClass)context.getRuntime().getClassFromPath("Diametric::Persistence::Database");
+            DiametricDatabase diametric_database = (DiametricDatabase)clazz.allocate();
+            diametric_database.init(database);
+            return diametric_database;
+        } catch (Throwable t) {
+            throw context.getRuntime().newRuntimeError(t.getMessage());
+        }
+    }
+
+    @JRubyMethod
+    public IRubyObject transact(ThreadContext context, IRubyObject arg) {
+        List<Object> tx_data = DiametricUtils.convertRubyTxDataToJava(context, arg);
+        if (tx_data == null) {
+            throw context.getRuntime().newArgumentError("Argument should be Array or clojure.lang.PersistentVector");
+        }
+
+        try {
+            Object future = clojure.lang.RT.var("datomic.api", "transact").invoke(conn, tx_data);
+            RubyClass clazz = (RubyClass)context.getRuntime().getClassFromPath("Diametric::Persistence::ListenableFuture");
+            DiametricListenableFuture diametric_listenable = (DiametricListenableFuture)clazz.allocate();
+            diametric_listenable.init(future);
+            return diametric_listenable;
+        } catch (Throwable t) {
+            throw context.getRuntime().newRuntimeError(t.getMessage());
+        }
+    }
+
+    @JRubyMethod
+    public IRubyObject transact_async(ThreadContext context, IRubyObject arg) {
+        List<Object> tx_data = DiametricUtils.convertRubyTxDataToJava(context, arg);
+        if (tx_data == null) {
+            throw context.getRuntime().newArgumentError("Argument should be Array or clojure.lang.PersistentVector");
+        }
+
+        try {
+            Object future = clojure.lang.RT.var("datomic.api", "transact-async").invoke(conn, tx_data);
+            RubyClass clazz = (RubyClass)context.getRuntime().getClassFromPath("Diametric::Persistence::ListenableFuture");
+            DiametricListenableFuture diametric_listenable = (DiametricListenableFuture)clazz.allocate();
+            diametric_listenable.init(future);
+            return diametric_listenable;
+        } catch (Throwable t) {
+            throw context.getRuntime().newRuntimeError(t.getMessage());
+        }
+    }
+
+    @JRubyMethod
+    public IRubyObject gc_storage(ThreadContext context, IRubyObject arg) {
+        if (!(arg.respondsTo("to_time"))) {
+            throw context.getRuntime().newArgumentError("Wrong argument type");
+        }
+        RubyTime rubyTime = (RubyTime) RuntimeHelpers.invoke(context, arg, "to_time");
+        Date olderThan = rubyTime.getJavaDate();
+        try {
+            clojure.lang.RT.var("datomic.api", "gc-strage").invoke(conn, olderThan);
+        } catch (Throwable t) {
+            throw context.getRuntime().newRuntimeError("Datomic error: " + t.getMessage());
+        }
+        return context.getRuntime().getNil();
+    }
+
+    @JRubyMethod
+    public IRubyObject release(ThreadContext context) {
+        try {
+            clojure.lang.RT.var("datomic.api", "release").invoke(conn);
+        } catch (Throwable t) {
+            throw context.getRuntime().newRuntimeError(t.getMessage());
+        }
+        return context.getRuntime().getNil();
+    }
+}