safrano 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e43512da576932288321a8e821e26fa9c70d578f52562f6a343bfe3c3711bae
-  data.tar.gz: e2c00621b792634355f99d2025fada0d05cd44666516d916aa2546fb72f5157f
+  metadata.gz: c341ac75683820fb122f94d0f45abe31258a48e3366db3ed4547c088a2afdab9
+  data.tar.gz: 7d0ddebfd2b00738235514e5f1544f22d8a20fa6c2b4cde5b9066af4251e50be
 SHA512:
-  metadata.gz: 8ff433c52ec4406198b0988e122213f0af36a8f1a06b2eb1d2ebfc2c3736db5f8c575fa86e04b8ac9801d4d4fb363edc468c3078b3f93c66313497739ffc3c2e
-  data.tar.gz: 59ebba62c9a7e81496a651473fa9469d843409dab4c1703221f897425136fe02439ea400e17124a910de599378056b7b21758815d734c9807778193c791e3286
+  metadata.gz: 220d3948fc7a80c1c3403fa3d98eab40880c2d80dd7745f003ea93b27581641df1cbcec4d7bf6d471b7c18843c6054addabb9635382f86e60531679aa1738c21
+  data.tar.gz: 4731134f71abd2f5e4b044ac5853d8f30a951c6c434fd2861fd5f59e3f5cdda1916f5ba5c3ff05030572a2f58c4a46d75c5e8289d1d3d96778d0df8a8f6504c8

data/lib/core_ext/REXML/Document/output.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Safrano
   module CoreIncl
     module REXML
@@ -6,7 +8,7 @@ module Safrano
           def to_pretty_xml
             formatter = ::REXML::Formatters::Pretty.new(2)
             formatter.compact = true
-            formatter.write(root, strio = '')
+            formatter.write(root, strio = ::String.new)
             strio
           end
         end

data/lib/core_ext/rexml.rb

@@ -1,3 +1,4 @@
 require_relative 'REXML/Document/output'
+require 'rexml/document'
 
 REXML::Document.include Safrano::CoreIncl::REXML::Document::Output

data/lib/odata/collection_order.rb

@@ -32,8 +32,7 @@ module Safrano
     attr_reader :oarg
 
     def initialize(ostr, jh)
-      ostr.strip!
-      @orderp = ostr
+      @orderp = ostr.strip
       @jh = jh
       build_oarg if @orderp
     end

data/lib/odata/expand.rb

@@ -82,9 +82,8 @@ module Safrano
     # Note: if you change this method, please also update arity_full_monkey?
     #       see below
     def initialize(expandstr, model)
-      expandstr.strip!
       @model = model
-      @expandp = expandstr
+      @expandp = expandstr.strip
 
       @exstrlist = expandstr.split(COMASPLIT)
       @exlist = @exstrlist.map { |exstr| Expand.new(exstr) }

data/lib/safrano/rack_app.rb

@@ -4,69 +4,3 @@ require 'rack'
 require_relative '../odata/walker'
 require_relative 'request'
 require_relative 'response'
-
-module Safrano
-  # Note there is a strong 1 to 1 relation between an app instance
-  # and a published service. --> actually means also
-  # we only support one service per App-class because publishing is
-  # made on app class level
-  class ServerApp
-    def initialize
-      # just get back the service base instance object
-      # that was saved on class level and save it here
-      # so it's not needed to call self.class.service
-      @service_base = self.class.get_service_base
-    end
-
-    def call(env)
-      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
-    end
-
-    # needed for testing only ? try to remove this
-    def self.path_prefix(path_pr)
-      @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
-    end
-
-    # needed for safrano-rack_builder
-    def get_path_prefix
-      self.class.get_service_base.xpath_prefix
-    end
-
-    def self.set_servicebase(sbase)
-      @service_base = sbase
-      @service_base.enable_v1_service
-      @service_base.enable_v2_service
-    end
-
-    def self.publish_service(&block)
-      sbase = Safrano::ServiceBase.new
-      sbase.instance_eval(&block) if block_given?
-      sbase.finalize_publishing
-      # save published service base instance on App-Class level
-      set_servicebase(sbase)
-    end
-  end
-end

