safrano 0.5.3 → 0.6.0

data/lib/safrano/service.rb

@@ -5,6 +5,7 @@ require 'odata/relations'
 require 'odata/batch'
 require 'odata/complex_type'
 require 'odata/function_import'
+require 'safrano/type_mapping'
 require 'odata/error'
 require 'odata/filter/sequel'
 require 'set'
@@ -138,6 +139,7 @@ module Safrano
     attr_accessor :complex_types
     attr_accessor :function_imports
     attr_accessor :function_import_keys
+    attr_accessor :type_mappings
 
     # Instance attributes for specialized Version specific Instances
     attr_accessor :v1
@@ -158,6 +160,9 @@ module Safrano
       @function_imports = {}
       @function_import_keys = []
       @cmap = {}
+      @type_mappings = {}
+      # enabled per default starting from 0.6
+      @bugfix_create_response = true
       instance_eval(&block) if block_given?
     end
 
@@ -206,9 +211,8 @@ module Safrano
       (@v2.xserver_url = @xserver_url) if @v2
     end
 
-    # keep the bug active for now, but allow to activate the fix,
-    # later we will change the default to be fixed
-    def bugfix_create_response(bool = false)
+    # keep the bug active for now, but allow to de-activate the fix
+    def bugfix_create_response(bool)
       @bugfix_create_response = bool
     end
 
@@ -242,6 +246,8 @@ module Safrano
       other.complex_types = @complex_types
       other.function_imports = @function_imports
       other.function_import_keys = @function_import_keys
+      other.type_mappings = @type_mappings
+      other.bugfix_create_response(@bugfix_create_response)
       other
     end
 
@@ -330,6 +336,11 @@ module Safrano
       funcimp
     end
 
+    def with_db_type(*dbtypnams, &proc)
+      m = TypeMapping.builder(*dbtypnams, &proc)
+      @type_mappings[m.db_types_rgx] = m
+    end
+
     def cmap=(imap)
       @cmap = imap
       set_collections_sorted(@cmap.values)
@@ -343,10 +354,10 @@ module Safrano
       @collections.sort_by! { |klass| klass.entity_set_name.size }.reverse! if @collections
       @collections
     end
-    
+
     # need to be sorted by size too
     def set_funcimports_sorted
-      @function_import_keys.sort_by!{|k| k.size}.reverse!
+      @function_import_keys.sort_by! { |k| k.size }.reverse!
     end
     # to be called at end of publishing block to ensure we get the right names
     # and additionally build the list of valid attribute path's used
@@ -370,16 +381,30 @@ module Safrano
 
       set_uribase
 
-      @collections.each(&:finalize_publishing)
-
       # finalize the uri's and include NoMappingBeforeOutput or MappingBeforeOutput as needed
       @collections.each do |klass|
+        klass.finalize_publishing(self)
+
         klass.build_uri(@uribase)
-        # TODO perf 
-        klass.include( (klass.time_cols.empty? && klass.decimal_cols.empty?) ? Safrano::NoMappingBeforeOutput : Safrano::MappingBeforeOutput)
 
         # Output create (POST) as single entity (Standard) or as array (non-standard buggy)
-        klass.include ( @bugfix_create_response ? Safrano::EntityCreateStandardOutput : Safrano::EntityCreateArrayOutput)
+        klass.include(@bugfix_create_response ? Safrano::EntityCreateStandardOutput : Safrano::EntityCreateArrayOutput)
+
+        # define the most optimal casted_values method for the given model(klass)
+        if klass.casted_cols.empty?
+          klass.send(:define_method, :casted_values) do |cols = nil|
+            cols ? selected_values_for_odata(cols) : values_for_odata
+          end
+        else
+          klass.send(:define_method, :casted_values) do |cols = nil|
+            # we need to dup the model values as we need to change it before passing to_json,
+            # but we dont want to interfere with Sequel's owned data
+            # (eg because then in worst case it could happen that we write back changed values to DB)
+            vals = cols ? selected_values_for_odata(cols) : values_for_odata.dup
+            self.class.casted_cols.each { |cc, lambda| vals[cc] = lambda.call(vals[cc]) if vals.key?(cc) }
+            vals
+          end
+        end
       end
 
       # build allowed transitions (requires that @collections are filled and sorted for having a
@@ -390,10 +415,16 @@ module Safrano
       case Sequel::Model.db.adapter_scheme
       when :postgres
         Safrano::Filter::FuncTree.include Safrano::Filter::FuncTreePostgres
+        Safrano::Filter::DateTimeLit.include Safrano::Filter::DateTimeDefault
+        Safrano::Filter::DateTimeOffsetLit.include Safrano::Filter::DateTimeDefault
       when :sqlite
         Safrano::Filter::FuncTree.include Safrano::Filter::FuncTreeSqlite
