sdl-ng 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02992c2203dd499f31781a014605b9199ecbfb3b
-  data.tar.gz: 533c35f720010f4a2eb91d0181651300ceef1c1f
+  metadata.gz: 0087ac1bbc359ae8f572a80782a5b71ab6aa1599
+  data.tar.gz: 1541db73e7090f6c099508a02d197aebd0c8dd66
 SHA512:
-  metadata.gz: 48d19496376b71a388e3d10657ed7694eccd901a249b8f248e3447648f5ce5a23994916a44ba8e83e8ef916bcaeb0aa353de67c8541586666b36b4aace3ce793
-  data.tar.gz: 6ba8b615c6a87eeb15a4e03caf0595b1779504baad4e1a43d6cf6124c985747a1a19ab0cfa239e502d448aac77fa8cb7fe6a19a4ebcdc03ed54ff059d9a8781b
+  metadata.gz: d56fdaf6e4b8442359afbc25cd0733ff106720754c89e9981b8b675b3e4a1989d948c21ebaa9afe3edcc0a8a91c566ee0a0fd6a30ef623d75a90ce36ab98fd0a
+  data.tar.gz: d796b0b1eb65a5149e79f78238ef8061a605df537a9298e302ca28ecb98d0a4b053a73066dd094c772e654a95147ef1762cd151ffaac25b4348d6216c30daef9

data/lib/sdl/base/fact.rb

@@ -5,6 +5,19 @@
 class SDL::Base::Fact < SDL::Base::Type
   attr_accessor :service
 
+  class << self
+    ##
+    # Returns the possible keywords to instantiate this fact class
+    # @return [<String>]
+    def keywords
+      is_form = "is_#{local_name.underscore.verb.conjugate(:tense => :past, :person => :third, :plurality => :singular, :aspect => :perfective)}"
+      has_form = "has_#{local_name.underscore}"
+      simple_form = local_name.underscore
+
+      [has_form, simple_form, is_form]
+    end
+  end
+
   def parent
     service
   end

data/lib/sdl/base/property.rb

@@ -1,31 +1,57 @@
 ##
 # A property of a Fact or Type. It has a #name and an associated Type.
 class SDL::Base::Property
+  ##
   # The Property name
+  # @!attribute [r] name
+  # @return [String]
   attr :name
 
+  ##
   # The Property Type
+  # @!attribute [r] type
+  # @return [Class]
   attr :type
 
+  ##
   # Is this Property multi-valued
+  # @!attribute [r] multi
+  # @return [Boolean]
   attr :multi
 
+  ##
   # The type, for which the property is defined
+  # @!attribute [r] parent
+  # @return [Class]
   attr :parent
 
+  ##
   # The type, which currently holds this property
+  # @!attribute [r] holder
+  # @return [Class]
   attr_accessor :holder
 
+  ##
   # Is this Property single-valued
+  # @return [Boolean]
   def single?
     !@multi
   end
 
+  ##
   # Is this Property multi-valued
+  # @return [Boolean]
   def multi?
     @multi
   end
 
+  ##
+  # Was this property inherited from one of its parents?
+  # @return [Boolean]
+  def inherited?
+    ! parent.eql? holder
+  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

data/lib/sdl/base/service_compendium.rb

@@ -3,6 +3,7 @@
 class SDL::Base::ServiceCompendium
   extend ActiveSupport::Autoload
 
+  autoload :LoadTransaction
   autoload :VocabularyLoadTransaction
   autoload :ServiceLoadTransaction
 
@@ -12,21 +13,44 @@ class SDL::Base::ServiceCompendium
   ##
   # A list of all +Fact+ classes registered in this compendium
   # @!attribute [r] fact_classes
-  # @return Array<Class>
+  # @return [Array<Class>]
   attr :fact_classes
 
   ##
   # A list of all +Type+ classes registered in this compendium
   # @!attribute [r] types
-  # @return Array<Class>
+  # @return [Array<Class>]
   attr :types
 
   ##
-  # Registered codes for +SDLSimpleType+s, used for defining property types.
+  # Registered codes for +SDLSimpleType+s and +Type+s.
   #
-  # @!attribute [r] sdltype_codes
-  # @return Hash{String => Class}
-  attr :sdltype_codes
+  # These are used in the definition of the type of a property.
+  #
+  # @!attribute [r] all_codes
+  # @return [Hash{String => Class}]
+  attr :all_codes
+
+  ##
+  # Registered codes for +SDLSimpleType+s.
+  #
+  # These are used in the definition of the type of a property.
+  #
+  # @!attribute [r] sdl_simple_type_codes
+  # @return [Hash{String => Class}]
+  attr :sdl_simple_type_codes
+
+  ##
+  # Registered codes for +Type+s.
+  #
+  # These are used in the definition of the type of a property.
+  #
+  # @!attribute [r] type_codes
+  # @return [Hash{String => Class}]
+  attr :type_codes
+
+  ##
+  # Registered codes for +SDL
 
   ##
   # A map containing predefined type instances, mapped to their Type classes.
