active-orient 0.5 → 0.6

data/linkmap.md

@@ -0,0 +1,75 @@
+# Joining Tables 
+
+The most important difference between OrientDB and a Relational Database is that relationships are represented by LINKS instead of JOINs.
+
+For this reason, the classic JOIN syntax is not supported. OrientDB uses the "dot (.) notation" to navigate LINKS
+(OrientDB-documation)
+
+This is supported by ActiveOrient in a very convient way.
+
+## Playing with Arrays and Linkmaps
+
+Linkmaps are the OrientDB equivalent to joined tables 
+Formally, they are ordinary arrays.
+
+They can be created schemaless
+
+```ruby
+DB.create_class :industry
+DB.create_class :property
+property_record=  Property.create  con_id: 12346, property: []
+industries =  ['Construction','HealthCare','Bevarage']
+industries.each{| industry | property_record.property <<  Industry.create( label: industry ) }
+
+Property.last
+ => #<Property:0x00000001d1a938 @metadata={"type"=>"d", (...)},  
+    @attributes={"con_id"=>12346, "property"=>["#34:0", "#35:0", "#36:0"],
+    "created_at"=>"2017-02-01T06:28:17.332 01:00", "updated_at"=>"2017-02-01T06:28:17.344 01:00"}> 
+ ```
+
+Stored data in this array is accessible via
+
+```ruby
+p =  Property.last
+p.property.label
+ => ["Construction", "HealthCare", "Bevarage"]
+p.property[2].label
+ => "Bevarage" 
+p.property.label[2]
+  => "Bevarage" 
+p.property[2].label[2]
+ => "v" 
+
+p.property.remove_at 2
+p.property.label
+  => ["Construction", "HealthCare"] 
+
+p.property[2] = Industry.where(label:'Bevarage').first
+p.property.label
+ => ["Construction", "HealthCare", "Bevarage"] 
+```
+
+The Elements of the Array can be treated like common ruby Arrays. Manipulations are
+performed in ruby-spac. Simply call
+```ruby
+p.update
+```
+to transfer the changes into the database. This approach can be extended to linked records as well
+
+```ruby
+p.property[2].label = 'zu'
+p.property[2].update
+p.property.label
+ => ["Construction", "HealthCare", "zu"]
+Industry.last.label
+ => "zu"
+
+
+```
+
+
+
+
+(to be continued)
+
+

data/namespace.md

