sdl-ng 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c497f1c651686544ac76c0bef8a35a7985d06890
-  data.tar.gz: afed6c73a2b9b35c1a99dbdf1a6dc72c1e49a87b
+  metadata.gz: ed2ffb4ec0dbbbcb9215c77af53ea65ff29697f4
+  data.tar.gz: 123f3cf6588274e6605708bc2fc27c71004702c4
 SHA512:
-  metadata.gz: e4e00d32bc7abf06443de8d8963388ad508972ed3fa3154ce74c5a183e1bd0b47d8fb9e484219d1b53d3522d88602a7127c0ec9f6a7aa4ff6804a87cf792d8b7
-  data.tar.gz: 29fe5546a275bc0be41b44094004cccfe95006907d6de86e0a07378089a5af7e0f0d618e335163780e6a189f5a37e0fd51153be3224c6feb58085e964280eb40
+  metadata.gz: e13f8fb585f8339390a6f82d339ce0daf8b3057467aa67ead071905af9bc125802746b8a984b10198b918cecc57b90e45f07f11099606e2dfd175289a87c0246
+  data.tar.gz: acc087d16fbf6ceb3380e80b6f118d24270c31beb2a0d1a7f757f087e32e07e4c637d3c4da562926d57944fc8daa9f7ec65b7ee3e998503a248a8352e93e96bd

data/examples/translations/en.yml

@@ -2,11 +2,11 @@
 en:
   sdl:
     fact:
-      add_on_repository: The service has an add-on repository.
-      audit_option: The service has an audit option
-      bill: The service billing terms.
-      charge_unit: The unit of service charging, e.g. "per user".
-      cloud_service_model: The cloud service model
+      add_on_repository: Service add-on repo
+      audit_option: Audit option
+      bill: Billing terms
+      charge_unit: Charge unit
+      cloud_service_model: Cloud service model
       communication_protection: The communication with the service is protected
       continuous_service_improvement: The service has continuous service improvement
         means
@@ -101,54 +101,54 @@ en:
     property:
       fact:
         add_on_repository:
-          number_of_add_ons: The number of available add-ons
-          url: The URL of the add-on repository
+          number_of_add_ons: Number of add-ons
+          url: Repository URL
         audit_option:
-          audit_option: The audit option
+          audit_option: Audit option
         bill:
-          billing_term: The billing terms
-          payment_term: The payment terms
+          billing_term: Billing terms
+          payment_term: Payment terms
         charge_unit:
-          charge_unit: The unit of charge
+          charge_unit: Charge unit
         cloud_service_model:
-          cloud_service_model: The cloud service model
+          cloud_service_model: Cloud service model
         communication_protection:
-          communication_protection: The protection means
+          communication_protection: Protection means
         continuous_service_improvement:
-          url: A link to the continuous service improvement
+          url: Link
         data_capability:
-          format: The data format
-          operation: The operation, which can be carried out on the data format
+          format: Format
+          operation: Operation
         data_encryption:
-          key_control: Who excercises control over the encryption keys
+          key_control: Controlling party
         data_location:
-          location: The location of data
+          location: Data location
         documentation:
-          url: The documentation URL
+          url: Documentation URL
         duration:
-          duration: The duration
+          duration: Duration
         establishing_year:
-          year: The year, the service was established
+          year: Established in
         feature:
-          description: The feature description
-          feature: The feature name
+          description: Description
+          feature: Name
         interface_browser_interface:
-          compatible_browsers: The compatible browsers
-          required_plugins: The required browser plugins
+          compatible_browsers: Compatible to
+          required_plugins: Required plugins
         maintenance_maintenance_window:
-          timespan: The timespan of the maintenance window
+          timespan: Maintenance Window
         name:
-          name: The service name
+          name: Service name
         payment_option:
-          payment_option: The payment option
+          payment_option: Payment option
         service_category:
-          service_category: The category of the service
+          service_category: Service category
         service_level_agreement_public_service_level_agreement:
-          url: The URL of the service level agreement
+          url: SLA URL
         service_tag:
-          service_tag: The service tag
+          service_tag: Tag
         status_page:
-          url: The URL of the service status page
+          url: Service status URL
       type:
         browser:
           browser_name: The name of the browser

data/lib/sdl/base/service.rb

@@ -8,6 +8,10 @@ module SDL
 
         @facts, @facades = [], []
       end
+
+      def fact_class_facts_map
+        facts.group_by &:class
+      end
     end
   end
 end

data/lib/sdl/base/type.rb

@@ -8,7 +8,7 @@ module SDL
         attr_accessor :namespace
 
         ##
-        # The local name of the fact, e.g. "Name" or "ServiceInterface". Defaults to the name of the class.
+        # The local name of the type, e.g. "Name" or "ServiceInterface". Defaults to the name of the class.
         #
         # The ServiceCompendium#register_classes_globally method makes this class accessible by a constant of this name
         @local_name
@@ -33,6 +33,18 @@ module SDL
           end
         end
 
+        def propertyless?(including_super = false)
+          properties(including_super).count == 0
+        end
+
+        def single_property?(including_super = false)
+          properties(including_super).count == 1
+        end
+
+        def multi_property?(including_super = true)
+          properties(including_super).count > 1
+        end
+
         def is_sub?
           not [SDL::Base::Type, SDL::Base::Fact].include? superclass
         end
@@ -49,7 +61,7 @@ module SDL
         naming_property = self.class.properties(true).find {|p| p.name.eql?(self.class.to_s.underscore) }
 
         if(naming_property)
-          instance_variable_get "@#{naming_property.name.to_sym}"
+          instance_variable_get("@#{naming_property.name.to_sym}").to_s
         else
           self.class.to_s
         end

data/lib/sdl/ng/version.rb

@@ -1,5 +1,5 @@
 module SDL
   module NG
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/sdl/receivers/type_instance_receiver.rb

@@ -24,7 +24,11 @@ module SDL
                 value = compendium.type_instances[property.type][value] || raise("Could not find instance :#{value.to_s} in predefined #{property.type.name} types")
               end
 
-              instance.send "#{property.name}=", value
+              begin
+                instance.send "#{property.name}=", value
+              rescue RuntimeError => e
+                raise RuntimeError, "Cannot set property '#{property.name}' of Type #{@instance.class.name}: #{e}", e.backtrace
+              end
             end
           else
             # Multi-valued properties are added to by their singular name

data/lib/sdl/receivers/type_receiver.rb

@@ -69,7 +69,16 @@ module SDL
         def add_property(sym, type, multi)
           unless multi
             @klass.class_eval do
-              attr_accessor sym
+              attr_reader sym
+
+              # Setter
+              define_method "#{sym}=" do |value|
+                if type < SDL::Types::SDLSimpleType
+                  instance_variable_set "@#{sym}".to_s, type.new(value)
+                else
+                  instance_variable_set "@#{sym}".to_s, value
+                end
+              end
             end
           else
             # Define accessor method for lists

data/lib/sdl/types.rb

@@ -1,5 +1,5 @@
 require_relative 'types/sdl_type'
-require_relative 'types/sdl_default_type'
+require_relative 'types/sdl_simple_type'
 require_relative 'types/sdl_string'
 require_relative 'types/sdl_description'
 require_relative 'types/sdl_number'

data/lib/sdl/types/sdl_datetime.rb

@@ -1,6 +1,6 @@
 module SDL
   module Types
-    class SDLDatetime < SDLDefaultType
+    class SDLDatetime < SDLSimpleType
       include SDLType
 
       wraps Time

data/lib/sdl/types/sdl_description.rb

@@ -1,10 +1,14 @@
 module SDL
   module Types
-    class SDLDescription < SDLDefaultType
+    class SDLDescription < SDLSimpleType
       include SDLType
 
       wraps String
       codes :description
+
+      def from_nilclass(nilvalue)
+        @value = ""
+      end
     end
   end
 end

data/lib/sdl/types/sdl_duration.rb

@@ -2,7 +2,7 @@ require 'active_support/duration'
 
 module SDL
   module Types
-    class SDLDuration < SDLDefaultType
+    class SDLDuration < SDLSimpleType
       include SDLType
 
       wraps ActiveSupport::Duration

data/lib/sdl/types/sdl_number.rb

@@ -1,9 +1,9 @@
 module SDL
   module Types
-    class SDLNumber < SDLDefaultType
+    class SDLNumber < SDLSimpleType
       include SDLType
 
-      wraps Integer
+      wraps Numeric
       codes :number, :int, :integer
     end
   end

data/lib/sdl/types/sdl_simple_type.rb

@@ -0,0 +1,57 @@
+##
+# Base SDL type.
+#
+# All types share a common constructor, which delegates part of its functionality.
+class SDL::Types::SDLSimpleType
+  include SDL::Types::SDLType
+
+  # The SDL value type value, possibly converted to the wrapped ruby type, e.g., an URI object created from an
+  # "http://" String
+  attr_reader :value
+
+  # The raw value, with which this type was instatiated
+  attr_reader :raw_value
+
+  ##
+  # Creates a new instance of an SDL type.
+  #
+  # Invokes +from_+ methods of subtypes, if +value+ is not subtype of the wrapped Ruby type.
+  #
+  # @param[Object] value
+  #   The instance value. Unless the value class is a subclass of the wrapped Ruby class,
+  #   perform conversion by invoking +from_#{classname}+, e.g. +from_string+ or +from_integer+.
+  #
+  #   Subclasses are expected to implement this conversion function.
+  def initialize(value)
+    @raw_value = value
+
+    if value.class <= self.class.wrapped_type
+      @value = value
+    else
+      begin
+        send(conversion_method_name(value), value)
+      rescue NoMethodError
+        raise "Cannot create instance of #{self.class.name} with a #{value.class.name} value. Please implement #{self.class.name}##{conversion_method_name(value)}"
+      end
+    end
+  end
+
+  def ==(value)
+    @value == value
+  end
+
+  def to_s
+    @value.to_s
+  end
+
+  ##
+  # Designates this SDLType to be a default type, i.e., to be loaded by all ServiceCompendiums automatically
+  def self.inherited(subclass)
+    SDL::Base::ServiceCompendium.default_sdltypes << subclass
+  end
+
+  private
+    def conversion_method_name(value)
+      value.class.name.demodulize.camelize.downcase
+    end
+end

data/lib/sdl/types/sdl_string.rb

@@ -1,6 +1,6 @@
 module SDL
   module Types
-    class SDLString < SDLDefaultType
+    class SDLString < SDLSimpleType
       include SDLType
 
       wraps String

data/lib/sdl/types/sdl_url.rb

@@ -2,11 +2,19 @@ require 'uri'
 
 module SDL
   module Types
-    class SDLUrl < SDLDefaultType
+    class SDLUrl < SDLSimpleType
       include SDLType
 
       wraps URI
       codes :uri, :url
+
+      def from_string(string_value)
+        begin
+          URI.parse string_value
+        rescue URI::InvalidURIError
+          throw "Invalid URI: #{string_value}"
+        end
+      end
     end
   end
 end

data/spec/fact_type_instance_definition_spec.rb

@@ -125,23 +125,23 @@ describe 'Doing type instance definition' do
       end
     end
 
-    expect(compendium.services[:multi_service].facts[0].a).to eql '1'
-    expect(compendium.services[:multi_service].facts[0].b).to eql '2'
-    expect(compendium.services[:multi_service].facts[0].c).to eq(nil)
-    expect(compendium.services[:multi_service].facts[0].d).to eql '3'
+    expect(compendium.services[:multi_service].facts[0].a).to eq '1'
+    expect(compendium.services[:multi_service].facts[0].b).to eq '2'
+    expect(compendium.services[:multi_service].facts[0].c).to eq nil
+    expect(compendium.services[:multi_service].facts[0].d).to eq '3'
     expect(compendium.services[:multi_service].facts[0].e).to eq(nil)
 
-    expect(compendium.services[:multi_service].facts[1].multis[0].b).to eql '2'
-    expect(compendium.services[:multi_service].facts[1].multis[1].e).to eql '5'
+    expect(compendium.services[:multi_service].facts[1].multis[0].b).to eq '2'
+    expect(compendium.services[:multi_service].facts[1].multis[1].e).to eq '5'
   end
 
-  context 'the #to_s method of a service' do
+  context 'the #to_s method of a fact' do
     it 'gives out the #to_s output of a same-named property than the class' do
-      compendium.service :named_color_service do
-        has_named_color 'My color name'
+      compendium.service :named_service do
+        has_name 'My name'
       end
 
-      expect(compendium.services[:named_color_service].facts[0].to_s).to eq('My color name')
+      expect(compendium.services[:named_service].facts[0].to_s).to eq 'My name'
     end
 
     it 'gives out the Fact class local name when no same-named property than the class exists' do
@@ -149,7 +149,7 @@ describe 'Doing type instance definition' do
         has_color :blue
       end
 
-      expect(compendium.services[:blue_service].facts[0].to_s).to eq('Color')
+      expect(compendium.services[:blue_service].facts[0].to_s).to eq 'Color'
     end
   end
 
@@ -171,8 +171,8 @@ describe 'Doing type instance definition' do
 
     expect(compendium.services[:favourite_service].facts[0].favourites[0].color).to eq(compendium.type_instances[Color][:red])
     expect(compendium.services[:favourite_service].facts[0].favourites[1].color).to eq(compendium.type_instances[Color][:green])
-    expect(compendium.services[:favourite_service].facts[0].favourites[0].rating).to eq(5)
-    expect(compendium.services[:favourite_service].facts[0].favourites[1].rating).to eq(10)
+    expect(compendium.services[:favourite_service].facts[0].favourites[0].rating).to eq 5
+    expect(compendium.services[:favourite_service].facts[0].favourites[1].rating).to eq 10
   end
 
   it 'returns the values of all properties by calling #property_values on a type' do
@@ -183,6 +183,6 @@ describe 'Doing type instance definition' do
     property_values = compendium.services[:imaginative_service].facts[0].property_values
 
     expect(property_values[property_values.keys[0]]).to eq(compendium.type_instances[Color][:yellow])
-    expect(property_values[property_values.keys[1]]).to eq('Yellow')
+    expect(property_values[property_values.keys[1]]).to eq 'Yellow'
   end
 end

data/spec/shared_test_compendium.rb

@@ -22,6 +22,10 @@ shared_context 'the default compendium' do
         end
       end
 
+      fact :name do
+        string :name
+      end
+
       fact :multicolor do
         list_of_colors :colors
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdl-ng
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Mathias Slawik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-17 00:00:00.000000000 Z
+date: 2014-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -237,10 +237,10 @@ files:
 - lib/sdl/translations/en.yml
 - lib/sdl/types.rb
 - lib/sdl/types/sdl_datetime.rb
-- lib/sdl/types/sdl_default_type.rb
 - lib/sdl/types/sdl_description.rb
 - lib/sdl/types/sdl_duration.rb
 - lib/sdl/types/sdl_number.rb
+- lib/sdl/types/sdl_simple_type.rb
 - lib/sdl/types/sdl_string.rb
 - lib/sdl/types/sdl_type.rb
 - lib/sdl/types/sdl_url.rb

data/lib/sdl/types/sdl_default_type.rb

@@ -1,13 +0,0 @@
-module SDL
-  module Types
-    class SDLDefaultType
-      include SDLType
-
-      ##
-      # Designates this SDLType to be a default type, i.e., to be loaded by all ServiceCompendiums automatically
-      def self.inherited(subclass)
-        SDL::Base::ServiceCompendium.default_sdltypes << subclass
-      end
-    end
-  end
-end