odata4 0.7.0

data/lib/odata4/properties/geography/line_string.rb

@@ -0,0 +1,33 @@
+module OData4
+  module Properties
+    module Geography
+      class LineString < Base
+        def type
+          'Edm.GeographyLineString'
+        end
+
+        def coords_to_s
+          value.map { |pos| pos.join(' ') }.join(',')
+        end
+
+        def coords_from_s(str)
+          str.split(',').map { |pos| pos.split(' ').map(&:to_f) }
+        end
+
+        def xml_value
+          value.map do |coords|
+            { pos: coords.join(' ') }
+          end
+        end
+
+        private
+
+        def self.parse_xml(property_xml)
+          property_xml.xpath('//pos').map do |el|
+            el.content.split(' ').map(&:to_f)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/odata4/properties/geography/point.rb

@@ -0,0 +1,31 @@
+module OData4
+  module Properties
+    module Geography
+      class Point < Base
+        def type
+          'Edm.GeographyPoint'
+        end
+
+        def coords_to_s
+          value.join(' ')
+        end
+
+        def coords_from_s(str)
+          str.split(' ').map(&:to_f)
+        end
+
+        def xml_value
+          { pos: coords_to_s }
+        end
+
+        private
+
+        def self.parse_xml(property_xml)
+          property_xml.xpath('//pos').map do |el|
+            el.content.split(' ').map(&:to_f)
+          end.flatten
+        end
+      end
+    end
+  end
+end

data/lib/odata4/properties/geography/polygon.rb

@@ -0,0 +1,38 @@
+module OData4
+  module Properties
+    module Geography
+      class Polygon < Base
+        def type
+          'Edm.GeographyPolygon'
+        end
+
+        def coords_to_s
+          '(' + value.map { |pos| pos.join(' ') }.join(',') + ')'
+        end
+
+        def coords_from_s(str)
+          str.gsub(/[()]/, '')
+             .split(',').map { |pos| pos.split(' ').map(&:to_f) }
+        end
+
+        def xml_value
+          {
+            exterior: {
+              LinearRing: value.map do |coords|
+                { pos: coords.join(' ') }
+              end
+            }
+          }
+        end
+
+        private
+
+        def self.parse_xml(property_xml)
+          property_xml.xpath('//pos').map do |el|
+            el.content.split(' ').map(&:to_f)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/odata4/properties/guid.rb

@@ -0,0 +1,17 @@
+module OData4
+  module Properties
+    # Defines the GUID OData4 type.
+    class Guid < OData4::Property
+      # The OData4 type name
+      def type
+        'Edm.Guid'
+      end
+
+      # Value to be used in URLs.
+      # @return [String]
+      def url_value
+        "guid'#{value}'"
+      end
+    end
+  end
+end

data/lib/odata4/properties/integer.rb

@@ -0,0 +1,107 @@
+module OData4
+  module Properties
+    # Defines the Integer OData4 type.
+    class Integer < OData4::Property
+      include OData4::Properties::Number
+
+      # Returns the property value, properly typecast
+      # @return [Integer,nil]
+      def value
+        if (@value.nil? || @value.empty?) && allows_nil?
+          nil
+        else
+          @value.to_i
+        end
+      end
+
+      # Sets the property value
+      # @params new_value [to_i]
+      def value=(new_value)
+        validate(new_value.to_i)
+        @value = new_value.to_i.to_s
+      end
+
+      # The OData4 type name
+      def type
+        'Edm.Int64'
+      end
+
+      private
+
+      def exponent_size
+        63
+      end
+
+      def min_value
+        @min ||= -(2**exponent_size)
+      end
+
+      def max_value
+        @max ||= (2**exponent_size)-1
+      end
+    end
+
+    # Defines the Integer (16 bit) OData4 type.
+    class Int16 < Integer
+      # The OData4 type name
+      def type
+        'Edm.Int16'
+      end
+
+      private
+
+      def exponent_size
+        15
+      end
+    end
+
+    # Defines the Integer (32 bit) OData4 type.
+    class Int32 < Integer
+      # The OData4 type name
+      def type
+        'Edm.Int32'
+      end
+
+      private
+
+      def exponent_size
+        31
+      end
+    end
+
+    # Defines the Integer (64 bit) OData4 type.
+    class Int64 < Integer; end
+
+    # Defines the Byte OData4 type.
+    class Byte < Integer
+      # The OData4 type name
+      def type
+        'Edm.Byte'
+      end
+
+      private
+
+      def exponent_size
+        8
+      end
+
+      def min_value
+        0
+      end
+    end
+
+    # Defines the Signed Byte OData4 type.
+    class SByte < Integer
+      # The OData4 type name
+      def type
+        'Edm.SByte'
+      end
+
+      private
+
+      def exponent_size
+        7
+      end
+    end
+  end
+end

data/lib/odata4/properties/number.rb

@@ -0,0 +1,14 @@
+module OData4
+  module Properties
+    # Defines common behavior for OData4 numeric types.
+    module Number
+      private
+
+      def validate(value)
+        if value > max_value || value < min_value
+          raise ::ArgumentError, "Value is outside accepted range: #{min_value} to #{max_value}"
+        end
+      end
+    end
+  end
+end

data/lib/odata4/properties/string.rb

