isomorfeus-data 1.0.0.zeta25 → 2.0.0.rc1

data/lib/isomorfeus/data/config.rb

@@ -1,110 +1,79 @@
-module Isomorfeus
-  # available settings
-  class << self
-    def instance_from_sid(sid)
-      data_class = cached_data_class(sid[0])
-      data_class.new(key: sid[1])
-    end
-
-    if RUBY_ENGINE == 'opal'
-      def cached_data_classes
-        @cached_data_classes ||= `{}`
-      end
-
-      def cached_data_class(class_name)
-        return "::#{class_name}".constantize if Isomorfeus.development?
-        return cached_data_classes.JS[class_name] if cached_data_classes.JS[class_name]
-        cached_data_classes.JS[class_name] = "::#{class_name}".constantize
-      end
-    else
-      def cached_data_classes
-        @cached_data_classes ||= {}
-      end
-
-      def cached_data_class(class_name)
-        return "::#{class_name}".constantize if Isomorfeus.development?
-        return cached_data_classes[class_name] if cached_data_classes.key?(class_name)
-        cached_data_classes[class_name] = "::#{class_name}".constantize
-      end
-
-      def valid_data_classes
-        @valid_data_classes ||= {}
-      end
-
-      def valid_data_class_name?(class_name)
-        valid_data_classes.key?(class_name)
-      end
-
-      def add_valid_data_class(klass)
-        valid_data_classes[raw_class_name(klass)] = true
-      end
-
-      def connect_to_arango
-        arango_options = if Isomorfeus.production? then Isomorfeus.arango_production
-                         elsif Isomorfeus.development? then Isomorfeus.arango_development
-                         elsif Isomorfeus.test? then Isomorfeus.arango_test
-                         end
-        arango_options = {}.merge(arango_options)
-        database = arango_options.delete(:database)
-        Arango.connect_to(**arango_options)
-        begin
-          Arango.current_server.get_database(database)
-        rescue Exception => e
-          Isomorfeus.raise_error(message: "Can't connect to database '#{database}' (#{e.message}).")
-        end
-      end
-
-      def prepare_arango_database
-        unless arango_configured?
-          STDOUT.puts "ArangoDB not configured, not preparing things, not using ArangoDB"
-          return
-        end
-        arango_options = if Isomorfeus.production? then Isomorfeus.arango_production
-                        elsif Isomorfeus.development? then Isomorfeus.arango_development
-                        elsif Isomorfeus.test? then Isomorfeus.arango_test
-                         end
-        arango_options = {}.merge(arango_options)
-        database = arango_options.delete(:database)
-        Arango.connect_to(**arango_options)
-        db = nil
-        begin
-         opened_db = Arango.current_server.get_database(database)
-         db = opened_db.name
-        rescue Exception => e
-         db = nil
-         unless e.message.include?('database not found')
-           Isomorfeus.raise_error(message: "Can't check if database '#{database}' exists.")
-         end
-        end
-        unless db
-         begin
-           Arango.current_server.create_database(database)
-         rescue Exception => e
-           Isomorfeus.raise_error(message: "Can't create database '#{database}' (#{e.message}).\nPlease make sure database '#{database}' exists.")
-         end
-         begin
-           Arango.current_server.get_database(database)
-         rescue Exception => e
-           Isomorfeus.raise_error(message: "Can't connect to database '#{database}' (#{e.message}).")
-         end
-        end
-
-        Arango.current_server.install_opal_module(database)
-        unless Arango.current_database.collection_exist?('IsomorfeusSessions')
-         Arango.current_database.create_collection('IsomorfeusSessions')
-        end
-        unless Arango.current_database.collection_exist?('IsomorfeusObjectStore')
-         Arango.current_database.create_collection('IsomorfeusObjectStore')
-        end
-      end
-
-      def arango_configured?
-        (defined? ::Arango) && !!(Isomorfeus.arango_production && Isomorfeus.arango_development && Isomorfeus.arango_test)
-      end
-
-      attr_accessor :arango_production
-      attr_accessor :arango_development
-      attr_accessor :arango_test
-    end
-  end
-end
+module Isomorfeus
+  # available settings
+  class << self
+    def instance_from_sid(sid)
+      data_class = cached_data_class(sid[0])
+      data_class.new(key: sid[1])
+    end
+
+    if RUBY_ENGINE == 'opal'
+      def cached_data_classes
+        @cached_data_classes ||= `{}`
+      end
+
+      def cached_data_class(class_name)
+        return "::#{class_name}".constantize if Isomorfeus.development?
+        return cached_data_classes.JS[class_name] if cached_data_classes.JS[class_name]
+        cached_data_classes.JS[class_name] = "::#{class_name}".constantize
+      end
+    else
+      def cached_data_classes
+        @cached_data_classes ||= {}
+      end
+
+      def cached_data_class(class_name)
+        return "::#{class_name}".constantize if Isomorfeus.development?
+        return cached_data_classes[class_name] if cached_data_classes.key?(class_name)
+        cached_data_classes[class_name] = "::#{class_name}".constantize
+      end
+
+      def valid_data_classes
+        @valid_data_classes ||= {}
+      end
+
+      def valid_data_class_name?(class_name)
+        valid_data_classes.key?(class_name)
+      end
+
+      def add_valid_data_class(klass)
+        valid_data_classes[raw_class_name(klass)] = true
+      end
+
+      def valid_file_classes
+        @valid_file_classes ||= {}
+      end
+
+      def valid_file_class_name?(class_name)
+        valid_file_classes.key?(class_name)
+      end
+
+      def add_valid_file_class(klass)
+        valid_file_classes[raw_class_name(klass)] = true
+      end
+
+      attr_accessor :data_path
+      attr_accessor :files_path
+
+      attr_accessor :ferret_path
+      attr_accessor :data_documents_path
+
+      attr_accessor :hamster_path
+      attr_accessor :data_object_env_path
+      attr_accessor :data_object_idx_path
+    end
+  end
+
+  if RUBY_ENGINE != 'opal'
+    self.data_path = File.expand_path(File.join(Isomorfeus.root, 'data', Isomorfeus.env))
+    self.files_path = File.expand_path(File.join(self.data_path, 'files'))
+
+    # documents and indices
+    self.ferret_path = File.expand_path(File.join(self.data_path, 'ferret'))
+    self.data_documents_path = File.expand_path(File.join(self.ferret_path, 'documents'))
+
+    # objects, nodes and edges
+    self.hamster_path = File.expand_path(File.join(self.data_path, 'hamster'))
+    self.data_object_env_path = File.expand_path(File.join(self.hamster_path, 'object_env'))
+    self.data_object_idx_path = File.expand_path(File.join(self.hamster_path, 'object_idx'))
+  end
+end

