mondrian-olap 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a82185c2c1e818166ad00f6a79629772eda89fd6
-  data.tar.gz: 48189b91d855f7dc3df6842d91360068285be951
+  metadata.gz: 33377438a5e2533d61b3304824a4e0aefe545f68
+  data.tar.gz: 13ef2ecd466795a07f43252231e4e7ad586c1e45
 SHA512:
-  metadata.gz: d11c3fb9718d6a81be7f534c1b96a6cf731b64019a947a01bbfb58e3a2d52453bd334c5f083ef05981093657f66b3b4572f64748ae0aa4382f4c6a03c445aa9f
-  data.tar.gz: 5f588afd736a0e8c62f05b5a9d56aa75fe181e46373d4025d85522532b8371a3fb439e3d000339ed70ad61d0f8c99ce37e17b9ddc693cfe44a4884ff557c375f
+  metadata.gz: c0ac6bc10f6ed6b4725d0991131402735e50c9c4cbc3de016a8714c7ceca5ce420ce9b5090fe006ae5495f0e8add0cf4f4cbb773b2f3da35767481e60b04a7d4
+  data.tar.gz: b7a47e4872dd58434b05e8d07b99d06d73d1ef023be953b4be00a5de2bd6c18db6e943496cecf1b3cad0fab60a5e3850b1084b7e31896533df3d1e6f2112d03c

data/Changelog.md

@@ -1,3 +1,18 @@
+### 0.6.0 / 2014-11-10
+
+* New features
+  * upgraded to latest Mondrian 3.8.0 version
+  * connection with generic JDBC driver using jdbc_driver and jdbc_url parameters
+  * added hierarchy and parent attributes for calculated member schema definition element
+  * added visible attribute for cube, dimension, virtual_cube_dimension, hierarchy and level schema definition elements
+  * added query builder generate method
+  * added schema parameters and query execution with parameters
+  * updated specs to pass on Java 8
+* Improvements
+  * set defaultRowPrefetch property for Oracle connection
+* Bug fixes
+  * fixed result drill_through method with just all members selection
+
 ### 0.5.0 / 2013-11-29
 
 * New features

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2010-2013 Raimonds Simanovskis
+Copyright (c) 2010-2014 Raimonds Simanovskis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -12,7 +12,7 @@ One of the most popular open-source OLAP engines is [Mondrian](http://mondrian.p
 
 mondrian-olap is JRuby gem which includes Mondrian OLAP engine and provides Ruby DSL for creating OLAP schemas on top of relational database schemas and provides MDX query language and query builder Ruby methods for making analytical queries.
 
-mondrian-olap is used in [eazyBI data analysis and reporting web application](https://eazybi.com). [eazyBI remote setup](https://eazybi.com/help/remote-setup) can be used to create easy-to-use web based reports and dashboards on top of mondrian-olap based backend database. There is also [mondrian-olap demo Rails application for trying MDX queries](https://github.com/rsim/mondrian_demo).
+mondrian-olap is used in [eazyBI data analysis and reporting web application](https://eazybi.com). [Private eazyBI](https://eazybi.com/help/private-eazybi) can be used to create easy-to-use web based reports and dashboards on top of mondrian-olap based backend database. There is also [mondrian-olap demo Rails application for trying MDX queries](https://github.com/rsim/mondrian_demo).
 
 USAGE
 -----
@@ -56,42 +56,42 @@ require "mondrian-olap"
 schema = Mondrian::OLAP::Schema.define do
   cube 'Sales' do
     table 'sales'
-    dimension 'Customers', :foreign_key => 'customer_id' do
-      hierarchy :has_all => true, :all_member_name => 'All Customers', :primary_key => 'id' do
+    dimension 'Customers', foreign_key: 'customer_id' do
+      hierarchy has_all: true, all_member_name: 'All Customers', primary_key: 'id' do
         table 'customers'
-        level 'Country', :column => 'country', :unique_members => true
-        level 'State Province', :column => 'state_province', :unique_members => true
-        level 'City', :column => 'city', :unique_members => false
-        level 'Name', :column => 'fullname', :unique_members => true
+        level 'Country', column: 'country', unique_members: true
+        level 'State Province', column: 'state_province', unique_members: true
+        level 'City', column: 'city', unique_members: false
+        level 'Name', column: 'fullname', unique_members: true
       end
     end
-    dimension 'Products', :foreign_key => 'product_id' do
-      hierarchy :has_all => true, :all_member_name => 'All Products',
-                :primary_key => 'id', :primary_key_table => 'products' do
-        join :left_key => 'product_class_id', :right_key => 'id' do
+    dimension 'Products', foreign_key: 'product_id' do
+      hierarchy has_all: true, all_member_name: 'All Products',
+                primary_key: 'id', primary_key_table: 'products' do
+        join left_key: 'product_class_id', right_key: 'id' do
           table 'products'
           table 'product_classes'
         end
-        level 'Product Family', :table => 'product_classes', :column => 'product_family', :unique_members => true
-        level 'Brand Name', :table => 'products', :column => 'brand_name', :unique_members => false
-        level 'Product Name', :table => 'products', :column => 'product_name', :unique_members => true
+        level 'Product Family', table: 'product_classes', column: 'product_family', unique_members: true
+        level 'Brand Name', table: 'products', column: 'brand_name', unique_members: false
+        level 'Product Name', table: 'products', column: 'product_name', unique_members: true
       end
     end
-    dimension 'Time', :foreign_key => 'time_id', :type => 'TimeDimension' do
-      hierarchy :has_all => false, :primary_key => 'id' do
+    dimension 'Time', foreign_key: 'time_id', type: 'TimeDimension' do
+      hierarchy has_all: false, primary_key: 'id' do
         table 'time'
-        level 'Year', :column => 'the_year', :type => 'Numeric', :unique_members => true, :level_type => 'TimeYears'
-        level 'Quarter', :column => 'quarter', :unique_members => false, :level_type => 'TimeQuarters'
-        level 'Month', :column => 'month_of_year', :type => 'Numeric', :unique_members => false, :level_type => 'TimeMonths'
+        level 'Year', column: 'the_year', type: 'Numeric', unique_members: true, level_type: 'TimeYears'
+        level 'Quarter', column: 'quarter', unique_members: false, level_type: 'TimeQuarters'
+        level 'Month', column: 'month_of_year', type: 'Numeric', unique_members: false, level_type: 'TimeMonths'
       end
-      hierarchy 'Weekly', :has_all => false, :primary_key => 'id' do
+      hierarchy 'Weekly', has_all: false, primary_key: 'id' do
         table 'time'
-        level 'Year', :column => 'the_year', :type => 'Numeric', :unique_members => true, :level_type => 'TimeYears'
-        level 'Week', :column => 'week_of_year', :type => 'Numeric', :unique_members => false, :level_type => 'TimeWeeks'
+        level 'Year', column: 'the_year', type: 'Numeric', unique_members: true, level_type: 'TimeYears'
+        level 'Week', column: 'week_of_year', type: 'Numeric', unique_members: false, level_type: 'TimeWeeks'
       end
     end
-    measure 'Unit Sales', :column => 'unit_sales', :aggregator => 'sum'
-    measure 'Store Sales', :column => 'store_sales', :aggregator => 'sum'
+    measure 'Unit Sales', column: 'unit_sales', aggregator: 'sum'
+    measure 'Store Sales', column: 'store_sales', aggregator: 'sum'
   end
 end
 ```
@@ -104,12 +104,12 @@ When schema is defined it is necessary to establish OLAP connection to database.
 require "jdbc/mysql"
 
 olap = Mondrian::OLAP::Connection.create(
-  :driver => 'mysql',
-  :host => 'localhost,
-  :database => 'mondrian_test',
-  :username => 'mondrian_user',
-  :password => 'secret',
-  :schema => schema
+  driver: 'mysql',
+  host: 'localhost,
+  database: 'mondrian_test',
+  username: 'mondrian_user',
+  password: 'secret',
+  schema: schema
 )
 ```
 
@@ -171,7 +171,7 @@ Here is example of more complex query "Get sales amount and profit % of top 50 p
 olap.from('Sales').
 with_member('[Measures].[ProfitPct]').
   as('Val((Measures.[Store Sales] - Measures.[Store Cost]) / Measures.[Store Sales])',
-  :format_string => 'Percent').
+  format_string: 'Percent').
 columns('[Measures].[Store Sales]', '[Measures].[ProfitPct]').
 rows('[Products].children').crossjoin('[Customers].[Canada]', '[Customers].[USA]').
   top_count(50, '[Measures].[Store Sales]').
@@ -251,13 +251,13 @@ subset of measures and dimension members. Here is example of data access role de
 schema = Mondrian::OLAP::Schema.define do
   # ... cube definitions ...
   role 'California manager' do
-    schema_grant :access => 'none' do
-      cube_grant :cube => 'Sales', :access => 'all' do
-        dimension_grant :dimension => '[Measures]', :access => 'all'
-        hierarchy_grant :hierarchy => '[Customers]', :access => 'custom',
-                        :top_level => '[Customers].[State Province]', :bottom_level => '[Customers].[City]' do
-          member_grant :member => '[Customers].[USA].[CA]', :access => 'all'
-          member_grant :member => '[Customers].[USA].[CA].[Los Angeles]', :access => 'none'
+    schema_grant access: 'none' do
+      cube_grant cube: 'Sales', access: 'all' do
+        dimension_grant dimension: '[Measures]', access: 'all'
+        hierarchy_grant hierarchy: '[Customers]', access: 'custom',
+                        top_level: '[Customers].[State Province]', bottom_level: '[Customers].[City]' do
+          member_grant member: '[Customers].[USA].[CA]', access: 'all'
+          member_grant member: '[Customers].[USA].[CA].[Los Angeles]', access: 'none'
         end
       end
     end
@@ -270,9 +270,9 @@ See more examples of data access roles in `spec/connection_role_spec.rb`.
 REQUIREMENTS
 ------------
 
-mondrian-olap gem is compatible with JRuby versions 1.6 and 1.7 and Java 6 and 7 VM. mondrian-olap works only with JRuby and not with other Ruby implementations as it includes Mondrian OLAP Java libraries.
+mondrian-olap gem is compatible with JRuby version 1.7 and Java 6, 7 or 8 VM. mondrian-olap works only with JRuby and not with other Ruby implementations as it includes Mondrian OLAP Java libraries.
 
-mondrian-olap currently supports MySQL, PostgreSQL, Oracle, LucidDB and Microsoft SQL Server databases. When using MySQL, PostgreSQL or LucidDB databases then install jdbc-mysql, jdbc-postgres or jdbc-luciddb gem and require "jdbc/mysql", "jdbc/postgres" or "jdbc/luciddb" to load the corresponding JDBC database driver. When using Oracle then include Oracle JDBC driver (`ojdbc6.jar` for Java 6) in `CLASSPATH` or copy to `JRUBY_HOME/lib` or require it in application manually. When using SQL Server you can choose between the jTDS or Microsoft JDBC drivers. If you use jTDS require "jdbc/jtds". If you use the Microsoft JDBC driver include `sqljdbc.jar` or `sqljdbc4.jar` in `CLASSPATH` or copy to `JRUBY_HOME/lib` or require it in application manually.
+mondrian-olap supports MySQL, PostgreSQL, Oracle, LucidDB and Microsoft SQL Server databases as well as other databases that are supported by Mondrian OLAP engine (using jdbc_driver and jdbc_url connection parameters). When using MySQL, PostgreSQL or LucidDB databases then install jdbc-mysql, jdbc-postgres or jdbc-luciddb gem and require "jdbc/mysql", "jdbc/postgres" or "jdbc/luciddb" to load the corresponding JDBC database driver. When using Oracle then include Oracle JDBC driver (`ojdbc6.jar` for Java 6) in `CLASSPATH` or copy to `JRUBY_HOME/lib` or require it in application manually. When using SQL Server you can choose between the jTDS or Microsoft JDBC drivers. If you use jTDS require "jdbc/jtds". If you use the Microsoft JDBC driver include `sqljdbc.jar` or `sqljdbc4.jar` in `CLASSPATH` or copy to `JRUBY_HOME/lib` or require it in application manually.
 
 INSTALL
 -------

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/mondrian/olap/connection.rb

@@ -7,7 +7,7 @@ module Mondrian
         connection
       end
 
-      attr_reader :raw_connection, :raw_catalog, :raw_schema
+      attr_reader :raw_connection, :raw_catalog, :raw_schema, :raw_schema_reader
 
       def initialize(params={})
         @params = params
@@ -29,6 +29,13 @@ module Mondrian
           props.setProperty('JdbcUser', @params[:username]) if @params[:username]
           props.setProperty('JdbcPassword', @params[:password]) if @params[:password]
 
+          # on Oracle increase default row prefetch size
+          # as default 10 is very low and slows down loading of all dimension members
+          if @driver == 'oracle'
+            prefetch_rows = @params[:prefetch_rows] || 100
+            props.setProperty("jdbc.defaultRowPrefetch", prefetch_rows.to_s)
+          end
+
           conn_string = connection_string
 
           # latest Mondrian version added ClassResolver which uses current thread class loader to load some classes
@@ -47,6 +54,7 @@ module Mondrian
           @raw_catalog = @raw_connection.getOlapCatalog
           # currently it is assumed that there is just one schema per connection catalog
           @raw_schema = @raw_catalog.getSchemas.first
+          @raw_schema_reader = @raw_connection.getMondrianConnection.getSchemaReader
           @connected = true
           true
         end
@@ -63,13 +71,21 @@ module Mondrian
         true
       end
 
-      def execute(query_string)
+      def execute(query_string, parameters = {})
         Error.wrap_native_exception do
           statement = @raw_connection.prepareOlapStatement(query_string)
+          set_statement_parameters(statement, parameters)
           Result.new(self, statement.executeQuery())
         end
       end
 
+      # access mondrian.olap.Parameter object
+      def mondrian_parameter(parameter_name)
+        Error.wrap_native_exception do
+          @raw_schema_reader.getParameter(parameter_name)
+        end
+      end
+
       def execute_drill_through(query_string)
         Error.wrap_native_exception do
           statement = @raw_connection.createStatement
@@ -195,6 +211,14 @@ module Mondrian
           pool.close if pool && !pool.isClosed
         end
 
+        # unregister MBean
+        mbs = Java::JavaLangManagement::ManagementFactory.getPlatformMBeanServer
+        mbean_name = Java::JavaxManagement::ObjectName.new("mondrian.server:type=Server-#{static_mondrian_server.getId}")
+        begin
+          mbs.unregisterMBean(mbean_name)
+        rescue Java::JavaxManagement::InstanceNotFoundException
+        end
+
         true
       end
 
@@ -255,6 +279,8 @@ module Mondrian
           uri << ";applicationName=#{@params[:application_name]}" if @params[:application_name]
           uri << ";instanceName=#{@params[:instance_name]}" if @params[:instance_name]
           uri
+        when 'jdbc'
+          @params[:jdbc_url] or raise ArgumentError, 'missing jdbc_url parameter'
         else
           raise ArgumentError, 'unknown JDBC driver'
         end
@@ -274,6 +300,8 @@ module Mondrian
           'net.sourceforge.jtds.jdbc.Driver'
         when 'sqlserver'
           'com.microsoft.sqlserver.jdbc.SQLServerDriver'
+        when 'jdbc'
+          @params[:jdbc_driver] or raise ArgumentError, 'missing jdbc_driver parameter'
         else
           raise ArgumentError, 'unknown JDBC driver'
         end
@@ -301,6 +329,25 @@ module Mondrian
         "'#{string.gsub("'","''")}'"
       end
 
+      def set_statement_parameters(statement, parameters)
+        if parameters && !parameters.empty?
+          # define addtional parameters which can be accessed from user defined functions
+          if parameters[:define_parameters]
+            parameters = parameters.dup
+            define_parameters = parameters.delete(:define_parameters)
+            query_validator = statement.getQuery.createValidator
+            define_parameters.each do |dp_name, dp_value|
+              dp_type_class = dp_value.is_a?(Numeric) ? Java::MondrianOlapType::NumericType : Java::MondrianOlapType::StringType
+              query_validator.createOrLookupParam(true, dp_name, dp_type_class.new, nil, nil)
+              parameters[dp_name] = dp_value
+            end
+          end
+          parameters.each do |parameter_name, value|
+            statement.getQuery.setParameter(parameter_name, value)
+          end
+        end
+      end
+
     end
   end
 end

data/lib/mondrian/olap/cube.rb

@@ -46,6 +46,10 @@ module Mondrian
         annotations_for(@raw_cube)
       end
 
+      def visible?
+        @raw_cube.isVisible
+      end
+
       def dimensions
         @dimenstions ||= @raw_cube.getDimensions.map{|d| Dimension.new(self, d)}
       end
@@ -132,6 +136,10 @@ module Mondrian
         annotations_for(@raw_dimension)
       end
 
+      def visible?
+        @raw_dimension.isVisible
+      end
+
     end
 
     class Hierarchy
@@ -207,6 +215,10 @@ module Mondrian
         annotations_for(@raw_hierarchy)
       end
 
+      def visible?
+        @raw_hierarchy.isVisible
+      end
+
     end
 
     class Level
@@ -260,6 +272,10 @@ module Mondrian
         annotations_for(@raw_level)
       end
 
+      def visible?
+        @raw_level.isVisible
+      end
+
     end
 
     class Member

data/lib/mondrian/olap/error.rb

@@ -44,7 +44,7 @@ module Mondrian
         bt = @native_error.backtrace
         if @root_cause
           root_cause_bt = Array(@root_cause.backtrace)
-          root_cause_bt[0,5].reverse.each do |bt_line|
+          root_cause_bt[0,10].reverse.each do |bt_line|
             bt.unshift "root cause:   #{bt_line}"
           end
           bt.unshift "root cause: #{@root_cause.java_class.name}: #{@root_cause.message.chomp}"

data/lib/mondrian/olap/query.rb

@@ -47,7 +47,7 @@ module Mondrian
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{method}(*axis_members)
             raise ArgumentError, "cannot use #{method} method before axis or with_set method" unless @current_set
-            raise ArgumentError, "specify list of members for #{method} method" if axis_members.empty?
+            raise ArgumentError, "specify set of members for #{method} method" if axis_members.empty?
             members = axis_members.length == 1 && axis_members[0].is_a?(Array) ? axis_members[0] : axis_members
             @current_set.replace [:#{method}, @current_set.clone, members]
             self
@@ -57,7 +57,7 @@ module Mondrian
 
       def except(*axis_members)
         raise ArgumentError, "cannot use except method before axis or with_set method" unless @current_set
-        raise ArgumentError, "specify list of members for except method" if axis_members.empty?
+        raise ArgumentError, "specify set of members for except method" if axis_members.empty?
         members = axis_members.length == 1 && axis_members[0].is_a?(Array) ? axis_members[0] : axis_members
         if [:crossjoin, :nonempty_crossjoin].include? @current_set[0]
           @current_set[2] = [:except, @current_set[2], members]
@@ -87,6 +87,19 @@ module Mondrian
         self
       end
 
+      def generate(*axis_members)
+        raise ArgumentError, "cannot use generate method before axis or with_set method" unless @current_set
+        all = if axis_members.last == :all
+          axis_members.pop
+          'ALL'
+        end
+        raise ArgumentError, "specify set of members for generate method" if axis_members.empty?
+        members = axis_members.length == 1 && axis_members[0].is_a?(Array) ? axis_members[0] : axis_members
+        @current_set.replace [:generate, @current_set.clone, members]
+        @current_set << all if all
+        self
+      end
+
       VALID_ORDERS = ['ASC', 'BASC', 'DESC', 'BDESC']
 
       def order(expression, direction)
@@ -216,9 +229,9 @@ module Mondrian
         mdx
       end
 
-      def execute
+      def execute(parameters = {})
         Error.wrap_native_exception do
-          @connection.execute to_mdx
+          @connection.execute to_mdx, parameters
         end
       end
 
@@ -299,6 +312,8 @@ module Mondrian
           when :filter
             as_alias = members[3] ? " AS #{members[3]}" : nil
             "FILTER(#{members_to_mdx(members[1])}#{as_alias}, #{members[2]})"
+          when :generate
+            "GENERATE(#{members_to_mdx(members[1])}, #{members_to_mdx(members[2])}#{members[3] && ", #{members[3]}"})"
           when :order
             "ORDER(#{members_to_mdx(members[1])}, #{expression_to_mdx(members[2])}, #{members[3]})"
           when :top_count, :bottom_count

data/lib/mondrian/olap/result.rb

@@ -8,6 +8,8 @@ module Mondrian
         @raw_cell_set = raw_cell_set
       end
 
+      attr_reader :raw_cell_set
+
       def axes_count
         axes.length
       end
@@ -248,6 +250,10 @@ module Mondrian
           if sql_non_extended =~ /\Aselect (.*) from (.*) where (.*) order by (.*)\Z/
             non_extended_from = $2
             non_extended_where = $3
+          # if drill through total measure with just all members selection
+          elsif sql_non_extended =~ /\Aselect (.*) from (.*)\Z/
+            non_extended_from = $2
+            non_extended_where = "1 = 1" # dummy true condition
           else
             raise ArgumentError, "cannot parse drill through SQL: #{sql_non_extended}"
           end

data/lib/mondrian/olap/schema.rb

@@ -50,10 +50,12 @@ module Mondrian
       public
 
       attributes :name, :description, :measures_caption
-      elements :annotations, :dimension, :cube, :virtual_cube, :role, :user_defined_function
+      elements :annotations, :parameter, :dimension, :cube, :virtual_cube, :role, :user_defined_function
 
       class Cube < SchemaElement
         attributes :name, :description, :caption,
+          # Whether this cube is visible in the user-interface. Default true.
+          :visible,
           # 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.
@@ -84,6 +86,8 @@ module Mondrian
 
       class Dimension < SchemaElement
         attributes :name, :description, :caption,
+          # Whether this dimension is visible in the user-interface. Default true.
+          :visible,
           # 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.
@@ -121,6 +125,8 @@ module Mondrian
 
       class Hierarchy < SchemaElement
         attributes :name, :description, :caption,
+          # Whether this hierarchy is visible in the user-interface. Default true.
+          :visible,
           # Whether this hierarchy has an 'all' member.
           :has_all,
           # Name of the 'all' member. If this attribute is not specified,
@@ -137,6 +143,8 @@ module Mondrian
           # 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,
+          #
+          :default_member,
           # 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
@@ -160,6 +168,8 @@ module Mondrian
 
       class Level < SchemaElement
         attributes :name, :description, :caption,
+          # Whether this level is visible in the user-interface. Default true.
+          :visible,
           # 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.
@@ -187,6 +197,12 @@ module Mondrian
           # for example, "DATE '2006-06-01'".
           # Default value: 'String'
           :type,
+          # Indicates the Java type that Mondrian uses to store this level's key column.
+          # It also determines the JDBC method that Mondrian will call to retrieve the column;
+          # for example, if the Java type is 'int', Mondrian will call 'ResultSet.getInt(int)'.
+          # Usually this attribute is not needed, because Mondrian can choose a sensible type based on the type of the database column.
+          # Allowable values are: 'int', 'long', 'Object', 'String'.
+          :internal_type,
           # Whether members are unique across all parents.
           # For example, zipcodes are unique across all states.
           # The first level's members are always unique.
@@ -288,8 +304,12 @@ module Mondrian
 
       class CalculatedMember < SchemaElement
         attributes :name, :description, :caption,
-          # Name of the dimension which this member belongs to.
+          # Name of the dimension which this member belongs to. Cannot be used if :hieararchy is specified.
           :dimension,
+          # Full unique name of the hierarchy that this member belongs to.
+          :hierarchy,
+          # Fully-qualified name of the parent member. If not specified, the member will be at the lowest level (besides the 'all' level) in the hierarchy.
+          :parent,
           # Format string with which to format cells of this measure. For more details, see the mondrian.util.Format class.
           :format_string,
           # Whether this member is visible in the user-interface. Default true.
@@ -312,6 +332,8 @@ module Mondrian
 
       class VirtualCube < SchemaElement
         attributes :name, :description, :caption,
+          # Whether this cube is visible in the user-interface. Default true.
+          :visible,
           # The name of the measure that would be taken as the default measure of the cube.
           :default_measure,
           # Whether element is enabled - if true, then the VirtualCube is realized otherwise it is ignored.
@@ -322,7 +344,9 @@ module Mondrian
       class VirtualCubeDimension < SchemaElement
         attributes :name,
           # Name of the cube which the dimension belongs to, or unspecified if the dimension is shared
-          :cube_name
+          :cube_name,
+          # Whether this dimension is visible in the user-interface. Default true.
+          :visible
       end
 
       class VirtualCubeMeasure < SchemaElement
@@ -473,6 +497,18 @@ module Mondrian
       class Annotation < SchemaElement
         content :text
       end
+
+      class Parameter < SchemaElement
+        attributes :name, :description,
+          # Indicates the type of this parameter: String, Numeric, Integer, Boolean, Date, Time, Timestamp, or Member.
+          :type,
+          # If false, statement cannot change the value of this parameter; the parameter becomes effectively constant
+          # (provided that its default value expression always returns the same value). Default is true.
+          :modifiable,
+          # Expression for the default value of this parameter.
+          :default_value
+      end
+
     end
   end
 end

data/spec/connection_spec.rb

@@ -45,7 +45,7 @@ describe "Connection" do
       schema_field = @olap.raw_schema.getClass.getDeclaredField("schema")
       schema_field.setAccessible(true)
       private_schema = schema_field.get(@olap.raw_schema)
-      private_schema.getDialect.java_class.name.should == case MONDRIAN_DRIVER
+      private_schema.getDialect.java_class.name.should == case MONDRIAN_DRIVER.split('_').last
         when 'mysql' then 'mondrian.spi.impl.MySqlDialect'
         when 'postgresql' then 'mondrian.spi.impl.PostgreSqlDialect'
         when 'oracle' then 'mondrian.spi.impl.OracleDialect'

data/spec/cube_spec.rb

@@ -10,17 +10,21 @@ describe "Cube" do
         caption 'Sales caption'
         annotations :foo => 'bar'
         table 'sales'
+        visible true
         dimension 'Gender', :foreign_key => 'customer_id' do
           description 'Gender description'
           caption 'Gender caption'
+          visible true
           hierarchy :has_all => true, :primary_key => 'id' do
             description 'Gender hierarchy description'
             caption 'Gender hierarchy caption'
             all_member_name 'All Genders'
             all_member_caption 'All Genders caption'
             table 'customers'
+            visible true
             level 'Gender', :column => 'gender', :unique_members => true,
                             :description => 'Gender level description', :caption => 'Gender level caption' do
+              visible true
               # Dimension values SQL generated by caption_expression fails on PostgreSQL and MS SQL
               if %w(mysql oracle).include?(MONDRIAN_DRIVER)
                 caption_expression do
@@ -56,6 +60,10 @@ describe "Cube" do
             level 'Week', :column => 'weak_of_year', :type => 'Numeric', :unique_members => false, :level_type => 'TimeWeeks'
           end
         end
+        calculated_member 'Last week' do
+          hierarchy '[Time.Weekly]'
+          formula 'Tail([Time.Weekly].[Week].Members).Item(0)'
+        end
         measure 'Unit Sales', :column => 'unit_sales', :aggregator => 'sum', :annotations => {:foo => 'bar'}
         measure 'Store Sales', :column => 'store_sales', :aggregator => 'sum'
         measure 'Store Cost', :column => 'store_cost', :aggregator => 'sum', :visible => false
@@ -92,6 +100,10 @@ describe "Cube" do
     @olap.cube('Sales').annotations.should == {'foo' => 'bar'}
   end
 
+  it "should be visible" do
+    @olap.cube('Sales').should be_visible
+  end
+
   describe "dimensions" do
     before(:all) do
       @cube = @olap.cube('Sales')
@@ -147,6 +159,11 @@ describe "Cube" do
     it "should get dimension empty annotations" do
       @cube.dimension('Gender').annotations.should == {}
     end
+
+    it "should be visible" do
+      @cube.dimension('Gender').should be_visible
+    end
+
   end
 
   describe "dimension hierarchies" do
@@ -208,6 +225,11 @@ describe "Cube" do
     it "should get hierarchy empty annotations" do
       @cube.dimension('Gender').hierarchy.annotations.should == {}
     end
+
+    it "should be visible" do
+      @cube.dimension('Gender').hierarchies.first.should be_visible
+    end
+
   end
 
   describe "hierarchy values" do
@@ -288,6 +310,10 @@ describe "Cube" do
       @cube.dimension('Gender').hierarchy.level('Gender').annotations.should == {}
     end
 
+    it "should be visible" do
+      @cube.dimension('Gender').hierarchy.level('Gender').should be_visible
+    end
+
   end
 
   describe "members" do
@@ -356,6 +382,10 @@ describe "Cube" do
       @cube.member('[Customers].[Non-USA]').should be_calculated
     end
 
+    it "should be calculated when member is calculated in non-default hierarchy" do
+      @cube.member('[Time.Weekly].[Last week]').should be_calculated
+    end
+
     it "should not be calculated in query when calculated member defined in schema" do
       @cube.member('[Customers].[Non-USA]').should_not be_calculated_in_query
     end
@@ -384,11 +414,11 @@ describe "Cube" do
       @cube.member('[Time].[2011]').dimension_type.should == :time
     end
 
-    it "should be visble when member is visible" do
+    it "should be visible when member is visible" do
       @cube.member('[Measures].[Store Sales]').should be_visible
     end
 
-    it "should not be visble when member is not visible" do
+    it "should not be visible when member is not visible" do
       @cube.member('[Measures].[Store Cost]').should_not be_visible
     end
 

data/spec/query_spec.rb

@@ -1,8 +1,8 @@
 require "spec_helper"
 
 describe "Query" do
-  def quote_table_name(name)
-    ActiveRecord::Base.connection.quote_table_name(name)
+  def qt(name)
+    ActiveRecord::Base.connection.quote_table_name(name.to_s)
   end
 
   before(:all) do
@@ -21,9 +21,9 @@ describe "Query" do
     FROM sales
       LEFT JOIN products ON sales.product_id = products.id
       LEFT JOIN product_classes ON products.product_class_id = product_classes.id
-      LEFT JOIN #{quote_table_name('time')} ON sales.time_id = #{quote_table_name('time')}.id
+      LEFT JOIN #{qt :time} ON sales.time_id = #{qt :time}.id
       LEFT JOIN customers ON sales.customer_id = customers.id
-    WHERE #{quote_table_name('time')}.the_year = 2010 AND #{quote_table_name('time')}.quarter = 'Q1'
+    WHERE #{qt :time}.the_year = 2010 AND #{qt :time}.quarter = 'Q1'
       AND customers.country = 'USA' AND customers.state_province = 'CA'
     GROUP BY product_classes.product_family
     ORDER BY product_classes.product_family
@@ -282,6 +282,18 @@ describe "Query" do
       end
     end
 
+    describe "generate" do
+      it "should generate new set" do
+        @query.rows('[Customers].[Country].Members').generate('[Customers].CurrentMember')
+        @query.rows.should == [:generate, ['[Customers].[Country].Members'], ['[Customers].CurrentMember']]
+      end
+
+      it "should generate new set with all option" do
+        @query.rows('[Customers].[Country].Members').generate('[Customers].CurrentMember', :all)
+        @query.rows.should == [:generate, ['[Customers].[Country].Members'], ['[Customers].CurrentMember'], 'ALL']
+      end
+    end
+
     describe "where" do
       it "should accept conditions" do
         @query.where('[Time].[2010].[Q1]', '[Customers].[USA].[CA]').should equal(@query)
@@ -605,6 +617,26 @@ describe "Query" do
           SQL
       end
 
+      it "should return query with generate" do
+        @query.columns('[Measures].[Unit Sales]', '[Measures].[Store Sales]').
+          rows('[Customers].[Country].Members').generate('[Customers].CurrentMember').
+          to_mdx.should be_like <<-SQL
+            SELECT  {[Measures].[Unit Sales], [Measures].[Store Sales]} ON COLUMNS,
+                    GENERATE([Customers].[Country].Members, [Customers].CurrentMember) ON ROWS
+              FROM  [Sales]
+          SQL
+      end
+
+      it "should return query with generate all" do
+        @query.columns('[Measures].[Unit Sales]', '[Measures].[Store Sales]').
+          rows('[Customers].[Country].Members').generate('[Customers].CurrentMember', :all).
+          to_mdx.should be_like <<-SQL
+            SELECT  {[Measures].[Unit Sales], [Measures].[Store Sales]} ON COLUMNS,
+                    GENERATE([Customers].[Country].Members, [Customers].CurrentMember, ALL) ON ROWS
+              FROM  [Sales]
+          SQL
+      end
+
       it "should return query including WITH MEMBER clause" do
         @query.
           with_member('[Measures].[ProfitPct]').
@@ -895,4 +927,50 @@ describe "Query" do
 
   end
 
+  describe "schema cache" do
+    before(:all) do
+      product_id = @sql.select_value("SELECT MIN(id) FROM products")
+      time_id = @sql.select_value("SELECT MIN(id) FROM #{qt :time}")
+      customer_id = @sql.select_value("SELECT MIN(id) FROM customers")
+      @condition = "product_id = #{product_id} AND time_id = #{time_id} AND customer_id = #{customer_id}"
+      # check expected initial value
+      @first_unit_sales = 1
+      @sql.select_value("SELECT unit_sales FROM sales WHERE #{@condition}").to_i.should == @first_unit_sales
+    end
+
+    after(:all) do
+      update_first_unit_sales(@first_unit_sales)
+    end
+
+    def create_olap_connection
+      @olap2.close if @olap2
+      @olap2 = Mondrian::OLAP::Connection.create(CONNECTION_PARAMS_WITH_CATALOG)
+    end
+
+    def update_first_unit_sales(value)
+      @sql.update "UPDATE sales SET unit_sales = #{value} WHERE #{@condition}"
+    end
+
+    def query_unit_sales_value
+      @olap2.from('Sales').columns('[Measures].[Unit Sales]').execute.values.first
+    end
+
+    it "should flush schema cache" do
+      create_olap_connection
+      unit_sales = query_unit_sales_value
+
+      update_first_unit_sales(@first_unit_sales + 1)
+
+      # should still use previous value from cache
+      create_olap_connection
+      query_unit_sales_value.should == unit_sales
+
+      # should query new value from the database after flush schema cache
+      @olap2.flush_schema_cache
+      create_olap_connection
+      query_unit_sales_value.should == unit_sales + 1
+    end
+
+  end
+
 end

data/spec/rake_tasks.rb

@@ -242,7 +242,7 @@ namespace :db do
 end
 
 namespace :spec do
-  %w(mysql postgresql oracle luciddb mssql sqlserver).each do |driver|
+  %w(mysql jdbc_mysql postgresql oracle luciddb mssql sqlserver).each do |driver|
     desc "Run specs with #{driver} driver"
     task driver do
       ENV['MONDRIAN_DRIVER'] = driver
@@ -253,7 +253,7 @@ namespace :spec do
 
   desc "Run specs with all primary database drivers"
   task :all do
-    %w(mysql postgresql oracle mssql).each do |driver|
+    %w(mysql jdbc_mysql postgresql oracle mssql).each do |driver|
       Rake::Task["spec:#{driver}"].invoke
     end
   end

data/spec/schema_definition_spec.rb

@@ -549,6 +549,27 @@ describe "Schema definition" do
         XML
       end
 
+      it "should render XML with dimension and hierarchy" do
+        @schema.define do
+          cube 'Sales' do
+            calculated_member 'Current week' do
+              hierarchy '[Time.Weekly]'
+              formula '[Time.Weekly].[Week].CurrentDateMember'
+            end
+          end
+        end
+        @schema.to_xml.should be_like <<-XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <Schema name="default">
+          <Cube name="Sales">
+            <CalculatedMember hierarchy="[Time.Weekly]" name="Current week">
+              <Formula>[Time.Weekly].[Week].CurrentDateMember</Formula>
+            </CalculatedMember>
+          </Cube>
+        </Schema>
+        XML
+      end
+
       it "should render embedded cube XML defintion before additional calculated member to XML" do
         @schema.define do
           cube 'Sales' do
@@ -824,6 +845,8 @@ describe "Schema definition" do
     end
 
     describe "User defined functions and formatters in JavaScript" do
+      next pending "not supported by Mondrian in Java 8" if ENV_JAVA["java.version"] >= "1.8"
+
       before(:each) do
         @schema.define do
           cube 'Sales' do
@@ -957,6 +980,8 @@ describe "Schema definition" do
     end
 
     describe "User defined functions and formatters in CoffeeScript" do
+      next pending "not supported by Mondrian in Java 8" if ENV_JAVA["java.version"] >= "1.8"
+
       before(:each) do
         @schema.define do
           cube 'Sales' do
@@ -1373,6 +1398,136 @@ describe "Schema definition" do
       end
     end
 
+    describe "Parameters" do
+      before(:each) do
+        @schema.define do
+          parameter 'Current User', :type => 'String', :modifiable => true, :default_value => "'demo'"
+          parameter 'Current User 1', :type => 'String', :modifiable => true, :default_value => "''"
+          parameter 'Default User', :type => 'String', :modifiable => false, :default_value => "'default'"
+          cube 'Sales' do
+            table 'sales'
+            measure 'Unit Sales', :column => 'unit_sales', :aggregator => 'sum'
+          end
+          user_defined_function 'ParameterValue' do
+            ruby :shared do
+              parameters :string
+              returns :scalar
+              syntax :function
+              def call_with_evaluator(evaluator, parameter_name)
+                parameter = evaluator.getQuery.getSchemaReader(false).getParameter(parameter_name)
+                parameter && parameter.getValue
+              end
+            end
+          end
+        end
+        @olap = Mondrian::OLAP::Connection.create(CONNECTION_PARAMS.merge :schema => @schema)
+      end
+
+      it "should render XML" do
+        @schema.to_xml.should be_like <<-XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <Schema name="default">
+          <Parameter defaultValue="'demo'" modifiable="true" name="Current User" type="String"/>
+          <Parameter defaultValue="''" modifiable="true" name="Current User 1" type="String"/>
+          <Parameter defaultValue="'default'" modifiable="false" name="Default User" type="String"/>
+          <Cube name="Sales">
+            <Table name="sales"/>
+            <Measure aggregator="sum" column="unit_sales" name="Unit Sales"/>
+          </Cube>
+          <UserDefinedFunction className="rubyobj.Mondrian.OLAP.Schema.UserDefinedFunction.ParametervalueUdf" name="ParameterValue"/>
+        </Schema>
+        XML
+      end
+
+      it "should get parameter definition from connection" do
+        parameter = @olap.mondrian_parameter('Current User')
+        parameter.should_not be_nil
+        parameter.name.should == 'Current User'
+        parameter.description.should be_nil
+        parameter.should be_modifiable
+        parameter.scope.to_s.should == 'Schema'
+        parameter.type.to_s.should == 'STRING'
+      end
+
+      it "should not get parameter definition with invalid name" do
+        @olap.mondrian_parameter('Current User 2').should be_nil
+      end
+
+      it "should get default parameter value with ParamRef" do
+        result = @olap.from('Sales').
+          with_member('[Measures].[Current User]').as("ParamRef('Current User')").
+            columns('[Measures].[Current User]').execute
+        result.values.should == ['demo']
+      end
+
+      it "should execute query with schema parameter value and get value with ParamRef" do
+        result = @olap.from('Sales').
+          with_member('[Measures].[Current User]').as("ParamRef('Current User 1')").
+            columns('[Measures].[Current User]').execute("Current User 1" => "test")
+        result.values.should == ['test']
+      end
+
+      it "should execute query with query parameter value and get value with Parameter" do
+        result = @olap.from('Sales').
+          with_member('[Measures].[Current User]').as("Parameter('Current User 2', String, 'demo2')").
+            columns('[Measures].[Current User]').execute("Current User 2" => "test2")
+        result.values.should == ['test2']
+      end
+
+      # can be used in user defined functions
+      it "should execute query with additional defined parameter string value" do
+        result = @olap.from('Sales').
+          with_member('[Measures].[Parameter]').as("ParameterValue('String Parameter')").
+            columns('[Measures].[Parameter]').execute(:define_parameters => {"String Parameter" => "test"})
+        result.values.should == ['test']
+      end
+
+      it "should execute query with additional defined parameter integer value" do
+        result = @olap.from('Sales').
+          with_member('[Measures].[Parameter]').as("ParameterValue('Integer Parameter')").
+            columns('[Measures].[Parameter]').execute(:define_parameters => {"Integer Parameter" => 123})
+        result.values.should == [123]
+      end
+
+      it "should execute query with additional defined parameter double value" do
+        result = @olap.from('Sales').
+          with_member('[Measures].[Parameter]').as("ParameterValue('Double Parameter')").
+            columns('[Measures].[Parameter]').execute(:define_parameters => {"Double Parameter" => 123.456})
+        result.values.should == [123.456]
+      end
+
+      it "should execute query with additional defined parameter nil value" do
+        result = @olap.from('Sales').
+          with_member('[Measures].[Parameter]').as("ParameterValue('Nil Parameter')").
+            columns('[Measures].[Parameter]').execute(:define_parameters => {"Nil Parameter" => nil})
+        result.values.should == [nil]
+      end
+
+      it "should fail if executing with invalid parameter name" do
+        expect {
+          @olap.from('Sales').
+            with_member('[Measures].[Current User]').as("'dummy'").
+              columns('[Measures].[Current User]').execute("Current User 2" => "test2")
+        }.to raise_error {|e|
+          e.should be_kind_of(Mondrian::OLAP::Error)
+          e.message.should == "mondrian.olap.MondrianException: Mondrian Error:Unknown parameter 'Current User 2'"
+          e.root_cause_message.should == "Unknown parameter 'Current User 2'"
+        }
+      end
+
+      it "should fail if executing with non-modifiable parameter" do
+        expect {
+          @olap.from('Sales').
+            with_member('[Measures].[Current User]').as("'dummy'").
+              columns('[Measures].[Current User]').execute("Default User" => "test")
+        }.to raise_error {|e|
+          e.should be_kind_of(Mondrian::OLAP::Error)
+          e.message.should == "mondrian.olap.MondrianException: Mondrian Error:Parameter 'Default User' (defined at 'Schema' scope) is not modifiable"
+          e.root_cause_message.should == "Parameter 'Default User' (defined at 'Schema' scope) is not modifiable"
+        }
+      end
+    end
+
   end
 
   describe "connection with schema" do

data/spec/spec_helper.rb

@@ -19,7 +19,7 @@ DATABASE_NAME     = ENV["#{env_prefix}_DATABASE_NAME"]     || ENV['DATABASE_NAME
 DATABASE_INSTANCE = ENV["#{env_prefix}_DATABASE_INSTANCE"] || ENV['DATABASE_INSTANCE']
 
 case MONDRIAN_DRIVER
-when 'mysql'
+when 'mysql', 'jdbc_mysql'
   require 'jdbc/mysql'
   JDBC_DRIVER = 'com.mysql.jdbc.Driver'
 when 'postgresql'
@@ -75,15 +75,25 @@ end
 
 CATALOG_FILE = File.expand_path('../fixtures/MondrianTest.xml', __FILE__) unless defined?(CATALOG_FILE)
 
-CONNECTION_PARAMS = {
-  # uncomment to test PostgreSQL SSL connection
-  # :properties => {'ssl'=>'true','sslfactory'=>'org.postgresql.ssl.NonValidatingFactory'},
-  :driver   => MONDRIAN_DRIVER,
-  :host     => DATABASE_HOST,
-  :database => DATABASE_NAME,
-  :username => DATABASE_USER,
-  :password => DATABASE_PASSWORD
-}
+CONNECTION_PARAMS = if MONDRIAN_DRIVER =~ /^jdbc/
+  {
+    :driver   => 'jdbc',
+    :jdbc_url => "jdbc:#{MONDRIAN_DRIVER.split('_').last}://#{DATABASE_HOST}/#{DATABASE_NAME}",
+    :jdbc_driver => JDBC_DRIVER,
+    :username => DATABASE_USER,
+    :password => DATABASE_PASSWORD
+  }
+else
+  {
+    # uncomment to test PostgreSQL SSL connection
+    # :properties => {'ssl'=>'true','sslfactory'=>'org.postgresql.ssl.NonValidatingFactory'},
+    :driver   => MONDRIAN_DRIVER,
+    :host     => DATABASE_HOST,
+    :database => DATABASE_NAME,
+    :username => DATABASE_USER,
+    :password => DATABASE_PASSWORD
+  }
+end
 
 case MONDRIAN_DRIVER
 when 'oracle'
@@ -126,6 +136,14 @@ when 'sqlserver'
     :password => CONNECTION_PARAMS[:password],
     :connection_alive_sql => 'SELECT 1'
   }
+when /jdbc/
+  AR_CONNECTION_PARAMS = {
+    :adapter  => 'jdbc',
+    :driver   => JDBC_DRIVER,
+    :url      => CONNECTION_PARAMS[:jdbc_url],
+    :username => CONNECTION_PARAMS[:username],
+    :password => CONNECTION_PARAMS[:password]
+  }
 else
   AR_CONNECTION_PARAMS = {
     # uncomment to test PostgreSQL SSL connection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mondrian-olap
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Raimonds Simanovskis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-11-29 00:00:00.000000000 Z
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -236,20 +236,21 @@ files:
 - VERSION
 - lib/mondrian-olap.rb
 - lib/mondrian/olap.rb
-- lib/mondrian/jars/commons-collections-3.2.jar
-- lib/mondrian/jars/commons-dbcp-1.2.1.jar
+- lib/mondrian/jars/commons-collections-3.2.1.jar
+- lib/mondrian/jars/commons-dbcp-1.4.jar
+- lib/mondrian/jars/commons-io-2.2.jar
 - lib/mondrian/jars/commons-logging-1.1.1.jar
 - lib/mondrian/jars/commons-math-1.1.jar
-- lib/mondrian/jars/commons-pool-1.2.jar
-- lib/mondrian/jars/commons-vfs-1.0.jar
+- lib/mondrian/jars/commons-pool-1.5.7.jar
+- lib/mondrian/jars/commons-vfs-20100924-pentaho.jar
 - lib/mondrian/jars/eigenbase-properties-1.1.2.jar
 - lib/mondrian/jars/eigenbase-resgen-1.3.1.jar
 - lib/mondrian/jars/eigenbase-xom-1.3.1.jar
 - lib/mondrian/jars/javacup-10k.jar
-- lib/mondrian/jars/log4j-1.2.14.jar
+- lib/mondrian/jars/log4j-1.2.17.jar
 - lib/mondrian/jars/log4j.properties
-- lib/mondrian/jars/mondrian.jar
-- lib/mondrian/jars/olap4j-1.0.1.539.jar
+- lib/mondrian/jars/mondrian-3.8.0.0-209.jar
+- lib/mondrian/jars/olap4j-1.2.0.jar
 - lib/mondrian/olap/connection.rb
 - lib/mondrian/olap/cube.rb
 - lib/mondrian/olap/error.rb