active-orient 0.4 → 0.5

data/examples/time_graph/Guardfile

@@ -0,0 +1,26 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+def fire
+  require "ostruct"
+
+  # Generic Ruby apps
+  rspec = OpenStruct.new
+  rspec.spec = ->(m) { "spec/#{m}_spec.rb" }
+  rspec.spec_dir = "spec"
+  rspec.spec_helper = "spec/spec_helper.rb"
+
+
+  watch(%r{^spec/.+_spec\.rb$})
+#  watch(%r{^spec/usecase/(.+)\.rb$})
+  watch(%r{^model/(.+)\.rb$})     { |m| "spec/model/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+#  watch(%r{^examples/time_graph/spec/(.+)_spec\.rb$}) 
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+interactor :simple
+if RUBY_PLATFORM == 'java' 
+guard( 'jruby-rspec') {fire}  #', :spec_paths => ["spec"]
+else
+guard( :rspec, cmd: "bundle exec rspec") { fire }
+end

data/examples/time_graph/README.md

@@ -0,0 +1,129 @@
+#Example: Time Graph
+
+The bin-directory contains a customized console-application. 
+Any libraries are included and one can start exploring the features immediately.
+
+*Prerequisites* : 
+* Edit the Gemfile, update the pathes to include the orientdb_jruby an d activeorient gem
+* Run "Bundle install" and "Bundle update"
+* customize config/connect.yml
+
+There is a rspec-section, run "bundle exec guard", edit the spec-files and start the test by saving the dataset.
+
+To play around, start the console by
+  cd bin
+  ./active-orient-console t  # test-modus
+
+The Database is initialized/resetted by calling
+
+```ruby
+ActiveOrient::OrientSetup.init_database
+```
+
+This executes the code located in 'config/init_db.rb'
+
+The following hierarchy is build:
+
+```ruby
+- E
+- - day_of
+- - time_of
+- V
+- - time_base
+- - - monat
+- - - stunde
+- - - tag
+```
+And this Graph is realized
+
+```ruby
+Monat --[DAY_OF]-- Tag --[TIME_OF]-- Stunde
+```
+and populated by calling 
+
+```ruby
+CreateTime.populate_month	# 1 One Month whith appropoiate Days and Hours
+```
+
+You can check the Status by counting the recods of the Classes
+
+```ruby
+Monat.count 		# 1
+Tag.count 			# 32
+Stunde.count		# 768
+```
+which should be equal to the counts of the Edge-Classes DAY_OF and TIME_OF
+
+In the Model-directory, customized methods simplify the usage of the graph.
+
+Some Examples:
+
+```ruby
+m =  Date.today.month  # current month
+
+Monat[m].tag.value
+=> [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31] 
+
+Monat[m].tag[9].stunde[9].value
+=> 9
+
+Monat[month].tag[9].next.datum
+ => "10.8.2016" 
+
+Stunde[9]					# [] is defined in model/timebase.rb
+=> An Array with Stunde-records 
+Stunde[9].datum				# datum is defined in model/stunde.rb
+ => ["0.8.2016 9:00", "1.8.2016 9:00", "2.8.2016 9:00", "3.8.2016 9:00", "4.8.2016 9:00", "5.8.2016 9:00", "6.8.2016 9:00", "7.8.2016 9:00", "8.8.2016 9:00", "9.8.2016 9:00", "10.8.2016 9:00", "11.8.2016 9:00", "12.8.2016 9:00", "13.8.2016 9:00", "14.8.2016 9:00", "15.8.2016 9:00", "16.8.2016 9:00", "17.8.2016 9:00", "18.8.2016 9:00", "19.8.2016 9:00", "20.8.2016 9:00", "21.8.2016 9:00", "22.8.2016 9:00", "23.8.2016 9:00", "24.8.2016 9:00", "25.8.2016 9:00", "26.8.2016 9:00", "27.8.2016 9:00", "28.8.2016 9:00", "29.8.2016 9:00", "30.8.2016 9:00", "31.8.2016 9:00"]
+
+Stunde[9][8 ..12].datum		# call datum on selected Stunde-records
+ => ["8.8.2016 9:00", "9.8.2016 9:00", "10.8.2016 9:00", "11.8.2016 9:00", "12.8.2016 9:00"] 
+
+```
+
+then you can assign appointments to these dates
+
+
+lets create a simple diary
+
+```ruby
+ORD.create_vertex_class :termin
+ => Termin
+ORD.create_edge_class   :date_of
+ => DATE_OF
+DATE_OF.create from: Monat[m].tag[9].stunde[12], 
+	       to: Termin.create( short: 'Mittagessen', 
+				  long: 'Schweinshaxen essen mit Lieschen Müller', 
+				  location: 'Hofbauhaus, München' )
+ => #<DATE_OF:0x0000000334e038 (..) @attributes={"out"=>"#21:57", "in"=>"#41:0", (..)}> 
+# create some regular events
+# attach breakfirst at 9 o clock from the 10th to the 21st Day in the current month
+DATE_OF.create from: Stunde[9][10..21], to: Termin.create( :short => 'Frühstück' )
+ => #<DATE_OF:0x000000028d5688 @metadata={(..) "cluster"=>45, "record"=>8}, 
+			      @attributes={"out"=>"#22:188", "in"=>"#42:0",(..)}>
+
+t = Termin.where short: 'Frühstück'
+t.in_time_of.out.first.datum
+  => ["10.8.2016 9:00", "11.8.2016 9:00", "12.8.2016 9:00", "13.8.2016 9:00", "14.8.2016 9:00", "15.8.2016 9:00", "16.8.2016 9:00", "17.8.2016 9:00", "18.8.2016 9:00", "19.8.2016 9:00", "20.8.2016 9:00", "21.8.2016 9:00"]
+
+
+```
+
+
+Another approach, starting with the simple graph 
+
+
+
+```ruby
+Monat[month].tag.each{|d| d.stunde.each{|s| s.termin=[]; s.save } } # populate hour-vertices 
+# we append our dates to the termin-property
+Monat[month].tag[9].stunde[8].termin << "Post"
+Monat[month].tag[9].stunde[9].termin << "zweites Frühstück"
+Monat[month].tag.each{|t| t.stunde[12].termin << "Mittag"}
+```
+
+
+
+
+
+
+

data/examples/time_graph/bin/active-orient-console

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+## loads the active-orient environment 
+## and starts an interactive shell
+## Parameter:  production (p)
+##	       development (d)  [default]
+##	       test (t)
+require 'logger'
+LogLevel = Logger::WARN
+require File.expand_path(File.dirname(__FILE__) + "/../config/boot")
+  
+ require 'orientdb' if RUBY_PLATFORM == 'java'
+ require 'yaml'
+
+puts "ORD points to the REST-Instance, Database: #{ActiveOrient.database}"
+puts "DB is the API-Instance of the database, DB.db gets the DB-Api-base " if RUBY_PLATFORM == 'java'
+
+puts '-'* 35
+ns= case ActiveOrient::Model.namespace 
+  when Object
+    "No Prefix, just ClassName#CamelCase"
+    else
+     ActiveOrient::Model.namespace.to_s + "{ClassName.camelcase}"
+    end
+puts "Namespace for model-classes : #{ns}"
+puts "Allocated Classes (Hierarchy) ( Modelclasses are Camelized ):"
+puts '-'* 35
+
+puts ORD.class_hierarchy.to_yaml
+
+
+include OrientDB
+
+require 'irb'
+ARGV.clear
+IRB.start(__FILE__)

data/examples/time_graph/config/boot.rb

@@ -0,0 +1,119 @@
+## parameters
+## @namespace : Class on which ActiveOrient::Model's should base
+## @do_not_preallocate : avoid preallocation upon boot
+
+require 'bundler/setup'
+require 'yaml'
+require 'active-orient'
+if RUBY_VERSION == 'java'
+  require 'orientdb'
+end
+project_root = File.expand_path('../..', __FILE__)
+#require "#{project_root}/lib/active-orient.rb"
+# mixin for define_namespace 
+include ActiveOrient::Init
+
+# make shure that E and V are required first => sort by length
+models= Dir.glob(File.join( project_root, "model",'**', "*rb")).sort{|x,y| x.size <=> y.size }
+
+begin
+  connect_file = File.expand_path('../../config/connect.yml', __FILE__)
+  config_file = File.expand_path('../../config/config.yml', __FILE__)
+  connectyml  = YAML.load_file( connect_file )[:orientdb][:admin] if connect_file.present?
+  configyml  = YAML.load_file( config_file )[:active_orient] if config_file.present?
+rescue Errno::ENOENT => e
+  ActiveOrient::Base.logger = Logger.new('/dev/stdout')
+  ActiveOrient::OrientDB.logger.error{ "config/connectyml not present"  }
+  ActiveOrient::OrientDB.logger.error{ "Using defaults to connect database-server"  }
+
+end
+
+e=  ARGV.present? ? ARGV.last.downcase : 'development'
+env =  if e =~ /^p/
+	 'production'
+       elsif e =~ /^t/
+	 'test'
+       else
+	 'development'
+       end
+puts "Using #{env}-environment"
+
+
+# lib/init.rb
+define_namespace yml: configyml, namespace: @namespace
+
+ActiveOrient::Model.model_dir =  "#{project_root}/#{ configyml.present? ? configyml[:model_dir] : "model" }"
+puts "BOOT--> Project-Root:  #{project_root}"
+puts "BOOT--> mode-dir:  #{ActiveOrient::Model.model_dir}"
+
+databaseyml   = YAML.load_file( connect_file )[:orientdb][:database]
+log_file =   if config_file.present?
+	       dev = YAML.load_file( connect_file )[:orientdb][:logger]
+	       if dev.blank? || dev== 'stdout'
+		 '/dev/stdout'
+	       else
+		 project_root+'/log/'+env+'.log'
+	       end
+	     end
+
+
+logger =  Logger.new log_file
+logger.level = case env
+	       when 'production' 
+		 Logger::ERROR
+	       when 'development'
+		 Logger::WARN
+	       else
+		 Logger::INFO
+	       end
+logger.formatter = proc do |severity, datetime, progname, msg|
+  "#{datetime.strftime("%d.%m.(%X)")}#{"%5s" % severity}->#{progname}:..:#{msg}\n"
+end
+ActiveOrient::Model.logger =  logger
+ActiveOrient::OrientDB.logger =  logger
+if connectyml.present? and connectyml[:user].present? and connectyml[:pass].present?
+  ActiveOrient.default_server= { user: connectyml[:user], password: connectyml[:pass] ,
+				 server: 'localhost', port: 2480  }
+  ActiveOrient.database = @configDatabase.presence || databaseyml[env.to_sym]
+
+  ## Include customized NamingConvention for Edges
+  ActiveOrient::Model.orientdb_class name:"E"
+  ActiveOrient::Model.orientdb_class name:"V"
+  class E #< ActiveOrient::Model
+      def self.naming_convention name=nil
+          name.present? ? name.upcase : ref_name.upcase
+      end
+  end
+
+
+  ORD = ActiveOrient::OrientDB.new  preallocate: @do_not_preallocate.present? ? false : true 
+  if RUBY_PLATFORM == 'java'
+    DB =  ActiveOrient::API.new   preallocate: false
+  else
+    DB = ORD
+  end
+
+#  ORD.create_classes 'E', 'V'
+#  E.ref_name = 'E'
+#  V.ref_name = 'V'
+
+# require model files after initializing the database
+#    require "#{project_root}/model/edge.rb"
+#    require "#{project_root}/model/vertex.rb"
+
+# require db-init and application
+     require "#{project_root}/config/init_db.rb"
+     require "#{project_root}/lib/createTime.rb"
+
+# thus the classes are predefined and modelfiles just extend the classes
+#included_models = models.collect { |file| [file, require( file )] }
+#puts "Included Models: "
+#puts included_models.collect{|x,y| [ "\t",x.split("/").last , " \t-> " , y].join }.join("\n")
+else
+  ActiveOrient::Base.logger = Logger.new('/dev/stdout')
+  ActiveOrient::OrientDB.logger.error{ "config/connectyml is  misconfigurated" }
+  ActiveOrient::OrientDB.logger.error{ "Database Server is NOT available"} 
+end
+
+
+

data/examples/time_graph/config/config.yml

@@ -0,0 +1,8 @@
+---
+:active_orient:
+## Namespace: Prefix of Model-Objects. :self -> ActiveOrient::Model::{name}
+##				       :object => No Prefix
+##				       :active_orient => ActiveOrient::{name}
+ :namespace: :object
+ :model_dir: 'model'
+

data/examples/time_graph/config/connect.yml

@@ -0,0 +1,17 @@
+---
+:orientdb:
+ :server: localhost # 172.28.50.109 # localhost   #mailout.halfgarten-capital.de
+ :port: 2480
+ :logger: stdout           # 'file' or 'stdout'
+ :database: 
+   :development: time_production
+   :production: time_dev
+   :test:  tempera
+ :admin:
+   :user: hctw
+   :pass: hc
+ :auth:
+   :user: topo
+   :pass: focus
+
+# hfx: 101

data/examples/time_graph/config/init_db.rb

@@ -0,0 +1,59 @@
+# Execute with 
+#  ActiveOrient::OrientSetup.init_database
+#
+module ActiveOrient
+  module OrientSetup
+    def self.init_database
+      (logger= ActiveOrient::Base.logger).progname= 'OrientSetup#InitDatabase'
+      vertexes =  ORD.class_hierarchy base_class: 'time_base'
+						# because edges are not resolved because of the namingconvention
+      edges = ORD.class_hierarchy base_class: 'E'
+      logger.info{ " preallocated-database-classes: #{ORD.database_classes.join(" , ")} " }
+
+      delete_class = -> (c,d) do 
+	the_class = ActiveOrient::Model.orientdb_class( name: c, superclass: d)
+	logger.info{  "The Class: "+the_class.to_s }
+	the_class.delete_class
+      end
+      
+      logger.info{ "  Deleting Class and Classdefinitions" }
+      vertexes.each{|v| delete_class[ v, :time_base ]}
+      delete_class[ :time_base, :V ] if defined?(TimeBase)
+      edges.each{|e| delete_class[ e, :E ] }
+
+      logger.info{ "  Creating Classes " }
+  ORD.create_classes 'E', 'V'
+  #E.ref_name = 'E'
+  #V.ref_name = 'V'
+      #ActiveOrient::Init.vertex_and_egde_class
+      ORD.create_vertex_class :time_base		      # --> TimeBase
+      # hour, day: month cannot be alloacated, because Day is a class of DateTime and thus reserved
+      time_base_classes = ORD.create_classes( :stunde, :tag, :monat ){ :time_base } # --> Hour, Day, Month
+      TimeBase.create_property :value_string, type: :string  
+      TimeBase.create_property :value, type:  :integer 						
+      ## this puts an uniqe index on child-classes
+      #time_base_classes.each{|y| y.create_index :value }
+      
+      # modified naming-convention in  model/e.rb
+      edges = ORD.create_edge_class :time_of, :day_of	     # --> TIME_OF, :DAY_OF
+      edges.each &:uniq_index
+
+      ORD.database_classes  # return_value
+    end
+  end
+end
+# to_do:  define validations
+#  hour_class   = r.create_vertex_class "Hour", properties: {value_string: {type: :string}, value: {type: :integer}}
+#  hour_class.alter_property property: "value", attribute: "MIN", alteration: 0
+#  hour_class.alter_property property: "value", attribute: "MAX", alteration: 23
+#
+#  day_class    = r.create_vertex_class "Day", properties: {value_string: {type: :string}, value: {type: :integer}}
+#  day_class.alter_property property: "value", attribute: "MIN", alteration: 1
+#  day_class.alter_property property: "value", attribute: "MAX", alteration: 31
+#
+#  month_class  = r.create_vertex_class "Month", properties: {value_string: {type: :string}, value: {type: :integer}}
+#  month_class.alter_property property: "value", attribute: "MIN", alteration: 1
+#  month_class.alter_property property: "value", attribute: "MAX", alteration: 12
+#
+
+#  timeof_class = r.create_edge_class "TIMEOF"

data/examples/time_graph/createTime.rb

@@ -0,0 +1,51 @@
+#require 'time'
+
+
+
+class CreateTime
+  class << self   # singleton class
+    def populate_month year = Date.today.year, month = Date.today.month
+      timestamp = DateTime.new year, month,1
+      if Monat.where( :value => month ).blank?
+	der_monat= Monat.create value_string: timestamp.strftime("%B"), value: timestamp.month.to_i
+	last_month_day =  (DateTime.new( year, month+1, 1)-1).day rescue 31  # rescue covers month > 12
+	(0 .. last_month_day ).each do | tag |
+	  der_tag = Tag.create value_string: "March #{timestamp.day}", value: tag 
+	  print der_tag.value.to_s + " > "
+	  ( 0 .. 23 ).each do | stunde |
+	    die_stunde = Stunde.create value_string: "March #{timestamp.day} #{timestamp.hour}:00", value: stunde
+	    print die_stunde.value.to_s + " .. "
+	    TIME_OF.create_edge from: der_tag, to: die_stunde
+	    timestamp += Rational(1,24)  # + 1 hour
+	  end
+	  print "\n"
+	  DAY_OF.create_edge from: der_monat, to: der_tag
+	end
+      else
+	"Month #{timestamp.strftime("%B %Y ") } exists "
+      end
+    end
+  end
+end # class
+
+  ## here we start if the file is called from the command-lind
+if $0 == __FILE__
+  require './config/boot'
+  ActiveOrient::OrientSetup.init_database   # --> config/init_db
+  CreateTime.populate_month
+
+  
+
+  puts "Features of the DateTime Graph"
+  puts '-' * 40
+  puts
+  puts "Allocated Month => Monat.first.value :" + Monat.first.value.to_s
+  puts
+  puts "Adressing Days => Monat.first.tag[2].value:" + Monat.first.tag[2].value.to_s
+  puts
+  puts "Adressing Hours => Monat.first.tag[2].stunde[4].value :" + Monat.first.tag[5].stunde[4].value.to_s
+
+
+
+
+end