@@ -61,7 +85,9 @@ class SDL::Base::ServiceCompendium
   # Initializes the compendium.
   def initialize
     @fact_classes, @types, @services = [], [], {}
-    @type_instances, @sdltype_codes = {}, {}
+    @type_instances, @sdl_simple_type_codes, @type_codes, @all_codes = {}, {}, {}, {}
+
+    @type_instances.default = {}
 
     @service_methods = Module.new() do |mod|
       include ServiceMethods
@@ -70,6 +96,17 @@ class SDL::Base::ServiceCompendium
     register_default_types
   end
 
+  ##
+  # A compendium is empty, if there are neither types, nor services loaded.
+  # @return [Boolean] If this compendium is empty.
+  def empty?
+    @fact_classes.empty? &&
+        @types.empty? &&
+        @services.empty? &&
+        @type_instances.empty? &&
+        @type_codes.empty?
+  end
+
   def facts_definition(&facts_definitions)
     self.instance_eval &facts_definitions
   end
@@ -78,6 +115,11 @@ class SDL::Base::ServiceCompendium
     self.instance_eval &type_instances_definition
   end
 
+  ##
+  # Runs the +&block+ with specified +current_uri+ and restores the old +current_uri+.
+  #
+  # @param [String] current_uri The URI, with which the block should be run.
+  # @param [Block] block The block, which will be called.
   def with_uri(current_uri, &block)
     old_uri = @current_uri
     @current_uri = current_uri
@@ -101,6 +143,8 @@ class SDL::Base::ServiceCompendium
       # Refer to the symbolic name of the current class, which can be a subclass of
       sym = fact_class.local_name.underscore.to_sym
 
+      # Extend the @service_methods module with methods retrieving the first or all
+      # instances of this fact, e.g. "service.features" would find all Feature facts
       @service_methods.class_eval do
         unless SDL::Base::Service.instance_methods.include? sym
           define_method sym do
@@ -122,10 +166,16 @@ class SDL::Base::ServiceCompendium
     receiver = SDL::Receivers::TypeReceiver.new(sym, self)
     receiver.klass.loaded_from = @current_uri
     receiver.instance_eval &type_definition if block_given?
-    register_sdltype_codes(receiver.klass)
-    register_sdltype(receiver.klass)
-    @types << receiver.klass
-    @type_instances[receiver.klass] = {}
+
+    @types.concat receiver.subclasses
+
+    receiver.subclasses.each do |klass|
+      klass.loaded_from = @current_uri
+      register_codes klass
+      register_sdltype klass
+      @type_instances[klass] = {}
+    end
+
     receiver.klass
   end
 
@@ -142,10 +192,17 @@ class SDL::Base::ServiceCompendium
   end
 
   ##
-  # Registers an SDLSimpleType under its code
-  def register_sdltype_codes(type)
+  # Registers an SDLSimpleType or SDLType under its code
+  # @param [Class] type The type to be registered.
+  def register_codes(type)
+    if type < SDL::Types::SDLSimpleType
+      type.codes.each do |c| @sdl_simple_type_codes[c] = type end
+    else
+      type.codes.each do |c| @type_codes[c] = type end
+    end
+
     type.codes.each do |code|
-      @sdltype_codes[code] = type
+      @all_codes[code] = type
     end
   end
 
@@ -174,19 +231,46 @@ class SDL::Base::ServiceCompendium
     end
   end
 
+  ##
+  # Returns an iterator for all items, which were loaded by this compendium
+  def loaded_items
+    @fact_classes.each do |fact_class|
+      yield fact_class
+    end
+
+    @types.each do |type_class|
+      yield type_class
+    end
+
+    @type_instances.each do |type_class, instance_hash|
+      instance_hash.each do |symbol, instance|
+        yield instance
+      end
+    end
+
+    @services.each do |symbol, service|
+      yield service
+    end
+  end
+
   ##
   # Unloads all items with the specified uri from this service compendium
   def unload(uri)
+    @services.delete_if do |symbolic_name, service| service.loaded_from.eql?(uri) end
+
     @fact_classes.delete_if do |item| item.loaded_from.eql?(uri) end
