safrano 0.4.1 → 0.4.2

data/lib/odata/filter/parse.rb

@@ -68,24 +68,18 @@ module OData
         each_typed_token(@input) do |tok, typ|
           case typ
           when :FuncTree
-            with_accepted(tok, typ) do
-              grow_at_cursor(FuncTree.new(tok))
-            end
+            with_accepted(tok, typ) { grow_at_cursor(FuncTree.new(tok)) }
           when :Delimiter
             case tok
             when '('
               with_accepted(tok, typ) do
-                unless @cursor.is_a? FuncTree
-                  grow_at_cursor(IdentityFuncTree.new)
-                end
+                grow_at_cursor(IdentityFuncTree.new) unless @cursor.is_a? FuncTree
                 openarg = ArgTree.new('(')
                 @stack << openarg
                 grow_at_cursor(openarg)
               end
             when ')'
-              unless (@cursor = @stack.pop)
-                break invalid_closing_delimiter_error(tok, typ)
-              end
+              break invalid_closing_delimiter_error(tok, typ) unless (@cursor = @stack.pop)
 
               with_accepted(tok, typ) do
                 @cursor.update_state(tok, typ)
@@ -94,9 +88,7 @@ module OData
             end
 
           when :Separator
-            unless (@cursor = @stack.last)
-              break invalid_separator_error(tok, typ)
-            end
+            break invalid_separator_error(tok, typ) unless (@cursor = @stack.last)
 
             with_accepted(tok, typ) { @cursor.update_state(tok, typ) }
 

data/lib/odata/filter/sequel.rb

@@ -13,7 +13,7 @@ module OData
     class RootTree
       def apply_to_dataset(dtcx, jh)
         filtexpr = @children.first.leuqes(jh)
-        dtcx = jh.dataset.where(filtexpr).select_all(jh.start_model.table_name)
+        jh.dataset(dtcx).where(filtexpr).select_all(jh.start_model.table_name)
       end
 
       def sequel_expr(jh)
@@ -38,21 +38,21 @@ module OData
         when :substringof
 
           # there are multiple possible argument types (but all should return edm.string)
-          if (args[0].is_a?(QString))
+          if args[0].is_a?(QString)
             # substringof('Rhum', name)  -->
             # name contains substr 'Rhum'
             Sequel.like(args[1].leuqes(jh),
                         args[0].leuqes_substringof_sig1(jh))
           # special non standard (ui5 client) case ?
-          elsif (args[0].is_a?(Literal) && args[1].is_a?(Literal))
+          elsif args[0].is_a?(Literal) && args[1].is_a?(Literal)
             Sequel.like(args[1].leuqes(jh),
                         args[0].leuqes_substringof_sig1(jh))
-          elsif (args[1].is_a?(QString))
+          elsif args[1].is_a?(QString)
             # substringof(name, '__Route du Rhum__')  -->
             # '__Route du Rhum__' contains name as a substring
             # TODO... check if the database supports instr (how?)
             # othewise use substr(postgresql) or whatevr?
-            instr_substr_func = if (Sequel::Model.db.adapter_scheme == :postgres)
+            instr_substr_func = if Sequel::Model.db.adapter_scheme == :postgres
                                   Sequel.function(:strpos, args[1].leuqes(jh), args[0].leuqes(jh))
                                 else
                                   Sequel.function(:instr, args[1].leuqes(jh), args[0].leuqes(jh))
@@ -167,26 +167,24 @@ module OData
       end
 
       def leuqes_starts_like(_jh)
-        "#{@value.to_s}%"
+        "#{@value}%"
       end
 
       def leuqes_ends_like(_jh)
-        "%#{@value.to_s}"
+        "%#{@value}"
       end
 
       def leuqes_substringof_sig1(_jh)
-        "%#{@value.to_s}%"
+        "%#{@value}%"
       end
     end
 
     # Literals are unquoted words
     class Literal
       def leuqes(jh)
-        if jh.start_model.db_schema.has_key?(@value.to_sym)
-          Sequel[jh.start_model.table_name][@value.to_sym]
-        else
-          raise OData::Filter::Parser::ErrorWrongColumnName
-        end
+        raise OData::Filter::Parser::ErrorWrongColumnName unless jh.start_model.db_schema.key?(@value.to_sym)
+
+        Sequel[jh.start_model.table_name][@value.to_sym]
       end
 
       # non stantard extensions to support things like

data/lib/odata/filter/tree.rb

@@ -238,7 +238,7 @@ module OData
         end
       end
 
-      # TODO different num types?
+      # TODO: different num types?
       def edm_type
         :any
       end
@@ -279,12 +279,10 @@ module OData
         when :Separator
           if @value == '(' && tok == ',' && @state == :val
             true
+          elsif @state == :sep
+            [false, Parser::ErrorInvalidToken.new(tok, typ, self)]
           else
