safrano 0.3.4 → 0.4.4

data/lib/odata/walker.rb

@@ -1,10 +1,10 @@
-#!/usr/bin/env ruby
+# 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
@@ -30,8 +30,12 @@ module OData
     # are $links requested ?
     attr_reader :do_links
 
+    NIL_SERVICE_FATAL = 'Walker is called with a nil service'.freeze
+    EMPTYSTR = ''.freeze
+    SLASH = '/'.freeze
+
     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
@@ -42,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
@@ -53,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
 
@@ -74,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
@@ -95,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
 
@@ -151,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 ?
@@ -159,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

data/lib/safrano.rb

@@ -1,32 +1,22 @@
-#!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'json'
 require 'rexml/document'
-require_relative './multipart.rb'
-require 'safrano_core.rb'
-require 'odata/entity.rb'
-require 'odata/attribute.rb'
-require 'odata/navigation_attribute.rb'
-require 'odata/collection.rb'
-require 'service.rb'
-require 'odata/walker.rb'
+require_relative 'safrano/version'
+require_relative 'safrano/deprecation'
+require_relative 'safrano/core_ext'
+require_relative 'safrano/contract'
+require_relative 'safrano/multipart'
+require_relative 'safrano/core'
+require_relative 'odata/transition'
+require_relative 'odata/edm/primitive_types'
+require_relative 'odata/entity'
+require_relative 'odata/attribute'
+require_relative 'odata/navigation_attribute'
+require_relative 'odata/model_ext'
+require_relative 'safrano/service'
+require_relative 'odata/walker'
 require 'sequel'
-require_relative './sequel_join_by_paths.rb'
-require 'rack_app'
-require 'odata_rack_builder'
-
-# picked from activsupport; needed for ruby < 2.5
-# Destructively converts all keys using the +block+ operations.
-# Same as +transform_keys+ but modifies +self+.
-class Hash
-  def transform_keys!
-    keys.each do |key|
-      self[yield(key)] = delete(key)
-    end
-    self
-  end unless method_defined? :transform_keys!
-
-  def symbolize_keys!
-    transform_keys! { |key| key.to_sym rescue key }
-  end
-end
+require_relative 'safrano/sequel_join_by_paths'
+require_relative 'safrano/rack_app'
+require_relative 'safrano/rack_builder'

data/lib/safrano/contract.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Safrano
+  # Design: the Invalid module and the Valid class share exactly the same
+  # methods (ie. interface) so methods returning such objects can be
+  # post-processed in a declarative way
+  # Example:
+  #   something.do_stuff(param).tap_valid{|valid_result| ... }
+  #                             .tap_error{|error|  ... }
+
+  module Contract
+    # represents a invalid result, ie. an error
+    # this shall be included/extended to our Error classes thus
+    # automagically making them contract/flow enabled
+
+    # All tap_valid* handlers are not executed
+    #     tap_error* handlers are executed
+    module Invalid
+      def tap_error
+        yield self
+        self # allow chaining
+      end
+
+      def tap_valid
+        self # allow chaining
+      end
+
+      def if_valid
+        self
+      end
+
+      def if_error
+        yield self ## return this
+      end
+
+      def if_valid_collect
+        self
+      end
+
+      def map_result!
+        self # allow chaining
+      end
+
+      def collect_result!
+        self # allow chaining
+      end
+
+      def error
+        self
+      end
+
+      def result
+        nil
+      end
+    end
+
+    class Error
+      include Invalid
+    end
+
+    # represents a valid result.
+    # All tap_valid* handlers are executed
+    #     tap_error* handlers are not executed
+    class Valid
+      def initialize(result)
+        @result = result
+      end
+
+      def tap_error
+        self # allow chaining
+      end
+
+      def tap_valid
+        yield @result
+        self # allow chaining
+      end
+
+      def if_valid
+        yield @result ## return this
+      end
+
+      def if_error
+        self # allow chaining
+      end
+
+      def if_valid_collect
+        yield(*@result) ## return this
+      end
+
+      def map_result!
+        @result = yield @result
+        self # allow chaining
+      end
+
+      def collect_result!
+        @result = yield(*@result)
+        self # allow chaining
+      end
+
+      def error
+        nil
+      end
+
+      def result
+        @result
+      end
+    end # class Valid
+
+    def Contract.valid(result)
+      Contract::Valid.new(result)
+    end
+
+    def Contract.and(*contracts)
+      # pick the first error if any
+      if (ff = contracts.find(&:error))
+        return ff
+      end
+
+      # return a new one with @result = list of the contracts's results
+      # usually this then be reduced again with #collect_result! or #               #if_valid_collect methods
+      Contract.valid(contracts.map(&:result))
+    end
+
+    # shortcut for Contract.and(*contracts).collect_result!
+    def Contract.collect_result!(*contracts)
+      # pick the first error if any
+      if (ff = contracts.find(&:error))
+        return ff
+      end
+
+      # return a new one with @result = yield(*list of the contracts's results)
+      Contract.valid(yield(*contracts.map(&:result)))
+    end
+
+    # generic success return, when return value does not matter
+    # but usefull for control-flow
+    OK = Contract.valid(nil).freeze
+    # generic error return, when error value does not matter
+    # but usefull for control-flow
+    NOT_OK = Error.new.freeze
+    NOK = NOT_OK # it's shorter
+  end # Contract
+end