@@ -0,0 +1,111 @@
+## Namespace Support
+
+Consider a project, where different tasks are clearly separated. 
+
+A common case is, to concentrate any gathering of raw data in a separate module, maybe even in a gem.
+
+ActiveOrient enables this by switching the "ActiveOrient::Model.namespace" directive.
+
+In out case, the "ib-ruby" gem gets data through an api 
+The gem provides the logic to convert the raw-data from the server to ActiveOrient::Model-Objects.
+Its located in the model-directory of the gem.
+
+Just by including the gem in the Gemfile and requiring the gem, anything is available in our project.
+
+The gem defines the ActiveOrient-Environment as follows:
+```ruby
+module IB                                
+module ORD                             
+include ActiveOrient::Init          # namespace support
+mattr_accessor :login 
+
+# establishes a connection to the Database and returns the Connection-Object (an ActiveOrient::OrientDB.         …instance)
+def self.connect                  
+
+  c = { :server => 'localhost', :port  => 2480,	:protocol => 'http',       
+	:user   => 'root',   :password => 'root', :database => 'temp'  }.merge login.presence || {}
+  ActiveOrient.default_server= { user: c[:user], password: c[:password] , server: c[:server], port: c[:port]  }
+  ActiveOrient.database = c[:database]
+  logger =  Logger.new '/dev/stdout'
+  ActiveOrient::Init.define_namespace { IB } 
+  project_root = File.expand_path('../..', __FILE__)
+
+  ActiveOrient::Model.model_dir =  "#{project_root}/models"
+  ActiveOrient::OrientDB.new  preallocate: true  # connect via http-rest
+
+(...)
+  ```
+The gem scans through all database classes present, and allocates only those, where a model-file
+is found in the model-directory. 
+
+This takes place by requiring 'ib-ruby' in 'config/boot.rb'
+
+```ruby
+  76 #read the configuration and model-files from the ib-ruby gem directotry
+  77 require 'ib/ord'
+  78 IB::ORD.login= ActiveOrient.default_server.merge database: ActiveOrient.database
+  79 require 'ib-ruby'  # automatically connects to the database
+  80 
+  81 # set the model-file for the time-graph
+  82 module TG
+  83 end
+  84 ActiveOrient::Model.model_dir =  "#{project_root}/model"
+  85 ActiveOrient::Init.define_namespace { TG }
+  86 puts "Namespace changed: #{ActiveOrient::Model.namespace}"
+  87 ActiveOrient::OrientDB.new  preallocate:  true
+
+```
+
+After row 80, the namspace is changed to "TG" (TimeGraph).  The example provides a gem as well. Just 
+»require 'orientdb_time_graph'« and call »TG.connect« to include it properly.
+
+The code above shows how to integrate the classes within the structure of the project. The difference is the placement
+of the model-files. With the gem, they are located in the root-directory of the gem. The other approach looks in the model-directory of the project (model/tg).
+
+Before we start, we  switch to the object-layer, where we want to define the working-classes. Their 
+logic is defined in model-files in 'model'. And we want to make shure, that all database-classes are allocated
+to ruby classes. 
+
+```ruby
+97   ActiveOrient::Init.define_namespace :object
+98   ActiveOrient::Model.keep_models_without_file = true
+99   ORD = ActiveOrient::OrientDB.new  preallocate: true
+```
+
+**note** The preallocation-algorithm trys to load any class. If »ActiveOrient::Model.keep_models_without_file«
+is set to false, classes are allocated only, if a model-file is present. As a consequence, any appropopiate
+model-file is loaded. 
+
+Any  previously allocated class can thus be extended, providing a proper model-file. For example: If we 
+allocated a class «Contract« in the namspace »IB«, methods for this class are included from the model-dir specified in the gem *and* in the actual-model-directory ( in this case: model/ib/contract.rb ). 
+
+
+As a result something like this appears:
+
+```
+DB-Class  -> Ruby-Object
+		V ->  V
+		E ->  E
+contract ->  		IB::Contract
+bag				->  IB::Bag
+forex			->  IB::Forex
+future			->  IB::Future
+option			->  IB::Option
+stock			->  IB::Stock
+account			->  IB::Account
+bar				->  IB::Bar
+contract_detail ->  IB::ContractDetail
+day_of	  ->  TG::DAY_OF
+time_of	  ->  TG::TIME_OF
+time_base ->  TG::TimeBase
+monat	  ->  TG::Monat
+stunde	  ->  TG::Stunde
+tag	  ->  TG::Tag
+
+new_test  ->  NewTest
+
+```
+
+By changing the namespace-scope with  'ActiveOrient::Init.define_namespace'  its always possible to 
+change properties, include links and edges or to add  and remove classes in the Sub-Modules.
+

data/rails.md

