safrano 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc504918971031d5c89c44a26e970a65da7e2cbd3da865e65138e95f90a2460d
-  data.tar.gz: dd418e35d807619d101b385434ab4f886e7a0b9d10267471a09418e50d14db49
+  metadata.gz: 6397b8b41d6241576f613abfa0e36c8f6973fa96542b60d388b15954aaa3a92b
+  data.tar.gz: 3f36fe0d18bd9659d4e3ce27f501ef1540e82f24a26418c28760aae869de85d9
 SHA512:
-  metadata.gz: af6cdb6492826c77f0d43846492e53bb5fdaf023de23f0a73496fec5076818291300d248f7d82874886cef99ac864b5632e928061ff8dfe3bf2dafb29cd0593e
-  data.tar.gz: 86893ddd4605f7d7eaa063c2cf869923db1c17acb42d69e880ab9fc92523743abaab205b18147452b5f55050a65676b2786458b6fcca560c65c4160bf069357d
+  metadata.gz: f6f666fb8e2fb136fe7ca0c215e19c24648d9a1a4494c3cdb1a53f45561cf827c2670be56bcf74005828b3a9ebf78e2efc63e8b89db35fefb9f70d4c730e7ebb
+  data.tar.gz: 2cdfe6b8cb732184dacb256e5c114361f41da91f5a0f821c2f61a5b7ae541b0aa8f5ad45b23598c0d5301311c193f9f6e51d6e8b8def7eac78a54176f92cfd98

data/lib/odata/batch.rb

@@ -59,7 +59,7 @@ module OData
         # TODO: test ?
         if (logga = @full_req.env['safrano.logger_mw'])
           logga.batch_log(env, status, header, began_at)
-          # TODO check why/if we need Rack::Utils::HeaderHash.new(header)
+          # TODO: check why/if we need Rack::Utils::HeaderHash.new(header)
           # and Rack::BodyProxy.new(body) ?
         end
         [status, header, body]
@@ -71,7 +71,7 @@ module OData
 
         headers.each do |name, value|
           env_key = name.upcase.tr('-', '_')
-          env_key = 'HTTP_' + env_key unless env_key == 'CONTENT_TYPE'
+          env_key = "HTTP_#{env_key}" unless env_key == 'CONTENT_TYPE'
           converted_headers[env_key] = value
         end
 
@@ -104,11 +104,11 @@ module OData
     # jaune d'oeuf
     class DisabledHandler < HandlerBase
       def odata_post(_req)
-        [404, {}, '$batch is not enabled ']
+        [404, EMPTY_HASH, '$batch is not enabled ']
       end
 
       def odata_get(_req)
-        [404, {}, '$batch is not enabled ']
+        [404, EMPTY_HASH, '$batch is not enabled ']
       end
     end
     # battre le tout
@@ -138,12 +138,12 @@ module OData
 
           [202, resp_hdrs, @mult_response.body[0]]
         else
-          [415, {}, 'Unsupported Media Type']
+          [415, EMPTY_HASH, 'Unsupported Media Type']
         end
       end
 
       def odata_get(_req)
-        [405, {}, 'You cant GET $batch, POST it ']
+        [405, EMPTY_HASH, 'You cant GET $batch, POST it ']
       end
     end
   end

data/lib/odata/collection.rb

@@ -8,6 +8,8 @@ require_relative '../safrano/core.rb'
 require_relative 'error.rb'
 require_relative 'collection_filter.rb'
 require_relative 'collection_order.rb'
+require_relative 'expand.rb'
+require_relative 'select.rb'
 require_relative 'url_parameters.rb'
 require_relative 'collection_media.rb'
 
@@ -43,23 +45,23 @@ module OData
   # we will add this to our Model classes with "extend" --> self is the Class
   module EntityClassBase
     SINGLE_PK_URL_REGEXP = /\A\(\s*'?([\w\s]+)'?\s*\)(.*)/.freeze
-    ONLY_INTEGER_RGX = /\A[+-]?\d+\z/
+    ONLY_INTEGER_RGX = /\A[+-]?\d+\z/.freeze
 
     attr_reader :nav_collection_url_regexp
     attr_reader :nav_entity_url_regexp
     attr_reader :entity_id_url_regexp
-    attr_reader :attrib_paths_url_regexp
     attr_reader :nav_collection_attribs
     attr_reader :nav_entity_attribs
     attr_reader :data_fields
     attr_reader :inlinecount