data/lib/safrano/core.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# our main namespace
+module Safrano
+  # frozen empty Array/Hash to reduce unncecessary object creation
+  EMPTY_ARRAY = [].freeze
+  EMPTY_HASH = {}.freeze
+  EMPTY_HASH_IN_ARY = [EMPTY_HASH].freeze
+  EMPTY_STRING = ''.freeze
+  ARY_204_EMPTY_HASH_ARY = [204, EMPTY_HASH, EMPTY_ARRAY].freeze
+  SPACE = ' '.freeze
+  COMMA = ','.freeze
+
+  # some prominent constants... probably already defined elsewhere eg in Rack
+  # but lets KISS
+  CONTENT_TYPE = 'Content-Type'.freeze
+  CTT_TYPE_LC = 'content-type'.freeze
+  TEXTPLAIN_UTF8 = 'text/plain;charset=utf-8'.freeze
+  APPJSON = 'application/json'.freeze
+  APPXML = 'application/xml'.freeze
+  MP_MIXED = 'multipart/mixed'.freeze
+  APPXML_UTF8 = 'application/xml;charset=utf-8'.freeze
+  APPATOMXML_UTF8 = 'application/atomsvc+xml;charset=utf-8'.freeze
+  APPJSON_UTF8 = 'application/json;charset=utf-8'.freeze
+
+  CT_JSON = { CONTENT_TYPE => APPJSON_UTF8 }.freeze
+  CT_TEXT = { CONTENT_TYPE => TEXTPLAIN_UTF8 }.freeze
+  CT_ATOMXML = { CONTENT_TYPE => APPATOMXML_UTF8 }.freeze
+  CT_APPXML = { CONTENT_TYPE => APPXML_UTF8 }.freeze
+
+  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

data/lib/safrano/core_ext.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Dir.glob(File.expand_path('../core_ext/*.rb', __dir__)).sort.each do |path|
+  require path
+end
+
+# small helper method
+# http://stackoverflow.com/
+#        questions/24980295/strictly-convert-string-to-integer-or-nil
+def number_or_nil(str)
+  num = str.to_i
+  num if num.to_s == str
+end

data/lib/safrano/deprecation.rb

