safrano 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6397b8b41d6241576f613abfa0e36c8f6973fa96542b60d388b15954aaa3a92b
-  data.tar.gz: 3f36fe0d18bd9659d4e3ce27f501ef1540e82f24a26418c28760aae869de85d9
+  metadata.gz: 497482614bfc6a87f8a42b9378a4fc8099ddb5b4f180d747b3717a6952f027b0
+  data.tar.gz: cd5236302671643fd9fbd9bcd200034f305ce7069e5d56ab2db2225dcfb4ce87
 SHA512:
-  metadata.gz: f6f666fb8e2fb136fe7ca0c215e19c24648d9a1a4494c3cdb1a53f45561cf827c2670be56bcf74005828b3a9ebf78e2efc63e8b89db35fefb9f70d4c730e7ebb
-  data.tar.gz: 2cdfe6b8cb732184dacb256e5c114361f41da91f5a0f821c2f61a5b7ae541b0aa8f5ad45b23598c0d5301311c193f9f6e51d6e8b8def7eac78a54176f92cfd98
+  metadata.gz: 4415ca4dc24362f3c179f0cc40f1d73fac6fb7207c0571ef63f1af318fc345e0be8043d8aa1b5ab48e0ead1f5c904dcab07b84061b3ca47f6b7d3c38696d4ae8
+  data.tar.gz: 6646d12aadb3827b43c013a3da6c6223d072e5676f8676eac0db59ad8e3ac80d1a64ceb0f5e87d52bb75e5b556eecda701e2d473c4bdd3b650cb680b6ce19b96

data/lib/odata/attribute.rb

@@ -13,15 +13,14 @@ module OData
     end
 
     def value
-      # WARNING; this code is duplicated in entity.rb
-      # (and the inverted transformation is in test/client.rb)
-      # will require a more systematic solution some day
-      # WARNING 2... this require more work to handle the timezones topci
+      # WARNING ... this require more work to handle the timezones topci
       # currently it is just set to make some minimal testcase work
       case (v = @entity.values[@name.to_sym])
       when Time
         # try to get back the database time zone and value
-        (v + v.gmt_offset).utc.to_datetime
+        #        (v + v.gmt_offset).utc.to_datetime
+        v.iso8601
+
       else
         v
       end
@@ -57,9 +56,11 @@ module OData
         [self, :end_with_value]
       end
 
+      ALLOWED_TRANSITIONS = [Safrano::TransitionEnd,
+                             Safrano::TransitionValue].freeze
+
       def allowed_transitions
-        [Safrano::TransitionEnd,
-         Safrano::TransitionValue]
+        ALLOWED_TRANSITIONS
       end
     end
     include Transitions

data/lib/odata/collection.rb

@@ -55,6 +55,8 @@ module OData
     attr_reader :data_fields
     attr_reader :inlinecount
     attr_reader :default_template
+    attr_reader :uri
+    attr_reader :time_cols
 
     # Sequel associations pointing to this model. Sequel provides association
     # reflection information on the "from" side. But in some cases
@@ -90,7 +92,11 @@ module OData
     # the class-name is not the OData Type. In these subclass we redefine "type_name"
     # thus when we need the Odata type name, we shall use this method instead of just the collection class name
     def type_name
-      to_s
+      @type_name
+    end
+
+    def build_type_name
+      @type_name = to_s
     end
 
     # convention: default for entity_set_name is the type name
@@ -102,9 +108,15 @@ module OData
       # TODO: automatically reset all attributes?
       @deferred_iblock = nil
       @entity_set_name = nil
+      @uri = nil
       @uparms = nil
       @params = nil
       @cx = nil
+      @@time_cols = nil
+    end
+
+    def build_uri(uribase)
+      @uri = "#{uribase}/#{entity_set_name}"
     end
 
     def execute_deferred_iblock
@@ -159,15 +171,7 @@ module OData
     end
 
     def odata_get_apply_params