-    
-    # Sequel associations pointing to this model. Sequel provides association 
+    attr_reader :default_template
+
+    # Sequel associations pointing to this model. Sequel provides association
     # reflection information on the "from" side. But in some cases
     # we will need the reverted way
     # finally not needed and not used yet
     # attr_accessor :assocs_to
-    
+
     # set to parent entity in case the collection is a nav.collection
     # nil otherwise
     attr_reader :nav_parent
@@ -69,9 +71,6 @@ module OData
     # dataset
     attr_accessor :cx
 
-    # array of the objects --> dataset.to_a
-    attr_accessor :ax
-
     # url params
     attr_reader :params
 
@@ -105,7 +104,6 @@ module OData
       @entity_set_name = nil
       @uparms = nil
       @params = nil
-      @ax = nil
       @cx = nil
     end
 
@@ -130,8 +128,7 @@ module OData
         new_entity.save(transaction: false)
         OData.create_nav_relation(new_entity, assoc, parent)
         parent.save(transaction: false)
-      else
-        # not supported
+        # else # not supported
       end
     end
     def odata_create_save_entity_and_rel(req, new_entity, assoc, parent)
@@ -199,9 +196,7 @@ module OData
     def check_u_p_inlinecount
       return unless (icp = @params['$inlinecount'])
 
-      unless (icp == 'allpages') || (icp == 'none')
-        return BadRequestInlineCountParamError
-      end
+      return BadRequestInlineCountParamError unless (icp == 'allpages') || (icp == 'none')
 
       nil
     end
@@ -214,26 +209,25 @@ module OData
       @uparms.check_order
     end
 
+    def check_u_p_expand
+      @uparms.check_expand
+    end
+
     def build_attribute_path_list
       @attribute_path_list = attribute_path_list
-      @attrib_paths_url_regexp = @attribute_path_list.join('|')
     end
 
     def attribute_path_list(nodes = Set.new)
       # break circles
-      return [] if nodes.include?(entity_set_name)
+      return EMPTY_ARRAY if nodes.include?(entity_set_name)
 
       ret = @columns.map(&:to_s)
       nodes.add entity_set_name
-      if @nav_entity_attribs
-        @nav_entity_attribs.each do |a, k|
-          ret.concat(k.attribute_path_list(nodes).map { |kc| "#{a}/#{kc}" })
-        end
+      @nav_entity_attribs&.each do |a, k|
+        ret.concat(k.attribute_path_list(nodes).map { |kc| "#{a}/#{kc}" })
       end
-      if @nav_collection_attribs
-        @nav_collection_attribs.each do |a, k|
-          ret.concat(k.attribute_path_list(nodes).map { |kc| "#{a}/#{kc}" })
-        end
+      @nav_collection_attribs&.each do |a, k|
+        ret.concat(k.attribute_path_list(nodes).map { |kc| "#{a}/#{kc}" })
       end
       ret
     end
@@ -242,20 +236,18 @@ module OData
       return nil unless @params
 
       check_u_p_top || check_u_p_skip || check_u_p_orderby ||
-        check_u_p_filter || check_u_p_inlinecount
+        check_u_p_filter || check_u_p_expand || check_u_p_inlinecount
     end
 
     def initialize_dataset
       @cx = self
-      @ax = nil
       @cx = navigated_dataset if @cx.nav_parent
       @model = if @cx.respond_to? :model
                  @cx.model
                else
                  @cx
                end
-      @jh = @model.join_by_paths_helper
-      @uparms = UrlParameters.new(@jh, @params)
+      @uparms = UrlParameters4Coll.new(@model, @params)
     end
 
     # finally return the requested output according to format, options etc
@@ -296,10 +288,10 @@ module OData
     # add metadata xml to the passed REXML schema object
     def add_metadata_rexml(schema)
       enty = if @media_handler
-        schema.add_element('EntityType', 'Name' => to_s, 'HasStream' => 'true' )
-      else
-        schema.add_element('EntityType', 'Name' => to_s)
-      end
+               schema.add_element('EntityType', 'Name' => to_s, 'HasStream' => 'true')
+             else
+               schema.add_element('EntityType', 'Name' => to_s)
+             end
       # with their properties
       db_schema.each do |pnam, prop|
         if prop[:primary_key] == true
