tailor_made 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 863305812d05db9660d68bf6792229fb6342287677b2ba35c2c894c159d96e21
-  data.tar.gz: bfcb7f8f175ae9dc099df303e2073352aa22529c8ebd9e83da50c97f54be8f63
+  metadata.gz: a9f46aa45e613f20e586a3f4ad9a87fbdc185c3a9d969885118556cc0c6f595f
+  data.tar.gz: 4025cca62e8d7565631f52e47b6be75f8c04ac42512f35138ca4f752716e5f22
 SHA512:
-  metadata.gz: b5b39873f2ab75d2a6787658d78538400a0b6251d45a48eb3c9fba042a237020b67a60a3e6619f25aa51a14563b4cc5b9db4ed263f1ab42e8f22a414931da3b3
-  data.tar.gz: ea191ba8ef5e24b3a6516007128370129d10fe88bb8d55d33d60c9135965dab49df1168377ebeb55fc78923671650c6f1ce6160a9d50d6759e8d01c53391554c
+  metadata.gz: 986def9764595200ed0d96a67d2816925ad881a1358beb85fb78561ed6b8bb97745792898ca0d5231ad82d1ab262bfbaa983de20b47927eee73ecc3dc04b6bdb
+  data.tar.gz: 7fe081b943bceb130ecd5f7b772a461c4f71fd190db4019169e01e87a528a0ebcec89cf867a12400bdc4ff31c4b5ed2486ab95b4af7e93edce0db5a77533f878

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+## TailorMade 0.2.0 (March 23, 2019) ##
+
+*   Add generators.
+
+    For example:
+
+    ```
+      bin/rails g tailor_made:dashboard Ahoy::Visits
+    ```
+
+    Generates a controller, query class and adds views.
+
+    *Pedro Carmona*
+
+*   Fix metaprogramming.
+
+    Was creating the arrays in the base query class, moved declaration to children.
+
+    *Pedro Carmona*
+
+
+## TailorMade 0.1.0 (March 17, 2019) ##
+
+*   Initial source code

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    tailor_made (0.1.0)
+    tailor_made (0.2.0)
       activerecord (>= 4.2)
+      groupdate (~> 4.1.1)
+      pagy (>= 2.1.2)
       railties (>= 4.2)
 
 GEM
@@ -57,6 +59,8 @@ GEM
     erubi (1.8.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
+    groupdate (4.1.1)
+      activesupport (>= 4.2)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     loofah (2.2.3)
@@ -74,6 +78,7 @@ GEM
     nio4r (2.3.1)
     nokogiri (1.10.1)
       mini_portile2 (~> 2.4.0)
+    pagy (2.1.3)
     rack (2.0.6)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)

data/README.md

@@ -2,8 +2,24 @@
 
 Currently in development.
 
