sdl-ng 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74e84faac50a5b0f87162c41f4432f17e7c14eb9
-  data.tar.gz: 859743f5d41746354019bf5a4d651049e2837137
+  metadata.gz: fb1fee76f36a1fd102acbf05d58bba9ed837b854
+  data.tar.gz: 74b4dc6a128f8919d4c18b844a505a75cf5ba9a2
 SHA512:
-  metadata.gz: 9b906a6a61d26020c7f8c3881faadda48600c58dcd94848f46b73d36076e9e1937ca436fe089b617ade562168113a818ad285b910c576a5a2e7fbf286bf2e460
-  data.tar.gz: 7e74e16dde89de290666cd991f6eace874f6657643acc7aab8ba5469c9bca68db72f77eec15b62dd9e9960fd3eefe699d1b214d92728ef12972b821c2e5ea0c6
+  metadata.gz: 5006227d35538634704f03c65ef56acfd06b75343d3a3540fa847b0624defcc7da386ef9290e4ff25c50af13b6ec501f1a814b46c64eb9325f5ca31f63c1fa45
+  data.tar.gz: a741df861180d5714844946b3d7bd42d7b99fedb55b17c2cba729652daa5b14b81b2ec4cdc9422ca74e6ef59b2e28a5a95e2e33f78fa3915eb37b745222a812f

data/.rspec

@@ -1,2 +1,2 @@
 --format Fuubar
---color
+--color

data/.simplecov

@@ -3,5 +3,8 @@ SimpleCov.start do
   add_group 'Library', 'lib'
   add_group 'Specs', 'spec'
 
+  add_filter 'bin'
+  add_filter 'examples'
+
   refuse_coverage_drop
 end

data/lib/sdl/base/service_compendium.rb

@@ -1,16 +1,72 @@
 ##
 # A service compendium allows the definition of service facts, types and services.
 class SDL::Base::ServiceCompendium
+  extend ActiveSupport::Autoload
+
+  autoload :VocabularyLoadTransaction, 'sdl/base/transactions/vocabulary_load_transaction'
+  autoload :ServiceLoadTransaction, 'sdl/base/transactions/service_load_transaction'
+
+  include VocabularyLoadTransaction
+  include ServiceLoadTransaction
+
+  ##
+  # A list of all +Fact+ classes registered in this compendium
+  # @!attribute [r] fact_classes
+  # @return Array<Class>
   attr :fact_classes
+
+  ##
+  # A list of all +Type+ classes registered in this compendium
+  # @!attribute [r] types
+  # @return Array<Class>
   attr :types
+
+  ##
+  # Registered codes for +SDLSimpleType+s, used for defining property types.
+  #
+  # @!attribute [r] sdltype_codes
+  # @return Hash{String => Class}
   attr :sdltype_codes
+
+  ##
+  # A map containing predefined type instances, mapped to their Type classes.
+  #
+  # @!attribute [r] type_instances
+  # @return Hash{Class => Hash{Symbol => Type}}
   attr :type_instances
+
+  ##
+  # A map of service names to service objects. It contains all loaded services in
+  # this compendium.
+  #
+  # @!attribute [r] services
+  # @return Hash{String => Service}
   attr :services
 
+  ##
+  # The service compendium specific copy of the ServiceMethods module. See #ServiceMethods
+  #
+  # @!attribute [r] service_methods
+  # @return [Module]
+  attr :service_methods
+
+  ##
+  # The current URI when loading services.
+  #
+  # @!attribute [r] current_uri
+  # @return [String]
+  attr :current_uri
+
+  ##
+  # Initializes the compendium.
   def initialize
     @fact_classes, @types, @services = [], [], {}
     @type_instances, @sdltype_codes = {}, {}
 
+    @service_methods = Module.new() do |mod|
+      include ServiceMethods
+    end
+
     register_default_types
   end
 
@@ -22,17 +78,30 @@ class SDL::Base::ServiceCompendium
     self.instance_eval &type_instances_definition
   end
 
+  def with_uri(current_uri, &block)
+    old_uri = @current_uri
+    @current_uri = current_uri
+
+    begin
+      block.call
+    ensure
+      @current_uri = old_uri
+    end
+  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_class.loaded_from = @current_uri
+
       @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