@@ -0,0 +1,73 @@
+# frozen-string-literal: true
+
+# shamelessly copied from Sequel...
+
+module Safrano
+  # This module makes it easy to print deprecation warnings with optional backtraces to a given stream.
+  # There are a two accessors you can use to change how/where the deprecation methods are printed
+  # and whether/how backtraces should be included:
+  #
+  #   Safrano::Deprecation.output = $stderr # print deprecation messages to standard error (default)
+  #   Safrano::Deprecation.output = File.open('deprecated_calls.txt', 'wb') # use a file instead
+  #   Safrano::Deprecation.output = false # do not output deprecation messages
+  #
+  #   Safrano::Deprecation.prefix = "SAFRANO DEPRECATION WARNING: " # prefix deprecation messages with a given string (default)
+  #   Safrano::Deprecation.prefix = false # do not prefix deprecation messages
+  #
+  #   Safrano::Deprecation.backtrace_filter = false # don't include backtraces
+  #   Safrano::Deprecation.backtrace_filter = true # include full backtraces
+  #   Safrano::Deprecation.backtrace_filter = 2 # include 2 backtrace lines (default)
+  #   Safrano::Deprecation.backtrace_filter = 1 # include 1 backtrace line
+  #   Safrano::Deprecation.backtrace_filter = lambda{|line, line_no| line_no < 3 || line =~ /my_app/} # select backtrace lines to output
+  module Deprecation
+    @backtrace_filter = false
+    @output = $stderr
+    @prefix = "SAFRANO DEPRECATION WARNING: ".freeze
+
+    class << self
+      # How to filter backtraces.  +false+ does not include backtraces, +true+ includes
+      # full backtraces, an Integer includes that number of backtrace lines, and
+      # a proc is called with the backtrace line and line number to select the backtrace
+      # lines to include.  The default is no backtrace .
+      attr_accessor :backtrace_filter
+
+      # Where deprecation messages should be output, must respond to puts.  $stderr by default.
+      attr_accessor :output
+
+      # Where deprecation messages should be prefixed with ("SEQUEL DEPRECATION WARNING: " by default).
+      attr_accessor :prefix
+    end
+
+    # Print the message and possibly backtrace to the output.
+    def self.deprecate(method, instead = nil)
+      return unless output
+
+      message = instead ? "#{method} is deprecated and will be removed in Safrano 0.6.  #{instead}." : method
+      message = "#{prefix}#{message}" if prefix
+      output.puts(message)
+      case b = backtrace_filter
+      when Integer
+        caller.each do |c|
+          b -= 1
+          output.puts(c)
+          break if b <= 0
+        end
+      when true
+        caller.each { |c| output.puts(c) }
+      when Proc
+        caller.each_with_index { |line, line_no| output.puts(line) if b.call(line, line_no) }
+      end
+      nil
+    end
+
+    # If using ruby 2.3+, use Module#deprecate_constant to deprecate the constant,
+    # otherwise do nothing as the ruby implementation does not support constant deprecation.
+    def self.deprecate_constant(mod, constant)
+      # :nocov:
+      if RUBY_VERSION > '2.3'
+        # :nocov:
+        mod.deprecate_constant(constant)
+      end
+    end
+  end
+end

data/lib/{multipart.rb → safrano/multipart.rb}

@@ -1,21 +1,25 @@
-CRLF = "\r\n".freeze
-LF = "\n".freeze
+# frozen_string_literal: true
+
+CRLF = "\r\n"
+LF = "\n"
 
 require 'securerandom'
 require 'webrick/httpstatus'
 
 # Simple multipart support for OData $batch purpose
 module MIME
+  CTT_TYPE_LC = 'content-type'
+  TEXT_PLAIN = 'text/plain'
+
   # a mime object has a header(with content-type etc) and a content(aka body)
   class Media
     # Parser for MIME::Media
     class Parser
       HMD_RGX = /^([\w-]+)\s*:\s*(.*)/.freeze
 
-      CRLF_LINE_RGX = /^#{CRLF}$/.freeze
-
       attr_accessor :lines
       attr_accessor :target
+
       def initialize
         @state = :h
         @lines = []
@@ -54,9 +58,8 @@ module MIME
         if (hmd = HMD_RGX.match(line))
           @target_hd[hmd[1].downcase] = hmd[2].strip
 
-        #        elsif CRLF_LINE_RGX =~ line
         elsif CRLF == line
-          @target_ct = @target_hd['content-type'] || 'text/plain'
+          @target_ct = @target_hd[CTT_TYPE_LC] || TEXT_PLAIN
           @state = new_content
 
         end
