ruby-xes 0.1.0

data/lib/xes/trace.rb

@@ -0,0 +1,57 @@
+module XES
+  # Trace represents "trace" element of XES.
+  class Trace
+    include TraceAttributeAccessor
+
+    # @return [Array<Attribute>]
+    #  attributes of the trace element
+    attr_accessor :attributes
+
+    # @return [Array<Event>]
+    #  events included in the trace element
+    attr_accessor :events
+
+    # Create a XES trace.
+    #
+    # @param events [Array<Event>]
+    #   events included in the trace element
+    def initialize(attributes=[], events=[])
+      @attributes = attributes
+      @events = events
+    end
+
+    # Return true if the element is formattable.
+    #
+    # @return [Boolean]
+    #   true if the element is formattable
+    def formattable?
+      @events.any? {|event| event.formattable?}
+    end
+
+    # Format as a XML element.
+    #
+    # @return [REXML::Element]
+    #   XML element
+    # @raise FormatError
+    def format
+      raise FormatError.new(self) unless formattable?
+
+      REXML::Element.new("trace").tap do |trace|
+        @attributes.each {|attribute| trace.elements << attribute.format if attribute.formattable?}
+        @events.each {|event| trace.elements << event.format if event.formattable?}
+      end
+    end
+
+    # @api private
+    def ==(other)
+      return false unless other.kind_of?(self.class)
+      @attributes == other.attributes and @events == other.events
+    end
+    alias :eql? :"=="
+
+    # @api private
+    def hash
+      @attributes.hash + @events.hash
+    end
+  end
+end

data/lib/xes/version.rb

@@ -0,0 +1,4 @@
+module XES
+  # version of ruby-xes
+  VERSION = "0.1.0"
+end

data/ruby-xes.gemspec

@@ -0,0 +1,24 @@
+# -*- ruby -*-
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ruby-xes"
+  gem.version       = XES::VERSION
+  gem.authors       = ["Keita Yamaguchi"]
+  gem.email         = ["keita.yamaguchi@gmail.com"]
+  gem.description   = "ruby-xes is a library for generating XES event log."
+  gem.summary       = "ruby-xes is a library for generating XES event log."
+  gem.homepage      = "https://github.com/pione/ruby-xes"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bacon"
+  gem.add_development_dependency "yard", "~> 0.8.5"
+  gem.add_development_dependency "redcarpet"
+end

data/test/spec_attribute.rb

