sdl-ng 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0644352c4f68bdd697515b482b9ef0cb0ff70b8f
-  data.tar.gz: 37c8cf487314ca128ba486e48b4cf49ff0ea78e6
+  metadata.gz: f05cf34193d34c129b79bf12f395678350f6366f
+  data.tar.gz: 5c06d5f6a525dd22c71d4cf298918f176c089602
 SHA512:
-  metadata.gz: e5fe0c2f6b2076254fed49c023c4d2ec03bc897ad706901df7456ad6a12640c4f9007358ea987aaa1642d0fb84bf8b2ae2a3c818d65217feef21db2028c52f8b
-  data.tar.gz: fe27ea63d5b1451eb1a0de2f2ac142b297d8912593cbb20284a8cd9efdb67066d8e8df8e34e84b9e5abf64741306f0685bf996dfe13a5bf3199ae326be6cbc77
+  metadata.gz: e60d8d666defcd7ccad82082db948c7b8d0f22743fd653d84aeed0376e9ccee9b1668d11838a827a79eb368df7eee574c78b1be9117fe2d39b33623cd80bb390
+  data.tar.gz: b7afec5669d7987b787ec2d161eeb210bf138f7a7cd641963cdbc3b09753be25bbbe0332784e43546cfcb5d328018c3e021c706a45b41cf1980be2ffdfc67f3d

data/.simplecov

@@ -0,0 +1,7 @@
+SimpleCov.start do
+  # any custom configs like groups and filters can be here at a central place
+  add_group 'Library', 'lib'
+  add_group 'Specs', 'spec'
+
+  refuse_coverage_drop
+end

data/bin/process_service_descriptions

@@ -1,4 +1,25 @@
 #!/usr/bin/env ruby
+require 'optparse'
+
+profile = false
+mock = false
+OptionParser.new do |opts|
+  opts.banner = 'Usage: process_service_descriptions [-p]'
+
+  opts.on('-p', '--profile', 'Enable profiling') do |p|
+    profile = true
+  end
+
+  opts.on('-m', '--mock', 'Mock HTTP request') do |m|
+    mock = true
+  end
+end.parse
+
+if profile
+  require 'ruby-prof'
+
+  RubyProf.start
+end
 
 gem 'sdl-ng'
 
@@ -6,6 +27,14 @@ require 'sdl'
 require 'active_support'
 require 'i18n'
 
+if mock
+  SDL::Util::NokogiriUtils.module_eval do
+    def fetch_from_url(url, *search)
+      []
+    end
+  end
+end
+
 # Make the translations for fact classes, instances, etc. known to the I18n framework
 I18n.load_path << File.join(Dir.pwd, 'translations', 'en.yml')
 
@@ -30,11 +59,10 @@ end
 
 puts "Loaded Service Compendium with #{compendium.services.count} services. Generating output"
 
-%w[xml rdf markdown].each do |directory| FileUtils.mkdir_p File.join(Dir.pwd, 'output', directory) end
+%w[xml rdf].each do |directory| FileUtils.mkdir_p File.join(Dir.pwd, 'output', directory) end
 
 schema_exporter = SDL::Exporters::XSDSchemaExporter.new(compendium)
 service_exporter = SDL::Exporters::XMLServiceExporter.new(compendium)
-markdown_exporter = SDL::Exporters::MarkdownServiceExporter.new(compendium)
 rdf_exporter = SDL::Exporters::RDFExporter.new(compendium)
 
 schema_dir = Dir.pwd + '/output/xml/schema.xsd'
@@ -43,26 +71,14 @@ File.open(schema_dir, 'w') {|f|
   puts "Written Service Compendium XSD schema into #{schema_dir}"
 }
 
-# Load XSD
-xsd = Nokogiri::XML::Schema(File.read(Dir.pwd + '/output/xml/schema.xsd'))
-
 compendium.services.each do |name, service|
   xml_output_file = Dir.pwd + "/output/xml/#{name}.xml"
   service_exporter.export_service_to_file service, xml_output_file
   puts "Wrote XML export of service '#{name}' to #{xml_output_file}"
 
-  puts "Validating XML export against schema"
-  xsd.validate(Nokogiri::XML(File.read(Dir.pwd + "/output/xml/#{name}.xml"))).each do |error|
-    puts error.message
-  end
-
   rdf_output_file = Dir.pwd + "/output/rdf/#{name}.rdf"
   rdf_exporter.export_service_to_file service, rdf_output_file
   puts "Wrote RDF export of service '#{name}' to #{rdf_output_file}"
