diametric 0.1.1-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87aa3d4e00a0b4f5ffbc7e06710d8bfaeddc318b
+  data.tar.gz: 8a5f18c2e823279ce54471a89b336670a5a6219e
+SHA512:
+  metadata.gz: 54e3e57bfad6731d7c09dbf23a6cc79e84becd30b0e9396171fe945c9a4b8e94351a4eb0795ec6e3a8e944d8ca636f4b13cf287821808975d82878427fac7c01
+  data.tar.gz: abd9bd9e3f162db5e6dd070c496f6f6363dc09fb6c573689b4f754b799dbe643a0e9b9e5fba880af7acd90efa143307cbc85576b6cb219ea174c2beb6dc549c8

data/Gemfile

@@ -0,0 +1,28 @@
+# -*- ruby -*-
+
+source 'https://rubygems.org'
+
+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'
+
+gem 'lock_jar', '~> 0.7.5', :platform => :jruby
+gem 'jruby-openssl', '~> 0.8.8', :platform => :jruby
+gem 'uuid', '~> 2.3.7'
+
+gem 'rspec', '~> 2.14.1'
+gem 'pry', '~> 0.9.12.2'
+
+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
+

data/Jarfile

@@ -0,0 +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:#{artifactId}:#{version}"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Clinton N. Dreisbach
+
+MIT License
+
+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 OR COPYRIGHT HOLDERS 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/README.md