-      begin
-        @cx = @uparms.apply_to_dataset(@cx)
-      rescue OData::Filter::Parser::ErrorWrongColumnName
-        @error = BadRequestFilterParseError
-        return
-      rescue OData::Filter::Parser::ErrorFunctionArgumentType
-        @error = BadRequestFilterParseError
-        return
-      end
+      @cx = @uparms.apply_to_dataset(@cx)
       odata_get_inlinecount_w_sequel
 
       @cx = @cx.offset(@params['$skip']) if @params['$skip']
@@ -217,17 +221,19 @@ module OData
       @attribute_path_list = attribute_path_list
     end
 
-    def attribute_path_list(nodes = Set.new)
+    MAX_DEPTH = 6
+    def attribute_path_list(depth = 0)
+      ret = @columns.map(&:to_s)
       # break circles
-      return EMPTY_ARRAY if nodes.include?(entity_set_name)
+      return ret if depth > MAX_DEPTH
+
+      depth += 1
 
-      ret = @columns.map(&:to_s)
-      nodes.add entity_set_name
       @nav_entity_attribs&.each do |a, k|
-        ret.concat(k.attribute_path_list(nodes).map { |kc| "#{a}/#{kc}" })
+        ret.concat(k.attribute_path_list(depth).map { |kc| "#{a}/#{kc}" })
       end
       @nav_collection_attribs&.each do |a, k|
-        ret.concat(k.attribute_path_list(nodes).map { |kc| "#{a}/#{kc}" })
+        ret.concat(k.attribute_path_list(depth).map { |kc| "#{a}/#{kc}" })
       end
       ret
     end
@@ -267,15 +273,31 @@ module OData
       end
     end
 
+    # validation/error handling methods.
+    # normal processing is done in the passed proc
+
+    def with_validated_get(req)
+      begin
+        initialize_dataset
+        return yield unless (@error = check_url_params)
+      rescue OData::Filter::Parser::ErrorWrongColumnName
+        @error = BadRequestFilterParseError
+      rescue OData::Filter::Parser::ErrorFunctionArgumentType
+        @error = BadRequestFilterParseError
+      rescue OData::Filter::FunctionNotImplemented => e
+        @error = e.odata_error
+      rescue OData::Filter::Parser::ErrorInvalidFunction => e
+        @error = e.odata_error
+      end
+
+      @error.odata_get(req) if @error
+    end
+
     # on model class level we return the collection
     def odata_get(req)
       @params = req.params
-      @uribase = req.uribase
-      initialize_dataset
 
-      if (@error = check_url_params)
-        @error.odata_get(req)
-      else
+      with_validated_get(req) do
         odata_get_apply_params
         odata_get_output(req)
       end
@@ -340,8 +362,7 @@ module OData
     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,
+      innerj = service.get_coll_odata_links_h(array: @cx.all,
                                               icount: @inlinecount).to_json
       "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
@@ -417,17 +438,12 @@ module OData
 
     def to_odata_json(service:)
       template = output_template(@uparms)
-      innerj = service.get_coll_odata_h(array: get_a,
+      innerj = service.get_coll_odata_h(array: @cx.all,
                                         template: template,
-                                        uribase: @uribase,
                                         icount: @inlinecount).to_json
       "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
-    def get_a
-      @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)
@@ -476,14 +492,22 @@ module OData
     #    alias_method :add_nav_prop_single, :addNavEntityAttrib
 
     def finalize_publishing
+      build_type_name
+
       # 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
+      # Time columns
+      @time_cols = db_schema.select { |c, v| v[:type] == :datetime }.map { |c, v| c }
+
+      # and finally build the path list and allowed tr's
       build_attribute_path_list
+
+      build_allowed_transitions
+      build_entity_allowed_transitions
     end
 
     def prepare_pk
@@ -574,10 +598,38 @@ module OData
       end
 
       def allowed_transitions