-            if (@state == :sep)
-              [false, Parser::ErrorInvalidToken.new(tok, typ, self)]
-            else
-              true
-            end
+            true
           end
         when :Literal, :Qualit, :QString, :FuncTree, :FPNumber
           if (@state == :open) || (@state == :sep)
@@ -350,22 +348,20 @@ module OData
       def initialize(val)
         super(val)
         # split into path + attrib
-        if (md = REGEXP.match(val))
-          @path = md[1].chomp('/')
-          @attrib = md[2]
-        else
-          raise Parser::Error.new(self, Qualit)
-        end
+        raise Parser::Error.new(self, Qualit) unless (md = REGEXP.match(val))
+
+        @path = md[1].chomp('/')
+        @attrib = md[2]
       end
     end
 
     # Quoted Strings
     class QString < Leave
-      DoubleQuote = "''".freeze
-      SingleQuote = "'".freeze
+      DBL_QO = "''".freeze
+      SI_QO = "'".freeze
       def initialize(val)
         # unescape double quotes
-        super(val.gsub(DoubleQuote, SingleQuote))
+        super(val.gsub(DBL_QO, SI_QO))
       end
 
       def accept?(tok, typ)

data/lib/odata/navigation_attribute.rb

@@ -3,31 +3,27 @@ require_relative '../safrano/core.rb'
 require_relative './entity.rb'
 
 module OData
-  
-  # remove the relation between entity and parent by clearing 
+  # remove the relation between entity and parent by clearing
   # the FK field(s) (if allowed)
-  def OData.remove_nav_relation(entity, assoc, parent)
+  def self.remove_nav_relation(assoc, parent)
     return unless assoc
 
-    case assoc[:type]
-      when :one_to_many, :one_to_one
-      when :many_to_one
-      # removes/clear the FK values in parent 
-      # thus deleting the "link" between the entity and the parent
-      # Note: This is called if we have to delete the child--> can only be
-      # done after removing the FK in parent (if allowed!)
-        lks = [assoc[:key]].flatten
-        lks.each{|lk| 
-          parent.set(lk => nil )
-          parent.save(transaction: false)
-        }
-      
-    end  
+    return unless assoc[:type] == :many_to_one
+
+    # removes/clear the FK values in parent
+    # thus deleting the "link" between the entity and the parent
+    # Note: This is called if we have to delete the child--> can only be
+    # done after removing the FK in parent (if allowed!)
+    lks = [assoc[:key]].flatten
+    lks.each do |lk|
+      parent.set(lk => nil)
+      parent.save(transaction: false)
+    end
   end
-  
+
   # link newly created entities(child) to an existing parent
   # by following the association_reflection rules
-  def OData.create_nav_relation(child, assoc, parent)
+  def self.create_nav_relation(child, assoc, parent)
     return unless assoc
 
     # Note: this coding shares some bits from our sequel/plugins/join_by_paths,
@@ -46,16 +42,16 @@ module OData
       lks = [leftm.primary_key].flatten
       rks = [assoc[:key]].flatten
       join_cond = rks.zip(lks).to_h
-      join_cond.each { |rk, lk|
+      join_cond.each do |rk, lk|
         if child.values[rk] # FK in new entity from payload not nil, only check consistency
           # with the parent - id(s)
-          if (child.values[rk] != parent.pk_hash[lk]) # error...
-            # TODO
-          end
+          # if (child.values[rk] != parent.pk_hash[lk]) # error...
+          # TODO
+          # end
         else # we can set the FK value, thus creating the "link"
           child.set(rk => parent.pk_hash[lk])
         end
-      }
+      end
     when :many_to_one
       # sets the FK values in parent to corresponding related child key-values
       # thus creating the "link" between the new entity and the parent
@@ -64,16 +60,16 @@ module OData
       lks = [assoc[:key]].flatten
       rks = [child.class.primary_key].flatten
       join_cond = rks.zip(lks).to_h
-      join_cond.each { |rk, lk|
+      join_cond.each do |rk, lk|
         if parent.values[lk] # FK in parent not nil, only check consistency
           # with the child - id(s)
-          if (parent.values[lk] != child.pk_hash[rk]) # error...
-            # TODO
-          end
+          # if parent.values[lk] != child.pk_hash[rk] # error...
+          # TODO
+          # end
         else # we can set the FK value, thus creating the "link"
           parent.set(lk => child.pk_hash[rk])
         end
-      }
+      end
     end
   end
 
@@ -82,7 +78,7 @@ module OData
       attr_reader :nav_parent
       attr_reader :navattr_reflection
       attr_reader :nav_name
-      def set_relation_info(parent,name)
+      def set_relation_info(parent, name)
         @nav_parent = parent
         @nav_name = name
         @navattr_reflection = parent.class.association_reflections[name.to_sym]
@@ -108,25 +104,25 @@ module OData
     # create the nav. entity
     def odata_post(req)
       # delegate to the class method