+      @service_methods.class_eval do
         unless SDL::Base::Service.instance_methods.include? sym
           define_method sym do
             @facts.find {|fact| fact.is_a? fact_class}
@@ -51,6 +120,7 @@ class SDL::Base::ServiceCompendium
   # Defines a new type and returns it
   def type(sym, &type_definition)
     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)
@@ -63,17 +133,18 @@ class SDL::Base::ServiceCompendium
   def service(sym, &service_definition)
     receiver = SDL::Receivers::ServiceReceiver.new(sym, self)
     receiver.instance_eval &service_definition if block_given?
+    receiver.service.loaded_from = current_uri
     @services[sym] = receiver.service
     receiver.service.symbolic_name = sym.to_s
     receiver.service.compendium = self
-    receiver.service.extend ServiceMethods
+    receiver.service.extend @service_methods
     receiver.service
   end
 
   ##
-  # Registers the type under its codes
+  # Registers an SDLSimpleType under its code
   def register_sdltype_codes(type)
-    type.instance_variable_get(:@codes).each do |code|
+    type.codes.each do |code|
       @sdltype_codes[code] = type
     end
   end
@@ -88,6 +159,7 @@ class SDL::Base::ServiceCompendium
 
       receiver.instance_eval &block if block != nil
 
+      receiver.instance.loaded_from = current_uri
       receiver.instance.identifier = identifier
       @type_instances[type][identifier] = receiver.instance
     end
@@ -102,12 +174,39 @@ class SDL::Base::ServiceCompendium
     end
   end
 
+  ##
+  # Unloads all items with the specified uri from this service compendium
+  def unload(uri)
+    @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
+
+      klass.loaded_from.eql? uri
+    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
 
+  # This module contains the #loaded_from attribute for all items, which can be loaded by a service compendium
+  module ServiceCompendiumMixin
+    attr_accessor :loaded_from
+
+    [SDL::Base::Type, SDL::Base::Type.class, SDL::Base::Service].each do |klass|
+      klass.instance_eval do
+        include SDL::Base::ServiceCompendium::ServiceCompendiumMixin
+      end
+    end
+  end
+
   private
     ##
     # Registers all default types

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

@@ -0,0 +1,35 @@
+# 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
+
+    Dir.glob(File.join(path_or_filename, '**', '*.service.rb')) do |filename|
+      service_name = filename.match(%r[.+/(.+).service.rb])[1]
+
+      load_service_from_string File.read(filename), service_name, filename
+    end
+  end
+
+  ##
+  # Loads a service from a string. The URI is used with ServiceCompendium#with_uri.
+  # @param [String] service_definition The service definition
+  # @param [String] service_name The service name
+  # @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
+      end
+    rescue Exception => e
+      raise SyntaxError.new("Error while loading '#{service_name}' from '#{uri}': #{e}")
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# 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
+
+    Dir.glob(File.join(path_or_filename, '**', '*.sdl.rb')) do |filename|
+      with_uri filename do
+        load_vocabulary_from_string File.read(filename), filename
+      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
+
+      raise "Error while loading vocabulary from #{uri}: #{e}"
+    end
+  end
+end

data/lib/sdl/ng/version.rb

@@ -1,5 +1,5 @@
 module SDL
   module NG
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/lib/sdl/types/sdl_type.rb

@@ -6,22 +6,34 @@ module SDL::Types::SDLType
   end
 
   module ClassMethods
-    ## The Ruby type, which is to be wrapped
+    ##
+    # The Ruby type, which is to be wrapped
+    #
+    # @return Class
     attr :wrapped_type
 
-    ## The codes, which are to be used to refer to this type
+    ##
+    # The codes, which are to be used to refer to this type
+    #
+    # @return [Symbol]
     attr :codes
 
     ##
     # Sets the wrapped Ruby type
+    # @param type Class
     def wraps(type)
       @wrapped_type = type
     end
 
     ##
-    # Registers the codes +symbols+ to be used to refer to this type
+    # Adds the +symbols+ to be used to refer to this type to the list
+    # of codes and returns them.
+    # @param [Array<Symbol>] *symbols the symbols to be used
+    # @return [Array<Symbol>] all resulting symbols
     def codes(*symbols)
