activecube 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baf4f5a3146bb1c03244f62328b0af901ae7882e41ff4234a86e1deb6cd881a9
-  data.tar.gz: 44ca0d2eefbf2b4cc38e95aa9ab2b352607b4817b5c5aaebce8b2a04022037f6
+  metadata.gz: fc8d353c9c9d670cda8c4f9de4a3e59994c4f8e6ebd2d25551a5bf712f53db00
+  data.tar.gz: 55ac707acc8dd783318739e8f4bb424454da0c597a54ab89b09c76a16982ac23
 SHA512:
-  metadata.gz: ac3b3dd34000d54054eba5a0fc7b6aa9803f7643f4f1cc67c88fc603c9e34d07a7ae7ef2eed755efca7bdcd60f532c25b67962b45f20550df98bcb2fc2e13a19
-  data.tar.gz: 408881f9f8f5c3c3b2af544f320846f8f9765cf3f9673e196c9d2f32555901c221539786eb4c3fa487a082f1d62bf2939442f836fe73cdf6e559bea4ba5f8945
+  metadata.gz: 7652d255be72680539226092333c4c1fa081a0416b4ef50a13de17d40385c45628be5e761d1191b9e7e5ab1b55c26ca613012d9e601fda4c44984249bd7053e2
+  data.tar.gz: b20ad10bbec9f17cc95a879f84690739fcb3109e451797e954efd720a0de3fbaeac0a38e7b4a0ab1e647d2f3666d0b4b3de7c93d6bd3441897d3a72ab9db03f2

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    activecube (0.1.0)
+    activecube (0.1.2)
       activerecord (>= 5.2)
 
 GEM

data/README.md

@@ -2,8 +2,7 @@
 
 Activecube is the library to make multi-dimensional queries to data warehouse, such as:
 
