safrano 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 351f486db0cd9cfa46ac9770e739dce4fcf9b4fe4a564799febc2d23eea2f713
-  data.tar.gz: b214e28350f97dc2a442950803773accb428f8316de8482884c56c81b0aab754
+  metadata.gz: 5e43512da576932288321a8e821e26fa9c70d578f52562f6a343bfe3c3711bae
+  data.tar.gz: e2c00621b792634355f99d2025fada0d05cd44666516d916aa2546fb72f5157f
 SHA512:
-  metadata.gz: 3e1a12730936b436c30c909970b8d31e90358b87f10242f76c7f8b238def70391fb20bc0568825495045a095db6d799b8da8c07c9f524914eecf0a072d083d40
-  data.tar.gz: 8a1fdd4ca3c8d4512bd6ef6890a653a1ad1e052daad13ee5355d51248c652a938cf75df16d42d97a42ee6149f111e69cce215102b69c414b58920cf4b62180a2
+  metadata.gz: 8ff433c52ec4406198b0988e122213f0af36a8f1a06b2eb1d2ebfc2c3736db5f8c575fa86e04b8ac9801d4d4fb363edc468c3078b3f93c66313497739ffc3c2e
+  data.tar.gz: 59ebba62c9a7e81496a651473fa9469d843409dab4c1703221f897425136fe02439ea400e17124a910de599378056b7b21758815d734c9807778193c791e3286

data/lib/core_ext/MatchData/matchlen.rb

@@ -0,0 +1,14 @@
+# mach_length for ruby < 3.0
+module Safrano
+  module CoreIncl
+    module MatchData
+      module MatchLen
+        unless method_defined? :match_length
+          def  match_length(i)
+            self[i].length
+          end
+        end
+      end
+    end
+  end
+end

data/lib/core_ext/matchdata.rb

@@ -0,0 +1,3 @@
+require_relative 'MatchData/matchlen'
+
+MatchData.include Safrano::CoreIncl::MatchData::MatchLen

data/lib/odata/complex_type.rb

@@ -215,10 +215,9 @@ module Safrano
     # needed for nested json output
     # this is a simpler version of model_ext#output_template
     def self.default_template
-      template = {}
+      template = { meta: EMPTYH, all_values: EMPTYH }
       expand_e = {}
 
-      template[:all_values] = EMPTYH
       @props.each do |prop, kl|
         expand_e[prop] = kl.default_template if kl.respond_to? :default_template
       end

data/lib/odata/entity.rb

@@ -217,7 +217,6 @@ module Safrano
     def odata_patch(req)
       req.with_parsed_data(self.class) do |data|
         data.delete('__metadata')
-
         # validate payload column names
         if (invalid = self.class.invalid_hash_data?(data))
           ::Safrano::Request::ON_CGST_ERROR.call(req)

data/lib/odata/error.rb

@@ -46,6 +46,14 @@ module Safrano
         super(msg, symbname)
       end
     end
+
+    # invalid response format option
+    class InvalidRespFormatOption < NameError
+      def initialize(opt)
+        msg = "Invalid response format option: #{opt}"
+        super(msg, opt.to_s)
+      end
+    end
   end
 
   # used in function import error handling. cf. func import / do_execute_func

data/lib/odata/model_ext.rb

@@ -236,9 +236,9 @@ module Safrano
     def output_template(expand_list:,
                         select: Safrano::SelectBase::ALL)
 
-      return @default_template if expand_list.empty? && select.all_props?
+      return @default_template.dup if expand_list.empty? && select.all_props?
 
-      template = {}
+      template = { meta: EMPTYH }
       expand_e = {}
       expand_c = {}
       deferr = []
@@ -364,7 +364,7 @@ module Safrano
     EMPTYH = {}.freeze
 
     def build_default_template
-      @default_template = { all_values: EMPTYH }
+      @default_template = { meta:  EMPTYH, all_values: EMPTYH }
       @default_template[:deferr] = (@nav_entity_attribs&.keys || []) + (@nav_collection_attribs&.keys || EMPTY_ARRAY) if @nav_entity_attribs || @nav_collection_attribs
     end
 

data/lib/safrano/rack_app.rb

@@ -22,6 +22,13 @@ module Safrano
       Safrano::Request.new(env, @service_base).process
     end
 
+    #  needed for testing only ? try to remove this
+    def self.copy(other)
+      copy = Class.new(Safrano::ServerApp) # <---- !!!
+      copy.set_servicebase(other.get_service_base.dup)
+      copy
+    end
+
     #  needed for testing only ? try to remove this
     def self.enable_batch
       @service_base.enable_batch
@@ -32,6 +39,12 @@ module Safrano
       @service_base.path_prefix path_pr
     end
 
+    # needed for testing only ? try to remove this
+
+    def self.response_format_options(*args)
+      @service_base.response_format_options(*args)
+    end
+
     # needed for testing only ? try to remove this
     def self.get_service_base
       @service_base

data/lib/safrano/service.rb

@@ -12,8 +12,12 @@ require 'set'
 require 'odata/collection'
 
 module Safrano
-  # this module has all methods related to expand/defered output preparation
+  # these modules have all methods related to expand/defered output preparation
   # and will be included in Service class