@@ -0,0 +1,72 @@
+module OData4
+  module Properties
+    # Defines the String OData4 type.
+    class String < OData4::Property
+      # Returns the property value, properly typecast
+      # @return [String,nil]
+      def value
+        if (@value.nil? || @value.empty?) && allows_nil?
+          nil
+        else
+          encode_value(@value)
+        end
+      end
+
+      # Sets the property value
+      # @params new_value [to_s,nil]
+      def value=(new_value)
+        validate(new_value)
+        @value = new_value.nil? ? nil : encode_value(new_value.to_s)
+      end
+
+      # Value to be used in URLs.
+      # @return [String]
+      def url_value
+        "'#{value}'"
+      end
+
+      # The OData4 type name
+      def type
+        'Edm.String'
+      end
+
+      # Is the property value Unicode encoded
+      def is_unicode?
+        options[:unicode]
+      end
+
+      # Does the property have a default value
+      def has_default_value?
+        not(options[:default_value].nil?)
+      end
+
+      # The default value for the property
+      def default_value
+        options[:default_value]
+      end
+
+      private
+
+      def default_options
+        super.merge({
+          unicode: true,
+          default_value: nil
+        })
+      end
+
+      def validate(new_value)
+        if new_value.nil? && !allows_nil?
+          raise ArgumentError, 'This property does not allow for nil values to be set'
+        end
+      end
+
+      def encode_value(new_value)
+        if options[:unicode]
+          new_value.encode(Encoding::UTF_8)
+        else
+          new_value.encode(Encoding::ASCII)
+        end
+      end
+    end
+  end
+end

data/lib/odata4/properties/time.rb

@@ -0,0 +1,40 @@
+module OData4
+  module Properties
+    # Defines the Time OData4 type.
+    class Time < OData4::Property
+      # Returns the property value, properly typecast
+      # @return [Time,nil]
+      def value
+        if (@value.nil? || @value.empty?) && allows_nil?
+          nil
+        else
+          ::Time.strptime(@value, '%H:%M:%S%:z')
+        end
+      end
+
+      # Sets the property value
+      # @params new_value [Time]
+      def value=(new_value)
+        validate(new_value)
+        @value = parse_value(new_value)
+      end
+
+      # The OData4 type name
+      def type
+        'Edm.Time'
+      end
+
+      private
+
+      def validate(value)
+        unless value.is_a?(::Time)
+          raise ArgumentError, 'Value is not a time object'
+        end
+      end
+
+      def parse_value(value)
+        value.strftime('%H:%M:%S%:z')
+      end
+    end
+  end
+end

data/lib/odata4/properties/time_of_day.rb

@@ -0,0 +1,27 @@
+require 'odata4/properties/date_time'
+
+module OData4
+  module Properties
+    # Defines the Date OData4 type.
+    class TimeOfDay < OData4::Properties::DateTime
+      # The OData4 type name
+      def type
+        'Edm.TimeOfDay'
+      end
+
+      def url_value
+        @value
+      end
+
+      protected
+
+      def date_class
+        ::Time
+      end
+
+      def strptime_format
+        '%H:%M:%S.%L'
+      end
+    end
+  end
+end

data/lib/odata4/property.rb

@@ -0,0 +1,118 @@
+module OData4
+  # OData4::Property represents an abstract property, defining the basic
+  # interface and required methods, with some default implementations. All
+  # supported property types should be implemented under the OData4::Properties
+  # namespace.
+  class Property
+    # The property's name
+    attr_reader :name
+    # The property's value
+    attr_accessor :value
+
+    # Default intialization for a property with a name, value and options.
+    # @param name [to_s]
+    # @param value [to_s,nil]
+    # @param options [Hash]
+    def initialize(name, value, options = {})
+      @name = name.to_s
+      @value = value.nil? ? nil : value.to_s
+      @options = default_options.merge(options)
+    end
+
+    # Abstract implementation, should return property type, based on
+    # OData4::Service metadata in proper implementation.
+    # @raise NotImplementedError
+    def type
+      raise NotImplementedError
+    end
+
+    # Provides for value-based equality checking.
+    # @param other [value] object for comparison
+    # @return [Boolean]
+    def ==(other)
+      self.value == other.value
+    end
+
+    # Whether the property permits a nil value.
+    # (Default=true)
+    # @return [Boolean]
+    def allows_nil?
+      options[:allows_nil]
+    end
+
+    # Whether the property uses strict validation.
+    # (Default=false)
+    # @return [Boolean]
+    def strict?
+      options[:strict]
+    end
+
+    # The configured concurrency mode for the property.
+    # @return [String]
+    def concurrency_mode
+      @concurrecy_mode ||= options[:concurrency_mode]
+    end
+
+    # Value to be used in XML.
+    # @return [String]
+    def xml_value
+      @value
+    end
+
+    # Value to be used in JSON.
+    # @return [*]
+    def json_value
+      value
+    end
+
+    # Value to be used in URLs.
+    # @return [String]
+    def url_value
+      @value
+    end
+
+    # Returns the XML representation of the property to the supplied XML
+    # builder.
+    # @param xml_builder [Nokogiri::XML::Builder]
+    def to_xml(xml_builder)
+      attributes = {
+          'metadata:type' => type,
+      }
+
+      if value.nil?
+        attributes['metadata:null'] = 'true'
+        xml_builder['data'].send(name.to_sym, attributes)
+      else
+        xml_builder['data'].send(name.to_sym, attributes, xml_value)
+      end
+    end
+
+    # Creates a new property instance from an XML element
+    # @param property_xml [Nokogiri::XML::Element]
+    # @param options [Hash]
+    # @return [OData4::Property]
+    def self.from_xml(property_xml, options = {})
+      if property_xml.attributes['null'].andand.value == 'true'
+        content = nil
+      else
+        content = property_xml.content
+      end
+
+      new(property_xml.name, content, options)
+    end
+
+    private
+
+    def default_options
+      {
+        allows_nil:       true,
+        concurrency_mode: :none,
+        strict:           false
+      }
+    end
+
+    def options
+      @options
+    end
+  end
+end