multidimensional_table 1.0.0

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
+*.un~

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in multidimensional_table.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 drKreso
+
+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,79 @@
+# MultidimensionalTable
+
+This is a product of a coding kata. I wanted an easy way to describe multidimensional table
+but only using ruby code and not some sort of .yaml or other custom format that you have to parse in some way.
+
+For example:
+
+```
+1994      
+  BuenosAires
+    Coal
+      19t
+    Potassium
+      5t
+1995 
+  BuenosAires
+    Coal  
+      8t
+    Potassium
+      6t
+```
+
+Then if I say I need to get Coal in Buenos Aires in 1995 I wan't to get 8t. The idea is to make easy DSL to 
+describe the same thing in pure Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'multidimensional_table'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multidimensional_table
+
+## Usage
+
+```
+class MaterialConsumption
+  include MultidimensionalTable
+
+  dimensions  :year => [:year_1994, :year_1995],
+              :city => [:buenos_aires],
+              :material => [:coal, :potassium]
+
+  table_data do
+    year_1994 do
+      buenos_aires do
+        coal '8t' 
+        potassium '5t' 
+      end
+    end
+
+    year_1995 do
+      buenos_aires do
+        coal '8t' 
+        potassium '6t' 
+      end
+    end
+  end
+
+end
+
+mt = new MaterialConsumption
+mt.update_attributes(:year => :year_1994, :city => :buenos_aires, :material => :coal)
+mt.table_result #=> '8t'
+```
+
+## 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/multidimensional_table/multidimensional_table.rb

@@ -0,0 +1,72 @@
+require 'multidimensional_table/non_existant_dimension_attribute'
+require 'multidimensional_table/non_valid_dimension'
+
+module MultidimensionalTable
+
+  def dimensions=(map)
+    @dimensions = map
+    check_duplicates(map)
+    @dimensions.each do |key, value|
+      value.each do |possible_value|
+        define_method possible_value do |value = nil,  &block|
+          if value.nil? && !block.nil?
+            @index_level += 1
+            @context[@index_level] = "@attributes[:#{key}] == :#{possible_value}" 
+            begin
+              block.call
+            rescue NoMethodError => e
+              raise NonExistantDimensionAttribute.new(e.name)
+            end
+            @index_level -= 1
+          elsif !value.nil?
+            context = (1..@index_level).reduce([]) { |context, level| context << @context[level] }
+            @table_rules[value] = context << ["@attributes[:#{key}] == :#{possible_value}"]  
+          end
+        end
+      end
+    end
+  end
+
+  def check_duplicates(map)
+    list = {}
+    combined = map.each_value.reduce([]) { |all, value| all << value }.flatten
+    combined.each do |item|
+      if list[item].nil? 
+        list[item] = 1
+      else
+        list[item] = list[item] + 1
+      end
+    end
+    duplicates = list.select { |key, value| key if value > 1 }
+    if duplicates != {}
+      non_valid_dimensions = {}
+      duplicates.each_key do |duplicate|
+        non_valid_dimensions[duplicate] = []
+        map.each do |key,value|
+          non_valid_dimensions[duplicate] << key if value.include?(duplicate)
+        end
+      end
+      raise NonValidDimension, non_valid_dimensions
+    end
+  end
+
+  def update_attributes(attrs)
+    attrs.each do |key, value| @attributes[key] = value end
+  end
+
+  def table_result
+    @table_rules.each { |key, condition| return key if class_eval(condition.join(' && ')) == true }
+  end
+
+  def table_data
+    @context = []
+    @table_rules = {}
+    @attributes ||= {}
+    @index_level = 0
+    yield
+  end
+
+  def dimensions
+    @dimensions ||= {}
+  end
+end

data/lib/multidimensional_table/non_existant_dimension_attribute.rb

@@ -0,0 +1,12 @@
+module MultidimensionalTable
+  class NonExistantDimensionAttribute < StandardError
+    attr_accessor :attribute
+    def initialize(attribute)
+      @attribute = attribute
+    end
+
+    def to_s
+     "Nonexistan dimension attribute :#@attribute"
+    end
+  end
+end

data/lib/multidimensional_table/non_valid_dimension.rb

@@ -0,0 +1,18 @@
+module MultidimensionalTable
+  class NonValidDimension < StandardError
+    attr_accessor :duplicate
+    def initialize(duplicate)
+      @duplicate = duplicate
+    end
+
+    def to_s
+      "Multiple definitions are not allowed : #{represent_duplicates}"
+    end
+
+    def represent_duplicates
+      duplicate.map do |key, value|
+         "#{key} for dimension " << value.join(' and ')
+      end.join(', ')
+    end
+  end
+end

data/lib/multidimensional_table/version.rb

@@ -0,0 +1,3 @@
+module MultidimensionalTable
+  VERSION = "1.0.0"
+end

data/lib/multidimensional_table.rb

@@ -0,0 +1,3 @@
+require "multidimensional_table/version"
+require "multidimensional_table/multidimensional_table"
+

data/multidimensional_table.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/multidimensional_table/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["drKreso"]
+  gem.email         = ["kresimir.bojcic@gmail.com"]
+  gem.description   = %q{Describe a multidimensional table in pure Ruby}
+  gem.summary       = %q{Attempt to make generic API for describing multidimensional data in Ruby}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "multidimensional_table"
+  gem.require_paths = ["lib"]
+  gem.version       = MultidimensionalTable::VERSION
+end