data/lib/safrano/service.rb

@@ -118,9 +118,10 @@ module Safrano
   LEADING_SLASH_RGX = %r{\A/}.freeze
   include XMLNS
   GENERIC_415_RESP = [415, {}, ['']].freeze
-  # Base class for service. Subclass will be for V1, V2 etc...
-  class ServiceBase
+
+  class ServerApp
     include Safrano
+    include Safrano::Edm
     include ExpandHandler
 
     XML_PREAMBLE = %(<?xml version="1.0" encoding="utf-8" standalone="yes"?>\r\n)
@@ -132,30 +133,31 @@ module Safrano
     # end
     # ---> @cmap ends up as   {'books' => Book }
     attr_reader :cmap
+    attr_reader :xbugfix_create_response
+    attr_reader :allowed_transitions
 
     # this is just the *sorted* list of the entity classes
     # (ie... @cmap.values.sorted)
-    attr_accessor :collections
-
-    attr_accessor :xtitle
-    attr_accessor :xname
-    attr_accessor :xnamespace
-    attr_accessor :xpath_prefix
-    attr_accessor :xserver_url
-    attr_accessor :uribase
-    attr_accessor :meta
-    attr_accessor :batch_handler
-    attr_accessor :relman
-    attr_accessor :complex_types
-    attr_accessor :function_imports
-    attr_accessor :function_import_keys
-    attr_accessor :type_mappings
-    attr_accessor :final_template_func
-    attr_accessor :response_format_options
+    attr_reader :collections
+
+    attr_reader :xtitle
+    attr_reader :xname
+    attr_reader :xnamespace
+    attr_reader :xpath_prefix
+    attr_reader :xserver_url
+    attr_reader :uribase
+    attr_reader :meta
+    attr_reader :batch_handler
+    attr_reader :complex_types
+    attr_reader :function_imports
+    attr_reader :function_import_keys
+    attr_reader :type_mappings
+    attr_reader :final_template_func
+    attr_reader :response_format_options
 
     # Instance attributes for specialized Version specific Instances
-    attr_accessor :v1
-    attr_accessor :v2
+    attr_reader :v1
+    attr_reader :v2
 
     # TODO: more elegant design
     attr_reader :data_service_version
@@ -166,14 +168,13 @@ module Safrano
     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
-      #  because of the version subclasses that dont use "super" initialise
-      # (todo: why not??)
+    def self.app_setup_singleton
+      @app_setup_singleton
+    end
+
+    def initialize(template_instance: nil)
       @meta = ServiceMeta.new(self)
       @batch_handler = Safrano::Batch::DisabledHandler.new
-      @relman = Safrano::RelationManager.new
       @complex_types = Set.new
       @function_imports = {}
       @function_import_keys = []
@@ -182,8 +183,61 @@ module Safrano
       @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?
+      @xbugfix_create_response = true
+      klass = self.class
+      # TODO better error
+      raise StandardError unless (klass.publish_proc or template_instance)
+
+      tmpli = if template_instance
+                template_instance
+              elsif klass.app_setup_singleton
+                klass.app_setup_singleton
+              end
+      initialize_fork(tmpli) if tmpli
+    end
+
+    def initialize_fork(template_instance)
+      @batch_handler = template_instance.batch_handler.dup
+      @complex_types = template_instance.complex_types.dup
+      @function_imports = template_instance.function_imports.dup
+      @function_import_keys = template_instance.function_import_keys.dup
+      @cmap = template_instance.cmap.dup
+      @type_mappings = template_instance.type_mappings.dup
+      @response_format_options = template_instance.response_format_options.dup
+      @final_template_func = template_instance.final_template_func.dup
+      @xbugfix_create_response = template_instance.xbugfix_create_response.dup
+      @xpath_prefix = template_instance.xpath_prefix.dup
+      @collections = template_instance.collections.dup
+      @xname = template_instance.xname.dup
+      @xserver_url = template_instance.xserver_url.dup
+      @uribase = template_instance.uribase.dup
+      @xtitle = template_instance.xtitle.dup
+      @xnamespace = template_instance.xnamespace.dup
+      @v1 = template_instance.v1.dup
+      @v2 = template_instance.v2.dup
+      @data_service_version = template_instance.data_service_version.dup
+      @allowed_transitions = template_instance.allowed_transitions.dup
+    end
+
+    def call(env)
+      Safrano::Request.new(env, self).process
+    end
+
+    def process_publish_service(&block)
+      instance_eval(&block)
+      finalize_publishing
+      enable_v1_service
+      enable_v2_service
+    end
+
+    def self.publish_service(&block)
+      @publish_proc = block
+      @app_setup_singleton = self.new
+      @app_setup_singleton.process_publish_service(&block)
+    end
+
+    def self.publish_proc
+      @publish_proc
     end
 
     DEFAULT_PATH_PREFIX = '/'