-      @nav_klass.odata_create_entity_and_relation(req, 
-                                                  @navattr_reflection, 
+      @nav_klass.odata_create_entity_and_relation(req,
+                                                  @navattr_reflection,
                                                   @nav_parent)
     end
 
     # 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
+      #      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)
     def to_odata_json(*)
-      { 'd' => {} }.to_json
+      { 'd' => EMPTY_HASH }.to_json
     end
 
     # for testing purpose (assert_equal ...)

data/lib/odata/select.rb

@@ -0,0 +1,42 @@
+require 'odata/error.rb'
+
+# all dataset selecting related classes in our OData module
+# ie  do eager loading
+module OData
+  # base class for selecting. We have to distinguish between
+  # fields of the current entity, and the navigation properties
+  # we can have one special case
+  #  empty, ie no $select specified --> return all fields and all nav props
+  #            ==> SelectAll
+
+  class SelectBase
+    ALL = new # re-useable selecting-all handler
+
+    def self.factory(selectstr)
+      case selectstr&.strip
+      when nil, '', '*'
+        ALL
+      else
+        Select.new(selectstr)
+      end
+    end
+
+    def all_props?
+      false
+    end
+
+    def ALL.all_props?
+      true
+    end
+  end
+
+  # single select
+  class Select < SelectBase
+    COMASPLIT = /\s*,\s*/.freeze
+    attr_reader :props
+    def initialize(selstr)
+      @selectp = selstr.strip
+      @props = @selectp.split(COMASPLIT)
+    end
+  end
+end

data/lib/odata/url_parameters.rb

@@ -3,57 +3,72 @@ require 'odata/error.rb'
 # url parameters processing . Mostly delegates to specialised classes
 # (filter, order...) to convert into Sequel exprs.
 module OData
-  class UrlParameters
+  class UrlParametersBase
+    attr_reader :expand
+    attr_reader :select
+
+    def check_expand
+      return BadRequestExpandParseError if @expand.parse_error?
+    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'])
+    end
+  end
+
+  # url parameters for a collection expand/select + filter/order
+  class UrlParameters4Coll < UrlParametersBase
     attr_reader :filt
     attr_reader :ordby
-    def initialize(jh, params)
-      @jh = jh
+
+    def initialize(model, params)
+      # join helper is only needed for odering or filtering
+      @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'])
     end
 
     def check_filter
-      return unless @params['$filter']
-
-      @filt = FilterByParse.new(@params['$filter'], @jh)
       return BadRequestFilterParseError if @filt.parse_error?
-
-      # nil is the expected return for no errors
-      nil
     end
 
     def check_order
-      return unless @params['$orderby']
+      return BadRequestOrderParseError if @ordby.parse_error?
+    end
 
-      pordlist = @params['$orderby'].dup
-      pordlist.split(',').each do |pord|
-        pord.strip!
-        qualfn, dir = pord.split(/\s/)
-        qualfn.strip!
-        dir.strip! if dir
-        return BadRequestError unless @jh.start_model.attrib_path_valid? qualfn
-        return BadRequestError unless [nil, 'asc', 'desc'].include? dir
-      end
+    def apply_to_dataset(dtcx)
+      dtcx = apply_expand_to_dataset(dtcx)
+      apply_filter_order_to_dataset(dtcx)
+    end
 
-      @ordby = Order.new_by_parse(@params['$orderby'], @jh)
+    def apply_expand_to_dataset(dtcx)
+      return dtcx if @expand.empty?
 
-      # nil is the expected return for no errors
-      nil
+      @expand.apply_to_dataset(dtcx)
     end
 
-    def apply_to_dataset(dtcx)
-      return dtcx if (@filt.nil? && @ordby.nil?)
-
-      if @filt.nil?
-        dtcx = @jh.dataset.select_all(@jh.start_model.table_name)
-
-        @ordby.apply_to_dataset(dtcx)
-      elsif @ordby.nil?
-        @filt.apply_to_dataset(dtcx)
-      else
-        filtexpr = @filt.sequel_expr
-        dtcx = @jh.dataset(dtcx).where(filtexpr).select_all(@jh.start_model.table_name)
-        @ordby.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?
+
+      # filter object and join-helper need to be finalized after filter has been parsed and checked
+      @filt.finalize(@jh)
+
+      # start with the join
+      dtcx = @jh.dataset(dtcx)
+
+      dtcx = @filt.apply_to_dataset(dtcx)
+      dtcx = @ordby.apply_to_dataset(dtcx)
+
+      dtcx.select_all(@jh.start_model.table_name)
     end
   end
 end

data/lib/safrano.rb

@@ -1,4 +1,3 @@
-
 require 'json'
 require 'rexml/document'
 require_relative 'safrano/multipart.rb'
@@ -34,9 +33,10 @@ end
 # needed for ruby < 2.5
 class Dir
   def self.each_child(dir)
-    Dir.foreach(dir) {|x| 
-      next if ( ( x == '.' ) or  ( x == '..' ) )
+    Dir.foreach(dir) do |x|
+      next if (x == '.') || (x == '..')
+
       yield x
-     }
+    end
   end unless respond_to? :each_child
-end
+end