sdl-ng 0.1.1 → 0.1.2

data/spec/documentation_spec.rb

@@ -1,12 +1,9 @@
-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'
-
+store_translation = lambda {
   I18n.backend.store_translations('en', :sdl => {
       :type => {
           :color => 'A color'
@@ -25,15 +22,22 @@ describe 'Documentation of SDL objects' do
       :instance => {
           :type => {
               :color => {
-                  :red => 'The color "red"'
+                  :red => 'The color "red"',
+                  :blue => '#{hex_value}'
               }
           }
       }
   })
+}
+
+describe 'Documentation of SDL objects' do
+  include_context 'the default compendium'
 
   # Registers the classes of the default compendium
   before(:each) do
     compendium.register_classes_globally
+
+    store_translation.call
   end
 
   it 'can document types' do
@@ -61,4 +65,8 @@ describe 'Documentation of SDL objects' do
 
     expect(I18n.backend.instance_variable_get(:@translations)[:en][:sdl][:instance][:type][:color][:green]).to eq('Translate')
   end
+
+  it 'evaluates statements enclosed within #{}' do
+    expect(compendium.type_instances[Color][:blue].documentation).to eq('#00F')
+  end
 end

data/spec/exporter_spec.rb

@@ -0,0 +1,82 @@
+require_relative 'spec_helper'
+require_relative 'shared_test_compendium'
+
+require 'rspec'
+
+describe 'The exporters' do
+  include_context 'the default compendium'
+
+  let :xsd_exporter do
+    SDL::Exporters::XSDSchemaExporter.new(compendium)
+  end
+
+  let :schema do
+    xsd_exporter.export_schema
+  end
+
+  let :parsed_schema do
+    Nokogiri::XML::Schema(schema)
+  end
+
+  context 'The XSD exporter' do
+    it 'creates a valid XML Schema Definition' do
+      expect {
+        parsed_schema
+      }.to_not raise_exception
+    end
+  end
+
+  context 'The XML exporter' do
+    it 'creates valid XML documents according to the schema' do
+      compendium.services.each do |name, service|
+        xml_export = service.to_xml
+
+        errors = parsed_schema.validate(Nokogiri::XML::Document.parse(xml_export))
+
+        expect(errors).to be_empty
+      end
+    end
+  end
+
+  context 'The RDF exporter' do
+    it 'creates valid RDF documents' do
+      compendium.services.each do |name, service|
+        rdf_export = service.to_rdf
+
+        RDF::RDFXML::Reader.new(rdf_export, :validate => true) do |reader|
+          expect(reader.valid?)
+        end
+      end
+    end
+  end
+
+  context 'The exported files' do
+    it 'contains the XSD export' do
+      file = Tempfile.new('export.xsd')
+      xsd_export = xsd_exporter.export_schema
+
+      begin
+        xsd_exporter.export_schema_to_file file.path
+        expect(file.read).to eq xsd_export
+      ensure
+        file.close
+        file.unlink
+      end
+    end
+
+    it 'contains XML export' do
+      compendium.services.each do |name, service|
+        file = Tempfile.new("#{name}.xml")
+        xml_export = service.to_xml
+
+        begin
+          SDL::Exporters::XMLServiceExporter.new(compendium).export_service_to_file(service, file.path)
+          expect(file.read).to eq xml_export
+        ensure
+          file.close
+          file.unlink
+        end
+      end
+    end
+  end
+end

data/spec/fact_type_instance_definition_spec.rb

@@ -1,4 +1,3 @@
-require_relative '../lib/sdl'
 require_relative 'spec_helper'
 require_relative 'shared_test_compendium'
 
@@ -93,6 +92,16 @@ describe 'Doing type instance definition' do
     end.to raise_exception
   end
 
+  it 'raises an error, if a value with an invalid type is given for multi valued properties' do
+    expect {
+      service = compendium.service(:invalid_service) do
+        has_multicolor do
+          color "Blue"
+        end
+      end
+    }.to raise_exception
+  end
+
   it 'can be done through multiple arguments and associative hashes' do
     compendium.facts_definition do
       type :multi do
@@ -158,6 +167,7 @@ describe 'Doing type instance definition' do
       has_color :yellow, annotation: "Yuck!"
     end
 
+    expect(compendium.services[:yellow_service].facts[0].annotated?).to eq true
     expect(compendium.services[:yellow_service].facts[0].annotations).to include("Yuck!")
   end
 
@@ -169,6 +179,8 @@ describe 'Doing type instance definition' do
       end
     end
 
+    expect(compendium.services[:favourite_service].facts[0].favourites[0].class.list_item?).to eq true
+
     expect(compendium.services[:favourite_service].facts[0].favourites[0].color).to eq(compendium.type_instances[Color][:red])
     expect(compendium.services[:favourite_service].facts[0].favourites[1].color).to eq(compendium.type_instances[Color][:green])
     expect(compendium.services[:favourite_service].facts[0].favourites[0].rating).to eq 5
@@ -176,13 +188,151 @@ describe 'Doing type instance definition' do
   end
 
   it 'returns the values of all properties by calling #property_values on a type' do
-    compendium.service :imaginative_service do
+    service = compendium.service :imaginative_service do
       has_color :yellow, 'Yellow'
     end
 
-    property_values = compendium.services[:imaginative_service].facts[0].property_values
+    property_values = service.facts[0].property_values
 
     expect(property_values[property_values.keys[0]]).to eq(compendium.type_instances[Color][:yellow])
     expect(property_values[property_values.keys[1]]).to eq 'Yellow'
   end
+
+  it 'can reject empty property values if specifying include_empty' do
+    property_values = compendium.service :empty_service do
+      has_color
+    end.color.property_values(false)
+
+    expect(property_values).to be_empty
+  end
+
+  it 'returns its service for the parent of facts' do
+    red_service = compendium.services[:red_service]
+
+    expect(red_service.facts[0].parent).to eq red_service
+  end
+
+  it 'returns a parent type or fact for the parent of types' do
+    compendium.facts_definition do
+      type :third_level_type
+
+      type :second_level_type do
+        third_level_type
+      end
+
+      type :first_level_type do
+        second_level_type
+      end
+
+      fact :fact_with_children do
+        first_level_type
+      end
+
+      third_level_type :third
+
+      second_level_type :second do
+        third_level_type :third
+      end
+
+      first_level_type :first do
+        second_level_type :second
+      end
+    end
+
+    service = compendium.service :service_with_children do
+      has_fact_with_children do
+        first_level_type :first
+      end
+    end
+
+    first_level = service.facts[0].first_level_type
+    second_level = first_level.second_level_type
+    third_level = second_level.third_level_type
+
+    expect(third_level.parent).to eq second_level
+    expect(second_level.parent).to eq first_level
+  end
+
+  it 'returns nil for #parent_index, if the type is used as value of a single-valued property' do
+    new_color = Color.new
+
+    compendium.service :service_single_value do
+      has_color do
+        color new_color
+      end
+    end
+
+    expect(new_color.parent_index).to eq nil
+  end
+
+  it 'returns the index of a value in a multi-valued property when giving a compatible value for the list' do
+    first_color = Color.new
+    second_color = Color.new
+
+    compendium.service :service_multi_value do
+      has_multicolor do
+        color first_color
+        color second_color
+      end
+    end
+
+    expect(first_color.parent_index).to eq 0
+    expect(second_color.parent_index).to eq 1
+  end
+
+  it 'returns the index of a value in a multi-valued property when specifying a list value' do
+    service = compendium.service :service_multi_value do
+      has_multicolor do
+        color do
+          hex_value '#123'
+        end
+
+        color do
+          hex_value '#456'
+        end
+      end
+    end
+
+    expect(service.multicolor.colors[0].parent_index).to eq 0
+    expect(service.multicolor.colors[1].parent_index).to eq 1
+  end
+
+  it 'does not set #parent_index if given a predefined type' do
+    service = compendium.service :service_multi_value_predefined_type do
+      color red
+    end
+
+    expect(compendium.type_instances[Color][:red].parent_index).to eq nil
+  end
+
+  it 'returns the index of a fact instance in relation to its fact class' do
+    service = compendium.service :service_multiple_facts do
+      has_color :red
+      has_color :green
+      has_color :blue
+
+      has_multicolor
+    end
+
+    expect(service.colors[0].parent_index).to eq 0
+    expect(service.colors[1].parent_index).to eq 1
+    expect(service.colors[2].parent_index).to eq 2
+    expect(service.multicolors[0].parent_index).to eq 0
+  end
+
+  it 'marks fact types with multiple properties as multi_property?' do
+    compendium.fact_classes.each do |fact_class|
+      if fact_class.properties.count > 1
+        expect(fact_class.multi_property?).to eq true
+      end
+    end
+  end
+
+  it 'raises an error, if it gets the wrong type of property value' do
+    expect {
+      service = compendium.service :simple_service do
+        name Object.new
+      end
+    }.to raise_exception
+  end
 end

data/spec/nokogiri_spec.rb

@@ -0,0 +1,54 @@
+require_relative 'spec_helper'
+
+require 'rspec'
+
+describe 'The nokogiri helper' do
+  # Mocks also open()
+  let :nokogiri_utils do
+    util_object = Object.new
+
+    util_object.class_eval do
+      include SDL::Util::NokogiriUtils
+
+      def open(url)
+        if(url.eql? 'http://www.shared-test-html.html/test')
+          Kernel.open(File.join(__dir__, 'shared_test_html.html'))
+        else
+          raise SocketError.new
+        end
+      end
+    end
+
+    util_object
+  end
+
+  let :html_root do
+    nokogiri_utils.fetch_from_url 'http://www.shared-test-html.html/test', 'html'
+  end
+
+  let :first_link do
+    html_root.search('a[@href]')[0]
+  end
+
+  it 'can open and process html content' do
+    expect {
+      html_root
+    }.to_not raise_exception
+  end
+
+  it 'can rewrite relative to absolute links' do
+    expect(first_link[:href]).to eq 'http://www.shared-test-html.html/test'
+  end
+
+  it 'can rewrite link targets' do
+    expect(first_link[:target]).to eq '_new'
+  end
+
+  it 'silently ignores invalid link urls' do
+    expect(html_root.search('a[@href]')[1][:href]).to eq '::#::'
+  end
+
+  it 'returns an empty array if getting an SocketError' do
+    expect(nokogiri_utils.fetch_from_url('http://SocketError', 'html')).to eq []
+  end
+end

data/spec/property_definitions_spec.rb

@@ -1,4 +1,3 @@
-require_relative '../lib/sdl'
 require_relative 'spec_helper'
 
 require 'rspec'
@@ -13,6 +12,9 @@ describe 'The definition of properties' do
 
     defined_property = subject.klass.properties.first
 
+    expect(subject.klass.single_property?).to eq true
+    expect(subject.klass.single_property).to eq defined_property
+
     expect(defined_property.name).to eq "my_string_property"
     expect(defined_property.type).to be SDL::Types::SDLString
     expect(defined_property.multi).to be_false

data/spec/service_compendium_spec.rb

@@ -1,4 +1,3 @@
-require_relative '../lib/sdl'
 require_relative 'spec_helper'
 
 require 'rspec'
@@ -18,6 +17,7 @@ describe 'The service compendium' do
     subject.fact :has_example_fact
 
     expect(subject.fact_classes.first).to be < SDL::Base::Fact
+    expect(subject.fact_classes.first.propertyless?).to eq true
   end
 
   it 'allows the definition of fact subclasses' do

data/spec/service_definition_spec.rb

@@ -1,4 +1,3 @@
-require_relative '../lib/sdl'
 require_relative 'spec_helper'
 
 require 'rspec'
@@ -21,29 +20,28 @@ describe 'The definition of services' do
   end
 
   context 'the addition of a Fact instance' do
-    after(:all) do
-      example_service = example_compendium.services[:example_service]
-      example_fact_instance = example_service.facts.first
-
-      expect(example_fact_instance).to be_a(example_compendium.fact_classes.first)
-    end
-
     it 'allows the addition of a Fact instance using has_{Fact class name} syntax' do
-      example_compendium.service(:example_service) do
+      service = example_compendium.service(:example_service_1) do
         has_fact
       end
+
+      expect(service.facts[0]).to be_a(example_compendium.fact_classes.first)
     end
 
     it 'allows the addition of a Fact instance using {Fact class name} syntax' do
-      example_compendium.service(:example_service) do
+      service = example_compendium.service(:example_service_2) do
         fact
       end
+
+      expect(service.facts[0]).to be_a(example_compendium.fact_classes.first)
     end
 
     it 'allows the addition of a Fact instance using is_{Fact class name past participle} syntax' do
-      example_compendium.service(:example_service) do
+      service = example_compendium.service(:example_service_3) do
         is_facted
       end
+
+      expect(service.facts[0]).to be_a(example_compendium.fact_classes.first)
     end
   end
 
@@ -78,4 +76,28 @@ describe 'The definition of services' do
 
     expect(service.my_value.my_value).to eq "ABC"
   end
+
+  it 'allows to access all fact instances by their plural name' do
+    service = example_compendium.service(:different_service) do
+      my_value 'GHI'
+      my_value 'JKL'
+      my_value 'MNO'
+    end
+
+    expect(service.my_values.join).to eq 'GHIJKLMNO'
+  end
+
+  it 'lets facts be grouped by their fact class' do
+    service = example_compendium.service(:another_service) do
+      my_value 'ABC'
+      my_value 'DEF'
+    end
+
+    fact_class_facts_map = service.fact_class_facts_map
+
+    expect(fact_class_facts_map.keys[0]).to eq service.facts[0].class
+
+    expect(fact_class_facts_map[service.facts[0].class][0]).to eq service.facts[0]
+    expect(fact_class_facts_map[service.facts[0].class][1]).to eq service.facts[1]
+  end
 end