safrano 0.4.2 → 0.4.3

data/lib/odata/error.rb

@@ -129,9 +129,27 @@ module OData
     HTTP_CODE = 501
     @msg = 'Not implemented: OData batch'
   end
+
   # error in filter parsing (Safrano specific)
   class FilterParseError < BadRequestError
     extend  ErrorClass
     HTTP_CODE = 400
   end
+
+  class FilterFunctionNotImplementedError < BadRequestError
+    extend  ErrorClass
+    include ErrorInstance
+    @msg = 'the requested $filter function is Not implemented'
+    HTTP_CODE = 400
+    def initialize(exception)
+      @msg = exception.to_s
+    end
+  end
+  class FilterInvalidFunctionError < BadRequestError
+    include ErrorInstance
+    HTTP_CODE = 400
+    def initialize(exception)
+      @msg = exception.to_s
+    end
+  end
 end

data/lib/odata/filter/base.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OData
+  module Filter
+    # Base class for Leaves, Trees, RootTrees etc
+    class Node
+    end
+
+    # Leaves are Nodes with a parent but no children
+    class Leave < Node
+    end
+
+    # RootTrees have childrens but no parent
+    class RootTree < Node
+    end
+
+    # Tree's have Parent and children
+    class Tree < RootTree
+    end
+
+    # For functions... should have a single child---> the argument list
+    class FuncTree < Tree
+    end
+
+    # Indentity Func to use as "parent" func of parenthesis expressions
+    # --> allow to handle generically parenthesis always as argument of
+    # some function
+    class IdentityFuncTree < FuncTree
+    end
+
+    # unary op eg. NOT
+    class UnopTree < Tree
+    end
+
+    # Bin ops
+    class BinopTree < Tree
+    end
+
+    class BinopBool < BinopTree
+    end
+
+    class BinopArithm < BinopTree
+    end
+
+    # Arguments or lists
+    class ArgTree < Tree
+    end
+
+    # Numbers (floating point, ints, dec)
+    class FPNumber < Leave
+    end
+
+    # Literals are unquoted words without /
+    class Literal < Leave
+    end
+
+    # Qualit (qualified lits) are words separated by /
+    # path/path/path/attrib
+    class Qualit < Literal
+    end
+
+    # Quoted Strings
+    class QString < Leave
+    end
+  end
+end

data/lib/odata/filter/error.rb

@@ -1,3 +1,5 @@
+require_relative '../error'
+
 module OData
   class SequelAdapterError < StandardError
     attr_reader :inner
@@ -5,7 +7,22 @@ module OData
       @inner = err
     end
   end
+
+  # exception to OData error bridge
+  module ErrorBridge
+    # return an odata error object wrapping the exception
+    # the odata error object should respond to odata_get for output
+    def odata_error
+      self.class.const_get('ODATA_ERROR_KLASS').new(self)
+    end
+  end
+
   module Filter
+    class FunctionNotImplemented < StandardError
+      ODATA_ERROR_KLASS = OData::FilterFunctionNotImplementedError
+      include ::OData::ErrorBridge
+    end
+
     class Parser
       # Parser errors
       class Error < StandardError
@@ -35,6 +52,16 @@ module OData
       class ErrorWrongColumnName < StandardError
       end
 
+      # attempt to add a child to a Leave
+      class ErrorLeaveChild < StandardError
+      end
+
+      # invalid function error (literal attach to IdentityFuncTree)
+      class ErrorInvalidFunction < StandardError
+        ODATA_ERROR_KLASS = OData::FilterInvalidFunctionError
+        include ::OData::ErrorBridge
+      end
+
       # Invalid function arity
       class ErrorInvalidArity < Error
       end

data/lib/odata/filter/parse.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './token.rb'
 require_relative './tree.rb'
 require_relative './error.rb'

data/lib/odata/filter/sequel.rb

