safrano 0.4.1 → 0.4.2

data/lib/safrano/core.rb

@@ -2,6 +2,15 @@
 
 # our main namespace
 module OData
+  # frozen empty Array/Hash to reduce unncecessary object creation
+  EMPTY_ARRAY = [].freeze
+  EMPTY_HASH = {}.freeze
+  EMPTY_HASH_IN_ARY = [EMPTY_HASH].freeze
+  EMPTY_STRING = ''.freeze
+  ARY_204_EMPTY_HASH_ARY = [204, EMPTY_HASH, EMPTY_ARRAY].freeze
+  SPACE = ' '.freeze
+  COMMA = ','.freeze
+
   # some prominent constants... probably already defined elsewhere eg in Rack
   # but lets KISS
   CONTENT_TYPE = 'Content-Type'.freeze
@@ -32,7 +41,7 @@ module OData
   # database-specific types.
   DB_TYPE_STRING_RGX = /\ACHAR\s*\(\d+\)\z/.freeze
 
-# TODO... complete; used in $metadata
+  # TODO... complete; used in $metadata
   def self.get_edm_type(db_type:)
     case db_type.upcase
     when 'INTEGER'

data/lib/safrano/multipart.rb

@@ -6,6 +6,9 @@ require 'webrick/httpstatus'
 
 # Simple multipart support for OData $batch purpose
 module MIME
+  CTT_TYPE_LC = 'content-type'.freeze
+  TEXT_PLAIN = 'text/plain'.freeze
+
   # a mime object has a header(with content-type etc) and a content(aka body)
   class Media
     # Parser for MIME::Media
@@ -56,7 +59,7 @@ module MIME
 
         #        elsif CRLF_LINE_RGX =~ line
         elsif CRLF == line
-          @target_ct = @target_hd['content-type'] || 'text/plain'
+          @target_ct = @target_hd[CTT_TYPE_LC] || TEXT_PLAIN
           @state = new_content
 
         end
@@ -100,8 +103,8 @@ module MIME
       end
 
       def hook_multipart(content_type, boundary)
-        @target_hd['content-type'] = content_type
-        @target_ct = @target_hd['content-type']
+        @target_hd[CTT_TYPE_LC] = content_type
+        @target_ct = @target_hd[CTT_TYPE_LC]
         @target = multipart_content(boundary)
         @target.hd = @target_hd
         @target.ct = @target_ct
@@ -114,10 +117,8 @@ module MIME
       APP_HTTP = 'application/http'.freeze
       def new_content
         @target =
-          if @target_ct.start_with?(MPS) and
-             (md = ((MP_RGX1.match(@target_ct[10..-1])) ||
-                      (MP_RGX2.match(@target_ct[10..-1])))
-             )
+          if @target_ct.start_with?(MPS) &&
+             (md = (MP_RGX1.match(@target_ct[10..-1]) || MP_RGX2.match(@target_ct[10..-1])))
             multipart_content(md[2].strip)
           elsif @target_ct.start_with?(APP_HTTP)
             MIME::Content::Application::Http.new
@@ -243,8 +244,8 @@ module MIME
           @hd = {}
           @content = ''
           # set default values. Can be overwritten by parser
-          @hd['content-type'] = 'text/plain'
-          @ct = 'text/plain'
+          @hd[CTT_TYPE_LC] = TEXT_PLAIN
+          @ct = TEXT_PLAIN
           @parser = Parser.new(self)
         end
 
@@ -364,7 +365,7 @@ module MIME
         end
 
         def set_multipart_header
-          @hd['content-type'] = "#{OData::MP_MIXED}; boundary=#{@boundary}"
+          @hd[CTT_TYPE_LC] = "#{OData::MP_MIXED}; boundary=#{@boundary}"
         end
 
         def get_http_resp(batcha)
@@ -382,9 +383,7 @@ module MIME
             # of the changes
             batcha.db.transaction do
               begin
-                @response.content = @content.map { |part|
-                  part.get_response(batcha)
-                }
+                @response.content = @content.map { |part| part.get_response(batcha) }
               rescue Sequel::Rollback => e
                 # one of the changes of the changeset has failed
                 # --> provide a dummy empty response for the change-parts
