mondrian-olap 0.1.0

data/lib/mondrian/olap/schema.rb

@@ -0,0 +1,158 @@
+require 'mondrian/olap/schema_element'
+
+module Mondrian
+  module OLAP
+    # See http://mondrian.pentaho.com/documentation/schema.php for more detailed description
+    # of Mondrian Schema elements.
+    class Schema < SchemaElement
+      def self.define(name = nil, attributes = {}, &block)
+        new(name || 'default', attributes, &block)
+      end
+
+      def define(name = nil, &block)
+        @attributes[:name] = name || 'default' # otherwise connection with empty name fails
+        instance_eval &block if block
+        self
+      end
+
+      attributes :description
+      elements :cube
+
+      class Cube < SchemaElement
+        attributes :description,
+          # The name of the measure that would be taken as the default measure of the cube.
+          :default_measure,
+          # Should the Fact table data for this Cube be cached by Mondrian or not.
+          # The default action is to cache the data.
+          :cache,
+          # Whether element is enabled - if true, then the Cube is realized otherwise it is ignored.
+          :enabled
+        elements :table, :dimension, :measure, :calculated_member
+      end
+
+      class Table < SchemaElement
+        attributes :schema, # Optional qualifier for table.
+          # Alias to be used with this table when it is used to form queries.
+          # If not specified, defaults to the table name, but in any case, must be unique within the schema.
+          # (You can use the same table in different hierarchies, but it must have different aliases.)
+          :alias
+        data_dictionary_names :name, :schema, :alias # values in XML will be uppercased when using Oracle driver
+      end
+
+      class Dimension < SchemaElement
+        attributes :description,
+          # The dimension's type may be one of "Standard" or "Time".
+          # A time dimension will allow the use of the MDX time functions (WTD, YTD, QTD, etc.).
+          # Use a standard dimension if the dimension is not a time-related dimension.
+          # The default value is "Standard".
+          :type,
+          # The name of the column in the fact table which joins to the leaf level of this dimension.
+          # Required in a private Dimension or a DimensionUsage, but not in a public Dimension.
+          :foreign_key
+        data_dictionary_names :foreign_key # values in XML will be uppercased when using Oracle driver
+        elements :hierarchy
+      end
+
+      class Hierarchy < SchemaElement
+        attributes :description,
+          # Whether this hierarchy has an 'all' member.
+          :has_all,
+          # Name of the 'all' member. If this attribute is not specified,
+          # the all member is named 'All hierarchyName', for example, 'All Store'.
+          :all_member_name,
+          # Name of the 'all' level. If this attribute is not specified,
+          # the all member is named '(All)'.
+          :all_level_name,
+          # The name of the column which identifies members, and which is referenced by rows in the fact table.
+          # If not specified, the key of the lowest level is used. See also Dimension foreign_key.
+          :primary_key,
+          # The name of the table which contains primary_key.
+          # If the hierarchy has only one table, defaults to that; it is required.
+          :primary_key_table,
+          # Should be set to the level (if such a level exists) at which depth it is known
+          # that all members have entirely unique rows, allowing SQL GROUP BY clauses to be completely eliminated from the query.
+          :unique_key_level_name
+        data_dictionary_names :primary_key, :primary_key_table # values in XML will be uppercased when using Oracle driver
+        elements :table, :join, :level
+      end
+
+      class Join < SchemaElement
+        attributes :left_key, :right_key
+        data_dictionary_names :left_key, :right_key # values in XML will be uppercased when using Oracle driver
+        elements :table
+      end
+
+      class Level < SchemaElement
+        attributes :description,
+          # The name of the table that the column comes from.
+          # If this hierarchy is based upon just one table, defaults to the name of that table;
+          # otherwise, it is required.
+          :table,
+          # The name of the column which holds the unique identifier of this level.
+          :column,
+          # The name of the column which holds the user identifier of this level.
+          :name_column,
+          # The name of the column which holds member ordinals.
+          # If this column is not specified, the key column is used for ordering.
+          :ordinal_column,
+          # The name of the column which references the parent member in a parent-child hierarchy.
+          :parent_column,
+          # Value which identifies null parents in a parent-child hierarchy.
+          # Typical values are 'NULL' and '0'.
+          :null_parent_value,
+          # Indicates the type of this level's key column:
+          # String, Numeric, Integer, Boolean, Date, Time or Timestamp.
+          # When generating SQL statements, Mondrian encloses values for String columns in quotation marks,
+          # but leaves values for Integer and Numeric columns un-quoted.
+          # Date, Time, and Timestamp values are quoted according to the SQL dialect.
+          # For a SQL-compliant dialect, the values appear prefixed by their typename, 
+          # for example, "DATE '2006-06-01'".
+          # Default value: 'String'
+          :type,
+          # Whether members are unique across all parents. 
+          # For example, zipcodes are unique across all states.
+          # The first level's members are always unique.
+          # Default value: false
+          :unique_members,
+          # Whether this is a regular or a time-related level.
+          # The value makes a difference to time-related functions such as YTD (year-to-date).
+          # Default value: 'Regular'
+          :level_type,
+          # Condition which determines whether a member of this level is hidden.
+          # If a hierarchy has one or more levels with hidden members,
+          # then it is possible that not all leaf members are the same distance from the root,
+          # and it is termed a ragged hierarchy.
+          # Allowable values are: Never (a member always appears; the default);
+          # IfBlankName (a member doesn't appear if its name is null, empty or all whitespace);
+          # and IfParentsName (a member appears unless its name matches the parent's.
+          # Default value: 'Never'
+          :hide_member_if
+        data_dictionary_names :table, :column, :name_column, :ordinal_column, :parent_column # values in XML will be uppercased when using Oracle driver
+      end
+
+      class Measure < SchemaElement
+        attributes :description,
+          # Column which is source of this measure's values.
+          # If not specified, a measure expression must be specified.
+          :column,
+          # The datatype of this measure: String, Numeric, Integer, Boolean, Date, Time or Timestamp.
+          # The default datatype of a measure is 'Integer' if the measure's aggregator is 'Count', otherwise it is 'Numeric'.
+          :datatype,
+          # Aggregation function. Allowed values are "sum", "count", "min", "max", "avg", and "distinct-count".
+          :aggregator,
+          # Format string with which to format cells of this measure. For more details, see the mondrian.util.Format class.
+          :format_string
+        data_dictionary_names :column # values in XML will be uppercased when using Oracle driver
+      end
+
+      class CalculatedMember < SchemaElement
+        attributes :description,
+          # MDX expression which gives the value of this member. Equivalent to the Formula sub-element.
+          :formula,
+          # Name of the dimension which this member belongs to.
+          :dimension
+      end
+
+    end
+  end
+end

