olap4r 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "jruby-openssl"
+  gem "rspec", "~> 2.11.0"
+  gem "yard", "~> 0.8.2.1"
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "olap4r-mondrian", "~>0.1.0"
+  gem "olap4r-xmla", "~>0.1.0"
+end

data/Gemfile.lock

@@ -0,0 +1,40 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bouncy-castle-java (1.5.0146.1)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    jruby-openssl (0.7.7)
+      bouncy-castle-java (>= 1.5.0146.1)
+    json (1.7.3-java)
+    olap4r-mondrian (0.1.0)
+    olap4r-xmla (0.1.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.0)
+    yard (0.8.2.1)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  bundler (~> 1.1.0)
+  jeweler (~> 1.8.4)
+  jruby-openssl
+  olap4r-mondrian (~> 0.1.0)
+  olap4r-xmla (~> 0.1.0)
+  rspec (~> 2.11.0)
+  yard (~> 0.8.2.1)

data/README.md

@@ -0,0 +1,69 @@
+# olap4r
+
+## Examples
+
+Create connection:
+
+    connection = Olap::Connection.new "jdbc:mondrian:JdbcDrivers=com.mysql.jdbc.Driver;Jdbc=jdbc:mysql://localhost/mondrian_foodmart?user=root;Catalog=file:spec/fixtures/FoodMart.xml;"
+
+Execute queries:
+
+    results = connection.execute "SELECT [Measures].[Unit Sales] ON COLUMNS, [Store] ON ROWS FROM [Sales]"
+    puts results
+    # => [["266,773"]]
+
+Build a query:
+
+    query_builder.select(:columns, "[Store].[All Stores]", "[Store].[All Stores].CHILDREN").
+      select(:rows, "[Measures].[Unit Sales]", "[Measures].[Sales Count]").
+      from("[Sales]").
+      where("[Store Type].[All Store Types].[Supermarket]")
+    query_builder.to_s.should == "SELECT HIERARCHIZE(UNION([Store].[All Stores], [Store].[All Stores].CHILDREN)) ON COLUMNS, { [Measures].[Unit Sales], [Measures].[Sales Count] } ON ROWS FROM [Sales] WHERE ( [Store Type].[All Store Types].[Supermarket] )"
+
+## Releasing new version
+
+Install required development toolset:
+
+    bundle install
+
+Write tests, write code. If you're ready to release a new version __first__ commit your changes, then run:
+
+    rake version:bump:patch
+
+To pull new gem into application switch to the same exact Ruby and gemset that you're using in your application, ie. if you're using `rvm jruby@myapp` for your app then use it to install this gem too.
+
+    bundle install
+    rake install
+
+Switch to your application and run:
+
+    bundle update olap4r
+
+## Testing
+
+Configure ``spec/config.yml`` using your JDBC / XML/A details (you'll find example in ``spec/config.yml.example``):
+
+    mondrian:
+      jdbc_driver_path: "/usr/local/Cellar/tomcat/7.0.6//libexec/common/endorsed/mysql-connector-java-5.1.15-bin"
+      connection_string: "jdbc:mondrian:JdbcDrivers=com.mysql.jdbc.Driver;Jdbc=jdbc:mysql://localhost/mondrian_foodmart?user=root;Catalog=file:spec/fixtures/FoodMart.xml;"
+
+    xmla:
+      connection_string: "jdbc:xmla:Server=http://127.0.0.1:8080/mondrian/xmla;Catalog=FoodMart;"
+
+``jdbc_driver_path`` is a path to the JAR file which you need as specified in the ``mondrian`` ``connection_string``.
+
+## Copyright
+
+Copyright 2011-2012 Freeport Metrics Inc.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "olap4r"
+  gem.homepage = "http://github.com/Freeport-Metrics/olap4r"
+  gem.license = "MIT"
+  gem.summary = %Q{olap4j wrapper for JRuby}
+  gem.description = %Q{olap4j wrapper for JRuby}
+  gem.email = "filip@tepper.pl"
+  gem.authors = ["Filip Tepper"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/olap4r.rb

@@ -0,0 +1,17 @@
+require "java"
+require "olap4j"
+
+java_import "java.sql.Connection"
+java_import "java.sql.DriverManager"
+java_import "org.olap4j.metadata.Property"
+java_import "org.olap4j.OlapConnection"
+java_import "org.olap4j.OlapDatabaseMetaData"
+java_import "org.olap4j.transform.StandardTransformLibrary"
+
+module Olap #:nodoc:
+end
+
+require "olap4r/connection"
+require "olap4r/cellset"
+require "olap4r/rowset"
+require "olap4r/query_builder"

data/lib/olap4r/cellset.rb

@@ -0,0 +1,59 @@
+module Olap
+  class CellSet
+    def initialize(cellset) # :nodoc:
+      @cellset = cellset
+    end
+
+    # Returns list of axes
+    #
+    def axes
+      @axes ||= @cellset.get_axes.map do |axis|
+        {
+          :axis => axis.get_axis_ordinal.to_s.downcase.to_sym,
+          :values => axis.get_positions.map do |position|
+            position.get_members.inject [] do |members, member|
+              members << {
+                :name => member.get_caption,
+                :unique_name => member.get_unique_name,
+                :drillable => member.get_child_members.size > 0
+              }
+            end
+          end
+        }
+      end
+    end
+
+    # Returns query values
+    #
+    # ==== Attributes
+    #
+    # * +value_type+ - Returned value type (:value or :formatted_value)
+    #
+    def values(value_type = :formatted_value)
+      return @values unless @values.nil?
+
+      @values = []
+
+      raise "olap4r doesn't support queries with more than 2 dimensions" if @cellset.get_axes.size > 2
+
+      columns = @cellset.get_axes[0].get_positions.size - 1
+      rows    = @cellset.get_axes[1].get_positions.size - 1
+
+      cells = []
+
+      (0..columns).each do |i|
+        (0..rows).each do |j|
+          cells << [i, j]
+        end
+      end
+
+      cells.each do |cell|
+        @values[cell[1]] = [] if @values[cell[1]].nil?
+        @values[cell[1]][cell[0]] = @cellset.get_cell(cell.map { |coord| coord.to_java(:int) }).send :"get_#{value_type}"
+        @values[cell[1]][cell[0]] = "0" if @values[cell[1]][cell[0]].respond_to?(:empty?) && @values[cell[1]][cell[0]].empty?
+      end
+
+      @values
+    end
+  end
+end

data/lib/olap4r/connection.rb

@@ -0,0 +1,161 @@
+Java::JavaClass.for_name "org.olap4j.mdx.IdentifierNode"
+
+module Olap #:nodoc:
+  class InvalidConnectionStringException < Exception; end
+  class InvalidOlapDriverException < Exception; end
+
+  class Connection
+
+    # Returns new OLAP connection.
+    #
+    # ==== Attributes
+    #
+    # * +connection_string+ - OLAP connection string.
+    #
+    # ==== Examples
+    #
+    # To create new connection provide a JDBC connection string:
+    #
+    #    @olap = Olap::Connection.new "jdbc:mondrian:JdbcDrivers=com.mysql.jdbc.Driver;Jdbc=jdbc:mysql://127.0.0.1/olap?user=olap&password=olap;Catalog=file:/home/olap/schemas/Olap.xml;"
+    #
+    def initialize(connection_string)
+      begin
+        driver = connection_string.match(/\Ajdbc\:([A-Za-z]+)\:/)[1]
+      rescue NoMethodError
+        raise Olap::InvalidConnectionStringException.new
+      end
+
+      begin
+        raise
+        @connection = DriverManager.get_connection connection_string
+      rescue
+        begin
+          driver_class = Olap.const_get("#{driver.capitalize}")
+          driver = driver_class.jdbc_driver
+          properties = java.util.Properties.new
+          @connection = driver_initialize(driver).connect(connection_string, properties)
+        rescue NameError => e
+          raise Olap::InvalidOlapDriverException.new
+        end
+      end
+    end
+
+    # Executes regular MDX query.
+    #
+    # ==== Attributes
+    #
+    # * +query+ - MDX Query.
+    #
+    def execute(query)
+      CellSet.new @connection.create_statement.execute_olap_query(query.to_s)
+    end
+
+    # Executes drillthrough MDX query.
+    #
+    # ==== Attributes
+    #
+    # * +query+ - MDX Query.
+    #
+    def drillthrough(query)
+      RowSet.new @connection.create_statement.execute_query(query.to_s)
+    end
+
+    # Returns list of all cubes.
+    #
+    def cubes
+      @cubes ||= @connection.get_olap_schema.get_cubes.map do |cube|
+        {
+          :unique_name => cube.get_unique_name,
+          :name => cube.get_caption
+        }
+      end
+    end
+
+    # Returns list of all measures for cube.
+    #
+    # ==== Attributes
+    #
+    # * +cube_unique_name+ - Cube name
+    #
+    def measures(cube_unique_name)
+      @measures = {} if @measures.nil?
+
+      @measures[cube_unique_name] ||= cube(cube_unique_name).get_measures.map do |measure|
+        {
+          :unique_name => measure.get_unique_name,
+          :name => measure.get_caption
+        }
+      end
+    end
+
+    # Returns list of all dimensions for cube.
+    #
+    # ==== Attributes
+    #
+    # * +cube_unique_name+ - Cube name
+    #
+    def dimensions(cube_unique_name)
+      @dimensions = {} if @dimensions.nil?
+
+      @dimensions[cube_unique_name] ||= cube(cube_unique_name).get_dimensions.map do |dimension|
+        {
+          :unique_name => dimension.get_unique_name,
+          :name => dimension.get_caption,
+          :children => true,
+          :type => dimension.get_dimension_type.to_s.downcase.to_sym
+        }
+      end
+    end
+
+    # Returns list of member children
+    #
+    # ==== Attributes
+    #
+    # * +cube_unique_name+ - Cube name
+    # * +member+ - Root member element
+    # * +recursive+ - Recursive lookup
+    #
+    def children_lookup(cube_unique_name, member = nil, recursive = false)
+      return dimensions cube_unique_name if member.nil?
+
+      if member.split(".").length == 1
+        cube(cube_unique_name).get_dimensions.reject { |dimension| dimension.get_unique_name != member }.first.get_hierarchies.map { |hierarchy| hierarchy.get_root_members.map { |member| dimension(member, recursive)} }.flatten
+      else
+        children cube(cube_unique_name).send(:lookup_member, Java::OrgOlap4jMdx::IdentifierNode.parse_identifier(member).get_segment_list()), recursive
+      end
+    end
+
+
+    private
+
+
+    def driver_initialize(klass)
+      constructor = klass.java_class.declared_constructor
+      constructor.accessible = true
+
+      begin
+        return constructor.new_instance.to_java
+      rescue TypeError
+        false
+      end
+    end
+
+    def cube(cube_unique_name)
+      @connection.get_olap_schema.get_cubes.reject { |cube| cube.get_unique_name != cube_unique_name }.first
+    end
+
+    def dimension(member, recursive = false)
+      {
+        :unique_name => member.get_unique_name,
+        :name => member.get_property_value(Java::org::olap4j::metadata::Property::StandardMemberProperty::MEMBER_CAPTION),
+        :children => recursive ? children(member, recursive) : member.get_child_member_count > 0
+      }
+    end
+
+    def children(member, recursive = false)
+      member.get_child_members.inject([]) do |children, root_member|
+        children << dimension(root_member, recursive)
+      end
+    end
+  end
+end

data/lib/olap4r/query_builder.rb

@@ -0,0 +1,131 @@
+module Olap
+  class QueryBuilder
+    def initialize
+      @select = { :columns => [], :rows => [] }
+      @from = nil
+      @conditions = []
+    end
+
+    def select axis, *fields
+      fields.flatten.each { |field| @select[axis] << field_as_string(field) }
+      self
+    end
+
+    def from cube
+      @from = cube
+      self
+    end
+
+    def where *conditions
+      conditions.flatten.each { |condition| @conditions << condition }
+      self
+    end
+
+    def to_s
+      build_query
+    end
+
+
+    private
+
+
+    def field_as_string field
+      if field.is_a?(Hash)
+        field_with_properties field[:id], field[:properties].map { |property| property.downcase.to_sym }
+      else
+        field
+      end
+    end
+
+    def field_with_properties field, properties
+      if properties.include?(:children)
+        field = "#{field}.CHILDREN"
+      end
+
+      if properties.include?(:drilldownlevel) && level(field) > 1
+        field = "DRILLDOWNLEVEL(#{field})"
+      end
+
+      field
+    end
+
+    def build_axis axis
+      return nil if @select[axis].empty?
+
+      hierarchies = {}
+      @select[axis].each do |field|
+        hierarchy = field.match(/\[([^\]]+)\]/)[0]
+
+        hierarchies[hierarchy] = [] if hierarchies[hierarchy].nil?
+        hierarchies[hierarchy].push field
+      end
+
+      if hierarchies.keys.length == 1
+        if hierarchies.keys[0] == "[Measures]" || @select[axis].length == 1
+          "{ #{@select[axis].join ", "} }"
+        else
+          "HIERARCHIZE(#{build_union @select[axis]})"
+        end
+      else
+        "HIERARCHIZE(#{build_crossjoin hierarchies.map { |hierarchy, fields| build_union(fields) }})"
+      end
+    end
+
+    def build_field field
+      # Case for dimensions - dimensions need to be wrapped as sets
+      if field.split(".").length == 1
+        "{ #{field} }"
+      else
+        field
+      end
+    end
+
+    def build_union fields
+      return "{ #{fields.join(", ")} }" if fields.length == 1
+
+      unionized = "UNION(#{build_field fields[0]}, #{build_field fields[1]})"
+
+      2.upto(fields.length - 1) do |i|
+        unionized = "UNION(#{unionized}, #{build_field fields[i]})"
+      end
+
+      unionized
+    end
+
+    def build_crossjoin hierarchy
+      crossjoined = "CROSSJOIN(#{hierarchy[0]}, #{hierarchy[1]})"
+
+      2.upto(hierarchy.length - 1) do |i|
+        crossjoined = "CROSSJOIN(#{crossjoined}, #{hierarchy[i]})"
+      end
+
+      crossjoined
+    end
+
+    def build_query
+      query = []
+
+      columns = build_axis :columns
+      rows = build_axis :rows
+
+      unless rows.nil? && columns.nil?
+        query << "SELECT"
+
+        fields = []
+        fields << "#{columns} ON COLUMNS" unless columns.nil?
+        fields << "#{rows} ON ROWS" unless rows.nil?
+
+        query << fields.join(", ")
+      end
+
+      query << "FROM #{@from}" unless @from.nil?
+      query << "WHERE ( #{@conditions.join ", "} )" if @conditions.any?
+
+      query.join " "
+    end
+
+    def level field
+      field.scan(/\[([^\]]*)\]/).length
+    end
+  end
+end