diametric 0.0.1 → 0.0.2

data/Gemfile

@@ -5,10 +5,21 @@ gemspec
 
 # Development-only dependencies
 gem 'rake'
-gem 'pry'
 gem 'rspec'
+gem 'pry'
+
+gem 'guard'
+gem 'guard-rspec'
+gem 'rb-inotify', :require => false
+gem 'rb-fsevent', :require => false
+gem 'rb-fchange', :require => false
 
 platform :mri do
-  gem 'yard'
-  gem 'redcarpet'
+  gem 'yard', :group => :development
+  gem 'redcarpet', :group => :development
+end
+
+platform :jruby do
+  gem 'jruby-openssl'
+  gem 'lock_jar'
 end

data/README.md

@@ -1,9 +1,19 @@
+[![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.
+
 ## Entity API
 
 The `Entity` module is interesting, in that it is primarily made of
@@ -150,7 +160,7 @@ require 'diametric/persistence/rest'
 
 # database url, database alias, database name
 # will create database if it does not already exist
-Diametric::Persistence::REST.connect('http://localhost:9000', 'test', 'animals')
+Diametric::Persistence::REST.connect('http://localhost:9000', 'free', 'animals')
 ```
 
 ### Using persisted models
@@ -212,4 +222,19 @@ Or install it yourself as:
 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

@@ -1,11 +1,13 @@
 begin
   require "bundler/gem_tasks"
+  require 'rspec/core/rake_task'
 rescue LoadError
 end
 
+
 task :default => :prepare
 
-task :prepare do
+task :prepare => :install_lockjar do
   if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
     require 'lock_jar'
 
@@ -15,3 +17,17 @@ task :prepare do
     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)

data/diametric.gemspec

@@ -6,26 +6,27 @@ require 'diametric/version'
 Gem::Specification.new do |gem|
   gem.name          = "diametric"
   gem.version       = Diametric::VERSION
-  gem.authors       = ["Clinton N. Dreisbach"]
-  gem.email         = ["crnixon@gmail.com"]
+  gem.authors       = ["Clinton N. Dreisbach", "Ryan K. Neufeld", "Yoko Harada"]
+  gem.email         = ["crnixon@gmail.com", "ryan@thinkrelevance.com", "yoko@thinkrelevance.com"]
   gem.summary       = %q{ActiveModel for Datomic}
   gem.description   = <<EOF
 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.
 EOF
-  gem.homepage      = "https://github.com/crnixon/diametric"
+  gem.homepage      = "https://github.com/relevance/diametric"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files         = %w(Gemfile Jarfile Jarfile.lock LICENSE.txt README.md Rakefile diametric.gemspec) + Dir.glob('lib/**/*')
+  gem.executables   = []
+  gem.test_files    = Dir.glob("spec/**/*.rb")
   gem.require_paths = ["lib"]
 
   gem.add_dependency 'edn', '~> 1.0'
   gem.add_dependency 'activesupport', '>= 3.0.0'
   gem.add_dependency 'activemodel', '>= 3.0.0'
   gem.add_dependency 'datomic-client', '~> 0.4.1'
-  gem.add_dependency 'lock_jar', '~> 0.7.2'
+  gem.add_dependency 'rspec'
+  gem.add_dependency 'lock_jar', '= 0.7.2' if defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
 
   gem.extensions = ['Rakefile']
 end

data/lib/diametric.rb

@@ -1,9 +1,17 @@
 require "diametric/version"
 require "diametric/entity"
 require "diametric/query"
+require "diametric/persistence"
+
+require 'diametric/config'
+
+if defined?(Rails)
+  require 'diametric/railtie'
+end
 
 # 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.
 module Diametric
+  extend Diametric::Config
 end

data/lib/diametric/config.rb

@@ -0,0 +1,54 @@
+require 'diametric/config/environment'
+require 'diametric/persistence'
+
+module Diametric
+  # Program-level configuration services including configuration loading and base connections.
+  module Config
+    extend self
+
+    # The current configuration Diametric will use in {#connect!}
+    #
+    # @return [Hash]
+    def configuration
+      @configuration ||= {}
+    end
+
+    # Determine if Diametric has been configured
+    #
+    # @return [Boolean]
+    def configured?
+      configuration.present?
+    end
+
+    # Load settings from a compliant diametric.yml file and make a connection. This can be used for
+    # easy setup with frameworks other than Rails.
+    #
+    # See {Persistence} for valid options.
+    #
+    # @example Configure Diametric.
+    #   Diametric.load_and_connect!("/path/to/diametric.yml")
+    #
+    # @param [ String ] path The path to the file.
+    # @param [ String, Symbol ] environment The environment to load.
+    def load_and_connect!(path, environment = nil)
+      settings = Environment.load_yaml(path, environment)
+      @configuration = settings.with_indifferent_access
+      connect!(configuration)
+      peer_setup if Diametric::Persistence.peer?
+      configuration
+    end
+
+    # Establish a base connection from the supplied configuration hash.
+    #
+    # @param [ Hash ] configuration The configuration of the database to connect to. See {Persistence.establish_base_connection} for valid options.
+    def connect!(configuration)
+      ::Diametric::Persistence.establish_base_connection(configuration)
+    end
+
+    private
+    def peer_setup
+      load File.join(File.dirname(__FILE__), '..', 'tasks', 'create_schema.rb')
+      Rake::Task["diametric:create_schema_for_peer"].invoke
+    end
+  end
+end

data/lib/diametric/config/environment.rb

@@ -0,0 +1,42 @@
+module Diametric
+  module Config
+
+    # Encapsulates logic for getting environment information.
+    #
+    # This is nearly a word-for-word copy of {http://github.com/mongoid/mongoid Mongoid}'s {https://github.com/mongoid/mongoid/blob/master/lib/mongoid/config/environment.rb lib/mongoid/config/environment.rb} file.
+    # Thanks!
+    module Environment
+      extend self
+
+      # Get the name of the environment that we are running under. This first
+      # looks for Rails, then Sinatra, then a RACK_ENV environment variable,
+      # and if none of those are found raises an error.
+      #
+      # @example Get the env name.
+      #   Environment.env_name
+      #
+      # @raise [ "No environment specified" ] If no environment was set.
+      #
+      # @return [ String ] The name of the current environment.
+      def env_name
+        return Rails.env if defined?(Rails)
+        return Sinatra::Base.environment.to_s if defined?(Sinatra)
+        ENV["RACK_ENV"] || ENV["DIAMETRIC_ENV"] || raise("No environment specified")
+      end
+
+      # Load the yaml from the provided path and return the settings for the
+      # current environment.
+      #
+      # @example Load the yaml.
+      #   Environment.load_yaml("/work/diametric.yml")
+      #
+      # @param [ String ] path The location of the file.
+      #
+      # @return [ Hash ] The settings.
+      def load_yaml(path, environment = nil)
+        env = environment ? environment.to_s : env_name
+        YAML.load(ERB.new(File.new(path).read).result)[env]
+      end
+    end
+  end
+end

data/lib/diametric/entity.rb

@@ -28,6 +28,7 @@ module Diametric
   #   The database id assigned to the entity by Datomic.
   #   @return [Integer]
   module Entity
+    Ref = "ref"
     # Conversions from Ruby types to Datomic types.
     VALUE_TYPES = {
       Symbol => "keyword",
@@ -39,6 +40,10 @@ module Diametric
       URI => "uri"
     }
 
+    DEFAULT_OPTIONS = {
+      :cardinality => :one
+    }
+
     @temp_ref = -1000
 
     def self.included(base)
@@ -46,9 +51,12 @@ module Diametric
       base.send(:extend, ActiveModel::Naming)
       base.send(:include, ActiveModel::Conversion)
       base.send(:include, ActiveModel::Dirty)
+      base.send(:include, ActiveModel::Validations)
 
       base.class_eval do
-        @attributes = []
+        @attributes = {}
+        @defaults = {}
+        @namespace_prefix = nil
         @partition = :"db.part/user"
       end
     end
@@ -64,6 +72,9 @@ module Diametric
     #
     # @!attribute [r] attributes
     #   @return [Array] Definitions of each of the entity's attributes (name, type, options).
+    #
+    # @!attribute [r] defaults
+    #   @return [Array] Default values for any entitites defined with a +:default+ key and value.
     module ClassMethods
       def partition
         @partition
@@ -77,13 +88,35 @@ module Diametric
         @attributes
       end
 
+      def defaults
+        @defaults
+      end
+
+      # Set the namespace prefix used for attribute names
+      #
+      # @param prefix [#to_s] The prefix to be used for namespacing entity attributes
+      #
+      # @example Override the default namespace prefix
+      #   class Mouse
+      #     include Diametric::Entity
+      #
+      #     namespace_prefix :mice
+      #   end
+      #
+      #   Mouse.new.prefix # => :mice
+      #
+      # @return void
+      def namespace_prefix(prefix)
+        @namespace_prefix = prefix
+      end
+
       # Add an attribute to a {Diametric::Entity}.
       #
       # Valid options are:
       #
       # * +:index+: The only valid value is +true+. This causes the
       #   attribute to be indexed for easier lookup.
-      # * +:unique+: Valid values are +:value+ or +:identity.
+      # * +:unique+: Valid values are +:value+ or +:identity.+
       #   * +:value+ causes the attribute value to be unique to the
       #     entity and attempts to insert a duplicate value will fail.
       #   * +:identity+ causes the attribute value to be unique to
@@ -98,11 +131,13 @@ module Diametric
       #     single value with an entity.
       #   * +:many+ - the attribute is mutli valued, it associates a
       #     set of values with an entity.
-      #   To be honest, I have no idea how this will work in Ruby. Try +:many+ at your own risk.
       #   +:one+ is the default.
       # * +:doc+: A string used in Datomic to document the attribute.
       # * +:fulltext+: The only valid value is +true+. Indicates that a
       #   fulltext search index should be generated for the attribute.
+      # * +:default+: The value the attribute will default to when the
+      #   Entity is initialized. Defaults for attributes with +:cardinality+ of +:many+
+      #   will be transformed into a Set by passing the default to +Set.new+.
       #
       # @example Add an indexed name attribute.
       #   attribute :name, String, :index => true
@@ -114,20 +149,18 @@ module Diametric
       #
       # @return void
       def attribute(name, value_type, opts = {})
-        @attributes << [name, value_type, opts]
-        define_attribute_method name
-        define_method(name) do
-          instance_variable_get("@#{name}")
-        end
-        define_method("#{name}=") do |value|
-          send("#{name}_will_change!") unless value == instance_variable_get("@#{name}")
-          instance_variable_set("@#{name}", value)
-        end
+        opts = DEFAULT_OPTIONS.merge(opts)
+
+        establish_defaults(name, value_type, opts)
+
+        @attributes[name] = {:value_type => value_type}.merge(opts)
+
+        setup_attribute_methods(name, opts[:cardinality])
       end
 
       # @return [Array<Symbol>] Names of the entity's attributes.
       def attribute_names
-        @attributes.map { |name, _, _| name }
+        @attributes.keys
       end
 
       # Generates a Datomic schema for a model's attributes.
@@ -141,10 +174,12 @@ module Diametric
           :"db.install/_attribute" => :"db.part/db"
         }
 
-        @attributes.reduce([]) do |schema, (attribute, value_type, opts)|
+        @attributes.reduce([]) do |schema, (attribute, opts)|
           opts = opts.dup
+          value_type = opts.delete(:value_type)
+
           unless opts.empty?
-            opts[:cardinality] = namespace("db.cardinality", opts[:cardinality]) if opts[:cardinality]
+            opts[:cardinality] = namespace("db.cardinality", opts[:cardinality])
             opts[:unique] = namespace("db.unique", opts[:unique]) if opts[:unique]
             opts = opts.map { |k, v|
               k = namespace("db", k)
@@ -166,12 +201,13 @@ module Diametric
       # @return [Entity]
       def from_query(query_results)
         dbid = query_results.shift
-        widget = self.new(Hash[*(@attributes.map { |attribute, _, _| attribute }.zip(query_results).flatten)])
+        widget = self.new(Hash[attribute_names.zip query_results])
         widget.dbid = dbid
         widget
       end
 
-      # Returns the prefix for this model used in Datomic.
+      # Returns the prefix for this model used in Datomic. Can be
+      # overriden by declaring {#namespace_prefix}
       #
       # @example
       #   Mouse.prefix #=> "mouse"
@@ -180,7 +216,7 @@ module Diametric
       #
       # @return [String]
       def prefix
-        self.to_s.underscore.sub('/', '.')
+        @namespace_prefix || self.to_s.underscore.sub('/', '.')
       end
 
       # Create a temporary id placeholder.
@@ -212,6 +248,27 @@ module Diametric
         end
         namespace("db.type", vt)
       end
+
+      def establish_defaults(name, value_type, opts = {})
+        default = opts.delete(:default)
+        @defaults[name] = default if default
+      end
+
+      def setup_attribute_methods(name, cardinality)
+        define_attribute_method name
+
+        define_method(name) do
+          instance_variable_get("@#{name}")
+        end
+
+        define_method("#{name}=") do |value|
+          send("#{name}_will_change!") unless value == instance_variable_get("@#{name}")
+          if cardinality == :many
+            value = Set.new(value)
+          end
+          instance_variable_set("@#{name}", value)
+        end
+      end
     end
 
     def dbid
@@ -230,7 +287,7 @@ module Diametric
     # @param params [Hash] A hash of attributes and values to
     #   initialize the entity with.
     def initialize(params = {})
-      params.each do |k, v|
+      self.class.defaults.merge(params).each do |k, v|
         self.send("#{k}=", v)
       end
     end
@@ -243,19 +300,45 @@ module Diametric
 
     # Creates data for a Datomic transaction.
     #
-    # @param attributes [*Symbol] Attributes to save in the
-    #   transaction. If no attributes are given, any changed
+    # @param attribute_names [*Symbol] Attribute names to save in the
+    #   transaction. If no names are given, any changed
     #   attributes will be saved.
     #
     # @return [Array] Datomic transaction data.
-    def tx_data(*attributes)
-      tx = {:"db/id" => dbid || tempid}
-      attributes = self.changed_attributes.keys if attributes.empty?
-      attributes.reduce(tx) do |t, attribute|
-        t[self.class.namespace(self.class.prefix, attribute)] = self.send(attribute)
-        t
+    def tx_data(*attribute_names)
+      attribute_names = self.changed_attributes.keys if attribute_names.empty?
+
+      entity_tx = {}
+      txes = []
+      attribute_names.each do |attribute_name|
+        cardinality = self.class.attributes[attribute_name.to_sym][:cardinality]
+
+        if cardinality == :many
+          txes += cardinality_many_tx_data(attribute_name)
+        else
+          entity_tx[self.class.namespace(self.class.prefix, attribute_name)] = self.send(attribute_name)
+        end
       end
-      [tx]
+
+      if entity_tx.present?
+        txes << entity_tx.merge({:"db/id" => dbid || tempid})
+      end
+
+      txes
+    end
+
+    def cardinality_many_tx_data(attribute_name)
+      prev = Array(self.changed_attributes[attribute_name]).to_set
+      curr = self.send(attribute_name)
+
+      protractions = curr - prev
+      retractions = prev - curr
+
+      txes = []
+      namespaced_attribute = self.class.namespace(self.class.prefix, attribute_name)
+      txes << [:"db/retract", (dbid || tempid), namespaced_attribute, retractions.to_a] unless retractions.empty?
+      txes << [:"db/add", (dbid || tempid) , namespaced_attribute, protractions.to_a] unless protractions.empty?
+      txes
     end
 
     # @return [Array<Symbol>] Names of the entity's attributes.
@@ -335,5 +418,20 @@ module Diametric
     def errors
       @errors ||= ActiveModel::Errors.new(self)
     end
+
+    # Update method updates attribute values and saves new values in datomic.
+    # The method receives hash as an argument.
+    def update(attrs)
+      attrs.each do |k, v|
+        self.send(k.to_s+"=", v)
+        self.changed_attributes[k]=v
+      end
+      self.save if self.respond_to? :save
+      true
+    end
+
+    def destroy
+      self.retract_entity(dbid)
+    end
   end
 end