safrano 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb412667db93e26340fc21440c89572fbff42fe52ae36807614f0fd11aac808c
-  data.tar.gz: 90883acded679aa860346e49242b1149933ccdb474e3e39eb6a893da5958dde7
+  metadata.gz: 26b1634021c6ab2117b0b2fe4fb8c49242d4a045b6afafec604ef61e26c3bc48
+  data.tar.gz: 86adac4fb2ab8ad02d570f373325b7e1c4945941a01e2328fc50ff10c9460abd
 SHA512:
-  metadata.gz: f66a01241685f18493d0519cb009674f0764e260ccc79b048ebc7346b5d4c64bd78deeb9983a0b4893e4fcfc2d1361f7024ca212bcbdc8071191417e793d9427
-  data.tar.gz: 85e2cdd6c5c65e52f882fe2e8386cdf772c239ecdf27d979d473170f51bb1c0a37d8919cb8fc7422bb04eadf50baa8adb1ad4e712ea3952d3e2c0f7d9923bd48
+  metadata.gz: c19b30f23c22127742d8c557a23feec6de75a91d20b1b8b0033fb85e4f1549e92de300e17cb3d80564f92ed0dcd81096b5b4aca1a268eba803b6bbd6a4c0a75c
+  data.tar.gz: ee3a9d73e9e1d5862cb1a699786e9f81c5a58d7937678b5a138eecae08ccc10e49248f70066ede55e270fb361744978ca4b5b9a75bbd6e62a2c4685e6fc2ae46

data/lib/core_ext/Date/format.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Safrano
+  module CoreExt
+    module Date
+      module Format
+        # Date is a DateTime with time 00:00:00 thus the milliseconds are ALWAYS 000
+        # excepted when we get Date(0)  = Epoch date
+        REGEX = /\/Date\((?:(-?\d+)000|0+)\)\//.freeze
+        # Input:   /Date(86400000)/
+        # Match groups
+        # 1.	86400
+        # Input:   /Date(0)/
+        # Match groups
+        # 1.
+
+        def from_edm_json(instr)
+          return unless (md = instr.match(REGEX))
+
+          if md[1].nil? # no offset relative to Epoch
+            ::Date.new(1970, 1, 1).freeze
+          else
+            # parse as seconds since epoch
+            ::Date.strptime(md[1], '%s')
+          end
+        end
+      end
+    end
+  end
+  module CoreIncl
+    module Date
+      module Format
+        # https://www.odata.org/documentation/odata-version-2-0/json-format/
+        # Edm.DateTime
+        # "/Date(<ticks>["+" | "-" <offset>)/"
+        #                      <ticks> = number of milliseconds since midnight Jan 1, 1970
+        #                      <offset> = number of minutes to add or subtract
+        # https://stackoverflow.com/questions/10286204/what-is-the-right-json-date-format/10286228#10286228
+        def to_edm_json
+          # no offset
+          # --> %Q milliseconds since epoch
+          strftime('/Date(%Q)/')
+        end
+      end
+    end
+  end
+end

