activecube 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a7d156d972363abe7b4b6fcd10ca0198701ffae6378546ec8d9d6167ffbd031
-  data.tar.gz: 3cb7a21db62dd00b5047db0625e429462f8d2654d54395f74cd1833500a896a7
+  metadata.gz: baf4f5a3146bb1c03244f62328b0af901ae7882e41ff4234a86e1deb6cd881a9
+  data.tar.gz: 44ca0d2eefbf2b4cc38e95aa9ab2b352607b4817b5c5aaebce8b2a04022037f6
 SHA512:
-  metadata.gz: 15afed4e4c5f034fa0284ae345486e4783ed50fa4a2c525b7c03dd4fa06ab44ddd732eb74b9c3a4cab7efa4bd56fdf2d23b6e361f9fd565c23976bb85374997d
-  data.tar.gz: 845d64b1bbd1a555c3ff8273f96769021baffe84768e4db792ad579e3d548acd6e2a7634565902d7b643af81600cf57379ea6ab3dbdd99f9a6e656a552de5f3b
+  metadata.gz: ac3b3dd34000d54054eba5a0fc7b6aa9803f7643f4f1cc67c88fc603c9e34d07a7ae7ef2eed755efca7bdcd60f532c25b67962b45f20550df98bcb2fc2e13a19
+  data.tar.gz: 408881f9f8f5c3c3b2af544f320846f8f9765cf3f9673e196c9d2f32555901c221539786eb4c3fa487a082f1d62bf2939442f836fe73cdf6e559bea4ba5f8945

data/.idea/workspace.xml

@@ -10,10 +10,7 @@
     <select />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="77368870-4045-496a-9737-2c7f83086a16" name="Default Changelist" comment="initial implementation">
-      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/activecube.gemspec" beforeDir="false" afterPath="$PROJECT_DIR$/activecube.gemspec" afterDir="false" />
-    </list>
+    <list default="true" id="77368870-4045-496a-9737-2c7f83086a16" name="Default Changelist" comment="initial implementation" />
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
     <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
@@ -31,11 +28,20 @@
   <component name="PropertiesComponent">
     <property name="WebServerToolWindowFactoryState" value="false" />
     <property name="last_opened_file_path" value="$PROJECT_DIR$/lib/activecube" />
+    <property name="node.js.detected.package.eslint" value="true" />
+    <property name="node.js.detected.package.tslint" value="true" />
+    <property name="node.js.path.for.package.eslint" value="project" />
+    <property name="node.js.path.for.package.tslint" value="project" />
+    <property name="node.js.selected.package.eslint" value="(autodetect)" />
+    <property name="node.js.selected.package.tslint" value="(autodetect)" />
     <property name="nodejs_interpreter_path.stuck_in_default_project" value="undefined stuck path" />
     <property name="nodejs_npm_path_reset_for_default_project" value="true" />
     <property name="settings.editor.selected.configurable" value="preferences.lookFeel" />
   </component>
   <component name="RecentsManager">
+    <key name="MoveFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$/lib/activecube" />
+    </key>
     <key name="CopyFile.RECENT_KEYS">
       <recent name="$PROJECT_DIR$/lib/activecube" />
     </key>
@@ -51,7 +57,7 @@
       <option name="number" value="Default" />
       <option name="presentableId" value="Default" />
       <updated>1581885096407</updated>
-      <workItem from="1581885099890" duration="963000" />
+      <workItem from="1581885099890" duration="3547000" />
     </task>
     <task id="LOCAL-00001" summary="initial commit">
       <created>1581885128091</created>
@@ -67,7 +73,28 @@
       <option name="project" value="LOCAL" />
       <updated>1581885329956</updated>
     </task>
-    <option name="localTasksCounter" value="3" />
+    <task id="LOCAL-00003" summary="initial implementation">
+      <created>1581886068687</created>
+      <option name="number" value="00003" />
+      <option name="presentableId" value="LOCAL-00003" />
+      <option name="project" value="LOCAL" />
+      <updated>1581886068687</updated>
+    </task>
+    <task id="LOCAL-00004" summary="initial implementation">
+      <created>1581888304903</created>
+      <option name="number" value="00004" />
+      <option name="presentableId" value="LOCAL-00004" />
+      <option name="project" value="LOCAL" />
+      <updated>1581888304904</updated>
+    </task>
+    <task id="LOCAL-00005" summary="initial implementation">
+      <created>1581888510999</created>
+      <option name="number" value="00005" />
+      <option name="presentableId" value="LOCAL-00005" />
+      <option name="project" value="LOCAL" />
+      <updated>1581888510999</updated>
+    </task>
+    <option name="localTasksCounter" value="6" />
     <servers />
   </component>
   <component name="TypeScriptGeneratedFilesManager">