data/spec/multidimensional_table/multidimensional_table_spec.rb

@@ -0,0 +1,130 @@
+require 'multidimensional_table/multidimensional_table'
+
+
+module MultidimensionalTable
+  describe MultidimensionalTable do
+    context 'basic setup' do
+      it 'knows dimenions it has' do
+        subject.extend(MultidimensionalTable)
+        subject.dimensions = { :material => [:potassium, :coal, :sugar] }
+        subject.dimensions[:material].should == [:potassium, :coal, :sugar]
+      end
+
+      it 'creates methods for dimensions' do
+        subject.extend(MultidimensionalTable)
+        subject.dimensions = { :material => [:potassium, :coal, :sugar] }
+        subject.respond_to?(:potassium).should == true
+        subject.respond_to?(:coal).should == true
+        subject.respond_to?(:sugar).should == true
+      end
+
+      it 'should be able to find data from table' do
+        subject.extend(MultidimensionalTable)
+        subject.dimensions = { :material => [:potassium, :coal, :sugar] }
+        subject.table_data do
+          subject.coal '8t' 
+          subject.sugar '9t' 
+        end
+        subject.update_attributes(:material => :coal)
+        subject.table_result.should == '8t'
+        subject.update_attributes(:material => :sugar)
+        subject.table_result.should == '9t'
+      end
+    end
+
+    context 'two dimensional' do
+      before(:each) do
+        subject.extend(MultidimensionalTable)
+        subject.dimensions = { :material => [:potassium, :coal, :sugar], :city => [:zagreb, :zadar] }
+        subject.table_data do
+          subject.zagreb do
+            subject.coal '8t' 
+            subject.sugar '9t' 
+          end
+          subject.zadar do
+            subject.coal '1t' 
+            subject.sugar '2t' 
+          end
+        end
+      end
+
+      it 'should be able to pinpoint coal in zagreb' do
+        subject.update_attributes(:material => :coal, :city => :zagreb)
+        subject.table_result.should == '8t'
+      end
+
+      it 'should be able to pinpoint sugar in zadar' do
+        subject.update_attributes(:material => :sugar, :city => :zadar)
+        subject.table_result.should == '2t'
+      end
+    end
+
+    context 'three dimensional' do
+      before(:each) do
+        subject.extend(MultidimensionalTable)
+        subject.dimensions = { :material => [:potassium, :coal, :sugar],
+          :city => [:zagreb, :zadar],
+          :time_of_day => [:morning, :evening] }
+        subject.table_data do
+          subject.zagreb do
+            subject.morning do
+              subject.coal '8t' 
+              subject.sugar '9t' 
+            end
+            subject.evening do
+              subject.coal '4t' 
+              subject.sugar '5t' 
+            end
+          end
+          subject.zadar do
+            subject.coal '1t' 
+            subject.sugar '2t' 
+          end
+        end
+      end
+
+      it 'should be able to pinpoint coal in zagreb at evening' do 
+        subject.update_attributes(:material => :coal, :city => :zagreb, :time_of_day => :evening)
+        subject.table_result.should == '4t'
+      end
+
+      it 'should be able to pinpoint sugar in zagreb at morning' do 
+        subject.update_attributes(:material => :sugar, :city => :zagreb, :time_of_day => :morning)
+        subject.table_result.should == '9t'
+      end
+
+      it 'should be able to pinpoint sugar in zadar' do 
+        subject.update_attributes(:material => :sugar, :city => :zadar)
+        subject.table_result.should == '2t'
+      end
+    end
+
+    it 'should complain if dimension does not exist' do
+      subject.extend(MultidimensionalTable)
+      subject.dimensions = { :material => [:potassium, :coal, :sugar],
+        :city => [:zagreb, :zadar],
+        :time_of_day => [:morning, :evening] }
+
+      expect do
+        subject.table_data do
+          subject.zagreb do
+            subject.morning do
+              subject.coal_error '8t' 
+              subject.sugar '9t' 
+            end
+          end
+        end
+      end.to raise_error(NonExistantDimensionAttribute, 'Nonexistan dimension attribute :coal_error')
+    end
+
+    it 'should complain if same dimension name exists' do
+      subject.extend(MultidimensionalTable)
+      expect do
+        subject.dimensions = { :material => [:potassium, :coal, :sugar],
+          :city => [:zagreb, :zadar],
+          :time_of_day => [:coal, :zagreb] }
+      end.to raise_error(NonValidDimension, 'Multiple definitions are not allowed : coal for dimension material and time_of_day, zagreb for dimension city and time_of_day')
+    end
+
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: multidimensional_table
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- drKreso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-25 00:00:00.000000000Z
+dependencies: []
+description: Describe a multidimensional table in pure Ruby
+email:
+- kresimir.bojcic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/multidimensional_table.rb
+- lib/multidimensional_table/multidimensional_table.rb
+- lib/multidimensional_table/non_existant_dimension_attribute.rb
+- lib/multidimensional_table/non_valid_dimension.rb
+- lib/multidimensional_table/version.rb
+- multidimensional_table.gemspec
+- spec/multidimensional_table/multidimensional_table_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Attempt to make generic API for describing multidimensional data in Ruby
+test_files:
+- spec/multidimensional_table/multidimensional_table_spec.rb