-      @codes = symbols
+      @codes ||= []
+      symbols.each do |symbol| @codes << symbol end
+      @codes
     end
   end
 end

data/spec/examples_spec.rb

@@ -0,0 +1,28 @@
+require_relative 'spec_helper'
+
+require 'rspec'
+
+describe 'the bundled examples' do
+  let :compendium do
+    SDL::Base::ServiceCompendium.new
+  end
+
+  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
+
+  it 'can be loaded' do
+    expect { loaded_compendium }.not_to raise_exception
+  end
+
+  it 'traces load path' do
+    expected_path = File.join(__dir__, '..', 'examples', 'services', 'google_drive_for_business.service.rb')
+
+    expect(loaded_compendium.services['google_drive_for_business'].loaded_from).to eq expected_path
+  end
+end

data/spec/service_compendium_spec.rb

@@ -59,6 +59,87 @@ describe 'The service compendium' do
     expect(subject).to be CONTEXT_SELF
   end
 
+  it 'is independent of one another' do
+    first_compendium = SDL::Base::ServiceCompendium.new
+    second_compendium = SDL::Base::ServiceCompendium.new
+
+    first_compendium.facts_definition do
+      fact :first
+    end
+
+    second_compendium.facts_definition do
+      fact :second
+    end
+
+    expect {
+      first_compendium.service 'first_service' do
+        has_second
+      end
+    }.to raise_exception
+
+    service = first_compendium.service 'second_service' do
+      has_first
+    end
+
+    expect(service).not_to respond_to :second
+  end
+
+  it 'does not partially load invalid services' do
+    compendium = SDL::Base::ServiceCompendium.new
+
+    compendium.facts_definition do
+      fact :first_fact
+      fact :second_fact
+    end
+
+    service_definition = <<END
+has_first_fact
+has_second_fact
+has_third_fact
+END
+
+    expect{
+      compendium.load_service_from_string(service_definition, 'my_service', 'empty')
+    }.to raise_exception
+
+    expect(compendium.services.size).to eq 0
+  end
+
+  it 'does not partially load invalid vocabulary' do
+    new_compendium = SDL::Base::ServiceCompendium.new
+
+    new_compendium.with_uri 'rspec' do
+      new_compendium.type_instances_definition do
+        fact :first_fact
+        type :first_type
+
+        first_type :abc
+      end
+    end
+
+    facts_definition = <<END
+fact :second_fact
+type :second_type
+
+second_type :def
+
+fakt :third_fact
+tüpe :third_type
+END
+
+    expect {
+      new_compendium.load_vocabulary_from_string(facts_definition, 'empty')
+    }.to raise_exception
+
+    expect(new_compendium.fact_classes.count).to eq 1
+    expect(new_compendium.types.count).to eq 1
+    expect(new_compendium.type_instances.count).to eq 1
+  end
+
+  it 'does not let double definitions of types and facts happen' do
+    pending 'Not yet implemented'
+  end
+
   context 'with defined example classes' do
     subject do
       compendium = SDL::Base::ServiceCompendium.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdl-ng
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Mathias Slawik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-20 00:00:00.000000000 Z
+date: 2014-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -233,6 +233,8 @@ files:
 - lib/sdl/base/property.rb
 - lib/sdl/base/service.rb
 - lib/sdl/base/service_compendium.rb
+- lib/sdl/base/transactions/service_load_transaction.rb
+- lib/sdl/base/transactions/vocabulary_load_transaction.rb
 - lib/sdl/base/type.rb
 - lib/sdl/base/uri_mapped_resource.rb
 - lib/sdl/exporters.rb
@@ -268,6 +270,7 @@ files:
 - sdl-ng.gemspec
 - spec/bin_spec.rb
 - spec/documentation_spec.rb
+- spec/examples_spec.rb
 - spec/exporter_spec.rb
 - spec/fact_type_instance_definition_spec.rb
 - spec/nokogiri_spec.rb
@@ -307,6 +310,7 @@ summary: Framework for building descriptions of business services.
 test_files:
 - spec/bin_spec.rb
 - spec/documentation_spec.rb
+- spec/examples_spec.rb
 - spec/exporter_spec.rb
 - spec/fact_type_instance_definition_spec.rb
 - spec/nokogiri_spec.rb