isomorfeus-data 1.0.0.zeta25 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5288c5f08a6cb9216328257e14606f41c6c9f9a7f970036dbd2e8d57502b2fb6
-  data.tar.gz: 473c71fd6c84860abca1ad373391cb44828ee8beaed4ce1af71d65a3e79e3f88
+  metadata.gz: 1394418f9a7765f02a9214dbeb633e6a873e6bba5f63d2e51612de04cc581adf
+  data.tar.gz: ab90990899ce3b0cc1140c8e5cf45d2777a57a74ab8b2161f06a3836749fa7f8
 SHA512:
-  metadata.gz: 57a9193f4b2ac22cd924c600ee4cfa3fc2f4ee25e4a6b59492b1e6f47c10d620b426b4e04e260d9341f6058df88387348bc16a3b23ba580e5bad138dfe337953
-  data.tar.gz: dc600448b3907f8675f049fde21d1098241c394eeed0e3134972e7b22ea0353a7a5b57aaf00e0038d8eb7ce4def20bf37a47b10c7898d110fc46696eb2dc4687
+  metadata.gz: 642842b79e5630a72a583ff48f96264b68b11bf4c670e02fe9a1243ec801cf751a3ea1ce410912810438021decf3f88c17426deea0e460df6b6c4f100dd1492e
+  data.tar.gz: 78fc44830ceb7366fa7c77e8fffa6da6cd9a4a12e4936a0738f1c9041ef8738ac095e4b089837a2a8685ffcc67672407b5ef86363f5e6ab5f88670deffa60925

data/LICENSE

@@ -1,21 +1,47 @@
-MIT License
-
-Copyright (c) 2019 Jan Biedermann
-
-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.
+MIT License
+
+Copyright (c) 2019 Jan Biedermann
+
+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.
+
+uri module in opal directory originally taken from
+https://github.com/ajjahn/opal-uri:
+
+Copyright (c) 2015 Jamie Gaskins
+
+MIT License
+
+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

