orientdb4r 0.2.0 → 0.2.1

data/README.rdoc

@@ -47,12 +47,19 @@ see Wiki page for more sample at https://github.com/veny/orientdb4r/wiki
   client.drop_class CLASS
   client.disconnect
 
+
 == INSTALL
 
   > sudo gem install orientdb4r
 
 * gem published on http://rubygems.org/gems/orientdb4r
 
+=== Important Upgrade Notice
+2012-06-19 [v0.2.1]: Client#create_class - parameter given to a block has new method 'link' to define a linked property
+2012-06-17 [v0.2.0]: Client#get_class raises Orientdb4r::NotFoundError instead of ArgumentError
+
+
+
 == FEATURES/PROBLEMS
 
 * Supports only REST API right now
@@ -63,6 +70,12 @@ Tested on
 * Ruby 1.9.3
 * OrientDB 1.0.0
 
+== TESTS
+
+   rake test
+
+Start an instance of OrientDB (on localhost with default port and 'admin/admin' account) before running.
+
 == AUTHOR
 
 * vaclav.sykora@gmail.com

data/lib/orientdb4r/client.rb

@@ -94,6 +94,11 @@ module Orientdb4r
         def proxy.property(property, type, options={})
           self.target.send :create_property, self.context, property, type, options
         end
+        def proxy.link(property, type, linked_class, options={})
+          raise ArgumentError, "type has to be a linked-type, given=#{type}" unless type.to_s.start_with? 'link'
+          options[:linked_class] = linked_class
+          self.target.send :create_property, self.context, property, type, options
+        end
         yield proxy
       end
     end
@@ -128,13 +133,20 @@ module Orientdb4r
       raise ArgumentError, "property name is blank" if blank?(property)
       opt_pattern = {
         :mandatory => :optional , :notnull => :optional, :min => :optional, :max => :optional,
-        :regexp =>  :optional, :custom => :optional
+        :regexp =>  :optional, :custom => :optional, :linked_class => :optional
       }
       verify_options(options, opt_pattern)
 
       cmd = "CREATE PROPERTY #{clazz}.#{property} #{type.to_s}"
+      # link?
+      if [:link, :linklist, :linkset, :linkmap].include? type.to_s.downcase.to_sym
+        raise ArgumentError, "defined linked-type, but not linked-class" unless options.include? :linked_class
+        cmd << " #{options[:linked_class]}"
+      end
       command cmd
 
+      # ALTER PROPERTY ...
+      options.delete :linked_class # it's not option for ALTER
       unless options.empty?
         options.each do |k,v|
           command "ALTER PROPERTY #{clazz}.#{property} #{k.to_s.upcase} #{v}"
@@ -142,6 +154,26 @@ module Orientdb4r
       end
     end
 
+
+    ###
+    # Creates links between two or more records of type Document.
+    # You need to create the class before.
+#    def create_link(clazz, options={})
+#      raise ArgumentError, "class name is blank" if blank?(clazz)
+#      opt_pattern = {
+#        :name => :optional, :type => :optional,
+#        :source_property => :mandatory, :destination_class => :mandatory, :destination_property => :mandatory
+#      }
+#      verify_options(options, opt_pattern)
+#
+#      cmd = 'CREATE LINK '
+#      cmd << "#{options[:name]} " if options.include? :name
+#      cmd << "TYPE #{options[:type]} " if options.include? :type
+#      cmd << "FROM #{clazz}.#{options[:source_property]} TO #{options[:destination_class]}.#{options[:destination_property]}"
+#puts cmd
+#      command cmd
+#    end
+
     # ----------------------------------------------------------------- DOCUMENT
 
     ###
@@ -178,7 +210,7 @@ module Orientdb4r
       ###
       # Asserts if the client is connected and raises an error if not.
       def assert_connected
-        raise OrientdbError, "not connected" unless @connected
+        raise ConnectionError, 'not connected' unless @connected
       end
 
       ###

data/lib/orientdb4r/rest/client.rb

