sdl-ng 0.0.1

data/spec/fact_type_instance_definition_spec.rb

@@ -0,0 +1,188 @@
+require_relative '../lib/sdl'
+require_relative 'spec_helper'
+require_relative 'shared_test_compendium'
+
+require 'rspec'
+
+shared_examples_for 'it can use identifiers for predefined types' do
+  it 'can set facts' do
+    eval "compendium.service :red_service do
+      has_color #{red_identifier}, 'Ruby Red'
+    end"
+
+    expect(compendium.services[:red_service].facts[0].color).to eq(compendium.type_instances[Color][:red])
+    expect(compendium.services[:red_service].facts[0].name).to eq("Ruby Red")
+  end
+
+  it 'lets service definitions use symbolic names also in lists' do
+    eval "compendium.service :multicolored_service do
+      has_multicolor do
+        color #{red_identifier}
+        color #{green_identifier}
+      end
+    end"
+
+    expect(compendium.services[:multicolored_service].facts[0].colors[0]).to eq(compendium.type_instances[Color][:red])
+    expect(compendium.services[:multicolored_service].facts[0].colors[1]).to eq(compendium.type_instances[Color][:green])
+  end
+end
+
+describe 'Doing type instance definition' do
+  include_context 'the default compendium'
+
+  # Registers the classes of the default compendium
+  before(:each) do
+    compendium.register_classes_globally
+  end
+
+  context 'With identifiers as symbolic names' do
+    it_should_behave_like 'it can use identifiers for predefined types' do
+      let :red_identifier do
+        ':red'
+      end
+
+      let :green_identifier do
+        ':green'
+      end
+    end
+  end
+
+  context 'With identifiers as regular names (i.e. method calls)' do
+    it_should_behave_like 'it can use identifiers for predefined types' do
+      let :red_identifier do
+        'red'
+      end
+
+      let :green_identifier do
+        'green'
+      end
+    end
+  end
+
+  it 'raises errors if it detects non existing names or symbols' do
+    expect {compendium.service :invalid_service do
+      has_multicolor do
+        color :the_colour_of_magic
+      end
+    end}.to raise_exception
+
+    expect do
+      compendium.service :second_invalid_service do
+        has_color :the_colour_of_magic
+      end
+    end.to raise_exception
+
+    expect {compendium.service :invalid_service do
+      has_multicolor do
+        color the_colour_of_magic
+      end
+    end}.to raise_exception
+
+    expect do
+      compendium.service :second_invalid_service do
+        has_color the_colour_of_magic
+      end
+    end.to raise_exception
+  end
+
+  it 'raises an error, if multiple predefined type instances with the same name are found by #method_missing' do
+    expect do
+      compendium.service :service_with_ambiguous_reference do
+        color text
+      end
+    end.to raise_exception
+  end
+
+  it 'can be done through multiple arguments and associative hashes' do
+    compendium.facts_definition do
+      type :multi do
+        string :a
+        string :b
+        string :c
+        string :d
+        string :e
+      end
+
+      fact :multi do
+        string :a
+        string :b
+        string :c
+        string :d
+        string :e
+      end
+
+      fact :multi_multi do
+        list_of_multis :multis
+      end
+    end
+
+    compendium.service :multi_service do
+      multi '1', '2', d: '3'
+
+      multi_multi do
+        multi '1', '2', d: '3'
+        multi '3', '4', e: '5'
+      end
+    end
+
+    expect(compendium.services[:multi_service].facts[0].a).to eql '1'
+    expect(compendium.services[:multi_service].facts[0].b).to eql '2'
+    expect(compendium.services[:multi_service].facts[0].c).to eq(nil)
+    expect(compendium.services[:multi_service].facts[0].d).to eql '3'
+    expect(compendium.services[:multi_service].facts[0].e).to eq(nil)
+
+    expect(compendium.services[:multi_service].facts[1].multis[0].b).to eql '2'
+    expect(compendium.services[:multi_service].facts[1].multis[1].e).to eql '5'
+  end
+
+  context 'the #to_s method of a service' do
+    it 'gives out the #to_s output of a same-named property than the class' do
+      compendium.service :named_color_service do
+        has_named_color 'My color name'
+      end
+
+      expect(compendium.services[:named_color_service].facts[0].to_s).to eq('My color name')
+    end
+
+    it 'gives out the Fact class local name when no same-named property than the class exists' do
+      compendium.service :blue_service do
+        has_color :blue
+      end
+
+      expect(compendium.services[:blue_service].facts[0].to_s).to eq('Color')
+    end
+  end
+
+  it 'lets facts be annotated by arbitrary values' do
+    compendium.service :yellow_service do
+      has_color :yellow, annotation: "Yuck!"
+    end
+
+    expect(compendium.services[:yellow_service].facts[0].annotations).to include("Yuck!")
+  end
+
+  it 'lets fact have list types' do
+    compendium.service :favourite_service do
+      favourite_colors do
+        favourite :red, 5
+        favourite :green, 10
+      end
+    end
+
+    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)
+    expect(compendium.services[:favourite_service].facts[0].favourites[1].rating).to eq(10)
+  end
+
+  it 'returns the values of all properties by calling #property_values on a type' do
+    compendium.service :imaginative_service do
+      has_color :yellow, 'Yellow'
+    end
+
+    property_values = compendium.services[:imaginative_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
+end

data/spec/property_definitions_spec.rb

@@ -0,0 +1,44 @@
+require_relative '../lib/sdl'
+require_relative 'spec_helper'
+
+require 'rspec'
+
+describe 'The definition of properties' do
+  subject do
+    SDL::Receivers::TypeReceiver.new :my_example_type, SDL::Base::ServiceCompendium.new
+  end
+
+  it 'allows the definition of properties' do
+    subject.string :my_string_property
+
+    defined_property = subject.klass.properties.first
+
+    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
+  end
+
+  it 'allows the definition of properties, omitting the name if it should be the same as the type' do
+    subject.url
+
+    defined_property = subject.klass.properties.first
+
+    expect(defined_property.name).to eq 'url'
+    expect(defined_property.type).to be SDL::Types::SDLUrl
+    expect(defined_property.multi).to be_false
+  end
+
+  it 'allows the definition of list properties' do
+    subject.list_of_integers :my_integer_list
+
+    defined_property = subject.klass.properties.first
+
+    expect(defined_property.name).to eq("my_integer_list")
+    expect(defined_property.type).to be SDL::Types::SDLNumber
+    expect(defined_property.multi?).to be_true
+  end
+
+  it 'does not handle unknown types' do
+    expect {subject.unknown_type}.to raise_exception
+  end
+end

data/spec/service_compendium_spec.rb

@@ -0,0 +1,90 @@
+require_relative '../lib/sdl'
+require_relative 'spec_helper'
+
+require 'rspec'
+
+describe 'The service compendium' do
+  subject do
+    SDL::Base::ServiceCompendium.new
+  end
+
+  it 'has empty arrays' do
+    %w[fact_classes types type_instances services].each do |list|
+      expect(subject.send(list)).to be_empty
+    end
+  end
+
+  it 'allows the definition of service fact classes' do
+    subject.fact :has_example_fact
+
+    expect(subject.fact_classes.first).to be < SDL::Base::Fact
+  end
+
+  it 'allows the definition of fact subclasses' do
+    subject.fact :example_fact do
+      subfact :example_subfact
+    end
+
+    expect(subject.fact_classes.last.superclass).to be subject.fact_classes.first
+  end
+
+  it 'allows the definition of service types' do
+    subject.type :example_type
+
+    expect(subject.types.first).to be < SDL::Base::Type
+  end
+
+  it 'allows the definition of services' do
+    subject.service :example_service
+
+    expect(subject.services[:example_service]).to be_a(SDL::Base::Service)
+    expect(subject.services[:example_service]).to eq(subject.services.first[1])
+  end
+
+  it 'can register defined classes globally' do
+    subject.fact :example_fact
+    subject.type :example_type
+
+    subject.register_classes_globally
+
+    expect(Kernel.const_get('ExampleFact')).to be < SDL::Base::Fact
+    expect(Kernel.const_get('ExampleType')).to be < SDL::Base::Type
+  end
+
+  it 'has a #facts_definition shortcut' do
+    subject.facts_definition do
+      CONTEXT_SELF = self
+    end
+
+    expect(subject).to be CONTEXT_SELF
+  end
+
+  context 'with defined example classes' do
+    subject do
+      compendium = SDL::Base::ServiceCompendium.new
+      compendium.fact :example_fact
+      compendium.register_classes_globally
+      compendium
+    end
+
+    it 'allows to use these facts in the definition of services' do
+      subject.service :example_service do
+        has_example_fact
+      end
+
+      expect(subject.services[:example_service].facts.first).to be_an(ExampleFact)
+    end
+  end
+
+  context 'with a new service type' do
+    subject do
+      compendium = SDL::Base::ServiceCompendium.new
+      compendium.type :example_type
+      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
+    end
+  end
+end

data/spec/service_definition_spec.rb

@@ -0,0 +1,81 @@
+require_relative '../lib/sdl'
+require_relative 'spec_helper'
+
+require 'rspec'
+
+describe 'The definition of services' do
+  let! :example_compendium do
+    compendium = SDL::Base::ServiceCompendium.new
+
+    compendium.facts_definition do
+      fact :fact
+
+      fact :my_value do
+        string :my_value
+
+        subfact :my_inherited_value
+      end
+    end
+
+    compendium
+  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
+        has_fact
+      end
+    end
+
+    it 'allows the addition of a Fact instance using {Fact class name} syntax' do
+      example_compendium.service(:example_service) do
+        fact
+      end
+    end
+
+    it 'allows the addition of a Fact instance using is_{Fact class name past participle} syntax' do
+      example_compendium.service(:example_service) do
+        is_facted
+      end
+    end
+  end
+
+  it 'allows to set a property value of a Fact instance, when both the property and the instance class have the same name' do
+    compendium = example_compendium
+
+    compendium.service(:example_service) do
+      my_value "ABC"
+      my_inherited_value "BCD"
+    end
+
+    example_service = compendium.services[:example_service]
+    my_inherited_value_fact = example_service.facts.last
+
+    expect(my_inherited_value_fact).to be_a(compendium.fact_classes.last)
+
+    expect(my_inherited_value_fact.my_value).to eq("BCD")
+  end
+
+  it 'raises an error, if a value is given for a non-existing property' do
+    expect do
+      example_compendium.service(:example_service) do
+        my_value "ABC", "DEF"
+      end
+    end.to raise_exception
+  end
+
+  it 'allows to access the first fact instance by its name' do
+    service = example_compendium.service(:my_service) do
+      my_value "ABC"
+    end
+
+    expect(service.my_value.my_value).to eq "ABC"
+  end
+end

data/spec/shared_test_compendium.rb

@@ -0,0 +1,65 @@
+require 'rspec'
+
+shared_context 'the default compendium' do
+  let :compendium do
+    compendium = SDL::Base::ServiceCompendium.new
+
+    compendium.facts_definition do
+      type :color do
+        string :hex_value
+      end
+
+      type :something_other do
+        string :some_text
+      end
+
+      fact :color do
+        color :color
+        string :name
+
+        subfact :supercolor do
+          string :superpower
+        end
+      end
+
+      fact :multicolor do
+        list_of_colors :colors
+      end
+
+      fact :favourite_colors do
+        list :favourites do
+          color :color
+          int :rating
+        end
+      end
+    end
+
+    compendium.type_instances_definition do
+      color :red do
+        hex_value '#F00'
+      end
+
+      color :green do
+        hex_value '#0F0'
+      end
+
+      color :blue do
+        hex_value '#00F'
+      end
+
+      color :yellow do
+        hex_value '#FF0'
+      end
+
+      color :text do
+        hex_value '#000'
+      end
+
+      something_other :text do
+        some_text 'This is some text'
+      end
+    end
+
+    compendium
+  end
+end