@@ -1,13 +1,17 @@
-require_relative './tree.rb'
+# frozen_string_literal: true
+
+require_relative './base.rb'
+require_relative './sequel_function_adapter.rb'
+
 module OData
   module Filter
     # Base class for Leaves, Trees, RootTrees etc
-    class Node
-    end
+    #    class Node
+    #    end
 
     # Leaves are Nodes with a parent but no children
-    class Leave < Node
-    end
+    #    class Leave < Node
+    #    end
 
     # RootTrees have childrens but no parent
     class RootTree
@@ -26,6 +30,8 @@ module OData
     end
 
     # For functions... should have a single child---> the argument list
+    # note: Adapter specific function helpers like year() or substringof_sig2()
+    # need to be mixed in on startup (eg. on publish finalize)
     class FuncTree < Tree
       def leuqes(jh)
         case @value
@@ -48,18 +54,7 @@ module OData
             Sequel.like(args[1].leuqes(jh),
                         args[0].leuqes_substringof_sig1(jh))
           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
-                                  Sequel.function(:strpos, args[1].leuqes(jh), args[0].leuqes(jh))
-                                else
-                                  Sequel.function(:instr, args[1].leuqes(jh), args[0].leuqes(jh))
-                                end
-
-            Sequel::SQL::BooleanExpression.new(:>, instr_substr_func, 0)
-
+            substringof_sig2(jh) # adapter specific
           else
             # TODO... actually not supported?
             raise OData::Filter::Parser::ErrorFunctionArgumentType
@@ -75,6 +70,26 @@ module OData
           Sequel.function(:upper, args.first.leuqes(jh))
         when :tolower
           Sequel.function(:lower, args.first.leuqes(jh))
+        # all datetime funcs are adapter specific (because sqlite does not have extract)
+        when :year
+          year(jh)
+        when :month
+          month(jh)
+        when :second
+          second(jh)
+        when :minute
+          minute(jh)
+        when :hour
+          hour(jh)
+        when :day
+          day(jh)
+        # math functions
+        when :round
+          Sequel.function(:round, args.first.leuqes(jh))
+        when :floor
+          floor(jh)
+        when :ceiling
+          ceiling(jh)
         else
           raise OData::FilterParseError
         end

