odata4 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9adfc90966866d69ec4082404f10a60cd8404563
-  data.tar.gz: 293c604e274b209c738496e41318f2441d41e159
+  metadata.gz: a9465568c8c8b575d04c9367e8c51b3c6161a8b9
+  data.tar.gz: 1da130b782964c9ccf410e74a6309c78bd13e050
 SHA512:
-  metadata.gz: 52bad8a865f20e227aa331f09e680d857caaaa3da8e70df5be873d78477d96b7e4451506e1a70efec9239034c4e98693c0f7b5600f78e5f383fcb56249e6085c
-  data.tar.gz: c1868354a432bed72b9b6db7b0e76d6194fd221e05827d3077cdaf9d258687e46bd489a444132154eb95a4835f959ca18e7f64c22dbaf49a41a1299f6d3be382
+  metadata.gz: c2949929b4b43e3fde0b26d845f630d59dfc7d5936717dca0531c11bba7514487c72e889a372863f8be2c2934ff85dee1cd8df9dc67193d145ca0245f42133cf
+  data.tar.gz: a1de80f33ab0719567cabbc948dc645a31363697ee705ba0654cabb31fbaffeb130cb751ed061b55dccf169f977e62689b96d3b6180a4052d1fdd31a10b7b5ca

data/.ruby-version

@@ -1 +1 @@
-2.1
+2.2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.8.2
+
+* [Refactor] Moved `ComplexType` and `EnumType` class into `Schema`, respective property types into `Properties` namespace
+
 ## 0.8.1
 
 * [New Feature] Basic support for `Collection` property type

data/lib/odata4.rb

@@ -16,8 +16,6 @@ require 'odata4/property_registry'
 require 'odata4/property'
 require 'odata4/properties'
 require 'odata4/navigation_property'
-require 'odata4/complex_type'
-require 'odata4/enum_type'
 require 'odata4/entity'
 require 'odata4/entity_container'
 require 'odata4/entity_set'

data/lib/odata4/entity.rb

@@ -56,7 +56,7 @@ module OData4
     # @param property_name [to_s]
     # @return [*]
     def [](property_name)
-      if get_property(property_name).is_a?(::OData4::ComplexType::Property)
+      if get_property(property_name).is_a?(::OData4::Properties::Complex)
         get_property(property_name)
       else
         get_property(property_name).value

data/lib/odata4/properties.rb

@@ -5,10 +5,12 @@ require 'odata4/properties/number'
 require 'odata4/properties/binary'
 require 'odata4/properties/boolean'
 require 'odata4/properties/collection'
+require 'odata4/properties/complex'
 require 'odata4/properties/date'
 require 'odata4/properties/date_time'
 require 'odata4/properties/date_time_offset'
 require 'odata4/properties/decimal'
+require 'odata4/properties/enum'
 require 'odata4/properties/float'
 require 'odata4/properties/geography'
 require 'odata4/properties/guid'
@@ -20,7 +22,11 @@ require 'odata4/properties/time_of_day'
 OData4::Properties.constants.each do |property_name|
   klass = OData4::Properties.const_get(property_name)
   if klass.is_a?(Class)
-    property = klass.new('test', nil)
-    OData4::PropertyRegistry.add(property.type, property.class)
+    begin
+      property = klass.new('test', nil)
+      OData4::PropertyRegistry.add(property.type, property.class)
+    rescue NotImplementedError
+      # Abstract type classes cannot be instantiated, ignore
+    end
   end
 end

data/lib/odata4/{complex_type/property.rb → properties/complex.rb}

@@ -1,8 +1,8 @@
 module OData4
-  class ComplexType
+  module Properties
     # Abstract base class for OData4 ComplexTypes
-    # @see [OData4::ComplexType]
-    class Property < OData4::Property
+    # @see [OData4::Schema::ComplexType]
+    class Complex < OData4::Property
       def initialize(name, value, options = {})
         super(name, value, options)
         init_properties

data/lib/odata4/{enum_type/property.rb → properties/enum.rb}

@@ -1,8 +1,8 @@
 module OData4