@@ -323,66 +315,130 @@ module OData
                                       association_reflection(assoc.to_sym)[:type],
                                       xnamespace,
                                       assoc)
-                                      
     end
 
     # and their Nav attributes == Sequel Model association
     def add_metadata_navs_rexml(schema_enty, relman, xnamespace)
-    
-      @nav_entity_attribs.each{|ne,klass|
-        nattr = metadata_nav_rexml_attribs(ne, 
-                                           klass, 
-                                           relman, 
+      @nav_entity_attribs&.each do |ne, klass|
+        nattr = metadata_nav_rexml_attribs(ne,
+                                           klass,
+                                           relman,
                                            xnamespace)
         schema_enty.add_element('NavigationProperty', nattr)
-      } if @nav_entity_attribs 
-    
-     
-      @nav_collection_attribs.each{|nc,klass|
-        nattr = metadata_nav_rexml_attribs(nc, 
-                                           klass, 
-                                           relman, 
+      end
+
+      @nav_collection_attribs&.each do |nc, klass|
+        nattr = metadata_nav_rexml_attribs(nc,
+                                           klass,
+                                           relman,
                                            xnamespace)
-          schema_enty.add_element('NavigationProperty', nattr)
-      } if @nav_collection_attribs 
-      
+        schema_enty.add_element('NavigationProperty', nattr)
+      end
     end
 
     D = 'd'.freeze
-    DJopen = '{"d":'.freeze
-    DJclose = '}'.freeze
+    DJ_OPEN = '{"d":'.freeze
+    DJ_CLOSE = '}'.freeze
     def to_odata_links_json(service:)
       innerj = service.get_coll_odata_links_h(array: get_a,
                                               uribase: @uribase,
                                               icount: @inlinecount).to_json
-      "#{DJopen}#{innerj}#{DJclose}"
+      "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
+    end
+
+    #    def output_template(expand: nil, select: nil)
+    def output_template(uparms)
+      #      output_template_deep(expand_list: expand_list, select: select)
+      output_template_deep(expand_list: uparms.expand.template, select: uparms.select)
+    end
+
+    # Recursive
+    def output_template_deep(expand_list:, select: OData::SelectBase::ALL)
+      return default_template if expand_list.empty? && select.all_props?
+
+      template = {}
+      expand_e = {}
+      expand_c = {}
+      deferr = []
+
+      # 1. handle non-navigation properties, only consider $select
+      # 2. handle navigations properties, need to check $select and $expand
+      if select.all_props?
+        template[:all_values] = EMPTYH
+        # include all nav attributes -->
+        @nav_entity_attribs&.each do |attr, klass|
+          if expand_list.key?(attr)
+            expand_e[attr] = klass.output_template_deep(expand_list: expand_list[attr])
+          else
+            deferr << attr
+          end
+        end
+
+        @nav_collection_attribs&.each do |attr, klass|
+          if expand_list.key?(attr)
+            expand_c[attr] = klass.output_template_deep(expand_list: expand_list[attr])
+          else
+            deferr << attr
+          end
+        end
+
+      else
+        template[:selected_vals] = @columns.map(&:to_s) & select.props
+        # include only selected nav attribs-->need additional intersection step
+        if @nav_entity_attribs
+          selected_nav_e = @nav_entity_attribs.keys & select.props
+
+          selected_nav_e&.each do |attr|
+            if expand_list.key?(attr)
+              klass = @nav_entity_attribs[attr]
+              expand_e[attr] = klass.output_template_deep(expand_list: expand_list[attr])
+            else
+              deferr << attr
+            end
+          end
+        end
+        if @nav_collection_attribs
+          selected_nav_c = @nav_collection_attribs.keys & select.props
+          selected_nav_c&.each do |attr|
+            if expand_list.key?(attr)
+              klass = @nav_collection_attribs[attr]
+              expand_c[attr] = klass.output_template_deep(expand_list: expand_list[attr])
+            else
+              deferr << attr
+            end
+          end
+        end
+      end
+      template[:expand_e] = expand_e if expand_e
+      template[:expand_c] = expand_c if expand_c
+      template[:deferr] = deferr if deferr
+      template
     end
 
     def to_odata_json(service:)
+      template = output_template(@uparms)
       innerj = service.get_coll_odata_h(array: get_a,
-                                        expand: @params['$expand'],
+                                        template: template,
                                         uribase: @uribase,
                                         icount: @inlinecount).to_json
-      "#{DJopen}#{innerj}#{DJclose}"
+      "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
     def get_a
-      @ax.nil? ? @cx.to_a : @ax
+      @cx.all
     end
 
     # this functionally similar to the Sequel Rels (many_to_one etc)
     # We need to base this on the Sequel rels, or extend them
     def add_nav_prop_collection(assoc_symb, attr_name_str = nil)
       @nav_collection_attribs = (@nav_collection_attribs || {})
-#      @assocs_to = ( @assocs_to || [] )
       # DONE: Error handling. This requires that associations
       # have been properly defined with Sequel before
       assoc = all_association_reflections.find do |a|
         a[:name] == assoc_symb && a[:model] == self
       end
-      unless assoc
-        raise OData::API::ModelAssociationNameError.new(self, assoc_symb)
-      end
+
+      raise OData::API::ModelAssociationNameError.new(self, assoc_symb) unless assoc
 
       attr_class = assoc[:class_name].constantize
       lattr_name_str = (attr_name_str || assoc_symb.to_s)
@@ -392,24 +448,29 @@ module OData
 
     def add_nav_prop_single(assoc_symb, attr_name_str = nil)
       @nav_entity_attribs = (@nav_entity_attribs || {})
-#      @assocs_to = ( @assocs_to || [])
       # DONE: Error handling. This requires that associations
       # have been properly defined with Sequel before
       assoc = all_association_reflections.find do |a|
         a[:name] == assoc_symb && a[:model] == self
       end
-      unless assoc
-        raise OData::API::ModelAssociationNameError.new(self, assoc_symb)
-      end
+
+      raise OData::API::ModelAssociationNameError.new(self, assoc_symb) unless assoc
 
       attr_class = assoc[:class_name].constantize
       lattr_name_str = (attr_name_str || assoc_symb.to_s)
       @nav_entity_attribs[lattr_name_str] = attr_class
       @nav_entity_url_regexp = @nav_entity_attribs.keys.join('|')
-#      attr_class.assocs_to = ( attr_class.assocs_to || [] )
-#      attr_class.assocs_to << assoc 
     end
 
+    EMPTYH = {}.freeze
+
+    def build_default_template
+      template = { all_values: EMPTYH }
+      if @nav_entity_attribs || @nav_collection_attribs
+        template[:deferr] = (@nav_entity_attribs&.keys || []) + (@nav_collection_attribs&.keys || EMPTY_ARRAY)
+      end
+      template
+    end
     # old names...
     #    alias_method :add_nav_prop_collection, :addNavCollectionAttrib
     #    alias_method :add_nav_prop_single, :addNavEntityAttrib
@@ -417,11 +478,14 @@ module OData
     def finalize_publishing
       # finalize media handler
       @media_handler.register(self) if @media_handler
-      
+
+      # build default output template structure
+      @default_template = build_default_template
+
       # and finally build the path list
       build_attribute_path_list
     end
-    
+
     def prepare_pk
       if primary_key.is_a? Array
         @pk_names = []
@@ -470,11 +534,7 @@ module OData
     def check_odata_val_type(val, type)
       case type
       when :integer
-        if (val =~ ONLY_INTEGER_RGX)
-          [true, Integer(val)]
-        else
-          [false, val]
-        end
+        val =~ ONLY_INTEGER_RGX ? [true, Integer(val)] : [false, val]
       when :string
         [true, val]
       else
@@ -535,7 +595,7 @@ module OData
       md.shift # remove first element which is the whole match
       mdc = []
       error = false
-      primary_key.each_with_index { |pk, i|
+      primary_key.each_with_index do |pk, i|
         ck, casted = check_odata_val_type(md[i], db_schema[pk][:type])
         if ck
           mdc << casted
@@ -543,7 +603,7 @@ module OData
           error = true
           break
         end
-      }
+      end
       if error
         [false, md]
       else
@@ -573,7 +633,7 @@ module OData
         # validate payload column names
         if (invalid = invalid_hash_data?(data))
           ::OData::Request::ON_CGST_ERROR.call(req)
-          return [422, {}, ['Invalid attribute name: ', invalid.to_s]]
+          return [422, EMPTY_HASH, ['Invalid attribute name: ', invalid.to_s]]
         end
 
         if req.accept?(APPJSON)