mondrian-olap 0.1.0

data/spec/rake_tasks.rb

@@ -0,0 +1,185 @@
+namespace :db do
+  task :require_spec_helper do
+    require File.expand_path("../spec_helper", __FILE__)
+  end
+
+  desc "Create test database tables"
+  task :create_tables => :require_spec_helper do
+    puts "==> Creating tables for test data"
+    ActiveRecord::Schema.define do
+
+      create_table :time, :force => true do |t|
+        t.datetime    :the_date
+        t.string      :the_day, :limit => 30
+        t.string      :the_month, :limit => 30
+        t.integer     :the_year
+        t.integer     :day_of_month
+        t.integer     :week_of_year
+        t.integer     :month_of_year
+        t.string      :quarter, :limit => 30
+      end
+
+      create_table :products, :force => true do |t|
+        t.integer     :product_class_id
+        t.string      :brand_name, :limit => 60
+        t.string      :product_name, :limit => 60
+      end
+
+      create_table :product_classes, :force => true do |t|
+        t.string      :product_subcategory, :limit => 30
+        t.string      :product_category, :limit => 30
+        t.string      :product_department, :limit => 30
+        t.string      :product_family, :limit => 30
+      end
+
+      create_table :customers, :force => true do |t|
+        t.string      :country, :limit => 30
+        t.string      :state_province, :limit => 30
+        t.string      :city, :limit => 30
+        t.string      :fname, :limit => 30
+        t.string      :lname, :limit => 30
+        t.string      :fullname, :limit => 60
+        t.string      :gender, :limit => 30
+      end
+
+      create_table :sales, :force => true, :id => false do |t|
+        t.integer     :product_id
+        t.integer     :time_id
+        t.integer     :customer_id
+        t.decimal     :store_sales, :precision => 10, :scale => 4
+        t.decimal     :store_cost, :precision => 10, :scale => 4
+        t.decimal     :unit_sales, :precision => 10, :scale => 4
+      end
+    end
+  end
+
+  task :define_models => :require_spec_helper do
+    class TimeDimension < ActiveRecord::Base
+      set_table_name "time"
+      validates_presence_of :the_date
+      before_create do
+        self.the_day = the_date.strftime("%A")
+        self.the_month = the_date.strftime("%B")
+        self.the_year = the_date.strftime("%Y").to_i
+        self.day_of_month = the_date.strftime("%d").to_i
+        self.week_of_year = the_date.strftime("%W").to_i
+        self.month_of_year = the_date.strftime("%m").to_i
+        self.quarter = "Q#{(month_of_year-1)/3+1}"
+      end
+    end
+    class Product < ActiveRecord::Base
+      belongs_to :product_class
+    end
+    class ProductClass < ActiveRecord::Base
+    end
+    class Customer < ActiveRecord::Base
+    end
+    class Sales < ActiveRecord::Base
+      set_table_name "sales"
+      belongs_to :time_by_day
+      belongs_to :product
+      belongs_to :customer
+    end
+  end
+
+  desc "Create test data"
+  task :create_data => [:create_tables, :create_time_data, :create_product_data, :create_customer_data, :create_sales_data]
+
+  task :create_time_data  => :define_models do
+    puts "==> Creating time dimension"
+    TimeDimension.delete_all
+    start_time = Time.local(2010,1,1)
+    (2*365).times do |i|
+      TimeDimension.create!(:the_date => start_time + i.day)
+    end
+  end
+
+  task :create_product_data => :define_models do
+    puts "==> Creating product data"
+    Product.delete_all
+    ProductClass.delete_all
+    families = ["Drink", "Food", "Non-Consumable"]
+    (1..100).each do |i|
+      product_class = ProductClass.create!(
+        :product_family => families[i % 3],
+        :product_department => "Department #{i}",
+        :product_category => "Category #{i}",
+        :product_subcategory => "Subcategory #{i}"
+      )
+      Product.create!(
+        :product_class_id => product_class.id,
+        :brand_name => "Brand #{i}",
+        :product_name => "Product #{i}"
+      )
+    end
+  end
+
+  task :create_customer_data => :define_models do
+    puts "==> Creating customer data"
+    Customer.delete_all
+    i = 0
+    [
+      ["Canada", "BC", "Burnaby"],["Canada", "BC", "Cliffside"],["Canada", "BC", "Haney"],["Canada", "BC", "Ladner"],
+      ["Canada", "BC", "Langford"],["Canada", "BC", "Langley"],["Canada", "BC", "Metchosin"],["Canada", "BC", "N. Vancouver"],
+      ["Canada", "BC", "Newton"],["Canada", "BC", "Oak Bay"],["Canada", "BC", "Port Hammond"],["Canada", "BC", "Richmond"],
+      ["Canada", "BC", "Royal Oak"],["Canada", "BC", "Shawnee"],["Canada", "BC", "Sooke"],["Canada", "BC", "Vancouver"],
+      ["Canada", "BC", "Victoria"],["Canada", "BC", "Westminster"],
+      ["Mexico", "DF", "San Andres"],["Mexico", "DF", "Santa Anita"],["Mexico", "DF", "Santa Fe"],["Mexico", "DF", "Tixapan"],
+      ["Mexico", "Guerrero", "Acapulco"],["Mexico", "Jalisco", "Guadalajara"],["Mexico", "Mexico", "Mexico City"],
+      ["Mexico", "Oaxaca", "Tlaxiaco"],["Mexico", "Sinaloa", "La Cruz"],["Mexico", "Veracruz", "Orizaba"],
+      ["Mexico", "Yucatan", "Merida"],["Mexico", "Zacatecas", "Camacho"],["Mexico", "Zacatecas", "Hidalgo"],
+      ["USA", "CA", "Altadena"],["USA", "CA", "Arcadia"],["USA", "CA", "Bellflower"],["USA", "CA", "Berkeley"],
+      ["USA", "CA", "Beverly Hills"],["USA", "CA", "Burbank"],["USA", "CA", "Burlingame"],["USA", "CA", "Chula Vista"],
+      ["USA", "CA", "Colma"],["USA", "CA", "Concord"],["USA", "CA", "Coronado"],["USA", "CA", "Daly City"],
+      ["USA", "CA", "Downey"],["USA", "CA", "El Cajon"],["USA", "CA", "Fremont"],["USA", "CA", "Glendale"],
+      ["USA", "CA", "Grossmont"],["USA", "CA", "Imperial Beach"],["USA", "CA", "La Jolla"],["USA", "CA", "La Mesa"],
+      ["USA", "CA", "Lakewood"],["USA", "CA", "Lemon Grove"],["USA", "CA", "Lincoln Acres"],["USA", "CA", "Long Beach"],
+      ["USA", "CA", "Los Angeles"],["USA", "CA", "Mill Valley"],["USA", "CA", "National City"],["USA", "CA", "Newport Beach"],
+      ["USA", "CA", "Novato"],["USA", "CA", "Oakland"],["USA", "CA", "Palo Alto"],["USA", "CA", "Pomona"],
+      ["USA", "CA", "Redwood City"],["USA", "CA", "Richmond"],["USA", "CA", "San Carlos"],["USA", "CA", "San Diego"],
+      ["USA", "CA", "San Francisco"],["USA", "CA", "San Gabriel"],["USA", "CA", "San Jose"],["USA", "CA", "Santa Cruz"],
+      ["USA", "CA", "Santa Monica"],["USA", "CA", "Spring Valley"],["USA", "CA", "Torrance"],["USA", "CA", "West Covina"],
+      ["USA", "CA", "Woodland Hills"],
+      ["USA", "OR", "Albany"],["USA", "OR", "Beaverton"],["USA", "OR", "Corvallis"],["USA", "OR", "Lake Oswego"],
+      ["USA", "OR", "Lebanon"],["USA", "OR", "Milwaukie"],["USA", "OR", "Oregon City"],["USA", "OR", "Portland"],
+      ["USA", "OR", "Salem"],["USA", "OR", "W. Linn"],["USA", "OR", "Woodburn"],
+      ["USA", "WA", "Anacortes"],["USA", "WA", "Ballard"],["USA", "WA", "Bellingham"],["USA", "WA", "Bremerton"],
+      ["USA", "WA", "Burien"],["USA", "WA", "Edmonds"],["USA", "WA", "Everett"],["USA", "WA", "Issaquah"],
+      ["USA", "WA", "Kirkland"],["USA", "WA", "Lynnwood"],["USA", "WA", "Marysville"],["USA", "WA", "Olympia"],
+      ["USA", "WA", "Port Orchard"],["USA", "WA", "Puyallup"],["USA", "WA", "Redmond"],["USA", "WA", "Renton"],
+      ["USA", "WA", "Seattle"],["USA", "WA", "Sedro Woolley"],["USA", "WA", "Spokane"],["USA", "WA", "Tacoma"],
+      ["USA", "WA", "Walla Walla"],["USA", "WA", "Yakima"]
+    ].each do |country, state, city|
+      i += 1
+      Customer.create!(
+        :country => country,
+        :state_province => state,
+        :city => city,
+        :fname => "First#{i}",
+        :lname => "Last#{i}",
+        :fullname => "First#{i} Last#{i}",
+        :gender => i % 2 == 0 ? "M" : "F"
+      )
+    end
+  end
+
+  task :create_sales_data => :define_models do
+    puts "==> Creating sales data"
+    Sales.delete_all
+    count = 100
+    products = Product.order("id").limit(count).all
+    times = TimeDimension.order("id").limit(count).all
+    customers = Customer.order("id").limit(count).all
+    count.times do |i|
+      Sales.create!(
+        :product_id => products[i].id,
+        :time_id => times[i].id,
+        :customer_id => customers[i].id,
+        :store_sales => BigDecimal("2#{i}.12"),
+        :store_cost => BigDecimal("1#{i}.1234"),
+        :unit_sales => i+1
+      )
+    end
+  end
+
+end

data/spec/schema_definition_spec.rb

@@ -0,0 +1,345 @@
+require "spec_helper"
+
+describe "Schema definition" do
+
+  describe "elements" do
+    before(:each) do
+      @schema = Mondrian::OLAP::Schema.new
+    end
+
+    describe "root element" do
+      it "should render to XML" do
+        @schema.to_xml.should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema/>
+        XML
+      end
+
+      it "should render to XML with attributes" do
+        @schema.define('FoodMart') do
+          description 'Demo "FoodMart" schema'
+        end
+        @schema.to_xml.should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema description="Demo &quot;FoodMart&quot; schema" name="FoodMart"/>
+        XML
+      end
+
+      it "should render to XML using class method" do
+        schema = Mondrian::OLAP::Schema.define('FoodMart')
+        schema.to_xml.should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema name="FoodMart"/>
+        XML
+      end
+    end
+
+    describe "Cube" do
+      it "should render to XML" do
+        @schema.define do
+          cube 'Sales' do
+            default_measure 'Unit Sales'
+            description 'Sales cube'
+            cache false
+            enabled true
+          end
+        end
+        @schema.to_xml.should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema name="default">
+          <Cube cache="false" defaultMeasure="Unit Sales" description="Sales cube" enabled="true" name="Sales"/>
+        </Schema>
+        XML
+      end
+
+      it "should render to XML using options hash" do
+        @schema.define do
+          cube 'Sales', :default_measure => 'Unit Sales',
+            :description => 'Sales cube', :cache => false, :enabled => true
+        end
+        @schema.to_xml.should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema name="default">
+          <Cube cache="false" defaultMeasure="Unit Sales" description="Sales cube" enabled="true" name="Sales"/>
+        </Schema>
+        XML
+      end
+    end
+
+    describe "Table" do
+      it "should render to XML" do
+        @schema.define do
+          cube 'Sales' do
+            table 'sales_fact', :alias => 'sales'
+          end
+        end
+        @schema.to_xml.should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema name="default">
+          <Cube name="Sales">
+            <Table alias="sales" name="sales_fact"/>
+          </Cube>
+        </Schema>
+        XML
+      end
+
+      it "should render table name in uppercase when using Oracle driver" do
+        @schema.define do
+          cube 'Sales' do
+            table 'sales_fact', :alias => 'sales'
+          end
+        end
+        @schema.to_xml(:driver => 'oracle').should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema name="default">
+          <Cube name="Sales">
+            <Table alias="SALES" name="SALES_FACT"/>
+          </Cube>
+        </Schema>
+        XML
+      end
+    end
+
+    describe "Dimension" do
+      it "should render to XML" do
+        @schema.define do
+          cube 'Sales' do
+            dimension 'Gender' do
+              foreign_key 'customer_id'
+              hierarchy do
+                has_all true
+                all_member_name 'All Genders'
+                primary_key 'customer_id'
+                table 'customer'
+                level 'Gender', :column => 'gender', :unique_members => true
+              end
+            end
+          end
+        end
+        @schema.to_xml.should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema name="default">
+          <Cube name="Sales">
+            <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"/>
+              </Hierarchy>
+            </Dimension>
+          </Cube>
+        </Schema>
+        XML
+      end
+
+      it "should render time dimension" do
+        @schema.define do
+          cube 'Sales' do
+            dimension 'Time' do
+              foreign_key 'time_id'
+              hierarchy do
+                has_all false
+                primary_key 'time_id'
+                table 'time_by_day'
+                level 'Year', :column => 'the_year', :type => 'Numeric', :unique_members => true
+                level 'Quarter', :column => 'quarter', :unique_members => false
+                level 'Month', :column => 'month_of_year', :type => 'Numeric', :unique_members => false
+              end
+            end
+          end
+        end
+        @schema.to_xml.should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema name="default">
+          <Cube name="Sales">
+            <Dimension foreignKey="time_id" name="Time">
+              <Hierarchy hasAll="false" primaryKey="time_id">
+                <Table name="time_by_day"/>
+                <Level column="the_year" name="Year" type="Numeric" uniqueMembers="true"/>
+                <Level column="quarter" name="Quarter" uniqueMembers="false"/>
+                <Level column="month_of_year" name="Month" type="Numeric" uniqueMembers="false"/>
+              </Hierarchy>
+            </Dimension>
+          </Cube>
+        </Schema>
+        XML
+      end
+
+      it "should render dimension hierarchy with join" do
+        @schema.define do
+          cube 'Sales' do
+            dimension 'Products', :foreign_key => 'product_id' do
+              hierarchy :has_all => true, :all_member_name => 'All Products',
+                        :primary_key => 'product_id', :primary_key_table => 'product' do
+                join :left_key => 'product_class_id', :right_key => 'product_class_id' do
+                  table 'product'
+                  table 'product_class'
+                end
+                level 'Product Family', :table => 'product_class', :column => 'product_family', :unique_members => true
+                level 'Brand Name', :table => 'product', :column => 'brand_name', :unique_members => false
+                level 'Product Name', :table => 'product', :column => 'product_name', :unique_members => true
+              end
+            end
+          end
+        end
+        @schema.to_xml.should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema name="default">
+          <Cube name="Sales">
+            <Dimension foreignKey="product_id" name="Products">
+              <Hierarchy allMemberName="All Products" hasAll="true" primaryKey="product_id" primaryKeyTable="product">
+                <Join leftKey="product_class_id" rightKey="product_class_id">
+                  <Table name="product"/>
+                  <Table name="product_class"/>
+                </Join>
+                <Level column="product_family" name="Product Family" table="product_class" uniqueMembers="true"/>
+                <Level column="brand_name" name="Brand Name" table="product" uniqueMembers="false"/>
+                <Level column="product_name" name="Product Name" table="product" uniqueMembers="true"/>
+              </Hierarchy>
+            </Dimension>
+          </Cube>
+        </Schema>
+        XML
+      end
+
+      it "should render table and column names in uppercase when using Oracle driver" do
+        @schema.define do
+          cube 'Sales' do
+            dimension 'Products', :foreign_key => 'product_id' do
+              hierarchy :has_all => true, :all_member_name => 'All Products',
+                        :primary_key => 'product_id', :primary_key_table => 'product' do
+                join :left_key => 'product_class_id', :right_key => 'product_class_id' do
+                  table 'product'
+                  table 'product_class'
+                end
+                level 'Product Family', :table => 'product_class', :column => 'product_family', :unique_members => true
+                level 'Brand Name', :table => 'product', :column => 'brand_name', :unique_members => false
+                level 'Product Name', :table => 'product', :column => 'product_name', :unique_members => true
+              end
+            end
+          end
+        end
+        @schema.to_xml(:driver => 'oracle').should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema name="default">
+          <Cube name="Sales">
+            <Dimension foreignKey="PRODUCT_ID" name="Products">
+              <Hierarchy allMemberName="All Products" hasAll="true" primaryKey="PRODUCT_ID" primaryKeyTable="PRODUCT">
+                <Join leftKey="PRODUCT_CLASS_ID" rightKey="PRODUCT_CLASS_ID">
+                  <Table name="PRODUCT"/>
+                  <Table name="PRODUCT_CLASS"/>
+                </Join>
+                <Level column="PRODUCT_FAMILY" name="Product Family" table="PRODUCT_CLASS" uniqueMembers="true"/>
+                <Level column="BRAND_NAME" name="Brand Name" table="PRODUCT" uniqueMembers="false"/>
+                <Level column="PRODUCT_NAME" name="Product Name" table="PRODUCT" uniqueMembers="true"/>
+              </Hierarchy>
+            </Dimension>
+          </Cube>
+        </Schema>
+        XML
+      end
+
+    end
+
+    describe "Measure" do
+      it "should render XML" do
+        @schema.define do
+          cube 'Sales' do
+            measure 'Unit Sales' do
+              column 'unit_sales'
+              aggregator 'sum'
+            end
+          end
+        end
+        @schema.to_xml.should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema name="default">
+          <Cube name="Sales">
+            <Measure aggregator="sum" column="unit_sales" name="Unit Sales"/>
+          </Cube>
+        </Schema>
+        XML
+      end
+
+      it "should render column name in uppercase when using Oracle driver" do
+        @schema.define do
+          cube 'Sales' do
+            measure 'Unit Sales' do
+              column 'unit_sales'
+              aggregator 'sum'
+            end
+          end
+        end
+        @schema.to_xml(:driver => 'oracle').should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema name="default">
+          <Cube name="Sales">
+            <Measure aggregator="sum" column="UNIT_SALES" name="Unit Sales"/>
+          </Cube>
+        </Schema>
+        XML
+      end
+    end
+
+    describe "Calculated Member" do
+      it "should render XML" do
+        @schema.define do
+          cube 'Sales' do
+            calculated_member 'Profit' do
+              dimension 'Measures'
+              formula '[Measures].[Store Sales] - [Measures].[Store Cost]'
+            end
+          end
+        end
+        @schema.to_xml.should be_like <<-XML
+        <?xml version="1.0"?>
+        <Schema name="default">
+          <Cube name="Sales">
+            <CalculatedMember dimension="Measures" formula="[Measures].[Store Sales] - [Measures].[Store Cost]" name="Profit"/>
+          </Cube>
+        </Schema>
+        XML
+      end
+    end
+  end
+
+  describe "connection with schema" do
+    before(:all) do
+      @schema = Mondrian::OLAP::Schema.define do
+        cube 'Sales' do
+          table 'sales'
+          dimension 'Gender', :foreign_key => 'customer_id' do
+            hierarchy :has_all => true, :primary_key => 'id' do
+              table 'customers'
+              level 'Gender', :column => 'gender', :unique_members => true
+            end
+          end
+          dimension 'Time', :foreign_key => 'time_id' do
+            hierarchy :has_all => false, :primary_key => 'id' do
+              table 'time'
+              level 'Year', :column => 'the_year', :type => 'Numeric', :unique_members => true
+              level 'Quarter', :column => 'quarter', :unique_members => false
+              level 'Month', :column => 'month_of_year', :type => 'Numeric', :unique_members => false
+            end
+          end
+          measure 'Unit Sales', :column => 'unit_sales', :aggregator => 'sum'
+          measure 'Store Sales', :column => 'store_sales', :aggregator => 'sum'
+        end
+      end
+      @olap = Mondrian::OLAP::Connection.create(CONNECTION_PARAMS.merge :schema => @schema)
+    end
+
+    it "should connect" do
+      @olap.should be_connected
+    end
+
+    it "should execute query" do
+      @olap.from('Sales').
+        columns('[Measures].[Unit Sales]', '[Measures].[Store Sales]').
+        rows('descendants([Time].[2010].[Q1])').
+        where('[Gender].[F]').
+        execute.should be_a(Mondrian::OLAP::Result)
+    end
+
+  end
+
+end