data/lib/core_ext/DateTime/format.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Safrano
+  module CoreExt
+    module DateTime
+      module Format
+        REGEX = /\/Date\((-?\d+)(?:([-+])(\d+))?\)\//.freeze
+        # Input:   /Date(120000+150)/
+        # Match groups
+        # 1.	120000
+        # 2.	+
+        # 3.	150
+
+        def from_edm_json(instr)
+          return unless (md = instr.match(REGEX))
+
+          if md[3].nil? # no offset
+            ::DateTime.strptime(md[1], '%Q')
+          else
+            # offset in hours / mins
+            off_h, off_m = md[3].to_i.divmod(60)
+            # DateTime.strptime("120000+2:30", '%Q%z')   milliseconds since epoch with a z-offset
+            # --> #<DateTime: 1970-01-01T02:32:00+02:30 ((2440588j,120s,0n),+9000s,2299161j)>
+            ::DateTime.strptime("#{md[1]}#{md[2]}#{off_h}:#{off_m}", '%Q%z')
+          end
+        end
+      end
+    end
+  end
+  module CoreIncl
+    module DateTime
+      module Format
+        # https://www.odata.org/documentation/odata-version-2-0/json-format/
+        # Edm.DateTime
+        # "/Date(<ticks>["+" | "-" <offset>)/"
+        #                      <ticks> = number of milliseconds since midnight Jan 1, 1970
+        #                      <offset> = number of minutes to add or subtract
+        # https://stackoverflow.com/questions/10286204/what-is-the-right-json-date-format/10286228#10286228
+        def to_edm_json
+          if offset.zero?
+            # no offset
+            # --> %Q milliseconds since epoch
+            strftime('/Date(%Q)/')
+          else
+            # same as above with GMT offset in minutes
+            # DateTime offset is Rational ; fraction of hours per Day --> *24*60
+            min_off_s = (min_off = (offset * 60 * 24).to_i) > 0 ? "+#{min_off}" : min_off.to_s
+            "/Date(#{strftime('%Q')}#{min_off_s})/"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/core_ext/Dir/iter.rb

@@ -5,13 +5,15 @@ module Safrano
   module CoreExt
     module Dir
       module Iter
-        def each_child(dir)
-          ::Dir.foreach(dir) do |x|
-            next if (x == '.') || (x == '..')
+        unless ::Dir.respond_to? :each_child
+          def each_child(dir)
+            ::Dir.foreach(dir) do |x|
+              next if (x == '.') || (x == '..')
 
-            yield x
+              yield x
+            end
           end
-        end unless ::Dir.respond_to? :each_child
+        end
       end
     end
   end

data/lib/core_ext/Hash/transform.rb

@@ -5,15 +5,23 @@ module Safrano
   module CoreIncl
     module Hash
       module Transform
-        def transform_keys!
-          keys.each do |key|
-            self[yield(key)] = delete(key)
+        unless method_defined? :transform_keys!
+          def transform_keys!
+            keys.each do |key|
+              self[yield(key)] = delete(key)
+            end
+            self
           end
-          self
-        end unless method_defined? :transform_keys!
+        end
 
         def symbolize_keys!
-          transform_keys! { |key| key.to_sym rescue key }
+          transform_keys! do |key|
+            begin
+                                    key.to_sym
+            rescue StandardError
+              key
+                                  end
+          end
         end
       end
     end

data/lib/core_ext/Numeric/convert.rb

@@ -17,7 +17,7 @@ module Safrano
 
         def toDecimalPrecisionScaleString(precision, scale)
           p = Integer(precision)
-          sprintf("%#{p + 2}.#{scale}f", self).strip
+          format("%#{p + 2}.#{scale}f", self).strip
         end
       end
     end