data/lib/mondrian/olap/schema_element.rb

@@ -0,0 +1,123 @@
+require 'nokogiri'
+
+module Mondrian
+  module OLAP
+    class SchemaElement
+      def initialize(name = nil, attributes = {}, &block)
+        # if just attributes hash provided
+        if name.is_a?(Hash) && attributes == {}
+          attributes = name
+          name = nil
+        end
+        @attributes = {}
+        @attributes[:name] = name if name
+        @attributes.merge!(attributes)
+        self.class.elements.each do |element|
+          instance_variable_set("@#{pluralize(element)}", [])
+        end
+        instance_eval &block if block
+      end
+
+      def self.attributes(*names)
+        names.each do |name|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}(*args)
+              if args.empty?
+                @attributes[:#{name}]
+              elsif args.size == 1
+                @attributes[:#{name}] = args[0]
+              else
+                raise ArgumentError, "too many arguments"
+              end
+            end
+          RUBY
+        end
+      end
+
+      def self.data_dictionary_names(*names)
+        return @data_dictionary_names || [] if names.empty?
+        @data_dictionary_names ||= []
+        @data_dictionary_names.concat(names)
+      end
+
+      def self.elements(*names)
+        return @elements || [] if names.empty?
+
+        @elements ||= []
+        @elements.concat(names)
+
+        names.each do |name|
+          attr_reader pluralize(name).to_sym
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}(name=nil, attributes = {}, &block)
+              @#{pluralize(name)} << Schema::#{camel_case(name)}.new(name, attributes, &block)
+            end
+          RUBY
+        end
+      end
+
+      def to_xml(options={})
+        Nokogiri::XML::Builder.new do |xml|
+          add_to_xml(xml, options)
+        end.to_xml
+      end
+
+      protected
+
+      def add_to_xml(xml, options)
+        xml.send(tag_name(self.class.name), xmlized_attributes(options)) do
+          self.class.elements.each do |element|
+            instance_variable_get("@#{pluralize(element)}").each {|item| item.add_to_xml(xml, options)}
+          end
+        end
+      end
+
+      private
+
+      def xmlized_attributes(options)
+        # data dictionary values should be in uppercase when using Oracle driver
+        upcase_attributes = if options[:driver] == 'oracle'
+          self.class.data_dictionary_names
+        else
+          []
+        end
+        hash = {}
+        @attributes.each do |attr, value|
+          value = value.upcase if upcase_attributes.include?(attr)
+          hash[
+            # camelcase attribute name
+            attr.to_s.gsub(/_([^_]+)/){|m| $1.capitalize}
+          ] = value
+        end
+        hash
+      end
+
+      def self.pluralize(string)
+        string = string.to_s
+        case string
+        when /^(.*)y$/
+          "#{$1}ies"
+        else
+          "#{string}s"
+        end
+      end
+
+      def pluralize(string)
+        self.class.pluralize(string)
+      end
+
+      def self.camel_case(string)
+        string.to_s.split('_').map{|s| s.capitalize}.join('')
+      end
+
+      def camel_case(string)
+        self.class.camel_case(string)
+      end
+
+      def tag_name(string)
+        string.split('::').last << '_'
+      end
+    end
+
+  end
+end

data/mondrian-olap.gemspec

@@ -0,0 +1,116 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mondrian-olap}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Raimonds Simanovskis"]
+  s.date = %q{2011-03-19}
+  s.description = %q{JRuby gem for performing multidimensional queries of relational database data using Mondrian OLAP Java library
+}
+  s.email = %q{raimonds.simanovskis@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE-Mondrian.html",
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".rspec",
+    "Gemfile",
+    "LICENSE-Mondrian.html",
+    "LICENSE.txt",
+    "README.rdoc",
+    "RUNNING_TESTS.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/mondrian-olap.rb",
+    "lib/mondrian/jars/commons-collections-3.1.jar",
+    "lib/mondrian/jars/commons-dbcp-1.2.1.jar",
+    "lib/mondrian/jars/commons-logging-1.0.4.jar",
+    "lib/mondrian/jars/commons-math-1.0.jar",
+    "lib/mondrian/jars/commons-pool-1.2.jar",
+    "lib/mondrian/jars/commons-vfs-1.0.jar",
+    "lib/mondrian/jars/eigenbase-properties.jar",
+    "lib/mondrian/jars/eigenbase-resgen.jar",
+    "lib/mondrian/jars/eigenbase-xom.jar",
+    "lib/mondrian/jars/javacup.jar",
+    "lib/mondrian/jars/log4j-1.2.8.jar",
+    "lib/mondrian/jars/log4j.properties",
+    "lib/mondrian/jars/mondrian.jar",
+    "lib/mondrian/jars/olap4j.jar",
+    "lib/mondrian/olap.rb",
+    "lib/mondrian/olap/connection.rb",
+    "lib/mondrian/olap/cube.rb",
+    "lib/mondrian/olap/query.rb",
+    "lib/mondrian/olap/result.rb",
+    "lib/mondrian/olap/schema.rb",
+    "lib/mondrian/olap/schema_element.rb",
+    "mondrian-olap.gemspec",
+    "spec/connection_spec.rb",
+    "spec/cube_spec.rb",
+    "spec/fixtures/MondrianTest.xml",
+    "spec/fixtures/MondrianTestOracle.xml",
+    "spec/query_spec.rb",
+    "spec/rake_tasks.rb",
+    "spec/schema_definition_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/matchers/be_like.rb"
+  ]
+  s.homepage = %q{http://github.com/rsim/mondrian-olap}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.1}
+  s.summary = %q{JRuby API for Mondrian OLAP Java library}
+  s.test_files = [
+    "spec/connection_spec.rb",
+    "spec/cube_spec.rb",
+    "spec/query_spec.rb",
+    "spec/rake_tasks.rb",
+    "spec/schema_definition_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/matchers/be_like.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.5.0.beta.4"])
+      s.add_development_dependency(%q<jruby-openssl>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.5"])
+      s.add_development_dependency(%q<autotest>, [">= 0"])
+      s.add_development_dependency(%q<jdbc-mysql>, [">= 0"])
+      s.add_development_dependency(%q<jdbc-postgres>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, ["~> 3.0.5"])
+      s.add_development_dependency(%q<activerecord-jdbc-adapter>, [">= 0"])
+      s.add_development_dependency(%q<activerecord-oracle_enhanced-adapter>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, ["~> 1.5.0.beta.4"])
+      s.add_dependency(%q<jruby-openssl>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rspec>, ["~> 2.5"])
+      s.add_dependency(%q<autotest>, [">= 0"])
+      s.add_dependency(%q<jdbc-mysql>, [">= 0"])
+      s.add_dependency(%q<jdbc-postgres>, [">= 0"])
+      s.add_dependency(%q<activerecord>, ["~> 3.0.5"])
+      s.add_dependency(%q<activerecord-jdbc-adapter>, [">= 0"])
+      s.add_dependency(%q<activerecord-oracle_enhanced-adapter>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, ["~> 1.5.0.beta.4"])
+    s.add_dependency(%q<jruby-openssl>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rspec>, ["~> 2.5"])
+    s.add_dependency(%q<autotest>, [">= 0"])
+    s.add_dependency(%q<jdbc-mysql>, [">= 0"])
+    s.add_dependency(%q<jdbc-postgres>, [">= 0"])
+    s.add_dependency(%q<activerecord>, ["~> 3.0.5"])
+    s.add_dependency(%q<activerecord-jdbc-adapter>, [">= 0"])
+    s.add_dependency(%q<activerecord-oracle_enhanced-adapter>, [">= 0"])
+  end
+end
+

data/spec/connection_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe "Connection" do
+
+  describe "create" do
+    before(:each) do
+      @olap = Mondrian::OLAP::Connection.new(CONNECTION_PARAMS_WITH_CATALOG)
+    end
+
+    it "should not be connected before connection" do
+      @olap.should_not be_connected
+    end
+
+    it "should be successful" do
+      @olap.connect.should be_true
+    end
+
+  end
+
+  describe "create with catalog content" do
+    before(:all) do
+      @schema_xml = File.read(CATALOG_FILE)
+    end
+    it "should be successful" do
+      @olap = Mondrian::OLAP::Connection.new(CONNECTION_PARAMS.merge(
+        :catalog_content => @schema_xml
+      ))
+      @olap.connect.should be_true
+    end
+
+  end
+
+  describe "properties" do
+    before(:all) do
+      @olap = Mondrian::OLAP::Connection.create(CONNECTION_PARAMS_WITH_CATALOG)
+    end
+
+    it "should be connected" do
+      @olap.should be_connected
+    end
+
+  end
+
+  describe "close" do
+    before(:all) do
+      @olap = Mondrian::OLAP::Connection.create(CONNECTION_PARAMS_WITH_CATALOG)
+    end
+
+    it "should not be connected after close" do
+      @olap.close
+      @olap.should_not be_connected
+    end
+
+  end
+
+end