orientdb-time-graph 0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa59beca751cdc1f71752f2863b1f62b56a6e9ad4b356e660ecf0c7a218e089b
+  data.tar.gz: 2ba65280af40d9a79b386f0d2a52c3e2f7bf640e20c6f808672e4573d16ead45
+SHA512:
+  metadata.gz: 363bf090b4203d4481d9bb4ce01474d764724e56f0dde7ef86af9c50ca5111325f923a2facca4c7eabfde3364fb6990fddb7650e85079bf8cebb6ac4ca1fde0e
+  data.tar.gz: 738430d774ee2730c863e3b9ee06afb3fcf7b6f8cb1b854d87b7118fdc233b7402288d04c728d7a9d79178ee2a11d4f0a49e3f343babb2eb8074bd13b1d56e81

data/.gitignore

@@ -0,0 +1,58 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# gemfile is overridden in git
+Gemfile
+
+## vim backupfiles
+*.swp
+*.swo
+*~

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+#guard :rspec, cmd: "bundle exec rspec -rdb" do
+guard :rspec, cmd: "bundle exec rspec --format documentation" do
+  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{^lib/(.+)\.rb$})     { |m| rspec.spec.("lib/#{m[1]}") }
+#  watch(rspec.spec_helper)      { rspec.spec_dir }
+#
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})  
+  #watch(%r{^models/(.+)\.rb$})  { |m| "spec/models/#{m[1]}_spec.rb" }
+  #watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 topofocus
+
+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,221 @@
+# Time Graph 
+
+Simple Time Graph using ActiveOrient/OrientDB. 
+
+This Graph is realized
+
+```ruby
+Jahr -- [MONTH_OF] -- Monat --[DAY_OF]-- Tag --[TIME_OF]-- Stunde
+```
+The nodes are crosslinked and any point of the grid is easily accessed.
+
+The library provides »to_tg« additions to »Date«, »DateTime« and »String«. 
+Thus
+
+```ruby
+z = "22.3.2003".to_tg
+=> #<TG::Tag:0x000000030d79d0 @metadata={"type"=>"d", "class"=>"tag", "version"=>4, "fieldTypes"=>"in_grid_of=g,out_grid_of=g,in_day_of=g", "cluster"=>25, "record"=>294}, @d=nil, @attributes={"value"=>22, "in_grid_of" =>["#49:304"], "out_grid_of"=>["#50:304"], "in_day_of"=>["#41:294"], "created_at"=>Mon, 12 Sep 2016 09:56:41 +0200}> 
+z.datum          => Sat, 22 Mar 2003  (returns a Date)
+z.next.datum     => Sun, 23 Mar 2003
+( z + 3 ).datum  => Tue, 25 Mar 2003 
+z.prev.datum     => Fri, 21 Mar 2003
+(z - 5 ).datum   => Mon, 17 Mar 2003 
+z.move( -20 ).datum => Sun, 02 Mar 2003 
+z.environment( 5).datum
+ => ["18.5.2003", "19.5.2003", "20.5.2003", "21.5.2003", "22.5.2003", "23.5.2003", "24.5.2003", "25.5.2003", "26.5.2003", "27.5.2003", "28.5.2003"] 
+
+
+```
+(datum is a method of TG::Day)
+
+*Prerequisites* : 
+* Ruby 2.5 (or 2.6) and OrientDB 3.0
+* Install and setup ruby via RVM (rvm.io) OrientDB 
+* Run "bundle install" and "bundle update"
+* customize config/connect.yml
+
+**or** start a new project and require the gem in the usual manner.
+
+Edges must be configurated with the following capitalising naming-convention
+```ruby
+class E
+      def self.naming_convention name=nil
+          name.present? ? name.upcase : ref_name.upcase
+      end
+end
+```
+* Initialize the data-structure by `TG::Setup.init_database »OrientDB Database instance«`  (eg. ORD)
+* After restarting the application, populate the timegraph by `TG::TimeGraph.populate 2015..2030`
+* In your Script activate the timegraph through `TG.connect`
+
+To play around, start the console by
+```
+  cd bin
+  ./console t  # test-modus
+```
+call   `TG::Init_database`  and restart the console
+
+The following database classes are build
+```ruby
+- E				# ruby-class
+- - month_of	      TG::MONTH_OF
+- - day_of		      TG::DAY_OF
+- - time_of		      TG::TIME_OF
+- - grid_of		      TG::GRID_OF
+- V
+- - time_base	    TG::TimeBase
+- - - jahr		      TG::Jahr
+- - - monat		      TG::Monat
+- - - stunde	      TG::Stunde
+- - - tag		      TG::Tag
+```
+
+The graph is populated by calling 
+
+```ruby
+TG::TimeGraph.populate( a single year or a range )  # default: 1900 .. 2050
+```
+(restart the console after this and check if all classes are assigned)
+
+If only one year is specified, a Monat--Tag--Stunde-Grid is build, otherwise a Jahr--Monat--Tag one.
+You can check the Status by calling 
+
+
+```ruby
+TG::TimeGraph.populate 2000..2003
+TG.info
+-------------- TIME GRAPH ------------------
+Allocated Years : 
+2000; 2001; 2002; 2003 
+
+```
+In the Model-directory, customized methods simplify the usage of the graph.
+
+Some Examples:
+Assuming, you build a standard day-based grid
+
+```ruby
+
+include TG					# we can omit the TG prefix
+
+Jahr[2000]    # --> returns a single object
+=> #<TG::Jahr:0x00000004ced160 @metadata={"type"=>"d", "class"=>"jahr", "version"=>13, "fieldTypes"=>"out_month_of=g", "cluster"=>34, "record"=>101}, @d=nil, @attributes={"value"=>2000, "out_month_of"=>["#53:1209", "#54:1209", "#55:1209", "#56:1209", "#53:1210", "#54:1210", "#55:1210", "#56:1210", "#53:1211", "#54:1211", "#55:1211", "#56:1211"], "created_at"=>Fri, 09 Sep 2016 10:14:30 +0200}>
+
+
+Jahr[2000 .. 2005].value  # returns an array
+ => [2003, 2000, 2004, 2001, 2005, 2002] 
+
+Jahr[2000 .. 2005].monat(5..7).value  # returns the result of the month-attribute (or method)
+ => [[5, 6, 7], [5, 6, 7], [5, 6, 7], [5, 6, 7], [5, 6, 7], [5, 6, 7]] 
+
+Jahr[2000].monat(4, 7).tag(4, 15,24 ).datum  # adresses methods or attributes of the specified day's
+ => [["4.4.2000", "15.4.2000", "24.4.2000"], ["4.7.2000", "15.7.2000", "24.7.2000"]] 
+ ``
+
+To filter datasets in that way, anything represented is queried from the database. In contrast to
+a pure ruby implementation, this works for small and large grid's.
+
+Obviously, you can do neat ruby-array playings, which are limited to the usual sizes.
+For example. As »TAG[31]« returns an array, the elements can be treated with ruby flavour:
+
+```ruby
+
+Tag[31][2..4].datum  # display three months with 31 days 
+ => ["31.10.1901", "31.1.1902", "31.5.1902"]
+
+```
+First all Tag-Objects with the Value 31 are queried. This gives »Jan, Mar, May ..«. Then one can inspect the array, in this case by slicing a range.
+
+Not surprisingly, the first occurence of the day is not the earliest date in the grid. Its just the first one,
+fetched from the database.
+
+``` ruby
+Tag[1][1].datum
+=> "1.5.1900"    # Tag[1][0] correctly fetches "1.1.1900"
+Tag[1].last.datum
+ => "1.11.2050"
+ ## however, 
+Jahr[2050].monat(12).tag(1)  # exists:
+=> ["1.12.2050"]
+
+TG::Jahr[2000..2002].monat(4,12).tag(1..4).datum.flatten
+=>  [Sat, 01 Apr 2000, Sun, 02 Apr 2000, Mon, 03 Apr 2000, Tue, 04 Apr 2000, Fri, 01 Dec 2000, Sat, 02 Dec 2000, Sun, 03 Dec 2000, Mon, 04 Dec 2000, 
+    Sun, 01 Apr 2001, Mon, 02 Apr 2001, Tue, 03 Apr 2001, Wed, 04 Apr 2001, Sat, 01 Dec 2001, Sun, 02 Dec 2001, Mon, 03 Dec 2001, Tue, 04 Dec 2001, 
+    Mon, 01 Apr 2002, Tue, 02 Apr 2002, Wed, 03 Apr 2002, Thu, 04 Apr 2002, Sun, 01 Dec 2002, Mon, 02 Dec 2002, Tue, 03 Dec 2002, Wed, 04 Dec 2002] 
+```
+
+## Horizontal Connections
+
+Besides the hierarchically TimeGraph »Jahr <-->Monat <--> Tag <--> Stunde«  the Vertices are connected
+horizontally via »grid_to«-Edges. This enables an easy access to the neighbours.
+
+On the TG::TimeBase-Level a method »environment« is implemented, that gathers the adjacent vertices 
+via traverse.
+
+``` ruby
+start =  "7.4.2000".to_tg
+start.environment(3).datum
+ => ["4.4.2000", "5.4.2000", "6.4.2000", "7.4.2000", "8.4.2000", "9.4.2000", "10.4.2000"] 
+
+2.3.1 :003 > start.environment(3,4).datum
+ => ["4.4.2000", "5.4.2000", "6.4.2000", "7.4.2000", "8.4.2000", "9.4.2000", "10.4.2000", "11.4.2000"] 
+ 
+start.environment(0,3).datum
+ => ["7.4.2000", "8.4.2000", "9.4.2000", "10.4.2000"] 
+ 
+ 
+```
+
+## Assigning Events
+
+To assign something to the TimeGrid its sufficiant to create an edge-class and connect this »something», 
+which is represented as Vertex, to the grid. The Diary example below describes how to do it.
+
+However, if a csv-file  with a »date« column is present, it's easier to assign it directly 
+to the grid:
+
+``` ruby
+  # csv record 
+  Ticker,Date/Time,Open,High,Low,Close,Volume,Open Interest,
+  ^GSPTSE,09.09.2016,14717.23,14717.23,14502.90,14540.00,202109040,0
+```
+assuming the record is read as string, then assigning is straightforward:
+``` ruby
+  ticker, date, open, high, low, close, volume, oi = record.split(',')
+  date.to_tg.assign vertex: Ticker.new(  high: high, ..), via: OHLC_TO, attributes:{ symbol: ticker }
+``` 
+The updated TimeBase-Object is returned. 
+
+»OHLC_TO« is the edge-class and »Ticker« represents a vertex-class
+## Diary
+
+lets create a simple diary
+
+```ruby
+include TG
+TimeGraph.populate 2016
+V.create_class :termin
+ => Termin
+E.create_class   :date_of
+ => DATE_OF
+DATE_OF.uniq_index	# put contrains to the edge-class, accept only one entry per item 
+
+Monat[8].tag(9).stunde(12).assign vertex: Termin.create( short: 'Mittagessen', 
+			                         	 long: 'Schweinshaxen essen mit Lieschen Müller', 
+				                         location: 'Hofbauhaus, München' ),
+				  via: DATE_OF
+ => #<DATE_OF:0x0000000334e038 (..) @attributes={"out"=>"#21:57", "in"=>"#41:0", (..)}> 
+# create some regular events  using Edge.create 
+# attach breakfirst at 9 o clock from the 10th to the 21st Day in the current month
+DATE_OF.create from: Monat[8].tag( 10 .. 21 ).stunde( 9 ), 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_date_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"]
+
+
+
+```
+

data/VERSION

@@ -0,0 +1 @@
+0.7

data/bin/console

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+## loads the active-orient environment 
+## and starts an interactive shell
+## Parameter:  production (p)
+##	       development (d)  [default]
+##	       test (t)
+require 'bundler/setup'
+require_relative '../lib/orientdb_time_graph'
+require_relative '../lib/setup'
+require 'logger'
+require 'pastel'
+LogLevel = Logger::INFO
+
+p =  Pastel.new
+c =  p.bright_white.bold.on_yellow.detach
+g =  p.green.on_black.detach
+
+#require File.expand_path(File.dirname(__FILE__) + "/../config/boot")
+
+specified_environment = ARGV[0] || 'D'
+env =  case specified_environment[-1].upcase
+				 when  'P'
+					 :production
+				 when 'D'
+					 :development
+				 else
+					 :test
+				 end
+module TG; end
+TG.setup env
+
+	ActiveOrient::Init.define_namespace  namespace: :object 
+	ActiveOrient::Model.keep_models_without_file = true
+	ActiveOrient::Model.keep_models_without_file = true
+	ActiveOrient::OrientDB.new  preallocate: true 
+
+
+#TG.check_and_initialize ORD
+  
+ #require 'orientdb' if RUBY_PLATFORM == 'java'
+ require 'yaml'
+
+class Array
+	# Method missing enables fancy stuff like
+	# Jahr[2000 .. 2005].monat(5..7).value 
+	#
+	# its included only in the console, for inspection purposes
+
+  def method_missing(method, *key)
+    unless method == :to_hash || method == :to_str #|| method == :to_int
+      return self.map{|x| x.public_send(method, *key)}
+    end
+
+  end
+end # Array
+
+
+puts '-'* 45
+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 "Present Classes (Hierarchy) "
+
+puts V.db.class_hierarchy.to_yaml
+puts ActiveOrient::show_classes
+
+include OrientDB
+
+require 'irb'
+ARGV.clear
+IRB.start(__FILE__)

data/config/boot.rb

@@ -0,0 +1,119 @@
+#  ########################  Outdated  ##################
+#
+#  do not use anymore
+#
+#  instead  
+#  require  lib/setup 
+#  and include 
+#  TG.setup environment in the startup-script
+#     with environment = :test, :development, :production
+#  followed by
+#  TG.connect
+#
+#
+#
+#
+#
+### Parameter: ARGV  (Array, argument from the command  line)
+### t)test
+### d)velopement
+### p)roduction
+###
+### 
+
+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/orientdb_time_graph.rb"
+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
+
+ActiveOrient::Model.model_dir =  "#{project_root}/#{ configyml.present? ? configyml[:model_dir] : "model" }"
+puts "BOOT--> Project-Root:  #{project_root}"
+puts "BOOT--> Model-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: '172.28.50.25', port: 2480  }
+  ActiveOrient.database = databaseyml[env.to_sym]
+	ActiveOrient::Init.define_namespace  namespace: :object  
+  ## Include customized NamingConvention for Edges
+  ORD = ActiveOrient::OrientDB.new  preallocate: true 
+  ORD.create_class 'E'
+	ORD.create_class 'V'
+  class E < ActiveOrient::Model
+      def self.naming_convention name=nil
+          name.present? ? name.upcase : ref_name.upcase
+      end
+  end
+
+  TG.connect
+
+  # load any unallocated database class, even it there is no model-file present
+  ActiveOrient::Model.keep_models_without_file = true
+
+
+  if RUBY_PLATFORM == 'java'
+    DB =  ActiveOrient::API.new   preallocate: false
+  else
+    DB = ORD
+  end
+
+else
+  ActiveOrient::OrientDB.logger = Logger.new('/dev/stdout')
+  ActiveOrient::OrientDB.logger.error{ "config/connectyml is  misconfigurated" }
+  ActiveOrient::OrientDB.logger.error{ "Database Server is NOT available"} 
+end
+
+
+