sdl-ng 0.0.1

data/lib/sdl/receivers/type_receiver.rb

@@ -0,0 +1,87 @@
+module SDL
+  module Receivers
+    class TypeReceiver
+      include ActiveSupport::Inflector
+
+      attr :klass
+      attr :subclasses
+      attr :compendium
+
+      def initialize(sym, compendium, superklass = nil)
+        @compendium = compendium
+        @klass = Class.new(superklass || base_class)
+        @klass.local_name = sym.to_s.camelize
+
+        @subclasses = [@klass]
+
+        register_sdltype(@klass)
+      end
+
+      def base_class
+        SDL::Base::Type
+      end
+
+      def register_sdltype(klass)
+        klass.class_eval do
+          include SDL::Types::SDLType
+
+          wraps self
+          codes local_name.underscore.to_sym
+        end
+      end
+
+      def subtype(sym, &definition)
+        receiver = self.class.new(sym, @compendium, @klass)
+        receiver.instance_eval(&definition) if block_given?
+
+        @subclasses.concat(receiver.subclasses)
+      end
+
+      ##
+      # Define a list of a type, which is defined in the block.
+      def list(name, &block)
+        list_type = @compendium.type name.to_s.singularize.to_sym, &block
+
+        add_property name.to_sym, list_type, true
+      end
+
+      def method_missing(name, *args, &block)
+        sym = args[0] || name.to_sym
+
+        if name =~ /list_of_/
+          multi = true
+          type = @compendium.sdltype_codes[name.to_s.gsub('list_of_', '').singularize.to_sym]
+        else
+          multi = false
+          type = @compendium.sdltype_codes[name.to_sym]
+        end
+
+        if type
+          add_property sym, type, multi
+        else
+          super(name, *args, &block)
+        end
+      end
+
+      private
+        ##
+        # Adds accessors to set the property to the target class.
+        def add_property(sym, type, multi)
+          unless multi
+            @klass.class_eval do
+              attr_accessor sym
+            end
+          else
+            # Define accessor method for lists
+            @klass.class_eval do
+              define_method sym do
+                eval "@#{sym} ||= []"
+              end
+            end
+          end
+
+          @klass.properties << SDL::Base::Property.new(sym, type, @klass, multi)
+        end
+    end
+  end
+end

data/lib/sdl/translations/en.yml

@@ -0,0 +1,9 @@
+---
+en:
+  sdl:
+    xml:
+      annotation: An arbitrary annotation to be displayed for the description consumer.
+      documentation: The documentation of this type or fact instance.
+      identifier: An identifier for a type instance. Two instances are the same, if they share the same identifier.
+      service_root: The root element of the service. Contains an arbitrary number of facts.
+      typebase: The base type of all SDL types and facts. Contains annotations and documentation.

data/lib/sdl/types.rb

@@ -0,0 +1,19 @@
+require_relative 'types/sdl_type'
+require_relative 'types/sdl_default_type'
+require_relative 'types/sdl_string'
+require_relative 'types/sdl_description'
+require_relative 'types/sdl_number'
+require_relative 'types/sdl_duration'
+require_relative 'types/sdl_url'
+require_relative 'types/sdl_datetime'
+
+module SDL
+  ##
+  # This module contains the SDL type system.
+  #
+  # An SDL type is a wrapper around a Ruby type and is used in two contexts:
+  # * When setting a property, its new value is checked for type compatibility to the wrapped Ruby class
+  # * When exporting a service description, the wrapper is used to determine the serialization format
+  module Types
+  end
+end

data/lib/sdl/types/sdl_datetime.rb

@@ -0,0 +1,10 @@
+module SDL
+  module Types
+    class SDLDatetime < SDLDefaultType
+      include SDLType
+
+      wraps Time
+      codes :datetime
+    end
+  end
+end

data/lib/sdl/types/sdl_default_type.rb

@@ -0,0 +1,13 @@
+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

data/lib/sdl/types/sdl_description.rb

@@ -0,0 +1,10 @@
+module SDL
+  module Types
+    class SDLDescription < SDLDefaultType
+      include SDLType
+
+      wraps String
+      codes :description
+    end
+  end
+end