@@ -90,22 +117,26 @@
     <option name="LAST_COMMIT_MESSAGE" value="initial implementation" />
   </component>
   <component name="WindowStateProjectService">
-    <state width="1207" height="201" key="GridCell.Tab.0.bottom" timestamp="1581885116972">
+    <state width="1207" height="48" key="GridCell.Tab.0.bottom" timestamp="1581888894138">
+      <screen x="0" y="23" width="1440" height="786" />
+    </state>
+    <state width="1207" height="48" key="GridCell.Tab.0.bottom/0.23.1440.786@0.23.1440.786" timestamp="1581888894138" />
+    <state width="1207" height="48" key="GridCell.Tab.0.center" timestamp="1581888894135">
       <screen x="0" y="23" width="1440" height="786" />
     </state>
-    <state width="1207" height="201" key="GridCell.Tab.0.bottom/0.23.1440.786@0.23.1440.786" timestamp="1581885116972" />
-    <state width="1207" height="201" key="GridCell.Tab.0.center" timestamp="1581885116972">
+    <state width="1207" height="48" key="GridCell.Tab.0.center/0.23.1440.786@0.23.1440.786" timestamp="1581888894135" />
+    <state width="1207" height="48" key="GridCell.Tab.0.left" timestamp="1581888894133">
       <screen x="0" y="23" width="1440" height="786" />
     </state>
-    <state width="1207" height="201" key="GridCell.Tab.0.center/0.23.1440.786@0.23.1440.786" timestamp="1581885116972" />
-    <state width="1207" height="201" key="GridCell.Tab.0.left" timestamp="1581885116971">
+    <state width="1207" height="48" key="GridCell.Tab.0.left/0.23.1440.786@0.23.1440.786" timestamp="1581888894133" />
+    <state width="1207" height="48" key="GridCell.Tab.0.right" timestamp="1581888894136">
       <screen x="0" y="23" width="1440" height="786" />
     </state>
-    <state width="1207" height="201" key="GridCell.Tab.0.left/0.23.1440.786@0.23.1440.786" timestamp="1581885116971" />
-    <state width="1207" height="201" key="GridCell.Tab.0.right" timestamp="1581885116972">
+    <state width="1207" height="48" key="GridCell.Tab.0.right/0.23.1440.786@0.23.1440.786" timestamp="1581888894136" />
+    <state x="537" y="156" key="Vcs.Push.Dialog.v2" timestamp="1581888518182">
       <screen x="0" y="23" width="1440" height="786" />
     </state>
-    <state width="1207" height="201" key="GridCell.Tab.0.right/0.23.1440.786@0.23.1440.786" timestamp="1581885116972" />
+    <state x="537" y="156" key="Vcs.Push.Dialog.v2/0.23.1440.786@0.23.1440.786" timestamp="1581888518182" />
     <state x="352" y="201" width="819" height="558" key="find.popup" timestamp="1581885294826">
       <screen x="0" y="23" width="1440" height="786" />
     </state>

data/Gemfile

@@ -4,3 +4,8 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in activecube.gemspec
 gemspec