-    @types.delete_if do |item| item.loaded_from.eql?(uri) end
-    @services.delete_if do |item| item.loaded_from.eql?(uri) end
 
-    @type_instances.delete_if do |klass, klass_map|
-      klass_map.delete_if do |symbol, type|
-        type.loaded_from.eql? uri
-      end
+    @types.delete_if do |item|
+      if item.loaded_from.eql?(uri) then
+        @type_instances.delete(item)
 
-      klass.loaded_from.eql? uri
+        @all_codes.delete_if do |code, type| type.eql? item end
+        @type_codes.delete_if do |code, type| type.eql? item end
+
+        true
+      else
+        false
+      end
     end
   end
 
@@ -212,7 +296,7 @@ class SDL::Base::ServiceCompendium
     # Registers all default types
     def register_default_types
       SDL::Types::SDLSimpleType.descendants.each do |type|
-        register_sdltype_codes type
+        register_codes type
       end
     end
 end

data/lib/sdl/base/service_compendium/load_transaction.rb

@@ -0,0 +1,9 @@
+module SDL::Base::ServiceCompendium::LoadTransaction
+  def to_files_array(path_or_filename, suffix)
+    if File.file? path_or_filename
+      [path_or_filename]
+    elsif File.directory? path_or_filename
+      Dir.glob(File.join(path_or_filename, '**', "*#{suffix}"))
+    end
+  end
+end

data/lib/sdl/base/service_compendium/service_load_transaction.rb

@@ -1,17 +1,24 @@
-# A transaction for loading vocabulary definition
-module SDL::Base::ServiceCompendium::ServiceLoadTransaction
-  ##
-  # Loads a service, either from a file or from a path recursively.
-  #
-  # Service definition files are expected to end with +.service.rb+
-  # @param path_or_filename[String] Either a filename or a path
-  def load_service_from_path(path_or_filename)
-    path_or_filename = [path_or_filename] if File.file? path_or_filename
+class SDL::Base::ServiceCompendium
+  # A transaction for loading vocabulary definition
+  module ServiceLoadTransaction
+    include LoadTransaction
 
-    Dir.glob(File.join(path_or_filename, '**', '*.service.rb')) do |filename|
-      service_name = filename.match(%r[.+/(.+).service.rb])[1]
+    ##
+    # Loads a service, either from a file or from a path recursively.
+    #
+    # Service definition files are expected to end with +.service.rb+
+    # @param path_or_filename[String] Either a filename or a path
+    # @param ignore_errors[Boolean] Ignore errors when loading service
+    def load_service_from_path(path_or_filename, ignore_errors = false)
+      to_files_array(path_or_filename, '.service.rb').each do |filename|
+        service_name = filename.match(%r[.+/(.+).service.rb])[1]
 
-      load_service_from_string File.read(filename), service_name, filename
+        begin
+          load_service_from_string File.read(filename), service_name, filename
+        rescue Exception => e
+          raise e unless ignore_errors
+        end
+      end
     end
   end
 
@@ -22,14 +29,10 @@ module SDL::Base::ServiceCompendium::ServiceLoadTransaction
   # @param [String] uri The URI
   # @raise [SyntaxError] If there is an error in service_definition
   def load_service_from_string(service_definition, service_name, uri)
-    begin
-      with_uri uri do
-        service service_name do
-          eval service_definition, binding
-        end
+    with_uri uri do
+      service service_name do
+        eval service_definition, binding, uri
       end
-    rescue Exception => e
-      raise SyntaxError.new("Error while loading '#{service_name}' from '#{uri}': #{e}")
     end
   end
 end

data/lib/sdl/base/service_compendium/vocabulary_load_transaction.rb

@@ -1,33 +1,35 @@
-# A transaction for loading vocabulary definition
-module SDL::Base::ServiceCompendium::VocabularyLoadTransaction
-  ##
-  # Loads vocabulary, either from a file or from a path recursively.
-  #
-  # Vocabulary definition files are expected to end with +.sdl.rb+
-  # @param path_or_filename[String] Either a filename or a path
-  def load_vocabulary_from_path(path_or_filename)
-    path_or_filename = [path_or_filename] if File.file? path_or_filename
+class SDL::Base::ServiceCompendium
+  # A transaction for loading vocabulary definition
+  module VocabularyLoadTransaction
+    include LoadTransaction
 
-    Dir.glob(File.join(path_or_filename, '**', '*.sdl.rb')) do |filename|
-      with_uri filename do
-        load_vocabulary_from_string File.read(filename), filename
+    ##
+    # Loads vocabulary, either from a file or from a path recursively.
+    #
+    # Vocabulary definition files are expected to end with +.sdl.rb+
+    # @param path_or_filename[String] Either a filename or a path
+    def load_vocabulary_from_path(path_or_filename)
+      to_files_array(path_or_filename, '.sdl.rb').each do |filename|
+        with_uri filename do
+          load_vocabulary_from_string File.read(filename), filename
+        end
       end
     end
