safrano 0.4.0 → 0.4.5

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'
+    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
@@ -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,42 +1,22 @@
+# frozen_string_literal: true
 
 require 'json'
 require 'rexml/document'
-require_relative 'safrano/multipart.rb'
-require_relative 'safrano/core.rb'
-require_relative 'odata/entity.rb'
-require_relative 'odata/attribute.rb'
-require_relative 'odata/navigation_attribute.rb'
-require_relative 'odata/collection.rb'
-require_relative 'safrano/service.rb'
-require_relative '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 'safrano/sequel_join_by_paths.rb'
+require_relative 'safrano/sequel_join_by_paths'
 require_relative 'safrano/rack_app'
-require_relative 'safrano/odata_rack_builder'
-require_relative 'safrano/version'
-
-# 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
-
-# needed for ruby < 2.5
-class Dir
-  def self.each_child(dir)
-    Dir.foreach(dir) {|x| 
-      next if ( ( x == '.' ) or  ( x == '..' ) )
-      yield x
-     }
-  end unless respond_to? :each_child
-end
+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 self.valid(result)
+      Contract::Valid.new(result)
+    end
+
+    def self.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
+      valid(contracts.map(&:result))
+    end
+
+    # shortcut for Contract.and(*contracts).collect_result!
+    def self.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)
+      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

@@ -1,118 +1,43 @@
-#!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # our main namespace
-module OData
+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 = ''
+  ARY_204_EMPTY_HASH_ARY = [204, EMPTY_HASH, EMPTY_ARRAY].freeze
+  SPACE = ' '
+  COMMA = ','
+
   # 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
+  CONTENT_TYPE = 'Content-Type'
+  CTT_TYPE_LC = 'content-type'
+  TEXTPLAIN_UTF8 = 'text/plain;charset=utf-8'
+  APPJSON = 'application/json'
+  APPXML = 'application/xml'
+  MP_MIXED = 'multipart/mixed'
+  APPXML_UTF8 = 'application/xml;charset=utf-8'
+  APPATOMXML_UTF8 = 'application/atomsvc+xml;charset=utf-8'
+  APPJSON_UTF8 = 'application/json;charset=utf-8'
 
   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
 
-  # Type mapping DB --> Edm
-  #  TypeMap = {"INTEGER" => "Edm.Int32" , "TEXT" => "Edm.String",
-  # "STRING" => "Edm.String"}
-  # Todo: complete mapping... this is just for the most common ones
-
-  # TODO: use Sequel GENERIC_TYPES: -->
-  # Constants
-  # GENERIC_TYPES = %w'String Integer Float Numeric BigDecimal Date DateTime
-  # Time File TrueClass FalseClass'.freeze
-  # Classes specifying generic types that Sequel will convert to
-  # database-specific types.
-  DB_TYPE_STRING_RGX = /\ACHAR\s*\(\d+\)\z/.freeze
+  module NavigationInfo
+    attr_reader :nav_parent
+    attr_reader :navattr_reflection
+    attr_reader :nav_name
 
-# TODO... complete; used in $metadata
-  def self.get_edm_type(db_type:)
-    case db_type.upcase
-    when 'INTEGER'
-      'Edm.Int32'
-    when 'TEXT', 'STRING'
-      'Edm.String'
-    else
-      'Edm.String' if DB_TYPE_STRING_RGX =~ db_type.upcase
+    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
-
-module REXML
-  # some small extensions
-  class Document
-    def to_pretty_xml
-      formatter = REXML::Formatters::Pretty.new(2)
-      formatter.compact = true
-      strio = ''
-      formatter.write(root, strio)
-      strio
-    end
-  end
-end
-
-# Core
-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
-    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] || ''
-      else
-        ''
-      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/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