+
+
+group :test do
+  gem 'clickhouse-activerecord', git: 'https://github.com/bitquery/clickhouse-activerecord.git'
+end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+GIT
+  remote: https://github.com/bitquery/clickhouse-activerecord.git
+  revision: 14e02bb475bb4974cc4d853b055b147fe4d59171
+  specs:
+    clickhouse-activerecord (0.3.9)
+      activerecord (>= 5.2)
+      bundler (>= 1.13.4)
+
+PATH
+  remote: .
+  specs:
+    activecube (0.1.0)
+      activerecord (>= 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activecube!
+  bundler (~> 1.17)
+  clickhouse-activerecord!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -39,7 +39,124 @@ Or install it yourself as:
 
 ## Usage
 
-TBD
+Basic steps to use ActiveCube are:
+
+1. Define your database schema in models, as you do with Rails
+2. Setup connection properties to data warehouse in config/database.yml. You can use multiple connections 
+if you use Rails 6 or higher
+3. Define cubes in models, sub-classed from Activecube::Base. Look 
+[spec/models/test/transfers_cube.rb](spec/models/test/transfers_cube.rb) as example
+4. Make queries to the cubes
+
+Check [spec/cases/activecube_spec.rb](spec/cases/activecube_spec.rb) for more examples.
+
+
+### Cube definition 
+
+Cube defined using the following attributes:
+
+- **table** specifies, which physical database tables can be considered to query
+```ruby
+    table TransfersCurrency
+    table TransfersFrom
+    table TransfersTo
+```
+
+- **dimension** specifies classes used for slicing the cube
+
+```ruby
+    dimension date: Dimension::Date,
+              currency: Dimension::Currency
+```
+
+Or 
+
+```ruby
+    dimension date: Dimension::Date
+    dimension currency: Dimension::Currency
+```
+
+- **metric** specifies which results expected from the cube queries
+
+```ruby
+    metric amount: Metric::Amount,
+           count: Metric::Count
+```
+
+Or
+
+```ruby
+    metric amount: Metric::Amount
+    metric count: Metric::Count
+```
+
+- **selector** is a set of expressions, which can filter results
+
+```ruby
+    selector currency: CurrencySelector,
+             transfer_from: TransferFromSelector,
+             transfer_to: TransferToSelector
+```
+
+### Table definition
+
+Tables are defined as regular active records, with additional optional attribute 'index':
+```ruby
+index 'currency_id', cardinality: 4
+```
+
+which means that the table has an index onm currency_id field, with average number of different entries
+of 10,000 ( 10^4). This creates a hint for optimizer to build queries.
+
+Indexes can span multiple fields, as
+
+```ruby
+index ['currency_id','date'], cardinality: 6
+```
+
+Note, that if you created combined index in database, you most probable will need to define all
+indexed combinations, for example:
+
+```ruby
+index ['currency_id'], cardinality: 4
+index ['currency_id','date'], cardinality: 6
+```
+
+### Query language
+
+You use the cube class to create and execute queries.
+
+Queries can be expressed as Arel query, SQL or executed against the database, returning results.
+
+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
+
+After the query contructed, the following methods can be applied:
+
+- **to_sql** to generate String SQL query from cube query
+- **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 
+ActiveRecord standard API:
+
+```ruby
+
+ApplicationRecord.connected_to(database: :data_warehouse) do
+      cube = My::TransfersCube
+      cube.slice(
+              date: cube.dimensions[:date][:date].format('%Y-%m'),
+              currency: cube.dimensions[:currency][:symbol]
+      ).measure(:count).query
+    end
+```
+
+will query using data_warehouse configuraton.
+
 
 ## Development
 
@@ -47,9 +164,20 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## RSPec tests
+
+
+To run tests, you need clickhouse server installation.
+Tests use database 'test' that have to be created in clickhouse as:
+```sql
+CREATE DATABASE test;
+```
+Check credentials for connection in [spec/spec_helper.rb](spec/spec_helper.rb) file.
+By default clickhouse must reside on "clickhouse" server name, port 8123 with the default user access open.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activecube. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/bitquery/activecube. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -57,4 +185,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Activecube project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/activecube/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Activecube project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bitquery/activecube/blob/master/CODE_OF_CONDUCT.md).

data/lib/activecube.rb

@@ -1,6 +1,19 @@
 require "activecube/version"
+require 'activecube/active_record_extension'
+
+require 'activecube/base'
+require 'activecube/dimension'
+require 'activecube/metric'
+require 'activecube/selector'
+
+require 'activecube/common/count'
+require 'activecube/common/sum'
+
+require 'active_record'
 
 module Activecube
-  class Error < StandardError; end
-  # Your code goes here...
+
+  # include the extension
+  ActiveRecord::Base.send(:include, Activecube::ActiveRecordExtension)
+
 end

data/lib/activecube/active_record_extension.rb