@@ -89,7 +89,7 @@ module Orientdb4r
       connect_info = process_response(response, :mode => :strict)
 
       classes = connect_info['classes'].select { |i| i['name'] == name }
-      raise ArgumentError, "class not found, name=#{name}" unless 1 == classes.size
+      raise NotFoundError, "class not found, name=#{name}" unless 1 == classes.size
       decorate_classes_with_model(classes)
       clazz = classes[0]
       clazz.extend Orientdb4r::HashExtension
@@ -109,7 +109,7 @@ module Orientdb4r
     def query(sql) #:nodoc:
       raise ArgumentError, 'query is blank' if blank? sql
 
-      response = @resource["query/#{@database}/sql/#{URI.escape(sql)}"].get
+      response = @resource["query/#{@database}/sql/#{CGI::escape(sql)}"].get
       rslt = process_response(response)
       rslt['result']
     end
@@ -119,7 +119,7 @@ module Orientdb4r
       raise ArgumentError, 'command is blank' if blank? sql
       begin
 #puts "REQ #{sql}"
-        response = @resource["command/#{@database}/sql/#{URI.escape(sql)}"].post ''
+        response = @resource["command/#{@database}/sql/#{CGI::escape(sql)}"].post ''
         rslt = process_response(response)
         rslt
 #puts "RESP #{response.code}"

data/lib/orientdb4r/rest/model.rb

@@ -92,6 +92,12 @@ module Orientdb4r
       get_mandatory_attribute :notNull
     end
 
+    ###
+    # Gets linked class if the property is a link.
+    def linked_class
+      self['linkedClass']
+    end
+
     ###
     # Gets the minimal allowed value.
     def min

data/lib/orientdb4r/utils.rb

@@ -60,9 +60,27 @@ module Orientdb4r
         block.call
       end
 
-    end
+    end # Proxy
+
+
+    class DataGenerator
+
+      def initialize
+        @worlds = IO.readlines('/usr/share/dict/words')
+        0.upto(@worlds.size - 1) do |i|
+          word = @worlds[i]
+          word.strip!
+          idx = word.index("'")
+          word = word[0..(idx - 1)] unless idx.nil?
+          @worlds[i] = word
+        end
+        @worlds.uniq
+        Orientdb4r::logger.info "DataGenerator: #{@worlds.size} words"
+      end
+
+    end # DataGenerator
 
-  end
+  end # Utils
 
 
   # TODO extend it to work with already defined methods ('before :foo, :baz' after method definition)

data/lib/orientdb4r/version.rb