data/lib/core_ext/Time/format.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Safrano
+  module CoreExt
+    module Time
+      module Format
+        REGEX = /\/Date\((-?\d+)(?:([-+])(\d+))?\)\//.freeze
+        # Input:   /Date(120000+150)/
+        # Match groups
+        # 1.	120000
+        # 2.	+
+        # 3.	150
+
+        def from_edm_json(instr)
+          return unless (md = instr.match(REGEX))
+
+          sec, milli = md[1].to_i.divmod(1000)
+          secm = milli.zero? ? sec : sec + Float(milli) / 1000
+          if md[3].nil? # no offset
+            #            ::Time.at(sec, milli,  :millisecond)  # not supported in ruby 2.4
+            ::Time.gm(1970, 1, 1) + secm
+          else
+            # offset in hours / mins
+            off_h, off_m = md[3].to_i.divmod(60)
+            # add leading 0 because Time.at is expecting "+HH:MM", "-HH:MM"
+            off_h = off_h < 10 ? "0#{off_h}" : off_h.to_s
+            off_m = off_m < 10 ? "0#{off_m}" : off_m.to_s
+            # Time.strptime("120000+2:30", '%Q%z')   milliseconds since epoch with a z-offset
+            # --> #<DateTime: 1970-01-01T02:32:00+02:30 ((2440588j,120s,0n),+9000s,2299161j)>
+            # ::Time.at(sec, milli,  :millisecond, in: "#{md[2]}#{off_h}:#{off_m}") # not supported in ruby 2.4
+            offset_str = "#{md[2]}#{off_h}:#{off_m}"
+            ::Time.new(1970, 1, 1, 0, 0, 0, offset_str) + secm + ::Time.zone_offset(offset_str)
+          end
+        end
+      end
+    end
+  end
+
+  module CoreIncl
+    module Time
+      module Format
+        # Welcome to Hell
+        # https://www.odata.org/documentation/odata-version-2-0/json-format/
+        # Edm.DateTime
+        # "/Date(<ticks>["+" | "-" <offset>)/"
+        #                      <ticks> = number of milliseconds since midnight Jan 1, 1970
+        #                      <offset> = number of minutes to add or subtract
+        # https://stackoverflow.com/questions/10286204/what-is-the-right-json-date-format/10286228#10286228
+        # also https://www.hanselman.com/blog/on-the-nightmare-that-is-json-dates-plus-jsonnet-and-aspnet-web-api
+        # and https://itecnote.com/tecnote/c-use-json-net-to-parse-json-date-of-format-dateepochtime-offset/
+        # https://docs.microsoft.com/de-de/dotnet/standard/datetime/system-text-json-support
+        # https://docs.microsoft.com/en-us/dotnet/framework/wcf/feature-details/stand-alone-json-serialization#datestimes-and-json
+        # https://blogs.sap.com/2017/01/05/date-and-time-in-sap-gateway-foundation/
+        def to_edm_json
+          if utc? || (gmt_offset == 0)
+            # no offset
+            # %s : seconds since unix epoch
+            # %L : milliseconds 000-999
+            # --> %S%L milliseconds since epoch
+            strftime('/Date(%s%L)/')
+          else
+            # same as above with GMT offset in minutes
+
+            min_off_s = (min_off = gmt_offset / 60) > 0 ? "+#{min_off}" : min_off.to_s
+            "/Date(#{strftime('%s%L')}#{min_off_s})/"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/core_ext/date.rb

@@ -0,0 +1,5 @@
+require_relative 'Date/format'
+require 'date'
+
+Date.include Safrano::CoreIncl::Date::Format
+Date.extend Safrano::CoreExt::Date::Format

data/lib/core_ext/datetime.rb

@@ -0,0 +1,5 @@
+require_relative 'DateTime/format'
+require 'date'
+
+DateTime.include Safrano::CoreIncl::DateTime::Format
+DateTime.extend Safrano::CoreExt::DateTime::Format

data/lib/core_ext/time.rb

@@ -0,0 +1,5 @@
+require_relative 'Time/format'
+require 'time'
+
+Time.include Safrano::CoreIncl::Time::Format
+Time.extend Safrano::CoreExt::Time::Format

data/lib/odata/attribute.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'json'
-require_relative '../safrano/core.rb'
-require_relative './entity.rb'
+require_relative '../safrano/core'
+require_relative './entity'
 
 module Safrano
   # Represents a named and valued attribute of an Entity
@@ -18,12 +18,14 @@ module Safrano
     def value
       # WARNING ... this require more work to handle the timezones topci
       # currently it is just set to make some minimal testcase work
+      # See also model_ext.rb
       case (v = @entity.values[@name.to_sym])
+      when Date
+        v.to_edm_json
       when Time
-        # try to get back the database time zone and value
-        #        (v + v.gmt_offset).utc.to_datetime
-        v.iso8601
-
+        v.to_edm_json
+      when DateTime
+        v.to_edm_json
       else
         v
       end

