rubiks 0.0.4 → 0.0.5

data/.gitignore

@@ -1,20 +1,35 @@
-*.gem
-*.rbc
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
 *.swp
-.DS_Store
-.bundle
-.config
-.vagrant
+
+## PROJECT::GENERAL
 .yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
 coverage
-doc/
-lib/bundler/man
+doc
+log
 pkg
 rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+
+## BUNDLER
+*.gem
+.bundle
+pkg
+Gemfile.lock
+
+## RBENV
+.ruby-version
+.rbenv*
+
+## RCOV
+coverage.data
+
+## RUBINIUS
+*.rbc

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3

data/.travis.yml

@@ -1,6 +1,5 @@
-language: ruby
 bundler_args: --without development
+language: ruby
 rvm:
-  - '1.9.2'
-notifications:
-  email: false
+  - jruby-19mode
+  - 1.9.2

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+-
+CHANGELOG.md
+CONTRIBUTING.md
+LICENSE.md
+README.md

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+0.0.5
+-----
+* [0.0.5 release](https://github.com/moneydesktop/rubiks/pull/2)
+
+0.0.4
+-----
+* [Bump to v0.0.4](https://github.com/moneydesktop/rubiks/commit/38dfd1f82e947f39457670adfdc6ca67da2728c6)
+* [Add GemVersion badge to README](https://github.com/moneydesktop/rubiks/commit/2d92097c4ba73d92690fab78455fc7db6ed0b3d9)
+
+0.0.3
+-----
+* [Bump to v0.0.3](https://github.com/moneydesktop/rubiks/commit/23ceb29936f663605527a12ca2d2a5c623abe99e)
+* Need to fill in other commits here
+
+0.0.2
+-----
+* [Bump to v0.0.2](https://github.com/moneydesktop/rubiks/commit/14a55449be9552268c66cbf8b902af02cf7b73c6)
+
+0.0.1
+-----
+* [Initial RubyGem project](https://github.com/moneydesktop/rubiks/commit/fa8be4badf70e86fda7e14bf23f9230a926893d2)

data/CONTRIBUTIG.md

@@ -0,0 +1,46 @@
+## Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code ( **no patch is too small**: fix typos, add comments, clean up
+  inconsistent whitespace)
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/moneydesktop/rubiks/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add, commit, and push your changes.
+9. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

@@ -7,13 +7,16 @@ gemspec
 # so CI can include just test dependencies
 group :test do
   gem 'rake'
+  gem 'yard'
+  gem 'coveralls', :require => false
+  gem 'simplecov', :require => false
   gem 'rspec'
   gem 'rspec-pride'
 end
 
 group :development do
   gem 'awesome_print'
+  gem 'kramdown'
   gem 'pry'
   gem 'pry-nav'
-  gem 'simplecov'
 end

data/{LICENSE.txt → LICENSE.md}

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

data/README.md

@@ -1,10 +1,18 @@
 # Rubiks
 
-[![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)
+[![Gem Version](https://badge.fury.io/rb/rubiks.png)][gem]
+[![Build Status](https://secure.travis-ci.org/moneydesktop/rubiks.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/moneydesktop/rubiks.png?travis)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/moneydesktop/rubiks.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/moneydesktop/rubiks/badge.png?branch=master)][coveralls]
 
-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.
+[gem]: https://rubygems.org/gems/rubiks
+[travis]: http://travis-ci.org/moneydesktop/rubiks
+[gemnasium]: https://gemnasium.com/moneydesktop/rubiks
+[codeclimate]: https://codeclimate.com/github/moneydesktop/rubiks
+[coveralls]: https://coveralls.io/r/moneydesktop/rubiks
+
+A gem to allow defining an OLAP schema from a hash and generating an XML schema for Mondrian.
 
 ## Installation
 
@@ -14,6 +22,91 @@ Or you can add the following to your Gemfile and run the `bundle` command to ins
 
     gem 'rubiks'
 
+## Examples
+
+This is an example taken from the [Mondrian documentation](http://mondrian.pentaho.com/documentation/schema.php#Cubes_and_dimensions) (then simplified a little and modified to use some Rails/Rubiks conventions)
+
+After installing the gem, fire up an IRB session with `irb` or `bundle exec irb` if you are using Bundler, and follow this (or even paste it into your session):
+
+```ruby
+require 'rubiks/examples'
+
+md = Rubiks::Examples::MondrianDocs.new
+
+md.filename           # => "/path/to/rubiks/examples/mondrian_docs.yml"
+
+puts md.file_contents # see the YAML section below
+
+puts md.to_xml        # see the XML section below
+```
+
+The [example YAML file](examples/mondrian_docs.yml) contents are:
+
+```yaml
+cubes:
+  - name: sales
+    dimensions:
+      - name: date
+        hierarchies:
+          - name: year_quarter_month
+            levels:
+              - name: year
+                column: the_year
+                data_type: numeric
+
+              - name: quarter
+                data_type: string
+
+              - name: month
+                column: month_of_year
+                data_type: Numeric
+
+    measures:
+      - name: unit_sales
+        aggregator: sum
+        format_string: '#,###'
+
+      - name: store_sales
+        aggregator: sum
+        format_string: '#,###'
+
+      - name: store_cost
+        aggregator: sum
+        format_string: '#,###'
+
+    calculated_members:
+      - name: profit
+        dimension: measures
+        formula: '[Measures].[Store Sales] / [Measures].[Store Cost]'
+        format_string: '$#,##0.00'
+```
+
+and the generated XML is:
+
+
+```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="the_year" type="Numeric"/>
+        <level name="Quarter" column="quarter" type="String"/>
+        <level name="Month" column="month_of_year" type="Numeric"/>
+      </hierarchy>
+    </dimension>
+    <measure name="Unit Sales" aggregator="sum" formatString="#,###" column="unit_sales"/>
+    <measure name="Store Sales" aggregator="sum" formatString="#,###" column="store_sales"/>
+    <measure name="Store Cost" aggregator="sum" formatString="#,###" column="store_cost"/>
+    <calculatedMember name="Profit" dimension="Measures" formula="[Measures].[Store Sales] / [Measures].[Store Cost]">
+      <calculatedMemberProperty name="FORMAT_STRING" value="$#,##0.00"/>
+    </calculatedMember>
+  </cube>
+</schema>
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,5 +1,12 @@
-require 'rspec/core/rake_task'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
+require 'rspec/core/rake_task'
+desc 'Run all specs'
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+task :test => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/examples/mondrian_docs.yml

@@ -0,0 +1,36 @@
+cubes:
+  - name: sales
+    dimensions:
+      - name: date
+        hierarchies:
+          - name: year_quarter_month
+            levels:
+              - name: year
+                column: the_year
+                data_type: numeric
+
+              - name: quarter
+                data_type: string
+
+              - name: month
+                column: month_of_year
+                data_type: Numeric
+
+    measures:
+      - name: unit_sales
+        aggregator: sum
+        format_string: '#,###'
+
+      - name: store_sales
+        aggregator: sum
+        format_string: '#,###'
+
+      - name: store_cost
+        aggregator: sum
+        format_string: '#,###'
+
+    calculated_members:
+      - name: profit
+        dimension: measures
+        formula: '[Measures].[Store Sales] / [Measures].[Store Cost]'
+        format_string: '$#,##0.00'

data/lib/rubiks/examples.rb

@@ -0,0 +1,61 @@
+require 'rubiks'
+require 'yaml'
+
+module ::Rubiks
+  module Examples
+
+    # 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:
+    #
+    # <?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="the_year" type="Numeric"/>
+    #         <level name="Quarter" column="quarter" type="String"/>
+    #         <level name="Month" column="month_of_year" type="Numeric"/>
+    #       </hierarchy>
+    #     </dimension>
+    #
+    #     <measure name="Unit Sales" aggregator="sum" formatString="#,###" column="unit_sales"/>
+    #     <measure name="Store Sales" aggregator="sum" formatString="#,###" column="store_sales"/>
+    #     <measure name="Store Cost" aggregator="sum" formatString="#,###" column="store_cost"/>
+    #
+    #     <calculatedMember name="Profit" dimension="Measures" formula="[Measures].[Store Sales] / [Measures].[Store Cost]">
+    #       <calculatedMemberProperty name="FORMAT_STRING" value="$#,##0.00"/>
+    #     </calculatedMember>
+    #   </cube>
+    # </schema>
+    class MondrianDocs
+      class << self
+        def filename
+          File.expand_path('../../../examples/mondrian_docs.yml', __FILE__)
+        end
+
+        def file_contents
+          File.read(self.filename)
+        end
+
+        def hash
+          YAML.load_file(self.filename)
+        end
+
+        def schema
+          ::Rubiks::Schema.new_from_hash(self.hash)
+        end
+
+        def to_xml
+          self.schema.to_xml
+        end
+      end
+    end
+
+  end
+end

data/lib/rubiks/nodes/annotated_node.rb

@@ -16,5 +16,11 @@ module ::Rubiks
       self.name = name_value.to_s
     end
 
+    def display_name
+      return if self.name.nil?
+
+      self.name.titleize
+    end
+
   end
 end

data/lib/rubiks/nodes/calculated_member.rb

@@ -0,0 +1,81 @@
+require 'rubiks/nodes/validated_node'
+
+module ::Rubiks
+
+  class CalculatedMember < ::Rubiks::AnnotatedNode
+    value :dimension, String
+    value :formula, String
+    value :format_string, String
+
+    validates :dimension_present, :formula_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_dimension(working_hash.delete('dimension'))
+      parse_formula(working_hash.delete('formula'))
+      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['dimension'] = self.dimension.to_s if self.dimension.present?
+      hash['formula'] = self.formula.to_s if self.formula.present?
+      hash['format_string'] = self.format_string.to_s if self.format_string.present?
+
+      return hash
+    end
+
+    def dimension_present
+      errors << 'Dimension required on CalculatedMember' if self.dimension.blank?
+    end
+
+    def parse_dimension(dimension_value)
+      return if dimension_value.nil?
+
+      self.dimension = dimension_value.to_s
+    end
+
+    def formula_present
+      errors << 'Formula required on CalculatedMember' if self.formula.blank?
+    end
+
+    def parse_formula(formula_value)
+      return if formula_value.nil?
+
+      self.formula = formula_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
+
+    def to_xml(builder = nil)
+      builder = Builder::XmlMarkup.new(:indent => 2) if builder.nil?
+
+      attrs = self.to_hash
+      attrs['name'] = self.name.titleize if self.name.present?
+      attrs['dimension'] = self.dimension.titleize if self.dimension.present?
+      attrs.delete('format_string')
+      builder.calculatedMember(attrs) do
+        if self.format_string.present?
+          format_attrs = {'name' => 'FORMAT_STRING', 'value' => self.format_string}
+          builder.calculatedMemberProperty(format_attrs)
+        end
+      end
+    end
+  end
+
+end

data/lib/rubiks/nodes/cube.rb

@@ -1,17 +1,24 @@
 require 'rubiks/nodes/annotated_node'
 require 'rubiks/nodes/dimension'
 require 'rubiks/nodes/measure'
+require 'rubiks/nodes/calculated_member'
 
 module ::Rubiks
 
   class Cube < ::Rubiks::AnnotatedNode
+    value :date_dimension, String
+    value :person_dimension, String
+    value :count_measure, String
+    value :person_count_measure, String
+
     child :dimensions, [::Rubiks::Dimension]
     child :measures, [::Rubiks::Measure]
+    child :calculated_members, [::Rubiks::CalculatedMember]
 
-    validates :dimensions_present, :measures_present
+    validates :dimensions_present, :measures_present, :calculated_members_if_present
 
     def self.new_from_hash(hash={})
-      new_instance = new('',[],[])
+      new_instance = new('','','','','',[],[],[])
       return new_instance.from_hash(hash)
     end
 
@@ -20,11 +27,57 @@ module ::Rubiks
       working_hash.stringify_keys!
 
       parse_name(working_hash.delete('name'))
+      parse_date_dimension(working_hash.delete('date_dimension'))
+      parse_person_dimension(working_hash.delete('person_dimension'))
+      parse_count_measure(working_hash.delete('count_measure'))
+      parse_person_count_measure(working_hash.delete('person_count_measure'))
       parse_dimensions(working_hash.delete('dimensions'))
       parse_measures(working_hash.delete('measures'))
+      parse_calculated_members(working_hash.delete('calculated_members'))
       return self
     end
 
+    def parse_date_dimension(input_value)
+      return if input_value.nil?
+
+      self.date_dimension = input_value.to_s.underscore
+    end
+
+    def parse_person_dimension(input_value)
+      return if input_value.nil?
+
+      self.person_dimension = input_value.to_s.underscore
+    end
+
+    def parse_count_measure(input_value)
+      return if input_value.nil?
+
+      self.count_measure = input_value.to_s.underscore
+    end
+
+    def parse_person_count_measure(input_value)
+      return if input_value.nil?
+
+      self.person_count_measure = input_value.to_s.underscore
+    end
+
+    def calculated_members_if_present
+      if self.calculated_members.present?
+        self.calculated_members.each do |calculated_member|
+          calculated_member.validate
+          errors.push(*calculated_member.errors)
+        end
+      end
+    end
+
+    def parse_calculated_members(calculated_members_array)
+      return if calculated_members_array.nil? || calculated_members_array.empty?
+
+      calculated_members_array.each do |calculated_member_hash|
+        self.calculated_members << ::Rubiks::CalculatedMember.new_from_hash(calculated_member_hash)
+      end
+    end
+
     def measures_present
       if self.measures.present?
         self.measures.each do |measure|
@@ -69,9 +122,28 @@ module ::Rubiks
       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?
+      hash['calculated_members'] = self.calculated_members.map(&:to_hash) if self.calculated_members.present?
+      hash['date_dimension'] = self.date_dimension if self.date_dimension.present?
+      hash['person_dimension'] = self.person_dimension if self.person_dimension.present?
+      hash['count_measure'] = self.count_measure if self.count_measure.present?
+      hash['person_count_measure'] = self.person_count_measure if self.person_count_measure.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?
+      builder.cube(attrs) {
+        builder.table('name' => "view_#{self.name.tableize}") if self.name.present?
+
+        self.dimensions.each{ |dim| dim.to_xml(builder) } if self.dimensions.present?
+        self.measures.each{ |measure| measure.to_xml(builder) } if self.measures.present?
+        self.calculated_members.each{ |calculated_member| calculated_member.to_xml(builder) } if self.calculated_members.present?
+      }
+    end
   end
 
 end

data/lib/rubiks/nodes/dimension.rb

@@ -37,6 +37,7 @@ module ::Rubiks
       return if hierarchies_array.nil? || hierarchies_array.empty?
 
       hierarchies_array.each do |hierarchy_hash|
+        hierarchy_hash['dimension'] = self.name if self.name.present?
         self.hierarchies << ::Rubiks::Hierarchy.new_from_hash(hierarchy_hash)
       end
     end
@@ -49,6 +50,23 @@ module ::Rubiks
 
       return hash
     end
+
+    def to_xml(builder = nil)
+      builder = Builder::XmlMarkup.new(:indent => 2) if builder.nil?
+
+      attrs = self.to_hash
+      attrs.delete('hierarchies')
+      attrs['name'] = self.name.titleize if self.name.present?
+      attrs.keys.each do |key|
+        attrs[key.camelize(:lower)] = attrs.delete(key)
+      end
+      attrs['foreignKey'] = "#{self.name.underscore}_id" if self.name.present?
+      builder.dimension(attrs) {
+        self.hierarchies.each do |hier|
+          hier.to_xml(builder)
+        end if self.hierarchies.present?
+      }
+    end
   end
 
 end