@@ -2,6 +2,7 @@ module Orientdb4r
 
   # Version history.
   VERSION_HISTORY = [
+    ['0.2.1', '2012-06-19', "Fixed linked property definition"],
     ['0.2.0', '2012-06-12', "Introduces document's CRUD operations"],
     ['0.1.2', '2012-06-10', 'Introduces new OClass module'],
     ['0.1.1', '2012-06-08', 'First working version (including unit tests) released at github.com'],

data/test/test_database.rb

@@ -46,7 +46,7 @@ class TestDatabase < Test::Unit::TestCase
     @client.disconnect
     assert !@client.connected?
     # unable to query after disconnect
-    assert_raise Orientdb4r::OrientdbError do @client.query 'SELECT FROM OUser'; end
+    assert_raise Orientdb4r::ConnectionError do @client.query 'SELECT FROM OUser'; end
   end
 
 

data/test/test_ddo.rb

@@ -30,7 +30,7 @@ class TestDdo < Test::Unit::TestCase
   def test_get_class
     assert_nothing_thrown do ouser = @client.get_class 'OUser'; end
     # class does not exist
-    assert_raise ArgumentError do @client.get_class 'OUserXXX'; end
+    assert_raise Orientdb4r::NotFoundError do @client.get_class 'OUserXXX'; end
 
     clazz = @client.get_class 'OUser'
     # test OClass
@@ -90,7 +90,7 @@ class TestDdo < Test::Unit::TestCase
     @client.create_class(super_clazz);
     @client.create_class(CLASS);
     assert_nothing_thrown do @client.drop_class(CLASS); end
-    assert_raise ArgumentError do @client.get_class(CLASS); end # no info more
+    assert_raise Orientdb4r::NotFoundError do @client.get_class(CLASS); end # no info more
     # the class is not visible in class list delivered by connect
     rslt = @client.connect :database => DB, :user => 'admin', :password => 'admin'
     assert rslt['classes'].select { |i| i.name == CLASS }.empty?
@@ -110,10 +110,32 @@ class TestDdo < Test::Unit::TestCase
     @client.create_class(CLASS)
     assert_nothing_thrown do @client.create_property(CLASS, 'prop1', :integer); end
     clazz = @client.get_class(CLASS)
-    assert_equal 'INTEGER', clazz.property(:prop1)['type']
+    assert_equal 'INTEGER', clazz.property(:prop1).type
+    assert_nil clazz.property(:prop1).linked_class
 
     # already exist
-#    assert_raise Orientdb4r::OrientdbError do @client.create_property(CLASS, 'prop1', :integer); end
+    assert_raise Orientdb4r::OrientdbError do @client.create_property(CLASS, 'prop1', :integer); end
+  end
+
+
+  ###
+  # CREATE PROPERTY (linked-type)
+  def test_create_linkedtype
+    @client.create_class(CLASS)
+    assert_nothing_thrown do @client.create_property(CLASS, 'friends', :linkset, :linked_class => 'OUser'); end
+    clazz = @client.get_class(CLASS)
+    assert_equal 'LINKSET', clazz.property(:friends).type
+    assert_equal 'OUser', clazz.property(:friends).linked_class
+
+    # unknow linked-class
+    assert_raise Orientdb4r::OrientdbError do
+      @client.create_property(CLASS, 'friends2', :linkset, :linked_class => 'UnknownClass')
+    end
+
+    # already exist
+    assert_raise Orientdb4r::OrientdbError do
+      @client.create_property(CLASS, 'friends', :linkset, :linked_class => 'OUser');
+    end
   end
 
 
@@ -123,26 +145,37 @@ class TestDdo < Test::Unit::TestCase
     assert_nothing_thrown do
       @client.create_class(CLASS) do |c|
         c.property 'prop1', :integer
-        c.property 'prop2', :string, :mandatory => true, :notnull => :true, :min => 1, :max => 99
+        c.property 'prop2', :string, :mandatory => true, :notnull => true, :min => 1, :max => 99
+        c.link     'user',  :linkset, 'OUser', :mandatory => true
       end
     end
 
     clazz = @client.get_class(CLASS)
-    assert_equal 2, clazz.properties.size
+    assert_equal 3, clazz.properties.size
 
     prop1 = clazz.property(:prop1)
-    assert_equal 'INTEGER', prop1['type']
-    assert !prop1['mandatory']
-    assert !prop1['notNull']
-    assert prop1['min'].nil?
-    assert prop1['max'].nil?
+    assert_equal 'INTEGER', prop1.type
+    assert !prop1.mandatory
+    assert !prop1.not_null
+    assert_nil prop1.min
+    assert_nil prop1.max
+    assert_nil prop1.linked_class
 
     prop2 = clazz.property(:prop2)
-    assert_equal 'STRING', prop2['type']
-    assert prop2['mandatory']
-    assert prop2['notNull']
-    assert_equal '1', prop2['min']
-    assert_equal '99',  prop2['max']
+    assert_equal 'STRING', prop2.type
+    assert prop2.mandatory
+    assert prop2.not_null
+    assert_equal '1', prop2.min
+    assert_equal '99',  prop2.max
+    assert_nil prop2.linked_class
+
+    user = clazz.property(:user)
+    assert_equal 'LINKSET', user.type
+    assert user.mandatory
+    assert !user.not_null
+    assert_nil user.min
+    assert_nil user.max
+    assert_equal 'OUser', user.linked_class
   end
 
 end

data/test/test_dmo.rb

@@ -17,7 +17,9 @@ class TestDmo < Test::Unit::TestCase
     @client.create_class(CLASS) do |c|
       c.property 'prop1', :integer
       c.property 'prop2', :string, :mandatory => true, :notnull => :true, :min => 1, :max => 99
+      c.link     'friends',  :linkset, 'OUser', :mandatory => true
     end
+    @admin = @client.query("SELECT FROM OUser WHERE name = 'admin'")[0]
   end
 
   def teardown
@@ -29,14 +31,25 @@ class TestDmo < Test::Unit::TestCase
 
   ###
   # INSERT INTO
-  def test_insert
+  def xtest_insert
     assert_nothing_thrown do
       1.upto(10) do |i|
-        @client.command "INSERT INTO #{CLASS} (prop1, prop2) VALUES (#{i}, '#{random_string}')"
+        @client.command "INSERT INTO #{CLASS} (prop1, prop2, friends) VALUES (#{i}, '#{random_string}', [#{@admin['@rid']}])"
       end
     end
 
-    assert_equal 10, @client.query("SELECT count(*) FROM #{CLASS}")[0]['count'].to_i
+    entries = @client.query("SELECT FROM #{CLASS}")
+    assert_equal 10, entries.size
+    assert_equal 10, entries.select { |e| e if e['prop1'] <= 10 }.size
+    assert_equal 10, entries.select { |e| e if e['friends'].size == 1 }.size
+
+    # insert more users into LINKSET
+    urids = @client.query('SELECT FROM OUser').collect { |u| u['@rid'] }
+    assert_nothing_thrown do
+      @client.command "INSERT INTO #{CLASS} (prop1, prop2, friends) VALUES (1, 'linkset', [#{urids.join(',')}])"
+    end
+    assert_equal urids.size, @client.query("SELECT FROM #{CLASS} WHERE prop2 = 'linkset'")[0]['friends'].size
+
   end
 
 
@@ -44,10 +57,19 @@ class TestDmo < Test::Unit::TestCase
   # SELECT
   def test_query
     1.upto(10) do |i|
-      @client.command "INSERT INTO #{CLASS} (prop1, prop2) VALUES (#{i}, 'string#{i}')"
+      @client.command "INSERT INTO #{CLASS} (prop1, prop2, friends) VALUES (#{i}, 'string#{i}', [#{@admin['@rid']}])"
     end
 
-    puts @client.query("SELECT FROM #{CLASS}")
+    assert_equal 10, @client.query("SELECT FROM #{CLASS}").size
+    assert_equal 1, @client.query("SELECT FROM #{CLASS} WHERE prop1 = 1").size
+    assert_equal 0, @client.query("SELECT FROM #{CLASS} WHERE prop1 = 11").size
+    # graph
+    rid = @client.query("SELECT FROM #{CLASS} WHERE prop1 = 1")[0]['@rid']
+    gr = @client.query("SELECT FROM (TRAVERSE * FROM #{rid})")
+    assert_equal 3, gr.size # # entries: testing, OUser, ORole
+    assert_equal 1, gr.select { |e| e if e['@class'] == CLASS }.size
+    assert_equal 1, gr.select { |e| e if e['@class'] == 'OUser' }.size
+    assert_equal 1, gr.select { |e| e if e['@class'] == 'ORole' }.size
   end
 
 end

data/test/test_document_crud.rb

@@ -2,7 +2,7 @@ require 'test/unit'
 require 'orientdb4r'
 
 ###
-# This class tests Data Manipulation Operarions.
+# This class tests CRUD operarions on document.
 class TestDocumentCrud < Test::Unit::TestCase
   include Orientdb4r::Utils
 
@@ -127,8 +127,8 @@ class TestDocumentCrud < Test::Unit::TestCase
     doc = @client.get_document rid
     assert_not_nil doc
 
+    assert_nothing_thrown do @client.delete_document rid; end
     # already deleted
-    @client.delete_document rid
     assert_raise Orientdb4r::NotFoundError do @client.get_document rid; end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orientdb4r
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-12 00:00:00.000000000 Z
+date: 2012-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client