@@ -1,46 +1,38 @@
-# isomorfeus-data
-
-Data access for Isomorfeus.
-
-*Use Ruby for Graphs! ... and more!*
-
-### Community and Support
-At the [Isomorfeus Framework Project](http://isomorfeus.com) 
-
-### Overview
-
-Isomorfeus Data provides convenient access to all sorts of data for the distributes, isomorphic system.
-Data is available in the same way on clients and server.
-
-Isomorfeus Data supports arrays, hashes, collections, graphs, nodes, edges and compositions of any of those which can be loaded with one requests.
-
-All LucidData classes are database agnostic. Any ORM or data source supported by ruby can be used.
-Data must then be shaped (usually in to a Hash or Array) to fit the Isomorfeus Data classes.
- 
-
-### Core Concepts and Common API
-
-- [Core Concepts](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/concepts.md)
-- [Common API](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/common_api.md)
-- [Data Policy](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_policy.md)
-
-### Available Classes
-
-All classes follow the common principles and the common API above.
-
-- [LucidData::Array](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_array.md) - A array, easily accessible on client and server
-- [LucidData::Collections](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_collection.md) - A collection of LucidData::Node or LucidData::Vertex or LucidData::Document objects
-- [LucidData::Composition](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_composition.md) - A composition of any of those other classes, even graphs, for easy, one request access to arbitrary data
-- [LucidData::Document, LucidData::Node, LucidData::Vertex](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_node.md) - A node/document/vertex, can be used stand alone, in a collection or in a graph
-- [LucidData::Edge, LucidData::Link](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_edge.md) - A edge/link, can be used standalone, in a collection or in a graph
-- [LucidData::EdgeCollection, LucidData::LinkCollection](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_edge_collection.md)  - A collection of LucidData::Edge or LucidData::Link objects
-- [LucidData::Graph](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_graph.md) - A graph, which can be build from several LucidData::Collection objects and LucidData::EdgeCollection objects
-- [LucidData::Hash](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_hash.md) - A hash, easily accessible on client and server
-
-For convenience the following generic classes are provided. They can be used when creating a separate class wouldn't be useful:
-- LucidData::GenericCollection
-- LucidData::GenericEdgeCollection 
-- LucidData::GenericNode
-- LucidData::GenericEdge
-
-(more to come soon)
+# isomorfeus-data
+
+Data access for Isomorfeus.
+
+*Use Ruby for Graphs! ... and more!*
+
+### Community and Support
+At the [Isomorfeus Framework Project](http://isomorfeus.com)
+
+### Overview
+
+Isomorfeus Data provides convenient access to data for the distributed, isomorphic system.
+Data is available in the same way on clients and server.
+
+Isomorfeus Data supports documents, objects and files.
+
+### Core Concepts and Common API
+
+- [Core Concepts](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/concepts.md)
+- [Common API](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/common_api.md)
+- [Data Policy](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_policy.md)
+
+### Available Classes
+
+All classes follow the common principles and the common API above.
+
+- [LucidDocument](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_document.md) - for textual data with fields
+- [LucidObject](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_object.md) - for objects with attributes
+- [LucidFile](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_file.md) - for files like images, pdfs, etc.
+- [LucidQuery](https://github.com/isomorfeus/isomorfeus-project/blob/master/ruby/isomorfeus-data/docs/data_query.md) - for isomorphic queries.
+
+### Storage
+
+isomorfeus-data relies on:
+- [isomorfeus-ferret](https://github.com/isomorfeus/isomorfeus-ferret) as storage and index for documents
+- [isomorfeus-hamster](https://github.com/isomorfeus/isomorfeus-hamster) as storage and index for objects
+- the Filesystem for files
+- [Oj](https://github.com/ohler55/oj) for serialization

data/lib/isomorfeus/data/attribute_support.rb

@@ -1,176 +1,176 @@
-module Isomorfeus
-  module Data
-    module AttributeSupport
-      def self.included(base)
-        base.instance_exec do
-          def attribute_conditions
-            @attribute_conditions ||= {}
-          end
-
-          def valid_attribute?(attr_name, attr_value)
-            Isomorfeus::Props::Validator.new(self.name, attr_name, attr_value, attribute_conditions[attr_name]).validate!
-          rescue
-            false
-          end
-
-          def validate
-            Isomorfeus::Props::ValidateHashProxy.new
-          end
-
-          def _validate_attribute(attr_name, attr_val)
-            Isomorfeus.raise_error(message: "#{self.name}: No such attribute declared: '#{attr_name}'!") unless attribute_conditions.key?(attr_name)
-            Isomorfeus::Props::Validator.new(self.name, attr_name, attr_val, attribute_conditions[attr_name]).validate!
-          end
-
-          def _validate_attributes(attrs)
-            attribute_conditions.each_key do |attr|
-              if attribute_conditions[attr].key?(:required) && attribute_conditions[attr][:required] && !attrs.key?(attr)
-                Isomorfeus.raise_error(message: "Required attribute #{attr} not given!")
-              end
-            end
-            attrs.each { |attr, val| _validate_attribute(attr, val) }
-          end
-        end
-
-        def _validate_attribute(attr_name, value)
-          self.class._validate_attribute(attr_name, value)
-        end
-
-        def _validate_attributes(attrs)
-          self.class._validate_attributes(attrs)
-        end
-
-        def exclude_attributes(*attrs)
-          @_excluded_attributes = attrs
-        end
-
-        def select_attributes(*attrs)
-          @_selected_attributes = attrs
-        end
-
-        if RUBY_ENGINE == 'opal'
-          base.instance_exec do
-            def attribute(name, options = {})
-              attribute_conditions[name] = options
-
-              define_method(name) do
-                _get_attribute(name)
-              end
-
-              define_method("#{name}=") do |val|
-                _validate_attribute(name, val)
-                changed!
-                @_changed_attributes[name] = val
-              end
-            end
-          end
-
-          def validate_attributes_function
-            %x{
-              if (typeof self.validate_attributes_function === 'undefined') {
-                self.validate_attributes_function = function(attributes_object) {
-                  try { self.$_validate_attributes(Opal.Hash.$new(attributes_object)) }
-                  catch (e) { return e.message; }
-                }
-              }
-              return self.validate_attributes_function;
-            }
-          end
-
-          def validate_attribute_function(attr)
-            function_name = "validate_attribute_#{attr}_function"
-            %x{
-              if (typeof self[function_name] === 'undefined') {
-                self[function_name] = function(value) {
-                  try { self.$_validate_attribute(attribute, value); }
-                  catch (e) { return e.message; }
-                }
-              }
-              return self[function_name];
-            }
-          end
-
-          def _get_attribute(name)
-            return @_changed_attributes[name] if @_changed_attributes.key?(name)
-            path = @_store_path + [name]
-            result = Redux.fetch_by_path(*path)
-            %x{
-              if (result === null) { return nil; }
-              else if (result instanceof Object && !(result instanceof Array)) {
-                return Opal.Hash.$new(result);
-              } else { return result; }
-            }
-          end
-
-          def attributes
-            raw_attributes = Redux.fetch_by_path(*@_store_path)
-            hash = Hash.new(raw_attributes)
-            hash.merge!(@_changed_attributes) if @_changed_attributes
-            hash
-          end
-
-          def native_attributes
-            Redux.fetch_by_path(*@_store_path)
-          end
-
-          def _get_selected_attributes
-            sel_attributes = attributes.dup
-            if @_selected_attributes && !@_selected_attributes.empty?
-              sel_attributes.each_key do |attr|
-                unless @_selected_attributes.include?(attr) || @_selected_attributes.include?(attr)
-                  sel_attributes.delete(attr)
-                end
-              end
-            end
-            if @_excluded_attributes && !@_excluded_attributes.empty?
-              @_excluded_attributes.each { |attr| sel_attributes.delete(attr) }
-            end
-            sel_attributes
-          end
-        else
-          base.instance_exec do
-            def attribute(name, options = {})
-              attribute_conditions[name] = options
-
-              define_method(name) do
-                @_raw_attributes[name]
-              end
-
-              define_method("#{name}=") do |val|
-                _validate_attribute(name, val)
-                changed!
-                @_raw_attributes[name] = val
-              end
-            end
-          end
-
-          def attributes
-            @_raw_attributes
-          end
-
-          def native_attributes
-            @_raw_attributes
-          end
-
-          def _get_selected_attributes
-            sel_attributes = attributes.transform_keys(&:to_s)
-            self.class.attribute_conditions.each do |attr, options|
-              sel_attributes.delete(attr.to_s) if options[:server_only]
-            end
-            if @_selected_attributes && !@_selected_attributes.empty?
-              sel_attributes.each_key do |attr|
-                unless @_selected_attributes.include?(attr.to_sym) || @_selected_attributes.include?(attr)
-                  sel_attributes.delete(attr)
-                end
-              end
-            end
-            if @_excluded_attributes && !@_excluded_attributes.empty?
-              @_excluded_attributes.each { |attr| sel_attributes.delete(attr.to_s) }
-            end
-            sel_attributes
-          end
-        end
-      end
-    end
-  end
-end
+module Isomorfeus
+  module Data
+    module AttributeSupport
+      def self.included(base)
+        base.instance_exec do
+          def attribute_conditions
+            @attribute_conditions ||= {}
+          end
+
+          def indexed_attributes
+            @indexed_attributes ||= {}
+          end
+
+          def valid_attribute?(attr_name, attr_value)
+            Isomorfeus::Props::Validator.new(self.name, attr_name, attr_value, attribute_conditions[attr_name]).validate!
+          rescue
+            false
+          end
+
+          def validate
+            Isomorfeus::Props::ValidateHashProxy.new
+          end
+
+          def _validate_attribute(attr_name, attr_val)
+            Isomorfeus.raise_error(message: "#{self.name}: No such attribute declared: '#{attr_name}'!") unless attribute_conditions.key?(attr_name)
+            Isomorfeus::Props::Validator.new(self.name, attr_name, attr_val, attribute_conditions[attr_name]).validate!
+          end
+
+          def _validate_attributes(attrs)
+            attribute_conditions.each_key do |attr|
+              if attribute_conditions[attr].key?(:required) && attribute_conditions[attr][:required] && !attrs.key?(attr)
+                Isomorfeus.raise_error(message: "Required attribute #{attr} not given!")
+              end
+            end
+            attrs.each { |attr, val| _validate_attribute(attr, val) }
+          end
+        end
+
+        def _validate_attribute(attr_name, value)
+          self.class._validate_attribute(attr_name, value)
+        end
+
+        def _validate_attributes(attrs)
+          self.class._validate_attributes(attrs)
+        end
+
+        def exclude_attributes(*attrs)
+          @_excluded_attributes = attrs
+        end
+
+        def select_attributes(*attrs)
+          @_selected_attributes = attrs
+        end
+
+        if RUBY_ENGINE == 'opal'
+          base.instance_exec do
+            def attribute(name, options = {})
+              indexed = options.delete(:index)
+              indexed_attributes[name] = indexed if indexed
+              attribute_conditions[name] = options
+
+              define_method(name) do
+                _get_attribute(name)
+              end
+
+              define_method("#{name}=") do |val|
+                _validate_attribute(name, val)
+                changed!
+                @_changed_attributes[name] = val
+              end
+            end
+          end
+
+          def validate_attributes_function
+            %x{
+              if (typeof self.validate_attributes_function === 'undefined') {
+                self.validate_attributes_function = function(attributes_object) {
+                  try { self.$_validate_attributes(Opal.Hash.$new(attributes_object)) }
+                  catch (e) { return e.message; }
+                }
+              }
+              return self.validate_attributes_function;
+            }
+          end
+
+          def validate_attribute_function(attr)
+            function_name = "validate_attribute_#{attr}_function"
+            %x{
+              if (typeof self[function_name] === 'undefined') {
+                self[function_name] = function(value) {
+                  try { self.$_validate_attribute(attribute, value); }
+                  catch (e) { return e.message; }
+                }
+              }
+              return self[function_name];
+            }
+          end
+
+          def _get_attribute(name)
+            return @_changed_attributes[name] if @_changed_attributes.key?(name)
+            path = @_store_path + [name]
+            result = Redux.fetch_by_path(*path)
+            %x{
+              if (result === null) { return nil; }
+              else if (result instanceof Object && !(result instanceof Array)) {
+                return Opal.Hash.$new(result);
+              } else { return result; }
+            }
+          end
+
+          def attributes
+            raw_attributes = Redux.fetch_by_path(*@_store_path)
+            hash = Hash.new(raw_attributes)
+            hash.merge!(@_changed_attributes) if @_changed_attributes
+            hash
+          end
+
+          def _get_selected_attributes
+            sel_attributes = attributes.dup
+            if @_selected_attributes && !@_selected_attributes.empty?
+              sel_attributes.each_key do |attr|
+                unless @_selected_attributes.include?(attr) || @_selected_attributes.include?(attr)
+                  sel_attributes.delete(attr)
+                end
+              end
+            end
+            if @_excluded_attributes && !@_excluded_attributes.empty?
+              @_excluded_attributes.each { |attr| sel_attributes.delete(attr) }
+            end
+            sel_attributes
+          end
+        else
+          base.instance_exec do
+            def attribute(name, options = {})
+              indexed = options.delete(:index)
+              indexed_attributes[name] = indexed if indexed
+              attribute_conditions[name] = options
+
+              define_method(name) do
+                @_raw_attributes[name]
+              end
+
+              define_method("#{name}=") do |val|
+                _validate_attribute(name, val)
+                changed!
+                @_raw_attributes[name] = val
+              end
+            end
+          end
+
+          def attributes
+            @_raw_attributes
+          end
+
+          def _get_selected_attributes
+            sel_attributes = attributes.transform_keys(&:to_s)
+            self.class.attribute_conditions.each do |attr, options|
+              sel_attributes.delete(attr.to_s) if options[:server_only]
+            end
+            if @_selected_attributes && !@_selected_attributes.empty?
+              sel_attributes.each_key do |attr|
+                unless @_selected_attributes.include?(attr.to_sym) || @_selected_attributes.include?(attr)
+                  sel_attributes.delete(attr)
+                end
+              end
+            end
+            if @_excluded_attributes && !@_excluded_attributes.empty?
+              @_excluded_attributes.each { |attr| sel_attributes.delete(attr.to_s) }
+            end
+            sel_attributes
+          end
+        end
+      end
+    end
+  end
+end