data/lib/sdl/types/sdl_duration.rb

@@ -0,0 +1,12 @@
+require 'active_support/duration'
+
+module SDL
+  module Types
+    class SDLDuration < SDLDefaultType
+      include SDLType
+
+      wraps ActiveSupport::Duration
+      codes :duration
+    end
+  end
+end

data/lib/sdl/types/sdl_number.rb

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

data/lib/sdl/types/sdl_string.rb

@@ -0,0 +1,10 @@
+module SDL
+  module Types
+    class SDLString < SDLDefaultType
+      include SDLType
+
+      wraps String
+      codes :string, :str
+    end
+  end
+end

data/lib/sdl/types/sdl_type.rb

@@ -0,0 +1,31 @@
+module SDL
+  module Types
+    ##
+    # An SDLType is a wrapper around a basic Ruby type
+    module SDLType
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        ## The Ruby type, which is to be wrapped
+        attr :wrapped_type
+
+        ## The codes, which are to be used to refer to this type
+        attr :codes
+
+        ##
+        # Sets the wrapped Ruby type
+        def wraps(type)
+          @wrapped_type = type
+        end
+
+        ##
+        # Registers the codes +symbols+ to be used to refer to this type
+        def codes(*symbols)
+          @codes = symbols
+        end
+      end
+    end
+  end
+end

data/lib/sdl/types/sdl_url.rb

@@ -0,0 +1,12 @@
+require 'uri'
+
+module SDL
+  module Types
+    class SDLUrl < SDLDefaultType
+      include SDLType
+
+      wraps URI
+      codes :uri, :url
+    end
+  end
+end

data/lib/sdl/util.rb

@@ -0,0 +1,4 @@
+require_relative 'util/nokogiri'
+require_relative 'util/documentation'
+
+I18n.load_path << File.join(__dir__, 'translations', 'en.yml')

data/lib/sdl/util/documentation.rb

@@ -0,0 +1,80 @@
+require 'active_support/inflector'
+
+module I18n
+  class MissingTranslation
+    module Base
+      alias :old_message :message
+
+      def message
+        puts old_message
+
+        puts @key
+
+        I18n.backend.store_translations I18n.locale, to_deep_hash({@key => 'Translate'})
+
+        old_message
+      end
+
+      # Taken from: http://www.ruby-doc.org/gems/docs/t/translate-rails3-0.2.2/Translate/Keys.html
+      def to_deep_hash(hash)
+        hash.inject({}) do |deep_hash, (key, value)|
+          keys = key.to_s.split('.').reverse
+          leaf_key = keys.shift
+          key_hash = keys.inject({leaf_key.to_sym => value}) { |hash, key| {key.to_sym => hash} }
+          deep_hash.deep_merge!(key_hash)
+          deep_hash
+        end
+      end
+    end
+  end
+end
+
+module SDL
+  module Util
+    module Documentation
+      def self.included(base)
+        base.extend(self)
+      end
+
+      def documentation
+        if self.respond_to?(:documentation_key)
+          I18n.t(documentation_key)
+        end
+      end
+
+      def self.walk_the_class_name(klass)
+        klass_key = klass.local_name.underscore.downcase
+
+        if klass.superclass.eql?(SDL::Base::Fact) || klass.superclass.eql?(SDL::Base::Type)
+          klass_key = "#{klass.superclass.local_name.underscore.downcase}.#{klass_key}"
+        else
+          klass_key = "#{walk_the_class_name(klass.superclass)}_#{klass_key}"
+        end
+
+        klass_key
+      end
+
+      [SDL::Base::Type, SDL::Base::Fact, SDL::Base::Property].each do |m| m.class_eval do include SDL::Util::Documentation end end
+    end
+  end
+end
+
+module SDL
+  module Base
+    class Type
+      def self.documentation_key
+        "sdl.#{SDL::Util::Documentation.walk_the_class_name(self)}"
+      end
+
+      def documentation_key
+        "sdl.instance.#{SDL::Util::Documentation.walk_the_class_name(self.class)}.#{@identifier}"
+      end
+    end
+
+    class Property
+      def documentation_key
+        "sdl.property.#{SDL::Util::Documentation.walk_the_class_name(@parent)}.#{@name}"
+      end
+    end
+  end
+end