-  class EnumType
+  module Properties
     # Abstract base class for OData4 EnumTypes
-    # @see [OData4::EnumType]
-    class Property < OData4::Property
+    # @see [OData4::Schema::EnumType]
+    class Enum < OData4::Property
       # Returns the property value, properly typecast
       # @return [String, nil]
       def value

data/lib/odata4/schema.rb

@@ -1,3 +1,6 @@
+require 'odata4/schema/complex_type'
+require 'odata4/schema/enum_type'
+
 module OData4
   class Schema
     # The schema's parent service
@@ -37,23 +40,23 @@ module OData4
     end
 
     # Returns a list of `ComplexType`s defined by the schema.
-    # @return [Hash<String, OData4::ComplexType>]
+    # @return [Hash<String, OData4::Schema::ComplexType>]
     def complex_types
       @complex_types ||= metadata.xpath('//ComplexType').map do |entity|
         [
           entity.attributes['Name'].value,
-          ::OData4::ComplexType.new(entity, self)
+          ComplexType.new(entity, self)
         ]
       end.to_h
     end
 
     # Returns a list of EnumTypes defined by the schema.
-    # @return [Hash<String, OData4::EnumType>]
+    # @return [Hash<String, OData4::Schema::EnumType>]
     def enum_types
       @enum_types ||= metadata.xpath('//EnumType').map do |entity|
         [
           entity.attributes['Name'].value,
-          ::OData4::EnumType.new(entity, self)
+          EnumType.new(entity, self)
         ]
       end.to_h
     end

data/lib/odata4/schema/complex_type.rb

@@ -0,0 +1,79 @@
+module OData4
+  class Schema
+    # ComplexTypes are used in OData4 to either encapsulate richer data types for
+    # use as Entity properties. ComplexTypes are composed of properties the same
+    # way that Entities are and, so, the interface for working with the various
+    # properties of a ComplexType mimics that of Entities.
+    class ComplexType
+      # Creates a new ComplexType based on the supplied options.
+      # @param type_xml [Nokogiri::XML::Element]
+      # @param service [OData4::Service]
+      def initialize(type_definition, schema)
+        @type_definition = type_definition
+        @schema          = schema
+      end
+
+      # The name of the ComplexType
+      # @return [String]
+      def name
+        @name ||= type_definition.attributes['Name'].value
+      end
+
+      # Returns the namespaced type for the ComplexType.
+      # @return [String]
+      def type
+        "#{namespace}.#{name}"
+      end
+
+      # Returns the namespace this ComplexType belongs to.
+      # @return [String]
+      def namespace
+        @namespace ||= service.namespace
+      end
+
+      # Returns this ComplexType's properties.
+      # @return [Hash<String, OData4::Property>]
+      def properties
+        @properties ||= collect_properties
+      end
+
+      # Returns a list of this ComplexType's property names.
+      # @return [Array<String>]
+      def property_names
+        @property_names ||= properties.keys
+      end
+
+      # Returns the property class that implements this `ComplexType`.
+      # @return [Class < OData4::Properties::Complex]
+      def property_class
+        @property_class ||= lambda { |type, complex_type|
+          klass = Class.new ::OData4::Properties::Complex
+          klass.send(:define_method, :type) { type }
+          klass.send(:define_method, :complex_type) { complex_type }
+          klass
+        }.call(type, self)
+      end
+
+      private
+
+      def schema
+        @schema
+      end
+
+      def service
+        @schema.service
+      end
+
+      def type_definition
+        @type_definition
+      end
+
+      def collect_properties
+        Hash[type_definition.xpath('./Property').map do |property_xml|
+          property_name, property = schema.send(:process_property_from_xml, property_xml)
+          [property_name, property]
+        end]
+      end
+    end
+  end
+end

data/lib/odata4/schema/enum_type.rb