+
+  METADATA_K = '__metadata'
+  EMPTYH = {}.freeze
+
   module ExpandHandler
     PATH_SPLITTER = %r{\A(\w+)/?(.*)\z}.freeze
     DEFERRED = '__deferred'
@@ -40,14 +44,17 @@ module Safrano
       { uri: entity.uri }
     end
 
-    EMPTYH = {}.freeze
-    METADATA_K = '__metadata'
     def get_entity_odata_h(entity:, template:)
-      # start with metadata
-      hres = { METADATA_K => entity.metadata_h }
+      hres = {}
+      # finalise the template according to options
+      # (eg. skip metadata and or deferred...)
+      @final_template_func.call(template)
 
       template.each do |elmt, arg|
         case elmt
+        when :meta
+          hres[METADATA_K] = entity.metadata_h
+
         when :all_values
           hres.merge! entity.casted_values
 
@@ -143,6 +150,8 @@ module Safrano
     attr_accessor :function_imports
     attr_accessor :function_import_keys
     attr_accessor :type_mappings
+    attr_accessor :final_template_func
+    attr_accessor :response_format_options
 
     # Instance attributes for specialized Version specific Instances
     attr_accessor :v1
@@ -151,6 +160,12 @@ module Safrano
     # TODO: more elegant design
     attr_reader :data_service_version
 
+    # for response format options
+    FINAL_TEMPLATE_FUNC_DEFAULT = ->(_template) {}
+    FINAL_TEMPLATE_FUNC_SKIP_META = ->(template) { template.delete(:meta) }
+    FINAL_TEMPLATE_FUNC_SKIP_DEFERR = ->(template) { template.delete(:deferr) }
+    FINAL_TEMPLATE_FUNC_SKIP_META_DEFERR = ->(template) { template.delete(:meta); template.delete(:deferr) }
+
     def initialize(&block)
       # Warning: if you add attributes here, you shall need add them
       # in copy_attribs_to as well
@@ -164,6 +179,8 @@ module Safrano
       @function_import_keys = []
       @cmap = {}
       @type_mappings = {}
+      @response_format_options = []
+      @final_template_func = FINAL_TEMPLATE_FUNC_DEFAULT
       # enabled per default starting from 0.6
       @bugfix_create_response = true
       instance_eval(&block) if block_given?
@@ -214,12 +231,42 @@ module Safrano
       (@v2.xserver_url = @xserver_url) if @v2
     end
 
+    VALID_RESP_FORMAT_OPTS = [:skip_deferred, :skip_metadata]
+    def valid_resp_format_options(*args)
+      args.map!(&:to_sym)
+      args.each { |arg|
+        raise API::InvalidRespFormatOption.new(arg) unless VALID_RESP_FORMAT_OPTS.include?(arg)
+      }
+      yield(args)
+    end
+
+    def response_format_options(*args)
+      valid_resp_format_options(*args) do |vargs|
+        @response_format_options = vargs.dup
+        process_response_format_options
+        @v1.response_format_options(*vargs) if @v1
+        @v2.response_format_options(*vargs) if @v2
+      end
+    end
+
     # keep the bug active for now, but allow to de-activate the fix
     def bugfix_create_response(bool)
       @bugfix_create_response = bool
     end
 
     # end public API
+    def process_response_format_options
+      @final_template_func = if (@response_format_options.include?(:skip_metadata) &&
+                                    @response_format_options.include?(:skip_deferred))
+                               FINAL_TEMPLATE_FUNC_SKIP_META_DEFERR
+                             elsif @response_format_options.include?(:skip_metadata)
+                               FINAL_TEMPLATE_FUNC_SKIP_META
+                             elsif @response_format_options.include?(:skip_deferred)
+                               FINAL_TEMPLATE_FUNC_SKIP_DEFERR
+                             else
+                               FINAL_TEMPLATE_FUNC_DEFAULT
+                             end
+    end
 
     def set_uribase
       @uribase = if @xpath_prefix.empty?
@@ -250,6 +297,8 @@ module Safrano
       other.function_imports = @function_imports
       other.function_import_keys = @function_import_keys
       other.type_mappings = @type_mappings
+      other.response_format_options = @response_format_options
+      other.final_template_func = @final_template_func
       other.bugfix_create_response(@bugfix_create_response)
       other
     end

data/lib/safrano/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safrano
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - oz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-18 00:00:00.000000000 Z
+date: 2024-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -187,6 +187,7 @@ files:
 - lib/core_ext/Dir/iter.rb
 - lib/core_ext/Hash/transform.rb
 - lib/core_ext/Integer/edm.rb
+- lib/core_ext/MatchData/matchlen.rb
 - lib/core_ext/Numeric/convert.rb
 - lib/core_ext/REXML/Document/output.rb
 - lib/core_ext/String/convert.rb
@@ -197,6 +198,7 @@ files:
 - lib/core_ext/dir.rb
 - lib/core_ext/hash.rb
 - lib/core_ext/integer.rb
+- lib/core_ext/matchdata.rb
 - lib/core_ext/numeric.rb
 - lib/core_ext/rexml.rb
 - lib/core_ext/string.rb