+        Safrano::Filter::DateTimeLit.include Safrano::Filter::DateTimeSqlite
+        Safrano::Filter::DateTimeOffsetLit.include Safrano::Filter::DateTimeSqlite
       else
         Safrano::Filter::FuncTree.include Safrano::Filter::FuncTreeDefault
+        Safrano::Filter::DateTimeLit.include Safrano::Filter::DateTimeDefault
+        Safrano::Filter::DateTimeOffsetLit.include Safrano::Filter::DateTimeDefault
       end
     end
 
@@ -505,8 +536,8 @@ module Safrano
       doc.add_element('edmx:Edmx', 'Version' => '1.0')
       doc.root.add_namespace('xmlns:edmx', XMLNS::MSFT_ADO_2007_EDMX)
       serv = doc.root.add_element('edmx:DataServices',
-      # TODO: export the real version (result from version negotions)
-      # but currently we support only v1 and v2, and most users will use v2
+                                  # TODO: export the real version (result from version negotions)
+                                  # but currently we support only v1 and v2, and most users will use v2
                                   'm:DataServiceVersion' => '2.0')
       # 'm:DataServiceVersion' => "#{self.dataServiceVersion}" )
       # DataServiceVersion: This attribute MUST be in the data service

data/lib/safrano/type_mapping.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+# Note: Safrano has hardcoded mapping rules for most of types.
+# But
+#   it might not be 100% complete
+#   it might not always do what is expected
+# The type mapping functionality here  allows Safrano users to design type mapping themselves
+# and fill or fix the two above issues
+module Safrano
+  # Base class
+  class TypeMapping
+    attr_reader :castfunc
+    attr_reader :db_types_rgx
+    attr_reader :edm_type
+
+    # wrapper to handle API
+    class Builder
+      attr_reader :xedm_type
+      attr_reader :castfunc
+      attr_reader :db_types_rgx
+      attr_reader :bui1
+      attr_reader :bui2
+
+      def initialize(*dbtyps)
+        @db_types_rgx = dbtyps.join('|')
+        @rgx = /\A\s*(?:#{@db_types_rgx})\s*\z/i
+      end
+
+      def edm_type(input)
+        @xedm_type = input
+      end
+
+      def with_one_param(lambda = nil, &proc)
+        proc1 = block_given? ? proc : lambda
+        @bui1 = Builder1Par.new(@db_types_rgx, proc1)
+      end
+
+      def with_two_params(lambda = nil, &proc)
+        proc2 = block_given? ? proc : lambda
+        @bui2 = Builder2Par.new(@db_types_rgx, proc2)
+      end
+
+      def json_value(lambda = nil, &proc)
+        @castfunc = block_given? ? proc : lambda
+      end
+
+      def match(curtyp)
+        if @bui2 && (m = @bui2.match(curtyp))
+          m
+        elsif @bui1 && (m = @bui1.match(curtyp))
+          m
+        elsif @rgx.match(curtyp)
+          type_mapping
+        end
+      end
+
+      def type_mapping
+        # TODO: perf; return always same object when called multiple times
+        FixedTypeMapping.new(self)
+      end
+    end # Builder
+
+    def self.builder(*dbtypnams, &proc)
+      builder = Builder.new(*dbtypnams)
+      builder.instance_eval(&proc)
+      builder
+    end
+
+    class Builder1Par < Builder
+      def initialize(db_ty_rgx, proc)
+        @db_types_rgx = db_ty_rgx
+        @proc = proc
+        @rgx = /\A\s*(?:#{@db_types_rgx})\s*\(\s*(\d+)\s*\)\z/i
+      end
+
+      def match(curtyp)
+        (@md = @rgx.match(curtyp)) ? type_mapping : nil
+      end
+
+      def json_value(lambda = nil, &proc)
+        @castfunc = block_given? ? proc : lambda
+      end
+
+      # this is a bit advanced/obscure programming
+      # the intance_exec here is required to produce correct results
+      # ie. it produces concrete instances of edm_type and json_val lambda
+      # for the later, it is kind of currying but with the *implicit* parameters
+      # from the calling context eg par1
+
+      # probably this is not best-practice programing as we
+      # have a mutating object (the builder) that
+      # produces different lambdas after each type_mapping(mutation) calls
+      def type_mapping
+        p1val = @md[1]
+        instance_exec p1val, &@proc
+
+        TypeMapping1Par.new(self)
+      end
+    end
+    class Builder2Par < Builder
+      def initialize(db_ty_rgx, proc)
+        @db_types_rgx = db_ty_rgx
+        @proc = proc
+        @rgx = /\A\s*(?:#{@db_types_rgx})\s*\(\s*(\d+)\s*,\s*(\d+)\s*\)\s*\z/i
+      end
+
+      def match(curtyp)
+        (@md = @rgx.match(curtyp)) ? type_mapping : nil
+      end
+
+      # this is a bit advanced/obscure programming
+      # the intance_exec here is required to produce correct results
+      # ie. it produces concrete instances of edm_type and json_val lambda
+      # for the later, it is kind of currying but with the *implicit* parameters
+      # from the calling context eg par1 and par2
+
+      # probably this is not best-practice programing as we
+      # have a mutating object (the builder) that
+      # produces different lambdas after each type_mapping(mutation) calls
+      def type_mapping
+        p1val = @md[1]
+        p2val = @md[2]
+        instance_exec p1val, p2val, &@proc
+        TypeMapping2Par.new(self)
+      end
+    end
+  end
+
+  # Fixed type (ie. without variable parts)
+  class FixedTypeMapping < TypeMapping
+    def initialize(builder)
+      @edm_type = builder.xedm_type
+      @castfunc = builder.castfunc
+    end
+  end
+
+  class TypeMapping1Par < TypeMapping
+    def initialize(builder)
+      @edm_type = builder.xedm_type
+      @castfunc = builder.castfunc
+    end
+  end
+  class TypeMapping2Par < TypeMapping
+    def initialize(builder)
+      @edm_type = builder.xedm_type
+      @castfunc = builder.castfunc
+    end
+  end
+end

data/lib/safrano/version.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 module Safrano
-  VERSION = '0.5.3'
+  VERSION = '0.6.0'
 end

data/lib/safrano.rb

@@ -14,9 +14,12 @@ require_relative 'odata/entity'
 require_relative 'odata/attribute'
 require_relative 'odata/navigation_attribute'
 require_relative 'odata/model_ext'
+require_relative 'odata/request/json'
 require_relative 'safrano/service'
 require_relative 'odata/walker'
 require 'sequel'
 require_relative 'safrano/sequel_join_by_paths'
 require_relative 'safrano/rack_app'
 require_relative 'safrano/rack_builder'
+
+Sequel.extension :named_timezones

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safrano
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - oz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-10 00:00:00.000000000 Z
+date: 2022-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rfc2047
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -53,33 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.15'
 - !ruby/object:Gem::Dependency
-  name: rfc2047
+  name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: tzinfo-data
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -108,23 +136,31 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.51'
-description: Safrano is an OData server library based on Ruby Sequel and Rack.
+description: 'Safrano is an OData server library '
 email: dev@aithscel.eu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/core_ext/Date/format.rb
+- lib/core_ext/DateTime/format.rb
 - lib/core_ext/Dir/iter.rb
 - lib/core_ext/Hash/transform.rb
 - lib/core_ext/Integer/edm.rb
+- lib/core_ext/Numeric/convert.rb
 - lib/core_ext/REXML/Document/output.rb
 - lib/core_ext/String/convert.rb
 - lib/core_ext/String/edm.rb
+- lib/core_ext/Time/format.rb
+- lib/core_ext/date.rb
+- lib/core_ext/datetime.rb
 - lib/core_ext/dir.rb
 - lib/core_ext/hash.rb
 - lib/core_ext/integer.rb
+- lib/core_ext/numeric.rb
 - lib/core_ext/rexml.rb
 - lib/core_ext/string.rb
+- lib/core_ext/time.rb
 - lib/odata/attribute.rb
 - lib/odata/batch.rb
 - lib/odata/collection.rb
@@ -141,6 +177,7 @@ files:
 - lib/odata/filter/error.rb
 - lib/odata/filter/parse.rb
 - lib/odata/filter/sequel.rb
+- lib/odata/filter/sequel_datetime_adapter.rb
 - lib/odata/filter/sequel_function_adapter.rb
 - lib/odata/filter/token.rb
 - lib/odata/filter/tree.rb
@@ -148,6 +185,7 @@ files:
 - lib/odata/model_ext.rb
 - lib/odata/navigation_attribute.rb
 - lib/odata/relations.rb
+- lib/odata/request/json.rb
 - lib/odata/select.rb
 - lib/odata/transition.rb
 - lib/odata/url_parameters.rb
@@ -164,6 +202,7 @@ files:
 - lib/safrano/response.rb
 - lib/safrano/sequel_join_by_paths.rb
 - lib/safrano/service.rb
+- lib/safrano/type_mapping.rb
 - lib/safrano/version.rb
 - lib/sequel/plugins/join_by_paths.rb
 homepage: https://gitlab.com/dm0da/safrano
@@ -192,5 +231,5 @@ requirements: []
 rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
-summary: Safrano is an OData server library based on Ruby Sequel and Rack
+summary: Safrano is an OData server library
 test_files: []