-```sql
-
+```ruby
 Cube.slice(
     date: cube.dimensions[:date][:date].format('%Y-%m'),
     currency: cube.dimensions[:currency][:symbol]
@@ -132,8 +131,10 @@ The methods used to contruct the query:
 
 - **slice** defines which dimensions slices the results
 - **measure** defines what to measure
-- **where** defines which selectors to apply
-- **desc, asc, take, limit** are for ordering and limiting result set
+- **when** defines which selectors to apply
+- **desc, asc, take, skip** are for ordering and limiting result set
+
+(take and skip have aliases: offset and limit).
 
 After the query contructed, the following methods can be applied:
 
@@ -141,11 +142,13 @@ After the query contructed, the following methods can be applied:
 - **to_query** to generate Arel query
 - **query** to execute query and return ResultSet
 
-Note, that you can control the connection used to construct and execute query by 
+### Managing Connections
+
+
+You can control the connection used to construct and execute query by 
 ActiveRecord standard API:
 
 ```ruby
-
 ApplicationRecord.connected_to(database: :data_warehouse) do
       cube = My::TransfersCube
       cube.slice(
@@ -158,6 +161,42 @@ ApplicationRecord.connected_to(database: :data_warehouse) do
 will query using data_warehouse configuraton.
 
 
+Alternatively you can use the method provided by activecube. It will 
+make the connection for the model or abstract class, which is super class for your models:
+
+```ruby
+My::TransfersCube.connected_to(database: :data_warehouse) do |cube|
+      cube.slice(
+              date: cube.dimensions[:date][:date].format('%Y-%m'),
+              currency: cube.dimensions[:currency][:symbol]
+      ).measure(:count).query
+    end
+```
+
+## How it works
+
+When you construct and execute cube query with any outcome ( sql, Arel query or ResultSet),
+the same sequence of operations happen:
+
+1) Cube is collecting the query into a set of objects from the chain method call;
+2) Query is matched against the physical tables, the tables are selected that can serve the query or its part. For example, one table can provide one set of metrics, and the other can provide remaining;
+3) If possible, the variant is selected from all possible options, which uses indexes with the most cardinality
+4) Query is constructed using Arel SQL engine ( included in ActiveRecord ) using selected tables, and possibly joins
+5) If requested, the query is converted to sql ( using Arel visitor ) or executed with database connection
+
+## Optimization
+
+The optimization on step #3 try to minimize the total cost of execution:
+
+![Formula min max](https://latex.codecogs.com/png.latex?min(\sum_{tables}max_{metrics}(cost))))
+
+where 
+
+![Formula cost](https://latex.codecogs.com/png.latex?\inline&space;cost(metric,table)&space;=&space;1&space;/&space;(1&space;+&space;cardinality(metric,&space;table)))
+
+Optimization is done using the algorithm, which checks possible combinations of metrics and tables.
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/activecube.rb

@@ -6,8 +6,7 @@ require 'activecube/dimension'
 require 'activecube/metric'
 require 'activecube/selector'
 
-require 'activecube/common/count'
-require 'activecube/common/sum'
+require 'activecube/common/metrics'
 
 require 'active_record'
 

data/lib/activecube/common/metrics.rb

@@ -0,0 +1,25 @@
+module Activecube::Common
+
+  module Metrics
+
+    METHODS = [:count, :minimum,:maximum,:average,:sum,:uniqueExact,:unique,:median,:any,:anyLast]
+
+    METHODS.each do |fname|
+
+      if fname==:count
+        define_method fname do |model, arel_table, measure, cube_query|
+          measure.selectors.empty? ? Arel.star.count : Arel.star.countIf(measure.condition_query model, arel_table, cube_query)
+        end
+      else
+        define_method fname do |model, arel_table, measure, cube_query|
+          column = arel_table[self.class.column_name.to_sym]
+          measure.selectors.empty? ? column.send(fname) : column.send(fname.to_s+'If', measure.condition_query(model, arel_table, cube_query))
+        end
+      end
+
+
+    end
+
+
+  end
+end

data/lib/activecube/{dimension_definition_methods.rb → definition_methods.rb}

@@ -1,10 +1,12 @@
 require 'activecube/cube_definition'
 require 'activecube/field'
+require 'activecube/modifier'
 
 module Activecube
-  module DimensionDefinitionMethods
 
-    attr_reader :column_names, :identity, :fields
+  module DefinitionMethods
+
+    attr_reader :column_names
 
     def column_name
       raise "Not defined column for a metric #{self.name}" if column_names.empty?
@@ -22,14 +24,41 @@ module Activecube
       array.concat data
     end
 
-    def field *args
-      (@fields ||= {} )[args.first.to_sym] = Field.new( *args)
-    end
+
+  end
+
+  module DimensionDefinitionMethods
+
+    include DefinitionMethods
+
+    attr_reader :identity, :fields
+
+    private
 
     def identity_column *args
       raise "Identity already defined as #{identity} for #{self.name}" if @identity
       @identity = args.first
     end
 
+    def field *args
+      (@fields ||= {} )[args.first.to_sym] = Field.new( *args)
+    end
+
+  end
+
+
+  module MetricDefinitionMethods
+
+    include DefinitionMethods
+
+    attr_reader :modifiers
+
+    private
+
+    def modifier *args
+      (@modifiers ||= {} )[args.first.to_sym] = Modifier.new( *args)
+    end
+
   end
+
 end

data/lib/activecube/dimension.rb

@@ -1,4 +1,4 @@
-require 'activecube/dimension_definition_methods'
+require 'activecube/definition_methods'
 
 module Activecube
   class Dimension

data/lib/activecube/metric.rb

@@ -1,7 +1,7 @@
-require 'activecube/dimension_definition_methods'
+require 'activecube/definition_methods'
 
 module Activecube
   class Metric
-    extend DimensionDefinitionMethods
+    extend MetricDefinitionMethods
   end
 end

data/lib/activecube/modifier.rb

@@ -0,0 +1,12 @@
+module Activecube
+  class Modifier
+
+    attr_reader :name, :definition
+    def initialize *args
+      @name = args.first
+      @definition = args.second
+    end
+
+
+  end
+end

data/lib/activecube/processor/table.rb

@@ -25,7 +25,7 @@ module Activecube::Processor
       query = table
 
       (cube_query.slices + cube_query.measures + cube_query.selectors + cube_query.options).each do |s|
-        query = s.append_query cube_query, table, query
+        query = s.append_query model, cube_query, table, query
       end
 
       query
@@ -42,7 +42,7 @@ module Activecube::Processor
           using(*dimension_names)
 
       cube_query.options.each do |option|
-        query = option.append_query cube_query, outer_table, query
+        query = option.append_query model, cube_query, outer_table, query
       end
 
 

data/lib/activecube/query/cube_query.rb

@@ -14,7 +14,7 @@ module Activecube::Query
 
     include ChainAppender
 
-    attr_reader :cube, :slices, :measures, :selectors, :orderings, :options
+    attr_reader :cube, :slices, :measures, :selectors, :options
     def initialize cube, slices = [], measures = [], selectors = [], options = []
       @cube = cube
       @slices = slices
@@ -31,7 +31,7 @@ module Activecube::Query
       append *args, @measures, Measure, cube.metrics
     end
 
-    def select *args
+    def when *args
       append *args, @selectors, Selector, cube.selectors
     end
 
@@ -63,6 +63,9 @@ module Activecube::Query
       self
     end
 
+    alias_method :limit, :take
+    alias_method :offset, :skip
+
     def query
       composer = Activecube::Processor::Composer.new(self)
       sql = composer.build_query.to_sql
@@ -101,7 +104,7 @@ module Activecube::Query
         reduced_selectors = self.selectors
       else
         reduced_measures = other_measures.collect{|m|
-          Measure.new m.cube, m.key, m.definition, (m.selectors - common_selectors)
+          Measure.new m.cube, m.key, m.definition, (m.selectors - common_selectors), m.modifications
         }
         reduced_selectors = self.selectors + common_selectors
       end
@@ -119,5 +122,9 @@ module Activecube::Query
       slices.map{|s| s.dimension_class.identity || s.key }.uniq
     end
 
+    def orderings
+      options.select{|s| s.kind_of? Ordering}
+    end
+
   end
 end

data/lib/activecube/query/item.rb

@@ -18,5 +18,9 @@ module Activecube::Query
       self.class.new cube, new_key, definition
     end
 
+    def to_s
+      "#{definition.class.name}(#{key})"
+    end
+
   end
 end

data/lib/activecube/query/limit.rb

@@ -8,7 +8,7 @@ module Activecube
         @option = option
       end
 
-      def append_query _cube_query, _table, query
+      def append_query _model, _cube_query, _table, query
         query.send(option,argument)
       end
 

data/lib/activecube/query/measure.rb

@@ -1,11 +1,16 @@
+require 'activecube/modifier'
+require 'activecube/query/modification'
+
 module Activecube::Query
   class Measure < Item
+    attr_reader :selectors, :modifications
 
-    attr_reader :selectors
-
-    def initialize cube, key, definition, selectors = []
+    def initialize cube, key, definition, selectors = [], modifications = []
       super cube, key, definition
       @selectors = selectors
+      @modifications = modifications
+
+      modifier_methods! if definition.class.modifiers
     end
 
     def required_column_names
@@ -17,24 +22,44 @@ module Activecube::Query
     end
 
     def alias! new_key
-      self.class.new cube, new_key, definition, selectors
+      self.class.new cube, new_key, definition, selectors, modifications
     end
 
-    def condition_query arel_table, cube_query
+    def condition_query model, arel_table, cube_query
       condition = nil
       selectors.each do |selector|
         condition = condition ?
-                        condition.and(selector.expression(arel_table, cube_query)) :
-                        selector.expression(arel_table, cube_query)
+                        condition.and(selector.expression(model, arel_table, cube_query)) :
+                        selector.expression(model, arel_table, cube_query)
       end
       condition
     end
 
-    def append_query cube_query, table, query
+    def append_query model, cube_query, table, query
       attr_alias = "`#{key.to_s}`"
-      expr = definition.expression table, self, cube_query
+      expr = definition.expression model, table, self, cube_query
       query.project expr.as(attr_alias)
     end
 
+    def to_s
+      "Metric #{super}"
+    end
+
+    def modifier name
+      ms = modifications.select{|m| m.modifier.name==name}
+      raise "Found multiple (#{ms.count}) definitions for #{name} in #{self}" if ms.count>1
+      ms.first
+    end
+
+    private
+
+    def modifier_methods!
+      definition.class.modifiers.each_pair do |key, modifier|
+        define_singleton_method key do |*args|
+          (@modifications ||= []) << Modification.new(modifier, *args)
+          self
+        end
+      end
+    end
   end
 end

data/lib/activecube/query/modification.rb

@@ -0,0 +1,14 @@
+require 'activecube/modifier'
+module Activecube
+  module Query
+    class Modification
+
+      attr_reader :modifier, :args
+      def initialize modifier, *args
+        @modifier = modifier
+        @args = args
+      end
+
+    end
+  end
+end

data/lib/activecube/query/or_selector.rb

@@ -9,10 +9,10 @@ module Activecube
         @selectors = selectors
       end
 
-      def append_query cube_query, table, query
+      def append_query model, cube_query, table, query
         expr = nil
         selectors.each do |s|
-          expr = expr ? expr.or(s.expression table, cube_query) : s.expression(table, cube_query)
+          expr = expr ? expr.or(s.expression model, table, cube_query) : s.expression(model, table, cube_query)
         end
         query.where(expr)
       end

data/lib/activecube/query/ordering.rb

@@ -8,7 +8,7 @@ module Activecube
         @direction = direction
       end
 
-      def append_query _cube_query, _table, query
+      def append_query _model, _cube_query, _table, query
         query.order(::Arel.sql(argument.to_s).send(direction))
       end
 

data/lib/activecube/query/selector.rb

@@ -1,7 +1,7 @@
 module Activecube::Query
   class Selector < Item
 
-    OPERATORS = ['eq','ne','gt','lt','ge','le','in','not_in']
+    OPERATORS = ['eq','ne','gt','lt','gteq','lteq','in','not_in','between']
     ARRAY_OPERATORS = ['in','not_in']
 
     class Operator
@@ -13,7 +13,7 @@ module Activecube::Query
         @argument = argument
       end
 
-      def expression left, right
+      def expression _model, left, right
         left.send(operation, right)
       end
 
@@ -33,6 +33,7 @@ module Activecube::Query
 
     end
 
+
     attr_reader :operator
     def initialize cube, key, definition, operator = nil
       super cube, key, definition
@@ -41,26 +42,42 @@ module Activecube::Query
 
     OPERATORS.each do |method|
       define_method(method) do |*args|
+        raise ArgumentError, "Selector for #{method} already set" if operator
         if ARRAY_OPERATORS.include? method
           @operator = Operator.new(method, args)
+        elsif method=='between'
+          if args.kind_of?(Range)
+            @operator = Operator.new(method, args)
+          elsif args.kind_of?(Array) && (arg = args.flatten).count==2
+            @operator = Operator.new(method, arg[0]..arg[1])
+          else
+            raise ArgumentError, "Unexpected size of arguments for #{method}, must be Range or Array of 2"
+          end
         else
-          raise ArgumentError, "Unexpected size of arguments" unless args.size==1
+          raise ArgumentError, "Unexpected size of arguments for #{method}" unless args.size==1
           @operator = Operator.new(method, args.first)
         end
         self
       end
     end
 
+    alias_method :since, :gteq
+    alias_method :till, :lteq
+    alias_method :is, :eq
+    alias_method :not, :ne
+    alias_method :after, :gt
+    alias_method :before, :lt
+
     def alias! new_key
       self.class.new cube, new_key, definition, operator
     end
 
-    def append_query cube_query, table, query
-      query.where(expression table, cube_query)
+    def append_query model, cube_query, table, query
+      query.where(expression model, table, cube_query)
     end
 
-    def expression arel_table, cube_query
-      definition.expression arel_table, self, cube_query
+    def expression model, arel_table, cube_query
+      definition.expression model, arel_table, self, cube_query
     end
 
     def eql?(other)
@@ -78,5 +95,9 @@ module Activecube::Query
       self.definition.class.hash + self.operator.hash
     end
 
+    def to_s
+      "Selector #{super}"
+    end
+
   end
 end

data/lib/activecube/query/slice.rb

@@ -24,7 +24,7 @@ module Activecube::Query
       definition.class
     end
 
-    def append_query _cube_query, table, query
+    def append_query _model, cube_query, table, query
 
       attr_alias = "`#{key.to_s}`"
       expr = field ? Arel.sql( modifier || field.definition ) : table[dimension_class.column_name]
@@ -33,12 +33,21 @@ module Activecube::Query
       if identity = dimension_class.identity
         query = query.project(table[identity]).group(table[identity])
       else
-        query = query.group(attr_alias).order(attr_alias)
+        query = query.group(attr_alias)
+      end
+
+      if cube_query.orderings.empty?
+        query = query.order(attr_alias)
       end
 
       query
     end
 
+    def to_s
+      "Dimension #{super}"
+    end
+
+
     private
 
     def field_methods!

data/lib/activecube/query_methods.rb

@@ -3,11 +3,38 @@ require 'activecube/query/cube_query'
 module Activecube
   module QueryMethods
 
-    [:slice, :measure, :when].each do |method|
+    attr_reader :database, :role
+
+    [:slice, :measure, :when, :skip, :take, :desc, :asc].each do |method|
       define_method(method) do |*args|
         Query::CubeQuery.new(self).send method, *args
       end
     end
 
+    def connected_to database: nil, role: nil, &block
+      raise ArgumentError, "Must pass block to method" unless block_given?
+      super_model.connected_to(database: database, role: role) do
+        @database = database
+        @role = role
+        block.call self
+      end
+    end
+
+    private
+
+
+    def super_model
+      raise ArgumentError, "No tables specified for cube #{name}" if tables.count==0
+      return tables.first.model if tables.count==1
+
+      tables.collect{ |t|
+        t.model.ancestors.select{|c| c <= ActiveRecord::Base }.reverse
+      }.transpose.select{|c|
+        c.uniq.count==1
+      }.last.first
+
+    end
+
+
   end
 end

data/lib/activecube/selector.rb

@@ -1,12 +1,12 @@
-require 'activecube/dimension_definition_methods'
+require 'activecube/definition_methods'
 
 module Activecube
   class Selector
-    extend DimensionDefinitionMethods
+    extend DefinitionMethods
 
-    def expression arel_table, selector, _cube_query
+    def expression model, arel_table, selector, _cube_query
       op = selector.operator
-      op.expression arel_table[self.class.column_name.to_sym], op.argument
+      op.expression  model, arel_table[self.class.column_name.to_sym], op.argument
     end
 
   end

data/lib/activecube/version.rb

@@ -1,3 +1,3 @@
 module Activecube
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activecube
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Aleksey Studnev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -91,13 +91,13 @@ files:
 - lib/activecube.rb
 - lib/activecube/active_record_extension.rb
 - lib/activecube/base.rb
-- lib/activecube/common/count.rb
-- lib/activecube/common/sum.rb
+- lib/activecube/common/metrics.rb
 - lib/activecube/cube_definition.rb
+- lib/activecube/definition_methods.rb
 - lib/activecube/dimension.rb
-- lib/activecube/dimension_definition_methods.rb
 - lib/activecube/field.rb
 - lib/activecube/metric.rb
+- lib/activecube/modifier.rb
 - lib/activecube/processor/composer.rb
 - lib/activecube/processor/index.rb
 - lib/activecube/processor/measure_tables.rb
@@ -108,6 +108,7 @@ files:
 - lib/activecube/query/item.rb
 - lib/activecube/query/limit.rb
 - lib/activecube/query/measure.rb
+- lib/activecube/query/modification.rb
 - lib/activecube/query/or_selector.rb
 - lib/activecube/query/ordering.rb
 - lib/activecube/query/selector.rb

data/lib/activecube/common/count.rb

@@ -1,10 +0,0 @@
-module Activecube::Common
-
-  class Count < Activecube::Metric
-
-    def expression arel_table, measure, cube_query
-      measure.selectors.empty? ? Arel.star.count : Arel.star.countIf(measure.condition_query arel_table, cube_query)
-    end
-
-  end
-end

data/lib/activecube/common/sum.rb

@@ -1,11 +0,0 @@
-module Activecube::Common
-
-  class Sum < Activecube::Metric
-
-    def expression arel_table, measure, cube_query
-      column = arel_table[self.class.column_name.to_sym]
-      measure.selectors.empty? ? column.sum : column.sumIf(measure.condition_query arel_table, cube_query)
-    end
-
-  end
-end