safrano 0.4.2 → 0.5.0

data/lib/odata/navigation_attribute.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'json'
-require_relative '../safrano/core.rb'
-require_relative './entity.rb'
+require_relative '../safrano/core'
+require_relative './entity'
 
-module OData
+module Safrano
   # remove the relation between entity and parent by clearing
   # the FK field(s) (if allowed)
   def self.remove_nav_relation(assoc, parent)
@@ -73,29 +75,15 @@ module OData
     end
   end
 
-  module EntityBase
-    module NavigationInfo
-      attr_reader :nav_parent
-      attr_reader :navattr_reflection
-      attr_reader :nav_name
-      def set_relation_info(parent, name)
-        @nav_parent = parent
-        @nav_name = name
-        @navattr_reflection = parent.class.association_reflections[name.to_sym]
-        @nav_klass = @navattr_reflection[:class_name].constantize
-      end
-    end
-  end
-
   # Represents a named but nil-valued navigation-attribute of an Entity
   # (usually resulting from a NULL FK db value)
   class NilNavigationAttribute
-    include EntityBase::NavigationInfo
+    include Safrano::NavigationInfo
     def odata_get(req)
       if req.walker.media_value
-        OData::ErrorNotFound.odata_get
+        Safrano::ErrorNotFound.odata_get
       elsif req.accept?(APPJSON)
-        [200, CT_JSON, to_odata_json(service: req.service)]
+        [200, EMPTY_HASH, to_odata_json(service: req.service)]
       else # TODO: other formats
         415
       end
@@ -111,13 +99,10 @@ module OData
 
     # create the nav. entity
     def odata_put(req)
-      #      if req.walker.raw_value
       # delegate to the class method
       @nav_klass.odata_create_entity_and_relation(req,
                                                   @navattr_reflection,
                                                   @nav_parent)
-      #      else
-      #      end
     end
 
     # empty output as OData json (v2)
@@ -133,16 +118,18 @@ module OData
     # methods related to transitions to next state (cf. walker)
     module Transitions
       def transition_end(_match_result)