data/lib/sdl/util/nokogiri.rb

@@ -0,0 +1,28 @@
+require 'nokogiri'
+require 'open-uri'
+
+module SDL
+  module Util
+    module NokogiriUtils
+      def fetch_from_url(url, *search)
+        begin
+          doc = Nokogiri::HTML(open(url))
+
+          doc.search(*search)
+        rescue SocketError => e
+          []
+        end
+      end
+    end
+  end
+end
+
+module SDL
+  module Receivers
+    [FactReceiver, ServiceReceiver, TypeInstanceReceiver, TypeReceiver].each do |r|
+      r.class_eval do
+        include(SDL::Util::NokogiriUtils)
+      end
+    end
+  end
+end

data/lib/sdl/util/verbs.rb

@@ -0,0 +1,3 @@
+Verbs::Conjugator.conjugations do |conjugate|
+  conjugate.irregular :color, :color, :colored
+end

data/lib/sdl/version.rb

@@ -0,0 +1,3 @@
+module SDL
+  VERSION = "0.0.1"
+end

data/sdl-ng.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('lib', __dir__)
+$:.unshift(lib) unless $:.include?(lib)
+require 'sdl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sdl-ng"
+  spec.version       = SDL::VERSION
+  spec.authors       = ["Mathias Slawik"]
+  spec.email         = ["mathias.slawik@tu-berlin.de"]
+  spec.description   = %q{Next Generation Service Description Language}
+  spec.summary       = %q{Framework for building descriptions of business services.}
+  spec.homepage      = 'https://github.com/TU-Berlin-SNET/sdl-ng'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activesupport', '>=4.0.0'
+  spec.add_runtime_dependency 'nokogiri', '1.6.0'
+  spec.add_runtime_dependency 'verbs', '~> 2.1.3'
+  spec.add_runtime_dependency 'linkeddata', '1.0.9'
+
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'yard-redcarpet-ext'
+  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'rspec', '2.14.1'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'fuubar'
+  spec.add_development_dependency 'simplecov', '~> 0.8.0.pre'
+end

data/spec/documentation_spec.rb

@@ -0,0 +1,64 @@
+require_relative '../lib/sdl'
+require_relative 'spec_helper'
+require_relative 'shared_test_compendium'
+
+require 'rspec'
+
+describe 'Documentation of SDL objects' do
+  include_context 'the default compendium'
+
+  I18n.backend.store_translations('en', :sdl => {
+      :type => {
+          :color => 'A color'
+      },
+      :fact => {
+          :multicolor => 'The service is multi-colored.',
+          :color_supercolor => 'The service has a supercolor.'
+      },
+      :property => {
+          :fact => {
+              :favourite_colors => {
+                  :favourites => 'The favourite colors'
+              }
+          }
+      },
+      :instance => {
+          :type => {
+              :color => {
+                  :red => 'The color "red"'
+              }
+          }
+      }
+  })
+
+  # Registers the classes of the default compendium
+  before(:each) do
+    compendium.register_classes_globally
+  end
+
+  it 'can document types' do
+    expect(Color.documentation).to eq('A color')
+  end
+
+  it 'can document facts' do
+    expect(Multicolor.documentation).to eq('The service is multi-colored.')
+  end
+
+  it 'can document subfacts' do
+    expect(Supercolor.documentation).to eq('The service has a supercolor.')
+  end
+
+  it 'can document properties' do
+    expect(FavouriteColors.properties.first.documentation).to eq('The favourite colors')
+  end
+
+  it 'can document instances' do
+    expect(compendium.type_instances[Color][:red].documentation).to eq('The color "red"')
+  end
+
+  it 'adds missing translations to the I18n backend as "translate" string after trying to translate a missing key' do
+    expect(compendium.type_instances[Color][:green].documentation).to eq('translation missing: en.sdl.instance.type.color.green')
+
+    expect(I18n.backend.instance_variable_get(:@translations)[:en][:sdl][:instance][:type][:color][:green]).to eq('Translate')
+  end
+end