data/lib/odata/batch.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative '../safrano/rack_app.rb'
-require_relative '../safrano/core.rb'
+require_relative '../safrano/rack_app'
+require_relative '../safrano/core'
 require 'rack/body_proxy'
-require_relative './common_logger.rb'
+require_relative './common_logger'
 
 module Safrano
   # Support for OData multipart $batch Requests

data/lib/odata/collection.rb

@@ -134,14 +134,14 @@ module Safrano
 
       # on model class level we return the collection
       def odata_get(req)
-        @params = @params || req.params
+        @params ||= req.params
         initialize_dataset
         initialize_uparms
-        @uparms.check_all.if_valid { |_ret|
-          odata_get_apply_params.if_valid { |_ret|
+        @uparms.check_all.if_valid do |_ret|
+          odata_get_apply_params.if_valid do |_ret|
             odata_get_output(req)
-          }
-        }.tap_error { |e| return e.odata_get(req) }.result
+          end
+        end.tap_error { |e| return e.odata_get(req) }.result
       end
 
       def odata_post(req)

data/lib/odata/collection_filter.rb

@@ -20,7 +20,9 @@ module Safrano
     end
 
     # finalize
-    def finalize(_jh) Contract::OK end
+    def finalize(_jh)
+      Contract::OK
+    end
 
     def empty?
       true

data/lib/odata/collection_media.rb

@@ -143,8 +143,8 @@ module Safrano
     # with directory Tree structure
 
     class StaticTree < Static
-      SEP = '/00/'.freeze
-      VERS = '/v'.freeze
+      SEP = '/00/'
+      VERS = '/v'
 
       def self.path_builder(ids)
         ids.map { |id| id.to_s.chars.join('/') }.join(SEP) << VERS
@@ -276,7 +276,7 @@ module Safrano
 
           media_handler.check_before_create(data: data,
                                             entity: new_entity,
-                                            filename: filename).if_valid { |_ret|
+                                            filename: filename).if_valid do |_ret|
             # to_one rels are create with FK data set on the parent entity
             if parent
               odata_create_save_entity_and_rel(req, new_entity, assoc, parent)
@@ -302,7 +302,7 @@ module Safrano
             #           Contract.valid([201, EMPTY_HASH, new_entity.to_odata_post_json(service: req.service)])
             # TODO quirks array mode !
             Contract.valid([201, EMPTY_HASH, new_entity.to_odata_create_json(request: req)])
-          }.tap_error { |e| return e.odata_get(req) }.result
+          end.tap_error { |e| return e.odata_get(req) }.result
 
         else # TODO: other formats
           415
@@ -311,26 +311,3 @@ module Safrano
     end
   end
 end
-
-# deprecated
-# REMOVE 0.6
-module OData
-  module Media
-    class Static < ::Safrano::Media::Static
-      def initialize(root: nil, mediaklass:)
-        ::Safrano::Deprecation.deprecate('OData::Media::Static',
-                                         'Use Safrano::Media::Static instead')
-
-        super
-      end
-    end
-    class StaticTree < ::Safrano::Media::StaticTree
-      def initialize(root: nil, mediaklass:)
-        ::Safrano::Deprecation.deprecate('OData::Media::StaticTree',
-                                         'Use Safrano::Media::StaticTree instead')
-
-        super
-      end
-    end
-  end
-end

data/lib/odata/collection_order.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'odata/error.rb'
+require 'odata/error'
 
 # all ordering related classes in our OData module
 module Safrano

data/lib/odata/common_logger.rb

@@ -10,36 +10,14 @@ module Rack
     # Handle https://github.com/rack/rack/pull/1526
     # new in Rack 2.2.2 : Format has now 11 placeholders instead of 10
 