@@ -15,6 +15,3 @@ module Activecube::ActiveRecordExtension
   end
 
 end
-
-# include the extension
-ActiveRecord::Base.send(:include, Activecube::ActiveRecordExtension)

data/lib/activecube/base.rb

@@ -1,3 +1,6 @@
+require 'activecube/cube_definition'
+require 'activecube/query_methods'
+
 module Activecube
   class Base
     extend CubeDefinition

data/lib/activecube/{clickhouse/metric → common}/count.rb

@@ -1,4 +1,4 @@
-module Activecube::Clickhouse::Metric
+module Activecube::Common
 
   class Count < Activecube::Metric
 

data/lib/activecube/{clickhouse/metric → common}/sum.rb

@@ -1,4 +1,4 @@
-module Activecube::Clickhouse::Metric
+module Activecube::Common
 
   class Sum < Activecube::Metric
 

data/lib/activecube/dimension.rb

@@ -1,3 +1,5 @@
+require 'activecube/dimension_definition_methods'
+
 module Activecube
   class Dimension
     extend DimensionDefinitionMethods

data/lib/activecube/dimension_definition_methods.rb

@@ -1,3 +1,6 @@
+require 'activecube/cube_definition'
+require 'activecube/field'
+
 module Activecube
   module DimensionDefinitionMethods
 

data/lib/activecube/metric.rb

@@ -1,3 +1,5 @@
+require 'activecube/dimension_definition_methods'
+
 module Activecube
   class Metric
     extend DimensionDefinitionMethods

data/lib/activecube/processor/composer.rb

@@ -1,3 +1,8 @@
+require 'activecube/processor/index'
+require 'activecube/processor/measure_tables'
+require 'activecube/processor/optimizer'
+require 'activecube/processor/table'
+
 module Activecube::Processor
   class Composer
 

data/lib/activecube/processor/optimizer.rb

@@ -8,11 +8,12 @@ module Activecube::Processor
     attr_reader :tables_count, :metrics_count, :cost_matrix
     def initialize cost_matrix
       @cost_matrix = cost_matrix
+      @cache = ActiveSupport::Cache::MemoryStore.new
     end
 
     def optimize
 
-      Rails.cache.fetch(cost_matrix, expires_in: 12.hours) do
+      @cache.fetch(cost_matrix, expires_in: 12.hours) do
 
         @tables_count = cost_matrix.map(&:count).max
         @metrics_count = cost_matrix.count

data/lib/activecube/query/cube_query.rb

@@ -1,3 +1,14 @@
+require 'activecube/query/chain_appender'
+require 'activecube/query/item'
+require 'activecube/query/limit'
+require 'activecube/query/measure'
+require 'activecube/query/or_selector'
+require 'activecube/query/ordering'
+require 'activecube/query/selector'
+require 'activecube/query/slice'
+
+require 'activecube/processor/composer'
+
 module Activecube::Query
   class CubeQuery
 

data/lib/activecube/query/or_selector.rb

@@ -1,3 +1,5 @@
+require 'activecube/query/selector'
+
 module Activecube
   module Query
     class OrSelector < Selector

data/lib/activecube/query/selector.rb

@@ -80,5 +80,3 @@ module Activecube::Query
 
   end
 end
-
-Arel::Nodes::SqlLiteral

data/lib/activecube/query_methods.rb

@@ -1,3 +1,5 @@
+require 'activecube/query/cube_query'
+
 module Activecube
   module QueryMethods
 

data/lib/activecube/selector.rb

@@ -1,3 +1,5 @@
+require 'activecube/dimension_definition_methods'
+
 module Activecube
   class Selector
     extend DimensionDefinitionMethods

data/lib/activecube/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activecube
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Aleksey Studnev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-16 00:00:00.000000000 Z
+date: 2020-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -81,6 +81,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -90,8 +91,8 @@ files:
 - lib/activecube.rb
 - lib/activecube/active_record_extension.rb
 - lib/activecube/base.rb
-- lib/activecube/clickhouse/metric/count.rb
-- lib/activecube/clickhouse/metric/sum.rb
+- lib/activecube/common/count.rb
+- lib/activecube/common/sum.rb
 - lib/activecube/cube_definition.rb
 - lib/activecube/dimension.rb
 - lib/activecube/dimension_definition_methods.rb