mondrian 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.rspec

@@ -0,0 +1,4 @@
+--colour
+--format d
+--profile
+--backtrace

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mondrian.gemspec
+gemspec
+
+
+group :test, :development do
+  gem 'guard'
+  gem 'rspec'
+  gem 'pry'
+  gem 'equivalent-xml'
+  gem 'rb-fsevent'
+  gem 'mocha'
+  gem 'bourne'
+  gem 'guard-rspec'
+  gem 'linecache19',       '>= 0.5.13'
+  gem 'ruby-debug-base19', '>= 0.11.26'
+  gem 'ruby-debug19', :require => 'ruby-debug'
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :all_on_start => true, :all_after_pass => true do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Scott Ellard,  2010-2011 Raimonds Simanovskis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# Mondrian
+
+A ruby DSL based off of https://github.com/rsim/mondrian-olap.
+
+This gem only consists of the schema definition and not the olap server
+itself. It is not dependent on jruby. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mondrian'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mondrian
+
+## Usage
+
+### Schema definition
+
+At first you need to define OLAP schema mapping to relational database schema tables and columns. OLAP schema consists of:
+
+* Cubes
+
+  Multidimensional cube is a collection of measures that can be accessed by dimensions. In relational database cubes are stored in fact tables with measure columns and dimension foreign key columns.
+
+* Dimensions
+
+  Dimension can be used in one cube (private) or in many cubes (shared). In relational database dimensions are stored in dimension tables.
+
+* Hierarchies and levels
+
+  Dimension has at least one primary hierarchy and optional additional hierarchies and each hierarchy has one or more levels. In relational database all levels can be stored in the same dimension table as different columns or can be stored also in several tables.
+
+* Members
+
+  Dimension hierarchy level values are called members.
+
+* Measures
+
+  Measures are values which can be accessed at detailed level or aggregated (e.g. as sum or average) at higher dimension hierarchy levels. In relational database measures are stored as columns in cube table.
+
+* Calculated measures
+
+  Calculated measures are not stored in database but calculated using specified formula from other measures.
+
+Read more about about [defining Mondrian OLAP schema](http://mondrian.pentaho.com/documentation/schema.php).
+
+Here is example how to define OLAP schema and its mapping to relational database tables and columns using mondrian-olap:
+
+    require "rubygems"
+    require "mondrian"
+
+    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
+            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
+          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
+              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
+          end
+        end
+        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'
+          end
+          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 => 'weak_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'
+      end
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/mondrian.rb

@@ -0,0 +1,6 @@
+require "mondrian/version"
+require "mondrian/schema"
+
+module Mondrian
+
+end

data/lib/mondrian/schema.rb

@@ -0,0 +1,297 @@
+require 'mondrian/schema_element'
+
+module Mondrian
+  # See http://mondrian.pentaho.com/documentation/schema.php for more detailed description
+  # of Mondrian Schema elements.
+  class Schema < SchemaElement
+    def initialize(name = nil, attributes = {}, &block)
+      name, attributes = self.class.pre_process_arguments(name, attributes)
+      pre_process_attributes(attributes)
+      super(name, attributes, &block)
+    end
+
+    def self.define(name = nil, attributes = {}, &block)
+      name, attributes = pre_process_arguments(name, attributes)
+      new(name || 'default', attributes, &block)
+    end
+
+    def define(name = nil, attributes = {}, &block)
+      name, attributes = self.class.pre_process_arguments(name, attributes)
+      pre_process_attributes(attributes)
+      @attributes[:name] = name || @attributes[:name] || 'default' # otherwise connection with empty name fails
+      instance_eval &block if block
+      self
+    end
+
+    def include_schema(shared_schema)
+      shared_schema.class.elements.each do |element|
+        instance_variable_get("@#{pluralize(element)}").concat shared_schema.send(pluralize(element))
+      end
+    end
+
+    private
+
+    def self.pre_process_arguments(name, attributes)
+      # if is called just with attributes hash and without name
+      if name.is_a?(Hash) && attributes.empty?
+        attributes = name
+        name = nil
+      end
+      [name, attributes]
+    end
+
+    def pre_process_attributes(attributes)
+      unless attributes[:upcase_data_dictionary].nil?
+        @upcase_data_dictionary = attributes.delete(:upcase_data_dictionary)
+      end
+    end
+
+    public
+
+    attributes :name, :description
+    elements :cube
+
+    class Cube < SchemaElement
+      attributes :name, :description,
+        # The name of the measure that would be taken as the default measure of the cube.
+        :default_measure,
+        # Should the Fact table data for this Cube be cached by Mondrian or not.
+        # The default action is to cache the data.
+        :cache,
+        # Whether element is enabled - if true, then the Cube is realized otherwise it is ignored.
+        :enabled
+      elements :table, :view, :dimension, :measure, :calculated_member
+    end
+
+    class Table < SchemaElement
+      attributes :name, :schema, # Optional qualifier for table.
+        # Alias to be used with this table when it is used to form queries.
+        # If not specified, defaults to the table name, but in any case, must be unique within the schema.
+        # (You can use the same table in different hierarchies, but it must have different aliases.)
+        :alias
+      data_dictionary_names :name, :schema, :alias # values in XML will be uppercased when using Oracle driver
+      elements :agg_exclude, :agg_name, :agg_pattern, :sql
+    end
+
+    class View < SchemaElement
+      attributes :alias
+      data_dictionary_names :alias
+      # Defines a "table" using SQL query which can have different variants for different underlying databases
+      elements :sql
+    end
+
+    class Dimension < SchemaElement
+      attributes :name, :description,
+        # The dimension's type may be one of "Standard" or "Time".
+        # A time dimension will allow the use of the MDX time functions (WTD, YTD, QTD, etc.).
+        # Use a standard dimension if the dimension is not a time-related dimension.
+        # The default value is "Standard".
+        :type,
+        # The name of the column in the fact table which joins to the leaf level of this dimension.
+        # Required in a private Dimension or a DimensionUsage, but not in a public Dimension.
+        :foreign_key
+      data_dictionary_names :foreign_key # values in XML will be uppercased when using Oracle driver
+      elements :hierarchy
+    end
+
+    class Hierarchy < SchemaElement
+      attributes :name, :description,
+        # Whether this hierarchy has an 'all' member.
+        :has_all,
+        # Name of the 'all' member. If this attribute is not specified,
+        # the all member is named 'All hierarchyName', for example, 'All Store'.
+        :all_member_name,
+        # Name of the 'all' level. If this attribute is not specified,
+        # the all member is named '(All)'.
+        :all_level_name,
+        # The name of the column which identifies members, and which is referenced by rows in the fact table.
+        # If not specified, the key of the lowest level is used. See also Dimension foreign_key.
+        :primary_key,
+        # The name of the table which contains primary_key.
+        # If the hierarchy has only one table, defaults to that; it is required.
+        :primary_key_table,
+        # Should be set to the level (if such a level exists) at which depth it is known
+        # that all members have entirely unique rows, allowing SQL GROUP BY clauses to be completely eliminated from the query.
+        :unique_key_level_name
+      data_dictionary_names :primary_key, :primary_key_table # values in XML will be uppercased when using Oracle driver
+      elements :table, :join, :property, :level
+    end
+
+    class Join < SchemaElement
+      attributes :left_key, :right_key, :left_alias, :right_alias
+      data_dictionary_names :left_key, :right_key, :left_alias, :right_alias # values in XML will be uppercased when using Oracle driver
+      elements :table, :join
+    end
+
+    class Level < SchemaElement
+      attributes :name, :description,
+        # The name of the table that the column comes from.
+        # If this hierarchy is based upon just one table, defaults to the name of that table;
+        # otherwise, it is required.
+        :table,
+        # The name of the column which holds the unique identifier of this level.
+        :column,
+        # The name of the column which holds the user identifier of this level.
+        :name_column,
+        # The name of the column which holds member ordinals.
+        # If this column is not specified, the key column is used for ordering.
+        :ordinal_column,
+        # The name of the column which references the parent member in a parent-child hierarchy.
+        :parent_column,
+        # Value which identifies null parents in a parent-child hierarchy.
+        # Typical values are 'NULL' and '0'.
+        :null_parent_value,
+        # Indicates the type of this level's key column:
+        # String, Numeric, Integer, Boolean, Date, Time or Timestamp.
+        # When generating SQL statements, Mondrian encloses values for String columns in quotation marks,
+        # but leaves values for Integer and Numeric columns un-quoted.
+        # Date, Time, and Timestamp values are quoted according to the SQL dialect.
+        # For a SQL-compliant dialect, the values appear prefixed by their typename, 
+        # for example, "DATE '2006-06-01'".
+        # Default value: 'String'
+        :type,
+        # Whether members are unique across all parents. 
+        # For example, zipcodes are unique across all states.
+        # The first level's members are always unique.
+        # Default value: false
+        :unique_members,
+        # Whether this is a regular or a time-related level.
+        # The value makes a difference to time-related functions such as YTD (year-to-date).
+        # Default value: 'Regular'
+        :level_type,
+        # Condition which determines whether a member of this level is hidden.
+        # If a hierarchy has one or more levels with hidden members,
+        # then it is possible that not all leaf members are the same distance from the root,
+        # and it is termed a ragged hierarchy.
+        # Allowable values are: Never (a member always appears; the default);
+        # IfBlankName (a member doesn't appear if its name is null, empty or all whitespace);
+        # and IfParentsName (a member appears unless its name matches the parent's.
+        # Default value: 'Never'
+        :hide_member_if
+      data_dictionary_names :table, :column, :name_column, :ordinal_column, :parent_column # values in XML will be uppercased when using Oracle driver
+      elements :key_expression, :name_expression, :ordinal_expression, :member_formatter, :property
+    end
+
+    class KeyExpression < SchemaElement
+      elements :sql
+    end
+
+    class NameExpression < SchemaElement
+      elements :sql
+    end
+
+    class OrdinalExpression < SchemaElement
+      elements :sql
+    end
+
+    class Sql < SchemaElement
+      def self.name
+        'SQL'
+      end
+      attributes :dialect
+      content :text
+    end
+
+    class Property < SchemaElement
+      attributes :name, :description,
+        :column,
+        # Data type of this property: String, Numeric, Integer, Boolean, Date, Time or Timestamp.
+        :type,
+        # Should be set to true if the value of the property is functionally dependent on the level value.
+        # This permits the associated property column to be omitted from the GROUP BY clause
+        # (if the database permits columns in the SELECT that are not in the GROUP BY).
+        # This can be a significant performance enhancement on some databases, such as MySQL.
+        :depends_on_level_value
+      elements :property_formatter
+    end
+
+    class Measure < SchemaElement
+      attributes :name, :description,
+        # Column which is source of this measure's values.
+        # If not specified, a measure expression must be specified.
+        :column,
+        # The datatype of this measure: String, Numeric, Integer, Boolean, Date, Time or Timestamp.
+        # The default datatype of a measure is 'Integer' if the measure's aggregator is 'Count', otherwise it is 'Numeric'.
+        :datatype,
+        # Aggregation function. Allowed values are "sum", "count", "min", "max", "avg", and "distinct-count".
+        :aggregator,
+        # Format string with which to format cells of this measure. For more details, see the mondrian.util.Format class.
+        :format_string,
+        # Whether this member is visible in the user-interface. Default true.
+        :visible
+      data_dictionary_names :column # values in XML will be uppercased when using Oracle driver
+      elements :measure_expression, :cell_formatter
+    end
+
+    class MeasureExpression < SchemaElement
+      elements :sql
+    end
+
+    class CalculatedMember < SchemaElement
+      attributes :name, :description,
+        # Name of the dimension which this member belongs to.
+        :dimension,
+        # 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.
+        :visible
+      elements :formula, :calculated_member_property, :cell_formatter
+    end
+
+    class Formula < SchemaElement
+      content :text
+    end
+
+    class CalculatedMemberProperty < SchemaElement
+      attributes :name, :description,
+        # MDX expression which defines the value of this property. If the expression is a constant string, you could enclose it in quotes,
+        # or just specify the 'value' attribute instead.
+        :expression,
+        # Value of this property. If the value is not constant, specify the 'expression' attribute instead.
+        :value
+    end
+
+    class AggName < SchemaElement
+      attributes :name
+      data_dictionary_names :name
+      elements :agg_fact_count, :agg_measure, :agg_level, :agg_foreign_key
+    end
+
+    class AggFactCount < SchemaElement
+      attributes :column
+      data_dictionary_names :column
+    end
+
+    class AggMeasure < SchemaElement
+      attributes :name, :column
+      data_dictionary_names :column
+    end
+
+    class AggLevel < SchemaElement
+      attributes :name, :column
+      data_dictionary_names :column
+    end
+
+    class AggForeignKey < SchemaElement
+      attributes :fact_column, :agg_column
+      data_dictionary_names :fact_column, :agg_column
+    end
+
+    class AggIgnoreColumn < SchemaElement
+      attributes :column
+      data_dictionary_names :column
+    end
+
+    class AggPattern < SchemaElement
+      attributes :pattern
+      data_dictionary_names :pattern
+      elements :agg_fact_count, :agg_measure, :agg_level, :agg_foreign_key, :agg_exclude
+    end
+
+    class AggExclude < SchemaElement
+      attributes :name, :pattern, :ignorecase
+      data_dictionary_names :name, :pattern
+    end
+
+  end
+end