-    MSG_FUNC = if FORMAT.count('%') == 10
+    MSG_FUNC = case FORMAT.count('%')
+               when 10
                  lambda { |env, length, status, began_at|
-                   FORMAT % [
-                     env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR'] || '-',
-                     env['REMOTE_USER'] || '-',
-                     Time.now.strftime('%d/%b/%Y:%H:%M:%S %z'),
-                     env[REQUEST_METHOD],
-                     env[SCRIPT_NAME] + env[PATH_INFO],
-                     env[QUERY_STRING].empty? ? '' : "?#{env[QUERY_STRING]}",
-                     env[SERVER_PROTOCOL],
-                     status.to_s[0..3],
-                     length,
-                     Utils.clock_time - began_at
-                   ]
+                   format(FORMAT, env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR'] || '-', env['REMOTE_USER'] || '-', Time.now.strftime('%d/%b/%Y:%H:%M:%S %z'), env[REQUEST_METHOD], env[SCRIPT_NAME] + env[PATH_INFO], env[QUERY_STRING].empty? ? '' : "?#{env[QUERY_STRING]}", env[SERVER_PROTOCOL], status.to_s[0..3], length, Utils.clock_time - began_at)
                  }
-               elsif FORMAT.count('%') == 11
+               when 11
                  lambda { |env, length, status, began_at|
-                   FORMAT % [
-                     env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR'] || '-',
-                     env['REMOTE_USER'] || '-',
-                     Time.now.strftime('%d/%b/%Y:%H:%M:%S %z'),
-                     env[REQUEST_METHOD],
-                     env[SCRIPT_NAME],
-                     env[PATH_INFO],
-                     env[QUERY_STRING].empty? ? '' : "?#{env[QUERY_STRING]}",
-                     env[SERVER_PROTOCOL],
-                     status.to_s[0..3],
-                     length,
-                     Utils.clock_time - began_at
-                   ]
+                   format(FORMAT, env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR'] || '-', env['REMOTE_USER'] || '-', Time.now.strftime('%d/%b/%Y:%H:%M:%S %z'), env[REQUEST_METHOD], env[SCRIPT_NAME], env[PATH_INFO], env[QUERY_STRING].empty? ? '' : "?#{env[QUERY_STRING]}", env[SERVER_PROTOCOL], status.to_s[0..3], length, Utils.clock_time - began_at)
                  }
                end
 

data/lib/odata/complex_type.rb

@@ -22,8 +22,8 @@ module Safrano
       end
 
       # we will have this on class and instance level for making things simpler first
-      def self.klassmod
-        @klassmod
+      class << self
+        attr_reader :klassmod
       end
 
       # return a subclass of ResultAsComplexType
@@ -88,8 +88,8 @@ module Safrano
       # 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)
+      def self.do_execute_func_result(result, _req, _apply_query_params = false)
+        new(result)
       end
     end
 
@@ -186,12 +186,12 @@ module Safrano
     EMPTYH = {}.freeze
 
     @namespace = nil
-    def self.namespace
-      @namespace
+    class << self
+      attr_reader :namespace
     end
 
-    def self.props
-      @props
+    class << self
+      attr_reader :props
     end
 
     def type_name
@@ -214,11 +214,9 @@ module Safrano
       expand_e = {}
 
       template[:all_values] = EMPTYH
-      @props.each { |prop, kl|
-        if kl.respond_to? :default_template
-          expand_e[prop] = kl.default_template
-        end
-      }
+      @props.each do |prop, kl|
+        expand_e[prop] = kl.default_template if kl.respond_to? :default_template
+      end
       template[:expand_e] = expand_e
       template
     end
@@ -228,7 +226,7 @@ module Safrano
     end
 
     def self.type_name
-      @namespace ? "#{@namespace}.#{self.to_s}" : self.to_s
+      @namespace ? "#{@namespace}.#{self}" : to_s
     end
 
     def initialize
@@ -240,13 +238,13 @@ module Safrano
     def odata_h
       ret = { METAK => { TYPEK => self.class.type_name } }
 
-      @values.each { |k, v|
+      @values.each do |k, v|
         ret[k] = if v.respond_to? :odata_h
                    v.odata_h
                  else
                    v
                  end
-      }
+      end
       ret
     end
 
@@ -272,14 +270,14 @@ module Safrano
     end
   end
 
-  def Safrano.ComplexType(**props)
+  def self.ComplexType(**props)
     Class.new(Safrano::ComplexType) do
       @props = props
-      props.each { |a, klassmod|
+      props.each do |a, _klassmod|
         asym = a.to_sym
-        define_method(asym) do @values[asym] end
-        define_method("#{a}=") do |val| @values[asym] = val end
-      }
+        define_method(asym) { @values[asym] }
+        define_method("#{a}=") { |val| @values[asym] = val }
+      end
       define_method :initialize do |*p, **kwvals|
         super()
         p.zip(props.keys).each { |val, a| @values[a] = val } if p

data/lib/odata/edm/primitive_types.rb

@@ -42,8 +42,8 @@ module Safrano
     metadata[:edm_type] = if (md = DB_TYPE_NUMDEC_RGX.match(props[:db_type]))
                             prec = md[4]
                             scale = md[6]
-                            if (scale && prec)
-                              if (scale == '0') # dont force default scale to 0 like SQL standard
+                            if scale && prec
+                              if scale == '0' # dont force default scale to 0 like SQL standard
                                 metadata[:edm_precision] = prec
                                 "Edm.Decimal(#{prec})"
                               else
@@ -116,7 +116,6 @@ module Safrano
                             'Edm.Decimal'
                           when :blob
                             'Edm.Binary'
-                          else
                           end
   end
 
@@ -142,12 +141,12 @@ module Safrano
       class Null < NilClass
         extend OutputClassMethods
         # nil --> null convertion is done by to_json
-        def self.odata_value(instance)
+        def self.odata_value(_instance)
           nil
         end
 
         def self.convert_from_urlparam(v)
-          return Contract::NOK unless (v == 'null')
+          return Contract::NOK unless v == 'null'
 
           Contract.valid(nil)
         end
@@ -167,7 +166,7 @@ module Safrano
       #  or false([nil, false])
       class Boolean < Object
         extend OutputClassMethods
-        def Boolean.odata_value(instance)
+        def self.odata_value(instance)
           instance ? true : false
         end
 
@@ -176,7 +175,7 @@ module Safrano
         end
 
         def self.convert_from_urlparam(v)
-          return Contract::NOK unless ['true', 'false'].include?(v)
+          return Contract::NOK unless %w[true false].include?(v)
 
           Contract.valid(v == 'true')
         end
@@ -188,7 +187,7 @@ module Safrano
         extend OutputClassMethods
 
         def self.convert_from_urlparam(v)
-          return Contract::NOK unless ((bytev = v.to_i) < 256)
+          return Contract::NOK unless (bytev = v.to_i) < 256
 
           Contract.valid(bytev)
         end
@@ -196,7 +195,7 @@ module Safrano
 
       class DateTime < ::DateTime
         extend OutputClassMethods
-        def DateTime.odata_value(instance)
+        def self.odata_value(instance)
           instance.to_datetime
         end
 
@@ -205,11 +204,9 @@ module Safrano
         end
 
         def self.convert_from_urlparam(v)
-          begin
-            Contract.valid(DateTime.parse(v))
-          rescue
-            return convertion_error(v)
-          end
+          Contract.valid(DateTime.parse(v))
+        rescue StandardError
+          convertion_error(v)
         end
       end
 
@@ -245,11 +242,9 @@ module Safrano
         extend OutputClassMethods
 
         def self.convert_from_urlparam(v)
-          begin
-            Contract.valid(v.to_f)
-          rescue
-            return Contract::NOK
-          end
+          Contract.valid(v.to_f)
+        rescue StandardError
+          Contract::NOK
         end
       end
     end