@@ -100,24 +103,22 @@ module MIME
       end
 
       def hook_multipart(content_type, boundary)
-        @target_hd['content-type'] = content_type
-        @target_ct = @target_hd['content-type']
+        @target_hd[CTT_TYPE_LC] = content_type
+        @target_ct = @target_hd[CTT_TYPE_LC]
         @target = multipart_content(boundary)
         @target.hd = @target_hd
         @target.ct = @target_ct
         @state = :bmp
       end
       MPS = 'multipart/'.freeze
-      MP_RGX1 = %r{^(digest|mixed);\s*boundary=\"(.*)\"}.freeze
+      MP_RGX1 = %r{^(digest|mixed);\s*boundary="(.*)"}.freeze
       MP_RGX2 = %r{^(digest|mixed);\s*boundary=(.*)}.freeze
       #      APP_HTTP_RGX = %r{^application/http}.freeze
       APP_HTTP = 'application/http'.freeze
       def new_content
         @target =
-          if @target_ct.start_with?(MPS) and
-             (md = ((MP_RGX1.match(@target_ct[10..-1])) ||
-                      (MP_RGX2.match(@target_ct[10..-1])))
-             )
+          if @target_ct.start_with?(MPS) &&
+             (md = (MP_RGX1.match(@target_ct[10..-1]) || MP_RGX2.match(@target_ct[10..-1])))
             multipart_content(md[2].strip)
           elsif @target_ct.start_with?(APP_HTTP)
             MIME::Content::Application::Http.new
@@ -198,7 +199,6 @@ module MIME
         # Parser for Text::Plain
         class Parser
           HMD_RGX = /^([\w-]+)\s*:\s*(.*)/.freeze
-          CRLF_LINE_RGX = /^#{CRLF}$/.freeze
           def initialize(target)
             @state = :h
             @lines = []
@@ -212,7 +212,6 @@ module MIME
           def parse_head(line)
             if (hmd = HMD_RGX.match(line))
               @target.hd[hmd[1].downcase] = hmd[2].strip
-            #            elsif CRLF_LINE_RGX =~ line
             elsif CRLF == line
               @state = :b
             else
@@ -241,10 +240,11 @@ module MIME
 
         def initialize
           @hd = {}
-          @content = ''
+          # we need it unfrozen --> +
+          @content = +''
           # set default values. Can be overwritten by parser
-          @hd['content-type'] = 'text/plain'
-          @ct = 'text/plain'
+          @hd[CTT_TYPE_LC] = TEXT_PLAIN
+          @ct = TEXT_PLAIN
           @parser = Parser.new(self)
         end
 
@@ -309,8 +309,10 @@ module MIME
             # to remove it from the end of the last body line
             return unless @body_lines
 
-            #            @body_lines.last.sub!(CRLF_ENDING_RGX, '')
-            @body_lines.last.chomp!(CRLF)
+            # the last line ends up frozen --> chomp! fails
+            # @body_lines.last.chomp!(CRLF)
+            last_line = @body_lines.pop.chomp(CRLF)
+            @body_lines.push last_line
             @parts << @body_lines
           end
 
@@ -364,7 +366,7 @@ module MIME
         end
 
         def set_multipart_header
-          @hd['content-type'] = "#{OData::MP_MIXED}; boundary=#{@boundary}"
+          @hd[CTT_TYPE_LC] = "#{Safrano::MP_MIXED}; boundary=#{@boundary}"
         end
 
         def get_http_resp(batcha)
@@ -382,9 +384,7 @@ module MIME
             # of the changes
             batcha.db.transaction do
               begin
-                @response.content = @content.map { |part|
-                  part.get_response(batcha)
-                }
+                @response.content = @content.map { |part| part.get_response(batcha) }
               rescue Sequel::Rollback => e
                 # one of the changes of the changeset has failed
                 # --> provide a dummy empty response for the change-parts
@@ -405,18 +405,18 @@ module MIME
           @response.content = [{ 'odata.error' =>
                                { 'message' =>
                                  'Bad Request: Failed changeset ' } }.to_json]
-          @response.hd = OData::CT_JSON
+          @response.hd = Safrano::CT_JSON
           @response
         end
 
         def unparse(bodyonly = false)
-          b = ''
+          b = +String.new
           unless bodyonly
-            #            b << OData::CONTENT_TYPE << ': ' << @hd[OData::CTT_TYPE_LC] << CRLF
-            b << "#{OData::CONTENT_TYPE}: #{@hd[OData::CTT_TYPE_LC]}#{CRLF}"
+            b << "#{Safrano::CONTENT_TYPE}: #{@hd[CTT_TYPE_LC]}#{CRLF}"
           end
-          b << "#{CRLF}--#{@boundary}#{CRLF}"
-          b << @content.map(&:unparse).join("#{CRLF}--#{@boundary}#{CRLF}")
+
+          b << crbdcr = "#{CRLF}--#{@boundary}#{CRLF}"
+          b << @content.map(&:unparse).join(crbdcr)
           b << "#{CRLF}--#{@boundary}--#{CRLF}"
           b
         end
@@ -436,15 +436,14 @@ module MIME
 
         def initialize
           @hd = {}
-          @content = ''
+          @content = +String.new
         end
 
         def unparse
-          b = "#{@http_method} #{@uri} HTTP/1.1#{CRLF}"
+          b = +"#{@http_method} #{@uri} HTTP/1.1#{CRLF}"
           @hd.each { |k, v| b << "#{k}: #{v}#{CRLF}" }
-          #          @hd.each { |k, v| b << k.to_s << ': ' << v.to_s << CRLF }
           b << CRLF
-          b << @content if @content != ''
+          b << @content unless content.empty?
           b
         end
       end
@@ -470,10 +469,9 @@ module MIME
         end
 
         def unparse
-          b = String.new(APPLICATION_HTTP_11)
+          b = +String.new(APPLICATION_HTTP_11)
           b << "#{@status} #{StatusMessage[@status]} #{CRLF}"
           @hd.each { |k, v| b << "#{k}: #{v}#{CRLF}" }
-          #          @hd.each { |k, v| b << k.to_s << ': ' << v.to_s << CRLF }
           b << CRLF
           b << @content.join if @content
           b
@@ -482,15 +480,14 @@ module MIME
 
       # For application/http . Content is either a Request or a Response
       class Http < Media
-        HTTP_MTHS_RGX = 'POST|GET|PUT|MERGE|PATCH|DELETE'.freeze
+        HTTP_MTHS_RGX = 'POST|GET|PUT|MERGE|PATCH|DELETE'
         HTTP_R_RGX = %r{^(#{HTTP_MTHS_RGX})\s+(\S*)\s?(HTTP/1\.1)\s*$}.freeze
-        HEADER_RGX = %r{^([a-zA-Z\-]+):\s*([0-9a-zA-Z\-\/,\s]+;?\S*)\s*$}.freeze
+        HEADER_RGX = %r{^([a-zA-Z\-]+):\s*([0-9a-zA-Z\-/,\s]+;?\S*)\s*$}.freeze
         HTTP_RESP_RGX = %r{^HTTP/1\.1\s(\d+)\s}.freeze
 
         # Parser for Http Media
         class Parser
           HMD_RGX = /^([\w-]+)\s*:\s*(.*)/.freeze
-          CRLF_LINE_RGX = /^#{CRLF}$/.freeze
 
           def initialize(target)
             @state = :http
@@ -523,7 +520,6 @@ module MIME
             if (hmd = HMD_RGX.match(line))
               @target.content.hd[hmd[1].downcase] = hmd[2].strip
             elsif CRLF == line
-              #            elsif CRLF_LINE_RGX =~ line
               @state = :b
             else
               @body_lines << line
@@ -575,7 +571,7 @@ module MIME
         end
 
         def unparse
-          b =  "Content-Type: #{@ct}#{CRLF}"
+          b =  +"Content-Type: #{@ct}#{CRLF}"
           b << "Content-Transfer-Encoding: binary#{CRLF}#{CRLF}"
           b << @content.unparse
           b