@@ -0,0 +1,125 @@
+# Active Orient and Rails
+
+The usage of Orientdb via ActiveOrient in Rails requires just a few steps.
+Based on a Rails 5 installation
+
+```ruby
+  rvm install 2.4
+  rvm use 2.4
+  gem install bundler
+  gem install nokogiri
+  gem install rails
+  rails -v   # Rails 5.0.1
+
+```
+
+create your working directory and initialize the system
+
+```ruby
+mkdir rails_project; cd rails_project
+rails -OCT .
+```
+This initializes a Rails-Stack, without active-record, action-cable and the test-suite.
+(We will use rspec later)
+
+This can be checked by inspecting «/config/application.rb «
+ 
+```ruby
+rails s puma
+```
+should work at this stage.
+
+## Modify the Gemfile
+Inform rails to use orientdb and active-orient
+
+```
+echo " gem 'active-orient' , :path => '/home/your_cloned_active_orient_path/activeorient' " >> Gemfile
+# or
+
+echo " gem 'active-orient' , :git => 'https://github.com/topofocus/active-orient.git' " >> Gemfile
+```
+
+After that, copy 
+
+* __active_orient/rails/activeorient.rb__   to   /config/initializers  in the rails-project dir
+* __active_orient/rails/connect.yml__ to /config
+* __active_orient/rails/config.yml__ to /config
+
+and modify the yml-files accordingly.
+
+Run the  bundler
+
+```
+bundle install & bundle update
+```
+
+The database should be present in the rails console, and 
+```ruby
+rails c
+
+V.count
+V.first
+E.count
+puts ActiveOrient::Model.allocated_classes.map{|x,y| "#{"%15s"% x} ->  #{y.to_s}" }.join("\n")
+
+```
+should work.
+
+**Notice** The spring-facility is running in the background. Stop the server prior reloading
+the console ( ./bin/spring stop ). 
+
+The final step is to generate Model-Files. In «/config/config.yml» the «:model_dir»-var points to
+the location of the model-files. The default is 'lib/orient'. 
+
+Upon startup this directory is scanned for autoloading database-files. 
+
+After envoking the rails console, the logfile displays sucessfully loaded and missing files, ie.
+
+```
+14.01.(08:28:45) INFO->ModelClass#RequireModelFile:..:model-file not present: /home/topo/workspace/orient-rails/lib/orient/followed_by.rb
+14.01.(08:28:45) INFO->ModelClass#RequireModelFile:..:/home/topo/workspace/orient-rails/lib/orient/v.rb sucessfully loaded
+```
+
+## Model-file Example
+
+To query the GratefulDeadConcerts Database, «v.rb» hosts the essential model methods.
+As always, use «def self.{method}« for class methods and simply «def {method}» for methods working on the record level.
+
+```
+1 class V 
+2        def  self.artists **attributes 
+3          names 'artist', **attributes
+4        end
+5        
+6        def  self.songs **attributes 
+7          names 'song', **attributes
+8        end
+9        
+10        def self.types
+11          oo =  OrientSupport::OrientQuery
+12          this_query = oo.new  distinct: [:type, :a ]
+13          query_database( this_query ).a
+14        end
+15 private
+16        def  self.names  type, sort: :asc, limit: 20, skip: 0
+17          puts "in names"
+18          oo =  OrientSupport::OrientQuery
+19          query_database  oo.new( where: {type: type }, 
+20                                 order: { name: sort } ,
+21                                 limit: limit ,
+22                                 skip: skip )
+23        end
+24 end
+
+```
+
+Now 
+
+```ruby
+  V.types
+  V.artists limit: 15, skip: 34, sort: :desc 
+```
+queries the database, fetches 15 artists and can be used everywhere.
+
+
+

data/rails/activeorient.rb