@@ -413,10 +412,11 @@ module MIME
           b = ''
           unless bodyonly
             #            b << OData::CONTENT_TYPE << ': ' << @hd[OData::CTT_TYPE_LC] << CRLF
-            b << "#{OData::CONTENT_TYPE}: #{@hd[OData::CTT_TYPE_LC]}#{CRLF}"
+            b << "#{OData::CONTENT_TYPE}: #{@hd[CTT_TYPE_LC]}#{CRLF}"
           end
-          b << "#{CRLF}--#{@boundary}#{CRLF}"
-          b << @content.map(&:unparse).join("#{CRLF}--#{@boundary}#{CRLF}")
+
+          b << crbdcr = "#{CRLF}--#{@boundary}#{CRLF}"
+          b << @content.map(&:unparse).join(crbdcr)
           b << "#{CRLF}--#{@boundary}--#{CRLF}"
           b
         end

data/lib/safrano/rack_app.rb

@@ -14,7 +14,7 @@ module OData
       x = if @walker.status == :end
             headers.delete('Content-Type')
             @response.headers.delete('Content-Type')
-            [200, {}, '']
+            [200, EMPTY_HASH, '']
           else
             odata_error
           end
@@ -70,7 +70,7 @@ module OData
     end
 
     def odata_head
-      [200, {}, ['']]
+      [200, EMPTY_HASH, [EMPTY_STRING]]
     end
   end
 
@@ -119,7 +119,7 @@ module OData
 
     def dispatch
       req_ret = if @request.request_method !~ METHODS_REGEXP
-                  [404, {}, ['Did you get lost?']]
+                  [404, EMPTY_HASH, ['Did you get lost?']]
                 elsif @request.request_method == 'HEAD'
                   odata_head
                 else

data/lib/safrano/request.rb

@@ -134,14 +134,14 @@ module OData
 
     def with_media_data
       if (filename = @env['HTTP_SLUG'])
-        
-        yield @env['rack.input'], 
+
+        yield @env['rack.input'],
                content_type.split(';').first,
                Rfc2047.decode(filename)
 
       else
         ON_CGST_ERROR.call(self)
-        return [400, {}, ['File upload error: Missing SLUG']]
+        [400, EMPTY_HASH, ['File upload error: Missing SLUG']]
       end
     end
 
@@ -152,15 +152,15 @@ module OData
           data = JSON.parse(body.read)
         rescue JSON::ParserError => e
           ON_CGST_ERROR.call(self)
-          return [400, {}, ['JSON Parser Error while parsing payload : ',
-                            e.message]]
+          return [400, EMPTY_HASH, ['JSON Parser Error while parsing payload : ',
+                                    e.message]]
         end
 
         yield data
 
       else # TODO: other formats
 
-        [415, {}, []]
+        [415, EMPTY_HASH, EMPTY_ARRAY]
       end
     end
 

data/lib/safrano/response.rb

@@ -34,7 +34,7 @@ module OData
 
       if drop_body?
         close
-        result = []
+        result = EMPTY_ARRAY
       end
 
       if calculate_content_length?

data/lib/safrano/service.rb

@@ -21,20 +21,22 @@ module OData
         # TODO: check errorhandling
         raise OData::ServerError if cur_exp.nil?
 
-        k = cur_exp.to_sym
+        k_s = cur_exp
+
       else
-        k = exp_one.strip.to_sym
+        k_s = exp_one.strip
         rest_exp = nil
       end
-      yield k, rest_exp
+      k = k_s.to_sym
+      yield k, k_s, rest_exp
     end
 
     # default v2
     # overriden in ServiceV1
-    def get_coll_odata_h(array:, expand: nil, uribase:, icount: nil)
+    def get_coll_odata_h(array:, template:, uribase:, icount: nil)
       res = array.map do |w|
         get_entity_odata_h(entity: w,
-                           expand: expand,
+                           template: template,
                            uribase: uribase)
       end
       if icount
@@ -44,107 +46,55 @@ module OData
       end
     end
 