@@ -0,0 +1,150 @@
+require 'xes'
+
+describe "XES::Attribute" do
+  it "should equal" do
+    XES::Attribute.new("string", "concept:name", "A").should ==
+      XES::Attribute.new("string", "concept:name", "A")
+  end
+
+  it 'should not equal' do
+    XES::Attribute.new("string", "concept:name", "A").should !=
+      XES::Attribute.new("string", "concept:name", "B")
+  end
+
+  it 'should make string attribute' do
+    XES.string("concept:name", "A").should ==
+      XES::Attribute.new("string", "concept:name", "A")
+  end
+
+  it 'should make date attribute' do
+    Time.now.tap do |time|
+      XES.date("time:timestamp", time).should ==
+        XES::Attribute.new("date", "time:timestamp", time)
+    end
+  end
+
+  it 'should make int attribute' do
+    XES.int("counter", 123).should ==
+      XES::Attribute.new("int", "counter", 123)
+  end
+
+  it 'should make float attribute' do
+    XES.float("counter", 0.123).should ==
+      XES::Attribute.new("float", "counter", 0.123)
+  end
+
+  it 'should make boolean attribute' do
+    XES.boolean("truth", true).should ==
+      XES::Attribute.new("boolean", "truth", true)
+  end
+
+  it 'should make id attribute' do
+    XES.id("identity:id", "123").should ==
+      XES::Attribute.new("id", "identity:id", "123")
+  end
+
+  it 'should get the type' do
+    XES::Attribute.new("string", "concept:name", "A").type.should == "string"
+  end
+
+  it 'should get the key' do
+    XES::Attribute.new("string", "concept:name", "A").key.should == "concept:name"
+  end
+
+  it 'should get the value' do
+    XES::Attribute.new("string", "concept:name", "A").value.should == "A"
+  end
+
+  it 'should get meta attributes' do
+    XES::Attribute.new("string", "concept:name", "A").tap do |x|
+      x.meta << XES::Attribute.new("string", "meta", "1")
+    end.meta.should == [XES::Attribute.new("string", "meta", "1")]
+  end
+
+  it 'should get identity:id' do
+    XES::Attribute.new("string", "concept:name", "A").tap do |x|
+      x.meta << XES::Attribute.new("id", "identity:id", "123456")
+    end.identity_id.should == "123456"
+  end
+
+  it 'should set identity:id' do
+    XES::Attribute.new("string", "concept:name", "A").tap do |x|
+      x.identity_id = "test"
+    end.identity_id.should == "test"
+  end
+
+  it "should get cost:amount" do
+    XES.string("concept:name", "A").tap do |x|
+      x.meta << XES.float("cost:amount", 0.123)
+    end.cost_amount.should == 0.123
+  end
+
+  it "should set cost:amount" do
+    XES.string("concept:name", "A").tap do |x|
+      x.cost_amount = 0.123
+    end.cost_amount.should == 0.123
+  end
+
+  it "should get cost:driver" do
+    XES.string("concept:name", "A").tap do |x|
+      x.meta << XES.string("cost:driver", "xyz123")
+    end.cost_driver.should == "xyz123"
+  end
+
+  it "should set cost:driver" do
+    XES.string("concept:name", "A").tap do |x|
+      x.cost_driver = "xyz123"
+    end.cost_driver.should == "xyz123"
+  end
+
+  it "should get cost:type" do
+    XES.string("concept:name", "A").tap do |x|
+      x.meta << XES.string("cost:type", "Fixed Overhead")
+    end.cost_type.should == "Fixed Overhead"
+  end
+
+  it "should set cost:driver" do
+    XES.string("concept:name", "A").tap do |x|
+      x.cost_type = "Fixed Overhead"
+    end.cost_type.should == "Fixed Overhead"
+  end
+
+  it 'should format string attribute as XML' do
+    XES.string("concept:name", "A").format.to_s.should ==
+      "<string key='concept:name' value='A'/>"
+  end
+
+  it 'should format date attribute as XML' do
+    Time.now.tap do |time|
+      XES.date("time:timestamp", time).format.to_s.should ==
+        "<date key='time:timestamp' value='%s'/>" % time.iso8601
+    end
+  end
+
+  it 'should format int attribute as XML' do
+    XES.int("counter", 123).format.to_s.should ==
+      "<int key='counter' value='123'/>"
+  end
+
+  it 'should format float attribute as XML' do
+    XES.float("counter", 0.123).format.to_s.should ==
+      "<float key='counter' value='0.123'/>"
+  end
+
+  it 'should format boolean attribute as XML' do
+    XES.boolean("truth", true).format.to_s.should ==
+      "<boolean key='truth' value='true'/>"
+  end
+
+  it 'should format id attribute as XML' do
+    XES.id("identity:id", "123456").format.to_s.should ==
+      "<id key='identity:id' value='123456'/>"
+  end
+
+  it 'should format attribute with meta attribute as XML' do
+    XES.string("concept:name", "A").tap do |x|
+      x.identity_id = "123456"
+    end.format.to_s.should ==
+      "<string key='concept:name' value='A'><id key='identity:id' value='123456'/></string>"
+  end
+end

data/test/spec_classifier.rb

@@ -0,0 +1,26 @@
+require 'xes'
+
+describe "XES::Classifier" do
+  it "should equal" do
+    XES::Classifier.new("Event Name", "concept:name").should ==
+      XES::Classifier.new("Event Name", "concept:name")
+  end
+
+  it "should not equal" do
+    XES::Classifier.new("Event Name", "concept:name").should !=
+      XES::Classifier.new("Resource", "org:resource")
+  end
+
+  it "should get the name" do
+    XES::Classifier.new("Event Name", "concept:name").name.should == "Event Name"
+  end
+
+  it "should get the keys" do
+    XES::Classifier.new("Event Name", "concept:name").keys.should == "concept:name"
+  end
+
+  it "should format as XML element" do
+    XES::Classifier.new("Event Name", "concept:name").format.to_s.should ==
+      "<classifier keys='concept:name' name='Event Name'/>"
+  end
+end

data/test/spec_document.rb

@@ -0,0 +1,19 @@
+require 'xes'
+
+describe "XES::Document" do
+  it "should equal" do
+    XES::Document.new.should == XES::Document.new
+  end
+
+  it "should formattable" do
+    XES::Document.new.tap do |doc|
+      doc.log = XES::Log.new.tap do |log|
+        log.traces << XES::Trace.new.tap do |trace|
+          trace.events << XES::Event.new.tap do |event|
+            event.attributes << XES.string("concept:name", "test")
+          end
+        end
+      end
+    end.should.formattable
+  end
+end

data/test/spec_event.rb

