rubiks 0.0.4 → 0.0.5

data/lib/rubiks/nodes/hierarchy.rb

@@ -4,15 +4,33 @@ require 'rubiks/nodes/level'
 module ::Rubiks
 
   class Hierarchy < ::Rubiks::AnnotatedNode
+    value :dimension, String
+    value :table, String
     child :levels, [::Rubiks::Level]
 
-    validates :levels_present
+    validates :levels_present, :dimension_present
 
     def self.new_from_hash(hash={})
-      new_instance = new('',[])
+      new_instance = new('','','',[])
       return new_instance.from_hash(hash)
     end
 
+    def dimension_present
+      errors << 'Dimension required on Hierarchy' if self.dimension.blank?
+    end
+
+    def parse_table(input_value)
+      return if input_value.nil?
+
+      self.table = input_value.to_s
+    end
+
+    def parse_dimension(dimension_value)
+      return if dimension_value.nil?
+
+      self.dimension = dimension_value.to_s
+    end
+
     def levels_present
       if self.levels.present?
         self.levels.each do |level|
@@ -29,6 +47,8 @@ module ::Rubiks
       working_hash.stringify_keys!
 
       parse_name(working_hash.delete('name'))
+      parse_table(working_hash.delete('table'))
+      parse_dimension(working_hash.delete('dimension'))
       parse_levels(working_hash.delete('levels'))
       return self
     end
@@ -45,11 +65,36 @@ module ::Rubiks
       hash = {}
 
       hash['name'] = self.name.to_s if self.name.present?
+      hash['table'] = self.table.to_s if self.table.present?
+      hash['dimension'] = self.dimension.to_s if self.dimension.present?
       hash['levels'] = self.levels.map(&:to_hash) if self.levels.present?
 
       return hash
     end
 
+    def to_xml(builder = nil)
+      builder = Builder::XmlMarkup.new(:indent => 2) if builder.nil?
+
+      attrs = Hash.new
+      attrs['name'] = self.name.titleize if self.name.present?
+      attrs['primaryKey'] = 'id'
+      attrs['hasAll'] = 'true'
+
+      builder.hierarchy(attrs) {
+        table_attrs = Hash.new
+        if self.table.present?
+          table_attrs['name'] = self.table
+        elsif self.dimension.present?
+          table_attrs['name'] = "view_#{dimension.tableize}"
+        end
+
+        builder.table(table_attrs)
+
+        self.levels.each do |level|
+          level.to_xml(builder)
+        end if self.levels.present?
+      }
+    end
   end
 
 end

data/lib/rubiks/nodes/level.rb

@@ -1,9 +1,20 @@
 require 'rubiks/nodes/annotated_node'
-require 'rubiks/nodes/hierarchy'
 
 module ::Rubiks
 
   class Level < ::Rubiks::AnnotatedNode
+    CARDINALITIES = %w[ low normal high ]
+    DATA_TYPES = %w[ String Integer Numeric Boolean Date Time Timestamp ]
+
+    value :cardinality, String
+    value :contiguous_value, Fixnum
+    value :sort_column, String
+    value :data_type, String
+    value :column, String
+    value :name_column, String
+
+    validates :cardinality_if_present, :data_type_if_present
+
     def self.new_from_hash(hash={})
       new_instance = new
       return new_instance.from_hash(hash)
@@ -14,16 +25,109 @@ module ::Rubiks
       working_hash.stringify_keys!
 
       parse_name(working_hash.delete('name'))
+      parse_name_column(working_hash.delete('name_column'))
+      parse_column(working_hash.delete('column'))
+      parse_data_type(working_hash.delete('data_type'))
+      parse_contiguous_value(working_hash.delete('contiguous'))
+      parse_cardinality(working_hash.delete('cardinality'))
+      parse_sort_column(working_hash.delete('sort'))
+      parse_sort_column(working_hash.delete('sorted'))
+      parse_sort_column(working_hash.delete('sort_column'))
       return self
     end
 
+    def parse_column(input_value)
+      return if input_value.nil?
+
+      self.column = input_value.to_s
+    end
+
+    def parse_name_column(input_value)
+      return if input_value.nil?
+
+      self.name_column = input_value.to_s
+    end
+
+    def parse_contiguous_value(input_value)
+      return if input_value.nil?
+
+      self.contiguous_value = !!input_value ? 1 : 0
+    end
+
+    def parse_sort_column(sort_column_value)
+      return if sort_column_value.nil?
+
+      if sort_column_value.kind_of?(::TrueClass)
+        self.sort_column = "#{self.name}_sort"
+
+      elsif sort_column_value.kind_of?(::String)
+        self.sort_column = sort_column_value
+      end
+    end
+
+    def data_type_if_present
+      if self.data_type.present? && !::Rubiks::Level::DATA_TYPES.include?(self.data_type)
+        errors << "DataType '#{self.data_type}' must be one of #{::Rubiks::Level::DATA_TYPES.join(', ')} on Level"
+      end
+    end
+
+    def parse_data_type(data_type_value)
+      return if data_type_value.nil?
+
+      self.data_type = data_type_value.to_s.capitalize
+    end
+
+    def cardinality_if_present
+      if self.cardinality.present? && !::Rubiks::Level::CARDINALITIES.include?(self.cardinality)
+        errors << "Cardinality '#{self.cardinality}' must be one of #{::Rubiks::Level::CARDINALITIES.join(', ')} on Level"
+      end
+    end
+
+    def parse_cardinality(cardinality_value)
+      return if cardinality_value.nil?
+
+      self.cardinality = cardinality_value.to_s
+    end
+
     def to_hash
       hash = {}
 
-      hash['name'] = self.name.to_s if self.name.present?
+      if self.name.present?
+        hash['name'] = self.name.to_s
+        hash['display_name'] = self.display_name
+      end
+      hash['contiguous'] = true if self.contiguous_value.present? && self.contiguous_value == 1
+      hash['cardinality'] = self.cardinality if self.cardinality.present?
+      hash['data_type'] = self.data_type if self.data_type.present?
+
+      if self.column.present?
+        hash['column'] = self.column
+      elsif self.name.present?
+        hash['column'] = self.name
+      end
 
       return hash
     end
+
+    def to_xml(builder = nil)
+      builder = Builder::XmlMarkup.new(:indent => 2) if builder.nil?
+
+      attrs = {}
+
+      if self.name.present?
+        attrs['name'] = self.display_name
+        attrs['column'] = self.column || self.name
+      end
+      attrs['type'] = self.data_type if self.data_type.present?
+      attrs['ordinalColumn'] = self.sort_column if self.sort_column.present?
+      attrs['nameColumn'] = self.name_column if self.name_column.present?
+
+      builder.level(attrs)
+    end
+
+    def to_json
+      MultiJson.dump(self.to_hash)
+    end
   end
 
 end

data/lib/rubiks/nodes/measure.rb

@@ -3,11 +3,11 @@ require 'rubiks/nodes/validated_node'
 module ::Rubiks
 
   class Measure < ::Rubiks::AnnotatedNode
-    value :column, String
     value :aggregator, String
+    value :column, String
     value :format_string, String
 
-    validates :column_present, :aggregator_present
+    validates :aggregator_present
 
     def self.new_from_hash(hash={})
       new_instance = new
@@ -28,26 +28,24 @@ module ::Rubiks
     def to_hash
       hash = {}
 
-      hash['name'] = self.name.to_s if self.name.present?
-      hash['column'] = self.column.to_s if self.column.present?
-      hash['aggregator'] = self.aggregator.to_s if self.aggregator.present?
-      hash['format_string'] = self.format_string.to_s if self.format_string.present?
+      hash['name'] = self.name if self.name.present?
+      hash['aggregator'] = self.aggregator if self.aggregator.present?
+      hash['format_string'] = self.format_string if self.format_string.present?
+      hash['column'] = self.column if self.column.present?
 
       return hash
     end
 
-    def column_present
-      errors << 'Column required on Measure' if self.column.blank?
+    def aggregator_present
+      errors << 'Aggregator required on Measure' if self.aggregator.blank?
     end
 
     def parse_column(column_value)
-      return if column_value.nil?
+      return if column_value.nil? && self.name.blank?
 
-      self.column = column_value.to_s
-    end
-
-    def aggregator_present
-      errors << 'Aggregator required on Measure' if self.aggregator.blank?
+      self.column = column_value.nil? ?
+                      self.name.underscore :
+                      column_value.to_s
     end
 
     def parse_aggregator(aggregator_value)
@@ -61,6 +59,17 @@ module ::Rubiks
 
       self.format_string = format_string_value.to_s
     end
+
+    def to_xml(builder = nil)
+      builder = Builder::XmlMarkup.new(:indent => 2) if builder.nil?
+
+      attrs = self.to_hash
+      attrs['name'] = self.display_name if self.name.present?
+      attrs.keys.each do |key|
+        attrs[key.camelize(:lower)] = attrs.delete(key)
+      end
+      builder.measure(attrs)
+    end
   end
 
 end

data/lib/rubiks/nodes/schema.rb

@@ -1,16 +1,17 @@
-require 'rubiks/nodes/validated_node'
+require 'rubiks/nodes/annotated_node'
 require 'rubiks/nodes/cube'
 require 'multi_json'
+require 'builder'
 
 module ::Rubiks
 
-  class Schema < ::Rubiks::ValidatedNode
+  class Schema < ::Rubiks::AnnotatedNode
     child :cubes, [::Rubiks::Cube]
 
     validates :cubes_present
 
     def self.new_from_hash(hash={})
-      new_instance = new([])
+      new_instance = new('',[])
       return new_instance.from_hash(hash)
     end
 
@@ -29,6 +30,8 @@ module ::Rubiks
       return self if working_hash.nil?
       working_hash.stringify_keys!
 
+      parse_name(working_hash.delete('name'))
+      self.name = 'default' if self.name.blank?
       parse_cubes(working_hash.delete('cubes'))
       return self
     end
@@ -44,17 +47,25 @@ module ::Rubiks
     def to_hash
       hash = {}
 
+      hash['name'] = self.name if self.name.present?
       hash['cubes'] = self.cubes.map(&:to_hash) if self.cubes.present?
 
       return hash
     end
 
-    def to_json
-      MultiJson.dump(to_hash)
-    end
+    def to_xml(builder = nil)
+      builder = Builder::XmlMarkup.new(:indent => 2) if builder.nil?
+
+      builder.instruct!
+
+      attrs = self.to_hash
+      attrs.delete('cubes')
 
-    def to_xml
-      to_hash.to_xml(:root => 'Schema')
+      builder.schema(attrs) {
+        self.cubes.each do |cube|
+          cube.to_xml(builder)
+        end
+      }
     end
   end
 

data/lib/rubiks/nodes/validated_node.rb

@@ -2,6 +2,38 @@ require 'rltk'
 require 'rltk/ast'
 
 module ::Rubiks
+
+  # == Rubiks ValidatedNode
+  #
+  # Provides a basic validation framework to ASTNodes.
+  #
+  # A minimal implementation could be:
+  #
+  #  class NamedNode < ::Rubiks::ValidatedNode
+  #    name :name, String
+  #
+  #    validates :name_present
+  #
+  #    def name_present
+  #      errors << "Name required on NamedNode" if self.name.blank?
+  #    end
+  #
+  #    def parse_name(name_value)
+  #      return if name_value.nil?
+  #
+  #      self.name = name_value.to_s
+  #    end
+  #  end
+  #
+  # Which provides you with the following behavior:
+  #
+  #   name_node = nameNode.new
+  #   name_node.valid?           # => false
+  #   name_node.errors           # => ["Name required on NamedNode"]
+  #
+  #   name_node.name = 7
+  #   name_node.valid?           # => true
+  #
   class ValidatedNode < ::RLTK::ASTNode
 
     class << self
@@ -44,4 +76,4 @@ module ::Rubiks
     end
 
   end
-end
+end

data/lib/rubiks/version.rb

@@ -1,3 +1,3 @@
 module ::Rubiks
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/rubiks.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Rubiks::VERSION
   gem.authors       = ['JohnnyT']
   gem.email         = ['johnnyt@moneydesktop.com']
-  gem.description   = %q{Define an OLAP schema}
-  gem.summary       = 'Rubiks is a Ruby gem that defines an OLAP schema and can output the schema as XML and JSON.'
+  gem.summary       = %q{A gem to provide translation of OLAP schemas}
+  gem.description   = %q{A gem to allow defining an OLAP schema from a hash and generate an XML schema for Mondrian}
   gem.homepage      = 'https://github.com/moneydesktop/rubiks'
 
   gem.files         = `git ls-files`.split($/)
@@ -20,4 +20,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'rltk'
   gem.add_dependency 'activesupport'
   gem.add_dependency 'builder'
+
+  # Check the Gemfile for test and development dependencies
 end

data/spec/examples/mondrian_docs_example_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+# This example is taken from the Mondrian documentation:
+# http://mondrian.pentaho.com/documentation/schema.php#Cubes_and_dimensions
+# then modified to use Rails/Rubiks conventions
+#
+# We want the output to be:
+#
+# <schema name="default">
+#   <cube name="Sales">
+#     <table name="view_sales"/>
+#
+#     <dimension name="Date" foreignKey="date_id">
+#       <hierarchy name="Year Quarter Month" primaryKey="id" hasAll="true">
+#         <table name="view_dates"/>
+#         <level name="Year" column="year"/>
+#         <level name="Quarter" column="quarter"/>
+#         <level name="Month" column="month"/>
+#       </hierarchy>
+#     </dimension>
+#
+#     <measure name="Unit Sales" column="unit_sales" aggregator="sum" formatString="#,###"/>
+#
+#     <calculatedMember name="Profit" dimension="Measures" formula="[Measures].[Store Sales] - [Measures].[Store Cost]">
+#       <calculatedMemberProperty name="FORMAT_STRING" value="$#,##0.00"/>
+#     </calculatedMember>
+#   </cube>
+# </schema>
+
+describe 'A Mondrian XML Schema' do
+  let(:described_class) { ::Rubiks::Schema }
+  let(:schema_hash) {
+    {
+      'cubes' => [{
+        'name' => 'sales',
+        'measures' => [
+          {
+            'name' => 'unit_sales',
+            'aggregator' => 'sum',
+            'format_string' => '#,###'
+          }
+        ],
+        'dimensions' => [
+          {
+            'name' => 'date',
+            'hierarchies' => [{
+              'name' => 'year_quarter_month',
+              'levels' => [
+                {
+                  'name' => 'year',
+                  'type' => 'numeric'
+                },
+                {
+                  'name' => 'quarter',
+                  'type' => 'string'
+                },
+                {
+                  'name' => 'month',
+                  'type' => 'numeric'
+                }
+              ]
+            }]
+          }
+        ],
+        'calculated_members' => [
+          {
+            'name' => 'Profit',
+            'dimension' => 'Measures',
+            'formula' => '[Measures].[Store Sales] - [Measures].[Store Cost]',
+            'format_string' => '$#,##0.00'
+          }
+        ]
+      }]
+    }
+  }
+
+  subject { described_class.new_from_hash(schema_hash) }
+
+  describe '#to_xml' do
+    it 'renders XML' do
+      subject.to_xml.should be_like <<-XML
+      <?xml version="1.0" encoding="UTF-8"?>
+
+      <schema name="default">
+        <cube name="Sales">
+          <table name="view_sales"/>
+
+          <dimension name="Date" foreignKey="date_id">
+            <hierarchy name="Year Quarter Month" primaryKey="id" hasAll="true">
+              <table name="view_dates"/>
+              <level name="Year" column="year"/>
+              <level name="Quarter" column="quarter"/>
+              <level name="Month" column="month"/>
+            </hierarchy>
+          </dimension>
+
+          <measure name="Unit Sales" aggregator="sum" formatString="#,###" column="unit_sales"/>
+
+          <calculatedMember name="Profit" dimension="Measures" formula="[Measures].[Store Sales] - [Measures].[Store Cost]">
+            <calculatedMemberProperty name="FORMAT_STRING" value="$#,##0.00"/>
+          </calculatedMember>
+        </cube>
+      </schema>
+      XML
+    end
+  end
+
+end

data/spec/examples/simple_mondrian_example_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+#  This schema is a valid XML schema for Mondrian
+#
+#  <?xml version="1.0" encoding="UTF-8"?>
+#  <schema name="default">
+#    <cube name="Transactions">
+#      <table name="view_transactions"/>
+#      <dimension name="Date" foreignKey="date_id">
+#        <hierarchy name="Year Quarter Month" primaryKey="id" hasAll="true">
+#          <table name="view_dates"/>
+#          <level name="Year" column="year"/>
+#          <level name="Quarter" column="quarter"/>
+#          <level name="Month" column="month"/>
+#        </hierarchy>
+#      </dimension>
+#      <measure name="Amount" column="amount" aggregator="sum" formatString="$#,###"/>
+#    </cube>
+#  </schema>
+
+describe 'A simple Mondrian XML Schema' do
+  let(:described_class) { ::Rubiks::Schema }
+  let(:schema_hash) {
+    {
+      'cubes' => [{
+        'name' => 'transactions',
+        'measures' => [
+          {
+            'name' => 'amount',
+            'aggregator' => 'sum',
+            'format_string' => '$#,###'
+          }
+        ],
+        'dimensions' => [
+          {
+            'name' => 'date',
+            'hierarchies' => [{
+              'name' => 'year_quarter_month',
+              'levels' => [
+                {
+                  'name' => 'year',
+                  'type' => 'numeric'
+                },
+                {
+                  'name' => 'quarter',
+                  'type' => 'numeric'
+                },
+                {
+                  'name' => 'month',
+                  'type' => 'numeric'
+                }
+              ]
+            }]
+          }
+        ]
+      }]
+    }
+  }
+
+  subject { described_class.new_from_hash(schema_hash) }
+
+  describe '#to_xml' do
+    it 'renders XML' do
+      subject.to_xml.should be_like <<-XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <schema name="default">
+          <cube name="Transactions">
+            <table name="view_transactions"/>
+            <dimension name="Date" foreignKey="date_id">
+              <hierarchy name="Year Quarter Month" primaryKey="id" hasAll="true">
+                <table name="view_dates"/>
+                <level name="Year" column="year"/>
+                <level name="Quarter" column="quarter"/>
+                <level name="Month" column="month"/>
+              </hierarchy>
+            </dimension>
+            <measure name="Amount" aggregator="sum" formatString="$#,###" column="amount"/>
+          </cube>
+        </schema>
+      XML
+    end
+  end
+
+end

data/spec/rubiks/nodes/calculated_member_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe ::Rubiks::CalculatedMember do
+  include_context 'schema_context'
+
+  subject { described_class.new_from_hash }
+
+  specify { subject.respond_to?(:from_hash) }
+  specify { subject.respond_to?(:to_hash) }
+  specify { subject.respond_to?(:dimension) }
+  specify { subject.respond_to?(:formula) }
+  specify { subject.respond_to?(:format_string) }
+
+  context 'when parsed from a valid hash' do
+    subject { described_class.new_from_hash(calculated_member_hash) }
+
+    it { should be_valid }
+
+    its(:to_hash) { should have_key('name') }
+    its(:to_hash) { should have_key('dimension') }
+    its(:to_hash) { should have_key('formula') }
+    its(:to_hash) { should have_key('format_string') }
+
+
+    describe '#to_xml' do
+      it 'renders a calculatedMember tag with attributes' do
+        subject.to_xml.should be_like <<-XML
+        <calculatedMember name="Fake Calculated Member" dimension="Fake Dimension" formula="fake_formula">
+          <calculatedMemberProperty name="FORMAT_STRING" value="$#,##0.00"/>
+        </calculatedMember>
+        XML
+      end
+    end
+  end
+
+  context 'when parsed from an invalid (empty) hash' do
+    subject { described_class.new_from_hash({}) }
+
+    it { should_not be_valid }
+
+    describe '#to_xml' do
+      it 'renders a calculatedMember tag' do
+        subject.to_xml.should be_like <<-XML
+        <calculatedMember>
+        </calculatedMember>
+        XML
+      end
+    end
+  end
+end