mondrian-olap 0.5.0 → 1.2.0

data/spec/schema_definition_spec.rb

@@ -85,13 +85,13 @@ describe "Schema definition" do
         XML
       end
 
-      it "should render table name in uppercase when using Oracle or LucidDB driver" do
+      it "should render table name in uppercase when using Oracle or Snowflake driver" do
         @schema.define do
           cube 'Sales' do
             table 'sales_fact', :alias => 'sales', :schema => 'facts'
           end
         end
-        %w(oracle luciddb).each do |driver|
+        %w(oracle snowflake).each do |driver|
           @schema.to_xml(:driver => driver).should be_like <<-XML
           <?xml version="1.0" encoding="UTF-8"?>
           <Schema name="default">
@@ -119,13 +119,13 @@ describe "Schema definition" do
         XML
       end
 
-      it "should render table name in lowercase when using Oracle or LucidDB driver but with :upcase_data_dictionary set to false" do
+      it "should render table name in lowercase when using Oracle or Snowflake driver but with :upcase_data_dictionary set to false" do
         @schema.define :upcase_data_dictionary => false do
           cube 'Sales' do
             table 'sales_fact', :alias => 'sales', :schema => 'facts'
           end
         end
-        %w(oracle luciddb).each do |driver|
+        %w(oracle snowflake).each do |driver|
           @schema.to_xml(:driver => driver).should be_like <<-XML
           <?xml version="1.0" encoding="UTF-8"?>
           <Schema name="default">
@@ -191,7 +191,9 @@ describe "Schema definition" do
                 all_member_name 'All Genders'
                 primary_key 'customer_id'
                 table 'customer'
-                level 'Gender', :column => 'gender', :unique_members => true
+                level 'Gender', :column => 'gender', :unique_members => true,
+                  # Test attribute with a future value
+                  :approx_row_count => Thread.new { sleep 0.1; 2 }
               end
             end
           end
@@ -203,7 +205,7 @@ describe "Schema definition" do
             <Dimension foreignKey="customer_id" name="Gender">
               <Hierarchy allMemberName="All Genders" hasAll="true" primaryKey="customer_id">
                 <Table name="customer"/>
-                <Level column="gender" name="Gender" uniqueMembers="true"/>
+                <Level approxRowCount="2" column="gender" name="Gender" uniqueMembers="true"/>
               </Hierarchy>
             </Dimension>
           </Cube>
@@ -549,6 +551,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
@@ -765,65 +788,86 @@ describe "Schema definition" do
     end
 
     describe "Element annotations" do
-      it "should render XML from block of elements" do
-        @schema.define do
-          cube 'Sales' do
-            annotations do
-              annotation 'key1', 'value1'
-              annotation 'key2', 'value2'
-            end
-            measure 'Unit Sales', :column => 'unit_sales' do
+      describe "block of elements" do
+        before do
+          @schema.define do
+            cube 'Sales' do
               annotations do
-                annotation 'key3', 'value3'
+                annotation 'key1', 'value1'
+                annotation 'key2', 'value2'
+              end
+              measure 'Unit Sales', :column => 'unit_sales' do
+                annotations do
+                  annotation 'key3', 'value3'
+                end
               end
             end
           end
         end
-        @schema.to_xml.should be_like <<-XML
-        <?xml version="1.0" encoding="UTF-8"?>
-        <Schema name="default">
-          <Cube name="Sales">
-            <Annotations>
-              <Annotation name="key1">value1</Annotation>
-              <Annotation name="key2">value2</Annotation>
-            </Annotations>
-            <Measure aggregator="sum" column="unit_sales" name="Unit Sales">
+
+        it "should render XML" do
+          @schema.to_xml.should be_like <<-XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <Schema name="default">
+            <Cube name="Sales">
               <Annotations>
-                <Annotation name="key3">value3</Annotation>
+                <Annotation name="key1">value1</Annotation>
+                <Annotation name="key2">value2</Annotation>
               </Annotations>
-            </Measure>
-          </Cube>
-        </Schema>
-        XML
+              <Measure aggregator="sum" column="unit_sales" name="Unit Sales">
+                <Annotations>
+                  <Annotation name="key3">value3</Annotation>
+                </Annotations>
+              </Measure>
+            </Cube>
+          </Schema>
+          XML
+        end
+
+        it "should access annotations from schema definition" do
+          @schema.cubes.first.annotations_hash.should == {'key1' => 'value1', 'key2' => 'value2'}
+        end
       end
 
-      it "should render XML from hash options" do
-        @schema.define do
-          cube 'Sales' do
-            annotations :key1 => 'value1', :key2 => 'value2'
-            measure 'Unit Sales', :column => 'unit_sales', :annotations => {:key3 => 'value3'}
+      describe "from hash options" do
+        before do
+          @schema.define do
+            cube 'Sales' do
+              annotations :key1 => 'value1', :key2 => 'value2'
+              measure 'Unit Sales', :column => 'unit_sales', :annotations => {:key3 => 'value3'}
+            end
           end
         end
-        @schema.to_xml.should be_like <<-XML
-        <?xml version="1.0" encoding="UTF-8"?>
-        <Schema name="default">
-          <Cube name="Sales">
-            <Annotations>
-              <Annotation name="key1">value1</Annotation>
-              <Annotation name="key2">value2</Annotation>
-            </Annotations>
-            <Measure aggregator="sum" column="unit_sales" name="Unit Sales">
+
+        it "should render XML " do
+          @schema.to_xml.should be_like <<-XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <Schema name="default">
+            <Cube name="Sales">
               <Annotations>
-                <Annotation name="key3">value3</Annotation>
+                <Annotation name="key1">value1</Annotation>
+                <Annotation name="key2">value2</Annotation>
               </Annotations>
-            </Measure>
-          </Cube>
-        </Schema>
-        XML
+              <Measure aggregator="sum" column="unit_sales" name="Unit Sales">
+                <Annotations>
+                  <Annotation name="key3">value3</Annotation>
+                </Annotations>
+              </Measure>
+            </Cube>
+          </Schema>
+          XML
+        end
+
+        it "should access annotations from schema definition" do
+          @schema.cubes.first.annotations_hash.should == {'key1' => 'value1', 'key2' => 'value2'}
+          @schema.cubes.first.measures.first.annotations_hash.should == {'key3' => 'value3'}
+        end
       end
     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 +1001,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
@@ -976,11 +1022,11 @@ describe "Schema definition" do
               dimension 'Measures'
               formula 'Factorial(6)'
               cell_formatter do
-                coffeescript <<-JS
+                coffeescript <<-CS
                   s = value.toString()
                   s = "0" + s while s.length < 20
                   s
-                JS
+                CS
               end
             end
             calculated_member 'City' do
@@ -989,30 +1035,30 @@ describe "Schema definition" do
             end
           end
           user_defined_function 'Factorial' do
-            coffeescript <<-JS
+            coffeescript <<-CS
               parameters: ["Numeric"]
               returns: "Numeric"
               execute: (n) ->
                 if n <= 1 then 1 else n * @execute(n - 1)
-            JS
+            CS
           end
           user_defined_function 'UpperName' do
-            coffeescript <<-JS
+            coffeescript <<-CS
               parameters: ["Member"]
               returns: "String"
               syntax: "Property"
               execute: (member) ->
                 member.getName().toUpperCase()
-            JS
+            CS
           end
           user_defined_function 'toUpperName' do
-            coffeescript <<-JS
+            coffeescript <<-CS
               parameters: ["Member", "String"]
               returns: "String"
               syntax: "Method"
               execute: (member, dummy) ->
                 member.getName().toUpperCase()
-            JS
+            CS
           end
         end
         @olap = Mondrian::OLAP::Connection.create(CONNECTION_PARAMS.merge :schema => @schema)
@@ -1059,12 +1105,21 @@ describe "Schema definition" do
         @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 'Time', foreign_key: 'time_id' do
+              hierarchy all_member_name: 'All Time', primary_key: 'time_id' do
+                table 'time_by_day'
+                level 'Year', column: 'the_year', type: 'Numeric'
+                level 'Quarter', column: 'quarter'
+                level 'Month', column: 'month_of_year', type: 'Numeric'
+                level 'Day', column: 'day_of_month', type: 'Numeric'
+              end
+            end
+            dimension 'Customers', foreign_key: 'customer_id' do
+              hierarchy all_member_name: 'All Customers', primary_key: 'id' do
                 table 'customers'
-                level 'Name', :column => 'fullname' do
+                level 'Name', column: 'fullname' do
                   member_formatter { ruby {|member| member.getName().upcase } }
-                  property 'City', :column => 'city' do
+                  property 'City', column: 'city' do
                     property_formatter { ruby {|member, property_name, property_value| property_value.upcase} }
                   end
                 end
@@ -1149,8 +1204,38 @@ describe "Schema definition" do
               end
             end
           end
+          user_defined_function 'ChildrenSet' do
+            ruby do
+              parameters :member
+              returns :member_set
+              syntax :function
+              def call_with_evaluator(evaluator, member)
+                evaluator.getSchemaReader.getMemberChildren(member)
+              end
+            end
+          end
+          user_defined_function 'SetFirstTuple' do
+            ruby do
+              parameters :set
+              returns :tuple
+              syntax :function
+              def call_with_evaluator(evaluator, set)
+                set.first
+              end
+            end
+          end
+          user_defined_function 'SetFirstTuples' do
+            ruby do
+              parameters :tuple_set, :numeric
+              returns :tuple_set
+              syntax :function
+              def call_with_evaluator(evaluator, set, count)
+                set.to_a[0, count]
+              end
+            end
+          end
         end
-        @olap = Mondrian::OLAP::Connection.create(CONNECTION_PARAMS.merge :schema => @schema)
+        @olap = Mondrian::OLAP::Connection.create(CONNECTION_PARAMS.merge schema: @schema)
       end
 
       it "should execute user defined function" do
@@ -1225,6 +1310,35 @@ describe "Schema definition" do
           result.values[i].should == [first_member.name.upcase]
         end
       end
+
+      it "should execute user defined functions with a member set result" do
+        result = @olap.from('Sales').
+          with_member('[Measures].[Children Set]').as("SetToStr(ChildrenSet([Customers].CurrentMember))").
+          columns('[Measures].[Children Set]').rows('[Customers].DefaultMember').execute
+        result.row_members.each_with_index do |member, i|
+          result.values[i].first.should == "{#{member.children.map(&:full_name).join(', ')}}"
+        end
+      end
+
+      it "should execute user defined functions with a tuple result" do
+        result = @olap.from('Sales').
+          with_member('[Measures].[First Tuple]').
+            as("TupleToStr(SetFirstTuple([Customers].CurrentMember.Children * [Time].DefaultMember))").
+          columns('[Measures].[First Tuple]').rows('[Customers].DefaultMember').execute
+        result.row_members.each_with_index do |member, i|
+          result.values[i].first.should == "(#{member.children.first.full_name}, [Time].[All Time])"
+        end
+      end
+
+      it "should execute user defined functions with a tuple result" do
+        result = @olap.from('Sales').
+          with_member('[Measures].[First Tuple]').
+            as("SetToStr(SetFirstTuples([Customers].CurrentMember.Children * [Time].DefaultMember, 1))").
+          columns('[Measures].[First Tuple]').rows('[Customers].DefaultMember').execute
+        result.row_members.each_with_index do |member, i|
+          result.values[i].first.should == "{(#{member.children.first.full_name}, [Time].[All Time])}"
+        end
+      end
     end
 
     describe "Shared user defined functions in Ruby" do
@@ -1328,6 +1442,15 @@ describe "Schema definition" do
         @olap.cube('Sales').member('[Measures].[Unit Sales]').cell_formatter_name.should be_nil
       end
 
+      it "should get measure cell formatter" do
+        @olap.cube('Sales').member('[Measures].[Factorial]').cell_formatter.class.name.should ==
+          'Mondrian::OLAP::Schema::CellFormatter::Integer20DigitsUdf'
+      end
+
+      it "should not get measure cell formatter if not specified" do
+        @olap.cube('Sales').member('[Measures].[Unit Sales]').cell_formatter.should be_nil
+      end
+
       it "should get measure format string" do
         @olap.cube('Sales').member('[Measures].[Unit Sales]').format_string.should == '#,##0'
       end
@@ -1373,6 +1496,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