safrano 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b38827d37fa3bfed54a30aa61c04b5da27470071c5e3167fb5a08aa5c48a69af
-  data.tar.gz: 3754e63822b6c504b42bc698df360295ab92bcf96a2ed8fdef4af7f2ed5c8d85
+  metadata.gz: 00bf6cd3a561928000b8bf53bbc71f139b162f92adc229e625f010dc6f1ce3c7
+  data.tar.gz: bf154e1b55e4d32e4640d6c993566a45eae8a2bce44b23dd979a9946d3633dc7
 SHA512:
-  metadata.gz: 0c6a3949c741f120955b4582ddad95aa3fefe80f613030970c174b4fe000129e4d2f67dcb43deae5608a2a287a489a4c94d6ba0df5a613c5557b22b8ca4f625b
-  data.tar.gz: 7e5070fa657435fbc3a2932344392e58fa7105863bb045ad5a0aac7227a1e7ce5e4f54628915c81156da2f315eb359409c786243c47697877237ac08294a7872
+  metadata.gz: 9b2fad0321b45bae50f3435b688b31f99d320cfa4f81f14867f64659faa0c4e8ece7bc4f1f7ecc2db2c7710c08f7726bb4d758bf5d09d487a54199afea50119a
+  data.tar.gz: b9a70b4a08fb7a2cc31df7e7637f635a42a85433660f5061f6897e1fb463496252c8d611fb1023e5f27202bbc478b58569d2ad42b1c3359db14e34c92f4ec35c

data/lib/odata/collection.rb

@@ -60,10 +60,13 @@ module Safrano
       end
 
       def initialize_dataset(dtset = nil)
-        @cx = dtset || @modelk
+        @cx = @cx ||  dtset || @modelk
+      end
+      
+      def initialize_uparms
         @uparms = UrlParameters4Coll.new(@cx, @params)
       end
-
+      
       def odata_get_apply_params
         @uparms.apply_to_dataset(@cx).map_result! do |dataset|
           @cx = dataset
@@ -131,9 +134,9 @@ module Safrano
 
       # on model class level we return the collection
       def odata_get(req)