-    # for expand 1..n nav attributes
-    # actually same as  v1 get_coll_odata_h
-#    def get_expandcoll_odata_h(array:, expand: nil, uribase:, icount: nil)
-#      array.map do |w|
-#        get_entity_odata_h(entity: w,
-#                           expand: expand,
-#                           uribase: uribase)
-#      end
-#    end
-
-    # handle a single expand
-    def handle_entity_expand_one(entity:, exp_one:, nav_values_h:, nav_coll_h:,
-                                 uribase:)
-
-
-      split_entity_expand_arg(exp_one) do |first, rest_exp|
-         if ( entity.nav_values.has_key?(first) )
-          if (enval = entity.nav_values[first])
-            nav_values_h[first.to_s] = get_entity_odata_h(entity: enval,
-                                                        expand: rest_exp,
-                                                        uribase: uribase)
-          else
-# FK is NULL --> nav_value is nil --> return empty json          
-            nav_values_h[first.to_s] = {}
-          end                                              
-        elsif (encoll = entity.nav_coll[first])
-#           nav attributes that are a collection (x..n)
-           nav_coll_h[first.to_s] = get_coll_odata_h(array: encoll,
-                                                    expand: rest_exp,
-                                                    uribase: uribase)
-#          nav_coll_h[first.to_s] = get_expandcoll_odata_h(array: encoll,
-#                                                    expand: rest_exp,
-#                                                    uribase: uribase)
-
-
-        end
-      end
-    end
-
-    def handle_entity_expand(entity:, expand:, nav_values_h:,
-                             nav_coll_h:, uribase:)
-      expand.strip!
-      explist = expand.split(',')
-      # handle multiple expands
-      explist.each do |exp|
-        handle_entity_expand_one(entity: entity, 
-                                 exp_one: exp,
-                                 nav_values_h: nav_values_h,
-                                 nav_coll_h: nav_coll_h,
-                                 uribase: uribase)
-      end
-    end
-
-    def handle_entity_deferred_attribs(entity:, nav_values_h:,
-                                       nav_coll_h:, uribase:)
-      entity.nav_values.each_key do |ksy|
-        ks = ksy.to_s
-        next if nav_values_h.key?(ks)
-
-        nav_values_h[ks] = get_deferred_odata_h(entity: entity,
-                                                attrib: ks, uribase: uribase)
-      end
-      entity.nav_coll.each_key do |ksy|
-        ks = ksy.to_s
-        next if nav_coll_h.key?(ks)
-
-        nav_coll_h[ks] = get_deferred_odata_h(entity: entity, attrib: ks,
-                                              uribase: uribase)
-      end
-    end
-
     # handle $links ... Note: $expand seems to be ignored when $links
     # are  requested
     def get_entity_odata_link_h(entity:, uribase:)
       { uri: entity.uri(uribase) }
     end
 
-    def get_entity_odata_h(entity:, expand: nil, uribase:)
-      hres = entity.casted_values
-      hres['__metadata'] = entity.metadata_h(uribase: uribase)
-
-      nav_values_h = {}
-      nav_coll_h = {}
+    EMPTYH = {}.freeze
+    def get_entity_odata_h(entity:, template:, uribase:)
+      # start with metadata
+      hres = { '__metadata' => entity.metadata_h(uribase: uribase) }
 
-      # handle expanded nav attributes
-      unless expand.nil?
-        handle_entity_expand(entity: entity, expand: expand,
-                             nav_values_h: nav_values_h,
-                             nav_coll_h: nav_coll_h,
-                             uribase: uribase)
-      end
+      template.each do |elmt, arg|
+        case elmt
+        when :all_values
+          hres.merge! entity.casted_values
+        when :selected_vals
+          hres.merge! entity.casted_values(arg)
+        when :expand_e
 
-      # handle not expanded (deferred) nav attributes
-      handle_entity_deferred_attribs(entity: entity,
-                                     nav_values_h: nav_values_h,
-                                     nav_coll_h: nav_coll_h,
-                                     uribase: uribase)
-      # merge  ...
-      hres.merge!(nav_values_h)
-      hres.merge!(nav_coll_h)
+          arg.each do |attr, templ|
+            enval = entity.send(attr)
+            hres[attr] = if enval
 