-  end
 
-  ##
-  # Loads a vocabulary from a string. The URI is used with ServiceCompendium#with_uri.
-  # @param [String] vocabulary_definition The vocabulary definition
-  # @param [String] uri The URI
-  def load_vocabulary_from_string(vocabulary_definition, uri)
-    begin
-      with_uri uri do
-        eval vocabulary_definition, binding
-      end
-    rescue Exception => e
-      unload uri
+    ##
+    # Loads a vocabulary from a string. The URI is used with ServiceCompendium#with_uri.
+    # @param [String] vocabulary_definition The vocabulary definition
+    # @param [String] uri The URI
+    def load_vocabulary_from_string(vocabulary_definition, uri)
+      begin
+        with_uri uri do
+          eval vocabulary_definition, binding
+        end
+      rescue Exception => e
+        unload uri
 
-      raise "Error while loading vocabulary from #{uri}: #{e}"
+        raise "Error while loading vocabulary from #{uri}: #{e}"
+      end
     end
   end
 end

data/lib/sdl/base/type.rb

@@ -5,9 +5,11 @@ class SDL::Base::Type
     include SDL::Base::URIMappedResource
 
     # The namespace URL of this Type class
+    # !@attr [r] namespace
     attr_accessor :namespace
 
     # If the Type is a list item type
+    # !@attr [r] list_item
     attr_accessor :list_item
 
     ##
@@ -16,14 +18,27 @@ class SDL::Base::Type
     # The ServiceCompendium#register_classes_globally method makes this class accessible by a constant of this name
     @local_name
 
+    alias :original_name :name
+
+    def name
+      original_name || local_name
+    end
+
     def local_name
-      @local_name || name.demodulize
+      @local_name || original_name.demodulize
     end
 
     def local_name=(name)
       @local_name = name
     end
 
+    # A list of all subtypes
+    # !@attr [r] subtypes
+    # @return [<Class>] The subtypes
+    def subtypes
+      @subtypes ||= []
+    end
+
     def to_s
       @local_name || name
     end
@@ -63,6 +78,10 @@ class SDL::Base::Type
     def is_sub?
       not [SDL::Base::Type, SDL::Base::Fact].include? superclass
     end
+
+    def sdl_ancestors
+      ancestors.drop(1).take_while {|ancestor| ! [SDL::Base::Type, SDL::Base::Fact, SDL::Types::SDLType].include? ancestor}
+    end
   end
 
   ##

data/lib/sdl/ng/version.rb

@@ -1,5 +1,5 @@
 module SDL
   module NG
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

data/lib/sdl/receivers/service_receiver.rb

@@ -11,16 +11,10 @@ class SDL::Receivers::ServiceReceiver < SDL::Receivers::Receiver
     @service = SDL::Base::Service.new(sym.to_s)
 
     compendium.fact_classes.each do |fact_class|
-      define_singleton_method("is_#{fact_class.local_name.underscore.verb.conjugate(:tense => :past, :person => :third, :plurality => :singular, :aspect => :perfective)}") do |*args, &block|
-        add_fact fact_class, *args, &block
-      end
-
-      define_singleton_method("has_#{fact_class.local_name.underscore}") do |*args, &block|
-        add_fact fact_class, *args, &block
-      end
-
-      define_singleton_method("#{fact_class.local_name.underscore}") do |*args, &block|
-        add_fact fact_class, *args, &block
+      fact_class.keywords.each do |keyword|
+        define_singleton_method keyword do |*args, &block|
+          add_fact fact_class, *args, &block
+        end
       end
     end
   end
@@ -48,12 +42,12 @@ class SDL::Receivers::ServiceReceiver < SDL::Receivers::Receiver
 
       unless possible_type_instances.nil? || possible_type_instances.empty?
         if possible_type_instances.length > 1
-          raise Exception.new("Multiple possibilities for #{name} in #{caller[0]}")
+          raise Exception.new("Multiple possibilities for #{name}")
         else
           possible_type_instances[0]
         end
       else
-        raise Exception.new("I do not know what to do with '#{name}' in #{caller[0]}")
+        raise Exception.new("I do not know what to do with '#{name}'")
       end
     end
 end

data/lib/sdl/receivers/type_instance_receiver.rb