@@ -0,0 +1,102 @@
+require 'xes'
+
+describe "XES::Event" do
+  it "should equal" do
+    XES::Event.new([XES.string("concept:name", "A")]).should ==
+      XES::Event.new([XES.string("concept:name", "A")])
+  end
+
+  it "should get concept:name" do
+    XES::Event.new([XES.string("concept:name", "A")]).concept_name.should == "A"
+  end
+
+  it "should set concept:name" do
+    XES::Event.new.tap{|x| x.concept_name = "A"}.concept_name.should == "A"
+  end
+
+  it "should get lifecycle:transition" do
+    XES::Event.new([XES.string("lifecycle:transition", "start")]).lifecycle_transition.should == "start"
+  end
+
+  it "should set lifecycle:transition" do
+    XES::Event.new.tap{|x| x.lifecycle_transition = "start"}.lifecycle_transition.should == "start"
+  end
+
+  it "should get org:resource" do
+    XES::Event.new([XES.string("org:resource", "A")]).org_resource.should == "A"
+  end
+
+  it "should set org:resource" do
+    XES::Event.new.tap{|x| x.org_resource = "A"}.org_resource.should == "A"
+  end
+
+  it "should get org:role" do
+    XES::Event.new([XES.string("org:role", "A")]).org_role.should == "A"
+  end
+
+  it "should set org:role" do
+    XES::Event.new.tap{|x| x.org_role = "A"}.org_role.should == "A"
+  end
+
+  it "should get org:group" do
+    XES::Event.new([XES.string("org:group", "A")]).org_group.should == "A"
+  end
+
+  it "should set org:group" do
+    XES::Event.new.tap{|x| x.org_group = "A"}.org_group.should == "A"
+  end
+
+  it "should get time:timestamp" do
+    Time.now.tap do |time|
+      XES::Event.new([XES.date("time:timestamp", time)]).time_timestamp.should == time
+    end
+  end
+
+  it "should set time:timestamp" do
+    Time.now.tap do |time|
+      XES::Event.new.tap{|x| x.time_timestamp = time}.time_timestamp.should == time
+    end
+  end
+
+  it "should get semantic:modelReference" do
+    XES::Event.new([XES.string("semantic:modelReference", "A")]).semantic_modelReference.should == "A"
+  end
+
+  it "should set semantic:modelReference" do
+    XES::Event.new.tap{|x| x.semantic_modelReference = "A"}.semantic_modelReference.should == "A"
+  end
+
+  it "should get identity:id" do
+    XES::Event.new([XES.id("identity:id", "A")]).identity_id.should == "A"
+  end
+
+  it "should set identity:id" do
+    XES::Event.new.tap{|x| x.identity_id = "123456"}.identity_id.should == "123456"
+  end
+
+  it "should get cost:total" do
+    XES::Event.new([XES.float("cost:total", 0.123)]).cost_total.should == 0.123
+  end
+
+  it "should set cost:total" do
+    XES::Event.new.tap{|x| x.cost_total = 0.123}.cost_total.should == 0.123
+  end
+
+  it "should get cost:currency" do
+    XES::Event.new([XES.string("cost:currency", "AUD")]).cost_currency.should == "AUD"
+  end
+
+  it "should set cost:total" do
+    XES::Event.new.tap{|x| x.cost_currency = "AUD"}.cost_currency.should == "AUD"
+  end
+
+  it "should get attributes" do
+    XES::Event.new([XES.string("concept:name", "A")]).attributes.should ==
+      [XES.string("concept:name", "A")]
+  end
+
+  it "should format as XML" do
+    XES::Event.new([XES.string("concept:name", "A")]).format.to_s.should ==
+      "<event><string key='concept:name' value='A'/></event>"
+  end
+end

data/test/spec_extension.rb

@@ -0,0 +1,34 @@
+require 'xes'
+
+describe "XES::Extension" do
+  it "should equal" do
+    XES::Extension.new("Concept", "concept", "http://www.xes-standard.org/concept.xesext").should ==
+      XES::Extension.new("Concept", "concept", "http://www.xes-standard.org/concept.xesext")
+  end
+
+  it "shoud not equal" do
+    XES::Extension.new("Concept", "concept", "http://www.xes-standard.org/concept.xesext").should !=
+      XES::Extension.new("Identity", "identity", "http://www.xes-standard.org/identity.xesext")
+  end
+
+  it "should get the name" do
+    XES::Extension.new("Concept", "concept", "http://www.xes-standard.org/concept.xesext").name.should == "Concept"
+  end
+
+  it "should get the prefix" do
+    XES::Extension.new("Concept", "concept", "http://www.xes-standard.org/concept.xesext").prefix.should == "concept"
+  end
+
+  it "should be formattable" do
+    XES::Extension.new("Concept", "concept", "http://www.xes-standard.org/concept.xesext").should.formattable
+  end
+
+  it "should be not formattable" do
+    XES::Extension.new("Concept", "concept", nil).should.not.formattable
+  end
+
+  it "should get the uri" do
+    XES::Extension.new("Concept", "concept", "http://www.xes-standard.org/concept.xesext").uri.should ==
+      "http://www.xes-standard.org/concept.xesext"
+  end
+end

