ruby-xes 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+html

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-xes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 NaU Data Institute Inc. and contributors.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# ruby-xes
+
+ruby-xes is a Ruby library for generating XES event log.
+
+## Installation
+
+    $ gem install ruby-xes
+
+## Usage
+
+```ruby
+require 'xes'
+
+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.format
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Licence
+
+ruby-xes is free software distributed under MIT licence.
+
+## Links
+
+* [PIONE project homepage](http://pione.github.io/)
+    * [repository on github](https://github.com/pione/pione)
+* [XES](http://www.xes-standard.org/start)

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+
+desc 'Test specs'
+task 'test' do
+  sh "bundle exec bacon -a"
+end
+
+desc 'Generate API document'
+task 'html' do
+  sh "bundle exec yard doc -o html --hide-void-return --no-api"
+end
+
+desc 'Show undocumented function list'
+task 'html:undoc' do
+  sh "bundle exec yard stats --list-undoc --no-api --compact"
+end

data/lib/xes.rb

@@ -0,0 +1,18 @@
+require "rexml/document"
+require "time"
+
+require "xes/version"
+require "xes/format-error"
+require "xes/attribute-accessor"
+require "xes/extension"
+require "xes/classifier"
+require "xes/attribute"
+require "xes/global"
+require "xes/event"
+require "xes/trace"
+require "xes/log"
+require "xes/document"
+
+# XES is a module for genereting XES event log.
+module XES
+end

data/lib/xes/attribute-accessor.rb

@@ -0,0 +1,121 @@
+module XES
+  # AttributeAccessor provides attribute accessors of standard extensions.
+  module AttributeAccessor
+    # Define an attribute accessor.
+    #
+    # @param name [String]
+    #   attribute name
+    # @param type [String]
+    #   attribute type
+    # @return [void]
+    def define_attribute(name, type)
+      _name = name.gsub(":", "_")
+
+      define_method(_name) do
+        var = instance_variables.include?(:@meta) ? :@meta : :@attributes
+        instance_variable_get(var).find do |attribute|
+          attribute.key == name
+        end.tap{|x| return x.value if x}
+      end
+
+      define_method("%s=" % _name) do |value|
+        var = instance_variables.include?(:@meta) ? :@meta : :@attributes
+        instance_variable_get(var).tap do |attributes|
+          if elt = __send__(_name)
+            attributes.delete(elt)
+          end
+          attributes << XES.send(type, name, value)
+        end
+      end
+    end
+  end
+
+  # EventAttributeAccessor provides attribute accessors for event or event global element.
+  module EventAttributeAccessor
+    extend AttributeAccessor
+
+    # @!attribute [rw] concept_name
+    #   @return [String]
+    #     the value of attribute "concept:name"
+    define_attribute "concept:name", "string"
+
+    # @!attribute [rw] concept_instance
+    #   @return [String]
+    #     the value of attribute "concept:instance"
+    define_attribute "concept:instance", "string"
+
+    # @!attribute [rw] lifecycle_transition
+    #   @return [String]
+    #     the value of attribute "lifecycle:transition"
+    define_attribute "lifecycle:transition", "string"
+
+    # @!attribute [rw] org_resource
+    #   @return [String]
+    #     the value of attribute "org:resource"
+    define_attribute "org:resource", "string"
+
+    # @!attribute [rw] org_role
+    #   @return [String]
+    #     the value of attribute "org:role"
+    define_attribute "org:role", "string"
+
+    # @!attribute [rw] org_group
+    #   @return [String]
+    #     the value of attribute "org:group"
+    define_attribute "org:group", "string"
+
+    # @!attribute [rw] time_timestamp
+    #   @return [Time,String]
+    #     the value of attribute "time:timestamp"
+    define_attribute "time:timestamp", "date"
+
+    # @!attribute [rw] semantic_modelReference
+    #   @return [String]
+    #     the value of attribute "semantic:modelReference"
+    define_attribute "semantic:modelReference", "string"
+
+    # @!attribute [rw] identity_id
+    #   @return [String]
+    #     the value of attribute "identity:id"
+    define_attribute "identity:id", "id"
+
+    # @!attribute [rw] cost_total
+    #   @return [Float]
+    #     the value of attribute "cost:total"
+    define_attribute "cost:total", "float"
+
+    # @!attribute [rw] cost_currency
+    #   @return [String]
+    #     the value of attribute "cost:currency"
+    define_attribute "cost:currency", "string"
+  end
+
+  # TraceAttributeAccessor provides attribute accessors for trace or trace global element.
+  module TraceAttributeAccessor
+    extend AttributeAccessor
+    # @!attribute [rw] concept_name
+    #   @return [String]
+    #     the value of attribute "concept:name"
+    define_attribute "concept:name", "string"
+
+    # @!attribute [rw] semantic_modelReference
+    #   @return [String]
+    #     the value of attribute "semantic:modelReference"
+    define_attribute "semantic:modelReference", "string"
+
+    # @!attribute [rw] identity_id
+    #   @return [String]
+    #     the value of attribute "identity:id"
+    define_attribute "identity:id", "id"
+
+    # @!attribute [rw] cost:total
+    #   @return [Float]
+    #     the value of attribute "cost:total"
+    define_attribute "cost:total", "float"
+
+    # @!attribute [rw] cost_currency
+    #   @return [String]
+    #     the value of attribute "cost:currency"
+    define_attribute "cost:currency", "string"
+  end
+end

data/lib/xes/attribute.rb

@@ -0,0 +1,201 @@
+module XES
+  # Attribute represents attribute of XES.
+  class Attribute
+    extend AttributeAccessor
+
+    # @!attribute [rw] semantic_modelReference
+    #   @return [String]
+    #     the value of meta attribute "semantic:modelReference"
+    define_attribute "semantic:modelReference", "string"
+
+    # @!attribute [rw] identity_id
+    #   @return [String]
+    #     the value of meta attribute "identity:id"
+    define_attribute "identity:id", "id"
+
+    # @!attribute [rw] cost_amount
+    #   @return [Float]
+    #     the value of meta attribute "cost:amount"
+    define_attribute "cost:amount", "float"
+
+    # @!attribute [rw] cost_driver
+    #   @return [String]
+    #     the value of meta attribute "cost:driver"
+    define_attribute "cost:driver", "string"
+
+    # @!attribute [rw] cost_type
+    #   @return [String]
+    #     the value of meta attribute "cost:type"
+    define_attribute "cost:type", "string"
+
+    # @return [String]
+    #   attribute type
+    attr_reader :type
+
+    # @return [String]
+    #   attribute name
+    attr_accessor :key
+
+    # @return [String]
+    #   attribute value
+    attr_accessor :value
+
+    # @return [Meta]
+    #   attribute meta attributes
+    attr_accessor :meta
+
+    # @param type [String]
+    #   attribute type
+    # @param key [String]
+    #   attribute name
+    # @param value [String]
+    #   attribute value
+    # @param meta [Array<Attribute>]
+    #   meta attributes
+    def initialize(type, key, value, meta=[])
+      @type = type
+      @key = key
+      @value = value
+      @meta = meta
+    end
+
+    # Return true if the element is formattable.
+    #
+    # @return [Boolean]
+    #   true if the element is formattable
+    def formattable?
+      not(@type.nil? or @key.nil? or @value.nil? or @meta.nil?)
+    end
+
+    # Format as a XML element.
+    def format
+      raise FormatError.new(self) unless formattable?
+
+      REXML::Element.new(type).tap do |attribute|
+        attribute.attributes["key"] = @key
+        attribute.attributes["value"] = format_value
+        meta.each {|m| attribute.elements << m.format if m.formattable?}
+      end
+    end
+
+    # @api private
+    def ==(other)
+      return false unless other.kind_of?(self.class)
+      @type == other.type and @key == other.key and @value == other.value and @meta == other.meta
+    end
+    alias :eql? :"=="
+
+    # @api private
+    def hash
+      @type.hash + @key.hash + @value.hash
+    end
+
+    private
+
+    # Format the value.
+    #
+    # @return [String]
+    def format_value
+      case @type
+      when "string"
+        @value
+      when "date"
+        @value.kind_of?(Time) ? @value.iso8601(3) : @value
+      when "int"
+        @value.kind_of?(Integer) ? @value : @value.to_i
+      when "float"
+        @value.kind_of?(Float) ? @value : @value.to_f
+      when "boolean"
+        @value
+      when "id"
+        @value
+      end.to_s
+    end
+  end
+
+  class << self
+    # Return string attribute object.
+    #
+    # @param key [String]
+    #   attribute name
+    # @param value [Object]
+    #   attribute value
+    # @param meta [Array<Attribute>]
+    #   meta attributes
+    # @return [Attribute]
+    #   string attribute
+    def string(key, value, meta=[])
+      Attribute.new("string", key, value, meta)
+    end
+
+    # Return date attribute object.
+    #
+    # @param key [String]
+    #   attribute name
+    # @param value [Object]
+    #   attribute value
+    # @param meta [Array<Attribute>]
+    #   meta attributes
+    # @return [Attribute]
+    #   date attribute
+    def date(key, value, meta=[])
+      Attribute.new("date", key, value, meta)
+    end
+
+    # Return int attribute object.
+    #
+    # @param key [String]
+    #   attribute name
+    # @param value [Object]
+    #   attribute value
+    # @param meta [Array<Attribute>]
+    #   meta attributes
+    # @return [Attribute]
+    #   int attribute
+    def int(key, value, meta=[])
+      Attribute.new("int", key, value, meta)
+    end
+
+    # Return float attribute object.
+    #
+    # @param key [String]
+    #   attribute name
+    # @param value [Object]
+    #   attribute value
+    # @param meta [Array<Attribute>]
+    #   meta attributes
+    # @return [Attribute]
+    #   float attribute
+    def float(key, value, meta=[])
+      Attribute.new("float", key, value, meta)
+    end
+
+    # Return boolean attribute object.
+    #
+    # @param key [String]
+    #   attribute name
+    # @param value [Object]
+    #   attribute value
+    # @param meta [Array<Attribute>]
+    #   meta attributes
+    # @return [Attribute]
+    #   boolean attribute
+    def boolean(key, value, meta=[])
+      Attribute.new("boolean", key, value, meta)
+    end
+
+    # Return id attribute object.
+    #
+    # @param key [String]
+    #   attribute name
+    # @param value [Object]
+    #   attribute value
+    # @param meta [Array<Attribute>]
+    #   meta attributes
+    # @return [Attribute]
+    #   id attribute
+    def id(key, value, meta=[])
+      Attribute.new("id", key, value, meta)
+    end
+  end
+end