@@ -82,7 +82,7 @@ class SDL::Receivers::TypeInstanceReceiver < SDL::Receivers::Receiver
     unless possible_type_instances.nil? || possible_type_instances.empty?
       possible_type_instances[0]
     else
-      raise Exception.new("I do not know what to do with '#{name}' in #{caller[0]}")
+      raise Exception.new("I do not know what to do with '#{name}'.")
     end
   end
 end

data/lib/sdl/receivers/type_receiver.rb

@@ -1,7 +1,14 @@
 class SDL::Receivers::TypeReceiver < SDL::Receivers::Receiver
   include ActiveSupport::Inflector
 
+  # The class for which the type receiver was instantiated
+  # !@attr [r] klass
+  # @return [Class]
   attr :klass
+
+  # The class and all subclasses
+  # !@attr [r] subclasses
+  # @return [Array<Class>]
   attr :subclasses
 
   def initialize(sym, compendium, superklass = nil)
@@ -31,6 +38,7 @@ class SDL::Receivers::TypeReceiver < SDL::Receivers::Receiver
   def subtype(sym, &definition)
     receiver = self.class.new(sym, @compendium, @klass)
     receiver.instance_eval(&definition) if block_given?
+    klass.subtypes << receiver.klass
 
     @subclasses.concat(receiver.subclasses)
   end
@@ -51,10 +59,10 @@ class SDL::Receivers::TypeReceiver < SDL::Receivers::Receiver
 
     if name =~ /list_of_/
       multi = true
-      type = @compendium.sdltype_codes[name.to_s.gsub('list_of_', '').singularize.to_sym]
+      type = @compendium.all_codes[name.to_s.gsub('list_of_', '').singularize.to_sym]
     else
       multi = false
-      type = @compendium.sdltype_codes[name.to_sym]
+      type = @compendium.all_codes[name.to_sym]
     end
 
     if type

data/spec/examples_spec.rb

@@ -3,26 +3,26 @@ require_relative 'spec_helper'
 require 'rspec'
 
 describe 'the bundled examples' do
-  let :compendium do
-    SDL::Base::ServiceCompendium.new
-  end
+  it 'can be (un-)loaded and traces the load path of files' do
+    compendium = SDL::Base::ServiceCompendium.new
 
-  let :loaded_compendium do
     expect {
       compendium.load_vocabulary_from_path File.join(__dir__, '..', 'examples', 'vocabulary')
       compendium.load_service_from_path File.join(__dir__, '..', 'examples', 'services')
     }.not_to raise_exception
 
-    compendium
-  end
+    items_to_unload = []
 
-  it 'can be loaded' do
-    expect { loaded_compendium }.not_to raise_exception
-  end
+    compendium.loaded_items do |loaded_item|
+      expect(File.exists?(loaded_item.loaded_from))
+
+      items_to_unload << loaded_item
+    end
 
-  it 'traces load path' do
-    expected_path = File.join(__dir__, '..', 'examples', 'services', 'google_drive_for_business.service.rb')
+    items_to_unload.each do |loaded_item|
+      expect{compendium.unload(loaded_item.loaded_from)}.not_to raise_exception
+    end
 
-    expect(loaded_compendium.services['google_drive_for_business'].loaded_from).to eq expected_path
+    expect(compendium).to be_empty
   end
 end

data/spec/service_compendium_spec.rb

@@ -34,6 +34,10 @@ describe 'The service compendium' do
     expect(subject.types.first).to be < SDL::Base::Type
   end
 
+  it 'allows the definition of service subtypes' do
+    pending 'Not yet implemented'
+  end
+
   it 'allows the definition of services' do
     subject.service :example_service
 
@@ -137,7 +141,7 @@ END
   end
 
   it 'does not let double definitions of types and facts happen' do
-    pending 'Not yet implemented'
+    pending
   end
 
   context 'with defined example classes' do
@@ -164,8 +168,8 @@ END
       compendium
     end
 
-    it 'registers the code for the example type with its #sdltype_codes' do
-      expect(subject.sdltype_codes[:example_type]).to be subject.types.first
+    it 'registers the code for the example type with its #all_codes' do
+      expect(subject.all_codes[:example_type]).to be subject.types.first
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdl-ng
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Mathias Slawik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-27 00:00:00.000000000 Z
+date: 2014-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -234,6 +234,7 @@ files:
 - lib/sdl/base/property.rb
 - lib/sdl/base/service.rb
 - lib/sdl/base/service_compendium.rb
+- lib/sdl/base/service_compendium/load_transaction.rb
 - lib/sdl/base/service_compendium/service_load_transaction.rb
 - lib/sdl/base/service_compendium/vocabulary_load_transaction.rb
 - lib/sdl/base/type.rb