@@ -0,0 +1,95 @@
+module OData4
+  class Schema
+    # Enumeration types are nominal types that represent a series of related values.
+    # Enumeration types expose these related values as members of the enumeration.
+    class EnumType
+      # Creates a new EnumType based on the supplied options.
+      # @param type_xml [Nokogiri::XML::Element]
+      # @param service [OData4::Service]
+      # @return [self]
+      def initialize(type_definition, schema)
+        @type_definition = type_definition
+        @schema          = schema
+      end
+
+      # The name of the EnumType
+      # @return [String]
+      def name
+        options['Name']
+      end
+
+      # Returns the namespaced type for the EnumType.
+      # @return [String]
+      def type
+        "#{namespace}.#{name}"
+      end
+
+      # Whether this EnumType supports setting multiple values.
+      # @return [Boolean]
+      def is_flags?
+        options['IsFlags'] == 'true'
+      end
+
+      # The underlying type of this EnumType.
+      # @return [String]
+      def underlying_type
+        options['UnderlyingType'] || 'Edm.Int32'
+      end
+
+      # Returns the namespace this EnumType belongs to.
+      # @return [String]
+      def namespace
+        @namespace ||= service.namespace
+      end
+
+      # Returns the members of this EnumType and their values.
+      # @return [Hash]
+      def members
+        @members ||= collect_members
+      end
+
+      # Returns the property class that implements this `EnumType`.
+      # @return [Class < OData4::Properties::Enum]
+      def property_class
+        @property_class ||= lambda { |type, members, is_flags|
+          klass = Class.new ::OData4::Properties::Enum
+          klass.send(:define_method, :type) { type }
+          klass.send(:define_method, :members) { members }
+          klass.send(:define_method, :is_flags?) { is_flags }
+          klass
+        }.call(type, members, is_flags?)
+      end
+
+      # Returns the value of the requested member.
+      # @param member_name [to_s]
+      # @return [*]
+      def [](member_name)
+        members.invert[member_name.to_s]
+      end
+
+      private
+
+      def service
+        @schema.service
+      end
+
+      def type_definition
+        @type_definition
+      end
+
+      def options
+        @options = type_definition.attributes.map do |name, attr|
+          [name, attr.value]
+        end.to_h
+      end
+
+      def collect_members
+        Hash[type_definition.xpath('./Member').map.with_index do |member_xml, index|
+          member_name  = member_xml.attributes['Name'].value
+          member_value = member_xml.attributes['Value'].andand.value.andand.to_i
+          [member_value || index, member_name]
+        end]
+      end
+    end
+  end
+end

data/lib/odata4/service.rb

@@ -111,7 +111,7 @@ module OData4
     end
 
     # Returns a list of `ComplexType`s used by the service.
-    # @return [Hash<String, OData4::ComplexType>]
+    # @return [Hash<String, OData4::Schema::ComplexType>]
     def complex_types
       @complex_types ||= schemas.map do |namespace, schema|
         schema.complex_types.map do |name, complex_type|
@@ -121,7 +121,7 @@ module OData4
     end
 
     # Returns a list of `EnumType`s used by the service
-    # @return [Hash<String, OData4::EnumType>]
+    # @return [Hash<String, OData4::Schema::EnumType>]
     def enum_types
       @enum_types ||= schemas.map do |namespace, schema|
         schema.enum_types.map do |name, enum_type|

data/lib/odata4/version.rb

@@ -1,3 +1,3 @@
 module OData4
-  VERSION = '0.8.1'
+  VERSION = '0.8.2'
 end

data/spec/odata4/entity/shared_examples.rb

@@ -65,7 +65,7 @@ shared_examples 'a valid supplier' do
   # Check property types
   it { expect(subject.get_property('ID')).to be_a(OData4::Properties::Integer) }
   it { expect(subject.get_property('Name')).to be_a(OData4::Properties::String) }
-  it { expect(subject.get_property('Address')).to be_a(OData4::ComplexType::Property) }
+  it { expect(subject.get_property('Address')).to be_a(OData4::Properties::Complex) }
   it { expect(subject.get_property('Location')).to be_a(OData4::Properties::Geography::Point) }
   # it { expect(subject.get_property('Products')).to be_a(OData4::NavigationProperty::Proxy)}
 