@@ -191,18 +245,17 @@ module Safrano
 
     def enable_batch
       @batch_handler = Safrano::Batch::EnabledHandler.new
-      (@v1.batch_handler = @batch_handler) if @v1
-      (@v2.batch_handler = @batch_handler) if @v2
+      (@v1.enable_batch) if @v1
+      (@v2.enable_batch) if @v2
+      self
     end
 
     def enable_v1_service
-      @v1 = Safrano::ServiceV1.new
-      copy_attribs_to @v1
+      @v1 = Safrano::ServiceV1.new(template_instance: self)
     end
 
     def enable_v2_service
-      @v2 = Safrano::ServiceV2.new
-      copy_attribs_to @v2
+      @v2 = Safrano::ServiceV2.new(template_instance: self)
     end
 
     # public API
@@ -221,14 +274,21 @@ module Safrano
     def path_prefix(path_pr)
       @xpath_prefix = path_pr.sub(TRAILING_SLASH_RGX, '')
       @xpath_prefix.freeze
-      (@v1.xpath_prefix = @xpath_prefix) if @v1
-      (@v2.xpath_prefix = @xpath_prefix) if @v2
+      (@v1.path_prefix(path_pr)) if @v1
+      (@v2.path_prefix(path_pr)) if @v2
+      self
+    end
+
+    # needed for safrano-rack_builder
+    def get_path_prefix
+      @xpath_prefix
     end
 
     def server_url(surl)
       @xserver_url = surl.sub(TRAILING_SLASH_RGX, '')
-      (@v1.xserver_url = @xserver_url) if @v1
-      (@v2.xserver_url = @xserver_url) if @v2
+      @xserver_url.freeze
+      (@v1.server_url(surl)) if @v1
+      (@v2.server_url(surl)) if @v2
     end
 
     VALID_RESP_FORMAT_OPTS = [:skip_deferred, :skip_metadata]
@@ -247,11 +307,12 @@ module Safrano
         @v1.response_format_options(*vargs) if @v1
         @v2.response_format_options(*vargs) if @v2
       end
+      self
     end
 
     # keep the bug active for now, but allow to de-activate the fix
     def bugfix_create_response(bool)
-      @bugfix_create_response = bool
+      @xbugfix_create_response = bool
     end
 
     # end public API
@@ -280,29 +341,6 @@ module Safrano
       (@v2.uribase = @uribase) if @v2
     end
 
-    def copy_attribs_to(other)
-      other.cmap = @cmap
-      other.collections = @collections
-      other.allowed_transitions = @allowed_transitions
-      other.xtitle = @xtitle
-      other.xname = @xname
-      other.xnamespace = @xnamespace
-      other.xpath_prefix = @xpath_prefix
-      other.xserver_url = @xserver_url
-      other.uribase = @uribase
-      other.meta = ServiceMeta.new(other) # hum ... #todo: versions as well ?
-      other.relman = @relman
-      other.batch_handler = @batch_handler
-      other.complex_types = @complex_types
-      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
-
     # this is a central place. We extend Sequel models with OData functionality
     # The included/extended modules depends on the properties(eg, pks, field types) of the model
     # we differentiate