-        [Safrano::TransitionEnd,
-         Safrano::TransitionCount,
-         Safrano::Transition.new(entity_id_url_regexp,
-                                 trans: 'transition_id')]
+        @allowed_transitions
+      end
+
+      def entity_allowed_transitions
+        @entity_allowed_transitions
+      end
+
+      def build_allowed_transitions
+        @allowed_transitions = [Safrano::TransitionEnd,
+                                Safrano::TransitionCount,
+                                Safrano::Transition.new(entity_id_url_regexp,
+                                                        trans: 'transition_id')].freeze
+      end
+
+      def build_entity_allowed_transitions
+        @entity_allowed_transitions = [
+          Safrano::TransitionEnd,
+          Safrano::TransitionCount,
+          Safrano::TransitionLinks,
+          Safrano::TransitionValue,
+          Safrano::Transition.new(transition_attribute_regexp, trans: 'transition_attribute')
+        ]
+        if (ncurgx = @nav_collection_url_regexp)
+          @entity_allowed_transitions <<
+            Safrano::Transition.new(%r{\A/(#{ncurgx})(.*)\z}, trans: 'transition_nav_collection')
+        end
+        if (neurgx = @nav_entity_url_regexp)
+          @entity_allowed_transitions <<
+            Safrano::Transition.new(%r{\A/(#{neurgx})(.*)\z}, trans: 'transition_nav_entity')
+        end
+        @entity_allowed_transitions.freeze
+        @entity_allowed_transitions
       end
     end
     include Transitions

data/lib/odata/entity.rb

@@ -8,33 +8,13 @@ module OData
   # this will be mixed in the  Model classes (subclasses of Sequel Model)
   module EntityBase
     attr_reader :params
-    attr_reader :uribase
 
     include EntityBase::NavigationInfo
 
     # methods related to transitions to next state (cf. walker)
     module Transitions
       def allowed_transitions
-        alltr = [
-          Safrano::TransitionEnd,
-          Safrano::TransitionCount,
-          Safrano::TransitionLinks,
-          Safrano::TransitionValue,
-          Safrano::Transition.new(self.class.transition_attribute_regexp,
-                                  trans: 'transition_attribute')
-        ]
-        if (ncurgx = self.class.nav_collection_url_regexp)
-          alltr <<
-            Safrano::Transition.new(%r{\A/(#{ncurgx})(.*)\z},
-                                    trans: 'transition_nav_collection')
-
-        end
-        if (neurgx = self.class.nav_entity_url_regexp)
-          alltr <<
-            Safrano::Transition.new(%r{\A/(#{neurgx})(.*)\z},
-                                    trans: 'transition_nav_entity')
-        end
-        alltr
+        self.class.entity_allowed_transitions
       end
 
       def transition_end(_match_result)
@@ -90,9 +70,11 @@ module OData
       @nav_coll
     end
 
-    def uri(uriba)
-      "#{uriba}/#{self.class.entity_set_name}(#{pk_uri})"
+    def uri
+      @odata_pk ||= "(#{pk_uri})"
+      "#{self.class.uri}#{@odata_pk}"
     end
+
     D = 'd'.freeze
     DJ_OPEN = '{"d":'.freeze
     DJ_CLOSE = '}'.freeze
@@ -101,15 +83,13 @@ module OData
     def to_odata_json(service:)
       template = self.class.output_template(@uparms)
       innerj = service.get_entity_odata_h(entity: self,
-                                          template: template,
-                                          uribase: @uribase).to_json
+                                          template: template).to_json
       "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
     # Json formatter for a single entity reached by navigation $links
     def to_odata_onelink_json(service:)
-      innerj = service.get_entity_odata_link_h(entity: self,
-                                               uribase: @uribase).to_json
+      innerj = service.get_entity_odata_link_h(entity: self).to_json
       "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
@@ -120,36 +100,10 @@ module OData
       selvals
     end
 
-    # needed for proper datetime output
-    # TODO: design/performance
-    def casted_values(cols = nil)
-      vals = case cols
-             when nil
-               values_for_odata
-             else
-               selected_values_for_odata(cols)
-             end
-
-      # WARNING; this code is duplicated in attribute.rb
-      # (and the inverted transformation is in test/client.rb)
-      # will require a more systematic solution some day
-
-      vals.transform_values! do |v|
-        case v
-        when Time
-          # try to get back the database time zone and value
-          (v + v.gmt_offset).utc.to_datetime
-        else
-          v
-        end
-      end
-    end
-
     # post paylod expects the new entity in an array
     def to_odata_post_json(service:)
       innerj = service.get_coll_odata_h(array: [self],
-                                        template: self.class.default_template,
-                                        uribase: @uribase).to_json
+                                        template: self.class.default_template).to_json
       "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
@@ -159,7 +113,6 @@ module OData
 
     def copy_request_infos(req)
       @params = req.params
-      @uribase = req.uribase
       @do_links = req.walker.do_links
       @uparms = UrlParameters4Single.new(@params)
     end
@@ -227,7 +180,6 @@ module OData
         odata_media_value_put(req)
       elsif req.accept?(APPJSON)
         data = JSON.parse(req.body.read)
-        @uribase = req.uribase
         data.delete('__metadata')
 
         if req.in_changeset
@@ -255,8 +207,6 @@ module OData
         # TODO: check values/types
 
         my_data_fields = self.class.data_fields
-        @uribase = req.uribase
-        #      if req.accept?('application/json')
 
         if req.in_changeset
           set_fields(data, my_data_fields, missing: :skip)
@@ -302,14 +252,30 @@ module OData
         superclass.type_name
       end
 
+      def time_cols
+        superclass.time_cols
+      end
+
       def media_handler
         superclass.media_handler
       end
 
+      def uri
+        superclass.uri
+      end
+
       def default_template
         superclass.default_template
       end
 
+      def allowed_transitions
+        superclass.allowed_transitions
+      end
+
+      def entity_allowed_transitions
+        superclass.entity_allowed_transitions
+      end
+
       def to_a
         y = @child_method.call
         y.to_a
@@ -364,13 +330,13 @@ module OData
 
   module NonMediaEntity
     # non media entity metadata for json h
-    def metadata_h(uribase:)
-      {   uri: uri(uribase),
+    def metadata_h
+      {   uri: uri,
           type: type_name }
     end
 
     def values_for_odata
-      values.dup
+      values
     end
 
     def odata_delete(req)
@@ -398,23 +364,53 @@ module OData
     end
   end
 
+  module MappingBeforeOutput
+    # needed for proper datetime output
+    def casted_values(cols = nil)
+      vals = case cols
+             when 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)
+               values_for_odata.dup
+             else
+               selected_values_for_odata(cols)
+        end
+      self.class.time_cols.each { |tc| vals[tc] = vals[tc]&.iso8601 if vals.key?(tc) }
+      vals
+    end
+  end
+  module NoMappingBeforeOutput
+    # current model does not have eg. Time fields--> no special mapping, just to_json is fine
+    # --> we can use directly the model.values (values_for_odata) withoud dup'ing it as we dont
+    # need to change it, just output as is
+    def casted_values(cols = nil)
+      case cols
+      when nil
+        values_for_odata
+      else
+        selected_values_for_odata(cols)
+        end
+    end
+  end
+
   module MediaEntity
     # media entity metadata for json h
-    def metadata_h(uribase:)
-      {   uri: uri(uribase),
+    def metadata_h
+      {   uri: uri,
           type: type_name,
-          media_src: media_src(uribase),
-          edit_media: edit_media(uribase),
+          media_src: media_src,
+          edit_media: edit_media,
           content_type: @values[:content_type] }
     end
 
-    def media_src(uribase)
+    def media_src
       version = self.class.media_handler.ressource_version(self)
-      "#{uri(uribase)}/$value?version=#{version}"
+      "#{uri}/$value?version=#{version}"
     end
 
-    def edit_media(uribase)
-      "#{uri(uribase)}/$value"
+    def edit_media
+      "#{uri}/$value"
     end
 
     # directory where to put/find the media files for this entity-type