data/lib/odata/filter/sequel_function_adapter.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require_relative './tree.rb'
+require_relative './sequel.rb'
+
+module OData
+  module Filter
+    # sqlite adapter specific function handler
+    module FuncTreeSqlite
+      def substringof_sig2(jh)
+        # substringof(name, '__Route du Rhum__')  -->
+        # '__Route du Rhum__' contains name as a substring
+        # sqlite uses instr()
+
+        substr_func = Sequel.function(:instr, args[1].leuqes(jh), args[0].leuqes(jh))
+
+        Sequel::SQL::BooleanExpression.new(:>, substr_func, 0)
+      end
+      # %d		day of month: 00
+      # %f		fractional seconds: SS.SSS
+      # %H		hour: 00-24
+      # %j		day of year: 001-366
+      # %J		Julian day number
+      # %m		month: 01-12
+      # %M		minute: 00-59
+      # %s		seconds since 1970-01-01
+      # %S		seconds: 00-59
+      # %w		day of week 0-6 with Sunday==0
+      # %W		week of year: 00-53
+      # %Y		year: 0000-9999
+      # %%		%
+
+      # sqlite does not have extract but recommends to use strftime
+      def year(jh)
+        Sequel.function(:strftime, '%Y', args.first.leuqes(jh)).cast(:integer)
+      end
+
+      def month(jh)
+        Sequel.function(:strftime, '%m', args.first.leuqes(jh)).cast(:integer)
+      end
+
+      def second(jh)
+        Sequel.function(:strftime, '%S', args.first.leuqes(jh)).cast(:integer)
+      end
+
+      def minute(jh)
+        Sequel.function(:strftime, '%M', args.first.leuqes(jh)).cast(:integer)
+      end
+
+      def hour(jh)
+        Sequel.function(:strftime, '%H', args.first.leuqes(jh)).cast(:integer)
+      end
+
+      def day(jh)
+        Sequel.function(:strftime, '%d', args.first.leuqes(jh)).cast(:integer)
+      end
+
+      def floor(jh)
+        raise OData::Filter::FunctionNotImplemented, "$filter function 'floor' is not implemented in sqlite adapter"
+      end
+
+      def ceiling(jh)
+        raise OData::Filter::FunctionNotImplemented, "$filter function 'ceiling' is not implemented in sqlite adapter"
+      end
+    end
+    # re-useable module with math floor/ceil functions for those adapters having these SQL funcs
+    module MathFloorCeilFuncTree
+      def floor(jh)
+        Sequel.function(:floor, args.first.leuqes(jh))
+      end
+
+      def ceiling(jh)
+        Sequel.function(:ceil, args.first.leuqes(jh))
+      end
+    end
+
+    # re-useable module with Datetime functions with extract()
+    module DateTimeFuncTreeExtract
+      def year(jh)
+        args.first.leuqes(jh).extract(:year)
+      end
+
+      def year(jh)
+        args.first.leuqes(jh).extract(:year)
+      end
+
+      def month(jh)
+        args.first.leuqes(jh).extract(:month)
+      end
+
+      def second(jh)
+        args.first.leuqes(jh).extract(:second)
+      end
+
+      def minute(jh)
+        args.first.leuqes(jh).extract(:minute)
+      end
+
+      def hour(jh)
+        args.first.leuqes(jh).extract(:hour)
+      end
+
+      def day(jh)
+        args.first.leuqes(jh).extract(:day)
+      end
+    end
+
+    # postgresql adapter specific function handler
+    module FuncTreePostgres
+      def substringof_sig2(jh)
+        # substringof(name, '__Route du Rhum__')  -->
+        # '__Route du Rhum__' contains name as a substring
+        # postgres does not know instr() but has strpos
+        substr_func = Sequel.function(:strpos, args[1].leuqes(jh), args[0].leuqes(jh))
+
+        Sequel::SQL::BooleanExpression.new(:>, substr_func, 0)
+      end
+
+      # postgres uses extract()
+      include DateTimeFuncTreeExtract
+
+      # postgres has floor/ceil funcs
+      include MathFloorCeilFuncTree
+    end
+
+    # default adapter  function handler for all others... try to use the most common version
+    # :substring --> instr because here is seems Postgres is special
+    # datetime funcs --> exctract, here sqlite is special(uses format)
+    # note: we dont test this, provided as an example/template, might work eg for mysql
+    module FuncTreeDefault
+      def substringof_sig2(jh)
+        # substringof(name, '__Route du Rhum__')  -->
+        # '__Route du Rhum__' contains name as a substring
+        # instr() seems to be the most common substring func
+        substr_func = Sequel.function(:instr, args[1].leuqes(jh), args[0].leuqes(jh))
+
+        Sequel::SQL::BooleanExpression.new(:>, substr_func, 0)
+      end
+
+      # XYZ uses extract() ?
+      include DateTimeFuncTreeExtract
+
+      # ... assume SQL
+      include MathFloorCeilFuncTree
+    end
+  end
+end

data/lib/odata/filter/token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # top level OData namespace
 module OData
   module Filter