@@ -0,0 +1,53 @@
+project_root = File.expand_path('../../..', __FILE__)
+config_root = File.expand_path('../..', __FILE__)
+begin
+  connect_file = File.expand_path('../../connect.yml', __FILE__)
+  config_file = File.expand_path('../../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?
+  databaseyml   = YAML.load_file( connect_file )[:orientdb][:database] if connect_file.present?
+rescue Errno::ENOENT => e
+  Rails.logger.error{ "config/connect.yml not present"  }
+  puts "config/connectyml not present"  
+  Rails.logger.error{ "Using defaults to connect database-server"  }
+  puts "Using defaults to connect database-server"  
+
+end
+
+ActiveOrient::Model.model_dir =  "#{project_root}/#{ configyml.present? ? configyml[:model_dir] : "model" }"
+ActiveOrient::Model.keep_models_without_file = true
+# lib/init.rb
+ActiveOrient::Init.define_namespace yml: configyml, namespace: @namespace
+
+
+
+Rails.logger.formatter = proc do |severity, datetime, progname, msg|
+  "#{datetime.strftime("%d.%m.(%X)")}#{"%5s" % severity}->#{progname}:..:#{msg}\n"
+end
+ActiveOrient::Base.logger =  Rails.logger
+ActiveOrient::OrientDB.logger =  Rails.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[Rails.env.to_sym]
+
+  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
+#  ActiveOrient::Init.vertex_and_edge_class
+
+      ORD.create_classes 'E', 'V'
+      E.ref_name = 'E'
+      V.ref_name = 'V'
+else
+  logger = Logger.new('/dev/stdout')
+  logger.error{ "config/connectyml is  misconfigurated" }
+  logger.error{ "Database Server is NOT available"} 
+end
+
+
+

data/{examples/time_graph/config → rails}/config.yml

@@ -4,5 +4,7 @@
 ##				       :object => No Prefix
 ##				       :active_orient => ActiveOrient::{name}
  :namespace: :object
- :model_dir: 'model'
+## model_dir: Path to model-files relative to the root of the application
+## ie. app/model  or model
+ :model_dir: 'lib/orient'
 

data/{examples/time_graph/config → rails}/connect.yml

@@ -4,8 +4,8 @@
  :port: 2480
  :logger: stdout           # 'file' or 'stdout'
  :database: 
-   :development: time_production
-   :production: time_dev
+   :development: GratefulDeadConcerts
+   :production: hcn_data
    :test:  tempera
  :admin:
    :user: hctw

data/usecase_oo.md

@@ -1,7 +1,7 @@
 ## Usecase
 Below some typical features are summarized by example
 
-Initialize ActiveOrient by calling »bin/actibe-orient-console t«.
+Initialize ActiveOrient by calling »bin/active-orient-console t«.
 This connects to the Test-Database.
 
  ```ruby
@@ -57,3 +57,5 @@ Attibutes/properties of the Database-Record  can be handled as normal ruby objec
 ```
 
 ## Inherence
+
+( to be continued )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active-orient
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Hartmut Bischoff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-01 00:00:00.000000000 Z
+date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,30 +42,30 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Persistent ORM for OrientDB, based on ActiveModel
+description: Persistent ORM for OrientDB(V.2.2), based on ActiveModel. Rails 5 compatible
 email:
 - topofocus@gmail.com
 executables: []
@@ -101,36 +101,14 @@ files:
 - config/connect.yml
 - create_project
 - examples/books.rb
-- examples/createTime.rb
 - examples/streets.rb
 - examples/test_commands.rb
 - examples/test_commands_2.rb
 - examples/test_commands_2.rb~
 - examples/test_commands_3.rb
 - examples/test_commands_4.rb
-- examples/time_graph/Gemfile
-- examples/time_graph/Guardfile
-- examples/time_graph/README.md
-- examples/time_graph/bin/active-orient-console
-- examples/time_graph/config/boot.rb
-- examples/time_graph/config/config.yml
-- examples/time_graph/config/connect.yml
-- examples/time_graph/config/init_db.rb
-- examples/time_graph/createTime.rb
-- examples/time_graph/lib/createTime.rb
-- examples/time_graph/model/day_of.rb
-- examples/time_graph/model/e.rb
-- examples/time_graph/model/edge.rb
-- examples/time_graph/model/monat.rb
-- examples/time_graph/model/stunde.rb
-- examples/time_graph/model/tag.rb
-- examples/time_graph/model/time_base.rb
-- examples/time_graph/model/time_of.rb
-- examples/time_graph/model/v.rb
-- examples/time_graph/model/vertex.rb
-- examples/time_graph/spec/lib/create_time_spec.rb
-- examples/time_graph/spec/rest_helper.rb
-- examples/time_graph/spec/spec_helper.rb
+- examples/time_graph.md
+- gratefuldeadconcerts.md
 - lib/active-orient.rb
 - lib/base.rb
 - lib/base_properties.rb
@@ -156,8 +134,13 @@ files:
 - lib/rest/rest.rb
 - lib/rest_disabled.rb
 - lib/support.rb
+- linkmap.md
+- namespace.md
 - old_lib_functions/two_general_class.rb
-- usecase.md
+- rails.md
+- rails/activeorient.rb
+- rails/config.yml
+- rails/connect.yml
 - usecase_oo.md
 homepage: https://github.com/topofocus/active-orient
 licenses:
@@ -179,8 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Pure ruby client for OrientDB based on ActiveModel
+summary: Pure ruby client for OrientDB(V.2.2) based on ActiveModel
 test_files: []