-Gem to query and plot grouped data. Makes it easy for people without sql knowledge to explore data.
-Uses active record.
+Business intelligence for humans. This gem allows to create dashboards, based on query objects and plot one measure of the grouped data. Makes it easy for people without sql knowledge to explore data. Uses active record.
+
+You will:
+
+  - Build and edit reports in minutes ([view usage](#usage))
+
+You should:
+
+  - Build reports on top of materialized views for performance
+  - Create a dedicated rails app for analytics (blazer, tailor_made, smashing, scenic).
+  - Test your dashboards data, for visibility when they start failing
+
+You could:
+
+  - And custom external data for correlation (advertising campaign spent, etc)
+  - Add input tables - pull data to input tables, or let it be pushed
+  - Join data in a materialized view in scenic. Refresh daily
+
 
 ## Installation
 
@@ -21,16 +37,119 @@ Or install it yourself as:
 
     $ gem install tailor_made
 
+Add pagy in app/helpers/application_helper.rb
+
+```ruby
+module ApplicationHelper
+  include Pagy::Frontend
+```
+
+Two ways:
+
+1. Add assets gems:
+
+```ruby
+# gem "selectize-rails" # and follow its instruction
+# gem "chartkick" # and follow its instruction
+# gem "flatpickr" # include also rangePlugin
+```
+Then you need to add statments to application.scss.
+
+Otherwise:
+
+2. Webpacker packages
+
+```
+  $ yarn add chartkick chart.js flatpickr selectize
+```
+
+2. Webpacker: /app/javascript/packs/application.js
+
+```js
+// tailor_made
+import jquery from 'jquery'
+import Chartkick from 'chartkick'
+import Chart from 'chart.js'
+import 'flatpickr'
+import rangePlugin from 'flatpickr/dist/plugins/rangePlugin'
+import "flatpickr/dist/flatpickr.css";
+import 'selectize'
+import "selectize/dist/css/selectize.css";
+import "selectize/dist/css/selectize.bootstrap3.css";
+Chartkick.addAdapter(Chart)
+window.Chartkick = Chartkick
+window.rangePlugin = rangePlugin
+window.jquery = jquery
+window.$ = jquery
+```
+
+2. Webpack: /app/assets/stylesheets/application.scss
+
+```scss
+@import "flatpickr/dist/flatpickr.css";
+@import "selectize/dist/css/selectize.css";
+@import "selectize/dist/css/selectize.bootstrap3.css";
+```
 ## Usage
 
-TODO: Write usage instructions here
+Create your first dashboard:
 
-## Development
+    $ bin/rails g tailor_made:dashboard Ahoy::Visit
 
-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.
 
-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).
+Then you can add the following statments to your query `rails_root/app/queries/tailor_made/ahoy/visit_query.rb`:
+
+
+```ruby
+  module TailorMade
+    class Ahoy::VisitQuery < TailorMade::Query
+      # creates attr_accessors for dimensions, measures and filters
+      include TailorMade::Methods
+
+      datetime_dimension :started_at, permit: [:day, :day_of_week, :day_of_month, :week, :month_of_year]
+      dimension(
+        :device_type,
+        domain: -> { Ahoy::Visits.all.pluck("DISTINCT device_type") }
+      )
+      dimension :referring_domain
+      dimension :utm_campaign
+      dimension :utm_content
+      dimension :utm_medium
+      dimension :utm_source
+      dimension :utm_term
+      measure :users_count, formula: "COUNT(user_id)"
+      measure :visits_count, formula: "COUNT(id)"
+
+      def default_dimensions
+        [:device_type]
+      end
+
+      def default_measures
+        [:visits_count, :users_count]
+      end
+
+      def initialize(attributes={})
+        super
+        @started_at_starts_at ||= Date.today.beginning_of_month
+        @started_at_ends_at   ||= Date.today
+      end
+
+      def from
+        ::Ahoy::Visit.all
+      end
+    end
+  end
+```
+
+Visit `http://localhost:3000/tailor_made/ahoy/visits`.
+
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tailor_made.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pedrocarmona/tailor_made.
+
+## TODO:
+
+- [ ] fix plot group by (n+1 queries not required).
+- [ ] plot and selectize in different request (caching, etc)
+- [ ] show row with totals (unique dimensions, sum without grouping)

data/lib/generators/tailor_made/dashboard/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate dashboard Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/tailor_made/dashboard/dashboard_generator.rb

@@ -0,0 +1,44 @@
+require "rails/generators/named_base"
+require 'active_support/inflector'
+
+class TailorMade::DashboardGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  class_option :namespace, type: :string, default: "tailor_made"
+
+  def create_resource_query
+    queries_dir = Rails.root.join("app/queries/#{namespace}")
+    FileUtils.mkdir_p(queries_dir) unless File.directory?(queries_dir)
+    destination = Rails.root.join(
+      "app/queries/#{namespace}/#{regular_file_path}_query.rb",
+    )
+
+    template("query.rb.erb", destination)
+  end
+
+  def create_resource_controller
+    destination = Rails.root.join(
+      "app/controllers/#{namespace}/#{regular_file_path.pluralize}_controller.rb",
+    )
+
+    template("controller.rb.erb", destination)
+  end
+
+  def create_resource_view
+    destination = Rails.root.join(
+      "app/views/#{namespace}/#{regular_file_path.pluralize}/index.html.erb",
+    )
+
+    copy_file("index.html.erb", destination)
+  end
+
+  private
+
+  def namespace
+    options['namespace']
+  end
+
+  def regular_file_path
+    (regular_class_path + [file_name]).map!(&:camelize).join("::").underscore
+  end
+end

data/lib/generators/tailor_made/dashboard/templates/controller.rb.erb

@@ -0,0 +1,22 @@
+module <%= namespace.classify %>
+  class <%= class_name.pluralize %>Controller < ApplicationController
+    include Pagy::Backend
+
+    before_action :set_query
+
+    def index
+      @pagy, @records = pagy(@query.all)
+    end
+
+    private
+
+    def set_query
+      @query = <%= namespace.classify %>::<%= class_name %>Query.new(query_params)
+    end
+
+    def query_params
+      return {} if params[:q].nil?
+      params[:q].permit(<%= namespace.classify %>::<%= class_name %>Query.permitted_attributes)
+    end
+  end
+end

data/lib/generators/tailor_made/dashboard/templates/index.html.erb

@@ -0,0 +1,158 @@
+<div class="row col-md-12 mr-sm-auto col-lg-12 pt-5">
+  <main role="main" class="col-md-9 mr-sm-auto col-lg-10 px-4">
+    <%#= pie_chart @query.plot %>
+    <%= send(@query.chart, @query.plot) %>
+
+    <div class="row justify-content-center border-bottom">
+      <h4 class="h4 text-center"><%= @query.plot_measure.to_s.titleize %></h4>
+    </div>
+
+    <div class="table-responsive mt-4">
+      <table class="table table-striped table-sm">
+        <thead>
+          <tr>
+            <% @query.table_columns.each do |column| %>
+              <th><%= column %></th>
+            <% end %>
+          </tr>
+        </thead>
+        <tbody>
+          <% @records.each do |row| %>
+            <tr>
+              <% @query.table_columns.each do |column| %>
+                <% cell = @query.tabelize(row, column) %>
+                <th>
+                  <% if cell.is_a?(Array) %>
+                    <%= link_to(cell[0], cell[1]) %>
+                  <% else %>
+                    <%= cell %>
+                  <% end %>
+                </th>
+              <% end %>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+    <%= pagy_bootstrap_nav(@pagy).html_safe %>
+  </main>
+
+  <nav class="col-md-3 col-lg-2 ml-sm-auto d-md-block bg-light sidebar">
+    <div class="sidebar-sticky">
+      <h4 class="mb-3 pt-3">Filters</h4>
+      <%= form_for(@query, as: :q, url: url_for(only_path: true), method: :get) do |f| %>
+       <div class="form-group">
+          <%= f.label :chart %>
+          <%=
+            f.select(
+              :chart,
+              options_for_select(
+                @query.options_for_select[:chart],
+                @query.chart
+              ),
+              {},
+              { :class => 'selectize', :onchange => 'if(this.value.length>0)this.form.submit();' }
+            )
+          %>
+        </div>
+        <div class="form-group">
+          <%= f.label :plot_measure %>
+          <%=
+            f.select(
+              :plot_measure,
+              options_for_select(
+                @query.options_for_select[:plot_measure],
+                @query.plot_measure
+              ),
+              {},
+              { :class => 'selectize', :onchange => 'if(this.value.length>0)this.form.submit();' }
+            )
+          %>
+        </div>
+        <hr class="mb-4">
+        <% @query.class.tailor_made_canonical_dimensions.each do |dimension| %>
+          <div class="form-group">
+            <%= f.label "#{dimension}".to_sym %>
+            <% if @query.options_for_select["#{dimension}".to_sym].nil? %>
+              <%= f.text_field "#{dimension}".to_sym, class: "form-control", :value => @query.send("#{dimension}".to_sym).try(:iso8601) %>
+            <% else %>
+              <%=
+                f.select(
+                  :host,
+                  options_for_select(@query.options_for_select["#{dimension}".to_sym], @query.send("#{dimension}".to_sym)),
+                  { include_blank: true },
+                  { :class => 'selectize' }
+                )
+              %>
+            <% end %>
+          </div>
+        <% end %>
+
+        <% @query.class.tailor_made_datetime_columns.each do |dimension| %>
+          <div class="form-group">
+            <%= f.label "#{dimension}_starts_at".to_sym, class: "label-control" %>
+            <%= f.text_field "#{dimension}_starts_at".to_sym, class: "form-control datepicker", :value => @query.send("#{dimension}_starts_at".to_sym).try(:iso8601), "data-date-locale" => "#{I18n.locale}" %>
+          </div>
+          <div class="form-group">
+            <%= f.label "#{dimension}_ends_at".to_sym, class: "label-control" %>
+            <%= f.text_field "#{dimension}_ends_at".to_sym, class: "form-control datepicker", :value => @query.send("#{dimension}_ends_at".to_sym).try(:iso8601), "data-date-locale" => "#{I18n.locale}" %>
+          </div>
+        <% end %>
+
+        <div class="form-group">
+          <%= f.label :dimensions %>
+          <%=
+            f.select(
+              :dimensions,
+              options_for_select(@query.options_for_select[:dimensions], nil),
+              {},
+              { :multiple => true, :class => 'custom-selectize' }
+            )
+          %>
+        </div>
+        <div class="form-group">
+          <%= f.label :measures %>
+          <%=
+            f.select(
+              :measures,
+              options_for_select(@query.options_for_select[:measures], nil),
+              {},
+              { :multiple => true, :class => 'custom-selectize' }
+            )
+          %>
+        </div>
+        <hr class="mb-4">
+        <div class="form-group">
+          <%= f.submit 'Search', class: "btn btn-primary btn-lg btn-block" %>
+        </div>
+      <% end %>
+    </div>
+  </nav>
+</div>
+
+<script type="text/javascript">
+  document.addEventListener('turbolinks:load', function() {
+    <% @query.class.tailor_made_datetime_columns.each do |dimension| %>
+      flatpickr("#q_<%= dimension.to_s %>_starts_at", {
+        enableTime: false,
+        "plugins": [
+          new rangePlugin({ input: "#q_<%= dimension.to_s %>_ends_at" })
+        ]
+      });
+    <% end %>
+
+    $('.selectize').selectize({
+      create: true
+    });
+
+    $('#q_dimensions').selectize({
+      create: true,
+      items: <%= @query.dimensions.to_json.html_safe %>
+    });
+
+    $('#q_measures').selectize({
+      create: true,
+      items: <%= @query.measures.to_json.html_safe %>
+    });
+  })
+</script>

data/lib/generators/tailor_made/dashboard/templates/query.rb.erb

@@ -0,0 +1,18 @@
+module <%= namespace.classify %>
+  class <%= class_name %>Query < TailorMade::Query
+    # creates attr_accessors for dimensions, measures and filters
+    include TailorMade::Methods
+
+    def default_dimensions
+      fail(NotImplementedError)
+    end
+
+    def default_measures
+      fail(NotImplementedError)
+    end
+
+    def from
+      fail(NotImplementedError)
+    end
+  end
+end

data/lib/groupdate/group_alias.rb

@@ -0,0 +1,5 @@
+module Groupdate
+  module GroupAlias
+    attr_accessor :relation, :name
+  end
+end

data/lib/groupdate/relation_builder.rb

@@ -0,0 +1,191 @@
+module Groupdate
+  class RelationBuilder
+    attr_reader :period, :column, :day_start, :week_start
+
+    def initialize(relation, column:, period:, time_zone:, time_range:, week_start:, day_start:)
+      @relation = relation
+      @alias_name = [column, period].join("_")
+      @column = resolve_column(relation, column)
+      @period = period
+      @time_zone = time_zone
+      @time_range = time_range
+      @week_start = week_start
+      @day_start = day_start
+
+      if relation.default_timezone == :local
+        raise Groupdate::Error, "ActiveRecord::Base.default_timezone must be :utc to use Groupdate"
+      end
+    end
+
+    def generate
+      clause = group_clause
+      clause.extend(::Groupdate::GroupAlias)
+      clause.relation = @relation.arel_table
+      clause.name = @alias_name
+      @relation.group(clause).where(*where_clause)
+    end
+
+    private
+
+    def group_clause
+      time_zone = @time_zone.tzinfo.name
+      adapter_name = @relation.connection.adapter_name
+      query =
+        case adapter_name
+        when "MySQL", "Mysql2", "Mysql2Spatial", 'Mysql2Rgeo'
+          case period
+          when :day_of_week
+            ["DAYOFWEEK(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?)) - 1", time_zone]
+          when :hour_of_day
+            ["(EXTRACT(HOUR from CONVERT_TZ(#{column}, '+00:00', ?)) + 24 - #{day_start / 3600}) % 24", time_zone]
+          when :minute_of_hour
+            ["(EXTRACT(MINUTE from CONVERT_TZ(#{column}, '+00:00', ?)))", time_zone]
+          when :day_of_month
+            ["DAYOFMONTH(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?))", time_zone]
+          when :month_of_year
+            ["MONTH(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?))", time_zone]
+          when :week
+            ["CONVERT_TZ(DATE_FORMAT(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL ((#{7 - week_start} + WEEKDAY(CONVERT_TZ(#{column}, '+00:00', ?) - INTERVAL #{day_start} second)) % 7) DAY) - INTERVAL #{day_start} second, '+00:00', ?), '%Y-%m-%d 00:00:00') + INTERVAL #{day_start} second, ?, '+00:00')", time_zone, time_zone, time_zone]
+          when :quarter
+            ["DATE_ADD(CONVERT_TZ(DATE_FORMAT(DATE(CONCAT(EXTRACT(YEAR FROM CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?)), '-', LPAD(1 + 3 * (QUARTER(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?)) - 1), 2, '00'), '-01')), '%Y-%m-%d %H:%i:%S'), ?, '+00:00'), INTERVAL #{day_start} second)", time_zone, time_zone, time_zone]
+          else
+            format =
+              case period
+              when :second
+                "%Y-%m-%d %H:%i:%S"
+              when :minute
+                "%Y-%m-%d %H:%i:00"
+              when :hour
+                "%Y-%m-%d %H:00:00"
+              when :day
+                "%Y-%m-%d 00:00:00"
+              when :month
+                "%Y-%m-01 00:00:00"
+              else # year
+                "%Y-01-01 00:00:00"
+              end
+
+            ["DATE_ADD(CONVERT_TZ(DATE_FORMAT(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?), '#{format}'), ?, '+00:00'), INTERVAL #{day_start} second)", time_zone, time_zone]
+          end
+        when "PostgreSQL", "PostGIS"
+          case period
+          when :day_of_week
+            ["EXTRACT(DOW from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} second')::integer", time_zone]
+          when :hour_of_day
+            ["EXTRACT(HOUR from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} second')::integer", time_zone]
+          when :minute_of_hour
+            ["EXTRACT(MINUTE from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} second')::integer", time_zone]
+          when :day_of_month
+            ["EXTRACT(DAY from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} second')::integer", time_zone]
+          when :month_of_year
+            ["EXTRACT(MONTH from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} second')::integer", time_zone]
+          when :week # start on Sunday, not PostgreSQL default Monday
+            ["(DATE_TRUNC('#{period}', (#{column}::timestamptz - INTERVAL '#{week_start} day' - INTERVAL '#{day_start} second') AT TIME ZONE ?) + INTERVAL '#{week_start} day' + INTERVAL '#{day_start} second') AT TIME ZONE ?", time_zone, time_zone]
+          else
+            ["(DATE_TRUNC('#{period}', (#{column}::timestamptz - INTERVAL '#{day_start} second') AT TIME ZONE ?) + INTERVAL '#{day_start} second') AT TIME ZONE ?", time_zone, time_zone]
+          end
+        when "SQLite"
+          raise Groupdate::Error, "Time zones not supported for SQLite" unless @time_zone.utc_offset.zero?
+          raise Groupdate::Error, "day_start not supported for SQLite" unless day_start.zero?
+          raise Groupdate::Error, "week_start not supported for SQLite" unless week_start == 6
+
+          if period == :week
+            ["strftime('%%Y-%%m-%%d 00:00:00 UTC', #{column}, '-6 days', 'weekday 0')"]
+          else
+            format =
+              case period
+              when :hour_of_day
+                "%H"
+              when :minute_of_hour
+                "%M"
+              when :day_of_week
+                "%w"
+              when :day_of_month
+                "%d"
+              when :month_of_year
+                "%m"
+              when :second
+                "%Y-%m-%d %H:%M:%S UTC"
+              when :minute
+                "%Y-%m-%d %H:%M:00 UTC"
+              when :hour
+                "%Y-%m-%d %H:00:00 UTC"
+              when :day
+                "%Y-%m-%d 00:00:00 UTC"
+              when :month
+                "%Y-%m-01 00:00:00 UTC"
+              when :quarter
+                raise Groupdate::Error, "Quarter not supported for SQLite"
+              else # year
+                "%Y-01-01 00:00:00 UTC"
+              end
+
+            ["strftime('#{format.gsub(/%/, '%%')}', #{column})"]
+          end
+        when "Redshift"
+          case period
+          when :day_of_week
+            ["EXTRACT(DOW from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
+          when :hour_of_day
+            ["EXTRACT(HOUR from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
+          when :minute_of_hour
+            ["EXTRACT(MINUTE from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
+          when :day_of_month
+            ["EXTRACT(DAY from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
+          when :month_of_year
+            ["EXTRACT(MONTH from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
+          when :week # start on Sunday, not Redshift default Monday
+            # Redshift does not return timezone information; it
+            # always says it is in UTC time, so we must convert
+            # back to UTC to play properly with the rest of Groupdate.
+            #
+            ["CONVERT_TIMEZONE(?, 'Etc/UTC', DATE_TRUNC(?, CONVERT_TIMEZONE(?, #{column}) - INTERVAL '#{week_start} day' - INTERVAL '#{day_start} second'))::timestamp + INTERVAL '#{week_start} day' + INTERVAL '#{day_start} second'", time_zone, period, time_zone]
+          else
+            ["CONVERT_TIMEZONE(?, 'Etc/UTC', DATE_TRUNC(?, CONVERT_TIMEZONE(?, #{column}) - INTERVAL '#{day_start} second'))::timestamp + INTERVAL '#{day_start} second'", time_zone, period, time_zone]
+          end
+        else
+          raise Groupdate::Error, "Connection adapter not supported: #{adapter_name}"
+        end
+
+      if adapter_name == "MySQL" && period == :week
+        query[0] = "CAST(#{query[0]} AS DATETIME)"
+      end
+
+      clause = @relation.send(:sanitize_sql_array, query)
+
+      # cleaner queries in logs
+      clause = clean_group_clause_postgresql(clause)
+      clean_group_clause_mysql(clause)
+    end
+
+    def clean_group_clause_postgresql(clause)
+      clause.gsub(/ (\-|\+) INTERVAL '0 second'/, "")
+    end
+
+    def clean_group_clause_mysql(clause)
+      clause = clause.gsub("DATE_SUB(#{column}, INTERVAL 0 second)", "#{column}")
+      if clause.start_with?("DATE_ADD(") && clause.end_with?(", INTERVAL 0 second)")
+        clause = clause[9..-21]
+      end
+      clause
+    end
+
+    def where_clause
+      if @time_range.is_a?(Range)
+        op = @time_range.exclude_end? ? "<" : "<="
+        ["#{column} >= ? AND #{column} #{op} ?", @time_range.first, @time_range.last]
+      else
+        ["#{column} IS NOT NULL"]
+      end
+    end
+
+    # resolves eagerly
+    # need to convert both where_clause (easy)
+    # and group_clause (not easy) if want to avoid this
+    def resolve_column(relation, column)
+      node = relation.send(:relation).send(:arel_columns, [column]).first
+      node = Arel::Nodes::SqlLiteral.new(node) if node.is_a?(String)
+      relation.connection.visitor.accept(node, Arel::Collectors::SQLString.new).value
+    end
+  end
+end

data/lib/tailor_made.rb

@@ -1,4 +1,11 @@
 require "tailor_made/version"
+
+require "groupdate"
+require "pagy"
+require 'pagy/extras/bootstrap'
+
+require "groupdate/group_alias" # mockey patch
+
 require "tailor_made/group_alias"
 require "tailor_made/relation_alias"
 require "tailor_made/methods"

data/lib/tailor_made/methods.rb

@@ -1,42 +1,44 @@
 module TailorMade
   module Methods
     def self.included(base) # :nodoc:
-      const_set('CANONICAL_DIMENSIONS', [])
-      const_set('CANONICAL_DOMAIN', {})
-      const_set('CANONICAL_ANCHORS', {})
-      const_set('TAILOR_MADE_MEASURES', [])
-      const_set('TAILOR_MADE_MEASURE_FORMULA', {})
-      const_set('DATETIME_COLUMNS', [])
-      const_set('DATETIME_DIMENSIONS', {})
-      const_set('TAILOR_MADE_MEASURES_DATETIME_PERMITED', {})
       base.extend ClassMethods
     end
 
     module ClassMethods
       def dimension(*attributes)
         dimension = attributes[0]
-        return if CANONICAL_DIMENSIONS.include?(dimension)
-        CANONICAL_DIMENSIONS << dimension
+        return if tailor_made_canonical_dimensions.include?(dimension)
+        tailor_made_canonical_dimensions << dimension
 
         attr_accessor dimension
-        CANONICAL_DOMAIN[dimension] = attributes[1][:domain] if attributes[1] && attributes[1][:domain]
-        CANONICAL_ANCHORS[dimension] = attributes[1][:anchor] if attributes[1] && attributes[1][:anchor]
+        tailor_made_canonical_domain[dimension] = attributes[1][:domain] if attributes[1] && attributes[1][:domain]
+        tailor_made_canonical_anchors[dimension] = attributes[1][:anchor] if attributes[1] && attributes[1][:anchor]
+      end
+
+      def filter(*attributes)
+        filter = attributes[0]
+        return if tailor_made_filters.include?(filter)
+        TAILOR_MADE_FILTERS << filter
+
+        attr_accessor filter
+        tailor_made_canonical_domain[dimension] = attributes[1][:domain] if attributes[1] && attributes[1][:domain]
+        tailor_made_canonical_anchors[dimension] = attributes[1][:anchor] if attributes[1] && attributes[1][:anchor]
       end
 
       def measure(*attributes)
         measure = attributes[0]
-        return if TAILOR_MADE_MEASURES.include?(measure)
-        TAILOR_MADE_MEASURES << measure
+        return if tailor_made_measures.include?(measure)
+        tailor_made_measures << measure
 
         if attributes[1] && attributes[1][:formula]
-          TAILOR_MADE_MEASURE_FORMULA[measure] = attributes[1][:formula]
+          tailor_made_measure_formula[measure] = attributes[1][:formula]
         end
       end
 
       def datetime_dimension(*attributes)
         dimension = attributes[0]
-        return if DATETIME_COLUMNS.include?(dimension)
-        DATETIME_COLUMNS << dimension
+        return if tailor_made_datetime_columns.include?(dimension)
+        tailor_made_datetime_columns << dimension
         attr_accessor "#{dimension.to_s}_starts_at".to_sym
         attr_accessor "#{dimension.to_s}_ends_at".to_sym
 
@@ -46,13 +48,63 @@ module TailorMade
           permit = Groupdate::PERIODS
         end
 
-        TAILOR_MADE_MEASURES_DATETIME_PERMITED[dimension] = permit
+        tailor_made_measures_datetime_permited[dimension] = permit
 
-        DATETIME_DIMENSIONS[dimension] = permit.map do |period|
+        tailor_made_datetime_dimensions[dimension] = permit.map do |period|
           [dimension, period].join("_").to_sym
         end
         # groups (day, month, year..)
       end
+
+      def permitted_attributes
+        [
+          :chart,
+          :plot_measure,
+          measures: [],
+          dimensions: []
+        ] +
+        tailor_made_datetime_columns.map { |a| "#{a.to_s}_starts_at".to_sym } +
+        tailor_made_datetime_columns.map { |a| "#{a.to_s}_ends_at".to_sym } +
+        tailor_made_canonical_dimensions +
+        tailor_made_filters
+
+      end
+
+      def tailor_made_canonical_dimensions
+        @tailor_made_canonical_dimensions ||= []
+      end
+
+      def tailor_made_canonical_domain
+        @tailor_made_canonical_domain ||= {}
+      end
+
+      def tailor_made_canonical_anchors
+        @tailor_made_canonical_anchors ||= {}
+      end
+
+      def tailor_made_measures
+        @tailor_made_measures ||= []
+      end
+
+      def tailor_made_measure_formula
+        @tailor_made_measure_formula ||= {}
+      end
+
+      def tailor_made_datetime_columns
+        @tailor_made_datetime_columns ||= []
+      end
+
+      def tailor_made_datetime_dimensions
+        @tailor_made_datetime_dimensions ||= {}
+      end
+
+      def tailor_made_measures_datetime_permited
+        @tailor_made_measures_datetime_permited ||= {}
+      end
+
+      def tailor_made_filters
+        @tailor_made_filters ||= []
+      end
     end
   end
 end

data/lib/tailor_made/query.rb

@@ -1,7 +1,6 @@
 module TailorMade
   class Query
     include ActiveModel::Model
-    include TailorMade::Methods # creates accesors for dimensions and measures
 
     attr_accessor :measures
     attr_accessor :dimensions
@@ -30,7 +29,6 @@ module TailorMade
       @plot_measure   ||= measures.first
 
       set_datetime_ranges
-      @scope = build_scope(from, dimensions)
     end
 
     def from
@@ -38,7 +36,21 @@ module TailorMade
     end
 
     def options_for_select
-      fail(NotImplementedError) # required in beta version
+      @options_for_select ||= begin
+        options = {
+          domain: self.class.tailor_made_canonical_dimensions + self.class.tailor_made_datetime_dimensions.values().flatten,
+          dimensions: self.class.tailor_made_canonical_dimensions + self.class.tailor_made_datetime_dimensions.values().flatten,
+          measures: self.class.tailor_made_measures,
+          plot_measure: self.class.tailor_made_measures,
+          chart: CHARTS
+        }
+        self.class.tailor_made_canonical_domain.each do |field|
+          if self.class.tailor_made_canonical_domain[field]
+            options = options.merge({ field => self.class.tailor_made_canonical_domain[field].call })
+          end
+        end
+        options
+      end
     end
 
     def chart
@@ -46,6 +58,7 @@ module TailorMade
     end
 
     def plot
+      scope = build_scope(from, dimensions)
       result = scope.order(order).pluck(plot_formulas(dimensions, scope))
       return result if dimensions.size < 2
       result.map { |row| row[1...-1] }.uniq.map { |combination|
@@ -72,6 +85,7 @@ module TailorMade
     end
 
     def all
+      @scope = build_scope(from, dimensions)
       scope.order(order).select(table_formulas)
     end
 
@@ -84,16 +98,14 @@ module TailorMade
       end
     end
 
-
-
     def tabelize(row, column)
-      if CANONICAL_ANCHORS[column].nil?
+      if self.class.tailor_made_canonical_anchors[column].nil?
         row.send(column)
       else
-        if CANONICAL_ANCHORS[column].respond_to? :call
-          CANONICAL_ANCHORS[column] = CANONICAL_ANCHORS[column].call
+        if self.class.tailor_made_canonical_anchors[column].respond_to? :call
+          self.class.tailor_made_canonical_anchors[column] = self.class.tailor_made_canonical_anchors[column].call
         end
-        result = CANONICAL_ANCHORS[column][row.send(column)]
+        result = self.class.tailor_made_canonical_anchors[column][row.send(column)]
         result = [row.send(column), result] if result
         result ||= row.send(column)
       end
@@ -106,7 +118,7 @@ module TailorMade
 
       scope = build_datetime_dimensions_scope(scope, dimensions)
 
-      datetime_dimensions = DATETIME_DIMENSIONS.values().flatten
+      datetime_dimensions = self.class.tailor_made_datetime_dimensions.values().flatten
       unless (dimensions - datetime_dimensions).empty?
         scope = scope.group(dimensions - datetime_dimensions)
       end
@@ -114,8 +126,13 @@ module TailorMade
     end
 
     def build_canonical_scope(scope)
-      CANONICAL_DIMENSIONS.each do |dimension|
-        scope = scope.where('#{dimension} LIKE ?', "%#{send(dimension)}%") if send(dimension).present?
+      self.class.tailor_made_canonical_dimensions.each do |dimension|
+        next if send(dimension).nil?
+        scope = scope.where(
+          ':dimension LIKE :pattern',
+          dimension: dimension,
+          pattern: "%#{send(dimension)}%"
+        )
       end
       scope
     end
@@ -123,7 +140,7 @@ module TailorMade
     # Datetime
 
     def build_datetime_dimensions_scope(scope, dimensions)
-      DATETIME_COLUMNS.each do |dimension|
+      self.class.tailor_made_datetime_columns.each do |dimension|
         scope = build_datetime_dimension_scope(scope, dimension, dimensions)
       end
       scope
@@ -132,7 +149,7 @@ module TailorMade
     def build_datetime_dimension_scope(scope, dimension, dimensions)
       starts_at = instance_variable_get("@#{dimension}_starts_at")
       ends_at = instance_variable_get("@#{dimension}_ends_at")
-      permit = TAILOR_MADE_MEASURES_DATETIME_PERMITED[dimension]
+      permit = self.class.tailor_made_measures_datetime_permited[dimension]
 
       if !starts_at.blank? && !ends_at.blank?
         scope = scope.where(dimension.to_sym => starts_at..ends_at)
@@ -147,7 +164,7 @@ module TailorMade
 
     def datetime_dimension_periods(datetime_dimension, dimensions)
       dimensions.select { |dimension|
-        DATETIME_DIMENSIONS[datetime_dimension].include?(dimension)
+        self.class.tailor_made_datetime_dimensions[datetime_dimension].include?(dimension)
       }
     end
 
@@ -156,7 +173,7 @@ module TailorMade
     end
 
     def set_datetime_ranges
-      DATETIME_COLUMNS.each do |dimension|
+      self.class.tailor_made_datetime_columns.each do |dimension|
         set_datetime_range(dimension)
       end
     end
@@ -311,7 +328,7 @@ module TailorMade
 
     def measure_formulas(measures)
       measures.map { |measure|
-        [TAILOR_MADE_MEASURE_FORMULA[measure], measure].join(" AS ")
+        [self.class.tailor_made_measure_formula[measure], measure].join(" AS ")
       }
     end
 

data/lib/tailor_made/version.rb

@@ -1,3 +1,3 @@
 module TailorMade
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/tailor_made.gemspec

@@ -26,6 +26,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "railties", ">= 4.2"
   spec.add_dependency "activerecord", ">= 4.2"
+  spec.add_dependency "pagy", ">= 2.1.2"
+  spec.add_dependency "groupdate", "~> 4.1.1"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tailor_made
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pedro Carmona
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-17 00:00:00.000000000 Z
+date: 2019-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: groupdate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +132,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -111,6 +140,13 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/tailor_made/dashboard/USAGE
+- lib/generators/tailor_made/dashboard/dashboard_generator.rb
+- lib/generators/tailor_made/dashboard/templates/controller.rb.erb
+- lib/generators/tailor_made/dashboard/templates/index.html.erb
+- lib/generators/tailor_made/dashboard/templates/query.rb.erb
+- lib/groupdate/group_alias.rb
+- lib/groupdate/relation_builder.rb
 - lib/tailor_made.rb
 - lib/tailor_made/group_alias.rb
 - lib/tailor_made/methods.rb