data/test/spec_global.rb

@@ -0,0 +1,131 @@
+require 'xes'
+
+describe "XES::Global" do
+  it "should equal" do
+    XES::Global.event.should == XES::Global.event
+  end
+
+  it "should not equal" do
+    XES::Global.event.should != XES::Global.trace
+  end
+
+  it "should get the scope" do
+    XES::Global.event.scope.should == "event"
+  end
+
+  it "should get the attributes" do
+    XES::Global.event.tap do |global|
+      global.attributes << XES.string("concept:name", "__INVALID__")
+    end.attributes.should == [XES.string("concept:name", "__INVALID__")]
+  end
+
+  it "should set and get concept:name of event global" do
+    XES::Global.event.tap do |global|
+      global.concept_name = "A"
+    end.concept_name.should == "A"
+  end
+
+  it "should set and get concept:instance of event global" do
+    XES::Global.event.tap do |global|
+      global.concept_instance = "A"
+    end.concept_instance.should == "A"
+  end
+
+  it "should set and get lifecycle:transition of event global" do
+    XES::Global.event.tap do |global|
+      global.lifecycle_transition = "complete"
+    end.lifecycle_transition.should == "complete"
+  end
+
+  it "should set and get org:resource of event global" do
+    XES::Global.event.tap do |global|
+      global.org_resource = "A"
+    end.org_resource.should == "A"
+  end
+
+  it "should set and get org:role of event global" do
+    XES::Global.event.tap do |global|
+      global.org_role = "A"
+    end.org_role.should == "A"
+  end
+
+  it "should set and get org:group of event global" do
+    XES::Global.event.tap do |global|
+      global.org_group = "A"
+    end.org_group.should == "A"
+  end
+
+  it "should set and get time:timestamp of event global" do
+    Time.now.tap do |time|
+      XES::Global.event.tap do |global|
+        global.time_timestamp = time
+      end.time_timestamp.should == time
+    end
+  end
+
+  it "should set and get semantic:modelReference of event global" do
+    XES::Global.event.tap do |global|
+      global.semantic_modelReference = "A"
+    end.semantic_modelReference.should == "A"
+  end
+
+  it "should set and get identity:id of event global" do
+    XES::Global.event.tap do |global|
+      global.identity_id = "A"
+    end.identity_id.should == "A"
+  end
+
+  it "should set and get cost:total of event global" do
+    XES::Global.event.tap do |global|
+      global.cost_total = 0.123
+    end.cost_total.should == 0.123
+  end
+
+  it "should set and get cost:currency of event global" do
+    XES::Global.event.tap do |global|
+      global.cost_currency = "A"
+    end.cost_currency.should == "A"
+  end
+
+  it "should set and get concept:name of trace global" do
+    XES::Global.trace.tap do |global|
+      global.concept_name = "A"
+    end.concept_name.should == "A"
+  end
+
+  it "should set and get semantic:modelReference of trace global" do
+    XES::Global.trace.tap do |global|
+      global.semantic_modelReference = "A"
+    end.semantic_modelReference.should == "A"
+  end
+
+  it "should set and get identity:id of trace global" do
+    XES::Global.trace.tap do |global|
+      global.identity_id = "A"
+    end.identity_id.should == "A"
+  end
+
+  it "should set and get cost:total of trace global" do
+    XES::Global.trace.tap do |global|
+      global.cost_total = 0.123
+    end.cost_total.should == 0.123
+  end
+
+  it "should set and get cost:currency of trace global" do
+    XES::Global.trace.tap do |global|
+      global.cost_currency = "A"
+    end.cost_currency.should == "A"
+  end
+
+  it "should format event global as XML element" do
+    XES::Global.event.tap do |global|
+      global.concept_name = "A"
+    end.format.to_s.should == "<global scope='event'><string key='concept:name' value='A'/></global>"
+  end
+
+  it "should format trace global as XML element" do
+    XES::Global.trace.tap do |global|
+      global.concept_name = "A"
+    end.format.to_s.should == "<global scope='trace'><string key='concept:name' value='A'/></global>"
+  end
+end