data/lib/isomorfeus/data/element_validator.rb

@@ -1,147 +1,147 @@
-module Isomorfeus
-  module Data
-    class ElementValidator
-      def initialize(source_class, element, options)
-        @c = source_class
-        @e = element
-        @o = options
-      end
-
-      def validate!
-        ensured = ensure!
-        unless ensured
-          cast!
-          type!
-        end
-        run_checks!
-        true
-      end
-
-      private
-
-      # basic tests
-
-      def cast!
-        if @o.key?(:cast)
-          begin
-            @e = case @o[:class]
-                 when Integer then @e.to_i
-                 when String then @e.to_s
-                 when Float then @e.to_f
-                 when Array then @e.to_a
-                 when Hash then @e.to_h
-                 end
-            @e = !!@e if @o[:type] == :boolean
-          rescue
-            Isomorfeus.raise_error(message: "#{@c}: #{@p} cast failed") unless @e.class == @o[:class]
-          end
-        end
-      end
-
-      def ensure!
-        if @o.key?(:ensure)
-          @e = @o[:ensure] unless @e
-          true
-        elsif @o.key?(:ensure_block)
-          @e = @o[:ensure_block].call(@e)
-          true
-        else
-          false
-        end
-      end
-
-      def type!
-        return if @o[:allow_nil] && @e.nil?
-        if @o.key?(:class)
-          Isomorfeus.raise_error(message: "#{@c}: #{@p} class not #{@o[:class]}") unless @e.class == @o[:class]
-        elsif @o.key?(:is_a)
-          Isomorfeus.raise_error(message: "#{@c}: #{@p} is not a #{@o[:is_a]}") unless @e.is_a?(@o[:is_a])
-        elsif @o.key?(:type)
-          case @o[:type]
-          when :boolean
-            Isomorfeus.raise_error(message: "#{@c}: #{@p} is not a boolean") unless @e.class == TrueClass || @e.class == FalseClass
-          else
-            c_string_sub_types
-          end
-        end
-      end
-
-      # all other checks
-
-      def run_checks!
-        if @o.key?(:validate)
-          @o[:validate].each do |m, l|
-            send('c_' + m, l)
-          end
-        end
-        @o[:validate_block].call(@e) if @o.key?(:validate_block)
-      end
-
-      # specific validations
-      def c_gt(v)
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} not greater than #{v}!") unless @e > v
-      end
-
-      def c_lt(v)
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} not less than #{v}!") unless @e < v
-      end
-
-      def c_keys(v)
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} keys dont fit!") unless @e.keys.sort == v.sort
-      end
-
-      def c_size(v)
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} length/size is not #{v}") unless @e.size == v
-      end
-
-      def c_matches(v)
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} does not match #{v}") unless v.match?(@e)
-      end
-
-      def c_max(v)
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} is larger than #{v}") unless @e <= v
-      end
-
-      def c_min(v)
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} is smaller than #{v}") unless @e >= v
-      end
-
-      def c_max_size(v)
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} is larger than #{v}") unless @e.size <= v
-      end
-
-      def c_min_size(v)
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} is smaller than #{v}") unless @e.size >= v
-      end
-
-      def c_direction(v)
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} is positive") if v == :negative && @e >= 0
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} is negative") if v == :positive && @e < 0
-      end
-
-      def c_test
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} test condition check failed") unless @o[:test].call(@e)
-      end
-
-      def c_string_sub_types
-        Isomorfeus.raise_error(message: "#{@c}: #{@p} must be a String") unless @e.class == String
-        case @o[:type]
-        when :email
-          Isomorfeus.raise_error(message: "#{@c}: #{@p} is not a valid email address") unless @e.match? /\A[^@\s]+@([^@\s]+\.)+[^@\s]+\z/
-        when :uri
-          if RUBY_ENGINE == 'opal'
-            %x{
-              try {
-                new URL(#@e);
-              } catch {
-                #{Isomorfeus.raise_error(message: "#{@c}: #{@p} is not a valid uri")}
-              }
-            }
-          else
-            Isomorfeus.raise_error(message: "#{@c}: #{@p} is not a valid uri") unless @e.match? /\A#{URI.regexp}\z/
-          end
-        end
-      end
-    end
-  end
-end
+module Isomorfeus
+  module Data
+    class ElementValidator
+      def initialize(source_class, element, options)
+        @c = source_class
+        @e = element
+        @o = options
+      end
+
+      def validate!
+        ensured = ensure!
+        unless ensured
+          cast!
+          type!
+        end
+        run_checks!
+        true
+      end
+
+      private
+
+      # basic tests
+
+      def cast!
+        if @o.key?(:cast)
+          begin
+            @e = case @o[:class]
+                 when Integer then @e.to_i
+                 when String then @e.to_s
+                 when Float then @e.to_f
+                 when Array then @e.to_a
+                 when Hash then @e.to_h
+                 end
+            @e = !!@e if @o[:type] == :boolean
+          rescue
+            Isomorfeus.raise_error(message: "#{@c}: #{@p} cast failed") unless @e.class == @o[:class]
+          end
+        end
+      end
+
+      def ensure!
+        if @o.key?(:ensure)
+          @e = @o[:ensure] unless @e
+          true
+        elsif @o.key?(:ensure_block)
+          @e = @o[:ensure_block].call(@e)
+          true
+        else
+          false
+        end
+      end
+
+      def type!
+        return if @o[:allow_nil] && @e.nil?
+        if @o.key?(:class)
+          Isomorfeus.raise_error(message: "#{@c}: #{@p} class not #{@o[:class]}") unless @e.class == @o[:class]
+        elsif @o.key?(:is_a)
+          Isomorfeus.raise_error(message: "#{@c}: #{@p} is not a #{@o[:is_a]}") unless @e.is_a?(@o[:is_a])
+        elsif @o.key?(:type)
+          case @o[:type]
+          when :boolean
+            Isomorfeus.raise_error(message: "#{@c}: #{@p} is not a boolean") unless @e.class == TrueClass || @e.class == FalseClass
+          else
+            c_string_sub_types
+          end
+        end
+      end
+
+      # all other checks
+
+      def run_checks!
+        if @o.key?(:validate)
+          @o[:validate].each do |m, l|
+            send('c_' + m, l)
+          end
+        end
+        @o[:validate_block].call(@e) if @o.key?(:validate_block)
+      end
+
+      # specific validations
+      def c_gt(v)
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} not greater than #{v}!") unless @e > v
+      end
+
+      def c_lt(v)
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} not less than #{v}!") unless @e < v
+      end
+
+      def c_keys(v)
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} keys dont fit!") unless @e.keys.sort == v.sort
+      end
+
+      def c_size(v)
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} length/size is not #{v}") unless @e.size == v
+      end
+
+      def c_matches(v)
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} does not match #{v}") unless v.match?(@e)
+      end
+
+      def c_max(v)
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} is larger than #{v}") unless @e <= v
+      end
+
+      def c_min(v)
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} is smaller than #{v}") unless @e >= v
+      end
+
+      def c_max_size(v)
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} is larger than #{v}") unless @e.size <= v
+      end
+
+      def c_min_size(v)
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} is smaller than #{v}") unless @e.size >= v
+      end
+
+      def c_direction(v)
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} is positive") if v == :negative && @e >= 0
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} is negative") if v == :positive && @e < 0
+      end
+
+      def c_test
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} test condition check failed") unless @o[:test].call(@e)
+      end
+
+      def c_string_sub_types
+        Isomorfeus.raise_error(message: "#{@c}: #{@p} must be a String") unless @e.class == String
+        case @o[:type]
+        when :email
+          Isomorfeus.raise_error(message: "#{@c}: #{@p} is not a valid email address") unless @e.match?(/\A[^@\s]+@([^@\s]+\.)+[^@\s]+\z/)
+        when :uri
+          if RUBY_ENGINE == 'opal'
+            %x{
+              try {
+                new URL(#@e);
+              } catch {
+                #{Isomorfeus.raise_error(message: "#{@c}: #{@p} is not a valid uri")}
+              }
+            }
+          else
+            Isomorfeus.raise_error(message: "#{@c}: #{@p} is not a valid uri") unless @e.match?(/\A#{URI.regexp}\z/)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/isomorfeus/data/ferret_accelerator.rb

@@ -0,0 +1,66 @@
+module Isomorfeus
+  module Data
+    class FerretAccelerator
+      def self.finalize(fer_acc)
+        proc { fer_acc.close_index }
+      end
+
+      attr_reader :doc_class, :doc_class_name, :doc_class_name_u
+      attr_accessor :index
+
+      def initialize(doc_class, &block)
+        @doc_class = doc_class
+        @doc_class_name = doc_class.name
+        @doc_class_name_u = @doc_class_name.underscore
+        if block_given?
+          res = block.call(self)
+          @index = res unless @index
+        else
+          open_index
+        end
+        ObjectSpace.define_finalizer(self, self.class.finalize(self))
+      end
+
+      def destroy_index
+        close_index
+        FileUtils.rm_rf(index_path(doc_class_name))
+      end
+
+      def close_index
+        @index.close
+      end
+
+      def create_doc(document)
+        @index.add_document(document)
+      end
+
+      def destroy_doc(id)
+        @index.delete(id)
+        true
+      end
+
+      def load_doc(id)
+        @index.doc(id)&.load
+      end
+
+      def save_doc(id, document)
+        @index.update(id, document)
+      end
+
+      def search_each(query, options, &block)
+        @index.search_each(query, options, &block)
+      end
+
+      private
+
+      def index_path
+        File.expand_path(File.join(Isomorfeus.data_documents_path, @doc_class_name_u))
+      end
+
+      def open_index
+        FileUtils.mkdir_p(Isomorfeus.data_documents_path) unless Dir.exist?(Isomorfeus.data_documents_path)
+        @index = Isomorfeus::Ferret::Index::Index.new(path: index_path, id_field: :key)
+      end
+    end
+  end
+end

data/lib/isomorfeus/data/field_support.rb

@@ -0,0 +1,110 @@
+module Isomorfeus
+  module Data
+    module FieldSupport
+      def self.included(base)
+        base.instance_exec do
+          def field_options
+            @field_options ||= {}
+          end
+
+          def valid_field?(field_name, field_value)
+            field_options.key?(field_name)
+          end
+        end
+
+        def exclude_fields(*flds)
+          @_excluded_fields = flds
+        end
+
+        def select_fields(*flds)
+          @_selected_fields = flds
+        end
+
+        if RUBY_ENGINE == 'opal'
+          base.instance_exec do
+            def field(name, options = nil)
+              field_options[name] = options
+
+              define_method(name) do
+                _get_field(name)
+              end
+
+              define_method("#{name}=") do |val|
+                val = val.to_s unless val.class == String
+                changed!
+                @_changed_fields[name] = val
+              end
+            end
+          end
+
+          def _get_field(name)
+            return @_changed_fields[name] if @_changed_fields.key?(name)
+            path = @_store_path + [name]
+            result = Redux.fetch_by_path(*path)
+            %x{
+              if (result === null) { return nil; }
+              else { return result; }
+            }
+          end
+
+          def fields
+            raw_fields = Redux.fetch_by_path(*@_store_path)
+            hash = Hash.new(raw_fields)
+            hash.merge!(@_changed_fields) if @_changed_fields
+            hash
+          end
+
+          def _get_selected_fields
+            sel_fields = fields.dup
+            if @_selected_fields && !@_selected_fields.empty?
+              sel_fields.each_key do |fld|
+                unless @_selected_fields.include?(fld) || @_selected_fields.include?(fld)
+                  sel_fields.delete(fld)
+                end
+              end
+            end
+            if @_excluded_fields && !@_excluded_fields.empty?
+              @_excluded_fields.each { |fld| sel_fields.delete(fld) }
+            end
+            sel_fields
+          end
+        else
+          base.instance_exec do
+            def field(name, options = {})
+              field_options[name] = options
+
+              define_method(name) do
+                @_raw_fields[name]
+              end
+
+              define_method("#{name}=") do |val|
+                val = val.to_s unless val.class == String
+                changed!
+                @_raw_fields[name] = val
+              end
+            end
+          end
+
+          def fields
+            @_raw_fields
+          end
+
+          def _get_selected_fields
+            sel_fields = fields.transform_keys(&:to_s)
+            if @_selected_fields && !@_selected_fields.empty?
+              sel_fields.each_key do |fld|
+                unless @_selected_fields.include?(fld.to_sym) || @_selected_fields.include?(fld)
+                  sel_fields.delete(fld)
+                end
+              end
+            end
+            if @_excluded_fields && !@_excluded_fields.empty?
+              @_excluded_fields.each { |fld| sel_fields.delete(fld.to_s) }
+            end
+            sel_fields
+          end
+        end
+      end
+    end
+  end
+end