-        [nil, :end]
+        Safrano::Transition::RESULT_END
       end
 
       def transition_value(_match_result)
         [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/relations.rb

@@ -1,9 +1,9 @@
-#!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'set'
 
 # OData relation related classes/module
-module OData
+module Safrano
   # we represent a relation as a Set (unordered) of two end elements
   class Relation < Set
     #    attr_reader :rid
@@ -20,7 +20,7 @@ module OData
 
     # we need a from/to order independant ID
     def rid
-      OData::RelationManager.build_id(self)
+      Safrano::RelationManager.build_id(self)
     end
 
     # we need a from/to order independant OData like name
@@ -76,11 +76,11 @@ module OData
     end
 
     def get(arg)
-      rid = OData::RelationManager.build_id(arg)
+      rid = Safrano::RelationManager.build_id(arg)
       if @list.key?(rid)
         @list[rid]
       else
-        rel = OData::Relation.new(arg)
+        rel = Safrano::Relation.new(arg)
         @list[rid] = rel
       end
     end

data/lib/odata/select.rb

@@ -1,8 +1,10 @@
-require 'odata/error.rb'
+# frozen_string_literal: true
+
+require 'odata/error'
 
 # all dataset selecting related classes in our OData module
 # ie  do eager loading
-module OData
+module Safrano
   # base class for selecting. We have to distinguish between
   # fields of the current entity, and the navigation properties
   # we can have one special case
@@ -12,12 +14,12 @@ module OData
   class SelectBase
     ALL = new # re-useable selecting-all handler
 
-    def self.factory(selectstr)
+    def self.factory(selectstr, model)
       case selectstr&.strip
       when nil, '', '*'
         ALL
       else
-        Select.new(selectstr)
+        Select.new(selectstr, model)
       end
     end
 
@@ -28,15 +30,25 @@ module OData
     def ALL.all_props?
       true
     end
+
+    def parse_error?
+      Contract::OK
+    end
   end
 
   # single select
   class Select < SelectBase
     COMASPLIT = /\s*,\s*/.freeze
     attr_reader :props
-    def initialize(selstr)
+
+    def initialize(selstr, model)
+      @model = model
       @selectp = selstr.strip
       @props = @selectp.split(COMASPLIT)
     end
+
+    def parse_error?
+      (invalids = @model.find_invalid_props(props.to_set)) ? BadRequestSelectInvalidProps.new(@model, invalids) : Contract::OK
+    end
   end
 end

data/lib/odata/transition.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+
+# our main namespace
+module Safrano
+  # represents a state transition when navigating/parsing the url path
+  # from left to right
+  class Transition < Regexp
+    attr_accessor :trans
+    attr_accessor :match_result
+    attr_accessor :rgx
+    attr_reader :remain_idx
+
+    EMPTYSTR = ''.freeze
+    SLASH = '/'.freeze
+
+    RESULT_BAD_REQ_ERR = [nil, :error, ::Safrano::BadRequestError].freeze
+    RESULT_NOT_FOUND_ERR = [nil, :error, ::Safrano::ErrorNotFound].freeze
+    RESULT_SERVER_TR_ERR = [nil, :error, ServerTransitionError].freeze
+    RESULT_END = [nil, :end].freeze
+
+    def initialize(arg, trans: nil, remain_idx: 2)
+      @rgx = if arg.respond_to? :each_char
+               Regexp.new(arg)
+             else
+               arg
+             end
+      @trans = trans
+      @remain_idx = remain_idx
+    end
+
+    def do_match(str)
+      @match_result = @rgx.match(str)
+    end
+
+    # remain_idx is the index of the last match-data. ususally its 2
+    # but can be overidden
+    def path_remain
+      @match_result[@remain_idx] if @match_result && @match_result[@remain_idx]
+    end
+
+    def path_done
+      if @match_result
+        @match_result[1] || EMPTYSTR
+      else
+        EMPTYSTR
+      end
+    end
+
+    def do_transition(ctx)
+      ctx.method(@trans).call(@match_result)
+    end
+  end
+
+  TransitionEnd = Transition.new('\A(\/?)\z', trans: 'transition_end')
+  TransitionMetadata = Transition.new('\A(\/\$metadata)(.*)',
+                                      trans: 'transition_metadata')
+  TransitionBatch = Transition.new('\A(\/\$batch)(.*)',
+                                   trans: 'transition_batch')
+  TransitionContentId = Transition.new('\A(\/\$(\d+))(.*)',
+                                       trans: 'transition_content_id',
+                                       remain_idx: 3)
+  TransitionCount = Transition.new('(\A\/\$count)(.*)\z',
+                                   trans: 'transition_count')
+  TransitionValue = Transition.new('(\A\/\$value)(.*)\z',
+                                   trans: 'transition_value')
+  TransitionLinks = Transition.new('(\A\/\$links)(.*)\z',
+                                   trans: 'transition_links')
+  attr_accessor :allowed_transitions
+end

data/lib/odata/url_parameters.rb

@@ -1,23 +1,50 @@
-require 'odata/error.rb'
+# frozen_string_literal: true
+
+require 'odata/error'
 
 # url parameters processing . Mostly delegates to specialised classes
 # (filter, order...) to convert into Sequel exprs.
-module OData
+module Safrano
   class UrlParametersBase
     attr_reader :expand
     attr_reader :select
 
+    # url params validation methods.
+    # nil is the expected return for no errors
+    # an error class is returned in case of errors
+    # this way we can combine multiple validation calls with logical ||
     def check_expand
-      return BadRequestExpandParseError if @expand.parse_error?
+      @expand.parse_error?
+    end
+
+    def check_select
+      @select.parse_error?
+    end
+
+    def initialize(dataset, params = {})
+      @model = if dataset.respond_to? :model
+                 dataset.model
+               else
+                 dataset
+               end
+      @params = params
     end
   end
 
   # url parameters for a single entity expand/select
   class UrlParameters4Single < UrlParametersBase
-    def initialize(params)
-      @params = params
-      @expand = ExpandBase.factory(@params['$expand'])
-      @select = SelectBase.factory(@params['$select'])
+    def initialize(dataset, params)
+      super
+      @expand = ExpandBase.factory(@params['$expand'], @model)
+      @select = SelectBase.factory(@params['$select'], @model)
+    end
+
+    def check_all
+      return Contract::OK unless @params
+
+      check_expand.if_valid do
+        check_select
+      end
     end
   end
 
@@ -26,49 +53,98 @@ module OData
     attr_reader :filt
     attr_reader :ordby
 
-    def initialize(model, params)
+    def initialize(dataset, params = {})
+      super
       # join helper is only needed for odering or filtering
-      @jh = model.join_by_paths_helper if params['$orderby'] || params['$filter']
+      @jh = @model.join_by_paths_helper if params['$orderby'] || params['$filter']
       @params = params
       @ordby = OrderBase.factory(@params['$orderby'], @jh)
       @filt = FilterBase.factory(@params['$filter'])
-      @expand = ExpandBase.factory(@params['$expand'])
-      @select = SelectBase.factory(@params['$select'])
+      @expand = ExpandBase.factory(@params['$expand'], @model)
+      @select = SelectBase.factory(@params['$select'], @model)
+    end
+
+    def check_top
+      return Contract::OK unless @params['$top']
+
+      itop = number_or_nil(@params['$top'])
+      (itop.nil? || itop.zero?) ? BadRequestError : Contract::OK
+    end
+
+    def check_skip
+      return Contract::OK unless @params['$skip']
+
+      iskip = number_or_nil(@params['$skip'])
+      (iskip.nil? || iskip.negative?) ? BadRequestError : Contract::OK
+    end
+
+    def check_inlinecount
+      return Contract::OK unless (icp = @params['$inlinecount'])
+
+      ((icp == 'allpages') || (icp == 'none')) ? Contract::OK : BadRequestInlineCountParamError
     end
 
     def check_filter
-      return BadRequestFilterParseError if @filt.parse_error?
+      (err = @filt.parse_error?) ? err : Contract::OK
     end
 
-    def check_order
+    def check_orderby
+      return Contract::OK if @ordby.empty?
       return BadRequestOrderParseError if @ordby.parse_error?
+
+      Contract::OK
     end
 
     def apply_to_dataset(dtcx)
-      dtcx = apply_expand_to_dataset(dtcx)
-      apply_filter_order_to_dataset(dtcx)
+      apply_expand_to_dataset(dtcx).if_valid do |dataset|
+        apply_filter_order_to_dataset(dataset)
+      end
     end
 
     def apply_expand_to_dataset(dtcx)
-      return dtcx if @expand.empty?
+      return Contract.valid(dtcx) if @expand.empty?
 
       @expand.apply_to_dataset(dtcx)
     end
 
     # Warning, the @ordby and @filt objects are coupled by way of the join helper
     def apply_filter_order_to_dataset(dtcx)
-      return dtcx if @filt.empty? && @ordby.empty?
+      return Contract.valid(dtcx) if @filt.empty? && @ordby.empty?
 
-      # filter object and join-helper need to be finalized after filter has been parsed and checked
-      @filt.finalize(@jh)
+      # filter object and join-helper need to be finalized after filter
+      # has been parsed and checked
+      @filt.finalize(@jh).if_valid do
+        # start with the join
+        dtcx = @jh.dataset(dtcx)
 
-      # start with the join
-      dtcx = @jh.dataset(dtcx)
+        @filt.apply_to_dataset(dtcx).map_result! do |dataset|
+          dtcx = dataset
+          dtcx = @ordby.apply_to_dataset(dtcx)
+          dtcx.select_all(@jh.start_model.table_name)
+        end
+      end
+    end
 
-      dtcx = @filt.apply_to_dataset(dtcx)
-      dtcx = @ordby.apply_to_dataset(dtcx)
+    ###########################################################
+    def check_all
+      return Contract::OK unless @params
 
-      dtcx.select_all(@jh.start_model.table_name)
+      # lazy nested proc evaluation.
+      # if one check fails, it will be passed up the chain and the ones
+      # below will not be evaluated
+      check_top.if_valid do
+        check_skip.if_valid do
+          check_orderby.if_valid do
+            check_filter.if_valid do
+              check_expand.if_valid do
+                check_select.if_valid do
+                  check_inlinecount
+                end
+              end
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/odata/walker.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'rexml/document'
-require 'safrano.rb'
+require 'safrano'
 
-module OData
+module Safrano
   # handle navigation in the Datamodel tree of entities/attributes
   # input is the url path. Url parameters ($filter etc...) are NOT handled here
   # This uses a state transition algorithm
@@ -28,8 +30,12 @@ module OData
     # are $links requested ?
     attr_reader :do_links
 
+    NIL_SERVICE_FATAL = 'Walker is called with a nil service'
+    EMPTYSTR = ''
+    SLASH = '/'
+
     def initialize(service, path, content_id_refs = nil)
-      raise 'Walker is called with a nil service' unless service
+      raise NIL_SERVICE_FATAL unless service
 
       path = URI.decode_www_form_component(path)
       @context = service
@@ -40,10 +46,9 @@ module OData
       @path_start = @path_remain = if service
                                      unprefixed(service.xpath_prefix, path)
                                    else # This is for batch function
-
                                      path
                                    end
-      @path_done = ''
+      @path_done = String.new
       @status = :start
       @end_context = nil
       @do_count = nil
@@ -51,12 +56,12 @@ module OData
     end
 
     def unprefixed(prefix, path)
-      if (prefix == '') || (prefix == '/')
+      if (prefix == EMPTYSTR) || (prefix == SLASH)
         path
       else
         #        path.sub!(/\A#{prefix}/, '')
         # TODO check
-        path.sub(/\A#{prefix}/, '')
+        path.sub(/\A#{prefix}/, EMPTYSTR)
       end
     end
 
@@ -72,6 +77,7 @@ module OData
       valid_tr = @context.allowed_transitions.select do |t|
         t.do_match(@path_remain)
       end
+
       # this is a very fragile and obscure but required hack (wanted: a
       # better one) to make attributes that are substrings of each other
       # work well
@@ -93,13 +99,13 @@ module OData
           @context = nil
           @status = :error
           # TODO: more appropriate error handling
-          @error = OData::ErrorNotFound
+          @error = Safrano::ErrorNotFound
         end
       else
         @context = nil
         @status = :error
         # TODO: more appropriate error handling
-        @error = OData::ErrorNotFound
+        @error = Safrano::ErrorNotFound
       end
     end
 
@@ -149,7 +155,7 @@ module OData
         else
           @context = nil
           @status = :error
-          @error = OData::ErrorNotFound
+          @error = Safrano::ErrorNotFoundSegment.new(@path_remain)
         end
       end
       # TODO: shouldnt we raise an error here if @status != :end ?
@@ -157,5 +163,9 @@ module OData
 
       @end_context = @contexts.size >= 2 ? @contexts[-2] : @contexts[1]
     end
+
+    def finalize
+      (@status == :end) ? Contract.valid(@end_context) : @error
+    end
   end
 end