@@ -5,7 +7,9 @@ module OData
       # Input tokenizer
       module Token
         FUNCNAMES = %w[concat substringof endswith startswith length indexof
-                       replace substring trim toupper tolower].freeze
+                       replace substring trim toupper tolower
+                       day hour minute month second year
+                       round floor ceiling].freeze
         FUNCRGX = FUNCNAMES.join('|').freeze
         QSTRINGRGX = /'((?:[^']|(?:\'{2}))*)'/.freeze
         BINOBOOL = '[eE][qQ]|[LlgGNn][eETt]|[aA][nN][dD]|[oO][rR]'.freeze

data/lib/odata/filter/tree.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require_relative './base.rb'
 require_relative './error.rb'
 
 module OData
@@ -16,17 +19,22 @@ module OData
     end
 
     # Leaves are Nodes with a parent but no children
-    class Leave < Node
+    class Leave
       attr_accessor :parent
       def accept?(tok, typ)
         [false, Parser::ErrorInvalidToken(tok, typ)]
       end
 
       def check_types; end
+
+      def attach(child)
+        # TODO better reporting of error infos
+        raise ErrorLeaveChild
+      end
     end
 
     # RootTrees have childrens but no parent
-    class RootTree < Node
+    class RootTree
       attr_reader :children
       attr_accessor :state
       def initialize(val: :root, &block)
@@ -71,7 +79,7 @@ module OData
     end
 
     # Tree's have Parent and children
-    class Tree < RootTree
+    class Tree
       attr_accessor :parent
 
       def initialize(val)
@@ -80,7 +88,7 @@ module OData
     end
 
     # For functions... should have a single child---> the argument list
-    class FuncTree < Tree
+    class FuncTree
       def initialize(val)
         super(val.downcase.to_sym)
       end
@@ -143,7 +151,7 @@ module OData
     # Indentity Func to use as "parent" func of parenthesis expressions
     # --> allow to handle generically parenthesis always as argument of
     # some function
-    class IdentityFuncTree < FuncTree
+    class IdentityFuncTree
       def initialize
         super(:__indentity)
       end
@@ -160,7 +168,7 @@ module OData
     end
 
     # unary op eg. NOT
-    class UnopTree < Tree
+    class UnopTree
       def initialize(val)
         super(val.downcase.to_sym)
       end
@@ -187,7 +195,7 @@ module OData
     end
 
     # Bin ops
-    class BinopTree < Tree
+    class BinopTree
       def initialize(val)
         @state = :open
         super(val.downcase.to_sym)
@@ -201,7 +209,7 @@ module OData
       end
     end
 
-    class BinopBool < BinopTree
+    class BinopBool
       # reference:
       # OData v4 par 5.1.1.9 Operator Precedence
       def precedence
@@ -224,7 +232,7 @@ module OData
       end
     end
 
-    class BinopArithm < BinopTree
+    class BinopArithm
       # reference:
       # OData v4 par 5.1.1.9 Operator Precedence
       def precedence
@@ -245,7 +253,7 @@ module OData
     end
 
     # Arguments or lists
-    class ArgTree < Tree
+    class ArgTree
       attr_reader :type
       def initialize(val)
         @type = :expression
@@ -307,7 +315,7 @@ module OData
     end
 
     # Numbers (floating point, ints, dec)
-    class FPNumber < Leave
+    class FPNumber
       def accept?(tok, typ)
         case typ
         when :Delimiter, :Separator, :BinopBool, :BinopArithm
@@ -324,7 +332,7 @@ module OData
     end
 
     # Literals are unquoted words without /
-    class Literal < Leave
+    class Literal
       def accept?(tok, typ)
         case typ
         when :Delimiter, :Separator, :BinopBool, :BinopArithm
@@ -337,11 +345,23 @@ module OData
       def edm_type
         :any
       end
+
+      # error, Literal are leaves
+      # when the child is a IdentityFuncTree then this looks like
+      # an attempt to use a unknown function, eg. ceil(Total)
+      # instead of ceiling(Total)
+      def attach(child)
+        if child.kind_of? OData::Filter::IdentityFuncTree
+          raise Parser::ErrorInvalidFunction.new("Error in $filter expr.: invalid function #{self.value}")
+        else
+          super
+        end
+      end
     end
 
     # Qualit (qualified lits) are words separated by /
     # path/path/path/attrib
-    class Qualit < Literal
+    class Qualit
       REGEXP = /((?:\w+\/)+)(\w+)/.freeze
       attr_reader :path
       attr_reader :attrib
@@ -356,7 +376,7 @@ module OData
     end
 
     # Quoted Strings
-    class QString < Leave
+    class QString
       DBL_QO = "''".freeze
       SI_QO = "'".freeze
       def initialize(val)