-        @params = req.params
-        initialize_dataset
-
+        @params = @params || req.params
+        initialize_dataset 
+        initialize_uparms
         @uparms.check_all.if_valid { |_ret|
           odata_get_apply_params.if_valid { |_ret|
             odata_get_output(req)
@@ -170,8 +173,7 @@ module Safrano
       end
 
       def initialize_dataset(dtset = nil)
-        @cx = dtset || navigated_dataset
-        @uparms = UrlParameters4Coll.new(@cx, @params)
+        @cx = @cx || dtset || navigated_dataset
       end
       # redefinitions of the main methods for a navigated collection
       # (eg. all Books of Author[2]  is Author[2].Books.all )

data/lib/odata/complex_type.rb

@@ -2,6 +2,7 @@
 
 module Safrano
   module FunctionImport
+    EMPTY_HASH = {}.freeze
     class ResultDefinition
       D = 'd'
       DJ_OPEN = '{"d":'
@@ -11,33 +12,104 @@ module Safrano
       VALUEK = 'value'
       RESULTSK = 'results'
       COLLECTION = 'Collection'
-
-      def initialize(klassmod)
-        @klassmod = klassmod
+      
+      def allowed_transitions
+        [Safrano::TransitionEnd]
       end
-
-      def to_odata_json(result, _req)
-        "#{DJ_OPEN}#{result.odata_h.to_json}#{DJ_CLOSE}"
+      
+      def transition_end(_match_result)
+        Safrano::Transition::RESULT_END
       end
-
-      def type_metadata
+           
+      # we will have this on class and instance level for making things simpler first
+      def self.klassmod
+        @klassmod
+      end
+      
+      # return a subclass of ResultAsComplexType
+      def self.asComplexType(klassmod)
+        Class.new(ResultAsComplexType) do
+          @klassmod = klassmod
+        end
+      end
+      
+      # return a subclass of ResultAsComplexType
+      def self.asComplexTypeColl(klassmod)
+        Class.new(ResultAsComplexTypeColl) do
+          @klassmod = klassmod
+        end
+      end
+      
+      def self.asPrimitiveType(klassmod)
+        Class.new(ResultAsPrimitiveType) do
+          @klassmod = klassmod
+        end
+      end
+      
+      def self.asPrimitiveTypeColl(klassmod)
+        Class.new(ResultAsPrimitiveTypeColl) do
+          @klassmod = klassmod
+        end
+      end      
+      
+      def self.asEntity(klassmod)
+        Class.new(ResultAsEntity) do
+          @klassmod = klassmod
+        end
+      end
+      
+      def self.asEntityColl(klassmod)
+        Class.new(ResultAsEntityColl) do
+          @klassmod = klassmod
+        end
+      end
+      
+      def initialize(value)
+        @value = value
+      end
+      
+      def odata_get(req)
+        [200, EMPTY_HASH, [to_odata_json(req)]]
+      end
+      def self.type_metadata
         @klassmod.type_name
       end
+      def type_metadata
+        self.class.type_metadata
+      end
+      
+      # needed for ComplexType result
+      def to_odata_json(_req)
+        "#{DJ_OPEN}#{@value.odata_h.to_json}#{DJ_CLOSE}"
+      end      
+      
+      # wrapper 
+      # for OData Entity and Collections, return them directly
+      # for others, ie ComplexType, Prims etc, return the ResultDefinition-subclass wrapped result
+      def self.do_execute_func_result(result, _req, apply_query_params=false)
+        self.new(result)
+      end
+      
     end
+    
     class ResultAsComplexType < ResultDefinition
+      def self.type_metadata
+        @klassmod.type_name
+      end
     end
+    
     class ResultAsComplexTypeColl < ResultDefinition
-      def type_metadata
+      def self.type_metadata
         "Collection(#{@klassmod.type_name})"
       end
 
-      def to_odata_json(coll, req)
+      def to_odata_json(req)
 #        "#{DJ_OPEN}#{{ RESULTSK => coll.map { |c| c.odata_h } }.to_json}#{DJ_CLOSE}"
-        template = @klassmod.output_template
+        template = self.class.klassmod.output_template
         # TODO: Error handling if database contains binary BLOB data that cant be
         # interpreted as UTF-8 then JSON will fail here
 
-        innerh = req.service.get_coll_odata_h(array: coll,
+        innerh = req.service.get_coll_odata_h(array: @value,
                                               template: template)
                                               
         innerj = innerh.to_json
@@ -45,43 +117,69 @@ module Safrano
         "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
       end
     end
+    
     class ResultAsEntity < ResultDefinition
-      def to_odata_json(result_entity, req)
-        result_entity.instance_exec do
-          copy_request_infos(req)
-          to_odata_json(request: req)
-        end
+    
+      def self.type_metadata
+        @klassmod.type_name
       end
+
+      
+      # wrapper 
+      # for OData Entity  return them directly
+      def self.do_execute_func_result(result, _req, apply_query_params=false)
+        # note: Sequel entities instances seem to be thread safe, so we can 
+        # safely add request-dependant data (eg. req.params) there
+        apply_query_params ? result : result.inactive_query_params
+      end
+      
     end
+    
     class ResultAsEntityColl < ResultDefinition
-      def type_metadata
+    
+      def self.type_metadata
         "Collection(#{@klassmod.type_name})"
       end
-
-      def to_odata_json(result_dataset, req)
+      
+      # wrapper 
+      # for OData Entity Collection return them directly
+      def self.do_execute_func_result(result, req, apply_query_params=false)
         coll = Safrano::OData::Collection.new(@klassmod)
+        # instance_exec has other instance variables; @values would be nil in the block below
+        # need to pass a local copy
+        dtset = result
         coll.instance_exec do
-          @params = req.params
-          initialize_dataset(result_dataset)
+
+          @params =  apply_query_params ?  req.params : EMPTY_HASH
+          initialize_dataset(dtset)
+          initialize_uparms
         end
-        coll.to_odata_json(request: req)
+        coll
       end
+
     end
+    
     class ResultAsPrimitiveType < ResultDefinition
-      def to_odata_json(result, _req)
+      def self.type_metadata
+        @klassmod.type_name
+      end
+
+      def to_odata_json(_req)
         { D => { METAK => { TYPEK => type_metadata },
-                 VALUEK => @klassmod.odata_value(result) } }.to_json
+                 VALUEK => self.class.klassmod.odata_value(@value) } }.to_json
       end
     end
+    
     class ResultAsPrimitiveTypeColl < ResultDefinition
-      def type_metadata
+      def self.type_metadata
         "Collection(#{@klassmod.type_name})"
       end
 
-      def to_odata_json(result, _req)
-        { D => { METAK => { TYPEK => type_metadata },
-                 RESULTSK => @klassmod.odata_collection(result) } }.to_json
+      def to_odata_json(_req)
+        { D => { METAK => { TYPEK => self.class.type_metadata },
+                 RESULTSK => self.class.klassmod.odata_collection(@value) } }.to_json
       end
+    
     end
   end
 
@@ -157,11 +255,11 @@ module Safrano
     end
 
     def self.return_as_collection_descriptor
-      FunctionImport::ResultAsComplexTypeColl.new(self)
+      FunctionImport::ResultDefinition.asComplexTypeColl(self)
     end
 
     def self.return_as_instance_descriptor
-      FunctionImport::ResultAsComplexType.new(self)
+      FunctionImport::ResultDefinition.asComplexType(self)
     end
 
     # add metadata xml to the passed REXML schema object

data/lib/odata/entity.rb

@@ -125,7 +125,7 @@ module Safrano
     end
 
     def copy_request_infos(req)
-      @params = req.params
+      @params = @inactive_query_params ? EMPTY_HASH : req.params
       @do_links = req.walker.do_links
       @uparms = UrlParameters4Single.new(self, @params)
     end
@@ -151,7 +151,11 @@ module Safrano
       @uparms.check_all.tap_valid { return odata_get_output(req) }
              .tap_error { |e| return e.odata_get(req) }
     end
-
+    def inactive_query_params
+      @inactive_query_params = true
+      self # chaining
+    end
+    
     DELETE_REL_AND_ENTY = lambda do |entity, assoc, parent|
       Safrano.remove_nav_relation(assoc, parent)
       entity.destroy(transaction: false)

data/lib/odata/function_import.rb

@@ -21,7 +21,7 @@ module Safrano
       end
 
       def allowed_transitions
-        [Safrano::TransitionEnd]
+        [Safrano::TransitionExecuteFunc]
       end
 
       def input(**parmtypes)
@@ -42,7 +42,13 @@ module Safrano
         end
         self
       end
-
+      
+      def auto_query_parameters
+        @auto_query_params = true
+        self   # chaining
+      end
+      alias auto_query_params auto_query_parameters 
+      
       def return(klassmod, &proc)
         raise('Please provide a code block') unless block_given?
 
@@ -51,7 +57,7 @@ module Safrano
                      else
                        # if it's neither a ComplexType nor a Model-Entity
                        # --> assume it is a Primitive
-                       ResultAsPrimitiveType.new(klassmod)
+                       ResultDefinition.asPrimitiveType(klassmod)
                      end
         @proc = proc
         self
@@ -65,7 +71,8 @@ module Safrano
                      else
                        # if it's neither a ComplexType nor a Modle-Entity
                        # --> assume it is a Primitive
-                       ResultAsPrimitiveTypeColl.new(klassmod)
+#                       ResultAsPrimitiveTypeColl.new(klassmod)
+                       ResultDefinition.asPrimitiveTypeColl(klassmod)
                      end
         @proc = proc
         self
@@ -135,33 +142,25 @@ module Safrano
         end if @input
         funky
       end
-
-      def with_validated_get(req)
+      
+      def with_transition_validated(req)
         #        initialize_params
+        @params = req.params
         return yield unless (@error = check_url_func_params)
 
-        @error.odata_get(req) if @error
-      end
-
-      def to_odata_json(req)
-        result = @proc.call(**@funcparams)
-        @returning.to_odata_json(result, req)
+        [nil, :error, @error] if @error
       end
-
-      def odata_get_output(req)
-        [200, EMPTY_HASH, [to_odata_json(req)]]
-      end
-
-      def odata_get(req)
-        @params = req.params
-
-        with_validated_get(req) do
-          odata_get_output(req)
+      
+     
+      def do_execute_func(req)
+        with_transition_validated(req) do
+          result = @proc.call(**@funcparams)
+          [@returning.do_execute_func_result(result, req, @auto_query_params), :run]
         end
       end
-
-      def transition_end(_match_result)
-        Transition::RESULT_END
+    
+      def transition_execute_func(_match_result)
+        [self, :run_with_execute_func]
       end
     end
   end

data/lib/odata/model_ext.rb

@@ -81,11 +81,11 @@ module Safrano
     end
 
     def return_as_collection_descriptor
-      Safrano::FunctionImport::ResultAsEntityColl.new(self)
+      Safrano::FunctionImport::ResultDefinition.asEntityColl(self)
     end
 
     def return_as_instance_descriptor
-      Safrano::FunctionImport::ResultAsEntity.new(self)
+      Safrano::FunctionImport::ResultDefinition.asEntity(self)
     end
 
     def execute_deferred_iblock

data/lib/odata/transition.rb

@@ -6,7 +6,7 @@ require_relative 'error'
 module Safrano
   # represents a state transition when navigating/parsing the url path
   # from left to right
-  class Transition < Regexp
+  class Transition 
     attr_accessor :trans
     attr_accessor :match_result
     attr_accessor :rgx
@@ -52,8 +52,28 @@ module Safrano
       ctx.method(@trans).call(@match_result)
     end
   end
-
+    
+  #Transition that does not move/change the input 
+  class InplaceTransition < Transition 
+    def initialize(trans: )
+      @trans = trans
+    end
+    def do_match(str)
+      @str = str
+    end
+    def path_remain
+      @str 
+    end
+    def path_done
+      EMPTYSTR
+    end
+    def do_transition(ctx)
+      ctx.method(@trans).call(@str)
+    end
+  end
+     
   TransitionEnd = Transition.new('\A(\/?)\z', trans: 'transition_end')
+  TransitionExecuteFunc = InplaceTransition.new(trans: 'transition_execute_func')
   TransitionMetadata = Transition.new('\A(\/\$metadata)(.*)',
                                       trans: 'transition_metadata')
   TransitionBatch = Transition.new('\A(\/\$batch)(.*)',

data/lib/odata/walker.rb

@@ -29,18 +29,24 @@ module Safrano
 
     # are $links requested ?
     attr_reader :do_links
+    
+    attr_reader :request 
 
     NIL_SERVICE_FATAL = 'Walker is called with a nil service'
     EMPTYSTR = ''
     SLASH = '/'
 
-    def initialize(service, path, content_id_refs = nil)
+    def initialize(service, path, request, content_id_refs = nil )
       raise NIL_SERVICE_FATAL unless service
 
       path = URI.decode_www_form_component(path)
       @context = service
       @content_id_refs = content_id_refs
-
+      
+      # needed because for function import we need access to the url parameters (req.params)
+      # who contains the functions params
+      @request = request
+      
       @contexts = [@context]
 
       @path_start = @path_remain = if service
@@ -109,6 +115,16 @@ module Safrano
       end
     end
 
+    # execute function import with request parameters 
+    # input: @context containt the function to exectute,
+    #        @request.params should normally contain the params
+    # result: validate the params for the given function, execute the function and 
+    #          return it's result back into @context,
+    #          and finaly set status :end   (or error if anyting went wrong )
+    def do_run_with_execute_func
+      @context, @status, @error = @context.do_execute_func(@request)
+    end
+   
     # little hacks... depending on returned state, set some attributes
     def state_mappings
       case @status
@@ -137,6 +153,8 @@ module Safrano
         # entity reference here and place it in @context
       when :run_with_content_id
         do_run_with_content_id
+      when :run_with_execute_func
+        do_run_with_execute_func
       end
 
       @contexts << @context

data/lib/safrano/request.rb

@@ -99,6 +99,7 @@ module Safrano
     def create_odata_walker
       @env['safrano.walker'] = @walker = Walker.new(@service,
                                                     path_info,
+                                                    self,
                                                     @content_id_references)
     end
 

data/lib/safrano/service.rb

@@ -137,6 +137,7 @@ module Safrano
     attr_accessor :relman
     attr_accessor :complex_types
     attr_accessor :function_imports
+    attr_accessor :function_import_keys
 
     # Instance attributes for specialized Version specific Instances
     attr_accessor :v1
@@ -155,6 +156,7 @@ module Safrano
       @relman = Safrano::RelationManager.new
       @complex_types = Set.new
       @function_imports = {}
+      @function_import_keys = []
       @cmap = {}
       instance_eval(&block) if block_given?
     end
@@ -239,6 +241,7 @@ module Safrano
       other.batch_handler = @batch_handler
       other.complex_types = @complex_types
       other.function_imports = @function_imports
+      other.function_import_keys = @function_import_keys
       other
     end
 
@@ -322,6 +325,8 @@ module Safrano
     def function_import(name)
       funcimp = Safrano::FunctionImport(name)
       @function_imports[name] = funcimp
+      @function_import_keys << name
+      set_funcimports_sorted
       funcimp
     end
 
@@ -338,7 +343,11 @@ module Safrano
       @collections.sort_by! { |klass| klass.entity_set_name.size }.reverse! if @collections
       @collections
     end
-
+    
+    # need to be sorted by size too
+    def set_funcimports_sorted
+      @function_import_keys.sort_by!{|k| k.size}.reverse!
+    end
     # to be called at end of publishing block to ensure we get the right names
     # and additionally build the list of valid attribute path's used
     # for validation of $orderby or $filter params
@@ -401,7 +410,7 @@ module Safrano
     end
 
     def base_url_func_regexp
-      @function_imports.keys.join('|')
+      @function_import_keys.join('|')
     end
 
     def service

data/lib/safrano/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Safrano
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safrano
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - oz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2021-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack