rubiks 0.0.3 → 0.0.4

data/.rspec

@@ -0,0 +1,4 @@
+--order rand
+--colour
+--tty
+--require rspec/pride --format RSpec::Pride

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - '1.9.2'
+notifications:
+  email: false

data/Gemfile

@@ -1,4 +1,19 @@
-source 'https://rubygems.org'
+source 'http://rubygems.org'
 
-# Specify your gem's dependencies in rubiks.gemspec
+# rubiks.gemspec defines the runtime dependencies
 gemspec
+
+# Test and development dependencies are defined here
+# so CI can include just test dependencies
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'rspec-pride'
+end
+
+group :development do
+  gem 'awesome_print'
+  gem 'pry'
+  gem 'pry-nav'
+  gem 'simplecov'
+end

data/Guardfile

@@ -1,5 +1,5 @@
-guard 'minitest' do
-  watch(%r|^test/(.*)\/?test_(.*)\.rb|)
-  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
-  watch(%r|^test/test_helper\.rb|)    { "test" }
+guard 'rspec' 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.txt

@@ -1,4 +1,4 @@
-Copyright 2012 MoneyDesktop Inc.
+Copyright 2013 MoneyDesktop Inc.
 Copyright Rubiks contributors https://github.com/moneydesktop/rubiks/contributors
 
 MIT License

data/README.md

@@ -1,13 +1,18 @@
 # Rubiks
 
-A Ruby OLAP Cube layer.
+[![Gem Version](https://badge.fury.io/rb/rubiks.png)](http://badge.fury.io/rb/rubiks)
+[![Build Status](https://secure.travis-ci.org/moneydesktop/rubiks.png?branch=master)](https://travis-ci.org/moneydesktop/rubiks)
+[![Code Climate](https://codeclimate.com/github/moneydesktop/rubiks.png)](https://codeclimate.com/github/moneydesktop/rubiks)
 
-## Usage
+Rubiks is a Ruby gem that defines an OLAP schema with `#to_xml` to generate a Mondrian XML schema and `#to_json` for everything else.
 
-Add this line to your application's Gemfile:
+## Installation
 
-    gem 'rubiks'
+Run `gem install rubiks` to install the gem on its own.
+
+Or you can add the following to your Gemfile and run the `bundle` command to install it.
 
+    gem 'rubiks'
 
 ## Contributing
 

data/Rakefile

@@ -1,10 +1,5 @@
-require 'bundler/gem_tasks'
-require 'rake'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new do |t|
-  t.pattern = 'test/**/test_*.rb'
-  t.libs.push 'test'
-end
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec

data/lib/rubiks/nodes/annotated_node.rb

@@ -0,0 +1,20 @@
+require 'rubiks/nodes/validated_node'
+
+module ::Rubiks
+  class AnnotatedNode < ::Rubiks::ValidatedNode
+    value :name, String
+
+    validates :name_present
+
+    def name_present
+      errors << "Name required on #{self.class.name.split('::').last}" if self.name.blank?
+    end
+
+    def parse_name(name_value)
+      return if name_value.nil?
+
+      self.name = name_value.to_s
+    end
+
+  end
+end

data/lib/rubiks/nodes/cube.rb

@@ -0,0 +1,77 @@
+require 'rubiks/nodes/annotated_node'
+require 'rubiks/nodes/dimension'
+require 'rubiks/nodes/measure'
+
+module ::Rubiks
+
+  class Cube < ::Rubiks::AnnotatedNode
+    child :dimensions, [::Rubiks::Dimension]
+    child :measures, [::Rubiks::Measure]
+
+    validates :dimensions_present, :measures_present
+
+    def self.new_from_hash(hash={})
+      new_instance = new('',[],[])
+      return new_instance.from_hash(hash)
+    end
+
+    def from_hash(working_hash)
+      return self if working_hash.nil?
+      working_hash.stringify_keys!
+
+      parse_name(working_hash.delete('name'))
+      parse_dimensions(working_hash.delete('dimensions'))
+      parse_measures(working_hash.delete('measures'))
+      return self
+    end
+
+    def measures_present
+      if self.measures.present?
+        self.measures.each do |measure|
+          measure.validate
+          errors.push(*measure.errors)
+        end
+      else
+        errors << 'Measures Required for Cube'
+      end
+    end
+
+    def parse_measures(measures_array)
+      return if measures_array.nil? || measures_array.empty?
+
+      measures_array.each do |measure_hash|
+        self.measures << ::Rubiks::Measure.new_from_hash(measure_hash)
+      end
+    end
+
+    def dimensions_present
+      if self.dimensions.present?
+        self.dimensions.each do |dimension|
+          dimension.validate
+          errors.push(*dimension.errors)
+        end
+      else
+        errors << 'Dimensions Required for Cube'
+      end
+    end
+
+    def parse_dimensions(dimensions_array)
+      return if dimensions_array.nil? || dimensions_array.empty?
+
+      dimensions_array.each do |dimension_hash|
+        self.dimensions << ::Rubiks::Dimension.new_from_hash(dimension_hash)
+      end
+    end
+
+    def to_hash
+      hash = {}
+
+      hash['name'] = self.name.to_s if self.name.present?
+      hash['dimensions'] = self.dimensions.map(&:to_hash) if self.dimensions.present?
+      hash['measures'] = self.measures.map(&:to_hash) if self.measures.present?
+
+      return hash
+    end
+  end
+
+end

data/lib/rubiks/nodes/dimension.rb

@@ -0,0 +1,54 @@
+require 'rubiks/nodes/validated_node'
+require 'rubiks/nodes/hierarchy'
+
+module ::Rubiks
+
+  class Dimension < ::Rubiks::AnnotatedNode
+    child :hierarchies, [::Rubiks::Hierarchy]
+
+    validates :hierarchies_present
+
+    def self.new_from_hash(hash={})
+      new_instance = new('',[])
+      return new_instance.from_hash(hash)
+    end
+
+    def hierarchies_present
+      if self.hierarchies.present?
+        self.hierarchies.each do |hierarchy|
+          hierarchy.validate
+          errors.push(*hierarchy.errors)
+        end
+      else
+        errors << 'Hierarchies Required for Dimension'
+      end
+    end
+
+    def from_hash(working_hash)
+      return self if working_hash.nil?
+      working_hash.stringify_keys!
+
+      parse_name(working_hash.delete('name'))
+      parse_hierarchies(working_hash.delete('hierarchies'))
+      return self
+    end
+
+    def parse_hierarchies(hierarchies_array)
+      return if hierarchies_array.nil? || hierarchies_array.empty?
+
+      hierarchies_array.each do |hierarchy_hash|
+        self.hierarchies << ::Rubiks::Hierarchy.new_from_hash(hierarchy_hash)
+      end
+    end
+
+    def to_hash
+      hash = {}
+
+      hash['name'] = self.name.to_s if self.name.present?
+      hash['hierarchies'] = self.hierarchies.map(&:to_hash) if self.hierarchies.present?
+
+      return hash
+    end
+  end
+
+end

data/lib/rubiks/nodes/hierarchy.rb

@@ -0,0 +1,55 @@
+require 'rubiks/nodes/annotated_node'
+require 'rubiks/nodes/level'
+
+module ::Rubiks
+
+  class Hierarchy < ::Rubiks::AnnotatedNode
+    child :levels, [::Rubiks::Level]
+
+    validates :levels_present
+
+    def self.new_from_hash(hash={})
+      new_instance = new('',[])
+      return new_instance.from_hash(hash)
+    end
+
+    def levels_present
+      if self.levels.present?
+        self.levels.each do |level|
+          level.validate
+          errors.push(*level.errors)
+        end
+      else
+        errors << 'Levels Required for Hierarchy'
+      end
+    end
+
+    def from_hash(working_hash)
+      return self if working_hash.nil?
+      working_hash.stringify_keys!
+
+      parse_name(working_hash.delete('name'))
+      parse_levels(working_hash.delete('levels'))
+      return self
+    end
+
+    def parse_levels(levels_array)
+      return if levels_array.nil? || levels_array.empty?
+
+      levels_array.each do |level_hash|
+        self.levels << ::Rubiks::Level.new_from_hash(level_hash)
+      end
+    end
+
+    def to_hash
+      hash = {}
+
+      hash['name'] = self.name.to_s if self.name.present?
+      hash['levels'] = self.levels.map(&:to_hash) if self.levels.present?
+
+      return hash
+    end
+
+  end
+
+end

data/lib/rubiks/nodes/level.rb

@@ -0,0 +1,29 @@
+require 'rubiks/nodes/annotated_node'
+require 'rubiks/nodes/hierarchy'
+
+module ::Rubiks
+
+  class Level < ::Rubiks::AnnotatedNode
+    def self.new_from_hash(hash={})
+      new_instance = new
+      return new_instance.from_hash(hash)
+    end
+
+    def from_hash(working_hash)
+      return self if working_hash.nil?
+      working_hash.stringify_keys!
+
+      parse_name(working_hash.delete('name'))
+      return self
+    end
+
+    def to_hash
+      hash = {}
+
+      hash['name'] = self.name.to_s if self.name.present?
+
+      return hash
+    end
+  end
+
+end

data/lib/rubiks/nodes/measure.rb

@@ -0,0 +1,66 @@
+require 'rubiks/nodes/validated_node'
+
+module ::Rubiks
+
+  class Measure < ::Rubiks::AnnotatedNode
+    value :column, String
+    value :aggregator, String
+    value :format_string, String
+
+    validates :column_present, :aggregator_present
+
+    def self.new_from_hash(hash={})
+      new_instance = new
+      return new_instance.from_hash(hash)
+    end
+
+    def from_hash(working_hash)
+      return self if working_hash.nil?
+      working_hash.stringify_keys!
+
+      parse_name(working_hash.delete('name'))
+      parse_column(working_hash.delete('column'))
+      parse_aggregator(working_hash.delete('aggregator'))
+      parse_format_string(working_hash.delete('format_string'))
+      return self
+    end
+
+    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?
+
+      return hash
+    end
+
+    def column_present
+      errors << 'Column required on Measure' if self.column.blank?
+    end
+
+    def parse_column(column_value)
+      return if column_value.nil?
+
+      self.column = column_value.to_s
+    end
+
+    def aggregator_present
+      errors << 'Aggregator required on Measure' if self.aggregator.blank?
+    end
+
+    def parse_aggregator(aggregator_value)
+      return if aggregator_value.nil?
+
+      self.aggregator = aggregator_value.to_s
+    end
+
+    def parse_format_string(format_string_value)
+      return if format_string_value.nil?
+
+      self.format_string = format_string_value.to_s
+    end
+  end
+
+end

data/lib/rubiks/nodes/schema.rb

@@ -0,0 +1,61 @@
+require 'rubiks/nodes/validated_node'
+require 'rubiks/nodes/cube'
+require 'multi_json'
+
+module ::Rubiks
+
+  class Schema < ::Rubiks::ValidatedNode
+    child :cubes, [::Rubiks::Cube]
+
+    validates :cubes_present
+
+    def self.new_from_hash(hash={})
+      new_instance = new([])
+      return new_instance.from_hash(hash)
+    end
+
+    def cubes_present
+      if self.cubes.present?
+        self.cubes.each do |cube|
+          cube.validate
+          errors.push(*cube.errors)
+        end
+      else
+        errors << 'Cubes Required for Schema'
+      end
+    end
+
+    def from_hash(working_hash)
+      return self if working_hash.nil?
+      working_hash.stringify_keys!
+
+      parse_cubes(working_hash.delete('cubes'))
+      return self
+    end
+
+    def parse_cubes(cubes_array)
+      return if cubes_array.nil? || cubes_array.empty?
+
+      cubes_array.each do |cube_hash|
+        self.cubes << ::Rubiks::Cube.new_from_hash(cube_hash)
+      end
+    end
+
+    def to_hash
+      hash = {}
+
+      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
+      to_hash.to_xml(:root => 'Schema')
+    end
+  end
+
+end

data/lib/rubiks/nodes/validated_node.rb

@@ -0,0 +1,47 @@
+require 'rltk'
+require 'rltk/ast'
+
+module ::Rubiks
+  class ValidatedNode < ::RLTK::ASTNode
+
+    class << self
+      attr_accessor :validators
+
+      alias_method :validator_methods, :validators
+    end
+
+    def self.validates(*validator_symbols)
+      @validators ||= []
+      @validators << validator_symbols.flatten
+      @validators.flatten!
+      @validators.compact!
+      @validators.uniq!
+
+      return @validators
+    end
+
+    def self.inherited(klass)
+      super
+      klass.validators = self.validators.nil? ?
+                          [] :
+                          self.validators.dup
+    end
+
+    def errors
+      @errors ||= []
+    end
+
+    def valid?
+      validate if errors.empty?
+
+      return errors.empty?
+    end
+
+    def validate
+      self.class.validator_methods.each do |validator_method|
+        self.__send__(validator_method) if respond_to?(validator_method)
+      end
+    end
+
+  end
+end

data/lib/rubiks/version.rb

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

data/lib/rubiks.rb

@@ -1,11 +1,9 @@
 require 'rubiks/version'
 
-module Rubiks
-  autoload :Cube,       'rubiks/cube'
-  autoload :Dimension,  'rubiks/dimension'
-  autoload :Hierarchy,  'rubiks/hierarchy'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/deep_dup'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/hash/conversions'
 
-  module Transformers
-    autoload :LookupTransformer, 'rubiks/transformers/lookup_transformer'
-  end
-end
+nodes_directory = File.expand_path('../rubiks/nodes', __FILE__)
+Dir["#{nodes_directory}/*.rb"].each { |file| require file }

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{A Ruby OLAP Cube library}
-  gem.summary       = gem.description
+  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.homepage      = 'https://github.com/moneydesktop/rubiks'
 
   gem.files         = `git ls-files`.split($/)
@@ -17,15 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'arel'
-
-  gem.add_development_dependency 'awesome_print'
-  gem.add_development_dependency 'guard'
-  gem.add_development_dependency 'guard-minitest'
-  gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rb-fsevent'
-  gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'simplecov-gem-adapter'
+  gem.add_dependency 'rltk'
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'builder'
 end

data/spec/examples/mondrian_xml_example_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+# This example is taken from the Mondrian documentation:
+# http://mondrian.pentaho.com/documentation/schema.php#Cubes_and_dimensions
+# and then modified to use Rails/Rubiks conventions
+#
+# We want the output to be:
+#
+# <Schema>
+#   <Cube name="Sales">
+#     <Table name="view_sales"/>
+# 
+#     <Dimension name="Gender" foreignKey="customer_id">
+#       <Hierarchy hasAll="true" allMemberName="All Genders" primaryKey="id">
+#         <Table name="customers"/>
+#         <Level name="Gender" column="gender" uniqueMembers="true"/>
+#       </Hierarchy>
+#     </Dimension>
+# 
+#     <Dimension name="Date" foreignKey="date_id">
+#       <Hierarchy hasAll="false" primaryKey="id">
+#         <Table name="view_dates"/>
+#         <Level name="Year" column="year" type="Numeric" uniqueMembers="true"/>
+#         <Level name="Quarter" column="quarter" uniqueMembers="false"/>
+#         <Level name="Month" column="month_of_year" type="Numeric" uniqueMembers="false"/>
+#       </Hierarchy>
+#     </Dimension>
+# 
+#     <Measure name="Unit Sales" column="unit_sales" aggregator="sum" formatString="#,###"/>
+#     <Measure name="Store Sales" column="store_sales" aggregator="sum" formatString="#,###.##"/>
+#     <Measure name="Store Cost" column="store_cost" aggregator="sum" formatString="#,###.00"/>
+# 
+#     <CalculatedMember name="Profit" dimension="Measures" formula="[Measures].[Store Sales] - [Measures].[Store Cost]">
+#       <CalculatedMemberProperty name="FORMAT_STRING" value="$#,##0.00"/>
+#     </CalculatedMember>
+#   </Cube>
+# </Schema>
+
+describe 'A basic Mondrian XML Schema' do
+  let(:described_class) { ::Rubiks::Schema }
+  let(:schema_hash) {
+    {
+      'cubes' => [{
+        'name' => 'sales',
+        'measures' => [
+          {
+            'name' => 'unit_sales',
+            'aggregator' => 'sum',
+            'format_string' => '#,###'
+          },
+          {
+            'name' => 'store_sales',
+            'aggregator' => 'sum',
+            'format_string' => '#,###.##'
+          },
+          {
+            'name' => 'store_cost',
+            'aggregator' => 'sum',
+            'format_string' => '#,###.00'
+          }
+        ],
+        'dimensions' => [
+          {
+            'name' => 'date',
+            'hierarchies' => [{
+              'name' => 'day_of_week',
+              'levels' => [{
+                'name' => 'day_of_week'
+              }]
+            }]
+          }
+        ]
+      }]
+    }
+  }
+
+  # subject { described_class.new_from_hash(schema_hash) }
+
+  # describe '#to_json' do
+  #   it 'generates a JSON string' do
+  #     subject.to_json.should be_kind_of String
+  #   end
+
+  #   it 'generates a valid JSON string' do
+  #     lambda {
+  #       MultiJson.load(subject.to_json)
+  #     }.should_not raise_error MultiJson::LoadError
+  #   end
+  # end
+
+end

data/spec/rubiks/nodes/annotated_node_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+# describe ::Rubiks::AnnotatedNode do
+#   # API
+#   specify { subject.respond_to?(:from_hash) }
+#   specify { subject.respond_to?(:to_hash) }
+# 
+#   context 'when parsed from a valid hash' do
+#     subject { described_class.new.from_hash('name' => 'some_name') }
+# 
+#     its(:name) { should eq('some_name') }
+# 
+#     its(:to_hash) { should have_key('name') }
+# 
+#     it { should be_valid }
+#   end
+# 
+#   context 'when parsed from an invalid (empty) hash' do
+#     subject { described_class.new.from_hash({}) }
+# 
+#     it { should_not be_valid }
+#   end
+# 
+# end