+                           get_entity_odata_h(entity: enval,
+                                              template: templ,
+                                              uribase: uribase)
+                         else
+                           # FK is NULL --> nav_value is nil --> return empty json
+                           EMPTYH
+                         end
+          end
+        when :expand_c
+          arg.each do |attr, templ|
+            next unless  (encoll = entity.send(attr))
+
+            #  nav attributes that are a collection (x..n)
+            hres[attr] = get_coll_odata_h(array: encoll,
+                                          template: templ,
+                                          uribase: uribase)
+            # else error ?
+          end
+        when :deferr
+          arg.each do |attr|
+            hres[attr] = get_deferred_odata_h(entity: entity,
+                                              attrib: attr,
+                                              uribase: uribase)
+          end
+        end
+      end
       hres
     end
   end
@@ -219,7 +169,7 @@ module OData
 
     DATASERVICEVERSION_RGX = /\A([1234])(?:\.0);*\w*\z/.freeze
     TRAILING_SLASH = %r{/\z}.freeze
-    DEFAULT_PATH_PREFIX = '/'
+    DEFAULT_PATH_PREFIX = '/'.freeze
 
     # input is the       DataServiceVersion request header string, eg.
     # '2.0;blabla' ---> Version -> 2
@@ -279,23 +229,20 @@ module OData
 
     def register_model(modelklass, entity_set_name = nil, is_media = false)
       # check that the provided klass is a Sequel Model
-      unless modelklass.is_a? Sequel::Model::ClassMethods
-        raise OData::API::ModelNameError, modelklass
-      end
+
+      raise(OData::API::ModelNameError, modelklass) unless modelklass.is_a? Sequel::Model::ClassMethods
 
       if modelklass.ancestors.include? OData::Entity
         # modules were already added previously;
         # cleanup state to avoid having data from previous calls
         # mostly usefull for testing (eg API)
         modelklass.reset
-      else # first API call... (normal non-testing case)
-        if modelklass.primary_key.is_a?(Array)
-          modelklass.extend OData::EntityClassMultiPK
-          modelklass.include OData::EntityMultiPK
-        else
-          modelklass.extend OData::EntityClassSinglePK
-          modelklass.include OData::EntitySinglePK
-        end
+      elsif modelklass.primary_key.is_a?(Array) # first API call... (normal non-testing case)
+        modelklass.extend OData::EntityClassMultiPK
+        modelklass.include OData::EntityMultiPK
+      else
+        modelklass.extend OData::EntityClassSinglePK
+        modelklass.include OData::EntitySinglePK
       end
       # Media/Non-media
       if is_media
@@ -345,9 +292,7 @@ module OData
     # example: CrewMember must be matched before Crew otherwise we get error
     def set_collections_sorted(coll_data)
       @collections = coll_data
-      if @collections
-        @collections.sort_by! { |klass| klass.entity_set_name.size }.reverse!
-      end
+      @collections.sort_by! { |klass| klass.entity_set_name.size }.reverse! if @collections
       @collections
     end
 
@@ -369,9 +314,9 @@ module OData
       path_prefix(DEFAULT_PATH_PREFIX) unless @xpath_prefix
 
       @collections.each(&:finalize_publishing)
-      
-      #finalize the media handlers
-      @collections.each{|klass| }
+
+      # finalize the media handlers
+      @collections.each { |klass| }
     end
 
     def execute_deferred_iblocks
@@ -568,16 +513,16 @@ module OData
       end
     end
 
-    def get_coll_odata_h(array:, expand: nil, uribase:, icount: nil)
+    def get_coll_odata_h(array:, template:, uribase:, icount: nil)
       array.map do |w|
         get_entity_odata_h(entity: w,
-                           expand: expand,
+                           template: template,
                            uribase: uribase)
       end
     end
 
     def get_emptycoll_odata_h
-      [{}]
+      EMPTY_HASH_IN_ARY
     end
   end
 
@@ -599,7 +544,7 @@ module OData
     end
 
     def get_emptycoll_odata_h
-      { 'results' => [{}] }
+      { 'results' => EMPTY_HASH_IN_ARY }
     end
   end