-
-  markdown_output_file = Dir.pwd + "/output/markdown/#{name}.md"
-  markdown_exporter.export_service_to_file service, markdown_output_file
-  puts "Wrote Markdown export of service '#{name}' to #{markdown_output_file}"
 end
 
 all_needed_translations = {
@@ -99,4 +115,8 @@ File.open(translations_output_file, 'w') do |f|
   puts "Wrote resulting translations file to #{translations_output_file}."
 end
 
-puts 'Finished'
+puts 'Finished'
+
+if profile
+  RubyProf::CallTreePrinter.new(RubyProf.stop).print(File.new('profile.kcachegrind', 'w'), {})
+end

data/lib/sdl/base/default_uri_mapper.rb

@@ -8,10 +8,14 @@ module SDL::Base
       case object
         when Type.class
           "#{DEFAULT_BASE_URI}/types/#{object.local_name}"
-        when Type
-          object.class.uri + '/' + object.hash.to_s
         when Fact
-          "#{object.service.uri}/#{object.class.local_name.underscore}-#{object.hash}"
+          "#{object.service.uri}/#{object.class.local_name.underscore}/#{object.parent_index}"
+        when Type
+          if object.identifier
+            "#{object.class.uri}/#{object.identifier.to_s}"
+          else
+            "#{object.parent.uri}/#{object.class.local_name}/#{object.parent_index}"
+          end
         when Service
           "#{DEFAULT_BASE_URI}/services/#{object.symbolic_name}"
         else

data/lib/sdl/base/fact.rb

@@ -4,4 +4,8 @@
 # Facts are defined by using a ServiceCompendium.
 class SDL::Base::Fact < SDL::Base::Type
   attr_accessor :service
+
+  def parent
+    service
+  end
 end

data/lib/sdl/base/type.rb

@@ -98,4 +98,10 @@ class SDL::Base::Type
 
   # An identifier for type instances
   attr_accessor :identifier
+
+  # The index of this type instance in the parent list
+  attr_accessor :parent_index
+
+  # The parent of this type.
+  attr_accessor :parent
 end

data/lib/sdl/exporters.rb

@@ -5,7 +5,6 @@ module SDL::Exporters
   autoload :SchemaExporter
   autoload :ServiceExporter
   autoload :RDFExporter
-  autoload :MarkdownServiceExporter
   autoload :XMLServiceExporter
   autoload :XSDSchemaExporter
 

data/lib/sdl/exporters/xml_mapping.rb

@@ -19,10 +19,6 @@ module SDL
         def xsd_type_name
           local_name
         end
-
-        def xsd_type_qname
-          'sdl:' + xsd_type_name
-        end
       end
     end
 

data/lib/sdl/exporters/xsd_schema_exporter.rb

@@ -17,10 +17,23 @@ class SDL::Exporters::XSDSchemaExporter < SDL::Exporters::SchemaExporter
   def export_schema_xml
     Nokogiri::XML::Builder.new do |xml|
       xml['ns'].schema('xmlns' => 'http://www.open-service-compendium.org', 'targetNamespace' => 'http://www.open-service-compendium.org', 'xmlns:ns' => 'http://www.w3.org/2001/XMLSchema', 'elementFormDefault' => 'qualified') do
-        xml['ns'].element :name => 'service' do
-          document(xml, I18n.t('sdl.xml.service_root'))
+        xml['ns'].element :name => 'services' do
+          document(xml, I18n.t('sdl.xml.services_root'))
           xml['ns'].complexType do
-            xml['ns'].choice :maxOccurs => 'unbounded' do
+            xml['ns'].sequence do
+              xml['ns'].element :name=> 'service', :type => 'Service', :minOccurs => 0, :maxOccurs => :unbounded
+            end
+          end
+        end
+
+        xml['ns'].element :name => 'service', :type => 'Service' do
+          document(xml, I18n.t('sdl.xml.service_root'))
+        end
+
+        xml['ns'].complexType :name => 'Service' do
+          document(xml, I18n.t('sdl.xml.service_class'))
+          xml['ns'].sequence do
+            xml['ns'].choice :maxOccurs => :unbounded do
               @compendium.fact_classes.each do |fact_class|
                 xml['ns'].element :name => fact_class.xsd_element_name, :type => fact_class.xsd_type_name do
                   document(xml, fact_class.documentation)

data/lib/sdl/ng/version.rb

@@ -1,5 +1,5 @@
 module SDL
   module NG
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/sdl/receivers/service_receiver.rb

@@ -37,6 +37,8 @@ class SDL::Receivers::ServiceReceiver < SDL::Receivers::Receiver
       end
 
       @service.facts << fact_instance
+
+      fact_instance.parent_index = @service.fact_class_facts_map[fact_class].count - 1
     end
 
     ##

data/lib/sdl/receivers/type_instance_receiver.rb

@@ -6,12 +6,12 @@ class SDL::Receivers::TypeInstanceReceiver < SDL::Receivers::Receiver
   ##
   # When initialized for a fact or type instance, the receiver creates singleton methods on itself for all
   # properties.
-  def initialize(instance, compendium)
+  def initialize(type_instance, compendium)
     super(compendium)
 
-    @instance = instance
+    @instance = type_instance
 
-    instance.class.properties(true).each do |property|
+    type_instance.class.properties(true).each do |property|
       if property.single?
         # Single valued properties are set by their name
         define_singleton_method property.name do |value = nil, &block|
@@ -20,39 +20,44 @@ class SDL::Receivers::TypeInstanceReceiver < SDL::Receivers::Receiver
           end
 
           begin
-            instance.send "#{property.name}=", value
+            type_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
+        # Multi-valued properties are added to by their singular name, e.g. 'browsers' is set by invoking 'browser'
         define_singleton_method property.name.singularize do |*property_values, &block|
-          existing_list = instance.send "#{property.name}"
-
-          unless property_values.empty?
-            # If there is just one parameter for a multi-valued property setter
-            if property_values.length == 1
-              # It could be a symbol, which would resolve to a predefined type instance of the same name
-              if property_values[0].is_a?(Symbol)
-                predefined_value = compendium.type_instances[property.type][property_values[0]]
-
-                raise "Could not find instance :#{property_values[0]} in predefined #{property.type.name} types" unless predefined_value
-
-                existing_list << compendium.type_instances[property.type][property_values[0]]
-              # Or better: it could already be an instance of the type - e.g. when using the implemented #method_mssing
-              elsif property_values[0].is_a? property.type
-                existing_list << property_values[0]
-              end
-            else
-              new_list_item = property.type.new
+          existing_list = type_instance.send "#{property.name}"
+
+          # If there is just one parameter for a multi-valued property setter
+          if property_values.length == 1
+            # It could be a symbol, which would resolve to a predefined type instance of the same name
+            if property_values[0].is_a?(Symbol)
+              predefined_value = compendium.type_instances[property.type][property_values[0]]
 
-              set_value(property.type, new_list_item, *property_values)
+              raise "Could not find instance :#{property_values[0]} in predefined #{property.type.name} types" unless predefined_value
 
-              self.class.new(new_list_item, @compendium).instance_exec(&block) unless block.nil?
+              existing_list << compendium.type_instances[property.type][property_values[0]]
+            # Or better: it could already be an instance of the type - e.g. when using the implemented #method_mssing
+            elsif property_values[0].is_a? property.type
+              existing_list << property_values[0]
 
-              existing_list << new_list_item
+              property_values[0].parent_index = existing_list.count - 1 unless property_values[0].identifier
+            else
+              raise "Type #{property_values[0].class} of list item '#{property_values}' is incompatible with list type #{property.type}."
             end
+          else
+            new_list_item = property.type.new
+
+            set_value(property.type, new_list_item, *property_values)
+
+            SDL::Receivers::TypeInstanceReceiver.new(new_list_item, @compendium).instance_exec(&block) unless block.nil?
+
+            existing_list << new_list_item
+
+            new_list_item.parent = type_instance
+            new_list_item.parent_index = existing_list.count - 1
           end
         end
       end

data/lib/sdl/receivers/type_receiver.rb

@@ -67,6 +67,8 @@ class SDL::Receivers::TypeReceiver < SDL::Receivers::Receiver
   private
     ##
     # Adds accessors to set the property to the target class.
+    #
+    # These accessors set the instance variable to the given value and set the parent of the value to self.
     def add_property(sym, type, multi)
       unless multi
         @klass.class_eval do
@@ -78,6 +80,8 @@ class SDL::Receivers::TypeReceiver < SDL::Receivers::Receiver
               instance_variable_set "@#{sym}".to_s, type.new(value)
             else
               instance_variable_set "@#{sym}".to_s, value
+
+              value.parent = self
             end
           end
         end

data/lib/sdl/translations/en.yml

@@ -7,5 +7,7 @@ en:
       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.
+      services_root: A list of services.
+      service_root: The root element of a service.
+      service_class: A service. It contains an arbitrary number of facts.
       typebase: The base type of all SDL types and facts. Contains annotations and documentation.

data/lib/sdl/types/sdl_description.rb

@@ -20,8 +20,10 @@ class SDL::Types::SDLDescription < SDL::Types::SDLSimpleType
         @raw_value.to_s
       when NilClass
         ''
+      when String
+        @value
       else
-        "Cannot convert #{@raw_value.class} to HTML. Please extend SDLDescription#to_html"
+        raise "Cannot convert #{@raw_value.class} to HTML. Please extend SDLDescription#to_html"
     end
   end
 end

data/lib/sdl/util/documentation.rb

@@ -85,7 +85,7 @@ module SDL::Base
     def documentation_key
       # Search class and ancestors, if any defines a documentation key
       @holder.ancestors.each do |ancestor|
-        break if ancestor.eql? SDL::Base::Type
+        break if ancestor.eql?(SDL::Base::Type) || ancestor.eql?(SDL::Types::SDLType)
 
         key = "sdl.property.#{SDL::Util::Documentation.walk_the_class_name(ancestor)}.#{@name}"
 

data/lib/sdl/util/nokogiri.rb

@@ -1,4 +1,5 @@
 require 'nokogiri'
+require 'socket'
 require 'open-uri'
 
 module SDL
@@ -7,30 +8,34 @@ module SDL
       ##
       # Fetches an Nokogiri::XML::NodeSet from the webpage at url by performing *search
       #
-      # Additionally it converts all relative href URLs to absolute URLs and adds a 'target' attribute to all
-      # links, so that they open in a new browser window and not the current broker.
       def fetch_from_url(url, *search)
         begin
-          doc = Nokogiri::HTML(open(url))
-
-          result = doc.search(*search)
+          fetch_from_io open(url), url, *search
+        rescue SocketError => e
+          []
+        end
+      end
 
-          result.search('//body//@href').each do |attribute|
-            begin
-              attribute.content = URI.join(url, attribute.value.gsub(/\s/, '')).to_s
-            rescue URI::InvalidURIError
-              next
-            end
+      def fetch_from_io(io, base_url, *search)
+        process_result Nokogiri::HTML(io).search(*search), base_url
+      end
 
-            if attribute.parent.name.eql? 'a'
-              attribute.parent['target'] = '_new'
-            end
+      # It converts all relative href URLs to absolute URLs and adds a 'target' attribute to all
+      # links, so that they open in a new browser window and not the current broker.
+      def process_result(result, base_url)
+        result.search('//body//@href').each do |attribute|
+          begin
+            attribute.content = URI.join(base_url, attribute.value.gsub(/\s/, '')).to_s
+          rescue URI::InvalidURIError
+            next
           end
 
-          result
-        rescue SocketError => e
-          []
+          if attribute.parent.name.eql? 'a'
+            attribute.parent['target'] = '_new'
+          end
         end
+
+        result
       end
     end
   end

data/sdl-ng.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activesupport', '~> 4.0'
   spec.add_runtime_dependency 'nokogiri', '~> 1.6'
   spec.add_runtime_dependency 'verbs', '~> 2.1'
-  spec.add_runtime_dependency 'linkeddata', '~> 1.1'
+  spec.add_runtime_dependency 'rdf', '~> 1.1'
+  spec.add_runtime_dependency 'rdf-rdfxml', '~> 1.1'
 
   spec.add_development_dependency 'yard', '~> 0.8.7.3'
   spec.add_development_dependency 'yard-redcarpet-ext', '~> 0.0.3'

data/spec/bin_spec.rb

@@ -1,14 +1,13 @@
-require_relative '../lib/sdl'
 require_relative 'spec_helper'
 
 require 'rspec'
 
 describe 'The process_service_descriptions binary script' do
   it 'can be executed' do
-    #Dir.chdir(File.join(__dir__, '..', 'examples')) do
-    #  `ruby #{File.join(__dir__, '..', 'bin', 'process_service_descriptions')}`
-    #
-    #  expect($?.exitstatus).to eq(0)
-    #end
+    Dir.chdir(File.join(__dir__, '..', 'examples')) do
+      expect {
+        load File.join(__dir__, '..', 'bin', 'process_service_descriptions')
+      }.not_to raise_exception
+    end
   end
 end