@@ -0,0 +1,264 @@
+[![Build Status](https://secure.travis-ci.org/relevance/diametric.png)](http://travis-ci.org/relevance/diametric)
+
+# Diametric
+
+Diametric is a library for building schemas, queries, and transactions
+for [Datomic][] from Ruby objects. It is also used to map Ruby objects
+as entities into a Datomic database.
+
+## Thanks
+
+Development of Diametric was sponsored by [Relevance][]. They are the
+best Clojure shop around and one of the best Ruby shops. I highly
+recommend them for help with your corporate projects.
+
+Special thanks to Mongoid for writing some solid ORM code that was liberally borrowed from to add Rails support to Diametric.
+
+## Documents
+
+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
+
+The `Entity` module is interesting, in that it is primarily made of
+pure functions that take their receiver (an instance of the class they
+are included in) and return data that you can use in Datomic. This
+makes it not an ORM-like thing at all, but instead a Ruby-ish data
+builder for Datomic. And yet, a `Diametric::Entity` is fully
+`ActiveModel` compliant! You can use them anywhere you would use an
+`ActiveRecord` model or another `ActiveModel`-compliant instance.
+
+They do not include all `ActiveModel` modules by default, only the
+ones needed to establish compliance. You may want to include others
+yourself, such as `Validations` or `Callbacks`.
+
+```ruby
+require 'diametric'
+
+class Person
+  include Diametric::Entity
+
+  attribute :name, String, :index => true
+  attribute :email, String, :cardinality => :many
+  attribute :birthday, DateTime
+  attribute :iq, Integer
+end
+
+# To see what schema data will be produced:
+Person.schema
+
+# 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
+#   :db/cardinality :db.cardinality/one
+#   :db/index true
+#   :db.install/_attribute :db.part/db}
+#  {:db/id #db/id[:db.part/db]
+#   :db/ident :person/email
+#   :db/valueType :db.type/string
+#   :db/cardinality :db.cardinality/many
+#   :db.install/_attribute :db.part/db}
+#  {:db/id #db/id[:db.part/db]
+#   :db/ident :person/birthday
+#   :db/valueType :db.type/instant
+#   :db/cardinality :db.cardinality/one
+#   :db.install/_attribute :db.part/db}
+#  {:db/id #db/id[:db.part/db]
+#   :db/ident :person/iq
+#   :db/valueType :db.type/long
+#   :db/cardinality :db.cardinality/one
+#   :db.install/_attribute :db.part/db}]
+
+# 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)
+
+# 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 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. 
+
+To get query data and args for a query, call `.data` on a `Query`.
+
+If you are using a persistence API, you can ask `Query` to get the results of a Datomic query. `Diametric::Query` is an `Enumerable`. To get the results of a query, use `Enumerable` methods such as `.each` or `.first`. `Query` also provides a `.all` method to run the query and get the results.
+
+```ruby
+query = Datomic::Query.new(Person).where(:name => "Clinton Dreisbach")
+query.data
+# Datomic query:
+# [:find ?e ?name ?email ?birthday ?iq ?website
+#  :from $ ?name
+#  :where [?e :person/name ?name]
+#         [?e :person/email ?email]
+#         [?e :person/birthday ?birthday]
+#         [?e :person/iq ?iq]
+#         [?e :person/website ?website]]
+# Args:
+#   ["Clinton Dreisbach"]
+#
+# Returns as an array, [query, args].
+
+query = Datomic::Query.new(Person).where(:name => "Clinton Dreisbach").filter(:>, :iq, 150)
+query.data
+# Datomic query:
+# [:find ?e ?name ?email ?birthday ?iq ?website
+#  :from $ ?name
+#  :where [?e :person/name ?name]
+#         [?e :person/email ?email]
+#         [?e :person/birthday ?birthday]
+#         [?e :person/iq ?iq]
+#         [?e :person/website ?website]
+#         [> ?iq 150]
+# Args:
+#   ["Clinton Dreisbach"]
+#
+# Returns as an array, [query, args].
+```
+
+## Persistence 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.
+However, if you like to inlcude REST or Peer module explicitely, you can write it.
+
+
+### 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.
+
+```ruby
+require 'diametric'
+require 'diametric/persistence'
+
+# database URI
+# will create database if it does not already exist
+Diametric::Persistence.establish_base_connection({:uri=>'datomic:mem://sample'})
+```
+
+### REST
+
+With REST connection, you can create objects that know how to store themselves to Datomic through the Datomic REST API.
+REST connection is available both on CRuby and JRuby.
+You need to download Datomic by yourself and start the server before you run the code.
+
+```ruby
+require 'diametric'
+require 'diametric/persistence'
+
+# database url, database alias, database name
+# will create database if it does not already exist
+Diametric::Persistence.establish_base_connection({:uri => 'http://localhost:9000', :storage => 'free', :database => 'sample'})
+```
+
+### Using persisted models
+
+```ruby
+class Goat
+  include Diametric::Entity
+  include Diametric::Persistence
+  
+  attribute :name, String, :index => true
+  attribute :age, Integer
+end
+
+goat = Goat.new(:name => 'Beans', :age => 2)
+goat.dbid # => nil
+goat.name # => "Beans"
+goat.persisted? # => false
+goat.new? # => true
+
+goat.save
+goat.dbid # => new id autogenerated
+goat.name # => "Beans"
+goat.persisted? # => true
+goat.new? # => false
+
+goats = Goat.where(:name => "Beans")
+#=> [Goat(id: 1, age: 2, name: "Beans")]
+
+goat = Goat.first(:name => "Beans")
+#=> Goat(id: 1, age: 2, name: "Beans")
+
+goats = Goat.filter(:<, :age, 3)
+#=> [Goat(id: 1, age: 2, name: "Beans")]
+
+goats = Goat.filter(:>, :age, 3)
+#=> []
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'diametric'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install diametric
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+This project uses the [BSD License][].
+
+Copyright (c) 2012, Clinton Dreisbach & Relevance Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+[Datomic]: http://www.datomic.com
+[Relevance]: http://www.thinkrelevance.com
+[BSD License]: http://opensource.org/licenses/BSD-2-Clause

data/Rakefile

@@ -0,0 +1,49 @@
+begin
+  require 'rake'
+  require 'rspec/core/rake_task'
+rescue LoadError
+end
+
+
+task :default => :prepare
+
+task :prepare => :install_lockjar do
+  if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+    require 'lock_jar'
+
+    # get jarfile relative the gem dir
+    lockfile = File.expand_path("../Jarfile.lock", __FILE__)
+
+    LockJar.install(lockfile)
+  end
+end
+
+task :install_lockjar do
+  if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+    require 'rubygems'
+    require 'rubygems/dependency_installer'
+    inst = Gem::DependencyInstaller.new
+    inst.install 'lock_jar', '~> 0.7.2'
+  end
+end
+
+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