@@ -451,7 +489,7 @@ module Safrano
         klass.build_uri(@uribase)
 
         # Output create (POST) as single entity (Standard) or as array (non-standard buggy)
-        klass.include(@bugfix_create_response ? Safrano::EntityCreateStandardOutput : Safrano::EntityCreateArrayOutput)
+        klass.include(@xbugfix_create_response ? Safrano::EntityCreateStandardOutput : Safrano::EntityCreateArrayOutput)
 
         # define the most optimal casted_values method for the given model(klass)
         if klass.casted_cols.empty?
@@ -557,10 +595,13 @@ module Safrano
     end
 
     def add_metadata_xml_entity_type(schema)
+      relman = Safrano::RelationManager.new
       @collections.each do |klass|
         enty = klass.add_metadata_rexml(schema)
-        klass.add_metadata_navs_rexml(enty, @relman)
+        klass.add_metadata_navs_rexml(enty, relman)
       end
+      # return the collected rels needed later
+      relman
     end
 
     def add_metadata_xml_complex_types(schema)
@@ -571,8 +612,8 @@ module Safrano
       @function_imports.each_value { |func| func.add_metadata_rexml(ec)    }
     end
 
-    def add_metadata_xml_associations(schema)
-      @relman.each_rel do |rel|
+    def add_metadata_xml_associations(schema, relman)
+      relman.each_rel do |rel|
         rel.with_metadata_info(@xnamespace) do |name, bdinfo|
           assoc = schema.add_element('Association', 'Name' => name)
           bdinfo.each do |bdi|
@@ -585,7 +626,7 @@ module Safrano
       end
     end
 
-    def add_metadata_xml_entity_container(schema)
+    def add_metadata_xml_entity_container(schema, relman)
       ec = schema.add_element('EntityContainer',
                               'Name' => @xname,
                               'm:IsDefaultEntityContainer' => 'true')
@@ -595,8 +636,9 @@ module Safrano
                        'Name' => klass.entity_set_name,
                        'EntityType' => klass.type_name)
       end
+
       # 3.b Association set's
-      @relman.each_rel do |rel|
+      relman.each_rel do |rel|
         assoc = ec.add_element('AssociationSet',
                                'Name' => rel.name,
                                'Association' => "#{@xnamespace}.#{rel.name}")
@@ -645,17 +687,18 @@ module Safrano
       schema = serv.add_element('Schema',
                                 'Namespace' => @xnamespace,
                                 'xmlns' => XMLNS::MSFT_ADO_2009_EDM)
-      # 1. a. all EntityType
-      add_metadata_xml_entity_type(schema)
+
+      # 1. a. all EntityType (and get the collected rels metadata)
+      relman = add_metadata_xml_entity_type(schema)
 
       # 1. b. all ComplexType
       add_metadata_xml_complex_types(schema)
 
       # 2. Associations
-      add_metadata_xml_associations(schema)
+      add_metadata_xml_associations(schema, relman)
 
       # 3. Enty container
-      add_metadata_xml_entity_container(schema)
+      add_metadata_xml_entity_container(schema, relman)
 
       XML_PREAMBLE + doc.to_pretty_xml
     end
@@ -737,8 +780,9 @@ module Safrano
   end
 
   # for OData V1
-  class ServiceV1 < ServiceBase
-    def initialize
+  class ServiceV1 < ServerApp
+    def initialize(template_instance: nil)
+      super
       @data_service_version = '1.0'
     end
 
@@ -762,8 +806,9 @@ module Safrano
   end
 
   # for OData V2
-  class ServiceV2 < ServiceBase
-    def initialize
+  class ServiceV2 < ServerApp
+    def initialize(template_instance: nil)
+      super
       @data_service_version = '2.0'
     end
 
@@ -785,7 +830,7 @@ module Safrano
 
   # a virtual entity for the service metadata
   class ServiceMeta
-    attr_accessor :service
+    attr_reader :service
 
     def initialize(service)
       @service = service

data/lib/safrano/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safrano
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - oz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-09 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack