sdl-ng 0.0.1

data/examples/vocabulary/crf/charging.sdl.rb

@@ -0,0 +1,8 @@
+type :charge_unit
+
+fact :charge_unit do
+  charge_unit
+end
+
+charge_unit :user_account
+charge_unit :floating_license

data/examples/vocabulary/crf/compliance.sdl.rb

@@ -0,0 +1,35 @@
+fact :data_location_transparency
+
+fact :data_location do
+  location
+end
+
+fact :data_deletion_policy
+
+type :key_control
+
+fact :data_encryption do
+  key_control
+end
+
+key_control :user_only
+key_control :provider_only
+key_control :shared
+
+type :audit_option
+
+fact :audit_option do
+  audit_option
+end
+
+audit_option :audit_log
+
+fact :status_page do
+  url
+end
+
+fact :service_level_agreement do
+  subfact :public_service_level_agreement do
+    url
+  end
+end

data/examples/vocabulary/crf/delivery.sdl.rb

@@ -0,0 +1,22 @@
+type :billing_term
+type :payment_term
+type :payment_option
+
+fact :bill do
+  billing_term
+  payment_term
+end
+
+fact :payment_option do
+  payment_option
+end
+
+billing_term :monthly
+billing_term :annually
+
+payment_term :in_advance
+payment_term :after_use
+
+payment_option :credit_card
+payment_option :cheque
+payment_option :invoice

data/examples/vocabulary/crf/dynamics.sdl.rb

@@ -0,0 +1,6 @@
+fact :duration do
+  duration :duration
+
+  subfact :set_up_consumption_duration
+  subfact :provision_end_user_duration
+end

data/examples/vocabulary/crf/interop.sdl.rb

@@ -0,0 +1,54 @@
+type :browser do
+  url
+end
+
+type :browser_plugin do
+  url
+end
+
+fact :feature do
+  string :feature
+  description
+end
+
+fact :documentation do
+  url
+end
+
+fact :interface do
+  subfact :rest_interface
+  subfact :soap_interface
+  subfact :xmlrpc_interface
+
+  subfact :browser_interface do
+    list :compatible_browsers do
+      browser :compatible_browser
+      string :min_version
+    end
+
+    list :required_plugins do
+      browser_plugin :required_plugin
+      string :min_version
+    end
+  end
+end
+
+browser :firefox do
+  url 'http://www.mozilla.org/firefox/'
+end
+
+browser :opera do
+  url 'http://www.opera.com/'
+end
+
+browser :chrome do
+  url 'https://www.google.com/chrome'
+end
+
+browser :internet_explorer do
+  url 'http://windows.microsoft.com/en-US/internet-explorer/download-ie'
+end
+
+browser :safari do
+  url 'http://www.apple.com/safari'
+end

data/examples/vocabulary/crf/optimizing.sdl.rb

@@ -0,0 +1,15 @@
+fact :maintenance do
+  subfact :maintenance_window do
+    timespan
+  end
+
+  subfact :maintenance_free
+end
+
+fact :continuous_service_improvement do
+  url
+
+  subfact :future_roadmap
+  subfact :past_release_notes
+  subfact :feedback_page
+end

data/examples/vocabulary/crf/portability.sdl.rb

@@ -0,0 +1,25 @@
+type :data_capability_operation
+
+type :data_format
+
+fact :data_capability do
+  data_capability_operation :operation
+  data_format :format
+end
+
+data_format :csv
+data_format :xls
+data_format :html
+data_format :rtf
+data_format :word
+data_format :open_office
+data_format :pdf
+data_format :text
+data_format :odf
+data_format :pptx
+data_format :png
+data_format :jpeg
+data_format :svg
+
+data_capability_operation :export
+data_capability_operation :import

data/examples/vocabulary/crf/protection.sdl.rb

@@ -0,0 +1,8 @@
+type :communication_protection
+
+fact :communication_protection do
+  communication_protection
+end
+
+communication_protection :https
+communication_protection :vpn

data/examples/vocabulary/crf/reliability.sdl.rb

@@ -0,0 +1 @@
+fact :offline_capability

data/examples/vocabulary/crf/reputation.sdl.rb

@@ -0,0 +1,3 @@
+fact :establishing_year do
+  number :year
+end

data/lib/sdl.rb

@@ -0,0 +1,17 @@
+#:include: ../README.md
+
+require_relative 'sdl/base'
+require_relative 'sdl/receivers'
+require_relative 'sdl/types'
+require_relative 'sdl/exporters'
+require_relative 'sdl/util'
+require_relative 'sdl/version'
+
+##
+#
+#
+# Author::  Mathias Slawik (mailto:mathias.slawik@tu-berlin.de)
+# License:: Apache License 2.0
+module SDL
+
+end

data/lib/sdl/base.rb

@@ -0,0 +1,20 @@
+require_relative 'base/type'
+require_relative 'base/fact'
+require_relative 'base/property'
+require_relative 'base/service'
+require_relative 'base/service_compendium'
+
+module SDL
+  ##
+  # This module contains the base classes of the \SDL Framework.
+  #
+  # These include:
+  # Fact::      A fact about a service
+  # Service::   A service, which is described through facts
+  # Type::      A type used in service descriptions
+  # Property::  A property of a fact or type
+  #
+  # The ServiceCompendium is used for easy definition of new facts, services, types and properties.
+  module Base
+  end
+end

data/lib/sdl/base/fact.rb

@@ -0,0 +1,11 @@
+module SDL
+  module Base
+    ##
+    # A fact, which is known about a service.
+    #
+    # Facts are defined by using a ServiceCompendium.
+    class Fact < Type
+      attr_accessor :service
+    end
+  end
+end

data/lib/sdl/base/property.rb

@@ -0,0 +1,34 @@
+module SDL
+  module Base
+    ##
+    # A property of a Fact or Type. It has a #name and an associated Type.
+    class Property
+      # The Property name
+      attr :name
+
+      # The Property Type
+      attr :type
+
+      # Is this Property multi-valued
+      attr :multi
+
+      # The parent type, where this property belongs to
+      attr :parent
+
+      # Is this Property single-valued
+      def single?
+        !@multi
+      end
+
+      # Is this Property multi-valued
+      def multi?
+        @multi
+      end
+
+      # Define a property by its name and type
+      def initialize(name, type, parent, multi = false)
+        @name, @type, @parent, @multi = name.to_s, type, parent, multi
+      end
+    end
+  end
+end

data/lib/sdl/base/service.rb

@@ -0,0 +1,13 @@
+module SDL
+  module Base
+    class Service
+      attr_accessor :facts, :symbolic_name
+
+      def initialize(symbolic_name)
+        @symbolic_name = symbolic_name
+
+        @facts, @facades = [], []
+      end
+    end
+  end
+end

data/lib/sdl/base/service_compendium.rb

@@ -0,0 +1,130 @@
+require 'active_support/inflector'
+
+module SDL
+  module Base
+    ##
+    # A service compendium allows the definition of service facts, types and services.
+    class ServiceCompendium
+      class << self
+        def default_sdltypes
+          @default_sdltypes ||= []
+        end
+      end
+
+      attr :fact_classes
+      attr :types
+      attr :sdltype_codes
+      attr :type_instances
+      attr :services
+
+      def initialize
+        @fact_classes, @types, @services = [], [], {}
+        @type_instances, @sdltype_codes = {}, {}
+
+        register_default_types
+      end
+
+      def facts_definition(&facts_definitions)
+        self.instance_eval &facts_definitions
+      end
+
+      def type_instances_definition(&type_instances_definition)
+        self.instance_eval &type_instances_definition
+      end
+
+      # Defines a new class of service facts
+      def fact(sym, &fact_definition)
+        receiver = SDL::Receivers::FactReceiver.new(sym, self)
+        receiver.instance_eval &fact_definition if block_given?
+        receiver.subclasses.each do |fact_class|
+          @fact_classes << fact_class
+
+          # Refer to the symbolic name of the current class, which can be a subclass of
+          sym = fact_class.local_name.underscore.to_sym
+
+          ServiceMethods.class_eval do
+            unless Service.instance_methods.include? sym
+              define_method sym do
+                @facts.find {|fact| fact.is_a? fact_class}
+              end
+            end
+
+            unless Service.instance_methods.include? sym.to_s.pluralize.to_sym
+              define_method sym.to_s.pluralize do
+                @facts.find_all {|fact| fact.is_a? fact_class}
+              end
+            end
+          end
+        end
+      end
+
+      # Defines a new type and returns it
+      def type(sym, &type_definition)
+        receiver = SDL::Receivers::TypeReceiver.new(sym, self)
+        receiver.instance_eval &type_definition if block_given?
+        register_sdltype_codes(receiver.klass)
+        register_sdltype(receiver.klass)
+        @types << receiver.klass
+        @type_instances[receiver.klass] = {}
+        receiver.klass
+      end
+
+      # Defines a new service, adds all service methods, and returns it
+      def service(sym, &service_definition)
+        receiver = SDL::Receivers::ServiceReceiver.new(sym, self)
+        receiver.instance_eval &service_definition if block_given?
+        @services[sym] = receiver.service
+        receiver.service.symbolic_name = sym.to_s
+        receiver.service.extend ServiceMethods
+        receiver.service
+      end
+
+      ##
+      # Registers the type under its codes
+      def register_sdltype_codes(type)
+        type.instance_variable_get(:@codes).each do |code|
+          @sdltype_codes[code] = type
+        end
+      end
+
+      ##
+      # Allows this compendium to be used for adding new type instances
+      def register_sdltype(type)
+        # Define a method, which adds the type instance defined in the block to this compendium and adds it as a
+        # constant the the type class
+        self.class.send(:define_method, type.local_name.underscore) do |identifier, &block|
+          receiver = SDL::Receivers::TypeInstanceReceiver.new(type.new, self)
+
+          receiver.instance_eval &block if block != nil
+
+          receiver.instance.identifier = identifier
+          @type_instances[type][identifier] = receiver.instance
+        end
+      end
+
+      ##
+      # Registers all classes by their #local_name to be used in all scopes
+      def register_classes_globally
+        (@fact_classes + @types).each do |defined_class|
+          Object.send(:remove_const, defined_class.local_name) if Object.const_defined? defined_class.local_name.to_sym
+          Object.const_set defined_class.local_name, defined_class
+        end
+      end
+
+      # This module is included in every service defined by this compendium and contains methods to easily retreive
+      # certain fact instances by their name.
+      module ServiceMethods
+
+      end
+
+      private
+        ##
+        # Registers all default types
+        def register_default_types
+          self.class.default_sdltypes.each do |type|
+            register_sdltype_codes type
+          end
+        end
+    end
+  end
+end

data/lib/sdl/base/type.rb

@@ -0,0 +1,66 @@
+require 'i18n'
+
+module SDL
+  module Base
+    class Type
+      class << self
+        ## The namespace URL of this Fact class
+        attr_accessor :namespace
+
+        ##
+        # The local name of the fact, 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
+
+        def local_name
+          @local_name || name.demodulize
+        end
+
+        def local_name=(name)
+          @local_name = name
+        end
+
+        def to_s
+          @local_name || name
+        end
+
+        def properties(including_super = false)
+          if including_super && is_sub?
+            self.properties + superclass.properties(true)
+          else
+            @properties ||= []
+          end
+        end
+
+        def is_sub?
+          not [SDL::Base::Type, SDL::Base::Fact].include? superclass
+        end
+      end
+
+      ##
+      # Gets the values of all properties
+      def property_values
+        Hash[self.class.properties(true).map{|p| [p, send(p.name)]}]
+      end
+
+      def to_s
+        # If there is a property with the same name, than the type, return its to_s, return the name of the class
+        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}"
+        else
+          self.class.to_s
+        end
+      end
+
+      def annotations
+        @annotations ||= []
+      end
+
+      # An identifier for type instances
+      attr_accessor :identifier
+    end
+  end
+end