data/spec/odata4/{complex_type_spec.rb → schema/complex_type_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe OData4::ComplexType, vcr: {cassette_name: 'complex_type_specs'} do
+describe OData4::Schema::ComplexType, vcr: {cassette_name: 'schema/complex_type_specs'} do
   before(:example) do
     OData4::Service.open('http://services.odata.org/V4/OData/OData.svc', name: 'ODataDemo')
   end
@@ -27,7 +27,7 @@ describe OData4::ComplexType, vcr: {cassette_name: 'complex_type_specs'} do
 
   # Check property instance inheritance hierarchy
   it { expect(subject).to be_a(OData4::Property) }
-  it { expect(subject).to be_a(OData4::ComplexType::Property) }
+  it { expect(subject).to be_a(OData4::Properties::Complex) }
 
   it { expect(subject).to respond_to(:name) }
   it { expect(subject).to respond_to(:type) }

data/spec/odata4/{enum_type_spec.rb → schema/enum_type_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe OData4::EnumType, vcr: {cassette_name: 'enum_type_specs'} do
+describe OData4::Schema::EnumType, vcr: {cassette_name: 'schema/enum_type_specs'} do
   before(:example) do
     OData4::Service.open('http://services.odata.org/V4/OData/OData.svc', name: 'ODataDemo', metadata_file: metadata_file)
   end
@@ -22,7 +22,7 @@ describe OData4::EnumType, vcr: {cassette_name: 'enum_type_specs'} do
 
   # Check property instance inheritance hierarchy
   it { expect(subject).to be_a(OData4::Property) }
-  it { expect(subject).to be_a(OData4::EnumType::Property) }
+  it { expect(subject).to be_a(OData4::Properties::Enum) }
 
   it { expect(subject).to respond_to(:name) }
   it { expect(subject).to respond_to(:type) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: odata4
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Christoph Wagner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -200,23 +200,21 @@ files:
 - Rakefile
 - TODO.md
 - lib/odata4.rb
-- lib/odata4/complex_type.rb
-- lib/odata4/complex_type/property.rb
 - lib/odata4/entity.rb
 - lib/odata4/entity_container.rb
 - lib/odata4/entity_set.rb
-- lib/odata4/enum_type.rb
-- lib/odata4/enum_type/property.rb
 - lib/odata4/navigation_property.rb
 - lib/odata4/navigation_property/proxy.rb
 - lib/odata4/properties.rb
 - lib/odata4/properties/binary.rb
 - lib/odata4/properties/boolean.rb
 - lib/odata4/properties/collection.rb
+- lib/odata4/properties/complex.rb
 - lib/odata4/properties/date.rb
 - lib/odata4/properties/date_time.rb
 - lib/odata4/properties/date_time_offset.rb
 - lib/odata4/properties/decimal.rb
+- lib/odata4/properties/enum.rb
 - lib/odata4/properties/float.rb
 - lib/odata4/properties/geography.rb
 - lib/odata4/properties/geography/base.rb
@@ -241,6 +239,8 @@ files:
 - lib/odata4/query/in_batches.rb
 - lib/odata4/railtie.rb
 - lib/odata4/schema.rb
+- lib/odata4/schema/complex_type.rb
+- lib/odata4/schema/enum_type.rb
 - lib/odata4/service.rb
 - lib/odata4/service/request.rb
 - lib/odata4/service/response.rb
@@ -260,7 +260,6 @@ files:
 - spec/fixtures/files/products.xml
 - spec/fixtures/files/supplier_0.json
 - spec/fixtures/files/supplier_0.xml
-- spec/fixtures/vcr_cassettes/complex_type_specs.yml
 - spec/fixtures/vcr_cassettes/entity_set_specs.yml
 - spec/fixtures/vcr_cassettes/entity_set_specs/bad_entry.yml
 - spec/fixtures/vcr_cassettes/entity_set_specs/existing_entry.yml
@@ -269,16 +268,15 @@ files:
 - spec/fixtures/vcr_cassettes/navigation_property_proxy_specs.yml
 - spec/fixtures/vcr_cassettes/query/result_specs.yml
 - spec/fixtures/vcr_cassettes/query_specs.yml
+- spec/fixtures/vcr_cassettes/schema/complex_type_specs.yml
 - spec/fixtures/vcr_cassettes/service/request_specs.yml
 - spec/fixtures/vcr_cassettes/service_registry_specs.yml
 - spec/fixtures/vcr_cassettes/service_specs.yml
 - spec/fixtures/vcr_cassettes/usage_example_specs.yml
-- spec/odata4/complex_type_spec.rb
 - spec/odata4/entity/shared_examples.rb
 - spec/odata4/entity_container_spec.rb
 - spec/odata4/entity_set_spec.rb
 - spec/odata4/entity_spec.rb
-- spec/odata4/enum_type_spec.rb
 - spec/odata4/navigation_property/proxy_spec.rb
 - spec/odata4/navigation_property_spec.rb
 - spec/odata4/properties/binary_spec.rb
@@ -302,6 +300,8 @@ files:
 - spec/odata4/property_spec.rb
 - spec/odata4/query/criteria_spec.rb
 - spec/odata4/query_spec.rb
+- spec/odata4/schema/complex_type_spec.rb
+- spec/odata4/schema/enum_type_spec.rb
 - spec/odata4/schema_spec.rb
 - spec/odata4/service/request_spec.rb
 - spec/odata4/service/response_spec.rb
@@ -345,7 +345,6 @@ test_files:
 - spec/fixtures/files/products.xml
 - spec/fixtures/files/supplier_0.json
 - spec/fixtures/files/supplier_0.xml
-- spec/fixtures/vcr_cassettes/complex_type_specs.yml
 - spec/fixtures/vcr_cassettes/entity_set_specs.yml
 - spec/fixtures/vcr_cassettes/entity_set_specs/bad_entry.yml
 - spec/fixtures/vcr_cassettes/entity_set_specs/existing_entry.yml
@@ -354,16 +353,15 @@ test_files:
 - spec/fixtures/vcr_cassettes/navigation_property_proxy_specs.yml
 - spec/fixtures/vcr_cassettes/query/result_specs.yml
 - spec/fixtures/vcr_cassettes/query_specs.yml
+- spec/fixtures/vcr_cassettes/schema/complex_type_specs.yml
 - spec/fixtures/vcr_cassettes/service/request_specs.yml
 - spec/fixtures/vcr_cassettes/service_registry_specs.yml
 - spec/fixtures/vcr_cassettes/service_specs.yml
 - spec/fixtures/vcr_cassettes/usage_example_specs.yml
-- spec/odata4/complex_type_spec.rb
 - spec/odata4/entity/shared_examples.rb
 - spec/odata4/entity_container_spec.rb
 - spec/odata4/entity_set_spec.rb
 - spec/odata4/entity_spec.rb
-- spec/odata4/enum_type_spec.rb
 - spec/odata4/navigation_property/proxy_spec.rb
 - spec/odata4/navigation_property_spec.rb
 - spec/odata4/properties/binary_spec.rb
@@ -387,6 +385,8 @@ test_files:
 - spec/odata4/property_spec.rb
 - spec/odata4/query/criteria_spec.rb
 - spec/odata4/query_spec.rb
+- spec/odata4/schema/complex_type_spec.rb
+- spec/odata4/schema/enum_type_spec.rb
 - spec/odata4/schema_spec.rb
 - spec/odata4/service/request_spec.rb
 - spec/odata4/service/response_spec.rb

data/lib/odata4/complex_type.rb

@@ -1,79 +0,0 @@
-require 'odata4/complex_type/property'
-
-module OData4
-  # ComplexTypes are used in OData4 to either encapsulate richer data types for
-  # use as Entity properties. ComplexTypes are composed of properties the same
-  # way that Entities are and, so, the interface for working with the various
-  # properties of a ComplexType mimics that of Entities.
-  class ComplexType
-    # Creates a new ComplexType based on the supplied options.
-    # @param type_xml [Nokogiri::XML::Element]
-    # @param service [OData4::Service]
-    def initialize(type_definition, schema)
-      @type_definition = type_definition
-      @schema          = schema
-    end
-
-    # The name of the ComplexType
-    # @return [String]
-    def name
-      @name ||= type_definition.attributes['Name'].value
-    end
-
-    # Returns the namespaced type for the ComplexType.
-    # @return [String]
-    def type
-      "#{namespace}.#{name}"
-    end
-
-    # Returns the namespace this ComplexType belongs to.
-    # @return [String]
-    def namespace
-      @namespace ||= service.namespace
-    end
-
-    # Returns this ComplexType's properties.
-    # @return [Hash<String, OData4::Property>]
-    def properties
-      @properties ||= collect_properties
-    end
-
-    # Returns a list of this ComplexType's property names.
-    # @return [Array<String>]
-    def property_names
-      @property_names ||= properties.keys
-    end
-
-    # Returns the property class that implements this `ComplexType`.
-    # @return [Class < OData4::ComplexType::Property]
-    def property_class
-      @property_class ||= lambda { |type, complex_type|
-        klass = Class.new ::OData4::ComplexType::Property
-        klass.send(:define_method, :type) { type }
-        klass.send(:define_method, :complex_type) { complex_type }
-        klass
-      }.call(type, self)
-    end
-
-    private
-
-    def schema
-      @schema
-    end
-
-    def service
-      @schema.service
-    end
-
-    def type_definition
-      @type_definition
-    end
-
-    def collect_properties
-      Hash[type_definition.xpath('./Property').map do |property_xml|
-        property_name, property = schema.send(:process_property_from_xml, property_xml)
-        [property_name, property]
-      end]
-    end
-  end
-end

data/lib/odata4/enum_type.rb

@@ -1,95 +0,0 @@
-require 'odata4/enum_type/property'
-
-module OData4
-  # Enumeration types are nominal types that represent a series of related values.
-  # Enumeration types expose these related values as members of the enumeration.
-  class EnumType
-    # Creates a new EnumType based on the supplied options.
-    # @param type_xml [Nokogiri::XML::Element]
-    # @param service [OData4::Service]
-    # @return [self]
-    def initialize(type_definition, schema)
-      @type_definition = type_definition
-      @schema          = schema
-    end
-
-    # The name of the EnumType
-    # @return [String]
-    def name
-      options['Name']
-    end
-
-    # Returns the namespaced type for the EnumType.
-    # @return [String]
-    def type
-      "#{namespace}.#{name}"
-    end
-
-    # Whether this EnumType supports setting multiple values.
-    # @return [Boolean]
-    def is_flags?
-      options['IsFlags'] == 'true'
-    end
-
-    # The underlying type of this EnumType.
-    # @return [String]
-    def underlying_type
-      options['UnderlyingType'] || 'Edm.Int32'
-    end
-
-    # Returns the namespace this EnumType belongs to.
-    # @return [String]
-    def namespace
-      @namespace ||= service.namespace
-    end
-
-    # Returns the members of this EnumType and their values.
-    # @return [Hash]
-    def members
-      @members ||= collect_members
-    end
-
-    # Returns the property class that implements this `EnumType`.
-    # @return [Class < OData4::EnumType::Property]
-    def property_class
-      @property_class ||= lambda { |type, members, is_flags|
-        klass = Class.new ::OData4::EnumType::Property
-        klass.send(:define_method, :type) { type }
-        klass.send(:define_method, :members) { members }
-        klass.send(:define_method, :is_flags?) { is_flags }
-        klass
-      }.call(type, members, is_flags?)
-    end
-
-    # Returns the value of the requested member.
-    # @param member_name [to_s]
-    # @return [*]
-    def [](member_name)
-      members.invert[member_name.to_s]
-    end
-
-    private
-
-    def service
-      @schema.service
-    end
-
-    def type_definition
-      @type_definition
-    end
-
-    def options
-      @options = type_definition.attributes.map do |name, attr|
-        [name, attr.value]
-      end.to_h
-    end
-
-    def collect_members
-      Hash[type_definition.xpath('./Member').map.with_index do |member_xml, index|
-        member_name  = member_xml.attributes['Name'].value
-        member_value = member_xml.attributes['Value'].andand.value.andand.to_i
-        [member_value || index, member_name]
-      end]
-    end
-  end
-end